diff --git a/Intento.MT.Plugin.PropertiesForm.Test/Intento.MT.Plugin.PropertiesForm.Test.csproj b/Intento.MT.Plugin.PropertiesForm.Test/Intento.MT.Plugin.PropertiesForm.Test.csproj new file mode 100644 index 0000000..a973c69 --- /dev/null +++ b/Intento.MT.Plugin.PropertiesForm.Test/Intento.MT.Plugin.PropertiesForm.Test.csproj @@ -0,0 +1,26 @@ + + + + net45 + + false + + + + + + + + + + + + + + + + + + + + diff --git a/Tests.cs b/Intento.MT.Plugin.PropertiesForm.Test/Tests.cs similarity index 98% rename from Tests.cs rename to Intento.MT.Plugin.PropertiesForm.Test/Tests.cs index 818bb4b..9708676 100644 --- a/Tests.cs +++ b/Intento.MT.Plugin.PropertiesForm.Test/Tests.cs @@ -2,20 +2,12 @@ using System.Collections.Generic; using System.Drawing; using System.Linq; -using System.Resources; -using System.Text; -using System.Threading.Tasks; using System.Windows.Forms; -using Intento.MT.Plugin.PropertiesForm.WinForms; -using Microsoft.VisualStudio.TestTools.UnitTesting; -using Newtonsoft; using Newtonsoft.Json.Linq; -using static Intento.MT.Plugin.PropertiesForm.ApiKeyState; -using static Intento.MT.Plugin.PropertiesForm.IntentoTranslationProviderOptionsForm; +using NUnit.Framework; -namespace Intento.MT.Plugin.PropertiesForm -{ - [TestClass] +namespace Intento.MT.Plugin.PropertiesForm.Test +{ public sealed class Tests { private IntentoSDK.IntentoAiTextTranslate Fabric(string apiKey, string userAgent, IntentoSDK.ProxySettings proxySettings) @@ -409,7 +401,7 @@ Form InitializeForm(Form form) #endregion all parametries filled, auth - delegated, models & glossary - delegated #region auth - not delegated (the provider has no predefined), models & glossary - empty - [TestMethod] + [Test] public void InitionalFillOptionsForm2() { IntentoTranslationProviderOptionsForm form; @@ -491,9 +483,9 @@ public void InitionalFillOptionsForm2() Assert.AreEqual(true, form.groupBoxMTConnect2.Visible); Assert.AreEqual(options.ApiKey, form.apiKey_tb.Text); Assert.AreEqual(options.ProviderName, form.textBoxProviderName.Text); - Assert.AreEqual(Resource.Empty, form.textBoxAccount.Text); - Assert.AreEqual(Resource.Empty, form.textBoxModel.Text); - Assert.AreEqual(Resource.Empty, form.textBoxGlossary.Text); + Assert.AreEqual(string.Empty, form.textBoxAccount.Text); + Assert.AreEqual(string.Empty, form.textBoxModel.Text); + Assert.AreEqual(string.Empty, form.textBoxGlossary.Text); Assert.AreEqual(true, form.buttonContinue.Enabled); form.formMT.Close(); qqq.Refresh(); @@ -502,7 +494,7 @@ public void InitionalFillOptionsForm2() #endregion auth - not delegated (the provider has no predefined), models & glossary - empty #region all parametries filled, auth - delegated, models & glossary - not delegated - [TestMethod] + [Test] public void InitionalFillOptionsForm3() { options = new IntentoMTFormOptions() @@ -712,7 +704,7 @@ public void InitionalFillOptionsForm3() //} #endregion only API key filled, smartRouting - true - [TestMethod] + [Test] public void CleanOptionsOnChangeProvider() { #region all parametries filled, auth - not delegated, models & glossary - delegated @@ -772,7 +764,7 @@ public void CleanOptionsOnChangeProvider() qqq.Close(); } - [TestMethod] + [Test] public void CleanOptionsOnChangeCreditionals() { // all parametries filled, auth, models & glossary - delegated @@ -856,7 +848,8 @@ public void CleanOptionsOnChangeCreditionals() } #region ChangeOfLanguageOnChangeModel: all parametries filled, auth - delegated, models & glossary - delegated - [TestMethod] + + [Test] public void ChangeOfLanguageOnChangeModel() { options = new IntentoMTFormOptions() @@ -878,7 +871,7 @@ public void ChangeOfLanguageOnChangeModel() }; using (form = new IntentoTranslationProviderOptionsForm(options, langPair, Fabric, true)) { - testProviderData.delegated_credentials = true; + testProviderData.delegated_credentials = true; form.testListProvidersData = testProvidersData; form.testOneProviderData = testProviderData; form.testAuthData = testAuthDataGoogle; @@ -950,7 +943,7 @@ public void ChangeOfLanguageOnChangeModel() Assert.AreEqual(options.ApiKey, form.apiKey_tb.Text); Assert.AreEqual(options.ProviderName, form.textBoxProviderName.Text); Assert.AreEqual("test1", form.textBoxAccount.Text); - Assert.AreEqual(Resource.Empty, form.textBoxModel.Text); + Assert.AreEqual(string.Empty, form.textBoxModel.Text); Assert.AreEqual("gloss_ru_en", form.textBoxGlossary.Text); Assert.AreEqual(true, form.buttonContinue.Enabled); form.formMT.Close(); diff --git a/Intento.MT.Plugin.PropertiesForm.sln b/Intento.MT.Plugin.PropertiesForm.sln index ed2180c..eb15aaf 100644 --- a/Intento.MT.Plugin.PropertiesForm.sln +++ b/Intento.MT.Plugin.PropertiesForm.sln @@ -1,29 +1,31 @@  Microsoft Visual Studio Solution File, Format Version 12.00 -# Visual Studio 15 -VisualStudioVersion = 15.0.28010.2050 +# Visual Studio Version 16 +VisualStudioVersion = 16.0.31105.61 MinimumVisualStudioVersion = 10.0.40219.1 -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Intento.MT.Plugin.PropertiesForm", "Intento.MT.Plugin.PropertiesForm.csproj", "{A4374128-DD01-4CE3-B62C-4CC3460620C0}" -EndProject Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "TestForm", "TestForm\TestForm.csproj", "{A963C442-DFD3-4FE8-A2E1-9917AC274695}" ProjectSection(ProjectDependencies) = postProject {A4374128-DD01-4CE3-B62C-4CC3460620C0} = {A4374128-DD01-4CE3-B62C-4CC3460620C0} EndProjectSection EndProject +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Intento.MT.Plugin.PropertiesForm.Test", "Intento.MT.Plugin.PropertiesForm.Test\Intento.MT.Plugin.PropertiesForm.Test.csproj", "{5954BDAE-A274-4615-9E94-2D0A6FA8B786}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Intento.MT.Plugin.PropertiesForm", "Intento.MT.Plugin.PropertiesForm\Intento.MT.Plugin.PropertiesForm.csproj", "{A4374128-DD01-4CE3-B62C-4CC3460620C0}" +EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution Debug|Any CPU = Debug|Any CPU Release|Any CPU = Release|Any CPU EndGlobalSection GlobalSection(ProjectConfigurationPlatforms) = postSolution + {A963C442-DFD3-4FE8-A2E1-9917AC274695}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {A963C442-DFD3-4FE8-A2E1-9917AC274695}.Release|Any CPU.ActiveCfg = Release|Any CPU + {5954BDAE-A274-4615-9E94-2D0A6FA8B786}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {5954BDAE-A274-4615-9E94-2D0A6FA8B786}.Release|Any CPU.ActiveCfg = Release|Any CPU {A4374128-DD01-4CE3-B62C-4CC3460620C0}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {A4374128-DD01-4CE3-B62C-4CC3460620C0}.Debug|Any CPU.Build.0 = Debug|Any CPU {A4374128-DD01-4CE3-B62C-4CC3460620C0}.Release|Any CPU.ActiveCfg = Release|Any CPU {A4374128-DD01-4CE3-B62C-4CC3460620C0}.Release|Any CPU.Build.0 = Release|Any CPU - {A963C442-DFD3-4FE8-A2E1-9917AC274695}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {A963C442-DFD3-4FE8-A2E1-9917AC274695}.Debug|Any CPU.Build.0 = Debug|Any CPU - {A963C442-DFD3-4FE8-A2E1-9917AC274695}.Release|Any CPU.ActiveCfg = Release|Any CPU - {A963C442-DFD3-4FE8-A2E1-9917AC274695}.Release|Any CPU.Build.0 = Release|Any CPU EndGlobalSection GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE diff --git a/ApiKeyState.cs b/Intento.MT.Plugin.PropertiesForm/ApiKeyState.cs similarity index 100% rename from ApiKeyState.cs rename to Intento.MT.Plugin.PropertiesForm/ApiKeyState.cs diff --git a/AuthState.cs b/Intento.MT.Plugin.PropertiesForm/AuthState.cs similarity index 100% rename from AuthState.cs rename to Intento.MT.Plugin.PropertiesForm/AuthState.cs diff --git a/BaseState.cs b/Intento.MT.Plugin.PropertiesForm/BaseState.cs similarity index 100% rename from BaseState.cs rename to Intento.MT.Plugin.PropertiesForm/BaseState.cs diff --git a/GlossaryState.cs b/Intento.MT.Plugin.PropertiesForm/GlossaryState.cs similarity index 100% rename from GlossaryState.cs rename to Intento.MT.Plugin.PropertiesForm/GlossaryState.cs diff --git a/IForm.cs b/Intento.MT.Plugin.PropertiesForm/IForm.cs similarity index 100% rename from IForm.cs rename to Intento.MT.Plugin.PropertiesForm/IForm.cs diff --git a/Intento.MT.Plugin.PropertiesForm.csproj b/Intento.MT.Plugin.PropertiesForm/Intento.MT.Plugin.PropertiesForm.csproj similarity index 82% rename from Intento.MT.Plugin.PropertiesForm.csproj rename to Intento.MT.Plugin.PropertiesForm/Intento.MT.Plugin.PropertiesForm.csproj index ebd1e66..1c86d31 100644 --- a/Intento.MT.Plugin.PropertiesForm.csproj +++ b/Intento.MT.Plugin.PropertiesForm/Intento.MT.Plugin.PropertiesForm.csproj @@ -12,12 +12,14 @@ v4.5 512 true + 0 + ..\intento-csharp\bin\ true full false - bin\ + bin\ DEBUG;TRACE prompt 4 @@ -25,7 +27,7 @@ pdbonly true - bin\ + bin\ TRACE prompt 4 @@ -34,19 +36,14 @@ true - intento.pfx + intento_sn.snk - - ..\intento-csharp\bin\IntentoSDK.dll + + ..\..\packages\IntentoSDK.1.5.2\lib\net45\IntentoSDK.dll - - False - ..\..\..\..\..\..\Program Files (x86)\Microsoft Visual Studio\2017\Community\Common7\IDE\PublicAssemblies\Microsoft.VisualStudio.QualityTools.UnitTestFramework.dll - - - False - ..\intento-csharp\bin\Newtonsoft.Json.dll + + ..\..\packages\Newtonsoft.Json.13.0.1\lib\net45\Newtonsoft.Json.dll @@ -61,7 +58,6 @@ - Form @@ -150,11 +146,11 @@ - + - + - + @@ -163,4 +159,7 @@ $(ProjectDir)githashForm.bat >$(ProjectDir)GitHash.cs + + powershell -ExecutionPolicy RemoteSigned $(ProjectDir)postbuild.ps1 '$(TargetDir)$(TargetName).dll' + \ No newline at end of file diff --git a/Intento.MT.Plugin.PropertiesFormMemoQ.csproj b/Intento.MT.Plugin.PropertiesForm/Intento.MT.Plugin.PropertiesFormMemoQ.csproj similarity index 100% rename from Intento.MT.Plugin.PropertiesFormMemoQ.csproj rename to Intento.MT.Plugin.PropertiesForm/Intento.MT.Plugin.PropertiesFormMemoQ.csproj diff --git a/IntentoMTFormOptions.cs b/Intento.MT.Plugin.PropertiesForm/IntentoMTFormOptions.cs similarity index 100% rename from IntentoMTFormOptions.cs rename to Intento.MT.Plugin.PropertiesForm/IntentoMTFormOptions.cs diff --git a/IntentoTranslationProviderOptionsForm.Designer.cs b/Intento.MT.Plugin.PropertiesForm/IntentoTranslationProviderOptionsForm.Designer.cs similarity index 98% rename from IntentoTranslationProviderOptionsForm.Designer.cs rename to Intento.MT.Plugin.PropertiesForm/IntentoTranslationProviderOptionsForm.Designer.cs index 35a0486..740e12c 100644 --- a/IntentoTranslationProviderOptionsForm.Designer.cs +++ b/Intento.MT.Plugin.PropertiesForm/IntentoTranslationProviderOptionsForm.Designer.cs @@ -1,577 +1,577 @@ -namespace Intento.MT.Plugin.PropertiesForm -{ - partial class IntentoTranslationProviderOptionsForm1 - { - /// - /// Required designer variable. - /// - private System.ComponentModel.IContainer components = null; - - /// - /// Clean up any resources being used. - /// - /// true if managed resources should be disposed; otherwise, false. - protected override void Dispose(bool disposing) - { - if (disposing && (components != null)) - { - components.Dispose(); - } - base.Dispose(disposing); - } - - #region Windows Form Designer generated code - - /// - /// Required method for Designer support - do not modify - /// the contents of this method with the code editor. - /// - private void InitializeComponent() - { - this.components = new System.ComponentModel.Container(); - this.buttonCheck = new System.Windows.Forms.Button(); - this.apiKey_tb = new System.Windows.Forms.TextBox(); - this.label5 = new System.Windows.Forms.Label(); - this.buttonContinue = new System.Windows.Forms.Button(); - this.groupBoxProviderSettings = new System.Windows.Forms.GroupBox(); - this.groupBoxAuth = new System.Windows.Forms.GroupBox(); - this.buttonWizard = new System.Windows.Forms.Button(); - this.textBoxCredentials = new System.Windows.Forms.TextBox(); - this.groupBoxAuthCredentialId = new System.Windows.Forms.GroupBox(); - this.comboBoxCredentialId = new System.Windows.Forms.ComboBox(); - this.labelStoredCredential1 = new System.Windows.Forms.Label(); - this.linkLabel3 = new System.Windows.Forms.LinkLabel(); - this.label8 = new System.Windows.Forms.Label(); - this.checkBoxUseCustomModel = new System.Windows.Forms.CheckBox(); - this.groupBoxGlossaries = new System.Windows.Forms.GroupBox(); - this.textBoxGlossary = new System.Windows.Forms.TextBox(); - this.comboBoxGlossaries = new System.Windows.Forms.ComboBox(); - this.groupBoxModel = new System.Windows.Forms.GroupBox(); - this.textBoxModel = new System.Windows.Forms.TextBox(); - this.comboBoxModels = new System.Windows.Forms.ComboBox(); - this.label1 = new System.Windows.Forms.Label(); - this.comboBoxProviders = new System.Windows.Forms.ComboBox(); - this.checkBoxUseOwnCred = new System.Windows.Forms.CheckBox(); - this.toolTipFormat = new System.Windows.Forms.ToolTip(this.components); - this.label2 = new System.Windows.Forms.Label(); - this.label3 = new System.Windows.Forms.Label(); - this.checkBoxTrace = new System.Windows.Forms.CheckBox(); - this.statusStrip1 = new System.Windows.Forms.StatusStrip(); - this.toolStripStatusLabel1 = new System.Windows.Forms.ToolStripStatusLabel(); - this.toolStripStatusLabel2 = new System.Windows.Forms.ToolStripStatusLabel(); - this.checkBoxShowHidden = new System.Windows.Forms.CheckBox(); - this.timer1 = new System.Windows.Forms.Timer(this.components); - this.checkBoxSmartRouting = new System.Windows.Forms.CheckBox(); - this.checkBoxSaveApiKeyInRegistry = new System.Windows.Forms.CheckBox(); - this.textBoxLabel1 = new System.Windows.Forms.TextBox(); - this.checkBoxProxy = new System.Windows.Forms.CheckBox(); - this.textBox1 = new System.Windows.Forms.TextBox(); - this.groupBoxProviderSettings.SuspendLayout(); - this.groupBoxAuth.SuspendLayout(); - this.groupBoxAuthCredentialId.SuspendLayout(); - this.groupBoxGlossaries.SuspendLayout(); - this.groupBoxModel.SuspendLayout(); - this.statusStrip1.SuspendLayout(); - this.SuspendLayout(); - // - // buttonCheck - // - this.buttonCheck.FlatStyle = System.Windows.Forms.FlatStyle.Flat; - this.buttonCheck.Location = new System.Drawing.Point(446, 92); - this.buttonCheck.Name = "buttonCheck"; - this.buttonCheck.Size = new System.Drawing.Size(81, 23); - this.buttonCheck.TabIndex = 2; - this.buttonCheck.Text = "Check"; - this.buttonCheck.UseVisualStyleBackColor = true; - this.buttonCheck.Click += new System.EventHandler(this.buttonCheck_Click); - // - // apiKey_tb - // - this.apiKey_tb.BorderStyle = System.Windows.Forms.BorderStyle.FixedSingle; - this.apiKey_tb.Location = new System.Drawing.Point(55, 94); - this.apiKey_tb.Name = "apiKey_tb"; - this.apiKey_tb.Size = new System.Drawing.Size(369, 20); - this.apiKey_tb.TabIndex = 1; - this.apiKey_tb.UseSystemPasswordChar = true; - this.apiKey_tb.WordWrap = false; - this.apiKey_tb.TextChanged += new System.EventHandler(this.apiKey_tb_TextChanged); - // - // label5 - // - this.label5.AutoSize = true; - this.label5.Location = new System.Drawing.Point(4, 97); - this.label5.Name = "label5"; - this.label5.Size = new System.Drawing.Size(45, 13); - this.label5.TabIndex = 7; - this.label5.Text = "API Key"; - // - // buttonContinue - // - this.buttonContinue.Anchor = ((System.Windows.Forms.AnchorStyles)((System.Windows.Forms.AnchorStyles.Bottom | System.Windows.Forms.AnchorStyles.Left))); - this.buttonContinue.DialogResult = System.Windows.Forms.DialogResult.OK; - this.buttonContinue.Enabled = false; - this.buttonContinue.FlatStyle = System.Windows.Forms.FlatStyle.Flat; - this.buttonContinue.Location = new System.Drawing.Point(7, 523); - this.buttonContinue.Name = "buttonContinue"; - this.buttonContinue.Size = new System.Drawing.Size(75, 23); - this.buttonContinue.TabIndex = 14; - this.buttonContinue.Text = "Continue"; - this.buttonContinue.UseVisualStyleBackColor = true; - this.buttonContinue.Click += new System.EventHandler(this.buttonContinue_Click); - // - // groupBoxProviderSettings - // - this.groupBoxProviderSettings.Anchor = ((System.Windows.Forms.AnchorStyles)((((System.Windows.Forms.AnchorStyles.Top | System.Windows.Forms.AnchorStyles.Bottom) - | System.Windows.Forms.AnchorStyles.Left) - | System.Windows.Forms.AnchorStyles.Right))); - this.groupBoxProviderSettings.Controls.Add(this.groupBoxAuth); - this.groupBoxProviderSettings.Controls.Add(this.groupBoxAuthCredentialId); - this.groupBoxProviderSettings.Controls.Add(this.checkBoxUseCustomModel); - this.groupBoxProviderSettings.Controls.Add(this.groupBoxGlossaries); - this.groupBoxProviderSettings.Controls.Add(this.groupBoxModel); - this.groupBoxProviderSettings.Controls.Add(this.label1); - this.groupBoxProviderSettings.Controls.Add(this.comboBoxProviders); - this.groupBoxProviderSettings.Controls.Add(this.checkBoxUseOwnCred); - this.groupBoxProviderSettings.FlatStyle = System.Windows.Forms.FlatStyle.Flat; - this.groupBoxProviderSettings.Location = new System.Drawing.Point(7, 154); - this.groupBoxProviderSettings.Name = "groupBoxProviderSettings"; - this.groupBoxProviderSettings.Size = new System.Drawing.Size(531, 348); - this.groupBoxProviderSettings.TabIndex = 5; - this.groupBoxProviderSettings.TabStop = false; - this.groupBoxProviderSettings.Text = "MT Provider settings"; - this.groupBoxProviderSettings.Visible = false; - // - // groupBoxAuth - // - this.groupBoxAuth.Controls.Add(this.buttonWizard); - this.groupBoxAuth.Controls.Add(this.textBoxCredentials); - this.groupBoxAuth.Location = new System.Drawing.Point(10, 84); - this.groupBoxAuth.Name = "groupBoxAuth"; - this.groupBoxAuth.Size = new System.Drawing.Size(511, 89); - this.groupBoxAuth.TabIndex = 7; - this.groupBoxAuth.TabStop = false; - this.groupBoxAuth.Text = "Authorization parameters groupBoxAuth"; - // - // buttonWizard - // - this.buttonWizard.FlatStyle = System.Windows.Forms.FlatStyle.Flat; - this.buttonWizard.Location = new System.Drawing.Point(414, 31); - this.buttonWizard.Name = "buttonWizard"; - this.buttonWizard.Size = new System.Drawing.Size(81, 23); - this.buttonWizard.TabIndex = 8; - this.buttonWizard.Text = "Fill or edit"; - this.buttonWizard.UseVisualStyleBackColor = true; - this.buttonWizard.EnabledChanged += new System.EventHandler(this.buttonWizard_EnabledChanged); - this.buttonWizard.Click += new System.EventHandler(this.buttonWizard_Click); - // - // textBoxCredentials - // - this.textBoxCredentials.BackColor = System.Drawing.SystemColors.Window; - this.textBoxCredentials.BorderStyle = System.Windows.Forms.BorderStyle.FixedSingle; - this.textBoxCredentials.Cursor = System.Windows.Forms.Cursors.Hand; - this.textBoxCredentials.ForeColor = System.Drawing.SystemColors.WindowText; - this.textBoxCredentials.Location = new System.Drawing.Point(21, 31); - this.textBoxCredentials.Name = "textBoxCredentials"; - this.textBoxCredentials.ReadOnly = true; - this.textBoxCredentials.Size = new System.Drawing.Size(387, 20); - this.textBoxCredentials.TabIndex = 7; - this.textBoxCredentials.UseSystemPasswordChar = true; - this.textBoxCredentials.Click += new System.EventHandler(this.textBoxCredentials_Enter); - this.textBoxCredentials.Enter += new System.EventHandler(this.textBoxCredentials_Enter); - // - // groupBoxAuthCredentialId - // - this.groupBoxAuthCredentialId.Controls.Add(this.comboBoxCredentialId); - this.groupBoxAuthCredentialId.Controls.Add(this.labelStoredCredential1); - this.groupBoxAuthCredentialId.Controls.Add(this.linkLabel3); - this.groupBoxAuthCredentialId.Controls.Add(this.label8); - this.groupBoxAuthCredentialId.Location = new System.Drawing.Point(79, 42); - this.groupBoxAuthCredentialId.Name = "groupBoxAuthCredentialId"; - this.groupBoxAuthCredentialId.Size = new System.Drawing.Size(512, 86); - this.groupBoxAuthCredentialId.TabIndex = 9; - this.groupBoxAuthCredentialId.TabStop = false; - this.groupBoxAuthCredentialId.Text = "Stored Credentials groupBoxAuthCredentialId"; - // - // comboBoxCredentialId - // - this.comboBoxCredentialId.DropDownStyle = System.Windows.Forms.ComboBoxStyle.DropDownList; - this.comboBoxCredentialId.Enabled = false; - this.comboBoxCredentialId.FlatStyle = System.Windows.Forms.FlatStyle.Flat; - this.comboBoxCredentialId.FormattingEnabled = true; - this.comboBoxCredentialId.Location = new System.Drawing.Point(42, 21); - this.comboBoxCredentialId.Name = "comboBoxCredentialId"; - this.comboBoxCredentialId.Size = new System.Drawing.Size(387, 21); - this.comboBoxCredentialId.TabIndex = 9; - this.comboBoxCredentialId.SelectedIndexChanged += new System.EventHandler(this.comboBoxCredentialId_SelectedIndexChanged); - // - // labelStoredCredential1 - // - this.labelStoredCredential1.AutoSize = true; - this.labelStoredCredential1.Location = new System.Drawing.Point(40, 59); - this.labelStoredCredential1.Name = "labelStoredCredential1"; - this.labelStoredCredential1.Size = new System.Drawing.Size(216, 13); - this.labelStoredCredential1.TabIndex = 33; - this.labelStoredCredential1.Text = "More information on Stored Credentials here:"; - // - // linkLabel3 - // - this.linkLabel3.AutoSize = true; - this.linkLabel3.Location = new System.Drawing.Point(255, 59); - this.linkLabel3.Name = "linkLabel3"; - this.linkLabel3.Size = new System.Drawing.Size(174, 13); - this.linkLabel3.TabIndex = 32; - this.linkLabel3.TabStop = true; - this.linkLabel3.Text = "https://console.inten.to/credentials"; - // - // label8 - // - this.label8.AutoSize = true; - this.label8.Location = new System.Drawing.Point(12, 21); - this.label8.Name = "label8"; - this.label8.Size = new System.Drawing.Size(0, 13); - this.label8.TabIndex = 27; - // - // checkBoxUseCustomModel - // - this.checkBoxUseCustomModel.AutoSize = true; - this.checkBoxUseCustomModel.Enabled = false; - this.checkBoxUseCustomModel.FlatStyle = System.Windows.Forms.FlatStyle.Flat; - this.checkBoxUseCustomModel.Location = new System.Drawing.Point(15, 183); - this.checkBoxUseCustomModel.Name = "checkBoxUseCustomModel"; - this.checkBoxUseCustomModel.Size = new System.Drawing.Size(133, 17); - this.checkBoxUseCustomModel.TabIndex = 10; - this.checkBoxUseCustomModel.Text = "Use own custom model"; - this.checkBoxUseCustomModel.UseVisualStyleBackColor = true; - this.checkBoxUseCustomModel.Visible = false; - this.checkBoxUseCustomModel.CheckedChanged += new System.EventHandler(this.checkBoxUseCustomModel_CheckedChanged); - // - // groupBoxGlossaries - // - this.groupBoxGlossaries.Controls.Add(this.textBoxGlossary); - this.groupBoxGlossaries.Controls.Add(this.comboBoxGlossaries); - this.groupBoxGlossaries.Location = new System.Drawing.Point(9, 280); - this.groupBoxGlossaries.Name = "groupBoxGlossaries"; - this.groupBoxGlossaries.Size = new System.Drawing.Size(511, 59); - this.groupBoxGlossaries.TabIndex = 13; - this.groupBoxGlossaries.TabStop = false; - this.groupBoxGlossaries.Text = "Glossary"; - this.groupBoxGlossaries.Visible = false; - // - // textBoxGlossary - // - this.textBoxGlossary.BorderStyle = System.Windows.Forms.BorderStyle.FixedSingle; - this.textBoxGlossary.ForeColor = System.Drawing.SystemColors.WindowText; - this.textBoxGlossary.Location = new System.Drawing.Point(11, 19); - this.textBoxGlossary.Name = "textBoxGlossary"; - this.textBoxGlossary.Size = new System.Drawing.Size(485, 20); - this.textBoxGlossary.TabIndex = 13; - // - // comboBoxGlossaries - // - this.comboBoxGlossaries.DropDownStyle = System.Windows.Forms.ComboBoxStyle.DropDownList; - this.comboBoxGlossaries.FlatStyle = System.Windows.Forms.FlatStyle.Flat; - this.comboBoxGlossaries.FormattingEnabled = true; - this.comboBoxGlossaries.Location = new System.Drawing.Point(11, 19); - this.comboBoxGlossaries.Name = "comboBoxGlossaries"; - this.comboBoxGlossaries.Size = new System.Drawing.Size(485, 21); - this.comboBoxGlossaries.TabIndex = 37; - // - // groupBoxModel - // - this.groupBoxModel.Controls.Add(this.textBoxModel); - this.groupBoxModel.Controls.Add(this.comboBoxModels); - this.groupBoxModel.Location = new System.Drawing.Point(9, 208); - this.groupBoxModel.Name = "groupBoxModel"; - this.groupBoxModel.Size = new System.Drawing.Size(512, 66); - this.groupBoxModel.TabIndex = 11; - this.groupBoxModel.TabStop = false; - this.groupBoxModel.Text = "Model"; - this.groupBoxModel.Visible = false; - // - // textBoxModel - // - this.textBoxModel.BorderStyle = System.Windows.Forms.BorderStyle.FixedSingle; - this.textBoxModel.ForeColor = System.Drawing.SystemColors.WindowText; - this.textBoxModel.Location = new System.Drawing.Point(11, 30); - this.textBoxModel.Name = "textBoxModel"; - this.textBoxModel.Size = new System.Drawing.Size(485, 20); - this.textBoxModel.TabIndex = 12; - this.textBoxModel.TextChanged += new System.EventHandler(this.textBoxModel_TextChanged); - // - // comboBoxModels - // - this.comboBoxModels.DropDownStyle = System.Windows.Forms.ComboBoxStyle.DropDownList; - this.comboBoxModels.FlatStyle = System.Windows.Forms.FlatStyle.Flat; - this.comboBoxModels.FormattingEnabled = true; - this.comboBoxModels.Location = new System.Drawing.Point(11, 19); - this.comboBoxModels.Name = "comboBoxModels"; - this.comboBoxModels.Size = new System.Drawing.Size(485, 21); - this.comboBoxModels.TabIndex = 11; - this.comboBoxModels.Visible = false; - this.comboBoxModels.SelectedIndexChanged += new System.EventHandler(this.comboBoxModels_SelectedIndexChanged); - // - // label1 - // - this.label1.AutoSize = true; - this.label1.Location = new System.Drawing.Point(17, 17); - this.label1.Name = "label1"; - this.label1.Size = new System.Drawing.Size(46, 13); - this.label1.TabIndex = 1; - this.label1.Text = "Provider"; - // - // comboBoxProviders - // - this.comboBoxProviders.DropDownStyle = System.Windows.Forms.ComboBoxStyle.DropDownList; - this.comboBoxProviders.FlatStyle = System.Windows.Forms.FlatStyle.Flat; - this.comboBoxProviders.FormattingEnabled = true; - this.comboBoxProviders.Location = new System.Drawing.Point(8, 33); - this.comboBoxProviders.Name = "comboBoxProviders"; - this.comboBoxProviders.Size = new System.Drawing.Size(512, 21); - this.comboBoxProviders.TabIndex = 5; - this.comboBoxProviders.SelectedIndexChanged += new System.EventHandler(this.comboBoxProviders_SelectedIndexChanged); - // - // checkBoxUseOwnCred - // - this.checkBoxUseOwnCred.AutoSize = true; - this.checkBoxUseOwnCred.FlatStyle = System.Windows.Forms.FlatStyle.Flat; - this.checkBoxUseOwnCred.Location = new System.Drawing.Point(15, 61); - this.checkBoxUseOwnCred.Name = "checkBoxUseOwnCred"; - this.checkBoxUseOwnCred.Size = new System.Drawing.Size(142, 17); - this.checkBoxUseOwnCred.TabIndex = 6; - this.checkBoxUseOwnCred.Text = "Use your own credentials"; - this.checkBoxUseOwnCred.UseVisualStyleBackColor = true; - this.checkBoxUseOwnCred.CheckedChanged += new System.EventHandler(this.checkBoxUseOwnCred_CheckedChanged); - // - // toolTipFormat - // - this.toolTipFormat.ToolTipTitle = "Format"; - // - // label2 - // - this.label2.AutoSize = true; - this.label2.Location = new System.Drawing.Point(8, 13); - this.label2.Name = "label2"; - this.label2.Size = new System.Drawing.Size(247, 13); - this.label2.TabIndex = 0; - this.label2.Text = "If you don\'t have an Intento API key, register here: "; - // - // label3 - // - this.label3.AutoSize = true; - this.label3.Location = new System.Drawing.Point(8, 30); - this.label3.Name = "label3"; - this.label3.Size = new System.Drawing.Size(57, 13); - this.label3.TabIndex = 0; - this.label3.Text = "More info: "; - // - // checkBoxTrace - // - this.checkBoxTrace.Anchor = ((System.Windows.Forms.AnchorStyles)((System.Windows.Forms.AnchorStyles.Bottom | System.Windows.Forms.AnchorStyles.Right))); - this.checkBoxTrace.AutoSize = true; - this.checkBoxTrace.FlatStyle = System.Windows.Forms.FlatStyle.Flat; - this.checkBoxTrace.Location = new System.Drawing.Point(383, 526); - this.checkBoxTrace.Name = "checkBoxTrace"; - this.checkBoxTrace.Size = new System.Drawing.Size(155, 17); - this.checkBoxTrace.TabIndex = 17; - this.checkBoxTrace.Text = "Log payloads for 30 minutes"; - this.checkBoxTrace.UseVisualStyleBackColor = true; - this.checkBoxTrace.CheckedChanged += new System.EventHandler(this.checkBoxTrace_CheckedChanged); - // - // statusStrip1 - // - this.statusStrip1.Items.AddRange(new System.Windows.Forms.ToolStripItem[] { - this.toolStripStatusLabel1, - this.toolStripStatusLabel2}); - this.statusStrip1.Location = new System.Drawing.Point(0, 554); - this.statusStrip1.Name = "statusStrip1"; - this.statusStrip1.Size = new System.Drawing.Size(546, 22); - this.statusStrip1.TabIndex = 20; - this.statusStrip1.Text = "statusStrip1"; - // - // toolStripStatusLabel1 - // - this.toolStripStatusLabel1.BackColor = System.Drawing.SystemColors.Control; - this.toolStripStatusLabel1.Name = "toolStripStatusLabel1"; - this.toolStripStatusLabel1.Size = new System.Drawing.Size(476, 17); - this.toolStripStatusLabel1.Spring = true; - this.toolStripStatusLabel1.TextAlign = System.Drawing.ContentAlignment.MiddleLeft; - // - // toolStripStatusLabel2 - // - this.toolStripStatusLabel2.DisplayStyle = System.Windows.Forms.ToolStripItemDisplayStyle.Text; - this.toolStripStatusLabel2.Font = new System.Drawing.Font("Microsoft Sans Serif", 8.25F, System.Drawing.FontStyle.Regular, System.Drawing.GraphicsUnit.Point, ((byte)(204))); - this.toolStripStatusLabel2.ImageAlign = System.Drawing.ContentAlignment.MiddleRight; - this.toolStripStatusLabel2.Name = "toolStripStatusLabel2"; - this.toolStripStatusLabel2.Size = new System.Drawing.Size(55, 17); - this.toolStripStatusLabel2.Text = "x.x.x/20xx"; - // - // checkBoxShowHidden - // - this.checkBoxShowHidden.Anchor = ((System.Windows.Forms.AnchorStyles)((System.Windows.Forms.AnchorStyles.Bottom | System.Windows.Forms.AnchorStyles.Right))); - this.checkBoxShowHidden.AutoSize = true; - this.checkBoxShowHidden.FlatStyle = System.Windows.Forms.FlatStyle.Flat; - this.checkBoxShowHidden.Location = new System.Drawing.Point(266, 526); - this.checkBoxShowHidden.Name = "checkBoxShowHidden"; - this.checkBoxShowHidden.Size = new System.Drawing.Size(105, 17); - this.checkBoxShowHidden.TabIndex = 16; - this.checkBoxShowHidden.Text = "Show hidden text"; - this.checkBoxShowHidden.UseVisualStyleBackColor = true; - this.checkBoxShowHidden.CheckedChanged += new System.EventHandler(this.checkBoxShowHidden_CheckedChanged); - // - // timer1 - // - this.timer1.Interval = 300; - this.timer1.Tick += new System.EventHandler(this.timer1_Tick); - // - // checkBoxSmartRouting - // - this.checkBoxSmartRouting.AutoSize = true; - this.checkBoxSmartRouting.FlatStyle = System.Windows.Forms.FlatStyle.Flat; - this.checkBoxSmartRouting.Location = new System.Drawing.Point(55, 120); - this.checkBoxSmartRouting.Name = "checkBoxSmartRouting"; - this.checkBoxSmartRouting.Size = new System.Drawing.Size(85, 17); - this.checkBoxSmartRouting.TabIndex = 3; - this.checkBoxSmartRouting.Text = "Smart routing"; - this.checkBoxSmartRouting.UseVisualStyleBackColor = true; - this.checkBoxSmartRouting.CheckedChanged += new System.EventHandler(this.checkBoxSmartRouting_CheckedChanged); - // - // checkBoxSaveApiKeyInRegistry - // - this.checkBoxSaveApiKeyInRegistry.Anchor = ((System.Windows.Forms.AnchorStyles)((System.Windows.Forms.AnchorStyles.Bottom | System.Windows.Forms.AnchorStyles.Right))); - this.checkBoxSaveApiKeyInRegistry.AutoSize = true; - this.checkBoxSaveApiKeyInRegistry.FlatStyle = System.Windows.Forms.FlatStyle.Flat; - this.checkBoxSaveApiKeyInRegistry.Location = new System.Drawing.Point(125, 526); - this.checkBoxSaveApiKeyInRegistry.Name = "checkBoxSaveApiKeyInRegistry"; - this.checkBoxSaveApiKeyInRegistry.Size = new System.Drawing.Size(121, 17); - this.checkBoxSaveApiKeyInRegistry.TabIndex = 15; - this.checkBoxSaveApiKeyInRegistry.Text = "Save API Key locally"; - this.checkBoxSaveApiKeyInRegistry.UseVisualStyleBackColor = true; - this.checkBoxSaveApiKeyInRegistry.CheckedChanged += new System.EventHandler(this.checkBoxSaveApiKeyInRegistry_CheckedChanged); - // - // textBoxLabel1 - // - this.textBoxLabel1.BackColor = System.Drawing.SystemColors.Control; - this.textBoxLabel1.BorderStyle = System.Windows.Forms.BorderStyle.None; - this.textBoxLabel1.Cursor = System.Windows.Forms.Cursors.Hand; - this.textBoxLabel1.Font = new System.Drawing.Font("Microsoft Sans Serif", 8.25F, System.Drawing.FontStyle.Underline, System.Drawing.GraphicsUnit.Point, ((byte)(204))); - this.textBoxLabel1.ForeColor = System.Drawing.Color.Blue; - this.textBoxLabel1.Location = new System.Drawing.Point(253, 13); - this.textBoxLabel1.Name = "textBoxLabel1"; - this.textBoxLabel1.Size = new System.Drawing.Size(118, 13); - this.textBoxLabel1.TabIndex = 18; - this.textBoxLabel1.Text = "https://console.inten.to"; - this.textBoxLabel1.Enter += new System.EventHandler(this.textBoxLabel_Enter); - // - // checkBoxProxy - // - this.checkBoxProxy.AutoSize = true; - this.checkBoxProxy.Checked = true; - this.checkBoxProxy.CheckState = System.Windows.Forms.CheckState.Checked; - this.checkBoxProxy.FlatStyle = System.Windows.Forms.FlatStyle.Flat; - this.checkBoxProxy.Location = new System.Drawing.Point(7, 60); - this.checkBoxProxy.Name = "checkBoxProxy"; - this.checkBoxProxy.Size = new System.Drawing.Size(371, 17); - this.checkBoxProxy.TabIndex = 26; - this.checkBoxProxy.Text = "Enable proxy server (Attention! This setting applies to all Intento MT rules.)"; - this.checkBoxProxy.UseVisualStyleBackColor = true; - // - // textBox1 - // - this.textBox1.BackColor = System.Drawing.SystemColors.Control; - this.textBox1.BorderStyle = System.Windows.Forms.BorderStyle.None; - this.textBox1.Cursor = System.Windows.Forms.Cursors.Hand; - this.textBox1.Font = new System.Drawing.Font("Microsoft Sans Serif", 8.25F, System.Drawing.FontStyle.Underline, System.Drawing.GraphicsUnit.Point, ((byte)(204))); - this.textBox1.ForeColor = System.Drawing.Color.Blue; - this.textBox1.Location = new System.Drawing.Point(64, 30); - this.textBox1.Name = "textBox1"; - this.textBox1.Size = new System.Drawing.Size(75, 13); - this.textBox1.TabIndex = 19; - this.textBox1.Text = "https://inten.to"; - this.textBox1.Enter += new System.EventHandler(this.textBoxLabel_Enter); - // - // IntentoTranslationProviderOptionsForm - // - this.AutoScaleDimensions = new System.Drawing.SizeF(96F, 96F); - this.AutoScaleMode = System.Windows.Forms.AutoScaleMode.Dpi; - this.ClientSize = new System.Drawing.Size(546, 576); - this.Controls.Add(this.checkBoxProxy); - this.Controls.Add(this.textBox1); - this.Controls.Add(this.textBoxLabel1); - this.Controls.Add(this.checkBoxSaveApiKeyInRegistry); - this.Controls.Add(this.checkBoxSmartRouting); - this.Controls.Add(this.checkBoxShowHidden); - this.Controls.Add(this.statusStrip1); - this.Controls.Add(this.checkBoxTrace); - this.Controls.Add(this.label3); - this.Controls.Add(this.label2); - this.Controls.Add(this.groupBoxProviderSettings); - this.Controls.Add(this.buttonContinue); - this.Controls.Add(this.label5); - this.Controls.Add(this.apiKey_tb); - this.Controls.Add(this.buttonCheck); - this.Font = new System.Drawing.Font("Microsoft Sans Serif", 8.25F, System.Drawing.FontStyle.Regular, System.Drawing.GraphicsUnit.Point, ((byte)(204))); - this.FormBorderStyle = System.Windows.Forms.FormBorderStyle.FixedDialog; - this.MaximizeBox = false; - this.MinimizeBox = false; - this.Name = "IntentoTranslationProviderOptionsForm"; - this.StartPosition = System.Windows.Forms.FormStartPosition.CenterParent; - this.Text = "Intento plugin settings"; - this.Shown += new System.EventHandler(this.IntentoTranslationProviderOptionsForm_Shown); - this.groupBoxProviderSettings.ResumeLayout(false); - this.groupBoxProviderSettings.PerformLayout(); - this.groupBoxAuth.ResumeLayout(false); - this.groupBoxAuth.PerformLayout(); - this.groupBoxAuthCredentialId.ResumeLayout(false); - this.groupBoxAuthCredentialId.PerformLayout(); - this.groupBoxGlossaries.ResumeLayout(false); - this.groupBoxGlossaries.PerformLayout(); - this.groupBoxModel.ResumeLayout(false); - this.groupBoxModel.PerformLayout(); - this.statusStrip1.ResumeLayout(false); - this.statusStrip1.PerformLayout(); - this.ResumeLayout(false); - this.PerformLayout(); - - } - - #endregion - - public System.Windows.Forms.Button buttonCheck; - public System.Windows.Forms.TextBox apiKey_tb; - private System.Windows.Forms.Label label5; - private System.Windows.Forms.Button buttonContinue; - public System.Windows.Forms.GroupBox groupBoxProviderSettings; - private System.Windows.Forms.Label label1; - public System.Windows.Forms.ComboBox comboBoxProviders; - public System.Windows.Forms.CheckBox checkBoxUseOwnCred; - private System.Windows.Forms.ToolTip toolTipFormat; - private System.Windows.Forms.Label label2; - private System.Windows.Forms.Label label3; - private System.Windows.Forms.CheckBox checkBoxTrace; - private System.Windows.Forms.StatusStrip statusStrip1; - private System.Windows.Forms.ToolStripStatusLabel toolStripStatusLabel1; - private System.Windows.Forms.ToolStripStatusLabel toolStripStatusLabel2; - public System.Windows.Forms.CheckBox checkBoxShowHidden; - public System.Windows.Forms.GroupBox groupBoxAuth; - private System.Windows.Forms.Button buttonWizard; - public System.Windows.Forms.TextBox textBoxCredentials; - public System.Windows.Forms.CheckBox checkBoxUseCustomModel; - public System.Windows.Forms.GroupBox groupBoxModel; - public System.Windows.Forms.ComboBox comboBoxModels; - private System.Windows.Forms.Timer timer1; - public System.Windows.Forms.CheckBox checkBoxSmartRouting; - public System.Windows.Forms.TextBox textBoxModel; - public System.Windows.Forms.GroupBox groupBoxAuthCredentialId; - public System.Windows.Forms.ComboBox comboBoxCredentialId; - private System.Windows.Forms.Label labelStoredCredential1; - private System.Windows.Forms.LinkLabel linkLabel3; - private System.Windows.Forms.Label label8; - public System.Windows.Forms.GroupBox groupBoxGlossaries; - public System.Windows.Forms.TextBox textBoxGlossary; - public System.Windows.Forms.ComboBox comboBoxGlossaries; - public System.Windows.Forms.CheckBox checkBoxSaveApiKeyInRegistry; - public System.Windows.Forms.CheckBox checkBoxProxy; - private System.Windows.Forms.TextBox textBoxLabel1; - private System.Windows.Forms.TextBox textBox1; - } +namespace Intento.MT.Plugin.PropertiesForm +{ + partial class IntentoTranslationProviderOptionsForm1 + { + /// + /// Required designer variable. + /// + private System.ComponentModel.IContainer components = null; + + /// + /// Clean up any resources being used. + /// + /// true if managed resources should be disposed; otherwise, false. + protected override void Dispose(bool disposing) + { + if (disposing && (components != null)) + { + components.Dispose(); + } + base.Dispose(disposing); + } + + #region Windows Form Designer generated code + + /// + /// Required method for Designer support - do not modify + /// the contents of this method with the code editor. + /// + private void InitializeComponent() + { + this.components = new System.ComponentModel.Container(); + this.buttonCheck = new System.Windows.Forms.Button(); + this.apiKey_tb = new System.Windows.Forms.TextBox(); + this.label5 = new System.Windows.Forms.Label(); + this.buttonContinue = new System.Windows.Forms.Button(); + this.groupBoxProviderSettings = new System.Windows.Forms.GroupBox(); + this.groupBoxAuth = new System.Windows.Forms.GroupBox(); + this.buttonWizard = new System.Windows.Forms.Button(); + this.textBoxCredentials = new System.Windows.Forms.TextBox(); + this.groupBoxAuthCredentialId = new System.Windows.Forms.GroupBox(); + this.comboBoxCredentialId = new System.Windows.Forms.ComboBox(); + this.labelStoredCredential1 = new System.Windows.Forms.Label(); + this.linkLabel3 = new System.Windows.Forms.LinkLabel(); + this.label8 = new System.Windows.Forms.Label(); + this.checkBoxUseCustomModel = new System.Windows.Forms.CheckBox(); + this.groupBoxGlossaries = new System.Windows.Forms.GroupBox(); + this.textBoxGlossary = new System.Windows.Forms.TextBox(); + this.comboBoxGlossaries = new System.Windows.Forms.ComboBox(); + this.groupBoxModel = new System.Windows.Forms.GroupBox(); + this.textBoxModel = new System.Windows.Forms.TextBox(); + this.comboBoxModels = new System.Windows.Forms.ComboBox(); + this.label1 = new System.Windows.Forms.Label(); + this.comboBoxProviders = new System.Windows.Forms.ComboBox(); + this.checkBoxUseOwnCred = new System.Windows.Forms.CheckBox(); + this.toolTipFormat = new System.Windows.Forms.ToolTip(this.components); + this.label2 = new System.Windows.Forms.Label(); + this.label3 = new System.Windows.Forms.Label(); + this.checkBoxTrace = new System.Windows.Forms.CheckBox(); + this.statusStrip1 = new System.Windows.Forms.StatusStrip(); + this.toolStripStatusLabel1 = new System.Windows.Forms.ToolStripStatusLabel(); + this.toolStripStatusLabel2 = new System.Windows.Forms.ToolStripStatusLabel(); + this.checkBoxShowHidden = new System.Windows.Forms.CheckBox(); + this.timer1 = new System.Windows.Forms.Timer(this.components); + this.checkBoxSmartRouting = new System.Windows.Forms.CheckBox(); + this.checkBoxSaveApiKeyInRegistry = new System.Windows.Forms.CheckBox(); + this.textBoxLabel1 = new System.Windows.Forms.TextBox(); + this.checkBoxProxy = new System.Windows.Forms.CheckBox(); + this.textBox1 = new System.Windows.Forms.TextBox(); + this.groupBoxProviderSettings.SuspendLayout(); + this.groupBoxAuth.SuspendLayout(); + this.groupBoxAuthCredentialId.SuspendLayout(); + this.groupBoxGlossaries.SuspendLayout(); + this.groupBoxModel.SuspendLayout(); + this.statusStrip1.SuspendLayout(); + this.SuspendLayout(); + // + // buttonCheck + // + this.buttonCheck.FlatStyle = System.Windows.Forms.FlatStyle.Flat; + this.buttonCheck.Location = new System.Drawing.Point(446, 92); + this.buttonCheck.Name = "buttonCheck"; + this.buttonCheck.Size = new System.Drawing.Size(81, 23); + this.buttonCheck.TabIndex = 2; + this.buttonCheck.Text = "Check"; + this.buttonCheck.UseVisualStyleBackColor = true; + this.buttonCheck.Click += new System.EventHandler(this.buttonCheck_Click); + // + // apiKey_tb + // + this.apiKey_tb.BorderStyle = System.Windows.Forms.BorderStyle.FixedSingle; + this.apiKey_tb.Location = new System.Drawing.Point(55, 94); + this.apiKey_tb.Name = "apiKey_tb"; + this.apiKey_tb.Size = new System.Drawing.Size(369, 20); + this.apiKey_tb.TabIndex = 1; + this.apiKey_tb.UseSystemPasswordChar = true; + this.apiKey_tb.WordWrap = false; + this.apiKey_tb.TextChanged += new System.EventHandler(this.apiKey_tb_TextChanged); + // + // label5 + // + this.label5.AutoSize = true; + this.label5.Location = new System.Drawing.Point(4, 97); + this.label5.Name = "label5"; + this.label5.Size = new System.Drawing.Size(45, 13); + this.label5.TabIndex = 7; + this.label5.Text = "API Key"; + // + // buttonContinue + // + this.buttonContinue.Anchor = ((System.Windows.Forms.AnchorStyles)((System.Windows.Forms.AnchorStyles.Bottom | System.Windows.Forms.AnchorStyles.Left))); + this.buttonContinue.DialogResult = System.Windows.Forms.DialogResult.OK; + this.buttonContinue.Enabled = false; + this.buttonContinue.FlatStyle = System.Windows.Forms.FlatStyle.Flat; + this.buttonContinue.Location = new System.Drawing.Point(7, 523); + this.buttonContinue.Name = "buttonContinue"; + this.buttonContinue.Size = new System.Drawing.Size(75, 23); + this.buttonContinue.TabIndex = 14; + this.buttonContinue.Text = "Continue"; + this.buttonContinue.UseVisualStyleBackColor = true; + this.buttonContinue.Click += new System.EventHandler(this.buttonContinue_Click); + // + // groupBoxProviderSettings + // + this.groupBoxProviderSettings.Anchor = ((System.Windows.Forms.AnchorStyles)((((System.Windows.Forms.AnchorStyles.Top | System.Windows.Forms.AnchorStyles.Bottom) + | System.Windows.Forms.AnchorStyles.Left) + | System.Windows.Forms.AnchorStyles.Right))); + this.groupBoxProviderSettings.Controls.Add(this.groupBoxAuth); + this.groupBoxProviderSettings.Controls.Add(this.groupBoxAuthCredentialId); + this.groupBoxProviderSettings.Controls.Add(this.checkBoxUseCustomModel); + this.groupBoxProviderSettings.Controls.Add(this.groupBoxGlossaries); + this.groupBoxProviderSettings.Controls.Add(this.groupBoxModel); + this.groupBoxProviderSettings.Controls.Add(this.label1); + this.groupBoxProviderSettings.Controls.Add(this.comboBoxProviders); + this.groupBoxProviderSettings.Controls.Add(this.checkBoxUseOwnCred); + this.groupBoxProviderSettings.FlatStyle = System.Windows.Forms.FlatStyle.Flat; + this.groupBoxProviderSettings.Location = new System.Drawing.Point(7, 154); + this.groupBoxProviderSettings.Name = "groupBoxProviderSettings"; + this.groupBoxProviderSettings.Size = new System.Drawing.Size(531, 348); + this.groupBoxProviderSettings.TabIndex = 5; + this.groupBoxProviderSettings.TabStop = false; + this.groupBoxProviderSettings.Text = "MT Provider settings"; + this.groupBoxProviderSettings.Visible = false; + // + // groupBoxAuth + // + this.groupBoxAuth.Controls.Add(this.buttonWizard); + this.groupBoxAuth.Controls.Add(this.textBoxCredentials); + this.groupBoxAuth.Location = new System.Drawing.Point(10, 84); + this.groupBoxAuth.Name = "groupBoxAuth"; + this.groupBoxAuth.Size = new System.Drawing.Size(511, 89); + this.groupBoxAuth.TabIndex = 7; + this.groupBoxAuth.TabStop = false; + this.groupBoxAuth.Text = "Authorization parameters groupBoxAuth"; + // + // buttonWizard + // + this.buttonWizard.FlatStyle = System.Windows.Forms.FlatStyle.Flat; + this.buttonWizard.Location = new System.Drawing.Point(414, 31); + this.buttonWizard.Name = "buttonWizard"; + this.buttonWizard.Size = new System.Drawing.Size(81, 23); + this.buttonWizard.TabIndex = 8; + this.buttonWizard.Text = "Fill or edit"; + this.buttonWizard.UseVisualStyleBackColor = true; + this.buttonWizard.EnabledChanged += new System.EventHandler(this.buttonWizard_EnabledChanged); + this.buttonWizard.Click += new System.EventHandler(this.buttonWizard_Click); + // + // textBoxCredentials + // + this.textBoxCredentials.BackColor = System.Drawing.SystemColors.Window; + this.textBoxCredentials.BorderStyle = System.Windows.Forms.BorderStyle.FixedSingle; + this.textBoxCredentials.Cursor = System.Windows.Forms.Cursors.Hand; + this.textBoxCredentials.ForeColor = System.Drawing.SystemColors.WindowText; + this.textBoxCredentials.Location = new System.Drawing.Point(21, 31); + this.textBoxCredentials.Name = "textBoxCredentials"; + this.textBoxCredentials.ReadOnly = true; + this.textBoxCredentials.Size = new System.Drawing.Size(387, 20); + this.textBoxCredentials.TabIndex = 7; + this.textBoxCredentials.UseSystemPasswordChar = true; + this.textBoxCredentials.Click += new System.EventHandler(this.textBoxCredentials_Enter); + this.textBoxCredentials.Enter += new System.EventHandler(this.textBoxCredentials_Enter); + // + // groupBoxAuthCredentialId + // + this.groupBoxAuthCredentialId.Controls.Add(this.comboBoxCredentialId); + this.groupBoxAuthCredentialId.Controls.Add(this.labelStoredCredential1); + this.groupBoxAuthCredentialId.Controls.Add(this.linkLabel3); + this.groupBoxAuthCredentialId.Controls.Add(this.label8); + this.groupBoxAuthCredentialId.Location = new System.Drawing.Point(79, 42); + this.groupBoxAuthCredentialId.Name = "groupBoxAuthCredentialId"; + this.groupBoxAuthCredentialId.Size = new System.Drawing.Size(512, 86); + this.groupBoxAuthCredentialId.TabIndex = 9; + this.groupBoxAuthCredentialId.TabStop = false; + this.groupBoxAuthCredentialId.Text = "Stored Credentials groupBoxAuthCredentialId"; + // + // comboBoxCredentialId + // + this.comboBoxCredentialId.DropDownStyle = System.Windows.Forms.ComboBoxStyle.DropDownList; + this.comboBoxCredentialId.Enabled = false; + this.comboBoxCredentialId.FlatStyle = System.Windows.Forms.FlatStyle.Flat; + this.comboBoxCredentialId.FormattingEnabled = true; + this.comboBoxCredentialId.Location = new System.Drawing.Point(42, 21); + this.comboBoxCredentialId.Name = "comboBoxCredentialId"; + this.comboBoxCredentialId.Size = new System.Drawing.Size(387, 21); + this.comboBoxCredentialId.TabIndex = 9; + this.comboBoxCredentialId.SelectedIndexChanged += new System.EventHandler(this.comboBoxCredentialId_SelectedIndexChanged); + // + // labelStoredCredential1 + // + this.labelStoredCredential1.AutoSize = true; + this.labelStoredCredential1.Location = new System.Drawing.Point(40, 59); + this.labelStoredCredential1.Name = "labelStoredCredential1"; + this.labelStoredCredential1.Size = new System.Drawing.Size(216, 13); + this.labelStoredCredential1.TabIndex = 33; + this.labelStoredCredential1.Text = "More information on Stored Credentials here:"; + // + // linkLabel3 + // + this.linkLabel3.AutoSize = true; + this.linkLabel3.Location = new System.Drawing.Point(255, 59); + this.linkLabel3.Name = "linkLabel3"; + this.linkLabel3.Size = new System.Drawing.Size(174, 13); + this.linkLabel3.TabIndex = 32; + this.linkLabel3.TabStop = true; + this.linkLabel3.Text = "https://console.inten.to/credentials"; + // + // label8 + // + this.label8.AutoSize = true; + this.label8.Location = new System.Drawing.Point(12, 21); + this.label8.Name = "label8"; + this.label8.Size = new System.Drawing.Size(0, 13); + this.label8.TabIndex = 27; + // + // checkBoxUseCustomModel + // + this.checkBoxUseCustomModel.AutoSize = true; + this.checkBoxUseCustomModel.Enabled = false; + this.checkBoxUseCustomModel.FlatStyle = System.Windows.Forms.FlatStyle.Flat; + this.checkBoxUseCustomModel.Location = new System.Drawing.Point(15, 183); + this.checkBoxUseCustomModel.Name = "checkBoxUseCustomModel"; + this.checkBoxUseCustomModel.Size = new System.Drawing.Size(133, 17); + this.checkBoxUseCustomModel.TabIndex = 10; + this.checkBoxUseCustomModel.Text = "Use own custom model"; + this.checkBoxUseCustomModel.UseVisualStyleBackColor = true; + this.checkBoxUseCustomModel.Visible = false; + this.checkBoxUseCustomModel.CheckedChanged += new System.EventHandler(this.checkBoxUseCustomModel_CheckedChanged); + // + // groupBoxGlossaries + // + this.groupBoxGlossaries.Controls.Add(this.textBoxGlossary); + this.groupBoxGlossaries.Controls.Add(this.comboBoxGlossaries); + this.groupBoxGlossaries.Location = new System.Drawing.Point(9, 280); + this.groupBoxGlossaries.Name = "groupBoxGlossaries"; + this.groupBoxGlossaries.Size = new System.Drawing.Size(511, 59); + this.groupBoxGlossaries.TabIndex = 13; + this.groupBoxGlossaries.TabStop = false; + this.groupBoxGlossaries.Text = "Glossary"; + this.groupBoxGlossaries.Visible = false; + // + // textBoxGlossary + // + this.textBoxGlossary.BorderStyle = System.Windows.Forms.BorderStyle.FixedSingle; + this.textBoxGlossary.ForeColor = System.Drawing.SystemColors.WindowText; + this.textBoxGlossary.Location = new System.Drawing.Point(11, 19); + this.textBoxGlossary.Name = "textBoxGlossary"; + this.textBoxGlossary.Size = new System.Drawing.Size(485, 20); + this.textBoxGlossary.TabIndex = 13; + // + // comboBoxGlossaries + // + this.comboBoxGlossaries.DropDownStyle = System.Windows.Forms.ComboBoxStyle.DropDownList; + this.comboBoxGlossaries.FlatStyle = System.Windows.Forms.FlatStyle.Flat; + this.comboBoxGlossaries.FormattingEnabled = true; + this.comboBoxGlossaries.Location = new System.Drawing.Point(11, 19); + this.comboBoxGlossaries.Name = "comboBoxGlossaries"; + this.comboBoxGlossaries.Size = new System.Drawing.Size(485, 21); + this.comboBoxGlossaries.TabIndex = 37; + // + // groupBoxModel + // + this.groupBoxModel.Controls.Add(this.textBoxModel); + this.groupBoxModel.Controls.Add(this.comboBoxModels); + this.groupBoxModel.Location = new System.Drawing.Point(9, 208); + this.groupBoxModel.Name = "groupBoxModel"; + this.groupBoxModel.Size = new System.Drawing.Size(512, 66); + this.groupBoxModel.TabIndex = 11; + this.groupBoxModel.TabStop = false; + this.groupBoxModel.Text = "Model"; + this.groupBoxModel.Visible = false; + // + // textBoxModel + // + this.textBoxModel.BorderStyle = System.Windows.Forms.BorderStyle.FixedSingle; + this.textBoxModel.ForeColor = System.Drawing.SystemColors.WindowText; + this.textBoxModel.Location = new System.Drawing.Point(11, 30); + this.textBoxModel.Name = "textBoxModel"; + this.textBoxModel.Size = new System.Drawing.Size(485, 20); + this.textBoxModel.TabIndex = 12; + this.textBoxModel.TextChanged += new System.EventHandler(this.textBoxModel_TextChanged); + // + // comboBoxModels + // + this.comboBoxModels.DropDownStyle = System.Windows.Forms.ComboBoxStyle.DropDownList; + this.comboBoxModels.FlatStyle = System.Windows.Forms.FlatStyle.Flat; + this.comboBoxModels.FormattingEnabled = true; + this.comboBoxModels.Location = new System.Drawing.Point(11, 19); + this.comboBoxModels.Name = "comboBoxModels"; + this.comboBoxModels.Size = new System.Drawing.Size(485, 21); + this.comboBoxModels.TabIndex = 11; + this.comboBoxModels.Visible = false; + this.comboBoxModels.SelectedIndexChanged += new System.EventHandler(this.comboBoxModels_SelectedIndexChanged); + // + // label1 + // + this.label1.AutoSize = true; + this.label1.Location = new System.Drawing.Point(17, 17); + this.label1.Name = "label1"; + this.label1.Size = new System.Drawing.Size(46, 13); + this.label1.TabIndex = 1; + this.label1.Text = "Provider"; + // + // comboBoxProviders + // + this.comboBoxProviders.DropDownStyle = System.Windows.Forms.ComboBoxStyle.DropDownList; + this.comboBoxProviders.FlatStyle = System.Windows.Forms.FlatStyle.Flat; + this.comboBoxProviders.FormattingEnabled = true; + this.comboBoxProviders.Location = new System.Drawing.Point(8, 33); + this.comboBoxProviders.Name = "comboBoxProviders"; + this.comboBoxProviders.Size = new System.Drawing.Size(512, 21); + this.comboBoxProviders.TabIndex = 5; + this.comboBoxProviders.SelectedIndexChanged += new System.EventHandler(this.comboBoxProviders_SelectedIndexChanged); + // + // checkBoxUseOwnCred + // + this.checkBoxUseOwnCred.AutoSize = true; + this.checkBoxUseOwnCred.FlatStyle = System.Windows.Forms.FlatStyle.Flat; + this.checkBoxUseOwnCred.Location = new System.Drawing.Point(15, 61); + this.checkBoxUseOwnCred.Name = "checkBoxUseOwnCred"; + this.checkBoxUseOwnCred.Size = new System.Drawing.Size(142, 17); + this.checkBoxUseOwnCred.TabIndex = 6; + this.checkBoxUseOwnCred.Text = "Use your own credentials"; + this.checkBoxUseOwnCred.UseVisualStyleBackColor = true; + this.checkBoxUseOwnCred.CheckedChanged += new System.EventHandler(this.checkBoxUseOwnCred_CheckedChanged); + // + // toolTipFormat + // + this.toolTipFormat.ToolTipTitle = "Format"; + // + // label2 + // + this.label2.AutoSize = true; + this.label2.Location = new System.Drawing.Point(8, 13); + this.label2.Name = "label2"; + this.label2.Size = new System.Drawing.Size(247, 13); + this.label2.TabIndex = 0; + this.label2.Text = "If you don\'t have an Intento API key, register here: "; + // + // label3 + // + this.label3.AutoSize = true; + this.label3.Location = new System.Drawing.Point(8, 30); + this.label3.Name = "label3"; + this.label3.Size = new System.Drawing.Size(57, 13); + this.label3.TabIndex = 0; + this.label3.Text = "More info: "; + // + // checkBoxTrace + // + this.checkBoxTrace.Anchor = ((System.Windows.Forms.AnchorStyles)((System.Windows.Forms.AnchorStyles.Bottom | System.Windows.Forms.AnchorStyles.Right))); + this.checkBoxTrace.AutoSize = true; + this.checkBoxTrace.FlatStyle = System.Windows.Forms.FlatStyle.Flat; + this.checkBoxTrace.Location = new System.Drawing.Point(383, 526); + this.checkBoxTrace.Name = "checkBoxTrace"; + this.checkBoxTrace.Size = new System.Drawing.Size(155, 17); + this.checkBoxTrace.TabIndex = 17; + this.checkBoxTrace.Text = "Log payloads for 30 minutes"; + this.checkBoxTrace.UseVisualStyleBackColor = true; + this.checkBoxTrace.CheckedChanged += new System.EventHandler(this.checkBoxTrace_CheckedChanged); + // + // statusStrip1 + // + this.statusStrip1.Items.AddRange(new System.Windows.Forms.ToolStripItem[] { + this.toolStripStatusLabel1, + this.toolStripStatusLabel2}); + this.statusStrip1.Location = new System.Drawing.Point(0, 554); + this.statusStrip1.Name = "statusStrip1"; + this.statusStrip1.Size = new System.Drawing.Size(546, 22); + this.statusStrip1.TabIndex = 20; + this.statusStrip1.Text = "statusStrip1"; + // + // toolStripStatusLabel1 + // + this.toolStripStatusLabel1.BackColor = System.Drawing.SystemColors.Control; + this.toolStripStatusLabel1.Name = "toolStripStatusLabel1"; + this.toolStripStatusLabel1.Size = new System.Drawing.Size(476, 17); + this.toolStripStatusLabel1.Spring = true; + this.toolStripStatusLabel1.TextAlign = System.Drawing.ContentAlignment.MiddleLeft; + // + // toolStripStatusLabel2 + // + this.toolStripStatusLabel2.DisplayStyle = System.Windows.Forms.ToolStripItemDisplayStyle.Text; + this.toolStripStatusLabel2.Font = new System.Drawing.Font("Microsoft Sans Serif", 8.25F, System.Drawing.FontStyle.Regular, System.Drawing.GraphicsUnit.Point, ((byte)(204))); + this.toolStripStatusLabel2.ImageAlign = System.Drawing.ContentAlignment.MiddleRight; + this.toolStripStatusLabel2.Name = "toolStripStatusLabel2"; + this.toolStripStatusLabel2.Size = new System.Drawing.Size(55, 17); + this.toolStripStatusLabel2.Text = "x.x.x/20xx"; + // + // checkBoxShowHidden + // + this.checkBoxShowHidden.Anchor = ((System.Windows.Forms.AnchorStyles)((System.Windows.Forms.AnchorStyles.Bottom | System.Windows.Forms.AnchorStyles.Right))); + this.checkBoxShowHidden.AutoSize = true; + this.checkBoxShowHidden.FlatStyle = System.Windows.Forms.FlatStyle.Flat; + this.checkBoxShowHidden.Location = new System.Drawing.Point(266, 526); + this.checkBoxShowHidden.Name = "checkBoxShowHidden"; + this.checkBoxShowHidden.Size = new System.Drawing.Size(105, 17); + this.checkBoxShowHidden.TabIndex = 16; + this.checkBoxShowHidden.Text = "Show hidden text"; + this.checkBoxShowHidden.UseVisualStyleBackColor = true; + this.checkBoxShowHidden.CheckedChanged += new System.EventHandler(this.checkBoxShowHidden_CheckedChanged); + // + // timer1 + // + this.timer1.Interval = 300; + this.timer1.Tick += new System.EventHandler(this.timer1_Tick); + // + // checkBoxSmartRouting + // + this.checkBoxSmartRouting.AutoSize = true; + this.checkBoxSmartRouting.FlatStyle = System.Windows.Forms.FlatStyle.Flat; + this.checkBoxSmartRouting.Location = new System.Drawing.Point(55, 120); + this.checkBoxSmartRouting.Name = "checkBoxSmartRouting"; + this.checkBoxSmartRouting.Size = new System.Drawing.Size(85, 17); + this.checkBoxSmartRouting.TabIndex = 3; + this.checkBoxSmartRouting.Text = "Smart routing"; + this.checkBoxSmartRouting.UseVisualStyleBackColor = true; + this.checkBoxSmartRouting.CheckedChanged += new System.EventHandler(this.checkBoxSmartRouting_CheckedChanged); + // + // checkBoxSaveApiKeyInRegistry + // + this.checkBoxSaveApiKeyInRegistry.Anchor = ((System.Windows.Forms.AnchorStyles)((System.Windows.Forms.AnchorStyles.Bottom | System.Windows.Forms.AnchorStyles.Right))); + this.checkBoxSaveApiKeyInRegistry.AutoSize = true; + this.checkBoxSaveApiKeyInRegistry.FlatStyle = System.Windows.Forms.FlatStyle.Flat; + this.checkBoxSaveApiKeyInRegistry.Location = new System.Drawing.Point(125, 526); + this.checkBoxSaveApiKeyInRegistry.Name = "checkBoxSaveApiKeyInRegistry"; + this.checkBoxSaveApiKeyInRegistry.Size = new System.Drawing.Size(121, 17); + this.checkBoxSaveApiKeyInRegistry.TabIndex = 15; + this.checkBoxSaveApiKeyInRegistry.Text = "Save API Key locally"; + this.checkBoxSaveApiKeyInRegistry.UseVisualStyleBackColor = true; + this.checkBoxSaveApiKeyInRegistry.CheckedChanged += new System.EventHandler(this.checkBoxSaveApiKeyInRegistry_CheckedChanged); + // + // textBoxLabel1 + // + this.textBoxLabel1.BackColor = System.Drawing.SystemColors.Control; + this.textBoxLabel1.BorderStyle = System.Windows.Forms.BorderStyle.None; + this.textBoxLabel1.Cursor = System.Windows.Forms.Cursors.Hand; + this.textBoxLabel1.Font = new System.Drawing.Font("Microsoft Sans Serif", 8.25F, System.Drawing.FontStyle.Underline, System.Drawing.GraphicsUnit.Point, ((byte)(204))); + this.textBoxLabel1.ForeColor = System.Drawing.Color.Blue; + this.textBoxLabel1.Location = new System.Drawing.Point(253, 13); + this.textBoxLabel1.Name = "textBoxLabel1"; + this.textBoxLabel1.Size = new System.Drawing.Size(118, 13); + this.textBoxLabel1.TabIndex = 18; + this.textBoxLabel1.Text = "https://console.inten.to"; + this.textBoxLabel1.Enter += new System.EventHandler(this.textBoxLabel_Enter); + // + // checkBoxProxy + // + this.checkBoxProxy.AutoSize = true; + this.checkBoxProxy.Checked = true; + this.checkBoxProxy.CheckState = System.Windows.Forms.CheckState.Checked; + this.checkBoxProxy.FlatStyle = System.Windows.Forms.FlatStyle.Flat; + this.checkBoxProxy.Location = new System.Drawing.Point(7, 60); + this.checkBoxProxy.Name = "checkBoxProxy"; + this.checkBoxProxy.Size = new System.Drawing.Size(371, 17); + this.checkBoxProxy.TabIndex = 26; + this.checkBoxProxy.Text = "Enable proxy server (Attention! This setting applies to all Intento MT rules.)"; + this.checkBoxProxy.UseVisualStyleBackColor = true; + // + // textBox1 + // + this.textBox1.BackColor = System.Drawing.SystemColors.Control; + this.textBox1.BorderStyle = System.Windows.Forms.BorderStyle.None; + this.textBox1.Cursor = System.Windows.Forms.Cursors.Hand; + this.textBox1.Font = new System.Drawing.Font("Microsoft Sans Serif", 8.25F, System.Drawing.FontStyle.Underline, System.Drawing.GraphicsUnit.Point, ((byte)(204))); + this.textBox1.ForeColor = System.Drawing.Color.Blue; + this.textBox1.Location = new System.Drawing.Point(64, 30); + this.textBox1.Name = "textBox1"; + this.textBox1.Size = new System.Drawing.Size(75, 13); + this.textBox1.TabIndex = 19; + this.textBox1.Text = "https://inten.to"; + this.textBox1.Enter += new System.EventHandler(this.textBoxLabel_Enter); + // + // IntentoTranslationProviderOptionsForm + // + this.AutoScaleDimensions = new System.Drawing.SizeF(96F, 96F); + this.AutoScaleMode = System.Windows.Forms.AutoScaleMode.Dpi; + this.ClientSize = new System.Drawing.Size(546, 576); + this.Controls.Add(this.checkBoxProxy); + this.Controls.Add(this.textBox1); + this.Controls.Add(this.textBoxLabel1); + this.Controls.Add(this.checkBoxSaveApiKeyInRegistry); + this.Controls.Add(this.checkBoxSmartRouting); + this.Controls.Add(this.checkBoxShowHidden); + this.Controls.Add(this.statusStrip1); + this.Controls.Add(this.checkBoxTrace); + this.Controls.Add(this.label3); + this.Controls.Add(this.label2); + this.Controls.Add(this.groupBoxProviderSettings); + this.Controls.Add(this.buttonContinue); + this.Controls.Add(this.label5); + this.Controls.Add(this.apiKey_tb); + this.Controls.Add(this.buttonCheck); + this.Font = new System.Drawing.Font("Microsoft Sans Serif", 8.25F, System.Drawing.FontStyle.Regular, System.Drawing.GraphicsUnit.Point, ((byte)(204))); + this.FormBorderStyle = System.Windows.Forms.FormBorderStyle.FixedDialog; + this.MaximizeBox = false; + this.MinimizeBox = false; + this.Name = "IntentoTranslationProviderOptionsForm"; + this.StartPosition = System.Windows.Forms.FormStartPosition.CenterParent; + this.Text = "Intento plugin settings"; + this.Shown += new System.EventHandler(this.IntentoTranslationProviderOptionsForm_Shown); + this.groupBoxProviderSettings.ResumeLayout(false); + this.groupBoxProviderSettings.PerformLayout(); + this.groupBoxAuth.ResumeLayout(false); + this.groupBoxAuth.PerformLayout(); + this.groupBoxAuthCredentialId.ResumeLayout(false); + this.groupBoxAuthCredentialId.PerformLayout(); + this.groupBoxGlossaries.ResumeLayout(false); + this.groupBoxGlossaries.PerformLayout(); + this.groupBoxModel.ResumeLayout(false); + this.groupBoxModel.PerformLayout(); + this.statusStrip1.ResumeLayout(false); + this.statusStrip1.PerformLayout(); + this.ResumeLayout(false); + this.PerformLayout(); + + } + + #endregion + + public System.Windows.Forms.Button buttonCheck; + public System.Windows.Forms.TextBox apiKey_tb; + private System.Windows.Forms.Label label5; + private System.Windows.Forms.Button buttonContinue; + public System.Windows.Forms.GroupBox groupBoxProviderSettings; + private System.Windows.Forms.Label label1; + public System.Windows.Forms.ComboBox comboBoxProviders; + public System.Windows.Forms.CheckBox checkBoxUseOwnCred; + private System.Windows.Forms.ToolTip toolTipFormat; + private System.Windows.Forms.Label label2; + private System.Windows.Forms.Label label3; + private System.Windows.Forms.CheckBox checkBoxTrace; + private System.Windows.Forms.StatusStrip statusStrip1; + private System.Windows.Forms.ToolStripStatusLabel toolStripStatusLabel1; + private System.Windows.Forms.ToolStripStatusLabel toolStripStatusLabel2; + public System.Windows.Forms.CheckBox checkBoxShowHidden; + public System.Windows.Forms.GroupBox groupBoxAuth; + private System.Windows.Forms.Button buttonWizard; + public System.Windows.Forms.TextBox textBoxCredentials; + public System.Windows.Forms.CheckBox checkBoxUseCustomModel; + public System.Windows.Forms.GroupBox groupBoxModel; + public System.Windows.Forms.ComboBox comboBoxModels; + private System.Windows.Forms.Timer timer1; + public System.Windows.Forms.CheckBox checkBoxSmartRouting; + public System.Windows.Forms.TextBox textBoxModel; + public System.Windows.Forms.GroupBox groupBoxAuthCredentialId; + public System.Windows.Forms.ComboBox comboBoxCredentialId; + private System.Windows.Forms.Label labelStoredCredential1; + private System.Windows.Forms.LinkLabel linkLabel3; + private System.Windows.Forms.Label label8; + public System.Windows.Forms.GroupBox groupBoxGlossaries; + public System.Windows.Forms.TextBox textBoxGlossary; + public System.Windows.Forms.ComboBox comboBoxGlossaries; + public System.Windows.Forms.CheckBox checkBoxSaveApiKeyInRegistry; + public System.Windows.Forms.CheckBox checkBoxProxy; + private System.Windows.Forms.TextBox textBoxLabel1; + private System.Windows.Forms.TextBox textBox1; + } } \ No newline at end of file diff --git a/IntentoTranslationProviderOptionsForm.cs b/Intento.MT.Plugin.PropertiesForm/IntentoTranslationProviderOptionsForm.cs similarity index 97% rename from IntentoTranslationProviderOptionsForm.cs rename to Intento.MT.Plugin.PropertiesForm/IntentoTranslationProviderOptionsForm.cs index f0c294c..14574e0 100644 --- a/IntentoTranslationProviderOptionsForm.cs +++ b/Intento.MT.Plugin.PropertiesForm/IntentoTranslationProviderOptionsForm.cs @@ -1,619 +1,619 @@ -using IntentoSDK; -using Microsoft.Win32; -using Newtonsoft.Json; -using Newtonsoft.Json.Linq; -using System; -using System.Collections.Generic; -using System.ComponentModel; -using System.Data; -using System.Diagnostics; -using System.Drawing; -using System.IO; -using System.Linq; -using System.Reflection; -using System.Resources; -using System.Text; -using System.Threading.Tasks; -using System.Windows.Forms; -using static Intento.MT.Plugin.PropertiesForm.IntentoTranslationProviderOptionsForm; - -namespace Intento.MT.Plugin.PropertiesForm -{ - - public partial class IntentoTranslationProviderOptionsForm1 : Form, IForm - { - - #region vars - public IntentoMTFormOptions originalOptions; - public IntentoMTFormOptions currentOptions; - public IntentoAiTextTranslate _translate; - - // Languages filter - public IList languages; - private LangPair[] _languagePairs; - - public static DateTime TraceEndTime; - - private int numberOfFlashes; - - public ApiKeyState apiKeyState; - - List errors; - - // Fabric to create intento connection. Parameters: apiKey and UserAgent for Settings Form - Func fabric; - - string version; - - #endregion vars - - /// - /// - /// - /// - /// - /// - public IntentoTranslationProviderOptionsForm1( - IntentoMTFormOptions options, - LangPair[] languagePairs, - Func fabric - ) - { - this.fabric = fabric; - - InitializeComponent(); - LocalizeContent(); - - if (options.HideHiddenTextButton) - checkBoxShowHidden.Visible = false; - if (options.ForbidSaveApikey) - checkBoxSaveApiKeyInRegistry.Visible = false; - - Assembly currentAssem = typeof(IntentoTranslationProviderOptionsForm1).Assembly; - version = String.Format("{0}-{1}", - IntentoHelpers.GetVersion(currentAssem), - IntentoHelpers.GetGitCommitHash(currentAssem)); - - originalOptions = options; - currentOptions = originalOptions.Duplicate(); - apiKeyState = new ApiKeyState(this, currentOptions); - if (apiKeyState.GetValueFromRegistry("ProxyEnabled") != null && apiKeyState.GetValueFromRegistry("ProxyEnabled") == "1") - { - currentOptions.proxySettings = new ProxySettings() - { - ProxyAddress = apiKeyState.GetValueFromRegistry("ProxyAddress"), - ProxyPort = apiKeyState.GetValueFromRegistry("ProxyPort"), - ProxyUserName = apiKeyState.GetValueFromRegistry("ProxyUserName"), - ProxyPassword = apiKeyState.GetValueFromRegistry("ProxyPassw"), - ProxyEnabled = true - }; - } - else - checkBoxProxy.Checked = false; - - checkBoxProxy.CheckedChanged += checkBoxProxy_CheckedChanged; - - _languagePairs = languagePairs; - DialogResult = DialogResult.None; - - var tmp = TraceEndTime; - checkBoxTrace.Checked = (TraceEndTime - DateTime.Now).Minutes > 0; - TraceEndTime = tmp; - // string pluginFor = string.IsNullOrEmpty(Options.PluginFor) ? "" : Options.PluginFor + '/'; - // toolStripStatusLabel2.Text = String.Format("{0} {1}{2}", Options.PluginName, pluginFor, Options.AssemblyVersion); - var arr = originalOptions.Signature.Split('/'); - toolStripStatusLabel2.Text = arr.Count()==3 ? String.Format("{0}/{1}",arr[0], arr[2]) : originalOptions.Signature; - textBoxModel.Location = comboBoxModels.Location; // new Point(comboBoxModels.Location.X, comboBoxModels.Location.Y); - textBoxGlossary.Location = comboBoxGlossaries.Location; // new Point(comboBoxGlossaries.Location.X, comboBoxGlossaries.Location.Y); - groupBoxAuthCredentialId.Location = groupBoxAuth.Location; // new Point(groupBoxAuth.Location.X, groupBoxAuth.Location.Y) - - apiKeyState.apiKeyChangedEvent += ChangeApiKeyStatusDelegate; - apiKey_tb.Select(); - - apiKeyState.EnableDisable(); - } - - public IntentoMTFormOptions GetOptions() - { - return currentOptions; - } - - public LangPair[] LanguagePairs - { get { return _languagePairs; } } - - public void ChangeApiKeyStatusDelegate(bool isOK) - { - if (apiKeyState.apiKeyStatus == ApiKeyState.EApiKeyStatus.download) - { - CreateIntentoConnection(); - } - apiKeyState.EnableDisable(); - } - - private void CreateIntentoConnection() - { - _translate = fabric(apiKeyState.apiKey, String.Format("{1}/{2}", originalOptions.UserAgent, "Intento.PluginSettingsForm", version), currentOptions.proxySettings); - } - - private void apiKey_tb_TextChanged(object sender, EventArgs e) - { - apiKeyState.SetValue(apiKey_tb.Text.Trim()); - apiKeyState.EnableDisable(); - } - - public static bool IsTrace() - { - return (TraceEndTime - DateTime.Now).Minutes > 0; - } - - private string customAuthJsonToString(string authJsonString) - { - string ret = String.Empty; - if (IsValidJson(authJsonString) == null) - { - var js = JToken.Parse(authJsonString); - foreach (dynamic val in js) - ret += String.Format("{0}:{1} ", val.Name, val.Value); - } - return ret; - } - - private string IsValidJson(string strInput) - { - strInput = String.IsNullOrEmpty(strInput) ? String.Empty : strInput.Trim(); - string result = "Invalid json for own authorization parameters"; - if ((strInput.StartsWith("{") && strInput.EndsWith("}")) || //For object - (strInput.StartsWith("[") && strInput.EndsWith("]"))) //For array - { - try - { - var obj = JToken.Parse(strInput); - if (obj.HasValues) - result = null; - } - catch { } - } - return result; - } - - private void LocalizeContent() - { - Text = Resource.MFCaption; - label2.Text = Resource.MFLabel2; - label3.Text = Resource.MFLabel3; - checkBoxProxy.Text = Resource.MFcheckBoxProxy; - label5.Text = Resource.ApiKeyLabel; - buttonCheck.Text = Resource.MFButtonCheck; - checkBoxSmartRouting.Text = Resource.MFCheckBoxSmartRouting; - groupBoxProviderSettings.Text = Resource.MFGroupBoxProviderSettings; - label1.Text = Resource.ProviderLabel; - groupBoxAuthCredentialId.Text = Resource.MFGroupBoxAuthCredentialId; - checkBoxUseOwnCred.Text = Resource.MFCheckBoxUseOwnCred; - groupBoxAuth.Text = Resource.MFGroupBoxAuth; - buttonWizard.Text = Resource.MFButtonWizard; - checkBoxUseCustomModel.Text = Resource.MFCheckBoxUseCustomModel; - groupBoxModel.Text = Resource.MFGroupBoxModel; - groupBoxGlossaries.Text = Resource.MFGroupBoxGlossary; - buttonContinue.Text = Resource.OKLabel; - checkBoxSaveApiKeyInRegistry.Text = Resource.MFCheckBoxSaveApiKeyInRegistry; - checkBoxShowHidden.Text = Resource.ShowHiddenTextLabel; - checkBoxTrace.Text = Resource.MFCheckBoxTrace; - - checkBoxShowHidden.Text = Resource.ShowHiddenTextLabel; - } - - #region paramount events - - private void comboBoxProviders_SelectedIndexChanged(object sender, EventArgs e) - { - if (apiKeyState != null && apiKeyState.smartRoutingState != null && apiKeyState.smartRoutingState.providerState != null) - // Can happen during loading data from Options - constructor of ProviderState change settings in a list of providers - apiKeyState.smartRoutingState.providerState.SelectedIndexChanged(); - } - - private bool filterBy(dynamic x, string lang) - { - if (x == null) return true; - if (x.GetType().Name == "JArray") - return ((JArray)x).Any(q => (string)q == lang); - if (x.GetType().Name == "JValue") - return (string)x == lang; - return true; - } - - #endregion paramount events - - #region events - - private void IntentoTranslationProviderOptionsForm_Shown(object sender, EventArgs e) - { - using (new CursorForm(this)) - { - checkBoxSmartRouting.Checked = GetOptions().SmartRouting; - apiKeyState.ReadProviders(); - CreateIntentoConnection(); - } - } - - private void buttonCheck_Click(object sender, EventArgs e) - { - using (new CursorForm(this)) - { - apiKeyState.ReadProviders(); - apiKeyState.EnableDisable(); - } - } - - private void checkBoxUseOwnCred_CheckedChanged(object sender, EventArgs e) - { - using (new CursorForm(this)) - apiKeyState?.smartRoutingState?.providerState?.GetAuthState()?.checkBoxUseOwnCred_CheckedChanged(); - } - - private void checkBoxUseCustomModel_CheckedChanged(object sender, EventArgs e) - { - using (new CursorForm(this)) - apiKeyState?.smartRoutingState?.providerState?.GetAuthState()?.GetModelState()?.checkBoxUseCustomModel_CheckedChanged(); - } - - // Save settings - private void buttonContinue_Click(object sender, EventArgs e) - { - using (new CursorForm(this)) - { - originalOptions.Translate = _translate; - apiKeyState.FillOptions(originalOptions); - - // originalOptions.StoreApikeyInRegistry = checkBoxSaveApiKeyInRegistry.Checked; - if (!string.IsNullOrEmpty(originalOptions.ApiKey)) - apiKeyState.SaveValueToRegistry("ApiKey", originalOptions.ApiKey); - else - apiKeyState.SaveValueToRegistry("ApiKey", originalOptions.ApiKey); - - Close(); - } - } - - private void linkLabel_LinkClicked(object sender, LinkLabelLinkClickedEventArgs e) - { - System.Diagnostics.Process.Start(((LinkLabel)sender).Text); - } - - private void linkLabel_Paint(object sender, System.Windows.Forms.PaintEventArgs e) - { - System.Windows.Forms.LinkLabel control = (System.Windows.Forms.LinkLabel)sender; - SizeF stringSize = e.Graphics.MeasureString(control.Text, control.Font); - control.Font = new Font(FontFamily.GenericSansSerif, control.Font.Size); - } - - private void buttonWizard_Click(object sender, EventArgs e) - { - apiKeyState?.smartRoutingState?.providerState?.GetAuthState()?.buttonWizard_Click(); - apiKeyState.EnableDisable(); - } - - private void comboBoxModels_SelectedIndexChanged(object sender, EventArgs e) - { - using (new CursorForm(this)) - { - apiKeyState?.smartRoutingState?.providerState?.GetAuthState()?.GetModelState()?.comboBoxModels_SelectedIndexChanged(); - apiKeyState.EnableDisable(); - } - } - - private void checkBoxShowHidden_CheckedChanged(object sender, EventArgs e) - { - using (new CursorForm(this)) - { - apiKey_tb.UseSystemPasswordChar = !checkBoxShowHidden.Checked; - textBoxCredentials.UseSystemPasswordChar = !checkBoxShowHidden.Checked; - } - } - - private void checkBoxTrace_CheckedChanged(object sender, EventArgs e) - { - TraceEndTime = DateTime.Now.AddMinutes(checkBoxTrace.Checked ? 30 : -40); - } - - private void IntentoTranslationProviderOptionsForm_Load(object sender, EventArgs e) - { - } - - private void comboBoxCredentialId_SelectedIndexChanged(object sender, EventArgs e) - { - using (new CursorForm(this)) - apiKeyState?.smartRoutingState?.providerState?.GetAuthState()?.comboBoxCredentialId_SelectedIndexChanged(); - } - - private void textBoxModel_TextChanged(object sender, EventArgs e) - { - apiKeyState.EnableDisable(); - } - - private void timer1_Tick(object sender, EventArgs e) - { - comboBoxGlossaries.BackColor = comboBoxGlossaries.BackColor != Color.LightPink ? Color.LightPink : SystemColors.Window; - numberOfFlashes++; - if (numberOfFlashes > 5) - { - timer1.Stop(); - numberOfFlashes = 0; - } - } - - private void checkBoxSmartRouting_CheckedChanged(object sender, EventArgs e) - { - using (new CursorForm(this)) - apiKeyState?.smartRoutingState?.CheckedChanged(); - } - - private void textBoxCredentials_Enter(object sender, EventArgs e) - { - buttonWizard_Click(null, null); - } - - private void checkBoxProxy_CheckedChanged(object sender, EventArgs e) - { - if (checkBoxProxy.Checked) - { - var form = new IntentoTranslationProviderProxySettingsForm(this); - if (form.ShowDialog() == DialogResult.OK) - { - - apiKeyState.SaveValueToRegistry("ProxyAddress", currentOptions.proxySettings.ProxyAddress); - apiKeyState.SaveValueToRegistry("ProxyPort", currentOptions.proxySettings.ProxyPort); - apiKeyState.SaveValueToRegistry("ProxyUserName", currentOptions.proxySettings.ProxyUserName); - apiKeyState.SaveValueToRegistry("ProxyPassw", currentOptions.proxySettings.ProxyPassword); - apiKeyState.SaveValueToRegistry("ProxyEnabled", "1"); - apiKeyState.ReadProviders(); - } - else - { - checkBoxProxy.Checked = false; - apiKeyState.SaveValueToRegistry("ProxyEnabled", "0"); - } - } - else - { - currentOptions.proxySettings = null; - apiKeyState.SaveValueToRegistry("ProxyEnabled", "0"); - apiKeyState.ReadProviders(); - } - } - - private void checkBoxSaveApiKeyInRegistry_CheckedChanged(object sender, EventArgs e) - { - } - #endregion events - - public static void Logging(string subject, string comment = null, Exception ex = null) - { - if (!IntentoTranslationProviderOptionsForm1.IsTrace()) - return; - - try - { - - string path = Environment.GetEnvironmentVariable("temp"); - if (string.IsNullOrEmpty(path)) - path = Environment.GetEnvironmentVariable("tmp"); - if (string.IsNullOrEmpty(path)) - return; - - DateTime now = DateTime.UtcNow; - List content = new List(); - content.Add("------------------------"); - content.Add(string.Format("{0} {1}", now.ToString("yyyy-MM-dd HH:mm:ss.fffff"), subject)); - if (comment != null) - content.Add(comment); - if (ex != null) - content.AddRange(LoggingEx(ex)); - - string filename = string.Format("{0}\\Intento_Logs_{1}", path, now.ToString("yyyy-MM-dd-HH")); - File.AppendAllLines(filename, content); - } - catch { } - } - - public static IEnumerable LoggingEx(Exception ex) - { - List items = new List(); - items.Add(string.Format("Exception {0}", ex.Message)); - if (ex.StackTrace != null) - { - items.Add("Stack Trace:"); - items.Add(ex.StackTrace); - } - if (ex.InnerException != null) - items.AddRange(LoggingEx(ex.InnerException)); - return items; - } - - private void textBoxLabel_Enter(object sender, System.EventArgs e) - { - System.Diagnostics.Process.Start(((TextBox)sender).Text); - } - - private int cursorCount = 0; - public class CursorForm : IDisposable - { - IForm form; - public CursorForm(IForm form) - { - this.form = form; - if (form.CursorCount == 0) - form.Cursor = Cursors.WaitCursor; - form.CursorCount++; - } - - public void Dispose() - { - form.CursorCount--; - if (form.CursorCount == 0) - form.Cursor = Cursors.Default; - } - } - - #region IForm - ApiKeyState IForm.ApiKeyState { get { return apiKeyState; } } - - // ApiKey textBox (apiKey_tb) - string IForm.ApiKey_TextBox_Text { get { return apiKey_tb.Text; } set { apiKey_tb.Text = value; } } - bool IForm.ApiKey_TextBox_Enabled { set { apiKey_tb.Enabled = value; } } - Color IForm.ApiKey_TextBox_BackColor { set { apiKey_tb.BackColor = value; } } - - - // ApiKey Check Button (buttonCheck) - bool IForm.ApiKeyCheck_Button_Enabled { set { buttonCheck.Enabled = value; } get { return buttonCheck.Enabled; } } - - // SmartRouting_CheckBox (checkBoxSmartRouting) - bool IForm.SmartRouting_CheckBox_Checked { get { return checkBoxSmartRouting.Checked; } set { checkBoxSmartRouting.Checked = value; } } - bool IForm.SmartRouting_CheckBox_Visible { set { checkBoxSmartRouting.Visible = value; } } - bool IForm.SmartRouting_CheckBox_Enabled { set { checkBoxSmartRouting.Enabled = value; } } - - // Providers_ComboBox (comboBoxProviders) - void IForm.Providers_ComboBox_Clear() { comboBoxProviders.Items.Clear(); } - void IForm.Providers_ComboBox_AddRange(object[] items) { comboBoxProviders.Items.AddRange(items); } - string IForm.Providers_ComboBox_SelectedItem { set { comboBoxProviders.SelectedItem = value; } } - string IForm.Providers_ComboBox_Text { get { return comboBoxProviders.Text; } } - //Color IForm.Providers_ComboBox_BackColor { set { comboBoxProviders.BackColor = value; } } - - void IForm.Providers_ComboBox_BackColor_State(bool hasErrors) - { - if (hasErrors) - comboBoxProviders.BackColor = Color.LightPink; - else - comboBoxProviders.BackColor = Color.White; - } - - // Providers_GroupBox (groupBoxProviderSettings) - bool IForm.Providers_Group_Enabled { set { groupBoxProviderSettings.Enabled = value; } } - - // Auth_CheckBox (checkBoxUseOwnCred) - bool IForm.Auth_CheckBox_Visible { set { checkBoxUseOwnCred.Visible = value; } } - bool IForm.Auth_CheckBox_Enabled { set { checkBoxUseOwnCred.Enabled = value; } } - bool IForm.Auth_CheckBox_Checked { get { return checkBoxUseOwnCred.Checked; } set { checkBoxUseOwnCred.Checked = value; } } - - // AuthText_Group (groupBoxAuth) - bool IForm.AuthText_Group_Visible { set { groupBoxAuth.Visible = value; } } - - // AuthText_TextBox (textBoxCredentials) - Color IForm.AuthText_TextBox_BackColor { set { textBoxCredentials.BackColor = value; } } - string IForm.AuthText_TextBox_Text { set { textBoxCredentials.Text = value; } } - - // AuthCombo_Group (groupBoxAuthCredentialId) - bool IForm.AuthCombo_Group_Visible { set { groupBoxAuthCredentialId.Visible = value; } } - - // AuthCombo_ComboBox (comboBoxCredentialId) - void IForm.AuthCombo_ComboBox_Clear() { comboBoxCredentialId.Items.Clear(); } - void IForm.AuthCombo_ComboBox_AddRange(object[] items) { comboBoxCredentialId.Items.AddRange(items); } - void IForm.AuthCombo_ComboBox_Insert(int n, string text) { comboBoxCredentialId.Items.Insert(n, text); } - bool IForm.AuthCombo_ComboBox_Contains(string text) { return comboBoxCredentialId.Items.Contains(text); } - object IForm.AuthCombo_ComboBox_SelectedItem { get { return comboBoxCredentialId.SelectedItem; } set { comboBoxCredentialId.SelectedItem = value; } } - bool IForm.AuthCombo_ComboBox_Enabled { set { comboBoxCredentialId.Enabled = value; } } - int IForm.AuthCombo_ComboBox_Count { get { return comboBoxCredentialId.Items.Count; } } - int IForm.AuthCombo_ComboBox_SelectedIndex { set { comboBoxCredentialId.SelectedIndex = value; } } - Color IForm.AuthCombo_ComboBox_BackColor { set { comboBoxCredentialId.BackColor = value; } } - string IForm.AuthCombo_ComboBox_Text { get { return comboBoxCredentialId.Text; } } - - // Model_CheckBox (checkBoxUseCustomModel) - bool IForm.Model_CheckBox_Checked { get { return checkBoxUseCustomModel.Checked; } set { checkBoxUseCustomModel.Checked = value; } } - //bool IForm.Model_CheckBox_Visible { set { checkBoxUseCustomModel.Visible = value; } } - bool IForm.Model_CheckBox_Enabled { set { checkBoxUseCustomModel.Enabled = value; } } - - // Model_Group (groupBoxModel) - //bool IForm.Model_Group_Visible { set { groupBoxModel.Visible = value; } } - bool IForm.Model_Group_Enabled { set { groupBoxModel.Enabled = value; } } - - // Model_ComboBox (comboBoxModels) - void IForm.Model_ComboBox_Clear() { comboBoxModels.Items.Clear(); } - int IForm.Model_ComboBox_Add(string text) { return comboBoxModels.Items.Add(text); } - int IForm.Model_ComboBox_SelectedIndex { set { comboBoxModels.SelectedIndex = value; } } - int IForm.Model_ComboBox_Count { get { return comboBoxModels.Items.Count; } } - bool IForm.Model_ComboBox_Visible { set { comboBoxModels.Visible = value; } } - //Color IForm.Model_ComboBox_BackColor { set { comboBoxModels.BackColor = value; } } - string IForm.Model_ComboBox_Text { get { return comboBoxModels.Text; } set { comboBoxModels.Text = value; } } - void IForm.Model_Control_BackColor_State(bool hasErrors) - { - if (hasErrors) - { - comboBoxModels.BackColor = Color.LightPink; - textBoxModel.BackColor = Color.LightPink; - } - else - { - comboBoxModels.BackColor = Color.White; - textBoxModel.BackColor = Color.White; - } - } - - // Model_TextBox (textBoxModel) - bool IForm.Model_TextBox_Visible { set { textBoxModel.Visible = value; } } - string IForm.Model_TextBox_Text { get { return textBoxModel.Text; } set { textBoxModel.Text = value; } } - //Color IForm.Model_TextBox_BackColor { set { textBoxModel.BackColor = value; } } - - // Glossary_Group (groupBoxGlossary) - bool IForm.Glossary_Group_Visible { get { return groupBoxGlossaries.Visible; } set { groupBoxGlossaries.Visible = value; } } - - // Glossary_TextBox (textBoxGlossary) - bool IForm.Glossary_TextBox_Visible { set { textBoxGlossary.Visible = value; } } - bool IForm.Glossary_TextBox_Enabled { set { textBoxGlossary.Enabled = value; } } - string IForm.Glossary_TextBox_Text { get { return textBoxGlossary.Text; } set { textBoxGlossary.Text = value; } } - - // Glossary_ComboBox (comboBoxGlossaries) - void IForm.Glossary_ComboBox_Clear() { comboBoxGlossaries.Items.Clear(); } - int IForm.Glossary_ComboBoxAdd(string text) { return comboBoxGlossaries.Items.Add(text); } - void IForm.Glossary_ComboBox_Insert(int n, string text) { comboBoxGlossaries.Items.Insert(n, text); } - int IForm.Glossary_ComboBox_SelectedIndex { set { comboBoxGlossaries.SelectedIndex = value; } } - bool IForm.Glossary_ComboBox_Visible { set { comboBoxGlossaries.Visible = value; } } - bool IForm.Glossary_ComboBox_Enabled { set { comboBoxGlossaries.Enabled = value; } } - string IForm.Glossary_ComboBox_Text { get { return comboBoxGlossaries.Text; } } - - // Continue Button (buttonContinue) - bool IForm.Continue_Button_Enabled { get { return buttonContinue.Enabled; } set { buttonContinue.Enabled = value; } } - - // ErrorMessage TextBox (toolStripStatusLabel1) - string IForm.ErrorMessage_TextBox_Text { get { return toolStripStatusLabel1.Text; } set { toolStripStatusLabel1.Text = value; } } - Color IForm.ErrorMessage_TextBox_BackColor { set { toolStripStatusLabel1.BackColor = value; } } - - // SaveApiKeyInRegistry checkBox () - bool IForm.SaveApiKeyInRegistry_CheckBox_Checked { get { return checkBoxSaveApiKeyInRegistry.Checked; } set { checkBoxSaveApiKeyInRegistry.Checked = value; } } - - // ShowHidden_CheckBox (checkBoxShowHidden) - bool IForm.ShowHidden_CheckBox_Checked { get { return checkBoxShowHidden.Checked; } } - - // Intento API - IEnumerable IForm.Providers(Dictionary filter) { return _translate.Providers(filter: filter); } - dynamic IForm.Provider(string provider, string additionalParams) { return _translate.Provider(provider: provider, additionalParams: additionalParams); } - IList IForm.DelegatedCredentials() { return _translate.DelegatedCredentials(); } - IList IForm.Models(string provider, Dictionary credential_id) { return _translate.Models(provider: provider, credentials: credential_id); } - IList IForm.Glossaries(string provider, Dictionary credential_id) { return _translate.Glossaries(provider: provider, credentials: credential_id); } - - // Other - int IForm.CursorCount { get { return cursorCount; } set { cursorCount = value; } } - Cursor IForm.Cursor { set { Cursor = value; } } - void IForm.SuspendLayout() { SuspendLayout(); } - void IForm.ResumeLayout() { ResumeLayout(); } - List IForm.Errors { get { return errors; } set { errors = value; } } - LangPair[] IForm.LanguagePairs { get { return _languagePairs; } } - - bool insideEnableDisable = false; - bool IForm.InsideEnableDisable { get { return insideEnableDisable; } set { insideEnableDisable = value; } } - - public static ResourceManager resourceManager = new ResourceManager(typeof(Resource)); - ResourceManager IForm.ResourceManager { get { return resourceManager; } } - - - - // Added for NewUI - void IForm.ApiKey_Set_Panel() { } - - - #endregion - - private void buttonWizard_EnabledChanged(object sender, EventArgs e) - { - - } - } -} +using IntentoSDK; +using Microsoft.Win32; +using Newtonsoft.Json; +using Newtonsoft.Json.Linq; +using System; +using System.Collections.Generic; +using System.ComponentModel; +using System.Data; +using System.Diagnostics; +using System.Drawing; +using System.IO; +using System.Linq; +using System.Reflection; +using System.Resources; +using System.Text; +using System.Threading.Tasks; +using System.Windows.Forms; +using static Intento.MT.Plugin.PropertiesForm.IntentoTranslationProviderOptionsForm; + +namespace Intento.MT.Plugin.PropertiesForm +{ + + public partial class IntentoTranslationProviderOptionsForm1 : Form, IForm + { + + #region vars + public IntentoMTFormOptions originalOptions; + public IntentoMTFormOptions currentOptions; + public IntentoAiTextTranslate _translate; + + // Languages filter + public IList languages; + private LangPair[] _languagePairs; + + public static DateTime TraceEndTime; + + private int numberOfFlashes; + + public ApiKeyState apiKeyState; + + List errors; + + // Fabric to create intento connection. Parameters: apiKey and UserAgent for Settings Form + Func fabric; + + string version; + + #endregion vars + + /// + /// + /// + /// + /// + /// + public IntentoTranslationProviderOptionsForm1( + IntentoMTFormOptions options, + LangPair[] languagePairs, + Func fabric + ) + { + this.fabric = fabric; + + InitializeComponent(); + LocalizeContent(); + + if (options.HideHiddenTextButton) + checkBoxShowHidden.Visible = false; + if (options.ForbidSaveApikey) + checkBoxSaveApiKeyInRegistry.Visible = false; + + Assembly currentAssem = typeof(IntentoTranslationProviderOptionsForm1).Assembly; + version = String.Format("{0}-{1}", + IntentoHelpers.GetVersion(currentAssem), + IntentoHelpers.GetGitCommitHash(currentAssem)); + + originalOptions = options; + currentOptions = originalOptions.Duplicate(); + apiKeyState = new ApiKeyState(this, currentOptions); + if (apiKeyState.GetValueFromRegistry("ProxyEnabled") != null && apiKeyState.GetValueFromRegistry("ProxyEnabled") == "1") + { + currentOptions.proxySettings = new ProxySettings() + { + ProxyAddress = apiKeyState.GetValueFromRegistry("ProxyAddress"), + ProxyPort = apiKeyState.GetValueFromRegistry("ProxyPort"), + ProxyUserName = apiKeyState.GetValueFromRegistry("ProxyUserName"), + ProxyPassword = apiKeyState.GetValueFromRegistry("ProxyPassw"), + ProxyEnabled = true + }; + } + else + checkBoxProxy.Checked = false; + + checkBoxProxy.CheckedChanged += checkBoxProxy_CheckedChanged; + + _languagePairs = languagePairs; + DialogResult = DialogResult.None; + + var tmp = TraceEndTime; + checkBoxTrace.Checked = (TraceEndTime - DateTime.Now).Minutes > 0; + TraceEndTime = tmp; + // string pluginFor = string.IsNullOrEmpty(Options.PluginFor) ? "" : Options.PluginFor + '/'; + // toolStripStatusLabel2.Text = String.Format("{0} {1}{2}", Options.PluginName, pluginFor, Options.AssemblyVersion); + var arr = originalOptions.Signature.Split('/'); + toolStripStatusLabel2.Text = arr.Count()==3 ? String.Format("{0}/{1}",arr[0], arr[2]) : originalOptions.Signature; + textBoxModel.Location = comboBoxModels.Location; // new Point(comboBoxModels.Location.X, comboBoxModels.Location.Y); + textBoxGlossary.Location = comboBoxGlossaries.Location; // new Point(comboBoxGlossaries.Location.X, comboBoxGlossaries.Location.Y); + groupBoxAuthCredentialId.Location = groupBoxAuth.Location; // new Point(groupBoxAuth.Location.X, groupBoxAuth.Location.Y) + + apiKeyState.apiKeyChangedEvent += ChangeApiKeyStatusDelegate; + apiKey_tb.Select(); + + apiKeyState.EnableDisable(); + } + + public IntentoMTFormOptions GetOptions() + { + return currentOptions; + } + + public LangPair[] LanguagePairs + { get { return _languagePairs; } } + + public void ChangeApiKeyStatusDelegate(bool isOK) + { + if (apiKeyState.apiKeyStatus == ApiKeyState.EApiKeyStatus.download) + { + CreateIntentoConnection(); + } + apiKeyState.EnableDisable(); + } + + private void CreateIntentoConnection() + { + _translate = fabric(apiKeyState.apiKey, String.Format("{1}/{2}", originalOptions.UserAgent, "Intento.PluginSettingsForm", version), currentOptions.proxySettings); + } + + private void apiKey_tb_TextChanged(object sender, EventArgs e) + { + apiKeyState.SetValue(apiKey_tb.Text.Trim()); + apiKeyState.EnableDisable(); + } + + public static bool IsTrace() + { + return (TraceEndTime - DateTime.Now).Minutes > 0; + } + + private string customAuthJsonToString(string authJsonString) + { + string ret = String.Empty; + if (IsValidJson(authJsonString) == null) + { + var js = JToken.Parse(authJsonString); + foreach (dynamic val in js) + ret += String.Format("{0}:{1} ", val.Name, val.Value); + } + return ret; + } + + private string IsValidJson(string strInput) + { + strInput = String.IsNullOrEmpty(strInput) ? String.Empty : strInput.Trim(); + string result = "Invalid json for own authorization parameters"; + if ((strInput.StartsWith("{") && strInput.EndsWith("}")) || //For object + (strInput.StartsWith("[") && strInput.EndsWith("]"))) //For array + { + try + { + var obj = JToken.Parse(strInput); + if (obj.HasValues) + result = null; + } + catch { } + } + return result; + } + + private void LocalizeContent() + { + Text = Resource.MFCaption; + label2.Text = Resource.MFLabel2; + label3.Text = Resource.MFLabel3; + checkBoxProxy.Text = Resource.MFcheckBoxProxy; + label5.Text = Resource.ApiKeyLabel; + buttonCheck.Text = Resource.MFButtonCheck; + checkBoxSmartRouting.Text = Resource.MFCheckBoxSmartRouting; + groupBoxProviderSettings.Text = Resource.MFGroupBoxProviderSettings; + label1.Text = Resource.ProviderLabel; + groupBoxAuthCredentialId.Text = Resource.MFGroupBoxAuthCredentialId; + checkBoxUseOwnCred.Text = Resource.MFCheckBoxUseOwnCred; + groupBoxAuth.Text = Resource.MFGroupBoxAuth; + buttonWizard.Text = Resource.MFButtonWizard; + checkBoxUseCustomModel.Text = Resource.MFCheckBoxUseCustomModel; + groupBoxModel.Text = Resource.MFGroupBoxModel; + groupBoxGlossaries.Text = Resource.MFGroupBoxGlossary; + buttonContinue.Text = Resource.OKLabel; + checkBoxSaveApiKeyInRegistry.Text = Resource.MFCheckBoxSaveApiKeyInRegistry; + checkBoxShowHidden.Text = Resource.ShowHiddenTextLabel; + checkBoxTrace.Text = Resource.MFCheckBoxTrace; + + checkBoxShowHidden.Text = Resource.ShowHiddenTextLabel; + } + + #region paramount events + + private void comboBoxProviders_SelectedIndexChanged(object sender, EventArgs e) + { + if (apiKeyState != null && apiKeyState.smartRoutingState != null && apiKeyState.smartRoutingState.providerState != null) + // Can happen during loading data from Options - constructor of ProviderState change settings in a list of providers + apiKeyState.smartRoutingState.providerState.SelectedIndexChanged(); + } + + private bool filterBy(dynamic x, string lang) + { + if (x == null) return true; + if (x.GetType().Name == "JArray") + return ((JArray)x).Any(q => (string)q == lang); + if (x.GetType().Name == "JValue") + return (string)x == lang; + return true; + } + + #endregion paramount events + + #region events + + private void IntentoTranslationProviderOptionsForm_Shown(object sender, EventArgs e) + { + using (new CursorForm(this)) + { + checkBoxSmartRouting.Checked = GetOptions().SmartRouting; + apiKeyState.ReadProviders(); + CreateIntentoConnection(); + } + } + + private void buttonCheck_Click(object sender, EventArgs e) + { + using (new CursorForm(this)) + { + apiKeyState.ReadProviders(); + apiKeyState.EnableDisable(); + } + } + + private void checkBoxUseOwnCred_CheckedChanged(object sender, EventArgs e) + { + using (new CursorForm(this)) + apiKeyState?.smartRoutingState?.providerState?.GetAuthState()?.checkBoxUseOwnCred_CheckedChanged(); + } + + private void checkBoxUseCustomModel_CheckedChanged(object sender, EventArgs e) + { + using (new CursorForm(this)) + apiKeyState?.smartRoutingState?.providerState?.GetAuthState()?.GetModelState()?.checkBoxUseCustomModel_CheckedChanged(); + } + + // Save settings + private void buttonContinue_Click(object sender, EventArgs e) + { + using (new CursorForm(this)) + { + originalOptions.Translate = _translate; + apiKeyState.FillOptions(originalOptions); + + // originalOptions.StoreApikeyInRegistry = checkBoxSaveApiKeyInRegistry.Checked; + if (!string.IsNullOrEmpty(originalOptions.ApiKey)) + apiKeyState.SaveValueToRegistry("ApiKey", originalOptions.ApiKey); + else + apiKeyState.SaveValueToRegistry("ApiKey", originalOptions.ApiKey); + + Close(); + } + } + + private void linkLabel_LinkClicked(object sender, LinkLabelLinkClickedEventArgs e) + { + System.Diagnostics.Process.Start(((LinkLabel)sender).Text); + } + + private void linkLabel_Paint(object sender, System.Windows.Forms.PaintEventArgs e) + { + System.Windows.Forms.LinkLabel control = (System.Windows.Forms.LinkLabel)sender; + SizeF stringSize = e.Graphics.MeasureString(control.Text, control.Font); + control.Font = new Font(FontFamily.GenericSansSerif, control.Font.Size); + } + + private void buttonWizard_Click(object sender, EventArgs e) + { + apiKeyState?.smartRoutingState?.providerState?.GetAuthState()?.buttonWizard_Click(); + apiKeyState.EnableDisable(); + } + + private void comboBoxModels_SelectedIndexChanged(object sender, EventArgs e) + { + using (new CursorForm(this)) + { + apiKeyState?.smartRoutingState?.providerState?.GetAuthState()?.GetModelState()?.comboBoxModels_SelectedIndexChanged(); + apiKeyState.EnableDisable(); + } + } + + private void checkBoxShowHidden_CheckedChanged(object sender, EventArgs e) + { + using (new CursorForm(this)) + { + apiKey_tb.UseSystemPasswordChar = !checkBoxShowHidden.Checked; + textBoxCredentials.UseSystemPasswordChar = !checkBoxShowHidden.Checked; + } + } + + private void checkBoxTrace_CheckedChanged(object sender, EventArgs e) + { + TraceEndTime = DateTime.Now.AddMinutes(checkBoxTrace.Checked ? 30 : -40); + } + + private void IntentoTranslationProviderOptionsForm_Load(object sender, EventArgs e) + { + } + + private void comboBoxCredentialId_SelectedIndexChanged(object sender, EventArgs e) + { + using (new CursorForm(this)) + apiKeyState?.smartRoutingState?.providerState?.GetAuthState()?.comboBoxCredentialId_SelectedIndexChanged(); + } + + private void textBoxModel_TextChanged(object sender, EventArgs e) + { + apiKeyState.EnableDisable(); + } + + private void timer1_Tick(object sender, EventArgs e) + { + comboBoxGlossaries.BackColor = comboBoxGlossaries.BackColor != Color.LightPink ? Color.LightPink : SystemColors.Window; + numberOfFlashes++; + if (numberOfFlashes > 5) + { + timer1.Stop(); + numberOfFlashes = 0; + } + } + + private void checkBoxSmartRouting_CheckedChanged(object sender, EventArgs e) + { + using (new CursorForm(this)) + apiKeyState?.smartRoutingState?.CheckedChanged(); + } + + private void textBoxCredentials_Enter(object sender, EventArgs e) + { + buttonWizard_Click(null, null); + } + + private void checkBoxProxy_CheckedChanged(object sender, EventArgs e) + { + if (checkBoxProxy.Checked) + { + var form = new IntentoTranslationProviderProxySettingsForm(this); + if (form.ShowDialog() == DialogResult.OK) + { + + apiKeyState.SaveValueToRegistry("ProxyAddress", currentOptions.proxySettings.ProxyAddress); + apiKeyState.SaveValueToRegistry("ProxyPort", currentOptions.proxySettings.ProxyPort); + apiKeyState.SaveValueToRegistry("ProxyUserName", currentOptions.proxySettings.ProxyUserName); + apiKeyState.SaveValueToRegistry("ProxyPassw", currentOptions.proxySettings.ProxyPassword); + apiKeyState.SaveValueToRegistry("ProxyEnabled", "1"); + apiKeyState.ReadProviders(); + } + else + { + checkBoxProxy.Checked = false; + apiKeyState.SaveValueToRegistry("ProxyEnabled", "0"); + } + } + else + { + currentOptions.proxySettings = null; + apiKeyState.SaveValueToRegistry("ProxyEnabled", "0"); + apiKeyState.ReadProviders(); + } + } + + private void checkBoxSaveApiKeyInRegistry_CheckedChanged(object sender, EventArgs e) + { + } + #endregion events + + public static void Logging(string subject, string comment = null, Exception ex = null) + { + if (!IntentoTranslationProviderOptionsForm1.IsTrace()) + return; + + try + { + + string path = Environment.GetEnvironmentVariable("temp"); + if (string.IsNullOrEmpty(path)) + path = Environment.GetEnvironmentVariable("tmp"); + if (string.IsNullOrEmpty(path)) + return; + + DateTime now = DateTime.UtcNow; + List content = new List(); + content.Add("------------------------"); + content.Add(string.Format("{0} {1}", now.ToString("yyyy-MM-dd HH:mm:ss.fffff"), subject)); + if (comment != null) + content.Add(comment); + if (ex != null) + content.AddRange(LoggingEx(ex)); + + string filename = string.Format("{0}\\Intento_Logs_{1}", path, now.ToString("yyyy-MM-dd-HH")); + File.AppendAllLines(filename, content); + } + catch { } + } + + public static IEnumerable LoggingEx(Exception ex) + { + List items = new List(); + items.Add(string.Format("Exception {0}", ex.Message)); + if (ex.StackTrace != null) + { + items.Add("Stack Trace:"); + items.Add(ex.StackTrace); + } + if (ex.InnerException != null) + items.AddRange(LoggingEx(ex.InnerException)); + return items; + } + + private void textBoxLabel_Enter(object sender, System.EventArgs e) + { + System.Diagnostics.Process.Start(((TextBox)sender).Text); + } + + private int cursorCount = 0; + public class CursorForm : IDisposable + { + IForm form; + public CursorForm(IForm form) + { + this.form = form; + if (form.CursorCount == 0) + form.Cursor = Cursors.WaitCursor; + form.CursorCount++; + } + + public void Dispose() + { + form.CursorCount--; + if (form.CursorCount == 0) + form.Cursor = Cursors.Default; + } + } + + #region IForm + ApiKeyState IForm.ApiKeyState { get { return apiKeyState; } } + + // ApiKey textBox (apiKey_tb) + string IForm.ApiKey_TextBox_Text { get { return apiKey_tb.Text; } set { apiKey_tb.Text = value; } } + bool IForm.ApiKey_TextBox_Enabled { set { apiKey_tb.Enabled = value; } } + Color IForm.ApiKey_TextBox_BackColor { set { apiKey_tb.BackColor = value; } } + + + // ApiKey Check Button (buttonCheck) + bool IForm.ApiKeyCheck_Button_Enabled { set { buttonCheck.Enabled = value; } get { return buttonCheck.Enabled; } } + + // SmartRouting_CheckBox (checkBoxSmartRouting) + bool IForm.SmartRouting_CheckBox_Checked { get { return checkBoxSmartRouting.Checked; } set { checkBoxSmartRouting.Checked = value; } } + bool IForm.SmartRouting_CheckBox_Visible { set { checkBoxSmartRouting.Visible = value; } } + bool IForm.SmartRouting_CheckBox_Enabled { set { checkBoxSmartRouting.Enabled = value; } } + + // Providers_ComboBox (comboBoxProviders) + void IForm.Providers_ComboBox_Clear() { comboBoxProviders.Items.Clear(); } + void IForm.Providers_ComboBox_AddRange(object[] items) { comboBoxProviders.Items.AddRange(items); } + string IForm.Providers_ComboBox_SelectedItem { set { comboBoxProviders.SelectedItem = value; } } + string IForm.Providers_ComboBox_Text { get { return comboBoxProviders.Text; } } + //Color IForm.Providers_ComboBox_BackColor { set { comboBoxProviders.BackColor = value; } } + + void IForm.Providers_ComboBox_BackColor_State(bool hasErrors) + { + if (hasErrors) + comboBoxProviders.BackColor = Color.LightPink; + else + comboBoxProviders.BackColor = Color.White; + } + + // Providers_GroupBox (groupBoxProviderSettings) + bool IForm.Providers_Group_Enabled { set { groupBoxProviderSettings.Enabled = value; } } + + // Auth_CheckBox (checkBoxUseOwnCred) + bool IForm.Auth_CheckBox_Visible { set { checkBoxUseOwnCred.Visible = value; } } + bool IForm.Auth_CheckBox_Enabled { set { checkBoxUseOwnCred.Enabled = value; } } + bool IForm.Auth_CheckBox_Checked { get { return checkBoxUseOwnCred.Checked; } set { checkBoxUseOwnCred.Checked = value; } } + + // AuthText_Group (groupBoxAuth) + bool IForm.AuthText_Group_Visible { set { groupBoxAuth.Visible = value; } } + + // AuthText_TextBox (textBoxCredentials) + Color IForm.AuthText_TextBox_BackColor { set { textBoxCredentials.BackColor = value; } } + string IForm.AuthText_TextBox_Text { set { textBoxCredentials.Text = value; } } + + // AuthCombo_Group (groupBoxAuthCredentialId) + bool IForm.AuthCombo_Group_Visible { set { groupBoxAuthCredentialId.Visible = value; } } + + // AuthCombo_ComboBox (comboBoxCredentialId) + void IForm.AuthCombo_ComboBox_Clear() { comboBoxCredentialId.Items.Clear(); } + void IForm.AuthCombo_ComboBox_AddRange(object[] items) { comboBoxCredentialId.Items.AddRange(items); } + void IForm.AuthCombo_ComboBox_Insert(int n, string text) { comboBoxCredentialId.Items.Insert(n, text); } + bool IForm.AuthCombo_ComboBox_Contains(string text) { return comboBoxCredentialId.Items.Contains(text); } + object IForm.AuthCombo_ComboBox_SelectedItem { get { return comboBoxCredentialId.SelectedItem; } set { comboBoxCredentialId.SelectedItem = value; } } + bool IForm.AuthCombo_ComboBox_Enabled { set { comboBoxCredentialId.Enabled = value; } } + int IForm.AuthCombo_ComboBox_Count { get { return comboBoxCredentialId.Items.Count; } } + int IForm.AuthCombo_ComboBox_SelectedIndex { set { comboBoxCredentialId.SelectedIndex = value; } } + Color IForm.AuthCombo_ComboBox_BackColor { set { comboBoxCredentialId.BackColor = value; } } + string IForm.AuthCombo_ComboBox_Text { get { return comboBoxCredentialId.Text; } } + + // Model_CheckBox (checkBoxUseCustomModel) + bool IForm.Model_CheckBox_Checked { get { return checkBoxUseCustomModel.Checked; } set { checkBoxUseCustomModel.Checked = value; } } + //bool IForm.Model_CheckBox_Visible { set { checkBoxUseCustomModel.Visible = value; } } + bool IForm.Model_CheckBox_Enabled { set { checkBoxUseCustomModel.Enabled = value; } } + + // Model_Group (groupBoxModel) + //bool IForm.Model_Group_Visible { set { groupBoxModel.Visible = value; } } + bool IForm.Model_Group_Enabled { set { groupBoxModel.Enabled = value; } } + + // Model_ComboBox (comboBoxModels) + void IForm.Model_ComboBox_Clear() { comboBoxModels.Items.Clear(); } + int IForm.Model_ComboBox_Add(string text) { return comboBoxModels.Items.Add(text); } + int IForm.Model_ComboBox_SelectedIndex { set { comboBoxModels.SelectedIndex = value; } } + int IForm.Model_ComboBox_Count { get { return comboBoxModels.Items.Count; } } + bool IForm.Model_ComboBox_Visible { set { comboBoxModels.Visible = value; } } + //Color IForm.Model_ComboBox_BackColor { set { comboBoxModels.BackColor = value; } } + string IForm.Model_ComboBox_Text { get { return comboBoxModels.Text; } set { comboBoxModels.Text = value; } } + void IForm.Model_Control_BackColor_State(bool hasErrors) + { + if (hasErrors) + { + comboBoxModels.BackColor = Color.LightPink; + textBoxModel.BackColor = Color.LightPink; + } + else + { + comboBoxModels.BackColor = Color.White; + textBoxModel.BackColor = Color.White; + } + } + + // Model_TextBox (textBoxModel) + bool IForm.Model_TextBox_Visible { set { textBoxModel.Visible = value; } } + string IForm.Model_TextBox_Text { get { return textBoxModel.Text; } set { textBoxModel.Text = value; } } + //Color IForm.Model_TextBox_BackColor { set { textBoxModel.BackColor = value; } } + + // Glossary_Group (groupBoxGlossary) + bool IForm.Glossary_Group_Visible { get { return groupBoxGlossaries.Visible; } set { groupBoxGlossaries.Visible = value; } } + + // Glossary_TextBox (textBoxGlossary) + bool IForm.Glossary_TextBox_Visible { set { textBoxGlossary.Visible = value; } } + bool IForm.Glossary_TextBox_Enabled { set { textBoxGlossary.Enabled = value; } } + string IForm.Glossary_TextBox_Text { get { return textBoxGlossary.Text; } set { textBoxGlossary.Text = value; } } + + // Glossary_ComboBox (comboBoxGlossaries) + void IForm.Glossary_ComboBox_Clear() { comboBoxGlossaries.Items.Clear(); } + int IForm.Glossary_ComboBoxAdd(string text) { return comboBoxGlossaries.Items.Add(text); } + void IForm.Glossary_ComboBox_Insert(int n, string text) { comboBoxGlossaries.Items.Insert(n, text); } + int IForm.Glossary_ComboBox_SelectedIndex { set { comboBoxGlossaries.SelectedIndex = value; } } + bool IForm.Glossary_ComboBox_Visible { set { comboBoxGlossaries.Visible = value; } } + bool IForm.Glossary_ComboBox_Enabled { set { comboBoxGlossaries.Enabled = value; } } + string IForm.Glossary_ComboBox_Text { get { return comboBoxGlossaries.Text; } } + + // Continue Button (buttonContinue) + bool IForm.Continue_Button_Enabled { get { return buttonContinue.Enabled; } set { buttonContinue.Enabled = value; } } + + // ErrorMessage TextBox (toolStripStatusLabel1) + string IForm.ErrorMessage_TextBox_Text { get { return toolStripStatusLabel1.Text; } set { toolStripStatusLabel1.Text = value; } } + Color IForm.ErrorMessage_TextBox_BackColor { set { toolStripStatusLabel1.BackColor = value; } } + + // SaveApiKeyInRegistry checkBox () + bool IForm.SaveApiKeyInRegistry_CheckBox_Checked { get { return checkBoxSaveApiKeyInRegistry.Checked; } set { checkBoxSaveApiKeyInRegistry.Checked = value; } } + + // ShowHidden_CheckBox (checkBoxShowHidden) + bool IForm.ShowHidden_CheckBox_Checked { get { return checkBoxShowHidden.Checked; } } + + // Intento API + IEnumerable IForm.Providers(Dictionary filter) { return _translate.Providers(filter: filter); } + dynamic IForm.Provider(string provider, string additionalParams) { return _translate.Provider(provider: provider, additionalParams: additionalParams); } + IList IForm.DelegatedCredentials() { return _translate.DelegatedCredentials(); } + IList IForm.Models(string provider, Dictionary credential_id) { return _translate.Models(provider: provider, credentials: credential_id); } + IList IForm.Glossaries(string provider, Dictionary credential_id) { return _translate.Glossaries(provider: provider, credentials: credential_id); } + + // Other + int IForm.CursorCount { get { return cursorCount; } set { cursorCount = value; } } + Cursor IForm.Cursor { set { Cursor = value; } } + void IForm.SuspendLayout() { SuspendLayout(); } + void IForm.ResumeLayout() { ResumeLayout(); } + List IForm.Errors { get { return errors; } set { errors = value; } } + LangPair[] IForm.LanguagePairs { get { return _languagePairs; } } + + bool insideEnableDisable = false; + bool IForm.InsideEnableDisable { get { return insideEnableDisable; } set { insideEnableDisable = value; } } + + public static ResourceManager resourceManager = new ResourceManager(typeof(Resource)); + ResourceManager IForm.ResourceManager { get { return resourceManager; } } + + + + // Added for NewUI + void IForm.ApiKey_Set_Panel() { } + + + #endregion + + private void buttonWizard_EnabledChanged(object sender, EventArgs e) + { + + } + } +} diff --git a/IntentoTranslationProviderOptionsForm.resx b/Intento.MT.Plugin.PropertiesForm/IntentoTranslationProviderOptionsForm.resx similarity index 98% rename from IntentoTranslationProviderOptionsForm.resx rename to Intento.MT.Plugin.PropertiesForm/IntentoTranslationProviderOptionsForm.resx index 5766795..76206be 100644 --- a/IntentoTranslationProviderOptionsForm.resx +++ b/Intento.MT.Plugin.PropertiesForm/IntentoTranslationProviderOptionsForm.resx @@ -1,132 +1,132 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - text/microsoft-resx - - - 2.0 - - - System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 - - - System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 - - - 17, 17 - - - 146, 17 - - - 262, 17 - - - 59 - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + text/microsoft-resx + + + 2.0 + + + System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 + + + System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 + + + 17, 17 + + + 146, 17 + + + 262, 17 + + + 59 + \ No newline at end of file diff --git a/Logs.cs b/Intento.MT.Plugin.PropertiesForm/Logs.cs similarity index 100% rename from Logs.cs rename to Intento.MT.Plugin.PropertiesForm/Logs.cs diff --git a/ModelState.cs b/Intento.MT.Plugin.PropertiesForm/ModelState.cs similarity index 100% rename from ModelState.cs rename to Intento.MT.Plugin.PropertiesForm/ModelState.cs diff --git a/PluginHelper.cs b/Intento.MT.Plugin.PropertiesForm/PluginHelper.cs similarity index 100% rename from PluginHelper.cs rename to Intento.MT.Plugin.PropertiesForm/PluginHelper.cs diff --git a/Properties/AssemblyInfo.cs b/Intento.MT.Plugin.PropertiesForm/Properties/AssemblyInfo.cs similarity index 100% rename from Properties/AssemblyInfo.cs rename to Intento.MT.Plugin.PropertiesForm/Properties/AssemblyInfo.cs diff --git a/Intento.MT.Plugin.PropertiesForm/Properties/Intento.MT.Plugin.PropertiesForm.nuspec b/Intento.MT.Plugin.PropertiesForm/Properties/Intento.MT.Plugin.PropertiesForm.nuspec new file mode 100644 index 0000000..b13de0d --- /dev/null +++ b/Intento.MT.Plugin.PropertiesForm/Properties/Intento.MT.Plugin.PropertiesForm.nuspec @@ -0,0 +1,18 @@ + + + + Intento.MT.Plugin.PropertiesForm + 2.2.22.0 + Intento + Intento + false + A library with a settings form used in Intento momoQ plugin and Intento Trados plugin. + Copyright © Intento 2018-2021 + + + + + + + + diff --git a/ProviderState.cs b/Intento.MT.Plugin.PropertiesForm/ProviderState.cs similarity index 100% rename from ProviderState.cs rename to Intento.MT.Plugin.PropertiesForm/ProviderState.cs diff --git a/Resources/intento.ico b/Intento.MT.Plugin.PropertiesForm/Resources/intento.ico similarity index 100% rename from Resources/intento.ico rename to Intento.MT.Plugin.PropertiesForm/Resources/intento.ico diff --git a/RevisionHistory.cs b/Intento.MT.Plugin.PropertiesForm/RevisionHistory.cs similarity index 100% rename from RevisionHistory.cs rename to Intento.MT.Plugin.PropertiesForm/RevisionHistory.cs diff --git a/SmartRoutingState.cs b/Intento.MT.Plugin.PropertiesForm/SmartRoutingState.cs similarity index 100% rename from SmartRoutingState.cs rename to Intento.MT.Plugin.PropertiesForm/SmartRoutingState.cs diff --git a/WinForms/IntentoFormAdvanced.Designer.cs b/Intento.MT.Plugin.PropertiesForm/WinForms/IntentoFormAdvanced.Designer.cs similarity index 100% rename from WinForms/IntentoFormAdvanced.Designer.cs rename to Intento.MT.Plugin.PropertiesForm/WinForms/IntentoFormAdvanced.Designer.cs diff --git a/WinForms/IntentoFormAdvanced.cs b/Intento.MT.Plugin.PropertiesForm/WinForms/IntentoFormAdvanced.cs similarity index 100% rename from WinForms/IntentoFormAdvanced.cs rename to Intento.MT.Plugin.PropertiesForm/WinForms/IntentoFormAdvanced.cs diff --git a/WinForms/IntentoFormAdvanced.resx b/Intento.MT.Plugin.PropertiesForm/WinForms/IntentoFormAdvanced.resx similarity index 100% rename from WinForms/IntentoFormAdvanced.resx rename to Intento.MT.Plugin.PropertiesForm/WinForms/IntentoFormAdvanced.resx diff --git a/WinForms/IntentoFormIgnoreError.Designer.cs b/Intento.MT.Plugin.PropertiesForm/WinForms/IntentoFormIgnoreError.Designer.cs similarity index 100% rename from WinForms/IntentoFormIgnoreError.Designer.cs rename to Intento.MT.Plugin.PropertiesForm/WinForms/IntentoFormIgnoreError.Designer.cs diff --git a/WinForms/IntentoFormIgnoreError.cs b/Intento.MT.Plugin.PropertiesForm/WinForms/IntentoFormIgnoreError.cs similarity index 100% rename from WinForms/IntentoFormIgnoreError.cs rename to Intento.MT.Plugin.PropertiesForm/WinForms/IntentoFormIgnoreError.cs diff --git a/WinForms/IntentoFormIgnoreError.resx b/Intento.MT.Plugin.PropertiesForm/WinForms/IntentoFormIgnoreError.resx similarity index 100% rename from WinForms/IntentoFormIgnoreError.resx rename to Intento.MT.Plugin.PropertiesForm/WinForms/IntentoFormIgnoreError.resx diff --git a/WinForms/IntentoFormOptionsAPI.Designer.cs b/Intento.MT.Plugin.PropertiesForm/WinForms/IntentoFormOptionsAPI.Designer.cs similarity index 100% rename from WinForms/IntentoFormOptionsAPI.Designer.cs rename to Intento.MT.Plugin.PropertiesForm/WinForms/IntentoFormOptionsAPI.Designer.cs diff --git a/WinForms/IntentoFormOptionsAPI.cs b/Intento.MT.Plugin.PropertiesForm/WinForms/IntentoFormOptionsAPI.cs similarity index 100% rename from WinForms/IntentoFormOptionsAPI.cs rename to Intento.MT.Plugin.PropertiesForm/WinForms/IntentoFormOptionsAPI.cs diff --git a/WinForms/IntentoFormOptionsAPI.resx b/Intento.MT.Plugin.PropertiesForm/WinForms/IntentoFormOptionsAPI.resx similarity index 100% rename from WinForms/IntentoFormOptionsAPI.resx rename to Intento.MT.Plugin.PropertiesForm/WinForms/IntentoFormOptionsAPI.resx diff --git a/WinForms/IntentoFormOptionsMT.Designer.cs b/Intento.MT.Plugin.PropertiesForm/WinForms/IntentoFormOptionsMT.Designer.cs similarity index 100% rename from WinForms/IntentoFormOptionsMT.Designer.cs rename to Intento.MT.Plugin.PropertiesForm/WinForms/IntentoFormOptionsMT.Designer.cs diff --git a/WinForms/IntentoFormOptionsMT.cs b/Intento.MT.Plugin.PropertiesForm/WinForms/IntentoFormOptionsMT.cs similarity index 100% rename from WinForms/IntentoFormOptionsMT.cs rename to Intento.MT.Plugin.PropertiesForm/WinForms/IntentoFormOptionsMT.cs diff --git a/WinForms/IntentoFormOptionsMT.resx b/Intento.MT.Plugin.PropertiesForm/WinForms/IntentoFormOptionsMT.resx similarity index 100% rename from WinForms/IntentoFormOptionsMT.resx rename to Intento.MT.Plugin.PropertiesForm/WinForms/IntentoFormOptionsMT.resx diff --git a/WinForms/IntentoFormOptonsMain.Designer.cs b/Intento.MT.Plugin.PropertiesForm/WinForms/IntentoFormOptonsMain.Designer.cs similarity index 100% rename from WinForms/IntentoFormOptonsMain.Designer.cs rename to Intento.MT.Plugin.PropertiesForm/WinForms/IntentoFormOptonsMain.Designer.cs diff --git a/WinForms/IntentoFormOptonsMain.cs b/Intento.MT.Plugin.PropertiesForm/WinForms/IntentoFormOptonsMain.cs similarity index 100% rename from WinForms/IntentoFormOptonsMain.cs rename to Intento.MT.Plugin.PropertiesForm/WinForms/IntentoFormOptonsMain.cs diff --git a/WinForms/IntentoFormOptonsMain.resx b/Intento.MT.Plugin.PropertiesForm/WinForms/IntentoFormOptonsMain.resx similarity index 100% rename from WinForms/IntentoFormOptonsMain.resx rename to Intento.MT.Plugin.PropertiesForm/WinForms/IntentoFormOptonsMain.resx diff --git a/WinForms/IntentoFormProviderAuthWizard.Designer.cs b/Intento.MT.Plugin.PropertiesForm/WinForms/IntentoFormProviderAuthWizard.Designer.cs similarity index 100% rename from WinForms/IntentoFormProviderAuthWizard.Designer.cs rename to Intento.MT.Plugin.PropertiesForm/WinForms/IntentoFormProviderAuthWizard.Designer.cs diff --git a/WinForms/IntentoFormProviderAuthWizard.cs b/Intento.MT.Plugin.PropertiesForm/WinForms/IntentoFormProviderAuthWizard.cs similarity index 100% rename from WinForms/IntentoFormProviderAuthWizard.cs rename to Intento.MT.Plugin.PropertiesForm/WinForms/IntentoFormProviderAuthWizard.cs diff --git a/WinForms/IntentoFormProviderAuthWizard.resx b/Intento.MT.Plugin.PropertiesForm/WinForms/IntentoFormProviderAuthWizard.resx similarity index 100% rename from WinForms/IntentoFormProviderAuthWizard.resx rename to Intento.MT.Plugin.PropertiesForm/WinForms/IntentoFormProviderAuthWizard.resx diff --git a/WinForms/IntentoFormSplash.Designer.cs b/Intento.MT.Plugin.PropertiesForm/WinForms/IntentoFormSplash.Designer.cs similarity index 100% rename from WinForms/IntentoFormSplash.Designer.cs rename to Intento.MT.Plugin.PropertiesForm/WinForms/IntentoFormSplash.Designer.cs diff --git a/WinForms/IntentoFormSplash.cs b/Intento.MT.Plugin.PropertiesForm/WinForms/IntentoFormSplash.cs similarity index 100% rename from WinForms/IntentoFormSplash.cs rename to Intento.MT.Plugin.PropertiesForm/WinForms/IntentoFormSplash.cs diff --git a/WinForms/IntentoFormSplash.resx b/Intento.MT.Plugin.PropertiesForm/WinForms/IntentoFormSplash.resx similarity index 100% rename from WinForms/IntentoFormSplash.resx rename to Intento.MT.Plugin.PropertiesForm/WinForms/IntentoFormSplash.resx diff --git a/WinForms/Resource.Designer.cs b/Intento.MT.Plugin.PropertiesForm/WinForms/Resource.Designer.cs similarity index 100% rename from WinForms/Resource.Designer.cs rename to Intento.MT.Plugin.PropertiesForm/WinForms/Resource.Designer.cs diff --git a/WinForms/Resource.resx b/Intento.MT.Plugin.PropertiesForm/WinForms/Resource.resx similarity index 100% rename from WinForms/Resource.resx rename to Intento.MT.Plugin.PropertiesForm/WinForms/Resource.resx diff --git a/Intento.MT.Plugin.PropertiesForm/app.config b/Intento.MT.Plugin.PropertiesForm/app.config new file mode 100644 index 0000000..a0cefc2 --- /dev/null +++ b/Intento.MT.Plugin.PropertiesForm/app.config @@ -0,0 +1,11 @@ + + + + + + + + + + + \ No newline at end of file diff --git a/githashForm.bat b/Intento.MT.Plugin.PropertiesForm/githashForm.bat similarity index 100% rename from githashForm.bat rename to Intento.MT.Plugin.PropertiesForm/githashForm.bat diff --git a/Intento.MT.Plugin.PropertiesForm/intento_sn.snk b/Intento.MT.Plugin.PropertiesForm/intento_sn.snk new file mode 100644 index 0000000..98e61d9 Binary files /dev/null and b/Intento.MT.Plugin.PropertiesForm/intento_sn.snk differ diff --git a/packages.config b/Intento.MT.Plugin.PropertiesForm/packages.config similarity index 59% rename from packages.config rename to Intento.MT.Plugin.PropertiesForm/packages.config index 0051a07..b742636 100644 --- a/packages.config +++ b/Intento.MT.Plugin.PropertiesForm/packages.config @@ -2,4 +2,6 @@ + + \ No newline at end of file diff --git a/Intento.MT.Plugin.PropertiesForm/postbuild.ps1 b/Intento.MT.Plugin.PropertiesForm/postbuild.ps1 new file mode 100644 index 0000000..b0b7726 --- /dev/null +++ b/Intento.MT.Plugin.PropertiesForm/postbuild.ps1 @@ -0,0 +1,15 @@ +$file=$args[0] +Write-Host $file +$res = signtool.exe verify /pa /q $file +if (!$?) +{ + Write-Host signing $file + signtool.exe sign /q /d "Intento.MT.Plugin.PropertiesForm Library" /du "https://inten.to" /fd SHA256 /tr http://ts.ssl.com /td sha256 /sha1 d79d7faf87aa9eecc1437e7da38e81f8a547dc38 $file +} +else +{ + Write-Host Alerady signed $file +} + + + diff --git a/TestForm/App.config b/TestForm/App.config index 5744095..4a35d1b 100644 --- a/TestForm/App.config +++ b/TestForm/App.config @@ -1,6 +1,14 @@ - + + + + + + + + + \ No newline at end of file diff --git a/TestForm/TestForm.csproj b/TestForm/TestForm.csproj index 21b40ba..bb399f4 100644 --- a/TestForm/TestForm.csproj +++ b/TestForm/TestForm.csproj @@ -99,11 +99,5 @@ - - - {a4374128-dd01-4ce3-b62c-4cc3460620c0} - Intento.MT.Plugin.PropertiesForm - - \ No newline at end of file diff --git a/intento.pfx b/intento.pfx deleted file mode 100644 index ef51a18..0000000 Binary files a/intento.pfx and /dev/null differ diff --git a/nuget.config b/nuget.config new file mode 100644 index 0000000..c649b43 --- /dev/null +++ b/nuget.config @@ -0,0 +1,23 @@ + + + + + + + ../packages + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/packages/AWSSDK.Core.3.3.107.14/.signature.p7s b/packages/AWSSDK.Core.3.3.107.14/.signature.p7s deleted file mode 100644 index 6e1caf6..0000000 Binary files a/packages/AWSSDK.Core.3.3.107.14/.signature.p7s and /dev/null differ diff --git a/packages/AWSSDK.Core.3.3.107.14/AWSSDK.Core.3.3.107.14.nupkg b/packages/AWSSDK.Core.3.3.107.14/AWSSDK.Core.3.3.107.14.nupkg deleted file mode 100644 index e031b8d..0000000 Binary files a/packages/AWSSDK.Core.3.3.107.14/AWSSDK.Core.3.3.107.14.nupkg and /dev/null differ diff --git a/packages/AWSSDK.Core.3.3.107.14/lib/MonoAndroid10/AWSSDK.Core.XML b/packages/AWSSDK.Core.3.3.107.14/lib/MonoAndroid10/AWSSDK.Core.XML deleted file mode 100644 index 2b1ead4..0000000 --- a/packages/AWSSDK.Core.3.3.107.14/lib/MonoAndroid10/AWSSDK.Core.XML +++ /dev/null @@ -1,10850 +0,0 @@ - - - - AWSSDK.Core - - - - - Utility class to parse Amazon resource names more commonly known as an ARN. - - - - - Gets and sets the partition associated with the ARN (e.g.: 'aws'). - - - - - Gets and sets the AWS service associated with the ARN (e.g.: 's3'). - - - - - Gets and sets the region associated with the ARN (e.g.: 'us-east-1'). - - - - - Gets and sets the account ID associated with the ARN. - - - - - Gets and sets the resource associated with the ARN (e.g.: 'mybucket/myobject'). - - - - - Returns true if the string appears to be an ARN by seeing if the string starts with "arn:". This method - doesn't guarantee the string is a valid ARN. To validate the string call TryParse. - - - - - - - Parses the string into an ARN object. - - String to parse into an ARN. - The out parameter for the ARN object created by TryParse. - True if the string was parsed into an ARN object. - - - - Parses the string into an ARN object. - - String to parse into an Arn. - The Arn object created from the passed in string. - Thrown if arnString is null. - Thrown if the string passed in not valid ARN. - - - - Turns the Arn object into a string representation of an ARN. - - - - - - Configuration options that apply to the entire SDK. - - These settings can be configured through app.config or web.config. - Below is a full sample configuration that illustrates all the possible options. - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws region="us-west-2"> - <logging logTo="Log4Net, SystemDiagnostics" logResponses="Always" logMetrics="true" /> - <s3 useSignatureVersion4="true" /> - <proxy host="localhost" port="8888" username="1" password="1" /> - - <dynamoDB> - <dynamoDBContext tableNamePrefix="Prod-"> - - <tableAliases> - <alias fromTable="FakeTable" toTable="People" /> - <alias fromTable="Persons" toTable="People" /> - </tableAliases> - - <mappings> - <map type="Sample.Tests.Author, SampleDLL" targetTable="People" /> - <map type="Sample.Tests.Editor, SampleDLL" targetTable="People"> - <property name="FullName" attribute="Name" /> - <property name="EmployeeId" attribute="Id" /> - <property name="ComplexData" converter="Sample.Tests.ComplexDataConverter, SampleDLL" /> - <property name="Version" version="true" /> - <property name="Password" ignore="true" /> - </map> - </mappings> - - </dynamoDBContext> - </dynamoDB> - </aws> - - - - Configuration options that apply to the entire SDK. - - - - - Manual offset to apply to client clock. This is a global setting that overrides - ClockOffset value calculated for all service endpoints. - - - - - Determines if the SDK should correct for client clock skew - by determining the correct server time and reissuing the - request with the correct time. - Default value of this field is True. - will be updated with the calculated - offset even if this field is set to false, though requests - will not be corrected or retried. - Ignored if is set. - - - - - The calculated clock skew correction, if there is one. - This field will be set if a service call resulted in an exception - and the SDK has determined that there is a difference between local - and server times. - - If is set to true, this - value will be set to the correction, but it will not be used by the - SDK and clock skew errors will not be retried. - - - - - Key for the AWSRegion property. - - - - - - Configures the default AWS region for clients which have not explicitly specified a region. - Changes to this setting will only take effect for newly constructed instances of AWS clients. - - This setting can be configured through the App.config. For example: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws region="us-west-2" /> - - - - - - Key for the AWSProfileName property. - - - - - - Profile name for stored AWS credentials that will be used to make service calls. - Changes to this setting will only take effect in newly-constructed clients. - - To reference the account from an application's App.config or Web.config use the AWSProfileName setting. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="development"/> - </appSettings> - </configuration> - - - - - - - Key for the AWSProfilesLocation property. - - - - - - Location of the credentials file shared with other AWS SDKs. - By default, the credentials file is stored in the .aws directory in the current user's home directory. - - Changes to this setting will only take effect in newly-constructed clients. - - To reference the profile from an application's App.config or Web.config use the AWSProfileName setting. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfilesLocation" value="c:\config"/> - </appSettings> - </configuration> - - - - - - - Key for the Logging property. - - - - - - Configures how the SDK should log events, if at all. - Changes to this setting will only take effect in newly-constructed clients. - - The setting can be configured through App.config, for example: - - <appSettings> - <add key="AWSLogging" value="log4net"/> - </appSettings> - - - - - - Key for the ResponseLogging property. - - - - - - - Configures when the SDK should log service responses. - Changes to this setting will take effect immediately. - - The setting can be configured through App.config, for example: - - <appSettings> - <add key="AWSResponseLogging" value="OnError"/> - </appSettings> - - - - - - Key for the LogMetrics property. - - - - - - Configures if the SDK should log performance metrics. - This setting configures the default LogMetrics property for all clients/configs. - Changes to this setting will only take effect in newly-constructed clients. - - The setting can be configured through App.config, for example: - - <appSettings> - <add key="AWSLogMetrics" value="true"/> - </appSettings> - - - - - - Key for the EndpointDefinition property. - - - - - - Configures if the SDK should use a custom configuration file that defines the regions and endpoints. - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws endpointDefinition="c:\config\endpoints.json" /> - - - - - - Key for the UseSdkCache property. - - - - - - Configures if the SDK Cache should be used, the default value is true. - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws useSdkCache="true" /> - - - - - - Configuration for the Logging section of AWS configuration. - Changes to some settings may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws> - <logging logTo="Log4Net, SystemDiagnostics" logResponses="Always" logMetrics="true" /> - </aws> - - - - - - Configuration for the Proxy section of AWS configuration. - Changes to some settings may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws> - <proxy host="localhost" port="8888" username="1" password="1" bypassList="addressexpr1;addressexpr2;..." bypassOnLocal="true" /> - </aws> - - - - - - Configuration for the region endpoint section of AWS configuration. - Changes may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws region="us-west-2" /> - - - - - - Lock for SomeEvent delegate access. - - - - - This method should never be called directly. - Call AWSSDKUtils.CorrectedUtcNow instead. - - - - - - Logging options. - Can be combined to enable multiple loggers. - - - - - No logging - - - - - Log using log4net - - - - - Log using System.Diagnostics - - - - - Log to the console - - - - - Log to a file - - - - - Response logging option. - - - - - Never log service response - - - - - Only log service response when there's an error - - - - - Always log service response - - - - - Format for metrics data in the logs - - - - - Emit metrics in human-readable format - - - - - Emit metrics as JSON data - - - - - An access control policy action identifies a specific action in a service - that can be performed on a resource. For example, sending a message to a - queue. - - ActionIdentifiers allow you to limit what your access control policy statement affects. - For example, you could create a policy statement that enables a certain group - of users to send messages to your queue, but not allow them to perform any - other actions on your queue. - - - The action is B in the statement - "A has permission to do B to C where D applies." - - Free form access control policy actions may include a wildcard (*) to match - multiple actions. - - - Constants for known actions can be found in the Amazon.Auth.AccessControlPolicy.ActionIdentifiers namespace. - - - - - - Constructs an Actionidentifer with the given action name. - - The name of the action - - - - Gets and sets the name of this action. For example, 'sqs:SendMessage' is the - name corresponding to the SQS action that enables users to send a message - to an SQS queue. - - - - - AWS access control policy conditions are contained in - objects, and affect when a statement is applied. For example, a statement - that allows access to an Amazon SQS queue could use a condition to only apply - the effect of that statement for requests that are made before a certain - date, or that originate from a range of IP addresses. - - Multiple conditions can be included in a single statement, and all conditions - must evaluate to true in order for the statement to take effect. - - - The set of conditions is D in the statement - "A has permission to do B to C where D applies." - - - A condition is composed of three parts: - - - Condition Key - The condition key declares which value of a - request to pull in and compare against when a policy is evaluated by AWS. For - example, using will cause - AWS to pull in the current request's source IP as the first value to compare - against every time your policy is evaluated. - - - - Comparison Type - This is a static value used as the second value - in the comparison when your policy is evaluated. Depending on the comparison - type, this value can optionally use wildcards. See the documentation for - individual comparison types for more information. - - - - Comparison Value - This is a static value used as the second value - in the comparison when your policy is evaluated. Depending on the comparison - type, this value can optionally use wildcards. See the documentation for - individual comparison types for more information. - - - - - - - - - Gets the type of this condition. - - - - - Gets and Sets the name of the condition key involved in this condition. - Condition keys are predefined values supported by AWS that provide input - to a condition's evaluation, such as the current time, or the IP address - of the incoming request. - - Your policy is evaluated for each incoming request, and condition keys - specify what information to pull out of those incoming requests and plug - into the conditions in your policy. - - - - - - Gets and Sets the values specified for this access control policy condition. - For example, in a condition that compares the incoming IP address of a - request to a specified range of IP addresses, the range of IP addresses - is the single value in the condition. - - Most conditions accept only one value, but multiple values are possible. - - - - - - A factory for creating conditions to be used in the policy. - - - - - Condition key for the current time. - - This condition key should only be used with enum. - - - - - - Condition key for whether or not an incoming request is using a secure - transport to make the request (i.e. HTTPS instead of HTTP). - - This condition key should only be used with the boolean overload of NewCondition. - - - - - - Condition key for the source IP from which a request originates. - - This condition key should only be used with enum. - - - - - - Condition key for the user agent included in a request. - - This condition key should only be used with - enum. - - - - - - Condition key for the current time, in epoch seconds. - - This condition key should only be used with enum. - objects. - - - - - - Condition key for the referrer specified by a request. - - This condition key should only be used with - objects. - - - - - - Condition key for the Amazon Resource Name (ARN) of the source specified - in a request. The source ARN indicates which resource is affecting the - resource listed in your policy. For example, an SNS topic is the source - ARN when publishing messages from the topic to an SQS queue. - - This condition key should only be used with enum. - - - - - - Enumeration of the supported ways an ARN comparison can be evaluated. - - - - Exact matching - - - - Loose case-insensitive matching of the ARN. Each of the six - colon-delimited components of the ARN is checked separately and each - can include a multi-character match wildcard (*) or a - single-character match wildcard (?). - - - - Negated form of ArnEquals - - - Negated form of ArnLike - - - - Enumeration of the supported ways a date comparison can be evaluated. - - - - - Enumeration of the supported ways an IP address comparison can be evaluated. - - - - - Matches an IP address against a CIDR IP range, evaluating to true if - the IP address being tested is in the condition's specified CIDR IP - range. - - - - - Negated form of IpAddress - - - - - Enumeration of the supported ways a numeric comparison can be evaluated - - - - - Enumeration of the supported ways a string comparison can be evaluated. - - - - - Case-sensitive exact string matching - - - - - Case-insensitive string matching - - - - - Loose case-insensitive matching. The values can include a - multi-character match wildcard (*) or a single-character match - wildcard (?) anywhere in the string. - - - - - Negated form of StringEquals. - - - - - Negated form of StringEqualsIgnorecase. - - - - - Negated form of StringLike. - - - - - Constructs a new access control policy condition that compares ARNs (Amazon Resource Names). - - The access policy condition key specifying where to get the first ARN for the comparison - The type of comparison to perform. - The second ARN to compare against. When using ArnLike or ArnNotLike this may contain the - multi-character wildcard (*) or the single-character wildcard - - - - Constructs a new access policy condition that performs a boolean - comparison. - - The access policy condition key specifying where to get the - first boolean value for the comparison (ex: aws:SecureTransport). - The boolean to compare against. - - - - This method is deprecated. Invoking this method results in non-UTC DateTimes - not being marshalled correctly. Use NewConditionUtc instead. - Constructs a new access policy condition that compares the current time - (on the AWS servers) to the specified date. - - The type of comparison to perform. For example, - DateComparisonType.DateLessThan will cause this policy - condition to evaluate to true if the current date is less than - the date specified in the second argument. - The date to compare against. - - - - Constructs a new access policy condition that compares the current time - (on the AWS servers) to the specified date. - - The type of comparison to perform. For example, - DateComparisonType.DateLessThan will cause this policy - condition to evaluate to true if the current date is less than - the date specified in the second argument. - The date to compare against. - - - - Constructs a new access policy condition that compares the source IP - address of the incoming request to an AWS service against the specified - CIDR range. The condition evaluates to true (meaning the policy statement - containing it will be applied) if the incoming source IP address is - within that range. - - To achieve the opposite effect (i.e. cause the condition to evaluate to - true when the incoming source IP is not in the specified CIDR - range) use the alternate constructor form and specify - IpAddressComparisonType.NotIpAddress. - - - The CIDR IP range involved in the policy condition. - - - - Constructs a new access policy condition that compares the source IP - address of the incoming request to an AWS service against the specified - CIDR range. When the condition evaluates to true (i.e. when the incoming - source IP address is within the CIDR range or not) depends on the - specified IpAddressComparisonType. - - The type of comparison to to perform. - The CIDR IP range involved in the policy condition. - - - - Constructs a new access policy condition that compares two numbers. - - The type of comparison to perform. - The access policy condition key specifying where to get the - first number for the comparison. - The second number to compare against. - - - - Constructs a new access control policy condition that compares two - strings. - - The type of comparison to perform - The access policy condition key specifying where to get the - first string for the comparison (ex: aws:UserAgent). - - The second string to compare against. When using - StringComparisonType.StringLike or - StringComparisonType.StringNotLike this may contain - the multi-character wildcard (*) or the single-character - wildcard (?). - - - - - Constructs a new access policy condition that compares the Amazon - Resource Name (ARN) of the source of an AWS resource that is modifying - another AWS resource with the specified pattern. - - For example, the source ARN could be an Amazon SNS topic ARN that is - sending messages to an Amazon SQS queue. In that case, the SNS topic ARN - would be compared the ARN pattern specified here. - - - The endpoint pattern may optionally contain the multi-character wildcard - * (*) or the single-character wildcard (?). Each of the six colon-delimited - components of the ARN is checked separately and each can include a - wildcard. - - - Policy policy = new Policy("MyQueuePolicy"); - policy.WithStatements(new Statement(Statement.StatementEffect.Allow) - .WithPrincipals(new Principal("*")).WithActionIdentifiers(SQSActionIdentifiers.SendMessage) - .WithResources(new Resource(myQueueArn)) - .WithConditions(ConditionFactory.NewSourceArnCondition(myTopicArn))); - - - The ARN pattern against which the source ARN will be compared. - Each of the six colon-delimited components of the ARN is - checked separately and each can include a wildcard. - A new access control policy condition that compares the ARN of - the source specified in an incoming request with the ARN pattern - specified here. - - - - Constructs a new access control policy condition that tests if the - incoming request was sent over a secure transport (HTTPS). - - A new access control policy condition that tests if the incoming - request was sent over a secure transport (HTTPS). - - - - Condition key for the canned ACL specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the location constraint specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the prefix specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the delimiter specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the max keys specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the source object specified by a request to copy an - object. - - This condition key may only be used with enum. - - - - - - Condition key for the metadata directive specified by a request to copy - an object. - - This condition key may only be used with enum. - - - - - - Condition key for the version ID of an object version specified by a - request. - - This condition key may only be used with enum. - - - - - - Constructs a new access policy condition that compares an Amazon S3 - canned ACL with the canned ACL specified by an incoming request. - - You can use this condition to ensure that any objects uploaded to an - Amazon S3 bucket have a specific canned ACL set. - - - The Amazon S3 canned ACL to compare against. - A new access control policy condition that compares the Amazon S3 - canned ACL specified in incoming requests against the value - specified. - - - - Condition key for The URL, e-mail address, or ARN from a Subscribe - request or a previously confirmed subscription. Use with string - conditions to restrict access to specific endpoints (e.g., - *@mycompany.com). - - This condition key may only be used with enum. - - - - - - Condition key for the protocol value from a Subscribe request or a - previously confirmed subscription. Use with string conditions to restrict - publication to specific delivery protocols (e.g., HTTPS). - - This condition key may only be used with enum. - - - - - - Constructs a new access policy condition that compares the requested - endpoint used to subscribe to an Amazon SNS topic with the specified - endpoint pattern. The endpoint pattern may optionally contain the - multi-character wildcard (*) or the single-character wildcard (?). - - For example, this condition can restrict subscriptions to a topic to - email addresses in a certain domain ("*@my-company.com"). - - - Policy policy = new Policy("MyTopicPolicy"); - policy.WithStatements(new Statement(Statement.StatementEffect.Allow) - .WithPrincipals(new Principal("*")).WithActionIdentifiers(SNSActionIdentifiers.Subscribe) - .WithResources(new Resource(myTopicArn)) - .WithConditions(ConditionFactory.NewEndpointCondition("*@my-company.com"))); - - - The endpoint pattern against which to compare the requested - endpoint for an Amazon SNS topic subscription. - A new access control policy condition that compares the endpoint - used in a request to subscribe to an Amazon SNS topic with the - endpoint pattern specified. - - - - Constructs a new AWS access control policy condition that allows an - access control statement to restrict subscriptions to an Amazon SNS topic - based on the protocol being used for the subscription. For example, this - condition can restrict subscriptions to a topic to endpoints using HTTPS - to ensure that messages are securely delivered. - - The protocol against which to compare the requested protocol - for an Amazon SNS topic subscription. - A new access control policy condition that compares the - notification protocol requested in a request to subscribe to an - Amazon SNS topic with the protocol value specified. - - - - An AWS access control policy is a object that acts as a container for one or - more statements, which specify fine grained rules for allowing or denying - various types of actions from being performed on your AWS resources. - - By default, all requests to use your resource coming from anyone but you are - denied. Access control polices can override that by allowing different types - of access to your resources, or by explicitly denying different types of - access. - - - Each statement in an AWS access control policy takes the form: - "A has permission to do B to C where D applies". - - - A is the prinicpal - The AWS account that is making a request to - access or modify one of your AWS resources. - - - - B is the action - the way in which your AWS resource is being accessed or modified, such - as sending a message to an Amazon SQS queue, or storing an object in an Amazon S3 bucket. - - - - C is the resource - your AWS entity that the principal wants to access, such - as an Amazon SQS queue, or an object stored in Amazon S3. - - - - D is the set of conditions - optional constraints that specify when to allow or deny - access for the principal to access your resource. Many expressive conditions are available, - some specific to each service. For example you can use date conditions to allow access to - your resources only after or before a specific time. - - - - - - Note that an AWS access control policy should not be confused with the - similarly named "POST form policy" concept used in Amazon S3. - - - - - - The default policy version - - - - - Constructs an empty AWS access control policy ready to be populated with - statements. - - - - - Constructs a new AWS access control policy with the specified policy ID. - The policy ID is a user specified string that serves to help developers - keep track of multiple polices. Policy IDs are often used as a human - readable name for a policy. - - The policy ID for the new policy object. Policy IDs serve to - help developers keep track of multiple policies, and are often - used to give the policy a meaningful, human readable name. - - - - Constructs a new AWS access control policy with the specified policy ID - and collection of statements. The policy ID is a user specified string - that serves to help developers keep track of multiple polices. Policy IDs - are often used as a human readable name for a policy. - - The policy ID for the new policy object. Policy IDs serve to - help developers keep track of multiple policies, and are often - used to give the policy a meaningful, human readable name. - The statements to include in the new policy. - - - - Gets and Sets the policy ID for this policy. Policy IDs serve to help - developers keep track of multiple policies, and are often used as human - readable name for a policy. - - - - - Sets the policy ID for this policy and returns the updated policy so that - multiple calls can be chained together. - - Policy IDs serve to help developers keep track of multiple policies, and - are often used as human readable name for a policy. - - - The polich ID for this policy - this instance - - - - Gets and sets the version of this AWS policy. - - - - - Gets and Sets the collection of statements contained by this policy. Individual - statements in a policy are what specify the rules that enable or disable - access to your AWS resources. - - - - - Checks to see if the permissions set in the statement are already set by another - statement in the policy. - - The statement to verify - True if the statement's permissions are already allowed by the statement - - - - Sets the collection of statements contained by this policy and returns - this policy object so that additional method calls can be chained - together. - - Individual statements in a policy are what specify the rules that enable - or disable access to your AWS resources. - - - The collection of statements included in this policy. - this instance - - - - Returns a JSON string representation of this AWS access control policy, - suitable to be sent to an AWS service as part of a request to set an - access control policy. - - A JSON string representation of this AWS access control policy. - - - - Returns a JSON string representation of this AWS access control policy, - suitable to be sent to an AWS service as part of a request to set an - access control policy. - - Toggle pretty print for the generated JSON document - A JSON string representation of this AWS access control policy. - - - - Parses a JSON document of a policy and creates a Policy object. - - JSON document of a policy. - - - - - A principal is an AWS account which is being allowed or denied access to a - resource through an access control policy. The principal is a property of the - Statement object, not directly the object. - - The principal is A in the statement - "A has permission to do B to C where D applies." - - - In an access control policy statement, you can set the principal to all - authenticated AWS users through the member. This - is useful when you don't want to restrict access based on the identity of the - requester, but instead on other identifying characteristics such as the - requester's IP address. - - - - - - Principal instance that includes all authenticated AWS users. - - This is useful when you don't want to restrict access based on the - identity of the requester, but instead on other identifying - characteristics such as the requester's IP address. - - - - - - The anonymous Principal. - - - - - The default Principal provider for AWS accounts. - - - - - Principal provider for Canonical User IDs. - - - - - Principal provider for federated users (using a SAML identity provider) - - - - - Principal provider for assume role policies that will be assumed by an AWS service - (e.g. "ec2.amazonaws.com"). - - - - - Dummy principal provider for anonynous. - - - - - Constructs a new principal with the specified AWS account ID. - - An AWS account ID. - - - - Constructs a new principal with the specified provider and id - - The provider of the principal - The unique ID of the Principal within the provider - - - - Constructs a new principal with the specified provider and id - and optionally strips hyphens from the id - - The provider of the principal - The unique ID of the Principal within the provider - Strip hyphen - - - - Gets and sets the provider for this principal, which indicates in what group of - users this principal resides. - - - - - Gets the unique ID for this principal. - - - - - Represents a resource involved in an AWS access control policy statement. - Resources are the service specific AWS entities owned by your account. Amazon - SQS queues, Amazon S3 buckets and objects, and Amazon SNS topics are all - examples of AWS resources. - - The standard way of specifying an AWS resource is with an Amazon Resource - Name (ARN). - - - The resource is C in the statement - "A has permission to do B to C where D applies." - - - - - - Constructs a new AWS access control policy resource. Resources are - typically specified as Amazon Resource Names (ARNs). - - You specify the resource using the following Amazon Resource Name (ARN) - format: arn:aws:<vendor>:<region>:<namespace>:<relative-id> - - - >vendor identifies the AWS product (e.g., sns) - - - region is the AWS Region the resource resides in (e.g., us-east-1), if any - - - namespace is the AWS account ID with no hyphens (e.g., 123456789012) - - - relative-id is the service specific portion that identifies the specific resource - - - - - For example, an Amazon SQS queue might be addressed with the following - ARN: arn:aws:sqs:us-east-1:987654321000:MyQueue - - - Some resources may not use every field in an ARN. For example, resources - in Amazon S3 are global, so they omit the region field: - arn:aws:s3:::bucket/* - - - The Amazon Resource Name (ARN) uniquely identifying the desired AWS resource. - - - - Gets the resource ID, typically an Amazon Resource Name (ARN), - identifying this resource. - - - - - A factory for creating resources to be used in the policy. - - - - - Constructs a new bucket resource that represents the the specified bucket - but not any of the contained objects. - - The name of the bucket represented by this AWS access control - policy resource. - - - - Constructs a new object resource that represents the specified objects. - The keyPattern argument may contain the '*' wildcard to match multiple - objects. For example, an object resource created for bucket 'mybucket' - and key pattern 'foo*' will match any object stored in 'mybucket' with a - key that starts with 'foo'. - - The name of the bucket containing the object or objects - represented by this resource. - The key or key pattern, which can optionally contain the '*' - wildcard to include multiple objects in the resource. - - - - Constructs a new SQS queue resource for an access control policy. A - policy statement using this resource will allow or deny actions on the - specified queue. - - The AWS account ID of the queue owner. - The name of the Amazon SQS queue. - - - - A statement is the formal description of a single permission, and is always - contained within a policy object. - - A statement describes a rule for allowing or denying access to a specific AWS - resource based on how the resource is being accessed, and who is attempting - to access the resource. Statements can also optionally contain a list of - conditions that specify when a statement is to be honored. - - - For example, consider a statement that: - - - A is the prinicpal - The AWS account that is making a request to - access or modify one of your AWS resources. - - - - B is the action - the way in which your AWS resource is being accessed or modified, such - as sending a message to an Amazon SQS queue, or storing an object in an Amazon S3 bucket. - - - - C is the resource - your AWS entity that the principal wants to access, such - as an Amazon SQS queue, or an object stored in Amazon S3. - - - - D is the set of conditions - optional constraints that specify when to allow or deny - access for the principal to access your resource. Many expressive conditions are available, - some specific to each service. For example you can use date conditions to allow access to - your resources only after or before a specific time. - - - - - - There are many resources and conditions available for use in statements, and - you can combine them to form fine grained custom access control polices. - - - - - - The effect is the result that you want a policy statement to return at - evaluation time. A policy statement can either allow access or explicitly - deny access. - - - - - Constructs a new access control policy statement with the specified - effect. - - Before a statement is valid and can be sent to AWS, callers must set the - principals, resources, and actions (as well as any optional conditions) - involved in the statement. - - - The effect this statement has (allowing access or denying - access) when all conditions, resources, principals, and - actions are matched. - - - - Gets and Sets the ID for this statement. Statement IDs serve to help keep track - of multiple statements, and are often used to give the statement a - meaningful, human readable name. - - Developers should be careful to not use the same statement ID for - multiple statements in the same policy. Reusing the same statement ID in - different policies is not a problem. - - - - - - Sets the ID for this statement and returns the updated statement so - multiple calls can be chained together. - - Statement IDs serve to help keep track of multiple statements, and are - often used to give the statement a meaningful, human readable name. - - - Developers should be careful to not use the same statement ID for - multiple statements in the same policy. Reusing the same statement ID in - different policies is not a problem. - - - The new statement ID for this statement. - this instance - - - - Gets and Sets the result effect of this policy statement when it is evaluated. - A policy statement can either allow access or explicitly - - - - - Gets and Sets the list of actions to which this policy statement applies. - Actions limit a policy statement to specific service operations that are - being allowed or denied by the policy statement. For example, you might - want to allow any AWS user to post messages to your SQS queue using the - SendMessage action, but you don't want to allow those users other actions - such as ReceiveMessage or DeleteQueue. - - - - - Sets the list of actions to which this policy statement applies and - returns this updated Statement object so that additional method calls can - be chained together. - - Actions limit a policy statement to specific service operations that are - being allowed or denied by the policy statement. For example, you might - want to allow any AWS user to post messages to your SQS queue using the - SendMessage action, but you don't want to allow those users other actions - such as ReceiveMessage or DeleteQueue. - - - The list of actions to which this statement applies. - this instance - - - - Gets and Sets the resources associated with this policy statement. Resources - are what a policy statement is allowing or denying access to, such as an - Amazon SQS queue or an Amazon SNS topic. - - Note that some services allow only one resource to be specified per - policy statement. - - - - - - Sets the resources associated with this policy statement and returns this - updated Statement object so that additional method calls can be chained - together. - - Resources are what a policy statement is allowing or denying access to, - such as an Amazon SQS queue or an Amazon SNS topic. - - - Note that some services allow only one resource to be specified per - policy statement. - - - The resources associated with this policy statement. - this instance - - - - Gets and Sets the conditions associated with this policy statement. Conditions - allow policy statements to be conditionally evaluated based on the many - available condition types. - - For example, a statement that allows access to an Amazon SQS queue could - use a condition to only apply the effect of that statement for requests - that are made before a certain date, or that originate from a range of IP - addresses. - - - When multiple conditions are included in a single statement, all - conditions must evaluate to true in order for the statement to take - effect. - - - - - - Sets the conditions associated with this policy statement, and returns - this updated Statement object so that additional method calls can be - chained together. - - Conditions allow policy statements to be conditionally evaluated based on - the many available condition types. - - - For example, a statement that allows access to an Amazon SQS queue could - use a condition to only apply the effect of that statement for requests - that are made before a certain date, or that originate from a range of IP - addresses. - - - Multiple conditions can be included in a single statement, and all - conditions must evaluate to true in order for the statement to take - effect. - - - The conditions associated with this policy statement. - this instance - - - - Gets and Sets the principals associated with this policy statement, indicating - which AWS accounts are affected by this policy statement. - - - - - Sets the principals associated with this policy statement, and returns - this updated Statement object. Principals control which AWS accounts are - affected by this policy statement. - - If you don't want to restrict your policy to specific users, you can use - to apply the policy to any user trying to - access your resource. - - - The list of principals associated with this policy statement. - this instance - - - - The available AWS access control policy actions for Amazon AppStream. - - - - - - The available AWS access control policy actions for Auto Scaling. - - - - - - The available AWS access control policy actions for AWS Billing. - - - - - - The available AWS access control policy actions for AWS CloudFormation. - - - - - - The available AWS access control policy actions for Amazon CloudFront. - - - - - - The available AWS access control policy actions for Amazon CloudSearch. - - - - - - The available AWS access control policy actions for AWS CloudTrail. - - - - - - The available AWS access control policy actions for Amazon CloudWatch. - - - - - - The available AWS access control policy actions for Amazon CloudWatch Logs. - - - - - - The available AWS access control policy actions for Amazon Cognito Identity. - - - - - - The available AWS access control policy actions for Amazon Cognito Sync. - - - - - - The available AWS access control policy actions for AWS Direct Connect. - - - - - - The available AWS access control policy actions for Amazon DynamoDB. - - - - - - The available AWS access control policy actions for Amazon EC2. - - - - - - The available AWS access control policy actions for AWS ElastiCache. - - - - - - The available AWS access control policy actions for AWS Elastic Beanstalk. - - - - - - The available AWS access control policy actions for Elastic Load Balancing. - - - - - - The available AWS access control policy actions for Amazon Elastic MapReduce. - - - - - - The available AWS access control policy actions for Amazon Elastic Transcoder. - - - - - - The available AWS access control policy actions for Amazon Glacier. - - - - - - The available AWS access control policy actions for AWS Identity and Access Management. - - - - - - The available AWS access control policy actions for AWS Import Export. - - - - - - The available AWS access control policy actions for Amazon Kinesis. - - - - - - The available AWS access control policy actions for AWS Marketplace. - - - - - - The available AWS access control policy actions for AWS Marketplace Management Portal. - - - - - - The available AWS access control policy actions for Amazon Mobile Analytics. - - - - - - The available AWS access control policy actions for AWS OpsWorks. - - - - - - The available AWS access control policy actions for Amazon RDS. - - - - - - The available AWS access control policy actions for Amazon Redshift. - - - - - - The available AWS access control policy actions for Amazon Route 53. - - - - - - The available AWS access control policy actions for Amazon S3. - - - - - - The available AWS access control policy actions for AWS Security Token Service. - - - - - - The available AWS access control policy actions for Amazon SES. - - - - - - The available AWS access control policy actions for Amazon SimpleDB. - - - - - - The available AWS access control policy actions for Amazon Simple Workflow Service. - - - - - - The available AWS access control policy actions for Amazon SNS. - - - - - - The available AWS access control policy actions for Amazon SQS. - - - - - - The available AWS access control policy actions for Amazon Storage Gateway. - - - - - - The available AWS access control policy actions for AWS Whispersync. - - - - - - The available AWS access control policy actions for Amazon Zocalo. - - - - - - Deserializes a JSON string into a AWS policy object. - - - - - Serializes an AWS policy object to a JSON string, suitable for sending to an - AWS service. - - - - Converts the specified AWS policy object to a JSON string, suitable for - passing to an AWS service. - - @param policy - The AWS policy object to convert to a JSON string. - - @return The JSON string representation of the specified policy object. - - @throws IllegalArgumentException - If the specified policy is null or invalid and cannot be - serialized to a JSON string. - - - - Uses the specified generator to write the JSON data for the principals in - the specified policy statement. - - - - - This sorts the conditions by condition type and key with the list of values for that combination. - - The list of conditions to be sorted. - - - - - Exception thrown by the SDK for errors that occur within the SDK. - - - - - This exception is thrown when there is a parse error on the response back from AWS. - - - - - The string value which could not be converted into a valid DateTime instance. - - - - - Occurs before a request is marshalled. - - - - - Occurs before a request is issued against the service. - - - - - Occurs after a response is received from the service. - - - - - Occurs after an exception is encountered. - - - - - Patches the in-flight uri to stop it unescaping the path etc (what Uri did before - Microsoft deprecated the constructor flag). This is particularly important for - Amazon S3 customers who want to use backslash (\) in their key names. - - - Different behavior in the various runtimes has been observed and in addition some - 'documented' ways of doing this between 2.x and 4.x runtimes has also been observed - to not be reliable. - - This patch effectively emulates what adding a schemesettings element to the - app.config file with value 'name="http" genericUriParserOptions="DontUnescapePathDotsAndSlashes"' - does. As we're a dll, that avenue is not open to us. - - - - - - Used to create a copy of the config for a different service than the current instance. - - Target service ClientConfig - The new ClientConfig for the desired service - - - - A base exception for some Amazon Web Services. - - Most exceptions thrown to client code will be service-specific exceptions, though some services - may throw this exception if there is a problem which is caught in the core client code. - - - - - - Whether the error was attributable to Sender or Reciever. - - - - - The error code returned by the service - - - - - The id of the request which generated the exception. - - - - - The HTTP status code from the service response - - - - - Flag indicating if the exception is retryable and the associated retry - details. A null value indicates that the exception is not retryable. - - - - - Class containing the retryable details for an AmazonServiceException - - - - - This property indicates that this exception is a - throttling exception and should be subject to congestion - control throttling. - - - - - This exception is thrown when there is a parse error on the response back from AWS. - - - - - Last known location in the response that was parsed, if available. - - - - - The entire response body that caused this exception, if available. - - - - - Base class for request used by some of the services. - - - - - This flag specifies if SigV4 will be used for the current request. - - - - - Gets or Sets a value indicating if "Expect: 100-continue" HTTP header will be - sent by the client for this request. The default value is false. - - - - - Gets the signer to use for this request. - A null return value indicates to use the configured - signer for the service that this request is part of. - - A signer for this request, or null. - - - - Abstract class for Response objects, contains only metadata, - and no result information. - - - - - Contains additional information about the request, such as the - Request Id. - - - - - Returns the content length of the HTTP response. - - - - - Returns the status code of the HTTP response. - - - - - Base class for determining region based on inspection. - - - - - Sets the Region property by looking up the corresponding RegionEndpoint - from the supplied region system name (us-east-1, us-west-2 etc). - - The system name of the region. - - - - Determines region based on application configuration settings. If the configuration does not contain - the region setting key an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of ApplicationConfigAWSRegion. If no region is found in the - application configuration file then an InvalidOperationException is thrown. - - - - - Probing mechanism to determine region from various sources. - - - - - This class is responsible for keeping track of Retry capacity across different ServiceURLs. - - - - - CapacityType determines the type of capacity to obtain or use. - - - - - The increment capacity type adds capacity. - - - - - The default retry capacity type uses the default capacity amount. - - - - - The timeout capacity type uses the timeout capacity amount. - - - - - This method acquires a said retry capacity if the container has the capacity. - - Contains the RetryCapacity object for the said ServiceURL. - - - - This method acquires a said retry capacity if the container has the capacity. - - Contains the RetryCapacity object for the said ServiceURL. - Specifies what capacity type cost to use for obtaining capacity - - - - This method calls a method to release capacity back - based on whether it was a successful response or a successful retry response. This is invoked by a retry request response. - - if this request is a retry, use a different capacity cost - Contains the RetryCapacity object for the said ServiceURL. - - - - This method calls a method to release capacity back - based on whether it was a successful response or a successful retry response. This is invoked by a retry request response. - - Specifies what capacity type cost to use for adding capacity - Contains the RetryCapacity object for the said ServiceURL. - - - - Ths method fetches the RetryCapacity for the given ServiceURL from CapacityManager.CapacityContainer - - - - - This method releases capacity back. This is invoked by the TryReleaseCapacity method. - - Contains the RetryCapacity object for the said ServiceURL. - The capacity that needs to be released based on whether it was a successful response or a successful retry response. - - - - This class is the RetryCapacity class for a given ServiceURL. - - - - - This class composes Client Context header for Amazon Web Service client. - It contains information like app title, version code, version name, client id, OS platform etc. - - - This class composes Client Context header for Amazon Web Service client. - It contains information like app title, version code, version name, client id, OS platform etc. - - - - - Adds the custom attributes to the Client Context. - - Key. - Value. - - - - Gets a Json Representation of the Client Context. - - Json Representation of Client Context - - - - Collection of parameters that an SDK client will send to a service. - - - - - Constructs empty ParameterCollection. - - - - - Adds a parameter with a string value. - - - - - - - Adds a parameter with a list-of-strings value. - - - - - - - Converts the current parameters into a list of key-value pairs. - - - - - - This class is responsible for managing adaptive retry mode client rate limiting. - - - - - The rate at which token are replenished. - - - - - The maximum capacity allowed in the token - - - - - The current capacity of the token - - - - - The last time the token bucket was refilled. - - - - - The smoothed rate which tokens are being retrieved. - - - - - The last half second time bucket used. - - - - - The number of requests seen within the current time - - - - - The maximum rate when the client was last throttled. - - - - - The last time when the client was throttled. - - - - - The cached time window calculation - - - - - Boolean indicating if the token bucket is enabled. - - - - - This method attempts to acquire capacity from the client's token - - The amount of capacity to obtain from the token bucket - Indicates that the client should or shouldn't sleep and - try again if capacity cannot be obtained. - - - - - This method attempts to acquire capacity from the client's token - - The amount of capacity to obtain from the token bucket - Indicates that the client should or shouldn't sleep and - try again if capacity cannot be obtained. - - Token which can be used to cancel the task. - - - - Updates the sending rate within the client's token bucket - - Indicates if the request resulted in a throttling error. - - - - Calculates the rate - - - Returns the calculated rate for a successful call - - - - Calculates the rate. - - The rate to use in the calculation - Returns the calculated rate for a throttled call - - - - Collection used to indicate if the property was initialized was created by the SDK. - - - - - - Collection used to indicate if the property was initialized was created by the SDK. - - - - - - - Default implementation of the IRequest interface. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Constructs a new DefaultRequest with the specified service name and the - original, user facing request object. - - The orignal request that is being wrapped - The service name - - - - The name of the request - - - - - Gets and sets the type of http request to make, whether it should be POST,GET or DELETE - - - - - Gets and sets a flag that indicates whether the request is sent as a query string instead of the request body. - - - - - Returns the original, user facing request object which this internal - request object is representing. - - - - - Returns a dictionary of the headers included in this request. - - - - - Returns a dictionary of the parameters included in this request. - - - - - Collection of parameters included in this request. - - - - - Returns the subresources that should be appended to the resource path. - This is used primarily for Amazon S3, where object keys can contain '?' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new null entry to the SubResources collection for the request - - The name of the subresource - - - - Adds a new entry to the SubResources collection for the request - - The name of the subresource - Value of the entry - - - - Gets and Sets the endpoint for this request. - - - - - Gets and Sets the resource path added on to the endpoint. - - - - - Returns the path resources that should be used within the resource path. - This is used for services where path keys can contain '/' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new entry to the PathResources collection for the request - - The name of the pathresource with potential greedy syntax: {key+} - Value of the entry - - - - Gets and Sets the version number for the marshaller used to create this request. The version number - is used to support backward compatible changes that would otherwise be breaking changes when a - newer core is used with an older service assembly. - Versions: - 1 - Default version - 2 - Support for path segments - - - - - Gets and Sets the content for this request. - - - - - Flag that signals that Content was and should be set - from the Parameters collection. - - - - - Gets and sets the content stream. - - - - - Gets and sets the original stream position. - If ContentStream is null or does not support seek, this propery - should be equal to -1. - - - - - Computes the SHA 256 hash of the content stream. If the stream is not - seekable, it searches the parent stream hierarchy to find a seekable - stream prior to computation. Once computed, the hash is cached for future - use. If a suitable stream cannot be found to use, null is returned. - - - - - The name of the service to which this request is being sent. - - - - - Alternate endpoint to use for this request, if any. - - - - - Host prefix value to prepend to the endpoint for this request, if any. - - - - - Gets and sets the Suppress404Exceptions property. If true then 404s return back from AWS will not cause an exception and - an empty response object will be returned. - - - - - If using AWS4 signing protocol, contains the resultant parts of the - signature that we may need to make use of if we elect to do a chunked - encoding upload. - - - - - Determine whether to use a chunked encoding upload for the request - (applies to Amazon S3 PutObject and UploadPart requests only). - - - - - - Used for Amazon S3 requests where the bucket name is removed from - the marshalled resource path into the host header. To comply with - AWS2 signature calculation, we need to recover the bucket name - and include it in the resource canonicalization, which we do using - this field. - - - - - This flag specifies if SigV4 is required for the current request. - - - - - The authentication region to use for the request. - Set from Config.AuthenticationRegion. - - - - - The region in which the service request was signed. - - - - - Checks if the request stream can be rewinded. - - Returns true if the request stream can be rewinded , - else false. - - - - Returns true if the request can contain a request body, else false. - - Returns true if the currect request can contain a request body, else false. - - - - Returns true if the request has a body, else false. - - Returns true if the request has a body, else false. - - - - Class containing the data for one endpoint returned from a endpoint discovery request - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Constructs a new DiscoveryEndpoint - - The address of the endpoint - The cache period for the endpoint in minutes - - - - The address of the endpoint. - - - - - The cache period for the endpoint in minutes - - - - - Calculates if this endpoint has expired - - A boolean value indicating if the cache period has expired - - - - Extends the endpoint expiration by the specified number of minutes from now. - - - - - Class containing the data for one endpoint returned from a endpoint discovery request - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class containing the data to use with endpoint discovery - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Gets/sets and flag indicating if endpoint discovery is required for the request. - - - - - Sorted dictionary of the identifiers that must be sent with the endpoint discovery request. These - identifiers are used to construct the cache key for the cache that stores discovered endpoints. A - sorted dictionary is used instead of a dictionary to ensure the cache key comes out in the same order - each time it is constructed. - - - - - Represents the data to be used with endpoint discovery operations - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class used to resolve endpoints using Endpoint Discovery. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Method that performs endpoint discovery for the current operation - - Context information used in calculations for endpoint discovery - The operation to fetch endpoints from the server - - - - - Gets the number of cache keys in the cache - - - - - Class used to resolve endpoints using Endpoint Discovery. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class containing context information to use with endpoint discovery - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Gets the customer credential information. - - - - - Gets the operation name. - - - - - Gets the current marshalled endpoint discovery data. - - - - - Gets the flag indicating if the specified key should be evicted from the cache. - - - - - Gets the Uri that should be evicted if EvictCacheKey is set to true. - - - - - Class containing context information to use with endpoint discovery - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Error type, one of Sender, Receiver, Unknown - Only applies to XML-based services. - - - - - Name of the exception class to return - - - - - Error message - - - - - RequestId of the error. - Only applies to XML-based services. - - - - - InternalConfiguration holds the cached SDK configuration values - obtained from the environment and profile configuration - factories. These configuration values are loaded internally and - are not the same as user exposed AWSConfigs. - - - - - Flag indicating if Endpoint Discovery is enabled. - - - - - The retry mode to use: Legacy, Standard, or Adaptive. - - - - - The max number of request attempts. - - - - - Probing mechanism to determine the configuration values from various sources. - - - - - Resets all the configuration values reloading as needed. This method will use - the AWS_PROFILE environment variable if set to construct the instance. Otherwise - the default profile will be used. - - - - - Flag that specifies if endpoint discovery is enabled, disabled, - or not set. - - - - - Flag that specifies which retry mode to use or if retry mode has - not been set. - - - - - Flag that specifies the max number of request attempts or if max - attempts has not been set. - - - - - Class containing the members used to invoke service calls - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class containing the members used to invoke service calls - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Represents a request being sent to an Amazon Web Service, including the - parameters being sent as part of the request, the endpoint to which the - request should be sent, etc. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - The name of the request - - - - - Returns a dictionary of the headers included in this request. - - - - - Gets and sets a flag that indicates whether the request is sent as a query string instead of the request body. - - - - - Returns a dictionary of the parameters included in this request. - - - - - Collection of parameters included in this request. - - - - - Returns the subresources that should be appended to the resource path. - This is used primarily for Amazon S3, where object keys can contain '?' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new null entry to the SubResources collection for the request - - The name of the subresource - - - - Adds a new entry to the SubResources collection for the request - - The name of the subresource - Value of the entry - - - - Gets and sets the type of http request to make, whether it should be POST,GET or DELETE - - - - - Gets and Sets the endpoint for this request. - - - - - Gets and Sets the resource path added on to the endpoint. - - - - - Returns the path resources that should be used within the resource path. - This is used for services where path keys can contain '/' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new entry to the PathResources collection for the request - - The name of the pathresource with potential greedy syntax: {key+} - Value of the entry - - - - Gets and Sets the version number for the marshaller used to create this request. The version number - is used to support backward compatible changes that would otherwise be breaking changes when a - newer core is used with an older service assembly. - - - - - Gets and Sets the content for this request. - - - - - Gets the header value from the request. - - - - - Flag that signals that Content was and should be set - from the Parameters collection. - - - - - Gets and sets the content stream. - - - - - Gets and sets the original stream position. - If ContentStream is null or does not support seek, this propery - should be equal to -1. - - - - - Computes the SHA 256 hash of the content stream. If the stream is not - seekable, it searches the parent stream hierarchy to find a seekable - stream prior to computation. Once computed, the hash is cached for future - use. - - - - - The name of the service to which this request is being sent. - - - - - Returns the original, user facing request object which this internal - request object is representing. - - - - - Alternate endpoint to use for this request, if any. - - - - - Host prefix value to prepend to the endpoint for this request, if any. - - - - - Gets and sets the Suppress404Exceptions property. If true then 404s return back from AWS will not cause an exception and - an empty response object will be returned. - - - - - If using AWS4 signing protocol, contains the resultant parts of the - signature that we may need to make use of if we elect to do a chunked - encoding upload. - - - - - Determine whether to use a chunked encoding upload for the request - (applies to Amazon S3 PutObject and UploadPart requests only). - - - - - - Used for Amazon S3 requests where the bucket name is removed from - the marshalled resource path into the host header. To comply with - AWS2 signature calculation, we need to recover the bucket name - and include it in the resource canonicalization, which we do using - this field. - - - - - This flag specifies if SigV4 is required for the current request. - - - - - The authentication region to use for the request. - Set from Config.AuthenticationRegion. - - - - - The region in which the service request was signed. - - - - - Checks if the request stream can be rewinded. - - Returns true if the request stream can be rewinded , - else false. - - - - Returns true if the request can contain a request body, else false. - - Returns true if the currect request can contain a request body, else false. - - - - Returns true if the request has a body, else false. - - Returns true if the request has a body, else false. - - - - Gets the value of the Service Id. - - - - - Gets the dictionary that gives mapping of renamed operations - - - - - IDictionary{String, String} access to ParameterCollection. - TODO: remove this class in version 3.4 of the SDK. - - - - - Constructs ParametersDictionaryFacade for a ParameterCollection - - - - - - A registry of object that will manipulate the runtime pipeline used by service clients. - - - - - Registers a customizer that will be applied for all service clients created. Each customizer has a unique name associated with it. If a customizer is registered more - than once with the same unique name then the calls after the first will be ignored. - - - - - - Deregistered the runtime pipeline customizer - - - - - - Deregistered the runtime pipeline customizer - - - - - - Applies all of the registered customizers on the runtime pipeline - - The service clients runtime pipeline. - Type object for the service client being created - - - - Interface for objects that will customize the runtime pipleine for newly created service clients. - - - - - The unique name for the customizer that identifies the customizer in the registry. The name is also used to identify the customizer on the SDK logs. - - - - - Called on service clients as they are being constructed to customize their runtime pipeline. - - - Type object for the service client being created - - - - Default ServiceMetadata implementation. - This implementation will be used if the service doesn't have a - IServiceMetadata implementation. - - - - - Gets the value of the Service Id. - - - - - Gets the dictionary that gives mapping of renamed operations - - - - - Computes RFC 2104-compliant HMAC signature. - - - - - Computes RFC 2104-compliant HMAC signature. - - - - - Inspects the supplied evidence to return the signer appropriate for the operation - - Global setting for the service - The request. - Configuration for the client - True if signature v4 request signing should be used - - - - Signs the specified request with the AWS3 signing protocol by using the - AWS account credentials given in the method parameters. - - The AWS public key - The AWS secret key used to sign the request in clear text - Request metrics - The configuration that specifies which hashing algorithm to use - The request to have the signature compute for - If any problems are encountered while signing the request - - - - AWS4 protocol signer for service calls that transmit authorization in the header field "Authorization". - - - - - Calculates and signs the specified request using the AWS4 signing protocol by using the - AWS account credentials given in the method parameters. The resulting signature is added - to the request headers as 'Authorization'. Parameters supplied in the request, either in - the resource path as a query string or in the Parameters collection must not have been - uri encoded. If they have, use the SignRequest method to obtain a signature. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. - - - Client configuration data encompassing the service call (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text. - - - If any problems are encountered while signing the request. - - - - - Calculates and signs the specified request using the AWS4 signing protocol by using the - AWS account credentials given in the method parameters. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. - - - Client configuration data encompassing the service call (notably authentication - region, endpoint and service name). - - - Metrics for the request. - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text. - - - If any problems are encountered while signing the request. - - - Parameters passed as part of the resource path should be uri-encoded prior to - entry to the signer. Parameters passed in the request.Parameters collection should - be not be encoded; encoding will be done for these parameters as part of the - construction of the canonical request. - - - - - Sets the AWS4 mandated 'host' and 'x-amz-date' headers, returning the date/time that will - be used throughout the signing process in various elements and formats. - - The current set of headers - - Date and time used for x-amz-date, in UTC - - - - Sets the AWS4 mandated 'host' and 'x-amz-date' headers, accepting and returning the date/time that will - be used throughout the signing process in various elements and formats. - - The current set of headers - - - Date and time used for x-amz-date, in UTC - - - - Computes and returns an AWS4 signature for the specified canonicalized request - - - - - - - - - - - - Computes and returns an AWS4 signature for the specified canonicalized request - - - - - - - - - - - - - Computes and returns an AWS4 signature for the specified canonicalized request - - - - - - - - - - - - - - Formats the supplied date and time for use in AWS4 signing, where various formats are used. - - - The required format - The UTC date/time in the requested format - - - - Compute and return the multi-stage signing key for the request. - - The clear-text AWS secret key, if not held in secureKey - The region in which the service request will be processed - Date of the request, in yyyyMMdd format - The name of the service being called by the request - Computed signing key - - - - If the caller has already set the x-amz-content-sha256 header with a pre-computed - content hash, or it is present as ContentStreamHash on the request instance, return - the value to be used in request canonicalization. - If not set as a header or in the request, attempt to compute a hash based on - inspection of the style of the request content. - - - - The computed hash, whether already set in headers or computed here. Null - if we were not able to compute a hash. - - - - - If signPayload is false set the x-amz-content-sha256 header to - the UNSIGNED-PAYLOAD magic string and return it. - Otherwise, if the caller has already set the x-amz-content-sha256 header with a pre-computed - content hash, or it is present as ContentStreamHash on the request instance, return - the value to be used in request canonicalization. - If not set as a header or in the request, attempt to compute a hash based on - inspection of the style of the request content. - - - - - The computed hash, whether already set in headers or computed here. Null - if we were not able to compute a hash. - - - - - Returns the HMAC256 for an arbitrary blob using the specified key - - - - - - - - Returns the HMAC256 for an arbitrary blob using the specified key - - - - - - - - Compute and return the hash of a data blob using the specified key - - Algorithm to use for hashing - Hash key - Data blob - Hash of the data - - - - Compute and return the hash of a data blob using the specified key - - Algorithm to use for hashing - Hash key - Data blob - Hash of the data - - - - Computes the non-keyed hash of the supplied data - - - - - - - Computes the non-keyed hash of the supplied data - - - - - - - Computes and returns the canonical request - - The endpoint URL - the path of the resource being operated on - The http method used for the request - The full request headers, sorted into canonical order - The query parameters for the request - - The hash of the binary request body if present. If not supplied, the routine - will look for the hash as a header on the request. - - Canonicalised request as a string - - - - Computes and returns the canonical request - - The endpoint URL - the path of the resource being operated on - The http method used for the request - The full request headers, sorted into canonical order - The query parameters for the request - - The path resource values lookup to use to replace the keys within resourcePath - The hash of the binary request body if present. If not supplied, the routine - will look for the hash as a header on the request. - - The version of the marshaller that constructed the request object. - Canonicalised request as a string - - - - Computes and returns the canonical request - - The endpoint URL - the path of the resource being operated on - The http method used for the request - The full request headers, sorted into canonical order - The query parameters for the request - - The path resource values lookup to use to replace the keys within resourcePath - The hash of the binary request body if present. If not supplied, the routine - will look for the hash as a header on the request. - - The version of the marshaller that constructed the request object. - The service being called for the request - Canonicalised request as a string - - - - Reorders the headers for the request for canonicalization. - - The set of proposed headers for the request - List of headers that must be included in the signature - For AWS4 signing, all headers are considered viable for inclusion - - - - Computes the canonical headers with values for the request. Only headers included in the signature - are included in the canonicalization process. - - All request headers, sorted into canonical order - Canonicalized string of headers, with the header names in lower case. - - - - Returns the set of headers included in the signature as a flattened, ;-delimited string - - The headers included in the signature - Formatted string of header names - - - - Collects the subresource and query string parameters into one collection - ready for canonicalization - - The in-flight request being signed - The fused set of parameters - - - - Computes and returns the canonicalized query string, if query parameters have been supplied. - Parameters with no value will be canonicalized as 'param='. The expectation is that parameters - have not already been url encoded prior to canonicalization. - - The set of parameters being passed on the uri - - Parameters must be uri encoded into the canonical request and by default the signer expects - that the supplied collection contains non-encoded data. Set this to false if the encoding was - done prior to signer entry. - - The uri encoded query string parameters in canonical ordering - - - - Computes and returns the canonicalized query string, if query parameters have been supplied. - Parameters with no value will be canonicalized as 'param='. The expectation is that parameters - have not already been url encoded prior to canonicalization. - - The set of parameters to be encoded in the query string - - Parameters must be uri encoded into the canonical request and by default the signer expects - that the supplied collection contains non-encoded data. Set this to false if the encoding was - done prior to signer entry. - - The uri encoded query string parameters in canonical ordering - - - - Returns the request parameters in the form of a query string. - - The request instance - Request parameters in query string format - - - - AWS4 protocol signer for Amazon S3 presigned urls. - - - - - Calculates and signs the specified request using the AWS4 signing protocol by using the - AWS account credentials given in the method parameters. The resulting signature is added - to the request headers as 'Authorization'. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. - - - Adding supporting data for the service call required by the signer (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text - - - If any problems are encountered while signing the request. - - - - - Calculates the AWS4 signature for a presigned url. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. If the Expires parameter - is present, it is renamed to 'X-Amz-Expires' before signing. - - - Adding supporting data for the service call required by the signer (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text - - - If any problems are encountered while signing the request. - - - Parameters passed as part of the resource path should be uri-encoded prior to - entry to the signer. Parameters passed in the request.Parameters collection should - be not be encoded; encoding will be done for these parameters as part of the - construction of the canonical request. - - - - - Calculates the AWS4 signature for a presigned url. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. If the Expires parameter - is present, it is renamed to 'X-Amz-Expires' before signing. - - - Adding supporting data for the service call required by the signer (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text - - - The service to sign for - - - The region to sign to, if null then the region the client is configured for will be used. - - - If any problems are encountered while signing the request. - - - Parameters passed as part of the resource path should be uri-encoded prior to - entry to the signer. Parameters passed in the request.Parameters collection should - be not be encoded; encoding will be done for these parameters as part of the - construction of the canonical request. - - The X-Amz-Content-SHA256 is cleared out of the request. - If the request is for S3 then the UNSIGNED_PAYLOAD value is used to generate the canonical request. - If the request isn't for S3 then the empty body SHA is used to generate the canonical request. - - - - - Encapsulates the various fields and eventual signing value that makes up - an AWS4 signature. This can be used to retrieve the required authorization string - or authorization query parameters for the final request as well as hold ongoing - signature computations for subsequent calls related to the initial signing. - - - - - Constructs a new signing result instance for a computed signature - - The access key that was included in the signature - Date/time (UTC) that the signature was computed - The collection of headers names that were included in the signature - Formatted 'scope' value for signing (YYYYMMDD/region/service/aws4_request) - Returns the key that was used to compute the signature - Computed signature - - - - The access key that was used in signature computation. - - - - - ISO8601 formatted date/time that the signature was computed - - - - - ISO8601 formatted date that the signature was computed - - - - - The ;-delimited collection of header names that were included in the signature computation - - - - - Formatted 'scope' value for signing (YYYYMMDD/region/service/aws4_request) - - - - - Returns a copy of the key that was used to compute the signature - - - - - Returns the hex string representing the signature - - - - - Returns a copy of the byte array containing the signature - - - - - Returns the signature in a form usable as an 'Authorization' header value. - - - - - Returns the signature in a form usable as a set of query string parameters. - - - - - Null Signer which does a no-op. - - - - - Signs the specified request with the AWS2 signing protocol by using the - AWS account credentials given in the method parameters. - - The AWS public key - The AWS secret key used to sign the request in clear text - Request metrics - The configuration that specifies which hashing algorithm to use - The request to have the signature compute for - If any problems are encountered while signing the request - - - - S3 signer constructor - - - - - S3 signer constructor - - - - - This exception is thrown if there are problems signing the request. - - - - - Response Unmarshaller for all Errors - - - - - Build an ErrorResponse from XML - - The XML parsing context. - Usually an Amazon.Runtime.Internal.UnmarshallerContext. - An ErrorResponse object. - - - - Return an instance of and ErrorResponseUnmarshaller. - - - - - - Interface for unmarshallers which unmarshall objects from response data. - The Unmarshallers are stateless, and only encode the rules for what data - in the XML stream goes into what members of an object. - - The type of object the unmarshaller returns - The type of the XML unmashaller context, which contains the - state during parsing of the XML stream. Usually an instance of - Amazon.Runtime.Internal.Transform.UnmarshallerContext. - - - - Given the current position in the XML stream, extract a T. - - The XML parsing context - An object of type T populated with data from the XML stream. - - - - Interface for unmarshallers which unmarshall service responses. - The Unmarshallers are stateless, and only encode the rules for what data - in the XML stream goes into what members of an object. - - The type of object the unmarshaller returns - The type of the XML unmashaller context, which contains the - state of parsing the XML stream. Uaually an instance of - Amazon.Runtime.Internal.Transform.UnmarshallerContext. - - - - Extracts an exeption with data from an ErrorResponse. - - The XML parsing context. - An inner exception to be included with the returned exception - The HttpStatusCode from the ErrorResponse - Either an exception based on the ErrorCode from the ErrorResponse, or the - general service exception for the service in question. - - - - Interface for unmarshallers which unmarshall objects from response data. - The Unmarshallers are stateless, and only encode the rules for what data - in the XML stream goes into what members of an object. - - The type of object the unmarshaller returns - The type of the XML unmashaller context, which contains the - state during parsing of the XML stream. Usually an instance of - Amazon.Runtime.Internal.Transform.UnmarshallerContext. - - - - Given the current position in the XML stream, extract a T. - - The XML parsing context - An object of type T populated with data from the XML stream. - - - - First-pass unmarshaller for all errors - - - - - Build an ErrorResponse from json - - The json parsing context. - Usually an Amazon.Runtime.Internal.JsonUnmarshallerContext. - An ErrorResponse object. - - - - Return an instance of JsonErrorResponseUnmarshaller. - - - - - - Wraps a json string for unmarshalling. - - Each Read() operation gets the next token. - TestExpression() is used to match the current key-chain - to an xpath expression. The general pattern looks like this: - - JsonUnmarshallerContext context = new JsonUnmarshallerContext(jsonString); - while (context.Read()) - { - if (context.IsKey) - { - if (context.TestExpresion("path/to/element")) - { - myObject.stringMember = stringUnmarshaller.GetInstance().Unmarshall(context); - continue; - } - } - } - - - - - - Wrap the jsonstring for unmarshalling. - - Stream that contains the JSON for unmarshalling - If set to true, maintains a copy of the complete response body constraint to log response size as the stream is being read. - Response data coming back from the request - If set to true, maintains a copy of the complete response body as the stream is being read. - - - - Are we at the start of the json document. - - - - - Is the current token the end of an object - - - - - Is the current token the start of an object - - - - - Returns the element depth of the parser's current position in the json - document being parsed. - - - - - The current Json path that is being unmarshalled. - - - - - Reads to the next token in the json document, and updates the context - accordingly. - - - True if a token was read, false if there are no more tokens to read. - - - - - Peeks at the next token. This peek implementation - reads the next token and makes the subsequent Read() return the same data. - If Peek is called successively, it will return the same data. - Only the first one calls Read(), subsequent calls - will return the same data until a Read() call is made. - - Token to peek. - Returns true if the peeked token matches given token. - - - - Returns the text contents of the current token being parsed. - - - The text contents of the current token being parsed. - - - - - The type of the current token - - - - - Get the base stream of the jsonStream. - - - - - Peeks at the next (non-whitespace) character in the jsonStream. - - The next (non-whitespace) character in the jsonStream, or -1 if at the end. - - - - Peeks at the next character in the stream. - If the data isn't buffered into the StreamReader (Peek() returns -1), - we flush the buffered data and try one more time. - - - - - - Abstract class for unmarshalling service responses. - - - - - Class for unmarshalling XML service responses. - - - - - Class for unmarshalling EC2 service responses. - - - - - Class for unmarshalling JSON service responses. - - - - - Unmarshaller for int fields - - - - - Unmarshaller for nullable int fields. Implemented only for JSON context - to handle cases where value can be null e.g. {'Priority': null}. - This unmarshaller is not implemented for XML context, as XML responses - will null elements (xsi:nil='true') will be skipped by the XML parser. - - - - - Unmarshaller for long fields - - - - - Unmarshaller for float fields - - - - - Unmarshaller for double fields - - - - - Unmarshaller for decimal fields - - - - - Unmarshaller for bool fields - - - - - Unmarshaller for string fields - - - - - Unmarshaller for byte fields - - - - - Unmarshaller for DateTime fields - - - - - Unmarshalls given string as a DateTime. Handles cases where we want to unmarshall - as just a DateTime or a nullable Datetime. - - Value to be parsed - If true, the method will return null if text is null. - If false, the method will return default(DateTime), if text is null. - - - - - Unmarshaller for nullable DateTime fields. Implemented only for JSON context - to handle cases where value can be null e.g. {'Priority': null}. - This unmarshaller is not implemented for XML context, as XML responses - will null elements (xsi:nil='true') will be skipped by the XML parser. - - - - - Unmarshaller for MemoryStream fields - - - - - Unmarshaller for ResponseMetadata - - - - - Base class for the UnmarshallerContext objects that are used - to unmarshall a web-service response. - - - - - Tests the specified expression against the current position in the XML - document - - The pseudo-XPath expression to test. - - True if the expression matches the current position in the document, - false otherwise. - - - - Tests the specified expression against the current position in the XML - document being parsed, and restricts the expression to matching at the - specified stack depth. - - The pseudo-XPath expression to test. - - The depth in the stack representing where the expression must - start matching in order for this method to return true. - - True if the specified expression matches the current position in - the XML document, starting from the specified depth. - - - - Reads the next token at depth greater than or equal to target depth. - - Tokens are read at depth greater than or equal to target depth. - True if a token was read and current depth is greater than or equal to target depth. - - - - The current path that is being unmarshalled. - - - - - Returns the element depth of the parser's current position in the - document being parsed. - - - - - Reads to the next node in the document, and updates the context accordingly. - - - True if a node was read, false if there are no more elements to read. - - - - - Returns the text contents of the current element being parsed. - - - The text contents of the current element being parsed. - - - - - True if NodeType is Element. - - - - - True if NodeType is EndElement. - - - - - True if the context is at the start of the document. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Wrap an XmltextReader for simulating an event stream. - - Each Read() operation goes either to the next element or next attribute within - the current element. TestExpression() is used to match the current event - to an xpath expression. The general pattern looks like this: - - UnmarshallerContext context = new UnmarshallerContext(...); - while (context.Read()) - { - if (context.TestExpresion("path/to/element")) - { - myObject.stringMember = stringUnmarshaller.GetInstance().Unmarshall(context); - continue; - } - if (context.TestExpression("path/to/@attribute")) - myObject.MyComplexTypeMember = MyComplexTypeUnmarshaller.GetInstance().Unmarshall(context); - } - - - - - - Wrap an XmlTextReader with state for event-based parsing of an XML stream. - - Stream with the XML from a service response. - If set to true, maintains a copy of the complete response body constraint to log response size as the stream is being read. - Response data coming back from the request - If set to true, maintains a copy of the complete response body as the stream is being read. - - - - The current XML path that is being unmarshalled. - - - - - Returns the element depth of the parser's current position in the XML - document being parsed. - - - - - Reads to the next node in the XML document, and updates the context accordingly. - - - True if a node was read, false if there are no more elements to read./ - - - - - Returns the text contents of the current element being parsed. - - - The text contents of the current element being parsed. - - - - - True if NodeType is Element. - - - - - True if NodeType is EndElement. - - - - - True if the context is at the start of the document. - - - - - True if NodeType is Attribute. - - - - - Wrap an XmlTextReader with state for event-based parsing of an XML stream. - - Stream with the XML from a service response. - If set to true, maintains a copy of the complete response body constraint to log response size as the stream is being read. - Response data coming back from the request - If set to true, maintains a copy of the complete response body as the stream is being read. - - - - RequestId value, if found in response - - - - - Reads to the next node in the XML document, and updates the context accordingly. - If node is RequestId, reads the contents and stores in RequestId property. - - - True if a node was read, false if there are no more elements to read./ - - - - - A stream which caches the contents of the underlying stream as it reads it. - - - - - All the bytes read by the stream. - - - - - All the bytes read by the stream constrained with _cacheLimit - - - - - Initializes the CachingWrapperStream with a base stream. - - The stream to be wrapped. - Maximum number of bytes to be cached. - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Gets a value indicating whether the current stream supports seeking. - CachingWrapperStream does not support seeking, this will always be false. - - - - - Gets or sets the position within the current stream. - CachingWrapperStream does not support seeking, attempting to set Position - will throw NotSupportedException. - - - - - Sets the position within the current stream. - CachingWrapperStream does not support seeking, attempting to call Seek - will throw NotSupportedException. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Stream wrapper that double-buffers from a wrapped stream and - returns the buffered content as a series of signed 'chunks' - for the AWS4 ('Signature V4') protocol. - - - - - Reads some or all of the processed chunk to the consumer, constructing - and streaming a new chunk if more input data is available. - - - - - - - - - Attempt to read sufficient data for a whole chunk from the wrapped stream, - returning the number of bytes successfully read to be processed into a chunk - - - - - Results of the header-signing portion of the request - - - - - Computed signature of the chunk prior to the one in-flight, in - hex - - - - - Computes the derived signature for a chunk of data of given length in the input buffer, - placing a formatted chunk with headers, signature and data into the output buffer - ready for streaming back to the consumer. - - - - - - Length override to return the true length of the payload plus the metainfo - supplied with each chunk - - - - - Computes the total size of the data payload, including the chunk metadata. - Called externally so as to be able to set the correct Content-Length header - value. - - - - - - - Computes the size of the header data for each chunk. - - - - - - - Attempt to read sufficient data for a whole chunk from the wrapped stream, - returning the number of bytes successfully read to be processed into a chunk - - - - - A list object that will always be sent to AWS services, - even if it is empty. - The AWS .NET SDK does not send empty collections to services, unless - the collection is of this type. - - - - - - A dictionary object that will always be sent to AWS services, - even if it is empty. - The AWS .NET SDK does not send empty collections to services, unless - the collection is of this type. - - - - - - - Class to perform actions on a background thread. - Uses a single background thread and performs actions - on it in the order the data was sent through the instance. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Class to invoke actions on a background thread. - Uses a single background thread and invokes actions - on it in the order they were invoked through the instance. - - - - - PCL doesn't have IPAddress. These methods are copied from the Microsoft source code. - - - - - Returns true if the Content is set or there are - query parameters. - - This request - True if data is present; false otherwise. - - - - Utilities for dealing with Guids - - - - - Hashes a set of objects. - - - - - - - Combines a set of hashses. - - - - - - - Combines two hashes. - - - - - - - - Disposes of all managed and unmanaged resources. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - A wrapper stream that calculates a hash of the base stream as it - is being read. - The calculated hash is only available after the stream is closed or - CalculateHash is called. After calling CalculateHash, any further reads - on the streams will not change the CalculatedHash. - If an ExpectedHash is specified and is not equal to the calculated hash, - Close or CalculateHash methods will throw an AmazonClientException. - If CalculatedHash is calculated for only the portion of the stream that - is read. - - - Exception thrown during Close() or CalculateHash(), if ExpectedHash is set and - is different from CalculateHash that the stream calculates, provided that - CalculatedHash is not a zero-length byte array. - - - - - Algorithm to use to calculate hash. - - - - - True if hashing is finished and no more hashing should be done; - otherwise false. - - - - - Current position in the stream. - - - - - Calculated hash for the stream. - This value is set only after the stream is closed. - - - - - Expected hash value. Compared against CalculatedHash upon Close(). - If the hashes are different, an AmazonClientException is thrown. - - - - - Expected length of stream. - - - - - Initializes an HashStream with a hash algorithm and a base stream. - - Stream to calculate hash for. - - Expected hash. Will be compared against calculated hash on stream close. - Pass in null to disable check. - - - Expected length of the stream. If the reading stops before reaching this - position, CalculatedHash will be set to empty array. - - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Asynchronously reads a sequence of bytes from the current stream, advances - the position within the stream by the number of bytes read, and monitors - cancellation requests. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous read operation. The value of the TResult - parameter contains the total number of bytes read into the buffer. This can be - less than the number of bytes requested if that many bytes are not currently - available, or zero (0) if the end of the stream has been reached. - - - - - Gets a value indicating whether the current stream supports seeking. - HashStream does not support seeking, this will always be false. - - - - - Gets or sets the position within the current stream. - HashStream does not support seeking, attempting to set Position - will throw NotSupportedException. - - - - - Sets the position within the current stream. - HashStream does not support seeking, attempting to call Seek - will throw NotSupportedException. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Gets the overridden length used to construct the HashStream - - - - - Calculates the hash for the stream so far and disables any further - hashing. - - - - - Resets the hash stream to starting state. - Use this if the underlying stream has been modified and needs - to be rehashed without reconstructing the hierarchy. - - - - - Validates the underlying stream. - - - - - Compares two hashes (arrays of bytes). - - Expected hash. - Actual hash. - - True if the hashes are identical; otherwise false. - - - - - A wrapper stream that calculates a hash of the base stream as it - is being read or written. - The calculated hash is only available after the stream is closed or - CalculateHash is called. After calling CalculateHash, any further reads - on the streams will not change the CalculatedHash. - If an ExpectedHash is specified and is not equal to the calculated hash, - Close or CalculateHash methods will throw an AmazonClientException. - If base stream's position is not 0 or HashOnReads is true and the entire stream is - not read, the CalculatedHash will be set to an empty byte array and - comparison to ExpectedHash will not be made. - - - Exception thrown during Close() or CalculateHash(), if ExpectedHash is set and - is different from CalculateHash that the stream calculates, provided that - CalculatedHash is not a zero-length byte array. - - - - - Initializes an HashStream with a hash algorithm and a base stream. - - Stream to calculate hash for. - - Expected hash. Will be compared against calculated hash on stream close. - Pass in null to disable check. - - - Expected length of the stream. If the reading stops before reaching this - position, CalculatedHash will be set to empty array. - - - - - A wrapper stream that calculates an MD5 hash of the base stream as it - is being read or written. - The calculated hash is only available after the stream is closed or - CalculateHash is called. After calling CalculateHash, any further reads - on the streams will not change the CalculatedHash. - If an ExpectedHash is specified and is not equal to the calculated hash, - Close or CalculateHash methods will throw an AmazonClientException. - If base stream's position is not 0 or HashOnReads is true and the entire stream is - not read, the CalculatedHash will be set to an empty byte array and - comparison to ExpectedHash will not be made. - - - Exception thrown during Close() or CalculateHash(), if ExpectedHash is set and - is different from CalculateHash that the stream calculates, provided that - CalculatedHash is not a zero-length byte array. - - - - - Initializes an MD5Stream with a base stream. - - Stream to calculate hash for. - - Expected hash. Will be compared against calculated hash on stream close. - Pass in null to disable check. - - - Expected length of the stream. If the reading stops before reaching this - position, CalculatedHash will be set to empty array. - - - - - Utilities for validating label values for host prefix templates - - - - - Validates a label value - - - - - Simple wrapper around the log4net Error method. - - - - - - - - Write debug message to Console - - - - - - - - Write debug message to Console - - - - - - - Simple wrapper around the log4net InfoFormat method. - - - - - - - This is a dynamic wrapper around log4net so we can avoid log4net being required - to be distributed with the SDK. - - - - - Abstract logger class, base for any custom/specific loggers. - - - - - Flushes the logger contents. - - - - - Simple wrapper around the log4net IsErrorEnabled property. - - - - - Simple wrapper around the log4net IsDebugEnabled property. - - - - - Simple wrapper around the log4net IsInfoEnabled property. - - - - - Simple wrapper around the log4net Error method. - - - - - - - - Simple wrapper around the log4net Debug method. - - - - - - - - Simple wrapper around the log4net DebugFormat method. - - - - - - - Simple wrapper around the log4net InfoFormat method. - - - - - - - Logger wrapper for reflected log4net logging methods. - - - - - This should be a one time call to use reflection to find all the types and methods - needed for the logging API. - - - - - Simple wrapper around the log4net IsErrorEnabled property. - - - - - Simple wrapper around the log4net Error method. - - - - - - - - Simple wrapper around the log4net IsDebugEnabled property. - - - - - Simple wrapper around the log4net Debug method. - - - - - - - - Simple wrapper around the log4net DebugFormat method. - - - - - - - Simple wrapper around the log4net IsInfoEnabled property. - - - - - Simple wrapper around the log4net InfoFormat method. - - - - - - - A single logged message - - - - - Log message arguments. - - - - - Culture-specific formatting provider. - - - - - Log message format. - - - - - a size-limited cache of key value pairs - - Once the maximum size has been reached, the least recently - used pairs will be evicted to make room for any new items. - - - - - - - the maximum number of entries this LruCache will hold - before items begin getting evicted - - - - - the number of items in the cache - - - - - Construct a new LruCache. - - maximum number of entries before items are evicted - - - - Add the key/value pair to the cache, or update - the value if the key already exists. - - If the cache is full, evicts the least recently used item. - - - - - - - Evicts a specific key out of the cache if it exists - - the key to evict from the cache - - - - Try to get the value associated with the key. - - the key to look up - the value, if the key exists - true if there is a value associated with the key, or false if no value is associated with the key - - - - Try to get the value associated with the key, if it doesn't exist, use the provided factory method to - create a new value and tries adding it to the cache. - - the key to look up - the factory method used in case the key is not present in the cache - the looked up value or the value created by the factory - - - - Clear the LruCache of all entries. - - - - - Helper class to support LruCache. - Does not implement the error checking and synchronization that - would be necessary for it to stand alone. - - - - - Item to be stored in the LruList - linked list structure. - - - - - Collection of properties being tracked - - - - - Timings for metrics being tracked - - - - - Counters being tracked - - - - - Whether metrics are enabled for the request - - - - - Constructs an empty, disabled metrics object - - - - - Starts timing an event. Logs an exception if an event - of the same type was started but not stopped. - - - - - - - Stops timing an event. Logs an exception if the event wasn't started. - - - - - - - Adds a property for a metric. If there are multiple, the - object is added as a new item in a list. - - - - - - - Sets a counter for a specific metric. - - - - - - - Increments a specific metric counter. - If counter doesn't exist yet, it is set to 1. - - - - - - Returns errors associated with the metric, including - if there are still any timing events in-flight. - - - - - - Returns a string representation of the current metrics. - - - - - - Return a JSON represenation of the current metrics - - - - - - Timing information for a metric - - - - - Empty, stopped timing object - - - - - Timing object in a started state - - - - - - Stops timing - - - - - - Whether the timing has been stopped - - - - - Elapsed ticks from start to stop. - If timing hasn't been stopped yet, returns 0. - - - - - Elapsed time from start to stop. - If timing hasn't been stopped yet, returns TimeSpan.Zero - - - - - Timing event, stops timing of a metric when disposed - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - The destructor for the client class. - - - - - A wrapper stream which supresses disposal of the underlying stream. - - - - - Constructor for NonDisposingWrapperStream. - - The base stream to wrap. - - - - The Dispose implementation for this wrapper stream - does not close the underlying stream. - - - - - This class is used to wrap a stream for a particular segment of a stream. It - makes that segment look like you are reading from beginning to end of the stream. - - - - - Asynchronously reads a sequence of bytes from the current stream, advances - the position within the stream by the number of bytes read, and monitors - cancellation requests. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous read operation. The value of the TResult - parameter contains the total number of bytes read into the buffer. This can be - less than the number of bytes requested if that many bytes are not currently - available, or zero (0) if the end of the stream has been reached. - - - - - Asynchronously writes a sequence of bytes to the current stream and advances the - current position within this stream by the number of bytes written. - - - An array of bytes. This method copies count bytes from buffer to the current stream. - - - The zero-based byte offset in buffer at which to begin copying bytes to the - current stream. - - The number of bytes to be written to the current stream. - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - A task that represents the asynchronous write operation. - - - - Wrapper stream that only supports reading - - - - - Asynchronously clears all buffers for this stream and causes any buffered data - to be written to the underlying device. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous flush operation. - - - - - Asynchronously writes a sequence of bytes to the current stream and advances the - current position within this stream by the number of bytes written. - - - An array of bytes. This method copies count bytes from buffer to the current stream. - - - The zero-based byte offset in buffer at which to begin copying bytes to the - current stream. - - The number of bytes to be written to the current stream. - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - A task that represents the asynchronous write operation. - - - - Partial wrapper stream that only supports reading - - - - - Uri wrapper that can parse out information (bucket, key, region, style) from an - S3 URI. - - - - - True if the URI contains the bucket in the path, false if it contains the bucket in the authority. - - - - - The bucket name parsed from the URI (or null if no bucket specified). - - - - - The key parsed from the URI (or null if no key specified). - - - - - The region parsed from the URI (or null if no region specified). - - - - - Constructs a parser for the S3 URI specified as a string. - - The S3 URI to be parsed. - - - - Constructs a parser for the S3 URI specified as a Uri instance. - - The S3 URI to be parsed. - - - - Percent-decodes the given string, with a fast path for strings that are not - percent-encoded. - - The string to decode - The decoded string - - - - Percent-decodes the given string. - - The string to decode - The index of the first '%' in the string - The decoded string - - - - Decodes the percent-encoded character at the given index in the string - and appends the decoded value to the string under construction. - - - The string under construction to which the decoded character will be - appended. - - The string being decoded. - The index of the '%' character in the string. - - - - Converts a hex character (0-9A-Fa-f) into its corresponding quad value. - - The hex character - The quad value - - - - Interface for a non-generic cache. - - - - - Clears the entire cache. - - - - - Maximum time to keep an item around after its last use. - - - - - How often should the cache be cleared of old items. - - - - - The number of items in the cache. - - - - - Interface for a generic cache. - - - - - - - Retrieves a value out of the cache or from the source. - - - - - - - - Retrieves a value out of the cache or from the source. - If the item was in the cache, isStaleItem is set to true; - otherwise, if the item comes from the source, isStaleItem is false. - - - - - - - - - Clears a specific value from the cache if it's there. - - - - - - Returns the keys for all items in the cache. - - - - - - Executes specified operation, catches exception, clears the cache for - the given key, retries the operation. - - - - - - - - - - - SDK-wide cache. - Provides access to caches specific to a particular set of credentials - and target region. - - - - - Clear all caches - - - - - Clear all caches of a particular type - - - - - - Retrieve a cache of a specific type for a client object. - The client object can be null in cases where a cache does - not correspond to a specific AWS account or target region. - - - - - - - - - - - Retrieve a cache of a specific type for a client object. - The client object can be null in cases where a cache does - not correspond to a specific AWS account or target region. - - - - - - - - - - - Utilities for converting objects to strings. Used by the marshaller classes. - - - - - Converts a DateTime to ISO8601 formatted string. - - - - - Converts a DateTime to RFC822 formatted string. - - - - - Converts a DateTime to Unix epoch time formatted string. - - - - - A wrapper stream. - - - - - Base stream. - - - - - Initializes WrapperStream with a base stream. - - - - - - Returns the first base non-WrapperStream. - - First base stream that is non-WrapperStream. - - - - Returns the first base non-WrapperStream. - - First base stream that is non-WrapperStream. - - - - Returns the first base non-WrapperStream. - - Potential WrapperStream - Base non-WrapperStream. - - - - Gets a value indicating whether the current stream supports reading. - True if the stream supports reading; otherwise, false. - - - - - Gets a value indicating whether the current stream supports seeking. - True if the stream supports seeking; otherwise, false. - - - - - Gets a value indicating whether the current stream supports writing. - True if the stream supports writing; otherwise, false. - - - - - Closes the current stream and releases any resources (such as sockets and - file handles) associated with the current stream. - - - - - Gets the length in bytes of the stream. - - - - - Gets or sets the position within the current stream. - - - - - Gets or sets a value, in miliseconds, that determines how long the stream - will attempt to read before timing out. - - - - - Gets or sets a value, in miliseconds, that determines how long the stream - will attempt to write before timing out. - - - - - Clears all buffers for this stream and causes any buffered data to be written - to the underlying device. - - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Sets the position within the current stream. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Sets the length of the current stream. - - The desired length of the current stream in bytes. - - - - Writes a sequence of bytes to the current stream and advances the current - position within this stream by the number of bytes written. - - - An array of bytes. This method copies count bytes from buffer to the current stream. - - - The zero-based byte offset in buffer at which to begin copying bytes to the - current stream. - - The number of bytes to be written to the current stream. - - - - Asynchronously clears all buffers for this stream and causes any buffered data - to be written to the underlying device. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous flush operation. - - - - - Asynchronously reads a sequence of bytes from the current stream, advances - the position within the stream by the number of bytes read, and monitors - cancellation requests. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous read operation. The value of the TResult - parameter contains the total number of bytes read into the buffer. This can be - less than the number of bytes requested if that many bytes are not currently - available, or zero (0) if the end of the stream has been reached. - - - - - Asynchronously writes a sequence of bytes to the current stream and advances the - current position within this stream by the number of bytes written. - - - An array of bytes. This method copies count bytes from buffer to the current stream. - - - The zero-based byte offset in buffer at which to begin copying bytes to the - current stream. - - The number of bytes to be written to the current stream. - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - A task that represents the asynchronous write operation. - - - - This is a utility class to be used in last resort for code paths that are synchronous but need to call an asynchronous method. - This should never be used for methods that are called at high volume as this utility class has a performance cost. For example this - class was added for the refreshing credentials like Cognito which would need to use this about once an hour. - - - - - Custom WebProxy implementation that creates a webproxy based on - user inputs(Host name and port number) - - - - - Set the ProxyUri - - - - - Create a Uri based on the user inputs(Host name and port number) - - - - - Proxy Uri property - - - - - Proxy Credentials property - - - - - Getter to fetch the set proxy - - - - - Method to determine if the proxy should be bypassed when accessing an internet source - - - - - Error is always enabled - - - - - Debug logging is always enabled - - - - - Info logging is always enabled - - - - - Prints the Log With Error Level - - - - - - - - Prints the Log with Debug Level - - - - - - - - Prints the Log with Debug Level - - - - - - - Prints the Log With Info Level - - - - - - - Logger wrapper for Console.WriteLine() - - - - - Simple wrapper around the log4net IsErrorEnabled property. - - - - - Simple wrapper around the log4net Error method. - - - - - - - - Simple wrapper around the log4net IsDebugEnabled property. - - - - - Simple wrapper around the log4net Debug method. - - - - - - - - Simple wrapper around the log4net DebugFormat method. - - - - - - - Simple wrapper around the log4net IsInfoEnabled property. - - - - - Simple wrapper around the log4net InfoFormat method. - - - - - - - This class is no longer used anymore and should be avoided as it is just meant - as a last resort when blending async and sync operations. The code is still - here to support versions before 3.3.9.0 of AWSSDK.DynamoDBv2. - - - - - Property to denote that the last exception returned by an AWS Service - was retryable or not. - - - - - An abstract pipeline handler that has implements IPipelineHandler, - and has the default implmentation. This is the base class for most of - the handler implementations. - - - - - The logger used to log messages. - - - - - The inner handler which is called after the current - handler completes it's processing. - - - - - The outer handler which encapsulates the current handler. - - - - - Contains the processing logic for a synchronous request invocation. - This method calls InnerHandler.InvokeSync to continue processing of the - request by the pipeline. - - The execution context which contains both the - requests and response context. - - - - Contains the processing logic for an asynchronous request invocation. - This method calls InnerHandler.InvokeSync to continue processing of the - request by the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Logs the metrics for the current execution context. - - The execution context, it contains the - request and response context. - - - - A runtime pipeline contains a collection of handlers which represent - different stages of request and response processing. - - - - - The top-most handler in the pipeline. - - - - - Constructor for RuntimePipeline. - - The handler with which the pipeline is initalized. - - - - Constructor for RuntimePipeline. - - List of handlers with which the pipeline is initalized. - - - - Constructor for RuntimePipeline. - - List of handlers with which the pipeline is initalized. - The logger used to log messages. - - - - Constructor for RuntimePipeline. - - The handler with which the pipeline is initalized. - The logger used to log messages. - - - - Invokes the pipeline synchronously. - - Request context - Response context - - - - Invokes the pipeline asynchronously. - - Request context - Response context - - - - Adds a new handler to the top of the pipeline. - - The handler to be added to the pipeline. - - - - Adds a handler after the first instance of handler of type T. - - Type of the handler after which the given handler instance is added. - The handler to be added to the pipeline. - - - - Adds a handler before the first instance of handler of type T. - - Type of the handler before which the given handler instance is added. - The handler to be added to the pipeline. - - - - Removes the first occurance of a handler of type T. - - Type of the handler which will be removed. - - - - Replaces the first occurance of a handler of type T with the given handler. - - Type of the handler which will be replaced. - The handler to be added to the pipeline. - - - - Inserts the given handler after current handler in the pipeline. - - Handler to be inserted in the pipeline. - Handler after which the given handler is inserted. - - - - Gets the innermost handler by traversing the inner handler till - it reaches the last one. - - - - - Retrieves a list of handlers, in the order of their execution. - - Handlers in the current pipeline. - - - - Retrieves current handlers, in the order of their execution. - - Handlers in the current pipeline. - - - - This handler processes exceptions thrown from the HTTP handler and - unmarshalls error responses. - - - - - Default set of exception handlers. - - - - - Default set of exception handlers. - - - - - Constructor for ErrorHandler. - - an ILogger instance. - - - - Handles and processes any exception thrown from underlying handlers. - - The execution context which contains both the - requests and response context. - - - - Handles and processes any exception thrown from underlying handlers. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Disposes the response body. - - The response context. - - - - Processes an exception by invoking a matching exception handler - for the given exception. - - The execution context, it contains the - request and response context. - The exception to be processed. - - This method returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception that may be thrown by exception - processing by a matching exception handler. - - - - - The abstract base class for exception handlers. - - The exception type. - - - - The exception handler for HttpErrorResponseException exception. - - - - - The constructor for HttpErrorResponseExceptionHandler. - - in instance of ILogger. - - - - Handles an exception for the given execution context. - - The execution context, it contains the - request and response context. - The exception to handle. - - Returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception to replace the original exception. - - - - - Checks if a HTTP 404 status code is returned which needs to be suppressed and - processes it. - If a suppressed 404 is present, it unmarshalls the response and returns true to - indicate that a suppressed 404 was processed, else returns false. - - The execution context, it contains the - request and response context. - - - If a suppressed 404 is present, returns true, else returns false. - - - - - A pipeline handler which provides hooks to run - external code in the pre-invoke and post-invoke phases. - - - - - Action to execute on the pre invoke phase. - - - - - Action to execute on the post invoke phase. - - - - - Calls the PreInvoke and PostInvoke methods before and after calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls the PreInvoke and PostInvoke methods before and after calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Executes the OnPreInvoke action as part of pre-invoke. - - The execution context, it contains the - request and response context. - - - - Executes the OnPreInvoke action as part of post-invoke. - - The execution context, it contains the - request and response context. - - - - This handler retrieved the AWS credentials to be used for the current call. - - - - - The constructor for CredentialsRetriever. - - An AWSCredentials instance. - - - - Retrieves the credentials to be used for the current call before - invoking the next handler. - - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - This handler resolves the endpoint to be used for the current request. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Resolves the endpoint to be used for the current request - before invoking the next handler. - - The execution context, it contains the - request and response context. - - - - This handler resolves the endpoint to be used for the current request. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Resolves the endpoint to be used for the current request - before invoking the next handler. - - The execution context, it contains the - request and response context. - - - - Determines the endpoint for the request. - - The request context. - - - - - This handler provides an OnError action that can be used as hook for - external code to handle exceptions in the runtime pipeline. - - - - - Action to execute if an exception occurs during the - execution of any underlying handlers. - - - - - Executes the OnError action if an exception occurs during the - execution of any underlying handlers. - - - - - - - This handler marshalls the request before calling invoking the next handler. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Marshalls the request before calling invoking the next handler. - - The execution context, it contains the - request and response context. - - - - This handler manages the metrics used to time the complete call and - logs the final metrics. - - - - - Captures the overall execution time and logs final metrics. - - The execution context which contains both the - requests and response context. - - - - Captures the overall execution time and logs final metrics. - - The response type for the current request. - - The execution context, it contains the request and response context. - - A task that represents the asynchronous operation. - - - - This handler processes HTTP redirects and reissues the call to the - redirected location. - - - - - Processes HTTP redirects and reissues the call to the - redirected location. - - The execution context which contains both the - requests and response context. - - - - Processes HTTP redirects and reissues the call to the - redirected location. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Checks if an HTTP 307 (temporary redirect) has occured and changes the - request endpoint to the redirected location. - - - The execution context, it contains the request and response context. - - - A boolean value that indicates if a redirect has occured. - - - - - This handler signs the request. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Signs the request before invoking the next handler. - - - The execution context, it contains the request and response context. - - - - - Determines if the request should be signed. - - The request context. - A boolean value that indicated if the request should be signed. - - - - Signs the request. - - The request context. - - - - This handler unmarshalls the HTTP response. - - - - - The constructor for Unmarshaller. - - - Boolean value which indicated if the unmarshaller - handler supports response logging. - - - - - Unmarshalls the response returned by the HttpHandler. - - The execution context which contains both the - requests and response context. - - - - Unmarshalls the response returned by the HttpHandler. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Unmarshalls the HTTP response. - - - The execution context, it contains the request and response context. - - - - - Unmarshalls the HTTP response. - - - The execution context, it contains the request and response context. - - - - - The HTTP handler contains common logic for issuing an HTTP request that is - independent of the underlying HTTP infrastructure. - - - - - - The sender parameter used in any events raised by this handler. - - - - - The constructor for HttpHandler. - - The request factory used to create HTTP Requests. - The sender parameter used in any events raised by this handler. - - - - Issues an HTTP request for the current request context. - - The execution context which contains both the - requests and response context. - - - - Issues an HTTP request for the current request context. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Determines the content for request body and uses the HTTP request - to write the content to the HTTP request body. - - Content to be written. - The HTTP request. - The request context. - - - - Creates the HttpWebRequest and configures the end point, content, user agent and proxy settings. - - The async request. - The web request that actually makes the call. - - - - Disposes the HTTP handler. - - - - - The default implementation of the adaptive retry policy. - - - The default implementation of the adaptive policy. - - - - - Constructor for AdaptiveRetryPolicy. - - The maximum number of retries before throwing - back a exception. This does not count the initial request. - - - - Constructor for AdaptiveRetryPolicy. - - The Client config object. This is used to - retrieve the maximum number of retries before throwing - back a exception(This does not count the initial request) and - the service URL for the request. - - - - OnRetry is called when a retry request is initiated to determine if the request will be retried. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - true if the error that will be retried is a throtting error - True if retry throttling is disabled or retry throttling is enabled and capacity can be obtained. - - - - This method uses a token bucket to enforce the maximum sending rate. - - The execution context which contains both the - requests and response context. - If the prior request failed, this exception is expected to be - the exception that occurred during the prior request failure. - - - - Virtual method that gets called on a success Response. If its a retry success response, the entire - retry acquired capacity is released(default is 5). If its just a success response a lesser value capacity - is released(default is 1). - - Request context containing the state of the request. - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - This method uses a token bucket to enforce the maximum sending rate. - - The execution context which contains both the - requests and response context. - If the prior request failed, this exception is expected to be - the exception that occurred during the prior request failure. - - - - The default implementation of the legacy retry policy. - - - The default implementation of the legacy retry policy. - - - - - The maximum value of exponential backoff in milliseconds, which will be used to wait - before retrying a request. The default is 30000 milliseconds. - - - - - Constructor for DefaultRetryPolicy. - - The maximum number of retries before throwing - back a exception. This does not count the initial request. - - - - Constructor for DefaultRetryPolicy. - - The Client config object. This is used to - retrieve the maximum number of retries before throwing - back a exception(This does not count the initial request) and - the service URL for the request. - - - - Returns true if the request is in a state where it can be retried, else false. - - Request context containing the state of the request. - Returns true if the request is in a state where it can be retried, else false. - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - true if the error that will be retried is a throtting error - - - - Virtual method that gets called on a success Response. If its a retry success response, the entire - retry acquired capacity is released(default is 5). If its just a success response a lesser value capacity - is released(default is 1). - - Request context containing the state of the request. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Request context containing the state of the request. - Return true if the request should be retried. - - - - Checks if the retry limit is reached. - - Request context containing the state of the request. - Return false if the request can be retried, based on number of retries. - - - - Waits before retrying a request. The default policy implements a exponential backoff. - - Request context containing the state of the request. - - - - Waits for an amount of time using an exponential backoff algorithm. - - The request retry index. The first request is expected to be 0 while - the first retry will be 1. - The max number of milliseconds to wait - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - The retry handler has the generic logic for retrying requests. - It uses a retry policy which specifies when - a retry should be performed. - - - - - The logger used to log messages. - - - - - The retry policy which specifies when - a retry should be performed. - - - - - Constructor which takes in a retry policy. - - Retry Policy - - - - Invokes the inner handler and performs a retry, if required as per the - retry policy. - - The execution context which contains both the - requests and response context. - - - - Invokes the inner handler and performs a retry, if required as per the - retry policy. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Prepares the request for retry. - - Request context containing the state of the request. - - - - The default implementation of the standard retry policy. - - - The default implementation of the standard policy. - - - - - The maximum value of exponential backoff in milliseconds, which will be used to wait - before retrying a request. The default is 20000 milliseconds. - - - - - Constructor for StandardRetryPolicy. - - The maximum number of retries before throwing - back a exception. This does not count the initial request. - - - - Constructor for StandardRetryPolicy. - - The Client config object. This is used to - retrieve the maximum number of retries before throwing - back a exception(This does not count the initial request) and - the service URL for the request. - - - - Returns true if the request is in a state where it can be retried, else false. - - Request context containing the state of the request. - Returns true if the request is in a state where it can be retried, else false. - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - true if the error that will be retried is a throtting error - - - - Virtual method that gets called on a success Response. If its a retry success response, the entire - retry acquired capacity is released(default is 5). If its just a success response a lesser value capacity - is released(default is 1). - - Request context containing the state of the request. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Request context containing the state of the request. - Return true if the request should be retried. - - - - Checks if the retry limit is reached. - - Request context containing the state of the request. - Return false if the request can be retried, based on number of retries. - - - - Waits before retrying a request. The default policy implements a exponential backoff with - jitter algorithm. - - Request context containing the state of the request. - - - - Waits for an amount of time using an exponential backoff with jitter algorithm. - - The request retry index. The first request is expected to be 0 while - the first retry will be 1. - The max number of milliseconds to wait - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - This class is the base class of all the configurations settings to connect - to a service. - - - This class is the base class of all the configurations settings to connect - to a service. - - - - - Gets Service Version - - - - - Gets and sets of the signatureMethod property. - - - - - Gets and sets of the SignatureVersion property. - - Note: This property exists for backward compatibility but is no longer - used by any service other than S3. - - - - - Gets and sets of the UserAgent property. - - - - - Gets and sets the RegionEndpoint property. The region constant that - determines the endpoint to use. - - Setting this property to null will force the SDK to recalculate the - RegionEndpoint value based on App/WebConfig, environment variables, - profile, etc. - - - - - The constant used to lookup in the region hash the endpoint. - - - - - Gets and sets of the ServiceURL property. - This is an optional property; change it - only if you want to try a different service - endpoint. - - - - - Gets and sets the UseHttp. - If this property is set to true, the client attempts - to use HTTP protocol, if the target endpoint supports it. - By default, this property is set to false. - - - - - Given this client configuration, return a string form ofthe service endpoint url. - - - - - Gets and sets the AuthenticationRegion property. - Used in AWS4 request signing, this is an optional property; - change it only if the region cannot be determined from the - service endpoint. - - - - - Gets and sets the AuthenticationServiceName property. - Used in AWS4 request signing, this is the short-form - name of the service being called. - - - - - Returns the flag indicating how many retry HTTP requests an SDK should - make for a single SDK operation invocation before giving up. This flag will - return 4 when the RetryMode is set to "Legacy" which is the default. For - RetryMode values of "Standard" or "Adaptive" this flag will return 2. In - addition to the values returned that are dependant on the RetryMode, the - value can be set to a specific value by using the AWS_MAX_ATTEMPTS environment - variable, max_attempts in the shared configuration file, or by setting a - value directly on this property. When using AWS_MAX_ATTEMPTS or max_attempts - the value returned from this property will be one less than the value entered - because this flag is the number of retry requests, not total requests. To - learn more about the RetryMode property that affects the values returned by - this flag, see . - - - - - Determines if MaxErrorRetry has been manually set. - - - - - Gets and sets the LogResponse property. - If this property is set to true, the service response is logged. - The size of response being logged is controlled by the AWSConfigs.LoggingConfig.LogResponsesSizeLimit property. - - - - - Gets and sets the ReadEntireResponse property. - NOTE: This property does not effect response processing and is deprecated. - To enable response logging, the ClientConfig.LogResponse and AWSConfigs.LoggingConfig - properties can be used. - - - - - Gets and Sets the BufferSize property. - The BufferSize controls the buffer used to read in from input streams and write - out to the request. - - - - - - Gets or sets the interval at which progress update events are raised - for upload operations. By default, the progress update events are - raised at every 100KB of data transferred. - - - If the value of this property is set less than ClientConfig.BufferSize, - progress updates events will be raised at the interval specified by ClientConfig.BufferSize. - - - - - - Flag on whether to resign requests on retry or not. - For Amazon S3 and Amazon Glacier this value will always be set to true. - - - - - This flag controls if .NET HTTP infrastructure should follow redirection - responses (e.g. HTTP 307 - temporary redirect). - - - - - Flag on whether to log metrics for service calls. - - This can be set in the application's configs, as below: - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSLogMetrics" value"true"/> - </appSettings> - </configuration> - - - - - - Gets and sets the DisableLogging. If true logging for this client will be disabled. - - - - - Credentials to use with a proxy. - - - - - - If the value is set, the value is assigned to the Timeout property of the HttpWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Configures the endpoint calculation for a service to go to a dual stack (ipv6 enabled) endpoint - for the configured region. - - - Note: AWS services are enabling dualstack endpoints over time. It is your responsibility to check - that the service actually supports a dualstack endpoint in the configured region before enabling - this option for a service. - - - - - Enable or disable the Retry Throttling feature by setting the ThrottleRetries flag to True/False resepctively. - Retry Throttling is a feature that intelligently throttles retry attempts when a large precentage of requests - are failing and retries are unsuccessful as well. In such situations the allotted retry capacity for the service URL - will be drained until requests start to succeed again. Once the requisite capacity is available, retries would - be permitted again. When retries are throttled, the service enters a fail-fast behaviour as the traditional retry attempt - for the request would be circumvented. Hence, errors will resurface quickly. This will result in a greated number of exceptions - but prevents requests being tied up in unsuccessful retry attempts. - Note: Retry Throttling is enabled by default. Set the ThrottleRetries flag to false to switch off this feature. - - - - - Enable or disable the Nagle algorithm on the underlying http - client. - - This method is not intended to be called by consumers of the AWS SDK for .NET - - - - - - Performs validation on this config object. - Throws exception if any of the required values are missing/invalid. - - - - - Returns the current UTC now after clock correction for this endpoint. - - - - - The calculated clock skew correction for a specific endpoint, if there is one. - This field will be set if a service call resulted in an exception - and the SDK has determined that there is a difference between local - and server times. - - If is set to true, this - value will still be set to the correction, but it will not be used by the - SDK and clock skew errors will not be retried. - - - - - Gets and sets the DisableHostPrefixInjection flag. If true, host prefix injection will be disabled for this client, the default value of this flag is false. - Host prefix injection prefixes the service endpoint with request members from APIs which use this feature. - Example: for a hostPrefix of "foo-name." and a endpoint of "service.region.amazonaws.com" the default behavior is to - prefix the endpoint with the hostPrefix resulting in a final endpoint of "foo-name.service.region.amazonaws.com". Setting - DisableHostPrefixInjection to true will disable hostPrefix injection resulting in a final endpoint of - "service.region.amazonaws.com" regardless of the value of hostPrefix. E.g. You may want to disable host prefix injection for testing against a local mock endpoint. - - - - - Returns the flag indicating if endpoint discovery should be enabled or disabled for operations that are not required to use endpoint discovery. - - - - - Returns the maximum number of discovered endpoints that can be stored within the cache for the client. The default limit is 1000 cache entries. - - - - - Returns the flag indicating the current mode in use for request - retries and influences the value returned from . - The default value is RequestRetryMode.Legacy. This flag can be configured - by using the AWS_RETRY_MODE environment variable, retry_mode in the - shared configuration file, or by setting this value directly. - - - - - Under Adaptive retry mode, this flag determines if the client should wait for - a send token to become available or don't block and fail the request immediately - if a send token is not available. - - - - - Throw an exception if the boxed TimeSpan parameter doesn't have a value or is out of range. - - - - - Returns the request timeout value if its value is set, - else returns client timeout value. - - - - - - This is a switch used for performance testing and is not intended for production applications - to change. This switch may be removed in a future version of the SDK as the .NET Core platform matures. - - - If true, the HttpClient is cached and reused for every request made by the service client - and shared with other service clients. - - - For the .NET Core platform this is default to true because the HttpClient manages the connection - pool. - - - - - - If CacheHttpClient is set to true then HttpClientCacheSize controls the number of HttpClients cached. - - On Windows the default value is 1 since the underlying native implementation does not have throttling constraints - like the non Windows Curl based implementation. For non Windows based platforms the default is the value return from - System.Environment.ProcessorCount. - - - - - - Overrides the default read-write timeout value. - On Unity platform, this value is not used as Unity HTTP client does not support timeouts, so - - - - If the value is set, the value is assigned to the ReadWriteTimeout property of the HttpWebRequest object used - to send requests. - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Returns a WebProxy instance configured to match the proxy settings - in the client configuration. - - - - - Unpacks the host, port and any credentials info into the instance's - proxy-related fields. - Unlike the SetWebProxy implementation on .NET 3.5/4.5,the Host and the Port are not reconstructed from the - input proxyuri - - The proxy details - - - - Gets and sets of the ProxyHost property. - - - - - Gets and sets of the ProxyPort property. - - - - - - Returns true if the clients should be cached by HttpRequestMessageFactory, false otherwise. - - - - - - - Returns true if the SDK should dispose HttpClients after one use, false otherwise. - - - - - - - Create a unique string used for caching the HttpClient based on the settings that are used from the ClientConfig that are set on the HttpClient. - - - - - - - Determines if HttpClients created with the given IClientConfig should be cached at the SDK - client level, or cached globally. - - If there is no HttpClientFactory assigned and proxy or proxy credentials are set - this returns false because those properties can't be serialized as part of the key in the global http client cache. - - - - - Base class for constant class that holds the value that will be sent to AWS for the static constants. - - - - - Gets the value that needs to be used when send the value to AWS - - - - - Attempt to find correct-cased constant value using whatever cased value the user - has provided. This is primarily useful for mapping any-cased values from a CLI - tool to the specific casing required by the service, avoiding the need for the - user to (a) remember the specific case and (b) actually type it correctly. - - The properly cased service constant matching the value - - - - Utility class that stores clock skew information. - - - - - GlobalClockCorrection should be only set by AWSConfigs.ManualClockCorrection property - and is only available to maintain backward compatibilty. This should override any - endpoint specific clockskew correction. - - - - - Return clock skew correction value for an endpoint if there is one. - - AWSConfigs.ManualClockCorrection overrides globally any calculated service endpoint specific - clock correction value. - - Endpoint should in a form such as "https://s3" - Clock correction value for an endpoint in TimeSpan. TimeSpan.Zero if no such clock correction is set. - - - - Get clock skew corrected UTC now value. If ManualClockCorrection is set, - use ManualClockCorrection instead of endpoint specific clock correction value. - - - - - - - Probing mechanism to determine the endpoint discovery enabled value from various sources. - - - - - The valid hashing algorithm supported by the sdk for request signing. - - - - - Which end of a request was responsible for a service error response. - - - - - The sender was responsible for the error, i.e. the client - request failed validation or was improperly formatted. - - - - - The error occured within the service. - - - - - An unrecognized error type was returned. - - - - - Sts Regional Endpoints Value determines whether or not - to send the sts request to the regional endpoint or to - the global sts endpoint - - - - - Send the request to the global sts endpoint - if the region is a legacy global region - - - - - Send the request to the regional endpoint - - - - - S3 US East 1 endpoint value determines wheter or not - to send the us-east-1 s3 requests to the regional endpoint or to - the legacy global endpoint - - - - - Sends the requests to the legacy global s3 endpoint for us-east-1 - - - - - Sends the request to the regional s3 endpoint for us-east-1 - - - - - RetryMode determines which request retry mode is used for requests that do - not complete successfully. - - - - - Legacy request retry strategy. - - - - - Standardized request retry strategy that is consistent across all SDKs. - - - - - An experimental request retry strategy that builds on the Standard strategy - and introduces congestion control through client side rate limiting. - - - - - All Amazon service interfaces like IAmazonS3 extend from this interface. This allows all the - Amazon service interfaces be identified by this base interface and helps with generic constraints. - - - - - A readonly view of the configuration for the service client. - - - - - This interface is the read only access to the ClientConfig object used when setting up service clients. Once service clients - are initiated the config object should not be changed to avoid issues with using a service client in a multi threaded environment. - - - - - Gets the RegionEndpoint property. The region constant to use that - determines the endpoint to use. If this is not set - then the client will fallback to the value of ServiceURL. - - - - - The constant used to lookup in the region hash the endpoint. - - - - - Gets and sets of the ServiceURL property. - This is an optional property if you need to set a specific service URL - instead setting the region with the RegionEndpoint property. - - - - - Gets the UseHttp property. - If this property is set to true, the client attempts - to use HTTP protocol. - By default, this property is set to false. - - - - - Gets Service Version - - - - - Gets the signatureMethod property. - - - - - Gets the SignatureVersion property. - - Note: This property exists for backward compatibility but is no longer - used by any service other than S3. - - - - - Gets the AuthenticationRegion property. - Used in AWS4 request signing, this is an optional property; - change it only if the region cannot be determined from the - service endpoint. - - - - - Gets the AuthenticationServiceName property. - Used in AWS4 request signing, this is the short-form - name of the service being called. - - - - - Gets the UserAgent property. - - - - - Gets the DisableLogging. If true logging for this client will be disabled. - - - - - Flag on whether to log metrics for service calls. - - This can be set in the application's configs, as below: - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSLogMetrics" value"true"/> - </appSettings> - </configuration> - - - - - - Gets the LogResponse property. - If this property is set to true, the service response - is read in its entirety and logged. - - - - - Gets the ReadEntireResponse. - If this property is set to true, the service response - is read in its entirety before being processed. - - - - - This flag controls if .NET HTTP infrastructure should follow redirection - responses (e.g. HTTP 307 - temporary redirect). - - - - - Gets the BufferSize property. - The BufferSize controls the buffer used to read in from input streams and write - out to the request. - - - - - Returns the flag indicating how many retry HTTP requests an SDK should - make for a single SDK operation invocation before giving up. This flag will - return 4 when the RetryMode is set to "Legacy" which is the default. For - RetryMode values of "Standard" or "Adaptive" this flag will return 2. In - addition to the values returned that are dependant on the RetryMode, the - value can be set to a specific value by using the AWS_MAX_ATTEMPTS environment - variable, max_attempts in the shared configuration file, or by setting a - value directly on this property. When using AWS_MAX_ATTEMPTS or max_attempts - the value returned from this property will be one less than the value entered - because this flag is the number of retry requests, not total requests. To - learn more about the RetryMode property that affects the values returned by - this flag, see . - - - - - Determines if MaxErrorRetry has been manually set. - - - - - Gets the interval at which progress update events are raised - for upload operations. By default, the progress update events are - raised at every 100KB of data transferred. - - - - - Flag on whether to resign requests on retry or not. - - - - - Credentials to use with a proxy. - - - - - Gets the default request timeout value. - - - - If the value is set, the value is assigned to the Timeout property of the HTTPWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - - - - Configures the endpoint calculation for a service to go to a dual stack (ipv6 enabled) endpoint - for the configured region. - - - Note: AWS services are enabling dualstack endpoints over time. It is your responsibility to check - that the service actually supports a dualstack endpoint in the configured region before enabling - this option for a service. - - - - - Configures a flag enabling to either opt in or opt out of the retry throttling service. - Note: set value to true to enable retry throttling feature. The Default value for this flag is false. - - - - - Using either the RegionEndpoint or the ServiceURL determine what the URL to the service is. - - The URL to the service. - - - - Performs validation on this config object. - Throws exception if any of the required values are missing/invalid. - - The timeout specified is null. - - - - Returns the clock skew adjusted utc now. This value is affected by AWSConfigs.ManualClockCorrection - - - - - Returns the calculated clock skew value for this config's service endpoint. If AWSConfigs.CorrectForClockSkew is false, - this value won't be used to construct service requests. - - - - - Gets the DisableHostPrefixInjection flag. If true, host prefix injection will be disabled for this client, the default value of this flag is false. - Host prefix injection prefixes the service endpoint with request members from APIs which use this feature. - Example: for a hostPrefix of "foo-name." and a endpoint of "service.region.amazonaws.com" the default behavior is to - prefix the endpoint with the hostPrefix resulting in a final endpoint of "foo-name.service.region.amazonaws.com". Setting - DisableHostPrefixInjection to true will disable hostPrefix injection resulting in a final endpoint of - "service.region.amazonaws.com" regardless of the value of hostPrefix. E.g. You may want to disable host prefix injection for testing against a local mock endpoint. - - - - - Returns the flag indicating if endpoint discovery should be enabled or disabled for operations that are not required to use endpoint discovery. - - - - - Returns the maximum number of discovered endpoints that can be stored within the cache for the client. The default limit is 1000 cache entries. - - - - - Returns the flag indicating the current mode in use for request - retries and influences the value returned from . - The default value is RequestRetryMode.Legacy. This flag can be configured - by using the AWS_RETRY_MODE environment variable, retry_mode in the - shared configuration file, or by setting this value directly. - - - - - Under Adaptive retry mode, this flag determines if the client should wait for - a send token to become available or don't block and fail the request immediately - if a send token is not available. - - - - - - This is a switch used for performance testing and is not intended for production applications - to change. This switch may be removed in a future version of the SDK as the .NET Core platform matures. - - - If true, the HttpClient is cached and reused for every request made by the service client - and shared with other service clients. - - - For the .NET Core platform this is default to true because the HttpClient manages the connection - pool. - - - - - - If CacheHttpClient is set to true then HttpClientCacheSize controls the number of HttpClients cached. - - - - - Gets the ProxyHost property. - - - - - Gets the ProxyPort property. - - - - - Returns a WebProxy instance configured to match the proxy settings - in the client configuration. - - - - - - Interface for a single logged message. - - - - - Log message format. - - - - - Log message arguments. - - - - - Culture-specific formatting provider. - - - - - Abstract parameter value. - - - - - String parameter value. - - - - - String value of the parameter. - - - - - Constructs ParameterValue for a single string. - - - - - - String list parameter value. - - - - - List of strings value of the parameter. - - - - - Constructs ParameterValue for a list of strings. - - - - - - Metrics collected by the SDK on a per-request basis. - - - Each request made to an AWS service by the SDK can have metrics - collected and logged. This interface represents the collected - metrics for a request. The metrics include properties (i.e. request id - and other metadata), timings for each stage of the request, and counters. - - - - - Collection of properties being tracked - - - - - Timings for metrics being tracked - - - - - Counters being tracked - - - - - Whether metrics are enabled for the request - - - - - JSON representation of the current metrics - - JSON string - - - - Represents how long a phase of an SDK request took. - - - - - Whether the timing has been stopped - - - - - Elapsed ticks from start to stop. - If timing hasn't been stopped yet, returns 0. - - - - - Elapsed time from start to stop. - If timing hasn't been stopped yet, returns TimeSpan.Zero - - - - - User supplied type to perform metrics formatting. - - - - - Produce custom formatting for SDK metrics. - - - If defined, this method will be called for every request made by the SDK. - - An instance of IRequestMetrics produced by the SDK - formatted string representation of the metrics - - - - Predefined request metrics that are collected by the SDK. - - - - - Information about the request. - - - - - Gets and sets the RequestId property. - ID that uniquely identifies a request. Amazon keeps track of request IDs. If you have a question about a request, include the request ID in your correspondence. - - - - - This exception is thrown if there are problems signing the request. - - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - - - - Gets the percentage of transfer completed - - - - - Gets the number of bytes transferred since last event - - - - - Gets the number of bytes transferred - - - - - Gets the total number of bytes to be transferred - - - - - Returns a string representation of this object - - - - - - Anonymous credentials. - Using these credentials, the client does not sign the request. - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - AWS Credentials that automatically refresh by calling AssumeRole on - the Amazon Security Token Service. - - - - - The credentials of the user that will be used to call AssumeRole. - - - - - The Amazon Resource Name (ARN) of the role to assume. - - - - - An identifier for the assumed role session. - - - - - Options to be used in the call to AssumeRole. - - - - - Constructs an AssumeRoleAWSCredentials object. - - The credentials of the user that will be used to call AssumeRole. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - - - - Constructs an AssumeRoleAWSCredentials object. - - The credentials of the user that will be used to call AssumeRole. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRole. - - - - A unique identifier that is used by third parties when assuming roles in their customers' accounts. - - - - - An IAM policy in JSON format. - - - - - The length of time in seconds before the credentials will expire. - - - - - The identification number of the MFA device that is associated with the user who is making the assume-role call. - - - - - The value provided by the MFA device, if the trust policy of the role being assumed requires MFA. - - - - - A callback that's used to obtain the MFA token code when the AssumeRoleAWSCredentials are refreshed. - - - - - Immutable representation of AWS credentials obtained as a result of - authenticating with the AssumeRole method of the Security Token Service. - - - - - The expiry time of the credentials, obtained from the AssumeRoleResponse. - - - - - Constructs an instance with supplied keys, token, and expiration. - - The AccessKey for the credentials. - The SecretKey for the credentials. - The security token for the credentials. - The expiration time for the credentials. - - - - Get a copy of this AssumeRoleImmutableCredentials object. - - A copy of this object. - - - - Abstract class that represents a credentials object for AWS services. - - - - - Returns a copy of ImmutableCredentials - - - - - - Called by AmazonServiceClient to validate the credential state - on client construction. - - - - - Basic set of credentials consisting of an AccessKey and SecretKey - - - - - Constructs a BasicAWSCredentials object for the specified accessKey and secretKey. - - - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - Immutable representation of AWS credentials. - - - - - Gets the AccessKey property for the current credentials. - - - - - Gets the SecretKey property for the current credentials. - - - - - Gets the Token property for the current credentials. - - - - - Gets the UseToken property for the current credentials. - Specifies if Token property is non-emtpy. - - - - - Constructs an ImmutableCredentials object with supplied accessKey, secretKey. - - - - Optional. Can be set to null or empty for non-session credentials. - - - - Returns a copy of the current credentials. - - - - - - Abstract class for automatically refreshing AWS credentials - - - - - Refresh state container consisting of credentials - and the date of the their expiration - - - - - Represents the current state of the Credentials. - - This can be cleared without synchronization. - - - - Semaphore to control thread access to GetCredentialsAsync method. - The semaphore will allow only one thread to generate new credentials and - update the current state. - - - - - The time before actual expiration to expire the credentials. - Property cannot be set to a negative TimeSpan. - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - Test credentials existence and expiration time - should update if: - credentials have not been loaded yet - it's past the expiration time. At this point currentState.Expiration may - have the PreemptExpiryTime baked into to the expiration from a call to - UpdateToGeneratedCredentials but it may not if this is new application load. - - - - - When overridden in a derived class, generates new credentials and new expiration date. - - Called on first credentials request and when expiration date is in the past. - - - - - - When overridden in a derived class, generates new credentials and new expiration date. - - Called on first credentials request and when expiration date is in the past. - - - - - - Clears currently-stored credentials, forcing the next GetCredentials call to generate new credentials. - - - - - Immutable representation of AWS credentials obtained as a result of - authenticating against a SAML-supporting federated identity provider. - - - - - The expiry time of the credentials, obtained from the AssumeRoleWithSAML response. - - - - - The value of the NameID element in the Subject element of the SAML assertion, as returned in the - AssumeRoleWithSAML response from the Security Token Service. - - - - - Constructs an instance with supplied keys and SAML assertion data. - - - - - - - - - - Constructs an instance with supplied keys and SAML assertion data. - - - - - - - - Returns a copy of the current credentials. - - - - - - Serializes the instance to a json-format string for external storage - - The serialized object in json - - - - Instantiates an instance from persisted json data - - The serialized data - Deserialized instance corresponding to the json data - - - - Session credentials consisting of AccessKey, SecretKey and Token - - - - - Constructs a SessionAWSCredentials object for the specified accessKey, secretKey. - - - - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - Credentials that are retrieved from the Instance Profile service on an EC2 instance - - - - - Constructs a InstanceProfileAWSCredentials object for specific role - - Role to use - - - - Constructs a InstanceProfileAWSCredentials object for the first found role - - - - - Retrieves a list of all roles available through current InstanceProfile service - - InstanceProfileAWSCredentials is no longer supported in PCL. - - - - - - Superclass for Exceptions that come over the event stream, or to wrap other kinds of generic exceptions. - - - - - The numeric code identifier for the type of error. - - - - - Constructs an EventStreamError. - - - - - Constructs an EventStreamError. - - The error code. - The error message. - - - - Event args that contain an . - - The - - - - The EventStream Event. - - - - - Constructs an EventStreamEventReceivedArgs. - - The EventStream Event. - - - - Event args that contain an . - - The . - - - - The EventStream Exception. - - - - - Constructs an EventStreamExceptionReceivedArgs. - - The EventStream Exception. - - - - Supported Header types for vnd.amazon.event-stream - - - - - Name for the Header. Maximum of 255 bytes. - - - - - Header type id - - - - - Computes the amount of memory neccesary to serialize this Header. - - - - - Writes this Header to buffer starting at offset - Keep in mind, this API assumes buffer is large enough - for the operation. - - buffer to serialize this Header to - offset to begin writing at. - - the new offset. - - - - - Returns the current value as a bool - - - - - Sets the current value - - - - - Returns the current value as a byte - - - - - Sets the current value - - - - - Gets the current value as a 16 bit integer. (Host Order). - - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a 32 bit integer. (Host Order) - - - - - Sets the current value - - - - - returns the current value as a 64-bit integer. (Host Order) - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a byte buffer. - - - - - - Sets the current value. Max length is 2^15 - 1 - - - - - Returns the current value as a utf-8 string. - - - - - Sets the current value. Utf-8 encoded. Max byte size is 2^16 - 1 - - - - - Gets the current value as a DateTime. - Note: You do not need to compensate for unix epoch on this API. - - - - - - Sets the current value. - Note: You do not need to compensate for unix epoch on this API. - - - - - Returns the current value as a Guid (UUID) - - - - - Sets the current value - - - - - Header Data for an EventStreamMessage - - Each header is of format: - [name len] (1) | [utf-8 name] (v) - [type (1)] - [value (v)] - - - - - Name for the Header. Maximum of 255 bytes. - - - - - Header type id - - - - - Initializes this Header with name. - - utf-8 string, max length is 255 - - - - Deserializes the header in buffer. - - buffer constaining the header - index to start from in the buffer. - updated offset with new value for offset - - - - Writes this Header to buffer starting at offset - Keep in mind, this API assumes buffer is large enough - for the operation. - - buffer to serialize this Header to - offset to begin writing at. - - the new offset. - - - - - Computes the amount of memory neccesary to serialize this Header. - - - - - Returns the current value as a bool - - - - - Sets the current value - - - - - Returns the current value as a byte - - - - - Sets the current value - - - - - Gets the current value as a 16 bit integer. (Host Order). - - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a 32 bit integer. (Host Order) - - - - - Sets the current value - - - - - returns the current value as a 64-bit integer. (Host Order) - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a byte buffer. - - - - - - Sets the current value. Max length is 2^15 - 1 - - - - - Returns the current value as a utf-8 string. - - - - - Sets the current value. Utf-8 encoded. Max byte size is 2^16 - 1 - - - - - Gets the current value as a DateTime. - Note: You do not need to compensate for unix epoch on this API. - - - - - - Sets the current value. - Note: You do not need to compensate for unix epoch on this API. - - - - - Returns the current value as a Guid (UUID) - - - - - Sets the current value - - - - - Headers for the message. Can be null. - - - - - Payload for the message. Can be null. - - - - - Converts a message into a byte buffer (usually for network transmission). - - - - - Message is a single datagram. The format is as follows: - [ total length (4) ] | [ headers_length (4)] | [ prelude crc(4)] - [ headers (v)] - [ payload (v)} - [ trailing crc ] - - CRCs use the CRC32 algorithm. - - - - - Content type for EventStreams. - - - - - Headers for the message. Can be null. - - - - - Payload for the message. Can be null. - - - - - Initialize a message with headers and a payload. - - list of headers for the message, can be null. - payload for the message, can be null. - - - - Builds a message from buffer. - - buffer to read - offset to start reading - buffer length. - - parsed instance of EventStreamMessage. Doesn't return null, - does throw if CRCs don't match. - - - - - Converts a message into a byte buffer (usually for network transmission). - - - - - Defines exceptions that arise from an not conforming to specification. - - - - - Constructs an EventStreamValidationException. - - - - - Constructs an EventStreamValidationException. - - The exception message. - - - - Constructs an EventStreamValidationException. - - The exception message. - The inner exception. - - - - This exception is thrown if an exception is retrieved from the event stream and should be modeled, - but a generator function for the strongly-typed exception is not defined. - - - - - The exception type. - - - - - Constructs an EventStreamException. - - The exception type. - - - - The contract for the . - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - A subclass of that enables an enumerable interface for interacting with Events. - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - Flag if the stream was chosen to be enumerated. - - - - - A Stream of Events. Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treated as mutually exclusive. - - - - - A Stream of Events. Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treated as mutually exclusive. - - - - - Returns an enumerator that iterates through the collection. - - An enumerator that can be used to iterate through the collection. - - - - Returns an enumerator that iterates through a collection. - - An object that can be used to iterate through the collection. - - - - Starts the background thread to start reading events from the network stream. - - - - - The contract for the . - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - The size of the buffer for reading from the network stream. - - - - - Fires when an event is received. - - - - - Fired when an exception or error is raised. - - - - - Starts the background thread to start reading events from the network stream. - - - - - The superclass for all EventStreams. It contains the common processing logic needed to retreive events from a network Stream. It - also contains the mechanisms needed to have a background loop raise events. - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - "Unique" key for unknown event lookup. - - - - - Header key for message type. - - - - - Header key for event type. - - - - - Header key for exception type. - - - - - Header key for error code. - - - - - Header key for error message. - - - - - Value of when the message is an event. - - - - - Value of when the message is an exception. - - - - - Value of when the message is an error. - - - - - The size of the buffer for reading from the network stream. - Default is 8192. - - - - - The underlying stream to read events from. - - - - - Responsible for decoding events from sequences of bytes. - - - - - Fires when an event is recieved. - - - - - Fired when an exception or error is raised. - - - - - The mapping of event message to a generator function to construct the matching Event Stream event. - - - - - The mapping of event message to a generator function to construct the matching Event Stream exception. - - - - - Whether the Stream is currently being processed. - - - - - A Stream of Events. Events can be retrieved from this stream by attaching handlers to listen events, and then calling StartProcessing. - - - - - A Stream of Events. Events can be retrieved from this stream by attaching handlers to listen events, and then calling StartProcessing. - - - - - Converts an EventStreamMessage to an event. - - The event stream message to be converted. - The event - - - - Abstraction for cross-framework initiation of the background thread. - - - - - The background thread main loop. It will constantly read from the network stream until IsProcessing is false, or an error occurs. - - This stub exists due to FXCop. - - - - - The background thread main loop. It will constantly read from the network stream until IsProcessing is false, or an error occurs. - - Needed for 3.5 support. Not used. - - - - Reads from the stream into the buffer. It then passes the buffer to the decoder, which raises an event for - each message it decodes. - - The buffer to store the read bytes from the stream. - - - - Wraps exceptions in an outer exception so they can be passed to event handlers. If the Exception is already of a compatable type, - the method returns what it was given. - - The exception to wrap. - An exception of type TE - - - - Starts the background thread to start reading events from the network stream. - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Disposes the resources of this stream. - - Should dispose of unmanged resources. - - - - Event Arguments for EventStreamDecoder.MessageReceived. - - - - - Received message. - - - - - Additional object context - - - - - Initialize this with message - - - - - Initialize this with message and object conetext - - - - - Exception thrown when a request is made of the Decoder, but the internal state - machine is an invalid state. This is usually the result of an interanl exception - being thrown during parsing of the network stream. - - - - - Contract for EventStreamDecoder - - - - - Invoked anytime an EventStreamMessage is found. - - - - - Processes data starting at offset up to length. - Invokes MessageRecieved for each message encountered. - If an exception is thrown, this object is not safe for reuse. - - buffer to read - offset in buffer to start reading. - length of data. - - - - Streaming decoder for listening for incoming EventStreamMessage datagrams. - - - - - Invoked anytime an EventStreamMessage is found. - - - - - Object data (optional) that can be passed to the event handler for MessageReceived. - - - - - Default constructor. Initializes internal _state machine. - - - - - Processes data starting at offset up to length. - Invokes MessageRecieved for each message encountered. - If an exception is thrown, this object is not safe for reuse. - - buffer to read - offset in buffer to start reading. - length of data. - - - - Superclass for Exceptions that come over the event stream, or to wrap other kinds of generic exceptions. - - - - - Constructs an EventStreamException. - - - - - Constructs an EventStreamException. - - The exception message. - - - - Constructs an EventStreamException. - - The exception message. - The inner exception. - - - - The contract for EventStream events. - - - - - The contract for EventStream terminal events. - - - - - This Event is returned if an event is retrieved from the event stream, but a generator function - for the event is not defined. This can occur if the SDK is not updated after a new event type is introduced. - - - - - The Message recieved from the event stream before conversion. - - - - - The event type. - - - - - Constructs an UnknownEventStreamEvent. - - - - - Constructs an UnknownEventStreamEvent. - - The Message recieved from the event stream before conversion. - The event type. - - - - Signals that an an has an unknown message type. These exceptions whould be - swallowed to allow future expansion of the EventStream specification without breaking existing clients. - - - - - Constructs an UnknownEventStreamMessageTypeException. - - - - - Interface for a handler in a pipeline. - - - - - The logger used to log messages. - - - - - The inner handler which is called after the current - handler completes it's processing. - - - - - The outer handler which encapsulates the current handler. - - - - - Contains the processing logic for a synchronous request invocation. - This method should call InnerHandler.InvokeSync to continue processing of the - request by the pipeline, unless it's a terminating handler. - - The execution context which contains both the - requests and response context. - - - - Contains the processing logic for an asynchronous request invocation. - This method should call InnerHandler.InvokeSync to continue processing of the - request by the pipeline, unless it's a terminating handler. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - The interface for an exception handler. - - - - - Handles an exception for the given execution context. - - The execution context, it contains the - request and response context. - The exception to handle. - - Returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception to replace the original exception. - - - - - The interface for an exception handler with a generic parameter for the exception type. - - The exception type. - - - - Handles an exception for the given execution context. - - The execution context, it contains the - request and response context. - The exception to handle. - - Returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception to replace the original exception. - - - - - The interface for a HTTP request factory. - - The type used by the underlying HTTP API to represent the request body. - - - - Creates an HTTP request for the given URI. - - The request URI. - An HTTP request. - - - - The interface for an HTTP request that is agnostic of the underlying HTTP API. - - The type used by the underlying HTTP API to represent the HTTP request content. - - - - The HTTP method or verb. - - - - - The request URI. - - - - - Configures a request as per the request context. - - The request context. - - - - Sets the headers on the request. - - A dictionary of header names and values. - - - - Gets a handle to the request content. - - The request content. - - - - Returns the HTTP response. - - The HTTP response. - - - - Writes a stream to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - The request context. - - - - Writes a byte array to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - - - - Sets up the progress listeners - - The content stream - The interval at which progress needs to be published - The objects which is trigerring the progress changes - The callback which will be invoked when the progress changed event is trigerred - an object, incase the progress is setup, else returns the original stream - - - - Aborts the HTTP request. - - - - - Gets a handle to the request content. - - - - - - Returns the HTTP response. - - A cancellation token that can be used to cancel the asynchronous operation. - - - - - A factory which creates HTTP clients. - - - - - Create and configure an HttpClient. - - - - - - A factory which creates HTTP requests which uses System.Net.Http.HttpClient. - - - - - The constructor for HttpRequestMessageFactory. - - Configuration setting for a client. - - - - Creates an HTTP request for the given URI. - - The request URI. - An HTTP request. - - - - Disposes the HttpRequestMessageFactory. - - - - - Dispose the factory - - - - - - Create and configure a managed HttpClient instance. - The use of HttpClientHandler in the constructor for HttpClient implicitly creates a managed HttpClient. - If a native HttpClient is required the SDK user must implement IHttpClientFactory and provide an - instance via IClientConfig.HttpClientFactory (only available in PCL). - - - - - - - A cache of HttpClient objects. The GetNextClient method does a round robin cycle through the clients - to distribute the load even across. - - - - - Constructs a container for a cache of HttpClient objects - - The HttpClient to cache - - - - Returns the next HttpClient using a round robin rotation. It is expected that individual clients will be used - by more then one Thread. - - - - - - Disposes the HttpClientCache. - - - - - Dispose the HttpClientCache - - - - - - HTTP request wrapper for System.Net.Http.HttpRequestMessage. - - - - - Set of content header names. - - - - - The constructor for HttpWebRequestMessage. - - The HttpClient used to make the request. - The request URI. - The service client config. - - - - The underlying HttpClient - - - - - The underlying HTTP web request. - - - - - The HTTP method or verb. - - - - - The request URI. - - - - - Configures a request as per the request context. - - The request context. - - - - Sets the headers on the request. - - A dictionary of header names and values. - - - - Gets a handle to the request content. - - The request content. - - - - Returns the HTTP response. - - The HTTP response. - - - - Aborts the HTTP request. - - - - - Returns the HTTP response. - - A cancellation token that can be used to cancel the asynchronous operation. - - - - - Writes a stream to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - The request context. - - - - Writes a byte array to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - - - - Gets a handle to the request content. - - - - - - Disposes the HttpWebRequestMessage. - - - - - - - - - - - Sets up the progress listeners - - The content stream - The interval at which progress needs to be published - The objects which is trigerring the progress changes - The callback which will be invoked when the progress changed event is trigerred - an object, incase the progress is setup, else returns the original stream - - - - A retry policy specifies all aspects of retry behavior. This includes conditions when the request should be retried, - checks of retry limit, preparing the request before retry and introducing delay (backoff) before retries. - - - A retry policy specifies all aspects of retry behavior. This includes conditions when the request should be retried, - checks of retry limit, preparing the request before retry and introducing delay (backoff) before retries. - - - - - Maximum number of retries to be performed. - This does not count the initial request. - - - - - The logger used to log messages. - - - - - The standard set of throttling error codes - - - - - The standard set of timeout error codes to retry on. - - - - - List of AWS specific error codes which are returned as part of the error response. - These error codes will be retried. - - - - - The standard set of transient error, HTTP status codes to retry on. - 502 and 504 are returned by proxies. These can also be returned for - S3 accelerate requests which are served by CloudFront. - - - - - Set of web exception status codes to retry on. - - - - - This parameter serves as the value to the CapacityManager.Container datastructure. - Its properties include the available capacity left for making a retry request and the maximum - capacity size. - - - - - Checks if a retry should be performed with the given execution context and exception. - - The execution context which contains both the - requests and response context. - The exception thrown after issuing the request. - Returns true if the request should be retried, else false. The exception is retried if it matches with clockskew error codes. - - - - Returns true if the request is in a state where it can be retried, else false. - - The execution context which contains both the - requests and response context. - Returns true if the request is in a state where it can be retried, else false. - - - - Return true if the request should be retried for the given exception. - - The execution context which contains both the - requests and response context. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Checks if the retry limit is reached. - - The execution context which contains both the - requests and response context. - Return false if the request can be retried, based on number of retries. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called on a successful request response. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called before a retry request is initiated. The value - returned is True by default(retry throttling feature is disabled). - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called before a retry request is initiated. The value - returned is True by default(retry throttling feature is disabled). - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - - - - Virtual method that gets called before a retry request is initiated. The value - returned is True by default(retry throttling feature is disabled). - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - true if the error that will be retried is a throttling error - - - - This method uses a token bucket to enforce the maximum sending rate. - - The execution context which contains both the - requests and response context. - If the prior request failed, this exception is expected to be - the exception that occurred during the prior request failure. - - - - Determines if an AmazonServiceException is a throttling error - - The current exception to check. - true if it is a throttling error else false. - - - - Determines if an AmazonServiceException is a transient error that - should be retried. - - The current execution context - The current exception to check. - true if the exception is a transient error else false. - - - - Determines if the exception is a known timeout error code that - should be retried under the timeout error category. - - The current exception to check. - true if the exception is considered a timeout else false - - - - Checks if a retry should be performed with the given execution context and exception. - - The execution context which contains both the - requests and response context. - The exception throw after issuing the request. - Returns true if the request should be retried, else false. The exception is retried if it matches with clockskew error codes. - - - - This method uses a token bucket to enforce the maximum sending rate. - - The execution context which contains both the - requests and response context. - If the prior request failed, this exception is expected to be - the exception that occurred during the prior request failure. - - - - Return true if the request should be retried for the given exception. - - The execution context which contains both the - requests and response context. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - ICoreAmazonKMS is not meant to be used directly. It defines Key Management Service - with basic .NET types and allows other services to be able to use the service as - a runtime dependency. This interface is implemented by the AmazonKeyManagementServiceClient - defined in the AWSSDK.KeyManagementService assembly. - - - - - The result of the GenerateDataKey and GenerateDataKeyAsync operations. - - - - - The plaintext for the data key. - - - - - The ciphertext for the data key. - - - - - ICoreAmazonS3 is not meant to use directly. It defines S3 with basic .NET types - and allows other services to be able to use S3 as a runtime dependency. This interface - is implemented by the AmazonS3Client defined in the S3 assembly. - - - ICoreAmazonS3 is not meant to use directly. It defines S3 with basic .NET types - and allows other services to be able to use S3 as a runtime dependency. This interface - is implemented by the AmazonS3Client defined in the S3 assembly. - - - - - Generate a presigned URL. - - - - - - - - - - Get all the object keys for the particular bucket and key prefix. - - - - - - - - - Upload an object from a stream. - - - - - - - - - - - Delete an object. - - - - - - - - - - Delete an object. - - - - - - - - - - Open a stream to an object in S3. - - - - - - - - - - Upload an object from a file path. - - - - - - - - - - - Download an object in S3 to a file path. - - - - - - - - - - - Set the ACL on the object to public readable. - - - - - - - - Check to see if the bucket exists and if it doesn't create the bucket. - - - - - - Check to see if the bucket exists. - - - - - - - ICoreAmazonSQS is not meant to use directly. It defines SQS with basic .NET types - and allows other services to be able to use SQS as a runtime dependency. This interface - is implemented by the AmazonSQSClient defined in the SQS assembly. - - - - - Get the attributes for the queue identified by the queue URL asynchronously. - - The queue URL to get attributes for. - A Task containing the result of a dictionary of attributes for the queue. - - - - Set the attributes on the queue identified by the queue URL asynchronously. - - The queue URL to set the attributues. - The attributes to set. - A Task - - - - ICoreAmazonSTS is not meant to be used directly. It defines Security Token - service with basic .NET types and allows other services to be able to use the service as - a runtime dependency. This interface is implemented by the AmazonSecurityTokenServiceClient - defined in the AWSSDK.SecurityToken assembly. - - - - - - This method is used internally to access the Amazon Security Token - service within other service assemblies. - Please use AmazonSecurityTokenServiceClient to access the Amazon Security Token - service instead. - - Use Amazon Security Token Service to assume a role. - - Proxy settings that are required for the HTTPS and STS calls made during the authentication/credential - generation process are supported and should have been configured on the STS ClientConfig instance - associated with the STS client instance exposing this interface. - - - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRole. - - - - - CoreAmazonKMS is not meant to use directly. It implements ICoreAmazonKMS - and allows other service clients to be able to use the KMS service as a runtime dependency. - - This class waits until a method is actually called on the ICoreAmazonKMS interface - before requiring the KMS assembly to be present and loaded. - - - - - Settings for configuring a proxy for the SDK to use. - - - - - The host name or IP address of the proxy server. - - - - - The port number of the proxy. - - - - - The username to authenticate with the proxy server. - - - - - The password to authenticate with the proxy server. - - - - - Collection of one or more regular expressions denoting addresses - for which the proxy will not be used. - - - For more information on bypass lists - see https://msdn.microsoft.com/en-us/library/system.net.webproxy.bypasslist%28v=vs.110%29.aspx. - - - - - If true requests to local addresses bypass the configured - proxy. - - - - - Settings for logging in the SDK. - - - - - Logging destination. - - - - - When to log responses. - - - - - Gets or sets the size limit in bytes for logged responses. - If logging for response body is enabled, logged response - body is limited to this size. The default limit is 1KB. - - - - - Whether or not to log SDK metrics. - - - - - A custom formatter added through Configuration - - - - - This class can be used to discover the public address ranges for AWS. The - information is retrieved from the publicly accessible - https://ip-ranges.amazonaws.com/ip-ranges.json file. - - - The information in this file is generated from our internal system-of-record and - is authoritative. You can expect it to change several times per week and should - poll accordingly. - - - - - Region identifier string for ROUTE53 and CLOUDFRONT ranges - - - - - Collection of service keys found in the data file. - - - - - The publication date and time of the file that was downloaded and parsed. - - - - - Collection of all public IP ranges. - - - - - Filtered collection of public IP ranges for the given service key - - - - - Filtered collection of public IP ranges for the given region (us-east-1 etc) or GLOBAL. - - - - - Filtered collection of public IP ranges for the given network border group. - - - - - Downloads the most recent copy of the endpoint address file and - parses it to a collection of address range objects. - - - - - Downloads the most recent copy of the endpoint address file and - parses it to a collection of address range objects. - - - - - Represents the IP address range for a single region and service key. - - - - - The public IPv4 or Ipv6 address range, in CIDR notation. - - - - - Indicates ipv4 or v6 format of the address - - - - - The AWS region or GLOBAL for edge locations. Note that the CLOUDFRONT and ROUTE53 - ranges are GLOBAL. - - - - - The subset of IP address ranges. Specify AMAZON to get all IP address ranges - (for example, the ranges in the EC2 subset are also in the AMAZON subset). Note - that some IP address ranges are only in the AMAZON subset. - - - Valid values for the service key include "AMAZON", "EC2", "ROUTE53", - "ROUTE53_HEALTHCHECKS", and "CLOUDFRONT." If you need to know all of - the ranges and don't care about the service, use the "AMAZON" entries. - The other entries are subsets of this one. Also, some of the services, - such as S3, are represented in "AMAZON" and do not have an entry that - is specific to the service. We plan to add additional values over time; - code accordingly! - - - - - The network border group the IP address range belongs to. - - - AWS Local Zones allow you to seamlessly connect to the full range of services in the AWS Region such - as Amazon Simple Storage Service and Amazon DynamoDB through the same APIs and tool sets. You can extend - your VPC Region by creating a new subnet that has a Local Zone assignment. When you create a subnet in - a Local Zone, the VPC is also extended to that Local Zone. - - A network border group is a unique set of Availability Zones or Local Zones from where AWS advertises - public IP addresses. - - When you create a VPC that has IPv6 addresses, you can choose to assign a set of Amazon-provided public - IP addresses to the VPC and also set a network border group for the addresses that limits the addresses - to the group. When you set a network border group, the IP addresses cannot move between network - border groups. The us-west-2 network border group contains the four US West (Oregon) Availability Zones. - The us-west-2-lax-1 network border group contains the Los Angeles Local Zones. - - - - - This class defines utilities and constants that can be used by - all the client libraries of the SDK. - - - - - The user agent string header - - - - - The Set of accepted and valid Url characters per RFC3986. - Characters outside of this set will be encoded. - - - - - The Set of accepted and valid Url characters per RFC1738. - Characters outside of this set will be encoded. - - - - - The set of accepted and valid Url path characters per RFC3986. - - - - - The string representing Url Encoded Content in HTTP requests - - - - - The GMT Date Format string. Used when parsing date objects - - - - - The ISO8601Date Format string. Used when parsing date objects - - - - - The ISO8601Date Format string. Used when parsing date objects - - - - - The ISO8601 Basic date/time format string. Used when parsing date objects - - - - - The ISO8601 basic date format. Used during AWS4 signature computation. - - - - - The RFC822Date Format string. Used when parsing date objects - - - - - Returns an extension of a path. - This has the same behavior as System.IO.Path.GetExtension, but does not - check the path for invalid characters. - - - - - - Convert request parameters to Url encoded query string - - - Convert Dictionary of parameters to Url encoded query string - - - - Returns the canonicalized resource path for the service endpoint with single URL encoded path segments. - - Endpoint URL for the request - Resource path for the request - - If resourcePath begins or ends with slash, the resulting canonicalized - path will follow suit. - - Canonicalized resource path for the endpoint - - - - Returns the canonicalized resource path for the service endpoint - - Endpoint URL for the request - Resource path for the request - If true pre URL encode path segments if necessary. - S3 is currently the only service that does not expect pre URL encoded segments. - - If resourcePath begins or ends with slash, the resulting canonicalized - path will follow suit. - - Canonicalized resource path for the endpoint - - - - Returns the canonicalized resource path for the service endpoint - - Endpoint URL for the request - Resource path for the request - If true pre URL encode path segments if necessary. - S3 is currently the only service that does not expect pre URL encoded segments. - Dictionary of key/value parameters containing the values for the ResourcePath key replacements - The version of the marshaller that constructed the request object. - - If resourcePath begins or ends with slash, the resulting canonicalized - path will follow suit. - - Canonicalized resource path for the endpoint - - - - Splits the resourcePath at / into segments then resolves any keys with the path resource values. Greedy - key values will be split into multiple segments at each /. - - The patterned resourcePath - The key/value lookup for the patterned resourcePath - A list of path segments where all keys in the resourcePath have been resolved to one or more path segment values - - - - Joins all path segments with the / character and encodes each segment before joining. - - The segments of a URL path split at each / character - If the path property is specified, - the accepted path characters {/+:} are not encoded. - A joined URL with encoded segments - - - - Takes a patterned resource path and resolves it using the key/value path resources into - a segmented encoded URL. - - The patterned resourcePath - The key/value lookup for the patterned resourcePath - A segmented encoded URL - - - - Returns a new string created by joining each of the strings in the - specified list together, with a comma between them. - - The list of strings to join into a single, comma delimited - string list. - A new string created by joining each of the strings in the - specified list together, with a comma between strings. - - - - Attempt to infer the region for a service request based on the endpoint - - Endpoint to the service to be called - - Region parsed from the endpoint; DefaultRegion (or DefaultGovRegion) - if it cannot be determined/is not explicit - - - - - Attempt to infer the service name for a request (in short form, eg 'iam') from the - service endpoint. - - Endpoint to the service to be called - - Short-form name of the service parsed from the endpoint; empty string if it cannot - be determined - - - - - Utility method for converting Unix epoch seconds to DateTime structure. - - The number of seconds since January 1, 1970. - Converted DateTime structure - - - - Helper function to format a byte array into string - - The data blob to process - If true, returns hex digits in lower case form - String version of the data - - - - Calls a specific EventHandler in a background thread - - - - - - - - Parses a query string of a URL and returns the parameters as a string-to-string dictionary. - - - - - - - Utility method for converting a string to a MemoryStream. - - - - - - - Utility method for copy the contents of the source stream to the destination stream. - - - - - - - Utility method for copy the contents of the source stream to the destination stream. - - - - - - - - Formats the current date as a GMT timestamp - - A GMT formatted string representation - of the current date and time - - - - - Formats the current date as ISO 8601 timestamp - - An ISO 8601 formatted string representation - of the current date and time - - - - - Gets the ISO8601 formatted timestamp that is minutesFromNow - in the future. - - The number of minutes from the current instant - for which the timestamp is needed. - The ISO8601 formatted future timestamp. - - - - Formats the current date as ISO 8601 timestamp - - An ISO 8601 formatted string representation - of the current date and time - - - - - Gets the RFC822 formatted timestamp that is minutesFromNow - in the future. - - The number of minutes from the current instant - for which the timestamp is needed. - The ISO8601 formatted future timestamp. - - - - Determines whether the given string is an absolute path to a root. - - The hypothetical absolute path. - True if is an absolute path. - - - - Returns true if the path specified is relative to the current drive or working directory. - Returns false if the path is fixed to a specific drive or UNC path. This method does no - validation of the path (URIs will be returned as relative as a result). - - - Handles paths that use the alternate directory separator. It is a frequent mistake to - assume that rooted paths (Path.IsPathRooted) are not relative. This isn't the case. - "C:a" is drive relative- meaning that it will be resolved against the current directory - for C: (rooted, but relative). "C:\a" is rooted and not relative (the current directory - will not be used to modify the path). - - - - - True if the given character is a directory separator. - - - - - Returns true if the given character is a valid drive letter - - - - - URL encodes a string per RFC3986. If the path property is specified, - the accepted path characters {/+:} are not encoded. - - The string to encode - Whether the string is a URL path or not - The encoded string - - - - URL encodes a string per the specified RFC. If the path property is specified, - the accepted path characters {/+:} are not encoded. - - RFC number determing safe characters - The string to encode - Whether the string is a URL path or not - The encoded string - - Currently recognised RFC versions are 1738 (Dec '94) and 3986 (Jan '05). - If the specified RFC is not recognised, 3986 is used by default. - - - - - URL encodes a string per the specified RFC with the exception of preserving the encoding of previously encoded slashes. - If the path property is specified, the accepted path characters {/+:} are not encoded. - - The string to encode - Whether the string is a URL path or not - The encoded string with any previously encoded %2F preserved - - - - Convert bytes to a hex string - - Bytes to convert. - Hexadecimal string representing the byte array. - - - - Convert a hex string to bytes - - Hexadecimal string - Byte array corresponding to the hex string. - - - - Returns DateTime.UtcNow + ManualClockCorrection when - is set. - This value should be used instead of DateTime.UtcNow to factor in manual clock correction - - - - - Returns true if the string has any bidirectional control characters. - - - - - - - Executes an HTTP request and returns the response as a string. This method - throws WebException and HttpRequestException. In the event HttpRequestException - is thrown the StatusCode is sent as user defined data on the exception under - the key "StatusCode". - - The URI to make the request to - The request type: GET, PUT, POST - null or the content to send with the request - Timeout for the request - Proxy for the request - null or any headers to send with the request - The response as a string. - - - - Utility method that accepts a string and replaces white spaces with a space. - - - - - - - Class that contains result of executing an external process through the SDKs - AWSSDKUtils.RunProcess/AWSSDKUtils.RunProcessAsync - - - - - The exit code with which the process exited - - - - - The output of the process read till the end - - - - - The error output of the process read till the end - - - - - Object to track circular references in nested types. - At each level of nesting, make a call to Track to retrieve Tracker, - a tracking object implementing the IDisposable interface. - Dispose of this tracker when leaving the context of the tracked object. - - - - - Tracker. Must be disposed. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Adds the current target to a reference list and returns a tracker. - The tracker removes the target from the reference list when the - tracker is disposed. - - - - - - - Root AWS config - - - - - AwsHttpClient is a wrapper around HttpClient class of the System.Net.Http library. - The wrapper has been added so as to remove System.Net.Http dependencies from the Services - and migrate it to a Core level dependecy only. This avoids version clashes when a service - and the Core depends on different versions of the System.Net.Http library. This is a Service - level utility method - - - - - AWSHttpClient wrapper that is wrapped around - HttpClient default wrapper. - - - - - AWSHttpClient BaseAddress property that is wrapper for - HttpClient BaseAddress property. - - - - - AWSHttpClient Timeout property that is wrapper for - HttpClient Timeout property. - - - - - AWSHttpClient MaxResponseContentBufferSize property that is wrapper for - HttpClient MaxResponseContentBufferSize property. - - - - - AWSHttpClient GetStreamAsync that accepts the requester's URI - and make a HttpClient.GetStreamAsync call. - - Requester Uri - - - - Wrapper method that accepts a request uri, stream content and headers and makes a sendAsync call. - - - - - - - Wrapper for HttpClient's HttpRequestMessage and SendAsync methods. - - - - Returns response headers information- header name,value and status code - - - - Wrapper for HttpClient Dispose. - - - - - Method that checks if the passed exception is of type - HttpRequestException - - - - - - - AWSStreamContent is a wrapper for StreamContent class in - the System.Net.Http library.The wrapper has been added so as to - remove System.Net.Http dependencies from the Services - and migrate it to a Core level dependecy only. This avoids version clashes when a service - and the Core depends on different versions of the System.Net.Http library. This is a Service - level utility method - - - - - Wrapper for StreamContent constructor - for stream content - - - - - - Wrapper for StreamContent constructor - for stream content and bufferSize - - - - - - - Wrapper to allow Services to remove StreamContent Headers - - - - - - - Wrapper to allow Services to add StreamContent Headers - - - - - - - Wrapper for StreamContent Dispose. - - - - - Allows to configure the proxy used for HTTP requests. The default value is null. - - - - - This class contains the endpoints available to the AWS clients. The static constants representing the - regions can be used while constructing the AWS client instead of looking up the exact endpoint URL. - - - - - Gets the endpoint for a service in a region. - - The services system name. - If true returns the endpoint for dualstack - Thrown when the request service does not have a valid endpoint in the region. - - - - - Enumerate through all the regions. - - - - - Gets the region based on its system name like "us-west-1" - - The system name of the service like "us-west-1" - - - - - This is a testing method and should not be called by production applications. - - - - - Gets the system name of a region. - - - - - Gets the display name of a region. - - - - - This region name is non-standard. Search the whole endpoints.json file to - determine the partition this region is in. - - - - - This class contains region information used to lazily compute the service endpoints. The static constants representing the - regions can be used while constructing the AWS client instead of looking up the exact endpoint URL. - - - - - The US East (Virginia) endpoint. - - - - - The US East (Virginia) regional endpoint. - - - - - The US East (Ohio) endpoint. - - - - - The US West (N. California) endpoint. - - - - - The US West (Oregon) endpoint. - - - - - The EU North (Stockholm) endpoint. - - - - - The EU West (Ireland) endpoint. - - - - - The EU West (London) endpoint. - - - - - The EU West (Paris) endpoint. - - - - - The EU Central (Frankfurt) endpoint. - - - - - The Europe (Milan) endpoint. - - - - - The Asia Pacific (Hong Kong) endpoint. - - - - - The Asia Pacific (Tokyo) endpoint. - - - - - The Asia Pacific (Seoul) endpoint. - - - - - The Asia Pacific (Osaka-Local) endpoint. - - - - - The Asia Pacific (Mumbai) endpoint. - - - - - The Asia Pacific (Singapore) endpoint. - - - - - The Asia Pacific (Sydney) endpoint. - - - - - The South America (Sao Paulo) endpoint. - - - - - The US GovCloud East (Virginia) endpoint. - - - - - The US GovCloud West (Oregon) endpoint. - - - - - The China (Beijing) endpoint. - - - - - The China (Ningxia) endpoint. - - - - - The Canada (Central) endpoint. - - - - - The Middle East (Bahrain) endpoint. - - - - - The Africa (Cape Town) endpoint. - - - - - Represents the endpoint overridding rules in the endpoints.json - Is used to map private region (ie us-east-1-regional) to public regions (us-east-1) - For signing purposes. - - - - - Enumerate through all the regions. - - - - - Gets the region based on its system name like "us-west-1" - - The system name of the service like "us-west-1" - - - - - Gets the region endpoint override if exists - - The region endpoint to find the possible override for - - - - - Gets the system name of a region. - - - - - Gets the display name of a region. - - - - - Gets the partition name the region is in. For example for us-east-1 the partition name is aws. For cn-northwest-1 the partition name is aws-cn. - - - - - Gets the dns suffix for the region endpoints in a partition. For example the aws partition's suffix is amazonaws.com. The aws-cn partition's suffix is amazonaws.com.cn. - - - - - Gets the endpoint for a service in a region. - - - The services system name. Service system names can be obtained from the - RegionEndpointServiceName member of the ClientConfig-derived class for the service. - - - For forwards compatibility, if the service being requested for isn't known in the region, this method - will generate an endpoint using the AWS endpoint heuristics. In this case, it is not guaranteed the - endpoint will point to a valid service endpoint. - - - - - - Gets the endpoint for a service in a region, optionally selecting a dualstack compatible endpoint. - - - The services system name. Service system names can be obtained from the - RegionEndpointServiceName member of the ClientConfig-derived class for the service. - - - If true a dualstack endpoint is returned. It is the user's responsibility to verify that the given service - supports a dualstack endpoint for the region. - - - For forwards compatibility, if the service being requested for isn't known in the region, this method - will generate an endpoint using the AWS endpoint heuristics. In this case, it is not guaranteed the - endpoint will point to a valid service endpoint. - - - - - - This class defines an endpoints hostname and which protocols it supports. - - - - - Gets the hostname for the service. - - - - - The authentication region to be used in request signing. - - - - - This property is only set for S3 endpoints. For all other services this property returns null. - For S3 endpoints, if the endpoint supports signature version 2 this property will be "2", otherwise it will be "4". - - - - - Calculates a 32bit Cyclic Redundancy Checksum (CRC) using the - same polynomial used by Zip. This type is used internally by DotNetZip; it is generally not used directly - by applications wishing to create, read, or manipulate zip archive files. - - - - - indicates the total number of bytes read on the CRC stream. - This is used when writing the ZipDirEntry when compressing files. - - - - - Indicates the current CRC for all blocks slurped in. - - - - - Returns the CRC32 for the specified stream. - - The stream over which to calculate the CRC32 - the CRC32 calculation - - - - Returns the CRC32 for the specified stream, and writes the input into the output stream. - - The stream over which to calculate the CRC32 - The stream into which to deflate the input - the CRC32 calculation - - - - Get the CRC32 for the given (word,byte) combo. - This is a computation defined by PKzip. - - The word to start with. - The byte to combine it with. - The CRC-ized result. - - - - Update the value for the running CRC32 using the given block of bytes. - This is useful when using the CRC32() class in a Stream. - - block of bytes to slurp - starting point in the block - how many bytes within the block to slurp - - - - A Stream that calculates a CRC32 (a checksum) on all bytes read, - or on all bytes written. - - - - - This class can be used to verify the CRC of a ZipEntry when reading from a stream, - or to calculate a CRC when writing to a stream. The stream should be used to either - read, or write, but not both. If you intermix reads and writes, the results are - not defined. - - This class is intended primarily for use internally by the DotNetZip library. - - - - - Gets the total number of bytes run through the CRC32 calculator. - - - - This is either the total number of bytes read, or the total number - of bytes written, depending on the direction of this stream. - - - - - The constructor. - - The underlying stream - - - - The constructor. - - The underlying stream - The length of the stream to slurp - - - - Provides the current CRC for all blocks slurped in. - - - - - Read from the stream - - the buffer to read - the offset at which to start - the number of bytes to read - the number of bytes actually read - - - - Write to the stream. - - the buffer from which to write - the offset at which to start writing - the number of bytes to write - - - - Indicates whether the stream supports reading. - - - - - Indicates whether the stream supports seeking. - - - - - Indicates whether the stream supports writing. - - - - - Flush the stream. - - - - - Not implemented. - - - - - Not implemented. - - - - - Not implemented. - - N/A - N/A - N/A - - - - Not implemented. - - N/A - - - diff --git a/packages/AWSSDK.Core.3.3.107.14/lib/MonoAndroid10/AWSSDK.Core.dll b/packages/AWSSDK.Core.3.3.107.14/lib/MonoAndroid10/AWSSDK.Core.dll deleted file mode 100644 index 9201934..0000000 Binary files a/packages/AWSSDK.Core.3.3.107.14/lib/MonoAndroid10/AWSSDK.Core.dll and /dev/null differ diff --git a/packages/AWSSDK.Core.3.3.107.14/lib/MonoTouch10/AWSSDK.Core.XML b/packages/AWSSDK.Core.3.3.107.14/lib/MonoTouch10/AWSSDK.Core.XML deleted file mode 100644 index 2b1ead4..0000000 --- a/packages/AWSSDK.Core.3.3.107.14/lib/MonoTouch10/AWSSDK.Core.XML +++ /dev/null @@ -1,10850 +0,0 @@ - - - - AWSSDK.Core - - - - - Utility class to parse Amazon resource names more commonly known as an ARN. - - - - - Gets and sets the partition associated with the ARN (e.g.: 'aws'). - - - - - Gets and sets the AWS service associated with the ARN (e.g.: 's3'). - - - - - Gets and sets the region associated with the ARN (e.g.: 'us-east-1'). - - - - - Gets and sets the account ID associated with the ARN. - - - - - Gets and sets the resource associated with the ARN (e.g.: 'mybucket/myobject'). - - - - - Returns true if the string appears to be an ARN by seeing if the string starts with "arn:". This method - doesn't guarantee the string is a valid ARN. To validate the string call TryParse. - - - - - - - Parses the string into an ARN object. - - String to parse into an ARN. - The out parameter for the ARN object created by TryParse. - True if the string was parsed into an ARN object. - - - - Parses the string into an ARN object. - - String to parse into an Arn. - The Arn object created from the passed in string. - Thrown if arnString is null. - Thrown if the string passed in not valid ARN. - - - - Turns the Arn object into a string representation of an ARN. - - - - - - Configuration options that apply to the entire SDK. - - These settings can be configured through app.config or web.config. - Below is a full sample configuration that illustrates all the possible options. - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws region="us-west-2"> - <logging logTo="Log4Net, SystemDiagnostics" logResponses="Always" logMetrics="true" /> - <s3 useSignatureVersion4="true" /> - <proxy host="localhost" port="8888" username="1" password="1" /> - - <dynamoDB> - <dynamoDBContext tableNamePrefix="Prod-"> - - <tableAliases> - <alias fromTable="FakeTable" toTable="People" /> - <alias fromTable="Persons" toTable="People" /> - </tableAliases> - - <mappings> - <map type="Sample.Tests.Author, SampleDLL" targetTable="People" /> - <map type="Sample.Tests.Editor, SampleDLL" targetTable="People"> - <property name="FullName" attribute="Name" /> - <property name="EmployeeId" attribute="Id" /> - <property name="ComplexData" converter="Sample.Tests.ComplexDataConverter, SampleDLL" /> - <property name="Version" version="true" /> - <property name="Password" ignore="true" /> - </map> - </mappings> - - </dynamoDBContext> - </dynamoDB> - </aws> - - - - Configuration options that apply to the entire SDK. - - - - - Manual offset to apply to client clock. This is a global setting that overrides - ClockOffset value calculated for all service endpoints. - - - - - Determines if the SDK should correct for client clock skew - by determining the correct server time and reissuing the - request with the correct time. - Default value of this field is True. - will be updated with the calculated - offset even if this field is set to false, though requests - will not be corrected or retried. - Ignored if is set. - - - - - The calculated clock skew correction, if there is one. - This field will be set if a service call resulted in an exception - and the SDK has determined that there is a difference between local - and server times. - - If is set to true, this - value will be set to the correction, but it will not be used by the - SDK and clock skew errors will not be retried. - - - - - Key for the AWSRegion property. - - - - - - Configures the default AWS region for clients which have not explicitly specified a region. - Changes to this setting will only take effect for newly constructed instances of AWS clients. - - This setting can be configured through the App.config. For example: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws region="us-west-2" /> - - - - - - Key for the AWSProfileName property. - - - - - - Profile name for stored AWS credentials that will be used to make service calls. - Changes to this setting will only take effect in newly-constructed clients. - - To reference the account from an application's App.config or Web.config use the AWSProfileName setting. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="development"/> - </appSettings> - </configuration> - - - - - - - Key for the AWSProfilesLocation property. - - - - - - Location of the credentials file shared with other AWS SDKs. - By default, the credentials file is stored in the .aws directory in the current user's home directory. - - Changes to this setting will only take effect in newly-constructed clients. - - To reference the profile from an application's App.config or Web.config use the AWSProfileName setting. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfilesLocation" value="c:\config"/> - </appSettings> - </configuration> - - - - - - - Key for the Logging property. - - - - - - Configures how the SDK should log events, if at all. - Changes to this setting will only take effect in newly-constructed clients. - - The setting can be configured through App.config, for example: - - <appSettings> - <add key="AWSLogging" value="log4net"/> - </appSettings> - - - - - - Key for the ResponseLogging property. - - - - - - - Configures when the SDK should log service responses. - Changes to this setting will take effect immediately. - - The setting can be configured through App.config, for example: - - <appSettings> - <add key="AWSResponseLogging" value="OnError"/> - </appSettings> - - - - - - Key for the LogMetrics property. - - - - - - Configures if the SDK should log performance metrics. - This setting configures the default LogMetrics property for all clients/configs. - Changes to this setting will only take effect in newly-constructed clients. - - The setting can be configured through App.config, for example: - - <appSettings> - <add key="AWSLogMetrics" value="true"/> - </appSettings> - - - - - - Key for the EndpointDefinition property. - - - - - - Configures if the SDK should use a custom configuration file that defines the regions and endpoints. - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws endpointDefinition="c:\config\endpoints.json" /> - - - - - - Key for the UseSdkCache property. - - - - - - Configures if the SDK Cache should be used, the default value is true. - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws useSdkCache="true" /> - - - - - - Configuration for the Logging section of AWS configuration. - Changes to some settings may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws> - <logging logTo="Log4Net, SystemDiagnostics" logResponses="Always" logMetrics="true" /> - </aws> - - - - - - Configuration for the Proxy section of AWS configuration. - Changes to some settings may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws> - <proxy host="localhost" port="8888" username="1" password="1" bypassList="addressexpr1;addressexpr2;..." bypassOnLocal="true" /> - </aws> - - - - - - Configuration for the region endpoint section of AWS configuration. - Changes may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws region="us-west-2" /> - - - - - - Lock for SomeEvent delegate access. - - - - - This method should never be called directly. - Call AWSSDKUtils.CorrectedUtcNow instead. - - - - - - Logging options. - Can be combined to enable multiple loggers. - - - - - No logging - - - - - Log using log4net - - - - - Log using System.Diagnostics - - - - - Log to the console - - - - - Log to a file - - - - - Response logging option. - - - - - Never log service response - - - - - Only log service response when there's an error - - - - - Always log service response - - - - - Format for metrics data in the logs - - - - - Emit metrics in human-readable format - - - - - Emit metrics as JSON data - - - - - An access control policy action identifies a specific action in a service - that can be performed on a resource. For example, sending a message to a - queue. - - ActionIdentifiers allow you to limit what your access control policy statement affects. - For example, you could create a policy statement that enables a certain group - of users to send messages to your queue, but not allow them to perform any - other actions on your queue. - - - The action is B in the statement - "A has permission to do B to C where D applies." - - Free form access control policy actions may include a wildcard (*) to match - multiple actions. - - - Constants for known actions can be found in the Amazon.Auth.AccessControlPolicy.ActionIdentifiers namespace. - - - - - - Constructs an Actionidentifer with the given action name. - - The name of the action - - - - Gets and sets the name of this action. For example, 'sqs:SendMessage' is the - name corresponding to the SQS action that enables users to send a message - to an SQS queue. - - - - - AWS access control policy conditions are contained in - objects, and affect when a statement is applied. For example, a statement - that allows access to an Amazon SQS queue could use a condition to only apply - the effect of that statement for requests that are made before a certain - date, or that originate from a range of IP addresses. - - Multiple conditions can be included in a single statement, and all conditions - must evaluate to true in order for the statement to take effect. - - - The set of conditions is D in the statement - "A has permission to do B to C where D applies." - - - A condition is composed of three parts: - - - Condition Key - The condition key declares which value of a - request to pull in and compare against when a policy is evaluated by AWS. For - example, using will cause - AWS to pull in the current request's source IP as the first value to compare - against every time your policy is evaluated. - - - - Comparison Type - This is a static value used as the second value - in the comparison when your policy is evaluated. Depending on the comparison - type, this value can optionally use wildcards. See the documentation for - individual comparison types for more information. - - - - Comparison Value - This is a static value used as the second value - in the comparison when your policy is evaluated. Depending on the comparison - type, this value can optionally use wildcards. See the documentation for - individual comparison types for more information. - - - - - - - - - Gets the type of this condition. - - - - - Gets and Sets the name of the condition key involved in this condition. - Condition keys are predefined values supported by AWS that provide input - to a condition's evaluation, such as the current time, or the IP address - of the incoming request. - - Your policy is evaluated for each incoming request, and condition keys - specify what information to pull out of those incoming requests and plug - into the conditions in your policy. - - - - - - Gets and Sets the values specified for this access control policy condition. - For example, in a condition that compares the incoming IP address of a - request to a specified range of IP addresses, the range of IP addresses - is the single value in the condition. - - Most conditions accept only one value, but multiple values are possible. - - - - - - A factory for creating conditions to be used in the policy. - - - - - Condition key for the current time. - - This condition key should only be used with enum. - - - - - - Condition key for whether or not an incoming request is using a secure - transport to make the request (i.e. HTTPS instead of HTTP). - - This condition key should only be used with the boolean overload of NewCondition. - - - - - - Condition key for the source IP from which a request originates. - - This condition key should only be used with enum. - - - - - - Condition key for the user agent included in a request. - - This condition key should only be used with - enum. - - - - - - Condition key for the current time, in epoch seconds. - - This condition key should only be used with enum. - objects. - - - - - - Condition key for the referrer specified by a request. - - This condition key should only be used with - objects. - - - - - - Condition key for the Amazon Resource Name (ARN) of the source specified - in a request. The source ARN indicates which resource is affecting the - resource listed in your policy. For example, an SNS topic is the source - ARN when publishing messages from the topic to an SQS queue. - - This condition key should only be used with enum. - - - - - - Enumeration of the supported ways an ARN comparison can be evaluated. - - - - Exact matching - - - - Loose case-insensitive matching of the ARN. Each of the six - colon-delimited components of the ARN is checked separately and each - can include a multi-character match wildcard (*) or a - single-character match wildcard (?). - - - - Negated form of ArnEquals - - - Negated form of ArnLike - - - - Enumeration of the supported ways a date comparison can be evaluated. - - - - - Enumeration of the supported ways an IP address comparison can be evaluated. - - - - - Matches an IP address against a CIDR IP range, evaluating to true if - the IP address being tested is in the condition's specified CIDR IP - range. - - - - - Negated form of IpAddress - - - - - Enumeration of the supported ways a numeric comparison can be evaluated - - - - - Enumeration of the supported ways a string comparison can be evaluated. - - - - - Case-sensitive exact string matching - - - - - Case-insensitive string matching - - - - - Loose case-insensitive matching. The values can include a - multi-character match wildcard (*) or a single-character match - wildcard (?) anywhere in the string. - - - - - Negated form of StringEquals. - - - - - Negated form of StringEqualsIgnorecase. - - - - - Negated form of StringLike. - - - - - Constructs a new access control policy condition that compares ARNs (Amazon Resource Names). - - The access policy condition key specifying where to get the first ARN for the comparison - The type of comparison to perform. - The second ARN to compare against. When using ArnLike or ArnNotLike this may contain the - multi-character wildcard (*) or the single-character wildcard - - - - Constructs a new access policy condition that performs a boolean - comparison. - - The access policy condition key specifying where to get the - first boolean value for the comparison (ex: aws:SecureTransport). - The boolean to compare against. - - - - This method is deprecated. Invoking this method results in non-UTC DateTimes - not being marshalled correctly. Use NewConditionUtc instead. - Constructs a new access policy condition that compares the current time - (on the AWS servers) to the specified date. - - The type of comparison to perform. For example, - DateComparisonType.DateLessThan will cause this policy - condition to evaluate to true if the current date is less than - the date specified in the second argument. - The date to compare against. - - - - Constructs a new access policy condition that compares the current time - (on the AWS servers) to the specified date. - - The type of comparison to perform. For example, - DateComparisonType.DateLessThan will cause this policy - condition to evaluate to true if the current date is less than - the date specified in the second argument. - The date to compare against. - - - - Constructs a new access policy condition that compares the source IP - address of the incoming request to an AWS service against the specified - CIDR range. The condition evaluates to true (meaning the policy statement - containing it will be applied) if the incoming source IP address is - within that range. - - To achieve the opposite effect (i.e. cause the condition to evaluate to - true when the incoming source IP is not in the specified CIDR - range) use the alternate constructor form and specify - IpAddressComparisonType.NotIpAddress. - - - The CIDR IP range involved in the policy condition. - - - - Constructs a new access policy condition that compares the source IP - address of the incoming request to an AWS service against the specified - CIDR range. When the condition evaluates to true (i.e. when the incoming - source IP address is within the CIDR range or not) depends on the - specified IpAddressComparisonType. - - The type of comparison to to perform. - The CIDR IP range involved in the policy condition. - - - - Constructs a new access policy condition that compares two numbers. - - The type of comparison to perform. - The access policy condition key specifying where to get the - first number for the comparison. - The second number to compare against. - - - - Constructs a new access control policy condition that compares two - strings. - - The type of comparison to perform - The access policy condition key specifying where to get the - first string for the comparison (ex: aws:UserAgent). - - The second string to compare against. When using - StringComparisonType.StringLike or - StringComparisonType.StringNotLike this may contain - the multi-character wildcard (*) or the single-character - wildcard (?). - - - - - Constructs a new access policy condition that compares the Amazon - Resource Name (ARN) of the source of an AWS resource that is modifying - another AWS resource with the specified pattern. - - For example, the source ARN could be an Amazon SNS topic ARN that is - sending messages to an Amazon SQS queue. In that case, the SNS topic ARN - would be compared the ARN pattern specified here. - - - The endpoint pattern may optionally contain the multi-character wildcard - * (*) or the single-character wildcard (?). Each of the six colon-delimited - components of the ARN is checked separately and each can include a - wildcard. - - - Policy policy = new Policy("MyQueuePolicy"); - policy.WithStatements(new Statement(Statement.StatementEffect.Allow) - .WithPrincipals(new Principal("*")).WithActionIdentifiers(SQSActionIdentifiers.SendMessage) - .WithResources(new Resource(myQueueArn)) - .WithConditions(ConditionFactory.NewSourceArnCondition(myTopicArn))); - - - The ARN pattern against which the source ARN will be compared. - Each of the six colon-delimited components of the ARN is - checked separately and each can include a wildcard. - A new access control policy condition that compares the ARN of - the source specified in an incoming request with the ARN pattern - specified here. - - - - Constructs a new access control policy condition that tests if the - incoming request was sent over a secure transport (HTTPS). - - A new access control policy condition that tests if the incoming - request was sent over a secure transport (HTTPS). - - - - Condition key for the canned ACL specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the location constraint specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the prefix specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the delimiter specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the max keys specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the source object specified by a request to copy an - object. - - This condition key may only be used with enum. - - - - - - Condition key for the metadata directive specified by a request to copy - an object. - - This condition key may only be used with enum. - - - - - - Condition key for the version ID of an object version specified by a - request. - - This condition key may only be used with enum. - - - - - - Constructs a new access policy condition that compares an Amazon S3 - canned ACL with the canned ACL specified by an incoming request. - - You can use this condition to ensure that any objects uploaded to an - Amazon S3 bucket have a specific canned ACL set. - - - The Amazon S3 canned ACL to compare against. - A new access control policy condition that compares the Amazon S3 - canned ACL specified in incoming requests against the value - specified. - - - - Condition key for The URL, e-mail address, or ARN from a Subscribe - request or a previously confirmed subscription. Use with string - conditions to restrict access to specific endpoints (e.g., - *@mycompany.com). - - This condition key may only be used with enum. - - - - - - Condition key for the protocol value from a Subscribe request or a - previously confirmed subscription. Use with string conditions to restrict - publication to specific delivery protocols (e.g., HTTPS). - - This condition key may only be used with enum. - - - - - - Constructs a new access policy condition that compares the requested - endpoint used to subscribe to an Amazon SNS topic with the specified - endpoint pattern. The endpoint pattern may optionally contain the - multi-character wildcard (*) or the single-character wildcard (?). - - For example, this condition can restrict subscriptions to a topic to - email addresses in a certain domain ("*@my-company.com"). - - - Policy policy = new Policy("MyTopicPolicy"); - policy.WithStatements(new Statement(Statement.StatementEffect.Allow) - .WithPrincipals(new Principal("*")).WithActionIdentifiers(SNSActionIdentifiers.Subscribe) - .WithResources(new Resource(myTopicArn)) - .WithConditions(ConditionFactory.NewEndpointCondition("*@my-company.com"))); - - - The endpoint pattern against which to compare the requested - endpoint for an Amazon SNS topic subscription. - A new access control policy condition that compares the endpoint - used in a request to subscribe to an Amazon SNS topic with the - endpoint pattern specified. - - - - Constructs a new AWS access control policy condition that allows an - access control statement to restrict subscriptions to an Amazon SNS topic - based on the protocol being used for the subscription. For example, this - condition can restrict subscriptions to a topic to endpoints using HTTPS - to ensure that messages are securely delivered. - - The protocol against which to compare the requested protocol - for an Amazon SNS topic subscription. - A new access control policy condition that compares the - notification protocol requested in a request to subscribe to an - Amazon SNS topic with the protocol value specified. - - - - An AWS access control policy is a object that acts as a container for one or - more statements, which specify fine grained rules for allowing or denying - various types of actions from being performed on your AWS resources. - - By default, all requests to use your resource coming from anyone but you are - denied. Access control polices can override that by allowing different types - of access to your resources, or by explicitly denying different types of - access. - - - Each statement in an AWS access control policy takes the form: - "A has permission to do B to C where D applies". - - - A is the prinicpal - The AWS account that is making a request to - access or modify one of your AWS resources. - - - - B is the action - the way in which your AWS resource is being accessed or modified, such - as sending a message to an Amazon SQS queue, or storing an object in an Amazon S3 bucket. - - - - C is the resource - your AWS entity that the principal wants to access, such - as an Amazon SQS queue, or an object stored in Amazon S3. - - - - D is the set of conditions - optional constraints that specify when to allow or deny - access for the principal to access your resource. Many expressive conditions are available, - some specific to each service. For example you can use date conditions to allow access to - your resources only after or before a specific time. - - - - - - Note that an AWS access control policy should not be confused with the - similarly named "POST form policy" concept used in Amazon S3. - - - - - - The default policy version - - - - - Constructs an empty AWS access control policy ready to be populated with - statements. - - - - - Constructs a new AWS access control policy with the specified policy ID. - The policy ID is a user specified string that serves to help developers - keep track of multiple polices. Policy IDs are often used as a human - readable name for a policy. - - The policy ID for the new policy object. Policy IDs serve to - help developers keep track of multiple policies, and are often - used to give the policy a meaningful, human readable name. - - - - Constructs a new AWS access control policy with the specified policy ID - and collection of statements. The policy ID is a user specified string - that serves to help developers keep track of multiple polices. Policy IDs - are often used as a human readable name for a policy. - - The policy ID for the new policy object. Policy IDs serve to - help developers keep track of multiple policies, and are often - used to give the policy a meaningful, human readable name. - The statements to include in the new policy. - - - - Gets and Sets the policy ID for this policy. Policy IDs serve to help - developers keep track of multiple policies, and are often used as human - readable name for a policy. - - - - - Sets the policy ID for this policy and returns the updated policy so that - multiple calls can be chained together. - - Policy IDs serve to help developers keep track of multiple policies, and - are often used as human readable name for a policy. - - - The polich ID for this policy - this instance - - - - Gets and sets the version of this AWS policy. - - - - - Gets and Sets the collection of statements contained by this policy. Individual - statements in a policy are what specify the rules that enable or disable - access to your AWS resources. - - - - - Checks to see if the permissions set in the statement are already set by another - statement in the policy. - - The statement to verify - True if the statement's permissions are already allowed by the statement - - - - Sets the collection of statements contained by this policy and returns - this policy object so that additional method calls can be chained - together. - - Individual statements in a policy are what specify the rules that enable - or disable access to your AWS resources. - - - The collection of statements included in this policy. - this instance - - - - Returns a JSON string representation of this AWS access control policy, - suitable to be sent to an AWS service as part of a request to set an - access control policy. - - A JSON string representation of this AWS access control policy. - - - - Returns a JSON string representation of this AWS access control policy, - suitable to be sent to an AWS service as part of a request to set an - access control policy. - - Toggle pretty print for the generated JSON document - A JSON string representation of this AWS access control policy. - - - - Parses a JSON document of a policy and creates a Policy object. - - JSON document of a policy. - - - - - A principal is an AWS account which is being allowed or denied access to a - resource through an access control policy. The principal is a property of the - Statement object, not directly the object. - - The principal is A in the statement - "A has permission to do B to C where D applies." - - - In an access control policy statement, you can set the principal to all - authenticated AWS users through the member. This - is useful when you don't want to restrict access based on the identity of the - requester, but instead on other identifying characteristics such as the - requester's IP address. - - - - - - Principal instance that includes all authenticated AWS users. - - This is useful when you don't want to restrict access based on the - identity of the requester, but instead on other identifying - characteristics such as the requester's IP address. - - - - - - The anonymous Principal. - - - - - The default Principal provider for AWS accounts. - - - - - Principal provider for Canonical User IDs. - - - - - Principal provider for federated users (using a SAML identity provider) - - - - - Principal provider for assume role policies that will be assumed by an AWS service - (e.g. "ec2.amazonaws.com"). - - - - - Dummy principal provider for anonynous. - - - - - Constructs a new principal with the specified AWS account ID. - - An AWS account ID. - - - - Constructs a new principal with the specified provider and id - - The provider of the principal - The unique ID of the Principal within the provider - - - - Constructs a new principal with the specified provider and id - and optionally strips hyphens from the id - - The provider of the principal - The unique ID of the Principal within the provider - Strip hyphen - - - - Gets and sets the provider for this principal, which indicates in what group of - users this principal resides. - - - - - Gets the unique ID for this principal. - - - - - Represents a resource involved in an AWS access control policy statement. - Resources are the service specific AWS entities owned by your account. Amazon - SQS queues, Amazon S3 buckets and objects, and Amazon SNS topics are all - examples of AWS resources. - - The standard way of specifying an AWS resource is with an Amazon Resource - Name (ARN). - - - The resource is C in the statement - "A has permission to do B to C where D applies." - - - - - - Constructs a new AWS access control policy resource. Resources are - typically specified as Amazon Resource Names (ARNs). - - You specify the resource using the following Amazon Resource Name (ARN) - format: arn:aws:<vendor>:<region>:<namespace>:<relative-id> - - - >vendor identifies the AWS product (e.g., sns) - - - region is the AWS Region the resource resides in (e.g., us-east-1), if any - - - namespace is the AWS account ID with no hyphens (e.g., 123456789012) - - - relative-id is the service specific portion that identifies the specific resource - - - - - For example, an Amazon SQS queue might be addressed with the following - ARN: arn:aws:sqs:us-east-1:987654321000:MyQueue - - - Some resources may not use every field in an ARN. For example, resources - in Amazon S3 are global, so they omit the region field: - arn:aws:s3:::bucket/* - - - The Amazon Resource Name (ARN) uniquely identifying the desired AWS resource. - - - - Gets the resource ID, typically an Amazon Resource Name (ARN), - identifying this resource. - - - - - A factory for creating resources to be used in the policy. - - - - - Constructs a new bucket resource that represents the the specified bucket - but not any of the contained objects. - - The name of the bucket represented by this AWS access control - policy resource. - - - - Constructs a new object resource that represents the specified objects. - The keyPattern argument may contain the '*' wildcard to match multiple - objects. For example, an object resource created for bucket 'mybucket' - and key pattern 'foo*' will match any object stored in 'mybucket' with a - key that starts with 'foo'. - - The name of the bucket containing the object or objects - represented by this resource. - The key or key pattern, which can optionally contain the '*' - wildcard to include multiple objects in the resource. - - - - Constructs a new SQS queue resource for an access control policy. A - policy statement using this resource will allow or deny actions on the - specified queue. - - The AWS account ID of the queue owner. - The name of the Amazon SQS queue. - - - - A statement is the formal description of a single permission, and is always - contained within a policy object. - - A statement describes a rule for allowing or denying access to a specific AWS - resource based on how the resource is being accessed, and who is attempting - to access the resource. Statements can also optionally contain a list of - conditions that specify when a statement is to be honored. - - - For example, consider a statement that: - - - A is the prinicpal - The AWS account that is making a request to - access or modify one of your AWS resources. - - - - B is the action - the way in which your AWS resource is being accessed or modified, such - as sending a message to an Amazon SQS queue, or storing an object in an Amazon S3 bucket. - - - - C is the resource - your AWS entity that the principal wants to access, such - as an Amazon SQS queue, or an object stored in Amazon S3. - - - - D is the set of conditions - optional constraints that specify when to allow or deny - access for the principal to access your resource. Many expressive conditions are available, - some specific to each service. For example you can use date conditions to allow access to - your resources only after or before a specific time. - - - - - - There are many resources and conditions available for use in statements, and - you can combine them to form fine grained custom access control polices. - - - - - - The effect is the result that you want a policy statement to return at - evaluation time. A policy statement can either allow access or explicitly - deny access. - - - - - Constructs a new access control policy statement with the specified - effect. - - Before a statement is valid and can be sent to AWS, callers must set the - principals, resources, and actions (as well as any optional conditions) - involved in the statement. - - - The effect this statement has (allowing access or denying - access) when all conditions, resources, principals, and - actions are matched. - - - - Gets and Sets the ID for this statement. Statement IDs serve to help keep track - of multiple statements, and are often used to give the statement a - meaningful, human readable name. - - Developers should be careful to not use the same statement ID for - multiple statements in the same policy. Reusing the same statement ID in - different policies is not a problem. - - - - - - Sets the ID for this statement and returns the updated statement so - multiple calls can be chained together. - - Statement IDs serve to help keep track of multiple statements, and are - often used to give the statement a meaningful, human readable name. - - - Developers should be careful to not use the same statement ID for - multiple statements in the same policy. Reusing the same statement ID in - different policies is not a problem. - - - The new statement ID for this statement. - this instance - - - - Gets and Sets the result effect of this policy statement when it is evaluated. - A policy statement can either allow access or explicitly - - - - - Gets and Sets the list of actions to which this policy statement applies. - Actions limit a policy statement to specific service operations that are - being allowed or denied by the policy statement. For example, you might - want to allow any AWS user to post messages to your SQS queue using the - SendMessage action, but you don't want to allow those users other actions - such as ReceiveMessage or DeleteQueue. - - - - - Sets the list of actions to which this policy statement applies and - returns this updated Statement object so that additional method calls can - be chained together. - - Actions limit a policy statement to specific service operations that are - being allowed or denied by the policy statement. For example, you might - want to allow any AWS user to post messages to your SQS queue using the - SendMessage action, but you don't want to allow those users other actions - such as ReceiveMessage or DeleteQueue. - - - The list of actions to which this statement applies. - this instance - - - - Gets and Sets the resources associated with this policy statement. Resources - are what a policy statement is allowing or denying access to, such as an - Amazon SQS queue or an Amazon SNS topic. - - Note that some services allow only one resource to be specified per - policy statement. - - - - - - Sets the resources associated with this policy statement and returns this - updated Statement object so that additional method calls can be chained - together. - - Resources are what a policy statement is allowing or denying access to, - such as an Amazon SQS queue or an Amazon SNS topic. - - - Note that some services allow only one resource to be specified per - policy statement. - - - The resources associated with this policy statement. - this instance - - - - Gets and Sets the conditions associated with this policy statement. Conditions - allow policy statements to be conditionally evaluated based on the many - available condition types. - - For example, a statement that allows access to an Amazon SQS queue could - use a condition to only apply the effect of that statement for requests - that are made before a certain date, or that originate from a range of IP - addresses. - - - When multiple conditions are included in a single statement, all - conditions must evaluate to true in order for the statement to take - effect. - - - - - - Sets the conditions associated with this policy statement, and returns - this updated Statement object so that additional method calls can be - chained together. - - Conditions allow policy statements to be conditionally evaluated based on - the many available condition types. - - - For example, a statement that allows access to an Amazon SQS queue could - use a condition to only apply the effect of that statement for requests - that are made before a certain date, or that originate from a range of IP - addresses. - - - Multiple conditions can be included in a single statement, and all - conditions must evaluate to true in order for the statement to take - effect. - - - The conditions associated with this policy statement. - this instance - - - - Gets and Sets the principals associated with this policy statement, indicating - which AWS accounts are affected by this policy statement. - - - - - Sets the principals associated with this policy statement, and returns - this updated Statement object. Principals control which AWS accounts are - affected by this policy statement. - - If you don't want to restrict your policy to specific users, you can use - to apply the policy to any user trying to - access your resource. - - - The list of principals associated with this policy statement. - this instance - - - - The available AWS access control policy actions for Amazon AppStream. - - - - - - The available AWS access control policy actions for Auto Scaling. - - - - - - The available AWS access control policy actions for AWS Billing. - - - - - - The available AWS access control policy actions for AWS CloudFormation. - - - - - - The available AWS access control policy actions for Amazon CloudFront. - - - - - - The available AWS access control policy actions for Amazon CloudSearch. - - - - - - The available AWS access control policy actions for AWS CloudTrail. - - - - - - The available AWS access control policy actions for Amazon CloudWatch. - - - - - - The available AWS access control policy actions for Amazon CloudWatch Logs. - - - - - - The available AWS access control policy actions for Amazon Cognito Identity. - - - - - - The available AWS access control policy actions for Amazon Cognito Sync. - - - - - - The available AWS access control policy actions for AWS Direct Connect. - - - - - - The available AWS access control policy actions for Amazon DynamoDB. - - - - - - The available AWS access control policy actions for Amazon EC2. - - - - - - The available AWS access control policy actions for AWS ElastiCache. - - - - - - The available AWS access control policy actions for AWS Elastic Beanstalk. - - - - - - The available AWS access control policy actions for Elastic Load Balancing. - - - - - - The available AWS access control policy actions for Amazon Elastic MapReduce. - - - - - - The available AWS access control policy actions for Amazon Elastic Transcoder. - - - - - - The available AWS access control policy actions for Amazon Glacier. - - - - - - The available AWS access control policy actions for AWS Identity and Access Management. - - - - - - The available AWS access control policy actions for AWS Import Export. - - - - - - The available AWS access control policy actions for Amazon Kinesis. - - - - - - The available AWS access control policy actions for AWS Marketplace. - - - - - - The available AWS access control policy actions for AWS Marketplace Management Portal. - - - - - - The available AWS access control policy actions for Amazon Mobile Analytics. - - - - - - The available AWS access control policy actions for AWS OpsWorks. - - - - - - The available AWS access control policy actions for Amazon RDS. - - - - - - The available AWS access control policy actions for Amazon Redshift. - - - - - - The available AWS access control policy actions for Amazon Route 53. - - - - - - The available AWS access control policy actions for Amazon S3. - - - - - - The available AWS access control policy actions for AWS Security Token Service. - - - - - - The available AWS access control policy actions for Amazon SES. - - - - - - The available AWS access control policy actions for Amazon SimpleDB. - - - - - - The available AWS access control policy actions for Amazon Simple Workflow Service. - - - - - - The available AWS access control policy actions for Amazon SNS. - - - - - - The available AWS access control policy actions for Amazon SQS. - - - - - - The available AWS access control policy actions for Amazon Storage Gateway. - - - - - - The available AWS access control policy actions for AWS Whispersync. - - - - - - The available AWS access control policy actions for Amazon Zocalo. - - - - - - Deserializes a JSON string into a AWS policy object. - - - - - Serializes an AWS policy object to a JSON string, suitable for sending to an - AWS service. - - - - Converts the specified AWS policy object to a JSON string, suitable for - passing to an AWS service. - - @param policy - The AWS policy object to convert to a JSON string. - - @return The JSON string representation of the specified policy object. - - @throws IllegalArgumentException - If the specified policy is null or invalid and cannot be - serialized to a JSON string. - - - - Uses the specified generator to write the JSON data for the principals in - the specified policy statement. - - - - - This sorts the conditions by condition type and key with the list of values for that combination. - - The list of conditions to be sorted. - - - - - Exception thrown by the SDK for errors that occur within the SDK. - - - - - This exception is thrown when there is a parse error on the response back from AWS. - - - - - The string value which could not be converted into a valid DateTime instance. - - - - - Occurs before a request is marshalled. - - - - - Occurs before a request is issued against the service. - - - - - Occurs after a response is received from the service. - - - - - Occurs after an exception is encountered. - - - - - Patches the in-flight uri to stop it unescaping the path etc (what Uri did before - Microsoft deprecated the constructor flag). This is particularly important for - Amazon S3 customers who want to use backslash (\) in their key names. - - - Different behavior in the various runtimes has been observed and in addition some - 'documented' ways of doing this between 2.x and 4.x runtimes has also been observed - to not be reliable. - - This patch effectively emulates what adding a schemesettings element to the - app.config file with value 'name="http" genericUriParserOptions="DontUnescapePathDotsAndSlashes"' - does. As we're a dll, that avenue is not open to us. - - - - - - Used to create a copy of the config for a different service than the current instance. - - Target service ClientConfig - The new ClientConfig for the desired service - - - - A base exception for some Amazon Web Services. - - Most exceptions thrown to client code will be service-specific exceptions, though some services - may throw this exception if there is a problem which is caught in the core client code. - - - - - - Whether the error was attributable to Sender or Reciever. - - - - - The error code returned by the service - - - - - The id of the request which generated the exception. - - - - - The HTTP status code from the service response - - - - - Flag indicating if the exception is retryable and the associated retry - details. A null value indicates that the exception is not retryable. - - - - - Class containing the retryable details for an AmazonServiceException - - - - - This property indicates that this exception is a - throttling exception and should be subject to congestion - control throttling. - - - - - This exception is thrown when there is a parse error on the response back from AWS. - - - - - Last known location in the response that was parsed, if available. - - - - - The entire response body that caused this exception, if available. - - - - - Base class for request used by some of the services. - - - - - This flag specifies if SigV4 will be used for the current request. - - - - - Gets or Sets a value indicating if "Expect: 100-continue" HTTP header will be - sent by the client for this request. The default value is false. - - - - - Gets the signer to use for this request. - A null return value indicates to use the configured - signer for the service that this request is part of. - - A signer for this request, or null. - - - - Abstract class for Response objects, contains only metadata, - and no result information. - - - - - Contains additional information about the request, such as the - Request Id. - - - - - Returns the content length of the HTTP response. - - - - - Returns the status code of the HTTP response. - - - - - Base class for determining region based on inspection. - - - - - Sets the Region property by looking up the corresponding RegionEndpoint - from the supplied region system name (us-east-1, us-west-2 etc). - - The system name of the region. - - - - Determines region based on application configuration settings. If the configuration does not contain - the region setting key an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of ApplicationConfigAWSRegion. If no region is found in the - application configuration file then an InvalidOperationException is thrown. - - - - - Probing mechanism to determine region from various sources. - - - - - This class is responsible for keeping track of Retry capacity across different ServiceURLs. - - - - - CapacityType determines the type of capacity to obtain or use. - - - - - The increment capacity type adds capacity. - - - - - The default retry capacity type uses the default capacity amount. - - - - - The timeout capacity type uses the timeout capacity amount. - - - - - This method acquires a said retry capacity if the container has the capacity. - - Contains the RetryCapacity object for the said ServiceURL. - - - - This method acquires a said retry capacity if the container has the capacity. - - Contains the RetryCapacity object for the said ServiceURL. - Specifies what capacity type cost to use for obtaining capacity - - - - This method calls a method to release capacity back - based on whether it was a successful response or a successful retry response. This is invoked by a retry request response. - - if this request is a retry, use a different capacity cost - Contains the RetryCapacity object for the said ServiceURL. - - - - This method calls a method to release capacity back - based on whether it was a successful response or a successful retry response. This is invoked by a retry request response. - - Specifies what capacity type cost to use for adding capacity - Contains the RetryCapacity object for the said ServiceURL. - - - - Ths method fetches the RetryCapacity for the given ServiceURL from CapacityManager.CapacityContainer - - - - - This method releases capacity back. This is invoked by the TryReleaseCapacity method. - - Contains the RetryCapacity object for the said ServiceURL. - The capacity that needs to be released based on whether it was a successful response or a successful retry response. - - - - This class is the RetryCapacity class for a given ServiceURL. - - - - - This class composes Client Context header for Amazon Web Service client. - It contains information like app title, version code, version name, client id, OS platform etc. - - - This class composes Client Context header for Amazon Web Service client. - It contains information like app title, version code, version name, client id, OS platform etc. - - - - - Adds the custom attributes to the Client Context. - - Key. - Value. - - - - Gets a Json Representation of the Client Context. - - Json Representation of Client Context - - - - Collection of parameters that an SDK client will send to a service. - - - - - Constructs empty ParameterCollection. - - - - - Adds a parameter with a string value. - - - - - - - Adds a parameter with a list-of-strings value. - - - - - - - Converts the current parameters into a list of key-value pairs. - - - - - - This class is responsible for managing adaptive retry mode client rate limiting. - - - - - The rate at which token are replenished. - - - - - The maximum capacity allowed in the token - - - - - The current capacity of the token - - - - - The last time the token bucket was refilled. - - - - - The smoothed rate which tokens are being retrieved. - - - - - The last half second time bucket used. - - - - - The number of requests seen within the current time - - - - - The maximum rate when the client was last throttled. - - - - - The last time when the client was throttled. - - - - - The cached time window calculation - - - - - Boolean indicating if the token bucket is enabled. - - - - - This method attempts to acquire capacity from the client's token - - The amount of capacity to obtain from the token bucket - Indicates that the client should or shouldn't sleep and - try again if capacity cannot be obtained. - - - - - This method attempts to acquire capacity from the client's token - - The amount of capacity to obtain from the token bucket - Indicates that the client should or shouldn't sleep and - try again if capacity cannot be obtained. - - Token which can be used to cancel the task. - - - - Updates the sending rate within the client's token bucket - - Indicates if the request resulted in a throttling error. - - - - Calculates the rate - - - Returns the calculated rate for a successful call - - - - Calculates the rate. - - The rate to use in the calculation - Returns the calculated rate for a throttled call - - - - Collection used to indicate if the property was initialized was created by the SDK. - - - - - - Collection used to indicate if the property was initialized was created by the SDK. - - - - - - - Default implementation of the IRequest interface. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Constructs a new DefaultRequest with the specified service name and the - original, user facing request object. - - The orignal request that is being wrapped - The service name - - - - The name of the request - - - - - Gets and sets the type of http request to make, whether it should be POST,GET or DELETE - - - - - Gets and sets a flag that indicates whether the request is sent as a query string instead of the request body. - - - - - Returns the original, user facing request object which this internal - request object is representing. - - - - - Returns a dictionary of the headers included in this request. - - - - - Returns a dictionary of the parameters included in this request. - - - - - Collection of parameters included in this request. - - - - - Returns the subresources that should be appended to the resource path. - This is used primarily for Amazon S3, where object keys can contain '?' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new null entry to the SubResources collection for the request - - The name of the subresource - - - - Adds a new entry to the SubResources collection for the request - - The name of the subresource - Value of the entry - - - - Gets and Sets the endpoint for this request. - - - - - Gets and Sets the resource path added on to the endpoint. - - - - - Returns the path resources that should be used within the resource path. - This is used for services where path keys can contain '/' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new entry to the PathResources collection for the request - - The name of the pathresource with potential greedy syntax: {key+} - Value of the entry - - - - Gets and Sets the version number for the marshaller used to create this request. The version number - is used to support backward compatible changes that would otherwise be breaking changes when a - newer core is used with an older service assembly. - Versions: - 1 - Default version - 2 - Support for path segments - - - - - Gets and Sets the content for this request. - - - - - Flag that signals that Content was and should be set - from the Parameters collection. - - - - - Gets and sets the content stream. - - - - - Gets and sets the original stream position. - If ContentStream is null or does not support seek, this propery - should be equal to -1. - - - - - Computes the SHA 256 hash of the content stream. If the stream is not - seekable, it searches the parent stream hierarchy to find a seekable - stream prior to computation. Once computed, the hash is cached for future - use. If a suitable stream cannot be found to use, null is returned. - - - - - The name of the service to which this request is being sent. - - - - - Alternate endpoint to use for this request, if any. - - - - - Host prefix value to prepend to the endpoint for this request, if any. - - - - - Gets and sets the Suppress404Exceptions property. If true then 404s return back from AWS will not cause an exception and - an empty response object will be returned. - - - - - If using AWS4 signing protocol, contains the resultant parts of the - signature that we may need to make use of if we elect to do a chunked - encoding upload. - - - - - Determine whether to use a chunked encoding upload for the request - (applies to Amazon S3 PutObject and UploadPart requests only). - - - - - - Used for Amazon S3 requests where the bucket name is removed from - the marshalled resource path into the host header. To comply with - AWS2 signature calculation, we need to recover the bucket name - and include it in the resource canonicalization, which we do using - this field. - - - - - This flag specifies if SigV4 is required for the current request. - - - - - The authentication region to use for the request. - Set from Config.AuthenticationRegion. - - - - - The region in which the service request was signed. - - - - - Checks if the request stream can be rewinded. - - Returns true if the request stream can be rewinded , - else false. - - - - Returns true if the request can contain a request body, else false. - - Returns true if the currect request can contain a request body, else false. - - - - Returns true if the request has a body, else false. - - Returns true if the request has a body, else false. - - - - Class containing the data for one endpoint returned from a endpoint discovery request - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Constructs a new DiscoveryEndpoint - - The address of the endpoint - The cache period for the endpoint in minutes - - - - The address of the endpoint. - - - - - The cache period for the endpoint in minutes - - - - - Calculates if this endpoint has expired - - A boolean value indicating if the cache period has expired - - - - Extends the endpoint expiration by the specified number of minutes from now. - - - - - Class containing the data for one endpoint returned from a endpoint discovery request - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class containing the data to use with endpoint discovery - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Gets/sets and flag indicating if endpoint discovery is required for the request. - - - - - Sorted dictionary of the identifiers that must be sent with the endpoint discovery request. These - identifiers are used to construct the cache key for the cache that stores discovered endpoints. A - sorted dictionary is used instead of a dictionary to ensure the cache key comes out in the same order - each time it is constructed. - - - - - Represents the data to be used with endpoint discovery operations - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class used to resolve endpoints using Endpoint Discovery. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Method that performs endpoint discovery for the current operation - - Context information used in calculations for endpoint discovery - The operation to fetch endpoints from the server - - - - - Gets the number of cache keys in the cache - - - - - Class used to resolve endpoints using Endpoint Discovery. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class containing context information to use with endpoint discovery - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Gets the customer credential information. - - - - - Gets the operation name. - - - - - Gets the current marshalled endpoint discovery data. - - - - - Gets the flag indicating if the specified key should be evicted from the cache. - - - - - Gets the Uri that should be evicted if EvictCacheKey is set to true. - - - - - Class containing context information to use with endpoint discovery - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Error type, one of Sender, Receiver, Unknown - Only applies to XML-based services. - - - - - Name of the exception class to return - - - - - Error message - - - - - RequestId of the error. - Only applies to XML-based services. - - - - - InternalConfiguration holds the cached SDK configuration values - obtained from the environment and profile configuration - factories. These configuration values are loaded internally and - are not the same as user exposed AWSConfigs. - - - - - Flag indicating if Endpoint Discovery is enabled. - - - - - The retry mode to use: Legacy, Standard, or Adaptive. - - - - - The max number of request attempts. - - - - - Probing mechanism to determine the configuration values from various sources. - - - - - Resets all the configuration values reloading as needed. This method will use - the AWS_PROFILE environment variable if set to construct the instance. Otherwise - the default profile will be used. - - - - - Flag that specifies if endpoint discovery is enabled, disabled, - or not set. - - - - - Flag that specifies which retry mode to use or if retry mode has - not been set. - - - - - Flag that specifies the max number of request attempts or if max - attempts has not been set. - - - - - Class containing the members used to invoke service calls - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class containing the members used to invoke service calls - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Represents a request being sent to an Amazon Web Service, including the - parameters being sent as part of the request, the endpoint to which the - request should be sent, etc. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - The name of the request - - - - - Returns a dictionary of the headers included in this request. - - - - - Gets and sets a flag that indicates whether the request is sent as a query string instead of the request body. - - - - - Returns a dictionary of the parameters included in this request. - - - - - Collection of parameters included in this request. - - - - - Returns the subresources that should be appended to the resource path. - This is used primarily for Amazon S3, where object keys can contain '?' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new null entry to the SubResources collection for the request - - The name of the subresource - - - - Adds a new entry to the SubResources collection for the request - - The name of the subresource - Value of the entry - - - - Gets and sets the type of http request to make, whether it should be POST,GET or DELETE - - - - - Gets and Sets the endpoint for this request. - - - - - Gets and Sets the resource path added on to the endpoint. - - - - - Returns the path resources that should be used within the resource path. - This is used for services where path keys can contain '/' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new entry to the PathResources collection for the request - - The name of the pathresource with potential greedy syntax: {key+} - Value of the entry - - - - Gets and Sets the version number for the marshaller used to create this request. The version number - is used to support backward compatible changes that would otherwise be breaking changes when a - newer core is used with an older service assembly. - - - - - Gets and Sets the content for this request. - - - - - Gets the header value from the request. - - - - - Flag that signals that Content was and should be set - from the Parameters collection. - - - - - Gets and sets the content stream. - - - - - Gets and sets the original stream position. - If ContentStream is null or does not support seek, this propery - should be equal to -1. - - - - - Computes the SHA 256 hash of the content stream. If the stream is not - seekable, it searches the parent stream hierarchy to find a seekable - stream prior to computation. Once computed, the hash is cached for future - use. - - - - - The name of the service to which this request is being sent. - - - - - Returns the original, user facing request object which this internal - request object is representing. - - - - - Alternate endpoint to use for this request, if any. - - - - - Host prefix value to prepend to the endpoint for this request, if any. - - - - - Gets and sets the Suppress404Exceptions property. If true then 404s return back from AWS will not cause an exception and - an empty response object will be returned. - - - - - If using AWS4 signing protocol, contains the resultant parts of the - signature that we may need to make use of if we elect to do a chunked - encoding upload. - - - - - Determine whether to use a chunked encoding upload for the request - (applies to Amazon S3 PutObject and UploadPart requests only). - - - - - - Used for Amazon S3 requests where the bucket name is removed from - the marshalled resource path into the host header. To comply with - AWS2 signature calculation, we need to recover the bucket name - and include it in the resource canonicalization, which we do using - this field. - - - - - This flag specifies if SigV4 is required for the current request. - - - - - The authentication region to use for the request. - Set from Config.AuthenticationRegion. - - - - - The region in which the service request was signed. - - - - - Checks if the request stream can be rewinded. - - Returns true if the request stream can be rewinded , - else false. - - - - Returns true if the request can contain a request body, else false. - - Returns true if the currect request can contain a request body, else false. - - - - Returns true if the request has a body, else false. - - Returns true if the request has a body, else false. - - - - Gets the value of the Service Id. - - - - - Gets the dictionary that gives mapping of renamed operations - - - - - IDictionary{String, String} access to ParameterCollection. - TODO: remove this class in version 3.4 of the SDK. - - - - - Constructs ParametersDictionaryFacade for a ParameterCollection - - - - - - A registry of object that will manipulate the runtime pipeline used by service clients. - - - - - Registers a customizer that will be applied for all service clients created. Each customizer has a unique name associated with it. If a customizer is registered more - than once with the same unique name then the calls after the first will be ignored. - - - - - - Deregistered the runtime pipeline customizer - - - - - - Deregistered the runtime pipeline customizer - - - - - - Applies all of the registered customizers on the runtime pipeline - - The service clients runtime pipeline. - Type object for the service client being created - - - - Interface for objects that will customize the runtime pipleine for newly created service clients. - - - - - The unique name for the customizer that identifies the customizer in the registry. The name is also used to identify the customizer on the SDK logs. - - - - - Called on service clients as they are being constructed to customize their runtime pipeline. - - - Type object for the service client being created - - - - Default ServiceMetadata implementation. - This implementation will be used if the service doesn't have a - IServiceMetadata implementation. - - - - - Gets the value of the Service Id. - - - - - Gets the dictionary that gives mapping of renamed operations - - - - - Computes RFC 2104-compliant HMAC signature. - - - - - Computes RFC 2104-compliant HMAC signature. - - - - - Inspects the supplied evidence to return the signer appropriate for the operation - - Global setting for the service - The request. - Configuration for the client - True if signature v4 request signing should be used - - - - Signs the specified request with the AWS3 signing protocol by using the - AWS account credentials given in the method parameters. - - The AWS public key - The AWS secret key used to sign the request in clear text - Request metrics - The configuration that specifies which hashing algorithm to use - The request to have the signature compute for - If any problems are encountered while signing the request - - - - AWS4 protocol signer for service calls that transmit authorization in the header field "Authorization". - - - - - Calculates and signs the specified request using the AWS4 signing protocol by using the - AWS account credentials given in the method parameters. The resulting signature is added - to the request headers as 'Authorization'. Parameters supplied in the request, either in - the resource path as a query string or in the Parameters collection must not have been - uri encoded. If they have, use the SignRequest method to obtain a signature. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. - - - Client configuration data encompassing the service call (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text. - - - If any problems are encountered while signing the request. - - - - - Calculates and signs the specified request using the AWS4 signing protocol by using the - AWS account credentials given in the method parameters. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. - - - Client configuration data encompassing the service call (notably authentication - region, endpoint and service name). - - - Metrics for the request. - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text. - - - If any problems are encountered while signing the request. - - - Parameters passed as part of the resource path should be uri-encoded prior to - entry to the signer. Parameters passed in the request.Parameters collection should - be not be encoded; encoding will be done for these parameters as part of the - construction of the canonical request. - - - - - Sets the AWS4 mandated 'host' and 'x-amz-date' headers, returning the date/time that will - be used throughout the signing process in various elements and formats. - - The current set of headers - - Date and time used for x-amz-date, in UTC - - - - Sets the AWS4 mandated 'host' and 'x-amz-date' headers, accepting and returning the date/time that will - be used throughout the signing process in various elements and formats. - - The current set of headers - - - Date and time used for x-amz-date, in UTC - - - - Computes and returns an AWS4 signature for the specified canonicalized request - - - - - - - - - - - - Computes and returns an AWS4 signature for the specified canonicalized request - - - - - - - - - - - - - Computes and returns an AWS4 signature for the specified canonicalized request - - - - - - - - - - - - - - Formats the supplied date and time for use in AWS4 signing, where various formats are used. - - - The required format - The UTC date/time in the requested format - - - - Compute and return the multi-stage signing key for the request. - - The clear-text AWS secret key, if not held in secureKey - The region in which the service request will be processed - Date of the request, in yyyyMMdd format - The name of the service being called by the request - Computed signing key - - - - If the caller has already set the x-amz-content-sha256 header with a pre-computed - content hash, or it is present as ContentStreamHash on the request instance, return - the value to be used in request canonicalization. - If not set as a header or in the request, attempt to compute a hash based on - inspection of the style of the request content. - - - - The computed hash, whether already set in headers or computed here. Null - if we were not able to compute a hash. - - - - - If signPayload is false set the x-amz-content-sha256 header to - the UNSIGNED-PAYLOAD magic string and return it. - Otherwise, if the caller has already set the x-amz-content-sha256 header with a pre-computed - content hash, or it is present as ContentStreamHash on the request instance, return - the value to be used in request canonicalization. - If not set as a header or in the request, attempt to compute a hash based on - inspection of the style of the request content. - - - - - The computed hash, whether already set in headers or computed here. Null - if we were not able to compute a hash. - - - - - Returns the HMAC256 for an arbitrary blob using the specified key - - - - - - - - Returns the HMAC256 for an arbitrary blob using the specified key - - - - - - - - Compute and return the hash of a data blob using the specified key - - Algorithm to use for hashing - Hash key - Data blob - Hash of the data - - - - Compute and return the hash of a data blob using the specified key - - Algorithm to use for hashing - Hash key - Data blob - Hash of the data - - - - Computes the non-keyed hash of the supplied data - - - - - - - Computes the non-keyed hash of the supplied data - - - - - - - Computes and returns the canonical request - - The endpoint URL - the path of the resource being operated on - The http method used for the request - The full request headers, sorted into canonical order - The query parameters for the request - - The hash of the binary request body if present. If not supplied, the routine - will look for the hash as a header on the request. - - Canonicalised request as a string - - - - Computes and returns the canonical request - - The endpoint URL - the path of the resource being operated on - The http method used for the request - The full request headers, sorted into canonical order - The query parameters for the request - - The path resource values lookup to use to replace the keys within resourcePath - The hash of the binary request body if present. If not supplied, the routine - will look for the hash as a header on the request. - - The version of the marshaller that constructed the request object. - Canonicalised request as a string - - - - Computes and returns the canonical request - - The endpoint URL - the path of the resource being operated on - The http method used for the request - The full request headers, sorted into canonical order - The query parameters for the request - - The path resource values lookup to use to replace the keys within resourcePath - The hash of the binary request body if present. If not supplied, the routine - will look for the hash as a header on the request. - - The version of the marshaller that constructed the request object. - The service being called for the request - Canonicalised request as a string - - - - Reorders the headers for the request for canonicalization. - - The set of proposed headers for the request - List of headers that must be included in the signature - For AWS4 signing, all headers are considered viable for inclusion - - - - Computes the canonical headers with values for the request. Only headers included in the signature - are included in the canonicalization process. - - All request headers, sorted into canonical order - Canonicalized string of headers, with the header names in lower case. - - - - Returns the set of headers included in the signature as a flattened, ;-delimited string - - The headers included in the signature - Formatted string of header names - - - - Collects the subresource and query string parameters into one collection - ready for canonicalization - - The in-flight request being signed - The fused set of parameters - - - - Computes and returns the canonicalized query string, if query parameters have been supplied. - Parameters with no value will be canonicalized as 'param='. The expectation is that parameters - have not already been url encoded prior to canonicalization. - - The set of parameters being passed on the uri - - Parameters must be uri encoded into the canonical request and by default the signer expects - that the supplied collection contains non-encoded data. Set this to false if the encoding was - done prior to signer entry. - - The uri encoded query string parameters in canonical ordering - - - - Computes and returns the canonicalized query string, if query parameters have been supplied. - Parameters with no value will be canonicalized as 'param='. The expectation is that parameters - have not already been url encoded prior to canonicalization. - - The set of parameters to be encoded in the query string - - Parameters must be uri encoded into the canonical request and by default the signer expects - that the supplied collection contains non-encoded data. Set this to false if the encoding was - done prior to signer entry. - - The uri encoded query string parameters in canonical ordering - - - - Returns the request parameters in the form of a query string. - - The request instance - Request parameters in query string format - - - - AWS4 protocol signer for Amazon S3 presigned urls. - - - - - Calculates and signs the specified request using the AWS4 signing protocol by using the - AWS account credentials given in the method parameters. The resulting signature is added - to the request headers as 'Authorization'. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. - - - Adding supporting data for the service call required by the signer (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text - - - If any problems are encountered while signing the request. - - - - - Calculates the AWS4 signature for a presigned url. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. If the Expires parameter - is present, it is renamed to 'X-Amz-Expires' before signing. - - - Adding supporting data for the service call required by the signer (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text - - - If any problems are encountered while signing the request. - - - Parameters passed as part of the resource path should be uri-encoded prior to - entry to the signer. Parameters passed in the request.Parameters collection should - be not be encoded; encoding will be done for these parameters as part of the - construction of the canonical request. - - - - - Calculates the AWS4 signature for a presigned url. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. If the Expires parameter - is present, it is renamed to 'X-Amz-Expires' before signing. - - - Adding supporting data for the service call required by the signer (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text - - - The service to sign for - - - The region to sign to, if null then the region the client is configured for will be used. - - - If any problems are encountered while signing the request. - - - Parameters passed as part of the resource path should be uri-encoded prior to - entry to the signer. Parameters passed in the request.Parameters collection should - be not be encoded; encoding will be done for these parameters as part of the - construction of the canonical request. - - The X-Amz-Content-SHA256 is cleared out of the request. - If the request is for S3 then the UNSIGNED_PAYLOAD value is used to generate the canonical request. - If the request isn't for S3 then the empty body SHA is used to generate the canonical request. - - - - - Encapsulates the various fields and eventual signing value that makes up - an AWS4 signature. This can be used to retrieve the required authorization string - or authorization query parameters for the final request as well as hold ongoing - signature computations for subsequent calls related to the initial signing. - - - - - Constructs a new signing result instance for a computed signature - - The access key that was included in the signature - Date/time (UTC) that the signature was computed - The collection of headers names that were included in the signature - Formatted 'scope' value for signing (YYYYMMDD/region/service/aws4_request) - Returns the key that was used to compute the signature - Computed signature - - - - The access key that was used in signature computation. - - - - - ISO8601 formatted date/time that the signature was computed - - - - - ISO8601 formatted date that the signature was computed - - - - - The ;-delimited collection of header names that were included in the signature computation - - - - - Formatted 'scope' value for signing (YYYYMMDD/region/service/aws4_request) - - - - - Returns a copy of the key that was used to compute the signature - - - - - Returns the hex string representing the signature - - - - - Returns a copy of the byte array containing the signature - - - - - Returns the signature in a form usable as an 'Authorization' header value. - - - - - Returns the signature in a form usable as a set of query string parameters. - - - - - Null Signer which does a no-op. - - - - - Signs the specified request with the AWS2 signing protocol by using the - AWS account credentials given in the method parameters. - - The AWS public key - The AWS secret key used to sign the request in clear text - Request metrics - The configuration that specifies which hashing algorithm to use - The request to have the signature compute for - If any problems are encountered while signing the request - - - - S3 signer constructor - - - - - S3 signer constructor - - - - - This exception is thrown if there are problems signing the request. - - - - - Response Unmarshaller for all Errors - - - - - Build an ErrorResponse from XML - - The XML parsing context. - Usually an Amazon.Runtime.Internal.UnmarshallerContext. - An ErrorResponse object. - - - - Return an instance of and ErrorResponseUnmarshaller. - - - - - - Interface for unmarshallers which unmarshall objects from response data. - The Unmarshallers are stateless, and only encode the rules for what data - in the XML stream goes into what members of an object. - - The type of object the unmarshaller returns - The type of the XML unmashaller context, which contains the - state during parsing of the XML stream. Usually an instance of - Amazon.Runtime.Internal.Transform.UnmarshallerContext. - - - - Given the current position in the XML stream, extract a T. - - The XML parsing context - An object of type T populated with data from the XML stream. - - - - Interface for unmarshallers which unmarshall service responses. - The Unmarshallers are stateless, and only encode the rules for what data - in the XML stream goes into what members of an object. - - The type of object the unmarshaller returns - The type of the XML unmashaller context, which contains the - state of parsing the XML stream. Uaually an instance of - Amazon.Runtime.Internal.Transform.UnmarshallerContext. - - - - Extracts an exeption with data from an ErrorResponse. - - The XML parsing context. - An inner exception to be included with the returned exception - The HttpStatusCode from the ErrorResponse - Either an exception based on the ErrorCode from the ErrorResponse, or the - general service exception for the service in question. - - - - Interface for unmarshallers which unmarshall objects from response data. - The Unmarshallers are stateless, and only encode the rules for what data - in the XML stream goes into what members of an object. - - The type of object the unmarshaller returns - The type of the XML unmashaller context, which contains the - state during parsing of the XML stream. Usually an instance of - Amazon.Runtime.Internal.Transform.UnmarshallerContext. - - - - Given the current position in the XML stream, extract a T. - - The XML parsing context - An object of type T populated with data from the XML stream. - - - - First-pass unmarshaller for all errors - - - - - Build an ErrorResponse from json - - The json parsing context. - Usually an Amazon.Runtime.Internal.JsonUnmarshallerContext. - An ErrorResponse object. - - - - Return an instance of JsonErrorResponseUnmarshaller. - - - - - - Wraps a json string for unmarshalling. - - Each Read() operation gets the next token. - TestExpression() is used to match the current key-chain - to an xpath expression. The general pattern looks like this: - - JsonUnmarshallerContext context = new JsonUnmarshallerContext(jsonString); - while (context.Read()) - { - if (context.IsKey) - { - if (context.TestExpresion("path/to/element")) - { - myObject.stringMember = stringUnmarshaller.GetInstance().Unmarshall(context); - continue; - } - } - } - - - - - - Wrap the jsonstring for unmarshalling. - - Stream that contains the JSON for unmarshalling - If set to true, maintains a copy of the complete response body constraint to log response size as the stream is being read. - Response data coming back from the request - If set to true, maintains a copy of the complete response body as the stream is being read. - - - - Are we at the start of the json document. - - - - - Is the current token the end of an object - - - - - Is the current token the start of an object - - - - - Returns the element depth of the parser's current position in the json - document being parsed. - - - - - The current Json path that is being unmarshalled. - - - - - Reads to the next token in the json document, and updates the context - accordingly. - - - True if a token was read, false if there are no more tokens to read. - - - - - Peeks at the next token. This peek implementation - reads the next token and makes the subsequent Read() return the same data. - If Peek is called successively, it will return the same data. - Only the first one calls Read(), subsequent calls - will return the same data until a Read() call is made. - - Token to peek. - Returns true if the peeked token matches given token. - - - - Returns the text contents of the current token being parsed. - - - The text contents of the current token being parsed. - - - - - The type of the current token - - - - - Get the base stream of the jsonStream. - - - - - Peeks at the next (non-whitespace) character in the jsonStream. - - The next (non-whitespace) character in the jsonStream, or -1 if at the end. - - - - Peeks at the next character in the stream. - If the data isn't buffered into the StreamReader (Peek() returns -1), - we flush the buffered data and try one more time. - - - - - - Abstract class for unmarshalling service responses. - - - - - Class for unmarshalling XML service responses. - - - - - Class for unmarshalling EC2 service responses. - - - - - Class for unmarshalling JSON service responses. - - - - - Unmarshaller for int fields - - - - - Unmarshaller for nullable int fields. Implemented only for JSON context - to handle cases where value can be null e.g. {'Priority': null}. - This unmarshaller is not implemented for XML context, as XML responses - will null elements (xsi:nil='true') will be skipped by the XML parser. - - - - - Unmarshaller for long fields - - - - - Unmarshaller for float fields - - - - - Unmarshaller for double fields - - - - - Unmarshaller for decimal fields - - - - - Unmarshaller for bool fields - - - - - Unmarshaller for string fields - - - - - Unmarshaller for byte fields - - - - - Unmarshaller for DateTime fields - - - - - Unmarshalls given string as a DateTime. Handles cases where we want to unmarshall - as just a DateTime or a nullable Datetime. - - Value to be parsed - If true, the method will return null if text is null. - If false, the method will return default(DateTime), if text is null. - - - - - Unmarshaller for nullable DateTime fields. Implemented only for JSON context - to handle cases where value can be null e.g. {'Priority': null}. - This unmarshaller is not implemented for XML context, as XML responses - will null elements (xsi:nil='true') will be skipped by the XML parser. - - - - - Unmarshaller for MemoryStream fields - - - - - Unmarshaller for ResponseMetadata - - - - - Base class for the UnmarshallerContext objects that are used - to unmarshall a web-service response. - - - - - Tests the specified expression against the current position in the XML - document - - The pseudo-XPath expression to test. - - True if the expression matches the current position in the document, - false otherwise. - - - - Tests the specified expression against the current position in the XML - document being parsed, and restricts the expression to matching at the - specified stack depth. - - The pseudo-XPath expression to test. - - The depth in the stack representing where the expression must - start matching in order for this method to return true. - - True if the specified expression matches the current position in - the XML document, starting from the specified depth. - - - - Reads the next token at depth greater than or equal to target depth. - - Tokens are read at depth greater than or equal to target depth. - True if a token was read and current depth is greater than or equal to target depth. - - - - The current path that is being unmarshalled. - - - - - Returns the element depth of the parser's current position in the - document being parsed. - - - - - Reads to the next node in the document, and updates the context accordingly. - - - True if a node was read, false if there are no more elements to read. - - - - - Returns the text contents of the current element being parsed. - - - The text contents of the current element being parsed. - - - - - True if NodeType is Element. - - - - - True if NodeType is EndElement. - - - - - True if the context is at the start of the document. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Wrap an XmltextReader for simulating an event stream. - - Each Read() operation goes either to the next element or next attribute within - the current element. TestExpression() is used to match the current event - to an xpath expression. The general pattern looks like this: - - UnmarshallerContext context = new UnmarshallerContext(...); - while (context.Read()) - { - if (context.TestExpresion("path/to/element")) - { - myObject.stringMember = stringUnmarshaller.GetInstance().Unmarshall(context); - continue; - } - if (context.TestExpression("path/to/@attribute")) - myObject.MyComplexTypeMember = MyComplexTypeUnmarshaller.GetInstance().Unmarshall(context); - } - - - - - - Wrap an XmlTextReader with state for event-based parsing of an XML stream. - - Stream with the XML from a service response. - If set to true, maintains a copy of the complete response body constraint to log response size as the stream is being read. - Response data coming back from the request - If set to true, maintains a copy of the complete response body as the stream is being read. - - - - The current XML path that is being unmarshalled. - - - - - Returns the element depth of the parser's current position in the XML - document being parsed. - - - - - Reads to the next node in the XML document, and updates the context accordingly. - - - True if a node was read, false if there are no more elements to read./ - - - - - Returns the text contents of the current element being parsed. - - - The text contents of the current element being parsed. - - - - - True if NodeType is Element. - - - - - True if NodeType is EndElement. - - - - - True if the context is at the start of the document. - - - - - True if NodeType is Attribute. - - - - - Wrap an XmlTextReader with state for event-based parsing of an XML stream. - - Stream with the XML from a service response. - If set to true, maintains a copy of the complete response body constraint to log response size as the stream is being read. - Response data coming back from the request - If set to true, maintains a copy of the complete response body as the stream is being read. - - - - RequestId value, if found in response - - - - - Reads to the next node in the XML document, and updates the context accordingly. - If node is RequestId, reads the contents and stores in RequestId property. - - - True if a node was read, false if there are no more elements to read./ - - - - - A stream which caches the contents of the underlying stream as it reads it. - - - - - All the bytes read by the stream. - - - - - All the bytes read by the stream constrained with _cacheLimit - - - - - Initializes the CachingWrapperStream with a base stream. - - The stream to be wrapped. - Maximum number of bytes to be cached. - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Gets a value indicating whether the current stream supports seeking. - CachingWrapperStream does not support seeking, this will always be false. - - - - - Gets or sets the position within the current stream. - CachingWrapperStream does not support seeking, attempting to set Position - will throw NotSupportedException. - - - - - Sets the position within the current stream. - CachingWrapperStream does not support seeking, attempting to call Seek - will throw NotSupportedException. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Stream wrapper that double-buffers from a wrapped stream and - returns the buffered content as a series of signed 'chunks' - for the AWS4 ('Signature V4') protocol. - - - - - Reads some or all of the processed chunk to the consumer, constructing - and streaming a new chunk if more input data is available. - - - - - - - - - Attempt to read sufficient data for a whole chunk from the wrapped stream, - returning the number of bytes successfully read to be processed into a chunk - - - - - Results of the header-signing portion of the request - - - - - Computed signature of the chunk prior to the one in-flight, in - hex - - - - - Computes the derived signature for a chunk of data of given length in the input buffer, - placing a formatted chunk with headers, signature and data into the output buffer - ready for streaming back to the consumer. - - - - - - Length override to return the true length of the payload plus the metainfo - supplied with each chunk - - - - - Computes the total size of the data payload, including the chunk metadata. - Called externally so as to be able to set the correct Content-Length header - value. - - - - - - - Computes the size of the header data for each chunk. - - - - - - - Attempt to read sufficient data for a whole chunk from the wrapped stream, - returning the number of bytes successfully read to be processed into a chunk - - - - - A list object that will always be sent to AWS services, - even if it is empty. - The AWS .NET SDK does not send empty collections to services, unless - the collection is of this type. - - - - - - A dictionary object that will always be sent to AWS services, - even if it is empty. - The AWS .NET SDK does not send empty collections to services, unless - the collection is of this type. - - - - - - - Class to perform actions on a background thread. - Uses a single background thread and performs actions - on it in the order the data was sent through the instance. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Class to invoke actions on a background thread. - Uses a single background thread and invokes actions - on it in the order they were invoked through the instance. - - - - - PCL doesn't have IPAddress. These methods are copied from the Microsoft source code. - - - - - Returns true if the Content is set or there are - query parameters. - - This request - True if data is present; false otherwise. - - - - Utilities for dealing with Guids - - - - - Hashes a set of objects. - - - - - - - Combines a set of hashses. - - - - - - - Combines two hashes. - - - - - - - - Disposes of all managed and unmanaged resources. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - A wrapper stream that calculates a hash of the base stream as it - is being read. - The calculated hash is only available after the stream is closed or - CalculateHash is called. After calling CalculateHash, any further reads - on the streams will not change the CalculatedHash. - If an ExpectedHash is specified and is not equal to the calculated hash, - Close or CalculateHash methods will throw an AmazonClientException. - If CalculatedHash is calculated for only the portion of the stream that - is read. - - - Exception thrown during Close() or CalculateHash(), if ExpectedHash is set and - is different from CalculateHash that the stream calculates, provided that - CalculatedHash is not a zero-length byte array. - - - - - Algorithm to use to calculate hash. - - - - - True if hashing is finished and no more hashing should be done; - otherwise false. - - - - - Current position in the stream. - - - - - Calculated hash for the stream. - This value is set only after the stream is closed. - - - - - Expected hash value. Compared against CalculatedHash upon Close(). - If the hashes are different, an AmazonClientException is thrown. - - - - - Expected length of stream. - - - - - Initializes an HashStream with a hash algorithm and a base stream. - - Stream to calculate hash for. - - Expected hash. Will be compared against calculated hash on stream close. - Pass in null to disable check. - - - Expected length of the stream. If the reading stops before reaching this - position, CalculatedHash will be set to empty array. - - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Asynchronously reads a sequence of bytes from the current stream, advances - the position within the stream by the number of bytes read, and monitors - cancellation requests. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous read operation. The value of the TResult - parameter contains the total number of bytes read into the buffer. This can be - less than the number of bytes requested if that many bytes are not currently - available, or zero (0) if the end of the stream has been reached. - - - - - Gets a value indicating whether the current stream supports seeking. - HashStream does not support seeking, this will always be false. - - - - - Gets or sets the position within the current stream. - HashStream does not support seeking, attempting to set Position - will throw NotSupportedException. - - - - - Sets the position within the current stream. - HashStream does not support seeking, attempting to call Seek - will throw NotSupportedException. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Gets the overridden length used to construct the HashStream - - - - - Calculates the hash for the stream so far and disables any further - hashing. - - - - - Resets the hash stream to starting state. - Use this if the underlying stream has been modified and needs - to be rehashed without reconstructing the hierarchy. - - - - - Validates the underlying stream. - - - - - Compares two hashes (arrays of bytes). - - Expected hash. - Actual hash. - - True if the hashes are identical; otherwise false. - - - - - A wrapper stream that calculates a hash of the base stream as it - is being read or written. - The calculated hash is only available after the stream is closed or - CalculateHash is called. After calling CalculateHash, any further reads - on the streams will not change the CalculatedHash. - If an ExpectedHash is specified and is not equal to the calculated hash, - Close or CalculateHash methods will throw an AmazonClientException. - If base stream's position is not 0 or HashOnReads is true and the entire stream is - not read, the CalculatedHash will be set to an empty byte array and - comparison to ExpectedHash will not be made. - - - Exception thrown during Close() or CalculateHash(), if ExpectedHash is set and - is different from CalculateHash that the stream calculates, provided that - CalculatedHash is not a zero-length byte array. - - - - - Initializes an HashStream with a hash algorithm and a base stream. - - Stream to calculate hash for. - - Expected hash. Will be compared against calculated hash on stream close. - Pass in null to disable check. - - - Expected length of the stream. If the reading stops before reaching this - position, CalculatedHash will be set to empty array. - - - - - A wrapper stream that calculates an MD5 hash of the base stream as it - is being read or written. - The calculated hash is only available after the stream is closed or - CalculateHash is called. After calling CalculateHash, any further reads - on the streams will not change the CalculatedHash. - If an ExpectedHash is specified and is not equal to the calculated hash, - Close or CalculateHash methods will throw an AmazonClientException. - If base stream's position is not 0 or HashOnReads is true and the entire stream is - not read, the CalculatedHash will be set to an empty byte array and - comparison to ExpectedHash will not be made. - - - Exception thrown during Close() or CalculateHash(), if ExpectedHash is set and - is different from CalculateHash that the stream calculates, provided that - CalculatedHash is not a zero-length byte array. - - - - - Initializes an MD5Stream with a base stream. - - Stream to calculate hash for. - - Expected hash. Will be compared against calculated hash on stream close. - Pass in null to disable check. - - - Expected length of the stream. If the reading stops before reaching this - position, CalculatedHash will be set to empty array. - - - - - Utilities for validating label values for host prefix templates - - - - - Validates a label value - - - - - Simple wrapper around the log4net Error method. - - - - - - - - Write debug message to Console - - - - - - - - Write debug message to Console - - - - - - - Simple wrapper around the log4net InfoFormat method. - - - - - - - This is a dynamic wrapper around log4net so we can avoid log4net being required - to be distributed with the SDK. - - - - - Abstract logger class, base for any custom/specific loggers. - - - - - Flushes the logger contents. - - - - - Simple wrapper around the log4net IsErrorEnabled property. - - - - - Simple wrapper around the log4net IsDebugEnabled property. - - - - - Simple wrapper around the log4net IsInfoEnabled property. - - - - - Simple wrapper around the log4net Error method. - - - - - - - - Simple wrapper around the log4net Debug method. - - - - - - - - Simple wrapper around the log4net DebugFormat method. - - - - - - - Simple wrapper around the log4net InfoFormat method. - - - - - - - Logger wrapper for reflected log4net logging methods. - - - - - This should be a one time call to use reflection to find all the types and methods - needed for the logging API. - - - - - Simple wrapper around the log4net IsErrorEnabled property. - - - - - Simple wrapper around the log4net Error method. - - - - - - - - Simple wrapper around the log4net IsDebugEnabled property. - - - - - Simple wrapper around the log4net Debug method. - - - - - - - - Simple wrapper around the log4net DebugFormat method. - - - - - - - Simple wrapper around the log4net IsInfoEnabled property. - - - - - Simple wrapper around the log4net InfoFormat method. - - - - - - - A single logged message - - - - - Log message arguments. - - - - - Culture-specific formatting provider. - - - - - Log message format. - - - - - a size-limited cache of key value pairs - - Once the maximum size has been reached, the least recently - used pairs will be evicted to make room for any new items. - - - - - - - the maximum number of entries this LruCache will hold - before items begin getting evicted - - - - - the number of items in the cache - - - - - Construct a new LruCache. - - maximum number of entries before items are evicted - - - - Add the key/value pair to the cache, or update - the value if the key already exists. - - If the cache is full, evicts the least recently used item. - - - - - - - Evicts a specific key out of the cache if it exists - - the key to evict from the cache - - - - Try to get the value associated with the key. - - the key to look up - the value, if the key exists - true if there is a value associated with the key, or false if no value is associated with the key - - - - Try to get the value associated with the key, if it doesn't exist, use the provided factory method to - create a new value and tries adding it to the cache. - - the key to look up - the factory method used in case the key is not present in the cache - the looked up value or the value created by the factory - - - - Clear the LruCache of all entries. - - - - - Helper class to support LruCache. - Does not implement the error checking and synchronization that - would be necessary for it to stand alone. - - - - - Item to be stored in the LruList - linked list structure. - - - - - Collection of properties being tracked - - - - - Timings for metrics being tracked - - - - - Counters being tracked - - - - - Whether metrics are enabled for the request - - - - - Constructs an empty, disabled metrics object - - - - - Starts timing an event. Logs an exception if an event - of the same type was started but not stopped. - - - - - - - Stops timing an event. Logs an exception if the event wasn't started. - - - - - - - Adds a property for a metric. If there are multiple, the - object is added as a new item in a list. - - - - - - - Sets a counter for a specific metric. - - - - - - - Increments a specific metric counter. - If counter doesn't exist yet, it is set to 1. - - - - - - Returns errors associated with the metric, including - if there are still any timing events in-flight. - - - - - - Returns a string representation of the current metrics. - - - - - - Return a JSON represenation of the current metrics - - - - - - Timing information for a metric - - - - - Empty, stopped timing object - - - - - Timing object in a started state - - - - - - Stops timing - - - - - - Whether the timing has been stopped - - - - - Elapsed ticks from start to stop. - If timing hasn't been stopped yet, returns 0. - - - - - Elapsed time from start to stop. - If timing hasn't been stopped yet, returns TimeSpan.Zero - - - - - Timing event, stops timing of a metric when disposed - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - The destructor for the client class. - - - - - A wrapper stream which supresses disposal of the underlying stream. - - - - - Constructor for NonDisposingWrapperStream. - - The base stream to wrap. - - - - The Dispose implementation for this wrapper stream - does not close the underlying stream. - - - - - This class is used to wrap a stream for a particular segment of a stream. It - makes that segment look like you are reading from beginning to end of the stream. - - - - - Asynchronously reads a sequence of bytes from the current stream, advances - the position within the stream by the number of bytes read, and monitors - cancellation requests. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous read operation. The value of the TResult - parameter contains the total number of bytes read into the buffer. This can be - less than the number of bytes requested if that many bytes are not currently - available, or zero (0) if the end of the stream has been reached. - - - - - Asynchronously writes a sequence of bytes to the current stream and advances the - current position within this stream by the number of bytes written. - - - An array of bytes. This method copies count bytes from buffer to the current stream. - - - The zero-based byte offset in buffer at which to begin copying bytes to the - current stream. - - The number of bytes to be written to the current stream. - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - A task that represents the asynchronous write operation. - - - - Wrapper stream that only supports reading - - - - - Asynchronously clears all buffers for this stream and causes any buffered data - to be written to the underlying device. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous flush operation. - - - - - Asynchronously writes a sequence of bytes to the current stream and advances the - current position within this stream by the number of bytes written. - - - An array of bytes. This method copies count bytes from buffer to the current stream. - - - The zero-based byte offset in buffer at which to begin copying bytes to the - current stream. - - The number of bytes to be written to the current stream. - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - A task that represents the asynchronous write operation. - - - - Partial wrapper stream that only supports reading - - - - - Uri wrapper that can parse out information (bucket, key, region, style) from an - S3 URI. - - - - - True if the URI contains the bucket in the path, false if it contains the bucket in the authority. - - - - - The bucket name parsed from the URI (or null if no bucket specified). - - - - - The key parsed from the URI (or null if no key specified). - - - - - The region parsed from the URI (or null if no region specified). - - - - - Constructs a parser for the S3 URI specified as a string. - - The S3 URI to be parsed. - - - - Constructs a parser for the S3 URI specified as a Uri instance. - - The S3 URI to be parsed. - - - - Percent-decodes the given string, with a fast path for strings that are not - percent-encoded. - - The string to decode - The decoded string - - - - Percent-decodes the given string. - - The string to decode - The index of the first '%' in the string - The decoded string - - - - Decodes the percent-encoded character at the given index in the string - and appends the decoded value to the string under construction. - - - The string under construction to which the decoded character will be - appended. - - The string being decoded. - The index of the '%' character in the string. - - - - Converts a hex character (0-9A-Fa-f) into its corresponding quad value. - - The hex character - The quad value - - - - Interface for a non-generic cache. - - - - - Clears the entire cache. - - - - - Maximum time to keep an item around after its last use. - - - - - How often should the cache be cleared of old items. - - - - - The number of items in the cache. - - - - - Interface for a generic cache. - - - - - - - Retrieves a value out of the cache or from the source. - - - - - - - - Retrieves a value out of the cache or from the source. - If the item was in the cache, isStaleItem is set to true; - otherwise, if the item comes from the source, isStaleItem is false. - - - - - - - - - Clears a specific value from the cache if it's there. - - - - - - Returns the keys for all items in the cache. - - - - - - Executes specified operation, catches exception, clears the cache for - the given key, retries the operation. - - - - - - - - - - - SDK-wide cache. - Provides access to caches specific to a particular set of credentials - and target region. - - - - - Clear all caches - - - - - Clear all caches of a particular type - - - - - - Retrieve a cache of a specific type for a client object. - The client object can be null in cases where a cache does - not correspond to a specific AWS account or target region. - - - - - - - - - - - Retrieve a cache of a specific type for a client object. - The client object can be null in cases where a cache does - not correspond to a specific AWS account or target region. - - - - - - - - - - - Utilities for converting objects to strings. Used by the marshaller classes. - - - - - Converts a DateTime to ISO8601 formatted string. - - - - - Converts a DateTime to RFC822 formatted string. - - - - - Converts a DateTime to Unix epoch time formatted string. - - - - - A wrapper stream. - - - - - Base stream. - - - - - Initializes WrapperStream with a base stream. - - - - - - Returns the first base non-WrapperStream. - - First base stream that is non-WrapperStream. - - - - Returns the first base non-WrapperStream. - - First base stream that is non-WrapperStream. - - - - Returns the first base non-WrapperStream. - - Potential WrapperStream - Base non-WrapperStream. - - - - Gets a value indicating whether the current stream supports reading. - True if the stream supports reading; otherwise, false. - - - - - Gets a value indicating whether the current stream supports seeking. - True if the stream supports seeking; otherwise, false. - - - - - Gets a value indicating whether the current stream supports writing. - True if the stream supports writing; otherwise, false. - - - - - Closes the current stream and releases any resources (such as sockets and - file handles) associated with the current stream. - - - - - Gets the length in bytes of the stream. - - - - - Gets or sets the position within the current stream. - - - - - Gets or sets a value, in miliseconds, that determines how long the stream - will attempt to read before timing out. - - - - - Gets or sets a value, in miliseconds, that determines how long the stream - will attempt to write before timing out. - - - - - Clears all buffers for this stream and causes any buffered data to be written - to the underlying device. - - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Sets the position within the current stream. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Sets the length of the current stream. - - The desired length of the current stream in bytes. - - - - Writes a sequence of bytes to the current stream and advances the current - position within this stream by the number of bytes written. - - - An array of bytes. This method copies count bytes from buffer to the current stream. - - - The zero-based byte offset in buffer at which to begin copying bytes to the - current stream. - - The number of bytes to be written to the current stream. - - - - Asynchronously clears all buffers for this stream and causes any buffered data - to be written to the underlying device. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous flush operation. - - - - - Asynchronously reads a sequence of bytes from the current stream, advances - the position within the stream by the number of bytes read, and monitors - cancellation requests. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous read operation. The value of the TResult - parameter contains the total number of bytes read into the buffer. This can be - less than the number of bytes requested if that many bytes are not currently - available, or zero (0) if the end of the stream has been reached. - - - - - Asynchronously writes a sequence of bytes to the current stream and advances the - current position within this stream by the number of bytes written. - - - An array of bytes. This method copies count bytes from buffer to the current stream. - - - The zero-based byte offset in buffer at which to begin copying bytes to the - current stream. - - The number of bytes to be written to the current stream. - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - A task that represents the asynchronous write operation. - - - - This is a utility class to be used in last resort for code paths that are synchronous but need to call an asynchronous method. - This should never be used for methods that are called at high volume as this utility class has a performance cost. For example this - class was added for the refreshing credentials like Cognito which would need to use this about once an hour. - - - - - Custom WebProxy implementation that creates a webproxy based on - user inputs(Host name and port number) - - - - - Set the ProxyUri - - - - - Create a Uri based on the user inputs(Host name and port number) - - - - - Proxy Uri property - - - - - Proxy Credentials property - - - - - Getter to fetch the set proxy - - - - - Method to determine if the proxy should be bypassed when accessing an internet source - - - - - Error is always enabled - - - - - Debug logging is always enabled - - - - - Info logging is always enabled - - - - - Prints the Log With Error Level - - - - - - - - Prints the Log with Debug Level - - - - - - - - Prints the Log with Debug Level - - - - - - - Prints the Log With Info Level - - - - - - - Logger wrapper for Console.WriteLine() - - - - - Simple wrapper around the log4net IsErrorEnabled property. - - - - - Simple wrapper around the log4net Error method. - - - - - - - - Simple wrapper around the log4net IsDebugEnabled property. - - - - - Simple wrapper around the log4net Debug method. - - - - - - - - Simple wrapper around the log4net DebugFormat method. - - - - - - - Simple wrapper around the log4net IsInfoEnabled property. - - - - - Simple wrapper around the log4net InfoFormat method. - - - - - - - This class is no longer used anymore and should be avoided as it is just meant - as a last resort when blending async and sync operations. The code is still - here to support versions before 3.3.9.0 of AWSSDK.DynamoDBv2. - - - - - Property to denote that the last exception returned by an AWS Service - was retryable or not. - - - - - An abstract pipeline handler that has implements IPipelineHandler, - and has the default implmentation. This is the base class for most of - the handler implementations. - - - - - The logger used to log messages. - - - - - The inner handler which is called after the current - handler completes it's processing. - - - - - The outer handler which encapsulates the current handler. - - - - - Contains the processing logic for a synchronous request invocation. - This method calls InnerHandler.InvokeSync to continue processing of the - request by the pipeline. - - The execution context which contains both the - requests and response context. - - - - Contains the processing logic for an asynchronous request invocation. - This method calls InnerHandler.InvokeSync to continue processing of the - request by the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Logs the metrics for the current execution context. - - The execution context, it contains the - request and response context. - - - - A runtime pipeline contains a collection of handlers which represent - different stages of request and response processing. - - - - - The top-most handler in the pipeline. - - - - - Constructor for RuntimePipeline. - - The handler with which the pipeline is initalized. - - - - Constructor for RuntimePipeline. - - List of handlers with which the pipeline is initalized. - - - - Constructor for RuntimePipeline. - - List of handlers with which the pipeline is initalized. - The logger used to log messages. - - - - Constructor for RuntimePipeline. - - The handler with which the pipeline is initalized. - The logger used to log messages. - - - - Invokes the pipeline synchronously. - - Request context - Response context - - - - Invokes the pipeline asynchronously. - - Request context - Response context - - - - Adds a new handler to the top of the pipeline. - - The handler to be added to the pipeline. - - - - Adds a handler after the first instance of handler of type T. - - Type of the handler after which the given handler instance is added. - The handler to be added to the pipeline. - - - - Adds a handler before the first instance of handler of type T. - - Type of the handler before which the given handler instance is added. - The handler to be added to the pipeline. - - - - Removes the first occurance of a handler of type T. - - Type of the handler which will be removed. - - - - Replaces the first occurance of a handler of type T with the given handler. - - Type of the handler which will be replaced. - The handler to be added to the pipeline. - - - - Inserts the given handler after current handler in the pipeline. - - Handler to be inserted in the pipeline. - Handler after which the given handler is inserted. - - - - Gets the innermost handler by traversing the inner handler till - it reaches the last one. - - - - - Retrieves a list of handlers, in the order of their execution. - - Handlers in the current pipeline. - - - - Retrieves current handlers, in the order of their execution. - - Handlers in the current pipeline. - - - - This handler processes exceptions thrown from the HTTP handler and - unmarshalls error responses. - - - - - Default set of exception handlers. - - - - - Default set of exception handlers. - - - - - Constructor for ErrorHandler. - - an ILogger instance. - - - - Handles and processes any exception thrown from underlying handlers. - - The execution context which contains both the - requests and response context. - - - - Handles and processes any exception thrown from underlying handlers. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Disposes the response body. - - The response context. - - - - Processes an exception by invoking a matching exception handler - for the given exception. - - The execution context, it contains the - request and response context. - The exception to be processed. - - This method returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception that may be thrown by exception - processing by a matching exception handler. - - - - - The abstract base class for exception handlers. - - The exception type. - - - - The exception handler for HttpErrorResponseException exception. - - - - - The constructor for HttpErrorResponseExceptionHandler. - - in instance of ILogger. - - - - Handles an exception for the given execution context. - - The execution context, it contains the - request and response context. - The exception to handle. - - Returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception to replace the original exception. - - - - - Checks if a HTTP 404 status code is returned which needs to be suppressed and - processes it. - If a suppressed 404 is present, it unmarshalls the response and returns true to - indicate that a suppressed 404 was processed, else returns false. - - The execution context, it contains the - request and response context. - - - If a suppressed 404 is present, returns true, else returns false. - - - - - A pipeline handler which provides hooks to run - external code in the pre-invoke and post-invoke phases. - - - - - Action to execute on the pre invoke phase. - - - - - Action to execute on the post invoke phase. - - - - - Calls the PreInvoke and PostInvoke methods before and after calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls the PreInvoke and PostInvoke methods before and after calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Executes the OnPreInvoke action as part of pre-invoke. - - The execution context, it contains the - request and response context. - - - - Executes the OnPreInvoke action as part of post-invoke. - - The execution context, it contains the - request and response context. - - - - This handler retrieved the AWS credentials to be used for the current call. - - - - - The constructor for CredentialsRetriever. - - An AWSCredentials instance. - - - - Retrieves the credentials to be used for the current call before - invoking the next handler. - - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - This handler resolves the endpoint to be used for the current request. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Resolves the endpoint to be used for the current request - before invoking the next handler. - - The execution context, it contains the - request and response context. - - - - This handler resolves the endpoint to be used for the current request. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Resolves the endpoint to be used for the current request - before invoking the next handler. - - The execution context, it contains the - request and response context. - - - - Determines the endpoint for the request. - - The request context. - - - - - This handler provides an OnError action that can be used as hook for - external code to handle exceptions in the runtime pipeline. - - - - - Action to execute if an exception occurs during the - execution of any underlying handlers. - - - - - Executes the OnError action if an exception occurs during the - execution of any underlying handlers. - - - - - - - This handler marshalls the request before calling invoking the next handler. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Marshalls the request before calling invoking the next handler. - - The execution context, it contains the - request and response context. - - - - This handler manages the metrics used to time the complete call and - logs the final metrics. - - - - - Captures the overall execution time and logs final metrics. - - The execution context which contains both the - requests and response context. - - - - Captures the overall execution time and logs final metrics. - - The response type for the current request. - - The execution context, it contains the request and response context. - - A task that represents the asynchronous operation. - - - - This handler processes HTTP redirects and reissues the call to the - redirected location. - - - - - Processes HTTP redirects and reissues the call to the - redirected location. - - The execution context which contains both the - requests and response context. - - - - Processes HTTP redirects and reissues the call to the - redirected location. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Checks if an HTTP 307 (temporary redirect) has occured and changes the - request endpoint to the redirected location. - - - The execution context, it contains the request and response context. - - - A boolean value that indicates if a redirect has occured. - - - - - This handler signs the request. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Signs the request before invoking the next handler. - - - The execution context, it contains the request and response context. - - - - - Determines if the request should be signed. - - The request context. - A boolean value that indicated if the request should be signed. - - - - Signs the request. - - The request context. - - - - This handler unmarshalls the HTTP response. - - - - - The constructor for Unmarshaller. - - - Boolean value which indicated if the unmarshaller - handler supports response logging. - - - - - Unmarshalls the response returned by the HttpHandler. - - The execution context which contains both the - requests and response context. - - - - Unmarshalls the response returned by the HttpHandler. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Unmarshalls the HTTP response. - - - The execution context, it contains the request and response context. - - - - - Unmarshalls the HTTP response. - - - The execution context, it contains the request and response context. - - - - - The HTTP handler contains common logic for issuing an HTTP request that is - independent of the underlying HTTP infrastructure. - - - - - - The sender parameter used in any events raised by this handler. - - - - - The constructor for HttpHandler. - - The request factory used to create HTTP Requests. - The sender parameter used in any events raised by this handler. - - - - Issues an HTTP request for the current request context. - - The execution context which contains both the - requests and response context. - - - - Issues an HTTP request for the current request context. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Determines the content for request body and uses the HTTP request - to write the content to the HTTP request body. - - Content to be written. - The HTTP request. - The request context. - - - - Creates the HttpWebRequest and configures the end point, content, user agent and proxy settings. - - The async request. - The web request that actually makes the call. - - - - Disposes the HTTP handler. - - - - - The default implementation of the adaptive retry policy. - - - The default implementation of the adaptive policy. - - - - - Constructor for AdaptiveRetryPolicy. - - The maximum number of retries before throwing - back a exception. This does not count the initial request. - - - - Constructor for AdaptiveRetryPolicy. - - The Client config object. This is used to - retrieve the maximum number of retries before throwing - back a exception(This does not count the initial request) and - the service URL for the request. - - - - OnRetry is called when a retry request is initiated to determine if the request will be retried. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - true if the error that will be retried is a throtting error - True if retry throttling is disabled or retry throttling is enabled and capacity can be obtained. - - - - This method uses a token bucket to enforce the maximum sending rate. - - The execution context which contains both the - requests and response context. - If the prior request failed, this exception is expected to be - the exception that occurred during the prior request failure. - - - - Virtual method that gets called on a success Response. If its a retry success response, the entire - retry acquired capacity is released(default is 5). If its just a success response a lesser value capacity - is released(default is 1). - - Request context containing the state of the request. - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - This method uses a token bucket to enforce the maximum sending rate. - - The execution context which contains both the - requests and response context. - If the prior request failed, this exception is expected to be - the exception that occurred during the prior request failure. - - - - The default implementation of the legacy retry policy. - - - The default implementation of the legacy retry policy. - - - - - The maximum value of exponential backoff in milliseconds, which will be used to wait - before retrying a request. The default is 30000 milliseconds. - - - - - Constructor for DefaultRetryPolicy. - - The maximum number of retries before throwing - back a exception. This does not count the initial request. - - - - Constructor for DefaultRetryPolicy. - - The Client config object. This is used to - retrieve the maximum number of retries before throwing - back a exception(This does not count the initial request) and - the service URL for the request. - - - - Returns true if the request is in a state where it can be retried, else false. - - Request context containing the state of the request. - Returns true if the request is in a state where it can be retried, else false. - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - true if the error that will be retried is a throtting error - - - - Virtual method that gets called on a success Response. If its a retry success response, the entire - retry acquired capacity is released(default is 5). If its just a success response a lesser value capacity - is released(default is 1). - - Request context containing the state of the request. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Request context containing the state of the request. - Return true if the request should be retried. - - - - Checks if the retry limit is reached. - - Request context containing the state of the request. - Return false if the request can be retried, based on number of retries. - - - - Waits before retrying a request. The default policy implements a exponential backoff. - - Request context containing the state of the request. - - - - Waits for an amount of time using an exponential backoff algorithm. - - The request retry index. The first request is expected to be 0 while - the first retry will be 1. - The max number of milliseconds to wait - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - The retry handler has the generic logic for retrying requests. - It uses a retry policy which specifies when - a retry should be performed. - - - - - The logger used to log messages. - - - - - The retry policy which specifies when - a retry should be performed. - - - - - Constructor which takes in a retry policy. - - Retry Policy - - - - Invokes the inner handler and performs a retry, if required as per the - retry policy. - - The execution context which contains both the - requests and response context. - - - - Invokes the inner handler and performs a retry, if required as per the - retry policy. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Prepares the request for retry. - - Request context containing the state of the request. - - - - The default implementation of the standard retry policy. - - - The default implementation of the standard policy. - - - - - The maximum value of exponential backoff in milliseconds, which will be used to wait - before retrying a request. The default is 20000 milliseconds. - - - - - Constructor for StandardRetryPolicy. - - The maximum number of retries before throwing - back a exception. This does not count the initial request. - - - - Constructor for StandardRetryPolicy. - - The Client config object. This is used to - retrieve the maximum number of retries before throwing - back a exception(This does not count the initial request) and - the service URL for the request. - - - - Returns true if the request is in a state where it can be retried, else false. - - Request context containing the state of the request. - Returns true if the request is in a state where it can be retried, else false. - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - true if the error that will be retried is a throtting error - - - - Virtual method that gets called on a success Response. If its a retry success response, the entire - retry acquired capacity is released(default is 5). If its just a success response a lesser value capacity - is released(default is 1). - - Request context containing the state of the request. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Request context containing the state of the request. - Return true if the request should be retried. - - - - Checks if the retry limit is reached. - - Request context containing the state of the request. - Return false if the request can be retried, based on number of retries. - - - - Waits before retrying a request. The default policy implements a exponential backoff with - jitter algorithm. - - Request context containing the state of the request. - - - - Waits for an amount of time using an exponential backoff with jitter algorithm. - - The request retry index. The first request is expected to be 0 while - the first retry will be 1. - The max number of milliseconds to wait - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - This class is the base class of all the configurations settings to connect - to a service. - - - This class is the base class of all the configurations settings to connect - to a service. - - - - - Gets Service Version - - - - - Gets and sets of the signatureMethod property. - - - - - Gets and sets of the SignatureVersion property. - - Note: This property exists for backward compatibility but is no longer - used by any service other than S3. - - - - - Gets and sets of the UserAgent property. - - - - - Gets and sets the RegionEndpoint property. The region constant that - determines the endpoint to use. - - Setting this property to null will force the SDK to recalculate the - RegionEndpoint value based on App/WebConfig, environment variables, - profile, etc. - - - - - The constant used to lookup in the region hash the endpoint. - - - - - Gets and sets of the ServiceURL property. - This is an optional property; change it - only if you want to try a different service - endpoint. - - - - - Gets and sets the UseHttp. - If this property is set to true, the client attempts - to use HTTP protocol, if the target endpoint supports it. - By default, this property is set to false. - - - - - Given this client configuration, return a string form ofthe service endpoint url. - - - - - Gets and sets the AuthenticationRegion property. - Used in AWS4 request signing, this is an optional property; - change it only if the region cannot be determined from the - service endpoint. - - - - - Gets and sets the AuthenticationServiceName property. - Used in AWS4 request signing, this is the short-form - name of the service being called. - - - - - Returns the flag indicating how many retry HTTP requests an SDK should - make for a single SDK operation invocation before giving up. This flag will - return 4 when the RetryMode is set to "Legacy" which is the default. For - RetryMode values of "Standard" or "Adaptive" this flag will return 2. In - addition to the values returned that are dependant on the RetryMode, the - value can be set to a specific value by using the AWS_MAX_ATTEMPTS environment - variable, max_attempts in the shared configuration file, or by setting a - value directly on this property. When using AWS_MAX_ATTEMPTS or max_attempts - the value returned from this property will be one less than the value entered - because this flag is the number of retry requests, not total requests. To - learn more about the RetryMode property that affects the values returned by - this flag, see . - - - - - Determines if MaxErrorRetry has been manually set. - - - - - Gets and sets the LogResponse property. - If this property is set to true, the service response is logged. - The size of response being logged is controlled by the AWSConfigs.LoggingConfig.LogResponsesSizeLimit property. - - - - - Gets and sets the ReadEntireResponse property. - NOTE: This property does not effect response processing and is deprecated. - To enable response logging, the ClientConfig.LogResponse and AWSConfigs.LoggingConfig - properties can be used. - - - - - Gets and Sets the BufferSize property. - The BufferSize controls the buffer used to read in from input streams and write - out to the request. - - - - - - Gets or sets the interval at which progress update events are raised - for upload operations. By default, the progress update events are - raised at every 100KB of data transferred. - - - If the value of this property is set less than ClientConfig.BufferSize, - progress updates events will be raised at the interval specified by ClientConfig.BufferSize. - - - - - - Flag on whether to resign requests on retry or not. - For Amazon S3 and Amazon Glacier this value will always be set to true. - - - - - This flag controls if .NET HTTP infrastructure should follow redirection - responses (e.g. HTTP 307 - temporary redirect). - - - - - Flag on whether to log metrics for service calls. - - This can be set in the application's configs, as below: - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSLogMetrics" value"true"/> - </appSettings> - </configuration> - - - - - - Gets and sets the DisableLogging. If true logging for this client will be disabled. - - - - - Credentials to use with a proxy. - - - - - - If the value is set, the value is assigned to the Timeout property of the HttpWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Configures the endpoint calculation for a service to go to a dual stack (ipv6 enabled) endpoint - for the configured region. - - - Note: AWS services are enabling dualstack endpoints over time. It is your responsibility to check - that the service actually supports a dualstack endpoint in the configured region before enabling - this option for a service. - - - - - Enable or disable the Retry Throttling feature by setting the ThrottleRetries flag to True/False resepctively. - Retry Throttling is a feature that intelligently throttles retry attempts when a large precentage of requests - are failing and retries are unsuccessful as well. In such situations the allotted retry capacity for the service URL - will be drained until requests start to succeed again. Once the requisite capacity is available, retries would - be permitted again. When retries are throttled, the service enters a fail-fast behaviour as the traditional retry attempt - for the request would be circumvented. Hence, errors will resurface quickly. This will result in a greated number of exceptions - but prevents requests being tied up in unsuccessful retry attempts. - Note: Retry Throttling is enabled by default. Set the ThrottleRetries flag to false to switch off this feature. - - - - - Enable or disable the Nagle algorithm on the underlying http - client. - - This method is not intended to be called by consumers of the AWS SDK for .NET - - - - - - Performs validation on this config object. - Throws exception if any of the required values are missing/invalid. - - - - - Returns the current UTC now after clock correction for this endpoint. - - - - - The calculated clock skew correction for a specific endpoint, if there is one. - This field will be set if a service call resulted in an exception - and the SDK has determined that there is a difference between local - and server times. - - If is set to true, this - value will still be set to the correction, but it will not be used by the - SDK and clock skew errors will not be retried. - - - - - Gets and sets the DisableHostPrefixInjection flag. If true, host prefix injection will be disabled for this client, the default value of this flag is false. - Host prefix injection prefixes the service endpoint with request members from APIs which use this feature. - Example: for a hostPrefix of "foo-name." and a endpoint of "service.region.amazonaws.com" the default behavior is to - prefix the endpoint with the hostPrefix resulting in a final endpoint of "foo-name.service.region.amazonaws.com". Setting - DisableHostPrefixInjection to true will disable hostPrefix injection resulting in a final endpoint of - "service.region.amazonaws.com" regardless of the value of hostPrefix. E.g. You may want to disable host prefix injection for testing against a local mock endpoint. - - - - - Returns the flag indicating if endpoint discovery should be enabled or disabled for operations that are not required to use endpoint discovery. - - - - - Returns the maximum number of discovered endpoints that can be stored within the cache for the client. The default limit is 1000 cache entries. - - - - - Returns the flag indicating the current mode in use for request - retries and influences the value returned from . - The default value is RequestRetryMode.Legacy. This flag can be configured - by using the AWS_RETRY_MODE environment variable, retry_mode in the - shared configuration file, or by setting this value directly. - - - - - Under Adaptive retry mode, this flag determines if the client should wait for - a send token to become available or don't block and fail the request immediately - if a send token is not available. - - - - - Throw an exception if the boxed TimeSpan parameter doesn't have a value or is out of range. - - - - - Returns the request timeout value if its value is set, - else returns client timeout value. - - - - - - This is a switch used for performance testing and is not intended for production applications - to change. This switch may be removed in a future version of the SDK as the .NET Core platform matures. - - - If true, the HttpClient is cached and reused for every request made by the service client - and shared with other service clients. - - - For the .NET Core platform this is default to true because the HttpClient manages the connection - pool. - - - - - - If CacheHttpClient is set to true then HttpClientCacheSize controls the number of HttpClients cached. - - On Windows the default value is 1 since the underlying native implementation does not have throttling constraints - like the non Windows Curl based implementation. For non Windows based platforms the default is the value return from - System.Environment.ProcessorCount. - - - - - - Overrides the default read-write timeout value. - On Unity platform, this value is not used as Unity HTTP client does not support timeouts, so - - - - If the value is set, the value is assigned to the ReadWriteTimeout property of the HttpWebRequest object used - to send requests. - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Returns a WebProxy instance configured to match the proxy settings - in the client configuration. - - - - - Unpacks the host, port and any credentials info into the instance's - proxy-related fields. - Unlike the SetWebProxy implementation on .NET 3.5/4.5,the Host and the Port are not reconstructed from the - input proxyuri - - The proxy details - - - - Gets and sets of the ProxyHost property. - - - - - Gets and sets of the ProxyPort property. - - - - - - Returns true if the clients should be cached by HttpRequestMessageFactory, false otherwise. - - - - - - - Returns true if the SDK should dispose HttpClients after one use, false otherwise. - - - - - - - Create a unique string used for caching the HttpClient based on the settings that are used from the ClientConfig that are set on the HttpClient. - - - - - - - Determines if HttpClients created with the given IClientConfig should be cached at the SDK - client level, or cached globally. - - If there is no HttpClientFactory assigned and proxy or proxy credentials are set - this returns false because those properties can't be serialized as part of the key in the global http client cache. - - - - - Base class for constant class that holds the value that will be sent to AWS for the static constants. - - - - - Gets the value that needs to be used when send the value to AWS - - - - - Attempt to find correct-cased constant value using whatever cased value the user - has provided. This is primarily useful for mapping any-cased values from a CLI - tool to the specific casing required by the service, avoiding the need for the - user to (a) remember the specific case and (b) actually type it correctly. - - The properly cased service constant matching the value - - - - Utility class that stores clock skew information. - - - - - GlobalClockCorrection should be only set by AWSConfigs.ManualClockCorrection property - and is only available to maintain backward compatibilty. This should override any - endpoint specific clockskew correction. - - - - - Return clock skew correction value for an endpoint if there is one. - - AWSConfigs.ManualClockCorrection overrides globally any calculated service endpoint specific - clock correction value. - - Endpoint should in a form such as "https://s3" - Clock correction value for an endpoint in TimeSpan. TimeSpan.Zero if no such clock correction is set. - - - - Get clock skew corrected UTC now value. If ManualClockCorrection is set, - use ManualClockCorrection instead of endpoint specific clock correction value. - - - - - - - Probing mechanism to determine the endpoint discovery enabled value from various sources. - - - - - The valid hashing algorithm supported by the sdk for request signing. - - - - - Which end of a request was responsible for a service error response. - - - - - The sender was responsible for the error, i.e. the client - request failed validation or was improperly formatted. - - - - - The error occured within the service. - - - - - An unrecognized error type was returned. - - - - - Sts Regional Endpoints Value determines whether or not - to send the sts request to the regional endpoint or to - the global sts endpoint - - - - - Send the request to the global sts endpoint - if the region is a legacy global region - - - - - Send the request to the regional endpoint - - - - - S3 US East 1 endpoint value determines wheter or not - to send the us-east-1 s3 requests to the regional endpoint or to - the legacy global endpoint - - - - - Sends the requests to the legacy global s3 endpoint for us-east-1 - - - - - Sends the request to the regional s3 endpoint for us-east-1 - - - - - RetryMode determines which request retry mode is used for requests that do - not complete successfully. - - - - - Legacy request retry strategy. - - - - - Standardized request retry strategy that is consistent across all SDKs. - - - - - An experimental request retry strategy that builds on the Standard strategy - and introduces congestion control through client side rate limiting. - - - - - All Amazon service interfaces like IAmazonS3 extend from this interface. This allows all the - Amazon service interfaces be identified by this base interface and helps with generic constraints. - - - - - A readonly view of the configuration for the service client. - - - - - This interface is the read only access to the ClientConfig object used when setting up service clients. Once service clients - are initiated the config object should not be changed to avoid issues with using a service client in a multi threaded environment. - - - - - Gets the RegionEndpoint property. The region constant to use that - determines the endpoint to use. If this is not set - then the client will fallback to the value of ServiceURL. - - - - - The constant used to lookup in the region hash the endpoint. - - - - - Gets and sets of the ServiceURL property. - This is an optional property if you need to set a specific service URL - instead setting the region with the RegionEndpoint property. - - - - - Gets the UseHttp property. - If this property is set to true, the client attempts - to use HTTP protocol. - By default, this property is set to false. - - - - - Gets Service Version - - - - - Gets the signatureMethod property. - - - - - Gets the SignatureVersion property. - - Note: This property exists for backward compatibility but is no longer - used by any service other than S3. - - - - - Gets the AuthenticationRegion property. - Used in AWS4 request signing, this is an optional property; - change it only if the region cannot be determined from the - service endpoint. - - - - - Gets the AuthenticationServiceName property. - Used in AWS4 request signing, this is the short-form - name of the service being called. - - - - - Gets the UserAgent property. - - - - - Gets the DisableLogging. If true logging for this client will be disabled. - - - - - Flag on whether to log metrics for service calls. - - This can be set in the application's configs, as below: - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSLogMetrics" value"true"/> - </appSettings> - </configuration> - - - - - - Gets the LogResponse property. - If this property is set to true, the service response - is read in its entirety and logged. - - - - - Gets the ReadEntireResponse. - If this property is set to true, the service response - is read in its entirety before being processed. - - - - - This flag controls if .NET HTTP infrastructure should follow redirection - responses (e.g. HTTP 307 - temporary redirect). - - - - - Gets the BufferSize property. - The BufferSize controls the buffer used to read in from input streams and write - out to the request. - - - - - Returns the flag indicating how many retry HTTP requests an SDK should - make for a single SDK operation invocation before giving up. This flag will - return 4 when the RetryMode is set to "Legacy" which is the default. For - RetryMode values of "Standard" or "Adaptive" this flag will return 2. In - addition to the values returned that are dependant on the RetryMode, the - value can be set to a specific value by using the AWS_MAX_ATTEMPTS environment - variable, max_attempts in the shared configuration file, or by setting a - value directly on this property. When using AWS_MAX_ATTEMPTS or max_attempts - the value returned from this property will be one less than the value entered - because this flag is the number of retry requests, not total requests. To - learn more about the RetryMode property that affects the values returned by - this flag, see . - - - - - Determines if MaxErrorRetry has been manually set. - - - - - Gets the interval at which progress update events are raised - for upload operations. By default, the progress update events are - raised at every 100KB of data transferred. - - - - - Flag on whether to resign requests on retry or not. - - - - - Credentials to use with a proxy. - - - - - Gets the default request timeout value. - - - - If the value is set, the value is assigned to the Timeout property of the HTTPWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - - - - Configures the endpoint calculation for a service to go to a dual stack (ipv6 enabled) endpoint - for the configured region. - - - Note: AWS services are enabling dualstack endpoints over time. It is your responsibility to check - that the service actually supports a dualstack endpoint in the configured region before enabling - this option for a service. - - - - - Configures a flag enabling to either opt in or opt out of the retry throttling service. - Note: set value to true to enable retry throttling feature. The Default value for this flag is false. - - - - - Using either the RegionEndpoint or the ServiceURL determine what the URL to the service is. - - The URL to the service. - - - - Performs validation on this config object. - Throws exception if any of the required values are missing/invalid. - - The timeout specified is null. - - - - Returns the clock skew adjusted utc now. This value is affected by AWSConfigs.ManualClockCorrection - - - - - Returns the calculated clock skew value for this config's service endpoint. If AWSConfigs.CorrectForClockSkew is false, - this value won't be used to construct service requests. - - - - - Gets the DisableHostPrefixInjection flag. If true, host prefix injection will be disabled for this client, the default value of this flag is false. - Host prefix injection prefixes the service endpoint with request members from APIs which use this feature. - Example: for a hostPrefix of "foo-name." and a endpoint of "service.region.amazonaws.com" the default behavior is to - prefix the endpoint with the hostPrefix resulting in a final endpoint of "foo-name.service.region.amazonaws.com". Setting - DisableHostPrefixInjection to true will disable hostPrefix injection resulting in a final endpoint of - "service.region.amazonaws.com" regardless of the value of hostPrefix. E.g. You may want to disable host prefix injection for testing against a local mock endpoint. - - - - - Returns the flag indicating if endpoint discovery should be enabled or disabled for operations that are not required to use endpoint discovery. - - - - - Returns the maximum number of discovered endpoints that can be stored within the cache for the client. The default limit is 1000 cache entries. - - - - - Returns the flag indicating the current mode in use for request - retries and influences the value returned from . - The default value is RequestRetryMode.Legacy. This flag can be configured - by using the AWS_RETRY_MODE environment variable, retry_mode in the - shared configuration file, or by setting this value directly. - - - - - Under Adaptive retry mode, this flag determines if the client should wait for - a send token to become available or don't block and fail the request immediately - if a send token is not available. - - - - - - This is a switch used for performance testing and is not intended for production applications - to change. This switch may be removed in a future version of the SDK as the .NET Core platform matures. - - - If true, the HttpClient is cached and reused for every request made by the service client - and shared with other service clients. - - - For the .NET Core platform this is default to true because the HttpClient manages the connection - pool. - - - - - - If CacheHttpClient is set to true then HttpClientCacheSize controls the number of HttpClients cached. - - - - - Gets the ProxyHost property. - - - - - Gets the ProxyPort property. - - - - - Returns a WebProxy instance configured to match the proxy settings - in the client configuration. - - - - - - Interface for a single logged message. - - - - - Log message format. - - - - - Log message arguments. - - - - - Culture-specific formatting provider. - - - - - Abstract parameter value. - - - - - String parameter value. - - - - - String value of the parameter. - - - - - Constructs ParameterValue for a single string. - - - - - - String list parameter value. - - - - - List of strings value of the parameter. - - - - - Constructs ParameterValue for a list of strings. - - - - - - Metrics collected by the SDK on a per-request basis. - - - Each request made to an AWS service by the SDK can have metrics - collected and logged. This interface represents the collected - metrics for a request. The metrics include properties (i.e. request id - and other metadata), timings for each stage of the request, and counters. - - - - - Collection of properties being tracked - - - - - Timings for metrics being tracked - - - - - Counters being tracked - - - - - Whether metrics are enabled for the request - - - - - JSON representation of the current metrics - - JSON string - - - - Represents how long a phase of an SDK request took. - - - - - Whether the timing has been stopped - - - - - Elapsed ticks from start to stop. - If timing hasn't been stopped yet, returns 0. - - - - - Elapsed time from start to stop. - If timing hasn't been stopped yet, returns TimeSpan.Zero - - - - - User supplied type to perform metrics formatting. - - - - - Produce custom formatting for SDK metrics. - - - If defined, this method will be called for every request made by the SDK. - - An instance of IRequestMetrics produced by the SDK - formatted string representation of the metrics - - - - Predefined request metrics that are collected by the SDK. - - - - - Information about the request. - - - - - Gets and sets the RequestId property. - ID that uniquely identifies a request. Amazon keeps track of request IDs. If you have a question about a request, include the request ID in your correspondence. - - - - - This exception is thrown if there are problems signing the request. - - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - - - - Gets the percentage of transfer completed - - - - - Gets the number of bytes transferred since last event - - - - - Gets the number of bytes transferred - - - - - Gets the total number of bytes to be transferred - - - - - Returns a string representation of this object - - - - - - Anonymous credentials. - Using these credentials, the client does not sign the request. - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - AWS Credentials that automatically refresh by calling AssumeRole on - the Amazon Security Token Service. - - - - - The credentials of the user that will be used to call AssumeRole. - - - - - The Amazon Resource Name (ARN) of the role to assume. - - - - - An identifier for the assumed role session. - - - - - Options to be used in the call to AssumeRole. - - - - - Constructs an AssumeRoleAWSCredentials object. - - The credentials of the user that will be used to call AssumeRole. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - - - - Constructs an AssumeRoleAWSCredentials object. - - The credentials of the user that will be used to call AssumeRole. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRole. - - - - A unique identifier that is used by third parties when assuming roles in their customers' accounts. - - - - - An IAM policy in JSON format. - - - - - The length of time in seconds before the credentials will expire. - - - - - The identification number of the MFA device that is associated with the user who is making the assume-role call. - - - - - The value provided by the MFA device, if the trust policy of the role being assumed requires MFA. - - - - - A callback that's used to obtain the MFA token code when the AssumeRoleAWSCredentials are refreshed. - - - - - Immutable representation of AWS credentials obtained as a result of - authenticating with the AssumeRole method of the Security Token Service. - - - - - The expiry time of the credentials, obtained from the AssumeRoleResponse. - - - - - Constructs an instance with supplied keys, token, and expiration. - - The AccessKey for the credentials. - The SecretKey for the credentials. - The security token for the credentials. - The expiration time for the credentials. - - - - Get a copy of this AssumeRoleImmutableCredentials object. - - A copy of this object. - - - - Abstract class that represents a credentials object for AWS services. - - - - - Returns a copy of ImmutableCredentials - - - - - - Called by AmazonServiceClient to validate the credential state - on client construction. - - - - - Basic set of credentials consisting of an AccessKey and SecretKey - - - - - Constructs a BasicAWSCredentials object for the specified accessKey and secretKey. - - - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - Immutable representation of AWS credentials. - - - - - Gets the AccessKey property for the current credentials. - - - - - Gets the SecretKey property for the current credentials. - - - - - Gets the Token property for the current credentials. - - - - - Gets the UseToken property for the current credentials. - Specifies if Token property is non-emtpy. - - - - - Constructs an ImmutableCredentials object with supplied accessKey, secretKey. - - - - Optional. Can be set to null or empty for non-session credentials. - - - - Returns a copy of the current credentials. - - - - - - Abstract class for automatically refreshing AWS credentials - - - - - Refresh state container consisting of credentials - and the date of the their expiration - - - - - Represents the current state of the Credentials. - - This can be cleared without synchronization. - - - - Semaphore to control thread access to GetCredentialsAsync method. - The semaphore will allow only one thread to generate new credentials and - update the current state. - - - - - The time before actual expiration to expire the credentials. - Property cannot be set to a negative TimeSpan. - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - Test credentials existence and expiration time - should update if: - credentials have not been loaded yet - it's past the expiration time. At this point currentState.Expiration may - have the PreemptExpiryTime baked into to the expiration from a call to - UpdateToGeneratedCredentials but it may not if this is new application load. - - - - - When overridden in a derived class, generates new credentials and new expiration date. - - Called on first credentials request and when expiration date is in the past. - - - - - - When overridden in a derived class, generates new credentials and new expiration date. - - Called on first credentials request and when expiration date is in the past. - - - - - - Clears currently-stored credentials, forcing the next GetCredentials call to generate new credentials. - - - - - Immutable representation of AWS credentials obtained as a result of - authenticating against a SAML-supporting federated identity provider. - - - - - The expiry time of the credentials, obtained from the AssumeRoleWithSAML response. - - - - - The value of the NameID element in the Subject element of the SAML assertion, as returned in the - AssumeRoleWithSAML response from the Security Token Service. - - - - - Constructs an instance with supplied keys and SAML assertion data. - - - - - - - - - - Constructs an instance with supplied keys and SAML assertion data. - - - - - - - - Returns a copy of the current credentials. - - - - - - Serializes the instance to a json-format string for external storage - - The serialized object in json - - - - Instantiates an instance from persisted json data - - The serialized data - Deserialized instance corresponding to the json data - - - - Session credentials consisting of AccessKey, SecretKey and Token - - - - - Constructs a SessionAWSCredentials object for the specified accessKey, secretKey. - - - - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - Credentials that are retrieved from the Instance Profile service on an EC2 instance - - - - - Constructs a InstanceProfileAWSCredentials object for specific role - - Role to use - - - - Constructs a InstanceProfileAWSCredentials object for the first found role - - - - - Retrieves a list of all roles available through current InstanceProfile service - - InstanceProfileAWSCredentials is no longer supported in PCL. - - - - - - Superclass for Exceptions that come over the event stream, or to wrap other kinds of generic exceptions. - - - - - The numeric code identifier for the type of error. - - - - - Constructs an EventStreamError. - - - - - Constructs an EventStreamError. - - The error code. - The error message. - - - - Event args that contain an . - - The - - - - The EventStream Event. - - - - - Constructs an EventStreamEventReceivedArgs. - - The EventStream Event. - - - - Event args that contain an . - - The . - - - - The EventStream Exception. - - - - - Constructs an EventStreamExceptionReceivedArgs. - - The EventStream Exception. - - - - Supported Header types for vnd.amazon.event-stream - - - - - Name for the Header. Maximum of 255 bytes. - - - - - Header type id - - - - - Computes the amount of memory neccesary to serialize this Header. - - - - - Writes this Header to buffer starting at offset - Keep in mind, this API assumes buffer is large enough - for the operation. - - buffer to serialize this Header to - offset to begin writing at. - - the new offset. - - - - - Returns the current value as a bool - - - - - Sets the current value - - - - - Returns the current value as a byte - - - - - Sets the current value - - - - - Gets the current value as a 16 bit integer. (Host Order). - - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a 32 bit integer. (Host Order) - - - - - Sets the current value - - - - - returns the current value as a 64-bit integer. (Host Order) - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a byte buffer. - - - - - - Sets the current value. Max length is 2^15 - 1 - - - - - Returns the current value as a utf-8 string. - - - - - Sets the current value. Utf-8 encoded. Max byte size is 2^16 - 1 - - - - - Gets the current value as a DateTime. - Note: You do not need to compensate for unix epoch on this API. - - - - - - Sets the current value. - Note: You do not need to compensate for unix epoch on this API. - - - - - Returns the current value as a Guid (UUID) - - - - - Sets the current value - - - - - Header Data for an EventStreamMessage - - Each header is of format: - [name len] (1) | [utf-8 name] (v) - [type (1)] - [value (v)] - - - - - Name for the Header. Maximum of 255 bytes. - - - - - Header type id - - - - - Initializes this Header with name. - - utf-8 string, max length is 255 - - - - Deserializes the header in buffer. - - buffer constaining the header - index to start from in the buffer. - updated offset with new value for offset - - - - Writes this Header to buffer starting at offset - Keep in mind, this API assumes buffer is large enough - for the operation. - - buffer to serialize this Header to - offset to begin writing at. - - the new offset. - - - - - Computes the amount of memory neccesary to serialize this Header. - - - - - Returns the current value as a bool - - - - - Sets the current value - - - - - Returns the current value as a byte - - - - - Sets the current value - - - - - Gets the current value as a 16 bit integer. (Host Order). - - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a 32 bit integer. (Host Order) - - - - - Sets the current value - - - - - returns the current value as a 64-bit integer. (Host Order) - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a byte buffer. - - - - - - Sets the current value. Max length is 2^15 - 1 - - - - - Returns the current value as a utf-8 string. - - - - - Sets the current value. Utf-8 encoded. Max byte size is 2^16 - 1 - - - - - Gets the current value as a DateTime. - Note: You do not need to compensate for unix epoch on this API. - - - - - - Sets the current value. - Note: You do not need to compensate for unix epoch on this API. - - - - - Returns the current value as a Guid (UUID) - - - - - Sets the current value - - - - - Headers for the message. Can be null. - - - - - Payload for the message. Can be null. - - - - - Converts a message into a byte buffer (usually for network transmission). - - - - - Message is a single datagram. The format is as follows: - [ total length (4) ] | [ headers_length (4)] | [ prelude crc(4)] - [ headers (v)] - [ payload (v)} - [ trailing crc ] - - CRCs use the CRC32 algorithm. - - - - - Content type for EventStreams. - - - - - Headers for the message. Can be null. - - - - - Payload for the message. Can be null. - - - - - Initialize a message with headers and a payload. - - list of headers for the message, can be null. - payload for the message, can be null. - - - - Builds a message from buffer. - - buffer to read - offset to start reading - buffer length. - - parsed instance of EventStreamMessage. Doesn't return null, - does throw if CRCs don't match. - - - - - Converts a message into a byte buffer (usually for network transmission). - - - - - Defines exceptions that arise from an not conforming to specification. - - - - - Constructs an EventStreamValidationException. - - - - - Constructs an EventStreamValidationException. - - The exception message. - - - - Constructs an EventStreamValidationException. - - The exception message. - The inner exception. - - - - This exception is thrown if an exception is retrieved from the event stream and should be modeled, - but a generator function for the strongly-typed exception is not defined. - - - - - The exception type. - - - - - Constructs an EventStreamException. - - The exception type. - - - - The contract for the . - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - A subclass of that enables an enumerable interface for interacting with Events. - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - Flag if the stream was chosen to be enumerated. - - - - - A Stream of Events. Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treated as mutually exclusive. - - - - - A Stream of Events. Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treated as mutually exclusive. - - - - - Returns an enumerator that iterates through the collection. - - An enumerator that can be used to iterate through the collection. - - - - Returns an enumerator that iterates through a collection. - - An object that can be used to iterate through the collection. - - - - Starts the background thread to start reading events from the network stream. - - - - - The contract for the . - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - The size of the buffer for reading from the network stream. - - - - - Fires when an event is received. - - - - - Fired when an exception or error is raised. - - - - - Starts the background thread to start reading events from the network stream. - - - - - The superclass for all EventStreams. It contains the common processing logic needed to retreive events from a network Stream. It - also contains the mechanisms needed to have a background loop raise events. - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - "Unique" key for unknown event lookup. - - - - - Header key for message type. - - - - - Header key for event type. - - - - - Header key for exception type. - - - - - Header key for error code. - - - - - Header key for error message. - - - - - Value of when the message is an event. - - - - - Value of when the message is an exception. - - - - - Value of when the message is an error. - - - - - The size of the buffer for reading from the network stream. - Default is 8192. - - - - - The underlying stream to read events from. - - - - - Responsible for decoding events from sequences of bytes. - - - - - Fires when an event is recieved. - - - - - Fired when an exception or error is raised. - - - - - The mapping of event message to a generator function to construct the matching Event Stream event. - - - - - The mapping of event message to a generator function to construct the matching Event Stream exception. - - - - - Whether the Stream is currently being processed. - - - - - A Stream of Events. Events can be retrieved from this stream by attaching handlers to listen events, and then calling StartProcessing. - - - - - A Stream of Events. Events can be retrieved from this stream by attaching handlers to listen events, and then calling StartProcessing. - - - - - Converts an EventStreamMessage to an event. - - The event stream message to be converted. - The event - - - - Abstraction for cross-framework initiation of the background thread. - - - - - The background thread main loop. It will constantly read from the network stream until IsProcessing is false, or an error occurs. - - This stub exists due to FXCop. - - - - - The background thread main loop. It will constantly read from the network stream until IsProcessing is false, or an error occurs. - - Needed for 3.5 support. Not used. - - - - Reads from the stream into the buffer. It then passes the buffer to the decoder, which raises an event for - each message it decodes. - - The buffer to store the read bytes from the stream. - - - - Wraps exceptions in an outer exception so they can be passed to event handlers. If the Exception is already of a compatable type, - the method returns what it was given. - - The exception to wrap. - An exception of type TE - - - - Starts the background thread to start reading events from the network stream. - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Disposes the resources of this stream. - - Should dispose of unmanged resources. - - - - Event Arguments for EventStreamDecoder.MessageReceived. - - - - - Received message. - - - - - Additional object context - - - - - Initialize this with message - - - - - Initialize this with message and object conetext - - - - - Exception thrown when a request is made of the Decoder, but the internal state - machine is an invalid state. This is usually the result of an interanl exception - being thrown during parsing of the network stream. - - - - - Contract for EventStreamDecoder - - - - - Invoked anytime an EventStreamMessage is found. - - - - - Processes data starting at offset up to length. - Invokes MessageRecieved for each message encountered. - If an exception is thrown, this object is not safe for reuse. - - buffer to read - offset in buffer to start reading. - length of data. - - - - Streaming decoder for listening for incoming EventStreamMessage datagrams. - - - - - Invoked anytime an EventStreamMessage is found. - - - - - Object data (optional) that can be passed to the event handler for MessageReceived. - - - - - Default constructor. Initializes internal _state machine. - - - - - Processes data starting at offset up to length. - Invokes MessageRecieved for each message encountered. - If an exception is thrown, this object is not safe for reuse. - - buffer to read - offset in buffer to start reading. - length of data. - - - - Superclass for Exceptions that come over the event stream, or to wrap other kinds of generic exceptions. - - - - - Constructs an EventStreamException. - - - - - Constructs an EventStreamException. - - The exception message. - - - - Constructs an EventStreamException. - - The exception message. - The inner exception. - - - - The contract for EventStream events. - - - - - The contract for EventStream terminal events. - - - - - This Event is returned if an event is retrieved from the event stream, but a generator function - for the event is not defined. This can occur if the SDK is not updated after a new event type is introduced. - - - - - The Message recieved from the event stream before conversion. - - - - - The event type. - - - - - Constructs an UnknownEventStreamEvent. - - - - - Constructs an UnknownEventStreamEvent. - - The Message recieved from the event stream before conversion. - The event type. - - - - Signals that an an has an unknown message type. These exceptions whould be - swallowed to allow future expansion of the EventStream specification without breaking existing clients. - - - - - Constructs an UnknownEventStreamMessageTypeException. - - - - - Interface for a handler in a pipeline. - - - - - The logger used to log messages. - - - - - The inner handler which is called after the current - handler completes it's processing. - - - - - The outer handler which encapsulates the current handler. - - - - - Contains the processing logic for a synchronous request invocation. - This method should call InnerHandler.InvokeSync to continue processing of the - request by the pipeline, unless it's a terminating handler. - - The execution context which contains both the - requests and response context. - - - - Contains the processing logic for an asynchronous request invocation. - This method should call InnerHandler.InvokeSync to continue processing of the - request by the pipeline, unless it's a terminating handler. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - The interface for an exception handler. - - - - - Handles an exception for the given execution context. - - The execution context, it contains the - request and response context. - The exception to handle. - - Returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception to replace the original exception. - - - - - The interface for an exception handler with a generic parameter for the exception type. - - The exception type. - - - - Handles an exception for the given execution context. - - The execution context, it contains the - request and response context. - The exception to handle. - - Returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception to replace the original exception. - - - - - The interface for a HTTP request factory. - - The type used by the underlying HTTP API to represent the request body. - - - - Creates an HTTP request for the given URI. - - The request URI. - An HTTP request. - - - - The interface for an HTTP request that is agnostic of the underlying HTTP API. - - The type used by the underlying HTTP API to represent the HTTP request content. - - - - The HTTP method or verb. - - - - - The request URI. - - - - - Configures a request as per the request context. - - The request context. - - - - Sets the headers on the request. - - A dictionary of header names and values. - - - - Gets a handle to the request content. - - The request content. - - - - Returns the HTTP response. - - The HTTP response. - - - - Writes a stream to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - The request context. - - - - Writes a byte array to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - - - - Sets up the progress listeners - - The content stream - The interval at which progress needs to be published - The objects which is trigerring the progress changes - The callback which will be invoked when the progress changed event is trigerred - an object, incase the progress is setup, else returns the original stream - - - - Aborts the HTTP request. - - - - - Gets a handle to the request content. - - - - - - Returns the HTTP response. - - A cancellation token that can be used to cancel the asynchronous operation. - - - - - A factory which creates HTTP clients. - - - - - Create and configure an HttpClient. - - - - - - A factory which creates HTTP requests which uses System.Net.Http.HttpClient. - - - - - The constructor for HttpRequestMessageFactory. - - Configuration setting for a client. - - - - Creates an HTTP request for the given URI. - - The request URI. - An HTTP request. - - - - Disposes the HttpRequestMessageFactory. - - - - - Dispose the factory - - - - - - Create and configure a managed HttpClient instance. - The use of HttpClientHandler in the constructor for HttpClient implicitly creates a managed HttpClient. - If a native HttpClient is required the SDK user must implement IHttpClientFactory and provide an - instance via IClientConfig.HttpClientFactory (only available in PCL). - - - - - - - A cache of HttpClient objects. The GetNextClient method does a round robin cycle through the clients - to distribute the load even across. - - - - - Constructs a container for a cache of HttpClient objects - - The HttpClient to cache - - - - Returns the next HttpClient using a round robin rotation. It is expected that individual clients will be used - by more then one Thread. - - - - - - Disposes the HttpClientCache. - - - - - Dispose the HttpClientCache - - - - - - HTTP request wrapper for System.Net.Http.HttpRequestMessage. - - - - - Set of content header names. - - - - - The constructor for HttpWebRequestMessage. - - The HttpClient used to make the request. - The request URI. - The service client config. - - - - The underlying HttpClient - - - - - The underlying HTTP web request. - - - - - The HTTP method or verb. - - - - - The request URI. - - - - - Configures a request as per the request context. - - The request context. - - - - Sets the headers on the request. - - A dictionary of header names and values. - - - - Gets a handle to the request content. - - The request content. - - - - Returns the HTTP response. - - The HTTP response. - - - - Aborts the HTTP request. - - - - - Returns the HTTP response. - - A cancellation token that can be used to cancel the asynchronous operation. - - - - - Writes a stream to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - The request context. - - - - Writes a byte array to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - - - - Gets a handle to the request content. - - - - - - Disposes the HttpWebRequestMessage. - - - - - - - - - - - Sets up the progress listeners - - The content stream - The interval at which progress needs to be published - The objects which is trigerring the progress changes - The callback which will be invoked when the progress changed event is trigerred - an object, incase the progress is setup, else returns the original stream - - - - A retry policy specifies all aspects of retry behavior. This includes conditions when the request should be retried, - checks of retry limit, preparing the request before retry and introducing delay (backoff) before retries. - - - A retry policy specifies all aspects of retry behavior. This includes conditions when the request should be retried, - checks of retry limit, preparing the request before retry and introducing delay (backoff) before retries. - - - - - Maximum number of retries to be performed. - This does not count the initial request. - - - - - The logger used to log messages. - - - - - The standard set of throttling error codes - - - - - The standard set of timeout error codes to retry on. - - - - - List of AWS specific error codes which are returned as part of the error response. - These error codes will be retried. - - - - - The standard set of transient error, HTTP status codes to retry on. - 502 and 504 are returned by proxies. These can also be returned for - S3 accelerate requests which are served by CloudFront. - - - - - Set of web exception status codes to retry on. - - - - - This parameter serves as the value to the CapacityManager.Container datastructure. - Its properties include the available capacity left for making a retry request and the maximum - capacity size. - - - - - Checks if a retry should be performed with the given execution context and exception. - - The execution context which contains both the - requests and response context. - The exception thrown after issuing the request. - Returns true if the request should be retried, else false. The exception is retried if it matches with clockskew error codes. - - - - Returns true if the request is in a state where it can be retried, else false. - - The execution context which contains both the - requests and response context. - Returns true if the request is in a state where it can be retried, else false. - - - - Return true if the request should be retried for the given exception. - - The execution context which contains both the - requests and response context. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Checks if the retry limit is reached. - - The execution context which contains both the - requests and response context. - Return false if the request can be retried, based on number of retries. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called on a successful request response. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called before a retry request is initiated. The value - returned is True by default(retry throttling feature is disabled). - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called before a retry request is initiated. The value - returned is True by default(retry throttling feature is disabled). - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - - - - Virtual method that gets called before a retry request is initiated. The value - returned is True by default(retry throttling feature is disabled). - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - true if the error that will be retried is a throttling error - - - - This method uses a token bucket to enforce the maximum sending rate. - - The execution context which contains both the - requests and response context. - If the prior request failed, this exception is expected to be - the exception that occurred during the prior request failure. - - - - Determines if an AmazonServiceException is a throttling error - - The current exception to check. - true if it is a throttling error else false. - - - - Determines if an AmazonServiceException is a transient error that - should be retried. - - The current execution context - The current exception to check. - true if the exception is a transient error else false. - - - - Determines if the exception is a known timeout error code that - should be retried under the timeout error category. - - The current exception to check. - true if the exception is considered a timeout else false - - - - Checks if a retry should be performed with the given execution context and exception. - - The execution context which contains both the - requests and response context. - The exception throw after issuing the request. - Returns true if the request should be retried, else false. The exception is retried if it matches with clockskew error codes. - - - - This method uses a token bucket to enforce the maximum sending rate. - - The execution context which contains both the - requests and response context. - If the prior request failed, this exception is expected to be - the exception that occurred during the prior request failure. - - - - Return true if the request should be retried for the given exception. - - The execution context which contains both the - requests and response context. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - ICoreAmazonKMS is not meant to be used directly. It defines Key Management Service - with basic .NET types and allows other services to be able to use the service as - a runtime dependency. This interface is implemented by the AmazonKeyManagementServiceClient - defined in the AWSSDK.KeyManagementService assembly. - - - - - The result of the GenerateDataKey and GenerateDataKeyAsync operations. - - - - - The plaintext for the data key. - - - - - The ciphertext for the data key. - - - - - ICoreAmazonS3 is not meant to use directly. It defines S3 with basic .NET types - and allows other services to be able to use S3 as a runtime dependency. This interface - is implemented by the AmazonS3Client defined in the S3 assembly. - - - ICoreAmazonS3 is not meant to use directly. It defines S3 with basic .NET types - and allows other services to be able to use S3 as a runtime dependency. This interface - is implemented by the AmazonS3Client defined in the S3 assembly. - - - - - Generate a presigned URL. - - - - - - - - - - Get all the object keys for the particular bucket and key prefix. - - - - - - - - - Upload an object from a stream. - - - - - - - - - - - Delete an object. - - - - - - - - - - Delete an object. - - - - - - - - - - Open a stream to an object in S3. - - - - - - - - - - Upload an object from a file path. - - - - - - - - - - - Download an object in S3 to a file path. - - - - - - - - - - - Set the ACL on the object to public readable. - - - - - - - - Check to see if the bucket exists and if it doesn't create the bucket. - - - - - - Check to see if the bucket exists. - - - - - - - ICoreAmazonSQS is not meant to use directly. It defines SQS with basic .NET types - and allows other services to be able to use SQS as a runtime dependency. This interface - is implemented by the AmazonSQSClient defined in the SQS assembly. - - - - - Get the attributes for the queue identified by the queue URL asynchronously. - - The queue URL to get attributes for. - A Task containing the result of a dictionary of attributes for the queue. - - - - Set the attributes on the queue identified by the queue URL asynchronously. - - The queue URL to set the attributues. - The attributes to set. - A Task - - - - ICoreAmazonSTS is not meant to be used directly. It defines Security Token - service with basic .NET types and allows other services to be able to use the service as - a runtime dependency. This interface is implemented by the AmazonSecurityTokenServiceClient - defined in the AWSSDK.SecurityToken assembly. - - - - - - This method is used internally to access the Amazon Security Token - service within other service assemblies. - Please use AmazonSecurityTokenServiceClient to access the Amazon Security Token - service instead. - - Use Amazon Security Token Service to assume a role. - - Proxy settings that are required for the HTTPS and STS calls made during the authentication/credential - generation process are supported and should have been configured on the STS ClientConfig instance - associated with the STS client instance exposing this interface. - - - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRole. - - - - - CoreAmazonKMS is not meant to use directly. It implements ICoreAmazonKMS - and allows other service clients to be able to use the KMS service as a runtime dependency. - - This class waits until a method is actually called on the ICoreAmazonKMS interface - before requiring the KMS assembly to be present and loaded. - - - - - Settings for configuring a proxy for the SDK to use. - - - - - The host name or IP address of the proxy server. - - - - - The port number of the proxy. - - - - - The username to authenticate with the proxy server. - - - - - The password to authenticate with the proxy server. - - - - - Collection of one or more regular expressions denoting addresses - for which the proxy will not be used. - - - For more information on bypass lists - see https://msdn.microsoft.com/en-us/library/system.net.webproxy.bypasslist%28v=vs.110%29.aspx. - - - - - If true requests to local addresses bypass the configured - proxy. - - - - - Settings for logging in the SDK. - - - - - Logging destination. - - - - - When to log responses. - - - - - Gets or sets the size limit in bytes for logged responses. - If logging for response body is enabled, logged response - body is limited to this size. The default limit is 1KB. - - - - - Whether or not to log SDK metrics. - - - - - A custom formatter added through Configuration - - - - - This class can be used to discover the public address ranges for AWS. The - information is retrieved from the publicly accessible - https://ip-ranges.amazonaws.com/ip-ranges.json file. - - - The information in this file is generated from our internal system-of-record and - is authoritative. You can expect it to change several times per week and should - poll accordingly. - - - - - Region identifier string for ROUTE53 and CLOUDFRONT ranges - - - - - Collection of service keys found in the data file. - - - - - The publication date and time of the file that was downloaded and parsed. - - - - - Collection of all public IP ranges. - - - - - Filtered collection of public IP ranges for the given service key - - - - - Filtered collection of public IP ranges for the given region (us-east-1 etc) or GLOBAL. - - - - - Filtered collection of public IP ranges for the given network border group. - - - - - Downloads the most recent copy of the endpoint address file and - parses it to a collection of address range objects. - - - - - Downloads the most recent copy of the endpoint address file and - parses it to a collection of address range objects. - - - - - Represents the IP address range for a single region and service key. - - - - - The public IPv4 or Ipv6 address range, in CIDR notation. - - - - - Indicates ipv4 or v6 format of the address - - - - - The AWS region or GLOBAL for edge locations. Note that the CLOUDFRONT and ROUTE53 - ranges are GLOBAL. - - - - - The subset of IP address ranges. Specify AMAZON to get all IP address ranges - (for example, the ranges in the EC2 subset are also in the AMAZON subset). Note - that some IP address ranges are only in the AMAZON subset. - - - Valid values for the service key include "AMAZON", "EC2", "ROUTE53", - "ROUTE53_HEALTHCHECKS", and "CLOUDFRONT." If you need to know all of - the ranges and don't care about the service, use the "AMAZON" entries. - The other entries are subsets of this one. Also, some of the services, - such as S3, are represented in "AMAZON" and do not have an entry that - is specific to the service. We plan to add additional values over time; - code accordingly! - - - - - The network border group the IP address range belongs to. - - - AWS Local Zones allow you to seamlessly connect to the full range of services in the AWS Region such - as Amazon Simple Storage Service and Amazon DynamoDB through the same APIs and tool sets. You can extend - your VPC Region by creating a new subnet that has a Local Zone assignment. When you create a subnet in - a Local Zone, the VPC is also extended to that Local Zone. - - A network border group is a unique set of Availability Zones or Local Zones from where AWS advertises - public IP addresses. - - When you create a VPC that has IPv6 addresses, you can choose to assign a set of Amazon-provided public - IP addresses to the VPC and also set a network border group for the addresses that limits the addresses - to the group. When you set a network border group, the IP addresses cannot move between network - border groups. The us-west-2 network border group contains the four US West (Oregon) Availability Zones. - The us-west-2-lax-1 network border group contains the Los Angeles Local Zones. - - - - - This class defines utilities and constants that can be used by - all the client libraries of the SDK. - - - - - The user agent string header - - - - - The Set of accepted and valid Url characters per RFC3986. - Characters outside of this set will be encoded. - - - - - The Set of accepted and valid Url characters per RFC1738. - Characters outside of this set will be encoded. - - - - - The set of accepted and valid Url path characters per RFC3986. - - - - - The string representing Url Encoded Content in HTTP requests - - - - - The GMT Date Format string. Used when parsing date objects - - - - - The ISO8601Date Format string. Used when parsing date objects - - - - - The ISO8601Date Format string. Used when parsing date objects - - - - - The ISO8601 Basic date/time format string. Used when parsing date objects - - - - - The ISO8601 basic date format. Used during AWS4 signature computation. - - - - - The RFC822Date Format string. Used when parsing date objects - - - - - Returns an extension of a path. - This has the same behavior as System.IO.Path.GetExtension, but does not - check the path for invalid characters. - - - - - - Convert request parameters to Url encoded query string - - - Convert Dictionary of parameters to Url encoded query string - - - - Returns the canonicalized resource path for the service endpoint with single URL encoded path segments. - - Endpoint URL for the request - Resource path for the request - - If resourcePath begins or ends with slash, the resulting canonicalized - path will follow suit. - - Canonicalized resource path for the endpoint - - - - Returns the canonicalized resource path for the service endpoint - - Endpoint URL for the request - Resource path for the request - If true pre URL encode path segments if necessary. - S3 is currently the only service that does not expect pre URL encoded segments. - - If resourcePath begins or ends with slash, the resulting canonicalized - path will follow suit. - - Canonicalized resource path for the endpoint - - - - Returns the canonicalized resource path for the service endpoint - - Endpoint URL for the request - Resource path for the request - If true pre URL encode path segments if necessary. - S3 is currently the only service that does not expect pre URL encoded segments. - Dictionary of key/value parameters containing the values for the ResourcePath key replacements - The version of the marshaller that constructed the request object. - - If resourcePath begins or ends with slash, the resulting canonicalized - path will follow suit. - - Canonicalized resource path for the endpoint - - - - Splits the resourcePath at / into segments then resolves any keys with the path resource values. Greedy - key values will be split into multiple segments at each /. - - The patterned resourcePath - The key/value lookup for the patterned resourcePath - A list of path segments where all keys in the resourcePath have been resolved to one or more path segment values - - - - Joins all path segments with the / character and encodes each segment before joining. - - The segments of a URL path split at each / character - If the path property is specified, - the accepted path characters {/+:} are not encoded. - A joined URL with encoded segments - - - - Takes a patterned resource path and resolves it using the key/value path resources into - a segmented encoded URL. - - The patterned resourcePath - The key/value lookup for the patterned resourcePath - A segmented encoded URL - - - - Returns a new string created by joining each of the strings in the - specified list together, with a comma between them. - - The list of strings to join into a single, comma delimited - string list. - A new string created by joining each of the strings in the - specified list together, with a comma between strings. - - - - Attempt to infer the region for a service request based on the endpoint - - Endpoint to the service to be called - - Region parsed from the endpoint; DefaultRegion (or DefaultGovRegion) - if it cannot be determined/is not explicit - - - - - Attempt to infer the service name for a request (in short form, eg 'iam') from the - service endpoint. - - Endpoint to the service to be called - - Short-form name of the service parsed from the endpoint; empty string if it cannot - be determined - - - - - Utility method for converting Unix epoch seconds to DateTime structure. - - The number of seconds since January 1, 1970. - Converted DateTime structure - - - - Helper function to format a byte array into string - - The data blob to process - If true, returns hex digits in lower case form - String version of the data - - - - Calls a specific EventHandler in a background thread - - - - - - - - Parses a query string of a URL and returns the parameters as a string-to-string dictionary. - - - - - - - Utility method for converting a string to a MemoryStream. - - - - - - - Utility method for copy the contents of the source stream to the destination stream. - - - - - - - Utility method for copy the contents of the source stream to the destination stream. - - - - - - - - Formats the current date as a GMT timestamp - - A GMT formatted string representation - of the current date and time - - - - - Formats the current date as ISO 8601 timestamp - - An ISO 8601 formatted string representation - of the current date and time - - - - - Gets the ISO8601 formatted timestamp that is minutesFromNow - in the future. - - The number of minutes from the current instant - for which the timestamp is needed. - The ISO8601 formatted future timestamp. - - - - Formats the current date as ISO 8601 timestamp - - An ISO 8601 formatted string representation - of the current date and time - - - - - Gets the RFC822 formatted timestamp that is minutesFromNow - in the future. - - The number of minutes from the current instant - for which the timestamp is needed. - The ISO8601 formatted future timestamp. - - - - Determines whether the given string is an absolute path to a root. - - The hypothetical absolute path. - True if is an absolute path. - - - - Returns true if the path specified is relative to the current drive or working directory. - Returns false if the path is fixed to a specific drive or UNC path. This method does no - validation of the path (URIs will be returned as relative as a result). - - - Handles paths that use the alternate directory separator. It is a frequent mistake to - assume that rooted paths (Path.IsPathRooted) are not relative. This isn't the case. - "C:a" is drive relative- meaning that it will be resolved against the current directory - for C: (rooted, but relative). "C:\a" is rooted and not relative (the current directory - will not be used to modify the path). - - - - - True if the given character is a directory separator. - - - - - Returns true if the given character is a valid drive letter - - - - - URL encodes a string per RFC3986. If the path property is specified, - the accepted path characters {/+:} are not encoded. - - The string to encode - Whether the string is a URL path or not - The encoded string - - - - URL encodes a string per the specified RFC. If the path property is specified, - the accepted path characters {/+:} are not encoded. - - RFC number determing safe characters - The string to encode - Whether the string is a URL path or not - The encoded string - - Currently recognised RFC versions are 1738 (Dec '94) and 3986 (Jan '05). - If the specified RFC is not recognised, 3986 is used by default. - - - - - URL encodes a string per the specified RFC with the exception of preserving the encoding of previously encoded slashes. - If the path property is specified, the accepted path characters {/+:} are not encoded. - - The string to encode - Whether the string is a URL path or not - The encoded string with any previously encoded %2F preserved - - - - Convert bytes to a hex string - - Bytes to convert. - Hexadecimal string representing the byte array. - - - - Convert a hex string to bytes - - Hexadecimal string - Byte array corresponding to the hex string. - - - - Returns DateTime.UtcNow + ManualClockCorrection when - is set. - This value should be used instead of DateTime.UtcNow to factor in manual clock correction - - - - - Returns true if the string has any bidirectional control characters. - - - - - - - Executes an HTTP request and returns the response as a string. This method - throws WebException and HttpRequestException. In the event HttpRequestException - is thrown the StatusCode is sent as user defined data on the exception under - the key "StatusCode". - - The URI to make the request to - The request type: GET, PUT, POST - null or the content to send with the request - Timeout for the request - Proxy for the request - null or any headers to send with the request - The response as a string. - - - - Utility method that accepts a string and replaces white spaces with a space. - - - - - - - Class that contains result of executing an external process through the SDKs - AWSSDKUtils.RunProcess/AWSSDKUtils.RunProcessAsync - - - - - The exit code with which the process exited - - - - - The output of the process read till the end - - - - - The error output of the process read till the end - - - - - Object to track circular references in nested types. - At each level of nesting, make a call to Track to retrieve Tracker, - a tracking object implementing the IDisposable interface. - Dispose of this tracker when leaving the context of the tracked object. - - - - - Tracker. Must be disposed. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Adds the current target to a reference list and returns a tracker. - The tracker removes the target from the reference list when the - tracker is disposed. - - - - - - - Root AWS config - - - - - AwsHttpClient is a wrapper around HttpClient class of the System.Net.Http library. - The wrapper has been added so as to remove System.Net.Http dependencies from the Services - and migrate it to a Core level dependecy only. This avoids version clashes when a service - and the Core depends on different versions of the System.Net.Http library. This is a Service - level utility method - - - - - AWSHttpClient wrapper that is wrapped around - HttpClient default wrapper. - - - - - AWSHttpClient BaseAddress property that is wrapper for - HttpClient BaseAddress property. - - - - - AWSHttpClient Timeout property that is wrapper for - HttpClient Timeout property. - - - - - AWSHttpClient MaxResponseContentBufferSize property that is wrapper for - HttpClient MaxResponseContentBufferSize property. - - - - - AWSHttpClient GetStreamAsync that accepts the requester's URI - and make a HttpClient.GetStreamAsync call. - - Requester Uri - - - - Wrapper method that accepts a request uri, stream content and headers and makes a sendAsync call. - - - - - - - Wrapper for HttpClient's HttpRequestMessage and SendAsync methods. - - - - Returns response headers information- header name,value and status code - - - - Wrapper for HttpClient Dispose. - - - - - Method that checks if the passed exception is of type - HttpRequestException - - - - - - - AWSStreamContent is a wrapper for StreamContent class in - the System.Net.Http library.The wrapper has been added so as to - remove System.Net.Http dependencies from the Services - and migrate it to a Core level dependecy only. This avoids version clashes when a service - and the Core depends on different versions of the System.Net.Http library. This is a Service - level utility method - - - - - Wrapper for StreamContent constructor - for stream content - - - - - - Wrapper for StreamContent constructor - for stream content and bufferSize - - - - - - - Wrapper to allow Services to remove StreamContent Headers - - - - - - - Wrapper to allow Services to add StreamContent Headers - - - - - - - Wrapper for StreamContent Dispose. - - - - - Allows to configure the proxy used for HTTP requests. The default value is null. - - - - - This class contains the endpoints available to the AWS clients. The static constants representing the - regions can be used while constructing the AWS client instead of looking up the exact endpoint URL. - - - - - Gets the endpoint for a service in a region. - - The services system name. - If true returns the endpoint for dualstack - Thrown when the request service does not have a valid endpoint in the region. - - - - - Enumerate through all the regions. - - - - - Gets the region based on its system name like "us-west-1" - - The system name of the service like "us-west-1" - - - - - This is a testing method and should not be called by production applications. - - - - - Gets the system name of a region. - - - - - Gets the display name of a region. - - - - - This region name is non-standard. Search the whole endpoints.json file to - determine the partition this region is in. - - - - - This class contains region information used to lazily compute the service endpoints. The static constants representing the - regions can be used while constructing the AWS client instead of looking up the exact endpoint URL. - - - - - The US East (Virginia) endpoint. - - - - - The US East (Virginia) regional endpoint. - - - - - The US East (Ohio) endpoint. - - - - - The US West (N. California) endpoint. - - - - - The US West (Oregon) endpoint. - - - - - The EU North (Stockholm) endpoint. - - - - - The EU West (Ireland) endpoint. - - - - - The EU West (London) endpoint. - - - - - The EU West (Paris) endpoint. - - - - - The EU Central (Frankfurt) endpoint. - - - - - The Europe (Milan) endpoint. - - - - - The Asia Pacific (Hong Kong) endpoint. - - - - - The Asia Pacific (Tokyo) endpoint. - - - - - The Asia Pacific (Seoul) endpoint. - - - - - The Asia Pacific (Osaka-Local) endpoint. - - - - - The Asia Pacific (Mumbai) endpoint. - - - - - The Asia Pacific (Singapore) endpoint. - - - - - The Asia Pacific (Sydney) endpoint. - - - - - The South America (Sao Paulo) endpoint. - - - - - The US GovCloud East (Virginia) endpoint. - - - - - The US GovCloud West (Oregon) endpoint. - - - - - The China (Beijing) endpoint. - - - - - The China (Ningxia) endpoint. - - - - - The Canada (Central) endpoint. - - - - - The Middle East (Bahrain) endpoint. - - - - - The Africa (Cape Town) endpoint. - - - - - Represents the endpoint overridding rules in the endpoints.json - Is used to map private region (ie us-east-1-regional) to public regions (us-east-1) - For signing purposes. - - - - - Enumerate through all the regions. - - - - - Gets the region based on its system name like "us-west-1" - - The system name of the service like "us-west-1" - - - - - Gets the region endpoint override if exists - - The region endpoint to find the possible override for - - - - - Gets the system name of a region. - - - - - Gets the display name of a region. - - - - - Gets the partition name the region is in. For example for us-east-1 the partition name is aws. For cn-northwest-1 the partition name is aws-cn. - - - - - Gets the dns suffix for the region endpoints in a partition. For example the aws partition's suffix is amazonaws.com. The aws-cn partition's suffix is amazonaws.com.cn. - - - - - Gets the endpoint for a service in a region. - - - The services system name. Service system names can be obtained from the - RegionEndpointServiceName member of the ClientConfig-derived class for the service. - - - For forwards compatibility, if the service being requested for isn't known in the region, this method - will generate an endpoint using the AWS endpoint heuristics. In this case, it is not guaranteed the - endpoint will point to a valid service endpoint. - - - - - - Gets the endpoint for a service in a region, optionally selecting a dualstack compatible endpoint. - - - The services system name. Service system names can be obtained from the - RegionEndpointServiceName member of the ClientConfig-derived class for the service. - - - If true a dualstack endpoint is returned. It is the user's responsibility to verify that the given service - supports a dualstack endpoint for the region. - - - For forwards compatibility, if the service being requested for isn't known in the region, this method - will generate an endpoint using the AWS endpoint heuristics. In this case, it is not guaranteed the - endpoint will point to a valid service endpoint. - - - - - - This class defines an endpoints hostname and which protocols it supports. - - - - - Gets the hostname for the service. - - - - - The authentication region to be used in request signing. - - - - - This property is only set for S3 endpoints. For all other services this property returns null. - For S3 endpoints, if the endpoint supports signature version 2 this property will be "2", otherwise it will be "4". - - - - - Calculates a 32bit Cyclic Redundancy Checksum (CRC) using the - same polynomial used by Zip. This type is used internally by DotNetZip; it is generally not used directly - by applications wishing to create, read, or manipulate zip archive files. - - - - - indicates the total number of bytes read on the CRC stream. - This is used when writing the ZipDirEntry when compressing files. - - - - - Indicates the current CRC for all blocks slurped in. - - - - - Returns the CRC32 for the specified stream. - - The stream over which to calculate the CRC32 - the CRC32 calculation - - - - Returns the CRC32 for the specified stream, and writes the input into the output stream. - - The stream over which to calculate the CRC32 - The stream into which to deflate the input - the CRC32 calculation - - - - Get the CRC32 for the given (word,byte) combo. - This is a computation defined by PKzip. - - The word to start with. - The byte to combine it with. - The CRC-ized result. - - - - Update the value for the running CRC32 using the given block of bytes. - This is useful when using the CRC32() class in a Stream. - - block of bytes to slurp - starting point in the block - how many bytes within the block to slurp - - - - A Stream that calculates a CRC32 (a checksum) on all bytes read, - or on all bytes written. - - - - - This class can be used to verify the CRC of a ZipEntry when reading from a stream, - or to calculate a CRC when writing to a stream. The stream should be used to either - read, or write, but not both. If you intermix reads and writes, the results are - not defined. - - This class is intended primarily for use internally by the DotNetZip library. - - - - - Gets the total number of bytes run through the CRC32 calculator. - - - - This is either the total number of bytes read, or the total number - of bytes written, depending on the direction of this stream. - - - - - The constructor. - - The underlying stream - - - - The constructor. - - The underlying stream - The length of the stream to slurp - - - - Provides the current CRC for all blocks slurped in. - - - - - Read from the stream - - the buffer to read - the offset at which to start - the number of bytes to read - the number of bytes actually read - - - - Write to the stream. - - the buffer from which to write - the offset at which to start writing - the number of bytes to write - - - - Indicates whether the stream supports reading. - - - - - Indicates whether the stream supports seeking. - - - - - Indicates whether the stream supports writing. - - - - - Flush the stream. - - - - - Not implemented. - - - - - Not implemented. - - - - - Not implemented. - - N/A - N/A - N/A - - - - Not implemented. - - N/A - - - diff --git a/packages/AWSSDK.Core.3.3.107.14/lib/MonoTouch10/AWSSDK.Core.dll b/packages/AWSSDK.Core.3.3.107.14/lib/MonoTouch10/AWSSDK.Core.dll deleted file mode 100644 index 0921366..0000000 Binary files a/packages/AWSSDK.Core.3.3.107.14/lib/MonoTouch10/AWSSDK.Core.dll and /dev/null differ diff --git a/packages/AWSSDK.Core.3.3.107.14/lib/Xamarin.Mac20/AWSSDK.Core.XML b/packages/AWSSDK.Core.3.3.107.14/lib/Xamarin.Mac20/AWSSDK.Core.XML deleted file mode 100644 index 2b1ead4..0000000 --- a/packages/AWSSDK.Core.3.3.107.14/lib/Xamarin.Mac20/AWSSDK.Core.XML +++ /dev/null @@ -1,10850 +0,0 @@ - - - - AWSSDK.Core - - - - - Utility class to parse Amazon resource names more commonly known as an ARN. - - - - - Gets and sets the partition associated with the ARN (e.g.: 'aws'). - - - - - Gets and sets the AWS service associated with the ARN (e.g.: 's3'). - - - - - Gets and sets the region associated with the ARN (e.g.: 'us-east-1'). - - - - - Gets and sets the account ID associated with the ARN. - - - - - Gets and sets the resource associated with the ARN (e.g.: 'mybucket/myobject'). - - - - - Returns true if the string appears to be an ARN by seeing if the string starts with "arn:". This method - doesn't guarantee the string is a valid ARN. To validate the string call TryParse. - - - - - - - Parses the string into an ARN object. - - String to parse into an ARN. - The out parameter for the ARN object created by TryParse. - True if the string was parsed into an ARN object. - - - - Parses the string into an ARN object. - - String to parse into an Arn. - The Arn object created from the passed in string. - Thrown if arnString is null. - Thrown if the string passed in not valid ARN. - - - - Turns the Arn object into a string representation of an ARN. - - - - - - Configuration options that apply to the entire SDK. - - These settings can be configured through app.config or web.config. - Below is a full sample configuration that illustrates all the possible options. - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws region="us-west-2"> - <logging logTo="Log4Net, SystemDiagnostics" logResponses="Always" logMetrics="true" /> - <s3 useSignatureVersion4="true" /> - <proxy host="localhost" port="8888" username="1" password="1" /> - - <dynamoDB> - <dynamoDBContext tableNamePrefix="Prod-"> - - <tableAliases> - <alias fromTable="FakeTable" toTable="People" /> - <alias fromTable="Persons" toTable="People" /> - </tableAliases> - - <mappings> - <map type="Sample.Tests.Author, SampleDLL" targetTable="People" /> - <map type="Sample.Tests.Editor, SampleDLL" targetTable="People"> - <property name="FullName" attribute="Name" /> - <property name="EmployeeId" attribute="Id" /> - <property name="ComplexData" converter="Sample.Tests.ComplexDataConverter, SampleDLL" /> - <property name="Version" version="true" /> - <property name="Password" ignore="true" /> - </map> - </mappings> - - </dynamoDBContext> - </dynamoDB> - </aws> - - - - Configuration options that apply to the entire SDK. - - - - - Manual offset to apply to client clock. This is a global setting that overrides - ClockOffset value calculated for all service endpoints. - - - - - Determines if the SDK should correct for client clock skew - by determining the correct server time and reissuing the - request with the correct time. - Default value of this field is True. - will be updated with the calculated - offset even if this field is set to false, though requests - will not be corrected or retried. - Ignored if is set. - - - - - The calculated clock skew correction, if there is one. - This field will be set if a service call resulted in an exception - and the SDK has determined that there is a difference between local - and server times. - - If is set to true, this - value will be set to the correction, but it will not be used by the - SDK and clock skew errors will not be retried. - - - - - Key for the AWSRegion property. - - - - - - Configures the default AWS region for clients which have not explicitly specified a region. - Changes to this setting will only take effect for newly constructed instances of AWS clients. - - This setting can be configured through the App.config. For example: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws region="us-west-2" /> - - - - - - Key for the AWSProfileName property. - - - - - - Profile name for stored AWS credentials that will be used to make service calls. - Changes to this setting will only take effect in newly-constructed clients. - - To reference the account from an application's App.config or Web.config use the AWSProfileName setting. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="development"/> - </appSettings> - </configuration> - - - - - - - Key for the AWSProfilesLocation property. - - - - - - Location of the credentials file shared with other AWS SDKs. - By default, the credentials file is stored in the .aws directory in the current user's home directory. - - Changes to this setting will only take effect in newly-constructed clients. - - To reference the profile from an application's App.config or Web.config use the AWSProfileName setting. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfilesLocation" value="c:\config"/> - </appSettings> - </configuration> - - - - - - - Key for the Logging property. - - - - - - Configures how the SDK should log events, if at all. - Changes to this setting will only take effect in newly-constructed clients. - - The setting can be configured through App.config, for example: - - <appSettings> - <add key="AWSLogging" value="log4net"/> - </appSettings> - - - - - - Key for the ResponseLogging property. - - - - - - - Configures when the SDK should log service responses. - Changes to this setting will take effect immediately. - - The setting can be configured through App.config, for example: - - <appSettings> - <add key="AWSResponseLogging" value="OnError"/> - </appSettings> - - - - - - Key for the LogMetrics property. - - - - - - Configures if the SDK should log performance metrics. - This setting configures the default LogMetrics property for all clients/configs. - Changes to this setting will only take effect in newly-constructed clients. - - The setting can be configured through App.config, for example: - - <appSettings> - <add key="AWSLogMetrics" value="true"/> - </appSettings> - - - - - - Key for the EndpointDefinition property. - - - - - - Configures if the SDK should use a custom configuration file that defines the regions and endpoints. - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws endpointDefinition="c:\config\endpoints.json" /> - - - - - - Key for the UseSdkCache property. - - - - - - Configures if the SDK Cache should be used, the default value is true. - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws useSdkCache="true" /> - - - - - - Configuration for the Logging section of AWS configuration. - Changes to some settings may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws> - <logging logTo="Log4Net, SystemDiagnostics" logResponses="Always" logMetrics="true" /> - </aws> - - - - - - Configuration for the Proxy section of AWS configuration. - Changes to some settings may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws> - <proxy host="localhost" port="8888" username="1" password="1" bypassList="addressexpr1;addressexpr2;..." bypassOnLocal="true" /> - </aws> - - - - - - Configuration for the region endpoint section of AWS configuration. - Changes may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws region="us-west-2" /> - - - - - - Lock for SomeEvent delegate access. - - - - - This method should never be called directly. - Call AWSSDKUtils.CorrectedUtcNow instead. - - - - - - Logging options. - Can be combined to enable multiple loggers. - - - - - No logging - - - - - Log using log4net - - - - - Log using System.Diagnostics - - - - - Log to the console - - - - - Log to a file - - - - - Response logging option. - - - - - Never log service response - - - - - Only log service response when there's an error - - - - - Always log service response - - - - - Format for metrics data in the logs - - - - - Emit metrics in human-readable format - - - - - Emit metrics as JSON data - - - - - An access control policy action identifies a specific action in a service - that can be performed on a resource. For example, sending a message to a - queue. - - ActionIdentifiers allow you to limit what your access control policy statement affects. - For example, you could create a policy statement that enables a certain group - of users to send messages to your queue, but not allow them to perform any - other actions on your queue. - - - The action is B in the statement - "A has permission to do B to C where D applies." - - Free form access control policy actions may include a wildcard (*) to match - multiple actions. - - - Constants for known actions can be found in the Amazon.Auth.AccessControlPolicy.ActionIdentifiers namespace. - - - - - - Constructs an Actionidentifer with the given action name. - - The name of the action - - - - Gets and sets the name of this action. For example, 'sqs:SendMessage' is the - name corresponding to the SQS action that enables users to send a message - to an SQS queue. - - - - - AWS access control policy conditions are contained in - objects, and affect when a statement is applied. For example, a statement - that allows access to an Amazon SQS queue could use a condition to only apply - the effect of that statement for requests that are made before a certain - date, or that originate from a range of IP addresses. - - Multiple conditions can be included in a single statement, and all conditions - must evaluate to true in order for the statement to take effect. - - - The set of conditions is D in the statement - "A has permission to do B to C where D applies." - - - A condition is composed of three parts: - - - Condition Key - The condition key declares which value of a - request to pull in and compare against when a policy is evaluated by AWS. For - example, using will cause - AWS to pull in the current request's source IP as the first value to compare - against every time your policy is evaluated. - - - - Comparison Type - This is a static value used as the second value - in the comparison when your policy is evaluated. Depending on the comparison - type, this value can optionally use wildcards. See the documentation for - individual comparison types for more information. - - - - Comparison Value - This is a static value used as the second value - in the comparison when your policy is evaluated. Depending on the comparison - type, this value can optionally use wildcards. See the documentation for - individual comparison types for more information. - - - - - - - - - Gets the type of this condition. - - - - - Gets and Sets the name of the condition key involved in this condition. - Condition keys are predefined values supported by AWS that provide input - to a condition's evaluation, such as the current time, or the IP address - of the incoming request. - - Your policy is evaluated for each incoming request, and condition keys - specify what information to pull out of those incoming requests and plug - into the conditions in your policy. - - - - - - Gets and Sets the values specified for this access control policy condition. - For example, in a condition that compares the incoming IP address of a - request to a specified range of IP addresses, the range of IP addresses - is the single value in the condition. - - Most conditions accept only one value, but multiple values are possible. - - - - - - A factory for creating conditions to be used in the policy. - - - - - Condition key for the current time. - - This condition key should only be used with enum. - - - - - - Condition key for whether or not an incoming request is using a secure - transport to make the request (i.e. HTTPS instead of HTTP). - - This condition key should only be used with the boolean overload of NewCondition. - - - - - - Condition key for the source IP from which a request originates. - - This condition key should only be used with enum. - - - - - - Condition key for the user agent included in a request. - - This condition key should only be used with - enum. - - - - - - Condition key for the current time, in epoch seconds. - - This condition key should only be used with enum. - objects. - - - - - - Condition key for the referrer specified by a request. - - This condition key should only be used with - objects. - - - - - - Condition key for the Amazon Resource Name (ARN) of the source specified - in a request. The source ARN indicates which resource is affecting the - resource listed in your policy. For example, an SNS topic is the source - ARN when publishing messages from the topic to an SQS queue. - - This condition key should only be used with enum. - - - - - - Enumeration of the supported ways an ARN comparison can be evaluated. - - - - Exact matching - - - - Loose case-insensitive matching of the ARN. Each of the six - colon-delimited components of the ARN is checked separately and each - can include a multi-character match wildcard (*) or a - single-character match wildcard (?). - - - - Negated form of ArnEquals - - - Negated form of ArnLike - - - - Enumeration of the supported ways a date comparison can be evaluated. - - - - - Enumeration of the supported ways an IP address comparison can be evaluated. - - - - - Matches an IP address against a CIDR IP range, evaluating to true if - the IP address being tested is in the condition's specified CIDR IP - range. - - - - - Negated form of IpAddress - - - - - Enumeration of the supported ways a numeric comparison can be evaluated - - - - - Enumeration of the supported ways a string comparison can be evaluated. - - - - - Case-sensitive exact string matching - - - - - Case-insensitive string matching - - - - - Loose case-insensitive matching. The values can include a - multi-character match wildcard (*) or a single-character match - wildcard (?) anywhere in the string. - - - - - Negated form of StringEquals. - - - - - Negated form of StringEqualsIgnorecase. - - - - - Negated form of StringLike. - - - - - Constructs a new access control policy condition that compares ARNs (Amazon Resource Names). - - The access policy condition key specifying where to get the first ARN for the comparison - The type of comparison to perform. - The second ARN to compare against. When using ArnLike or ArnNotLike this may contain the - multi-character wildcard (*) or the single-character wildcard - - - - Constructs a new access policy condition that performs a boolean - comparison. - - The access policy condition key specifying where to get the - first boolean value for the comparison (ex: aws:SecureTransport). - The boolean to compare against. - - - - This method is deprecated. Invoking this method results in non-UTC DateTimes - not being marshalled correctly. Use NewConditionUtc instead. - Constructs a new access policy condition that compares the current time - (on the AWS servers) to the specified date. - - The type of comparison to perform. For example, - DateComparisonType.DateLessThan will cause this policy - condition to evaluate to true if the current date is less than - the date specified in the second argument. - The date to compare against. - - - - Constructs a new access policy condition that compares the current time - (on the AWS servers) to the specified date. - - The type of comparison to perform. For example, - DateComparisonType.DateLessThan will cause this policy - condition to evaluate to true if the current date is less than - the date specified in the second argument. - The date to compare against. - - - - Constructs a new access policy condition that compares the source IP - address of the incoming request to an AWS service against the specified - CIDR range. The condition evaluates to true (meaning the policy statement - containing it will be applied) if the incoming source IP address is - within that range. - - To achieve the opposite effect (i.e. cause the condition to evaluate to - true when the incoming source IP is not in the specified CIDR - range) use the alternate constructor form and specify - IpAddressComparisonType.NotIpAddress. - - - The CIDR IP range involved in the policy condition. - - - - Constructs a new access policy condition that compares the source IP - address of the incoming request to an AWS service against the specified - CIDR range. When the condition evaluates to true (i.e. when the incoming - source IP address is within the CIDR range or not) depends on the - specified IpAddressComparisonType. - - The type of comparison to to perform. - The CIDR IP range involved in the policy condition. - - - - Constructs a new access policy condition that compares two numbers. - - The type of comparison to perform. - The access policy condition key specifying where to get the - first number for the comparison. - The second number to compare against. - - - - Constructs a new access control policy condition that compares two - strings. - - The type of comparison to perform - The access policy condition key specifying where to get the - first string for the comparison (ex: aws:UserAgent). - - The second string to compare against. When using - StringComparisonType.StringLike or - StringComparisonType.StringNotLike this may contain - the multi-character wildcard (*) or the single-character - wildcard (?). - - - - - Constructs a new access policy condition that compares the Amazon - Resource Name (ARN) of the source of an AWS resource that is modifying - another AWS resource with the specified pattern. - - For example, the source ARN could be an Amazon SNS topic ARN that is - sending messages to an Amazon SQS queue. In that case, the SNS topic ARN - would be compared the ARN pattern specified here. - - - The endpoint pattern may optionally contain the multi-character wildcard - * (*) or the single-character wildcard (?). Each of the six colon-delimited - components of the ARN is checked separately and each can include a - wildcard. - - - Policy policy = new Policy("MyQueuePolicy"); - policy.WithStatements(new Statement(Statement.StatementEffect.Allow) - .WithPrincipals(new Principal("*")).WithActionIdentifiers(SQSActionIdentifiers.SendMessage) - .WithResources(new Resource(myQueueArn)) - .WithConditions(ConditionFactory.NewSourceArnCondition(myTopicArn))); - - - The ARN pattern against which the source ARN will be compared. - Each of the six colon-delimited components of the ARN is - checked separately and each can include a wildcard. - A new access control policy condition that compares the ARN of - the source specified in an incoming request with the ARN pattern - specified here. - - - - Constructs a new access control policy condition that tests if the - incoming request was sent over a secure transport (HTTPS). - - A new access control policy condition that tests if the incoming - request was sent over a secure transport (HTTPS). - - - - Condition key for the canned ACL specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the location constraint specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the prefix specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the delimiter specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the max keys specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the source object specified by a request to copy an - object. - - This condition key may only be used with enum. - - - - - - Condition key for the metadata directive specified by a request to copy - an object. - - This condition key may only be used with enum. - - - - - - Condition key for the version ID of an object version specified by a - request. - - This condition key may only be used with enum. - - - - - - Constructs a new access policy condition that compares an Amazon S3 - canned ACL with the canned ACL specified by an incoming request. - - You can use this condition to ensure that any objects uploaded to an - Amazon S3 bucket have a specific canned ACL set. - - - The Amazon S3 canned ACL to compare against. - A new access control policy condition that compares the Amazon S3 - canned ACL specified in incoming requests against the value - specified. - - - - Condition key for The URL, e-mail address, or ARN from a Subscribe - request or a previously confirmed subscription. Use with string - conditions to restrict access to specific endpoints (e.g., - *@mycompany.com). - - This condition key may only be used with enum. - - - - - - Condition key for the protocol value from a Subscribe request or a - previously confirmed subscription. Use with string conditions to restrict - publication to specific delivery protocols (e.g., HTTPS). - - This condition key may only be used with enum. - - - - - - Constructs a new access policy condition that compares the requested - endpoint used to subscribe to an Amazon SNS topic with the specified - endpoint pattern. The endpoint pattern may optionally contain the - multi-character wildcard (*) or the single-character wildcard (?). - - For example, this condition can restrict subscriptions to a topic to - email addresses in a certain domain ("*@my-company.com"). - - - Policy policy = new Policy("MyTopicPolicy"); - policy.WithStatements(new Statement(Statement.StatementEffect.Allow) - .WithPrincipals(new Principal("*")).WithActionIdentifiers(SNSActionIdentifiers.Subscribe) - .WithResources(new Resource(myTopicArn)) - .WithConditions(ConditionFactory.NewEndpointCondition("*@my-company.com"))); - - - The endpoint pattern against which to compare the requested - endpoint for an Amazon SNS topic subscription. - A new access control policy condition that compares the endpoint - used in a request to subscribe to an Amazon SNS topic with the - endpoint pattern specified. - - - - Constructs a new AWS access control policy condition that allows an - access control statement to restrict subscriptions to an Amazon SNS topic - based on the protocol being used for the subscription. For example, this - condition can restrict subscriptions to a topic to endpoints using HTTPS - to ensure that messages are securely delivered. - - The protocol against which to compare the requested protocol - for an Amazon SNS topic subscription. - A new access control policy condition that compares the - notification protocol requested in a request to subscribe to an - Amazon SNS topic with the protocol value specified. - - - - An AWS access control policy is a object that acts as a container for one or - more statements, which specify fine grained rules for allowing or denying - various types of actions from being performed on your AWS resources. - - By default, all requests to use your resource coming from anyone but you are - denied. Access control polices can override that by allowing different types - of access to your resources, or by explicitly denying different types of - access. - - - Each statement in an AWS access control policy takes the form: - "A has permission to do B to C where D applies". - - - A is the prinicpal - The AWS account that is making a request to - access or modify one of your AWS resources. - - - - B is the action - the way in which your AWS resource is being accessed or modified, such - as sending a message to an Amazon SQS queue, or storing an object in an Amazon S3 bucket. - - - - C is the resource - your AWS entity that the principal wants to access, such - as an Amazon SQS queue, or an object stored in Amazon S3. - - - - D is the set of conditions - optional constraints that specify when to allow or deny - access for the principal to access your resource. Many expressive conditions are available, - some specific to each service. For example you can use date conditions to allow access to - your resources only after or before a specific time. - - - - - - Note that an AWS access control policy should not be confused with the - similarly named "POST form policy" concept used in Amazon S3. - - - - - - The default policy version - - - - - Constructs an empty AWS access control policy ready to be populated with - statements. - - - - - Constructs a new AWS access control policy with the specified policy ID. - The policy ID is a user specified string that serves to help developers - keep track of multiple polices. Policy IDs are often used as a human - readable name for a policy. - - The policy ID for the new policy object. Policy IDs serve to - help developers keep track of multiple policies, and are often - used to give the policy a meaningful, human readable name. - - - - Constructs a new AWS access control policy with the specified policy ID - and collection of statements. The policy ID is a user specified string - that serves to help developers keep track of multiple polices. Policy IDs - are often used as a human readable name for a policy. - - The policy ID for the new policy object. Policy IDs serve to - help developers keep track of multiple policies, and are often - used to give the policy a meaningful, human readable name. - The statements to include in the new policy. - - - - Gets and Sets the policy ID for this policy. Policy IDs serve to help - developers keep track of multiple policies, and are often used as human - readable name for a policy. - - - - - Sets the policy ID for this policy and returns the updated policy so that - multiple calls can be chained together. - - Policy IDs serve to help developers keep track of multiple policies, and - are often used as human readable name for a policy. - - - The polich ID for this policy - this instance - - - - Gets and sets the version of this AWS policy. - - - - - Gets and Sets the collection of statements contained by this policy. Individual - statements in a policy are what specify the rules that enable or disable - access to your AWS resources. - - - - - Checks to see if the permissions set in the statement are already set by another - statement in the policy. - - The statement to verify - True if the statement's permissions are already allowed by the statement - - - - Sets the collection of statements contained by this policy and returns - this policy object so that additional method calls can be chained - together. - - Individual statements in a policy are what specify the rules that enable - or disable access to your AWS resources. - - - The collection of statements included in this policy. - this instance - - - - Returns a JSON string representation of this AWS access control policy, - suitable to be sent to an AWS service as part of a request to set an - access control policy. - - A JSON string representation of this AWS access control policy. - - - - Returns a JSON string representation of this AWS access control policy, - suitable to be sent to an AWS service as part of a request to set an - access control policy. - - Toggle pretty print for the generated JSON document - A JSON string representation of this AWS access control policy. - - - - Parses a JSON document of a policy and creates a Policy object. - - JSON document of a policy. - - - - - A principal is an AWS account which is being allowed or denied access to a - resource through an access control policy. The principal is a property of the - Statement object, not directly the object. - - The principal is A in the statement - "A has permission to do B to C where D applies." - - - In an access control policy statement, you can set the principal to all - authenticated AWS users through the member. This - is useful when you don't want to restrict access based on the identity of the - requester, but instead on other identifying characteristics such as the - requester's IP address. - - - - - - Principal instance that includes all authenticated AWS users. - - This is useful when you don't want to restrict access based on the - identity of the requester, but instead on other identifying - characteristics such as the requester's IP address. - - - - - - The anonymous Principal. - - - - - The default Principal provider for AWS accounts. - - - - - Principal provider for Canonical User IDs. - - - - - Principal provider for federated users (using a SAML identity provider) - - - - - Principal provider for assume role policies that will be assumed by an AWS service - (e.g. "ec2.amazonaws.com"). - - - - - Dummy principal provider for anonynous. - - - - - Constructs a new principal with the specified AWS account ID. - - An AWS account ID. - - - - Constructs a new principal with the specified provider and id - - The provider of the principal - The unique ID of the Principal within the provider - - - - Constructs a new principal with the specified provider and id - and optionally strips hyphens from the id - - The provider of the principal - The unique ID of the Principal within the provider - Strip hyphen - - - - Gets and sets the provider for this principal, which indicates in what group of - users this principal resides. - - - - - Gets the unique ID for this principal. - - - - - Represents a resource involved in an AWS access control policy statement. - Resources are the service specific AWS entities owned by your account. Amazon - SQS queues, Amazon S3 buckets and objects, and Amazon SNS topics are all - examples of AWS resources. - - The standard way of specifying an AWS resource is with an Amazon Resource - Name (ARN). - - - The resource is C in the statement - "A has permission to do B to C where D applies." - - - - - - Constructs a new AWS access control policy resource. Resources are - typically specified as Amazon Resource Names (ARNs). - - You specify the resource using the following Amazon Resource Name (ARN) - format: arn:aws:<vendor>:<region>:<namespace>:<relative-id> - - - >vendor identifies the AWS product (e.g., sns) - - - region is the AWS Region the resource resides in (e.g., us-east-1), if any - - - namespace is the AWS account ID with no hyphens (e.g., 123456789012) - - - relative-id is the service specific portion that identifies the specific resource - - - - - For example, an Amazon SQS queue might be addressed with the following - ARN: arn:aws:sqs:us-east-1:987654321000:MyQueue - - - Some resources may not use every field in an ARN. For example, resources - in Amazon S3 are global, so they omit the region field: - arn:aws:s3:::bucket/* - - - The Amazon Resource Name (ARN) uniquely identifying the desired AWS resource. - - - - Gets the resource ID, typically an Amazon Resource Name (ARN), - identifying this resource. - - - - - A factory for creating resources to be used in the policy. - - - - - Constructs a new bucket resource that represents the the specified bucket - but not any of the contained objects. - - The name of the bucket represented by this AWS access control - policy resource. - - - - Constructs a new object resource that represents the specified objects. - The keyPattern argument may contain the '*' wildcard to match multiple - objects. For example, an object resource created for bucket 'mybucket' - and key pattern 'foo*' will match any object stored in 'mybucket' with a - key that starts with 'foo'. - - The name of the bucket containing the object or objects - represented by this resource. - The key or key pattern, which can optionally contain the '*' - wildcard to include multiple objects in the resource. - - - - Constructs a new SQS queue resource for an access control policy. A - policy statement using this resource will allow or deny actions on the - specified queue. - - The AWS account ID of the queue owner. - The name of the Amazon SQS queue. - - - - A statement is the formal description of a single permission, and is always - contained within a policy object. - - A statement describes a rule for allowing or denying access to a specific AWS - resource based on how the resource is being accessed, and who is attempting - to access the resource. Statements can also optionally contain a list of - conditions that specify when a statement is to be honored. - - - For example, consider a statement that: - - - A is the prinicpal - The AWS account that is making a request to - access or modify one of your AWS resources. - - - - B is the action - the way in which your AWS resource is being accessed or modified, such - as sending a message to an Amazon SQS queue, or storing an object in an Amazon S3 bucket. - - - - C is the resource - your AWS entity that the principal wants to access, such - as an Amazon SQS queue, or an object stored in Amazon S3. - - - - D is the set of conditions - optional constraints that specify when to allow or deny - access for the principal to access your resource. Many expressive conditions are available, - some specific to each service. For example you can use date conditions to allow access to - your resources only after or before a specific time. - - - - - - There are many resources and conditions available for use in statements, and - you can combine them to form fine grained custom access control polices. - - - - - - The effect is the result that you want a policy statement to return at - evaluation time. A policy statement can either allow access or explicitly - deny access. - - - - - Constructs a new access control policy statement with the specified - effect. - - Before a statement is valid and can be sent to AWS, callers must set the - principals, resources, and actions (as well as any optional conditions) - involved in the statement. - - - The effect this statement has (allowing access or denying - access) when all conditions, resources, principals, and - actions are matched. - - - - Gets and Sets the ID for this statement. Statement IDs serve to help keep track - of multiple statements, and are often used to give the statement a - meaningful, human readable name. - - Developers should be careful to not use the same statement ID for - multiple statements in the same policy. Reusing the same statement ID in - different policies is not a problem. - - - - - - Sets the ID for this statement and returns the updated statement so - multiple calls can be chained together. - - Statement IDs serve to help keep track of multiple statements, and are - often used to give the statement a meaningful, human readable name. - - - Developers should be careful to not use the same statement ID for - multiple statements in the same policy. Reusing the same statement ID in - different policies is not a problem. - - - The new statement ID for this statement. - this instance - - - - Gets and Sets the result effect of this policy statement when it is evaluated. - A policy statement can either allow access or explicitly - - - - - Gets and Sets the list of actions to which this policy statement applies. - Actions limit a policy statement to specific service operations that are - being allowed or denied by the policy statement. For example, you might - want to allow any AWS user to post messages to your SQS queue using the - SendMessage action, but you don't want to allow those users other actions - such as ReceiveMessage or DeleteQueue. - - - - - Sets the list of actions to which this policy statement applies and - returns this updated Statement object so that additional method calls can - be chained together. - - Actions limit a policy statement to specific service operations that are - being allowed or denied by the policy statement. For example, you might - want to allow any AWS user to post messages to your SQS queue using the - SendMessage action, but you don't want to allow those users other actions - such as ReceiveMessage or DeleteQueue. - - - The list of actions to which this statement applies. - this instance - - - - Gets and Sets the resources associated with this policy statement. Resources - are what a policy statement is allowing or denying access to, such as an - Amazon SQS queue or an Amazon SNS topic. - - Note that some services allow only one resource to be specified per - policy statement. - - - - - - Sets the resources associated with this policy statement and returns this - updated Statement object so that additional method calls can be chained - together. - - Resources are what a policy statement is allowing or denying access to, - such as an Amazon SQS queue or an Amazon SNS topic. - - - Note that some services allow only one resource to be specified per - policy statement. - - - The resources associated with this policy statement. - this instance - - - - Gets and Sets the conditions associated with this policy statement. Conditions - allow policy statements to be conditionally evaluated based on the many - available condition types. - - For example, a statement that allows access to an Amazon SQS queue could - use a condition to only apply the effect of that statement for requests - that are made before a certain date, or that originate from a range of IP - addresses. - - - When multiple conditions are included in a single statement, all - conditions must evaluate to true in order for the statement to take - effect. - - - - - - Sets the conditions associated with this policy statement, and returns - this updated Statement object so that additional method calls can be - chained together. - - Conditions allow policy statements to be conditionally evaluated based on - the many available condition types. - - - For example, a statement that allows access to an Amazon SQS queue could - use a condition to only apply the effect of that statement for requests - that are made before a certain date, or that originate from a range of IP - addresses. - - - Multiple conditions can be included in a single statement, and all - conditions must evaluate to true in order for the statement to take - effect. - - - The conditions associated with this policy statement. - this instance - - - - Gets and Sets the principals associated with this policy statement, indicating - which AWS accounts are affected by this policy statement. - - - - - Sets the principals associated with this policy statement, and returns - this updated Statement object. Principals control which AWS accounts are - affected by this policy statement. - - If you don't want to restrict your policy to specific users, you can use - to apply the policy to any user trying to - access your resource. - - - The list of principals associated with this policy statement. - this instance - - - - The available AWS access control policy actions for Amazon AppStream. - - - - - - The available AWS access control policy actions for Auto Scaling. - - - - - - The available AWS access control policy actions for AWS Billing. - - - - - - The available AWS access control policy actions for AWS CloudFormation. - - - - - - The available AWS access control policy actions for Amazon CloudFront. - - - - - - The available AWS access control policy actions for Amazon CloudSearch. - - - - - - The available AWS access control policy actions for AWS CloudTrail. - - - - - - The available AWS access control policy actions for Amazon CloudWatch. - - - - - - The available AWS access control policy actions for Amazon CloudWatch Logs. - - - - - - The available AWS access control policy actions for Amazon Cognito Identity. - - - - - - The available AWS access control policy actions for Amazon Cognito Sync. - - - - - - The available AWS access control policy actions for AWS Direct Connect. - - - - - - The available AWS access control policy actions for Amazon DynamoDB. - - - - - - The available AWS access control policy actions for Amazon EC2. - - - - - - The available AWS access control policy actions for AWS ElastiCache. - - - - - - The available AWS access control policy actions for AWS Elastic Beanstalk. - - - - - - The available AWS access control policy actions for Elastic Load Balancing. - - - - - - The available AWS access control policy actions for Amazon Elastic MapReduce. - - - - - - The available AWS access control policy actions for Amazon Elastic Transcoder. - - - - - - The available AWS access control policy actions for Amazon Glacier. - - - - - - The available AWS access control policy actions for AWS Identity and Access Management. - - - - - - The available AWS access control policy actions for AWS Import Export. - - - - - - The available AWS access control policy actions for Amazon Kinesis. - - - - - - The available AWS access control policy actions for AWS Marketplace. - - - - - - The available AWS access control policy actions for AWS Marketplace Management Portal. - - - - - - The available AWS access control policy actions for Amazon Mobile Analytics. - - - - - - The available AWS access control policy actions for AWS OpsWorks. - - - - - - The available AWS access control policy actions for Amazon RDS. - - - - - - The available AWS access control policy actions for Amazon Redshift. - - - - - - The available AWS access control policy actions for Amazon Route 53. - - - - - - The available AWS access control policy actions for Amazon S3. - - - - - - The available AWS access control policy actions for AWS Security Token Service. - - - - - - The available AWS access control policy actions for Amazon SES. - - - - - - The available AWS access control policy actions for Amazon SimpleDB. - - - - - - The available AWS access control policy actions for Amazon Simple Workflow Service. - - - - - - The available AWS access control policy actions for Amazon SNS. - - - - - - The available AWS access control policy actions for Amazon SQS. - - - - - - The available AWS access control policy actions for Amazon Storage Gateway. - - - - - - The available AWS access control policy actions for AWS Whispersync. - - - - - - The available AWS access control policy actions for Amazon Zocalo. - - - - - - Deserializes a JSON string into a AWS policy object. - - - - - Serializes an AWS policy object to a JSON string, suitable for sending to an - AWS service. - - - - Converts the specified AWS policy object to a JSON string, suitable for - passing to an AWS service. - - @param policy - The AWS policy object to convert to a JSON string. - - @return The JSON string representation of the specified policy object. - - @throws IllegalArgumentException - If the specified policy is null or invalid and cannot be - serialized to a JSON string. - - - - Uses the specified generator to write the JSON data for the principals in - the specified policy statement. - - - - - This sorts the conditions by condition type and key with the list of values for that combination. - - The list of conditions to be sorted. - - - - - Exception thrown by the SDK for errors that occur within the SDK. - - - - - This exception is thrown when there is a parse error on the response back from AWS. - - - - - The string value which could not be converted into a valid DateTime instance. - - - - - Occurs before a request is marshalled. - - - - - Occurs before a request is issued against the service. - - - - - Occurs after a response is received from the service. - - - - - Occurs after an exception is encountered. - - - - - Patches the in-flight uri to stop it unescaping the path etc (what Uri did before - Microsoft deprecated the constructor flag). This is particularly important for - Amazon S3 customers who want to use backslash (\) in their key names. - - - Different behavior in the various runtimes has been observed and in addition some - 'documented' ways of doing this between 2.x and 4.x runtimes has also been observed - to not be reliable. - - This patch effectively emulates what adding a schemesettings element to the - app.config file with value 'name="http" genericUriParserOptions="DontUnescapePathDotsAndSlashes"' - does. As we're a dll, that avenue is not open to us. - - - - - - Used to create a copy of the config for a different service than the current instance. - - Target service ClientConfig - The new ClientConfig for the desired service - - - - A base exception for some Amazon Web Services. - - Most exceptions thrown to client code will be service-specific exceptions, though some services - may throw this exception if there is a problem which is caught in the core client code. - - - - - - Whether the error was attributable to Sender or Reciever. - - - - - The error code returned by the service - - - - - The id of the request which generated the exception. - - - - - The HTTP status code from the service response - - - - - Flag indicating if the exception is retryable and the associated retry - details. A null value indicates that the exception is not retryable. - - - - - Class containing the retryable details for an AmazonServiceException - - - - - This property indicates that this exception is a - throttling exception and should be subject to congestion - control throttling. - - - - - This exception is thrown when there is a parse error on the response back from AWS. - - - - - Last known location in the response that was parsed, if available. - - - - - The entire response body that caused this exception, if available. - - - - - Base class for request used by some of the services. - - - - - This flag specifies if SigV4 will be used for the current request. - - - - - Gets or Sets a value indicating if "Expect: 100-continue" HTTP header will be - sent by the client for this request. The default value is false. - - - - - Gets the signer to use for this request. - A null return value indicates to use the configured - signer for the service that this request is part of. - - A signer for this request, or null. - - - - Abstract class for Response objects, contains only metadata, - and no result information. - - - - - Contains additional information about the request, such as the - Request Id. - - - - - Returns the content length of the HTTP response. - - - - - Returns the status code of the HTTP response. - - - - - Base class for determining region based on inspection. - - - - - Sets the Region property by looking up the corresponding RegionEndpoint - from the supplied region system name (us-east-1, us-west-2 etc). - - The system name of the region. - - - - Determines region based on application configuration settings. If the configuration does not contain - the region setting key an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of ApplicationConfigAWSRegion. If no region is found in the - application configuration file then an InvalidOperationException is thrown. - - - - - Probing mechanism to determine region from various sources. - - - - - This class is responsible for keeping track of Retry capacity across different ServiceURLs. - - - - - CapacityType determines the type of capacity to obtain or use. - - - - - The increment capacity type adds capacity. - - - - - The default retry capacity type uses the default capacity amount. - - - - - The timeout capacity type uses the timeout capacity amount. - - - - - This method acquires a said retry capacity if the container has the capacity. - - Contains the RetryCapacity object for the said ServiceURL. - - - - This method acquires a said retry capacity if the container has the capacity. - - Contains the RetryCapacity object for the said ServiceURL. - Specifies what capacity type cost to use for obtaining capacity - - - - This method calls a method to release capacity back - based on whether it was a successful response or a successful retry response. This is invoked by a retry request response. - - if this request is a retry, use a different capacity cost - Contains the RetryCapacity object for the said ServiceURL. - - - - This method calls a method to release capacity back - based on whether it was a successful response or a successful retry response. This is invoked by a retry request response. - - Specifies what capacity type cost to use for adding capacity - Contains the RetryCapacity object for the said ServiceURL. - - - - Ths method fetches the RetryCapacity for the given ServiceURL from CapacityManager.CapacityContainer - - - - - This method releases capacity back. This is invoked by the TryReleaseCapacity method. - - Contains the RetryCapacity object for the said ServiceURL. - The capacity that needs to be released based on whether it was a successful response or a successful retry response. - - - - This class is the RetryCapacity class for a given ServiceURL. - - - - - This class composes Client Context header for Amazon Web Service client. - It contains information like app title, version code, version name, client id, OS platform etc. - - - This class composes Client Context header for Amazon Web Service client. - It contains information like app title, version code, version name, client id, OS platform etc. - - - - - Adds the custom attributes to the Client Context. - - Key. - Value. - - - - Gets a Json Representation of the Client Context. - - Json Representation of Client Context - - - - Collection of parameters that an SDK client will send to a service. - - - - - Constructs empty ParameterCollection. - - - - - Adds a parameter with a string value. - - - - - - - Adds a parameter with a list-of-strings value. - - - - - - - Converts the current parameters into a list of key-value pairs. - - - - - - This class is responsible for managing adaptive retry mode client rate limiting. - - - - - The rate at which token are replenished. - - - - - The maximum capacity allowed in the token - - - - - The current capacity of the token - - - - - The last time the token bucket was refilled. - - - - - The smoothed rate which tokens are being retrieved. - - - - - The last half second time bucket used. - - - - - The number of requests seen within the current time - - - - - The maximum rate when the client was last throttled. - - - - - The last time when the client was throttled. - - - - - The cached time window calculation - - - - - Boolean indicating if the token bucket is enabled. - - - - - This method attempts to acquire capacity from the client's token - - The amount of capacity to obtain from the token bucket - Indicates that the client should or shouldn't sleep and - try again if capacity cannot be obtained. - - - - - This method attempts to acquire capacity from the client's token - - The amount of capacity to obtain from the token bucket - Indicates that the client should or shouldn't sleep and - try again if capacity cannot be obtained. - - Token which can be used to cancel the task. - - - - Updates the sending rate within the client's token bucket - - Indicates if the request resulted in a throttling error. - - - - Calculates the rate - - - Returns the calculated rate for a successful call - - - - Calculates the rate. - - The rate to use in the calculation - Returns the calculated rate for a throttled call - - - - Collection used to indicate if the property was initialized was created by the SDK. - - - - - - Collection used to indicate if the property was initialized was created by the SDK. - - - - - - - Default implementation of the IRequest interface. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Constructs a new DefaultRequest with the specified service name and the - original, user facing request object. - - The orignal request that is being wrapped - The service name - - - - The name of the request - - - - - Gets and sets the type of http request to make, whether it should be POST,GET or DELETE - - - - - Gets and sets a flag that indicates whether the request is sent as a query string instead of the request body. - - - - - Returns the original, user facing request object which this internal - request object is representing. - - - - - Returns a dictionary of the headers included in this request. - - - - - Returns a dictionary of the parameters included in this request. - - - - - Collection of parameters included in this request. - - - - - Returns the subresources that should be appended to the resource path. - This is used primarily for Amazon S3, where object keys can contain '?' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new null entry to the SubResources collection for the request - - The name of the subresource - - - - Adds a new entry to the SubResources collection for the request - - The name of the subresource - Value of the entry - - - - Gets and Sets the endpoint for this request. - - - - - Gets and Sets the resource path added on to the endpoint. - - - - - Returns the path resources that should be used within the resource path. - This is used for services where path keys can contain '/' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new entry to the PathResources collection for the request - - The name of the pathresource with potential greedy syntax: {key+} - Value of the entry - - - - Gets and Sets the version number for the marshaller used to create this request. The version number - is used to support backward compatible changes that would otherwise be breaking changes when a - newer core is used with an older service assembly. - Versions: - 1 - Default version - 2 - Support for path segments - - - - - Gets and Sets the content for this request. - - - - - Flag that signals that Content was and should be set - from the Parameters collection. - - - - - Gets and sets the content stream. - - - - - Gets and sets the original stream position. - If ContentStream is null or does not support seek, this propery - should be equal to -1. - - - - - Computes the SHA 256 hash of the content stream. If the stream is not - seekable, it searches the parent stream hierarchy to find a seekable - stream prior to computation. Once computed, the hash is cached for future - use. If a suitable stream cannot be found to use, null is returned. - - - - - The name of the service to which this request is being sent. - - - - - Alternate endpoint to use for this request, if any. - - - - - Host prefix value to prepend to the endpoint for this request, if any. - - - - - Gets and sets the Suppress404Exceptions property. If true then 404s return back from AWS will not cause an exception and - an empty response object will be returned. - - - - - If using AWS4 signing protocol, contains the resultant parts of the - signature that we may need to make use of if we elect to do a chunked - encoding upload. - - - - - Determine whether to use a chunked encoding upload for the request - (applies to Amazon S3 PutObject and UploadPart requests only). - - - - - - Used for Amazon S3 requests where the bucket name is removed from - the marshalled resource path into the host header. To comply with - AWS2 signature calculation, we need to recover the bucket name - and include it in the resource canonicalization, which we do using - this field. - - - - - This flag specifies if SigV4 is required for the current request. - - - - - The authentication region to use for the request. - Set from Config.AuthenticationRegion. - - - - - The region in which the service request was signed. - - - - - Checks if the request stream can be rewinded. - - Returns true if the request stream can be rewinded , - else false. - - - - Returns true if the request can contain a request body, else false. - - Returns true if the currect request can contain a request body, else false. - - - - Returns true if the request has a body, else false. - - Returns true if the request has a body, else false. - - - - Class containing the data for one endpoint returned from a endpoint discovery request - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Constructs a new DiscoveryEndpoint - - The address of the endpoint - The cache period for the endpoint in minutes - - - - The address of the endpoint. - - - - - The cache period for the endpoint in minutes - - - - - Calculates if this endpoint has expired - - A boolean value indicating if the cache period has expired - - - - Extends the endpoint expiration by the specified number of minutes from now. - - - - - Class containing the data for one endpoint returned from a endpoint discovery request - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class containing the data to use with endpoint discovery - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Gets/sets and flag indicating if endpoint discovery is required for the request. - - - - - Sorted dictionary of the identifiers that must be sent with the endpoint discovery request. These - identifiers are used to construct the cache key for the cache that stores discovered endpoints. A - sorted dictionary is used instead of a dictionary to ensure the cache key comes out in the same order - each time it is constructed. - - - - - Represents the data to be used with endpoint discovery operations - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class used to resolve endpoints using Endpoint Discovery. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Method that performs endpoint discovery for the current operation - - Context information used in calculations for endpoint discovery - The operation to fetch endpoints from the server - - - - - Gets the number of cache keys in the cache - - - - - Class used to resolve endpoints using Endpoint Discovery. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class containing context information to use with endpoint discovery - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Gets the customer credential information. - - - - - Gets the operation name. - - - - - Gets the current marshalled endpoint discovery data. - - - - - Gets the flag indicating if the specified key should be evicted from the cache. - - - - - Gets the Uri that should be evicted if EvictCacheKey is set to true. - - - - - Class containing context information to use with endpoint discovery - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Error type, one of Sender, Receiver, Unknown - Only applies to XML-based services. - - - - - Name of the exception class to return - - - - - Error message - - - - - RequestId of the error. - Only applies to XML-based services. - - - - - InternalConfiguration holds the cached SDK configuration values - obtained from the environment and profile configuration - factories. These configuration values are loaded internally and - are not the same as user exposed AWSConfigs. - - - - - Flag indicating if Endpoint Discovery is enabled. - - - - - The retry mode to use: Legacy, Standard, or Adaptive. - - - - - The max number of request attempts. - - - - - Probing mechanism to determine the configuration values from various sources. - - - - - Resets all the configuration values reloading as needed. This method will use - the AWS_PROFILE environment variable if set to construct the instance. Otherwise - the default profile will be used. - - - - - Flag that specifies if endpoint discovery is enabled, disabled, - or not set. - - - - - Flag that specifies which retry mode to use or if retry mode has - not been set. - - - - - Flag that specifies the max number of request attempts or if max - attempts has not been set. - - - - - Class containing the members used to invoke service calls - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class containing the members used to invoke service calls - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Represents a request being sent to an Amazon Web Service, including the - parameters being sent as part of the request, the endpoint to which the - request should be sent, etc. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - The name of the request - - - - - Returns a dictionary of the headers included in this request. - - - - - Gets and sets a flag that indicates whether the request is sent as a query string instead of the request body. - - - - - Returns a dictionary of the parameters included in this request. - - - - - Collection of parameters included in this request. - - - - - Returns the subresources that should be appended to the resource path. - This is used primarily for Amazon S3, where object keys can contain '?' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new null entry to the SubResources collection for the request - - The name of the subresource - - - - Adds a new entry to the SubResources collection for the request - - The name of the subresource - Value of the entry - - - - Gets and sets the type of http request to make, whether it should be POST,GET or DELETE - - - - - Gets and Sets the endpoint for this request. - - - - - Gets and Sets the resource path added on to the endpoint. - - - - - Returns the path resources that should be used within the resource path. - This is used for services where path keys can contain '/' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new entry to the PathResources collection for the request - - The name of the pathresource with potential greedy syntax: {key+} - Value of the entry - - - - Gets and Sets the version number for the marshaller used to create this request. The version number - is used to support backward compatible changes that would otherwise be breaking changes when a - newer core is used with an older service assembly. - - - - - Gets and Sets the content for this request. - - - - - Gets the header value from the request. - - - - - Flag that signals that Content was and should be set - from the Parameters collection. - - - - - Gets and sets the content stream. - - - - - Gets and sets the original stream position. - If ContentStream is null or does not support seek, this propery - should be equal to -1. - - - - - Computes the SHA 256 hash of the content stream. If the stream is not - seekable, it searches the parent stream hierarchy to find a seekable - stream prior to computation. Once computed, the hash is cached for future - use. - - - - - The name of the service to which this request is being sent. - - - - - Returns the original, user facing request object which this internal - request object is representing. - - - - - Alternate endpoint to use for this request, if any. - - - - - Host prefix value to prepend to the endpoint for this request, if any. - - - - - Gets and sets the Suppress404Exceptions property. If true then 404s return back from AWS will not cause an exception and - an empty response object will be returned. - - - - - If using AWS4 signing protocol, contains the resultant parts of the - signature that we may need to make use of if we elect to do a chunked - encoding upload. - - - - - Determine whether to use a chunked encoding upload for the request - (applies to Amazon S3 PutObject and UploadPart requests only). - - - - - - Used for Amazon S3 requests where the bucket name is removed from - the marshalled resource path into the host header. To comply with - AWS2 signature calculation, we need to recover the bucket name - and include it in the resource canonicalization, which we do using - this field. - - - - - This flag specifies if SigV4 is required for the current request. - - - - - The authentication region to use for the request. - Set from Config.AuthenticationRegion. - - - - - The region in which the service request was signed. - - - - - Checks if the request stream can be rewinded. - - Returns true if the request stream can be rewinded , - else false. - - - - Returns true if the request can contain a request body, else false. - - Returns true if the currect request can contain a request body, else false. - - - - Returns true if the request has a body, else false. - - Returns true if the request has a body, else false. - - - - Gets the value of the Service Id. - - - - - Gets the dictionary that gives mapping of renamed operations - - - - - IDictionary{String, String} access to ParameterCollection. - TODO: remove this class in version 3.4 of the SDK. - - - - - Constructs ParametersDictionaryFacade for a ParameterCollection - - - - - - A registry of object that will manipulate the runtime pipeline used by service clients. - - - - - Registers a customizer that will be applied for all service clients created. Each customizer has a unique name associated with it. If a customizer is registered more - than once with the same unique name then the calls after the first will be ignored. - - - - - - Deregistered the runtime pipeline customizer - - - - - - Deregistered the runtime pipeline customizer - - - - - - Applies all of the registered customizers on the runtime pipeline - - The service clients runtime pipeline. - Type object for the service client being created - - - - Interface for objects that will customize the runtime pipleine for newly created service clients. - - - - - The unique name for the customizer that identifies the customizer in the registry. The name is also used to identify the customizer on the SDK logs. - - - - - Called on service clients as they are being constructed to customize their runtime pipeline. - - - Type object for the service client being created - - - - Default ServiceMetadata implementation. - This implementation will be used if the service doesn't have a - IServiceMetadata implementation. - - - - - Gets the value of the Service Id. - - - - - Gets the dictionary that gives mapping of renamed operations - - - - - Computes RFC 2104-compliant HMAC signature. - - - - - Computes RFC 2104-compliant HMAC signature. - - - - - Inspects the supplied evidence to return the signer appropriate for the operation - - Global setting for the service - The request. - Configuration for the client - True if signature v4 request signing should be used - - - - Signs the specified request with the AWS3 signing protocol by using the - AWS account credentials given in the method parameters. - - The AWS public key - The AWS secret key used to sign the request in clear text - Request metrics - The configuration that specifies which hashing algorithm to use - The request to have the signature compute for - If any problems are encountered while signing the request - - - - AWS4 protocol signer for service calls that transmit authorization in the header field "Authorization". - - - - - Calculates and signs the specified request using the AWS4 signing protocol by using the - AWS account credentials given in the method parameters. The resulting signature is added - to the request headers as 'Authorization'. Parameters supplied in the request, either in - the resource path as a query string or in the Parameters collection must not have been - uri encoded. If they have, use the SignRequest method to obtain a signature. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. - - - Client configuration data encompassing the service call (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text. - - - If any problems are encountered while signing the request. - - - - - Calculates and signs the specified request using the AWS4 signing protocol by using the - AWS account credentials given in the method parameters. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. - - - Client configuration data encompassing the service call (notably authentication - region, endpoint and service name). - - - Metrics for the request. - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text. - - - If any problems are encountered while signing the request. - - - Parameters passed as part of the resource path should be uri-encoded prior to - entry to the signer. Parameters passed in the request.Parameters collection should - be not be encoded; encoding will be done for these parameters as part of the - construction of the canonical request. - - - - - Sets the AWS4 mandated 'host' and 'x-amz-date' headers, returning the date/time that will - be used throughout the signing process in various elements and formats. - - The current set of headers - - Date and time used for x-amz-date, in UTC - - - - Sets the AWS4 mandated 'host' and 'x-amz-date' headers, accepting and returning the date/time that will - be used throughout the signing process in various elements and formats. - - The current set of headers - - - Date and time used for x-amz-date, in UTC - - - - Computes and returns an AWS4 signature for the specified canonicalized request - - - - - - - - - - - - Computes and returns an AWS4 signature for the specified canonicalized request - - - - - - - - - - - - - Computes and returns an AWS4 signature for the specified canonicalized request - - - - - - - - - - - - - - Formats the supplied date and time for use in AWS4 signing, where various formats are used. - - - The required format - The UTC date/time in the requested format - - - - Compute and return the multi-stage signing key for the request. - - The clear-text AWS secret key, if not held in secureKey - The region in which the service request will be processed - Date of the request, in yyyyMMdd format - The name of the service being called by the request - Computed signing key - - - - If the caller has already set the x-amz-content-sha256 header with a pre-computed - content hash, or it is present as ContentStreamHash on the request instance, return - the value to be used in request canonicalization. - If not set as a header or in the request, attempt to compute a hash based on - inspection of the style of the request content. - - - - The computed hash, whether already set in headers or computed here. Null - if we were not able to compute a hash. - - - - - If signPayload is false set the x-amz-content-sha256 header to - the UNSIGNED-PAYLOAD magic string and return it. - Otherwise, if the caller has already set the x-amz-content-sha256 header with a pre-computed - content hash, or it is present as ContentStreamHash on the request instance, return - the value to be used in request canonicalization. - If not set as a header or in the request, attempt to compute a hash based on - inspection of the style of the request content. - - - - - The computed hash, whether already set in headers or computed here. Null - if we were not able to compute a hash. - - - - - Returns the HMAC256 for an arbitrary blob using the specified key - - - - - - - - Returns the HMAC256 for an arbitrary blob using the specified key - - - - - - - - Compute and return the hash of a data blob using the specified key - - Algorithm to use for hashing - Hash key - Data blob - Hash of the data - - - - Compute and return the hash of a data blob using the specified key - - Algorithm to use for hashing - Hash key - Data blob - Hash of the data - - - - Computes the non-keyed hash of the supplied data - - - - - - - Computes the non-keyed hash of the supplied data - - - - - - - Computes and returns the canonical request - - The endpoint URL - the path of the resource being operated on - The http method used for the request - The full request headers, sorted into canonical order - The query parameters for the request - - The hash of the binary request body if present. If not supplied, the routine - will look for the hash as a header on the request. - - Canonicalised request as a string - - - - Computes and returns the canonical request - - The endpoint URL - the path of the resource being operated on - The http method used for the request - The full request headers, sorted into canonical order - The query parameters for the request - - The path resource values lookup to use to replace the keys within resourcePath - The hash of the binary request body if present. If not supplied, the routine - will look for the hash as a header on the request. - - The version of the marshaller that constructed the request object. - Canonicalised request as a string - - - - Computes and returns the canonical request - - The endpoint URL - the path of the resource being operated on - The http method used for the request - The full request headers, sorted into canonical order - The query parameters for the request - - The path resource values lookup to use to replace the keys within resourcePath - The hash of the binary request body if present. If not supplied, the routine - will look for the hash as a header on the request. - - The version of the marshaller that constructed the request object. - The service being called for the request - Canonicalised request as a string - - - - Reorders the headers for the request for canonicalization. - - The set of proposed headers for the request - List of headers that must be included in the signature - For AWS4 signing, all headers are considered viable for inclusion - - - - Computes the canonical headers with values for the request. Only headers included in the signature - are included in the canonicalization process. - - All request headers, sorted into canonical order - Canonicalized string of headers, with the header names in lower case. - - - - Returns the set of headers included in the signature as a flattened, ;-delimited string - - The headers included in the signature - Formatted string of header names - - - - Collects the subresource and query string parameters into one collection - ready for canonicalization - - The in-flight request being signed - The fused set of parameters - - - - Computes and returns the canonicalized query string, if query parameters have been supplied. - Parameters with no value will be canonicalized as 'param='. The expectation is that parameters - have not already been url encoded prior to canonicalization. - - The set of parameters being passed on the uri - - Parameters must be uri encoded into the canonical request and by default the signer expects - that the supplied collection contains non-encoded data. Set this to false if the encoding was - done prior to signer entry. - - The uri encoded query string parameters in canonical ordering - - - - Computes and returns the canonicalized query string, if query parameters have been supplied. - Parameters with no value will be canonicalized as 'param='. The expectation is that parameters - have not already been url encoded prior to canonicalization. - - The set of parameters to be encoded in the query string - - Parameters must be uri encoded into the canonical request and by default the signer expects - that the supplied collection contains non-encoded data. Set this to false if the encoding was - done prior to signer entry. - - The uri encoded query string parameters in canonical ordering - - - - Returns the request parameters in the form of a query string. - - The request instance - Request parameters in query string format - - - - AWS4 protocol signer for Amazon S3 presigned urls. - - - - - Calculates and signs the specified request using the AWS4 signing protocol by using the - AWS account credentials given in the method parameters. The resulting signature is added - to the request headers as 'Authorization'. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. - - - Adding supporting data for the service call required by the signer (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text - - - If any problems are encountered while signing the request. - - - - - Calculates the AWS4 signature for a presigned url. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. If the Expires parameter - is present, it is renamed to 'X-Amz-Expires' before signing. - - - Adding supporting data for the service call required by the signer (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text - - - If any problems are encountered while signing the request. - - - Parameters passed as part of the resource path should be uri-encoded prior to - entry to the signer. Parameters passed in the request.Parameters collection should - be not be encoded; encoding will be done for these parameters as part of the - construction of the canonical request. - - - - - Calculates the AWS4 signature for a presigned url. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. If the Expires parameter - is present, it is renamed to 'X-Amz-Expires' before signing. - - - Adding supporting data for the service call required by the signer (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text - - - The service to sign for - - - The region to sign to, if null then the region the client is configured for will be used. - - - If any problems are encountered while signing the request. - - - Parameters passed as part of the resource path should be uri-encoded prior to - entry to the signer. Parameters passed in the request.Parameters collection should - be not be encoded; encoding will be done for these parameters as part of the - construction of the canonical request. - - The X-Amz-Content-SHA256 is cleared out of the request. - If the request is for S3 then the UNSIGNED_PAYLOAD value is used to generate the canonical request. - If the request isn't for S3 then the empty body SHA is used to generate the canonical request. - - - - - Encapsulates the various fields and eventual signing value that makes up - an AWS4 signature. This can be used to retrieve the required authorization string - or authorization query parameters for the final request as well as hold ongoing - signature computations for subsequent calls related to the initial signing. - - - - - Constructs a new signing result instance for a computed signature - - The access key that was included in the signature - Date/time (UTC) that the signature was computed - The collection of headers names that were included in the signature - Formatted 'scope' value for signing (YYYYMMDD/region/service/aws4_request) - Returns the key that was used to compute the signature - Computed signature - - - - The access key that was used in signature computation. - - - - - ISO8601 formatted date/time that the signature was computed - - - - - ISO8601 formatted date that the signature was computed - - - - - The ;-delimited collection of header names that were included in the signature computation - - - - - Formatted 'scope' value for signing (YYYYMMDD/region/service/aws4_request) - - - - - Returns a copy of the key that was used to compute the signature - - - - - Returns the hex string representing the signature - - - - - Returns a copy of the byte array containing the signature - - - - - Returns the signature in a form usable as an 'Authorization' header value. - - - - - Returns the signature in a form usable as a set of query string parameters. - - - - - Null Signer which does a no-op. - - - - - Signs the specified request with the AWS2 signing protocol by using the - AWS account credentials given in the method parameters. - - The AWS public key - The AWS secret key used to sign the request in clear text - Request metrics - The configuration that specifies which hashing algorithm to use - The request to have the signature compute for - If any problems are encountered while signing the request - - - - S3 signer constructor - - - - - S3 signer constructor - - - - - This exception is thrown if there are problems signing the request. - - - - - Response Unmarshaller for all Errors - - - - - Build an ErrorResponse from XML - - The XML parsing context. - Usually an Amazon.Runtime.Internal.UnmarshallerContext. - An ErrorResponse object. - - - - Return an instance of and ErrorResponseUnmarshaller. - - - - - - Interface for unmarshallers which unmarshall objects from response data. - The Unmarshallers are stateless, and only encode the rules for what data - in the XML stream goes into what members of an object. - - The type of object the unmarshaller returns - The type of the XML unmashaller context, which contains the - state during parsing of the XML stream. Usually an instance of - Amazon.Runtime.Internal.Transform.UnmarshallerContext. - - - - Given the current position in the XML stream, extract a T. - - The XML parsing context - An object of type T populated with data from the XML stream. - - - - Interface for unmarshallers which unmarshall service responses. - The Unmarshallers are stateless, and only encode the rules for what data - in the XML stream goes into what members of an object. - - The type of object the unmarshaller returns - The type of the XML unmashaller context, which contains the - state of parsing the XML stream. Uaually an instance of - Amazon.Runtime.Internal.Transform.UnmarshallerContext. - - - - Extracts an exeption with data from an ErrorResponse. - - The XML parsing context. - An inner exception to be included with the returned exception - The HttpStatusCode from the ErrorResponse - Either an exception based on the ErrorCode from the ErrorResponse, or the - general service exception for the service in question. - - - - Interface for unmarshallers which unmarshall objects from response data. - The Unmarshallers are stateless, and only encode the rules for what data - in the XML stream goes into what members of an object. - - The type of object the unmarshaller returns - The type of the XML unmashaller context, which contains the - state during parsing of the XML stream. Usually an instance of - Amazon.Runtime.Internal.Transform.UnmarshallerContext. - - - - Given the current position in the XML stream, extract a T. - - The XML parsing context - An object of type T populated with data from the XML stream. - - - - First-pass unmarshaller for all errors - - - - - Build an ErrorResponse from json - - The json parsing context. - Usually an Amazon.Runtime.Internal.JsonUnmarshallerContext. - An ErrorResponse object. - - - - Return an instance of JsonErrorResponseUnmarshaller. - - - - - - Wraps a json string for unmarshalling. - - Each Read() operation gets the next token. - TestExpression() is used to match the current key-chain - to an xpath expression. The general pattern looks like this: - - JsonUnmarshallerContext context = new JsonUnmarshallerContext(jsonString); - while (context.Read()) - { - if (context.IsKey) - { - if (context.TestExpresion("path/to/element")) - { - myObject.stringMember = stringUnmarshaller.GetInstance().Unmarshall(context); - continue; - } - } - } - - - - - - Wrap the jsonstring for unmarshalling. - - Stream that contains the JSON for unmarshalling - If set to true, maintains a copy of the complete response body constraint to log response size as the stream is being read. - Response data coming back from the request - If set to true, maintains a copy of the complete response body as the stream is being read. - - - - Are we at the start of the json document. - - - - - Is the current token the end of an object - - - - - Is the current token the start of an object - - - - - Returns the element depth of the parser's current position in the json - document being parsed. - - - - - The current Json path that is being unmarshalled. - - - - - Reads to the next token in the json document, and updates the context - accordingly. - - - True if a token was read, false if there are no more tokens to read. - - - - - Peeks at the next token. This peek implementation - reads the next token and makes the subsequent Read() return the same data. - If Peek is called successively, it will return the same data. - Only the first one calls Read(), subsequent calls - will return the same data until a Read() call is made. - - Token to peek. - Returns true if the peeked token matches given token. - - - - Returns the text contents of the current token being parsed. - - - The text contents of the current token being parsed. - - - - - The type of the current token - - - - - Get the base stream of the jsonStream. - - - - - Peeks at the next (non-whitespace) character in the jsonStream. - - The next (non-whitespace) character in the jsonStream, or -1 if at the end. - - - - Peeks at the next character in the stream. - If the data isn't buffered into the StreamReader (Peek() returns -1), - we flush the buffered data and try one more time. - - - - - - Abstract class for unmarshalling service responses. - - - - - Class for unmarshalling XML service responses. - - - - - Class for unmarshalling EC2 service responses. - - - - - Class for unmarshalling JSON service responses. - - - - - Unmarshaller for int fields - - - - - Unmarshaller for nullable int fields. Implemented only for JSON context - to handle cases where value can be null e.g. {'Priority': null}. - This unmarshaller is not implemented for XML context, as XML responses - will null elements (xsi:nil='true') will be skipped by the XML parser. - - - - - Unmarshaller for long fields - - - - - Unmarshaller for float fields - - - - - Unmarshaller for double fields - - - - - Unmarshaller for decimal fields - - - - - Unmarshaller for bool fields - - - - - Unmarshaller for string fields - - - - - Unmarshaller for byte fields - - - - - Unmarshaller for DateTime fields - - - - - Unmarshalls given string as a DateTime. Handles cases where we want to unmarshall - as just a DateTime or a nullable Datetime. - - Value to be parsed - If true, the method will return null if text is null. - If false, the method will return default(DateTime), if text is null. - - - - - Unmarshaller for nullable DateTime fields. Implemented only for JSON context - to handle cases where value can be null e.g. {'Priority': null}. - This unmarshaller is not implemented for XML context, as XML responses - will null elements (xsi:nil='true') will be skipped by the XML parser. - - - - - Unmarshaller for MemoryStream fields - - - - - Unmarshaller for ResponseMetadata - - - - - Base class for the UnmarshallerContext objects that are used - to unmarshall a web-service response. - - - - - Tests the specified expression against the current position in the XML - document - - The pseudo-XPath expression to test. - - True if the expression matches the current position in the document, - false otherwise. - - - - Tests the specified expression against the current position in the XML - document being parsed, and restricts the expression to matching at the - specified stack depth. - - The pseudo-XPath expression to test. - - The depth in the stack representing where the expression must - start matching in order for this method to return true. - - True if the specified expression matches the current position in - the XML document, starting from the specified depth. - - - - Reads the next token at depth greater than or equal to target depth. - - Tokens are read at depth greater than or equal to target depth. - True if a token was read and current depth is greater than or equal to target depth. - - - - The current path that is being unmarshalled. - - - - - Returns the element depth of the parser's current position in the - document being parsed. - - - - - Reads to the next node in the document, and updates the context accordingly. - - - True if a node was read, false if there are no more elements to read. - - - - - Returns the text contents of the current element being parsed. - - - The text contents of the current element being parsed. - - - - - True if NodeType is Element. - - - - - True if NodeType is EndElement. - - - - - True if the context is at the start of the document. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Wrap an XmltextReader for simulating an event stream. - - Each Read() operation goes either to the next element or next attribute within - the current element. TestExpression() is used to match the current event - to an xpath expression. The general pattern looks like this: - - UnmarshallerContext context = new UnmarshallerContext(...); - while (context.Read()) - { - if (context.TestExpresion("path/to/element")) - { - myObject.stringMember = stringUnmarshaller.GetInstance().Unmarshall(context); - continue; - } - if (context.TestExpression("path/to/@attribute")) - myObject.MyComplexTypeMember = MyComplexTypeUnmarshaller.GetInstance().Unmarshall(context); - } - - - - - - Wrap an XmlTextReader with state for event-based parsing of an XML stream. - - Stream with the XML from a service response. - If set to true, maintains a copy of the complete response body constraint to log response size as the stream is being read. - Response data coming back from the request - If set to true, maintains a copy of the complete response body as the stream is being read. - - - - The current XML path that is being unmarshalled. - - - - - Returns the element depth of the parser's current position in the XML - document being parsed. - - - - - Reads to the next node in the XML document, and updates the context accordingly. - - - True if a node was read, false if there are no more elements to read./ - - - - - Returns the text contents of the current element being parsed. - - - The text contents of the current element being parsed. - - - - - True if NodeType is Element. - - - - - True if NodeType is EndElement. - - - - - True if the context is at the start of the document. - - - - - True if NodeType is Attribute. - - - - - Wrap an XmlTextReader with state for event-based parsing of an XML stream. - - Stream with the XML from a service response. - If set to true, maintains a copy of the complete response body constraint to log response size as the stream is being read. - Response data coming back from the request - If set to true, maintains a copy of the complete response body as the stream is being read. - - - - RequestId value, if found in response - - - - - Reads to the next node in the XML document, and updates the context accordingly. - If node is RequestId, reads the contents and stores in RequestId property. - - - True if a node was read, false if there are no more elements to read./ - - - - - A stream which caches the contents of the underlying stream as it reads it. - - - - - All the bytes read by the stream. - - - - - All the bytes read by the stream constrained with _cacheLimit - - - - - Initializes the CachingWrapperStream with a base stream. - - The stream to be wrapped. - Maximum number of bytes to be cached. - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Gets a value indicating whether the current stream supports seeking. - CachingWrapperStream does not support seeking, this will always be false. - - - - - Gets or sets the position within the current stream. - CachingWrapperStream does not support seeking, attempting to set Position - will throw NotSupportedException. - - - - - Sets the position within the current stream. - CachingWrapperStream does not support seeking, attempting to call Seek - will throw NotSupportedException. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Stream wrapper that double-buffers from a wrapped stream and - returns the buffered content as a series of signed 'chunks' - for the AWS4 ('Signature V4') protocol. - - - - - Reads some or all of the processed chunk to the consumer, constructing - and streaming a new chunk if more input data is available. - - - - - - - - - Attempt to read sufficient data for a whole chunk from the wrapped stream, - returning the number of bytes successfully read to be processed into a chunk - - - - - Results of the header-signing portion of the request - - - - - Computed signature of the chunk prior to the one in-flight, in - hex - - - - - Computes the derived signature for a chunk of data of given length in the input buffer, - placing a formatted chunk with headers, signature and data into the output buffer - ready for streaming back to the consumer. - - - - - - Length override to return the true length of the payload plus the metainfo - supplied with each chunk - - - - - Computes the total size of the data payload, including the chunk metadata. - Called externally so as to be able to set the correct Content-Length header - value. - - - - - - - Computes the size of the header data for each chunk. - - - - - - - Attempt to read sufficient data for a whole chunk from the wrapped stream, - returning the number of bytes successfully read to be processed into a chunk - - - - - A list object that will always be sent to AWS services, - even if it is empty. - The AWS .NET SDK does not send empty collections to services, unless - the collection is of this type. - - - - - - A dictionary object that will always be sent to AWS services, - even if it is empty. - The AWS .NET SDK does not send empty collections to services, unless - the collection is of this type. - - - - - - - Class to perform actions on a background thread. - Uses a single background thread and performs actions - on it in the order the data was sent through the instance. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Class to invoke actions on a background thread. - Uses a single background thread and invokes actions - on it in the order they were invoked through the instance. - - - - - PCL doesn't have IPAddress. These methods are copied from the Microsoft source code. - - - - - Returns true if the Content is set or there are - query parameters. - - This request - True if data is present; false otherwise. - - - - Utilities for dealing with Guids - - - - - Hashes a set of objects. - - - - - - - Combines a set of hashses. - - - - - - - Combines two hashes. - - - - - - - - Disposes of all managed and unmanaged resources. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - A wrapper stream that calculates a hash of the base stream as it - is being read. - The calculated hash is only available after the stream is closed or - CalculateHash is called. After calling CalculateHash, any further reads - on the streams will not change the CalculatedHash. - If an ExpectedHash is specified and is not equal to the calculated hash, - Close or CalculateHash methods will throw an AmazonClientException. - If CalculatedHash is calculated for only the portion of the stream that - is read. - - - Exception thrown during Close() or CalculateHash(), if ExpectedHash is set and - is different from CalculateHash that the stream calculates, provided that - CalculatedHash is not a zero-length byte array. - - - - - Algorithm to use to calculate hash. - - - - - True if hashing is finished and no more hashing should be done; - otherwise false. - - - - - Current position in the stream. - - - - - Calculated hash for the stream. - This value is set only after the stream is closed. - - - - - Expected hash value. Compared against CalculatedHash upon Close(). - If the hashes are different, an AmazonClientException is thrown. - - - - - Expected length of stream. - - - - - Initializes an HashStream with a hash algorithm and a base stream. - - Stream to calculate hash for. - - Expected hash. Will be compared against calculated hash on stream close. - Pass in null to disable check. - - - Expected length of the stream. If the reading stops before reaching this - position, CalculatedHash will be set to empty array. - - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Asynchronously reads a sequence of bytes from the current stream, advances - the position within the stream by the number of bytes read, and monitors - cancellation requests. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous read operation. The value of the TResult - parameter contains the total number of bytes read into the buffer. This can be - less than the number of bytes requested if that many bytes are not currently - available, or zero (0) if the end of the stream has been reached. - - - - - Gets a value indicating whether the current stream supports seeking. - HashStream does not support seeking, this will always be false. - - - - - Gets or sets the position within the current stream. - HashStream does not support seeking, attempting to set Position - will throw NotSupportedException. - - - - - Sets the position within the current stream. - HashStream does not support seeking, attempting to call Seek - will throw NotSupportedException. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Gets the overridden length used to construct the HashStream - - - - - Calculates the hash for the stream so far and disables any further - hashing. - - - - - Resets the hash stream to starting state. - Use this if the underlying stream has been modified and needs - to be rehashed without reconstructing the hierarchy. - - - - - Validates the underlying stream. - - - - - Compares two hashes (arrays of bytes). - - Expected hash. - Actual hash. - - True if the hashes are identical; otherwise false. - - - - - A wrapper stream that calculates a hash of the base stream as it - is being read or written. - The calculated hash is only available after the stream is closed or - CalculateHash is called. After calling CalculateHash, any further reads - on the streams will not change the CalculatedHash. - If an ExpectedHash is specified and is not equal to the calculated hash, - Close or CalculateHash methods will throw an AmazonClientException. - If base stream's position is not 0 or HashOnReads is true and the entire stream is - not read, the CalculatedHash will be set to an empty byte array and - comparison to ExpectedHash will not be made. - - - Exception thrown during Close() or CalculateHash(), if ExpectedHash is set and - is different from CalculateHash that the stream calculates, provided that - CalculatedHash is not a zero-length byte array. - - - - - Initializes an HashStream with a hash algorithm and a base stream. - - Stream to calculate hash for. - - Expected hash. Will be compared against calculated hash on stream close. - Pass in null to disable check. - - - Expected length of the stream. If the reading stops before reaching this - position, CalculatedHash will be set to empty array. - - - - - A wrapper stream that calculates an MD5 hash of the base stream as it - is being read or written. - The calculated hash is only available after the stream is closed or - CalculateHash is called. After calling CalculateHash, any further reads - on the streams will not change the CalculatedHash. - If an ExpectedHash is specified and is not equal to the calculated hash, - Close or CalculateHash methods will throw an AmazonClientException. - If base stream's position is not 0 or HashOnReads is true and the entire stream is - not read, the CalculatedHash will be set to an empty byte array and - comparison to ExpectedHash will not be made. - - - Exception thrown during Close() or CalculateHash(), if ExpectedHash is set and - is different from CalculateHash that the stream calculates, provided that - CalculatedHash is not a zero-length byte array. - - - - - Initializes an MD5Stream with a base stream. - - Stream to calculate hash for. - - Expected hash. Will be compared against calculated hash on stream close. - Pass in null to disable check. - - - Expected length of the stream. If the reading stops before reaching this - position, CalculatedHash will be set to empty array. - - - - - Utilities for validating label values for host prefix templates - - - - - Validates a label value - - - - - Simple wrapper around the log4net Error method. - - - - - - - - Write debug message to Console - - - - - - - - Write debug message to Console - - - - - - - Simple wrapper around the log4net InfoFormat method. - - - - - - - This is a dynamic wrapper around log4net so we can avoid log4net being required - to be distributed with the SDK. - - - - - Abstract logger class, base for any custom/specific loggers. - - - - - Flushes the logger contents. - - - - - Simple wrapper around the log4net IsErrorEnabled property. - - - - - Simple wrapper around the log4net IsDebugEnabled property. - - - - - Simple wrapper around the log4net IsInfoEnabled property. - - - - - Simple wrapper around the log4net Error method. - - - - - - - - Simple wrapper around the log4net Debug method. - - - - - - - - Simple wrapper around the log4net DebugFormat method. - - - - - - - Simple wrapper around the log4net InfoFormat method. - - - - - - - Logger wrapper for reflected log4net logging methods. - - - - - This should be a one time call to use reflection to find all the types and methods - needed for the logging API. - - - - - Simple wrapper around the log4net IsErrorEnabled property. - - - - - Simple wrapper around the log4net Error method. - - - - - - - - Simple wrapper around the log4net IsDebugEnabled property. - - - - - Simple wrapper around the log4net Debug method. - - - - - - - - Simple wrapper around the log4net DebugFormat method. - - - - - - - Simple wrapper around the log4net IsInfoEnabled property. - - - - - Simple wrapper around the log4net InfoFormat method. - - - - - - - A single logged message - - - - - Log message arguments. - - - - - Culture-specific formatting provider. - - - - - Log message format. - - - - - a size-limited cache of key value pairs - - Once the maximum size has been reached, the least recently - used pairs will be evicted to make room for any new items. - - - - - - - the maximum number of entries this LruCache will hold - before items begin getting evicted - - - - - the number of items in the cache - - - - - Construct a new LruCache. - - maximum number of entries before items are evicted - - - - Add the key/value pair to the cache, or update - the value if the key already exists. - - If the cache is full, evicts the least recently used item. - - - - - - - Evicts a specific key out of the cache if it exists - - the key to evict from the cache - - - - Try to get the value associated with the key. - - the key to look up - the value, if the key exists - true if there is a value associated with the key, or false if no value is associated with the key - - - - Try to get the value associated with the key, if it doesn't exist, use the provided factory method to - create a new value and tries adding it to the cache. - - the key to look up - the factory method used in case the key is not present in the cache - the looked up value or the value created by the factory - - - - Clear the LruCache of all entries. - - - - - Helper class to support LruCache. - Does not implement the error checking and synchronization that - would be necessary for it to stand alone. - - - - - Item to be stored in the LruList - linked list structure. - - - - - Collection of properties being tracked - - - - - Timings for metrics being tracked - - - - - Counters being tracked - - - - - Whether metrics are enabled for the request - - - - - Constructs an empty, disabled metrics object - - - - - Starts timing an event. Logs an exception if an event - of the same type was started but not stopped. - - - - - - - Stops timing an event. Logs an exception if the event wasn't started. - - - - - - - Adds a property for a metric. If there are multiple, the - object is added as a new item in a list. - - - - - - - Sets a counter for a specific metric. - - - - - - - Increments a specific metric counter. - If counter doesn't exist yet, it is set to 1. - - - - - - Returns errors associated with the metric, including - if there are still any timing events in-flight. - - - - - - Returns a string representation of the current metrics. - - - - - - Return a JSON represenation of the current metrics - - - - - - Timing information for a metric - - - - - Empty, stopped timing object - - - - - Timing object in a started state - - - - - - Stops timing - - - - - - Whether the timing has been stopped - - - - - Elapsed ticks from start to stop. - If timing hasn't been stopped yet, returns 0. - - - - - Elapsed time from start to stop. - If timing hasn't been stopped yet, returns TimeSpan.Zero - - - - - Timing event, stops timing of a metric when disposed - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - The destructor for the client class. - - - - - A wrapper stream which supresses disposal of the underlying stream. - - - - - Constructor for NonDisposingWrapperStream. - - The base stream to wrap. - - - - The Dispose implementation for this wrapper stream - does not close the underlying stream. - - - - - This class is used to wrap a stream for a particular segment of a stream. It - makes that segment look like you are reading from beginning to end of the stream. - - - - - Asynchronously reads a sequence of bytes from the current stream, advances - the position within the stream by the number of bytes read, and monitors - cancellation requests. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous read operation. The value of the TResult - parameter contains the total number of bytes read into the buffer. This can be - less than the number of bytes requested if that many bytes are not currently - available, or zero (0) if the end of the stream has been reached. - - - - - Asynchronously writes a sequence of bytes to the current stream and advances the - current position within this stream by the number of bytes written. - - - An array of bytes. This method copies count bytes from buffer to the current stream. - - - The zero-based byte offset in buffer at which to begin copying bytes to the - current stream. - - The number of bytes to be written to the current stream. - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - A task that represents the asynchronous write operation. - - - - Wrapper stream that only supports reading - - - - - Asynchronously clears all buffers for this stream and causes any buffered data - to be written to the underlying device. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous flush operation. - - - - - Asynchronously writes a sequence of bytes to the current stream and advances the - current position within this stream by the number of bytes written. - - - An array of bytes. This method copies count bytes from buffer to the current stream. - - - The zero-based byte offset in buffer at which to begin copying bytes to the - current stream. - - The number of bytes to be written to the current stream. - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - A task that represents the asynchronous write operation. - - - - Partial wrapper stream that only supports reading - - - - - Uri wrapper that can parse out information (bucket, key, region, style) from an - S3 URI. - - - - - True if the URI contains the bucket in the path, false if it contains the bucket in the authority. - - - - - The bucket name parsed from the URI (or null if no bucket specified). - - - - - The key parsed from the URI (or null if no key specified). - - - - - The region parsed from the URI (or null if no region specified). - - - - - Constructs a parser for the S3 URI specified as a string. - - The S3 URI to be parsed. - - - - Constructs a parser for the S3 URI specified as a Uri instance. - - The S3 URI to be parsed. - - - - Percent-decodes the given string, with a fast path for strings that are not - percent-encoded. - - The string to decode - The decoded string - - - - Percent-decodes the given string. - - The string to decode - The index of the first '%' in the string - The decoded string - - - - Decodes the percent-encoded character at the given index in the string - and appends the decoded value to the string under construction. - - - The string under construction to which the decoded character will be - appended. - - The string being decoded. - The index of the '%' character in the string. - - - - Converts a hex character (0-9A-Fa-f) into its corresponding quad value. - - The hex character - The quad value - - - - Interface for a non-generic cache. - - - - - Clears the entire cache. - - - - - Maximum time to keep an item around after its last use. - - - - - How often should the cache be cleared of old items. - - - - - The number of items in the cache. - - - - - Interface for a generic cache. - - - - - - - Retrieves a value out of the cache or from the source. - - - - - - - - Retrieves a value out of the cache or from the source. - If the item was in the cache, isStaleItem is set to true; - otherwise, if the item comes from the source, isStaleItem is false. - - - - - - - - - Clears a specific value from the cache if it's there. - - - - - - Returns the keys for all items in the cache. - - - - - - Executes specified operation, catches exception, clears the cache for - the given key, retries the operation. - - - - - - - - - - - SDK-wide cache. - Provides access to caches specific to a particular set of credentials - and target region. - - - - - Clear all caches - - - - - Clear all caches of a particular type - - - - - - Retrieve a cache of a specific type for a client object. - The client object can be null in cases where a cache does - not correspond to a specific AWS account or target region. - - - - - - - - - - - Retrieve a cache of a specific type for a client object. - The client object can be null in cases where a cache does - not correspond to a specific AWS account or target region. - - - - - - - - - - - Utilities for converting objects to strings. Used by the marshaller classes. - - - - - Converts a DateTime to ISO8601 formatted string. - - - - - Converts a DateTime to RFC822 formatted string. - - - - - Converts a DateTime to Unix epoch time formatted string. - - - - - A wrapper stream. - - - - - Base stream. - - - - - Initializes WrapperStream with a base stream. - - - - - - Returns the first base non-WrapperStream. - - First base stream that is non-WrapperStream. - - - - Returns the first base non-WrapperStream. - - First base stream that is non-WrapperStream. - - - - Returns the first base non-WrapperStream. - - Potential WrapperStream - Base non-WrapperStream. - - - - Gets a value indicating whether the current stream supports reading. - True if the stream supports reading; otherwise, false. - - - - - Gets a value indicating whether the current stream supports seeking. - True if the stream supports seeking; otherwise, false. - - - - - Gets a value indicating whether the current stream supports writing. - True if the stream supports writing; otherwise, false. - - - - - Closes the current stream and releases any resources (such as sockets and - file handles) associated with the current stream. - - - - - Gets the length in bytes of the stream. - - - - - Gets or sets the position within the current stream. - - - - - Gets or sets a value, in miliseconds, that determines how long the stream - will attempt to read before timing out. - - - - - Gets or sets a value, in miliseconds, that determines how long the stream - will attempt to write before timing out. - - - - - Clears all buffers for this stream and causes any buffered data to be written - to the underlying device. - - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Sets the position within the current stream. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Sets the length of the current stream. - - The desired length of the current stream in bytes. - - - - Writes a sequence of bytes to the current stream and advances the current - position within this stream by the number of bytes written. - - - An array of bytes. This method copies count bytes from buffer to the current stream. - - - The zero-based byte offset in buffer at which to begin copying bytes to the - current stream. - - The number of bytes to be written to the current stream. - - - - Asynchronously clears all buffers for this stream and causes any buffered data - to be written to the underlying device. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous flush operation. - - - - - Asynchronously reads a sequence of bytes from the current stream, advances - the position within the stream by the number of bytes read, and monitors - cancellation requests. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous read operation. The value of the TResult - parameter contains the total number of bytes read into the buffer. This can be - less than the number of bytes requested if that many bytes are not currently - available, or zero (0) if the end of the stream has been reached. - - - - - Asynchronously writes a sequence of bytes to the current stream and advances the - current position within this stream by the number of bytes written. - - - An array of bytes. This method copies count bytes from buffer to the current stream. - - - The zero-based byte offset in buffer at which to begin copying bytes to the - current stream. - - The number of bytes to be written to the current stream. - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - A task that represents the asynchronous write operation. - - - - This is a utility class to be used in last resort for code paths that are synchronous but need to call an asynchronous method. - This should never be used for methods that are called at high volume as this utility class has a performance cost. For example this - class was added for the refreshing credentials like Cognito which would need to use this about once an hour. - - - - - Custom WebProxy implementation that creates a webproxy based on - user inputs(Host name and port number) - - - - - Set the ProxyUri - - - - - Create a Uri based on the user inputs(Host name and port number) - - - - - Proxy Uri property - - - - - Proxy Credentials property - - - - - Getter to fetch the set proxy - - - - - Method to determine if the proxy should be bypassed when accessing an internet source - - - - - Error is always enabled - - - - - Debug logging is always enabled - - - - - Info logging is always enabled - - - - - Prints the Log With Error Level - - - - - - - - Prints the Log with Debug Level - - - - - - - - Prints the Log with Debug Level - - - - - - - Prints the Log With Info Level - - - - - - - Logger wrapper for Console.WriteLine() - - - - - Simple wrapper around the log4net IsErrorEnabled property. - - - - - Simple wrapper around the log4net Error method. - - - - - - - - Simple wrapper around the log4net IsDebugEnabled property. - - - - - Simple wrapper around the log4net Debug method. - - - - - - - - Simple wrapper around the log4net DebugFormat method. - - - - - - - Simple wrapper around the log4net IsInfoEnabled property. - - - - - Simple wrapper around the log4net InfoFormat method. - - - - - - - This class is no longer used anymore and should be avoided as it is just meant - as a last resort when blending async and sync operations. The code is still - here to support versions before 3.3.9.0 of AWSSDK.DynamoDBv2. - - - - - Property to denote that the last exception returned by an AWS Service - was retryable or not. - - - - - An abstract pipeline handler that has implements IPipelineHandler, - and has the default implmentation. This is the base class for most of - the handler implementations. - - - - - The logger used to log messages. - - - - - The inner handler which is called after the current - handler completes it's processing. - - - - - The outer handler which encapsulates the current handler. - - - - - Contains the processing logic for a synchronous request invocation. - This method calls InnerHandler.InvokeSync to continue processing of the - request by the pipeline. - - The execution context which contains both the - requests and response context. - - - - Contains the processing logic for an asynchronous request invocation. - This method calls InnerHandler.InvokeSync to continue processing of the - request by the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Logs the metrics for the current execution context. - - The execution context, it contains the - request and response context. - - - - A runtime pipeline contains a collection of handlers which represent - different stages of request and response processing. - - - - - The top-most handler in the pipeline. - - - - - Constructor for RuntimePipeline. - - The handler with which the pipeline is initalized. - - - - Constructor for RuntimePipeline. - - List of handlers with which the pipeline is initalized. - - - - Constructor for RuntimePipeline. - - List of handlers with which the pipeline is initalized. - The logger used to log messages. - - - - Constructor for RuntimePipeline. - - The handler with which the pipeline is initalized. - The logger used to log messages. - - - - Invokes the pipeline synchronously. - - Request context - Response context - - - - Invokes the pipeline asynchronously. - - Request context - Response context - - - - Adds a new handler to the top of the pipeline. - - The handler to be added to the pipeline. - - - - Adds a handler after the first instance of handler of type T. - - Type of the handler after which the given handler instance is added. - The handler to be added to the pipeline. - - - - Adds a handler before the first instance of handler of type T. - - Type of the handler before which the given handler instance is added. - The handler to be added to the pipeline. - - - - Removes the first occurance of a handler of type T. - - Type of the handler which will be removed. - - - - Replaces the first occurance of a handler of type T with the given handler. - - Type of the handler which will be replaced. - The handler to be added to the pipeline. - - - - Inserts the given handler after current handler in the pipeline. - - Handler to be inserted in the pipeline. - Handler after which the given handler is inserted. - - - - Gets the innermost handler by traversing the inner handler till - it reaches the last one. - - - - - Retrieves a list of handlers, in the order of their execution. - - Handlers in the current pipeline. - - - - Retrieves current handlers, in the order of their execution. - - Handlers in the current pipeline. - - - - This handler processes exceptions thrown from the HTTP handler and - unmarshalls error responses. - - - - - Default set of exception handlers. - - - - - Default set of exception handlers. - - - - - Constructor for ErrorHandler. - - an ILogger instance. - - - - Handles and processes any exception thrown from underlying handlers. - - The execution context which contains both the - requests and response context. - - - - Handles and processes any exception thrown from underlying handlers. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Disposes the response body. - - The response context. - - - - Processes an exception by invoking a matching exception handler - for the given exception. - - The execution context, it contains the - request and response context. - The exception to be processed. - - This method returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception that may be thrown by exception - processing by a matching exception handler. - - - - - The abstract base class for exception handlers. - - The exception type. - - - - The exception handler for HttpErrorResponseException exception. - - - - - The constructor for HttpErrorResponseExceptionHandler. - - in instance of ILogger. - - - - Handles an exception for the given execution context. - - The execution context, it contains the - request and response context. - The exception to handle. - - Returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception to replace the original exception. - - - - - Checks if a HTTP 404 status code is returned which needs to be suppressed and - processes it. - If a suppressed 404 is present, it unmarshalls the response and returns true to - indicate that a suppressed 404 was processed, else returns false. - - The execution context, it contains the - request and response context. - - - If a suppressed 404 is present, returns true, else returns false. - - - - - A pipeline handler which provides hooks to run - external code in the pre-invoke and post-invoke phases. - - - - - Action to execute on the pre invoke phase. - - - - - Action to execute on the post invoke phase. - - - - - Calls the PreInvoke and PostInvoke methods before and after calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls the PreInvoke and PostInvoke methods before and after calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Executes the OnPreInvoke action as part of pre-invoke. - - The execution context, it contains the - request and response context. - - - - Executes the OnPreInvoke action as part of post-invoke. - - The execution context, it contains the - request and response context. - - - - This handler retrieved the AWS credentials to be used for the current call. - - - - - The constructor for CredentialsRetriever. - - An AWSCredentials instance. - - - - Retrieves the credentials to be used for the current call before - invoking the next handler. - - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - This handler resolves the endpoint to be used for the current request. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Resolves the endpoint to be used for the current request - before invoking the next handler. - - The execution context, it contains the - request and response context. - - - - This handler resolves the endpoint to be used for the current request. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Resolves the endpoint to be used for the current request - before invoking the next handler. - - The execution context, it contains the - request and response context. - - - - Determines the endpoint for the request. - - The request context. - - - - - This handler provides an OnError action that can be used as hook for - external code to handle exceptions in the runtime pipeline. - - - - - Action to execute if an exception occurs during the - execution of any underlying handlers. - - - - - Executes the OnError action if an exception occurs during the - execution of any underlying handlers. - - - - - - - This handler marshalls the request before calling invoking the next handler. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Marshalls the request before calling invoking the next handler. - - The execution context, it contains the - request and response context. - - - - This handler manages the metrics used to time the complete call and - logs the final metrics. - - - - - Captures the overall execution time and logs final metrics. - - The execution context which contains both the - requests and response context. - - - - Captures the overall execution time and logs final metrics. - - The response type for the current request. - - The execution context, it contains the request and response context. - - A task that represents the asynchronous operation. - - - - This handler processes HTTP redirects and reissues the call to the - redirected location. - - - - - Processes HTTP redirects and reissues the call to the - redirected location. - - The execution context which contains both the - requests and response context. - - - - Processes HTTP redirects and reissues the call to the - redirected location. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Checks if an HTTP 307 (temporary redirect) has occured and changes the - request endpoint to the redirected location. - - - The execution context, it contains the request and response context. - - - A boolean value that indicates if a redirect has occured. - - - - - This handler signs the request. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Signs the request before invoking the next handler. - - - The execution context, it contains the request and response context. - - - - - Determines if the request should be signed. - - The request context. - A boolean value that indicated if the request should be signed. - - - - Signs the request. - - The request context. - - - - This handler unmarshalls the HTTP response. - - - - - The constructor for Unmarshaller. - - - Boolean value which indicated if the unmarshaller - handler supports response logging. - - - - - Unmarshalls the response returned by the HttpHandler. - - The execution context which contains both the - requests and response context. - - - - Unmarshalls the response returned by the HttpHandler. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Unmarshalls the HTTP response. - - - The execution context, it contains the request and response context. - - - - - Unmarshalls the HTTP response. - - - The execution context, it contains the request and response context. - - - - - The HTTP handler contains common logic for issuing an HTTP request that is - independent of the underlying HTTP infrastructure. - - - - - - The sender parameter used in any events raised by this handler. - - - - - The constructor for HttpHandler. - - The request factory used to create HTTP Requests. - The sender parameter used in any events raised by this handler. - - - - Issues an HTTP request for the current request context. - - The execution context which contains both the - requests and response context. - - - - Issues an HTTP request for the current request context. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Determines the content for request body and uses the HTTP request - to write the content to the HTTP request body. - - Content to be written. - The HTTP request. - The request context. - - - - Creates the HttpWebRequest and configures the end point, content, user agent and proxy settings. - - The async request. - The web request that actually makes the call. - - - - Disposes the HTTP handler. - - - - - The default implementation of the adaptive retry policy. - - - The default implementation of the adaptive policy. - - - - - Constructor for AdaptiveRetryPolicy. - - The maximum number of retries before throwing - back a exception. This does not count the initial request. - - - - Constructor for AdaptiveRetryPolicy. - - The Client config object. This is used to - retrieve the maximum number of retries before throwing - back a exception(This does not count the initial request) and - the service URL for the request. - - - - OnRetry is called when a retry request is initiated to determine if the request will be retried. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - true if the error that will be retried is a throtting error - True if retry throttling is disabled or retry throttling is enabled and capacity can be obtained. - - - - This method uses a token bucket to enforce the maximum sending rate. - - The execution context which contains both the - requests and response context. - If the prior request failed, this exception is expected to be - the exception that occurred during the prior request failure. - - - - Virtual method that gets called on a success Response. If its a retry success response, the entire - retry acquired capacity is released(default is 5). If its just a success response a lesser value capacity - is released(default is 1). - - Request context containing the state of the request. - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - This method uses a token bucket to enforce the maximum sending rate. - - The execution context which contains both the - requests and response context. - If the prior request failed, this exception is expected to be - the exception that occurred during the prior request failure. - - - - The default implementation of the legacy retry policy. - - - The default implementation of the legacy retry policy. - - - - - The maximum value of exponential backoff in milliseconds, which will be used to wait - before retrying a request. The default is 30000 milliseconds. - - - - - Constructor for DefaultRetryPolicy. - - The maximum number of retries before throwing - back a exception. This does not count the initial request. - - - - Constructor for DefaultRetryPolicy. - - The Client config object. This is used to - retrieve the maximum number of retries before throwing - back a exception(This does not count the initial request) and - the service URL for the request. - - - - Returns true if the request is in a state where it can be retried, else false. - - Request context containing the state of the request. - Returns true if the request is in a state where it can be retried, else false. - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - true if the error that will be retried is a throtting error - - - - Virtual method that gets called on a success Response. If its a retry success response, the entire - retry acquired capacity is released(default is 5). If its just a success response a lesser value capacity - is released(default is 1). - - Request context containing the state of the request. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Request context containing the state of the request. - Return true if the request should be retried. - - - - Checks if the retry limit is reached. - - Request context containing the state of the request. - Return false if the request can be retried, based on number of retries. - - - - Waits before retrying a request. The default policy implements a exponential backoff. - - Request context containing the state of the request. - - - - Waits for an amount of time using an exponential backoff algorithm. - - The request retry index. The first request is expected to be 0 while - the first retry will be 1. - The max number of milliseconds to wait - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - The retry handler has the generic logic for retrying requests. - It uses a retry policy which specifies when - a retry should be performed. - - - - - The logger used to log messages. - - - - - The retry policy which specifies when - a retry should be performed. - - - - - Constructor which takes in a retry policy. - - Retry Policy - - - - Invokes the inner handler and performs a retry, if required as per the - retry policy. - - The execution context which contains both the - requests and response context. - - - - Invokes the inner handler and performs a retry, if required as per the - retry policy. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Prepares the request for retry. - - Request context containing the state of the request. - - - - The default implementation of the standard retry policy. - - - The default implementation of the standard policy. - - - - - The maximum value of exponential backoff in milliseconds, which will be used to wait - before retrying a request. The default is 20000 milliseconds. - - - - - Constructor for StandardRetryPolicy. - - The maximum number of retries before throwing - back a exception. This does not count the initial request. - - - - Constructor for StandardRetryPolicy. - - The Client config object. This is used to - retrieve the maximum number of retries before throwing - back a exception(This does not count the initial request) and - the service URL for the request. - - - - Returns true if the request is in a state where it can be retried, else false. - - Request context containing the state of the request. - Returns true if the request is in a state where it can be retried, else false. - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - true if the error that will be retried is a throtting error - - - - Virtual method that gets called on a success Response. If its a retry success response, the entire - retry acquired capacity is released(default is 5). If its just a success response a lesser value capacity - is released(default is 1). - - Request context containing the state of the request. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Request context containing the state of the request. - Return true if the request should be retried. - - - - Checks if the retry limit is reached. - - Request context containing the state of the request. - Return false if the request can be retried, based on number of retries. - - - - Waits before retrying a request. The default policy implements a exponential backoff with - jitter algorithm. - - Request context containing the state of the request. - - - - Waits for an amount of time using an exponential backoff with jitter algorithm. - - The request retry index. The first request is expected to be 0 while - the first retry will be 1. - The max number of milliseconds to wait - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - This class is the base class of all the configurations settings to connect - to a service. - - - This class is the base class of all the configurations settings to connect - to a service. - - - - - Gets Service Version - - - - - Gets and sets of the signatureMethod property. - - - - - Gets and sets of the SignatureVersion property. - - Note: This property exists for backward compatibility but is no longer - used by any service other than S3. - - - - - Gets and sets of the UserAgent property. - - - - - Gets and sets the RegionEndpoint property. The region constant that - determines the endpoint to use. - - Setting this property to null will force the SDK to recalculate the - RegionEndpoint value based on App/WebConfig, environment variables, - profile, etc. - - - - - The constant used to lookup in the region hash the endpoint. - - - - - Gets and sets of the ServiceURL property. - This is an optional property; change it - only if you want to try a different service - endpoint. - - - - - Gets and sets the UseHttp. - If this property is set to true, the client attempts - to use HTTP protocol, if the target endpoint supports it. - By default, this property is set to false. - - - - - Given this client configuration, return a string form ofthe service endpoint url. - - - - - Gets and sets the AuthenticationRegion property. - Used in AWS4 request signing, this is an optional property; - change it only if the region cannot be determined from the - service endpoint. - - - - - Gets and sets the AuthenticationServiceName property. - Used in AWS4 request signing, this is the short-form - name of the service being called. - - - - - Returns the flag indicating how many retry HTTP requests an SDK should - make for a single SDK operation invocation before giving up. This flag will - return 4 when the RetryMode is set to "Legacy" which is the default. For - RetryMode values of "Standard" or "Adaptive" this flag will return 2. In - addition to the values returned that are dependant on the RetryMode, the - value can be set to a specific value by using the AWS_MAX_ATTEMPTS environment - variable, max_attempts in the shared configuration file, or by setting a - value directly on this property. When using AWS_MAX_ATTEMPTS or max_attempts - the value returned from this property will be one less than the value entered - because this flag is the number of retry requests, not total requests. To - learn more about the RetryMode property that affects the values returned by - this flag, see . - - - - - Determines if MaxErrorRetry has been manually set. - - - - - Gets and sets the LogResponse property. - If this property is set to true, the service response is logged. - The size of response being logged is controlled by the AWSConfigs.LoggingConfig.LogResponsesSizeLimit property. - - - - - Gets and sets the ReadEntireResponse property. - NOTE: This property does not effect response processing and is deprecated. - To enable response logging, the ClientConfig.LogResponse and AWSConfigs.LoggingConfig - properties can be used. - - - - - Gets and Sets the BufferSize property. - The BufferSize controls the buffer used to read in from input streams and write - out to the request. - - - - - - Gets or sets the interval at which progress update events are raised - for upload operations. By default, the progress update events are - raised at every 100KB of data transferred. - - - If the value of this property is set less than ClientConfig.BufferSize, - progress updates events will be raised at the interval specified by ClientConfig.BufferSize. - - - - - - Flag on whether to resign requests on retry or not. - For Amazon S3 and Amazon Glacier this value will always be set to true. - - - - - This flag controls if .NET HTTP infrastructure should follow redirection - responses (e.g. HTTP 307 - temporary redirect). - - - - - Flag on whether to log metrics for service calls. - - This can be set in the application's configs, as below: - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSLogMetrics" value"true"/> - </appSettings> - </configuration> - - - - - - Gets and sets the DisableLogging. If true logging for this client will be disabled. - - - - - Credentials to use with a proxy. - - - - - - If the value is set, the value is assigned to the Timeout property of the HttpWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Configures the endpoint calculation for a service to go to a dual stack (ipv6 enabled) endpoint - for the configured region. - - - Note: AWS services are enabling dualstack endpoints over time. It is your responsibility to check - that the service actually supports a dualstack endpoint in the configured region before enabling - this option for a service. - - - - - Enable or disable the Retry Throttling feature by setting the ThrottleRetries flag to True/False resepctively. - Retry Throttling is a feature that intelligently throttles retry attempts when a large precentage of requests - are failing and retries are unsuccessful as well. In such situations the allotted retry capacity for the service URL - will be drained until requests start to succeed again. Once the requisite capacity is available, retries would - be permitted again. When retries are throttled, the service enters a fail-fast behaviour as the traditional retry attempt - for the request would be circumvented. Hence, errors will resurface quickly. This will result in a greated number of exceptions - but prevents requests being tied up in unsuccessful retry attempts. - Note: Retry Throttling is enabled by default. Set the ThrottleRetries flag to false to switch off this feature. - - - - - Enable or disable the Nagle algorithm on the underlying http - client. - - This method is not intended to be called by consumers of the AWS SDK for .NET - - - - - - Performs validation on this config object. - Throws exception if any of the required values are missing/invalid. - - - - - Returns the current UTC now after clock correction for this endpoint. - - - - - The calculated clock skew correction for a specific endpoint, if there is one. - This field will be set if a service call resulted in an exception - and the SDK has determined that there is a difference between local - and server times. - - If is set to true, this - value will still be set to the correction, but it will not be used by the - SDK and clock skew errors will not be retried. - - - - - Gets and sets the DisableHostPrefixInjection flag. If true, host prefix injection will be disabled for this client, the default value of this flag is false. - Host prefix injection prefixes the service endpoint with request members from APIs which use this feature. - Example: for a hostPrefix of "foo-name." and a endpoint of "service.region.amazonaws.com" the default behavior is to - prefix the endpoint with the hostPrefix resulting in a final endpoint of "foo-name.service.region.amazonaws.com". Setting - DisableHostPrefixInjection to true will disable hostPrefix injection resulting in a final endpoint of - "service.region.amazonaws.com" regardless of the value of hostPrefix. E.g. You may want to disable host prefix injection for testing against a local mock endpoint. - - - - - Returns the flag indicating if endpoint discovery should be enabled or disabled for operations that are not required to use endpoint discovery. - - - - - Returns the maximum number of discovered endpoints that can be stored within the cache for the client. The default limit is 1000 cache entries. - - - - - Returns the flag indicating the current mode in use for request - retries and influences the value returned from . - The default value is RequestRetryMode.Legacy. This flag can be configured - by using the AWS_RETRY_MODE environment variable, retry_mode in the - shared configuration file, or by setting this value directly. - - - - - Under Adaptive retry mode, this flag determines if the client should wait for - a send token to become available or don't block and fail the request immediately - if a send token is not available. - - - - - Throw an exception if the boxed TimeSpan parameter doesn't have a value or is out of range. - - - - - Returns the request timeout value if its value is set, - else returns client timeout value. - - - - - - This is a switch used for performance testing and is not intended for production applications - to change. This switch may be removed in a future version of the SDK as the .NET Core platform matures. - - - If true, the HttpClient is cached and reused for every request made by the service client - and shared with other service clients. - - - For the .NET Core platform this is default to true because the HttpClient manages the connection - pool. - - - - - - If CacheHttpClient is set to true then HttpClientCacheSize controls the number of HttpClients cached. - - On Windows the default value is 1 since the underlying native implementation does not have throttling constraints - like the non Windows Curl based implementation. For non Windows based platforms the default is the value return from - System.Environment.ProcessorCount. - - - - - - Overrides the default read-write timeout value. - On Unity platform, this value is not used as Unity HTTP client does not support timeouts, so - - - - If the value is set, the value is assigned to the ReadWriteTimeout property of the HttpWebRequest object used - to send requests. - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Returns a WebProxy instance configured to match the proxy settings - in the client configuration. - - - - - Unpacks the host, port and any credentials info into the instance's - proxy-related fields. - Unlike the SetWebProxy implementation on .NET 3.5/4.5,the Host and the Port are not reconstructed from the - input proxyuri - - The proxy details - - - - Gets and sets of the ProxyHost property. - - - - - Gets and sets of the ProxyPort property. - - - - - - Returns true if the clients should be cached by HttpRequestMessageFactory, false otherwise. - - - - - - - Returns true if the SDK should dispose HttpClients after one use, false otherwise. - - - - - - - Create a unique string used for caching the HttpClient based on the settings that are used from the ClientConfig that are set on the HttpClient. - - - - - - - Determines if HttpClients created with the given IClientConfig should be cached at the SDK - client level, or cached globally. - - If there is no HttpClientFactory assigned and proxy or proxy credentials are set - this returns false because those properties can't be serialized as part of the key in the global http client cache. - - - - - Base class for constant class that holds the value that will be sent to AWS for the static constants. - - - - - Gets the value that needs to be used when send the value to AWS - - - - - Attempt to find correct-cased constant value using whatever cased value the user - has provided. This is primarily useful for mapping any-cased values from a CLI - tool to the specific casing required by the service, avoiding the need for the - user to (a) remember the specific case and (b) actually type it correctly. - - The properly cased service constant matching the value - - - - Utility class that stores clock skew information. - - - - - GlobalClockCorrection should be only set by AWSConfigs.ManualClockCorrection property - and is only available to maintain backward compatibilty. This should override any - endpoint specific clockskew correction. - - - - - Return clock skew correction value for an endpoint if there is one. - - AWSConfigs.ManualClockCorrection overrides globally any calculated service endpoint specific - clock correction value. - - Endpoint should in a form such as "https://s3" - Clock correction value for an endpoint in TimeSpan. TimeSpan.Zero if no such clock correction is set. - - - - Get clock skew corrected UTC now value. If ManualClockCorrection is set, - use ManualClockCorrection instead of endpoint specific clock correction value. - - - - - - - Probing mechanism to determine the endpoint discovery enabled value from various sources. - - - - - The valid hashing algorithm supported by the sdk for request signing. - - - - - Which end of a request was responsible for a service error response. - - - - - The sender was responsible for the error, i.e. the client - request failed validation or was improperly formatted. - - - - - The error occured within the service. - - - - - An unrecognized error type was returned. - - - - - Sts Regional Endpoints Value determines whether or not - to send the sts request to the regional endpoint or to - the global sts endpoint - - - - - Send the request to the global sts endpoint - if the region is a legacy global region - - - - - Send the request to the regional endpoint - - - - - S3 US East 1 endpoint value determines wheter or not - to send the us-east-1 s3 requests to the regional endpoint or to - the legacy global endpoint - - - - - Sends the requests to the legacy global s3 endpoint for us-east-1 - - - - - Sends the request to the regional s3 endpoint for us-east-1 - - - - - RetryMode determines which request retry mode is used for requests that do - not complete successfully. - - - - - Legacy request retry strategy. - - - - - Standardized request retry strategy that is consistent across all SDKs. - - - - - An experimental request retry strategy that builds on the Standard strategy - and introduces congestion control through client side rate limiting. - - - - - All Amazon service interfaces like IAmazonS3 extend from this interface. This allows all the - Amazon service interfaces be identified by this base interface and helps with generic constraints. - - - - - A readonly view of the configuration for the service client. - - - - - This interface is the read only access to the ClientConfig object used when setting up service clients. Once service clients - are initiated the config object should not be changed to avoid issues with using a service client in a multi threaded environment. - - - - - Gets the RegionEndpoint property. The region constant to use that - determines the endpoint to use. If this is not set - then the client will fallback to the value of ServiceURL. - - - - - The constant used to lookup in the region hash the endpoint. - - - - - Gets and sets of the ServiceURL property. - This is an optional property if you need to set a specific service URL - instead setting the region with the RegionEndpoint property. - - - - - Gets the UseHttp property. - If this property is set to true, the client attempts - to use HTTP protocol. - By default, this property is set to false. - - - - - Gets Service Version - - - - - Gets the signatureMethod property. - - - - - Gets the SignatureVersion property. - - Note: This property exists for backward compatibility but is no longer - used by any service other than S3. - - - - - Gets the AuthenticationRegion property. - Used in AWS4 request signing, this is an optional property; - change it only if the region cannot be determined from the - service endpoint. - - - - - Gets the AuthenticationServiceName property. - Used in AWS4 request signing, this is the short-form - name of the service being called. - - - - - Gets the UserAgent property. - - - - - Gets the DisableLogging. If true logging for this client will be disabled. - - - - - Flag on whether to log metrics for service calls. - - This can be set in the application's configs, as below: - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSLogMetrics" value"true"/> - </appSettings> - </configuration> - - - - - - Gets the LogResponse property. - If this property is set to true, the service response - is read in its entirety and logged. - - - - - Gets the ReadEntireResponse. - If this property is set to true, the service response - is read in its entirety before being processed. - - - - - This flag controls if .NET HTTP infrastructure should follow redirection - responses (e.g. HTTP 307 - temporary redirect). - - - - - Gets the BufferSize property. - The BufferSize controls the buffer used to read in from input streams and write - out to the request. - - - - - Returns the flag indicating how many retry HTTP requests an SDK should - make for a single SDK operation invocation before giving up. This flag will - return 4 when the RetryMode is set to "Legacy" which is the default. For - RetryMode values of "Standard" or "Adaptive" this flag will return 2. In - addition to the values returned that are dependant on the RetryMode, the - value can be set to a specific value by using the AWS_MAX_ATTEMPTS environment - variable, max_attempts in the shared configuration file, or by setting a - value directly on this property. When using AWS_MAX_ATTEMPTS or max_attempts - the value returned from this property will be one less than the value entered - because this flag is the number of retry requests, not total requests. To - learn more about the RetryMode property that affects the values returned by - this flag, see . - - - - - Determines if MaxErrorRetry has been manually set. - - - - - Gets the interval at which progress update events are raised - for upload operations. By default, the progress update events are - raised at every 100KB of data transferred. - - - - - Flag on whether to resign requests on retry or not. - - - - - Credentials to use with a proxy. - - - - - Gets the default request timeout value. - - - - If the value is set, the value is assigned to the Timeout property of the HTTPWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - - - - Configures the endpoint calculation for a service to go to a dual stack (ipv6 enabled) endpoint - for the configured region. - - - Note: AWS services are enabling dualstack endpoints over time. It is your responsibility to check - that the service actually supports a dualstack endpoint in the configured region before enabling - this option for a service. - - - - - Configures a flag enabling to either opt in or opt out of the retry throttling service. - Note: set value to true to enable retry throttling feature. The Default value for this flag is false. - - - - - Using either the RegionEndpoint or the ServiceURL determine what the URL to the service is. - - The URL to the service. - - - - Performs validation on this config object. - Throws exception if any of the required values are missing/invalid. - - The timeout specified is null. - - - - Returns the clock skew adjusted utc now. This value is affected by AWSConfigs.ManualClockCorrection - - - - - Returns the calculated clock skew value for this config's service endpoint. If AWSConfigs.CorrectForClockSkew is false, - this value won't be used to construct service requests. - - - - - Gets the DisableHostPrefixInjection flag. If true, host prefix injection will be disabled for this client, the default value of this flag is false. - Host prefix injection prefixes the service endpoint with request members from APIs which use this feature. - Example: for a hostPrefix of "foo-name." and a endpoint of "service.region.amazonaws.com" the default behavior is to - prefix the endpoint with the hostPrefix resulting in a final endpoint of "foo-name.service.region.amazonaws.com". Setting - DisableHostPrefixInjection to true will disable hostPrefix injection resulting in a final endpoint of - "service.region.amazonaws.com" regardless of the value of hostPrefix. E.g. You may want to disable host prefix injection for testing against a local mock endpoint. - - - - - Returns the flag indicating if endpoint discovery should be enabled or disabled for operations that are not required to use endpoint discovery. - - - - - Returns the maximum number of discovered endpoints that can be stored within the cache for the client. The default limit is 1000 cache entries. - - - - - Returns the flag indicating the current mode in use for request - retries and influences the value returned from . - The default value is RequestRetryMode.Legacy. This flag can be configured - by using the AWS_RETRY_MODE environment variable, retry_mode in the - shared configuration file, or by setting this value directly. - - - - - Under Adaptive retry mode, this flag determines if the client should wait for - a send token to become available or don't block and fail the request immediately - if a send token is not available. - - - - - - This is a switch used for performance testing and is not intended for production applications - to change. This switch may be removed in a future version of the SDK as the .NET Core platform matures. - - - If true, the HttpClient is cached and reused for every request made by the service client - and shared with other service clients. - - - For the .NET Core platform this is default to true because the HttpClient manages the connection - pool. - - - - - - If CacheHttpClient is set to true then HttpClientCacheSize controls the number of HttpClients cached. - - - - - Gets the ProxyHost property. - - - - - Gets the ProxyPort property. - - - - - Returns a WebProxy instance configured to match the proxy settings - in the client configuration. - - - - - - Interface for a single logged message. - - - - - Log message format. - - - - - Log message arguments. - - - - - Culture-specific formatting provider. - - - - - Abstract parameter value. - - - - - String parameter value. - - - - - String value of the parameter. - - - - - Constructs ParameterValue for a single string. - - - - - - String list parameter value. - - - - - List of strings value of the parameter. - - - - - Constructs ParameterValue for a list of strings. - - - - - - Metrics collected by the SDK on a per-request basis. - - - Each request made to an AWS service by the SDK can have metrics - collected and logged. This interface represents the collected - metrics for a request. The metrics include properties (i.e. request id - and other metadata), timings for each stage of the request, and counters. - - - - - Collection of properties being tracked - - - - - Timings for metrics being tracked - - - - - Counters being tracked - - - - - Whether metrics are enabled for the request - - - - - JSON representation of the current metrics - - JSON string - - - - Represents how long a phase of an SDK request took. - - - - - Whether the timing has been stopped - - - - - Elapsed ticks from start to stop. - If timing hasn't been stopped yet, returns 0. - - - - - Elapsed time from start to stop. - If timing hasn't been stopped yet, returns TimeSpan.Zero - - - - - User supplied type to perform metrics formatting. - - - - - Produce custom formatting for SDK metrics. - - - If defined, this method will be called for every request made by the SDK. - - An instance of IRequestMetrics produced by the SDK - formatted string representation of the metrics - - - - Predefined request metrics that are collected by the SDK. - - - - - Information about the request. - - - - - Gets and sets the RequestId property. - ID that uniquely identifies a request. Amazon keeps track of request IDs. If you have a question about a request, include the request ID in your correspondence. - - - - - This exception is thrown if there are problems signing the request. - - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - - - - Gets the percentage of transfer completed - - - - - Gets the number of bytes transferred since last event - - - - - Gets the number of bytes transferred - - - - - Gets the total number of bytes to be transferred - - - - - Returns a string representation of this object - - - - - - Anonymous credentials. - Using these credentials, the client does not sign the request. - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - AWS Credentials that automatically refresh by calling AssumeRole on - the Amazon Security Token Service. - - - - - The credentials of the user that will be used to call AssumeRole. - - - - - The Amazon Resource Name (ARN) of the role to assume. - - - - - An identifier for the assumed role session. - - - - - Options to be used in the call to AssumeRole. - - - - - Constructs an AssumeRoleAWSCredentials object. - - The credentials of the user that will be used to call AssumeRole. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - - - - Constructs an AssumeRoleAWSCredentials object. - - The credentials of the user that will be used to call AssumeRole. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRole. - - - - A unique identifier that is used by third parties when assuming roles in their customers' accounts. - - - - - An IAM policy in JSON format. - - - - - The length of time in seconds before the credentials will expire. - - - - - The identification number of the MFA device that is associated with the user who is making the assume-role call. - - - - - The value provided by the MFA device, if the trust policy of the role being assumed requires MFA. - - - - - A callback that's used to obtain the MFA token code when the AssumeRoleAWSCredentials are refreshed. - - - - - Immutable representation of AWS credentials obtained as a result of - authenticating with the AssumeRole method of the Security Token Service. - - - - - The expiry time of the credentials, obtained from the AssumeRoleResponse. - - - - - Constructs an instance with supplied keys, token, and expiration. - - The AccessKey for the credentials. - The SecretKey for the credentials. - The security token for the credentials. - The expiration time for the credentials. - - - - Get a copy of this AssumeRoleImmutableCredentials object. - - A copy of this object. - - - - Abstract class that represents a credentials object for AWS services. - - - - - Returns a copy of ImmutableCredentials - - - - - - Called by AmazonServiceClient to validate the credential state - on client construction. - - - - - Basic set of credentials consisting of an AccessKey and SecretKey - - - - - Constructs a BasicAWSCredentials object for the specified accessKey and secretKey. - - - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - Immutable representation of AWS credentials. - - - - - Gets the AccessKey property for the current credentials. - - - - - Gets the SecretKey property for the current credentials. - - - - - Gets the Token property for the current credentials. - - - - - Gets the UseToken property for the current credentials. - Specifies if Token property is non-emtpy. - - - - - Constructs an ImmutableCredentials object with supplied accessKey, secretKey. - - - - Optional. Can be set to null or empty for non-session credentials. - - - - Returns a copy of the current credentials. - - - - - - Abstract class for automatically refreshing AWS credentials - - - - - Refresh state container consisting of credentials - and the date of the their expiration - - - - - Represents the current state of the Credentials. - - This can be cleared without synchronization. - - - - Semaphore to control thread access to GetCredentialsAsync method. - The semaphore will allow only one thread to generate new credentials and - update the current state. - - - - - The time before actual expiration to expire the credentials. - Property cannot be set to a negative TimeSpan. - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - Test credentials existence and expiration time - should update if: - credentials have not been loaded yet - it's past the expiration time. At this point currentState.Expiration may - have the PreemptExpiryTime baked into to the expiration from a call to - UpdateToGeneratedCredentials but it may not if this is new application load. - - - - - When overridden in a derived class, generates new credentials and new expiration date. - - Called on first credentials request and when expiration date is in the past. - - - - - - When overridden in a derived class, generates new credentials and new expiration date. - - Called on first credentials request and when expiration date is in the past. - - - - - - Clears currently-stored credentials, forcing the next GetCredentials call to generate new credentials. - - - - - Immutable representation of AWS credentials obtained as a result of - authenticating against a SAML-supporting federated identity provider. - - - - - The expiry time of the credentials, obtained from the AssumeRoleWithSAML response. - - - - - The value of the NameID element in the Subject element of the SAML assertion, as returned in the - AssumeRoleWithSAML response from the Security Token Service. - - - - - Constructs an instance with supplied keys and SAML assertion data. - - - - - - - - - - Constructs an instance with supplied keys and SAML assertion data. - - - - - - - - Returns a copy of the current credentials. - - - - - - Serializes the instance to a json-format string for external storage - - The serialized object in json - - - - Instantiates an instance from persisted json data - - The serialized data - Deserialized instance corresponding to the json data - - - - Session credentials consisting of AccessKey, SecretKey and Token - - - - - Constructs a SessionAWSCredentials object for the specified accessKey, secretKey. - - - - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - Credentials that are retrieved from the Instance Profile service on an EC2 instance - - - - - Constructs a InstanceProfileAWSCredentials object for specific role - - Role to use - - - - Constructs a InstanceProfileAWSCredentials object for the first found role - - - - - Retrieves a list of all roles available through current InstanceProfile service - - InstanceProfileAWSCredentials is no longer supported in PCL. - - - - - - Superclass for Exceptions that come over the event stream, or to wrap other kinds of generic exceptions. - - - - - The numeric code identifier for the type of error. - - - - - Constructs an EventStreamError. - - - - - Constructs an EventStreamError. - - The error code. - The error message. - - - - Event args that contain an . - - The - - - - The EventStream Event. - - - - - Constructs an EventStreamEventReceivedArgs. - - The EventStream Event. - - - - Event args that contain an . - - The . - - - - The EventStream Exception. - - - - - Constructs an EventStreamExceptionReceivedArgs. - - The EventStream Exception. - - - - Supported Header types for vnd.amazon.event-stream - - - - - Name for the Header. Maximum of 255 bytes. - - - - - Header type id - - - - - Computes the amount of memory neccesary to serialize this Header. - - - - - Writes this Header to buffer starting at offset - Keep in mind, this API assumes buffer is large enough - for the operation. - - buffer to serialize this Header to - offset to begin writing at. - - the new offset. - - - - - Returns the current value as a bool - - - - - Sets the current value - - - - - Returns the current value as a byte - - - - - Sets the current value - - - - - Gets the current value as a 16 bit integer. (Host Order). - - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a 32 bit integer. (Host Order) - - - - - Sets the current value - - - - - returns the current value as a 64-bit integer. (Host Order) - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a byte buffer. - - - - - - Sets the current value. Max length is 2^15 - 1 - - - - - Returns the current value as a utf-8 string. - - - - - Sets the current value. Utf-8 encoded. Max byte size is 2^16 - 1 - - - - - Gets the current value as a DateTime. - Note: You do not need to compensate for unix epoch on this API. - - - - - - Sets the current value. - Note: You do not need to compensate for unix epoch on this API. - - - - - Returns the current value as a Guid (UUID) - - - - - Sets the current value - - - - - Header Data for an EventStreamMessage - - Each header is of format: - [name len] (1) | [utf-8 name] (v) - [type (1)] - [value (v)] - - - - - Name for the Header. Maximum of 255 bytes. - - - - - Header type id - - - - - Initializes this Header with name. - - utf-8 string, max length is 255 - - - - Deserializes the header in buffer. - - buffer constaining the header - index to start from in the buffer. - updated offset with new value for offset - - - - Writes this Header to buffer starting at offset - Keep in mind, this API assumes buffer is large enough - for the operation. - - buffer to serialize this Header to - offset to begin writing at. - - the new offset. - - - - - Computes the amount of memory neccesary to serialize this Header. - - - - - Returns the current value as a bool - - - - - Sets the current value - - - - - Returns the current value as a byte - - - - - Sets the current value - - - - - Gets the current value as a 16 bit integer. (Host Order). - - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a 32 bit integer. (Host Order) - - - - - Sets the current value - - - - - returns the current value as a 64-bit integer. (Host Order) - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a byte buffer. - - - - - - Sets the current value. Max length is 2^15 - 1 - - - - - Returns the current value as a utf-8 string. - - - - - Sets the current value. Utf-8 encoded. Max byte size is 2^16 - 1 - - - - - Gets the current value as a DateTime. - Note: You do not need to compensate for unix epoch on this API. - - - - - - Sets the current value. - Note: You do not need to compensate for unix epoch on this API. - - - - - Returns the current value as a Guid (UUID) - - - - - Sets the current value - - - - - Headers for the message. Can be null. - - - - - Payload for the message. Can be null. - - - - - Converts a message into a byte buffer (usually for network transmission). - - - - - Message is a single datagram. The format is as follows: - [ total length (4) ] | [ headers_length (4)] | [ prelude crc(4)] - [ headers (v)] - [ payload (v)} - [ trailing crc ] - - CRCs use the CRC32 algorithm. - - - - - Content type for EventStreams. - - - - - Headers for the message. Can be null. - - - - - Payload for the message. Can be null. - - - - - Initialize a message with headers and a payload. - - list of headers for the message, can be null. - payload for the message, can be null. - - - - Builds a message from buffer. - - buffer to read - offset to start reading - buffer length. - - parsed instance of EventStreamMessage. Doesn't return null, - does throw if CRCs don't match. - - - - - Converts a message into a byte buffer (usually for network transmission). - - - - - Defines exceptions that arise from an not conforming to specification. - - - - - Constructs an EventStreamValidationException. - - - - - Constructs an EventStreamValidationException. - - The exception message. - - - - Constructs an EventStreamValidationException. - - The exception message. - The inner exception. - - - - This exception is thrown if an exception is retrieved from the event stream and should be modeled, - but a generator function for the strongly-typed exception is not defined. - - - - - The exception type. - - - - - Constructs an EventStreamException. - - The exception type. - - - - The contract for the . - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - A subclass of that enables an enumerable interface for interacting with Events. - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - Flag if the stream was chosen to be enumerated. - - - - - A Stream of Events. Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treated as mutually exclusive. - - - - - A Stream of Events. Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treated as mutually exclusive. - - - - - Returns an enumerator that iterates through the collection. - - An enumerator that can be used to iterate through the collection. - - - - Returns an enumerator that iterates through a collection. - - An object that can be used to iterate through the collection. - - - - Starts the background thread to start reading events from the network stream. - - - - - The contract for the . - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - The size of the buffer for reading from the network stream. - - - - - Fires when an event is received. - - - - - Fired when an exception or error is raised. - - - - - Starts the background thread to start reading events from the network stream. - - - - - The superclass for all EventStreams. It contains the common processing logic needed to retreive events from a network Stream. It - also contains the mechanisms needed to have a background loop raise events. - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - "Unique" key for unknown event lookup. - - - - - Header key for message type. - - - - - Header key for event type. - - - - - Header key for exception type. - - - - - Header key for error code. - - - - - Header key for error message. - - - - - Value of when the message is an event. - - - - - Value of when the message is an exception. - - - - - Value of when the message is an error. - - - - - The size of the buffer for reading from the network stream. - Default is 8192. - - - - - The underlying stream to read events from. - - - - - Responsible for decoding events from sequences of bytes. - - - - - Fires when an event is recieved. - - - - - Fired when an exception or error is raised. - - - - - The mapping of event message to a generator function to construct the matching Event Stream event. - - - - - The mapping of event message to a generator function to construct the matching Event Stream exception. - - - - - Whether the Stream is currently being processed. - - - - - A Stream of Events. Events can be retrieved from this stream by attaching handlers to listen events, and then calling StartProcessing. - - - - - A Stream of Events. Events can be retrieved from this stream by attaching handlers to listen events, and then calling StartProcessing. - - - - - Converts an EventStreamMessage to an event. - - The event stream message to be converted. - The event - - - - Abstraction for cross-framework initiation of the background thread. - - - - - The background thread main loop. It will constantly read from the network stream until IsProcessing is false, or an error occurs. - - This stub exists due to FXCop. - - - - - The background thread main loop. It will constantly read from the network stream until IsProcessing is false, or an error occurs. - - Needed for 3.5 support. Not used. - - - - Reads from the stream into the buffer. It then passes the buffer to the decoder, which raises an event for - each message it decodes. - - The buffer to store the read bytes from the stream. - - - - Wraps exceptions in an outer exception so they can be passed to event handlers. If the Exception is already of a compatable type, - the method returns what it was given. - - The exception to wrap. - An exception of type TE - - - - Starts the background thread to start reading events from the network stream. - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Disposes the resources of this stream. - - Should dispose of unmanged resources. - - - - Event Arguments for EventStreamDecoder.MessageReceived. - - - - - Received message. - - - - - Additional object context - - - - - Initialize this with message - - - - - Initialize this with message and object conetext - - - - - Exception thrown when a request is made of the Decoder, but the internal state - machine is an invalid state. This is usually the result of an interanl exception - being thrown during parsing of the network stream. - - - - - Contract for EventStreamDecoder - - - - - Invoked anytime an EventStreamMessage is found. - - - - - Processes data starting at offset up to length. - Invokes MessageRecieved for each message encountered. - If an exception is thrown, this object is not safe for reuse. - - buffer to read - offset in buffer to start reading. - length of data. - - - - Streaming decoder for listening for incoming EventStreamMessage datagrams. - - - - - Invoked anytime an EventStreamMessage is found. - - - - - Object data (optional) that can be passed to the event handler for MessageReceived. - - - - - Default constructor. Initializes internal _state machine. - - - - - Processes data starting at offset up to length. - Invokes MessageRecieved for each message encountered. - If an exception is thrown, this object is not safe for reuse. - - buffer to read - offset in buffer to start reading. - length of data. - - - - Superclass for Exceptions that come over the event stream, or to wrap other kinds of generic exceptions. - - - - - Constructs an EventStreamException. - - - - - Constructs an EventStreamException. - - The exception message. - - - - Constructs an EventStreamException. - - The exception message. - The inner exception. - - - - The contract for EventStream events. - - - - - The contract for EventStream terminal events. - - - - - This Event is returned if an event is retrieved from the event stream, but a generator function - for the event is not defined. This can occur if the SDK is not updated after a new event type is introduced. - - - - - The Message recieved from the event stream before conversion. - - - - - The event type. - - - - - Constructs an UnknownEventStreamEvent. - - - - - Constructs an UnknownEventStreamEvent. - - The Message recieved from the event stream before conversion. - The event type. - - - - Signals that an an has an unknown message type. These exceptions whould be - swallowed to allow future expansion of the EventStream specification without breaking existing clients. - - - - - Constructs an UnknownEventStreamMessageTypeException. - - - - - Interface for a handler in a pipeline. - - - - - The logger used to log messages. - - - - - The inner handler which is called after the current - handler completes it's processing. - - - - - The outer handler which encapsulates the current handler. - - - - - Contains the processing logic for a synchronous request invocation. - This method should call InnerHandler.InvokeSync to continue processing of the - request by the pipeline, unless it's a terminating handler. - - The execution context which contains both the - requests and response context. - - - - Contains the processing logic for an asynchronous request invocation. - This method should call InnerHandler.InvokeSync to continue processing of the - request by the pipeline, unless it's a terminating handler. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - The interface for an exception handler. - - - - - Handles an exception for the given execution context. - - The execution context, it contains the - request and response context. - The exception to handle. - - Returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception to replace the original exception. - - - - - The interface for an exception handler with a generic parameter for the exception type. - - The exception type. - - - - Handles an exception for the given execution context. - - The execution context, it contains the - request and response context. - The exception to handle. - - Returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception to replace the original exception. - - - - - The interface for a HTTP request factory. - - The type used by the underlying HTTP API to represent the request body. - - - - Creates an HTTP request for the given URI. - - The request URI. - An HTTP request. - - - - The interface for an HTTP request that is agnostic of the underlying HTTP API. - - The type used by the underlying HTTP API to represent the HTTP request content. - - - - The HTTP method or verb. - - - - - The request URI. - - - - - Configures a request as per the request context. - - The request context. - - - - Sets the headers on the request. - - A dictionary of header names and values. - - - - Gets a handle to the request content. - - The request content. - - - - Returns the HTTP response. - - The HTTP response. - - - - Writes a stream to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - The request context. - - - - Writes a byte array to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - - - - Sets up the progress listeners - - The content stream - The interval at which progress needs to be published - The objects which is trigerring the progress changes - The callback which will be invoked when the progress changed event is trigerred - an object, incase the progress is setup, else returns the original stream - - - - Aborts the HTTP request. - - - - - Gets a handle to the request content. - - - - - - Returns the HTTP response. - - A cancellation token that can be used to cancel the asynchronous operation. - - - - - A factory which creates HTTP clients. - - - - - Create and configure an HttpClient. - - - - - - A factory which creates HTTP requests which uses System.Net.Http.HttpClient. - - - - - The constructor for HttpRequestMessageFactory. - - Configuration setting for a client. - - - - Creates an HTTP request for the given URI. - - The request URI. - An HTTP request. - - - - Disposes the HttpRequestMessageFactory. - - - - - Dispose the factory - - - - - - Create and configure a managed HttpClient instance. - The use of HttpClientHandler in the constructor for HttpClient implicitly creates a managed HttpClient. - If a native HttpClient is required the SDK user must implement IHttpClientFactory and provide an - instance via IClientConfig.HttpClientFactory (only available in PCL). - - - - - - - A cache of HttpClient objects. The GetNextClient method does a round robin cycle through the clients - to distribute the load even across. - - - - - Constructs a container for a cache of HttpClient objects - - The HttpClient to cache - - - - Returns the next HttpClient using a round robin rotation. It is expected that individual clients will be used - by more then one Thread. - - - - - - Disposes the HttpClientCache. - - - - - Dispose the HttpClientCache - - - - - - HTTP request wrapper for System.Net.Http.HttpRequestMessage. - - - - - Set of content header names. - - - - - The constructor for HttpWebRequestMessage. - - The HttpClient used to make the request. - The request URI. - The service client config. - - - - The underlying HttpClient - - - - - The underlying HTTP web request. - - - - - The HTTP method or verb. - - - - - The request URI. - - - - - Configures a request as per the request context. - - The request context. - - - - Sets the headers on the request. - - A dictionary of header names and values. - - - - Gets a handle to the request content. - - The request content. - - - - Returns the HTTP response. - - The HTTP response. - - - - Aborts the HTTP request. - - - - - Returns the HTTP response. - - A cancellation token that can be used to cancel the asynchronous operation. - - - - - Writes a stream to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - The request context. - - - - Writes a byte array to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - - - - Gets a handle to the request content. - - - - - - Disposes the HttpWebRequestMessage. - - - - - - - - - - - Sets up the progress listeners - - The content stream - The interval at which progress needs to be published - The objects which is trigerring the progress changes - The callback which will be invoked when the progress changed event is trigerred - an object, incase the progress is setup, else returns the original stream - - - - A retry policy specifies all aspects of retry behavior. This includes conditions when the request should be retried, - checks of retry limit, preparing the request before retry and introducing delay (backoff) before retries. - - - A retry policy specifies all aspects of retry behavior. This includes conditions when the request should be retried, - checks of retry limit, preparing the request before retry and introducing delay (backoff) before retries. - - - - - Maximum number of retries to be performed. - This does not count the initial request. - - - - - The logger used to log messages. - - - - - The standard set of throttling error codes - - - - - The standard set of timeout error codes to retry on. - - - - - List of AWS specific error codes which are returned as part of the error response. - These error codes will be retried. - - - - - The standard set of transient error, HTTP status codes to retry on. - 502 and 504 are returned by proxies. These can also be returned for - S3 accelerate requests which are served by CloudFront. - - - - - Set of web exception status codes to retry on. - - - - - This parameter serves as the value to the CapacityManager.Container datastructure. - Its properties include the available capacity left for making a retry request and the maximum - capacity size. - - - - - Checks if a retry should be performed with the given execution context and exception. - - The execution context which contains both the - requests and response context. - The exception thrown after issuing the request. - Returns true if the request should be retried, else false. The exception is retried if it matches with clockskew error codes. - - - - Returns true if the request is in a state where it can be retried, else false. - - The execution context which contains both the - requests and response context. - Returns true if the request is in a state where it can be retried, else false. - - - - Return true if the request should be retried for the given exception. - - The execution context which contains both the - requests and response context. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Checks if the retry limit is reached. - - The execution context which contains both the - requests and response context. - Return false if the request can be retried, based on number of retries. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called on a successful request response. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called before a retry request is initiated. The value - returned is True by default(retry throttling feature is disabled). - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called before a retry request is initiated. The value - returned is True by default(retry throttling feature is disabled). - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - - - - Virtual method that gets called before a retry request is initiated. The value - returned is True by default(retry throttling feature is disabled). - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - true if the error that will be retried is a throttling error - - - - This method uses a token bucket to enforce the maximum sending rate. - - The execution context which contains both the - requests and response context. - If the prior request failed, this exception is expected to be - the exception that occurred during the prior request failure. - - - - Determines if an AmazonServiceException is a throttling error - - The current exception to check. - true if it is a throttling error else false. - - - - Determines if an AmazonServiceException is a transient error that - should be retried. - - The current execution context - The current exception to check. - true if the exception is a transient error else false. - - - - Determines if the exception is a known timeout error code that - should be retried under the timeout error category. - - The current exception to check. - true if the exception is considered a timeout else false - - - - Checks if a retry should be performed with the given execution context and exception. - - The execution context which contains both the - requests and response context. - The exception throw after issuing the request. - Returns true if the request should be retried, else false. The exception is retried if it matches with clockskew error codes. - - - - This method uses a token bucket to enforce the maximum sending rate. - - The execution context which contains both the - requests and response context. - If the prior request failed, this exception is expected to be - the exception that occurred during the prior request failure. - - - - Return true if the request should be retried for the given exception. - - The execution context which contains both the - requests and response context. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - ICoreAmazonKMS is not meant to be used directly. It defines Key Management Service - with basic .NET types and allows other services to be able to use the service as - a runtime dependency. This interface is implemented by the AmazonKeyManagementServiceClient - defined in the AWSSDK.KeyManagementService assembly. - - - - - The result of the GenerateDataKey and GenerateDataKeyAsync operations. - - - - - The plaintext for the data key. - - - - - The ciphertext for the data key. - - - - - ICoreAmazonS3 is not meant to use directly. It defines S3 with basic .NET types - and allows other services to be able to use S3 as a runtime dependency. This interface - is implemented by the AmazonS3Client defined in the S3 assembly. - - - ICoreAmazonS3 is not meant to use directly. It defines S3 with basic .NET types - and allows other services to be able to use S3 as a runtime dependency. This interface - is implemented by the AmazonS3Client defined in the S3 assembly. - - - - - Generate a presigned URL. - - - - - - - - - - Get all the object keys for the particular bucket and key prefix. - - - - - - - - - Upload an object from a stream. - - - - - - - - - - - Delete an object. - - - - - - - - - - Delete an object. - - - - - - - - - - Open a stream to an object in S3. - - - - - - - - - - Upload an object from a file path. - - - - - - - - - - - Download an object in S3 to a file path. - - - - - - - - - - - Set the ACL on the object to public readable. - - - - - - - - Check to see if the bucket exists and if it doesn't create the bucket. - - - - - - Check to see if the bucket exists. - - - - - - - ICoreAmazonSQS is not meant to use directly. It defines SQS with basic .NET types - and allows other services to be able to use SQS as a runtime dependency. This interface - is implemented by the AmazonSQSClient defined in the SQS assembly. - - - - - Get the attributes for the queue identified by the queue URL asynchronously. - - The queue URL to get attributes for. - A Task containing the result of a dictionary of attributes for the queue. - - - - Set the attributes on the queue identified by the queue URL asynchronously. - - The queue URL to set the attributues. - The attributes to set. - A Task - - - - ICoreAmazonSTS is not meant to be used directly. It defines Security Token - service with basic .NET types and allows other services to be able to use the service as - a runtime dependency. This interface is implemented by the AmazonSecurityTokenServiceClient - defined in the AWSSDK.SecurityToken assembly. - - - - - - This method is used internally to access the Amazon Security Token - service within other service assemblies. - Please use AmazonSecurityTokenServiceClient to access the Amazon Security Token - service instead. - - Use Amazon Security Token Service to assume a role. - - Proxy settings that are required for the HTTPS and STS calls made during the authentication/credential - generation process are supported and should have been configured on the STS ClientConfig instance - associated with the STS client instance exposing this interface. - - - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRole. - - - - - CoreAmazonKMS is not meant to use directly. It implements ICoreAmazonKMS - and allows other service clients to be able to use the KMS service as a runtime dependency. - - This class waits until a method is actually called on the ICoreAmazonKMS interface - before requiring the KMS assembly to be present and loaded. - - - - - Settings for configuring a proxy for the SDK to use. - - - - - The host name or IP address of the proxy server. - - - - - The port number of the proxy. - - - - - The username to authenticate with the proxy server. - - - - - The password to authenticate with the proxy server. - - - - - Collection of one or more regular expressions denoting addresses - for which the proxy will not be used. - - - For more information on bypass lists - see https://msdn.microsoft.com/en-us/library/system.net.webproxy.bypasslist%28v=vs.110%29.aspx. - - - - - If true requests to local addresses bypass the configured - proxy. - - - - - Settings for logging in the SDK. - - - - - Logging destination. - - - - - When to log responses. - - - - - Gets or sets the size limit in bytes for logged responses. - If logging for response body is enabled, logged response - body is limited to this size. The default limit is 1KB. - - - - - Whether or not to log SDK metrics. - - - - - A custom formatter added through Configuration - - - - - This class can be used to discover the public address ranges for AWS. The - information is retrieved from the publicly accessible - https://ip-ranges.amazonaws.com/ip-ranges.json file. - - - The information in this file is generated from our internal system-of-record and - is authoritative. You can expect it to change several times per week and should - poll accordingly. - - - - - Region identifier string for ROUTE53 and CLOUDFRONT ranges - - - - - Collection of service keys found in the data file. - - - - - The publication date and time of the file that was downloaded and parsed. - - - - - Collection of all public IP ranges. - - - - - Filtered collection of public IP ranges for the given service key - - - - - Filtered collection of public IP ranges for the given region (us-east-1 etc) or GLOBAL. - - - - - Filtered collection of public IP ranges for the given network border group. - - - - - Downloads the most recent copy of the endpoint address file and - parses it to a collection of address range objects. - - - - - Downloads the most recent copy of the endpoint address file and - parses it to a collection of address range objects. - - - - - Represents the IP address range for a single region and service key. - - - - - The public IPv4 or Ipv6 address range, in CIDR notation. - - - - - Indicates ipv4 or v6 format of the address - - - - - The AWS region or GLOBAL for edge locations. Note that the CLOUDFRONT and ROUTE53 - ranges are GLOBAL. - - - - - The subset of IP address ranges. Specify AMAZON to get all IP address ranges - (for example, the ranges in the EC2 subset are also in the AMAZON subset). Note - that some IP address ranges are only in the AMAZON subset. - - - Valid values for the service key include "AMAZON", "EC2", "ROUTE53", - "ROUTE53_HEALTHCHECKS", and "CLOUDFRONT." If you need to know all of - the ranges and don't care about the service, use the "AMAZON" entries. - The other entries are subsets of this one. Also, some of the services, - such as S3, are represented in "AMAZON" and do not have an entry that - is specific to the service. We plan to add additional values over time; - code accordingly! - - - - - The network border group the IP address range belongs to. - - - AWS Local Zones allow you to seamlessly connect to the full range of services in the AWS Region such - as Amazon Simple Storage Service and Amazon DynamoDB through the same APIs and tool sets. You can extend - your VPC Region by creating a new subnet that has a Local Zone assignment. When you create a subnet in - a Local Zone, the VPC is also extended to that Local Zone. - - A network border group is a unique set of Availability Zones or Local Zones from where AWS advertises - public IP addresses. - - When you create a VPC that has IPv6 addresses, you can choose to assign a set of Amazon-provided public - IP addresses to the VPC and also set a network border group for the addresses that limits the addresses - to the group. When you set a network border group, the IP addresses cannot move between network - border groups. The us-west-2 network border group contains the four US West (Oregon) Availability Zones. - The us-west-2-lax-1 network border group contains the Los Angeles Local Zones. - - - - - This class defines utilities and constants that can be used by - all the client libraries of the SDK. - - - - - The user agent string header - - - - - The Set of accepted and valid Url characters per RFC3986. - Characters outside of this set will be encoded. - - - - - The Set of accepted and valid Url characters per RFC1738. - Characters outside of this set will be encoded. - - - - - The set of accepted and valid Url path characters per RFC3986. - - - - - The string representing Url Encoded Content in HTTP requests - - - - - The GMT Date Format string. Used when parsing date objects - - - - - The ISO8601Date Format string. Used when parsing date objects - - - - - The ISO8601Date Format string. Used when parsing date objects - - - - - The ISO8601 Basic date/time format string. Used when parsing date objects - - - - - The ISO8601 basic date format. Used during AWS4 signature computation. - - - - - The RFC822Date Format string. Used when parsing date objects - - - - - Returns an extension of a path. - This has the same behavior as System.IO.Path.GetExtension, but does not - check the path for invalid characters. - - - - - - Convert request parameters to Url encoded query string - - - Convert Dictionary of parameters to Url encoded query string - - - - Returns the canonicalized resource path for the service endpoint with single URL encoded path segments. - - Endpoint URL for the request - Resource path for the request - - If resourcePath begins or ends with slash, the resulting canonicalized - path will follow suit. - - Canonicalized resource path for the endpoint - - - - Returns the canonicalized resource path for the service endpoint - - Endpoint URL for the request - Resource path for the request - If true pre URL encode path segments if necessary. - S3 is currently the only service that does not expect pre URL encoded segments. - - If resourcePath begins or ends with slash, the resulting canonicalized - path will follow suit. - - Canonicalized resource path for the endpoint - - - - Returns the canonicalized resource path for the service endpoint - - Endpoint URL for the request - Resource path for the request - If true pre URL encode path segments if necessary. - S3 is currently the only service that does not expect pre URL encoded segments. - Dictionary of key/value parameters containing the values for the ResourcePath key replacements - The version of the marshaller that constructed the request object. - - If resourcePath begins or ends with slash, the resulting canonicalized - path will follow suit. - - Canonicalized resource path for the endpoint - - - - Splits the resourcePath at / into segments then resolves any keys with the path resource values. Greedy - key values will be split into multiple segments at each /. - - The patterned resourcePath - The key/value lookup for the patterned resourcePath - A list of path segments where all keys in the resourcePath have been resolved to one or more path segment values - - - - Joins all path segments with the / character and encodes each segment before joining. - - The segments of a URL path split at each / character - If the path property is specified, - the accepted path characters {/+:} are not encoded. - A joined URL with encoded segments - - - - Takes a patterned resource path and resolves it using the key/value path resources into - a segmented encoded URL. - - The patterned resourcePath - The key/value lookup for the patterned resourcePath - A segmented encoded URL - - - - Returns a new string created by joining each of the strings in the - specified list together, with a comma between them. - - The list of strings to join into a single, comma delimited - string list. - A new string created by joining each of the strings in the - specified list together, with a comma between strings. - - - - Attempt to infer the region for a service request based on the endpoint - - Endpoint to the service to be called - - Region parsed from the endpoint; DefaultRegion (or DefaultGovRegion) - if it cannot be determined/is not explicit - - - - - Attempt to infer the service name for a request (in short form, eg 'iam') from the - service endpoint. - - Endpoint to the service to be called - - Short-form name of the service parsed from the endpoint; empty string if it cannot - be determined - - - - - Utility method for converting Unix epoch seconds to DateTime structure. - - The number of seconds since January 1, 1970. - Converted DateTime structure - - - - Helper function to format a byte array into string - - The data blob to process - If true, returns hex digits in lower case form - String version of the data - - - - Calls a specific EventHandler in a background thread - - - - - - - - Parses a query string of a URL and returns the parameters as a string-to-string dictionary. - - - - - - - Utility method for converting a string to a MemoryStream. - - - - - - - Utility method for copy the contents of the source stream to the destination stream. - - - - - - - Utility method for copy the contents of the source stream to the destination stream. - - - - - - - - Formats the current date as a GMT timestamp - - A GMT formatted string representation - of the current date and time - - - - - Formats the current date as ISO 8601 timestamp - - An ISO 8601 formatted string representation - of the current date and time - - - - - Gets the ISO8601 formatted timestamp that is minutesFromNow - in the future. - - The number of minutes from the current instant - for which the timestamp is needed. - The ISO8601 formatted future timestamp. - - - - Formats the current date as ISO 8601 timestamp - - An ISO 8601 formatted string representation - of the current date and time - - - - - Gets the RFC822 formatted timestamp that is minutesFromNow - in the future. - - The number of minutes from the current instant - for which the timestamp is needed. - The ISO8601 formatted future timestamp. - - - - Determines whether the given string is an absolute path to a root. - - The hypothetical absolute path. - True if is an absolute path. - - - - Returns true if the path specified is relative to the current drive or working directory. - Returns false if the path is fixed to a specific drive or UNC path. This method does no - validation of the path (URIs will be returned as relative as a result). - - - Handles paths that use the alternate directory separator. It is a frequent mistake to - assume that rooted paths (Path.IsPathRooted) are not relative. This isn't the case. - "C:a" is drive relative- meaning that it will be resolved against the current directory - for C: (rooted, but relative). "C:\a" is rooted and not relative (the current directory - will not be used to modify the path). - - - - - True if the given character is a directory separator. - - - - - Returns true if the given character is a valid drive letter - - - - - URL encodes a string per RFC3986. If the path property is specified, - the accepted path characters {/+:} are not encoded. - - The string to encode - Whether the string is a URL path or not - The encoded string - - - - URL encodes a string per the specified RFC. If the path property is specified, - the accepted path characters {/+:} are not encoded. - - RFC number determing safe characters - The string to encode - Whether the string is a URL path or not - The encoded string - - Currently recognised RFC versions are 1738 (Dec '94) and 3986 (Jan '05). - If the specified RFC is not recognised, 3986 is used by default. - - - - - URL encodes a string per the specified RFC with the exception of preserving the encoding of previously encoded slashes. - If the path property is specified, the accepted path characters {/+:} are not encoded. - - The string to encode - Whether the string is a URL path or not - The encoded string with any previously encoded %2F preserved - - - - Convert bytes to a hex string - - Bytes to convert. - Hexadecimal string representing the byte array. - - - - Convert a hex string to bytes - - Hexadecimal string - Byte array corresponding to the hex string. - - - - Returns DateTime.UtcNow + ManualClockCorrection when - is set. - This value should be used instead of DateTime.UtcNow to factor in manual clock correction - - - - - Returns true if the string has any bidirectional control characters. - - - - - - - Executes an HTTP request and returns the response as a string. This method - throws WebException and HttpRequestException. In the event HttpRequestException - is thrown the StatusCode is sent as user defined data on the exception under - the key "StatusCode". - - The URI to make the request to - The request type: GET, PUT, POST - null or the content to send with the request - Timeout for the request - Proxy for the request - null or any headers to send with the request - The response as a string. - - - - Utility method that accepts a string and replaces white spaces with a space. - - - - - - - Class that contains result of executing an external process through the SDKs - AWSSDKUtils.RunProcess/AWSSDKUtils.RunProcessAsync - - - - - The exit code with which the process exited - - - - - The output of the process read till the end - - - - - The error output of the process read till the end - - - - - Object to track circular references in nested types. - At each level of nesting, make a call to Track to retrieve Tracker, - a tracking object implementing the IDisposable interface. - Dispose of this tracker when leaving the context of the tracked object. - - - - - Tracker. Must be disposed. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Adds the current target to a reference list and returns a tracker. - The tracker removes the target from the reference list when the - tracker is disposed. - - - - - - - Root AWS config - - - - - AwsHttpClient is a wrapper around HttpClient class of the System.Net.Http library. - The wrapper has been added so as to remove System.Net.Http dependencies from the Services - and migrate it to a Core level dependecy only. This avoids version clashes when a service - and the Core depends on different versions of the System.Net.Http library. This is a Service - level utility method - - - - - AWSHttpClient wrapper that is wrapped around - HttpClient default wrapper. - - - - - AWSHttpClient BaseAddress property that is wrapper for - HttpClient BaseAddress property. - - - - - AWSHttpClient Timeout property that is wrapper for - HttpClient Timeout property. - - - - - AWSHttpClient MaxResponseContentBufferSize property that is wrapper for - HttpClient MaxResponseContentBufferSize property. - - - - - AWSHttpClient GetStreamAsync that accepts the requester's URI - and make a HttpClient.GetStreamAsync call. - - Requester Uri - - - - Wrapper method that accepts a request uri, stream content and headers and makes a sendAsync call. - - - - - - - Wrapper for HttpClient's HttpRequestMessage and SendAsync methods. - - - - Returns response headers information- header name,value and status code - - - - Wrapper for HttpClient Dispose. - - - - - Method that checks if the passed exception is of type - HttpRequestException - - - - - - - AWSStreamContent is a wrapper for StreamContent class in - the System.Net.Http library.The wrapper has been added so as to - remove System.Net.Http dependencies from the Services - and migrate it to a Core level dependecy only. This avoids version clashes when a service - and the Core depends on different versions of the System.Net.Http library. This is a Service - level utility method - - - - - Wrapper for StreamContent constructor - for stream content - - - - - - Wrapper for StreamContent constructor - for stream content and bufferSize - - - - - - - Wrapper to allow Services to remove StreamContent Headers - - - - - - - Wrapper to allow Services to add StreamContent Headers - - - - - - - Wrapper for StreamContent Dispose. - - - - - Allows to configure the proxy used for HTTP requests. The default value is null. - - - - - This class contains the endpoints available to the AWS clients. The static constants representing the - regions can be used while constructing the AWS client instead of looking up the exact endpoint URL. - - - - - Gets the endpoint for a service in a region. - - The services system name. - If true returns the endpoint for dualstack - Thrown when the request service does not have a valid endpoint in the region. - - - - - Enumerate through all the regions. - - - - - Gets the region based on its system name like "us-west-1" - - The system name of the service like "us-west-1" - - - - - This is a testing method and should not be called by production applications. - - - - - Gets the system name of a region. - - - - - Gets the display name of a region. - - - - - This region name is non-standard. Search the whole endpoints.json file to - determine the partition this region is in. - - - - - This class contains region information used to lazily compute the service endpoints. The static constants representing the - regions can be used while constructing the AWS client instead of looking up the exact endpoint URL. - - - - - The US East (Virginia) endpoint. - - - - - The US East (Virginia) regional endpoint. - - - - - The US East (Ohio) endpoint. - - - - - The US West (N. California) endpoint. - - - - - The US West (Oregon) endpoint. - - - - - The EU North (Stockholm) endpoint. - - - - - The EU West (Ireland) endpoint. - - - - - The EU West (London) endpoint. - - - - - The EU West (Paris) endpoint. - - - - - The EU Central (Frankfurt) endpoint. - - - - - The Europe (Milan) endpoint. - - - - - The Asia Pacific (Hong Kong) endpoint. - - - - - The Asia Pacific (Tokyo) endpoint. - - - - - The Asia Pacific (Seoul) endpoint. - - - - - The Asia Pacific (Osaka-Local) endpoint. - - - - - The Asia Pacific (Mumbai) endpoint. - - - - - The Asia Pacific (Singapore) endpoint. - - - - - The Asia Pacific (Sydney) endpoint. - - - - - The South America (Sao Paulo) endpoint. - - - - - The US GovCloud East (Virginia) endpoint. - - - - - The US GovCloud West (Oregon) endpoint. - - - - - The China (Beijing) endpoint. - - - - - The China (Ningxia) endpoint. - - - - - The Canada (Central) endpoint. - - - - - The Middle East (Bahrain) endpoint. - - - - - The Africa (Cape Town) endpoint. - - - - - Represents the endpoint overridding rules in the endpoints.json - Is used to map private region (ie us-east-1-regional) to public regions (us-east-1) - For signing purposes. - - - - - Enumerate through all the regions. - - - - - Gets the region based on its system name like "us-west-1" - - The system name of the service like "us-west-1" - - - - - Gets the region endpoint override if exists - - The region endpoint to find the possible override for - - - - - Gets the system name of a region. - - - - - Gets the display name of a region. - - - - - Gets the partition name the region is in. For example for us-east-1 the partition name is aws. For cn-northwest-1 the partition name is aws-cn. - - - - - Gets the dns suffix for the region endpoints in a partition. For example the aws partition's suffix is amazonaws.com. The aws-cn partition's suffix is amazonaws.com.cn. - - - - - Gets the endpoint for a service in a region. - - - The services system name. Service system names can be obtained from the - RegionEndpointServiceName member of the ClientConfig-derived class for the service. - - - For forwards compatibility, if the service being requested for isn't known in the region, this method - will generate an endpoint using the AWS endpoint heuristics. In this case, it is not guaranteed the - endpoint will point to a valid service endpoint. - - - - - - Gets the endpoint for a service in a region, optionally selecting a dualstack compatible endpoint. - - - The services system name. Service system names can be obtained from the - RegionEndpointServiceName member of the ClientConfig-derived class for the service. - - - If true a dualstack endpoint is returned. It is the user's responsibility to verify that the given service - supports a dualstack endpoint for the region. - - - For forwards compatibility, if the service being requested for isn't known in the region, this method - will generate an endpoint using the AWS endpoint heuristics. In this case, it is not guaranteed the - endpoint will point to a valid service endpoint. - - - - - - This class defines an endpoints hostname and which protocols it supports. - - - - - Gets the hostname for the service. - - - - - The authentication region to be used in request signing. - - - - - This property is only set for S3 endpoints. For all other services this property returns null. - For S3 endpoints, if the endpoint supports signature version 2 this property will be "2", otherwise it will be "4". - - - - - Calculates a 32bit Cyclic Redundancy Checksum (CRC) using the - same polynomial used by Zip. This type is used internally by DotNetZip; it is generally not used directly - by applications wishing to create, read, or manipulate zip archive files. - - - - - indicates the total number of bytes read on the CRC stream. - This is used when writing the ZipDirEntry when compressing files. - - - - - Indicates the current CRC for all blocks slurped in. - - - - - Returns the CRC32 for the specified stream. - - The stream over which to calculate the CRC32 - the CRC32 calculation - - - - Returns the CRC32 for the specified stream, and writes the input into the output stream. - - The stream over which to calculate the CRC32 - The stream into which to deflate the input - the CRC32 calculation - - - - Get the CRC32 for the given (word,byte) combo. - This is a computation defined by PKzip. - - The word to start with. - The byte to combine it with. - The CRC-ized result. - - - - Update the value for the running CRC32 using the given block of bytes. - This is useful when using the CRC32() class in a Stream. - - block of bytes to slurp - starting point in the block - how many bytes within the block to slurp - - - - A Stream that calculates a CRC32 (a checksum) on all bytes read, - or on all bytes written. - - - - - This class can be used to verify the CRC of a ZipEntry when reading from a stream, - or to calculate a CRC when writing to a stream. The stream should be used to either - read, or write, but not both. If you intermix reads and writes, the results are - not defined. - - This class is intended primarily for use internally by the DotNetZip library. - - - - - Gets the total number of bytes run through the CRC32 calculator. - - - - This is either the total number of bytes read, or the total number - of bytes written, depending on the direction of this stream. - - - - - The constructor. - - The underlying stream - - - - The constructor. - - The underlying stream - The length of the stream to slurp - - - - Provides the current CRC for all blocks slurped in. - - - - - Read from the stream - - the buffer to read - the offset at which to start - the number of bytes to read - the number of bytes actually read - - - - Write to the stream. - - the buffer from which to write - the offset at which to start writing - the number of bytes to write - - - - Indicates whether the stream supports reading. - - - - - Indicates whether the stream supports seeking. - - - - - Indicates whether the stream supports writing. - - - - - Flush the stream. - - - - - Not implemented. - - - - - Not implemented. - - - - - Not implemented. - - N/A - N/A - N/A - - - - Not implemented. - - N/A - - - diff --git a/packages/AWSSDK.Core.3.3.107.14/lib/Xamarin.Mac20/AWSSDK.Core.dll b/packages/AWSSDK.Core.3.3.107.14/lib/Xamarin.Mac20/AWSSDK.Core.dll deleted file mode 100644 index 0921366..0000000 Binary files a/packages/AWSSDK.Core.3.3.107.14/lib/Xamarin.Mac20/AWSSDK.Core.dll and /dev/null differ diff --git a/packages/AWSSDK.Core.3.3.107.14/lib/Xamarin.iOS10/AWSSDK.Core.XML b/packages/AWSSDK.Core.3.3.107.14/lib/Xamarin.iOS10/AWSSDK.Core.XML deleted file mode 100644 index 2b1ead4..0000000 --- a/packages/AWSSDK.Core.3.3.107.14/lib/Xamarin.iOS10/AWSSDK.Core.XML +++ /dev/null @@ -1,10850 +0,0 @@ - - - - AWSSDK.Core - - - - - Utility class to parse Amazon resource names more commonly known as an ARN. - - - - - Gets and sets the partition associated with the ARN (e.g.: 'aws'). - - - - - Gets and sets the AWS service associated with the ARN (e.g.: 's3'). - - - - - Gets and sets the region associated with the ARN (e.g.: 'us-east-1'). - - - - - Gets and sets the account ID associated with the ARN. - - - - - Gets and sets the resource associated with the ARN (e.g.: 'mybucket/myobject'). - - - - - Returns true if the string appears to be an ARN by seeing if the string starts with "arn:". This method - doesn't guarantee the string is a valid ARN. To validate the string call TryParse. - - - - - - - Parses the string into an ARN object. - - String to parse into an ARN. - The out parameter for the ARN object created by TryParse. - True if the string was parsed into an ARN object. - - - - Parses the string into an ARN object. - - String to parse into an Arn. - The Arn object created from the passed in string. - Thrown if arnString is null. - Thrown if the string passed in not valid ARN. - - - - Turns the Arn object into a string representation of an ARN. - - - - - - Configuration options that apply to the entire SDK. - - These settings can be configured through app.config or web.config. - Below is a full sample configuration that illustrates all the possible options. - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws region="us-west-2"> - <logging logTo="Log4Net, SystemDiagnostics" logResponses="Always" logMetrics="true" /> - <s3 useSignatureVersion4="true" /> - <proxy host="localhost" port="8888" username="1" password="1" /> - - <dynamoDB> - <dynamoDBContext tableNamePrefix="Prod-"> - - <tableAliases> - <alias fromTable="FakeTable" toTable="People" /> - <alias fromTable="Persons" toTable="People" /> - </tableAliases> - - <mappings> - <map type="Sample.Tests.Author, SampleDLL" targetTable="People" /> - <map type="Sample.Tests.Editor, SampleDLL" targetTable="People"> - <property name="FullName" attribute="Name" /> - <property name="EmployeeId" attribute="Id" /> - <property name="ComplexData" converter="Sample.Tests.ComplexDataConverter, SampleDLL" /> - <property name="Version" version="true" /> - <property name="Password" ignore="true" /> - </map> - </mappings> - - </dynamoDBContext> - </dynamoDB> - </aws> - - - - Configuration options that apply to the entire SDK. - - - - - Manual offset to apply to client clock. This is a global setting that overrides - ClockOffset value calculated for all service endpoints. - - - - - Determines if the SDK should correct for client clock skew - by determining the correct server time and reissuing the - request with the correct time. - Default value of this field is True. - will be updated with the calculated - offset even if this field is set to false, though requests - will not be corrected or retried. - Ignored if is set. - - - - - The calculated clock skew correction, if there is one. - This field will be set if a service call resulted in an exception - and the SDK has determined that there is a difference between local - and server times. - - If is set to true, this - value will be set to the correction, but it will not be used by the - SDK and clock skew errors will not be retried. - - - - - Key for the AWSRegion property. - - - - - - Configures the default AWS region for clients which have not explicitly specified a region. - Changes to this setting will only take effect for newly constructed instances of AWS clients. - - This setting can be configured through the App.config. For example: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws region="us-west-2" /> - - - - - - Key for the AWSProfileName property. - - - - - - Profile name for stored AWS credentials that will be used to make service calls. - Changes to this setting will only take effect in newly-constructed clients. - - To reference the account from an application's App.config or Web.config use the AWSProfileName setting. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="development"/> - </appSettings> - </configuration> - - - - - - - Key for the AWSProfilesLocation property. - - - - - - Location of the credentials file shared with other AWS SDKs. - By default, the credentials file is stored in the .aws directory in the current user's home directory. - - Changes to this setting will only take effect in newly-constructed clients. - - To reference the profile from an application's App.config or Web.config use the AWSProfileName setting. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfilesLocation" value="c:\config"/> - </appSettings> - </configuration> - - - - - - - Key for the Logging property. - - - - - - Configures how the SDK should log events, if at all. - Changes to this setting will only take effect in newly-constructed clients. - - The setting can be configured through App.config, for example: - - <appSettings> - <add key="AWSLogging" value="log4net"/> - </appSettings> - - - - - - Key for the ResponseLogging property. - - - - - - - Configures when the SDK should log service responses. - Changes to this setting will take effect immediately. - - The setting can be configured through App.config, for example: - - <appSettings> - <add key="AWSResponseLogging" value="OnError"/> - </appSettings> - - - - - - Key for the LogMetrics property. - - - - - - Configures if the SDK should log performance metrics. - This setting configures the default LogMetrics property for all clients/configs. - Changes to this setting will only take effect in newly-constructed clients. - - The setting can be configured through App.config, for example: - - <appSettings> - <add key="AWSLogMetrics" value="true"/> - </appSettings> - - - - - - Key for the EndpointDefinition property. - - - - - - Configures if the SDK should use a custom configuration file that defines the regions and endpoints. - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws endpointDefinition="c:\config\endpoints.json" /> - - - - - - Key for the UseSdkCache property. - - - - - - Configures if the SDK Cache should be used, the default value is true. - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws useSdkCache="true" /> - - - - - - Configuration for the Logging section of AWS configuration. - Changes to some settings may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws> - <logging logTo="Log4Net, SystemDiagnostics" logResponses="Always" logMetrics="true" /> - </aws> - - - - - - Configuration for the Proxy section of AWS configuration. - Changes to some settings may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws> - <proxy host="localhost" port="8888" username="1" password="1" bypassList="addressexpr1;addressexpr2;..." bypassOnLocal="true" /> - </aws> - - - - - - Configuration for the region endpoint section of AWS configuration. - Changes may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws region="us-west-2" /> - - - - - - Lock for SomeEvent delegate access. - - - - - This method should never be called directly. - Call AWSSDKUtils.CorrectedUtcNow instead. - - - - - - Logging options. - Can be combined to enable multiple loggers. - - - - - No logging - - - - - Log using log4net - - - - - Log using System.Diagnostics - - - - - Log to the console - - - - - Log to a file - - - - - Response logging option. - - - - - Never log service response - - - - - Only log service response when there's an error - - - - - Always log service response - - - - - Format for metrics data in the logs - - - - - Emit metrics in human-readable format - - - - - Emit metrics as JSON data - - - - - An access control policy action identifies a specific action in a service - that can be performed on a resource. For example, sending a message to a - queue. - - ActionIdentifiers allow you to limit what your access control policy statement affects. - For example, you could create a policy statement that enables a certain group - of users to send messages to your queue, but not allow them to perform any - other actions on your queue. - - - The action is B in the statement - "A has permission to do B to C where D applies." - - Free form access control policy actions may include a wildcard (*) to match - multiple actions. - - - Constants for known actions can be found in the Amazon.Auth.AccessControlPolicy.ActionIdentifiers namespace. - - - - - - Constructs an Actionidentifer with the given action name. - - The name of the action - - - - Gets and sets the name of this action. For example, 'sqs:SendMessage' is the - name corresponding to the SQS action that enables users to send a message - to an SQS queue. - - - - - AWS access control policy conditions are contained in - objects, and affect when a statement is applied. For example, a statement - that allows access to an Amazon SQS queue could use a condition to only apply - the effect of that statement for requests that are made before a certain - date, or that originate from a range of IP addresses. - - Multiple conditions can be included in a single statement, and all conditions - must evaluate to true in order for the statement to take effect. - - - The set of conditions is D in the statement - "A has permission to do B to C where D applies." - - - A condition is composed of three parts: - - - Condition Key - The condition key declares which value of a - request to pull in and compare against when a policy is evaluated by AWS. For - example, using will cause - AWS to pull in the current request's source IP as the first value to compare - against every time your policy is evaluated. - - - - Comparison Type - This is a static value used as the second value - in the comparison when your policy is evaluated. Depending on the comparison - type, this value can optionally use wildcards. See the documentation for - individual comparison types for more information. - - - - Comparison Value - This is a static value used as the second value - in the comparison when your policy is evaluated. Depending on the comparison - type, this value can optionally use wildcards. See the documentation for - individual comparison types for more information. - - - - - - - - - Gets the type of this condition. - - - - - Gets and Sets the name of the condition key involved in this condition. - Condition keys are predefined values supported by AWS that provide input - to a condition's evaluation, such as the current time, or the IP address - of the incoming request. - - Your policy is evaluated for each incoming request, and condition keys - specify what information to pull out of those incoming requests and plug - into the conditions in your policy. - - - - - - Gets and Sets the values specified for this access control policy condition. - For example, in a condition that compares the incoming IP address of a - request to a specified range of IP addresses, the range of IP addresses - is the single value in the condition. - - Most conditions accept only one value, but multiple values are possible. - - - - - - A factory for creating conditions to be used in the policy. - - - - - Condition key for the current time. - - This condition key should only be used with enum. - - - - - - Condition key for whether or not an incoming request is using a secure - transport to make the request (i.e. HTTPS instead of HTTP). - - This condition key should only be used with the boolean overload of NewCondition. - - - - - - Condition key for the source IP from which a request originates. - - This condition key should only be used with enum. - - - - - - Condition key for the user agent included in a request. - - This condition key should only be used with - enum. - - - - - - Condition key for the current time, in epoch seconds. - - This condition key should only be used with enum. - objects. - - - - - - Condition key for the referrer specified by a request. - - This condition key should only be used with - objects. - - - - - - Condition key for the Amazon Resource Name (ARN) of the source specified - in a request. The source ARN indicates which resource is affecting the - resource listed in your policy. For example, an SNS topic is the source - ARN when publishing messages from the topic to an SQS queue. - - This condition key should only be used with enum. - - - - - - Enumeration of the supported ways an ARN comparison can be evaluated. - - - - Exact matching - - - - Loose case-insensitive matching of the ARN. Each of the six - colon-delimited components of the ARN is checked separately and each - can include a multi-character match wildcard (*) or a - single-character match wildcard (?). - - - - Negated form of ArnEquals - - - Negated form of ArnLike - - - - Enumeration of the supported ways a date comparison can be evaluated. - - - - - Enumeration of the supported ways an IP address comparison can be evaluated. - - - - - Matches an IP address against a CIDR IP range, evaluating to true if - the IP address being tested is in the condition's specified CIDR IP - range. - - - - - Negated form of IpAddress - - - - - Enumeration of the supported ways a numeric comparison can be evaluated - - - - - Enumeration of the supported ways a string comparison can be evaluated. - - - - - Case-sensitive exact string matching - - - - - Case-insensitive string matching - - - - - Loose case-insensitive matching. The values can include a - multi-character match wildcard (*) or a single-character match - wildcard (?) anywhere in the string. - - - - - Negated form of StringEquals. - - - - - Negated form of StringEqualsIgnorecase. - - - - - Negated form of StringLike. - - - - - Constructs a new access control policy condition that compares ARNs (Amazon Resource Names). - - The access policy condition key specifying where to get the first ARN for the comparison - The type of comparison to perform. - The second ARN to compare against. When using ArnLike or ArnNotLike this may contain the - multi-character wildcard (*) or the single-character wildcard - - - - Constructs a new access policy condition that performs a boolean - comparison. - - The access policy condition key specifying where to get the - first boolean value for the comparison (ex: aws:SecureTransport). - The boolean to compare against. - - - - This method is deprecated. Invoking this method results in non-UTC DateTimes - not being marshalled correctly. Use NewConditionUtc instead. - Constructs a new access policy condition that compares the current time - (on the AWS servers) to the specified date. - - The type of comparison to perform. For example, - DateComparisonType.DateLessThan will cause this policy - condition to evaluate to true if the current date is less than - the date specified in the second argument. - The date to compare against. - - - - Constructs a new access policy condition that compares the current time - (on the AWS servers) to the specified date. - - The type of comparison to perform. For example, - DateComparisonType.DateLessThan will cause this policy - condition to evaluate to true if the current date is less than - the date specified in the second argument. - The date to compare against. - - - - Constructs a new access policy condition that compares the source IP - address of the incoming request to an AWS service against the specified - CIDR range. The condition evaluates to true (meaning the policy statement - containing it will be applied) if the incoming source IP address is - within that range. - - To achieve the opposite effect (i.e. cause the condition to evaluate to - true when the incoming source IP is not in the specified CIDR - range) use the alternate constructor form and specify - IpAddressComparisonType.NotIpAddress. - - - The CIDR IP range involved in the policy condition. - - - - Constructs a new access policy condition that compares the source IP - address of the incoming request to an AWS service against the specified - CIDR range. When the condition evaluates to true (i.e. when the incoming - source IP address is within the CIDR range or not) depends on the - specified IpAddressComparisonType. - - The type of comparison to to perform. - The CIDR IP range involved in the policy condition. - - - - Constructs a new access policy condition that compares two numbers. - - The type of comparison to perform. - The access policy condition key specifying where to get the - first number for the comparison. - The second number to compare against. - - - - Constructs a new access control policy condition that compares two - strings. - - The type of comparison to perform - The access policy condition key specifying where to get the - first string for the comparison (ex: aws:UserAgent). - - The second string to compare against. When using - StringComparisonType.StringLike or - StringComparisonType.StringNotLike this may contain - the multi-character wildcard (*) or the single-character - wildcard (?). - - - - - Constructs a new access policy condition that compares the Amazon - Resource Name (ARN) of the source of an AWS resource that is modifying - another AWS resource with the specified pattern. - - For example, the source ARN could be an Amazon SNS topic ARN that is - sending messages to an Amazon SQS queue. In that case, the SNS topic ARN - would be compared the ARN pattern specified here. - - - The endpoint pattern may optionally contain the multi-character wildcard - * (*) or the single-character wildcard (?). Each of the six colon-delimited - components of the ARN is checked separately and each can include a - wildcard. - - - Policy policy = new Policy("MyQueuePolicy"); - policy.WithStatements(new Statement(Statement.StatementEffect.Allow) - .WithPrincipals(new Principal("*")).WithActionIdentifiers(SQSActionIdentifiers.SendMessage) - .WithResources(new Resource(myQueueArn)) - .WithConditions(ConditionFactory.NewSourceArnCondition(myTopicArn))); - - - The ARN pattern against which the source ARN will be compared. - Each of the six colon-delimited components of the ARN is - checked separately and each can include a wildcard. - A new access control policy condition that compares the ARN of - the source specified in an incoming request with the ARN pattern - specified here. - - - - Constructs a new access control policy condition that tests if the - incoming request was sent over a secure transport (HTTPS). - - A new access control policy condition that tests if the incoming - request was sent over a secure transport (HTTPS). - - - - Condition key for the canned ACL specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the location constraint specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the prefix specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the delimiter specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the max keys specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the source object specified by a request to copy an - object. - - This condition key may only be used with enum. - - - - - - Condition key for the metadata directive specified by a request to copy - an object. - - This condition key may only be used with enum. - - - - - - Condition key for the version ID of an object version specified by a - request. - - This condition key may only be used with enum. - - - - - - Constructs a new access policy condition that compares an Amazon S3 - canned ACL with the canned ACL specified by an incoming request. - - You can use this condition to ensure that any objects uploaded to an - Amazon S3 bucket have a specific canned ACL set. - - - The Amazon S3 canned ACL to compare against. - A new access control policy condition that compares the Amazon S3 - canned ACL specified in incoming requests against the value - specified. - - - - Condition key for The URL, e-mail address, or ARN from a Subscribe - request or a previously confirmed subscription. Use with string - conditions to restrict access to specific endpoints (e.g., - *@mycompany.com). - - This condition key may only be used with enum. - - - - - - Condition key for the protocol value from a Subscribe request or a - previously confirmed subscription. Use with string conditions to restrict - publication to specific delivery protocols (e.g., HTTPS). - - This condition key may only be used with enum. - - - - - - Constructs a new access policy condition that compares the requested - endpoint used to subscribe to an Amazon SNS topic with the specified - endpoint pattern. The endpoint pattern may optionally contain the - multi-character wildcard (*) or the single-character wildcard (?). - - For example, this condition can restrict subscriptions to a topic to - email addresses in a certain domain ("*@my-company.com"). - - - Policy policy = new Policy("MyTopicPolicy"); - policy.WithStatements(new Statement(Statement.StatementEffect.Allow) - .WithPrincipals(new Principal("*")).WithActionIdentifiers(SNSActionIdentifiers.Subscribe) - .WithResources(new Resource(myTopicArn)) - .WithConditions(ConditionFactory.NewEndpointCondition("*@my-company.com"))); - - - The endpoint pattern against which to compare the requested - endpoint for an Amazon SNS topic subscription. - A new access control policy condition that compares the endpoint - used in a request to subscribe to an Amazon SNS topic with the - endpoint pattern specified. - - - - Constructs a new AWS access control policy condition that allows an - access control statement to restrict subscriptions to an Amazon SNS topic - based on the protocol being used for the subscription. For example, this - condition can restrict subscriptions to a topic to endpoints using HTTPS - to ensure that messages are securely delivered. - - The protocol against which to compare the requested protocol - for an Amazon SNS topic subscription. - A new access control policy condition that compares the - notification protocol requested in a request to subscribe to an - Amazon SNS topic with the protocol value specified. - - - - An AWS access control policy is a object that acts as a container for one or - more statements, which specify fine grained rules for allowing or denying - various types of actions from being performed on your AWS resources. - - By default, all requests to use your resource coming from anyone but you are - denied. Access control polices can override that by allowing different types - of access to your resources, or by explicitly denying different types of - access. - - - Each statement in an AWS access control policy takes the form: - "A has permission to do B to C where D applies". - - - A is the prinicpal - The AWS account that is making a request to - access or modify one of your AWS resources. - - - - B is the action - the way in which your AWS resource is being accessed or modified, such - as sending a message to an Amazon SQS queue, or storing an object in an Amazon S3 bucket. - - - - C is the resource - your AWS entity that the principal wants to access, such - as an Amazon SQS queue, or an object stored in Amazon S3. - - - - D is the set of conditions - optional constraints that specify when to allow or deny - access for the principal to access your resource. Many expressive conditions are available, - some specific to each service. For example you can use date conditions to allow access to - your resources only after or before a specific time. - - - - - - Note that an AWS access control policy should not be confused with the - similarly named "POST form policy" concept used in Amazon S3. - - - - - - The default policy version - - - - - Constructs an empty AWS access control policy ready to be populated with - statements. - - - - - Constructs a new AWS access control policy with the specified policy ID. - The policy ID is a user specified string that serves to help developers - keep track of multiple polices. Policy IDs are often used as a human - readable name for a policy. - - The policy ID for the new policy object. Policy IDs serve to - help developers keep track of multiple policies, and are often - used to give the policy a meaningful, human readable name. - - - - Constructs a new AWS access control policy with the specified policy ID - and collection of statements. The policy ID is a user specified string - that serves to help developers keep track of multiple polices. Policy IDs - are often used as a human readable name for a policy. - - The policy ID for the new policy object. Policy IDs serve to - help developers keep track of multiple policies, and are often - used to give the policy a meaningful, human readable name. - The statements to include in the new policy. - - - - Gets and Sets the policy ID for this policy. Policy IDs serve to help - developers keep track of multiple policies, and are often used as human - readable name for a policy. - - - - - Sets the policy ID for this policy and returns the updated policy so that - multiple calls can be chained together. - - Policy IDs serve to help developers keep track of multiple policies, and - are often used as human readable name for a policy. - - - The polich ID for this policy - this instance - - - - Gets and sets the version of this AWS policy. - - - - - Gets and Sets the collection of statements contained by this policy. Individual - statements in a policy are what specify the rules that enable or disable - access to your AWS resources. - - - - - Checks to see if the permissions set in the statement are already set by another - statement in the policy. - - The statement to verify - True if the statement's permissions are already allowed by the statement - - - - Sets the collection of statements contained by this policy and returns - this policy object so that additional method calls can be chained - together. - - Individual statements in a policy are what specify the rules that enable - or disable access to your AWS resources. - - - The collection of statements included in this policy. - this instance - - - - Returns a JSON string representation of this AWS access control policy, - suitable to be sent to an AWS service as part of a request to set an - access control policy. - - A JSON string representation of this AWS access control policy. - - - - Returns a JSON string representation of this AWS access control policy, - suitable to be sent to an AWS service as part of a request to set an - access control policy. - - Toggle pretty print for the generated JSON document - A JSON string representation of this AWS access control policy. - - - - Parses a JSON document of a policy and creates a Policy object. - - JSON document of a policy. - - - - - A principal is an AWS account which is being allowed or denied access to a - resource through an access control policy. The principal is a property of the - Statement object, not directly the object. - - The principal is A in the statement - "A has permission to do B to C where D applies." - - - In an access control policy statement, you can set the principal to all - authenticated AWS users through the member. This - is useful when you don't want to restrict access based on the identity of the - requester, but instead on other identifying characteristics such as the - requester's IP address. - - - - - - Principal instance that includes all authenticated AWS users. - - This is useful when you don't want to restrict access based on the - identity of the requester, but instead on other identifying - characteristics such as the requester's IP address. - - - - - - The anonymous Principal. - - - - - The default Principal provider for AWS accounts. - - - - - Principal provider for Canonical User IDs. - - - - - Principal provider for federated users (using a SAML identity provider) - - - - - Principal provider for assume role policies that will be assumed by an AWS service - (e.g. "ec2.amazonaws.com"). - - - - - Dummy principal provider for anonynous. - - - - - Constructs a new principal with the specified AWS account ID. - - An AWS account ID. - - - - Constructs a new principal with the specified provider and id - - The provider of the principal - The unique ID of the Principal within the provider - - - - Constructs a new principal with the specified provider and id - and optionally strips hyphens from the id - - The provider of the principal - The unique ID of the Principal within the provider - Strip hyphen - - - - Gets and sets the provider for this principal, which indicates in what group of - users this principal resides. - - - - - Gets the unique ID for this principal. - - - - - Represents a resource involved in an AWS access control policy statement. - Resources are the service specific AWS entities owned by your account. Amazon - SQS queues, Amazon S3 buckets and objects, and Amazon SNS topics are all - examples of AWS resources. - - The standard way of specifying an AWS resource is with an Amazon Resource - Name (ARN). - - - The resource is C in the statement - "A has permission to do B to C where D applies." - - - - - - Constructs a new AWS access control policy resource. Resources are - typically specified as Amazon Resource Names (ARNs). - - You specify the resource using the following Amazon Resource Name (ARN) - format: arn:aws:<vendor>:<region>:<namespace>:<relative-id> - - - >vendor identifies the AWS product (e.g., sns) - - - region is the AWS Region the resource resides in (e.g., us-east-1), if any - - - namespace is the AWS account ID with no hyphens (e.g., 123456789012) - - - relative-id is the service specific portion that identifies the specific resource - - - - - For example, an Amazon SQS queue might be addressed with the following - ARN: arn:aws:sqs:us-east-1:987654321000:MyQueue - - - Some resources may not use every field in an ARN. For example, resources - in Amazon S3 are global, so they omit the region field: - arn:aws:s3:::bucket/* - - - The Amazon Resource Name (ARN) uniquely identifying the desired AWS resource. - - - - Gets the resource ID, typically an Amazon Resource Name (ARN), - identifying this resource. - - - - - A factory for creating resources to be used in the policy. - - - - - Constructs a new bucket resource that represents the the specified bucket - but not any of the contained objects. - - The name of the bucket represented by this AWS access control - policy resource. - - - - Constructs a new object resource that represents the specified objects. - The keyPattern argument may contain the '*' wildcard to match multiple - objects. For example, an object resource created for bucket 'mybucket' - and key pattern 'foo*' will match any object stored in 'mybucket' with a - key that starts with 'foo'. - - The name of the bucket containing the object or objects - represented by this resource. - The key or key pattern, which can optionally contain the '*' - wildcard to include multiple objects in the resource. - - - - Constructs a new SQS queue resource for an access control policy. A - policy statement using this resource will allow or deny actions on the - specified queue. - - The AWS account ID of the queue owner. - The name of the Amazon SQS queue. - - - - A statement is the formal description of a single permission, and is always - contained within a policy object. - - A statement describes a rule for allowing or denying access to a specific AWS - resource based on how the resource is being accessed, and who is attempting - to access the resource. Statements can also optionally contain a list of - conditions that specify when a statement is to be honored. - - - For example, consider a statement that: - - - A is the prinicpal - The AWS account that is making a request to - access or modify one of your AWS resources. - - - - B is the action - the way in which your AWS resource is being accessed or modified, such - as sending a message to an Amazon SQS queue, or storing an object in an Amazon S3 bucket. - - - - C is the resource - your AWS entity that the principal wants to access, such - as an Amazon SQS queue, or an object stored in Amazon S3. - - - - D is the set of conditions - optional constraints that specify when to allow or deny - access for the principal to access your resource. Many expressive conditions are available, - some specific to each service. For example you can use date conditions to allow access to - your resources only after or before a specific time. - - - - - - There are many resources and conditions available for use in statements, and - you can combine them to form fine grained custom access control polices. - - - - - - The effect is the result that you want a policy statement to return at - evaluation time. A policy statement can either allow access or explicitly - deny access. - - - - - Constructs a new access control policy statement with the specified - effect. - - Before a statement is valid and can be sent to AWS, callers must set the - principals, resources, and actions (as well as any optional conditions) - involved in the statement. - - - The effect this statement has (allowing access or denying - access) when all conditions, resources, principals, and - actions are matched. - - - - Gets and Sets the ID for this statement. Statement IDs serve to help keep track - of multiple statements, and are often used to give the statement a - meaningful, human readable name. - - Developers should be careful to not use the same statement ID for - multiple statements in the same policy. Reusing the same statement ID in - different policies is not a problem. - - - - - - Sets the ID for this statement and returns the updated statement so - multiple calls can be chained together. - - Statement IDs serve to help keep track of multiple statements, and are - often used to give the statement a meaningful, human readable name. - - - Developers should be careful to not use the same statement ID for - multiple statements in the same policy. Reusing the same statement ID in - different policies is not a problem. - - - The new statement ID for this statement. - this instance - - - - Gets and Sets the result effect of this policy statement when it is evaluated. - A policy statement can either allow access or explicitly - - - - - Gets and Sets the list of actions to which this policy statement applies. - Actions limit a policy statement to specific service operations that are - being allowed or denied by the policy statement. For example, you might - want to allow any AWS user to post messages to your SQS queue using the - SendMessage action, but you don't want to allow those users other actions - such as ReceiveMessage or DeleteQueue. - - - - - Sets the list of actions to which this policy statement applies and - returns this updated Statement object so that additional method calls can - be chained together. - - Actions limit a policy statement to specific service operations that are - being allowed or denied by the policy statement. For example, you might - want to allow any AWS user to post messages to your SQS queue using the - SendMessage action, but you don't want to allow those users other actions - such as ReceiveMessage or DeleteQueue. - - - The list of actions to which this statement applies. - this instance - - - - Gets and Sets the resources associated with this policy statement. Resources - are what a policy statement is allowing or denying access to, such as an - Amazon SQS queue or an Amazon SNS topic. - - Note that some services allow only one resource to be specified per - policy statement. - - - - - - Sets the resources associated with this policy statement and returns this - updated Statement object so that additional method calls can be chained - together. - - Resources are what a policy statement is allowing or denying access to, - such as an Amazon SQS queue or an Amazon SNS topic. - - - Note that some services allow only one resource to be specified per - policy statement. - - - The resources associated with this policy statement. - this instance - - - - Gets and Sets the conditions associated with this policy statement. Conditions - allow policy statements to be conditionally evaluated based on the many - available condition types. - - For example, a statement that allows access to an Amazon SQS queue could - use a condition to only apply the effect of that statement for requests - that are made before a certain date, or that originate from a range of IP - addresses. - - - When multiple conditions are included in a single statement, all - conditions must evaluate to true in order for the statement to take - effect. - - - - - - Sets the conditions associated with this policy statement, and returns - this updated Statement object so that additional method calls can be - chained together. - - Conditions allow policy statements to be conditionally evaluated based on - the many available condition types. - - - For example, a statement that allows access to an Amazon SQS queue could - use a condition to only apply the effect of that statement for requests - that are made before a certain date, or that originate from a range of IP - addresses. - - - Multiple conditions can be included in a single statement, and all - conditions must evaluate to true in order for the statement to take - effect. - - - The conditions associated with this policy statement. - this instance - - - - Gets and Sets the principals associated with this policy statement, indicating - which AWS accounts are affected by this policy statement. - - - - - Sets the principals associated with this policy statement, and returns - this updated Statement object. Principals control which AWS accounts are - affected by this policy statement. - - If you don't want to restrict your policy to specific users, you can use - to apply the policy to any user trying to - access your resource. - - - The list of principals associated with this policy statement. - this instance - - - - The available AWS access control policy actions for Amazon AppStream. - - - - - - The available AWS access control policy actions for Auto Scaling. - - - - - - The available AWS access control policy actions for AWS Billing. - - - - - - The available AWS access control policy actions for AWS CloudFormation. - - - - - - The available AWS access control policy actions for Amazon CloudFront. - - - - - - The available AWS access control policy actions for Amazon CloudSearch. - - - - - - The available AWS access control policy actions for AWS CloudTrail. - - - - - - The available AWS access control policy actions for Amazon CloudWatch. - - - - - - The available AWS access control policy actions for Amazon CloudWatch Logs. - - - - - - The available AWS access control policy actions for Amazon Cognito Identity. - - - - - - The available AWS access control policy actions for Amazon Cognito Sync. - - - - - - The available AWS access control policy actions for AWS Direct Connect. - - - - - - The available AWS access control policy actions for Amazon DynamoDB. - - - - - - The available AWS access control policy actions for Amazon EC2. - - - - - - The available AWS access control policy actions for AWS ElastiCache. - - - - - - The available AWS access control policy actions for AWS Elastic Beanstalk. - - - - - - The available AWS access control policy actions for Elastic Load Balancing. - - - - - - The available AWS access control policy actions for Amazon Elastic MapReduce. - - - - - - The available AWS access control policy actions for Amazon Elastic Transcoder. - - - - - - The available AWS access control policy actions for Amazon Glacier. - - - - - - The available AWS access control policy actions for AWS Identity and Access Management. - - - - - - The available AWS access control policy actions for AWS Import Export. - - - - - - The available AWS access control policy actions for Amazon Kinesis. - - - - - - The available AWS access control policy actions for AWS Marketplace. - - - - - - The available AWS access control policy actions for AWS Marketplace Management Portal. - - - - - - The available AWS access control policy actions for Amazon Mobile Analytics. - - - - - - The available AWS access control policy actions for AWS OpsWorks. - - - - - - The available AWS access control policy actions for Amazon RDS. - - - - - - The available AWS access control policy actions for Amazon Redshift. - - - - - - The available AWS access control policy actions for Amazon Route 53. - - - - - - The available AWS access control policy actions for Amazon S3. - - - - - - The available AWS access control policy actions for AWS Security Token Service. - - - - - - The available AWS access control policy actions for Amazon SES. - - - - - - The available AWS access control policy actions for Amazon SimpleDB. - - - - - - The available AWS access control policy actions for Amazon Simple Workflow Service. - - - - - - The available AWS access control policy actions for Amazon SNS. - - - - - - The available AWS access control policy actions for Amazon SQS. - - - - - - The available AWS access control policy actions for Amazon Storage Gateway. - - - - - - The available AWS access control policy actions for AWS Whispersync. - - - - - - The available AWS access control policy actions for Amazon Zocalo. - - - - - - Deserializes a JSON string into a AWS policy object. - - - - - Serializes an AWS policy object to a JSON string, suitable for sending to an - AWS service. - - - - Converts the specified AWS policy object to a JSON string, suitable for - passing to an AWS service. - - @param policy - The AWS policy object to convert to a JSON string. - - @return The JSON string representation of the specified policy object. - - @throws IllegalArgumentException - If the specified policy is null or invalid and cannot be - serialized to a JSON string. - - - - Uses the specified generator to write the JSON data for the principals in - the specified policy statement. - - - - - This sorts the conditions by condition type and key with the list of values for that combination. - - The list of conditions to be sorted. - - - - - Exception thrown by the SDK for errors that occur within the SDK. - - - - - This exception is thrown when there is a parse error on the response back from AWS. - - - - - The string value which could not be converted into a valid DateTime instance. - - - - - Occurs before a request is marshalled. - - - - - Occurs before a request is issued against the service. - - - - - Occurs after a response is received from the service. - - - - - Occurs after an exception is encountered. - - - - - Patches the in-flight uri to stop it unescaping the path etc (what Uri did before - Microsoft deprecated the constructor flag). This is particularly important for - Amazon S3 customers who want to use backslash (\) in their key names. - - - Different behavior in the various runtimes has been observed and in addition some - 'documented' ways of doing this between 2.x and 4.x runtimes has also been observed - to not be reliable. - - This patch effectively emulates what adding a schemesettings element to the - app.config file with value 'name="http" genericUriParserOptions="DontUnescapePathDotsAndSlashes"' - does. As we're a dll, that avenue is not open to us. - - - - - - Used to create a copy of the config for a different service than the current instance. - - Target service ClientConfig - The new ClientConfig for the desired service - - - - A base exception for some Amazon Web Services. - - Most exceptions thrown to client code will be service-specific exceptions, though some services - may throw this exception if there is a problem which is caught in the core client code. - - - - - - Whether the error was attributable to Sender or Reciever. - - - - - The error code returned by the service - - - - - The id of the request which generated the exception. - - - - - The HTTP status code from the service response - - - - - Flag indicating if the exception is retryable and the associated retry - details. A null value indicates that the exception is not retryable. - - - - - Class containing the retryable details for an AmazonServiceException - - - - - This property indicates that this exception is a - throttling exception and should be subject to congestion - control throttling. - - - - - This exception is thrown when there is a parse error on the response back from AWS. - - - - - Last known location in the response that was parsed, if available. - - - - - The entire response body that caused this exception, if available. - - - - - Base class for request used by some of the services. - - - - - This flag specifies if SigV4 will be used for the current request. - - - - - Gets or Sets a value indicating if "Expect: 100-continue" HTTP header will be - sent by the client for this request. The default value is false. - - - - - Gets the signer to use for this request. - A null return value indicates to use the configured - signer for the service that this request is part of. - - A signer for this request, or null. - - - - Abstract class for Response objects, contains only metadata, - and no result information. - - - - - Contains additional information about the request, such as the - Request Id. - - - - - Returns the content length of the HTTP response. - - - - - Returns the status code of the HTTP response. - - - - - Base class for determining region based on inspection. - - - - - Sets the Region property by looking up the corresponding RegionEndpoint - from the supplied region system name (us-east-1, us-west-2 etc). - - The system name of the region. - - - - Determines region based on application configuration settings. If the configuration does not contain - the region setting key an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of ApplicationConfigAWSRegion. If no region is found in the - application configuration file then an InvalidOperationException is thrown. - - - - - Probing mechanism to determine region from various sources. - - - - - This class is responsible for keeping track of Retry capacity across different ServiceURLs. - - - - - CapacityType determines the type of capacity to obtain or use. - - - - - The increment capacity type adds capacity. - - - - - The default retry capacity type uses the default capacity amount. - - - - - The timeout capacity type uses the timeout capacity amount. - - - - - This method acquires a said retry capacity if the container has the capacity. - - Contains the RetryCapacity object for the said ServiceURL. - - - - This method acquires a said retry capacity if the container has the capacity. - - Contains the RetryCapacity object for the said ServiceURL. - Specifies what capacity type cost to use for obtaining capacity - - - - This method calls a method to release capacity back - based on whether it was a successful response or a successful retry response. This is invoked by a retry request response. - - if this request is a retry, use a different capacity cost - Contains the RetryCapacity object for the said ServiceURL. - - - - This method calls a method to release capacity back - based on whether it was a successful response or a successful retry response. This is invoked by a retry request response. - - Specifies what capacity type cost to use for adding capacity - Contains the RetryCapacity object for the said ServiceURL. - - - - Ths method fetches the RetryCapacity for the given ServiceURL from CapacityManager.CapacityContainer - - - - - This method releases capacity back. This is invoked by the TryReleaseCapacity method. - - Contains the RetryCapacity object for the said ServiceURL. - The capacity that needs to be released based on whether it was a successful response or a successful retry response. - - - - This class is the RetryCapacity class for a given ServiceURL. - - - - - This class composes Client Context header for Amazon Web Service client. - It contains information like app title, version code, version name, client id, OS platform etc. - - - This class composes Client Context header for Amazon Web Service client. - It contains information like app title, version code, version name, client id, OS platform etc. - - - - - Adds the custom attributes to the Client Context. - - Key. - Value. - - - - Gets a Json Representation of the Client Context. - - Json Representation of Client Context - - - - Collection of parameters that an SDK client will send to a service. - - - - - Constructs empty ParameterCollection. - - - - - Adds a parameter with a string value. - - - - - - - Adds a parameter with a list-of-strings value. - - - - - - - Converts the current parameters into a list of key-value pairs. - - - - - - This class is responsible for managing adaptive retry mode client rate limiting. - - - - - The rate at which token are replenished. - - - - - The maximum capacity allowed in the token - - - - - The current capacity of the token - - - - - The last time the token bucket was refilled. - - - - - The smoothed rate which tokens are being retrieved. - - - - - The last half second time bucket used. - - - - - The number of requests seen within the current time - - - - - The maximum rate when the client was last throttled. - - - - - The last time when the client was throttled. - - - - - The cached time window calculation - - - - - Boolean indicating if the token bucket is enabled. - - - - - This method attempts to acquire capacity from the client's token - - The amount of capacity to obtain from the token bucket - Indicates that the client should or shouldn't sleep and - try again if capacity cannot be obtained. - - - - - This method attempts to acquire capacity from the client's token - - The amount of capacity to obtain from the token bucket - Indicates that the client should or shouldn't sleep and - try again if capacity cannot be obtained. - - Token which can be used to cancel the task. - - - - Updates the sending rate within the client's token bucket - - Indicates if the request resulted in a throttling error. - - - - Calculates the rate - - - Returns the calculated rate for a successful call - - - - Calculates the rate. - - The rate to use in the calculation - Returns the calculated rate for a throttled call - - - - Collection used to indicate if the property was initialized was created by the SDK. - - - - - - Collection used to indicate if the property was initialized was created by the SDK. - - - - - - - Default implementation of the IRequest interface. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Constructs a new DefaultRequest with the specified service name and the - original, user facing request object. - - The orignal request that is being wrapped - The service name - - - - The name of the request - - - - - Gets and sets the type of http request to make, whether it should be POST,GET or DELETE - - - - - Gets and sets a flag that indicates whether the request is sent as a query string instead of the request body. - - - - - Returns the original, user facing request object which this internal - request object is representing. - - - - - Returns a dictionary of the headers included in this request. - - - - - Returns a dictionary of the parameters included in this request. - - - - - Collection of parameters included in this request. - - - - - Returns the subresources that should be appended to the resource path. - This is used primarily for Amazon S3, where object keys can contain '?' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new null entry to the SubResources collection for the request - - The name of the subresource - - - - Adds a new entry to the SubResources collection for the request - - The name of the subresource - Value of the entry - - - - Gets and Sets the endpoint for this request. - - - - - Gets and Sets the resource path added on to the endpoint. - - - - - Returns the path resources that should be used within the resource path. - This is used for services where path keys can contain '/' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new entry to the PathResources collection for the request - - The name of the pathresource with potential greedy syntax: {key+} - Value of the entry - - - - Gets and Sets the version number for the marshaller used to create this request. The version number - is used to support backward compatible changes that would otherwise be breaking changes when a - newer core is used with an older service assembly. - Versions: - 1 - Default version - 2 - Support for path segments - - - - - Gets and Sets the content for this request. - - - - - Flag that signals that Content was and should be set - from the Parameters collection. - - - - - Gets and sets the content stream. - - - - - Gets and sets the original stream position. - If ContentStream is null or does not support seek, this propery - should be equal to -1. - - - - - Computes the SHA 256 hash of the content stream. If the stream is not - seekable, it searches the parent stream hierarchy to find a seekable - stream prior to computation. Once computed, the hash is cached for future - use. If a suitable stream cannot be found to use, null is returned. - - - - - The name of the service to which this request is being sent. - - - - - Alternate endpoint to use for this request, if any. - - - - - Host prefix value to prepend to the endpoint for this request, if any. - - - - - Gets and sets the Suppress404Exceptions property. If true then 404s return back from AWS will not cause an exception and - an empty response object will be returned. - - - - - If using AWS4 signing protocol, contains the resultant parts of the - signature that we may need to make use of if we elect to do a chunked - encoding upload. - - - - - Determine whether to use a chunked encoding upload for the request - (applies to Amazon S3 PutObject and UploadPart requests only). - - - - - - Used for Amazon S3 requests where the bucket name is removed from - the marshalled resource path into the host header. To comply with - AWS2 signature calculation, we need to recover the bucket name - and include it in the resource canonicalization, which we do using - this field. - - - - - This flag specifies if SigV4 is required for the current request. - - - - - The authentication region to use for the request. - Set from Config.AuthenticationRegion. - - - - - The region in which the service request was signed. - - - - - Checks if the request stream can be rewinded. - - Returns true if the request stream can be rewinded , - else false. - - - - Returns true if the request can contain a request body, else false. - - Returns true if the currect request can contain a request body, else false. - - - - Returns true if the request has a body, else false. - - Returns true if the request has a body, else false. - - - - Class containing the data for one endpoint returned from a endpoint discovery request - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Constructs a new DiscoveryEndpoint - - The address of the endpoint - The cache period for the endpoint in minutes - - - - The address of the endpoint. - - - - - The cache period for the endpoint in minutes - - - - - Calculates if this endpoint has expired - - A boolean value indicating if the cache period has expired - - - - Extends the endpoint expiration by the specified number of minutes from now. - - - - - Class containing the data for one endpoint returned from a endpoint discovery request - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class containing the data to use with endpoint discovery - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Gets/sets and flag indicating if endpoint discovery is required for the request. - - - - - Sorted dictionary of the identifiers that must be sent with the endpoint discovery request. These - identifiers are used to construct the cache key for the cache that stores discovered endpoints. A - sorted dictionary is used instead of a dictionary to ensure the cache key comes out in the same order - each time it is constructed. - - - - - Represents the data to be used with endpoint discovery operations - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class used to resolve endpoints using Endpoint Discovery. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Method that performs endpoint discovery for the current operation - - Context information used in calculations for endpoint discovery - The operation to fetch endpoints from the server - - - - - Gets the number of cache keys in the cache - - - - - Class used to resolve endpoints using Endpoint Discovery. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class containing context information to use with endpoint discovery - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Gets the customer credential information. - - - - - Gets the operation name. - - - - - Gets the current marshalled endpoint discovery data. - - - - - Gets the flag indicating if the specified key should be evicted from the cache. - - - - - Gets the Uri that should be evicted if EvictCacheKey is set to true. - - - - - Class containing context information to use with endpoint discovery - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Error type, one of Sender, Receiver, Unknown - Only applies to XML-based services. - - - - - Name of the exception class to return - - - - - Error message - - - - - RequestId of the error. - Only applies to XML-based services. - - - - - InternalConfiguration holds the cached SDK configuration values - obtained from the environment and profile configuration - factories. These configuration values are loaded internally and - are not the same as user exposed AWSConfigs. - - - - - Flag indicating if Endpoint Discovery is enabled. - - - - - The retry mode to use: Legacy, Standard, or Adaptive. - - - - - The max number of request attempts. - - - - - Probing mechanism to determine the configuration values from various sources. - - - - - Resets all the configuration values reloading as needed. This method will use - the AWS_PROFILE environment variable if set to construct the instance. Otherwise - the default profile will be used. - - - - - Flag that specifies if endpoint discovery is enabled, disabled, - or not set. - - - - - Flag that specifies which retry mode to use or if retry mode has - not been set. - - - - - Flag that specifies the max number of request attempts or if max - attempts has not been set. - - - - - Class containing the members used to invoke service calls - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class containing the members used to invoke service calls - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Represents a request being sent to an Amazon Web Service, including the - parameters being sent as part of the request, the endpoint to which the - request should be sent, etc. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - The name of the request - - - - - Returns a dictionary of the headers included in this request. - - - - - Gets and sets a flag that indicates whether the request is sent as a query string instead of the request body. - - - - - Returns a dictionary of the parameters included in this request. - - - - - Collection of parameters included in this request. - - - - - Returns the subresources that should be appended to the resource path. - This is used primarily for Amazon S3, where object keys can contain '?' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new null entry to the SubResources collection for the request - - The name of the subresource - - - - Adds a new entry to the SubResources collection for the request - - The name of the subresource - Value of the entry - - - - Gets and sets the type of http request to make, whether it should be POST,GET or DELETE - - - - - Gets and Sets the endpoint for this request. - - - - - Gets and Sets the resource path added on to the endpoint. - - - - - Returns the path resources that should be used within the resource path. - This is used for services where path keys can contain '/' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new entry to the PathResources collection for the request - - The name of the pathresource with potential greedy syntax: {key+} - Value of the entry - - - - Gets and Sets the version number for the marshaller used to create this request. The version number - is used to support backward compatible changes that would otherwise be breaking changes when a - newer core is used with an older service assembly. - - - - - Gets and Sets the content for this request. - - - - - Gets the header value from the request. - - - - - Flag that signals that Content was and should be set - from the Parameters collection. - - - - - Gets and sets the content stream. - - - - - Gets and sets the original stream position. - If ContentStream is null or does not support seek, this propery - should be equal to -1. - - - - - Computes the SHA 256 hash of the content stream. If the stream is not - seekable, it searches the parent stream hierarchy to find a seekable - stream prior to computation. Once computed, the hash is cached for future - use. - - - - - The name of the service to which this request is being sent. - - - - - Returns the original, user facing request object which this internal - request object is representing. - - - - - Alternate endpoint to use for this request, if any. - - - - - Host prefix value to prepend to the endpoint for this request, if any. - - - - - Gets and sets the Suppress404Exceptions property. If true then 404s return back from AWS will not cause an exception and - an empty response object will be returned. - - - - - If using AWS4 signing protocol, contains the resultant parts of the - signature that we may need to make use of if we elect to do a chunked - encoding upload. - - - - - Determine whether to use a chunked encoding upload for the request - (applies to Amazon S3 PutObject and UploadPart requests only). - - - - - - Used for Amazon S3 requests where the bucket name is removed from - the marshalled resource path into the host header. To comply with - AWS2 signature calculation, we need to recover the bucket name - and include it in the resource canonicalization, which we do using - this field. - - - - - This flag specifies if SigV4 is required for the current request. - - - - - The authentication region to use for the request. - Set from Config.AuthenticationRegion. - - - - - The region in which the service request was signed. - - - - - Checks if the request stream can be rewinded. - - Returns true if the request stream can be rewinded , - else false. - - - - Returns true if the request can contain a request body, else false. - - Returns true if the currect request can contain a request body, else false. - - - - Returns true if the request has a body, else false. - - Returns true if the request has a body, else false. - - - - Gets the value of the Service Id. - - - - - Gets the dictionary that gives mapping of renamed operations - - - - - IDictionary{String, String} access to ParameterCollection. - TODO: remove this class in version 3.4 of the SDK. - - - - - Constructs ParametersDictionaryFacade for a ParameterCollection - - - - - - A registry of object that will manipulate the runtime pipeline used by service clients. - - - - - Registers a customizer that will be applied for all service clients created. Each customizer has a unique name associated with it. If a customizer is registered more - than once with the same unique name then the calls after the first will be ignored. - - - - - - Deregistered the runtime pipeline customizer - - - - - - Deregistered the runtime pipeline customizer - - - - - - Applies all of the registered customizers on the runtime pipeline - - The service clients runtime pipeline. - Type object for the service client being created - - - - Interface for objects that will customize the runtime pipleine for newly created service clients. - - - - - The unique name for the customizer that identifies the customizer in the registry. The name is also used to identify the customizer on the SDK logs. - - - - - Called on service clients as they are being constructed to customize their runtime pipeline. - - - Type object for the service client being created - - - - Default ServiceMetadata implementation. - This implementation will be used if the service doesn't have a - IServiceMetadata implementation. - - - - - Gets the value of the Service Id. - - - - - Gets the dictionary that gives mapping of renamed operations - - - - - Computes RFC 2104-compliant HMAC signature. - - - - - Computes RFC 2104-compliant HMAC signature. - - - - - Inspects the supplied evidence to return the signer appropriate for the operation - - Global setting for the service - The request. - Configuration for the client - True if signature v4 request signing should be used - - - - Signs the specified request with the AWS3 signing protocol by using the - AWS account credentials given in the method parameters. - - The AWS public key - The AWS secret key used to sign the request in clear text - Request metrics - The configuration that specifies which hashing algorithm to use - The request to have the signature compute for - If any problems are encountered while signing the request - - - - AWS4 protocol signer for service calls that transmit authorization in the header field "Authorization". - - - - - Calculates and signs the specified request using the AWS4 signing protocol by using the - AWS account credentials given in the method parameters. The resulting signature is added - to the request headers as 'Authorization'. Parameters supplied in the request, either in - the resource path as a query string or in the Parameters collection must not have been - uri encoded. If they have, use the SignRequest method to obtain a signature. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. - - - Client configuration data encompassing the service call (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text. - - - If any problems are encountered while signing the request. - - - - - Calculates and signs the specified request using the AWS4 signing protocol by using the - AWS account credentials given in the method parameters. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. - - - Client configuration data encompassing the service call (notably authentication - region, endpoint and service name). - - - Metrics for the request. - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text. - - - If any problems are encountered while signing the request. - - - Parameters passed as part of the resource path should be uri-encoded prior to - entry to the signer. Parameters passed in the request.Parameters collection should - be not be encoded; encoding will be done for these parameters as part of the - construction of the canonical request. - - - - - Sets the AWS4 mandated 'host' and 'x-amz-date' headers, returning the date/time that will - be used throughout the signing process in various elements and formats. - - The current set of headers - - Date and time used for x-amz-date, in UTC - - - - Sets the AWS4 mandated 'host' and 'x-amz-date' headers, accepting and returning the date/time that will - be used throughout the signing process in various elements and formats. - - The current set of headers - - - Date and time used for x-amz-date, in UTC - - - - Computes and returns an AWS4 signature for the specified canonicalized request - - - - - - - - - - - - Computes and returns an AWS4 signature for the specified canonicalized request - - - - - - - - - - - - - Computes and returns an AWS4 signature for the specified canonicalized request - - - - - - - - - - - - - - Formats the supplied date and time for use in AWS4 signing, where various formats are used. - - - The required format - The UTC date/time in the requested format - - - - Compute and return the multi-stage signing key for the request. - - The clear-text AWS secret key, if not held in secureKey - The region in which the service request will be processed - Date of the request, in yyyyMMdd format - The name of the service being called by the request - Computed signing key - - - - If the caller has already set the x-amz-content-sha256 header with a pre-computed - content hash, or it is present as ContentStreamHash on the request instance, return - the value to be used in request canonicalization. - If not set as a header or in the request, attempt to compute a hash based on - inspection of the style of the request content. - - - - The computed hash, whether already set in headers or computed here. Null - if we were not able to compute a hash. - - - - - If signPayload is false set the x-amz-content-sha256 header to - the UNSIGNED-PAYLOAD magic string and return it. - Otherwise, if the caller has already set the x-amz-content-sha256 header with a pre-computed - content hash, or it is present as ContentStreamHash on the request instance, return - the value to be used in request canonicalization. - If not set as a header or in the request, attempt to compute a hash based on - inspection of the style of the request content. - - - - - The computed hash, whether already set in headers or computed here. Null - if we were not able to compute a hash. - - - - - Returns the HMAC256 for an arbitrary blob using the specified key - - - - - - - - Returns the HMAC256 for an arbitrary blob using the specified key - - - - - - - - Compute and return the hash of a data blob using the specified key - - Algorithm to use for hashing - Hash key - Data blob - Hash of the data - - - - Compute and return the hash of a data blob using the specified key - - Algorithm to use for hashing - Hash key - Data blob - Hash of the data - - - - Computes the non-keyed hash of the supplied data - - - - - - - Computes the non-keyed hash of the supplied data - - - - - - - Computes and returns the canonical request - - The endpoint URL - the path of the resource being operated on - The http method used for the request - The full request headers, sorted into canonical order - The query parameters for the request - - The hash of the binary request body if present. If not supplied, the routine - will look for the hash as a header on the request. - - Canonicalised request as a string - - - - Computes and returns the canonical request - - The endpoint URL - the path of the resource being operated on - The http method used for the request - The full request headers, sorted into canonical order - The query parameters for the request - - The path resource values lookup to use to replace the keys within resourcePath - The hash of the binary request body if present. If not supplied, the routine - will look for the hash as a header on the request. - - The version of the marshaller that constructed the request object. - Canonicalised request as a string - - - - Computes and returns the canonical request - - The endpoint URL - the path of the resource being operated on - The http method used for the request - The full request headers, sorted into canonical order - The query parameters for the request - - The path resource values lookup to use to replace the keys within resourcePath - The hash of the binary request body if present. If not supplied, the routine - will look for the hash as a header on the request. - - The version of the marshaller that constructed the request object. - The service being called for the request - Canonicalised request as a string - - - - Reorders the headers for the request for canonicalization. - - The set of proposed headers for the request - List of headers that must be included in the signature - For AWS4 signing, all headers are considered viable for inclusion - - - - Computes the canonical headers with values for the request. Only headers included in the signature - are included in the canonicalization process. - - All request headers, sorted into canonical order - Canonicalized string of headers, with the header names in lower case. - - - - Returns the set of headers included in the signature as a flattened, ;-delimited string - - The headers included in the signature - Formatted string of header names - - - - Collects the subresource and query string parameters into one collection - ready for canonicalization - - The in-flight request being signed - The fused set of parameters - - - - Computes and returns the canonicalized query string, if query parameters have been supplied. - Parameters with no value will be canonicalized as 'param='. The expectation is that parameters - have not already been url encoded prior to canonicalization. - - The set of parameters being passed on the uri - - Parameters must be uri encoded into the canonical request and by default the signer expects - that the supplied collection contains non-encoded data. Set this to false if the encoding was - done prior to signer entry. - - The uri encoded query string parameters in canonical ordering - - - - Computes and returns the canonicalized query string, if query parameters have been supplied. - Parameters with no value will be canonicalized as 'param='. The expectation is that parameters - have not already been url encoded prior to canonicalization. - - The set of parameters to be encoded in the query string - - Parameters must be uri encoded into the canonical request and by default the signer expects - that the supplied collection contains non-encoded data. Set this to false if the encoding was - done prior to signer entry. - - The uri encoded query string parameters in canonical ordering - - - - Returns the request parameters in the form of a query string. - - The request instance - Request parameters in query string format - - - - AWS4 protocol signer for Amazon S3 presigned urls. - - - - - Calculates and signs the specified request using the AWS4 signing protocol by using the - AWS account credentials given in the method parameters. The resulting signature is added - to the request headers as 'Authorization'. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. - - - Adding supporting data for the service call required by the signer (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text - - - If any problems are encountered while signing the request. - - - - - Calculates the AWS4 signature for a presigned url. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. If the Expires parameter - is present, it is renamed to 'X-Amz-Expires' before signing. - - - Adding supporting data for the service call required by the signer (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text - - - If any problems are encountered while signing the request. - - - Parameters passed as part of the resource path should be uri-encoded prior to - entry to the signer. Parameters passed in the request.Parameters collection should - be not be encoded; encoding will be done for these parameters as part of the - construction of the canonical request. - - - - - Calculates the AWS4 signature for a presigned url. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. If the Expires parameter - is present, it is renamed to 'X-Amz-Expires' before signing. - - - Adding supporting data for the service call required by the signer (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text - - - The service to sign for - - - The region to sign to, if null then the region the client is configured for will be used. - - - If any problems are encountered while signing the request. - - - Parameters passed as part of the resource path should be uri-encoded prior to - entry to the signer. Parameters passed in the request.Parameters collection should - be not be encoded; encoding will be done for these parameters as part of the - construction of the canonical request. - - The X-Amz-Content-SHA256 is cleared out of the request. - If the request is for S3 then the UNSIGNED_PAYLOAD value is used to generate the canonical request. - If the request isn't for S3 then the empty body SHA is used to generate the canonical request. - - - - - Encapsulates the various fields and eventual signing value that makes up - an AWS4 signature. This can be used to retrieve the required authorization string - or authorization query parameters for the final request as well as hold ongoing - signature computations for subsequent calls related to the initial signing. - - - - - Constructs a new signing result instance for a computed signature - - The access key that was included in the signature - Date/time (UTC) that the signature was computed - The collection of headers names that were included in the signature - Formatted 'scope' value for signing (YYYYMMDD/region/service/aws4_request) - Returns the key that was used to compute the signature - Computed signature - - - - The access key that was used in signature computation. - - - - - ISO8601 formatted date/time that the signature was computed - - - - - ISO8601 formatted date that the signature was computed - - - - - The ;-delimited collection of header names that were included in the signature computation - - - - - Formatted 'scope' value for signing (YYYYMMDD/region/service/aws4_request) - - - - - Returns a copy of the key that was used to compute the signature - - - - - Returns the hex string representing the signature - - - - - Returns a copy of the byte array containing the signature - - - - - Returns the signature in a form usable as an 'Authorization' header value. - - - - - Returns the signature in a form usable as a set of query string parameters. - - - - - Null Signer which does a no-op. - - - - - Signs the specified request with the AWS2 signing protocol by using the - AWS account credentials given in the method parameters. - - The AWS public key - The AWS secret key used to sign the request in clear text - Request metrics - The configuration that specifies which hashing algorithm to use - The request to have the signature compute for - If any problems are encountered while signing the request - - - - S3 signer constructor - - - - - S3 signer constructor - - - - - This exception is thrown if there are problems signing the request. - - - - - Response Unmarshaller for all Errors - - - - - Build an ErrorResponse from XML - - The XML parsing context. - Usually an Amazon.Runtime.Internal.UnmarshallerContext. - An ErrorResponse object. - - - - Return an instance of and ErrorResponseUnmarshaller. - - - - - - Interface for unmarshallers which unmarshall objects from response data. - The Unmarshallers are stateless, and only encode the rules for what data - in the XML stream goes into what members of an object. - - The type of object the unmarshaller returns - The type of the XML unmashaller context, which contains the - state during parsing of the XML stream. Usually an instance of - Amazon.Runtime.Internal.Transform.UnmarshallerContext. - - - - Given the current position in the XML stream, extract a T. - - The XML parsing context - An object of type T populated with data from the XML stream. - - - - Interface for unmarshallers which unmarshall service responses. - The Unmarshallers are stateless, and only encode the rules for what data - in the XML stream goes into what members of an object. - - The type of object the unmarshaller returns - The type of the XML unmashaller context, which contains the - state of parsing the XML stream. Uaually an instance of - Amazon.Runtime.Internal.Transform.UnmarshallerContext. - - - - Extracts an exeption with data from an ErrorResponse. - - The XML parsing context. - An inner exception to be included with the returned exception - The HttpStatusCode from the ErrorResponse - Either an exception based on the ErrorCode from the ErrorResponse, or the - general service exception for the service in question. - - - - Interface for unmarshallers which unmarshall objects from response data. - The Unmarshallers are stateless, and only encode the rules for what data - in the XML stream goes into what members of an object. - - The type of object the unmarshaller returns - The type of the XML unmashaller context, which contains the - state during parsing of the XML stream. Usually an instance of - Amazon.Runtime.Internal.Transform.UnmarshallerContext. - - - - Given the current position in the XML stream, extract a T. - - The XML parsing context - An object of type T populated with data from the XML stream. - - - - First-pass unmarshaller for all errors - - - - - Build an ErrorResponse from json - - The json parsing context. - Usually an Amazon.Runtime.Internal.JsonUnmarshallerContext. - An ErrorResponse object. - - - - Return an instance of JsonErrorResponseUnmarshaller. - - - - - - Wraps a json string for unmarshalling. - - Each Read() operation gets the next token. - TestExpression() is used to match the current key-chain - to an xpath expression. The general pattern looks like this: - - JsonUnmarshallerContext context = new JsonUnmarshallerContext(jsonString); - while (context.Read()) - { - if (context.IsKey) - { - if (context.TestExpresion("path/to/element")) - { - myObject.stringMember = stringUnmarshaller.GetInstance().Unmarshall(context); - continue; - } - } - } - - - - - - Wrap the jsonstring for unmarshalling. - - Stream that contains the JSON for unmarshalling - If set to true, maintains a copy of the complete response body constraint to log response size as the stream is being read. - Response data coming back from the request - If set to true, maintains a copy of the complete response body as the stream is being read. - - - - Are we at the start of the json document. - - - - - Is the current token the end of an object - - - - - Is the current token the start of an object - - - - - Returns the element depth of the parser's current position in the json - document being parsed. - - - - - The current Json path that is being unmarshalled. - - - - - Reads to the next token in the json document, and updates the context - accordingly. - - - True if a token was read, false if there are no more tokens to read. - - - - - Peeks at the next token. This peek implementation - reads the next token and makes the subsequent Read() return the same data. - If Peek is called successively, it will return the same data. - Only the first one calls Read(), subsequent calls - will return the same data until a Read() call is made. - - Token to peek. - Returns true if the peeked token matches given token. - - - - Returns the text contents of the current token being parsed. - - - The text contents of the current token being parsed. - - - - - The type of the current token - - - - - Get the base stream of the jsonStream. - - - - - Peeks at the next (non-whitespace) character in the jsonStream. - - The next (non-whitespace) character in the jsonStream, or -1 if at the end. - - - - Peeks at the next character in the stream. - If the data isn't buffered into the StreamReader (Peek() returns -1), - we flush the buffered data and try one more time. - - - - - - Abstract class for unmarshalling service responses. - - - - - Class for unmarshalling XML service responses. - - - - - Class for unmarshalling EC2 service responses. - - - - - Class for unmarshalling JSON service responses. - - - - - Unmarshaller for int fields - - - - - Unmarshaller for nullable int fields. Implemented only for JSON context - to handle cases where value can be null e.g. {'Priority': null}. - This unmarshaller is not implemented for XML context, as XML responses - will null elements (xsi:nil='true') will be skipped by the XML parser. - - - - - Unmarshaller for long fields - - - - - Unmarshaller for float fields - - - - - Unmarshaller for double fields - - - - - Unmarshaller for decimal fields - - - - - Unmarshaller for bool fields - - - - - Unmarshaller for string fields - - - - - Unmarshaller for byte fields - - - - - Unmarshaller for DateTime fields - - - - - Unmarshalls given string as a DateTime. Handles cases where we want to unmarshall - as just a DateTime or a nullable Datetime. - - Value to be parsed - If true, the method will return null if text is null. - If false, the method will return default(DateTime), if text is null. - - - - - Unmarshaller for nullable DateTime fields. Implemented only for JSON context - to handle cases where value can be null e.g. {'Priority': null}. - This unmarshaller is not implemented for XML context, as XML responses - will null elements (xsi:nil='true') will be skipped by the XML parser. - - - - - Unmarshaller for MemoryStream fields - - - - - Unmarshaller for ResponseMetadata - - - - - Base class for the UnmarshallerContext objects that are used - to unmarshall a web-service response. - - - - - Tests the specified expression against the current position in the XML - document - - The pseudo-XPath expression to test. - - True if the expression matches the current position in the document, - false otherwise. - - - - Tests the specified expression against the current position in the XML - document being parsed, and restricts the expression to matching at the - specified stack depth. - - The pseudo-XPath expression to test. - - The depth in the stack representing where the expression must - start matching in order for this method to return true. - - True if the specified expression matches the current position in - the XML document, starting from the specified depth. - - - - Reads the next token at depth greater than or equal to target depth. - - Tokens are read at depth greater than or equal to target depth. - True if a token was read and current depth is greater than or equal to target depth. - - - - The current path that is being unmarshalled. - - - - - Returns the element depth of the parser's current position in the - document being parsed. - - - - - Reads to the next node in the document, and updates the context accordingly. - - - True if a node was read, false if there are no more elements to read. - - - - - Returns the text contents of the current element being parsed. - - - The text contents of the current element being parsed. - - - - - True if NodeType is Element. - - - - - True if NodeType is EndElement. - - - - - True if the context is at the start of the document. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Wrap an XmltextReader for simulating an event stream. - - Each Read() operation goes either to the next element or next attribute within - the current element. TestExpression() is used to match the current event - to an xpath expression. The general pattern looks like this: - - UnmarshallerContext context = new UnmarshallerContext(...); - while (context.Read()) - { - if (context.TestExpresion("path/to/element")) - { - myObject.stringMember = stringUnmarshaller.GetInstance().Unmarshall(context); - continue; - } - if (context.TestExpression("path/to/@attribute")) - myObject.MyComplexTypeMember = MyComplexTypeUnmarshaller.GetInstance().Unmarshall(context); - } - - - - - - Wrap an XmlTextReader with state for event-based parsing of an XML stream. - - Stream with the XML from a service response. - If set to true, maintains a copy of the complete response body constraint to log response size as the stream is being read. - Response data coming back from the request - If set to true, maintains a copy of the complete response body as the stream is being read. - - - - The current XML path that is being unmarshalled. - - - - - Returns the element depth of the parser's current position in the XML - document being parsed. - - - - - Reads to the next node in the XML document, and updates the context accordingly. - - - True if a node was read, false if there are no more elements to read./ - - - - - Returns the text contents of the current element being parsed. - - - The text contents of the current element being parsed. - - - - - True if NodeType is Element. - - - - - True if NodeType is EndElement. - - - - - True if the context is at the start of the document. - - - - - True if NodeType is Attribute. - - - - - Wrap an XmlTextReader with state for event-based parsing of an XML stream. - - Stream with the XML from a service response. - If set to true, maintains a copy of the complete response body constraint to log response size as the stream is being read. - Response data coming back from the request - If set to true, maintains a copy of the complete response body as the stream is being read. - - - - RequestId value, if found in response - - - - - Reads to the next node in the XML document, and updates the context accordingly. - If node is RequestId, reads the contents and stores in RequestId property. - - - True if a node was read, false if there are no more elements to read./ - - - - - A stream which caches the contents of the underlying stream as it reads it. - - - - - All the bytes read by the stream. - - - - - All the bytes read by the stream constrained with _cacheLimit - - - - - Initializes the CachingWrapperStream with a base stream. - - The stream to be wrapped. - Maximum number of bytes to be cached. - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Gets a value indicating whether the current stream supports seeking. - CachingWrapperStream does not support seeking, this will always be false. - - - - - Gets or sets the position within the current stream. - CachingWrapperStream does not support seeking, attempting to set Position - will throw NotSupportedException. - - - - - Sets the position within the current stream. - CachingWrapperStream does not support seeking, attempting to call Seek - will throw NotSupportedException. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Stream wrapper that double-buffers from a wrapped stream and - returns the buffered content as a series of signed 'chunks' - for the AWS4 ('Signature V4') protocol. - - - - - Reads some or all of the processed chunk to the consumer, constructing - and streaming a new chunk if more input data is available. - - - - - - - - - Attempt to read sufficient data for a whole chunk from the wrapped stream, - returning the number of bytes successfully read to be processed into a chunk - - - - - Results of the header-signing portion of the request - - - - - Computed signature of the chunk prior to the one in-flight, in - hex - - - - - Computes the derived signature for a chunk of data of given length in the input buffer, - placing a formatted chunk with headers, signature and data into the output buffer - ready for streaming back to the consumer. - - - - - - Length override to return the true length of the payload plus the metainfo - supplied with each chunk - - - - - Computes the total size of the data payload, including the chunk metadata. - Called externally so as to be able to set the correct Content-Length header - value. - - - - - - - Computes the size of the header data for each chunk. - - - - - - - Attempt to read sufficient data for a whole chunk from the wrapped stream, - returning the number of bytes successfully read to be processed into a chunk - - - - - A list object that will always be sent to AWS services, - even if it is empty. - The AWS .NET SDK does not send empty collections to services, unless - the collection is of this type. - - - - - - A dictionary object that will always be sent to AWS services, - even if it is empty. - The AWS .NET SDK does not send empty collections to services, unless - the collection is of this type. - - - - - - - Class to perform actions on a background thread. - Uses a single background thread and performs actions - on it in the order the data was sent through the instance. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Class to invoke actions on a background thread. - Uses a single background thread and invokes actions - on it in the order they were invoked through the instance. - - - - - PCL doesn't have IPAddress. These methods are copied from the Microsoft source code. - - - - - Returns true if the Content is set or there are - query parameters. - - This request - True if data is present; false otherwise. - - - - Utilities for dealing with Guids - - - - - Hashes a set of objects. - - - - - - - Combines a set of hashses. - - - - - - - Combines two hashes. - - - - - - - - Disposes of all managed and unmanaged resources. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - A wrapper stream that calculates a hash of the base stream as it - is being read. - The calculated hash is only available after the stream is closed or - CalculateHash is called. After calling CalculateHash, any further reads - on the streams will not change the CalculatedHash. - If an ExpectedHash is specified and is not equal to the calculated hash, - Close or CalculateHash methods will throw an AmazonClientException. - If CalculatedHash is calculated for only the portion of the stream that - is read. - - - Exception thrown during Close() or CalculateHash(), if ExpectedHash is set and - is different from CalculateHash that the stream calculates, provided that - CalculatedHash is not a zero-length byte array. - - - - - Algorithm to use to calculate hash. - - - - - True if hashing is finished and no more hashing should be done; - otherwise false. - - - - - Current position in the stream. - - - - - Calculated hash for the stream. - This value is set only after the stream is closed. - - - - - Expected hash value. Compared against CalculatedHash upon Close(). - If the hashes are different, an AmazonClientException is thrown. - - - - - Expected length of stream. - - - - - Initializes an HashStream with a hash algorithm and a base stream. - - Stream to calculate hash for. - - Expected hash. Will be compared against calculated hash on stream close. - Pass in null to disable check. - - - Expected length of the stream. If the reading stops before reaching this - position, CalculatedHash will be set to empty array. - - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Asynchronously reads a sequence of bytes from the current stream, advances - the position within the stream by the number of bytes read, and monitors - cancellation requests. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous read operation. The value of the TResult - parameter contains the total number of bytes read into the buffer. This can be - less than the number of bytes requested if that many bytes are not currently - available, or zero (0) if the end of the stream has been reached. - - - - - Gets a value indicating whether the current stream supports seeking. - HashStream does not support seeking, this will always be false. - - - - - Gets or sets the position within the current stream. - HashStream does not support seeking, attempting to set Position - will throw NotSupportedException. - - - - - Sets the position within the current stream. - HashStream does not support seeking, attempting to call Seek - will throw NotSupportedException. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Gets the overridden length used to construct the HashStream - - - - - Calculates the hash for the stream so far and disables any further - hashing. - - - - - Resets the hash stream to starting state. - Use this if the underlying stream has been modified and needs - to be rehashed without reconstructing the hierarchy. - - - - - Validates the underlying stream. - - - - - Compares two hashes (arrays of bytes). - - Expected hash. - Actual hash. - - True if the hashes are identical; otherwise false. - - - - - A wrapper stream that calculates a hash of the base stream as it - is being read or written. - The calculated hash is only available after the stream is closed or - CalculateHash is called. After calling CalculateHash, any further reads - on the streams will not change the CalculatedHash. - If an ExpectedHash is specified and is not equal to the calculated hash, - Close or CalculateHash methods will throw an AmazonClientException. - If base stream's position is not 0 or HashOnReads is true and the entire stream is - not read, the CalculatedHash will be set to an empty byte array and - comparison to ExpectedHash will not be made. - - - Exception thrown during Close() or CalculateHash(), if ExpectedHash is set and - is different from CalculateHash that the stream calculates, provided that - CalculatedHash is not a zero-length byte array. - - - - - Initializes an HashStream with a hash algorithm and a base stream. - - Stream to calculate hash for. - - Expected hash. Will be compared against calculated hash on stream close. - Pass in null to disable check. - - - Expected length of the stream. If the reading stops before reaching this - position, CalculatedHash will be set to empty array. - - - - - A wrapper stream that calculates an MD5 hash of the base stream as it - is being read or written. - The calculated hash is only available after the stream is closed or - CalculateHash is called. After calling CalculateHash, any further reads - on the streams will not change the CalculatedHash. - If an ExpectedHash is specified and is not equal to the calculated hash, - Close or CalculateHash methods will throw an AmazonClientException. - If base stream's position is not 0 or HashOnReads is true and the entire stream is - not read, the CalculatedHash will be set to an empty byte array and - comparison to ExpectedHash will not be made. - - - Exception thrown during Close() or CalculateHash(), if ExpectedHash is set and - is different from CalculateHash that the stream calculates, provided that - CalculatedHash is not a zero-length byte array. - - - - - Initializes an MD5Stream with a base stream. - - Stream to calculate hash for. - - Expected hash. Will be compared against calculated hash on stream close. - Pass in null to disable check. - - - Expected length of the stream. If the reading stops before reaching this - position, CalculatedHash will be set to empty array. - - - - - Utilities for validating label values for host prefix templates - - - - - Validates a label value - - - - - Simple wrapper around the log4net Error method. - - - - - - - - Write debug message to Console - - - - - - - - Write debug message to Console - - - - - - - Simple wrapper around the log4net InfoFormat method. - - - - - - - This is a dynamic wrapper around log4net so we can avoid log4net being required - to be distributed with the SDK. - - - - - Abstract logger class, base for any custom/specific loggers. - - - - - Flushes the logger contents. - - - - - Simple wrapper around the log4net IsErrorEnabled property. - - - - - Simple wrapper around the log4net IsDebugEnabled property. - - - - - Simple wrapper around the log4net IsInfoEnabled property. - - - - - Simple wrapper around the log4net Error method. - - - - - - - - Simple wrapper around the log4net Debug method. - - - - - - - - Simple wrapper around the log4net DebugFormat method. - - - - - - - Simple wrapper around the log4net InfoFormat method. - - - - - - - Logger wrapper for reflected log4net logging methods. - - - - - This should be a one time call to use reflection to find all the types and methods - needed for the logging API. - - - - - Simple wrapper around the log4net IsErrorEnabled property. - - - - - Simple wrapper around the log4net Error method. - - - - - - - - Simple wrapper around the log4net IsDebugEnabled property. - - - - - Simple wrapper around the log4net Debug method. - - - - - - - - Simple wrapper around the log4net DebugFormat method. - - - - - - - Simple wrapper around the log4net IsInfoEnabled property. - - - - - Simple wrapper around the log4net InfoFormat method. - - - - - - - A single logged message - - - - - Log message arguments. - - - - - Culture-specific formatting provider. - - - - - Log message format. - - - - - a size-limited cache of key value pairs - - Once the maximum size has been reached, the least recently - used pairs will be evicted to make room for any new items. - - - - - - - the maximum number of entries this LruCache will hold - before items begin getting evicted - - - - - the number of items in the cache - - - - - Construct a new LruCache. - - maximum number of entries before items are evicted - - - - Add the key/value pair to the cache, or update - the value if the key already exists. - - If the cache is full, evicts the least recently used item. - - - - - - - Evicts a specific key out of the cache if it exists - - the key to evict from the cache - - - - Try to get the value associated with the key. - - the key to look up - the value, if the key exists - true if there is a value associated with the key, or false if no value is associated with the key - - - - Try to get the value associated with the key, if it doesn't exist, use the provided factory method to - create a new value and tries adding it to the cache. - - the key to look up - the factory method used in case the key is not present in the cache - the looked up value or the value created by the factory - - - - Clear the LruCache of all entries. - - - - - Helper class to support LruCache. - Does not implement the error checking and synchronization that - would be necessary for it to stand alone. - - - - - Item to be stored in the LruList - linked list structure. - - - - - Collection of properties being tracked - - - - - Timings for metrics being tracked - - - - - Counters being tracked - - - - - Whether metrics are enabled for the request - - - - - Constructs an empty, disabled metrics object - - - - - Starts timing an event. Logs an exception if an event - of the same type was started but not stopped. - - - - - - - Stops timing an event. Logs an exception if the event wasn't started. - - - - - - - Adds a property for a metric. If there are multiple, the - object is added as a new item in a list. - - - - - - - Sets a counter for a specific metric. - - - - - - - Increments a specific metric counter. - If counter doesn't exist yet, it is set to 1. - - - - - - Returns errors associated with the metric, including - if there are still any timing events in-flight. - - - - - - Returns a string representation of the current metrics. - - - - - - Return a JSON represenation of the current metrics - - - - - - Timing information for a metric - - - - - Empty, stopped timing object - - - - - Timing object in a started state - - - - - - Stops timing - - - - - - Whether the timing has been stopped - - - - - Elapsed ticks from start to stop. - If timing hasn't been stopped yet, returns 0. - - - - - Elapsed time from start to stop. - If timing hasn't been stopped yet, returns TimeSpan.Zero - - - - - Timing event, stops timing of a metric when disposed - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - The destructor for the client class. - - - - - A wrapper stream which supresses disposal of the underlying stream. - - - - - Constructor for NonDisposingWrapperStream. - - The base stream to wrap. - - - - The Dispose implementation for this wrapper stream - does not close the underlying stream. - - - - - This class is used to wrap a stream for a particular segment of a stream. It - makes that segment look like you are reading from beginning to end of the stream. - - - - - Asynchronously reads a sequence of bytes from the current stream, advances - the position within the stream by the number of bytes read, and monitors - cancellation requests. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous read operation. The value of the TResult - parameter contains the total number of bytes read into the buffer. This can be - less than the number of bytes requested if that many bytes are not currently - available, or zero (0) if the end of the stream has been reached. - - - - - Asynchronously writes a sequence of bytes to the current stream and advances the - current position within this stream by the number of bytes written. - - - An array of bytes. This method copies count bytes from buffer to the current stream. - - - The zero-based byte offset in buffer at which to begin copying bytes to the - current stream. - - The number of bytes to be written to the current stream. - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - A task that represents the asynchronous write operation. - - - - Wrapper stream that only supports reading - - - - - Asynchronously clears all buffers for this stream and causes any buffered data - to be written to the underlying device. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous flush operation. - - - - - Asynchronously writes a sequence of bytes to the current stream and advances the - current position within this stream by the number of bytes written. - - - An array of bytes. This method copies count bytes from buffer to the current stream. - - - The zero-based byte offset in buffer at which to begin copying bytes to the - current stream. - - The number of bytes to be written to the current stream. - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - A task that represents the asynchronous write operation. - - - - Partial wrapper stream that only supports reading - - - - - Uri wrapper that can parse out information (bucket, key, region, style) from an - S3 URI. - - - - - True if the URI contains the bucket in the path, false if it contains the bucket in the authority. - - - - - The bucket name parsed from the URI (or null if no bucket specified). - - - - - The key parsed from the URI (or null if no key specified). - - - - - The region parsed from the URI (or null if no region specified). - - - - - Constructs a parser for the S3 URI specified as a string. - - The S3 URI to be parsed. - - - - Constructs a parser for the S3 URI specified as a Uri instance. - - The S3 URI to be parsed. - - - - Percent-decodes the given string, with a fast path for strings that are not - percent-encoded. - - The string to decode - The decoded string - - - - Percent-decodes the given string. - - The string to decode - The index of the first '%' in the string - The decoded string - - - - Decodes the percent-encoded character at the given index in the string - and appends the decoded value to the string under construction. - - - The string under construction to which the decoded character will be - appended. - - The string being decoded. - The index of the '%' character in the string. - - - - Converts a hex character (0-9A-Fa-f) into its corresponding quad value. - - The hex character - The quad value - - - - Interface for a non-generic cache. - - - - - Clears the entire cache. - - - - - Maximum time to keep an item around after its last use. - - - - - How often should the cache be cleared of old items. - - - - - The number of items in the cache. - - - - - Interface for a generic cache. - - - - - - - Retrieves a value out of the cache or from the source. - - - - - - - - Retrieves a value out of the cache or from the source. - If the item was in the cache, isStaleItem is set to true; - otherwise, if the item comes from the source, isStaleItem is false. - - - - - - - - - Clears a specific value from the cache if it's there. - - - - - - Returns the keys for all items in the cache. - - - - - - Executes specified operation, catches exception, clears the cache for - the given key, retries the operation. - - - - - - - - - - - SDK-wide cache. - Provides access to caches specific to a particular set of credentials - and target region. - - - - - Clear all caches - - - - - Clear all caches of a particular type - - - - - - Retrieve a cache of a specific type for a client object. - The client object can be null in cases where a cache does - not correspond to a specific AWS account or target region. - - - - - - - - - - - Retrieve a cache of a specific type for a client object. - The client object can be null in cases where a cache does - not correspond to a specific AWS account or target region. - - - - - - - - - - - Utilities for converting objects to strings. Used by the marshaller classes. - - - - - Converts a DateTime to ISO8601 formatted string. - - - - - Converts a DateTime to RFC822 formatted string. - - - - - Converts a DateTime to Unix epoch time formatted string. - - - - - A wrapper stream. - - - - - Base stream. - - - - - Initializes WrapperStream with a base stream. - - - - - - Returns the first base non-WrapperStream. - - First base stream that is non-WrapperStream. - - - - Returns the first base non-WrapperStream. - - First base stream that is non-WrapperStream. - - - - Returns the first base non-WrapperStream. - - Potential WrapperStream - Base non-WrapperStream. - - - - Gets a value indicating whether the current stream supports reading. - True if the stream supports reading; otherwise, false. - - - - - Gets a value indicating whether the current stream supports seeking. - True if the stream supports seeking; otherwise, false. - - - - - Gets a value indicating whether the current stream supports writing. - True if the stream supports writing; otherwise, false. - - - - - Closes the current stream and releases any resources (such as sockets and - file handles) associated with the current stream. - - - - - Gets the length in bytes of the stream. - - - - - Gets or sets the position within the current stream. - - - - - Gets or sets a value, in miliseconds, that determines how long the stream - will attempt to read before timing out. - - - - - Gets or sets a value, in miliseconds, that determines how long the stream - will attempt to write before timing out. - - - - - Clears all buffers for this stream and causes any buffered data to be written - to the underlying device. - - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Sets the position within the current stream. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Sets the length of the current stream. - - The desired length of the current stream in bytes. - - - - Writes a sequence of bytes to the current stream and advances the current - position within this stream by the number of bytes written. - - - An array of bytes. This method copies count bytes from buffer to the current stream. - - - The zero-based byte offset in buffer at which to begin copying bytes to the - current stream. - - The number of bytes to be written to the current stream. - - - - Asynchronously clears all buffers for this stream and causes any buffered data - to be written to the underlying device. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous flush operation. - - - - - Asynchronously reads a sequence of bytes from the current stream, advances - the position within the stream by the number of bytes read, and monitors - cancellation requests. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous read operation. The value of the TResult - parameter contains the total number of bytes read into the buffer. This can be - less than the number of bytes requested if that many bytes are not currently - available, or zero (0) if the end of the stream has been reached. - - - - - Asynchronously writes a sequence of bytes to the current stream and advances the - current position within this stream by the number of bytes written. - - - An array of bytes. This method copies count bytes from buffer to the current stream. - - - The zero-based byte offset in buffer at which to begin copying bytes to the - current stream. - - The number of bytes to be written to the current stream. - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - A task that represents the asynchronous write operation. - - - - This is a utility class to be used in last resort for code paths that are synchronous but need to call an asynchronous method. - This should never be used for methods that are called at high volume as this utility class has a performance cost. For example this - class was added for the refreshing credentials like Cognito which would need to use this about once an hour. - - - - - Custom WebProxy implementation that creates a webproxy based on - user inputs(Host name and port number) - - - - - Set the ProxyUri - - - - - Create a Uri based on the user inputs(Host name and port number) - - - - - Proxy Uri property - - - - - Proxy Credentials property - - - - - Getter to fetch the set proxy - - - - - Method to determine if the proxy should be bypassed when accessing an internet source - - - - - Error is always enabled - - - - - Debug logging is always enabled - - - - - Info logging is always enabled - - - - - Prints the Log With Error Level - - - - - - - - Prints the Log with Debug Level - - - - - - - - Prints the Log with Debug Level - - - - - - - Prints the Log With Info Level - - - - - - - Logger wrapper for Console.WriteLine() - - - - - Simple wrapper around the log4net IsErrorEnabled property. - - - - - Simple wrapper around the log4net Error method. - - - - - - - - Simple wrapper around the log4net IsDebugEnabled property. - - - - - Simple wrapper around the log4net Debug method. - - - - - - - - Simple wrapper around the log4net DebugFormat method. - - - - - - - Simple wrapper around the log4net IsInfoEnabled property. - - - - - Simple wrapper around the log4net InfoFormat method. - - - - - - - This class is no longer used anymore and should be avoided as it is just meant - as a last resort when blending async and sync operations. The code is still - here to support versions before 3.3.9.0 of AWSSDK.DynamoDBv2. - - - - - Property to denote that the last exception returned by an AWS Service - was retryable or not. - - - - - An abstract pipeline handler that has implements IPipelineHandler, - and has the default implmentation. This is the base class for most of - the handler implementations. - - - - - The logger used to log messages. - - - - - The inner handler which is called after the current - handler completes it's processing. - - - - - The outer handler which encapsulates the current handler. - - - - - Contains the processing logic for a synchronous request invocation. - This method calls InnerHandler.InvokeSync to continue processing of the - request by the pipeline. - - The execution context which contains both the - requests and response context. - - - - Contains the processing logic for an asynchronous request invocation. - This method calls InnerHandler.InvokeSync to continue processing of the - request by the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Logs the metrics for the current execution context. - - The execution context, it contains the - request and response context. - - - - A runtime pipeline contains a collection of handlers which represent - different stages of request and response processing. - - - - - The top-most handler in the pipeline. - - - - - Constructor for RuntimePipeline. - - The handler with which the pipeline is initalized. - - - - Constructor for RuntimePipeline. - - List of handlers with which the pipeline is initalized. - - - - Constructor for RuntimePipeline. - - List of handlers with which the pipeline is initalized. - The logger used to log messages. - - - - Constructor for RuntimePipeline. - - The handler with which the pipeline is initalized. - The logger used to log messages. - - - - Invokes the pipeline synchronously. - - Request context - Response context - - - - Invokes the pipeline asynchronously. - - Request context - Response context - - - - Adds a new handler to the top of the pipeline. - - The handler to be added to the pipeline. - - - - Adds a handler after the first instance of handler of type T. - - Type of the handler after which the given handler instance is added. - The handler to be added to the pipeline. - - - - Adds a handler before the first instance of handler of type T. - - Type of the handler before which the given handler instance is added. - The handler to be added to the pipeline. - - - - Removes the first occurance of a handler of type T. - - Type of the handler which will be removed. - - - - Replaces the first occurance of a handler of type T with the given handler. - - Type of the handler which will be replaced. - The handler to be added to the pipeline. - - - - Inserts the given handler after current handler in the pipeline. - - Handler to be inserted in the pipeline. - Handler after which the given handler is inserted. - - - - Gets the innermost handler by traversing the inner handler till - it reaches the last one. - - - - - Retrieves a list of handlers, in the order of their execution. - - Handlers in the current pipeline. - - - - Retrieves current handlers, in the order of their execution. - - Handlers in the current pipeline. - - - - This handler processes exceptions thrown from the HTTP handler and - unmarshalls error responses. - - - - - Default set of exception handlers. - - - - - Default set of exception handlers. - - - - - Constructor for ErrorHandler. - - an ILogger instance. - - - - Handles and processes any exception thrown from underlying handlers. - - The execution context which contains both the - requests and response context. - - - - Handles and processes any exception thrown from underlying handlers. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Disposes the response body. - - The response context. - - - - Processes an exception by invoking a matching exception handler - for the given exception. - - The execution context, it contains the - request and response context. - The exception to be processed. - - This method returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception that may be thrown by exception - processing by a matching exception handler. - - - - - The abstract base class for exception handlers. - - The exception type. - - - - The exception handler for HttpErrorResponseException exception. - - - - - The constructor for HttpErrorResponseExceptionHandler. - - in instance of ILogger. - - - - Handles an exception for the given execution context. - - The execution context, it contains the - request and response context. - The exception to handle. - - Returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception to replace the original exception. - - - - - Checks if a HTTP 404 status code is returned which needs to be suppressed and - processes it. - If a suppressed 404 is present, it unmarshalls the response and returns true to - indicate that a suppressed 404 was processed, else returns false. - - The execution context, it contains the - request and response context. - - - If a suppressed 404 is present, returns true, else returns false. - - - - - A pipeline handler which provides hooks to run - external code in the pre-invoke and post-invoke phases. - - - - - Action to execute on the pre invoke phase. - - - - - Action to execute on the post invoke phase. - - - - - Calls the PreInvoke and PostInvoke methods before and after calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls the PreInvoke and PostInvoke methods before and after calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Executes the OnPreInvoke action as part of pre-invoke. - - The execution context, it contains the - request and response context. - - - - Executes the OnPreInvoke action as part of post-invoke. - - The execution context, it contains the - request and response context. - - - - This handler retrieved the AWS credentials to be used for the current call. - - - - - The constructor for CredentialsRetriever. - - An AWSCredentials instance. - - - - Retrieves the credentials to be used for the current call before - invoking the next handler. - - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - This handler resolves the endpoint to be used for the current request. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Resolves the endpoint to be used for the current request - before invoking the next handler. - - The execution context, it contains the - request and response context. - - - - This handler resolves the endpoint to be used for the current request. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Resolves the endpoint to be used for the current request - before invoking the next handler. - - The execution context, it contains the - request and response context. - - - - Determines the endpoint for the request. - - The request context. - - - - - This handler provides an OnError action that can be used as hook for - external code to handle exceptions in the runtime pipeline. - - - - - Action to execute if an exception occurs during the - execution of any underlying handlers. - - - - - Executes the OnError action if an exception occurs during the - execution of any underlying handlers. - - - - - - - This handler marshalls the request before calling invoking the next handler. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Marshalls the request before calling invoking the next handler. - - The execution context, it contains the - request and response context. - - - - This handler manages the metrics used to time the complete call and - logs the final metrics. - - - - - Captures the overall execution time and logs final metrics. - - The execution context which contains both the - requests and response context. - - - - Captures the overall execution time and logs final metrics. - - The response type for the current request. - - The execution context, it contains the request and response context. - - A task that represents the asynchronous operation. - - - - This handler processes HTTP redirects and reissues the call to the - redirected location. - - - - - Processes HTTP redirects and reissues the call to the - redirected location. - - The execution context which contains both the - requests and response context. - - - - Processes HTTP redirects and reissues the call to the - redirected location. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Checks if an HTTP 307 (temporary redirect) has occured and changes the - request endpoint to the redirected location. - - - The execution context, it contains the request and response context. - - - A boolean value that indicates if a redirect has occured. - - - - - This handler signs the request. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Signs the request before invoking the next handler. - - - The execution context, it contains the request and response context. - - - - - Determines if the request should be signed. - - The request context. - A boolean value that indicated if the request should be signed. - - - - Signs the request. - - The request context. - - - - This handler unmarshalls the HTTP response. - - - - - The constructor for Unmarshaller. - - - Boolean value which indicated if the unmarshaller - handler supports response logging. - - - - - Unmarshalls the response returned by the HttpHandler. - - The execution context which contains both the - requests and response context. - - - - Unmarshalls the response returned by the HttpHandler. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Unmarshalls the HTTP response. - - - The execution context, it contains the request and response context. - - - - - Unmarshalls the HTTP response. - - - The execution context, it contains the request and response context. - - - - - The HTTP handler contains common logic for issuing an HTTP request that is - independent of the underlying HTTP infrastructure. - - - - - - The sender parameter used in any events raised by this handler. - - - - - The constructor for HttpHandler. - - The request factory used to create HTTP Requests. - The sender parameter used in any events raised by this handler. - - - - Issues an HTTP request for the current request context. - - The execution context which contains both the - requests and response context. - - - - Issues an HTTP request for the current request context. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Determines the content for request body and uses the HTTP request - to write the content to the HTTP request body. - - Content to be written. - The HTTP request. - The request context. - - - - Creates the HttpWebRequest and configures the end point, content, user agent and proxy settings. - - The async request. - The web request that actually makes the call. - - - - Disposes the HTTP handler. - - - - - The default implementation of the adaptive retry policy. - - - The default implementation of the adaptive policy. - - - - - Constructor for AdaptiveRetryPolicy. - - The maximum number of retries before throwing - back a exception. This does not count the initial request. - - - - Constructor for AdaptiveRetryPolicy. - - The Client config object. This is used to - retrieve the maximum number of retries before throwing - back a exception(This does not count the initial request) and - the service URL for the request. - - - - OnRetry is called when a retry request is initiated to determine if the request will be retried. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - true if the error that will be retried is a throtting error - True if retry throttling is disabled or retry throttling is enabled and capacity can be obtained. - - - - This method uses a token bucket to enforce the maximum sending rate. - - The execution context which contains both the - requests and response context. - If the prior request failed, this exception is expected to be - the exception that occurred during the prior request failure. - - - - Virtual method that gets called on a success Response. If its a retry success response, the entire - retry acquired capacity is released(default is 5). If its just a success response a lesser value capacity - is released(default is 1). - - Request context containing the state of the request. - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - This method uses a token bucket to enforce the maximum sending rate. - - The execution context which contains both the - requests and response context. - If the prior request failed, this exception is expected to be - the exception that occurred during the prior request failure. - - - - The default implementation of the legacy retry policy. - - - The default implementation of the legacy retry policy. - - - - - The maximum value of exponential backoff in milliseconds, which will be used to wait - before retrying a request. The default is 30000 milliseconds. - - - - - Constructor for DefaultRetryPolicy. - - The maximum number of retries before throwing - back a exception. This does not count the initial request. - - - - Constructor for DefaultRetryPolicy. - - The Client config object. This is used to - retrieve the maximum number of retries before throwing - back a exception(This does not count the initial request) and - the service URL for the request. - - - - Returns true if the request is in a state where it can be retried, else false. - - Request context containing the state of the request. - Returns true if the request is in a state where it can be retried, else false. - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - true if the error that will be retried is a throtting error - - - - Virtual method that gets called on a success Response. If its a retry success response, the entire - retry acquired capacity is released(default is 5). If its just a success response a lesser value capacity - is released(default is 1). - - Request context containing the state of the request. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Request context containing the state of the request. - Return true if the request should be retried. - - - - Checks if the retry limit is reached. - - Request context containing the state of the request. - Return false if the request can be retried, based on number of retries. - - - - Waits before retrying a request. The default policy implements a exponential backoff. - - Request context containing the state of the request. - - - - Waits for an amount of time using an exponential backoff algorithm. - - The request retry index. The first request is expected to be 0 while - the first retry will be 1. - The max number of milliseconds to wait - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - The retry handler has the generic logic for retrying requests. - It uses a retry policy which specifies when - a retry should be performed. - - - - - The logger used to log messages. - - - - - The retry policy which specifies when - a retry should be performed. - - - - - Constructor which takes in a retry policy. - - Retry Policy - - - - Invokes the inner handler and performs a retry, if required as per the - retry policy. - - The execution context which contains both the - requests and response context. - - - - Invokes the inner handler and performs a retry, if required as per the - retry policy. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Prepares the request for retry. - - Request context containing the state of the request. - - - - The default implementation of the standard retry policy. - - - The default implementation of the standard policy. - - - - - The maximum value of exponential backoff in milliseconds, which will be used to wait - before retrying a request. The default is 20000 milliseconds. - - - - - Constructor for StandardRetryPolicy. - - The maximum number of retries before throwing - back a exception. This does not count the initial request. - - - - Constructor for StandardRetryPolicy. - - The Client config object. This is used to - retrieve the maximum number of retries before throwing - back a exception(This does not count the initial request) and - the service URL for the request. - - - - Returns true if the request is in a state where it can be retried, else false. - - Request context containing the state of the request. - Returns true if the request is in a state where it can be retried, else false. - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - true if the error that will be retried is a throtting error - - - - Virtual method that gets called on a success Response. If its a retry success response, the entire - retry acquired capacity is released(default is 5). If its just a success response a lesser value capacity - is released(default is 1). - - Request context containing the state of the request. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Request context containing the state of the request. - Return true if the request should be retried. - - - - Checks if the retry limit is reached. - - Request context containing the state of the request. - Return false if the request can be retried, based on number of retries. - - - - Waits before retrying a request. The default policy implements a exponential backoff with - jitter algorithm. - - Request context containing the state of the request. - - - - Waits for an amount of time using an exponential backoff with jitter algorithm. - - The request retry index. The first request is expected to be 0 while - the first retry will be 1. - The max number of milliseconds to wait - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - This class is the base class of all the configurations settings to connect - to a service. - - - This class is the base class of all the configurations settings to connect - to a service. - - - - - Gets Service Version - - - - - Gets and sets of the signatureMethod property. - - - - - Gets and sets of the SignatureVersion property. - - Note: This property exists for backward compatibility but is no longer - used by any service other than S3. - - - - - Gets and sets of the UserAgent property. - - - - - Gets and sets the RegionEndpoint property. The region constant that - determines the endpoint to use. - - Setting this property to null will force the SDK to recalculate the - RegionEndpoint value based on App/WebConfig, environment variables, - profile, etc. - - - - - The constant used to lookup in the region hash the endpoint. - - - - - Gets and sets of the ServiceURL property. - This is an optional property; change it - only if you want to try a different service - endpoint. - - - - - Gets and sets the UseHttp. - If this property is set to true, the client attempts - to use HTTP protocol, if the target endpoint supports it. - By default, this property is set to false. - - - - - Given this client configuration, return a string form ofthe service endpoint url. - - - - - Gets and sets the AuthenticationRegion property. - Used in AWS4 request signing, this is an optional property; - change it only if the region cannot be determined from the - service endpoint. - - - - - Gets and sets the AuthenticationServiceName property. - Used in AWS4 request signing, this is the short-form - name of the service being called. - - - - - Returns the flag indicating how many retry HTTP requests an SDK should - make for a single SDK operation invocation before giving up. This flag will - return 4 when the RetryMode is set to "Legacy" which is the default. For - RetryMode values of "Standard" or "Adaptive" this flag will return 2. In - addition to the values returned that are dependant on the RetryMode, the - value can be set to a specific value by using the AWS_MAX_ATTEMPTS environment - variable, max_attempts in the shared configuration file, or by setting a - value directly on this property. When using AWS_MAX_ATTEMPTS or max_attempts - the value returned from this property will be one less than the value entered - because this flag is the number of retry requests, not total requests. To - learn more about the RetryMode property that affects the values returned by - this flag, see . - - - - - Determines if MaxErrorRetry has been manually set. - - - - - Gets and sets the LogResponse property. - If this property is set to true, the service response is logged. - The size of response being logged is controlled by the AWSConfigs.LoggingConfig.LogResponsesSizeLimit property. - - - - - Gets and sets the ReadEntireResponse property. - NOTE: This property does not effect response processing and is deprecated. - To enable response logging, the ClientConfig.LogResponse and AWSConfigs.LoggingConfig - properties can be used. - - - - - Gets and Sets the BufferSize property. - The BufferSize controls the buffer used to read in from input streams and write - out to the request. - - - - - - Gets or sets the interval at which progress update events are raised - for upload operations. By default, the progress update events are - raised at every 100KB of data transferred. - - - If the value of this property is set less than ClientConfig.BufferSize, - progress updates events will be raised at the interval specified by ClientConfig.BufferSize. - - - - - - Flag on whether to resign requests on retry or not. - For Amazon S3 and Amazon Glacier this value will always be set to true. - - - - - This flag controls if .NET HTTP infrastructure should follow redirection - responses (e.g. HTTP 307 - temporary redirect). - - - - - Flag on whether to log metrics for service calls. - - This can be set in the application's configs, as below: - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSLogMetrics" value"true"/> - </appSettings> - </configuration> - - - - - - Gets and sets the DisableLogging. If true logging for this client will be disabled. - - - - - Credentials to use with a proxy. - - - - - - If the value is set, the value is assigned to the Timeout property of the HttpWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Configures the endpoint calculation for a service to go to a dual stack (ipv6 enabled) endpoint - for the configured region. - - - Note: AWS services are enabling dualstack endpoints over time. It is your responsibility to check - that the service actually supports a dualstack endpoint in the configured region before enabling - this option for a service. - - - - - Enable or disable the Retry Throttling feature by setting the ThrottleRetries flag to True/False resepctively. - Retry Throttling is a feature that intelligently throttles retry attempts when a large precentage of requests - are failing and retries are unsuccessful as well. In such situations the allotted retry capacity for the service URL - will be drained until requests start to succeed again. Once the requisite capacity is available, retries would - be permitted again. When retries are throttled, the service enters a fail-fast behaviour as the traditional retry attempt - for the request would be circumvented. Hence, errors will resurface quickly. This will result in a greated number of exceptions - but prevents requests being tied up in unsuccessful retry attempts. - Note: Retry Throttling is enabled by default. Set the ThrottleRetries flag to false to switch off this feature. - - - - - Enable or disable the Nagle algorithm on the underlying http - client. - - This method is not intended to be called by consumers of the AWS SDK for .NET - - - - - - Performs validation on this config object. - Throws exception if any of the required values are missing/invalid. - - - - - Returns the current UTC now after clock correction for this endpoint. - - - - - The calculated clock skew correction for a specific endpoint, if there is one. - This field will be set if a service call resulted in an exception - and the SDK has determined that there is a difference between local - and server times. - - If is set to true, this - value will still be set to the correction, but it will not be used by the - SDK and clock skew errors will not be retried. - - - - - Gets and sets the DisableHostPrefixInjection flag. If true, host prefix injection will be disabled for this client, the default value of this flag is false. - Host prefix injection prefixes the service endpoint with request members from APIs which use this feature. - Example: for a hostPrefix of "foo-name." and a endpoint of "service.region.amazonaws.com" the default behavior is to - prefix the endpoint with the hostPrefix resulting in a final endpoint of "foo-name.service.region.amazonaws.com". Setting - DisableHostPrefixInjection to true will disable hostPrefix injection resulting in a final endpoint of - "service.region.amazonaws.com" regardless of the value of hostPrefix. E.g. You may want to disable host prefix injection for testing against a local mock endpoint. - - - - - Returns the flag indicating if endpoint discovery should be enabled or disabled for operations that are not required to use endpoint discovery. - - - - - Returns the maximum number of discovered endpoints that can be stored within the cache for the client. The default limit is 1000 cache entries. - - - - - Returns the flag indicating the current mode in use for request - retries and influences the value returned from . - The default value is RequestRetryMode.Legacy. This flag can be configured - by using the AWS_RETRY_MODE environment variable, retry_mode in the - shared configuration file, or by setting this value directly. - - - - - Under Adaptive retry mode, this flag determines if the client should wait for - a send token to become available or don't block and fail the request immediately - if a send token is not available. - - - - - Throw an exception if the boxed TimeSpan parameter doesn't have a value or is out of range. - - - - - Returns the request timeout value if its value is set, - else returns client timeout value. - - - - - - This is a switch used for performance testing and is not intended for production applications - to change. This switch may be removed in a future version of the SDK as the .NET Core platform matures. - - - If true, the HttpClient is cached and reused for every request made by the service client - and shared with other service clients. - - - For the .NET Core platform this is default to true because the HttpClient manages the connection - pool. - - - - - - If CacheHttpClient is set to true then HttpClientCacheSize controls the number of HttpClients cached. - - On Windows the default value is 1 since the underlying native implementation does not have throttling constraints - like the non Windows Curl based implementation. For non Windows based platforms the default is the value return from - System.Environment.ProcessorCount. - - - - - - Overrides the default read-write timeout value. - On Unity platform, this value is not used as Unity HTTP client does not support timeouts, so - - - - If the value is set, the value is assigned to the ReadWriteTimeout property of the HttpWebRequest object used - to send requests. - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Returns a WebProxy instance configured to match the proxy settings - in the client configuration. - - - - - Unpacks the host, port and any credentials info into the instance's - proxy-related fields. - Unlike the SetWebProxy implementation on .NET 3.5/4.5,the Host and the Port are not reconstructed from the - input proxyuri - - The proxy details - - - - Gets and sets of the ProxyHost property. - - - - - Gets and sets of the ProxyPort property. - - - - - - Returns true if the clients should be cached by HttpRequestMessageFactory, false otherwise. - - - - - - - Returns true if the SDK should dispose HttpClients after one use, false otherwise. - - - - - - - Create a unique string used for caching the HttpClient based on the settings that are used from the ClientConfig that are set on the HttpClient. - - - - - - - Determines if HttpClients created with the given IClientConfig should be cached at the SDK - client level, or cached globally. - - If there is no HttpClientFactory assigned and proxy or proxy credentials are set - this returns false because those properties can't be serialized as part of the key in the global http client cache. - - - - - Base class for constant class that holds the value that will be sent to AWS for the static constants. - - - - - Gets the value that needs to be used when send the value to AWS - - - - - Attempt to find correct-cased constant value using whatever cased value the user - has provided. This is primarily useful for mapping any-cased values from a CLI - tool to the specific casing required by the service, avoiding the need for the - user to (a) remember the specific case and (b) actually type it correctly. - - The properly cased service constant matching the value - - - - Utility class that stores clock skew information. - - - - - GlobalClockCorrection should be only set by AWSConfigs.ManualClockCorrection property - and is only available to maintain backward compatibilty. This should override any - endpoint specific clockskew correction. - - - - - Return clock skew correction value for an endpoint if there is one. - - AWSConfigs.ManualClockCorrection overrides globally any calculated service endpoint specific - clock correction value. - - Endpoint should in a form such as "https://s3" - Clock correction value for an endpoint in TimeSpan. TimeSpan.Zero if no such clock correction is set. - - - - Get clock skew corrected UTC now value. If ManualClockCorrection is set, - use ManualClockCorrection instead of endpoint specific clock correction value. - - - - - - - Probing mechanism to determine the endpoint discovery enabled value from various sources. - - - - - The valid hashing algorithm supported by the sdk for request signing. - - - - - Which end of a request was responsible for a service error response. - - - - - The sender was responsible for the error, i.e. the client - request failed validation or was improperly formatted. - - - - - The error occured within the service. - - - - - An unrecognized error type was returned. - - - - - Sts Regional Endpoints Value determines whether or not - to send the sts request to the regional endpoint or to - the global sts endpoint - - - - - Send the request to the global sts endpoint - if the region is a legacy global region - - - - - Send the request to the regional endpoint - - - - - S3 US East 1 endpoint value determines wheter or not - to send the us-east-1 s3 requests to the regional endpoint or to - the legacy global endpoint - - - - - Sends the requests to the legacy global s3 endpoint for us-east-1 - - - - - Sends the request to the regional s3 endpoint for us-east-1 - - - - - RetryMode determines which request retry mode is used for requests that do - not complete successfully. - - - - - Legacy request retry strategy. - - - - - Standardized request retry strategy that is consistent across all SDKs. - - - - - An experimental request retry strategy that builds on the Standard strategy - and introduces congestion control through client side rate limiting. - - - - - All Amazon service interfaces like IAmazonS3 extend from this interface. This allows all the - Amazon service interfaces be identified by this base interface and helps with generic constraints. - - - - - A readonly view of the configuration for the service client. - - - - - This interface is the read only access to the ClientConfig object used when setting up service clients. Once service clients - are initiated the config object should not be changed to avoid issues with using a service client in a multi threaded environment. - - - - - Gets the RegionEndpoint property. The region constant to use that - determines the endpoint to use. If this is not set - then the client will fallback to the value of ServiceURL. - - - - - The constant used to lookup in the region hash the endpoint. - - - - - Gets and sets of the ServiceURL property. - This is an optional property if you need to set a specific service URL - instead setting the region with the RegionEndpoint property. - - - - - Gets the UseHttp property. - If this property is set to true, the client attempts - to use HTTP protocol. - By default, this property is set to false. - - - - - Gets Service Version - - - - - Gets the signatureMethod property. - - - - - Gets the SignatureVersion property. - - Note: This property exists for backward compatibility but is no longer - used by any service other than S3. - - - - - Gets the AuthenticationRegion property. - Used in AWS4 request signing, this is an optional property; - change it only if the region cannot be determined from the - service endpoint. - - - - - Gets the AuthenticationServiceName property. - Used in AWS4 request signing, this is the short-form - name of the service being called. - - - - - Gets the UserAgent property. - - - - - Gets the DisableLogging. If true logging for this client will be disabled. - - - - - Flag on whether to log metrics for service calls. - - This can be set in the application's configs, as below: - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSLogMetrics" value"true"/> - </appSettings> - </configuration> - - - - - - Gets the LogResponse property. - If this property is set to true, the service response - is read in its entirety and logged. - - - - - Gets the ReadEntireResponse. - If this property is set to true, the service response - is read in its entirety before being processed. - - - - - This flag controls if .NET HTTP infrastructure should follow redirection - responses (e.g. HTTP 307 - temporary redirect). - - - - - Gets the BufferSize property. - The BufferSize controls the buffer used to read in from input streams and write - out to the request. - - - - - Returns the flag indicating how many retry HTTP requests an SDK should - make for a single SDK operation invocation before giving up. This flag will - return 4 when the RetryMode is set to "Legacy" which is the default. For - RetryMode values of "Standard" or "Adaptive" this flag will return 2. In - addition to the values returned that are dependant on the RetryMode, the - value can be set to a specific value by using the AWS_MAX_ATTEMPTS environment - variable, max_attempts in the shared configuration file, or by setting a - value directly on this property. When using AWS_MAX_ATTEMPTS or max_attempts - the value returned from this property will be one less than the value entered - because this flag is the number of retry requests, not total requests. To - learn more about the RetryMode property that affects the values returned by - this flag, see . - - - - - Determines if MaxErrorRetry has been manually set. - - - - - Gets the interval at which progress update events are raised - for upload operations. By default, the progress update events are - raised at every 100KB of data transferred. - - - - - Flag on whether to resign requests on retry or not. - - - - - Credentials to use with a proxy. - - - - - Gets the default request timeout value. - - - - If the value is set, the value is assigned to the Timeout property of the HTTPWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - - - - Configures the endpoint calculation for a service to go to a dual stack (ipv6 enabled) endpoint - for the configured region. - - - Note: AWS services are enabling dualstack endpoints over time. It is your responsibility to check - that the service actually supports a dualstack endpoint in the configured region before enabling - this option for a service. - - - - - Configures a flag enabling to either opt in or opt out of the retry throttling service. - Note: set value to true to enable retry throttling feature. The Default value for this flag is false. - - - - - Using either the RegionEndpoint or the ServiceURL determine what the URL to the service is. - - The URL to the service. - - - - Performs validation on this config object. - Throws exception if any of the required values are missing/invalid. - - The timeout specified is null. - - - - Returns the clock skew adjusted utc now. This value is affected by AWSConfigs.ManualClockCorrection - - - - - Returns the calculated clock skew value for this config's service endpoint. If AWSConfigs.CorrectForClockSkew is false, - this value won't be used to construct service requests. - - - - - Gets the DisableHostPrefixInjection flag. If true, host prefix injection will be disabled for this client, the default value of this flag is false. - Host prefix injection prefixes the service endpoint with request members from APIs which use this feature. - Example: for a hostPrefix of "foo-name." and a endpoint of "service.region.amazonaws.com" the default behavior is to - prefix the endpoint with the hostPrefix resulting in a final endpoint of "foo-name.service.region.amazonaws.com". Setting - DisableHostPrefixInjection to true will disable hostPrefix injection resulting in a final endpoint of - "service.region.amazonaws.com" regardless of the value of hostPrefix. E.g. You may want to disable host prefix injection for testing against a local mock endpoint. - - - - - Returns the flag indicating if endpoint discovery should be enabled or disabled for operations that are not required to use endpoint discovery. - - - - - Returns the maximum number of discovered endpoints that can be stored within the cache for the client. The default limit is 1000 cache entries. - - - - - Returns the flag indicating the current mode in use for request - retries and influences the value returned from . - The default value is RequestRetryMode.Legacy. This flag can be configured - by using the AWS_RETRY_MODE environment variable, retry_mode in the - shared configuration file, or by setting this value directly. - - - - - Under Adaptive retry mode, this flag determines if the client should wait for - a send token to become available or don't block and fail the request immediately - if a send token is not available. - - - - - - This is a switch used for performance testing and is not intended for production applications - to change. This switch may be removed in a future version of the SDK as the .NET Core platform matures. - - - If true, the HttpClient is cached and reused for every request made by the service client - and shared with other service clients. - - - For the .NET Core platform this is default to true because the HttpClient manages the connection - pool. - - - - - - If CacheHttpClient is set to true then HttpClientCacheSize controls the number of HttpClients cached. - - - - - Gets the ProxyHost property. - - - - - Gets the ProxyPort property. - - - - - Returns a WebProxy instance configured to match the proxy settings - in the client configuration. - - - - - - Interface for a single logged message. - - - - - Log message format. - - - - - Log message arguments. - - - - - Culture-specific formatting provider. - - - - - Abstract parameter value. - - - - - String parameter value. - - - - - String value of the parameter. - - - - - Constructs ParameterValue for a single string. - - - - - - String list parameter value. - - - - - List of strings value of the parameter. - - - - - Constructs ParameterValue for a list of strings. - - - - - - Metrics collected by the SDK on a per-request basis. - - - Each request made to an AWS service by the SDK can have metrics - collected and logged. This interface represents the collected - metrics for a request. The metrics include properties (i.e. request id - and other metadata), timings for each stage of the request, and counters. - - - - - Collection of properties being tracked - - - - - Timings for metrics being tracked - - - - - Counters being tracked - - - - - Whether metrics are enabled for the request - - - - - JSON representation of the current metrics - - JSON string - - - - Represents how long a phase of an SDK request took. - - - - - Whether the timing has been stopped - - - - - Elapsed ticks from start to stop. - If timing hasn't been stopped yet, returns 0. - - - - - Elapsed time from start to stop. - If timing hasn't been stopped yet, returns TimeSpan.Zero - - - - - User supplied type to perform metrics formatting. - - - - - Produce custom formatting for SDK metrics. - - - If defined, this method will be called for every request made by the SDK. - - An instance of IRequestMetrics produced by the SDK - formatted string representation of the metrics - - - - Predefined request metrics that are collected by the SDK. - - - - - Information about the request. - - - - - Gets and sets the RequestId property. - ID that uniquely identifies a request. Amazon keeps track of request IDs. If you have a question about a request, include the request ID in your correspondence. - - - - - This exception is thrown if there are problems signing the request. - - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - - - - Gets the percentage of transfer completed - - - - - Gets the number of bytes transferred since last event - - - - - Gets the number of bytes transferred - - - - - Gets the total number of bytes to be transferred - - - - - Returns a string representation of this object - - - - - - Anonymous credentials. - Using these credentials, the client does not sign the request. - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - AWS Credentials that automatically refresh by calling AssumeRole on - the Amazon Security Token Service. - - - - - The credentials of the user that will be used to call AssumeRole. - - - - - The Amazon Resource Name (ARN) of the role to assume. - - - - - An identifier for the assumed role session. - - - - - Options to be used in the call to AssumeRole. - - - - - Constructs an AssumeRoleAWSCredentials object. - - The credentials of the user that will be used to call AssumeRole. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - - - - Constructs an AssumeRoleAWSCredentials object. - - The credentials of the user that will be used to call AssumeRole. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRole. - - - - A unique identifier that is used by third parties when assuming roles in their customers' accounts. - - - - - An IAM policy in JSON format. - - - - - The length of time in seconds before the credentials will expire. - - - - - The identification number of the MFA device that is associated with the user who is making the assume-role call. - - - - - The value provided by the MFA device, if the trust policy of the role being assumed requires MFA. - - - - - A callback that's used to obtain the MFA token code when the AssumeRoleAWSCredentials are refreshed. - - - - - Immutable representation of AWS credentials obtained as a result of - authenticating with the AssumeRole method of the Security Token Service. - - - - - The expiry time of the credentials, obtained from the AssumeRoleResponse. - - - - - Constructs an instance with supplied keys, token, and expiration. - - The AccessKey for the credentials. - The SecretKey for the credentials. - The security token for the credentials. - The expiration time for the credentials. - - - - Get a copy of this AssumeRoleImmutableCredentials object. - - A copy of this object. - - - - Abstract class that represents a credentials object for AWS services. - - - - - Returns a copy of ImmutableCredentials - - - - - - Called by AmazonServiceClient to validate the credential state - on client construction. - - - - - Basic set of credentials consisting of an AccessKey and SecretKey - - - - - Constructs a BasicAWSCredentials object for the specified accessKey and secretKey. - - - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - Immutable representation of AWS credentials. - - - - - Gets the AccessKey property for the current credentials. - - - - - Gets the SecretKey property for the current credentials. - - - - - Gets the Token property for the current credentials. - - - - - Gets the UseToken property for the current credentials. - Specifies if Token property is non-emtpy. - - - - - Constructs an ImmutableCredentials object with supplied accessKey, secretKey. - - - - Optional. Can be set to null or empty for non-session credentials. - - - - Returns a copy of the current credentials. - - - - - - Abstract class for automatically refreshing AWS credentials - - - - - Refresh state container consisting of credentials - and the date of the their expiration - - - - - Represents the current state of the Credentials. - - This can be cleared without synchronization. - - - - Semaphore to control thread access to GetCredentialsAsync method. - The semaphore will allow only one thread to generate new credentials and - update the current state. - - - - - The time before actual expiration to expire the credentials. - Property cannot be set to a negative TimeSpan. - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - Test credentials existence and expiration time - should update if: - credentials have not been loaded yet - it's past the expiration time. At this point currentState.Expiration may - have the PreemptExpiryTime baked into to the expiration from a call to - UpdateToGeneratedCredentials but it may not if this is new application load. - - - - - When overridden in a derived class, generates new credentials and new expiration date. - - Called on first credentials request and when expiration date is in the past. - - - - - - When overridden in a derived class, generates new credentials and new expiration date. - - Called on first credentials request and when expiration date is in the past. - - - - - - Clears currently-stored credentials, forcing the next GetCredentials call to generate new credentials. - - - - - Immutable representation of AWS credentials obtained as a result of - authenticating against a SAML-supporting federated identity provider. - - - - - The expiry time of the credentials, obtained from the AssumeRoleWithSAML response. - - - - - The value of the NameID element in the Subject element of the SAML assertion, as returned in the - AssumeRoleWithSAML response from the Security Token Service. - - - - - Constructs an instance with supplied keys and SAML assertion data. - - - - - - - - - - Constructs an instance with supplied keys and SAML assertion data. - - - - - - - - Returns a copy of the current credentials. - - - - - - Serializes the instance to a json-format string for external storage - - The serialized object in json - - - - Instantiates an instance from persisted json data - - The serialized data - Deserialized instance corresponding to the json data - - - - Session credentials consisting of AccessKey, SecretKey and Token - - - - - Constructs a SessionAWSCredentials object for the specified accessKey, secretKey. - - - - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - Credentials that are retrieved from the Instance Profile service on an EC2 instance - - - - - Constructs a InstanceProfileAWSCredentials object for specific role - - Role to use - - - - Constructs a InstanceProfileAWSCredentials object for the first found role - - - - - Retrieves a list of all roles available through current InstanceProfile service - - InstanceProfileAWSCredentials is no longer supported in PCL. - - - - - - Superclass for Exceptions that come over the event stream, or to wrap other kinds of generic exceptions. - - - - - The numeric code identifier for the type of error. - - - - - Constructs an EventStreamError. - - - - - Constructs an EventStreamError. - - The error code. - The error message. - - - - Event args that contain an . - - The - - - - The EventStream Event. - - - - - Constructs an EventStreamEventReceivedArgs. - - The EventStream Event. - - - - Event args that contain an . - - The . - - - - The EventStream Exception. - - - - - Constructs an EventStreamExceptionReceivedArgs. - - The EventStream Exception. - - - - Supported Header types for vnd.amazon.event-stream - - - - - Name for the Header. Maximum of 255 bytes. - - - - - Header type id - - - - - Computes the amount of memory neccesary to serialize this Header. - - - - - Writes this Header to buffer starting at offset - Keep in mind, this API assumes buffer is large enough - for the operation. - - buffer to serialize this Header to - offset to begin writing at. - - the new offset. - - - - - Returns the current value as a bool - - - - - Sets the current value - - - - - Returns the current value as a byte - - - - - Sets the current value - - - - - Gets the current value as a 16 bit integer. (Host Order). - - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a 32 bit integer. (Host Order) - - - - - Sets the current value - - - - - returns the current value as a 64-bit integer. (Host Order) - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a byte buffer. - - - - - - Sets the current value. Max length is 2^15 - 1 - - - - - Returns the current value as a utf-8 string. - - - - - Sets the current value. Utf-8 encoded. Max byte size is 2^16 - 1 - - - - - Gets the current value as a DateTime. - Note: You do not need to compensate for unix epoch on this API. - - - - - - Sets the current value. - Note: You do not need to compensate for unix epoch on this API. - - - - - Returns the current value as a Guid (UUID) - - - - - Sets the current value - - - - - Header Data for an EventStreamMessage - - Each header is of format: - [name len] (1) | [utf-8 name] (v) - [type (1)] - [value (v)] - - - - - Name for the Header. Maximum of 255 bytes. - - - - - Header type id - - - - - Initializes this Header with name. - - utf-8 string, max length is 255 - - - - Deserializes the header in buffer. - - buffer constaining the header - index to start from in the buffer. - updated offset with new value for offset - - - - Writes this Header to buffer starting at offset - Keep in mind, this API assumes buffer is large enough - for the operation. - - buffer to serialize this Header to - offset to begin writing at. - - the new offset. - - - - - Computes the amount of memory neccesary to serialize this Header. - - - - - Returns the current value as a bool - - - - - Sets the current value - - - - - Returns the current value as a byte - - - - - Sets the current value - - - - - Gets the current value as a 16 bit integer. (Host Order). - - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a 32 bit integer. (Host Order) - - - - - Sets the current value - - - - - returns the current value as a 64-bit integer. (Host Order) - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a byte buffer. - - - - - - Sets the current value. Max length is 2^15 - 1 - - - - - Returns the current value as a utf-8 string. - - - - - Sets the current value. Utf-8 encoded. Max byte size is 2^16 - 1 - - - - - Gets the current value as a DateTime. - Note: You do not need to compensate for unix epoch on this API. - - - - - - Sets the current value. - Note: You do not need to compensate for unix epoch on this API. - - - - - Returns the current value as a Guid (UUID) - - - - - Sets the current value - - - - - Headers for the message. Can be null. - - - - - Payload for the message. Can be null. - - - - - Converts a message into a byte buffer (usually for network transmission). - - - - - Message is a single datagram. The format is as follows: - [ total length (4) ] | [ headers_length (4)] | [ prelude crc(4)] - [ headers (v)] - [ payload (v)} - [ trailing crc ] - - CRCs use the CRC32 algorithm. - - - - - Content type for EventStreams. - - - - - Headers for the message. Can be null. - - - - - Payload for the message. Can be null. - - - - - Initialize a message with headers and a payload. - - list of headers for the message, can be null. - payload for the message, can be null. - - - - Builds a message from buffer. - - buffer to read - offset to start reading - buffer length. - - parsed instance of EventStreamMessage. Doesn't return null, - does throw if CRCs don't match. - - - - - Converts a message into a byte buffer (usually for network transmission). - - - - - Defines exceptions that arise from an not conforming to specification. - - - - - Constructs an EventStreamValidationException. - - - - - Constructs an EventStreamValidationException. - - The exception message. - - - - Constructs an EventStreamValidationException. - - The exception message. - The inner exception. - - - - This exception is thrown if an exception is retrieved from the event stream and should be modeled, - but a generator function for the strongly-typed exception is not defined. - - - - - The exception type. - - - - - Constructs an EventStreamException. - - The exception type. - - - - The contract for the . - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - A subclass of that enables an enumerable interface for interacting with Events. - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - Flag if the stream was chosen to be enumerated. - - - - - A Stream of Events. Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treated as mutually exclusive. - - - - - A Stream of Events. Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treated as mutually exclusive. - - - - - Returns an enumerator that iterates through the collection. - - An enumerator that can be used to iterate through the collection. - - - - Returns an enumerator that iterates through a collection. - - An object that can be used to iterate through the collection. - - - - Starts the background thread to start reading events from the network stream. - - - - - The contract for the . - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - The size of the buffer for reading from the network stream. - - - - - Fires when an event is received. - - - - - Fired when an exception or error is raised. - - - - - Starts the background thread to start reading events from the network stream. - - - - - The superclass for all EventStreams. It contains the common processing logic needed to retreive events from a network Stream. It - also contains the mechanisms needed to have a background loop raise events. - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - "Unique" key for unknown event lookup. - - - - - Header key for message type. - - - - - Header key for event type. - - - - - Header key for exception type. - - - - - Header key for error code. - - - - - Header key for error message. - - - - - Value of when the message is an event. - - - - - Value of when the message is an exception. - - - - - Value of when the message is an error. - - - - - The size of the buffer for reading from the network stream. - Default is 8192. - - - - - The underlying stream to read events from. - - - - - Responsible for decoding events from sequences of bytes. - - - - - Fires when an event is recieved. - - - - - Fired when an exception or error is raised. - - - - - The mapping of event message to a generator function to construct the matching Event Stream event. - - - - - The mapping of event message to a generator function to construct the matching Event Stream exception. - - - - - Whether the Stream is currently being processed. - - - - - A Stream of Events. Events can be retrieved from this stream by attaching handlers to listen events, and then calling StartProcessing. - - - - - A Stream of Events. Events can be retrieved from this stream by attaching handlers to listen events, and then calling StartProcessing. - - - - - Converts an EventStreamMessage to an event. - - The event stream message to be converted. - The event - - - - Abstraction for cross-framework initiation of the background thread. - - - - - The background thread main loop. It will constantly read from the network stream until IsProcessing is false, or an error occurs. - - This stub exists due to FXCop. - - - - - The background thread main loop. It will constantly read from the network stream until IsProcessing is false, or an error occurs. - - Needed for 3.5 support. Not used. - - - - Reads from the stream into the buffer. It then passes the buffer to the decoder, which raises an event for - each message it decodes. - - The buffer to store the read bytes from the stream. - - - - Wraps exceptions in an outer exception so they can be passed to event handlers. If the Exception is already of a compatable type, - the method returns what it was given. - - The exception to wrap. - An exception of type TE - - - - Starts the background thread to start reading events from the network stream. - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Disposes the resources of this stream. - - Should dispose of unmanged resources. - - - - Event Arguments for EventStreamDecoder.MessageReceived. - - - - - Received message. - - - - - Additional object context - - - - - Initialize this with message - - - - - Initialize this with message and object conetext - - - - - Exception thrown when a request is made of the Decoder, but the internal state - machine is an invalid state. This is usually the result of an interanl exception - being thrown during parsing of the network stream. - - - - - Contract for EventStreamDecoder - - - - - Invoked anytime an EventStreamMessage is found. - - - - - Processes data starting at offset up to length. - Invokes MessageRecieved for each message encountered. - If an exception is thrown, this object is not safe for reuse. - - buffer to read - offset in buffer to start reading. - length of data. - - - - Streaming decoder for listening for incoming EventStreamMessage datagrams. - - - - - Invoked anytime an EventStreamMessage is found. - - - - - Object data (optional) that can be passed to the event handler for MessageReceived. - - - - - Default constructor. Initializes internal _state machine. - - - - - Processes data starting at offset up to length. - Invokes MessageRecieved for each message encountered. - If an exception is thrown, this object is not safe for reuse. - - buffer to read - offset in buffer to start reading. - length of data. - - - - Superclass for Exceptions that come over the event stream, or to wrap other kinds of generic exceptions. - - - - - Constructs an EventStreamException. - - - - - Constructs an EventStreamException. - - The exception message. - - - - Constructs an EventStreamException. - - The exception message. - The inner exception. - - - - The contract for EventStream events. - - - - - The contract for EventStream terminal events. - - - - - This Event is returned if an event is retrieved from the event stream, but a generator function - for the event is not defined. This can occur if the SDK is not updated after a new event type is introduced. - - - - - The Message recieved from the event stream before conversion. - - - - - The event type. - - - - - Constructs an UnknownEventStreamEvent. - - - - - Constructs an UnknownEventStreamEvent. - - The Message recieved from the event stream before conversion. - The event type. - - - - Signals that an an has an unknown message type. These exceptions whould be - swallowed to allow future expansion of the EventStream specification without breaking existing clients. - - - - - Constructs an UnknownEventStreamMessageTypeException. - - - - - Interface for a handler in a pipeline. - - - - - The logger used to log messages. - - - - - The inner handler which is called after the current - handler completes it's processing. - - - - - The outer handler which encapsulates the current handler. - - - - - Contains the processing logic for a synchronous request invocation. - This method should call InnerHandler.InvokeSync to continue processing of the - request by the pipeline, unless it's a terminating handler. - - The execution context which contains both the - requests and response context. - - - - Contains the processing logic for an asynchronous request invocation. - This method should call InnerHandler.InvokeSync to continue processing of the - request by the pipeline, unless it's a terminating handler. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - The interface for an exception handler. - - - - - Handles an exception for the given execution context. - - The execution context, it contains the - request and response context. - The exception to handle. - - Returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception to replace the original exception. - - - - - The interface for an exception handler with a generic parameter for the exception type. - - The exception type. - - - - Handles an exception for the given execution context. - - The execution context, it contains the - request and response context. - The exception to handle. - - Returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception to replace the original exception. - - - - - The interface for a HTTP request factory. - - The type used by the underlying HTTP API to represent the request body. - - - - Creates an HTTP request for the given URI. - - The request URI. - An HTTP request. - - - - The interface for an HTTP request that is agnostic of the underlying HTTP API. - - The type used by the underlying HTTP API to represent the HTTP request content. - - - - The HTTP method or verb. - - - - - The request URI. - - - - - Configures a request as per the request context. - - The request context. - - - - Sets the headers on the request. - - A dictionary of header names and values. - - - - Gets a handle to the request content. - - The request content. - - - - Returns the HTTP response. - - The HTTP response. - - - - Writes a stream to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - The request context. - - - - Writes a byte array to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - - - - Sets up the progress listeners - - The content stream - The interval at which progress needs to be published - The objects which is trigerring the progress changes - The callback which will be invoked when the progress changed event is trigerred - an object, incase the progress is setup, else returns the original stream - - - - Aborts the HTTP request. - - - - - Gets a handle to the request content. - - - - - - Returns the HTTP response. - - A cancellation token that can be used to cancel the asynchronous operation. - - - - - A factory which creates HTTP clients. - - - - - Create and configure an HttpClient. - - - - - - A factory which creates HTTP requests which uses System.Net.Http.HttpClient. - - - - - The constructor for HttpRequestMessageFactory. - - Configuration setting for a client. - - - - Creates an HTTP request for the given URI. - - The request URI. - An HTTP request. - - - - Disposes the HttpRequestMessageFactory. - - - - - Dispose the factory - - - - - - Create and configure a managed HttpClient instance. - The use of HttpClientHandler in the constructor for HttpClient implicitly creates a managed HttpClient. - If a native HttpClient is required the SDK user must implement IHttpClientFactory and provide an - instance via IClientConfig.HttpClientFactory (only available in PCL). - - - - - - - A cache of HttpClient objects. The GetNextClient method does a round robin cycle through the clients - to distribute the load even across. - - - - - Constructs a container for a cache of HttpClient objects - - The HttpClient to cache - - - - Returns the next HttpClient using a round robin rotation. It is expected that individual clients will be used - by more then one Thread. - - - - - - Disposes the HttpClientCache. - - - - - Dispose the HttpClientCache - - - - - - HTTP request wrapper for System.Net.Http.HttpRequestMessage. - - - - - Set of content header names. - - - - - The constructor for HttpWebRequestMessage. - - The HttpClient used to make the request. - The request URI. - The service client config. - - - - The underlying HttpClient - - - - - The underlying HTTP web request. - - - - - The HTTP method or verb. - - - - - The request URI. - - - - - Configures a request as per the request context. - - The request context. - - - - Sets the headers on the request. - - A dictionary of header names and values. - - - - Gets a handle to the request content. - - The request content. - - - - Returns the HTTP response. - - The HTTP response. - - - - Aborts the HTTP request. - - - - - Returns the HTTP response. - - A cancellation token that can be used to cancel the asynchronous operation. - - - - - Writes a stream to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - The request context. - - - - Writes a byte array to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - - - - Gets a handle to the request content. - - - - - - Disposes the HttpWebRequestMessage. - - - - - - - - - - - Sets up the progress listeners - - The content stream - The interval at which progress needs to be published - The objects which is trigerring the progress changes - The callback which will be invoked when the progress changed event is trigerred - an object, incase the progress is setup, else returns the original stream - - - - A retry policy specifies all aspects of retry behavior. This includes conditions when the request should be retried, - checks of retry limit, preparing the request before retry and introducing delay (backoff) before retries. - - - A retry policy specifies all aspects of retry behavior. This includes conditions when the request should be retried, - checks of retry limit, preparing the request before retry and introducing delay (backoff) before retries. - - - - - Maximum number of retries to be performed. - This does not count the initial request. - - - - - The logger used to log messages. - - - - - The standard set of throttling error codes - - - - - The standard set of timeout error codes to retry on. - - - - - List of AWS specific error codes which are returned as part of the error response. - These error codes will be retried. - - - - - The standard set of transient error, HTTP status codes to retry on. - 502 and 504 are returned by proxies. These can also be returned for - S3 accelerate requests which are served by CloudFront. - - - - - Set of web exception status codes to retry on. - - - - - This parameter serves as the value to the CapacityManager.Container datastructure. - Its properties include the available capacity left for making a retry request and the maximum - capacity size. - - - - - Checks if a retry should be performed with the given execution context and exception. - - The execution context which contains both the - requests and response context. - The exception thrown after issuing the request. - Returns true if the request should be retried, else false. The exception is retried if it matches with clockskew error codes. - - - - Returns true if the request is in a state where it can be retried, else false. - - The execution context which contains both the - requests and response context. - Returns true if the request is in a state where it can be retried, else false. - - - - Return true if the request should be retried for the given exception. - - The execution context which contains both the - requests and response context. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Checks if the retry limit is reached. - - The execution context which contains both the - requests and response context. - Return false if the request can be retried, based on number of retries. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called on a successful request response. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called before a retry request is initiated. The value - returned is True by default(retry throttling feature is disabled). - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called before a retry request is initiated. The value - returned is True by default(retry throttling feature is disabled). - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - - - - Virtual method that gets called before a retry request is initiated. The value - returned is True by default(retry throttling feature is disabled). - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - true if the error that will be retried is a throttling error - - - - This method uses a token bucket to enforce the maximum sending rate. - - The execution context which contains both the - requests and response context. - If the prior request failed, this exception is expected to be - the exception that occurred during the prior request failure. - - - - Determines if an AmazonServiceException is a throttling error - - The current exception to check. - true if it is a throttling error else false. - - - - Determines if an AmazonServiceException is a transient error that - should be retried. - - The current execution context - The current exception to check. - true if the exception is a transient error else false. - - - - Determines if the exception is a known timeout error code that - should be retried under the timeout error category. - - The current exception to check. - true if the exception is considered a timeout else false - - - - Checks if a retry should be performed with the given execution context and exception. - - The execution context which contains both the - requests and response context. - The exception throw after issuing the request. - Returns true if the request should be retried, else false. The exception is retried if it matches with clockskew error codes. - - - - This method uses a token bucket to enforce the maximum sending rate. - - The execution context which contains both the - requests and response context. - If the prior request failed, this exception is expected to be - the exception that occurred during the prior request failure. - - - - Return true if the request should be retried for the given exception. - - The execution context which contains both the - requests and response context. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - ICoreAmazonKMS is not meant to be used directly. It defines Key Management Service - with basic .NET types and allows other services to be able to use the service as - a runtime dependency. This interface is implemented by the AmazonKeyManagementServiceClient - defined in the AWSSDK.KeyManagementService assembly. - - - - - The result of the GenerateDataKey and GenerateDataKeyAsync operations. - - - - - The plaintext for the data key. - - - - - The ciphertext for the data key. - - - - - ICoreAmazonS3 is not meant to use directly. It defines S3 with basic .NET types - and allows other services to be able to use S3 as a runtime dependency. This interface - is implemented by the AmazonS3Client defined in the S3 assembly. - - - ICoreAmazonS3 is not meant to use directly. It defines S3 with basic .NET types - and allows other services to be able to use S3 as a runtime dependency. This interface - is implemented by the AmazonS3Client defined in the S3 assembly. - - - - - Generate a presigned URL. - - - - - - - - - - Get all the object keys for the particular bucket and key prefix. - - - - - - - - - Upload an object from a stream. - - - - - - - - - - - Delete an object. - - - - - - - - - - Delete an object. - - - - - - - - - - Open a stream to an object in S3. - - - - - - - - - - Upload an object from a file path. - - - - - - - - - - - Download an object in S3 to a file path. - - - - - - - - - - - Set the ACL on the object to public readable. - - - - - - - - Check to see if the bucket exists and if it doesn't create the bucket. - - - - - - Check to see if the bucket exists. - - - - - - - ICoreAmazonSQS is not meant to use directly. It defines SQS with basic .NET types - and allows other services to be able to use SQS as a runtime dependency. This interface - is implemented by the AmazonSQSClient defined in the SQS assembly. - - - - - Get the attributes for the queue identified by the queue URL asynchronously. - - The queue URL to get attributes for. - A Task containing the result of a dictionary of attributes for the queue. - - - - Set the attributes on the queue identified by the queue URL asynchronously. - - The queue URL to set the attributues. - The attributes to set. - A Task - - - - ICoreAmazonSTS is not meant to be used directly. It defines Security Token - service with basic .NET types and allows other services to be able to use the service as - a runtime dependency. This interface is implemented by the AmazonSecurityTokenServiceClient - defined in the AWSSDK.SecurityToken assembly. - - - - - - This method is used internally to access the Amazon Security Token - service within other service assemblies. - Please use AmazonSecurityTokenServiceClient to access the Amazon Security Token - service instead. - - Use Amazon Security Token Service to assume a role. - - Proxy settings that are required for the HTTPS and STS calls made during the authentication/credential - generation process are supported and should have been configured on the STS ClientConfig instance - associated with the STS client instance exposing this interface. - - - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRole. - - - - - CoreAmazonKMS is not meant to use directly. It implements ICoreAmazonKMS - and allows other service clients to be able to use the KMS service as a runtime dependency. - - This class waits until a method is actually called on the ICoreAmazonKMS interface - before requiring the KMS assembly to be present and loaded. - - - - - Settings for configuring a proxy for the SDK to use. - - - - - The host name or IP address of the proxy server. - - - - - The port number of the proxy. - - - - - The username to authenticate with the proxy server. - - - - - The password to authenticate with the proxy server. - - - - - Collection of one or more regular expressions denoting addresses - for which the proxy will not be used. - - - For more information on bypass lists - see https://msdn.microsoft.com/en-us/library/system.net.webproxy.bypasslist%28v=vs.110%29.aspx. - - - - - If true requests to local addresses bypass the configured - proxy. - - - - - Settings for logging in the SDK. - - - - - Logging destination. - - - - - When to log responses. - - - - - Gets or sets the size limit in bytes for logged responses. - If logging for response body is enabled, logged response - body is limited to this size. The default limit is 1KB. - - - - - Whether or not to log SDK metrics. - - - - - A custom formatter added through Configuration - - - - - This class can be used to discover the public address ranges for AWS. The - information is retrieved from the publicly accessible - https://ip-ranges.amazonaws.com/ip-ranges.json file. - - - The information in this file is generated from our internal system-of-record and - is authoritative. You can expect it to change several times per week and should - poll accordingly. - - - - - Region identifier string for ROUTE53 and CLOUDFRONT ranges - - - - - Collection of service keys found in the data file. - - - - - The publication date and time of the file that was downloaded and parsed. - - - - - Collection of all public IP ranges. - - - - - Filtered collection of public IP ranges for the given service key - - - - - Filtered collection of public IP ranges for the given region (us-east-1 etc) or GLOBAL. - - - - - Filtered collection of public IP ranges for the given network border group. - - - - - Downloads the most recent copy of the endpoint address file and - parses it to a collection of address range objects. - - - - - Downloads the most recent copy of the endpoint address file and - parses it to a collection of address range objects. - - - - - Represents the IP address range for a single region and service key. - - - - - The public IPv4 or Ipv6 address range, in CIDR notation. - - - - - Indicates ipv4 or v6 format of the address - - - - - The AWS region or GLOBAL for edge locations. Note that the CLOUDFRONT and ROUTE53 - ranges are GLOBAL. - - - - - The subset of IP address ranges. Specify AMAZON to get all IP address ranges - (for example, the ranges in the EC2 subset are also in the AMAZON subset). Note - that some IP address ranges are only in the AMAZON subset. - - - Valid values for the service key include "AMAZON", "EC2", "ROUTE53", - "ROUTE53_HEALTHCHECKS", and "CLOUDFRONT." If you need to know all of - the ranges and don't care about the service, use the "AMAZON" entries. - The other entries are subsets of this one. Also, some of the services, - such as S3, are represented in "AMAZON" and do not have an entry that - is specific to the service. We plan to add additional values over time; - code accordingly! - - - - - The network border group the IP address range belongs to. - - - AWS Local Zones allow you to seamlessly connect to the full range of services in the AWS Region such - as Amazon Simple Storage Service and Amazon DynamoDB through the same APIs and tool sets. You can extend - your VPC Region by creating a new subnet that has a Local Zone assignment. When you create a subnet in - a Local Zone, the VPC is also extended to that Local Zone. - - A network border group is a unique set of Availability Zones or Local Zones from where AWS advertises - public IP addresses. - - When you create a VPC that has IPv6 addresses, you can choose to assign a set of Amazon-provided public - IP addresses to the VPC and also set a network border group for the addresses that limits the addresses - to the group. When you set a network border group, the IP addresses cannot move between network - border groups. The us-west-2 network border group contains the four US West (Oregon) Availability Zones. - The us-west-2-lax-1 network border group contains the Los Angeles Local Zones. - - - - - This class defines utilities and constants that can be used by - all the client libraries of the SDK. - - - - - The user agent string header - - - - - The Set of accepted and valid Url characters per RFC3986. - Characters outside of this set will be encoded. - - - - - The Set of accepted and valid Url characters per RFC1738. - Characters outside of this set will be encoded. - - - - - The set of accepted and valid Url path characters per RFC3986. - - - - - The string representing Url Encoded Content in HTTP requests - - - - - The GMT Date Format string. Used when parsing date objects - - - - - The ISO8601Date Format string. Used when parsing date objects - - - - - The ISO8601Date Format string. Used when parsing date objects - - - - - The ISO8601 Basic date/time format string. Used when parsing date objects - - - - - The ISO8601 basic date format. Used during AWS4 signature computation. - - - - - The RFC822Date Format string. Used when parsing date objects - - - - - Returns an extension of a path. - This has the same behavior as System.IO.Path.GetExtension, but does not - check the path for invalid characters. - - - - - - Convert request parameters to Url encoded query string - - - Convert Dictionary of parameters to Url encoded query string - - - - Returns the canonicalized resource path for the service endpoint with single URL encoded path segments. - - Endpoint URL for the request - Resource path for the request - - If resourcePath begins or ends with slash, the resulting canonicalized - path will follow suit. - - Canonicalized resource path for the endpoint - - - - Returns the canonicalized resource path for the service endpoint - - Endpoint URL for the request - Resource path for the request - If true pre URL encode path segments if necessary. - S3 is currently the only service that does not expect pre URL encoded segments. - - If resourcePath begins or ends with slash, the resulting canonicalized - path will follow suit. - - Canonicalized resource path for the endpoint - - - - Returns the canonicalized resource path for the service endpoint - - Endpoint URL for the request - Resource path for the request - If true pre URL encode path segments if necessary. - S3 is currently the only service that does not expect pre URL encoded segments. - Dictionary of key/value parameters containing the values for the ResourcePath key replacements - The version of the marshaller that constructed the request object. - - If resourcePath begins or ends with slash, the resulting canonicalized - path will follow suit. - - Canonicalized resource path for the endpoint - - - - Splits the resourcePath at / into segments then resolves any keys with the path resource values. Greedy - key values will be split into multiple segments at each /. - - The patterned resourcePath - The key/value lookup for the patterned resourcePath - A list of path segments where all keys in the resourcePath have been resolved to one or more path segment values - - - - Joins all path segments with the / character and encodes each segment before joining. - - The segments of a URL path split at each / character - If the path property is specified, - the accepted path characters {/+:} are not encoded. - A joined URL with encoded segments - - - - Takes a patterned resource path and resolves it using the key/value path resources into - a segmented encoded URL. - - The patterned resourcePath - The key/value lookup for the patterned resourcePath - A segmented encoded URL - - - - Returns a new string created by joining each of the strings in the - specified list together, with a comma between them. - - The list of strings to join into a single, comma delimited - string list. - A new string created by joining each of the strings in the - specified list together, with a comma between strings. - - - - Attempt to infer the region for a service request based on the endpoint - - Endpoint to the service to be called - - Region parsed from the endpoint; DefaultRegion (or DefaultGovRegion) - if it cannot be determined/is not explicit - - - - - Attempt to infer the service name for a request (in short form, eg 'iam') from the - service endpoint. - - Endpoint to the service to be called - - Short-form name of the service parsed from the endpoint; empty string if it cannot - be determined - - - - - Utility method for converting Unix epoch seconds to DateTime structure. - - The number of seconds since January 1, 1970. - Converted DateTime structure - - - - Helper function to format a byte array into string - - The data blob to process - If true, returns hex digits in lower case form - String version of the data - - - - Calls a specific EventHandler in a background thread - - - - - - - - Parses a query string of a URL and returns the parameters as a string-to-string dictionary. - - - - - - - Utility method for converting a string to a MemoryStream. - - - - - - - Utility method for copy the contents of the source stream to the destination stream. - - - - - - - Utility method for copy the contents of the source stream to the destination stream. - - - - - - - - Formats the current date as a GMT timestamp - - A GMT formatted string representation - of the current date and time - - - - - Formats the current date as ISO 8601 timestamp - - An ISO 8601 formatted string representation - of the current date and time - - - - - Gets the ISO8601 formatted timestamp that is minutesFromNow - in the future. - - The number of minutes from the current instant - for which the timestamp is needed. - The ISO8601 formatted future timestamp. - - - - Formats the current date as ISO 8601 timestamp - - An ISO 8601 formatted string representation - of the current date and time - - - - - Gets the RFC822 formatted timestamp that is minutesFromNow - in the future. - - The number of minutes from the current instant - for which the timestamp is needed. - The ISO8601 formatted future timestamp. - - - - Determines whether the given string is an absolute path to a root. - - The hypothetical absolute path. - True if is an absolute path. - - - - Returns true if the path specified is relative to the current drive or working directory. - Returns false if the path is fixed to a specific drive or UNC path. This method does no - validation of the path (URIs will be returned as relative as a result). - - - Handles paths that use the alternate directory separator. It is a frequent mistake to - assume that rooted paths (Path.IsPathRooted) are not relative. This isn't the case. - "C:a" is drive relative- meaning that it will be resolved against the current directory - for C: (rooted, but relative). "C:\a" is rooted and not relative (the current directory - will not be used to modify the path). - - - - - True if the given character is a directory separator. - - - - - Returns true if the given character is a valid drive letter - - - - - URL encodes a string per RFC3986. If the path property is specified, - the accepted path characters {/+:} are not encoded. - - The string to encode - Whether the string is a URL path or not - The encoded string - - - - URL encodes a string per the specified RFC. If the path property is specified, - the accepted path characters {/+:} are not encoded. - - RFC number determing safe characters - The string to encode - Whether the string is a URL path or not - The encoded string - - Currently recognised RFC versions are 1738 (Dec '94) and 3986 (Jan '05). - If the specified RFC is not recognised, 3986 is used by default. - - - - - URL encodes a string per the specified RFC with the exception of preserving the encoding of previously encoded slashes. - If the path property is specified, the accepted path characters {/+:} are not encoded. - - The string to encode - Whether the string is a URL path or not - The encoded string with any previously encoded %2F preserved - - - - Convert bytes to a hex string - - Bytes to convert. - Hexadecimal string representing the byte array. - - - - Convert a hex string to bytes - - Hexadecimal string - Byte array corresponding to the hex string. - - - - Returns DateTime.UtcNow + ManualClockCorrection when - is set. - This value should be used instead of DateTime.UtcNow to factor in manual clock correction - - - - - Returns true if the string has any bidirectional control characters. - - - - - - - Executes an HTTP request and returns the response as a string. This method - throws WebException and HttpRequestException. In the event HttpRequestException - is thrown the StatusCode is sent as user defined data on the exception under - the key "StatusCode". - - The URI to make the request to - The request type: GET, PUT, POST - null or the content to send with the request - Timeout for the request - Proxy for the request - null or any headers to send with the request - The response as a string. - - - - Utility method that accepts a string and replaces white spaces with a space. - - - - - - - Class that contains result of executing an external process through the SDKs - AWSSDKUtils.RunProcess/AWSSDKUtils.RunProcessAsync - - - - - The exit code with which the process exited - - - - - The output of the process read till the end - - - - - The error output of the process read till the end - - - - - Object to track circular references in nested types. - At each level of nesting, make a call to Track to retrieve Tracker, - a tracking object implementing the IDisposable interface. - Dispose of this tracker when leaving the context of the tracked object. - - - - - Tracker. Must be disposed. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Adds the current target to a reference list and returns a tracker. - The tracker removes the target from the reference list when the - tracker is disposed. - - - - - - - Root AWS config - - - - - AwsHttpClient is a wrapper around HttpClient class of the System.Net.Http library. - The wrapper has been added so as to remove System.Net.Http dependencies from the Services - and migrate it to a Core level dependecy only. This avoids version clashes when a service - and the Core depends on different versions of the System.Net.Http library. This is a Service - level utility method - - - - - AWSHttpClient wrapper that is wrapped around - HttpClient default wrapper. - - - - - AWSHttpClient BaseAddress property that is wrapper for - HttpClient BaseAddress property. - - - - - AWSHttpClient Timeout property that is wrapper for - HttpClient Timeout property. - - - - - AWSHttpClient MaxResponseContentBufferSize property that is wrapper for - HttpClient MaxResponseContentBufferSize property. - - - - - AWSHttpClient GetStreamAsync that accepts the requester's URI - and make a HttpClient.GetStreamAsync call. - - Requester Uri - - - - Wrapper method that accepts a request uri, stream content and headers and makes a sendAsync call. - - - - - - - Wrapper for HttpClient's HttpRequestMessage and SendAsync methods. - - - - Returns response headers information- header name,value and status code - - - - Wrapper for HttpClient Dispose. - - - - - Method that checks if the passed exception is of type - HttpRequestException - - - - - - - AWSStreamContent is a wrapper for StreamContent class in - the System.Net.Http library.The wrapper has been added so as to - remove System.Net.Http dependencies from the Services - and migrate it to a Core level dependecy only. This avoids version clashes when a service - and the Core depends on different versions of the System.Net.Http library. This is a Service - level utility method - - - - - Wrapper for StreamContent constructor - for stream content - - - - - - Wrapper for StreamContent constructor - for stream content and bufferSize - - - - - - - Wrapper to allow Services to remove StreamContent Headers - - - - - - - Wrapper to allow Services to add StreamContent Headers - - - - - - - Wrapper for StreamContent Dispose. - - - - - Allows to configure the proxy used for HTTP requests. The default value is null. - - - - - This class contains the endpoints available to the AWS clients. The static constants representing the - regions can be used while constructing the AWS client instead of looking up the exact endpoint URL. - - - - - Gets the endpoint for a service in a region. - - The services system name. - If true returns the endpoint for dualstack - Thrown when the request service does not have a valid endpoint in the region. - - - - - Enumerate through all the regions. - - - - - Gets the region based on its system name like "us-west-1" - - The system name of the service like "us-west-1" - - - - - This is a testing method and should not be called by production applications. - - - - - Gets the system name of a region. - - - - - Gets the display name of a region. - - - - - This region name is non-standard. Search the whole endpoints.json file to - determine the partition this region is in. - - - - - This class contains region information used to lazily compute the service endpoints. The static constants representing the - regions can be used while constructing the AWS client instead of looking up the exact endpoint URL. - - - - - The US East (Virginia) endpoint. - - - - - The US East (Virginia) regional endpoint. - - - - - The US East (Ohio) endpoint. - - - - - The US West (N. California) endpoint. - - - - - The US West (Oregon) endpoint. - - - - - The EU North (Stockholm) endpoint. - - - - - The EU West (Ireland) endpoint. - - - - - The EU West (London) endpoint. - - - - - The EU West (Paris) endpoint. - - - - - The EU Central (Frankfurt) endpoint. - - - - - The Europe (Milan) endpoint. - - - - - The Asia Pacific (Hong Kong) endpoint. - - - - - The Asia Pacific (Tokyo) endpoint. - - - - - The Asia Pacific (Seoul) endpoint. - - - - - The Asia Pacific (Osaka-Local) endpoint. - - - - - The Asia Pacific (Mumbai) endpoint. - - - - - The Asia Pacific (Singapore) endpoint. - - - - - The Asia Pacific (Sydney) endpoint. - - - - - The South America (Sao Paulo) endpoint. - - - - - The US GovCloud East (Virginia) endpoint. - - - - - The US GovCloud West (Oregon) endpoint. - - - - - The China (Beijing) endpoint. - - - - - The China (Ningxia) endpoint. - - - - - The Canada (Central) endpoint. - - - - - The Middle East (Bahrain) endpoint. - - - - - The Africa (Cape Town) endpoint. - - - - - Represents the endpoint overridding rules in the endpoints.json - Is used to map private region (ie us-east-1-regional) to public regions (us-east-1) - For signing purposes. - - - - - Enumerate through all the regions. - - - - - Gets the region based on its system name like "us-west-1" - - The system name of the service like "us-west-1" - - - - - Gets the region endpoint override if exists - - The region endpoint to find the possible override for - - - - - Gets the system name of a region. - - - - - Gets the display name of a region. - - - - - Gets the partition name the region is in. For example for us-east-1 the partition name is aws. For cn-northwest-1 the partition name is aws-cn. - - - - - Gets the dns suffix for the region endpoints in a partition. For example the aws partition's suffix is amazonaws.com. The aws-cn partition's suffix is amazonaws.com.cn. - - - - - Gets the endpoint for a service in a region. - - - The services system name. Service system names can be obtained from the - RegionEndpointServiceName member of the ClientConfig-derived class for the service. - - - For forwards compatibility, if the service being requested for isn't known in the region, this method - will generate an endpoint using the AWS endpoint heuristics. In this case, it is not guaranteed the - endpoint will point to a valid service endpoint. - - - - - - Gets the endpoint for a service in a region, optionally selecting a dualstack compatible endpoint. - - - The services system name. Service system names can be obtained from the - RegionEndpointServiceName member of the ClientConfig-derived class for the service. - - - If true a dualstack endpoint is returned. It is the user's responsibility to verify that the given service - supports a dualstack endpoint for the region. - - - For forwards compatibility, if the service being requested for isn't known in the region, this method - will generate an endpoint using the AWS endpoint heuristics. In this case, it is not guaranteed the - endpoint will point to a valid service endpoint. - - - - - - This class defines an endpoints hostname and which protocols it supports. - - - - - Gets the hostname for the service. - - - - - The authentication region to be used in request signing. - - - - - This property is only set for S3 endpoints. For all other services this property returns null. - For S3 endpoints, if the endpoint supports signature version 2 this property will be "2", otherwise it will be "4". - - - - - Calculates a 32bit Cyclic Redundancy Checksum (CRC) using the - same polynomial used by Zip. This type is used internally by DotNetZip; it is generally not used directly - by applications wishing to create, read, or manipulate zip archive files. - - - - - indicates the total number of bytes read on the CRC stream. - This is used when writing the ZipDirEntry when compressing files. - - - - - Indicates the current CRC for all blocks slurped in. - - - - - Returns the CRC32 for the specified stream. - - The stream over which to calculate the CRC32 - the CRC32 calculation - - - - Returns the CRC32 for the specified stream, and writes the input into the output stream. - - The stream over which to calculate the CRC32 - The stream into which to deflate the input - the CRC32 calculation - - - - Get the CRC32 for the given (word,byte) combo. - This is a computation defined by PKzip. - - The word to start with. - The byte to combine it with. - The CRC-ized result. - - - - Update the value for the running CRC32 using the given block of bytes. - This is useful when using the CRC32() class in a Stream. - - block of bytes to slurp - starting point in the block - how many bytes within the block to slurp - - - - A Stream that calculates a CRC32 (a checksum) on all bytes read, - or on all bytes written. - - - - - This class can be used to verify the CRC of a ZipEntry when reading from a stream, - or to calculate a CRC when writing to a stream. The stream should be used to either - read, or write, but not both. If you intermix reads and writes, the results are - not defined. - - This class is intended primarily for use internally by the DotNetZip library. - - - - - Gets the total number of bytes run through the CRC32 calculator. - - - - This is either the total number of bytes read, or the total number - of bytes written, depending on the direction of this stream. - - - - - The constructor. - - The underlying stream - - - - The constructor. - - The underlying stream - The length of the stream to slurp - - - - Provides the current CRC for all blocks slurped in. - - - - - Read from the stream - - the buffer to read - the offset at which to start - the number of bytes to read - the number of bytes actually read - - - - Write to the stream. - - the buffer from which to write - the offset at which to start writing - the number of bytes to write - - - - Indicates whether the stream supports reading. - - - - - Indicates whether the stream supports seeking. - - - - - Indicates whether the stream supports writing. - - - - - Flush the stream. - - - - - Not implemented. - - - - - Not implemented. - - - - - Not implemented. - - N/A - N/A - N/A - - - - Not implemented. - - N/A - - - diff --git a/packages/AWSSDK.Core.3.3.107.14/lib/Xamarin.iOS10/AWSSDK.Core.dll b/packages/AWSSDK.Core.3.3.107.14/lib/Xamarin.iOS10/AWSSDK.Core.dll deleted file mode 100644 index 0921366..0000000 Binary files a/packages/AWSSDK.Core.3.3.107.14/lib/Xamarin.iOS10/AWSSDK.Core.dll and /dev/null differ diff --git a/packages/AWSSDK.Core.3.3.107.14/lib/net35/AWSSDK.Core.dll b/packages/AWSSDK.Core.3.3.107.14/lib/net35/AWSSDK.Core.dll deleted file mode 100644 index f28337d..0000000 Binary files a/packages/AWSSDK.Core.3.3.107.14/lib/net35/AWSSDK.Core.dll and /dev/null differ diff --git a/packages/AWSSDK.Core.3.3.107.14/lib/net35/AWSSDK.Core.xml b/packages/AWSSDK.Core.3.3.107.14/lib/net35/AWSSDK.Core.xml deleted file mode 100644 index b79349e..0000000 --- a/packages/AWSSDK.Core.3.3.107.14/lib/net35/AWSSDK.Core.xml +++ /dev/null @@ -1,14886 +0,0 @@ - - - - AWSSDK.Core - - - - - An access control policy action identifies a specific action in a service - that can be performed on a resource. For example, sending a message to a - queue. - - ActionIdentifiers allow you to limit what your access control policy statement affects. - For example, you could create a policy statement that enables a certain group - of users to send messages to your queue, but not allow them to perform any - other actions on your queue. - - - The action is B in the statement - "A has permission to do B to C where D applies." - - Free form access control policy actions may include a wildcard (*) to match - multiple actions. - - - Constants for known actions can be found in the Amazon.Auth.AccessControlPolicy.ActionIdentifiers namespace. - - - - - - Constructs an Actionidentifer with the given action name. - - The name of the action - - - - Gets and sets the name of this action. For example, 'sqs:SendMessage' is the - name corresponding to the SQS action that enables users to send a message - to an SQS queue. - - - - - The available AWS access control policy actions for Amazon AppStream. - - - - - - The available AWS access control policy actions for Auto Scaling. - - - - - - The available AWS access control policy actions for AWS Billing. - - - - - - The available AWS access control policy actions for AWS CloudFormation. - - - - - - The available AWS access control policy actions for Amazon CloudFront. - - - - - - The available AWS access control policy actions for Amazon CloudSearch. - - - - - - The available AWS access control policy actions for AWS CloudTrail. - - - - - - The available AWS access control policy actions for Amazon CloudWatch. - - - - - - The available AWS access control policy actions for Amazon CloudWatch Logs. - - - - - - The available AWS access control policy actions for Amazon Cognito Identity. - - - - - - The available AWS access control policy actions for Amazon Cognito Sync. - - - - - - The available AWS access control policy actions for AWS Direct Connect. - - - - - - The available AWS access control policy actions for Amazon DynamoDB. - - - - - - The available AWS access control policy actions for Amazon EC2. - - - - - - The available AWS access control policy actions for AWS ElastiCache. - - - - - - The available AWS access control policy actions for AWS Elastic Beanstalk. - - - - - - The available AWS access control policy actions for Elastic Load Balancing. - - - - - - The available AWS access control policy actions for Amazon Elastic MapReduce. - - - - - - The available AWS access control policy actions for Amazon Elastic Transcoder. - - - - - - The available AWS access control policy actions for Amazon Glacier. - - - - - - The available AWS access control policy actions for AWS Identity and Access Management. - - - - - - The available AWS access control policy actions for AWS Import Export. - - - - - - The available AWS access control policy actions for Amazon Kinesis. - - - - - - The available AWS access control policy actions for AWS Marketplace. - - - - - - The available AWS access control policy actions for AWS Marketplace Management Portal. - - - - - - The available AWS access control policy actions for Amazon Mobile Analytics. - - - - - - The available AWS access control policy actions for AWS OpsWorks. - - - - - - The available AWS access control policy actions for Amazon RDS. - - - - - - The available AWS access control policy actions for Amazon Redshift. - - - - - - The available AWS access control policy actions for Amazon Route 53. - - - - - - The available AWS access control policy actions for Amazon S3. - - - - - - The available AWS access control policy actions for AWS Security Token Service. - - - - - - The available AWS access control policy actions for Amazon SES. - - - - - - The available AWS access control policy actions for Amazon SimpleDB. - - - - - - The available AWS access control policy actions for Amazon Simple Workflow Service. - - - - - - The available AWS access control policy actions for Amazon SNS. - - - - - - The available AWS access control policy actions for Amazon SQS. - - - - - - The available AWS access control policy actions for Amazon Storage Gateway. - - - - - - The available AWS access control policy actions for AWS Whispersync. - - - - - - The available AWS access control policy actions for Amazon Zocalo. - - - - - - AWS access control policy conditions are contained in - objects, and affect when a statement is applied. For example, a statement - that allows access to an Amazon SQS queue could use a condition to only apply - the effect of that statement for requests that are made before a certain - date, or that originate from a range of IP addresses. - - Multiple conditions can be included in a single statement, and all conditions - must evaluate to true in order for the statement to take effect. - - - The set of conditions is D in the statement - "A has permission to do B to C where D applies." - - - A condition is composed of three parts: - - - Condition Key - The condition key declares which value of a - request to pull in and compare against when a policy is evaluated by AWS. For - example, using will cause - AWS to pull in the current request's source IP as the first value to compare - against every time your policy is evaluated. - - - - Comparison Type - This is a static value used as the second value - in the comparison when your policy is evaluated. Depending on the comparison - type, this value can optionally use wildcards. See the documentation for - individual comparison types for more information. - - - - Comparison Value - This is a static value used as the second value - in the comparison when your policy is evaluated. Depending on the comparison - type, this value can optionally use wildcards. See the documentation for - individual comparison types for more information. - - - - - - - - - Gets the type of this condition. - - - - - Gets and Sets the name of the condition key involved in this condition. - Condition keys are predefined values supported by AWS that provide input - to a condition's evaluation, such as the current time, or the IP address - of the incoming request. - - Your policy is evaluated for each incoming request, and condition keys - specify what information to pull out of those incoming requests and plug - into the conditions in your policy. - - - - - - Gets and Sets the values specified for this access control policy condition. - For example, in a condition that compares the incoming IP address of a - request to a specified range of IP addresses, the range of IP addresses - is the single value in the condition. - - Most conditions accept only one value, but multiple values are possible. - - - - - - A factory for creating conditions to be used in the policy. - - - - - Condition key for the current time. - - This condition key should only be used with enum. - - - - - - Condition key for whether or not an incoming request is using a secure - transport to make the request (i.e. HTTPS instead of HTTP). - - This condition key should only be used with the boolean overload of NewCondition. - - - - - - Condition key for the source IP from which a request originates. - - This condition key should only be used with enum. - - - - - - Condition key for the user agent included in a request. - - This condition key should only be used with - enum. - - - - - - Condition key for the current time, in epoch seconds. - - This condition key should only be used with enum. - objects. - - - - - - Condition key for the referrer specified by a request. - - This condition key should only be used with - objects. - - - - - - Condition key for the Amazon Resource Name (ARN) of the source specified - in a request. The source ARN indicates which resource is affecting the - resource listed in your policy. For example, an SNS topic is the source - ARN when publishing messages from the topic to an SQS queue. - - This condition key should only be used with enum. - - - - - - Enumeration of the supported ways an ARN comparison can be evaluated. - - - - Exact matching - - - - Loose case-insensitive matching of the ARN. Each of the six - colon-delimited components of the ARN is checked separately and each - can include a multi-character match wildcard (*) or a - single-character match wildcard (?). - - - - Negated form of ArnEquals - - - Negated form of ArnLike - - - - Enumeration of the supported ways a date comparison can be evaluated. - - - - - Enumeration of the supported ways an IP address comparison can be evaluated. - - - - - Matches an IP address against a CIDR IP range, evaluating to true if - the IP address being tested is in the condition's specified CIDR IP - range. - - - - - Negated form of IpAddress - - - - - Enumeration of the supported ways a numeric comparison can be evaluated - - - - - Enumeration of the supported ways a string comparison can be evaluated. - - - - - Case-sensitive exact string matching - - - - - Case-insensitive string matching - - - - - Loose case-insensitive matching. The values can include a - multi-character match wildcard (*) or a single-character match - wildcard (?) anywhere in the string. - - - - - Negated form of StringEquals. - - - - - Negated form of StringEqualsIgnorecase. - - - - - Negated form of StringLike. - - - - - Constructs a new access control policy condition that compares ARNs (Amazon Resource Names). - - The access policy condition key specifying where to get the first ARN for the comparison - The type of comparison to perform. - The second ARN to compare against. When using ArnLike or ArnNotLike this may contain the - multi-character wildcard (*) or the single-character wildcard - - - - Constructs a new access policy condition that performs a boolean - comparison. - - The access policy condition key specifying where to get the - first boolean value for the comparison (ex: aws:SecureTransport). - The boolean to compare against. - - - - This method is deprecated. Invoking this method results in non-UTC DateTimes - not being marshalled correctly. Use NewConditionUtc instead. - Constructs a new access policy condition that compares the current time - (on the AWS servers) to the specified date. - - The type of comparison to perform. For example, - DateComparisonType.DateLessThan will cause this policy - condition to evaluate to true if the current date is less than - the date specified in the second argument. - The date to compare against. - - - - Constructs a new access policy condition that compares the current time - (on the AWS servers) to the specified date. - - The type of comparison to perform. For example, - DateComparisonType.DateLessThan will cause this policy - condition to evaluate to true if the current date is less than - the date specified in the second argument. - The date to compare against. - - - - Constructs a new access policy condition that compares the source IP - address of the incoming request to an AWS service against the specified - CIDR range. The condition evaluates to true (meaning the policy statement - containing it will be applied) if the incoming source IP address is - within that range. - - To achieve the opposite effect (i.e. cause the condition to evaluate to - true when the incoming source IP is not in the specified CIDR - range) use the alternate constructor form and specify - IpAddressComparisonType.NotIpAddress. - - - The CIDR IP range involved in the policy condition. - - - - Constructs a new access policy condition that compares the source IP - address of the incoming request to an AWS service against the specified - CIDR range. When the condition evaluates to true (i.e. when the incoming - source IP address is within the CIDR range or not) depends on the - specified IpAddressComparisonType. - - The type of comparison to to perform. - The CIDR IP range involved in the policy condition. - - - - Constructs a new access policy condition that compares two numbers. - - The type of comparison to perform. - The access policy condition key specifying where to get the - first number for the comparison. - The second number to compare against. - - - - Constructs a new access control policy condition that compares two - strings. - - The type of comparison to perform - The access policy condition key specifying where to get the - first string for the comparison (ex: aws:UserAgent). - - The second string to compare against. When using - StringComparisonType.StringLike or - StringComparisonType.StringNotLike this may contain - the multi-character wildcard (*) or the single-character - wildcard (?). - - - - - Constructs a new access policy condition that compares the Amazon - Resource Name (ARN) of the source of an AWS resource that is modifying - another AWS resource with the specified pattern. - - For example, the source ARN could be an Amazon SNS topic ARN that is - sending messages to an Amazon SQS queue. In that case, the SNS topic ARN - would be compared the ARN pattern specified here. - - - The endpoint pattern may optionally contain the multi-character wildcard - * (*) or the single-character wildcard (?). Each of the six colon-delimited - components of the ARN is checked separately and each can include a - wildcard. - - - Policy policy = new Policy("MyQueuePolicy"); - policy.WithStatements(new Statement(Statement.StatementEffect.Allow) - .WithPrincipals(new Principal("*")).WithActionIdentifiers(SQSActionIdentifiers.SendMessage) - .WithResources(new Resource(myQueueArn)) - .WithConditions(ConditionFactory.NewSourceArnCondition(myTopicArn))); - - - The ARN pattern against which the source ARN will be compared. - Each of the six colon-delimited components of the ARN is - checked separately and each can include a wildcard. - A new access control policy condition that compares the ARN of - the source specified in an incoming request with the ARN pattern - specified here. - - - - Constructs a new access control policy condition that tests if the - incoming request was sent over a secure transport (HTTPS). - - A new access control policy condition that tests if the incoming - request was sent over a secure transport (HTTPS). - - - - Condition key for the canned ACL specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the location constraint specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the prefix specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the delimiter specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the max keys specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the source object specified by a request to copy an - object. - - This condition key may only be used with enum. - - - - - - Condition key for the metadata directive specified by a request to copy - an object. - - This condition key may only be used with enum. - - - - - - Condition key for the version ID of an object version specified by a - request. - - This condition key may only be used with enum. - - - - - - Constructs a new access policy condition that compares an Amazon S3 - canned ACL with the canned ACL specified by an incoming request. - - You can use this condition to ensure that any objects uploaded to an - Amazon S3 bucket have a specific canned ACL set. - - - The Amazon S3 canned ACL to compare against. - A new access control policy condition that compares the Amazon S3 - canned ACL specified in incoming requests against the value - specified. - - - - Condition key for The URL, e-mail address, or ARN from a Subscribe - request or a previously confirmed subscription. Use with string - conditions to restrict access to specific endpoints (e.g., - *@mycompany.com). - - This condition key may only be used with enum. - - - - - - Condition key for the protocol value from a Subscribe request or a - previously confirmed subscription. Use with string conditions to restrict - publication to specific delivery protocols (e.g., HTTPS). - - This condition key may only be used with enum. - - - - - - Constructs a new access policy condition that compares the requested - endpoint used to subscribe to an Amazon SNS topic with the specified - endpoint pattern. The endpoint pattern may optionally contain the - multi-character wildcard (*) or the single-character wildcard (?). - - For example, this condition can restrict subscriptions to a topic to - email addresses in a certain domain ("*@my-company.com"). - - - Policy policy = new Policy("MyTopicPolicy"); - policy.WithStatements(new Statement(Statement.StatementEffect.Allow) - .WithPrincipals(new Principal("*")).WithActionIdentifiers(SNSActionIdentifiers.Subscribe) - .WithResources(new Resource(myTopicArn)) - .WithConditions(ConditionFactory.NewEndpointCondition("*@my-company.com"))); - - - The endpoint pattern against which to compare the requested - endpoint for an Amazon SNS topic subscription. - A new access control policy condition that compares the endpoint - used in a request to subscribe to an Amazon SNS topic with the - endpoint pattern specified. - - - - Constructs a new AWS access control policy condition that allows an - access control statement to restrict subscriptions to an Amazon SNS topic - based on the protocol being used for the subscription. For example, this - condition can restrict subscriptions to a topic to endpoints using HTTPS - to ensure that messages are securely delivered. - - The protocol against which to compare the requested protocol - for an Amazon SNS topic subscription. - A new access control policy condition that compares the - notification protocol requested in a request to subscribe to an - Amazon SNS topic with the protocol value specified. - - - - Deserializes a JSON string into a AWS policy object. - - - - - Serializes an AWS policy object to a JSON string, suitable for sending to an - AWS service. - - - - Converts the specified AWS policy object to a JSON string, suitable for - passing to an AWS service. - - @param policy - The AWS policy object to convert to a JSON string. - - @return The JSON string representation of the specified policy object. - - @throws IllegalArgumentException - If the specified policy is null or invalid and cannot be - serialized to a JSON string. - - - - Uses the specified generator to write the JSON data for the principals in - the specified policy statement. - - - - - This sorts the conditions by condition type and key with the list of values for that combination. - - The list of conditions to be sorted. - - - - - An AWS access control policy is a object that acts as a container for one or - more statements, which specify fine grained rules for allowing or denying - various types of actions from being performed on your AWS resources. - - By default, all requests to use your resource coming from anyone but you are - denied. Access control polices can override that by allowing different types - of access to your resources, or by explicitly denying different types of - access. - - - Each statement in an AWS access control policy takes the form: - "A has permission to do B to C where D applies". - - - A is the prinicpal - The AWS account that is making a request to - access or modify one of your AWS resources. - - - - B is the action - the way in which your AWS resource is being accessed or modified, such - as sending a message to an Amazon SQS queue, or storing an object in an Amazon S3 bucket. - - - - C is the resource - your AWS entity that the principal wants to access, such - as an Amazon SQS queue, or an object stored in Amazon S3. - - - - D is the set of conditions - optional constraints that specify when to allow or deny - access for the principal to access your resource. Many expressive conditions are available, - some specific to each service. For example you can use date conditions to allow access to - your resources only after or before a specific time. - - - - - - Note that an AWS access control policy should not be confused with the - similarly named "POST form policy" concept used in Amazon S3. - - - - - - The default policy version - - - - - Constructs an empty AWS access control policy ready to be populated with - statements. - - - - - Constructs a new AWS access control policy with the specified policy ID. - The policy ID is a user specified string that serves to help developers - keep track of multiple polices. Policy IDs are often used as a human - readable name for a policy. - - The policy ID for the new policy object. Policy IDs serve to - help developers keep track of multiple policies, and are often - used to give the policy a meaningful, human readable name. - - - - Constructs a new AWS access control policy with the specified policy ID - and collection of statements. The policy ID is a user specified string - that serves to help developers keep track of multiple polices. Policy IDs - are often used as a human readable name for a policy. - - The policy ID for the new policy object. Policy IDs serve to - help developers keep track of multiple policies, and are often - used to give the policy a meaningful, human readable name. - The statements to include in the new policy. - - - - Gets and Sets the policy ID for this policy. Policy IDs serve to help - developers keep track of multiple policies, and are often used as human - readable name for a policy. - - - - - Sets the policy ID for this policy and returns the updated policy so that - multiple calls can be chained together. - - Policy IDs serve to help developers keep track of multiple policies, and - are often used as human readable name for a policy. - - - The polich ID for this policy - this instance - - - - Gets and sets the version of this AWS policy. - - - - - Gets and Sets the collection of statements contained by this policy. Individual - statements in a policy are what specify the rules that enable or disable - access to your AWS resources. - - - - - Checks to see if the permissions set in the statement are already set by another - statement in the policy. - - The statement to verify - True if the statement's permissions are already allowed by the statement - - - - Sets the collection of statements contained by this policy and returns - this policy object so that additional method calls can be chained - together. - - Individual statements in a policy are what specify the rules that enable - or disable access to your AWS resources. - - - The collection of statements included in this policy. - this instance - - - - Returns a JSON string representation of this AWS access control policy, - suitable to be sent to an AWS service as part of a request to set an - access control policy. - - A JSON string representation of this AWS access control policy. - - - - Returns a JSON string representation of this AWS access control policy, - suitable to be sent to an AWS service as part of a request to set an - access control policy. - - Toggle pretty print for the generated JSON document - A JSON string representation of this AWS access control policy. - - - - Parses a JSON document of a policy and creates a Policy object. - - JSON document of a policy. - - - - - A principal is an AWS account which is being allowed or denied access to a - resource through an access control policy. The principal is a property of the - Statement object, not directly the object. - - The principal is A in the statement - "A has permission to do B to C where D applies." - - - In an access control policy statement, you can set the principal to all - authenticated AWS users through the member. This - is useful when you don't want to restrict access based on the identity of the - requester, but instead on other identifying characteristics such as the - requester's IP address. - - - - - - Principal instance that includes all authenticated AWS users. - - This is useful when you don't want to restrict access based on the - identity of the requester, but instead on other identifying - characteristics such as the requester's IP address. - - - - - - The anonymous Principal. - - - - - The default Principal provider for AWS accounts. - - - - - Principal provider for Canonical User IDs. - - - - - Principal provider for federated users (using a SAML identity provider) - - - - - Principal provider for assume role policies that will be assumed by an AWS service - (e.g. "ec2.amazonaws.com"). - - - - - Dummy principal provider for anonynous. - - - - - Constructs a new principal with the specified AWS account ID. - - An AWS account ID. - - - - Constructs a new principal with the specified provider and id - - The provider of the principal - The unique ID of the Principal within the provider - - - - Constructs a new principal with the specified provider and id - and optionally strips hyphens from the id - - The provider of the principal - The unique ID of the Principal within the provider - Strip hyphen - - - - Gets and sets the provider for this principal, which indicates in what group of - users this principal resides. - - - - - Gets the unique ID for this principal. - - - - - Represents a resource involved in an AWS access control policy statement. - Resources are the service specific AWS entities owned by your account. Amazon - SQS queues, Amazon S3 buckets and objects, and Amazon SNS topics are all - examples of AWS resources. - - The standard way of specifying an AWS resource is with an Amazon Resource - Name (ARN). - - - The resource is C in the statement - "A has permission to do B to C where D applies." - - - - - - Constructs a new AWS access control policy resource. Resources are - typically specified as Amazon Resource Names (ARNs). - - You specify the resource using the following Amazon Resource Name (ARN) - format: arn:aws:<vendor>:<region>:<namespace>:<relative-id> - - - >vendor identifies the AWS product (e.g., sns) - - - region is the AWS Region the resource resides in (e.g., us-east-1), if any - - - namespace is the AWS account ID with no hyphens (e.g., 123456789012) - - - relative-id is the service specific portion that identifies the specific resource - - - - - For example, an Amazon SQS queue might be addressed with the following - ARN: arn:aws:sqs:us-east-1:987654321000:MyQueue - - - Some resources may not use every field in an ARN. For example, resources - in Amazon S3 are global, so they omit the region field: - arn:aws:s3:::bucket/* - - - The Amazon Resource Name (ARN) uniquely identifying the desired AWS resource. - - - - Gets the resource ID, typically an Amazon Resource Name (ARN), - identifying this resource. - - - - - A factory for creating resources to be used in the policy. - - - - - Constructs a new bucket resource that represents the the specified bucket - but not any of the contained objects. - - The name of the bucket represented by this AWS access control - policy resource. - - - - Constructs a new object resource that represents the specified objects. - The keyPattern argument may contain the '*' wildcard to match multiple - objects. For example, an object resource created for bucket 'mybucket' - and key pattern 'foo*' will match any object stored in 'mybucket' with a - key that starts with 'foo'. - - The name of the bucket containing the object or objects - represented by this resource. - The key or key pattern, which can optionally contain the '*' - wildcard to include multiple objects in the resource. - - - - Constructs a new SQS queue resource for an access control policy. A - policy statement using this resource will allow or deny actions on the - specified queue. - - The AWS account ID of the queue owner. - The name of the Amazon SQS queue. - - - - A statement is the formal description of a single permission, and is always - contained within a policy object. - - A statement describes a rule for allowing or denying access to a specific AWS - resource based on how the resource is being accessed, and who is attempting - to access the resource. Statements can also optionally contain a list of - conditions that specify when a statement is to be honored. - - - For example, consider a statement that: - - - A is the prinicpal - The AWS account that is making a request to - access or modify one of your AWS resources. - - - - B is the action - the way in which your AWS resource is being accessed or modified, such - as sending a message to an Amazon SQS queue, or storing an object in an Amazon S3 bucket. - - - - C is the resource - your AWS entity that the principal wants to access, such - as an Amazon SQS queue, or an object stored in Amazon S3. - - - - D is the set of conditions - optional constraints that specify when to allow or deny - access for the principal to access your resource. Many expressive conditions are available, - some specific to each service. For example you can use date conditions to allow access to - your resources only after or before a specific time. - - - - - - There are many resources and conditions available for use in statements, and - you can combine them to form fine grained custom access control polices. - - - - - - The effect is the result that you want a policy statement to return at - evaluation time. A policy statement can either allow access or explicitly - deny access. - - - - - Constructs a new access control policy statement with the specified - effect. - - Before a statement is valid and can be sent to AWS, callers must set the - principals, resources, and actions (as well as any optional conditions) - involved in the statement. - - - The effect this statement has (allowing access or denying - access) when all conditions, resources, principals, and - actions are matched. - - - - Gets and Sets the ID for this statement. Statement IDs serve to help keep track - of multiple statements, and are often used to give the statement a - meaningful, human readable name. - - Developers should be careful to not use the same statement ID for - multiple statements in the same policy. Reusing the same statement ID in - different policies is not a problem. - - - - - - Sets the ID for this statement and returns the updated statement so - multiple calls can be chained together. - - Statement IDs serve to help keep track of multiple statements, and are - often used to give the statement a meaningful, human readable name. - - - Developers should be careful to not use the same statement ID for - multiple statements in the same policy. Reusing the same statement ID in - different policies is not a problem. - - - The new statement ID for this statement. - this instance - - - - Gets and Sets the result effect of this policy statement when it is evaluated. - A policy statement can either allow access or explicitly - - - - - Gets and Sets the list of actions to which this policy statement applies. - Actions limit a policy statement to specific service operations that are - being allowed or denied by the policy statement. For example, you might - want to allow any AWS user to post messages to your SQS queue using the - SendMessage action, but you don't want to allow those users other actions - such as ReceiveMessage or DeleteQueue. - - - - - Sets the list of actions to which this policy statement applies and - returns this updated Statement object so that additional method calls can - be chained together. - - Actions limit a policy statement to specific service operations that are - being allowed or denied by the policy statement. For example, you might - want to allow any AWS user to post messages to your SQS queue using the - SendMessage action, but you don't want to allow those users other actions - such as ReceiveMessage or DeleteQueue. - - - The list of actions to which this statement applies. - this instance - - - - Gets and Sets the resources associated with this policy statement. Resources - are what a policy statement is allowing or denying access to, such as an - Amazon SQS queue or an Amazon SNS topic. - - Note that some services allow only one resource to be specified per - policy statement. - - - - - - Sets the resources associated with this policy statement and returns this - updated Statement object so that additional method calls can be chained - together. - - Resources are what a policy statement is allowing or denying access to, - such as an Amazon SQS queue or an Amazon SNS topic. - - - Note that some services allow only one resource to be specified per - policy statement. - - - The resources associated with this policy statement. - this instance - - - - Gets and Sets the conditions associated with this policy statement. Conditions - allow policy statements to be conditionally evaluated based on the many - available condition types. - - For example, a statement that allows access to an Amazon SQS queue could - use a condition to only apply the effect of that statement for requests - that are made before a certain date, or that originate from a range of IP - addresses. - - - When multiple conditions are included in a single statement, all - conditions must evaluate to true in order for the statement to take - effect. - - - - - - Sets the conditions associated with this policy statement, and returns - this updated Statement object so that additional method calls can be - chained together. - - Conditions allow policy statements to be conditionally evaluated based on - the many available condition types. - - - For example, a statement that allows access to an Amazon SQS queue could - use a condition to only apply the effect of that statement for requests - that are made before a certain date, or that originate from a range of IP - addresses. - - - Multiple conditions can be included in a single statement, and all - conditions must evaluate to true in order for the statement to take - effect. - - - The conditions associated with this policy statement. - this instance - - - - Gets and Sets the principals associated with this policy statement, indicating - which AWS accounts are affected by this policy statement. - - - - - Sets the principals associated with this policy statement, and returns - this updated Statement object. Principals control which AWS accounts are - affected by this policy statement. - - If you don't want to restrict your policy to specific users, you can use - to apply the policy to any user trying to - access your resource. - - - The list of principals associated with this policy statement. - this instance - - - - Exception thrown by the SDK for errors that occur within the SDK. - - - - - Constructs a new instance of the AmazonClientException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - This exception is thrown when there is a parse error on the response back from AWS. - - - - - The string value which could not be converted into a valid DateTime instance. - - - - - Constructs a new instance of the AmazonDateTimeUnmarshallingException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - Occurs before a request is marshalled. - - - - - Occurs before a request is issued against the service. - - - - - Occurs after a response is received from the service. - - - - - Occurs after an exception is encountered. - - - - - Patches the in-flight uri to stop it unescaping the path etc (what Uri did before - Microsoft deprecated the constructor flag). This is particularly important for - Amazon S3 customers who want to use backslash (\) in their key names. - - - Different behavior in the various runtimes has been observed and in addition some - 'documented' ways of doing this between 2.x and 4.x runtimes has also been observed - to not be reliable. - - This patch effectively emulates what adding a schemesettings element to the - app.config file with value 'name="http" genericUriParserOptions="DontUnescapePathDotsAndSlashes"' - does. As we're a dll, that avenue is not open to us. - - - - - - Used to create a copy of the config for a different service than the current instance. - - Target service ClientConfig - The new ClientConfig for the desired service - - - - A base exception for some Amazon Web Services. - - Most exceptions thrown to client code will be service-specific exceptions, though some services - may throw this exception if there is a problem which is caught in the core client code. - - - - - - Whether the error was attributable to Sender or Reciever. - - - - - The error code returned by the service - - - - - The id of the request which generated the exception. - - - - - The HTTP status code from the service response - - - - - Flag indicating if the exception is retryable and the associated retry - details. A null value indicates that the exception is not retryable. - - - - - Constructs a new instance of the AmazonServiceException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - Class containing the retryable details for an AmazonServiceException - - - - - This property indicates that this exception is a - throttling exception and should be subject to congestion - control throttling. - - - - - This exception is thrown when there is a parse error on the response back from AWS. - - - - - Last known location in the response that was parsed, if available. - - - - - The entire response body that caused this exception, if available. - - - - - Constructs a new instance of the AmazonSimpleDBException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - Base class for request used by some of the services. - - - - - This flag specifies if SigV4 will be used for the current request. - - - - - Gets or Sets a value indicating if "Expect: 100-continue" HTTP header will be - sent by the client for this request. The default value is false. - - - - - Gets the signer to use for this request. - A null return value indicates to use the configured - signer for the service that this request is part of. - - A signer for this request, or null. - - - - Overrides the default request timeout value. - - - - If the value is set, the value is assigned to the Timeout property of the HTTPWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Overrides the default read-write timeout value. - - - - If the value is set, the value is assigned to the ReadWriteTimeout property of the HTTPWebRequest/WebRequestHandler object used - to send requests. - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - - Abstract class for Response objects, contains only metadata, - and no result information. - - - - - Contains additional information about the request, such as the - Request Id. - - - - - Returns the content length of the HTTP response. - - - - - Returns the status code of the HTTP response. - - - - - Base class for determining region based on inspection. - - - - - Sets the Region property by looking up the corresponding RegionEndpoint - from the supplied region system name (us-east-1, us-west-2 etc). - - The system name of the region. - - - - Determines region based on application configuration settings. If the configuration does not contain - the region setting key an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of ApplicationConfigAWSRegion. If no region is found in the - application configuration file then an InvalidOperationException is thrown. - - - - - Determines region based on an environment variable. If the environment does not contain - the region setting key an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of EnvironmentVariableAWSRegion. If no region is found in the - environment then an InvalidOperationException is thrown. - - - - - Determines region based on inspection of the instance metadata if running on an EC2 instance. - If instance metadata cannot be read or does not contain region information an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of InstanceProfileAWSRegion. If no region is found in the - metadata or we are not running on an EC2 instance an InvalidOperationException is thrown. - - - - - Determines region based on a stored in an . - If the profile doesn't exist or there is no region information an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of . - If the AWS_PROFILE environment variable is set the instance will be constructed using that profile, - otherwise it will use the default profile. - - If the profile doesn't exist or there is no region information an InvalidOperationException is thrown. - - The ICredentialProfileSource to read the profile from. - - - - Attempts to construct an instance of . - If the profile doesn't exist or there is no region information an InvalidOperationException is thrown. - - The ICredentialProfileSource to read the profile from. - The name of the profile. - - - - Probing mechanism to determine region from various sources. - - - - - This class is responsible for keeping track of Retry capacity across different ServiceURLs. - - - - - CapacityType determines the type of capacity to obtain or use. - - - - - The increment capacity type adds capacity. - - - - - The default retry capacity type uses the default capacity amount. - - - - - The timeout capacity type uses the timeout capacity amount. - - - - - This method acquires a said retry capacity if the container has the capacity. - - Contains the RetryCapacity object for the said ServiceURL. - - - - This method acquires a said retry capacity if the container has the capacity. - - Contains the RetryCapacity object for the said ServiceURL. - Specifies what capacity type cost to use for obtaining capacity - - - - This method calls a method to release capacity back - based on whether it was a successful response or a successful retry response. This is invoked by a retry request response. - - if this request is a retry, use a different capacity cost - Contains the RetryCapacity object for the said ServiceURL. - - - - This method calls a method to release capacity back - based on whether it was a successful response or a successful retry response. This is invoked by a retry request response. - - Specifies what capacity type cost to use for adding capacity - Contains the RetryCapacity object for the said ServiceURL. - - - - Ths method fetches the RetryCapacity for the given ServiceURL from CapacityManager.CapacityContainer - - - - - This method releases capacity back. This is invoked by the TryReleaseCapacity method. - - Contains the RetryCapacity object for the said ServiceURL. - The capacity that needs to be released based on whether it was a successful response or a successful retry response. - - - - This class is the RetryCapacity class for a given ServiceURL. - - - - - This class composes Client Context header for Amazon Web Service client. - It contains information like app title, version code, version name, client id, OS platform etc. - - - This class composes Client Context header for Amazon Web Service client. - It contains information like app title, version code, version name, client id, OS platform etc. - - - - - Adds the custom attributes to the Client Context. - - Key. - Value. - - - - Gets a Json Representation of the Client Context. - - Json Representation of Client Context - - - - Class to which the Json stdout from credential process is - de-serialized into. - - - - - Version of the Json payload - - - - - AWS Access key - - - - - AWS Secret key - - - - - AWS Session token for session credentials - - - - - ISO8601 formatted timestamp till when the credential is valid. - - - - - Computes RFC 2104-compliant HMAC signature. - - - - - Computes RFC 2104-compliant HMAC signature. - - - - - Inspects the supplied evidence to return the signer appropriate for the operation - - Global setting for the service - The request. - Configuration for the client - True if signature v4 request signing should be used - - - - Signs the specified request with the AWS3 signing protocol by using the - AWS account credentials given in the method parameters. - - The AWS public key - The AWS secret key used to sign the request in clear text - Request metrics - The configuration that specifies which hashing algorithm to use - The request to have the signature compute for - If any problems are encountered while signing the request - - - - AWS4 protocol signer for service calls that transmit authorization in the header field "Authorization". - - - - - Calculates and signs the specified request using the AWS4 signing protocol by using the - AWS account credentials given in the method parameters. The resulting signature is added - to the request headers as 'Authorization'. Parameters supplied in the request, either in - the resource path as a query string or in the Parameters collection must not have been - uri encoded. If they have, use the SignRequest method to obtain a signature. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. - - - Client configuration data encompassing the service call (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text. - - - If any problems are encountered while signing the request. - - - - - Calculates and signs the specified request using the AWS4 signing protocol by using the - AWS account credentials given in the method parameters. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. - - - Client configuration data encompassing the service call (notably authentication - region, endpoint and service name). - - - Metrics for the request. - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text. - - - If any problems are encountered while signing the request. - - - Parameters passed as part of the resource path should be uri-encoded prior to - entry to the signer. Parameters passed in the request.Parameters collection should - be not be encoded; encoding will be done for these parameters as part of the - construction of the canonical request. - - - - - Sets the AWS4 mandated 'host' and 'x-amz-date' headers, returning the date/time that will - be used throughout the signing process in various elements and formats. - - The current set of headers - - Date and time used for x-amz-date, in UTC - - - - Sets the AWS4 mandated 'host' and 'x-amz-date' headers, accepting and returning the date/time that will - be used throughout the signing process in various elements and formats. - - The current set of headers - - - Date and time used for x-amz-date, in UTC - - - - Computes and returns an AWS4 signature for the specified canonicalized request - - - - - - - - - - - - Computes and returns an AWS4 signature for the specified canonicalized request - - - - - - - - - - - - - Computes and returns an AWS4 signature for the specified canonicalized request - - - - - - - - - - - - - - Formats the supplied date and time for use in AWS4 signing, where various formats are used. - - - The required format - The UTC date/time in the requested format - - - - Compute and return the multi-stage signing key for the request. - - The clear-text AWS secret key, if not held in secureKey - The region in which the service request will be processed - Date of the request, in yyyyMMdd format - The name of the service being called by the request - Computed signing key - - - - If the caller has already set the x-amz-content-sha256 header with a pre-computed - content hash, or it is present as ContentStreamHash on the request instance, return - the value to be used in request canonicalization. - If not set as a header or in the request, attempt to compute a hash based on - inspection of the style of the request content. - - - - The computed hash, whether already set in headers or computed here. Null - if we were not able to compute a hash. - - - - - If signPayload is false set the x-amz-content-sha256 header to - the UNSIGNED-PAYLOAD magic string and return it. - Otherwise, if the caller has already set the x-amz-content-sha256 header with a pre-computed - content hash, or it is present as ContentStreamHash on the request instance, return - the value to be used in request canonicalization. - If not set as a header or in the request, attempt to compute a hash based on - inspection of the style of the request content. - - - - - The computed hash, whether already set in headers or computed here. Null - if we were not able to compute a hash. - - - - - Returns the HMAC256 for an arbitrary blob using the specified key - - - - - - - - Returns the HMAC256 for an arbitrary blob using the specified key - - - - - - - - Compute and return the hash of a data blob using the specified key - - Algorithm to use for hashing - Hash key - Data blob - Hash of the data - - - - Compute and return the hash of a data blob using the specified key - - Algorithm to use for hashing - Hash key - Data blob - Hash of the data - - - - Computes the non-keyed hash of the supplied data - - - - - - - Computes the non-keyed hash of the supplied data - - - - - - - Computes and returns the canonical request - - The endpoint URL - the path of the resource being operated on - The http method used for the request - The full request headers, sorted into canonical order - The query parameters for the request - - The hash of the binary request body if present. If not supplied, the routine - will look for the hash as a header on the request. - - Canonicalised request as a string - - - - Computes and returns the canonical request - - The endpoint URL - the path of the resource being operated on - The http method used for the request - The full request headers, sorted into canonical order - The query parameters for the request - - The path resource values lookup to use to replace the keys within resourcePath - The hash of the binary request body if present. If not supplied, the routine - will look for the hash as a header on the request. - - The version of the marshaller that constructed the request object. - Canonicalised request as a string - - - - Computes and returns the canonical request - - The endpoint URL - the path of the resource being operated on - The http method used for the request - The full request headers, sorted into canonical order - The query parameters for the request - - The path resource values lookup to use to replace the keys within resourcePath - The hash of the binary request body if present. If not supplied, the routine - will look for the hash as a header on the request. - - The version of the marshaller that constructed the request object. - The service being called for the request - Canonicalised request as a string - - - - Reorders the headers for the request for canonicalization. - - The set of proposed headers for the request - List of headers that must be included in the signature - For AWS4 signing, all headers are considered viable for inclusion - - - - Computes the canonical headers with values for the request. Only headers included in the signature - are included in the canonicalization process. - - All request headers, sorted into canonical order - Canonicalized string of headers, with the header names in lower case. - - - - Returns the set of headers included in the signature as a flattened, ;-delimited string - - The headers included in the signature - Formatted string of header names - - - - Collects the subresource and query string parameters into one collection - ready for canonicalization - - The in-flight request being signed - The fused set of parameters - - - - Computes and returns the canonicalized query string, if query parameters have been supplied. - Parameters with no value will be canonicalized as 'param='. The expectation is that parameters - have not already been url encoded prior to canonicalization. - - The set of parameters being passed on the uri - - Parameters must be uri encoded into the canonical request and by default the signer expects - that the supplied collection contains non-encoded data. Set this to false if the encoding was - done prior to signer entry. - - The uri encoded query string parameters in canonical ordering - - - - Computes and returns the canonicalized query string, if query parameters have been supplied. - Parameters with no value will be canonicalized as 'param='. The expectation is that parameters - have not already been url encoded prior to canonicalization. - - The set of parameters to be encoded in the query string - - Parameters must be uri encoded into the canonical request and by default the signer expects - that the supplied collection contains non-encoded data. Set this to false if the encoding was - done prior to signer entry. - - The uri encoded query string parameters in canonical ordering - - - - Returns the request parameters in the form of a query string. - - The request instance - Request parameters in query string format - - - - AWS4 protocol signer for Amazon S3 presigned urls. - - - - - Calculates and signs the specified request using the AWS4 signing protocol by using the - AWS account credentials given in the method parameters. The resulting signature is added - to the request headers as 'Authorization'. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. - - - Adding supporting data for the service call required by the signer (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text - - - If any problems are encountered while signing the request. - - - - - Calculates the AWS4 signature for a presigned url. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. If the Expires parameter - is present, it is renamed to 'X-Amz-Expires' before signing. - - - Adding supporting data for the service call required by the signer (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text - - - If any problems are encountered while signing the request. - - - Parameters passed as part of the resource path should be uri-encoded prior to - entry to the signer. Parameters passed in the request.Parameters collection should - be not be encoded; encoding will be done for these parameters as part of the - construction of the canonical request. - - - - - Calculates the AWS4 signature for a presigned url. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. If the Expires parameter - is present, it is renamed to 'X-Amz-Expires' before signing. - - - Adding supporting data for the service call required by the signer (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text - - - The service to sign for - - - The region to sign to, if null then the region the client is configured for will be used. - - - If any problems are encountered while signing the request. - - - Parameters passed as part of the resource path should be uri-encoded prior to - entry to the signer. Parameters passed in the request.Parameters collection should - be not be encoded; encoding will be done for these parameters as part of the - construction of the canonical request. - - The X-Amz-Content-SHA256 is cleared out of the request. - If the request is for S3 then the UNSIGNED_PAYLOAD value is used to generate the canonical request. - If the request isn't for S3 then the empty body SHA is used to generate the canonical request. - - - - - Encapsulates the various fields and eventual signing value that makes up - an AWS4 signature. This can be used to retrieve the required authorization string - or authorization query parameters for the final request as well as hold ongoing - signature computations for subsequent calls related to the initial signing. - - - - - Constructs a new signing result instance for a computed signature - - The access key that was included in the signature - Date/time (UTC) that the signature was computed - The collection of headers names that were included in the signature - Formatted 'scope' value for signing (YYYYMMDD/region/service/aws4_request) - Returns the key that was used to compute the signature - Computed signature - - - - The access key that was used in signature computation. - - - - - ISO8601 formatted date/time that the signature was computed - - - - - ISO8601 formatted date that the signature was computed - - - - - The ;-delimited collection of header names that were included in the signature computation - - - - - Formatted 'scope' value for signing (YYYYMMDD/region/service/aws4_request) - - - - - Returns a copy of the key that was used to compute the signature - - - - - Returns the hex string representing the signature - - - - - Returns a copy of the byte array containing the signature - - - - - Returns the signature in a form usable as an 'Authorization' header value. - - - - - Returns the signature in a form usable as a set of query string parameters. - - - - - Null Signer which does a no-op. - - - - - Signs the specified request with the AWS2 signing protocol by using the - AWS account credentials given in the method parameters. - - The AWS public key - The AWS secret key used to sign the request in clear text - Request metrics - The configuration that specifies which hashing algorithm to use - The request to have the signature compute for - If any problems are encountered while signing the request - - - - S3 signer constructor - - - - - S3 signer constructor - - - - - This exception is thrown if there are problems signing the request. - - - - - Constructs a new instance of the SignatureException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Collection used to indicate if the property was initialized was created by the SDK. - - - - - - Collection used to indicate if the property was initialized was created by the SDK. - - - - - - - Default implementation of the IRequest interface. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Constructs a new DefaultRequest with the specified service name and the - original, user facing request object. - - The orignal request that is being wrapped - The service name - - - - The name of the request - - - - - Gets and sets the type of http request to make, whether it should be POST,GET or DELETE - - - - - Gets and sets a flag that indicates whether the request is sent as a query string instead of the request body. - - - - - Returns the original, user facing request object which this internal - request object is representing. - - - - - Returns a dictionary of the headers included in this request. - - - - - Returns a dictionary of the parameters included in this request. - - - - - Collection of parameters included in this request. - - - - - Returns the subresources that should be appended to the resource path. - This is used primarily for Amazon S3, where object keys can contain '?' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new null entry to the SubResources collection for the request - - The name of the subresource - - - - Adds a new entry to the SubResources collection for the request - - The name of the subresource - Value of the entry - - - - Gets and Sets the endpoint for this request. - - - - - Gets and Sets the resource path added on to the endpoint. - - - - - Returns the path resources that should be used within the resource path. - This is used for services where path keys can contain '/' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new entry to the PathResources collection for the request - - The name of the pathresource with potential greedy syntax: {key+} - Value of the entry - - - - Gets and Sets the version number for the marshaller used to create this request. The version number - is used to support backward compatible changes that would otherwise be breaking changes when a - newer core is used with an older service assembly. - Versions: - 1 - Default version - 2 - Support for path segments - - - - - Gets and Sets the content for this request. - - - - - Flag that signals that Content was and should be set - from the Parameters collection. - - - - - Gets and sets the content stream. - - - - - Gets and sets the original stream position. - If ContentStream is null or does not support seek, this propery - should be equal to -1. - - - - - Computes the SHA 256 hash of the content stream. If the stream is not - seekable, it searches the parent stream hierarchy to find a seekable - stream prior to computation. Once computed, the hash is cached for future - use. If a suitable stream cannot be found to use, null is returned. - - - - - The name of the service to which this request is being sent. - - - - - Alternate endpoint to use for this request, if any. - - - - - Host prefix value to prepend to the endpoint for this request, if any. - - - - - Gets and sets the Suppress404Exceptions property. If true then 404s return back from AWS will not cause an exception and - an empty response object will be returned. - - - - - If using AWS4 signing protocol, contains the resultant parts of the - signature that we may need to make use of if we elect to do a chunked - encoding upload. - - - - - Determine whether to use a chunked encoding upload for the request - (applies to Amazon S3 PutObject and UploadPart requests only). - - - - - - Used for Amazon S3 requests where the bucket name is removed from - the marshalled resource path into the host header. To comply with - AWS2 signature calculation, we need to recover the bucket name - and include it in the resource canonicalization, which we do using - this field. - - - - - This flag specifies if SigV4 is required for the current request. - - - - - The authentication region to use for the request. - Set from Config.AuthenticationRegion. - - - - - The region in which the service request was signed. - - - - - Checks if the request stream can be rewinded. - - Returns true if the request stream can be rewinded , - else false. - - - - Returns true if the request can contain a request body, else false. - - Returns true if the currect request can contain a request body, else false. - - - - Returns true if the request has a body, else false. - - Returns true if the request has a body, else false. - - - - Class containing the data for one endpoint returned from a endpoint discovery request - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Constructs a new DiscoveryEndpoint - - The address of the endpoint - The cache period for the endpoint in minutes - - - - The address of the endpoint. - - - - - The cache period for the endpoint in minutes - - - - - Calculates if this endpoint has expired - - A boolean value indicating if the cache period has expired - - - - Extends the endpoint expiration by the specified number of minutes from now. - - - - - Class containing the data for one endpoint returned from a endpoint discovery request - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class containing the data to use with endpoint discovery - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Gets/sets and flag indicating if endpoint discovery is required for the request. - - - - - Sorted dictionary of the identifiers that must be sent with the endpoint discovery request. These - identifiers are used to construct the cache key for the cache that stores discovered endpoints. A - sorted dictionary is used instead of a dictionary to ensure the cache key comes out in the same order - each time it is constructed. - - - - - Represents the data to be used with endpoint discovery operations - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class used to resolve endpoints using Endpoint Discovery. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Method that performs endpoint discovery for the current operation - - Context information used in calculations for endpoint discovery - The operation to fetch endpoints from the server - - - - - Gets the number of cache keys in the cache - - - - - Class used to resolve endpoints using Endpoint Discovery. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class containing context information to use with endpoint discovery - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Gets the customer credential information. - - - - - Gets the operation name. - - - - - Gets the current marshalled endpoint discovery data. - - - - - Gets the flag indicating if the specified key should be evicted from the cache. - - - - - Gets the Uri that should be evicted if EvictCacheKey is set to true. - - - - - Class containing context information to use with endpoint discovery - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Error type, one of Sender, Receiver, Unknown - Only applies to XML-based services. - - - - - Name of the exception class to return - - - - - Error message - - - - - RequestId of the error. - Only applies to XML-based services. - - - - - InternalConfiguration holds the cached SDK configuration values - obtained from the environment and profile configuration - factories. These configuration values are loaded internally and - are not the same as user exposed AWSConfigs. - - - - - Flag indicating if Endpoint Discovery is enabled. - - - - - The retry mode to use: Legacy, Standard, or Adaptive. - - - - - The max number of request attempts. - - - - - Determines the configuration values based on environment variables. If - no values is found for a configuration the value will be set to null. - - - - - Attempts to construct a configuration instance of configuration environment - variables. If an environment variable value isn't found then the individual value - for that environment variable will be null. If unable to obtain a value converter - to convert a configuration string to the appropriate type a InvalidOperationException - is thrown. - - - - - Determines configuration values based on a stored in an . - If the profile doesn't exist, the status will be logged and no value will be set in the configuration. - - - - - Attempts to construct an instance of . - If the AWS_PROFILE environment variable is set the instance will be constructed using that profile, - otherwise it will use the default profile. - - If the profile doesn't exist status will be logged and no value will be set in the configuration. - - The ICredentialProfileSource to read the profile from. - - - - Attempts to construct an instance of . - If the profile doesn't exist status will be logged and no value will be set in the configuration. - - The ICredentialProfileSource to read the profile from. - The name of the profile. - - - - Probing mechanism to determine the configuration values from various sources. - - - - - Resets all the configuration values reloading as needed. This method will use - the AWS_PROFILE environment variable if set to construct the instance. Otherwise - the default profile will be used. - - - - - Flag that specifies if endpoint discovery is enabled, disabled, - or not set. - - - - - Flag that specifies which retry mode to use or if retry mode has - not been set. - - - - - Flag that specifies the max number of request attempts or if max - attempts has not been set. - - - - - Class containing the members used to invoke service calls - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class containing the members used to invoke service calls - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Represents a request being sent to an Amazon Web Service, including the - parameters being sent as part of the request, the endpoint to which the - request should be sent, etc. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - The name of the request - - - - - Returns a dictionary of the headers included in this request. - - - - - Gets and sets a flag that indicates whether the request is sent as a query string instead of the request body. - - - - - Returns a dictionary of the parameters included in this request. - - - - - Collection of parameters included in this request. - - - - - Returns the subresources that should be appended to the resource path. - This is used primarily for Amazon S3, where object keys can contain '?' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new null entry to the SubResources collection for the request - - The name of the subresource - - - - Adds a new entry to the SubResources collection for the request - - The name of the subresource - Value of the entry - - - - Gets and sets the type of http request to make, whether it should be POST,GET or DELETE - - - - - Gets and Sets the endpoint for this request. - - - - - Gets and Sets the resource path added on to the endpoint. - - - - - Returns the path resources that should be used within the resource path. - This is used for services where path keys can contain '/' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new entry to the PathResources collection for the request - - The name of the pathresource with potential greedy syntax: {key+} - Value of the entry - - - - Gets and Sets the version number for the marshaller used to create this request. The version number - is used to support backward compatible changes that would otherwise be breaking changes when a - newer core is used with an older service assembly. - - - - - Gets and Sets the content for this request. - - - - - Gets the header value from the request. - - - - - Flag that signals that Content was and should be set - from the Parameters collection. - - - - - Gets and sets the content stream. - - - - - Gets and sets the original stream position. - If ContentStream is null or does not support seek, this propery - should be equal to -1. - - - - - Computes the SHA 256 hash of the content stream. If the stream is not - seekable, it searches the parent stream hierarchy to find a seekable - stream prior to computation. Once computed, the hash is cached for future - use. - - - - - The name of the service to which this request is being sent. - - - - - Returns the original, user facing request object which this internal - request object is representing. - - - - - Alternate endpoint to use for this request, if any. - - - - - Host prefix value to prepend to the endpoint for this request, if any. - - - - - Gets and sets the Suppress404Exceptions property. If true then 404s return back from AWS will not cause an exception and - an empty response object will be returned. - - - - - If using AWS4 signing protocol, contains the resultant parts of the - signature that we may need to make use of if we elect to do a chunked - encoding upload. - - - - - Determine whether to use a chunked encoding upload for the request - (applies to Amazon S3 PutObject and UploadPart requests only). - - - - - - Used for Amazon S3 requests where the bucket name is removed from - the marshalled resource path into the host header. To comply with - AWS2 signature calculation, we need to recover the bucket name - and include it in the resource canonicalization, which we do using - this field. - - - - - This flag specifies if SigV4 is required for the current request. - - - - - The authentication region to use for the request. - Set from Config.AuthenticationRegion. - - - - - The region in which the service request was signed. - - - - - Checks if the request stream can be rewinded. - - Returns true if the request stream can be rewinded , - else false. - - - - Returns true if the request can contain a request body, else false. - - Returns true if the currect request can contain a request body, else false. - - - - Returns true if the request has a body, else false. - - Returns true if the request has a body, else false. - - - - Gets the value of the Service Id. - - - - - Gets the dictionary that gives mapping of renamed operations - - - - - IDictionary{String, String} access to ParameterCollection. - TODO: remove this class in version 3.4 of the SDK. - - - - - Constructs ParametersDictionaryFacade for a ParameterCollection - - - - - - A registry of object that will manipulate the runtime pipeline used by service clients. - - - - - Registers a customizer that will be applied for all service clients created. Each customizer has a unique name associated with it. If a customizer is registered more - than once with the same unique name then the calls after the first will be ignored. - - - - - - Deregistered the runtime pipeline customizer - - - - - - Deregistered the runtime pipeline customizer - - - - - - Applies all of the registered customizers on the runtime pipeline - - The service clients runtime pipeline. - Type object for the service client being created - - - - Interface for objects that will customize the runtime pipleine for newly created service clients. - - - - - The unique name for the customizer that identifies the customizer in the registry. The name is also used to identify the customizer on the SDK logs. - - - - - Called on service clients as they are being constructed to customize their runtime pipeline. - - - Type object for the service client being created - - - - Default ServiceMetadata implementation. - This implementation will be used if the service doesn't have a - IServiceMetadata implementation. - - - - - Gets the value of the Service Id. - - - - - Gets the dictionary that gives mapping of renamed operations - - - - - Response Unmarshaller for all Errors - - - - - Build an ErrorResponse from XML - - The XML parsing context. - Usually an Amazon.Runtime.Internal.UnmarshallerContext. - An ErrorResponse object. - - - - Return an instance of and ErrorResponseUnmarshaller. - - - - - - Interface for unmarshallers which unmarshall objects from response data. - The Unmarshallers are stateless, and only encode the rules for what data - in the XML stream goes into what members of an object. - - The type of object the unmarshaller returns - The type of the XML unmashaller context, which contains the - state during parsing of the XML stream. Usually an instance of - Amazon.Runtime.Internal.Transform.UnmarshallerContext. - - - - Given the current position in the XML stream, extract a T. - - The XML parsing context - An object of type T populated with data from the XML stream. - - - - Interface for unmarshallers which unmarshall service responses. - The Unmarshallers are stateless, and only encode the rules for what data - in the XML stream goes into what members of an object. - - The type of object the unmarshaller returns - The type of the XML unmashaller context, which contains the - state of parsing the XML stream. Uaually an instance of - Amazon.Runtime.Internal.Transform.UnmarshallerContext. - - - - Extracts an exeption with data from an ErrorResponse. - - The XML parsing context. - An inner exception to be included with the returned exception - The HttpStatusCode from the ErrorResponse - Either an exception based on the ErrorCode from the ErrorResponse, or the - general service exception for the service in question. - - - - Interface for unmarshallers which unmarshall objects from response data. - The Unmarshallers are stateless, and only encode the rules for what data - in the XML stream goes into what members of an object. - - The type of object the unmarshaller returns - The type of the XML unmashaller context, which contains the - state during parsing of the XML stream. Usually an instance of - Amazon.Runtime.Internal.Transform.UnmarshallerContext. - - - - Given the current position in the XML stream, extract a T. - - The XML parsing context - An object of type T populated with data from the XML stream. - - - - First-pass unmarshaller for all errors - - - - - Build an ErrorResponse from json - - The json parsing context. - Usually an Amazon.Runtime.Internal.JsonUnmarshallerContext. - An ErrorResponse object. - - - - Return an instance of JsonErrorResponseUnmarshaller. - - - - - - Wraps a json string for unmarshalling. - - Each Read() operation gets the next token. - TestExpression() is used to match the current key-chain - to an xpath expression. The general pattern looks like this: - - JsonUnmarshallerContext context = new JsonUnmarshallerContext(jsonString); - while (context.Read()) - { - if (context.IsKey) - { - if (context.TestExpresion("path/to/element")) - { - myObject.stringMember = stringUnmarshaller.GetInstance().Unmarshall(context); - continue; - } - } - } - - - - - - Wrap the jsonstring for unmarshalling. - - Stream that contains the JSON for unmarshalling - If set to true, maintains a copy of the complete response body constraint to log response size as the stream is being read. - Response data coming back from the request - If set to true, maintains a copy of the complete response body as the stream is being read. - - - - Are we at the start of the json document. - - - - - Is the current token the end of an object - - - - - Is the current token the start of an object - - - - - Returns the element depth of the parser's current position in the json - document being parsed. - - - - - The current Json path that is being unmarshalled. - - - - - Reads to the next token in the json document, and updates the context - accordingly. - - - True if a token was read, false if there are no more tokens to read. - - - - - Peeks at the next token. This peek implementation - reads the next token and makes the subsequent Read() return the same data. - If Peek is called successively, it will return the same data. - Only the first one calls Read(), subsequent calls - will return the same data until a Read() call is made. - - Token to peek. - Returns true if the peeked token matches given token. - - - - Returns the text contents of the current token being parsed. - - - The text contents of the current token being parsed. - - - - - The type of the current token - - - - - Get the base stream of the jsonStream. - - - - - Peeks at the next (non-whitespace) character in the jsonStream. - - The next (non-whitespace) character in the jsonStream, or -1 if at the end. - - - - Peeks at the next character in the stream. - If the data isn't buffered into the StreamReader (Peek() returns -1), - we flush the buffered data and try one more time. - - - - - - Abstract class for unmarshalling service responses. - - - - - Class for unmarshalling XML service responses. - - - - - Class for unmarshalling EC2 service responses. - - - - - Class for unmarshalling JSON service responses. - - - - - Unmarshaller for int fields - - - - - Unmarshaller for nullable int fields. Implemented only for JSON context - to handle cases where value can be null e.g. {'Priority': null}. - This unmarshaller is not implemented for XML context, as XML responses - will null elements (xsi:nil='true') will be skipped by the XML parser. - - - - - Unmarshaller for long fields - - - - - Unmarshaller for float fields - - - - - Unmarshaller for double fields - - - - - Unmarshaller for decimal fields - - - - - Unmarshaller for bool fields - - - - - Unmarshaller for string fields - - - - - Unmarshaller for byte fields - - - - - Unmarshaller for DateTime fields - - - - - Unmarshalls given string as a DateTime. Handles cases where we want to unmarshall - as just a DateTime or a nullable Datetime. - - Value to be parsed - If true, the method will return null if text is null. - If false, the method will return default(DateTime), if text is null. - - - - - Unmarshaller for nullable DateTime fields. Implemented only for JSON context - to handle cases where value can be null e.g. {'Priority': null}. - This unmarshaller is not implemented for XML context, as XML responses - will null elements (xsi:nil='true') will be skipped by the XML parser. - - - - - Unmarshaller for MemoryStream fields - - - - - Unmarshaller for ResponseMetadata - - - - - Base class for the UnmarshallerContext objects that are used - to unmarshall a web-service response. - - - - - Tests the specified expression against the current position in the XML - document - - The pseudo-XPath expression to test. - - True if the expression matches the current position in the document, - false otherwise. - - - - Tests the specified expression against the current position in the XML - document being parsed, and restricts the expression to matching at the - specified stack depth. - - The pseudo-XPath expression to test. - - The depth in the stack representing where the expression must - start matching in order for this method to return true. - - True if the specified expression matches the current position in - the XML document, starting from the specified depth. - - - - Reads the next token at depth greater than or equal to target depth. - - Tokens are read at depth greater than or equal to target depth. - True if a token was read and current depth is greater than or equal to target depth. - - - - The current path that is being unmarshalled. - - - - - Returns the element depth of the parser's current position in the - document being parsed. - - - - - Reads to the next node in the document, and updates the context accordingly. - - - True if a node was read, false if there are no more elements to read. - - - - - Returns the text contents of the current element being parsed. - - - The text contents of the current element being parsed. - - - - - True if NodeType is Element. - - - - - True if NodeType is EndElement. - - - - - True if the context is at the start of the document. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Wrap an XmltextReader for simulating an event stream. - - Each Read() operation goes either to the next element or next attribute within - the current element. TestExpression() is used to match the current event - to an xpath expression. The general pattern looks like this: - - UnmarshallerContext context = new UnmarshallerContext(...); - while (context.Read()) - { - if (context.TestExpresion("path/to/element")) - { - myObject.stringMember = stringUnmarshaller.GetInstance().Unmarshall(context); - continue; - } - if (context.TestExpression("path/to/@attribute")) - myObject.MyComplexTypeMember = MyComplexTypeUnmarshaller.GetInstance().Unmarshall(context); - } - - - - - - Wrap an XmlTextReader with state for event-based parsing of an XML stream. - - Stream with the XML from a service response. - If set to true, maintains a copy of the complete response body constraint to log response size as the stream is being read. - Response data coming back from the request - If set to true, maintains a copy of the complete response body as the stream is being read. - - - - The current XML path that is being unmarshalled. - - - - - Returns the element depth of the parser's current position in the XML - document being parsed. - - - - - Reads to the next node in the XML document, and updates the context accordingly. - - - True if a node was read, false if there are no more elements to read./ - - - - - Returns the text contents of the current element being parsed. - - - The text contents of the current element being parsed. - - - - - True if NodeType is Element. - - - - - True if NodeType is EndElement. - - - - - True if the context is at the start of the document. - - - - - True if NodeType is Attribute. - - - - - Wrap an XmlTextReader with state for event-based parsing of an XML stream. - - Stream with the XML from a service response. - If set to true, maintains a copy of the complete response body constraint to log response size as the stream is being read. - Response data coming back from the request - If set to true, maintains a copy of the complete response body as the stream is being read. - - - - RequestId value, if found in response - - - - - Reads to the next node in the XML document, and updates the context accordingly. - If node is RequestId, reads the contents and stores in RequestId property. - - - True if a node was read, false if there are no more elements to read./ - - - - - Constructs a new instance of the HttpWebRequestResponseData class with serialized data. - - The that holds the serialized object data. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - A stream which caches the contents of the underlying stream as it reads it. - - - - - All the bytes read by the stream. - - - - - All the bytes read by the stream constrained with _cacheLimit - - - - - Initializes the CachingWrapperStream with a base stream. - - The stream to be wrapped. - Maximum number of bytes to be cached. - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Gets a value indicating whether the current stream supports seeking. - CachingWrapperStream does not support seeking, this will always be false. - - - - - Gets or sets the position within the current stream. - CachingWrapperStream does not support seeking, attempting to set Position - will throw NotSupportedException. - - - - - Sets the position within the current stream. - CachingWrapperStream does not support seeking, attempting to call Seek - will throw NotSupportedException. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Stream wrapper that double-buffers from a wrapped stream and - returns the buffered content as a series of signed 'chunks' - for the AWS4 ('Signature V4') protocol. - - - - - Reads some or all of the processed chunk to the consumer, constructing - and streaming a new chunk if more input data is available. - - - - - - - - - Results of the header-signing portion of the request - - - - - Computed signature of the chunk prior to the one in-flight, in - hex - - - - - Computes the derived signature for a chunk of data of given length in the input buffer, - placing a formatted chunk with headers, signature and data into the output buffer - ready for streaming back to the consumer. - - - - - - Length override to return the true length of the payload plus the metainfo - supplied with each chunk - - - - - Computes the total size of the data payload, including the chunk metadata. - Called externally so as to be able to set the correct Content-Length header - value. - - - - - - - Computes the size of the header data for each chunk. - - - - - - - Attempt to read sufficient data for a whole chunk from the wrapped stream, - returning the number of bytes successfully read to be processed into a chunk - - - - - A list object that will always be sent to AWS services, - even if it is empty. - The AWS .NET SDK does not send empty collections to services, unless - the collection is of this type. - - - - - - A dictionary object that will always be sent to AWS services, - even if it is empty. - The AWS .NET SDK does not send empty collections to services, unless - the collection is of this type. - - - - - - - Class to perform actions on a background thread. - Uses a single background thread and performs actions - on it in the order the data was sent through the instance. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Class to invoke actions on a background thread. - Uses a single background thread and invokes actions - on it in the order they were invoked through the instance. - - - - - PCL doesn't have IPAddress. These methods are copied from the Microsoft source code. - - - - - Returns true if the Content is set or there are - query parameters. - - This request - True if data is present; false otherwise. - - - - Utilities for dealing with Guids - - - - - Hashes a set of objects. - - - - - - - Combines a set of hashses. - - - - - - - Combines two hashes. - - - - - - - - Disposes of all managed and unmanaged resources. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - A wrapper stream that calculates a hash of the base stream as it - is being read. - The calculated hash is only available after the stream is closed or - CalculateHash is called. After calling CalculateHash, any further reads - on the streams will not change the CalculatedHash. - If an ExpectedHash is specified and is not equal to the calculated hash, - Close or CalculateHash methods will throw an AmazonClientException. - If CalculatedHash is calculated for only the portion of the stream that - is read. - - - Exception thrown during Close() or CalculateHash(), if ExpectedHash is set and - is different from CalculateHash that the stream calculates, provided that - CalculatedHash is not a zero-length byte array. - - - - - Algorithm to use to calculate hash. - - - - - True if hashing is finished and no more hashing should be done; - otherwise false. - - - - - Current position in the stream. - - - - - Calculated hash for the stream. - This value is set only after the stream is closed. - - - - - Expected hash value. Compared against CalculatedHash upon Close(). - If the hashes are different, an AmazonClientException is thrown. - - - - - Expected length of stream. - - - - - Initializes an HashStream with a hash algorithm and a base stream. - - Stream to calculate hash for. - - Expected hash. Will be compared against calculated hash on stream close. - Pass in null to disable check. - - - Expected length of the stream. If the reading stops before reaching this - position, CalculatedHash will be set to empty array. - - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Closes the underlying stream and finishes calculating the hash. - If an ExpectedHash is specified and is not equal to the calculated hash, - this method will throw an AmazonClientException. - - - If ExpectedHash is set and is different from CalculateHash that the stream calculates. - - - - - Gets a value indicating whether the current stream supports seeking. - HashStream does not support seeking, this will always be false. - - - - - Gets or sets the position within the current stream. - HashStream does not support seeking, attempting to set Position - will throw NotSupportedException. - - - - - Sets the position within the current stream. - HashStream does not support seeking, attempting to call Seek - will throw NotSupportedException. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Gets the overridden length used to construct the HashStream - - - - - Calculates the hash for the stream so far and disables any further - hashing. - - - - - Resets the hash stream to starting state. - Use this if the underlying stream has been modified and needs - to be rehashed without reconstructing the hierarchy. - - - - - Validates the underlying stream. - - - - - Compares two hashes (arrays of bytes). - - Expected hash. - Actual hash. - - True if the hashes are identical; otherwise false. - - - - - A wrapper stream that calculates a hash of the base stream as it - is being read or written. - The calculated hash is only available after the stream is closed or - CalculateHash is called. After calling CalculateHash, any further reads - on the streams will not change the CalculatedHash. - If an ExpectedHash is specified and is not equal to the calculated hash, - Close or CalculateHash methods will throw an AmazonClientException. - If base stream's position is not 0 or HashOnReads is true and the entire stream is - not read, the CalculatedHash will be set to an empty byte array and - comparison to ExpectedHash will not be made. - - - Exception thrown during Close() or CalculateHash(), if ExpectedHash is set and - is different from CalculateHash that the stream calculates, provided that - CalculatedHash is not a zero-length byte array. - - - - - Initializes an HashStream with a hash algorithm and a base stream. - - Stream to calculate hash for. - - Expected hash. Will be compared against calculated hash on stream close. - Pass in null to disable check. - - - Expected length of the stream. If the reading stops before reaching this - position, CalculatedHash will be set to empty array. - - - - - A wrapper stream that calculates an MD5 hash of the base stream as it - is being read or written. - The calculated hash is only available after the stream is closed or - CalculateHash is called. After calling CalculateHash, any further reads - on the streams will not change the CalculatedHash. - If an ExpectedHash is specified and is not equal to the calculated hash, - Close or CalculateHash methods will throw an AmazonClientException. - If base stream's position is not 0 or HashOnReads is true and the entire stream is - not read, the CalculatedHash will be set to an empty byte array and - comparison to ExpectedHash will not be made. - - - Exception thrown during Close() or CalculateHash(), if ExpectedHash is set and - is different from CalculateHash that the stream calculates, provided that - CalculatedHash is not a zero-length byte array. - - - - - Initializes an MD5Stream with a base stream. - - Stream to calculate hash for. - - Expected hash. Will be compared against calculated hash on stream close. - Pass in null to disable check. - - - Expected length of the stream. If the reading stops before reaching this - position, CalculatedHash will be set to empty array. - - - - - Utilities for validating label values for host prefix templates - - - - - Validates a label value - - - - - Simple wrapper around the log4net Error method. - - - - - - - - Write debug message to Console - - - - - - - - Write debug message to Console - - - - - - - Simple wrapper around the log4net InfoFormat method. - - - - - - - This is a dynamic wrapper around log4net so we can avoid log4net being required - to be distributed with the SDK. - - - - - Abstract logger class, base for any custom/specific loggers. - - - - - Flushes the logger contents. - - - - - Simple wrapper around the log4net IsErrorEnabled property. - - - - - Simple wrapper around the log4net IsDebugEnabled property. - - - - - Simple wrapper around the log4net IsInfoEnabled property. - - - - - Simple wrapper around the log4net Error method. - - - - - - - - Simple wrapper around the log4net Debug method. - - - - - - - - Simple wrapper around the log4net DebugFormat method. - - - - - - - Simple wrapper around the log4net InfoFormat method. - - - - - - - Logger wrapper for reflected log4net logging methods. - - - - - This should be a one time call to use reflection to find all the types and methods - needed for the logging API. - - - - - Simple wrapper around the log4net IsErrorEnabled property. - - - - - Simple wrapper around the log4net Error method. - - - - - - - - Simple wrapper around the log4net IsDebugEnabled property. - - - - - Simple wrapper around the log4net Debug method. - - - - - - - - Simple wrapper around the log4net DebugFormat method. - - - - - - - Simple wrapper around the log4net IsInfoEnabled property. - - - - - Simple wrapper around the log4net InfoFormat method. - - - - - - - A single logged message - - - - - Log message arguments. - - - - - Culture-specific formatting provider. - - - - - Log message format. - - - - - a size-limited cache of key value pairs - - Once the maximum size has been reached, the least recently - used pairs will be evicted to make room for any new items. - - - - - - - the maximum number of entries this LruCache will hold - before items begin getting evicted - - - - - the number of items in the cache - - - - - Construct a new LruCache. - - maximum number of entries before items are evicted - - - - Add the key/value pair to the cache, or update - the value if the key already exists. - - If the cache is full, evicts the least recently used item. - - - - - - - Evicts a specific key out of the cache if it exists - - the key to evict from the cache - - - - Try to get the value associated with the key. - - the key to look up - the value, if the key exists - true if there is a value associated with the key, or false if no value is associated with the key - - - - Try to get the value associated with the key, if it doesn't exist, use the provided factory method to - create a new value and tries adding it to the cache. - - the key to look up - the factory method used in case the key is not present in the cache - the looked up value or the value created by the factory - - - - Clear the LruCache of all entries. - - - - - Helper class to support LruCache. - Does not implement the error checking and synchronization that - would be necessary for it to stand alone. - - - - - Item to be stored in the LruList - linked list structure. - - - - - Collection of properties being tracked - - - - - Timings for metrics being tracked - - - - - Counters being tracked - - - - - Whether metrics are enabled for the request - - - - - Constructs an empty, disabled metrics object - - - - - Starts timing an event. Logs an exception if an event - of the same type was started but not stopped. - - - - - - - Stops timing an event. Logs an exception if the event wasn't started. - - - - - - - Adds a property for a metric. If there are multiple, the - object is added as a new item in a list. - - - - - - - Sets a counter for a specific metric. - - - - - - - Increments a specific metric counter. - If counter doesn't exist yet, it is set to 1. - - - - - - Returns errors associated with the metric, including - if there are still any timing events in-flight. - - - - - - Returns a string representation of the current metrics. - - - - - - Return a JSON represenation of the current metrics - - - - - - Timing information for a metric - - - - - Empty, stopped timing object - - - - - Timing object in a started state - - - - - - Stops timing - - - - - - Whether the timing has been stopped - - - - - Elapsed ticks from start to stop. - If timing hasn't been stopped yet, returns 0. - - - - - Elapsed time from start to stop. - If timing hasn't been stopped yet, returns TimeSpan.Zero - - - - - Timing event, stops timing of a metric when disposed - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - The destructor for the client class. - - - - - A wrapper stream which supresses disposal of the underlying stream. - - - - - Constructor for NonDisposingWrapperStream. - - The base stream to wrap. - - - - The Close implementation for this wrapper stream - does not close the underlying stream. - - - - - The Dispose implementation for this wrapper stream - does not close the underlying stream. - - - - - This class is used to wrap a stream for a particular segment of a stream. It - makes that segment look like you are reading from beginning to end of the stream. - - - - - Wrapper stream that only supports reading - - - - - Partial wrapper stream that only supports reading - - - - - Uri wrapper that can parse out information (bucket, key, region, style) from an - S3 URI. - - - - - True if the URI contains the bucket in the path, false if it contains the bucket in the authority. - - - - - The bucket name parsed from the URI (or null if no bucket specified). - - - - - The key parsed from the URI (or null if no key specified). - - - - - The region parsed from the URI (or null if no region specified). - - - - - Constructs a parser for the S3 URI specified as a string. - - The S3 URI to be parsed. - - - - Constructs a parser for the S3 URI specified as a Uri instance. - - The S3 URI to be parsed. - - - - Percent-decodes the given string, with a fast path for strings that are not - percent-encoded. - - The string to decode - The decoded string - - - - Percent-decodes the given string. - - The string to decode - The index of the first '%' in the string - The decoded string - - - - Decodes the percent-encoded character at the given index in the string - and appends the decoded value to the string under construction. - - - The string under construction to which the decoded character will be - appended. - - The string being decoded. - The index of the '%' character in the string. - - - - Converts a hex character (0-9A-Fa-f) into its corresponding quad value. - - The hex character - The quad value - - - - Interface for a non-generic cache. - - - - - Clears the entire cache. - - - - - Maximum time to keep an item around after its last use. - - - - - How often should the cache be cleared of old items. - - - - - The number of items in the cache. - - - - - Interface for a generic cache. - - - - - - - Retrieves a value out of the cache or from the source. - - - - - - - - Retrieves a value out of the cache or from the source. - If the item was in the cache, isStaleItem is set to true; - otherwise, if the item comes from the source, isStaleItem is false. - - - - - - - - - Clears a specific value from the cache if it's there. - - - - - - Returns the keys for all items in the cache. - - - - - - Executes specified operation, catches exception, clears the cache for - the given key, retries the operation. - - - - - - - - - - - SDK-wide cache. - Provides access to caches specific to a particular set of credentials - and target region. - - - - - Clear all caches - - - - - Clear all caches of a particular type - - - - - - Retrieve a cache of a specific type for a client object. - The client object can be null in cases where a cache does - not correspond to a specific AWS account or target region. - - - - - - - - - - - Retrieve a cache of a specific type for a client object. - The client object can be null in cases where a cache does - not correspond to a specific AWS account or target region. - - - - - - - - - - - Utilities for converting objects to strings. Used by the marshaller classes. - - - - - Converts a DateTime to ISO8601 formatted string. - - - - - Converts a DateTime to RFC822 formatted string. - - - - - Converts a DateTime to Unix epoch time formatted string. - - - - - A wrapper stream. - - - - - Base stream. - - - - - Initializes WrapperStream with a base stream. - - - - - - Returns the first base non-WrapperStream. - - First base stream that is non-WrapperStream. - - - - Returns the first base non-WrapperStream. - - First base stream that is non-WrapperStream. - - - - Returns the first base non-WrapperStream. - - Potential WrapperStream - Base non-WrapperStream. - - - - Gets a value indicating whether the current stream supports reading. - True if the stream supports reading; otherwise, false. - - - - - Gets a value indicating whether the current stream supports seeking. - True if the stream supports seeking; otherwise, false. - - - - - Gets a value indicating whether the current stream supports writing. - True if the stream supports writing; otherwise, false. - - - - - Closes the current stream and releases any resources (such as sockets and - file handles) associated with the current stream. - - - - - Gets the length in bytes of the stream. - - - - - Gets or sets the position within the current stream. - - - - - Gets or sets a value, in miliseconds, that determines how long the stream - will attempt to read before timing out. - - - - - Gets or sets a value, in miliseconds, that determines how long the stream - will attempt to write before timing out. - - - - - Clears all buffers for this stream and causes any buffered data to be written - to the underlying device. - - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Sets the position within the current stream. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Sets the length of the current stream. - - The desired length of the current stream in bytes. - - - - Writes a sequence of bytes to the current stream and advances the current - position within this stream by the number of bytes written. - - - An array of bytes. This method copies count bytes from buffer to the current stream. - - - The zero-based byte offset in buffer at which to begin copying bytes to the - current stream. - - The number of bytes to be written to the current stream. - - - - A wrapper stream that decrypts the base stream as it - is being read. - - - - - Initializes an DecryptStream with an decryption algorithm and a base stream. - - Stream to perform encryption on.. - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Gets a value indicating whether the current stream supports seeking. - DecryptStream does not support seeking, this will always be false. - - - - - Gets or sets the position within the current stream. - DecryptStream does not support seeking, attempting to set Position - will throw NotSupportedException. - - - - - Sets the position within the current stream. - DecryptStream does not support seeking, attempting to call Seek - will throw NotSupportedException. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Validates the underlying stream. - - - - - A wrapper stream that decrypts the base stream as it - is being read. - - - - - Initializes an DecryptStream with an decryption algorithm and a base stream. - - Stream to perform encryption on.. - Symmetric key to perform decryption - Initialization vector to perform decryption - - - - A wrapper stream that decrypts the base stream using AES algorithm as it - is being read. - - - - - Initializes an AESDecryptionStream with a base stream. - - Stream to perform decryption on.. - Symmetric key to perform decryption - Initialization vector to perform decryption - - - - A wrapper stream that encrypts the base stream as it - is being read. - - - - - Initializes an EncryptStream with an encryption algorithm and a base stream. - - Stream to perform encryption on.. - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Gets a value indicating whether the current stream supports seeking. - - - - - Returns encrypted content length. - - - - - Gets or sets the position within the current stream. - - - - - Sets the position within the current stream. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Validates the underlying stream. - - - - - A wrapper stream that encrypts the base stream as it - is being read. - - - - - Initializes an EncryptStream with an encryption algorithm and a base stream. - - Stream to perform encryption on.. - Symmetric key to perform encryption - Initialization vector to perform encryption - - - - A wrapper stream that encrypts the base stream using AES algorithm as it - is being read. - - - - - Initializes an AESEncryptionStream with a base stream. - - Stream to perform encryption on.. - Symmetric key to perform encryption - Initialization vector to perform encryption - - - - A wrapper stream that encrypts the base stream as it - is being read. - - - - - Initializes an EncryptStream for Multipart uploads with an encryption algorithm and a base stream. - - Stream to perform encryption on.. - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Gets a value indicating whether the current stream supports seeking. - - - - - Returns encrypted content length. - - - - - Gets or sets the position within the current stream. - - - - - Sets the position within the current stream. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Validates the underlying stream. - - - - - A wrapper stream that encrypts the base stream as it - is being read. - - - - - Initializes an EncryptStream with an encryption algorithm and a base stream. - - Stream to perform encryption on.. - Symmetric key to perform encryption - Initialization vector to perform encryption - - - - A wrapper stream that encrypts the base stream as it - is being read. - - - - - Initializes an AESEncryptionStream with a base stream. - - Stream to perform encryption on.. - Symmetric key to perform encryption - Initialization vector to perform encryption - - - - Provides read/write access to a file in the INI format. - - This class is not threadsafe. - - - - - Construct a new IniFile. - - path of the IniFile - - - - the path of the file - - - - - helper to access the lines of the file - - - - - Persist the changes to this INI file to disk. - - - - - Rename the section fromSectionName to toSectionName - - - - - - - Rename the section fromSectionName to toSectionName - - - - if true and destination section already exists overwrite it - - - - Copy the section fromSectionName to toSectionName - - - - Any properties in the original section that are also in this dictionary will - be replaced by the value from this dictionary. - - - - Copy the section fromSectionName to toSectionName - - - - Any properties in the original section that are also in this dictionary will - be replaced by the value from this dictionary. - if true and destination section already exists overwrite it - - - - Update the section with the properties given. - If the section doesn't exist, it will be appended to the file. - - Notes: - 1. Any properties that do exist in the section will be updated. - 2. A null value for a property denotes that it should be deleted from the section - 3. If any properties don't exist they will be appended to the end of the section - in the same order they appear in the SortedDictionary. - - name of the section to operate on - properties to add/update/delete - - - - Check if the section exists. If not, append it to the end of the file. - - section to ensure exists - - - - If the section exists, delete it from the INI file. - - section to delete - - - - Determine if a section exists in the INI file. - - name of section to look for - true if the section exists, false otherwise - - - - Return the properties for the section if it exists. - - name of section to get - properties contained in the section - True if the section was found, false otherwise - - - - Return the properties for the section if it exists. - - Regex to match name of section to get - properties contained in the section - True if the section was found, false otherwise - - - - Return the properties for the section if it exists. - - Regex to match name of section to get - name of section if regex matches - properties contained in the section - True if the section was found, false otherwise - - - - Logger wrapper for System.Diagnostics.TraceSource logger. - - - - - Creates TraceRoute for a given Type or the closest "parent" that has a listener configured. - Example: if type is Amazon.DynamoDB.AmazonDynamoDBClient, listeners can be configured for: - -Amazon.DynamoDB.AmazonDynamoDBClient - -Amazon.DynamoDB - -Amazon - The first matching TraceSource with listeners will be used. - If no listeners are configured for type or one of its "parents", will return null. - - - - - Gets a TraceSource for given Type with SourceLevels.All. - If there are no listeners configured for targetType or one of its "parents", returns null. - - - - - - - Gets a TraceSource for given Type and SourceLevels. - If there are no listeners configured for targetType or one of its "parents", returns null. - - - - - - - - Provides line-based read/write access to a file. - The file can be read into memory, changed, then written back to disk. - When the file is persisted back to disk, an optimistic concurrency - check is performed to make sure the file hasn't changed since it was - originally read. - - This class is not threadsafe. - - - - - a full copy of the original file - This is used for optimistic concurrency. - Note that this assumes a small file and does not scale large files. - - - - - path of the file - - - - - Read/write access to the lines that make up the file. - Any changes to this List are persisted back to disk when Persist() is called. - - NOTE: - The lines have the original line endings on them to preserve the - original text as much as possible. - - - - - Construct a new OptimisticLockedTextFile. - - path of the file - - - - Persist changes to disk after an optimistic concurrency check is completed. - - - - - Subclass of IniFile that allows INI sections to be read with the profile keyword in front of the section name. - - - - - Collection of parameters that an SDK client will send to a service. - - - - - Constructs empty ParameterCollection. - - - - - Adds a parameter with a string value. - - - - - - - Adds a parameter with a list-of-strings value. - - - - - - - Converts the current parameters into a list of key-value pairs. - - - - - - Property to denote that the last exception returned by an AWS Service - was retryable or not. - - - - - This handler processes exceptions thrown from the HTTP handler and - unmarshalls error responses. - - - - - Default set of exception handlers. - - - - - Default set of exception handlers. - - - - - Constructor for ErrorHandler. - - an ILogger instance. - - - - Handles and processes any exception thrown from underlying handlers. - - The execution context which contains both the - requests and response context. - - - - Handles and processes any exception thrown from underlying handlers. - - The execution context, it contains the - request and response context. - - - - Disposes the response body. - - The response context. - - - - Processes an exception by invoking a matching exception handler - for the given exception. - - The execution context, it contains the - request and response context. - The exception to be processed. - - This method returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception that may be thrown by exception - processing by a matching exception handler. - - - - - The abstract base class for exception handlers. - - The exception type. - - - - The exception handler for HttpErrorResponseException exception. - - - - - The constructor for HttpErrorResponseExceptionHandler. - - in instance of ILogger. - - - - Handles an exception for the given execution context. - - The execution context, it contains the - request and response context. - The exception to handle. - - Returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception to replace the original exception. - - - - - Checks if a HTTP 404 status code is returned which needs to be suppressed and - processes it. - If a suppressed 404 is present, it unmarshalls the response and returns true to - indicate that a suppressed 404 was processed, else returns false. - - The execution context, it contains the - request and response context. - - - If a suppressed 404 is present, returns true, else returns false. - - - - - The exception handler for HttpErrorResponseException exception. - - - - - A pipeline handler which provides hooks to run - external code in the pre-invoke and post-invoke phases. - - - - - Action to execute on the pre invoke phase. - - - - - Action to execute on the post invoke phase. - - - - - Calls the PreInvoke and PostInvoke methods before and after calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls the PreInvoke method before calling the next handler in the pipeline. - - The execution context which contains both the - requests and response context. - IAsyncResult which represent an async operation. - - - - Calls the PostInvoke methods after calling the next handler - in the pipeline. - - The execution context, it contains the - request and response context. - - - - Executes the OnPreInvoke action as part of pre-invoke. - - The execution context, it contains the - request and response context. - - - - Executes the OnPreInvoke action as part of post-invoke. - - The execution context, it contains the - request and response context. - - - - This handler retrieved the AWS credentials to be used for the current call. - - - - - The constructor for CredentialsRetriever. - - An AWSCredentials instance. - - - - Retrieves the credentials to be used for the current call before - invoking the next handler. - - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - IAsyncResult which represent an async operation. - - - - This handler resolves the endpoint to be used for the current request. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Invokes the inner handler - - The execution context which contains both the - requests and response context. - - - - Resolves the endpoint to be used for the current request - before invoking the next handler. - - The execution context, it contains the - request and response context. - - - - This handler resolves the endpoint to be used for the current request. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - IAsyncResult which represent an async operation. - - - - Resolves the endpoint to be used for the current request - before invoking the next handler. - - The execution context, it contains the - request and response context. - - - - Determines the endpoint for the request. - - The request context. - - - - - This handler provides an OnError action that can be used as hook for - external code to handle exceptions in the runtime pipeline. - - - - - Action to execute if an exception occurs during the - execution of any underlying handlers. - - - - - Executes the OnError action if an exception occurs during the - execution of any underlying handlers. - - - - - - - This handler marshalls the request before calling invoking the next handler. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - IAsyncResult which represent an async operation. - - - - Marshalls the request before calling invoking the next handler. - - The execution context, it contains the - request and response context. - - - - This handler manages the metrics used to time the complete call and - logs the final metrics. - - - - - Captures the overall execution time and logs final metrics. - - The execution context which contains both the - requests and response context. - - - - Captures the overall execution time. - - The execution context which contains both the - requests and response context. - IAsyncResult which represent an async operation. - - - - Captures the overall execution time and logs final metrics. - - The execution context, it contains the - request and response context. - - - - This handler processes HTTP redirects and reissues the call to the - redirected location. - - - - - Processes HTTP redirects and reissues the call to the - redirected location. - - The execution context which contains both the - requests and response context. - - - - Processes HTTP redirects and reissues the call to the - redirected location. - - The execution context, it contains the - request and response context. - - - - Checks if an HTTP 307 (temporary redirect) has occured and changes the - request endpoint to the redirected location. - - - The execution context, it contains the request and response context. - - - A boolean value that indicates if a redirect has occured. - - - - - This handler signs the request. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - IAsyncResult which represent an async operation. - - - - Signs the request before invoking the next handler. - - - The execution context, it contains the request and response context. - - - - - Determines if the request should be signed. - - The request context. - A boolean value that indicated if the request should be signed. - - - - Signs the request. - - The request context. - - - - This handler unmarshalls the HTTP response. - - - - - The constructor for Unmarshaller. - - - Boolean value which indicated if the unmarshaller - handler supports response logging. - - - - - Unmarshalls the response returned by the HttpHandler. - - The execution context which contains both the - requests and response context. - - - - Unmarshalls the response returned by the HttpHandler. - - The execution context, it contains the - request and response context. - - - - Unmarshalls the HTTP response. - - - The execution context, it contains the request and response context. - - - - - Constructs a new instance of the HttpErrorResponseException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - The HTTP handler contains common logic for issuing an HTTP request that is - independent of the underlying HTTP infrastructure. - - - - - - The sender parameter used in any events raised by this handler. - - - - - The constructor for HttpHandler. - - The request factory used to create HTTP Requests. - The sender parameter used in any events raised by this handler. - - - - Issues an HTTP request for the current request context. - - The execution context which contains both the - requests and response context. - - - - Issues an HTTP request for the current request context. - - The execution context which contains both the - requests and response context. - IAsyncResult which represent an async operation. - - - - Determines the content for request body and uses the HTTP request - to write the content to the HTTP request body. - - Content to be written. - The HTTP request. - The request context. - - - - Creates the HttpWebRequest and configures the end point, content, user agent and proxy settings. - - The async request. - The web request that actually makes the call. - - - - Disposes the HTTP handler. - - - - - The request factory for System.Net.HttpWebRequest. - - - - - Some AWS services like Cloud 9 require at least TLS 1.1. Version of .NET Framework 4.5 and earlier - do not eanble TLS 1.1 and TLS 1.2 by default. This code adds those protocols if using an earlier - version of .NET that explicitly set the protocol and didn't have TLS 1.1 and TLS 1.2. - - - - - - Some AWS services like Cloud 9 require at least TLS 1.1. Version of .NET Framework 4.5 and earlier - do not eanble TLS 1.1 and TLS 1.2 by default. This code adds those protocols if using an earlier - version of .NET that explicitly set the protocol and didn't have TLS 1.1 and TLS 1.2. - - - - - - - Creates an HTTP request for the given URI. - - The request URI. - An HTTP request. - - - - This method is used for unit testing purposes. It allows setting of the flag - that indicates protocol setting was attempted. - - The new value - - - - Disposes the HttpWebRequestFactory. - - - - - HTTP request wrapper for System.Net.HttpWebRequest. - - - - - Constructor for HttpRequest. - - The request URI. - - - - The underlying HTTP web request. - - - - - The HTTP method or verb. - - - - - The request URI. - - - - - Returns the HTTP response. - - The HTTP response. - - - - Gets a handle to the request content. - - The request content. - - - - Writes a stream to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - The request context. - - - - Writes a byte array to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - - - - Aborts the HTTP request. - - - - - Initiates the operation to gets a handle to the request content. - - The async callback invoked when the operation completes. - The state object to be passed to the async callback. - IAsyncResult that represents an async operation. - - - - Ends the operation to gets a handle to the request content. - - IAsyncResult that represents an async operation. - The request content. - - - - Initiates the operation to Returns the HTTP response. - - The async callback invoked when the operation completes. - The state object to be passed to the async callback. - IAsyncResult that represents an async operation. - - - - Ends the operation to Returns the HTTP response. - - IAsyncResult that represents an async operation. - The HTTP response. - - - - Configures a request as per the request context. - - The request context. - - - - Sets the headers on the request. - - A dictionary of header names and values. - - - - Disposes the HttpRequest. - - - - - Sets up the progress listeners - - The content stream - The interval at which progress needs to be published - The objects which is trigerring the progress changes - The callback which will be invoked when the progress changed event is trigerred - an object, incase the progress is setup, else returns the original stream - - - - An abstract pipeline handler that has implements IPipelineHandler, - and has the default implmentation. This is the base class for most of - the handler implementations. - - - - - The logger used to log messages. - - - - - The inner handler which is called after the current - handler completes it's processing. - - - - - The outer handler which encapsulates the current handler. - - - - - Contains the processing logic for a synchronous request invocation. - This method calls InnerHandler.InvokeSync to continue processing of the - request by the pipeline. - - The execution context which contains both the - requests and response context. - - - - Contains the processing logic for an asynchronous request invocation. - This method should calls InnerHandler.InvokeSync to continue processing of the - request by the pipeline. - - The execution context which contains both the - requests and response context. - IAsyncResult which represent an async operation. - - - - This callback method is called by the callback method of the inner handler - as part of asynchronous processing after any underlying asynchronous - operations complete. - - The execution context, it contains the - request and response context. - - - - This callback method contains the processing logic that should be executed - after the underlying asynchronous operation completes. - This method is called as part of a callback chain which starts - from the InvokeAsyncCallback method of the bottommost handler and then invokes - each callback method of the handler above it. - This method calls OuterHandler.AsyncCallback to continue processing of the - request by the pipeline, unless it's the topmost handler. - - The execution context, it contains the - request and response context. - - - - Logs the metrics for the current execution context. - - The execution context, it contains the - request and response context. - - - - The default implementation of the adaptive retry policy. - - - - - Constructor for AdaptiveRetryPolicy. - - The maximum number of retries before throwing - back a exception. This does not count the initial request. - - - - Constructor for AdaptiveRetryPolicy. - - The Client config object. This is used to - retrieve the maximum number of retries before throwing - back a exception(This does not count the initial request) and - the service URL for the request. - - - - OnRetry is called when a retry request is initiated to determine if the request will be retried. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - true if the error that will be retried is a throtting error - True if retry throttling is disabled or retry throttling is enabled and capacity can be obtained. - - - - This method uses a token bucket to enforce the maximum sending rate. - - The execution context which contains both the - requests and response context. - If the prior request failed, this exception is expected to be - the exception that occurred during the prior request failure. - - - - Virtual method that gets called on a success Response. If its a retry success response, the entire - retry acquired capacity is released(default is 5). If its just a success response a lesser value capacity - is released(default is 1). - - Request context containing the state of the request. - - - - The default implementation of the legacy retry policy. - - - - - The maximum value of exponential backoff in milliseconds, which will be used to wait - before retrying a request. The default is 30000 milliseconds. - - - - - Constructor for DefaultRetryPolicy. - - The maximum number of retries before throwing - back a exception. This does not count the initial request. - - - - Constructor for DefaultRetryPolicy. - - The Client config object. This is used to - retrieve the maximum number of retries before throwing - back a exception(This does not count the initial request) and - the service URL for the request. - - - - Returns true if the request is in a state where it can be retried, else false. - - Request context containing the state of the request. - Returns true if the request is in a state where it can be retried, else false. - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - true if the error that will be retried is a throtting error - - - - Virtual method that gets called on a success Response. If its a retry success response, the entire - retry acquired capacity is released(default is 5). If its just a success response a lesser value capacity - is released(default is 1). - - Request context containing the state of the request. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Request context containing the state of the request. - Return true if the request should be retried. - - - - Checks if the retry limit is reached. - - Request context containing the state of the request. - Return false if the request can be retried, based on number of retries. - - - - Waits before retrying a request. The default policy implements a exponential backoff. - - Request context containing the state of the request. - - - - Waits for an amount of time using an exponential backoff algorithm. - - The request retry index. The first request is expected to be 0 while - the first retry will be 1. - The max number of milliseconds to wait - - - - The retry handler has the generic logic for retrying requests. - It uses a retry policy which specifies when - a retry should be performed. - - - - - The logger used to log messages. - - - - - The retry policy which specifies when - a retry should be performed. - - - - - Constructor which takes in a retry policy. - - Retry Policy - - - - Invokes the inner handler and performs a retry, if required as per the - retry policy. - - The execution context which contains both the - requests and response context. - - - - Invokes the inner handler and performs a retry, if required as per the - retry policy. - - The execution context which contains both the - requests and response context. - - - - Prepares the request for retry. - - Request context containing the state of the request. - - - - The default implementation of the standard retry policy. - - - - - The maximum value of exponential backoff in milliseconds, which will be used to wait - before retrying a request. The default is 20000 milliseconds. - - - - - Constructor for StandardRetryPolicy. - - The maximum number of retries before throwing - back a exception. This does not count the initial request. - - - - Constructor for StandardRetryPolicy. - - The Client config object. This is used to - retrieve the maximum number of retries before throwing - back a exception(This does not count the initial request) and - the service URL for the request. - - - - Returns true if the request is in a state where it can be retried, else false. - - Request context containing the state of the request. - Returns true if the request is in a state where it can be retried, else false. - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - true if the error that will be retried is a throtting error - - - - Virtual method that gets called on a success Response. If its a retry success response, the entire - retry acquired capacity is released(default is 5). If its just a success response a lesser value capacity - is released(default is 1). - - Request context containing the state of the request. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Request context containing the state of the request. - Return true if the request should be retried. - - - - Checks if the retry limit is reached. - - Request context containing the state of the request. - Return false if the request can be retried, based on number of retries. - - - - Waits before retrying a request. The default policy implements a exponential backoff with - jitter algorithm. - - Request context containing the state of the request. - - - - Waits for an amount of time using an exponential backoff with jitter algorithm. - - The request retry index. The first request is expected to be 0 while - the first retry will be 1. - The max number of milliseconds to wait - - - - A runtime pipeline contains a collection of handlers which represent - different stages of request and response processing. - - - - - The top-most handler in the pipeline. - - - - - Constructor for RuntimePipeline. - - The handler with which the pipeline is initalized. - - - - Constructor for RuntimePipeline. - - List of handlers with which the pipeline is initalized. - - - - Constructor for RuntimePipeline. - - List of handlers with which the pipeline is initalized. - The logger used to log messages. - - - - Constructor for RuntimePipeline. - - The handler with which the pipeline is initalized. - The logger used to log messages. - - - - Invokes the pipeline synchronously. - - Request context - Response context - - - - Invokes the pipeline asynchronously. - - Request context - IAsyncResult which represents the in progress asynchronous operation. - - - - Adds a new handler to the top of the pipeline. - - The handler to be added to the pipeline. - - - - Adds a handler after the first instance of handler of type T. - - Type of the handler after which the given handler instance is added. - The handler to be added to the pipeline. - - - - Adds a handler before the first instance of handler of type T. - - Type of the handler before which the given handler instance is added. - The handler to be added to the pipeline. - - - - Removes the first occurance of a handler of type T. - - Type of the handler which will be removed. - - - - Replaces the first occurance of a handler of type T with the given handler. - - Type of the handler which will be replaced. - The handler to be added to the pipeline. - - - - Inserts the given handler after current handler in the pipeline. - - Handler to be inserted in the pipeline. - Handler after which the given handler is inserted. - - - - Gets the innermost handler by traversing the inner handler till - it reaches the last one. - - - - - Retrieves a list of handlers, in the order of their execution. - - Handlers in the current pipeline. - - - - Retrieves current handlers, in the order of their execution. - - Handlers in the current pipeline. - - - - The CSM handler has the logic for capturing data for CSM attempts when enabled. - - - - - Invokes the CSM handler and captures data for the CSM attempts. - - - - - Invokes the CSM handler and captures data for the CSM attempts. - - - - - Method that gets called in the final clause that captures data for each http request - from the request and response context. - - - - - Executes the OnPreInvoke action as part of pre-invoke. - - - - - Method to collect data in case of connection exception - - - - - Method to collect data in case of Amazon service exception - - - - - The CSM handler has the logic for capturing data for CSM events when enabled. - - - - - Invokes the CSM handler and captures data for the CSM events. - - - - - Invokes the CSM handler and captures data for the CSM events. - - - - - Invoked from the finally block of CSMCallEventHandler's Invoke method. - This method is used to capture CSM Call event metrics. - - - - - - Method that gets invoked in case of an exception in the API request completion. - - - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - This class is responsible for managing adaptive retry mode client rate limiting. - - - - - The rate at which token are replenished. - - - - - The maximum capacity allowed in the token - - - - - The current capacity of the token - - - - - The last time the token bucket was refilled. - - - - - The smoothed rate which tokens are being retrieved. - - - - - The last half second time bucket used. - - - - - The number of requests seen within the current time - - - - - The maximum rate when the client was last throttled. - - - - - The last time when the client was throttled. - - - - - The cached time window calculation - - - - - Boolean indicating if the token bucket is enabled. - - - - - This method attempts to acquire capacity from the client's token - - The amount of capacity to obtain from the token bucket - Indicates that the client should or shouldn't sleep and - try again if capacity cannot be obtained. - - - - - Updates the sending rate within the client's token bucket - - Indicates if the request resulted in a throttling error. - - - - Calculates the rate - - - Returns the calculated rate for a successful call - - - - Calculates the rate. - - The rate to use in the calculation - Returns the calculated rate for a throttled call - - - - This class gets the CSM configuration if set. - The priority goes - 1. App.config / instantiate on the AWSConfigs class - 2. Environment variable - 3. Shared Profile - - - - - Determine CSM configs from shared profile file. - - - - - Determine CSM configs from environment variables. - - - - - Determine CSM configs from AWSConfigs class. - - - - - Utility class for CSM. - Contains logic to serialize CSM events to Json. - - - - - Method to retrieve the API name from the request name. - - - - - Method to serialize MonitoringAPICallAttempt CSM event to json. - - - - - Method to serialize MonitoringAPICallEvent CSM event to json. - - - - - Method to serialize MonitoringAPICall CSM event to json. - - - - - Internal class that has the CSM configurations for the Monitoring Listener - after being derived from the CSMConfigChain class. - - - - - CSM event base class - - - - - Contains the operation name for the api call being made - - - - - Contains the service id ServiceId Sep of the service - against which the call is being made - - - - - Contains the "ClientId" configuration value - computed from the CSMConfigChain class - - - - - Contains the elapsed time, in milliseconds, - since January 1st, 1970, for the time point - at which the event occurred - - - - - Contains "ApiCall" or "ApiCallAttempt" - based on what the monitoring event is describing - - - - - Contains the enum of the above CSM type property - - - - - Contains the "Version" configuration value - computed from the CSMConfigChain class - Defaults to 1. - - - - - Contains the signing region used by the - service client that made the request attempt. - - - - - Contains the full value of the SDK's default - user agent header for http requests. - - - - - Class that captures the CSM Api Call Attempt Monitoring Events - for each http request and its subsequent response. - - - - - Contains the fully-qualified domain name of the endpoint that - the request attempt was submitted to. - - - - - Contains the session token passed - in the x-amz-security-token header. - - - - - Contains the aws_access_key value that - was used to sign the http request. - - - - - Contains the attempt's response status code, - as returned by the http client. - - - - - Contains the full text (exception object converted to String, - for example) for any attempt-level failure that is due to - something other than an Aws exception. The value of this entry - has a maximum length of 512. - - - - - Contains the short error name (exception class name, for example) - for any attempt-level failure that is due to something other - than an Aws exception.The value of this entry has a maximum length of 128. - - - - - Contains the Aws exception code returned in the response. - - - - - Contains the full text of the Aws exception message. - - - - - Contains the value of the response's x-amzn-RequestId header. - - - - - Contains the value of the response's x-amz-request-id header. - - - - - Contains the value of the response's x-amz-id-2 header. - - - - - Contains the elapsed time, in milliseconds, - between the construction of the http request and the - point in time where the http response has been parsed - or the attempt has definitively failed. - - - - - Class that captures the CSM Api Call Monitoring Events - for the entire SDK call. This is processed once. - - - - - Contains the total number of attempts that were made - by the service client to fulfill this request before succeeding or failing - - - - - Contains the elapsed time, in milliseconds, - between when the Api Call was begun and when a - final response or error is manifested to the caller - - - - - a boolean (0/1) value that is 0 unless the Api call failed - and the final attempt returned a retryable error.This entry should be - serialized as a numeric 0/1 value. This is mapped to MaxRetriesExceeded - when serialized to a UDP datagram. - - - - - Contains the full text (exception object - converted to String, for example) for an attempt-level failure that is due to - something other than an Aws exception that occurred on the last attempt to - fulfill the Api call.The value of this entry has a maximum length of 512. - - - - - Contains the short error name (exception - class name, for example) for a failure that is due to something other than an - Aws exception that occurred on the last attempt to fulfill an Api call.See - the SdkException entry for more details.The value of this entry has a - maximum length of 128. - - - - - Contains the Aws exception code - returned in the response to the final attempt at fulfilling this API call. - The value of this entry has a maximum length of 128. - - - - - - Contains the attempt's response status code, - as returned by the http client. - - - - - Provides information for Client Context header. - Client Context header needs information like App title, version code, version name, package name etc. - - - - - The title of your app. For example, "My App". - If this property is not null, the value would be used in Client Context header. - - - - - The version for your app. For example, V3.0. - If this property is not null, the value would be used in Client Context header. - - - - - The version code of your app. For example, 3.0. - If this property is not null, the value would be used in Client Context header. - - - - - The name of your app package. For example, com.your_company.your_app. - If this property is not null, the value would be used in Client Context header. - - - - - The operating system of the device. For example, iPhoneOS. - If this property is not null, the value would be used in Client Context header. - - - - - The version of the operating system of the device. For example, 8.1. - If this property is not null, the value would be used in Client Context header. - - - - - The locale of the device. For example, en_US. - If this property is not null, the value would be used in Client Context header. - - - - - The manufacturer of the device. For example, Samsung. - If this property is not null, the value would be used in Client Context header. - - - - - The model of the device. For example, Nexus. - If this property is not null, the value would be used in Client Context header. - - - - - This class is the base class of all the configurations settings to connect - to a service. - - - This class is the base class of all the configurations settings to connect - to a service. - - - - - Gets Service Version - - - - - Gets and sets of the signatureMethod property. - - - - - Gets and sets of the SignatureVersion property. - - Note: This property exists for backward compatibility but is no longer - used by any service other than S3. - - - - - Gets and sets of the UserAgent property. - - - - - When set to true, the service client will use the x-amz-user-agent - header instead of the User-Agent header to report version and - environment information to the AWS service. - - Note: This is especially useful when using a platform like WebAssembly - which doesn't allow to specify the User-Agent header. - - - - - Gets and sets the RegionEndpoint property. The region constant that - determines the endpoint to use. - - Setting this property to null will force the SDK to recalculate the - RegionEndpoint value based on App/WebConfig, environment variables, - profile, etc. - - - - - The constant used to lookup in the region hash the endpoint. - - - - - Gets and sets of the ServiceURL property. - This is an optional property; change it - only if you want to try a different service - endpoint. - - - - - Gets and sets the UseHttp. - If this property is set to true, the client attempts - to use HTTP protocol, if the target endpoint supports it. - By default, this property is set to false. - - - - - Given this client configuration, return a string form ofthe service endpoint url. - - - - - Gets and sets the AuthenticationRegion property. - Used in AWS4 request signing, this is an optional property; - change it only if the region cannot be determined from the - service endpoint. - - - - - Gets and sets the AuthenticationServiceName property. - Used in AWS4 request signing, this is the short-form - name of the service being called. - - - - - Returns the flag indicating how many retry HTTP requests an SDK should - make for a single SDK operation invocation before giving up. This flag will - return 4 when the RetryMode is set to "Legacy" which is the default. For - RetryMode values of "Standard" or "Adaptive" this flag will return 2. In - addition to the values returned that are dependant on the RetryMode, the - value can be set to a specific value by using the AWS_MAX_ATTEMPTS environment - variable, max_attempts in the shared configuration file, or by setting a - value directly on this property. When using AWS_MAX_ATTEMPTS or max_attempts - the value returned from this property will be one less than the value entered - because this flag is the number of retry requests, not total requests. To - learn more about the RetryMode property that affects the values returned by - this flag, see . - - - - - Determines if MaxErrorRetry has been manually set. - - - - - Gets and sets the LogResponse property. - If this property is set to true, the service response is logged. - The size of response being logged is controlled by the AWSConfigs.LoggingConfig.LogResponsesSizeLimit property. - - - - - Gets and sets the ReadEntireResponse property. - NOTE: This property does not effect response processing and is deprecated. - To enable response logging, the ClientConfig.LogResponse and AWSConfigs.LoggingConfig - properties can be used. - - - - - Gets and Sets the BufferSize property. - The BufferSize controls the buffer used to read in from input streams and write - out to the request. - - - - - - Gets or sets the interval at which progress update events are raised - for upload operations. By default, the progress update events are - raised at every 100KB of data transferred. - - - If the value of this property is set less than ClientConfig.BufferSize, - progress updates events will be raised at the interval specified by ClientConfig.BufferSize. - - - - - - Flag on whether to resign requests on retry or not. - For Amazon S3 and Amazon Glacier this value will always be set to true. - - - - - This flag controls if .NET HTTP infrastructure should follow redirection - responses (e.g. HTTP 307 - temporary redirect). - - - - - Flag on whether to log metrics for service calls. - - This can be set in the application's configs, as below: - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSLogMetrics" value"true"/> - </appSettings> - </configuration> - - - - - - Gets and sets the DisableLogging. If true logging for this client will be disabled. - - - - - Credentials to use with a proxy. - - - - - Specifies the TCP keep-alive values to use for service requests. - - - - - - If the value is set, the value is assigned to the Timeout property of the HttpWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Configures the endpoint calculation for a service to go to a dual stack (ipv6 enabled) endpoint - for the configured region. - - - Note: AWS services are enabling dualstack endpoints over time. It is your responsibility to check - that the service actually supports a dualstack endpoint in the configured region before enabling - this option for a service. - - - - - Enable or disable the Retry Throttling feature by setting the ThrottleRetries flag to True/False resepctively. - Retry Throttling is a feature that intelligently throttles retry attempts when a large precentage of requests - are failing and retries are unsuccessful as well. In such situations the allotted retry capacity for the service URL - will be drained until requests start to succeed again. Once the requisite capacity is available, retries would - be permitted again. When retries are throttled, the service enters a fail-fast behaviour as the traditional retry attempt - for the request would be circumvented. Hence, errors will resurface quickly. This will result in a greated number of exceptions - but prevents requests being tied up in unsuccessful retry attempts. - Note: Retry Throttling is enabled by default. Set the ThrottleRetries flag to false to switch off this feature. - - - - - Enable or disable the Nagle algorithm on the underlying http - client. - - This method is not intended to be called by consumers of the AWS SDK for .NET - - - - - - Performs validation on this config object. - Throws exception if any of the required values are missing/invalid. - - - - - Returns the current UTC now after clock correction for this endpoint. - - - - - The calculated clock skew correction for a specific endpoint, if there is one. - This field will be set if a service call resulted in an exception - and the SDK has determined that there is a difference between local - and server times. - - If is set to true, this - value will still be set to the correction, but it will not be used by the - SDK and clock skew errors will not be retried. - - - - - Gets and sets the DisableHostPrefixInjection flag. If true, host prefix injection will be disabled for this client, the default value of this flag is false. - Host prefix injection prefixes the service endpoint with request members from APIs which use this feature. - Example: for a hostPrefix of "foo-name." and a endpoint of "service.region.amazonaws.com" the default behavior is to - prefix the endpoint with the hostPrefix resulting in a final endpoint of "foo-name.service.region.amazonaws.com". Setting - DisableHostPrefixInjection to true will disable hostPrefix injection resulting in a final endpoint of - "service.region.amazonaws.com" regardless of the value of hostPrefix. E.g. You may want to disable host prefix injection for testing against a local mock endpoint. - - - - - Returns the flag indicating if endpoint discovery should be enabled or disabled for operations that are not required to use endpoint discovery. - - - - - Returns the maximum number of discovered endpoints that can be stored within the cache for the client. The default limit is 1000 cache entries. - - - - - Returns the flag indicating the current mode in use for request - retries and influences the value returned from . - The default value is RequestRetryMode.Legacy. This flag can be configured - by using the AWS_RETRY_MODE environment variable, retry_mode in the - shared configuration file, or by setting this value directly. - - - - - Under Adaptive retry mode, this flag determines if the client should wait for - a send token to become available or don't block and fail the request immediately - if a send token is not available. - - - - - Throw an exception if the boxed TimeSpan parameter doesn't have a value or is out of range. - - - - - Returns the request timeout value if its value is set, - else returns client timeout value. - - - - - Overrides the default read-write timeout value. - On Unity platform, this value is not used as Unity HTTP client does not support timeouts, so - - - - If the value is set, the value is assigned to the ReadWriteTimeout property of the HttpWebRequest object used - to send requests. - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Gets and sets of the ProxyHost property. - - - - - Gets and sets the ProxyPort property. - - - - - Gets and sets the ProxyBypassList property; a collection - of regular expressions denoting the set of endpoints for - which the configured proxy host will be bypassed. - - - For more information on bypass lists - see https://msdn.microsoft.com/en-us/library/system.net.webproxy.bypasslist%28v=vs.110%29.aspx. - - - - - Gets and sets the ProxyBypassOnLocal property. - If set true requests to local addresses bypass the configured - proxy. - - - - - Returns a WebProxy instance configured to match the proxy settings - in the client configuration. - - - - - Unpacks the host, port and any credentials info into the instance's - proxy-related fields. - - The proxy details - - - - Gets and sets the max idle time set on the ServicePoint for the WebRequest. - Default value is 50 seconds (50,000 ms) unless ServicePointManager.MaxServicePointIdleTime is set, - in which case ServicePointManager.MaxServicePointIdleTime will be used as the default. - - - - - Gets and sets the connection limit set on the ServicePoint for the WebRequest. - Default value is 50 connections unless ServicePointManager.DefaultConnectionLimit is set in - which case ServicePointManager.DefaultConnectionLimit will be used as the default. - - - - - Gets or sets a Boolean value that determines whether the Nagle algorithm is used on connections managed by the ServicePoint object used - for requests to AWS. This is defaulted to false for lower latency with responses that return small amount of data. This is the opposite - default than ServicePoint.UseNagleAlgorithm which is optimized for large responses like web pages or images. - - - - - Base class for constant class that holds the value that will be sent to AWS for the static constants. - - - - - Gets the value that needs to be used when send the value to AWS - - - - - Attempt to find correct-cased constant value using whatever cased value the user - has provided. This is primarily useful for mapping any-cased values from a CLI - tool to the specific casing required by the service, avoiding the need for the - user to (a) remember the specific case and (b) actually type it correctly. - - The properly cased service constant matching the value - - - - Utility class that stores clock skew information. - - - - - GlobalClockCorrection should be only set by AWSConfigs.ManualClockCorrection property - and is only available to maintain backward compatibilty. This should override any - endpoint specific clockskew correction. - - - - - Return clock skew correction value for an endpoint if there is one. - - AWSConfigs.ManualClockCorrection overrides globally any calculated service endpoint specific - clock correction value. - - Endpoint should in a form such as "https://s3" - Clock correction value for an endpoint in TimeSpan. TimeSpan.Zero if no such clock correction is set. - - - - Get clock skew corrected UTC now value. If ManualClockCorrection is set, - use ManualClockCorrection instead of endpoint specific clock correction value. - - - - - - - Class to easily convert from Dictionary<string, string> to ProfileOptions and back. - - - - - Separate the profileDictionary into its parts. - profileDictionary = profileOptions + reservedProperties + userProperties - - Dictionary with everything in it - Keys to ignore - The resulting CredentialProfileOptions - The properties that are left - - - - Separate the profileDictionary into its parts. - profileDictionary = profileOptions + reservedProperties + userProperties - - Dictionary with everything in it - Keys for the reservedKeys dictionary - The resulting CredentialProfileOptions - The resulting reserved properties - The properties that are left - - - - Validate the userProperties and then combine profileOptions, reservedProperties, and userProperties into one Dictionary. - - - - - - - - - - Make sure the userProperties dictionary doesn't contain any keys that are reserved. - Check is case-insensitive for added safety. - - - - - - - Make sure the userProperties dictionary doesn't contain any keys that - overlap with the names of mapped names for CredentialProfileOptions property names. - Check is case-insensitive for added safety. - - - - - - This class is used internally and should not be accessed by SDK users. - - Provide access to internal properties of CredentialProfile to - PowerShell tools and the Visual Studio Toolkit. - - - - - Attempt to read a role session with the given name. - If the session is invalid or expired it will not be returned. - - The name of the role session to get. - The credentials for the session, if found. - True if the session was found, false otherwise. - - - - Factory to construct different types of AWSCredentials based on a profile. - - - - - Gets the AWSCredentials for this profile if CanCreateAWSCredentials is true - and AWSCredentials can be created. Throws an exception otherwise. - - See for a list of AWSCredentials returned by this method. - - The profile to get AWSCredentials for. - The profile source, for profiles that reference other profiles. - AWSCredentials for this profile. - - - - Gets the AWSCredentials for this profile if CanCreateAWSCredentials is true - and AWSCredentials can be created. Throws an exception otherwise. - - See for a list of AWSCredentials returned by this method. - - The options to get AWSCredentials for. - The profile source, for options that reference other profiles. - AWSCredentials for the options given. - - - - Gets the AWSCredentials for this profile if CanCreateAWSCredentials is true - and AWSCredentials can be created. Throws an exception otherwise. - - See for a list of AWSCredentials returned by this method. - - The profile to get AWSCredentials for. - The profile source, for profiles that reference other profiles. - If true, throw a descriptive exception for any credentials that would not operate as-is. - In other words, any credentials that require programmatic callbacks at runtime. - AWSCredentials for this profile. - - - - Gets the AWSCredentials for this profile if CanCreateAWSCredentials is true - and AWSCredentials can be created. Throws an exception otherwise. - - See for a list of AWSCredentials returned by this method. - - The options to get AWSCredentials for. - The profile source, for options that reference other profiles. - If true, throw a descriptive exception for any credentials that would not operate as-is. - In other words, any credentials that require programmatic callbacks at runtime. - AWSCredentials for the options given. - - - - Return the credentials for the profile if valid credentials can created. - - The profile to create credentials with. - The profile source, for profiles that reference other profiles. - The credentials for the profile. - True if credentials can be created from the profile, false otherwise. - - - - Return the credentials for the profile if valid credentials can created. - - The options to get AWSCredentials for. - The profile source, for profiles that reference other profiles. - The credentials for the profile. - True if credentials can be created from the profile, false otherwise. - - - - Determine if the profileType will generate AWSCredentials that require a callback to be set on them. - - - - - - - A named group of options that are persisted and used to obtain AWSCredentials. - - - - - The name of the CredentialProfile - - - - - The options to be used to create AWSCredentials. - - - - - The region to be used with this CredentialProfile - - - - - The unique key for this CredentialProfile. - This key is used by the Visual Studio Tooklit to associate external artifacts with this profile. - - - - - The endpoint discovery enabled value for this CredentialProfile - - - - - If true the region identified in the S3 access point arn will be used when making requests. - - - - - The Sts Regional Endpoints Value as either legacy or regional - - - - - The S3 Regional Endpoint Value as either legacy or regional - - - - - The request retry mode as legacy, standard, or adaptive - - - - - Specified how many HTTP requests an SDK should make for a single - SDK operation invocation before giving up. - - - - - An optional dictionary of name-value pairs stored with the CredentialProfile - - - - - True if the properties of the Options object can be converted into AWSCredentials, false otherwise. - See for more details about which options are available. - - - - - The that this is associated with. - Null if this is not associated with a . - - - - - If CanCreateAWSCredentials is true, returns a short description of the type of - credentials that would be created. - If CanCreateAWSCredentials is false, return null. - - - - - The CredentialProfileType of this CredentialProfile, if one applies. - - - - - Determine this CredentialProfile will generate AWSCredentials that require a callback to be set on them. - - - - - Construct a new CredentialProfile. - - - - - - - Gets the AWSCredentials for this profile if CanCreateAWSCredentials is true - and AWSCredentials can be created. Throws an exception otherwise. - - See for a list of AWSCredentials returned by this method. - - The profile source, for profiles that reference other profiles. - AWSCredentials for this profile. - - - - Gets the AWSCredentials for this profile if CanCreateAWSCredentials is true - and AWSCredentials can be created. Throws an exception otherwise. - - See for a list of AWSCredentials returned by this method. - - The profile source, for profiles that reference other profiles. - If true, throw a descriptive exception for any credentials that would not operate as-is. - In other words, any credentials that require programmatic callbacks at runtime. - AWSCredentials for this profile. - - - - The options that are available for creating AWSCredentials with the AWSCredentialsFactory. - The type of AWSCredentials that are created depends on which Options are set. - - Below are the different types of credentials returned, along with the options that are used to obtain them. - ([] denotes options that are not required) - - BasicAWSCredentials AccessKey SecretKey - SessionAWSCredentials AccessKey SecretKey Token - AssmeRoleAWSCredentials SourceProfile RoleArn [ExternalID] [MfaSerial] - FederatedAWSCredentials EndpointName RoleArn [UserIdentity] - - - - - The access key to be used in the AWSCredentials. - - - - - The source of credentials to be used to obtain AWSCredentials. - - - - - The endpoint name to be used for federated AWSCredentials. - - - - - The external id to use in assume role AWSCredentials. - - - - - The serial number of the MFA to use in assume role AWSCredentials. - - - - The role ARN to use when creating assume role or federated AWSCredentials. - - - - An identifier for the assumed role session. - - - - - The secret key to use when creating AWSCredentials. - - - - - When this CredentialProfileOptions object references another CredentialProfile, - the name of the referenced CredentialProfile. - - - - - The session token to be used to create AWSCredentials. - - - - - The user identity to use when creating federated AWSCredentials. - If not set, the user identity that the code is running under will be used. - - - - - Contains the executable information to be used by the process credential retriever - to either fetch Basic or Session credentials - - - - - Absolute path to the file on disk containing an OIDC token. - - - - - Return true the properties are all null or empty, false otherwise. - - - - - Class to abstract the combined use of NetSDKCredentialsFile and SharedCredentialsFile where possible. - - - - - - The location of the shared credentials file, or null to use the default location. - - - - - Construct a CredentialProfileChain. - - - - - Construct a CredentialProfileChain. - - The path to the aws credentials file to look at. - - - - - Try to get from a profile. - - - If ProfilesLocation is non-null and non-empty search the shared credentials - file at the disk path in the ProfilesLocation property. - - - If ProfilesLocation is null or empty and the platform supports the .NET SDK credentials file - search the SDK credentials file. If the profile is not found search the shared credentials file in the default location. - - - If ProfilesLocation is null or empty and the platform doesn't support the .NET SDK credentials file - search the shared credentials file in the default location. - - - The name of the profile to get credentials from. - The credentials, if the profile is found and credentials can be created. - True if the profile was found and credentials could be created, false otherwise. - - - - - Try to get a - - - If ProfilesLocation is non-null and non-empty search the shared credentials - file at the disk path in the ProfilesLocation property. - - - If ProfilesLocation is null or empty and the platform supports the .NET SDK credentials file - search the SDK credentials file. If the profile is not found search the shared credentials file in the default location. - - - If ProfilesLocation is null or empty and the platform doesn't support the .NET SDK credentials file - search the shared credentials file in the default location. - - - The name of the profile to get. - The profile, if found - True if the profile was found, false otherwise. - - - - - Get a list of available objects. - - - If ProfilesLocation is non-null and non-empty include profiles in the shared credentials - file at the disk path in the ProfilesLocation property. - - - If ProfilesLocation is null or empty and the platform supports the .NET SDK credentials file - include profiles from the SDK credentials file and from the shared credentials file in the default location. - - - If ProfilesLocation is null or empty and the platform doesn't support the .NET SDK credentials file - include profiles from the shared credentials file in the default location. - - - A list of objects. - - - - - Register a - - - If ProfilesLocation is non-null and non-empty register the profile in the shared credentials - file at the disk path in the ProfilesLocation property. - - - If ProfilesLocation is null or empty and the platform supports the .NET SDK credentials file - register the profile in the SDK credentials file. - - - If ProfilesLocation is null or empty and the platform doesn't support the .NET SDK credentials file - register the profile in the shared credentials file in the default location. - - - The profile to register. - - - - - Unregister a - - - If ProfilesLocation is non-null and non-empty unregister the profile from the shared credentials - file at the disk path in the ProfilesLocation property. - - - If ProfilesLocation is null or empty and the platform supports the .NET SDK credentials file - search the SDK credentials file. If the profile is found there unregister it. - If the profile was not found search the shared credentials file in the default location. - If the profile is found in the shared credentials file in the default location unregister it. - - - If ProfilesLocation is null or empty and the platform doesn't support the .NET SDK credentials file - search the shared credentials file in the default location. If the profile is found in the - shared credentials file in the default location unregister it. - - - The name of the profile to unregister. - - - - Interface to define the necessary operations for a CredentialProfile lookup mechanism. - - - - - Get the profile with the given name, if one exists. - - The name of the profile to get. - The profile, if it was found, null otherwise. - True if the profile was found, false otherwise. - - - - Interface to define the necessary operations for a CredentialProfile storage mechanism. - - - - - Rename the profile with oldProfileName to newProfileName. - - The profile to rename. - The new name for the profile. - - - - Rename the profile with oldProfileName to newProfileName. - - The profile to rename. - The new name for the profile. - If true and the destination profile exists it will be overwritten. - - - - Make a copy of the profile with fromProfileName called toProfileName. - - The name of the profile to copy from. - The name of the new profile. - - - - Make a copy of the profile with fromProfileName called toProfileName. - - The name of the profile to copy from. - The name of the new profile. - If true and the destination profile exists it will be overwritten. - - - - Add the given profile to the store, or update it if one with the same name already exists. - - - - - - Delete the profile with profileName if it exists. - - The name of the profile to delete. - - - - Get a list of valid profile names from this store. - Invalid profiles are ignored. - See for more information - about valid profiles. - - - - - - Get a list of valid profiles from this store. - Invalid profiles are ignored. - See for more information - about valid profiles. - - - - - - This class allows profiles supporting AWSCredentials to be registered with - the SDK so that they can later be reference by a profile name. The credential profiles will be available - for use in the AWS Toolkit for Visual Studio and the AWS Tools for Windows PowerShell. - - The credentials are stored under the current users AppData folder encrypted using Windows Data Protection API. - - - This class is not threadsafe. - - - - - - Get the profile with the name given, if it exists in this store. - - The name of the profile to find. - The profile, if it was found, null otherwise - True if the profile was found, false otherwise. - - - - Add the profile to this store, if it's valid. - - The profile to add. - - - - If there is a profile in the store with the given name, delete it. - - The name of the profile to delete. - - - - Rename the profile with oldProfileName to newProfileName. - - The profile to rename. - The new name for the profile. - - - - Rename the profile with oldProfileName to newProfileName. - - The profile to rename. - The new name for the profile. - If true and the destination profile exists it will be overwritten. - - - - Make a copy of the profile with fromProfileName called toProfileName. - - The name of the profile to copy from. - The name of the new profile. - - - - Make a copy of the profile with fromProfileName called toProfileName. - - The name of the profile to copy from. - The name of the new profile. - If true and the destination profile exists it will be overwritten. - - - - Set the ProfileType field to maintain backward compatibility with ProfileManager. - The value is ignored when it's read back in. - - - - - - - Represents the different types of authentication available for SAML endpoints. - - - - - Representation of a SAML Endpoint. - - - - - The name given to this SAMLEndpoint. - - - - - The URI of the SAML endnpoint. - - - - - The authentication type associated with the SAML endpoint. - - - - - Internal constructor. Used by SAMLEndpointManager when reading endpoints from the encrypted store. - - - - - - - - Construct a SAMLEndpoint using the default SAMLAuthenticationType - Kerberos. - - The name of the endpoint. - The URI of the endpoint. - - - - Construct a SAMLEndpoint. - - The name of the endpoint. - The URI of the endpoint. - The authentication type of the endpoint. - - - - Manages endpoints to be used in conjunction with SAML role profiles. The role profiles - reference the endpoint to obtain the actual endpoint and any customization settings - needed to perform authentication. - - - - - Construct a SAMLEndpointManager. - - - - - True if the SAMLEndpointManager is available on the current platform, false otherwise. - - - - - Register an endpoint, or update an existing one. - - The endpoint to register. - - - - Get an endpoint, if it exists and is valid. - - The name of the endpoint to get. - The endpoint, or null if it's invalid or doesn't exist. - True if the endpoint exists and is valid, false otherwise. - - - - Get an endpoint from the store. - Throws an exception if there's an error reading the endpoint, or if it doesn't exist. - - The name of the endpoint to get. - The endpoint with the given name. - - - - Delete an endpoint from the store, if it exists. - - The name of the endpoint to delete. - - - - List the names of valid endpoints in the store. - - - - - - List valid endopints that can be read from the store. - - - - - - Provides access to read and write to the shared credentials INI file. - The file is read, parsed, and validated at construction time. - Changes can be made using the RegisterProfile() and - UnregisterProfile() methods. - - This class is not threadsafe. - - - - - To maintain compatibility with the CLI, - SharedCredentialsFile doesn't support the SAML profileTypes. - - - - - Construct a new SharedCredentialsFile in the default location. - - - - - Construct a new SharedCredentialsFile. - - The path of the shared credentials file. - - - - Add the profile given. If the profile already exists, update it. - - The profile to be written. - - - - Update the profile on disk regardless of the profile type. - - - - - - Deletes the section with the given ProfileName from the SharedCredentialsFile, if one exists. - - The ProfileName of the section to delete. - - - - Rename the profile with oldProfileName to newProfileName. - - The profile to rename. - The new name for the profile. - - - - Rename the profile with oldProfileName to newProfileName. - - The profile to rename. - The new name for the profile. - If true and the destination profile exists it will be overwritten. - - - - Make a copy of the profile with fromProfileName called toProfileName. - - The name of the profile to copy from. - The name of the new profile. - - - - Make a copy of the profile with fromProfileName called toProfileName. - - The name of the profile to copy from. - The name of the new profile. - If true and the destination profile exists it will be overwritten. - - - - Try to get a profile that may be partially in the credentials file and partially in the config file. - If there are identically named properties in both files, the properties in the credentials file take precedence. - - - - - - - - Anonymous credentials. - Using these credentials, the client does not sign the request. - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - AWS Credentials that automatically refresh by calling AssumeRole on - the Amazon Security Token Service. - - - - - The credentials of the user that will be used to call AssumeRole. - - - - - The Amazon Resource Name (ARN) of the role to assume. - - - - - An identifier for the assumed role session. - - - - - Options to be used in the call to AssumeRole. - - - - - Constructs an AssumeRoleAWSCredentials object. - - The credentials of the user that will be used to call AssumeRole. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - - - - Constructs an AssumeRoleAWSCredentials object. - - The credentials of the user that will be used to call AssumeRole. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRole. - - - - A unique identifier that is used by third parties when assuming roles in their customers' accounts. - - - - - An IAM policy in JSON format. - - - - - The length of time in seconds before the credentials will expire. - - - - - The proxy settings to use when calling AssumeRole. - - - - - The identification number of the MFA device that is associated with the user who is making the assume-role call. - - - - - The value provided by the MFA device, if the trust policy of the role being assumed requires MFA. - - - - - A callback that's used to obtain the MFA token code when the AssumeRoleAWSCredentials are refreshed. - - - - - Immutable representation of AWS credentials obtained as a result of - authenticating with the AssumeRole method of the Security Token Service. - - - - - The expiry time of the credentials, obtained from the AssumeRoleResponse. - - - - - Constructs an instance with supplied keys, token, and expiration. - - The AccessKey for the credentials. - The SecretKey for the credentials. - The security token for the credentials. - The expiration time for the credentials. - - - - Get a copy of this AssumeRoleImmutableCredentials object. - - A copy of this object. - - - - Abstract class that represents a credentials object for AWS services. - - - - - Returns a copy of ImmutableCredentials - - - - - - Called by AmazonServiceClient to validate the credential state - on client construction. - - - - - Basic set of credentials consisting of an AccessKey and SecretKey - - - - - Constructs a BasicAWSCredentials object for the specified accessKey and secretKey. - - - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - When running in an ECS container and AWS_CONTAINER_CREDENTIALS_RELATIVE_URI is set, - use the given end point to retrieve the credentials. - - - - - These constants should not be consumed by client code. They are only relevant - in the context of ECS container and, especially, AWS_CONTAINER_CREDENTIALS_RELATIVE_URI - environment variable should not be overriden by the client code. - - - - If AWS_CONTAINER_CREDENTIALS_RELATIVE_URI environment variable is set, we want to attempt to retrieve credentials - using ECS endpoint instead of referring to instance profile credentials. - - - If AWS_CONTAINER_CREDENTIALS_RELATIVE_URI environment variable is set, we want to attempt to retrieve credentials - using ECS endpoint instead of referring to instance profile credentials. - - - - Immutable representation of AWS credentials. - - - - - Gets the AccessKey property for the current credentials. - - - - - Gets the SecretKey property for the current credentials. - - - - - Gets the Token property for the current credentials. - - - - - Gets the UseToken property for the current credentials. - Specifies if Token property is non-emtpy. - - - - - Constructs an ImmutableCredentials object with supplied accessKey, secretKey. - - - - Optional. Can be set to null or empty for non-session credentials. - - - - Returns a copy of the current credentials. - - - - - - Abstract class for automatically refreshing AWS credentials - - - - - Refresh state container consisting of credentials - and the date of the their expiration - - - - - Represents the current state of the Credentials. - - This can be cleared without synchronization. - - - - Semaphore to control thread access to GetCredentialsAsync method. - The semaphore will allow only one thread to generate new credentials and - update the current state. - - - - - The time before actual expiration to expire the credentials. - Property cannot be set to a negative TimeSpan. - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - Test credentials existence and expiration time - should update if: - credentials have not been loaded yet - it's past the expiration time. At this point currentState.Expiration may - have the PreemptExpiryTime baked into to the expiration from a call to - UpdateToGeneratedCredentials but it may not if this is new application load. - - - - - When overridden in a derived class, generates new credentials and new expiration date. - - Called on first credentials request and when expiration date is in the past. - - - - - - Clears currently-stored credentials, forcing the next GetCredentials call to generate new credentials. - - - - - Immutable representation of AWS credentials obtained as a result of - authenticating against a SAML-supporting federated identity provider. - - - - - The expiry time of the credentials, obtained from the AssumeRoleWithSAML response. - - - - - The value of the NameID element in the Subject element of the SAML assertion, as returned in the - AssumeRoleWithSAML response from the Security Token Service. - - - - - Constructs an instance with supplied keys and SAML assertion data. - - - - - - - - - - Constructs an instance with supplied keys and SAML assertion data. - - - - - - - - Returns a copy of the current credentials. - - - - - - Serializes the instance to a json-format string for external storage - - The serialized object in json - - - - Instantiates an instance from persisted json data - - The serialized data - Deserialized instance corresponding to the json data - - - - Session credentials consisting of AccessKey, SecretKey and Token - - - - - Constructs a SessionAWSCredentials object for the specified accessKey, secretKey. - - - - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - AWS Credentials that automatically refresh by calling AssumeRole on - the Amazon Security Token Service. - - - - - As established by STS, the regex used to validate the role session names is a string of 2-64 characters consisting of - upper- and lower-case alphanumeric characters with no spaces. You can also include - underscores or any of the following characters: =,.@- - - - - - Options to be used in the call to AssumeRole. - - - - - The absolute path to the file on disk containing an OIDC token - - - - - The Amazon Resource Name (ARN) of the role to assume. - - - - - An identifier for the assumed role session. - - - - - Constructs an AssumeRoleWithWebIdentityCredentials object. - - The absolute path to the file on disk containing an OIDC token. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - - - - Constructs an AssumeRoleWithWebIdentityCredentials object. - - The absolute path to the file on disk containing an OIDC token. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRole. - - - - Creates an instance of from environment variables. - - Throws an if the needed environment variables are not set. - The new credentials. - - - - Gets a client to be used for AssumeRoleWithWebIdentity requests. - - The STS client. - - - - Options for using a credentials object to make AssumeRoleWithWebIdentity calls. - - - - - Gets and sets the property DurationSeconds. - - The duration, in seconds, of the role session. The value can range from 900 seconds - (15 minutes) up to the maximum session duration setting for the role. This setting - can have a value from 1 hour to 12 hours. If you specify a value higher than this - setting, the operation fails. For example, if you specify a session duration of 12 - hours, but your administrator set the maximum session duration to 6 hours, your operation - fails. To learn how to view the maximum value for your role, see View - the Maximum Session Duration Setting for a Role in the IAM User Guide. - - - - By default, the value is set to 3600 seconds. - - - - The DurationSeconds parameter is separate from the duration of a console - session that you might request using the returned credentials. The request to the - federation endpoint for a console sign-in token takes a SessionDuration - parameter that specifies the maximum length of the console session. For more information, - see Creating - a URL that Enables Federated Users to Access the AWS Management Console in the - IAM User Guide. - - - - - - - Gets and sets the property ProviderId. - - The fully qualified host component of the domain name of the identity provider. - - - - Specify this value only for OAuth 2.0 access tokens. Currently www.amazon.com - and graph.facebook.com are the only supported identity providers for - OAuth 2.0 access tokens. Do not include URL schemes and port numbers. - - - - Do not specify this value for OpenID Connect ID tokens. - - - - - - Gets and sets the property Policy. - - An IAM policy in JSON format that you want to use as an inline session policy. - - - - This parameter is optional. Passing policies to this operation returns new temporary - credentials. The resulting session's permissions are the intersection of the role's - identity-based policy and the session policies. You can use the role's temporary credentials - in subsequent AWS API calls to access resources in the account that owns the role. - You cannot use session policies to grant more permissions than those allowed by the - identity-based policy of the role that is being assumed. For more information, see - Session - Policies in the IAM User Guide. - - - - The plain text that you use for both inline and managed session policies shouldn't - exceed 2048 characters. The JSON policy characters can be any ASCII character from - the space character to the end of the valid character list (\u0020 through \u00FF). - It can also include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D) - characters. - - - - The characters in this parameter count towards the 2048 character session policy guideline. - However, an AWS conversion compresses the session policies into a packed binary format - that has a separate limit. This is the enforced limit. The PackedPolicySize - response element indicates by percentage how close the policy is to the upper size - limit. - - - - - - - Gets and sets the property PolicyArns. - - The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use - as managed session policies. The policies must exist in the same account as the role. - - - - This parameter is optional. You can provide up to 10 managed policy ARNs. However, - the plain text that you use for both inline and managed session policies shouldn't - exceed 2048 characters. For more information about ARNs, see Amazon - Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference. - - - - The characters in this parameter count towards the 2048 character session policy guideline. - However, an AWS conversion compresses the session policies into a packed binary format - that has a separate limit. This is the enforced limit. The PackedPolicySize - response element indicates by percentage how close the policy is to the upper size - limit. - - - - Passing policies to this operation returns new temporary credentials. The resulting - session's permissions are the intersection of the role's identity-based policy and - the session policies. You can use the role's temporary credentials in subsequent AWS - API calls to access resources in the account that owns the role. You cannot use session - policies to grant more permissions than those allowed by the identity-based policy - of the role that is being assumed. For more information, see Session - Policies in the IAM User Guide. - - - - - - The proxy settings to use when calling AssumeRoleWithWebIdentity. - - This parameter is optional. - - - - - - State class passed on callback to demand user credentials when authentication - needs to be performed using a non-default identity. - - - - - If the current authentication callback is associated with - a credential profile, this can be used to give the user - some context on the request for his/her authentication. - - - - - Contains the user identity that the user should supply a password - for. The user can ignore if they choose and return credentials for - an alternate account. - - - - - Any custom state that was registered with the callback. - - - - - Set if the callback was due to a failed authentication attempt. - If false we are beginning to obtain or refresh credentials. - - - - - InstanceProfileAWSCredentials allows configuring Roles and every instance hits IMDS individually. - This class has a singleton timer task that caches instance profile credentials every 2 minutes. - - - - - Returns a copy of the most recent instance profile credentials. - - - - - Dispose this object and all related resources. - - - - - Uses aws credentials stored in environment variables to construct the credentials object. - AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY are used for the access key id and secret key. - If the variable AWS_SESSION_TOKEN exists then it will be used to create temporary session - credentials. - - - For backwards compatibility the class will also attempt to discover the secret key from - the AWS_SECRET_KEY variable, if a value cannot be obtained using the standard - AWS_SECRET_ACCESS_KEY variable. - - - - - Constructs an instance of EnvironmentVariablesAWSCredentials. If no credentials are found in - the environment variables then an InvalidOperationException is thrown. - - - - - Creates immutable credentials from environment variables. - - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - Custom exception type thrown when a role profile with user identity is used - in conjunction with a credential request callback. This exception is thrown - if the callback returns null, indicating the user declined to supply credentials. - - - - - Initializes a new exception instance. - - - - - - Initializes a new exception instance. - - - - - - - Constructs a new instance of the FederatedAuthenticationCancelledException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Custom exception type thrown when authentication for a user fails due to - invalid credentials. - - - - - Initializes a new exception instance. - - - - - - Initializes a new exception instance. - - - - - - - Constructs a new instance of the FederatedAuthenticationFailureException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Temporary credentials that are created following successful authentication with - a federated endpoint supporting SAML. - - - In order to use the FederatedAWSCredentials class the AWSSDK.SecurityToken assembly - must be available to your application at runtime. - - - - - Constructs an instance of FederatedAWSCredentials. After construction call GetCredentials - to authenticate the user/process and obtain temporary AWS credentials. - - The SAML endpoint used for authentication. - The role ARN used for authentication. - - - - Constructs an instance of FederatedAWSCredentials. After construction call GetCredentials - to authenticate the user/process and obtain temporary AWS credentials. - - The SAML endpoint used for authentication. - The role ARN used for authentication. - The options used for authentication. - See for details about available options. - - - - The SAML Endpoint used for authentication. - - - - - The role ARN used for authentication. - - - - - The options used for authentication. - See for details about available options. - - - - - Refresh credentials after expiry. If the role profile is configured with user identity - information and a callback has been registered to obtain the user credential, the callback - will be invoked ahead of authentication. For role profiles configured with user identity - but no callback registration, the SDK will fall back to attempting to use the default - user identity of the current process. - - - - - - Clears currently-stored credentials, forcing the next GetCredentials call to generate new credentials. - - - - - Options that control the behavior of . - - - - - The identity to use when authenticating. - This is in the form domain\username, or just username. - If this option is not set, the current user's identity will be used. - - - - - uses this callback to get credentials if the UserIdentity is set. - - - - - When makes a callback for credentials, - this state will be included for use by the callback handler. - - - - - The proxy settings to use when calling the - Secure Token Service and the ADFS endpoint. - - - - - Set this property when a region-specific STS endpoint must be used (eg cn-north-1). - If left empty/null, the global sts.amazonaws.com endpoint will be used when credentials are obtained. - - - - - The profile name, if this FederatedAWSCredentialsOptions - is associated with a CredentialProfile. - - - - - Credentials that are retrieved from the Instance Profile service on an EC2 instance - - - - - Role for which the credentials are retrieved - - - - - Constructs a InstanceProfileAWSCredentials object for specific role - - Role to use - - - - Constructs a InstanceProfileAWSCredentials object for specific role - - Role to use - - - - Constructs a InstanceProfileAWSCredentials object for the first found role - - - - - Constructs a InstanceProfileAWSCredentials object for the first found role - - - - - Retrieves a list of all roles available through current InstanceProfile service - - - - - - Retrieves a list of all roles available through current InstanceProfile service - - - - - - Return true if string is null or whitespace, false otherwise. - We can't use String.IsNullOrWhitespace because it doesn't exist - in all frameworks we support. - - - - - - - Process Credentials can retrieve credentials by running a process and reading its stdout. - A new config option, "credential_process" is added to the shared config file that allows customers - to specify which process to run. The credentials retrieved by running this process could be either - Basic or Session credentials. - - - - - Generates new credentials by running the "credential_process" process. - - - - - Exception class to capture all exceptions encountered when starting or - executing the "credential_process" process. If the user has specified an executable - and the SDK is unable to execute it, the exception should be surfaces to the user - instead of moving on to the next credential provider. - - - - - - Credentials that are retrieved using a stored profile. - - - Unless otherwise specified priority is given to loading credentials from the SDK credential store - file which is shared between the SDK, PowerShell CLI and Toolkit. Credentials in profiles in this - file are encrypted and can only be used by the user account on the current machine that stored the - profile. Credentials can also be loaded from the plain-text ini-format credential file which is - shared with other AWS SDKs. This file is expected to exist in a '.aws' folder in the user's home - directory but alternate locations can be specified using either the AWSProfilesLocation setting in - the application configuration file, or by using the AWS_SHARED_CREDENTIALS_FILE environment variable. - - - The profile name can be specified in the App.config using the AWSProfileName setting. - - - - - - Constructs an instance for credentials stored in a profile. This constructor searches for credentials - using the account name specified using the AWSProfileName setting, if set, in the application configuration - file. If the configuration file setting is not set the SDK will attempt to locate a profile with the name - 'default'. - - - - - Constructs an instance for credentials stored in a profile with the specified name. The SDK will - check the SDK credential store file first before looking for the shared ini-format credentials - file unless the application configuration file contains a setting for the 'AWSProfilesLocation' - indicating the search should be constrained to the shared credentials file at the specified - location. - - The name of the profile in which the credentials were stored. - - - - Constructs an instance for credentials stored in a profile with the specified name. - - The profile name to search for credentials for - - Optional; instructs the SDK to check for the profile in the shared credentials file at the - specified location. If not set, the SDK will inspect its own credential store file first before - attempting to locate a shared credential file using either the default location beneath the user's - home profile folder or the location specified in the AWS_SHARED_CREDENTIALS_FILE environment - variable. - - - If credential materials cannot be read or are invalid due to missing data an InvalidDataException - is thrown. If no credentials can be located with the specified profile name, an ArgumentException - is thrown. - - - - - Name of the profile being used. - - - - - Location of the profiles, if used. - - - - - Tests if a profile has been registered in either the SDK store or the specified credential - file. - - The name of the profile to test - - Optional; instructs the SDK to check for the profile in the shared credentials file at the - specified location. If not set, the SDK will inspect its own credential store file first before - attempting to locate a shared credential file using either the default location beneath the user's - home profile folder or the location specified in the AWS_SHARED_CREDENTIALS_FILE environment - variable. - - True if a profile with the specified name has been registered. - - - - Tests if an instance can be created from the persisted profile data. - If profilesLocation is null/empty, the SDK store is searched for the - profile data before probing for the profile in the shared the ini-format - credential file. - - The name of the profile to test - - If null/empty, the SDK store is searched for the named profile otherwise - the ini-format credential file at the specified location is inspected. - - True if the persisted data would yield a valid credentials instance. - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - Helper routiners for AWS and Federated credential profiles. Probes the - profile type for the supplied profile name and returns the appropriate profile - instance. - - - - - Determines the type of the requested profile and returns the - appropriate profile instance. - - The name of the profile (AWS or federated) to be loaded. - Instantiated profile type. - - - - Determines the type of the requested profile and returns the - appropriate profile instance. - - The name of the profile (AWS or federated) to be loaded. - - The location of the shared credentials (.ini) file, for profiles that are not stored in the - SDK credential store. - - Instantiated profile type. - - - - Probes for and returns the fully qualified name of the shared ini-format credentials - file. - - - Contains the file or folder name of the credential file. If not specified, the - routine will first check the application configuration file for a setting indicating - the file location or filename. If the configuration file does not yield a credential - file location then an environment variable is examined. Finally the routine will - inspect the fallback default location beneath the user's home folder location. - - - The fully qualified name to the credential file that was located, or null - if no credential file could be found. - - - - - Obtains credentials from access key/secret key or AWSProfileName settings - in the application's app.config or web.config file. - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - Exception thrown on validation of a StoredProfileFederatedCredentials instance if the role profile - is configured to use a non-default user identity and the QueryUserCredentialCallback on the - instance has not been set. - - - - - Initializes a new exception instance. - - - - - - Initializes a new exception instance. - - - - - - - Initializes a new exception instance. - - - - - - Constructs a new instance of the CredentialRequestCallbackRequiredException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Credentials that are retrieved from ConfigurationManager.AppSettings - - - - - Constructs an instance of EnvironmentAWSCredentials and attempts - to load AccessKey and SecretKey from ConfigurationManager.AppSettings - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - Temporary credentials that are created following successful authentication with - a federated endpoint supporting SAML. - - - 1. Currently only the SDK store supports profiles that contain the necessary data to support - authentication and role-based credential generation. The ini-format files used by the AWS CLI - and some other SDKs are not supported at this time. -
- 2. In order to use the StoredProfileFederatedCredentials class the AWSSDK.SecurityToken assembly - must be available to your application at runtime. - - - - - Custom state to return to the registered callback to handle credential requests. - The data will be contained in the CredentialRequestCallbackArgs instance supplied - to the callback. - - - - - The minimum allowed timespan for generated credentials, per STS documentation. - - - - - The maximum allowed timespan for generated credentials, per STS documentation. - - - - - Name of the profile being used. - - - - - Location of the profiles, if used. - - - - - The data about the SAML endpoint and any required user credentials parsed from the - profile. - - - - - Callback signature for obtaining user credentials that may be needed for authentication. - - - Data about the credential demand including any custom state data that was supplied - when the callback was registered. - - - The network credential to use in user authentication. Return null to signal the user - declined to provide credentials and authentication should not proceed. - - - - - Constructs an instance of StoredProfileFederatedCredentials using the profile name specified - in the App.config. If no profile name is specified then the default credentials are used. - - - - - Constructs an instance of StoredProfileFederatedCredentials. Credentials will be searched - for using the profileName parameter. - - The profile name to search for credentials for - - - - - Constructs an instance of StoredProfileFederatedCredentials. After construction call one of the Authenticate - methods to authenticate the user/process and obtain temporary AWS credentials. - - - For users who are domain joined (the role profile does not contain user identity information) the temporary - credentials will be refreshed automatically as needed. Non domain-joined users (those with user identity - data in the profile) are required to re-authenticate when credential refresh is required. An exception is - thrown when attempt is made to refresh credentials in this scenario. The consuming code of this class - should catch the exception and prompt the user for credentials, then call Authenticate to re-initialize - with a new set of temporary AWS credentials. - - - - The name of the profile holding the necessary role data to enable authentication and credential generation. - - Reserved for future use. - - The ini-format credentials file is not currently supported for SAML role profiles. - - - - - - Constructs an instance of StoredProfileFederatedCredentials. After construction call one of the Authenticate - methods to authenticate the user/process and obtain temporary AWS credentials. - - - For users who are domain joined (the role profile does not contain user identity information) the temporary - credentials will be refreshed automatically as needed. Non domain-joined users (those with user identity - data in the profile) are required to re-authenticate when credential refresh is required. An exception is - thrown when attempt is made to refresh credentials in this scenario. The consuming code of this class - should catch the exception and prompt the user for credentials, then call Authenticate to re-initialize - with a new set of temporary AWS credentials. - - - - The name of the profile holding the necessary role data to enable authentication and credential generation. - - Reserved for future use. - - Null or proxy settings to be used during the HHTPS authentication calls when generating credentials. - /// - The ini-format credentials file is not currently supported for SAML role profiles. - - - - - Registers a callback handler for scenarios where credentials need to be supplied - during user authentication (primarily the non-domain-joined use case). Custom data, - which will be supplied in the CredentialRequestCallbackArgs instance passed to the - callback, can also be supplied. - - - The callback will only be invoked if the underlying SAML role profile indicates it - was set up for use with a specific identity. For profiles that do not contain any user - identity the SDK will default to using the identity of the current process during - authentication. Additionally, if the profile contain user identity information but no - callback has been registered, the SDK will also attempt to use the current process - identity during authentication. - - - The handler to be called - - Custom state data to be supplied in the arguments to the callback. - - - Only one callback handler can be registered. The call to the handler will be made on - whatever thread is executing at the time a demand to provide AWS credentials is made. - If the handler code requires that UI need to be displayed, the handler should - transition to the UI thread as appropriate. - - - - - Tests if an instance can be created from the persisted profile data. - - The name of the profile to test. - The location of the shared ini-format credential file. - True if the persisted data would yield a valid credentials instance. - - This profile type is currently only supported in the SDK credential store file. - The shared ini-format file is not currently supported; any value supplied - for the profilesLocation value is ignored. - - - - - Performs any additional validation we may require on the profile content. - - - - - Refresh credentials after expiry. If the role profile is configured with user identity - information and a callback has been registered to obtain the user credential the callback - will be invoked ahead of authentication. For role profiles configured with user identity - but no callback registration, the SDK will fall back to attempting to use the default - user identity of the current process. - - - - - - Determines the endpoint discovery enabled value based on an environment variable. If no value is found in the - environment then an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of EnvironmentVariable AWS_ENABLED_ENDPOINT_DISCOVERY. If no value is found in the - environment then an InvalidOperationException is thrown. - - - - - Determines endpoint discovery enabled based on a stored in an . - If the profile doesn't exist or there is no endpoint discovery enabled information an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of . - If the AWS_PROFILE environment variable is set the instance will be constructed using that profile, - otherwise it will use the default profile. - - If the profile doesn't exist or there is no endpoint discovery enabled information an InvalidOperationException is thrown. - - The ICredentialProfileSource to read the profile from. - - - - Attempts to construct an instance of . - If the profile doesn't exist or there is no endpoint discovery enabled information an InvalidOperationException is thrown. - - The ICredentialProfileSource to read the profile from. - The name of the profile. - - - - Probing mechanism to determine the endpoint discovery enabled value from various sources. - - - - - The valid hashing algorithm supported by the sdk for request signing. - - - - - Which end of a request was responsible for a service error response. - - - - - The sender was responsible for the error, i.e. the client - request failed validation or was improperly formatted. - - - - - The error occured within the service. - - - - - An unrecognized error type was returned. - - - - - Sts Regional Endpoints Value determines whether or not - to send the sts request to the regional endpoint or to - the global sts endpoint - - - - - Send the request to the global sts endpoint - if the region is a legacy global region - - - - - Send the request to the regional endpoint - - - - - S3 US East 1 endpoint value determines wheter or not - to send the us-east-1 s3 requests to the regional endpoint or to - the legacy global endpoint - - - - - Sends the requests to the legacy global s3 endpoint for us-east-1 - - - - - Sends the request to the regional s3 endpoint for us-east-1 - - - - - RetryMode determines which request retry mode is used for requests that do - not complete successfully. - - - - - Legacy request retry strategy. - - - - - Standardized request retry strategy that is consistent across all SDKs. - - - - - An experimental request retry strategy that builds on the Standard strategy - and introduces congestion control through client side rate limiting. - - - - - Superclass for Exceptions that come over the event stream, or to wrap other kinds of generic exceptions. - - - - - The numeric code identifier for the type of error. - - - - - Constructs an EventStreamError. - - - - - Constructs an EventStreamError. - - The error code. - The error message. - - - - Constructs a new instance of the EventStreamErrorCodeException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Event args that contain an . - - The - - - - The EventStream Event. - - - - - Constructs an EventStreamEventReceivedArgs. - - The EventStream Event. - - - - Event args that contain an . - - The . - - - - The EventStream Exception. - - - - - Constructs an EventStreamExceptionReceivedArgs. - - The EventStream Exception. - - - - Supported Header types for vnd.amazon.event-stream - - - - - Name for the Header. Maximum of 255 bytes. - - - - - Header type id - - - - - Computes the amount of memory neccesary to serialize this Header. - - - - - Writes this Header to buffer starting at offset - Keep in mind, this API assumes buffer is large enough - for the operation. - - buffer to serialize this Header to - offset to begin writing at. - - the new offset. - - - - - Returns the current value as a bool - - - - - Sets the current value - - - - - Returns the current value as a byte - - - - - Sets the current value - - - - - Gets the current value as a 16 bit integer. (Host Order). - - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a 32 bit integer. (Host Order) - - - - - Sets the current value - - - - - returns the current value as a 64-bit integer. (Host Order) - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a byte buffer. - - - - - - Sets the current value. Max length is 2^15 - 1 - - - - - Returns the current value as a utf-8 string. - - - - - Sets the current value. Utf-8 encoded. Max byte size is 2^16 - 1 - - - - - Gets the current value as a DateTime. - Note: You do not need to compensate for unix epoch on this API. - - - - - - Sets the current value. - Note: You do not need to compensate for unix epoch on this API. - - - - - Returns the current value as a Guid (UUID) - - - - - Sets the current value - - - - - Header Data for an EventStreamMessage - - Each header is of format: - [name len] (1) | [utf-8 name] (v) - [type (1)] - [value (v)] - - - - - Name for the Header. Maximum of 255 bytes. - - - - - Header type id - - - - - Initializes this Header with name. - - utf-8 string, max length is 255 - - - - Deserializes the header in buffer. - - buffer constaining the header - index to start from in the buffer. - updated offset with new value for offset - - - - Writes this Header to buffer starting at offset - Keep in mind, this API assumes buffer is large enough - for the operation. - - buffer to serialize this Header to - offset to begin writing at. - - the new offset. - - - - - Computes the amount of memory neccesary to serialize this Header. - - - - - Returns the current value as a bool - - - - - Sets the current value - - - - - Returns the current value as a byte - - - - - Sets the current value - - - - - Gets the current value as a 16 bit integer. (Host Order). - - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a 32 bit integer. (Host Order) - - - - - Sets the current value - - - - - returns the current value as a 64-bit integer. (Host Order) - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a byte buffer. - - - - - - Sets the current value. Max length is 2^15 - 1 - - - - - Returns the current value as a utf-8 string. - - - - - Sets the current value. Utf-8 encoded. Max byte size is 2^16 - 1 - - - - - Gets the current value as a DateTime. - Note: You do not need to compensate for unix epoch on this API. - - - - - - Sets the current value. - Note: You do not need to compensate for unix epoch on this API. - - - - - Returns the current value as a Guid (UUID) - - - - - Sets the current value - - - - - Constructs a new instance of the EventStreamParseException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Constructs a new instance of the EventStreamChecksumFailureException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Headers for the message. Can be null. - - - - - Payload for the message. Can be null. - - - - - Converts a message into a byte buffer (usually for network transmission). - - - - - Message is a single datagram. The format is as follows: - [ total length (4) ] | [ headers_length (4)] | [ prelude crc(4)] - [ headers (v)] - [ payload (v)} - [ trailing crc ] - - CRCs use the CRC32 algorithm. - - - - - Content type for EventStreams. - - - - - Headers for the message. Can be null. - - - - - Payload for the message. Can be null. - - - - - Initialize a message with headers and a payload. - - list of headers for the message, can be null. - payload for the message, can be null. - - - - Builds a message from buffer. - - buffer to read - offset to start reading - buffer length. - - parsed instance of EventStreamMessage. Doesn't return null, - does throw if CRCs don't match. - - - - - Converts a message into a byte buffer (usually for network transmission). - - - - - Defines exceptions that arise from an not conforming to specification. - - - - - Constructs an EventStreamValidationException. - - - - - Constructs an EventStreamValidationException. - - The exception message. - - - - Constructs an EventStreamValidationException. - - The exception message. - The inner exception. - - - - Constructs a new instance of the EventStreamValidationException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - The contract for the . - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - A subclass of that enables an enumerable interface for interacting with Events. - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - Flag if the stream was chosen to be enumerated. - - - - - A Stream of Events. Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treated as mutually exclusive. - - - - - A Stream of Events. Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treated as mutually exclusive. - - - - - Returns an enumerator that iterates through the collection. - - An enumerator that can be used to iterate through the collection. - - - - Returns an enumerator that iterates through a collection. - - An object that can be used to iterate through the collection. - - - - Starts the background thread to start reading events from the network stream. - - - - - The contract for the . - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - The size of the buffer for reading from the network stream. - - - - - Fires when an event is received. - - - - - Fired when an exception or error is raised. - - - - - Starts the background thread to start reading events from the network stream. - - - - - The superclass for all EventStreams. It contains the common processing logic needed to retreive events from a network Stream. It - also contains the mechanisms needed to have a background loop raise events. - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - "Unique" key for unknown event lookup. - - - - - Header key for message type. - - - - - Header key for event type. - - - - - Header key for exception type. - - - - - Header key for error code. - - - - - Header key for error message. - - - - - Value of when the message is an event. - - - - - Value of when the message is an exception. - - - - - Value of when the message is an error. - - - - - The size of the buffer for reading from the network stream. - Default is 8192. - - - - - The underlying stream to read events from. - - - - - Responsible for decoding events from sequences of bytes. - - - - - Fires when an event is recieved. - - - - - Fired when an exception or error is raised. - - - - - The mapping of event message to a generator function to construct the matching Event Stream event. - - - - - The mapping of event message to a generator function to construct the matching Event Stream exception. - - - - - Whether the Stream is currently being processed. - - - - - A Stream of Events. Events can be retrieved from this stream by attaching handlers to listen events, and then calling StartProcessing. - - - - - A Stream of Events. Events can be retrieved from this stream by attaching handlers to listen events, and then calling StartProcessing. - - - - - Converts an EventStreamMessage to an event. - - The event stream message to be converted. - The event - - - - Abstraction for cross-framework initiation of the background thread. - - - - - The background thread main loop. It will constantly read from the network stream until IsProcessing is false, or an error occurs. - - This stub exists due to FXCop. - - - - - The background thread main loop. It will constantly read from the network stream until IsProcessing is false, or an error occurs. - - Needed for 3.5 support. Not used. - - - - Reads from the stream into the buffer. It then passes the buffer to the decoder, which raises an event for - each message it decodes. - - The buffer to store the read bytes from the stream. - - - - Wraps exceptions in an outer exception so they can be passed to event handlers. If the Exception is already of a compatable type, - the method returns what it was given. - - The exception to wrap. - An exception of type TE - - - - Starts the background thread to start reading events from the network stream. - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Disposes the resources of this stream. - - Should dispose of unmanged resources. - - - - Event Arguments for EventStreamDecoder.MessageReceived. - - - - - Received message. - - - - - Additional object context - - - - - Initialize this with message - - - - - Initialize this with message and object conetext - - - - - Exception thrown when a request is made of the Decoder, but the internal state - machine is an invalid state. This is usually the result of an interanl exception - being thrown during parsing of the network stream. - - - - - Constructs a new instance of the EventStreamDecoderIllegalStateException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Contract for EventStreamDecoder - - - - - Invoked anytime an EventStreamMessage is found. - - - - - Processes data starting at offset up to length. - Invokes MessageRecieved for each message encountered. - If an exception is thrown, this object is not safe for reuse. - - buffer to read - offset in buffer to start reading. - length of data. - - - - Streaming decoder for listening for incoming EventStreamMessage datagrams. - - - - - Invoked anytime an EventStreamMessage is found. - - - - - Object data (optional) that can be passed to the event handler for MessageReceived. - - - - - Default constructor. Initializes internal _state machine. - - - - - Processes data starting at offset up to length. - Invokes MessageRecieved for each message encountered. - If an exception is thrown, this object is not safe for reuse. - - buffer to read - offset in buffer to start reading. - length of data. - - - - Superclass for Exceptions that come over the event stream, or to wrap other kinds of generic exceptions. - - - - - Constructs an EventStreamException. - - - - - Constructs an EventStreamException. - - The exception message. - - - - Constructs an EventStreamException. - - The exception message. - The inner exception. - - - - Constructs a new instance of the EventStreamException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - The contract for EventStream events. - - - - - The contract for EventStream terminal events. - - - - - This Event is returned if an event is retrieved from the event stream, but a generator function - for the event is not defined. This can occur if the SDK is not updated after a new event type is introduced. - - - - - The Message recieved from the event stream before conversion. - - - - - The event type. - - - - - Constructs an UnknownEventStreamEvent. - - - - - Constructs an UnknownEventStreamEvent. - - The Message recieved from the event stream before conversion. - The event type. - - - - Signals that an an has an unknown message type. These exceptions whould be - swallowed to allow future expansion of the EventStream specification without breaking existing clients. - - - - - Constructs an UnknownEventStreamMessageTypeException. - - - - - Constructs a new instance of the UnknownEventStreamMessageTypeException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - This exception is thrown if an exception is retrieved from the event stream and should be modeled, - but a generator function for the strongly-typed exception is not defined. - - - - - The exception type. - - - - - Constructs an EventStreamException. - - The exception type. - - - - Constructs a new instance of the UnknownEventStreamException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - All Amazon service interfaces like IAmazonS3 extend from this interface. This allows all the - Amazon service interfaces be identified by this base interface and helps with generic constraints. - - - - - A readonly view of the configuration for the service client. - - - - - This interface is the read only access to the ClientConfig object used when setting up service clients. Once service clients - are initiated the config object should not be changed to avoid issues with using a service client in a multi threaded environment. - - - - - Gets the RegionEndpoint property. The region constant to use that - determines the endpoint to use. If this is not set - then the client will fallback to the value of ServiceURL. - - - - - The constant used to lookup in the region hash the endpoint. - - - - - Gets and sets of the ServiceURL property. - This is an optional property if you need to set a specific service URL - instead setting the region with the RegionEndpoint property. - - - - - Gets the UseHttp property. - If this property is set to true, the client attempts - to use HTTP protocol. - By default, this property is set to false. - - - - - Gets Service Version - - - - - Gets the signatureMethod property. - - - - - Gets the SignatureVersion property. - - Note: This property exists for backward compatibility but is no longer - used by any service other than S3. - - - - - Gets the AuthenticationRegion property. - Used in AWS4 request signing, this is an optional property; - change it only if the region cannot be determined from the - service endpoint. - - - - - Gets the AuthenticationServiceName property. - Used in AWS4 request signing, this is the short-form - name of the service being called. - - - - - Gets the UserAgent property. - - - - - Gets the DisableLogging. If true logging for this client will be disabled. - - - - - Flag on whether to log metrics for service calls. - - This can be set in the application's configs, as below: - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSLogMetrics" value"true"/> - </appSettings> - </configuration> - - - - - - Gets the LogResponse property. - If this property is set to true, the service response - is read in its entirety and logged. - - - - - Gets the ReadEntireResponse. - If this property is set to true, the service response - is read in its entirety before being processed. - - - - - This flag controls if .NET HTTP infrastructure should follow redirection - responses (e.g. HTTP 307 - temporary redirect). - - - - - Gets the BufferSize property. - The BufferSize controls the buffer used to read in from input streams and write - out to the request. - - - - - Returns the flag indicating how many retry HTTP requests an SDK should - make for a single SDK operation invocation before giving up. This flag will - return 4 when the RetryMode is set to "Legacy" which is the default. For - RetryMode values of "Standard" or "Adaptive" this flag will return 2. In - addition to the values returned that are dependant on the RetryMode, the - value can be set to a specific value by using the AWS_MAX_ATTEMPTS environment - variable, max_attempts in the shared configuration file, or by setting a - value directly on this property. When using AWS_MAX_ATTEMPTS or max_attempts - the value returned from this property will be one less than the value entered - because this flag is the number of retry requests, not total requests. To - learn more about the RetryMode property that affects the values returned by - this flag, see . - - - - - Determines if MaxErrorRetry has been manually set. - - - - - Gets the interval at which progress update events are raised - for upload operations. By default, the progress update events are - raised at every 100KB of data transferred. - - - - - Flag on whether to resign requests on retry or not. - - - - - Credentials to use with a proxy. - - - - - Gets the default request timeout value. - - - - If the value is set, the value is assigned to the Timeout property of the HTTPWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - - - - Configures the endpoint calculation for a service to go to a dual stack (ipv6 enabled) endpoint - for the configured region. - - - Note: AWS services are enabling dualstack endpoints over time. It is your responsibility to check - that the service actually supports a dualstack endpoint in the configured region before enabling - this option for a service. - - - - - Configures a flag enabling to either opt in or opt out of the retry throttling service. - Note: set value to true to enable retry throttling feature. The Default value for this flag is false. - - - - - Using either the RegionEndpoint or the ServiceURL determine what the URL to the service is. - - The URL to the service. - - - - Performs validation on this config object. - Throws exception if any of the required values are missing/invalid. - - The timeout specified is null. - - - - Returns the clock skew adjusted utc now. This value is affected by AWSConfigs.ManualClockCorrection - - - - - Returns the calculated clock skew value for this config's service endpoint. If AWSConfigs.CorrectForClockSkew is false, - this value won't be used to construct service requests. - - - - - Gets the DisableHostPrefixInjection flag. If true, host prefix injection will be disabled for this client, the default value of this flag is false. - Host prefix injection prefixes the service endpoint with request members from APIs which use this feature. - Example: for a hostPrefix of "foo-name." and a endpoint of "service.region.amazonaws.com" the default behavior is to - prefix the endpoint with the hostPrefix resulting in a final endpoint of "foo-name.service.region.amazonaws.com". Setting - DisableHostPrefixInjection to true will disable hostPrefix injection resulting in a final endpoint of - "service.region.amazonaws.com" regardless of the value of hostPrefix. E.g. You may want to disable host prefix injection for testing against a local mock endpoint. - - - - - Returns the flag indicating if endpoint discovery should be enabled or disabled for operations that are not required to use endpoint discovery. - - - - - Returns the maximum number of discovered endpoints that can be stored within the cache for the client. The default limit is 1000 cache entries. - - - - - Returns the flag indicating the current mode in use for request - retries and influences the value returned from . - The default value is RequestRetryMode.Legacy. This flag can be configured - by using the AWS_RETRY_MODE environment variable, retry_mode in the - shared configuration file, or by setting this value directly. - - - - - Under Adaptive retry mode, this flag determines if the client should wait for - a send token to become available or don't block and fail the request immediately - if a send token is not available. - - - - - Gets the TCP keep-alive values to use for service requests. Enabling TCP keep-alive sends periodic TCP keep-alive probe packets, to prevent disconnection due to - network inactivity. This is useful when you make API calls that take a long time to respond. In this case, the connection could be dropped by an intermediate - node (e.g. proxy) as the connection is inactive for a long time. Timeout controls the duration of inactivity before a keep-alive probe packet is sent. - Interval controls the amount of time to wait before retrying a keep-alive probe packet in the event the server doesn't respond to a keep-alive probe. - - - - - Gets the ProxyHost property. - - - - - Gets the ProxyPort property. - - - - - Gets the max idle time set on the ServicePoint for the WebRequest. - Default value is 50 seconds (50,000 ms) unless ServicePointManager.MaxServicePointIdleTime is set, - in which case ServicePointManager.MaxServicePointIdleTime will be used as the default. - - - - - Gets the default read-write timeout value. - - - - - - - Gets the connection limit set on the ServicePoint for the WebRequest. - Default value is 50 connections unless ServicePointManager.DefaultConnectionLimit is set in - which case ServicePointManager.DefaultConnectionLimit will be used as the default. - - - - - Gets whether the Nagle algorithm is used on connections managed by the ServicePoint object used - for requests to AWS. This is defaulted to false for lower latency with responses that return small amount of data. This is the opposite - default than ServicePoint.UseNagleAlgorithm which is optimized for large responses like web pages or images. - - - - - Returns a WebProxy instance configured to match the proxy settings - in the client configuration. - - - - - Interface for a single logged message. - - - - - Log message format. - - - - - Log message arguments. - - - - - Culture-specific formatting provider. - - - - - Abstract parameter value. - - - - - String parameter value. - - - - - String value of the parameter. - - - - - Constructs ParameterValue for a single string. - - - - - - String list parameter value. - - - - - List of strings value of the parameter. - - - - - Constructs ParameterValue for a list of strings. - - - - - - The interface for an exception handler. - - - - - Handles an exception for the given execution context. - - The execution context, it contains the - request and response context. - The exception to handle. - - Returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception to replace the original exception. - - - - - The interface for an exception handler with a generic parameter for the exception type. - - The exception type. - - - - Handles an exception for the given execution context. - - The execution context, it contains the - request and response context. - The exception to handle. - - Returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception to replace the original exception. - - - - - The interface for a HTTP request factory. - - The type used by the underlying HTTP API to represent the request body. - - - - Creates an HTTP request for the given URI. - - The request URI. - An HTTP request. - - - - The interface for an HTTP request that is agnostic of the underlying HTTP API. - - The type used by the underlying HTTP API to represent the HTTP request content. - - - - The HTTP method or verb. - - - - - The request URI. - - - - - Configures a request as per the request context. - - The request context. - - - - Sets the headers on the request. - - A dictionary of header names and values. - - - - Gets a handle to the request content. - - The request content. - - - - Returns the HTTP response. - - The HTTP response. - - - - Writes a stream to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - The request context. - - - - Writes a byte array to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - - - - Sets up the progress listeners - - The content stream - The interval at which progress needs to be published - The objects which is trigerring the progress changes - The callback which will be invoked when the progress changed event is trigerred - an object, incase the progress is setup, else returns the original stream - - - - Aborts the HTTP request. - - - - - Initiates the operation to gets a handle to the request content. - - The async callback invoked when the operation completes. - The state object to be passed to the async callback. - IAsyncResult that represents an async operation. - - - - Ends the operation to gets a handle to the request content. - - IAsyncResult that represents an async operation. - The request content. - - - - Initiates the operation to Returns the HTTP response. - - The async callback invoked when the operation completes. - The state object to be passed to the async callback. - IAsyncResult that represents an async operation. - - - - Ends the operation to Returns the HTTP response. - - IAsyncResult that represents an async operation. - The HTTP response. - - - - Interface for a handler in a pipeline. - - - - - The logger used to log messages. - - - - - The inner handler which is called after the current - handler completes it's processing. - - - - - The outer handler which encapsulates the current handler. - - - - - Contains the processing logic for a synchronous request invocation. - This method should call InnerHandler.InvokeSync to continue processing of the - request by the pipeline, unless it's a terminating handler. - - The execution context which contains both the - requests and response context. - - - - Contains the processing logic for an asynchronous request invocation. - This method should call InnerHandler.InvokeSync to continue processing of the - request by the pipeline, unless it's a terminating handler. - - The execution context which contains both the - requests and response context. - IAsyncResult which represent a async operation. - - - - This callback method contains the processing logic that should be executed - after the underlying asynchronous operation completes. - This method is called as part of a callback chain which starts - from the InvokeAsyncCallback method of the bottommost handler and then invokes - each callback method of the handler above it. - This method should call OuterHandler.AsyncCallback to continue processing of the - request by the pipeline, unless it's the topmost handler. - - The execution context, it contains the - request and response context. - - - - A retry policy specifies all aspects of retry behavior. This includes conditions when the request should be retried, - checks of retry limit, preparing the request before retry and introducing delay (backoff) before retries. - - - - - Maximum number of retries to be performed. - This does not count the initial request. - - - - - The logger used to log messages. - - - - - The standard set of throttling error codes - - - - - The standard set of timeout error codes to retry on. - - - - - List of AWS specific error codes which are returned as part of the error response. - These error codes will be retried. - - - - - The standard set of transient error, HTTP status codes to retry on. - 502 and 504 are returned by proxies. These can also be returned for - S3 accelerate requests which are served by CloudFront. - - - - - Set of web exception status codes to retry on. - - - - - This parameter serves as the value to the CapacityManager.Container datastructure. - Its properties include the available capacity left for making a retry request and the maximum - capacity size. - - - - - Checks if a retry should be performed with the given execution context and exception. - - The execution context which contains both the - requests and response context. - The exception thrown after issuing the request. - Returns true if the request should be retried, else false. The exception is retried if it matches with clockskew error codes. - - - - Returns true if the request is in a state where it can be retried, else false. - - The execution context which contains both the - requests and response context. - Returns true if the request is in a state where it can be retried, else false. - - - - Return true if the request should be retried for the given exception. - - The execution context which contains both the - requests and response context. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Checks if the retry limit is reached. - - The execution context which contains both the - requests and response context. - Return false if the request can be retried, based on number of retries. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called on a successful request response. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called before a retry request is initiated. The value - returned is True by default(retry throttling feature is disabled). - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called before a retry request is initiated. The value - returned is True by default(retry throttling feature is disabled). - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - - - - Virtual method that gets called before a retry request is initiated. The value - returned is True by default(retry throttling feature is disabled). - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - true if the error that will be retried is a throttling error - - - - This method uses a token bucket to enforce the maximum sending rate. - - The execution context which contains both the - requests and response context. - If the prior request failed, this exception is expected to be - the exception that occurred during the prior request failure. - - - - Determines if an AmazonServiceException is a throttling error - - The current exception to check. - true if it is a throttling error else false. - - - - Determines if an AmazonServiceException is a transient error that - should be retried. - - The current execution context - The current exception to check. - true if the exception is a transient error else false. - - - - Determines if the exception is a known timeout error code that - should be retried under the timeout error category. - - The current exception to check. - true if the exception is considered a timeout else false - - - - Metrics collected by the SDK on a per-request basis. - - - Each request made to an AWS service by the SDK can have metrics - collected and logged. This interface represents the collected - metrics for a request. The metrics include properties (i.e. request id - and other metadata), timings for each stage of the request, and counters. - - - - - Collection of properties being tracked - - - - - Timings for metrics being tracked - - - - - Counters being tracked - - - - - Whether metrics are enabled for the request - - - - - JSON representation of the current metrics - - JSON string - - - - Represents how long a phase of an SDK request took. - - - - - Whether the timing has been stopped - - - - - Elapsed ticks from start to stop. - If timing hasn't been stopped yet, returns 0. - - - - - Elapsed time from start to stop. - If timing hasn't been stopped yet, returns TimeSpan.Zero - - - - - User supplied type to perform metrics formatting. - - - - - Produce custom formatting for SDK metrics. - - - If defined, this method will be called for every request made by the SDK. - - An instance of IRequestMetrics produced by the SDK - formatted string representation of the metrics - - - - Predefined request metrics that are collected by the SDK. - - - - - Information about the request. - - - - - Gets and sets the RequestId property. - ID that uniquely identifies a request. Amazon keeps track of request IDs. If you have a question about a request, include the request ID in your correspondence. - - - - - ICoreAmazonKMS is not meant to be used directly. It defines Key Management Service - with basic .NET types and allows other services to be able to use the service as - a runtime dependency. This interface is implemented by the AmazonKeyManagementServiceClient - defined in the AWSSDK.KeyManagementService assembly. - - - - - The result of the GenerateDataKey and GenerateDataKeyAsync operations. - - - - - The plaintext for the data key. - - - - - The ciphertext for the data key. - - - - - ICoreAmazonS3 is not meant to use directly. It defines S3 with basic .NET types - and allows other services to be able to use S3 as a runtime dependency. This interface - is implemented by the AmazonS3Client defined in the S3 assembly. - - - ICoreAmazonS3 is not meant to use directly. It defines S3 with basic .NET types - and allows other services to be able to use S3 as a runtime dependency. This interface - is implemented by the AmazonS3Client defined in the S3 assembly. - - - - - Generate a presigned URL. - - - - - - - - - - Start a delete object. - - - - - - - - - - - Get the results of a delete object. - - - - - - Start an upload object from stream. - - - - - - - - - - - - Get the results of an upload from stream. - - - - - - Start an upload object from file path. - - - - - - - - - - - - Get the results of an upload from file path. - - - - - - Start a download to a file path. - - - - - - - - - - - - Get results of downloading an object to a file path. - - - - - - Start opening a stream to an object in S3. - - - - - - - - - - - Get results of opening a stream to an object in S3. - - - - - - - Get all the object keys for the particular bucket and key prefix. - - - - - - - - - Delete the object. - - - - - - - - Deletes the ojects. - - - - - - - - Upload an object from a stream. - - - - - - - - - Upload an object from a file path. - - - - - - - - - Download object to a file path. - - - - - - - - - Get stream for an object. - - - - - - - - - Set the ACL on the object to public readable. - - - - - - - - Check to see if the bucket exists and if it doesn't create the bucket. - - - - - - Check to see if the bucket exists. - - - - - - - ICoreAmazonSQS is not meant to use directly. It defines SQS with basic .NET types - and allows other services to be able to use SQS as a runtime dependency. This interface - is implemented by the AmazonSQSClient defined in the SQS assembly. - - - - - - This method is used internally to access the Amazon SQS service within other service assemblies. - Please use AmazonSQSClient to access Amazon SQS instead. - - Get the attributes for the queue identified by the queue URL. - - The queue URL to get attributes for. - The attributes for the queue. - - - - - This method is used internally to access the Amazon SQS service within other service assemblies. - Please use AmazonSQSClient to access Amazon SQS instead. - - Set the attributes on the queue identified by the queue URL. - - The queue URL to set the attributues. - The attributes to set. - - - - ICoreAmazonSTS is not meant to be used directly. It defines Security Token - service with basic .NET types and allows other services to be able to use the service as - a runtime dependency. This interface is implemented by the AmazonSecurityTokenServiceClient - defined in the AWSSDK.SecurityToken assembly. - - - - - - This method is used internally to access the Amazon Security Token - service within other service assemblies. - Please use AmazonSecurityTokenServiceClient to access the Amazon Security Token - service instead. - - Use Amazon Security Token Service to assume a role. - - Proxy settings that are required for the HTTPS and STS calls made during the authentication/credential - generation process are supported and should have been configured on the STS ClientConfig instance - associated with the STS client instance exposing this interface. - - - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRole. - - - - - - This method is used internally to access the Amazon Security Token - service within other service assemblies. - Please use AmazonSecurityTokenServiceClient to access the Amazon Security Token - service instead. - - Authenticates against a federated identity endpoint supporting SAML and returns - temporary AWS credentials for the supplied role. - - The endpoint for the federated identity provider - The authentication type to use (NTLM, Kerberos etc) - The ARN of the role the user is to assume following authentication - TTL duration for the generated credentials. - - Optional; alternate user credential for authentication. If null the identity of the - current process is used. - - Generated credential data, including SAML-related information such as subject. - - Proxy settings that are required for the HTTPS and STS calls made during the authentication/credential - generation process are supported and should have been configured on the STS ClientConfig instance - associated with the STS client instance exposing this interface. - - - - - - This method is used internally to access the Amazon Security Token - service within other service assemblies. - Please use AmazonSecurityTokenServiceClient to access the Amazon Security Token - service instead. - - Use Amazon Security Token Service to assume a role. - - Proxy settings that are required for the HTTPS and STS calls made during the authentication/credential - generation process are supported and should have been configured on the STS ClientConfig instance - associated with the STS client instance exposing this interface. - - - The web identity token used to assume the role. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRoleWithWebIdentity - - - - - CoreAmazonKMS is not meant to use directly. It implements ICoreAmazonKMS - and allows other service clients to be able to use the KMS service as a runtime dependency. - - This class waits until a method is actually called on the ICoreAmazonKMS interface - before requiring the KMS assembly to be present and loaded. - - - - - This exception is thrown if there are problems signing the request. - - - - - Constructs a new instance of the SignatureException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - - - - Gets the percentage of transfer completed - - - - - Gets the number of bytes transferred since last event - - - - - Gets the number of bytes transferred - - - - - Gets the total number of bytes to be transferred - - - - - Returns a string representation of this object - - - - - - Class that posts the CSM event to a UDP portconfig - This is a singleton class and is created once - per AmazonServiceClient. - - - - - The CSMevents are always posted to the localhost - - - - - Method to post UDP datagram for sync calls - - - - - Method to post UDP datagram for async calls - - - - - TcpKeepAlive class used to group all the different properties used for working with TCP keep-alives. - - - - - Specifies if TCP keep-alive is enabled or disabled. The default value is false for all services except Lambda. - - - - - The timeout before a TCP keep-alive packet will be sent. The timeout value must be greater - than 0 seconds and not null if Enabled is set to true. The default value is 5 minutes. - - - - - The interval before retrying a TCP keep-alive packet that did not receive an acknowledgement. The - interval must be greater than 0 seconds and not null if Enabled is set to true. The default value is 15 seconds. - - - - - Root AWS config section - - - - - Gets and sets the proxy settings for the SDK to use. - - - - - Settings for configuring a proxy for the SDK to use. - - - - - Gets and sets the host name or IP address of the proxy server. - - - - - Gets and sets the port number of the proxy. - - - - - Gets and sets the username to authenticate with the proxy server. - - - - - Gets and sets the password to authenticate with the proxy server. - - - - - Gets and set the proxy bypass list. A set of semi-colon - delimited regular expressions denoting the addresses that - should bypass the proxy. - - - - - Gets and sets the proxy option to bypass local addresses. - - - - - Logging section - - - - - Easy-to-use generic collection - - - - - - Configuration element that serializes properly when used with collections - - - - - ConfigurationElement class which returns false for IsReadOnly - - - - - Settings for configuring a proxy for the SDK to use. - - - Settings for configuring a proxy for the SDK to use. - - - - - The host name or IP address of the proxy server. - - - - - The port number of the proxy. - - - - - The username to authenticate with the proxy server. - - - - - The password to authenticate with the proxy server. - - - - - Collection of one or more regular expressions denoting addresses - for which the proxy will not be used. - - - For more information on bypass lists - see https://msdn.microsoft.com/en-us/library/system.net.webproxy.bypasslist%28v=vs.110%29.aspx. - - - - - If true requests to local addresses bypass the configured - proxy. - - - - - Settings for logging in the SDK. - - - Settings for logging in the SDK. - - - - - Logging destination. - - - - - When to log responses. - - - - - Gets or sets the size limit in bytes for logged responses. - If logging for response body is enabled, logged response - body is limited to this size. The default limit is 1KB. - - - - - Whether or not to log SDK metrics. - - - - - A custom formatter added through Configuration - - - - - Settings for configuring CSM in the SDK. - - - - - This class can be used to discover the public address ranges for AWS. The - information is retrieved from the publicly accessible - https://ip-ranges.amazonaws.com/ip-ranges.json file. - - - The information in this file is generated from our internal system-of-record and - is authoritative. You can expect it to change several times per week and should - poll accordingly. - - - - - Region identifier string for ROUTE53 and CLOUDFRONT ranges - - - - - Collection of service keys found in the data file. - - - - - The publication date and time of the file that was downloaded and parsed. - - - - - Collection of all public IP ranges. - - - - - Filtered collection of public IP ranges for the given service key - - - - - Filtered collection of public IP ranges for the given region (us-east-1 etc) or GLOBAL. - - - - - Filtered collection of public IP ranges for the given network border group. - - - - - Downloads the most recent copy of the endpoint address file and - parses it to a collection of address range objects. - - - - - Downloads the most recent copy of the endpoint address file and - parses it to a collection of address range objects. - - - - - Represents the IP address range for a single region and service key. - - - - - The public IPv4 or Ipv6 address range, in CIDR notation. - - - - - Indicates ipv4 or v6 format of the address - - - - - The AWS region or GLOBAL for edge locations. Note that the CLOUDFRONT and ROUTE53 - ranges are GLOBAL. - - - - - The subset of IP address ranges. Specify AMAZON to get all IP address ranges - (for example, the ranges in the EC2 subset are also in the AMAZON subset). Note - that some IP address ranges are only in the AMAZON subset. - - - Valid values for the service key include "AMAZON", "EC2", "ROUTE53", - "ROUTE53_HEALTHCHECKS", and "CLOUDFRONT." If you need to know all of - the ranges and don't care about the service, use the "AMAZON" entries. - The other entries are subsets of this one. Also, some of the services, - such as S3, are represented in "AMAZON" and do not have an entry that - is specific to the service. We plan to add additional values over time; - code accordingly! - - - - - The network border group the IP address range belongs to. - - - AWS Local Zones allow you to seamlessly connect to the full range of services in the AWS Region such - as Amazon Simple Storage Service and Amazon DynamoDB through the same APIs and tool sets. You can extend - your VPC Region by creating a new subnet that has a Local Zone assignment. When you create a subnet in - a Local Zone, the VPC is also extended to that Local Zone. - - A network border group is a unique set of Availability Zones or Local Zones from where AWS advertises - public IP addresses. - - When you create a VPC that has IPv6 addresses, you can choose to assign a set of Amazon-provided public - IP addresses to the VPC and also set a network border group for the addresses that limits the addresses - to the group. When you set a network border group, the IP addresses cannot move between network - border groups. The us-west-2 network border group contains the four US West (Oregon) Availability Zones. - The us-west-2-lax-1 network border group contains the Los Angeles Local Zones. - - - - - This class defines utilities and constants that can be used by - all the client libraries of the SDK. - - - - - The user agent string header - - - - - The Set of accepted and valid Url characters per RFC3986. - Characters outside of this set will be encoded. - - - - - The Set of accepted and valid Url characters per RFC1738. - Characters outside of this set will be encoded. - - - - - The set of accepted and valid Url path characters per RFC3986. - - - - - The string representing Url Encoded Content in HTTP requests - - - - - The GMT Date Format string. Used when parsing date objects - - - - - The ISO8601Date Format string. Used when parsing date objects - - - - - The ISO8601Date Format string. Used when parsing date objects - - - - - The ISO8601 Basic date/time format string. Used when parsing date objects - - - - - The ISO8601 basic date format. Used during AWS4 signature computation. - - - - - The RFC822Date Format string. Used when parsing date objects - - - - - Returns an extension of a path. - This has the same behavior as System.IO.Path.GetExtension, but does not - check the path for invalid characters. - - - - - - Convert request parameters to Url encoded query string - - - Convert Dictionary of parameters to Url encoded query string - - - - Returns the canonicalized resource path for the service endpoint with single URL encoded path segments. - - Endpoint URL for the request - Resource path for the request - - If resourcePath begins or ends with slash, the resulting canonicalized - path will follow suit. - - Canonicalized resource path for the endpoint - - - - Returns the canonicalized resource path for the service endpoint - - Endpoint URL for the request - Resource path for the request - If true pre URL encode path segments if necessary. - S3 is currently the only service that does not expect pre URL encoded segments. - - If resourcePath begins or ends with slash, the resulting canonicalized - path will follow suit. - - Canonicalized resource path for the endpoint - - - - Returns the canonicalized resource path for the service endpoint - - Endpoint URL for the request - Resource path for the request - If true pre URL encode path segments if necessary. - S3 is currently the only service that does not expect pre URL encoded segments. - Dictionary of key/value parameters containing the values for the ResourcePath key replacements - The version of the marshaller that constructed the request object. - - If resourcePath begins or ends with slash, the resulting canonicalized - path will follow suit. - - Canonicalized resource path for the endpoint - - - - Splits the resourcePath at / into segments then resolves any keys with the path resource values. Greedy - key values will be split into multiple segments at each /. - - The patterned resourcePath - The key/value lookup for the patterned resourcePath - A list of path segments where all keys in the resourcePath have been resolved to one or more path segment values - - - - Joins all path segments with the / character and encodes each segment before joining. - - The segments of a URL path split at each / character - If the path property is specified, - the accepted path characters {/+:} are not encoded. - A joined URL with encoded segments - - - - Takes a patterned resource path and resolves it using the key/value path resources into - a segmented encoded URL. - - The patterned resourcePath - The key/value lookup for the patterned resourcePath - A segmented encoded URL - - - - Returns a new string created by joining each of the strings in the - specified list together, with a comma between them. - - The list of strings to join into a single, comma delimited - string list. - A new string created by joining each of the strings in the - specified list together, with a comma between strings. - - - - Attempt to infer the region for a service request based on the endpoint - - Endpoint to the service to be called - - Region parsed from the endpoint; DefaultRegion (or DefaultGovRegion) - if it cannot be determined/is not explicit - - - - - Attempt to infer the service name for a request (in short form, eg 'iam') from the - service endpoint. - - Endpoint to the service to be called - - Short-form name of the service parsed from the endpoint; empty string if it cannot - be determined - - - - - Utility method for converting Unix epoch seconds to DateTime structure. - - The number of seconds since January 1, 1970. - Converted DateTime structure - - - - Helper function to format a byte array into string - - The data blob to process - If true, returns hex digits in lower case form - String version of the data - - - - Calls a specific EventHandler in a background thread - - - - - - - - Parses a query string of a URL and returns the parameters as a string-to-string dictionary. - - - - - - - Utility method for converting a string to a MemoryStream. - - - - - - - Utility method for copy the contents of the source stream to the destination stream. - - - - - - - Utility method for copy the contents of the source stream to the destination stream. - - - - - - - - Formats the current date as a GMT timestamp - - A GMT formatted string representation - of the current date and time - - - - - Formats the current date as ISO 8601 timestamp - - An ISO 8601 formatted string representation - of the current date and time - - - - - Gets the ISO8601 formatted timestamp that is minutesFromNow - in the future. - - The number of minutes from the current instant - for which the timestamp is needed. - The ISO8601 formatted future timestamp. - - - - Formats the current date as ISO 8601 timestamp - - An ISO 8601 formatted string representation - of the current date and time - - - - - Gets the RFC822 formatted timestamp that is minutesFromNow - in the future. - - The number of minutes from the current instant - for which the timestamp is needed. - The ISO8601 formatted future timestamp. - - - - Determines whether the given string is an absolute path to a root. - - The hypothetical absolute path. - True if is an absolute path. - - - - Returns true if the path specified is relative to the current drive or working directory. - Returns false if the path is fixed to a specific drive or UNC path. This method does no - validation of the path (URIs will be returned as relative as a result). - - - Handles paths that use the alternate directory separator. It is a frequent mistake to - assume that rooted paths (Path.IsPathRooted) are not relative. This isn't the case. - "C:a" is drive relative- meaning that it will be resolved against the current directory - for C: (rooted, but relative). "C:\a" is rooted and not relative (the current directory - will not be used to modify the path). - - - - - True if the given character is a directory separator. - - - - - Returns true if the given character is a valid drive letter - - - - - URL encodes a string per RFC3986. If the path property is specified, - the accepted path characters {/+:} are not encoded. - - The string to encode - Whether the string is a URL path or not - The encoded string - - - - URL encodes a string per the specified RFC. If the path property is specified, - the accepted path characters {/+:} are not encoded. - - RFC number determing safe characters - The string to encode - Whether the string is a URL path or not - The encoded string - - Currently recognised RFC versions are 1738 (Dec '94) and 3986 (Jan '05). - If the specified RFC is not recognised, 3986 is used by default. - - - - - URL encodes a string per the specified RFC with the exception of preserving the encoding of previously encoded slashes. - If the path property is specified, the accepted path characters {/+:} are not encoded. - - The string to encode - Whether the string is a URL path or not - The encoded string with any previously encoded %2F preserved - - - - Convert bytes to a hex string - - Bytes to convert. - Hexadecimal string representing the byte array. - - - - Convert a hex string to bytes - - Hexadecimal string - Byte array corresponding to the hex string. - - - - Returns DateTime.UtcNow + ManualClockCorrection when - is set. - This value should be used instead of DateTime.UtcNow to factor in manual clock correction - - - - - Returns true if the string has any bidirectional control characters. - - - - - - - Executes an HTTP request and returns the response as a string. This method - throws WebException and HttpRequestException. In the event HttpRequestException - is thrown the StatusCode is sent as user defined data on the exception under - the key "StatusCode". - - The URI to make the request to - The request type: GET, PUT, POST - null or the content to send with the request - Timeout for the request - Proxy for the request - null or any headers to send with the request - The response as a string. - - - - Utility method that accepts a string and replaces white spaces with a space. - - - - - - - Runs a process with the below input parameters. - - - - - - - This method allows to check whether a property of an object returned by a service call - is set. This method is needed to discriminate whether a field is not set (not present in - the service response) or if it is set to the default value for its type. Using this - method is not required for nullable properties (non-ValueType and Nullable) because - they will be simply set to null when not included in the service response. - This method can also be used on objects used as part of service requests. - This method doesn't support objects that are part of the S3 service model. - - An object that is used in an AWS service request or is - returned as part of an AWS service response. - The name of the property of awsServiceObject to check. - True if the property is set, otherwise false. - - - - This method is used preserve the stacktrace used from clients that support async calls. This - make sure that exceptions thrown during EndXXX methods has the orignal stacktrace that happen - in the background thread. - - - - - - Root AWS config - - - - - Wrapper class which invokes the static method - public static string GetEnvironmentVariable(string variable) - underneath. This class is added as a property on the singleton class - EnvironmentVariableSource. This change was done for testability. - - - - - Singleton class that holds the property of type IEnvironmentVariableRetreiver. - This property can hold an instance of type EnvironmentVariableRetreiver which has a wrapper - method for - public static string GetEnvironmentVariable(string variable) - or can be mocked for testing purposes. - - - - - Interface for EnvironmentVariableRetriever. - This serves as a property for the singleton EnvironmentVariableSource - - - - - Manager to access a settings store file. Objects are primarily accessed by DisplayName rather than unique key. - Settings store files are located under the current user's AppData\Local\AWSToolkit folder. - Select keys in these files are encrypted on a per user, per machine basis using the Windows Data Protection API; - the encrypted values cannot be used by any other user or on any other machine. - - This class is not threadsafe. - - - - - True if the encrypted store is availble, false otherwise. - - - - - Construct an NamedSettingsManager. - - The base filename to read/write. - - - - Register an object. Let the uniqueKey be assigned automatically. - - The display name for the object. - The property names and values for the object. - The unique key that was assigned to the object. - - - - Try to get an object form the store. - - The display name for the object. - The property names and values for the object. - True if the object was found, false otherwise. - - - - Try to get an object form the store. - - The display name for the object. - The uniqueKey of the object in the store - The property names and values for the object. - True if the object was found, false otherwise. - - - - Unregister an object from the store. - - The display name for the object. - - - - Rename an object in the store. - - - - if true and destination object already exists overwrite it - - - - Copy an object in the store. - The new object will be a copy of the original, except it will be assigned a new unique key. - - - - if true and destination object already exists overwrite it - - - - Get a list of the display names for the objects in the store. - - A list of display names. - - - - Manager to access a settings store file. - Settings store files are located under the current user's AppData\Local\AWSToolkit folder. - Select keys in these files are encrypted on a per user, per machine basis using the Windows Data Protection API; - the encrypted values cannot be used by any other user or on any other machine. - - This class is not threadsafe. - - - - - True if the encrypted store is availble, false otherwise. - - - - - Construct a SettingsManager. - - The base filename to read/write. - - - - The base filename to read/write. - - - - - Register an object. Let the uniqueKey be assigned automatically. - - The property names and values for the object. - The unique key that was assigned to the object. - - - - Register an object. - - The uniqueKey for the object, or null if one should be assigned automatically. - The property names and values for the object. - The unique key that was assigned to the object. - - - - Try to get an object form the store. - - The uniqueKey of the object in the store - The property names and values for the object. - True if the object was found, false otherwise. - - - - Try to get an object form the store based on the value of a specific property. - If multiple objects with the same property value exist, return the first one. - - The name of the property to search on. - The value of the property to search on. - The unique key of the object. - The properties of the object. - - - - - Get a list of the unique keys of all the objects in the store. - - - - - - Get the value of a specific property for each object in the store. - - - - - - - Unregister an object from the store. - - The unique key for the object. - - - - Class that contains result of executing an external process through the SDKs - AWSSDKUtils.RunProcess/AWSSDKUtils.RunProcessAsync - - - - - The exit code with which the process exited - - - - - The output of the process read till the end - - - - - The error output of the process read till the end - - - - - Object to track circular references in nested types. - At each level of nesting, make a call to Track to retrieve Tracker, - a tracking object implementing the IDisposable interface. - Dispose of this tracker when leaving the context of the tracked object. - - - - - Tracker. Must be disposed. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Adds the current target to a reference list and returns a tracker. - The tracker removes the target from the reference list when the - tracker is disposed. - - - - - - - Provides access to EC2 instance metadata when running on an EC2 instance. - If this class is used on a non-EC2 instance, the properties in this class - will return null. - - - - Amazon EC2 instances can access instance-specific metadata, as well as data supplied when launching the instances, using a specific URI. - - - You can use this data to build more generic AMIs that can be modified by configuration files supplied at launch time. - For example, if you run web servers for various small businesses, they can all use the same AMI and retrieve their content from the - Amazon S3 bucket you specify at launch. To add a new customer at any time, simply create a bucket for the customer, add their content, - and launch your AMI. - - - More information about EC2 Metadata - - - - - - - - - - Allows to configure the proxy used for HTTP requests. The default value is null. - - - - - The AMI ID used to launch the instance. - - - - - The index of this instance in the reservation. - - - - - The manifest path of the AMI with which the instance was launched. - - - - - The AMI IDs of any instances that were rebundled to create this AMI. - Will only exist if the AMI manifest file contained an ancestor-amis key. - - - - - The private hostname of the instance. - In cases where multiple network interfaces are present, - this refers to the eth0 device (the device for which the device number is 0). - - - - - Notifies the instance that it should reboot in preparation for bundling. - Valid values: none | shutdown | bundle-pending. - - - - - The ID of this instance. - - - - - The type of instance. - - - - - The ID of the kernel launched with this instance, if applicable. - - - - - The local hostname of the instance. In cases where multiple network interfaces are present, - this refers to the eth0 device (the device for which device-number is 0). - - - - - The instance's MAC address. In cases where multiple network interfaces are present, - this refers to the eth0 device (the device for which device-number is 0). - - - - - The private IP address of the instance. In cases where multiple network interfaces are present, - this refers to the eth0 device (the device for which device-number is 0). - - - - - The Availability Zone in which the instance launched. - - - - - Product codes associated with the instance, if any. - - - - - Public key. Only available if supplied at instance launch time. - - - - - The ID of the RAM disk specified at launch time, if applicable. - - - - - The region in which the instance is running, extracted from the identity - document data. - - - - - ID of the reservation. - - - - - The names of the security groups applied to the instance. - - - - - Returns information about the last time the instance profile was updated, - including the instance's LastUpdated date, InstanceProfileArn, and InstanceProfileId. - - - - - Returns the temporary security credentials (AccessKeyId, SecretAccessKey, SessionToken, and Expiration) - associated with the IAM roles on the instance. - - - - - The virtual devices associated with the ami, root, ebs, and swap. - - - - - The network interfaces on the instance. - - - - - The metadata sent to the instance. - - - - - Value showing whether the customer has enabled detailed - one-minute monitoring in CloudWatch. - - - - - JSON containing instance attributes, such as instance-id, private IP - address, etc - - - - - Data that can be used by other parties to verify its origin and authenticity. - - - - - Used to verify the document's authenticity and content against the signature. - - - - - Return the list of items in the metadata at path. - - Path at which to query the metadata; may be relative or absolute. - List of items returned by the metadata service - - - - Return the metadata at the path - - Path at which to query the metadata; may be relative or absolute. - Data returned by the metadata service - - - - Return the metadata at the path - - Path at which to query the metadata; may be relative or absolute. - Number of attempts to make - Data returned by the metadata service - - - - Return the list of items in the metadata at path. - - Path at which to query the metadata; may be relative or absolute. - Number of attempts to make - List of items returned by the metadata service - - - - Fetches the api token to use with metadata requests. - - The API token or null - - - - Fetches the api token to use with metadata requests. - - The number of tries to fetch the api token before giving up and throwing the web exception - The API token or null if an API token couldn't be obtained and doesn't need to be used - - - - Exponentially sleeps based on the current retry value. A lower - value will sleep shorter than a larger value - - Base 0 retry index - - - - Returns information about the last time the instance profile was updated, - including the instance's LastUpdated date, InstanceProfileArn, and InstanceProfileId. - - - - - The status of the instance profile - - - - - Further information about the status of the instance profile - - - - - The date and time the instance profile was updated - - - - - The Amazon Resource Name (ARN) of the instance profile - - - - - The Id of the instance profile - - - - - The temporary security credentials (AccessKeyId, SecretAccessKey, SessionToken, and Expiration) associated with the IAM role. - - - - - The status of the security credential - - - - - Further information about the status of the instance profile - - - - - The date and time the security credential was last updated - - - - - The type of the security credential - - - - - The uniqe id of the security credential - - - - - The secret key used to sign requests - - - - - The security token - - - - - The date and time when these credentials expire - - - - - All of the metadata associated with a network interface on the instance. - - - - - Construct an instance of NetworkInterface - - - - - - The interface's Media Access Control (mac) address. - - - - - The ID of the owner of the network interface. - - - In multiple-interface environments, an interface can be attached by a third party, such as Elastic Load Balancing. - Traffic on an interface is always billed to the interface owner. - - - - - The interface's profile - - - - - The interface's local hostname. - - - - - The private IP addresses associated with the interface. - - - - - The interface's public hostname. - - - - - The elastic IP addresses associated with the interface. - - - There may be multiple IP addresses on an instance. - - - - - Security groups to which the network interface belongs. - - - - - IDs of the security groups to which the network interface belongs. Returned only for Amazon EC2 instances launched into a VPC. - - - - - The ID of the Amazon EC2-VPC subnet in which the interface resides. - - - Returned only for Amazon EC2 instances launched into a VPC. - - - - - The CIDR block of the Amazon EC2-VPC subnet in which the interface resides. - - - Returned only for Amazon EC2 instances launched into a VPC. - - - - - The CIDR block of the Amazon EC2-VPC subnet in which the interface resides. - - - Returned only for Amazon EC2 instances launched into a VPC. - - - - - Get the private IPv4 address(es) that are associated with the public-ip address and assigned to that interface. - - The public IP address - Private IPv4 address(es) associated with the public IP address - - - - This class allows profiles supporting AWS credentials and SAML-based authentication to be registered with - the SDK so that they can later be reference by a profile name. The credential profiles will be available - for use in the AWS Toolkit for Visual Studio and the AWS Tools for Windows PowerShell. - - The credentials are stored under the current users AppData folder encrypted using Windows Data Protection API. - - - To reference a profile from an application's App.config or Web.config use the AWSProfileName setting. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="development"/> - </appSettings> - </configuration> - - - - - - - Registers an AWS credentials profile that can later be referenced by the profileName. - This profile will only be visible for the current user. - - Name given to the AWS credentials. - The AWS access key id - The AWS secret key - - - - - Registers a role-based profile to be used with SAML authentication. The profile contains - details of the role to be assumed when AWS credentials are requested based on the role and - a reference to a SAML endpoint profile containing details of the endpoint to be called to - authenticate the user. - - - If user identity information is not supplied then the identity of the logged-in user will - be used when authenticaton is performed against the endpoint referenced in the SAML endpoint - profile. If identity is provided, no password information is stored in the role profile and - the user must supply the password for the identity prior to authentication with the endpoint. - - - Name to be assigned to the profile - - The name assigned to the endpoint settings, previously saved with RegisterSAMLEndpoint. - - - The arn of the role that the user wants to assume when using this profile. This - must be one of the set returned by the saml endpoint when the user authenticates. - - - Optional. By default the identity of the logged-in user will be used when authentication - is performed - the user will not be prompted to supply a password. By supplying a custom - identity for this parameter, the user will be prompted to supply the password for the - identity prior to authentication. - - - - - - Registers a role-based profile to be used with SAML authentication. The profile contains - details of the role to be assumed when AWS credentials are requested based on the role and - a reference to a SAML endpoint profile containing details of the endpoint to be called to - authenticate the user. - - - If user identity information is not supplied then the identity of the logged-in user will - be used when authenticaton is performed against the endpoint referenced in the SAML endpoint - profile. If identity is provided, no password information is stored in the role profile and - the user must supply the password for the identity prior to authentication with the endpoint. - - - Name to be assigned to the profile - - The name assigned to the endpoint settings, previously saved with RegisterSAMLEndpoint. - - - The arn of the role that the user wants to assume when using this profile. This - must be one of the set returned by the saml endpoint when the user authenticates. - - - Optional. By default the identity of the logged-in user will be used when authentication - is performed - the user will not be prompted to supply a password. By supplying a custom - identity for this parameter, the user will be prompted to supply the password for the - identity prior to authentication. - - - Set for profiles intended to be used in regions where a region-specific STS endpoint - must be used (eg cn-north-1). If left empty/null, the global sts.amazonaws.com endpoint - will be used when credentials are obtained for this profile. - - - - - Registers an endpoint to be used in conjunction with SAML role profiles. The role profiles - reference the endpoint settings to obtain the actual endpoint and any customization settings - needed to perform authentication. - - Name to be assigned to the endpoint settings. - The full uri of the authentication endpoint. - - The authentication type to use when performing calls against the endpoint. Valid values are 'NTLM', - 'Digest', 'Kerberos' and 'Negotiate'. The default if not configured (null/empty string) is 'Kerberos'. - - The unique id assigned to the new settings. - - - - Deletes the settings for an AWS credentials or SAML role profile from the SDK account store. - - The name of the profile to remove. - - - - Lists all profile names registered with the SDK account store. - - The profile names. - - - - Loads and returns all available credential profiles registered in the store. - - Collection of profiles. - - - - Checks if a given profile is known in the SDK credential store. - - The name of the profile to test for existence - True if the profile exists. - - - - Copies the contents of the source profile to the destination. If the destination - profile does not exist a new profile is created. Note that if the destination - profile exists, all keys it contains are removed and replaced with keys from the - source profile. - - The name of the profile to copy from. - The name of the profile to create or update. - The unique id assigned to the destination settings. - - - - Copies the contents of the source profile to the destination. If the destination - profile does not exist a new profile is created. Note that if the destination - profile exists, all keys it contains are removed and replaced with keys from the - source profile. - - The source profile to copy keys and values from. - The name of the profile to create or update. - The unique id assigned to the destination settings. - - - - Tries to get the AWS credentials from a profile in the SDK account store. - - The profile to get the credentials for. - Outputs the credentials for the profile. - Returns true if the profile exists otherwise false is returned. - - - - Gets the AWS credentials from a profile in the SDK account store. - - The profile to get the credentials for. - The AWS credentials for the profile. - Thrown if the profile does not exist - - - - Returns the profile with the specified name, if it has been registered in the SDK store. - - The name of the registered profile - The loaded profile data - - - - Returns the persisted data in the SDK store as a profile of the specified type T. - - The name of the profile holding the settings. - The loaded profile. An exception is thrown if the profile could not be loaded. - Thrown if the profile does not exist - - Currently supported profile types: AWSCredentialsProfile and SAMLRoleProfile. - - - - - Tries to load the specified profile data corresponding to profile type T from a named - profile in the SDK account store. - - The name of the profile holding the settings. - The loaded profile data. - Returns true if the profile exists otherwise false is returned. - - Currently supported profile types: AWSCredentialsProfile and SAMLRoleProfile. - - - - - Attempts to load the settings defining a SAML endpoint. - - The name assigned to the settings for the endpoint. - The instantiated endpoint. - True if the settings were successfully loaded. - - - - Loads the settings defining a SAML endpoint. - - The name assigned to the settings for the endpoint. - The loaded settings. An exception is thrown if they could not be loaded. - Thrown if the endpoint settings do not exist. - - - - Common base contract for all types of credential and role profiles. - - - - - The user-defined name for the settings. - - - - - The unique id of the profile in the backing store. - - - - - Saves the profile data to backing store, returning the unique id - assigned to the data. - - - - - The persisted data for a set of AWS credentials. At a minimum this - is access key and secret key data. - - - - - Tests if an AWSCredentialsProfile instance could be instantiated from - the persisted settings data. - - The name given to the persisted settings (previously verified as existing). - True if the settings are compatible with an AWSCredentialsProfile type. - - - - Tests if an AWSCredentialsProfile instance could be instantiated from - the persisted settings data. - - The persisted settings. - True if the settings are compatible with an AWSCredentialsProfile type. - - - - Instantiates an AWSCredentialsProfile instance from the specified profile name. - - The name of the profile holding the settings. - New credentials profile instance. An exception is thrown if the profile data is invalid. - - - - Instantiates an AWSCredentialsProfile instance from the supplied settings collection. - - The settings representing the stored profile. - New credentials profile instance. An exception is thrown if the profile data is invalid. - - - - Validates the contents of the specified profile. - - The name of the AWS credentials profile to validate. - Thrown if the profile settings fail to validate. - - - - Verifies that the persisted settings contains the minimal viable data to - instantiate an AWSCredentialsProfile instance. - - The persisted settings. - Thrown if the profile settings fail to validate. - - - - Persists the profile data to the store file. - - The unique ID assigned to the settings. - - - - Creates or updates the profile data in the store file. - - The unique ID assigned to the settings. - - - - The persisted data for a SAML endpoint. One or more role profiles - will reference this to obtain the common endpoint and other data needed - to perform authentication with a set of user credentials. - - - - - The default authentication type to use when attempting to perform an - authentication call against the configured endpoint. - - - - - The authentication endpoint which must be a HTTPS scheme. - - - - - The authentication type to use when calling the endpoint. - - - - - Tests if a SAMLEndpointSettings instance could be instantiated from - the persisted settings data. - - The name given to the persisted settings. - True if the settings are compatible. - - - - Tests if a SAMLEndpointSettings instance could be instantiated from - the persisted settings data. - - The persisted settings. - True if the settings are compatible. - - - - Instantiates an instance from settings stored with the specified name. - - The name of the endpoint settings in the store. - Profile instance or an exception if the profile data does not exist/contains invalid data. - - - - Instantiates an instance from the supplied settings. - - The persisted settings. - Profile instance or an exception if the profile data is invalid. - - - - Validates the contents of the specified endpoint settings. - - The name of the SAML endpoint settings to validate. - Thrown if the settings fail to validate. - - - - Verifies that the persisted settings contains the minimal viable data to - instantiate a SAMLEndpointSettings instance. - - The persisted settings. - Thrown if the settings fail to validate. - - - - Persists the settings to the storage file. - - The unique id assigned to the profile - - - - Creates or updates the settings data for a SAML endpoint in the backing store file. An error is - thrown if the scheme for the endpoint is not https. - - The name of the settings to create or update - The authentication endpoint - Optional authentication type to use when performing calls against the endpoint - The unique id assigned to the profile - - - - Constructs an endpoint settings instance. - - The user-defined name to assign to the settings. - - The absolute uri, including any query and relyingParty data, of the endpoint. - - - The authentication type to use when performing requests against the endpoint. - - - - - - The persisted data for a saml role profile for a user. This profile - references an endpoint profile containing the actual endpoint to be used, and - adds details of the role to be assumed when the profile is selected. - - - Optionally the profile can store a username and domain to be used during - authentication (default behavior, if this is not specified, is to use the user's - default network credentials). - - - - - - The ARN of the role that is to be assumed. - - - - - If non-default network credentials are to used contains - the user identity (in domain\user format, domain optional) that - should be used to supply credentials when the profile is used in - authentication. The user must be prompted to supply the - corresponding password prior to authentication. - - - - - If a specific user identity was specified in the profile, - returns true to indicate a password needs to be obtained from - the user before obtaining network credentials to be used on - authentication. The default is to use the credentials - associated with the currently logged-in user or process to - perform authentication, which does not require the user to be - prompted. - - - - - - For regions with a region-specific endpoint for STS (eg cn-north-1) this - field can be set to ensure calls to obtain temporary credentials - after successful authentication are forwarded to the correct regional - endpoint. - - - This field does not need to be set when running in a region for - which the sts.amazonaws.com endpoint is valid. - - - - - - Retrieves the active credential session, if any, associated with the - role profile. - - - The current credentials valid for the role specified in the profile. Returns - null if no active session is available, or the active session has expired. - - - When a user successfully authenticates and receives temporary AWS - credentials for a role, the profile is updated with details of the - session. When the profile is loaded by other processes or tools, if - session data is present and still valid it can be retrieved using this - method avoiding the need to re-authenticate and get additional temporary - credentials. - - - - - Persists the current credentials to a 'session' key in the RoleSessions.json file. - This enables external applications and tools using the same profile to obtain credentials - without needing to separately re-authenticate the user prior to expiry of the current - credentials. After persisting the session data it can be retrieved using GetCurrentSession(). - - - Although the credentials are temporary we still encrypt the stored data when at rest in - the sdk credential store. - - - The current credentials valid for the role specified in the profile. - - - - - Stores or clears the persisted session data. - - - - - - The endpoint settings from which the actual endpoint to use in authentication - is obtained. - - - - - Tests if a SAMLRoleProfile instance could be instantiated from - the persisted settings data. - - The name given to the persisted settings. - True if the settings are compatible with a SAMLRoleProfile type. - - - - Tests if a SAMLRoleProfile instance could be instantiated from - the persisted settings data. - - The persisted settings. - True if the settings are compatible with a SAMLRoleProfile type. - - - - Instantiates an instance from settings stored with the specified name. - - The name of the endpoint profile. - Profile instance or an exception if the profile data does not exist/contains invalid data. - - - - Instantiates an instance from the supplied settings. In addition to the profile settings - the SDK will inspect for a RoleSessions.json file containing active session data and if - an entry for the profile is present, will add the session data to the returned profile - object. - - The persisted settings. - Profile instance or an exception if the profile data is invalid. - - - - Validates the contents of the specified profile. - - The name of the SAML role profile to validate. - Thrown if the profile settings fail to validate. - - - - Validates that the presented settings would result in a valid role profile - instance. - - The persisted settings. - Thrown if the profile settings fail to validate. - - - - Stores the data in the role profile to the backing store file. - - - - - - Registers a role-based profile to be used with SAML authentication. The profile contains - details of the role to be assumed when AWS credentials are requested based on the role and - a reference to a SAML endpoint profile containing details of the endpoint to be called to - authenticate the user. - - - If user identity information is not supplied then the identity of the logged-in user will - be used when authenticaton is performed against the endpoint referenced in the SAML endpoint - profile. If identity is provided, no password information is stored in the role profile and - the user must supply the password for the identity prior to authentication with the endpoint. - - - Name to be assigned to the profile - - The name of the settings in the SAML endpoints file containing details of the - endpoint to authenticate with. - - - The arn of the role that the user wants to assume when using this profile. This - must be one of the set returned by the saml endpoint when the user authenticates. - - - Optional, can be used to prompt the user for a password for the account when authentication - is performed from a system that is not domain-joined. - - - Optional, details of the currently active credentials for the role that we want to - persist into the profile for other tools or processes to pick up, avoiding the need - to continually re-authenticate the user as they switch between tools. The active session, - if any, is stored separately from the profile using the file RoleSessions.json. - - - Set for profiles intended to be used in regions where a region-specific STS endpoint - must be used (eg cn-north-1). If left empty/null, the global sts.amazonaws.com endpoint - will be used when credentials are obtained for this profile. - - The unique id assigned to the profile. - - - - Tests for and loads any active session credentials for the specified profile. The session data - exists in a separate file from the profile, RoleSessions.json. - - - - - - - Stores the supplied session data into the RoleSessions.json backing file. - - - - - - - Constructs a profile data instance that will use the specified network identity - during authentication with configured endpoint. - - The user-defined name of the profile that sourced this data. - The settings for the authentication endpoint. - The role that should be assumed on successful authentication. - The credentials to supply in authentication, in domain\user format. - - Deserialized credential data from the profile, if still valid. Null if the profile does not - contain any active credentials, or the credentials it did hold are now invalid. - - - Set for profiles intended to be used in regions where a region-specific STS endpoint - must be used (eg cn-north-1). If left empty/null, the global sts.amazonaws.com endpoint - will be used when credentials are obtained for this profile. - - - - - Utility class to parse Amazon resource names more commonly known as an ARN. - - - - - Gets and sets the partition associated with the ARN (e.g.: 'aws'). - - - - - Gets and sets the AWS service associated with the ARN (e.g.: 's3'). - - - - - Gets and sets the region associated with the ARN (e.g.: 'us-east-1'). - - - - - Gets and sets the account ID associated with the ARN. - - - - - Gets and sets the resource associated with the ARN (e.g.: 'mybucket/myobject'). - - - - - Returns true if the string appears to be an ARN by seeing if the string starts with "arn:". This method - doesn't guarantee the string is a valid ARN. To validate the string call TryParse. - - - - - - - Parses the string into an ARN object. - - String to parse into an ARN. - The out parameter for the ARN object created by TryParse. - True if the string was parsed into an ARN object. - - - - Parses the string into an ARN object. - - String to parse into an Arn. - The Arn object created from the passed in string. - Thrown if arnString is null. - Thrown if the string passed in not valid ARN. - - - - Turns the Arn object into a string representation of an ARN. - - - - - - Configuration options that apply to the entire SDK. - - These settings can be configured through app.config or web.config. - Below is a full sample configuration that illustrates all the possible options. - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws region="us-west-2"> - <logging logTo="Log4Net, SystemDiagnostics" logResponses="Always" logMetrics="true" /> - <s3 useSignatureVersion4="true" /> - <proxy host="localhost" port="8888" username="1" password="1" /> - - <dynamoDB> - <dynamoDBContext tableNamePrefix="Prod-"> - - <tableAliases> - <alias fromTable="FakeTable" toTable="People" /> - <alias fromTable="Persons" toTable="People" /> - </tableAliases> - - <mappings> - <map type="Sample.Tests.Author, SampleDLL" targetTable="People" /> - <map type="Sample.Tests.Editor, SampleDLL" targetTable="People"> - <property name="FullName" attribute="Name" /> - <property name="EmployeeId" attribute="Id" /> - <property name="ComplexData" converter="Sample.Tests.ComplexDataConverter, SampleDLL" /> - <property name="Version" version="true" /> - <property name="Password" ignore="true" /> - </map> - </mappings> - - </dynamoDBContext> - </dynamoDB> - </aws> - - - - Configuration options that apply to the entire SDK. - - - - - Manual offset to apply to client clock. This is a global setting that overrides - ClockOffset value calculated for all service endpoints. - - - - - Determines if the SDK should correct for client clock skew - by determining the correct server time and reissuing the - request with the correct time. - Default value of this field is True. - will be updated with the calculated - offset even if this field is set to false, though requests - will not be corrected or retried. - Ignored if is set. - - - - - The calculated clock skew correction, if there is one. - This field will be set if a service call resulted in an exception - and the SDK has determined that there is a difference between local - and server times. - - If is set to true, this - value will be set to the correction, but it will not be used by the - SDK and clock skew errors will not be retried. - - - - - Key for the AWSRegion property. - - - - - - Configures the default AWS region for clients which have not explicitly specified a region. - Changes to this setting will only take effect for newly constructed instances of AWS clients. - - This setting can be configured through the App.config. For example: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws region="us-west-2" /> - - - - - - Key for the AWSProfileName property. - - - - - - Profile name for stored AWS credentials that will be used to make service calls. - Changes to this setting will only take effect in newly-constructed clients. - - To reference the account from an application's App.config or Web.config use the AWSProfileName setting. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="development"/> - </appSettings> - </configuration> - - - - - - - Key for the AWSProfilesLocation property. - - - - - - Location of the credentials file shared with other AWS SDKs. - By default, the credentials file is stored in the .aws directory in the current user's home directory. - - Changes to this setting will only take effect in newly-constructed clients. - - To reference the profile from an application's App.config or Web.config use the AWSProfileName setting. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfilesLocation" value="c:\config"/> - </appSettings> - </configuration> - - - - - - - Key for the Logging property. - - - - - - Configures how the SDK should log events, if at all. - Changes to this setting will only take effect in newly-constructed clients. - - The setting can be configured through App.config, for example: - - <appSettings> - <add key="AWSLogging" value="log4net"/> - </appSettings> - - - - - - Key for the ResponseLogging property. - - - - - - - Configures when the SDK should log service responses. - Changes to this setting will take effect immediately. - - The setting can be configured through App.config, for example: - - <appSettings> - <add key="AWSResponseLogging" value="OnError"/> - </appSettings> - - - - - - Key for the LogMetrics property. - - - - - - Configures if the SDK should log performance metrics. - This setting configures the default LogMetrics property for all clients/configs. - Changes to this setting will only take effect in newly-constructed clients. - - The setting can be configured through App.config, for example: - - <appSettings> - <add key="AWSLogMetrics" value="true"/> - </appSettings> - - - - - - Key for the EndpointDefinition property. - - - - - - Configures if the SDK should use a custom configuration file that defines the regions and endpoints. - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws endpointDefinition="c:\config\endpoints.json" /> - - - - - - Key for the UseSdkCache property. - - - - - - Configures if the SDK Cache should be used, the default value is true. - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws useSdkCache="true" /> - - - - - - Configuration for the Logging section of AWS configuration. - Changes to some settings may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws> - <logging logTo="Log4Net, SystemDiagnostics" logResponses="Always" logMetrics="true" /> - </aws> - - - - - - Configuration for the Proxy section of AWS configuration. - Changes to some settings may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws> - <proxy host="localhost" port="8888" username="1" password="1" bypassList="addressexpr1;addressexpr2;..." bypassOnLocal="true" /> - </aws> - - - - - - When set to true, the service client will use the x-amz-user-agent - header instead of the User-Agent header to report version and - environment information to the AWS service. - - Note: This is especially useful when using a platform like WebAssembly - which doesn't allow to specify the User-Agent header. - - - - - Configuration for the region endpoint section of AWS configuration. - Changes may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws region="us-west-2" /> - - - - - - Lock for SomeEvent delegate access. - - - - - This method should never be called directly. - Call AWSSDKUtils.CorrectedUtcNow instead. - - - - - - The unique application name for the current application. This values is currently used - by high level APIs (Mobile Analytics Manager and Cognito Sync Manager) to create a unique file - path to store local database files. - Changes to this setting will only take effect in newly-constructed objects using this property. - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws applicationName="" /> - - - - - - Add a listener for SDK logging. - - If the listener does not have a name, you will not be able to remove it later. - The source to log for, e.g. "Amazon", or "Amazon.DynamoDB". - The listener to add. - - - - Remove a trace listener from SDK logging. - - The source the listener was added to. - The name of the listener. - - - - Generates a sample XML representation of the SDK configuration section. - - - The XML returned has an example of every tag in the SDK configuration - section, and sample input for each attribute. This can be included in - an App.config or Web.config and edited to suit. Where a section contains - a collection, multiple of the same tag will be output. - - Sample XML configuration string. - - - - Logging options. - Can be combined to enable multiple loggers. - - - - - No logging - - - - - Log using log4net - - - - - Log using System.Diagnostics - - - - - Log to the console - - - - - Response logging option. - - - - - Never log service response - - - - - Only log service response when there's an error - - - - - Always log service response - - - - - Format for metrics data in the logs - - - - - Emit metrics in human-readable format - - - - - Emit metrics as JSON data - - - - - Allows to configure the proxy used for HTTP requests. The default value is null. - - - - - This class contains the endpoints available to the AWS clients. The static constants representing the - regions can be used while constructing the AWS client instead of looking up the exact endpoint URL. - - - - - Gets the endpoint for a service in a region. - - The services system name. - If true returns the endpoint for dualstack - Thrown when the request service does not have a valid endpoint in the region. - - - - - Enumerate through all the regions. - - - - - Gets the region based on its system name like "us-west-1" - - The system name of the service like "us-west-1" - - - - - This is a testing method and should not be called by production applications. - - - - - Gets the system name of a region. - - - - - Gets the display name of a region. - - - - - This region name is non-standard. Search the whole endpoints.json file to - determine the partition this region is in. - - - - - This class contains region information used to lazily compute the service endpoints. The static constants representing the - regions can be used while constructing the AWS client instead of looking up the exact endpoint URL. - - - - - The US East (Virginia) endpoint. - - - - - The US East (Virginia) regional endpoint. - - - - - The US East (Ohio) endpoint. - - - - - The US West (N. California) endpoint. - - - - - The US West (Oregon) endpoint. - - - - - The EU North (Stockholm) endpoint. - - - - - The EU West (Ireland) endpoint. - - - - - The EU West (London) endpoint. - - - - - The EU West (Paris) endpoint. - - - - - The EU Central (Frankfurt) endpoint. - - - - - The Europe (Milan) endpoint. - - - - - The Asia Pacific (Hong Kong) endpoint. - - - - - The Asia Pacific (Tokyo) endpoint. - - - - - The Asia Pacific (Seoul) endpoint. - - - - - The Asia Pacific (Osaka-Local) endpoint. - - - - - The Asia Pacific (Mumbai) endpoint. - - - - - The Asia Pacific (Singapore) endpoint. - - - - - The Asia Pacific (Sydney) endpoint. - - - - - The South America (Sao Paulo) endpoint. - - - - - The US GovCloud East (Virginia) endpoint. - - - - - The US GovCloud West (Oregon) endpoint. - - - - - The China (Beijing) endpoint. - - - - - The China (Ningxia) endpoint. - - - - - The Canada (Central) endpoint. - - - - - The Middle East (Bahrain) endpoint. - - - - - The Africa (Cape Town) endpoint. - - - - - Represents the endpoint overridding rules in the endpoints.json - Is used to map private region (ie us-east-1-regional) to public regions (us-east-1) - For signing purposes. - - - - - Enumerate through all the regions. - - - - - Gets the region based on its system name like "us-west-1" - - The system name of the service like "us-west-1" - - - - - Gets the region endpoint override if exists - - The region endpoint to find the possible override for - - - - - Gets the system name of a region. - - - - - Gets the display name of a region. - - - - - Gets the partition name the region is in. For example for us-east-1 the partition name is aws. For cn-northwest-1 the partition name is aws-cn. - - - - - Gets the dns suffix for the region endpoints in a partition. For example the aws partition's suffix is amazonaws.com. The aws-cn partition's suffix is amazonaws.com.cn. - - - - - Gets the endpoint for a service in a region. - - - The services system name. Service system names can be obtained from the - RegionEndpointServiceName member of the ClientConfig-derived class for the service. - - - For forwards compatibility, if the service being requested for isn't known in the region, this method - will generate an endpoint using the AWS endpoint heuristics. In this case, it is not guaranteed the - endpoint will point to a valid service endpoint. - - - - - - Gets the endpoint for a service in a region, optionally selecting a dualstack compatible endpoint. - - - The services system name. Service system names can be obtained from the - RegionEndpointServiceName member of the ClientConfig-derived class for the service. - - - If true a dualstack endpoint is returned. It is the user's responsibility to verify that the given service - supports a dualstack endpoint for the region. - - - For forwards compatibility, if the service being requested for isn't known in the region, this method - will generate an endpoint using the AWS endpoint heuristics. In this case, it is not guaranteed the - endpoint will point to a valid service endpoint. - - - - - - This class defines an endpoints hostname and which protocols it supports. - - - - - Gets the hostname for the service. - - - - - The authentication region to be used in request signing. - - - - - This property is only set for S3 endpoints. For all other services this property returns null. - For S3 endpoints, if the endpoint supports signature version 2 this property will be "2", otherwise it will be "4". - - - - - Calculates a 32bit Cyclic Redundancy Checksum (CRC) using the - same polynomial used by Zip. This type is used internally by DotNetZip; it is generally not used directly - by applications wishing to create, read, or manipulate zip archive files. - - - - - indicates the total number of bytes read on the CRC stream. - This is used when writing the ZipDirEntry when compressing files. - - - - - Indicates the current CRC for all blocks slurped in. - - - - - Returns the CRC32 for the specified stream. - - The stream over which to calculate the CRC32 - the CRC32 calculation - - - - Returns the CRC32 for the specified stream, and writes the input into the output stream. - - The stream over which to calculate the CRC32 - The stream into which to deflate the input - the CRC32 calculation - - - - Get the CRC32 for the given (word,byte) combo. - This is a computation defined by PKzip. - - The word to start with. - The byte to combine it with. - The CRC-ized result. - - - - Update the value for the running CRC32 using the given block of bytes. - This is useful when using the CRC32() class in a Stream. - - block of bytes to slurp - starting point in the block - how many bytes within the block to slurp - - - - A Stream that calculates a CRC32 (a checksum) on all bytes read, - or on all bytes written. - - - - - This class can be used to verify the CRC of a ZipEntry when reading from a stream, - or to calculate a CRC when writing to a stream. The stream should be used to either - read, or write, but not both. If you intermix reads and writes, the results are - not defined. - - This class is intended primarily for use internally by the DotNetZip library. - - - - - Gets the total number of bytes run through the CRC32 calculator. - - - - This is either the total number of bytes read, or the total number - of bytes written, depending on the direction of this stream. - - - - - The constructor. - - The underlying stream - - - - The constructor. - - The underlying stream - The length of the stream to slurp - - - - Provides the current CRC for all blocks slurped in. - - - - - Read from the stream - - the buffer to read - the offset at which to start - the number of bytes to read - the number of bytes actually read - - - - Write to the stream. - - the buffer from which to write - the offset at which to start writing - the number of bytes to write - - - - Indicates whether the stream supports reading. - - - - - Indicates whether the stream supports seeking. - - - - - Indicates whether the stream supports writing. - - - - - Flush the stream. - - - - - Not implemented. - - - - - Not implemented. - - - - - Not implemented. - - N/A - N/A - N/A - - - - Not implemented. - - N/A - - - a general purpose ASN.1 decoder - note: this class differs from the - others in that it returns null after it has read the last object in - the stream. If an ASN.1 Null is encountered a Der/BER Null object is - returned. - - - Create an ASN1InputStream where no DER object will be longer than limit. - - @param input stream containing ASN.1 encoded data. - @param limit maximum size of a DER encoded object. - - - Create an ASN1InputStream based on the input byte array. The length of DER objects in - the stream is automatically limited to the length of the input array. - - @param input array containing ASN.1 encoded data. - - - build an object given its tag and the number of bytes to construct it from. - - - Create a base ASN.1 object from a byte array. - The byte array to parse. - The base ASN.1 object represented by the byte array. - If there is a problem parsing the data. - - - Read a base ASN.1 object from a stream. - The stream to parse. - The base ASN.1 object represented by the byte array. - If there is a problem parsing the data. - - - return the object at the sequence position indicated by index. - - @param index the sequence number (starting at zero) of the object - @return the object at the sequence position indicated by index. - - - create an empty sequence - - - create a sequence containing one object - - - create a sequence containing a vector of objects. - - - - A - - - - - - A - - - A - - - - - - A - - - - - return a = a + b - b preserved. - - - unsigned comparison on two arrays - note the arrays may - start with leading zeros. - - - returns x = x - y - we assume x is >= y - - - diff --git a/packages/AWSSDK.Core.3.3.107.14/lib/net45/AWSSDK.Core.dll b/packages/AWSSDK.Core.3.3.107.14/lib/net45/AWSSDK.Core.dll deleted file mode 100644 index c392f68..0000000 Binary files a/packages/AWSSDK.Core.3.3.107.14/lib/net45/AWSSDK.Core.dll and /dev/null differ diff --git a/packages/AWSSDK.Core.3.3.107.14/lib/net45/AWSSDK.Core.xml b/packages/AWSSDK.Core.3.3.107.14/lib/net45/AWSSDK.Core.xml deleted file mode 100644 index 4ebe211..0000000 --- a/packages/AWSSDK.Core.3.3.107.14/lib/net45/AWSSDK.Core.xml +++ /dev/null @@ -1,15413 +0,0 @@ - - - - AWSSDK.Core - - - - - An access control policy action identifies a specific action in a service - that can be performed on a resource. For example, sending a message to a - queue. - - ActionIdentifiers allow you to limit what your access control policy statement affects. - For example, you could create a policy statement that enables a certain group - of users to send messages to your queue, but not allow them to perform any - other actions on your queue. - - - The action is B in the statement - "A has permission to do B to C where D applies." - - Free form access control policy actions may include a wildcard (*) to match - multiple actions. - - - Constants for known actions can be found in the Amazon.Auth.AccessControlPolicy.ActionIdentifiers namespace. - - - - - - Constructs an Actionidentifer with the given action name. - - The name of the action - - - - Gets and sets the name of this action. For example, 'sqs:SendMessage' is the - name corresponding to the SQS action that enables users to send a message - to an SQS queue. - - - - - The available AWS access control policy actions for Amazon AppStream. - - - - - - The available AWS access control policy actions for Auto Scaling. - - - - - - The available AWS access control policy actions for AWS Billing. - - - - - - The available AWS access control policy actions for AWS CloudFormation. - - - - - - The available AWS access control policy actions for Amazon CloudFront. - - - - - - The available AWS access control policy actions for Amazon CloudSearch. - - - - - - The available AWS access control policy actions for AWS CloudTrail. - - - - - - The available AWS access control policy actions for Amazon CloudWatch. - - - - - - The available AWS access control policy actions for Amazon CloudWatch Logs. - - - - - - The available AWS access control policy actions for Amazon Cognito Identity. - - - - - - The available AWS access control policy actions for Amazon Cognito Sync. - - - - - - The available AWS access control policy actions for AWS Direct Connect. - - - - - - The available AWS access control policy actions for Amazon DynamoDB. - - - - - - The available AWS access control policy actions for Amazon EC2. - - - - - - The available AWS access control policy actions for AWS ElastiCache. - - - - - - The available AWS access control policy actions for AWS Elastic Beanstalk. - - - - - - The available AWS access control policy actions for Elastic Load Balancing. - - - - - - The available AWS access control policy actions for Amazon Elastic MapReduce. - - - - - - The available AWS access control policy actions for Amazon Elastic Transcoder. - - - - - - The available AWS access control policy actions for Amazon Glacier. - - - - - - The available AWS access control policy actions for AWS Identity and Access Management. - - - - - - The available AWS access control policy actions for AWS Import Export. - - - - - - The available AWS access control policy actions for Amazon Kinesis. - - - - - - The available AWS access control policy actions for AWS Marketplace. - - - - - - The available AWS access control policy actions for AWS Marketplace Management Portal. - - - - - - The available AWS access control policy actions for Amazon Mobile Analytics. - - - - - - The available AWS access control policy actions for AWS OpsWorks. - - - - - - The available AWS access control policy actions for Amazon RDS. - - - - - - The available AWS access control policy actions for Amazon Redshift. - - - - - - The available AWS access control policy actions for Amazon Route 53. - - - - - - The available AWS access control policy actions for Amazon S3. - - - - - - The available AWS access control policy actions for AWS Security Token Service. - - - - - - The available AWS access control policy actions for Amazon SES. - - - - - - The available AWS access control policy actions for Amazon SimpleDB. - - - - - - The available AWS access control policy actions for Amazon Simple Workflow Service. - - - - - - The available AWS access control policy actions for Amazon SNS. - - - - - - The available AWS access control policy actions for Amazon SQS. - - - - - - The available AWS access control policy actions for Amazon Storage Gateway. - - - - - - The available AWS access control policy actions for AWS Whispersync. - - - - - - The available AWS access control policy actions for Amazon Zocalo. - - - - - - AWS access control policy conditions are contained in - objects, and affect when a statement is applied. For example, a statement - that allows access to an Amazon SQS queue could use a condition to only apply - the effect of that statement for requests that are made before a certain - date, or that originate from a range of IP addresses. - - Multiple conditions can be included in a single statement, and all conditions - must evaluate to true in order for the statement to take effect. - - - The set of conditions is D in the statement - "A has permission to do B to C where D applies." - - - A condition is composed of three parts: - - - Condition Key - The condition key declares which value of a - request to pull in and compare against when a policy is evaluated by AWS. For - example, using will cause - AWS to pull in the current request's source IP as the first value to compare - against every time your policy is evaluated. - - - - Comparison Type - This is a static value used as the second value - in the comparison when your policy is evaluated. Depending on the comparison - type, this value can optionally use wildcards. See the documentation for - individual comparison types for more information. - - - - Comparison Value - This is a static value used as the second value - in the comparison when your policy is evaluated. Depending on the comparison - type, this value can optionally use wildcards. See the documentation for - individual comparison types for more information. - - - - - - - - - Gets the type of this condition. - - - - - Gets and Sets the name of the condition key involved in this condition. - Condition keys are predefined values supported by AWS that provide input - to a condition's evaluation, such as the current time, or the IP address - of the incoming request. - - Your policy is evaluated for each incoming request, and condition keys - specify what information to pull out of those incoming requests and plug - into the conditions in your policy. - - - - - - Gets and Sets the values specified for this access control policy condition. - For example, in a condition that compares the incoming IP address of a - request to a specified range of IP addresses, the range of IP addresses - is the single value in the condition. - - Most conditions accept only one value, but multiple values are possible. - - - - - - A factory for creating conditions to be used in the policy. - - - - - Condition key for the current time. - - This condition key should only be used with enum. - - - - - - Condition key for whether or not an incoming request is using a secure - transport to make the request (i.e. HTTPS instead of HTTP). - - This condition key should only be used with the boolean overload of NewCondition. - - - - - - Condition key for the source IP from which a request originates. - - This condition key should only be used with enum. - - - - - - Condition key for the user agent included in a request. - - This condition key should only be used with - enum. - - - - - - Condition key for the current time, in epoch seconds. - - This condition key should only be used with enum. - objects. - - - - - - Condition key for the referrer specified by a request. - - This condition key should only be used with - objects. - - - - - - Condition key for the Amazon Resource Name (ARN) of the source specified - in a request. The source ARN indicates which resource is affecting the - resource listed in your policy. For example, an SNS topic is the source - ARN when publishing messages from the topic to an SQS queue. - - This condition key should only be used with enum. - - - - - - Enumeration of the supported ways an ARN comparison can be evaluated. - - - - Exact matching - - - - Loose case-insensitive matching of the ARN. Each of the six - colon-delimited components of the ARN is checked separately and each - can include a multi-character match wildcard (*) or a - single-character match wildcard (?). - - - - Negated form of ArnEquals - - - Negated form of ArnLike - - - - Enumeration of the supported ways a date comparison can be evaluated. - - - - - Enumeration of the supported ways an IP address comparison can be evaluated. - - - - - Matches an IP address against a CIDR IP range, evaluating to true if - the IP address being tested is in the condition's specified CIDR IP - range. - - - - - Negated form of IpAddress - - - - - Enumeration of the supported ways a numeric comparison can be evaluated - - - - - Enumeration of the supported ways a string comparison can be evaluated. - - - - - Case-sensitive exact string matching - - - - - Case-insensitive string matching - - - - - Loose case-insensitive matching. The values can include a - multi-character match wildcard (*) or a single-character match - wildcard (?) anywhere in the string. - - - - - Negated form of StringEquals. - - - - - Negated form of StringEqualsIgnorecase. - - - - - Negated form of StringLike. - - - - - Constructs a new access control policy condition that compares ARNs (Amazon Resource Names). - - The access policy condition key specifying where to get the first ARN for the comparison - The type of comparison to perform. - The second ARN to compare against. When using ArnLike or ArnNotLike this may contain the - multi-character wildcard (*) or the single-character wildcard - - - - Constructs a new access policy condition that performs a boolean - comparison. - - The access policy condition key specifying where to get the - first boolean value for the comparison (ex: aws:SecureTransport). - The boolean to compare against. - - - - This method is deprecated. Invoking this method results in non-UTC DateTimes - not being marshalled correctly. Use NewConditionUtc instead. - Constructs a new access policy condition that compares the current time - (on the AWS servers) to the specified date. - - The type of comparison to perform. For example, - DateComparisonType.DateLessThan will cause this policy - condition to evaluate to true if the current date is less than - the date specified in the second argument. - The date to compare against. - - - - Constructs a new access policy condition that compares the current time - (on the AWS servers) to the specified date. - - The type of comparison to perform. For example, - DateComparisonType.DateLessThan will cause this policy - condition to evaluate to true if the current date is less than - the date specified in the second argument. - The date to compare against. - - - - Constructs a new access policy condition that compares the source IP - address of the incoming request to an AWS service against the specified - CIDR range. The condition evaluates to true (meaning the policy statement - containing it will be applied) if the incoming source IP address is - within that range. - - To achieve the opposite effect (i.e. cause the condition to evaluate to - true when the incoming source IP is not in the specified CIDR - range) use the alternate constructor form and specify - IpAddressComparisonType.NotIpAddress. - - - The CIDR IP range involved in the policy condition. - - - - Constructs a new access policy condition that compares the source IP - address of the incoming request to an AWS service against the specified - CIDR range. When the condition evaluates to true (i.e. when the incoming - source IP address is within the CIDR range or not) depends on the - specified IpAddressComparisonType. - - The type of comparison to to perform. - The CIDR IP range involved in the policy condition. - - - - Constructs a new access policy condition that compares two numbers. - - The type of comparison to perform. - The access policy condition key specifying where to get the - first number for the comparison. - The second number to compare against. - - - - Constructs a new access control policy condition that compares two - strings. - - The type of comparison to perform - The access policy condition key specifying where to get the - first string for the comparison (ex: aws:UserAgent). - - The second string to compare against. When using - StringComparisonType.StringLike or - StringComparisonType.StringNotLike this may contain - the multi-character wildcard (*) or the single-character - wildcard (?). - - - - - Constructs a new access policy condition that compares the Amazon - Resource Name (ARN) of the source of an AWS resource that is modifying - another AWS resource with the specified pattern. - - For example, the source ARN could be an Amazon SNS topic ARN that is - sending messages to an Amazon SQS queue. In that case, the SNS topic ARN - would be compared the ARN pattern specified here. - - - The endpoint pattern may optionally contain the multi-character wildcard - * (*) or the single-character wildcard (?). Each of the six colon-delimited - components of the ARN is checked separately and each can include a - wildcard. - - - Policy policy = new Policy("MyQueuePolicy"); - policy.WithStatements(new Statement(Statement.StatementEffect.Allow) - .WithPrincipals(new Principal("*")).WithActionIdentifiers(SQSActionIdentifiers.SendMessage) - .WithResources(new Resource(myQueueArn)) - .WithConditions(ConditionFactory.NewSourceArnCondition(myTopicArn))); - - - The ARN pattern against which the source ARN will be compared. - Each of the six colon-delimited components of the ARN is - checked separately and each can include a wildcard. - A new access control policy condition that compares the ARN of - the source specified in an incoming request with the ARN pattern - specified here. - - - - Constructs a new access control policy condition that tests if the - incoming request was sent over a secure transport (HTTPS). - - A new access control policy condition that tests if the incoming - request was sent over a secure transport (HTTPS). - - - - Condition key for the canned ACL specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the location constraint specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the prefix specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the delimiter specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the max keys specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the source object specified by a request to copy an - object. - - This condition key may only be used with enum. - - - - - - Condition key for the metadata directive specified by a request to copy - an object. - - This condition key may only be used with enum. - - - - - - Condition key for the version ID of an object version specified by a - request. - - This condition key may only be used with enum. - - - - - - Constructs a new access policy condition that compares an Amazon S3 - canned ACL with the canned ACL specified by an incoming request. - - You can use this condition to ensure that any objects uploaded to an - Amazon S3 bucket have a specific canned ACL set. - - - The Amazon S3 canned ACL to compare against. - A new access control policy condition that compares the Amazon S3 - canned ACL specified in incoming requests against the value - specified. - - - - Condition key for The URL, e-mail address, or ARN from a Subscribe - request or a previously confirmed subscription. Use with string - conditions to restrict access to specific endpoints (e.g., - *@mycompany.com). - - This condition key may only be used with enum. - - - - - - Condition key for the protocol value from a Subscribe request or a - previously confirmed subscription. Use with string conditions to restrict - publication to specific delivery protocols (e.g., HTTPS). - - This condition key may only be used with enum. - - - - - - Constructs a new access policy condition that compares the requested - endpoint used to subscribe to an Amazon SNS topic with the specified - endpoint pattern. The endpoint pattern may optionally contain the - multi-character wildcard (*) or the single-character wildcard (?). - - For example, this condition can restrict subscriptions to a topic to - email addresses in a certain domain ("*@my-company.com"). - - - Policy policy = new Policy("MyTopicPolicy"); - policy.WithStatements(new Statement(Statement.StatementEffect.Allow) - .WithPrincipals(new Principal("*")).WithActionIdentifiers(SNSActionIdentifiers.Subscribe) - .WithResources(new Resource(myTopicArn)) - .WithConditions(ConditionFactory.NewEndpointCondition("*@my-company.com"))); - - - The endpoint pattern against which to compare the requested - endpoint for an Amazon SNS topic subscription. - A new access control policy condition that compares the endpoint - used in a request to subscribe to an Amazon SNS topic with the - endpoint pattern specified. - - - - Constructs a new AWS access control policy condition that allows an - access control statement to restrict subscriptions to an Amazon SNS topic - based on the protocol being used for the subscription. For example, this - condition can restrict subscriptions to a topic to endpoints using HTTPS - to ensure that messages are securely delivered. - - The protocol against which to compare the requested protocol - for an Amazon SNS topic subscription. - A new access control policy condition that compares the - notification protocol requested in a request to subscribe to an - Amazon SNS topic with the protocol value specified. - - - - Deserializes a JSON string into a AWS policy object. - - - - - Serializes an AWS policy object to a JSON string, suitable for sending to an - AWS service. - - - - Converts the specified AWS policy object to a JSON string, suitable for - passing to an AWS service. - - @param policy - The AWS policy object to convert to a JSON string. - - @return The JSON string representation of the specified policy object. - - @throws IllegalArgumentException - If the specified policy is null or invalid and cannot be - serialized to a JSON string. - - - - Uses the specified generator to write the JSON data for the principals in - the specified policy statement. - - - - - This sorts the conditions by condition type and key with the list of values for that combination. - - The list of conditions to be sorted. - - - - - An AWS access control policy is a object that acts as a container for one or - more statements, which specify fine grained rules for allowing or denying - various types of actions from being performed on your AWS resources. - - By default, all requests to use your resource coming from anyone but you are - denied. Access control polices can override that by allowing different types - of access to your resources, or by explicitly denying different types of - access. - - - Each statement in an AWS access control policy takes the form: - "A has permission to do B to C where D applies". - - - A is the prinicpal - The AWS account that is making a request to - access or modify one of your AWS resources. - - - - B is the action - the way in which your AWS resource is being accessed or modified, such - as sending a message to an Amazon SQS queue, or storing an object in an Amazon S3 bucket. - - - - C is the resource - your AWS entity that the principal wants to access, such - as an Amazon SQS queue, or an object stored in Amazon S3. - - - - D is the set of conditions - optional constraints that specify when to allow or deny - access for the principal to access your resource. Many expressive conditions are available, - some specific to each service. For example you can use date conditions to allow access to - your resources only after or before a specific time. - - - - - - Note that an AWS access control policy should not be confused with the - similarly named "POST form policy" concept used in Amazon S3. - - - - - - The default policy version - - - - - Constructs an empty AWS access control policy ready to be populated with - statements. - - - - - Constructs a new AWS access control policy with the specified policy ID. - The policy ID is a user specified string that serves to help developers - keep track of multiple polices. Policy IDs are often used as a human - readable name for a policy. - - The policy ID for the new policy object. Policy IDs serve to - help developers keep track of multiple policies, and are often - used to give the policy a meaningful, human readable name. - - - - Constructs a new AWS access control policy with the specified policy ID - and collection of statements. The policy ID is a user specified string - that serves to help developers keep track of multiple polices. Policy IDs - are often used as a human readable name for a policy. - - The policy ID for the new policy object. Policy IDs serve to - help developers keep track of multiple policies, and are often - used to give the policy a meaningful, human readable name. - The statements to include in the new policy. - - - - Gets and Sets the policy ID for this policy. Policy IDs serve to help - developers keep track of multiple policies, and are often used as human - readable name for a policy. - - - - - Sets the policy ID for this policy and returns the updated policy so that - multiple calls can be chained together. - - Policy IDs serve to help developers keep track of multiple policies, and - are often used as human readable name for a policy. - - - The polich ID for this policy - this instance - - - - Gets and sets the version of this AWS policy. - - - - - Gets and Sets the collection of statements contained by this policy. Individual - statements in a policy are what specify the rules that enable or disable - access to your AWS resources. - - - - - Checks to see if the permissions set in the statement are already set by another - statement in the policy. - - The statement to verify - True if the statement's permissions are already allowed by the statement - - - - Sets the collection of statements contained by this policy and returns - this policy object so that additional method calls can be chained - together. - - Individual statements in a policy are what specify the rules that enable - or disable access to your AWS resources. - - - The collection of statements included in this policy. - this instance - - - - Returns a JSON string representation of this AWS access control policy, - suitable to be sent to an AWS service as part of a request to set an - access control policy. - - A JSON string representation of this AWS access control policy. - - - - Returns a JSON string representation of this AWS access control policy, - suitable to be sent to an AWS service as part of a request to set an - access control policy. - - Toggle pretty print for the generated JSON document - A JSON string representation of this AWS access control policy. - - - - Parses a JSON document of a policy and creates a Policy object. - - JSON document of a policy. - - - - - A principal is an AWS account which is being allowed or denied access to a - resource through an access control policy. The principal is a property of the - Statement object, not directly the object. - - The principal is A in the statement - "A has permission to do B to C where D applies." - - - In an access control policy statement, you can set the principal to all - authenticated AWS users through the member. This - is useful when you don't want to restrict access based on the identity of the - requester, but instead on other identifying characteristics such as the - requester's IP address. - - - - - - Principal instance that includes all authenticated AWS users. - - This is useful when you don't want to restrict access based on the - identity of the requester, but instead on other identifying - characteristics such as the requester's IP address. - - - - - - The anonymous Principal. - - - - - The default Principal provider for AWS accounts. - - - - - Principal provider for Canonical User IDs. - - - - - Principal provider for federated users (using a SAML identity provider) - - - - - Principal provider for assume role policies that will be assumed by an AWS service - (e.g. "ec2.amazonaws.com"). - - - - - Dummy principal provider for anonynous. - - - - - Constructs a new principal with the specified AWS account ID. - - An AWS account ID. - - - - Constructs a new principal with the specified provider and id - - The provider of the principal - The unique ID of the Principal within the provider - - - - Constructs a new principal with the specified provider and id - and optionally strips hyphens from the id - - The provider of the principal - The unique ID of the Principal within the provider - Strip hyphen - - - - Gets and sets the provider for this principal, which indicates in what group of - users this principal resides. - - - - - Gets the unique ID for this principal. - - - - - Represents a resource involved in an AWS access control policy statement. - Resources are the service specific AWS entities owned by your account. Amazon - SQS queues, Amazon S3 buckets and objects, and Amazon SNS topics are all - examples of AWS resources. - - The standard way of specifying an AWS resource is with an Amazon Resource - Name (ARN). - - - The resource is C in the statement - "A has permission to do B to C where D applies." - - - - - - Constructs a new AWS access control policy resource. Resources are - typically specified as Amazon Resource Names (ARNs). - - You specify the resource using the following Amazon Resource Name (ARN) - format: arn:aws:<vendor>:<region>:<namespace>:<relative-id> - - - >vendor identifies the AWS product (e.g., sns) - - - region is the AWS Region the resource resides in (e.g., us-east-1), if any - - - namespace is the AWS account ID with no hyphens (e.g., 123456789012) - - - relative-id is the service specific portion that identifies the specific resource - - - - - For example, an Amazon SQS queue might be addressed with the following - ARN: arn:aws:sqs:us-east-1:987654321000:MyQueue - - - Some resources may not use every field in an ARN. For example, resources - in Amazon S3 are global, so they omit the region field: - arn:aws:s3:::bucket/* - - - The Amazon Resource Name (ARN) uniquely identifying the desired AWS resource. - - - - Gets the resource ID, typically an Amazon Resource Name (ARN), - identifying this resource. - - - - - A factory for creating resources to be used in the policy. - - - - - Constructs a new bucket resource that represents the the specified bucket - but not any of the contained objects. - - The name of the bucket represented by this AWS access control - policy resource. - - - - Constructs a new object resource that represents the specified objects. - The keyPattern argument may contain the '*' wildcard to match multiple - objects. For example, an object resource created for bucket 'mybucket' - and key pattern 'foo*' will match any object stored in 'mybucket' with a - key that starts with 'foo'. - - The name of the bucket containing the object or objects - represented by this resource. - The key or key pattern, which can optionally contain the '*' - wildcard to include multiple objects in the resource. - - - - Constructs a new SQS queue resource for an access control policy. A - policy statement using this resource will allow or deny actions on the - specified queue. - - The AWS account ID of the queue owner. - The name of the Amazon SQS queue. - - - - A statement is the formal description of a single permission, and is always - contained within a policy object. - - A statement describes a rule for allowing or denying access to a specific AWS - resource based on how the resource is being accessed, and who is attempting - to access the resource. Statements can also optionally contain a list of - conditions that specify when a statement is to be honored. - - - For example, consider a statement that: - - - A is the prinicpal - The AWS account that is making a request to - access or modify one of your AWS resources. - - - - B is the action - the way in which your AWS resource is being accessed or modified, such - as sending a message to an Amazon SQS queue, or storing an object in an Amazon S3 bucket. - - - - C is the resource - your AWS entity that the principal wants to access, such - as an Amazon SQS queue, or an object stored in Amazon S3. - - - - D is the set of conditions - optional constraints that specify when to allow or deny - access for the principal to access your resource. Many expressive conditions are available, - some specific to each service. For example you can use date conditions to allow access to - your resources only after or before a specific time. - - - - - - There are many resources and conditions available for use in statements, and - you can combine them to form fine grained custom access control polices. - - - - - - The effect is the result that you want a policy statement to return at - evaluation time. A policy statement can either allow access or explicitly - deny access. - - - - - Constructs a new access control policy statement with the specified - effect. - - Before a statement is valid and can be sent to AWS, callers must set the - principals, resources, and actions (as well as any optional conditions) - involved in the statement. - - - The effect this statement has (allowing access or denying - access) when all conditions, resources, principals, and - actions are matched. - - - - Gets and Sets the ID for this statement. Statement IDs serve to help keep track - of multiple statements, and are often used to give the statement a - meaningful, human readable name. - - Developers should be careful to not use the same statement ID for - multiple statements in the same policy. Reusing the same statement ID in - different policies is not a problem. - - - - - - Sets the ID for this statement and returns the updated statement so - multiple calls can be chained together. - - Statement IDs serve to help keep track of multiple statements, and are - often used to give the statement a meaningful, human readable name. - - - Developers should be careful to not use the same statement ID for - multiple statements in the same policy. Reusing the same statement ID in - different policies is not a problem. - - - The new statement ID for this statement. - this instance - - - - Gets and Sets the result effect of this policy statement when it is evaluated. - A policy statement can either allow access or explicitly - - - - - Gets and Sets the list of actions to which this policy statement applies. - Actions limit a policy statement to specific service operations that are - being allowed or denied by the policy statement. For example, you might - want to allow any AWS user to post messages to your SQS queue using the - SendMessage action, but you don't want to allow those users other actions - such as ReceiveMessage or DeleteQueue. - - - - - Sets the list of actions to which this policy statement applies and - returns this updated Statement object so that additional method calls can - be chained together. - - Actions limit a policy statement to specific service operations that are - being allowed or denied by the policy statement. For example, you might - want to allow any AWS user to post messages to your SQS queue using the - SendMessage action, but you don't want to allow those users other actions - such as ReceiveMessage or DeleteQueue. - - - The list of actions to which this statement applies. - this instance - - - - Gets and Sets the resources associated with this policy statement. Resources - are what a policy statement is allowing or denying access to, such as an - Amazon SQS queue or an Amazon SNS topic. - - Note that some services allow only one resource to be specified per - policy statement. - - - - - - Sets the resources associated with this policy statement and returns this - updated Statement object so that additional method calls can be chained - together. - - Resources are what a policy statement is allowing or denying access to, - such as an Amazon SQS queue or an Amazon SNS topic. - - - Note that some services allow only one resource to be specified per - policy statement. - - - The resources associated with this policy statement. - this instance - - - - Gets and Sets the conditions associated with this policy statement. Conditions - allow policy statements to be conditionally evaluated based on the many - available condition types. - - For example, a statement that allows access to an Amazon SQS queue could - use a condition to only apply the effect of that statement for requests - that are made before a certain date, or that originate from a range of IP - addresses. - - - When multiple conditions are included in a single statement, all - conditions must evaluate to true in order for the statement to take - effect. - - - - - - Sets the conditions associated with this policy statement, and returns - this updated Statement object so that additional method calls can be - chained together. - - Conditions allow policy statements to be conditionally evaluated based on - the many available condition types. - - - For example, a statement that allows access to an Amazon SQS queue could - use a condition to only apply the effect of that statement for requests - that are made before a certain date, or that originate from a range of IP - addresses. - - - Multiple conditions can be included in a single statement, and all - conditions must evaluate to true in order for the statement to take - effect. - - - The conditions associated with this policy statement. - this instance - - - - Gets and Sets the principals associated with this policy statement, indicating - which AWS accounts are affected by this policy statement. - - - - - Sets the principals associated with this policy statement, and returns - this updated Statement object. Principals control which AWS accounts are - affected by this policy statement. - - If you don't want to restrict your policy to specific users, you can use - to apply the policy to any user trying to - access your resource. - - - The list of principals associated with this policy statement. - this instance - - - - Exception thrown by the SDK for errors that occur within the SDK. - - - - - Constructs a new instance of the AmazonClientException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - This exception is thrown when there is a parse error on the response back from AWS. - - - - - The string value which could not be converted into a valid DateTime instance. - - - - - Constructs a new instance of the AmazonDateTimeUnmarshallingException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - Occurs before a request is marshalled. - - - - - Occurs before a request is issued against the service. - - - - - Occurs after a response is received from the service. - - - - - Occurs after an exception is encountered. - - - - - Patches the in-flight uri to stop it unescaping the path etc (what Uri did before - Microsoft deprecated the constructor flag). This is particularly important for - Amazon S3 customers who want to use backslash (\) in their key names. - - - Different behavior in the various runtimes has been observed and in addition some - 'documented' ways of doing this between 2.x and 4.x runtimes has also been observed - to not be reliable. - - This patch effectively emulates what adding a schemesettings element to the - app.config file with value 'name="http" genericUriParserOptions="DontUnescapePathDotsAndSlashes"' - does. As we're a dll, that avenue is not open to us. - - - - - - Used to create a copy of the config for a different service than the current instance. - - Target service ClientConfig - The new ClientConfig for the desired service - - - - A base exception for some Amazon Web Services. - - Most exceptions thrown to client code will be service-specific exceptions, though some services - may throw this exception if there is a problem which is caught in the core client code. - - - - - - Whether the error was attributable to Sender or Reciever. - - - - - The error code returned by the service - - - - - The id of the request which generated the exception. - - - - - The HTTP status code from the service response - - - - - Flag indicating if the exception is retryable and the associated retry - details. A null value indicates that the exception is not retryable. - - - - - Constructs a new instance of the AmazonServiceException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - Class containing the retryable details for an AmazonServiceException - - - - - This property indicates that this exception is a - throttling exception and should be subject to congestion - control throttling. - - - - - This exception is thrown when there is a parse error on the response back from AWS. - - - - - Last known location in the response that was parsed, if available. - - - - - The entire response body that caused this exception, if available. - - - - - Constructs a new instance of the AmazonSimpleDBException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - Base class for request used by some of the services. - - - - - This flag specifies if SigV4 will be used for the current request. - - - - - Gets or Sets a value indicating if "Expect: 100-continue" HTTP header will be - sent by the client for this request. The default value is false. - - - - - Gets the signer to use for this request. - A null return value indicates to use the configured - signer for the service that this request is part of. - - A signer for this request, or null. - - - - Overrides the default request timeout value. - - - - If the value is set, the value is assigned to the Timeout property of the HTTPWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Overrides the default read-write timeout value. - - - - If the value is set, the value is assigned to the ReadWriteTimeout property of the HTTPWebRequest/WebRequestHandler object used - to send requests. - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - - Abstract class for Response objects, contains only metadata, - and no result information. - - - - - Contains additional information about the request, such as the - Request Id. - - - - - Returns the content length of the HTTP response. - - - - - Returns the status code of the HTTP response. - - - - - Base class for determining region based on inspection. - - - - - Sets the Region property by looking up the corresponding RegionEndpoint - from the supplied region system name (us-east-1, us-west-2 etc). - - The system name of the region. - - - - Determines region based on application configuration settings. If the configuration does not contain - the region setting key an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of ApplicationConfigAWSRegion. If no region is found in the - application configuration file then an InvalidOperationException is thrown. - - - - - Determines region based on an environment variable. If the environment does not contain - the region setting key an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of EnvironmentVariableAWSRegion. If no region is found in the - environment then an InvalidOperationException is thrown. - - - - - Determines region based on inspection of the instance metadata if running on an EC2 instance. - If instance metadata cannot be read or does not contain region information an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of InstanceProfileAWSRegion. If no region is found in the - metadata or we are not running on an EC2 instance an InvalidOperationException is thrown. - - - - - Determines region based on a stored in an . - If the profile doesn't exist or there is no region information an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of . - If the AWS_PROFILE environment variable is set the instance will be constructed using that profile, - otherwise it will use the default profile. - - If the profile doesn't exist or there is no region information an InvalidOperationException is thrown. - - The ICredentialProfileSource to read the profile from. - - - - Attempts to construct an instance of . - If the profile doesn't exist or there is no region information an InvalidOperationException is thrown. - - The ICredentialProfileSource to read the profile from. - The name of the profile. - - - - Probing mechanism to determine region from various sources. - - - - - This class is responsible for keeping track of Retry capacity across different ServiceURLs. - - - - - CapacityType determines the type of capacity to obtain or use. - - - - - The increment capacity type adds capacity. - - - - - The default retry capacity type uses the default capacity amount. - - - - - The timeout capacity type uses the timeout capacity amount. - - - - - This method acquires a said retry capacity if the container has the capacity. - - Contains the RetryCapacity object for the said ServiceURL. - - - - This method acquires a said retry capacity if the container has the capacity. - - Contains the RetryCapacity object for the said ServiceURL. - Specifies what capacity type cost to use for obtaining capacity - - - - This method calls a method to release capacity back - based on whether it was a successful response or a successful retry response. This is invoked by a retry request response. - - if this request is a retry, use a different capacity cost - Contains the RetryCapacity object for the said ServiceURL. - - - - This method calls a method to release capacity back - based on whether it was a successful response or a successful retry response. This is invoked by a retry request response. - - Specifies what capacity type cost to use for adding capacity - Contains the RetryCapacity object for the said ServiceURL. - - - - Ths method fetches the RetryCapacity for the given ServiceURL from CapacityManager.CapacityContainer - - - - - This method releases capacity back. This is invoked by the TryReleaseCapacity method. - - Contains the RetryCapacity object for the said ServiceURL. - The capacity that needs to be released based on whether it was a successful response or a successful retry response. - - - - This class is the RetryCapacity class for a given ServiceURL. - - - - - This class composes Client Context header for Amazon Web Service client. - It contains information like app title, version code, version name, client id, OS platform etc. - - - This class composes Client Context header for Amazon Web Service client. - It contains information like app title, version code, version name, client id, OS platform etc. - - - - - Adds the custom attributes to the Client Context. - - Key. - Value. - - - - Gets a Json Representation of the Client Context. - - Json Representation of Client Context - - - - Class to which the Json stdout from credential process is - de-serialized into. - - - - - Version of the Json payload - - - - - AWS Access key - - - - - AWS Secret key - - - - - AWS Session token for session credentials - - - - - ISO8601 formatted timestamp till when the credential is valid. - - - - - Computes RFC 2104-compliant HMAC signature. - - - - - Computes RFC 2104-compliant HMAC signature. - - - - - Inspects the supplied evidence to return the signer appropriate for the operation - - Global setting for the service - The request. - Configuration for the client - True if signature v4 request signing should be used - - - - Signs the specified request with the AWS3 signing protocol by using the - AWS account credentials given in the method parameters. - - The AWS public key - The AWS secret key used to sign the request in clear text - Request metrics - The configuration that specifies which hashing algorithm to use - The request to have the signature compute for - If any problems are encountered while signing the request - - - - AWS4 protocol signer for service calls that transmit authorization in the header field "Authorization". - - - - - Calculates and signs the specified request using the AWS4 signing protocol by using the - AWS account credentials given in the method parameters. The resulting signature is added - to the request headers as 'Authorization'. Parameters supplied in the request, either in - the resource path as a query string or in the Parameters collection must not have been - uri encoded. If they have, use the SignRequest method to obtain a signature. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. - - - Client configuration data encompassing the service call (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text. - - - If any problems are encountered while signing the request. - - - - - Calculates and signs the specified request using the AWS4 signing protocol by using the - AWS account credentials given in the method parameters. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. - - - Client configuration data encompassing the service call (notably authentication - region, endpoint and service name). - - - Metrics for the request. - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text. - - - If any problems are encountered while signing the request. - - - Parameters passed as part of the resource path should be uri-encoded prior to - entry to the signer. Parameters passed in the request.Parameters collection should - be not be encoded; encoding will be done for these parameters as part of the - construction of the canonical request. - - - - - Sets the AWS4 mandated 'host' and 'x-amz-date' headers, returning the date/time that will - be used throughout the signing process in various elements and formats. - - The current set of headers - - Date and time used for x-amz-date, in UTC - - - - Sets the AWS4 mandated 'host' and 'x-amz-date' headers, accepting and returning the date/time that will - be used throughout the signing process in various elements and formats. - - The current set of headers - - - Date and time used for x-amz-date, in UTC - - - - Computes and returns an AWS4 signature for the specified canonicalized request - - - - - - - - - - - - Computes and returns an AWS4 signature for the specified canonicalized request - - - - - - - - - - - - - Computes and returns an AWS4 signature for the specified canonicalized request - - - - - - - - - - - - - - Formats the supplied date and time for use in AWS4 signing, where various formats are used. - - - The required format - The UTC date/time in the requested format - - - - Compute and return the multi-stage signing key for the request. - - The clear-text AWS secret key, if not held in secureKey - The region in which the service request will be processed - Date of the request, in yyyyMMdd format - The name of the service being called by the request - Computed signing key - - - - If the caller has already set the x-amz-content-sha256 header with a pre-computed - content hash, or it is present as ContentStreamHash on the request instance, return - the value to be used in request canonicalization. - If not set as a header or in the request, attempt to compute a hash based on - inspection of the style of the request content. - - - - The computed hash, whether already set in headers or computed here. Null - if we were not able to compute a hash. - - - - - If signPayload is false set the x-amz-content-sha256 header to - the UNSIGNED-PAYLOAD magic string and return it. - Otherwise, if the caller has already set the x-amz-content-sha256 header with a pre-computed - content hash, or it is present as ContentStreamHash on the request instance, return - the value to be used in request canonicalization. - If not set as a header or in the request, attempt to compute a hash based on - inspection of the style of the request content. - - - - - The computed hash, whether already set in headers or computed here. Null - if we were not able to compute a hash. - - - - - Returns the HMAC256 for an arbitrary blob using the specified key - - - - - - - - Returns the HMAC256 for an arbitrary blob using the specified key - - - - - - - - Compute and return the hash of a data blob using the specified key - - Algorithm to use for hashing - Hash key - Data blob - Hash of the data - - - - Compute and return the hash of a data blob using the specified key - - Algorithm to use for hashing - Hash key - Data blob - Hash of the data - - - - Computes the non-keyed hash of the supplied data - - - - - - - Computes the non-keyed hash of the supplied data - - - - - - - Computes and returns the canonical request - - The endpoint URL - the path of the resource being operated on - The http method used for the request - The full request headers, sorted into canonical order - The query parameters for the request - - The hash of the binary request body if present. If not supplied, the routine - will look for the hash as a header on the request. - - Canonicalised request as a string - - - - Computes and returns the canonical request - - The endpoint URL - the path of the resource being operated on - The http method used for the request - The full request headers, sorted into canonical order - The query parameters for the request - - The path resource values lookup to use to replace the keys within resourcePath - The hash of the binary request body if present. If not supplied, the routine - will look for the hash as a header on the request. - - The version of the marshaller that constructed the request object. - Canonicalised request as a string - - - - Computes and returns the canonical request - - The endpoint URL - the path of the resource being operated on - The http method used for the request - The full request headers, sorted into canonical order - The query parameters for the request - - The path resource values lookup to use to replace the keys within resourcePath - The hash of the binary request body if present. If not supplied, the routine - will look for the hash as a header on the request. - - The version of the marshaller that constructed the request object. - The service being called for the request - Canonicalised request as a string - - - - Reorders the headers for the request for canonicalization. - - The set of proposed headers for the request - List of headers that must be included in the signature - For AWS4 signing, all headers are considered viable for inclusion - - - - Computes the canonical headers with values for the request. Only headers included in the signature - are included in the canonicalization process. - - All request headers, sorted into canonical order - Canonicalized string of headers, with the header names in lower case. - - - - Returns the set of headers included in the signature as a flattened, ;-delimited string - - The headers included in the signature - Formatted string of header names - - - - Collects the subresource and query string parameters into one collection - ready for canonicalization - - The in-flight request being signed - The fused set of parameters - - - - Computes and returns the canonicalized query string, if query parameters have been supplied. - Parameters with no value will be canonicalized as 'param='. The expectation is that parameters - have not already been url encoded prior to canonicalization. - - The set of parameters being passed on the uri - - Parameters must be uri encoded into the canonical request and by default the signer expects - that the supplied collection contains non-encoded data. Set this to false if the encoding was - done prior to signer entry. - - The uri encoded query string parameters in canonical ordering - - - - Computes and returns the canonicalized query string, if query parameters have been supplied. - Parameters with no value will be canonicalized as 'param='. The expectation is that parameters - have not already been url encoded prior to canonicalization. - - The set of parameters to be encoded in the query string - - Parameters must be uri encoded into the canonical request and by default the signer expects - that the supplied collection contains non-encoded data. Set this to false if the encoding was - done prior to signer entry. - - The uri encoded query string parameters in canonical ordering - - - - Returns the request parameters in the form of a query string. - - The request instance - Request parameters in query string format - - - - AWS4 protocol signer for Amazon S3 presigned urls. - - - - - Calculates and signs the specified request using the AWS4 signing protocol by using the - AWS account credentials given in the method parameters. The resulting signature is added - to the request headers as 'Authorization'. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. - - - Adding supporting data for the service call required by the signer (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text - - - If any problems are encountered while signing the request. - - - - - Calculates the AWS4 signature for a presigned url. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. If the Expires parameter - is present, it is renamed to 'X-Amz-Expires' before signing. - - - Adding supporting data for the service call required by the signer (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text - - - If any problems are encountered while signing the request. - - - Parameters passed as part of the resource path should be uri-encoded prior to - entry to the signer. Parameters passed in the request.Parameters collection should - be not be encoded; encoding will be done for these parameters as part of the - construction of the canonical request. - - - - - Calculates the AWS4 signature for a presigned url. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. If the Expires parameter - is present, it is renamed to 'X-Amz-Expires' before signing. - - - Adding supporting data for the service call required by the signer (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text - - - The service to sign for - - - The region to sign to, if null then the region the client is configured for will be used. - - - If any problems are encountered while signing the request. - - - Parameters passed as part of the resource path should be uri-encoded prior to - entry to the signer. Parameters passed in the request.Parameters collection should - be not be encoded; encoding will be done for these parameters as part of the - construction of the canonical request. - - The X-Amz-Content-SHA256 is cleared out of the request. - If the request is for S3 then the UNSIGNED_PAYLOAD value is used to generate the canonical request. - If the request isn't for S3 then the empty body SHA is used to generate the canonical request. - - - - - Encapsulates the various fields and eventual signing value that makes up - an AWS4 signature. This can be used to retrieve the required authorization string - or authorization query parameters for the final request as well as hold ongoing - signature computations for subsequent calls related to the initial signing. - - - - - Constructs a new signing result instance for a computed signature - - The access key that was included in the signature - Date/time (UTC) that the signature was computed - The collection of headers names that were included in the signature - Formatted 'scope' value for signing (YYYYMMDD/region/service/aws4_request) - Returns the key that was used to compute the signature - Computed signature - - - - The access key that was used in signature computation. - - - - - ISO8601 formatted date/time that the signature was computed - - - - - ISO8601 formatted date that the signature was computed - - - - - The ;-delimited collection of header names that were included in the signature computation - - - - - Formatted 'scope' value for signing (YYYYMMDD/region/service/aws4_request) - - - - - Returns a copy of the key that was used to compute the signature - - - - - Returns the hex string representing the signature - - - - - Returns a copy of the byte array containing the signature - - - - - Returns the signature in a form usable as an 'Authorization' header value. - - - - - Returns the signature in a form usable as a set of query string parameters. - - - - - Null Signer which does a no-op. - - - - - Signs the specified request with the AWS2 signing protocol by using the - AWS account credentials given in the method parameters. - - The AWS public key - The AWS secret key used to sign the request in clear text - Request metrics - The configuration that specifies which hashing algorithm to use - The request to have the signature compute for - If any problems are encountered while signing the request - - - - S3 signer constructor - - - - - S3 signer constructor - - - - - This exception is thrown if there are problems signing the request. - - - - - Constructs a new instance of the SignatureException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Collection used to indicate if the property was initialized was created by the SDK. - - - - - - Collection used to indicate if the property was initialized was created by the SDK. - - - - - - - Default implementation of the IRequest interface. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Constructs a new DefaultRequest with the specified service name and the - original, user facing request object. - - The orignal request that is being wrapped - The service name - - - - The name of the request - - - - - Gets and sets the type of http request to make, whether it should be POST,GET or DELETE - - - - - Gets and sets a flag that indicates whether the request is sent as a query string instead of the request body. - - - - - Returns the original, user facing request object which this internal - request object is representing. - - - - - Returns a dictionary of the headers included in this request. - - - - - Returns a dictionary of the parameters included in this request. - - - - - Collection of parameters included in this request. - - - - - Returns the subresources that should be appended to the resource path. - This is used primarily for Amazon S3, where object keys can contain '?' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new null entry to the SubResources collection for the request - - The name of the subresource - - - - Adds a new entry to the SubResources collection for the request - - The name of the subresource - Value of the entry - - - - Gets and Sets the endpoint for this request. - - - - - Gets and Sets the resource path added on to the endpoint. - - - - - Returns the path resources that should be used within the resource path. - This is used for services where path keys can contain '/' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new entry to the PathResources collection for the request - - The name of the pathresource with potential greedy syntax: {key+} - Value of the entry - - - - Gets and Sets the version number for the marshaller used to create this request. The version number - is used to support backward compatible changes that would otherwise be breaking changes when a - newer core is used with an older service assembly. - Versions: - 1 - Default version - 2 - Support for path segments - - - - - Gets and Sets the content for this request. - - - - - Flag that signals that Content was and should be set - from the Parameters collection. - - - - - Gets and sets the content stream. - - - - - Gets and sets the original stream position. - If ContentStream is null or does not support seek, this propery - should be equal to -1. - - - - - Computes the SHA 256 hash of the content stream. If the stream is not - seekable, it searches the parent stream hierarchy to find a seekable - stream prior to computation. Once computed, the hash is cached for future - use. If a suitable stream cannot be found to use, null is returned. - - - - - The name of the service to which this request is being sent. - - - - - Alternate endpoint to use for this request, if any. - - - - - Host prefix value to prepend to the endpoint for this request, if any. - - - - - Gets and sets the Suppress404Exceptions property. If true then 404s return back from AWS will not cause an exception and - an empty response object will be returned. - - - - - If using AWS4 signing protocol, contains the resultant parts of the - signature that we may need to make use of if we elect to do a chunked - encoding upload. - - - - - Determine whether to use a chunked encoding upload for the request - (applies to Amazon S3 PutObject and UploadPart requests only). - - - - - - Used for Amazon S3 requests where the bucket name is removed from - the marshalled resource path into the host header. To comply with - AWS2 signature calculation, we need to recover the bucket name - and include it in the resource canonicalization, which we do using - this field. - - - - - This flag specifies if SigV4 is required for the current request. - - - - - The authentication region to use for the request. - Set from Config.AuthenticationRegion. - - - - - The region in which the service request was signed. - - - - - Checks if the request stream can be rewinded. - - Returns true if the request stream can be rewinded , - else false. - - - - Returns true if the request can contain a request body, else false. - - Returns true if the currect request can contain a request body, else false. - - - - Returns true if the request has a body, else false. - - Returns true if the request has a body, else false. - - - - Class containing the data for one endpoint returned from a endpoint discovery request - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Constructs a new DiscoveryEndpoint - - The address of the endpoint - The cache period for the endpoint in minutes - - - - The address of the endpoint. - - - - - The cache period for the endpoint in minutes - - - - - Calculates if this endpoint has expired - - A boolean value indicating if the cache period has expired - - - - Extends the endpoint expiration by the specified number of minutes from now. - - - - - Class containing the data for one endpoint returned from a endpoint discovery request - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class containing the data to use with endpoint discovery - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Gets/sets and flag indicating if endpoint discovery is required for the request. - - - - - Sorted dictionary of the identifiers that must be sent with the endpoint discovery request. These - identifiers are used to construct the cache key for the cache that stores discovered endpoints. A - sorted dictionary is used instead of a dictionary to ensure the cache key comes out in the same order - each time it is constructed. - - - - - Represents the data to be used with endpoint discovery operations - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class used to resolve endpoints using Endpoint Discovery. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Method that performs endpoint discovery for the current operation - - Context information used in calculations for endpoint discovery - The operation to fetch endpoints from the server - - - - - Gets the number of cache keys in the cache - - - - - Class used to resolve endpoints using Endpoint Discovery. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class containing context information to use with endpoint discovery - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Gets the customer credential information. - - - - - Gets the operation name. - - - - - Gets the current marshalled endpoint discovery data. - - - - - Gets the flag indicating if the specified key should be evicted from the cache. - - - - - Gets the Uri that should be evicted if EvictCacheKey is set to true. - - - - - Class containing context information to use with endpoint discovery - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Error type, one of Sender, Receiver, Unknown - Only applies to XML-based services. - - - - - Name of the exception class to return - - - - - Error message - - - - - RequestId of the error. - Only applies to XML-based services. - - - - - InternalConfiguration holds the cached SDK configuration values - obtained from the environment and profile configuration - factories. These configuration values are loaded internally and - are not the same as user exposed AWSConfigs. - - - - - Flag indicating if Endpoint Discovery is enabled. - - - - - The retry mode to use: Legacy, Standard, or Adaptive. - - - - - The max number of request attempts. - - - - - Determines the configuration values based on environment variables. If - no values is found for a configuration the value will be set to null. - - - - - Attempts to construct a configuration instance of configuration environment - variables. If an environment variable value isn't found then the individual value - for that environment variable will be null. If unable to obtain a value converter - to convert a configuration string to the appropriate type a InvalidOperationException - is thrown. - - - - - Determines configuration values based on a stored in an . - If the profile doesn't exist, the status will be logged and no value will be set in the configuration. - - - - - Attempts to construct an instance of . - If the AWS_PROFILE environment variable is set the instance will be constructed using that profile, - otherwise it will use the default profile. - - If the profile doesn't exist status will be logged and no value will be set in the configuration. - - The ICredentialProfileSource to read the profile from. - - - - Attempts to construct an instance of . - If the profile doesn't exist status will be logged and no value will be set in the configuration. - - The ICredentialProfileSource to read the profile from. - The name of the profile. - - - - Probing mechanism to determine the configuration values from various sources. - - - - - Resets all the configuration values reloading as needed. This method will use - the AWS_PROFILE environment variable if set to construct the instance. Otherwise - the default profile will be used. - - - - - Flag that specifies if endpoint discovery is enabled, disabled, - or not set. - - - - - Flag that specifies which retry mode to use or if retry mode has - not been set. - - - - - Flag that specifies the max number of request attempts or if max - attempts has not been set. - - - - - Class containing the members used to invoke service calls - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class containing the members used to invoke service calls - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Represents a request being sent to an Amazon Web Service, including the - parameters being sent as part of the request, the endpoint to which the - request should be sent, etc. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - The name of the request - - - - - Returns a dictionary of the headers included in this request. - - - - - Gets and sets a flag that indicates whether the request is sent as a query string instead of the request body. - - - - - Returns a dictionary of the parameters included in this request. - - - - - Collection of parameters included in this request. - - - - - Returns the subresources that should be appended to the resource path. - This is used primarily for Amazon S3, where object keys can contain '?' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new null entry to the SubResources collection for the request - - The name of the subresource - - - - Adds a new entry to the SubResources collection for the request - - The name of the subresource - Value of the entry - - - - Gets and sets the type of http request to make, whether it should be POST,GET or DELETE - - - - - Gets and Sets the endpoint for this request. - - - - - Gets and Sets the resource path added on to the endpoint. - - - - - Returns the path resources that should be used within the resource path. - This is used for services where path keys can contain '/' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new entry to the PathResources collection for the request - - The name of the pathresource with potential greedy syntax: {key+} - Value of the entry - - - - Gets and Sets the version number for the marshaller used to create this request. The version number - is used to support backward compatible changes that would otherwise be breaking changes when a - newer core is used with an older service assembly. - - - - - Gets and Sets the content for this request. - - - - - Gets the header value from the request. - - - - - Flag that signals that Content was and should be set - from the Parameters collection. - - - - - Gets and sets the content stream. - - - - - Gets and sets the original stream position. - If ContentStream is null or does not support seek, this propery - should be equal to -1. - - - - - Computes the SHA 256 hash of the content stream. If the stream is not - seekable, it searches the parent stream hierarchy to find a seekable - stream prior to computation. Once computed, the hash is cached for future - use. - - - - - The name of the service to which this request is being sent. - - - - - Returns the original, user facing request object which this internal - request object is representing. - - - - - Alternate endpoint to use for this request, if any. - - - - - Host prefix value to prepend to the endpoint for this request, if any. - - - - - Gets and sets the Suppress404Exceptions property. If true then 404s return back from AWS will not cause an exception and - an empty response object will be returned. - - - - - If using AWS4 signing protocol, contains the resultant parts of the - signature that we may need to make use of if we elect to do a chunked - encoding upload. - - - - - Determine whether to use a chunked encoding upload for the request - (applies to Amazon S3 PutObject and UploadPart requests only). - - - - - - Used for Amazon S3 requests where the bucket name is removed from - the marshalled resource path into the host header. To comply with - AWS2 signature calculation, we need to recover the bucket name - and include it in the resource canonicalization, which we do using - this field. - - - - - This flag specifies if SigV4 is required for the current request. - - - - - The authentication region to use for the request. - Set from Config.AuthenticationRegion. - - - - - The region in which the service request was signed. - - - - - Checks if the request stream can be rewinded. - - Returns true if the request stream can be rewinded , - else false. - - - - Returns true if the request can contain a request body, else false. - - Returns true if the currect request can contain a request body, else false. - - - - Returns true if the request has a body, else false. - - Returns true if the request has a body, else false. - - - - Gets the value of the Service Id. - - - - - Gets the dictionary that gives mapping of renamed operations - - - - - IDictionary{String, String} access to ParameterCollection. - TODO: remove this class in version 3.4 of the SDK. - - - - - Constructs ParametersDictionaryFacade for a ParameterCollection - - - - - - A registry of object that will manipulate the runtime pipeline used by service clients. - - - - - Registers a customizer that will be applied for all service clients created. Each customizer has a unique name associated with it. If a customizer is registered more - than once with the same unique name then the calls after the first will be ignored. - - - - - - Deregistered the runtime pipeline customizer - - - - - - Deregistered the runtime pipeline customizer - - - - - - Applies all of the registered customizers on the runtime pipeline - - The service clients runtime pipeline. - Type object for the service client being created - - - - Interface for objects that will customize the runtime pipleine for newly created service clients. - - - - - The unique name for the customizer that identifies the customizer in the registry. The name is also used to identify the customizer on the SDK logs. - - - - - Called on service clients as they are being constructed to customize their runtime pipeline. - - - Type object for the service client being created - - - - Default ServiceMetadata implementation. - This implementation will be used if the service doesn't have a - IServiceMetadata implementation. - - - - - Gets the value of the Service Id. - - - - - Gets the dictionary that gives mapping of renamed operations - - - - - Response Unmarshaller for all Errors - - - - - Build an ErrorResponse from XML - - The XML parsing context. - Usually an Amazon.Runtime.Internal.UnmarshallerContext. - An ErrorResponse object. - - - - Return an instance of and ErrorResponseUnmarshaller. - - - - - - Interface for unmarshallers which unmarshall objects from response data. - The Unmarshallers are stateless, and only encode the rules for what data - in the XML stream goes into what members of an object. - - The type of object the unmarshaller returns - The type of the XML unmashaller context, which contains the - state during parsing of the XML stream. Usually an instance of - Amazon.Runtime.Internal.Transform.UnmarshallerContext. - - - - Given the current position in the XML stream, extract a T. - - The XML parsing context - An object of type T populated with data from the XML stream. - - - - Interface for unmarshallers which unmarshall service responses. - The Unmarshallers are stateless, and only encode the rules for what data - in the XML stream goes into what members of an object. - - The type of object the unmarshaller returns - The type of the XML unmashaller context, which contains the - state of parsing the XML stream. Uaually an instance of - Amazon.Runtime.Internal.Transform.UnmarshallerContext. - - - - Extracts an exeption with data from an ErrorResponse. - - The XML parsing context. - An inner exception to be included with the returned exception - The HttpStatusCode from the ErrorResponse - Either an exception based on the ErrorCode from the ErrorResponse, or the - general service exception for the service in question. - - - - Interface for unmarshallers which unmarshall objects from response data. - The Unmarshallers are stateless, and only encode the rules for what data - in the XML stream goes into what members of an object. - - The type of object the unmarshaller returns - The type of the XML unmashaller context, which contains the - state during parsing of the XML stream. Usually an instance of - Amazon.Runtime.Internal.Transform.UnmarshallerContext. - - - - Given the current position in the XML stream, extract a T. - - The XML parsing context - An object of type T populated with data from the XML stream. - - - - First-pass unmarshaller for all errors - - - - - Build an ErrorResponse from json - - The json parsing context. - Usually an Amazon.Runtime.Internal.JsonUnmarshallerContext. - An ErrorResponse object. - - - - Return an instance of JsonErrorResponseUnmarshaller. - - - - - - Wraps a json string for unmarshalling. - - Each Read() operation gets the next token. - TestExpression() is used to match the current key-chain - to an xpath expression. The general pattern looks like this: - - JsonUnmarshallerContext context = new JsonUnmarshallerContext(jsonString); - while (context.Read()) - { - if (context.IsKey) - { - if (context.TestExpresion("path/to/element")) - { - myObject.stringMember = stringUnmarshaller.GetInstance().Unmarshall(context); - continue; - } - } - } - - - - - - Wrap the jsonstring for unmarshalling. - - Stream that contains the JSON for unmarshalling - If set to true, maintains a copy of the complete response body constraint to log response size as the stream is being read. - Response data coming back from the request - If set to true, maintains a copy of the complete response body as the stream is being read. - - - - Are we at the start of the json document. - - - - - Is the current token the end of an object - - - - - Is the current token the start of an object - - - - - Returns the element depth of the parser's current position in the json - document being parsed. - - - - - The current Json path that is being unmarshalled. - - - - - Reads to the next token in the json document, and updates the context - accordingly. - - - True if a token was read, false if there are no more tokens to read. - - - - - Peeks at the next token. This peek implementation - reads the next token and makes the subsequent Read() return the same data. - If Peek is called successively, it will return the same data. - Only the first one calls Read(), subsequent calls - will return the same data until a Read() call is made. - - Token to peek. - Returns true if the peeked token matches given token. - - - - Returns the text contents of the current token being parsed. - - - The text contents of the current token being parsed. - - - - - The type of the current token - - - - - Get the base stream of the jsonStream. - - - - - Peeks at the next (non-whitespace) character in the jsonStream. - - The next (non-whitespace) character in the jsonStream, or -1 if at the end. - - - - Peeks at the next character in the stream. - If the data isn't buffered into the StreamReader (Peek() returns -1), - we flush the buffered data and try one more time. - - - - - - Abstract class for unmarshalling service responses. - - - - - Class for unmarshalling XML service responses. - - - - - Class for unmarshalling EC2 service responses. - - - - - Class for unmarshalling JSON service responses. - - - - - Unmarshaller for int fields - - - - - Unmarshaller for nullable int fields. Implemented only for JSON context - to handle cases where value can be null e.g. {'Priority': null}. - This unmarshaller is not implemented for XML context, as XML responses - will null elements (xsi:nil='true') will be skipped by the XML parser. - - - - - Unmarshaller for long fields - - - - - Unmarshaller for float fields - - - - - Unmarshaller for double fields - - - - - Unmarshaller for decimal fields - - - - - Unmarshaller for bool fields - - - - - Unmarshaller for string fields - - - - - Unmarshaller for byte fields - - - - - Unmarshaller for DateTime fields - - - - - Unmarshalls given string as a DateTime. Handles cases where we want to unmarshall - as just a DateTime or a nullable Datetime. - - Value to be parsed - If true, the method will return null if text is null. - If false, the method will return default(DateTime), if text is null. - - - - - Unmarshaller for nullable DateTime fields. Implemented only for JSON context - to handle cases where value can be null e.g. {'Priority': null}. - This unmarshaller is not implemented for XML context, as XML responses - will null elements (xsi:nil='true') will be skipped by the XML parser. - - - - - Unmarshaller for MemoryStream fields - - - - - Unmarshaller for ResponseMetadata - - - - - Base class for the UnmarshallerContext objects that are used - to unmarshall a web-service response. - - - - - Tests the specified expression against the current position in the XML - document - - The pseudo-XPath expression to test. - - True if the expression matches the current position in the document, - false otherwise. - - - - Tests the specified expression against the current position in the XML - document being parsed, and restricts the expression to matching at the - specified stack depth. - - The pseudo-XPath expression to test. - - The depth in the stack representing where the expression must - start matching in order for this method to return true. - - True if the specified expression matches the current position in - the XML document, starting from the specified depth. - - - - Reads the next token at depth greater than or equal to target depth. - - Tokens are read at depth greater than or equal to target depth. - True if a token was read and current depth is greater than or equal to target depth. - - - - The current path that is being unmarshalled. - - - - - Returns the element depth of the parser's current position in the - document being parsed. - - - - - Reads to the next node in the document, and updates the context accordingly. - - - True if a node was read, false if there are no more elements to read. - - - - - Returns the text contents of the current element being parsed. - - - The text contents of the current element being parsed. - - - - - True if NodeType is Element. - - - - - True if NodeType is EndElement. - - - - - True if the context is at the start of the document. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Wrap an XmltextReader for simulating an event stream. - - Each Read() operation goes either to the next element or next attribute within - the current element. TestExpression() is used to match the current event - to an xpath expression. The general pattern looks like this: - - UnmarshallerContext context = new UnmarshallerContext(...); - while (context.Read()) - { - if (context.TestExpresion("path/to/element")) - { - myObject.stringMember = stringUnmarshaller.GetInstance().Unmarshall(context); - continue; - } - if (context.TestExpression("path/to/@attribute")) - myObject.MyComplexTypeMember = MyComplexTypeUnmarshaller.GetInstance().Unmarshall(context); - } - - - - - - Wrap an XmlTextReader with state for event-based parsing of an XML stream. - - Stream with the XML from a service response. - If set to true, maintains a copy of the complete response body constraint to log response size as the stream is being read. - Response data coming back from the request - If set to true, maintains a copy of the complete response body as the stream is being read. - - - - The current XML path that is being unmarshalled. - - - - - Returns the element depth of the parser's current position in the XML - document being parsed. - - - - - Reads to the next node in the XML document, and updates the context accordingly. - - - True if a node was read, false if there are no more elements to read./ - - - - - Returns the text contents of the current element being parsed. - - - The text contents of the current element being parsed. - - - - - True if NodeType is Element. - - - - - True if NodeType is EndElement. - - - - - True if the context is at the start of the document. - - - - - True if NodeType is Attribute. - - - - - Wrap an XmlTextReader with state for event-based parsing of an XML stream. - - Stream with the XML from a service response. - If set to true, maintains a copy of the complete response body constraint to log response size as the stream is being read. - Response data coming back from the request - If set to true, maintains a copy of the complete response body as the stream is being read. - - - - RequestId value, if found in response - - - - - Reads to the next node in the XML document, and updates the context accordingly. - If node is RequestId, reads the contents and stores in RequestId property. - - - True if a node was read, false if there are no more elements to read./ - - - - - Constructs a new instance of the HttpWebRequestResponseData class with serialized data. - - The that holds the serialized object data. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - A stream which caches the contents of the underlying stream as it reads it. - - - - - All the bytes read by the stream. - - - - - All the bytes read by the stream constrained with _cacheLimit - - - - - Initializes the CachingWrapperStream with a base stream. - - The stream to be wrapped. - Maximum number of bytes to be cached. - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Gets a value indicating whether the current stream supports seeking. - CachingWrapperStream does not support seeking, this will always be false. - - - - - Gets or sets the position within the current stream. - CachingWrapperStream does not support seeking, attempting to set Position - will throw NotSupportedException. - - - - - Sets the position within the current stream. - CachingWrapperStream does not support seeking, attempting to call Seek - will throw NotSupportedException. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Stream wrapper that double-buffers from a wrapped stream and - returns the buffered content as a series of signed 'chunks' - for the AWS4 ('Signature V4') protocol. - - - - - Reads some or all of the processed chunk to the consumer, constructing - and streaming a new chunk if more input data is available. - - - - - - - - - Attempt to read sufficient data for a whole chunk from the wrapped stream, - returning the number of bytes successfully read to be processed into a chunk - - - - - Results of the header-signing portion of the request - - - - - Computed signature of the chunk prior to the one in-flight, in - hex - - - - - Computes the derived signature for a chunk of data of given length in the input buffer, - placing a formatted chunk with headers, signature and data into the output buffer - ready for streaming back to the consumer. - - - - - - Length override to return the true length of the payload plus the metainfo - supplied with each chunk - - - - - Computes the total size of the data payload, including the chunk metadata. - Called externally so as to be able to set the correct Content-Length header - value. - - - - - - - Computes the size of the header data for each chunk. - - - - - - - Attempt to read sufficient data for a whole chunk from the wrapped stream, - returning the number of bytes successfully read to be processed into a chunk - - - - - A list object that will always be sent to AWS services, - even if it is empty. - The AWS .NET SDK does not send empty collections to services, unless - the collection is of this type. - - - - - - A dictionary object that will always be sent to AWS services, - even if it is empty. - The AWS .NET SDK does not send empty collections to services, unless - the collection is of this type. - - - - - - - Class to perform actions on a background thread. - Uses a single background thread and performs actions - on it in the order the data was sent through the instance. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Class to invoke actions on a background thread. - Uses a single background thread and invokes actions - on it in the order they were invoked through the instance. - - - - - PCL doesn't have IPAddress. These methods are copied from the Microsoft source code. - - - - - Returns true if the Content is set or there are - query parameters. - - This request - True if data is present; false otherwise. - - - - Utilities for dealing with Guids - - - - - Hashes a set of objects. - - - - - - - Combines a set of hashses. - - - - - - - Combines two hashes. - - - - - - - - Disposes of all managed and unmanaged resources. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - A wrapper stream that calculates a hash of the base stream as it - is being read. - The calculated hash is only available after the stream is closed or - CalculateHash is called. After calling CalculateHash, any further reads - on the streams will not change the CalculatedHash. - If an ExpectedHash is specified and is not equal to the calculated hash, - Close or CalculateHash methods will throw an AmazonClientException. - If CalculatedHash is calculated for only the portion of the stream that - is read. - - - Exception thrown during Close() or CalculateHash(), if ExpectedHash is set and - is different from CalculateHash that the stream calculates, provided that - CalculatedHash is not a zero-length byte array. - - - - - Algorithm to use to calculate hash. - - - - - True if hashing is finished and no more hashing should be done; - otherwise false. - - - - - Current position in the stream. - - - - - Calculated hash for the stream. - This value is set only after the stream is closed. - - - - - Expected hash value. Compared against CalculatedHash upon Close(). - If the hashes are different, an AmazonClientException is thrown. - - - - - Expected length of stream. - - - - - Initializes an HashStream with a hash algorithm and a base stream. - - Stream to calculate hash for. - - Expected hash. Will be compared against calculated hash on stream close. - Pass in null to disable check. - - - Expected length of the stream. If the reading stops before reaching this - position, CalculatedHash will be set to empty array. - - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Asynchronously reads a sequence of bytes from the current stream, advances - the position within the stream by the number of bytes read, and monitors - cancellation requests. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous read operation. The value of the TResult - parameter contains the total number of bytes read into the buffer. This can be - less than the number of bytes requested if that many bytes are not currently - available, or zero (0) if the end of the stream has been reached. - - - - - Closes the underlying stream and finishes calculating the hash. - If an ExpectedHash is specified and is not equal to the calculated hash, - this method will throw an AmazonClientException. - - - If ExpectedHash is set and is different from CalculateHash that the stream calculates. - - - - - Gets a value indicating whether the current stream supports seeking. - HashStream does not support seeking, this will always be false. - - - - - Gets or sets the position within the current stream. - HashStream does not support seeking, attempting to set Position - will throw NotSupportedException. - - - - - Sets the position within the current stream. - HashStream does not support seeking, attempting to call Seek - will throw NotSupportedException. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Gets the overridden length used to construct the HashStream - - - - - Calculates the hash for the stream so far and disables any further - hashing. - - - - - Resets the hash stream to starting state. - Use this if the underlying stream has been modified and needs - to be rehashed without reconstructing the hierarchy. - - - - - Validates the underlying stream. - - - - - Compares two hashes (arrays of bytes). - - Expected hash. - Actual hash. - - True if the hashes are identical; otherwise false. - - - - - A wrapper stream that calculates a hash of the base stream as it - is being read or written. - The calculated hash is only available after the stream is closed or - CalculateHash is called. After calling CalculateHash, any further reads - on the streams will not change the CalculatedHash. - If an ExpectedHash is specified and is not equal to the calculated hash, - Close or CalculateHash methods will throw an AmazonClientException. - If base stream's position is not 0 or HashOnReads is true and the entire stream is - not read, the CalculatedHash will be set to an empty byte array and - comparison to ExpectedHash will not be made. - - - Exception thrown during Close() or CalculateHash(), if ExpectedHash is set and - is different from CalculateHash that the stream calculates, provided that - CalculatedHash is not a zero-length byte array. - - - - - Initializes an HashStream with a hash algorithm and a base stream. - - Stream to calculate hash for. - - Expected hash. Will be compared against calculated hash on stream close. - Pass in null to disable check. - - - Expected length of the stream. If the reading stops before reaching this - position, CalculatedHash will be set to empty array. - - - - - A wrapper stream that calculates an MD5 hash of the base stream as it - is being read or written. - The calculated hash is only available after the stream is closed or - CalculateHash is called. After calling CalculateHash, any further reads - on the streams will not change the CalculatedHash. - If an ExpectedHash is specified and is not equal to the calculated hash, - Close or CalculateHash methods will throw an AmazonClientException. - If base stream's position is not 0 or HashOnReads is true and the entire stream is - not read, the CalculatedHash will be set to an empty byte array and - comparison to ExpectedHash will not be made. - - - Exception thrown during Close() or CalculateHash(), if ExpectedHash is set and - is different from CalculateHash that the stream calculates, provided that - CalculatedHash is not a zero-length byte array. - - - - - Initializes an MD5Stream with a base stream. - - Stream to calculate hash for. - - Expected hash. Will be compared against calculated hash on stream close. - Pass in null to disable check. - - - Expected length of the stream. If the reading stops before reaching this - position, CalculatedHash will be set to empty array. - - - - - Utilities for validating label values for host prefix templates - - - - - Validates a label value - - - - - Simple wrapper around the log4net Error method. - - - - - - - - Write debug message to Console - - - - - - - - Write debug message to Console - - - - - - - Simple wrapper around the log4net InfoFormat method. - - - - - - - This is a dynamic wrapper around log4net so we can avoid log4net being required - to be distributed with the SDK. - - - - - Abstract logger class, base for any custom/specific loggers. - - - - - Flushes the logger contents. - - - - - Simple wrapper around the log4net IsErrorEnabled property. - - - - - Simple wrapper around the log4net IsDebugEnabled property. - - - - - Simple wrapper around the log4net IsInfoEnabled property. - - - - - Simple wrapper around the log4net Error method. - - - - - - - - Simple wrapper around the log4net Debug method. - - - - - - - - Simple wrapper around the log4net DebugFormat method. - - - - - - - Simple wrapper around the log4net InfoFormat method. - - - - - - - Logger wrapper for reflected log4net logging methods. - - - - - This should be a one time call to use reflection to find all the types and methods - needed for the logging API. - - - - - Simple wrapper around the log4net IsErrorEnabled property. - - - - - Simple wrapper around the log4net Error method. - - - - - - - - Simple wrapper around the log4net IsDebugEnabled property. - - - - - Simple wrapper around the log4net Debug method. - - - - - - - - Simple wrapper around the log4net DebugFormat method. - - - - - - - Simple wrapper around the log4net IsInfoEnabled property. - - - - - Simple wrapper around the log4net InfoFormat method. - - - - - - - A single logged message - - - - - Log message arguments. - - - - - Culture-specific formatting provider. - - - - - Log message format. - - - - - a size-limited cache of key value pairs - - Once the maximum size has been reached, the least recently - used pairs will be evicted to make room for any new items. - - - - - - - the maximum number of entries this LruCache will hold - before items begin getting evicted - - - - - the number of items in the cache - - - - - Construct a new LruCache. - - maximum number of entries before items are evicted - - - - Add the key/value pair to the cache, or update - the value if the key already exists. - - If the cache is full, evicts the least recently used item. - - - - - - - Evicts a specific key out of the cache if it exists - - the key to evict from the cache - - - - Try to get the value associated with the key. - - the key to look up - the value, if the key exists - true if there is a value associated with the key, or false if no value is associated with the key - - - - Try to get the value associated with the key, if it doesn't exist, use the provided factory method to - create a new value and tries adding it to the cache. - - the key to look up - the factory method used in case the key is not present in the cache - the looked up value or the value created by the factory - - - - Clear the LruCache of all entries. - - - - - Helper class to support LruCache. - Does not implement the error checking and synchronization that - would be necessary for it to stand alone. - - - - - Item to be stored in the LruList - linked list structure. - - - - - Collection of properties being tracked - - - - - Timings for metrics being tracked - - - - - Counters being tracked - - - - - Whether metrics are enabled for the request - - - - - Constructs an empty, disabled metrics object - - - - - Starts timing an event. Logs an exception if an event - of the same type was started but not stopped. - - - - - - - Stops timing an event. Logs an exception if the event wasn't started. - - - - - - - Adds a property for a metric. If there are multiple, the - object is added as a new item in a list. - - - - - - - Sets a counter for a specific metric. - - - - - - - Increments a specific metric counter. - If counter doesn't exist yet, it is set to 1. - - - - - - Returns errors associated with the metric, including - if there are still any timing events in-flight. - - - - - - Returns a string representation of the current metrics. - - - - - - Return a JSON represenation of the current metrics - - - - - - Timing information for a metric - - - - - Empty, stopped timing object - - - - - Timing object in a started state - - - - - - Stops timing - - - - - - Whether the timing has been stopped - - - - - Elapsed ticks from start to stop. - If timing hasn't been stopped yet, returns 0. - - - - - Elapsed time from start to stop. - If timing hasn't been stopped yet, returns TimeSpan.Zero - - - - - Timing event, stops timing of a metric when disposed - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - The destructor for the client class. - - - - - A wrapper stream which supresses disposal of the underlying stream. - - - - - Constructor for NonDisposingWrapperStream. - - The base stream to wrap. - - - - The Close implementation for this wrapper stream - does not close the underlying stream. - - - - - The Dispose implementation for this wrapper stream - does not close the underlying stream. - - - - - This class is used to wrap a stream for a particular segment of a stream. It - makes that segment look like you are reading from beginning to end of the stream. - - - - - Asynchronously reads a sequence of bytes from the current stream, advances - the position within the stream by the number of bytes read, and monitors - cancellation requests. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous read operation. The value of the TResult - parameter contains the total number of bytes read into the buffer. This can be - less than the number of bytes requested if that many bytes are not currently - available, or zero (0) if the end of the stream has been reached. - - - - - Asynchronously writes a sequence of bytes to the current stream and advances the - current position within this stream by the number of bytes written. - - - An array of bytes. This method copies count bytes from buffer to the current stream. - - - The zero-based byte offset in buffer at which to begin copying bytes to the - current stream. - - The number of bytes to be written to the current stream. - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - A task that represents the asynchronous write operation. - - - - Wrapper stream that only supports reading - - - - - Asynchronously clears all buffers for this stream and causes any buffered data - to be written to the underlying device. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous flush operation. - - - - - Asynchronously writes a sequence of bytes to the current stream and advances the - current position within this stream by the number of bytes written. - - - An array of bytes. This method copies count bytes from buffer to the current stream. - - - The zero-based byte offset in buffer at which to begin copying bytes to the - current stream. - - The number of bytes to be written to the current stream. - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - A task that represents the asynchronous write operation. - - - - Partial wrapper stream that only supports reading - - - - - Uri wrapper that can parse out information (bucket, key, region, style) from an - S3 URI. - - - - - True if the URI contains the bucket in the path, false if it contains the bucket in the authority. - - - - - The bucket name parsed from the URI (or null if no bucket specified). - - - - - The key parsed from the URI (or null if no key specified). - - - - - The region parsed from the URI (or null if no region specified). - - - - - Constructs a parser for the S3 URI specified as a string. - - The S3 URI to be parsed. - - - - Constructs a parser for the S3 URI specified as a Uri instance. - - The S3 URI to be parsed. - - - - Percent-decodes the given string, with a fast path for strings that are not - percent-encoded. - - The string to decode - The decoded string - - - - Percent-decodes the given string. - - The string to decode - The index of the first '%' in the string - The decoded string - - - - Decodes the percent-encoded character at the given index in the string - and appends the decoded value to the string under construction. - - - The string under construction to which the decoded character will be - appended. - - The string being decoded. - The index of the '%' character in the string. - - - - Converts a hex character (0-9A-Fa-f) into its corresponding quad value. - - The hex character - The quad value - - - - Interface for a non-generic cache. - - - - - Clears the entire cache. - - - - - Maximum time to keep an item around after its last use. - - - - - How often should the cache be cleared of old items. - - - - - The number of items in the cache. - - - - - Interface for a generic cache. - - - - - - - Retrieves a value out of the cache or from the source. - - - - - - - - Retrieves a value out of the cache or from the source. - If the item was in the cache, isStaleItem is set to true; - otherwise, if the item comes from the source, isStaleItem is false. - - - - - - - - - Clears a specific value from the cache if it's there. - - - - - - Returns the keys for all items in the cache. - - - - - - Executes specified operation, catches exception, clears the cache for - the given key, retries the operation. - - - - - - - - - - - SDK-wide cache. - Provides access to caches specific to a particular set of credentials - and target region. - - - - - Clear all caches - - - - - Clear all caches of a particular type - - - - - - Retrieve a cache of a specific type for a client object. - The client object can be null in cases where a cache does - not correspond to a specific AWS account or target region. - - - - - - - - - - - Retrieve a cache of a specific type for a client object. - The client object can be null in cases where a cache does - not correspond to a specific AWS account or target region. - - - - - - - - - - - Utilities for converting objects to strings. Used by the marshaller classes. - - - - - Converts a DateTime to ISO8601 formatted string. - - - - - Converts a DateTime to RFC822 formatted string. - - - - - Converts a DateTime to Unix epoch time formatted string. - - - - - A wrapper stream. - - - - - Base stream. - - - - - Initializes WrapperStream with a base stream. - - - - - - Returns the first base non-WrapperStream. - - First base stream that is non-WrapperStream. - - - - Returns the first base non-WrapperStream. - - First base stream that is non-WrapperStream. - - - - Returns the first base non-WrapperStream. - - Potential WrapperStream - Base non-WrapperStream. - - - - Gets a value indicating whether the current stream supports reading. - True if the stream supports reading; otherwise, false. - - - - - Gets a value indicating whether the current stream supports seeking. - True if the stream supports seeking; otherwise, false. - - - - - Gets a value indicating whether the current stream supports writing. - True if the stream supports writing; otherwise, false. - - - - - Closes the current stream and releases any resources (such as sockets and - file handles) associated with the current stream. - - - - - Gets the length in bytes of the stream. - - - - - Gets or sets the position within the current stream. - - - - - Gets or sets a value, in miliseconds, that determines how long the stream - will attempt to read before timing out. - - - - - Gets or sets a value, in miliseconds, that determines how long the stream - will attempt to write before timing out. - - - - - Clears all buffers for this stream and causes any buffered data to be written - to the underlying device. - - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Sets the position within the current stream. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Sets the length of the current stream. - - The desired length of the current stream in bytes. - - - - Writes a sequence of bytes to the current stream and advances the current - position within this stream by the number of bytes written. - - - An array of bytes. This method copies count bytes from buffer to the current stream. - - - The zero-based byte offset in buffer at which to begin copying bytes to the - current stream. - - The number of bytes to be written to the current stream. - - - - Asynchronously clears all buffers for this stream and causes any buffered data - to be written to the underlying device. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous flush operation. - - - - - Asynchronously reads a sequence of bytes from the current stream, advances - the position within the stream by the number of bytes read, and monitors - cancellation requests. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous read operation. The value of the TResult - parameter contains the total number of bytes read into the buffer. This can be - less than the number of bytes requested if that many bytes are not currently - available, or zero (0) if the end of the stream has been reached. - - - - - Asynchronously writes a sequence of bytes to the current stream and advances the - current position within this stream by the number of bytes written. - - - An array of bytes. This method copies count bytes from buffer to the current stream. - - - The zero-based byte offset in buffer at which to begin copying bytes to the - current stream. - - The number of bytes to be written to the current stream. - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - A task that represents the asynchronous write operation. - - - - A wrapper stream that decrypts the base stream as it - is being read. - - - - - Initializes an DecryptStream with an decryption algorithm and a base stream. - - Stream to perform encryption on.. - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Asynchronously reads a sequence of bytes from the current stream and advances - the position within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Gets a value indicating whether the current stream supports seeking. - DecryptStream does not support seeking, this will always be false. - - - - - Gets or sets the position within the current stream. - DecryptStream does not support seeking, attempting to set Position - will throw NotSupportedException. - - - - - Sets the position within the current stream. - DecryptStream does not support seeking, attempting to call Seek - will throw NotSupportedException. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Validates the underlying stream. - - - - - A wrapper stream that decrypts the base stream as it - is being read. - - - - - Initializes an DecryptStream with an decryption algorithm and a base stream. - - Stream to perform encryption on.. - Symmetric key to perform decryption - Initialization vector to perform decryption - - - - A wrapper stream that decrypts the base stream using AES algorithm as it - is being read. - - - - - Initializes an AESDecryptionStream with a base stream. - - Stream to perform decryption on.. - Symmetric key to perform decryption - Initialization vector to perform decryption - - - - A wrapper stream that encrypts the base stream as it - is being read. - - - - - Initializes an EncryptStream with an encryption algorithm and a base stream. - - Stream to perform encryption on.. - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Asynchronously reads a sequence of bytes from the current stream, advances - the position within the stream by the number of bytes read, and monitors - cancellation requests. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous read operation. The value of the TResult - parameter contains the total number of bytes read into the buffer. This can be - less than the number of bytes requested if that many bytes are not currently - available, or zero (0) if the end of the stream has been reached. - - - - - Gets a value indicating whether the current stream supports seeking. - - - - - Returns encrypted content length. - - - - - Gets or sets the position within the current stream. - - - - - Sets the position within the current stream. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Validates the underlying stream. - - - - - A wrapper stream that encrypts the base stream as it - is being read. - - - - - Initializes an EncryptStream with an encryption algorithm and a base stream. - - Stream to perform encryption on.. - Symmetric key to perform encryption - Initialization vector to perform encryption - - - - A wrapper stream that encrypts the base stream using AES algorithm as it - is being read. - - - - - Initializes an AESEncryptionStream with a base stream. - - Stream to perform encryption on.. - Symmetric key to perform encryption - Initialization vector to perform encryption - - - - A wrapper stream that encrypts the base stream as it - is being read. - - - - - Initializes an EncryptStream for Multipart uploads with an encryption algorithm and a base stream. - - Stream to perform encryption on.. - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Asynchronously reads a sequence of bytes from the current stream, advances - the position within the stream by the number of bytes read, and monitors - cancellation requests. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous read operation. The value of the TResult - parameter contains the total number of bytes read into the buffer. This can be - less than the number of bytes requested if that many bytes are not currently - available, or zero (0) if the end of the stream has been reached. - - - - - Gets a value indicating whether the current stream supports seeking. - - - - - Returns encrypted content length. - - - - - Gets or sets the position within the current stream. - - - - - Sets the position within the current stream. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Validates the underlying stream. - - - - - A wrapper stream that encrypts the base stream as it - is being read. - - - - - Initializes an EncryptStream with an encryption algorithm and a base stream. - - Stream to perform encryption on.. - Symmetric key to perform encryption - Initialization vector to perform encryption - - - - A wrapper stream that encrypts the base stream as it - is being read. - - - - - Initializes an AESEncryptionStream with a base stream. - - Stream to perform encryption on.. - Symmetric key to perform encryption - Initialization vector to perform encryption - - - - Provides read/write access to a file in the INI format. - - This class is not threadsafe. - - - - - Construct a new IniFile. - - path of the IniFile - - - - the path of the file - - - - - helper to access the lines of the file - - - - - Persist the changes to this INI file to disk. - - - - - Rename the section fromSectionName to toSectionName - - - - - - - Rename the section fromSectionName to toSectionName - - - - if true and destination section already exists overwrite it - - - - Copy the section fromSectionName to toSectionName - - - - Any properties in the original section that are also in this dictionary will - be replaced by the value from this dictionary. - - - - Copy the section fromSectionName to toSectionName - - - - Any properties in the original section that are also in this dictionary will - be replaced by the value from this dictionary. - if true and destination section already exists overwrite it - - - - Update the section with the properties given. - If the section doesn't exist, it will be appended to the file. - - Notes: - 1. Any properties that do exist in the section will be updated. - 2. A null value for a property denotes that it should be deleted from the section - 3. If any properties don't exist they will be appended to the end of the section - in the same order they appear in the SortedDictionary. - - name of the section to operate on - properties to add/update/delete - - - - Check if the section exists. If not, append it to the end of the file. - - section to ensure exists - - - - If the section exists, delete it from the INI file. - - section to delete - - - - Determine if a section exists in the INI file. - - name of section to look for - true if the section exists, false otherwise - - - - Return the properties for the section if it exists. - - name of section to get - properties contained in the section - True if the section was found, false otherwise - - - - Return the properties for the section if it exists. - - Regex to match name of section to get - properties contained in the section - True if the section was found, false otherwise - - - - Return the properties for the section if it exists. - - Regex to match name of section to get - name of section if regex matches - properties contained in the section - True if the section was found, false otherwise - - - - Logger wrapper for System.Diagnostics.TraceSource logger. - - - - - Creates TraceRoute for a given Type or the closest "parent" that has a listener configured. - Example: if type is Amazon.DynamoDB.AmazonDynamoDBClient, listeners can be configured for: - -Amazon.DynamoDB.AmazonDynamoDBClient - -Amazon.DynamoDB - -Amazon - The first matching TraceSource with listeners will be used. - If no listeners are configured for type or one of its "parents", will return null. - - - - - Gets a TraceSource for given Type with SourceLevels.All. - If there are no listeners configured for targetType or one of its "parents", returns null. - - - - - - - Gets a TraceSource for given Type and SourceLevels. - If there are no listeners configured for targetType or one of its "parents", returns null. - - - - - - - - Provides line-based read/write access to a file. - The file can be read into memory, changed, then written back to disk. - When the file is persisted back to disk, an optimistic concurrency - check is performed to make sure the file hasn't changed since it was - originally read. - - This class is not threadsafe. - - - - - a full copy of the original file - This is used for optimistic concurrency. - Note that this assumes a small file and does not scale large files. - - - - - path of the file - - - - - Read/write access to the lines that make up the file. - Any changes to this List are persisted back to disk when Persist() is called. - - NOTE: - The lines have the original line endings on them to preserve the - original text as much as possible. - - - - - Construct a new OptimisticLockedTextFile. - - path of the file - - - - Persist changes to disk after an optimistic concurrency check is completed. - - - - - Subclass of IniFile that allows INI sections to be read with the profile keyword in front of the section name. - - - - - This class is no longer used anymore and should be avoided as it is just meant - as a last resort when blending async and sync operations. The code is still - here to support versions before 3.3.9.0 of AWSSDK.DynamoDBv2. - - - - - Collection of parameters that an SDK client will send to a service. - - - - - Constructs empty ParameterCollection. - - - - - Adds a parameter with a string value. - - - - - - - Adds a parameter with a list-of-strings value. - - - - - - - Converts the current parameters into a list of key-value pairs. - - - - - - Property to denote that the last exception returned by an AWS Service - was retryable or not. - - - - - This handler processes exceptions thrown from the HTTP handler and - unmarshalls error responses. - - - - - Default set of exception handlers. - - - - - Default set of exception handlers. - - - - - Constructor for ErrorHandler. - - an ILogger instance. - - - - Handles and processes any exception thrown from underlying handlers. - - The execution context which contains both the - requests and response context. - - - - Handles and processes any exception thrown from underlying handlers. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Disposes the response body. - - The response context. - - - - Processes an exception by invoking a matching exception handler - for the given exception. - - The execution context, it contains the - request and response context. - The exception to be processed. - - This method returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception that may be thrown by exception - processing by a matching exception handler. - - - - - The abstract base class for exception handlers. - - The exception type. - - - - The exception handler for HttpErrorResponseException exception. - - - - - The constructor for HttpErrorResponseExceptionHandler. - - in instance of ILogger. - - - - Handles an exception for the given execution context. - - The execution context, it contains the - request and response context. - The exception to handle. - - Returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception to replace the original exception. - - - - - Checks if a HTTP 404 status code is returned which needs to be suppressed and - processes it. - If a suppressed 404 is present, it unmarshalls the response and returns true to - indicate that a suppressed 404 was processed, else returns false. - - The execution context, it contains the - request and response context. - - - If a suppressed 404 is present, returns true, else returns false. - - - - - The exception handler for HttpErrorResponseException exception. - - - - - A pipeline handler which provides hooks to run - external code in the pre-invoke and post-invoke phases. - - - - - Action to execute on the pre invoke phase. - - - - - Action to execute on the post invoke phase. - - - - - Calls the PreInvoke and PostInvoke methods before and after calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls the PreInvoke and PostInvoke methods before and after calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Executes the OnPreInvoke action as part of pre-invoke. - - The execution context, it contains the - request and response context. - - - - Executes the OnPreInvoke action as part of post-invoke. - - The execution context, it contains the - request and response context. - - - - This handler retrieved the AWS credentials to be used for the current call. - - - - - The constructor for CredentialsRetriever. - - An AWSCredentials instance. - - - - Retrieves the credentials to be used for the current call before - invoking the next handler. - - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - This handler resolves the endpoint to be used for the current request. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Resolves the endpoint to be used for the current request - before invoking the next handler. - - The execution context, it contains the - request and response context. - - - - This handler resolves the endpoint to be used for the current request. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Resolves the endpoint to be used for the current request - before invoking the next handler. - - The execution context, it contains the - request and response context. - - - - Determines the endpoint for the request. - - The request context. - - - - - This handler provides an OnError action that can be used as hook for - external code to handle exceptions in the runtime pipeline. - - - - - Action to execute if an exception occurs during the - execution of any underlying handlers. - - - - - Executes the OnError action if an exception occurs during the - execution of any underlying handlers. - - - - - - - This handler marshalls the request before calling invoking the next handler. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Marshalls the request before calling invoking the next handler. - - The execution context, it contains the - request and response context. - - - - This handler manages the metrics used to time the complete call and - logs the final metrics. - - - - - Captures the overall execution time and logs final metrics. - - The execution context which contains both the - requests and response context. - - - - Captures the overall execution time and logs final metrics. - - The response type for the current request. - - The execution context, it contains the request and response context. - - A task that represents the asynchronous operation. - - - - This handler processes HTTP redirects and reissues the call to the - redirected location. - - - - - Processes HTTP redirects and reissues the call to the - redirected location. - - The execution context which contains both the - requests and response context. - - - - Processes HTTP redirects and reissues the call to the - redirected location. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Checks if an HTTP 307 (temporary redirect) has occured and changes the - request endpoint to the redirected location. - - - The execution context, it contains the request and response context. - - - A boolean value that indicates if a redirect has occured. - - - - - This handler signs the request. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Signs the request before invoking the next handler. - - - The execution context, it contains the request and response context. - - - - - Determines if the request should be signed. - - The request context. - A boolean value that indicated if the request should be signed. - - - - Signs the request. - - The request context. - - - - This handler unmarshalls the HTTP response. - - - - - The constructor for Unmarshaller. - - - Boolean value which indicated if the unmarshaller - handler supports response logging. - - - - - Unmarshalls the response returned by the HttpHandler. - - The execution context which contains both the - requests and response context. - - - - Unmarshalls the response returned by the HttpHandler. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Unmarshalls the HTTP response. - - - The execution context, it contains the request and response context. - - - - - Constructs a new instance of the HttpErrorResponseException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - The HTTP handler contains common logic for issuing an HTTP request that is - independent of the underlying HTTP infrastructure. - - - - - - The sender parameter used in any events raised by this handler. - - - - - The constructor for HttpHandler. - - The request factory used to create HTTP Requests. - The sender parameter used in any events raised by this handler. - - - - Issues an HTTP request for the current request context. - - The execution context which contains both the - requests and response context. - - - - Issues an HTTP request for the current request context. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Determines the content for request body and uses the HTTP request - to write the content to the HTTP request body. - - Content to be written. - The HTTP request. - The request context. - - - - Determines the content for request body and uses the HTTP request - to write the content to the HTTP request body. - - Content to be written. - The HTTP request. - The request context. - - - - Creates the HttpWebRequest and configures the end point, content, user agent and proxy settings. - - The async request. - The web request that actually makes the call. - - - - Disposes the HTTP handler. - - - - - The request factory for System.Net.HttpWebRequest. - - - - - Some AWS services like Cloud 9 require at least TLS 1.1. Version of .NET Framework 4.5 and earlier - do not eanble TLS 1.1 and TLS 1.2 by default. This code adds those protocols if using an earlier - version of .NET that explicitly set the protocol and didn't have TLS 1.1 and TLS 1.2. - - - - - - Some AWS services like Cloud 9 require at least TLS 1.1. Version of .NET Framework 4.5 and earlier - do not eanble TLS 1.1 and TLS 1.2 by default. This code adds those protocols if using an earlier - version of .NET that explicitly set the protocol and didn't have TLS 1.1 and TLS 1.2. - - - - - - - Creates an HTTP request for the given URI. - - The request URI. - An HTTP request. - - - - This method is used for unit testing purposes. It allows setting of the flag - that indicates protocol setting was attempted. - - The new value - - - - Disposes the HttpWebRequestFactory. - - - - - HTTP request wrapper for System.Net.HttpWebRequest. - - - - - Constructor for HttpRequest. - - The request URI. - - - - The underlying HTTP web request. - - - - - The HTTP method or verb. - - - - - The request URI. - - - - - Returns the HTTP response. - - The HTTP response. - - - - Gets a handle to the request content. - - The request content. - - - - Writes a stream to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - The request context. - - - - Writes a byte array to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - - - - Aborts the HTTP request. - - - - - Writes a stream to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - The request context. - - - - Writes a byte array to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - - - - Gets a handle to the request content. - - - - - - Gets a handle to the request content. - - Used to cancel the request on demand - - - - - Returns the HTTP response. - - A cancellation token that can be used to cancel the asynchronous operation. - - - - - Configures a request as per the request context. - - The request context. - - - - Sets the headers on the request. - - A dictionary of header names and values. - - - - Disposes the HttpRequest. - - - - - Sets up the progress listeners - - The content stream - The interval at which progress needs to be published - The objects which is trigerring the progress changes - The callback which will be invoked when the progress changed event is trigerred - an object, incase the progress is setup, else returns the original stream - - - - An abstract pipeline handler that has implements IPipelineHandler, - and has the default implmentation. This is the base class for most of - the handler implementations. - - - - - The logger used to log messages. - - - - - The inner handler which is called after the current - handler completes it's processing. - - - - - The outer handler which encapsulates the current handler. - - - - - Contains the processing logic for a synchronous request invocation. - This method calls InnerHandler.InvokeSync to continue processing of the - request by the pipeline. - - The execution context which contains both the - requests and response context. - - - - Contains the processing logic for an asynchronous request invocation. - This method calls InnerHandler.InvokeSync to continue processing of the - request by the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Logs the metrics for the current execution context. - - The execution context, it contains the - request and response context. - - - - The default implementation of the adaptive retry policy. - - - The default implementation of the adaptive policy. - - - - - Constructor for AdaptiveRetryPolicy. - - The maximum number of retries before throwing - back a exception. This does not count the initial request. - - - - Constructor for AdaptiveRetryPolicy. - - The Client config object. This is used to - retrieve the maximum number of retries before throwing - back a exception(This does not count the initial request) and - the service URL for the request. - - - - OnRetry is called when a retry request is initiated to determine if the request will be retried. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - true if the error that will be retried is a throtting error - True if retry throttling is disabled or retry throttling is enabled and capacity can be obtained. - - - - This method uses a token bucket to enforce the maximum sending rate. - - The execution context which contains both the - requests and response context. - If the prior request failed, this exception is expected to be - the exception that occurred during the prior request failure. - - - - Virtual method that gets called on a success Response. If its a retry success response, the entire - retry acquired capacity is released(default is 5). If its just a success response a lesser value capacity - is released(default is 1). - - Request context containing the state of the request. - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - This method uses a token bucket to enforce the maximum sending rate. - - The execution context which contains both the - requests and response context. - If the prior request failed, this exception is expected to be - the exception that occurred during the prior request failure. - - - - The default implementation of the legacy retry policy. - - - The default implementation of the legacy retry policy. - - - - - The maximum value of exponential backoff in milliseconds, which will be used to wait - before retrying a request. The default is 30000 milliseconds. - - - - - Constructor for DefaultRetryPolicy. - - The maximum number of retries before throwing - back a exception. This does not count the initial request. - - - - Constructor for DefaultRetryPolicy. - - The Client config object. This is used to - retrieve the maximum number of retries before throwing - back a exception(This does not count the initial request) and - the service URL for the request. - - - - Returns true if the request is in a state where it can be retried, else false. - - Request context containing the state of the request. - Returns true if the request is in a state where it can be retried, else false. - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - true if the error that will be retried is a throtting error - - - - Virtual method that gets called on a success Response. If its a retry success response, the entire - retry acquired capacity is released(default is 5). If its just a success response a lesser value capacity - is released(default is 1). - - Request context containing the state of the request. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Request context containing the state of the request. - Return true if the request should be retried. - - - - Checks if the retry limit is reached. - - Request context containing the state of the request. - Return false if the request can be retried, based on number of retries. - - - - Waits before retrying a request. The default policy implements a exponential backoff. - - Request context containing the state of the request. - - - - Waits for an amount of time using an exponential backoff algorithm. - - The request retry index. The first request is expected to be 0 while - the first retry will be 1. - The max number of milliseconds to wait - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - The retry handler has the generic logic for retrying requests. - It uses a retry policy which specifies when - a retry should be performed. - - - - - The logger used to log messages. - - - - - The retry policy which specifies when - a retry should be performed. - - - - - Constructor which takes in a retry policy. - - Retry Policy - - - - Invokes the inner handler and performs a retry, if required as per the - retry policy. - - The execution context which contains both the - requests and response context. - - - - Invokes the inner handler and performs a retry, if required as per the - retry policy. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Prepares the request for retry. - - Request context containing the state of the request. - - - - The default implementation of the standard retry policy. - - - The default implementation of the standard policy. - - - - - The maximum value of exponential backoff in milliseconds, which will be used to wait - before retrying a request. The default is 20000 milliseconds. - - - - - Constructor for StandardRetryPolicy. - - The maximum number of retries before throwing - back a exception. This does not count the initial request. - - - - Constructor for StandardRetryPolicy. - - The Client config object. This is used to - retrieve the maximum number of retries before throwing - back a exception(This does not count the initial request) and - the service URL for the request. - - - - Returns true if the request is in a state where it can be retried, else false. - - Request context containing the state of the request. - Returns true if the request is in a state where it can be retried, else false. - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - true if the error that will be retried is a throtting error - - - - Virtual method that gets called on a success Response. If its a retry success response, the entire - retry acquired capacity is released(default is 5). If its just a success response a lesser value capacity - is released(default is 1). - - Request context containing the state of the request. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Request context containing the state of the request. - Return true if the request should be retried. - - - - Checks if the retry limit is reached. - - Request context containing the state of the request. - Return false if the request can be retried, based on number of retries. - - - - Waits before retrying a request. The default policy implements a exponential backoff with - jitter algorithm. - - Request context containing the state of the request. - - - - Waits for an amount of time using an exponential backoff with jitter algorithm. - - The request retry index. The first request is expected to be 0 while - the first retry will be 1. - The max number of milliseconds to wait - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - A runtime pipeline contains a collection of handlers which represent - different stages of request and response processing. - - - - - The top-most handler in the pipeline. - - - - - Constructor for RuntimePipeline. - - The handler with which the pipeline is initalized. - - - - Constructor for RuntimePipeline. - - List of handlers with which the pipeline is initalized. - - - - Constructor for RuntimePipeline. - - List of handlers with which the pipeline is initalized. - The logger used to log messages. - - - - Constructor for RuntimePipeline. - - The handler with which the pipeline is initalized. - The logger used to log messages. - - - - Invokes the pipeline synchronously. - - Request context - Response context - - - - Invokes the pipeline asynchronously. - - Request context - Response context - - - - Adds a new handler to the top of the pipeline. - - The handler to be added to the pipeline. - - - - Adds a handler after the first instance of handler of type T. - - Type of the handler after which the given handler instance is added. - The handler to be added to the pipeline. - - - - Adds a handler before the first instance of handler of type T. - - Type of the handler before which the given handler instance is added. - The handler to be added to the pipeline. - - - - Removes the first occurance of a handler of type T. - - Type of the handler which will be removed. - - - - Replaces the first occurance of a handler of type T with the given handler. - - Type of the handler which will be replaced. - The handler to be added to the pipeline. - - - - Inserts the given handler after current handler in the pipeline. - - Handler to be inserted in the pipeline. - Handler after which the given handler is inserted. - - - - Gets the innermost handler by traversing the inner handler till - it reaches the last one. - - - - - Retrieves a list of handlers, in the order of their execution. - - Handlers in the current pipeline. - - - - Retrieves current handlers, in the order of their execution. - - Handlers in the current pipeline. - - - - The CSM handler has the logic for capturing data for CSM attempts when enabled. - - - - - Invokes the CSM handler and captures data for the CSM attempts. - - - - - Calls the PreInvoke and PostInvoke methods before and after calling the next handler - in the pipeline. - - - - - Method that gets called in the final clause that captures data for each http request - from the request and response context. - - - - - Executes the OnPreInvoke action as part of pre-invoke. - - - - - Method to collect data in case of connection exception - - - - - Method to collect data in case of Amazon service exception - - - - - The CSM handler has the logic for capturing data for CSM events when enabled. - - - - - Invokes the CSM handler and captures data for the CSM events. - - - - - Calls the PreInvoke and PostInvoke methods before and after calling the next handler - in the pipeline. - - - - - Invoked from the finally block of CSMCallEventHandler's Invoke method. - This method is used to capture CSM Call event metrics. - - - - - - Method that gets invoked in case of an exception in the API request completion. - - - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - This class is responsible for managing adaptive retry mode client rate limiting. - - - - - The rate at which token are replenished. - - - - - The maximum capacity allowed in the token - - - - - The current capacity of the token - - - - - The last time the token bucket was refilled. - - - - - The smoothed rate which tokens are being retrieved. - - - - - The last half second time bucket used. - - - - - The number of requests seen within the current time - - - - - The maximum rate when the client was last throttled. - - - - - The last time when the client was throttled. - - - - - The cached time window calculation - - - - - Boolean indicating if the token bucket is enabled. - - - - - This method attempts to acquire capacity from the client's token - - The amount of capacity to obtain from the token bucket - Indicates that the client should or shouldn't sleep and - try again if capacity cannot be obtained. - - - - - This method attempts to acquire capacity from the client's token - - The amount of capacity to obtain from the token bucket - Indicates that the client should or shouldn't sleep and - try again if capacity cannot be obtained. - - Token which can be used to cancel the task. - - - - Updates the sending rate within the client's token bucket - - Indicates if the request resulted in a throttling error. - - - - Calculates the rate - - - Returns the calculated rate for a successful call - - - - Calculates the rate. - - The rate to use in the calculation - Returns the calculated rate for a throttled call - - - - This class gets the CSM configuration if set. - The priority goes - 1. App.config / instantiate on the AWSConfigs class - 2. Environment variable - 3. Shared Profile - - - - - Determine CSM configs from shared profile file. - - - - - Determine CSM configs from environment variables. - - - - - Determine CSM configs from AWSConfigs class. - - - - - Utility class for CSM. - Contains logic to serialize CSM events to Json. - - - - - Method to retrieve the API name from the request name. - - - - - Method to serialize MonitoringAPICallAttempt CSM event to json. - - - - - Method to serialize MonitoringAPICallEvent CSM event to json. - - - - - Method to serialize MonitoringAPICall CSM event to json. - - - - - Internal class that has the CSM configurations for the Monitoring Listener - after being derived from the CSMConfigChain class. - - - - - CSM event base class - - - - - Contains the operation name for the api call being made - - - - - Contains the service id ServiceId Sep of the service - against which the call is being made - - - - - Contains the "ClientId" configuration value - computed from the CSMConfigChain class - - - - - Contains the elapsed time, in milliseconds, - since January 1st, 1970, for the time point - at which the event occurred - - - - - Contains "ApiCall" or "ApiCallAttempt" - based on what the monitoring event is describing - - - - - Contains the enum of the above CSM type property - - - - - Contains the "Version" configuration value - computed from the CSMConfigChain class - Defaults to 1. - - - - - Contains the signing region used by the - service client that made the request attempt. - - - - - Contains the full value of the SDK's default - user agent header for http requests. - - - - - Class that captures the CSM Api Call Attempt Monitoring Events - for each http request and its subsequent response. - - - - - Contains the fully-qualified domain name of the endpoint that - the request attempt was submitted to. - - - - - Contains the session token passed - in the x-amz-security-token header. - - - - - Contains the aws_access_key value that - was used to sign the http request. - - - - - Contains the attempt's response status code, - as returned by the http client. - - - - - Contains the full text (exception object converted to String, - for example) for any attempt-level failure that is due to - something other than an Aws exception. The value of this entry - has a maximum length of 512. - - - - - Contains the short error name (exception class name, for example) - for any attempt-level failure that is due to something other - than an Aws exception.The value of this entry has a maximum length of 128. - - - - - Contains the Aws exception code returned in the response. - - - - - Contains the full text of the Aws exception message. - - - - - Contains the value of the response's x-amzn-RequestId header. - - - - - Contains the value of the response's x-amz-request-id header. - - - - - Contains the value of the response's x-amz-id-2 header. - - - - - Contains the elapsed time, in milliseconds, - between the construction of the http request and the - point in time where the http response has been parsed - or the attempt has definitively failed. - - - - - Class that captures the CSM Api Call Monitoring Events - for the entire SDK call. This is processed once. - - - - - Contains the total number of attempts that were made - by the service client to fulfill this request before succeeding or failing - - - - - Contains the elapsed time, in milliseconds, - between when the Api Call was begun and when a - final response or error is manifested to the caller - - - - - a boolean (0/1) value that is 0 unless the Api call failed - and the final attempt returned a retryable error.This entry should be - serialized as a numeric 0/1 value. This is mapped to MaxRetriesExceeded - when serialized to a UDP datagram. - - - - - Contains the full text (exception object - converted to String, for example) for an attempt-level failure that is due to - something other than an Aws exception that occurred on the last attempt to - fulfill the Api call.The value of this entry has a maximum length of 512. - - - - - Contains the short error name (exception - class name, for example) for a failure that is due to something other than an - Aws exception that occurred on the last attempt to fulfill an Api call.See - the SdkException entry for more details.The value of this entry has a - maximum length of 128. - - - - - Contains the Aws exception code - returned in the response to the final attempt at fulfilling this API call. - The value of this entry has a maximum length of 128. - - - - - - Contains the attempt's response status code, - as returned by the http client. - - - - - Provides information for Client Context header. - Client Context header needs information like App title, version code, version name, package name etc. - - - - - The title of your app. For example, "My App". - If this property is not null, the value would be used in Client Context header. - - - - - The version for your app. For example, V3.0. - If this property is not null, the value would be used in Client Context header. - - - - - The version code of your app. For example, 3.0. - If this property is not null, the value would be used in Client Context header. - - - - - The name of your app package. For example, com.your_company.your_app. - If this property is not null, the value would be used in Client Context header. - - - - - The operating system of the device. For example, iPhoneOS. - If this property is not null, the value would be used in Client Context header. - - - - - The version of the operating system of the device. For example, 8.1. - If this property is not null, the value would be used in Client Context header. - - - - - The locale of the device. For example, en_US. - If this property is not null, the value would be used in Client Context header. - - - - - The manufacturer of the device. For example, Samsung. - If this property is not null, the value would be used in Client Context header. - - - - - The model of the device. For example, Nexus. - If this property is not null, the value would be used in Client Context header. - - - - - This class is the base class of all the configurations settings to connect - to a service. - - - This class is the base class of all the configurations settings to connect - to a service. - - - - - Gets Service Version - - - - - Gets and sets of the signatureMethod property. - - - - - Gets and sets of the SignatureVersion property. - - Note: This property exists for backward compatibility but is no longer - used by any service other than S3. - - - - - Gets and sets of the UserAgent property. - - - - - When set to true, the service client will use the x-amz-user-agent - header instead of the User-Agent header to report version and - environment information to the AWS service. - - Note: This is especially useful when using a platform like WebAssembly - which doesn't allow to specify the User-Agent header. - - - - - Gets and sets the RegionEndpoint property. The region constant that - determines the endpoint to use. - - Setting this property to null will force the SDK to recalculate the - RegionEndpoint value based on App/WebConfig, environment variables, - profile, etc. - - - - - The constant used to lookup in the region hash the endpoint. - - - - - Gets and sets of the ServiceURL property. - This is an optional property; change it - only if you want to try a different service - endpoint. - - - - - Gets and sets the UseHttp. - If this property is set to true, the client attempts - to use HTTP protocol, if the target endpoint supports it. - By default, this property is set to false. - - - - - Given this client configuration, return a string form ofthe service endpoint url. - - - - - Gets and sets the AuthenticationRegion property. - Used in AWS4 request signing, this is an optional property; - change it only if the region cannot be determined from the - service endpoint. - - - - - Gets and sets the AuthenticationServiceName property. - Used in AWS4 request signing, this is the short-form - name of the service being called. - - - - - Returns the flag indicating how many retry HTTP requests an SDK should - make for a single SDK operation invocation before giving up. This flag will - return 4 when the RetryMode is set to "Legacy" which is the default. For - RetryMode values of "Standard" or "Adaptive" this flag will return 2. In - addition to the values returned that are dependant on the RetryMode, the - value can be set to a specific value by using the AWS_MAX_ATTEMPTS environment - variable, max_attempts in the shared configuration file, or by setting a - value directly on this property. When using AWS_MAX_ATTEMPTS or max_attempts - the value returned from this property will be one less than the value entered - because this flag is the number of retry requests, not total requests. To - learn more about the RetryMode property that affects the values returned by - this flag, see . - - - - - Determines if MaxErrorRetry has been manually set. - - - - - Gets and sets the LogResponse property. - If this property is set to true, the service response is logged. - The size of response being logged is controlled by the AWSConfigs.LoggingConfig.LogResponsesSizeLimit property. - - - - - Gets and sets the ReadEntireResponse property. - NOTE: This property does not effect response processing and is deprecated. - To enable response logging, the ClientConfig.LogResponse and AWSConfigs.LoggingConfig - properties can be used. - - - - - Gets and Sets the BufferSize property. - The BufferSize controls the buffer used to read in from input streams and write - out to the request. - - - - - - Gets or sets the interval at which progress update events are raised - for upload operations. By default, the progress update events are - raised at every 100KB of data transferred. - - - If the value of this property is set less than ClientConfig.BufferSize, - progress updates events will be raised at the interval specified by ClientConfig.BufferSize. - - - - - - Flag on whether to resign requests on retry or not. - For Amazon S3 and Amazon Glacier this value will always be set to true. - - - - - This flag controls if .NET HTTP infrastructure should follow redirection - responses (e.g. HTTP 307 - temporary redirect). - - - - - Flag on whether to log metrics for service calls. - - This can be set in the application's configs, as below: - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSLogMetrics" value"true"/> - </appSettings> - </configuration> - - - - - - Gets and sets the DisableLogging. If true logging for this client will be disabled. - - - - - Credentials to use with a proxy. - - - - - Specifies the TCP keep-alive values to use for service requests. - - - - - - If the value is set, the value is assigned to the Timeout property of the HttpWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Configures the endpoint calculation for a service to go to a dual stack (ipv6 enabled) endpoint - for the configured region. - - - Note: AWS services are enabling dualstack endpoints over time. It is your responsibility to check - that the service actually supports a dualstack endpoint in the configured region before enabling - this option for a service. - - - - - Enable or disable the Retry Throttling feature by setting the ThrottleRetries flag to True/False resepctively. - Retry Throttling is a feature that intelligently throttles retry attempts when a large precentage of requests - are failing and retries are unsuccessful as well. In such situations the allotted retry capacity for the service URL - will be drained until requests start to succeed again. Once the requisite capacity is available, retries would - be permitted again. When retries are throttled, the service enters a fail-fast behaviour as the traditional retry attempt - for the request would be circumvented. Hence, errors will resurface quickly. This will result in a greated number of exceptions - but prevents requests being tied up in unsuccessful retry attempts. - Note: Retry Throttling is enabled by default. Set the ThrottleRetries flag to false to switch off this feature. - - - - - Enable or disable the Nagle algorithm on the underlying http - client. - - This method is not intended to be called by consumers of the AWS SDK for .NET - - - - - - Performs validation on this config object. - Throws exception if any of the required values are missing/invalid. - - - - - Returns the current UTC now after clock correction for this endpoint. - - - - - The calculated clock skew correction for a specific endpoint, if there is one. - This field will be set if a service call resulted in an exception - and the SDK has determined that there is a difference between local - and server times. - - If is set to true, this - value will still be set to the correction, but it will not be used by the - SDK and clock skew errors will not be retried. - - - - - Gets and sets the DisableHostPrefixInjection flag. If true, host prefix injection will be disabled for this client, the default value of this flag is false. - Host prefix injection prefixes the service endpoint with request members from APIs which use this feature. - Example: for a hostPrefix of "foo-name." and a endpoint of "service.region.amazonaws.com" the default behavior is to - prefix the endpoint with the hostPrefix resulting in a final endpoint of "foo-name.service.region.amazonaws.com". Setting - DisableHostPrefixInjection to true will disable hostPrefix injection resulting in a final endpoint of - "service.region.amazonaws.com" regardless of the value of hostPrefix. E.g. You may want to disable host prefix injection for testing against a local mock endpoint. - - - - - Returns the flag indicating if endpoint discovery should be enabled or disabled for operations that are not required to use endpoint discovery. - - - - - Returns the maximum number of discovered endpoints that can be stored within the cache for the client. The default limit is 1000 cache entries. - - - - - Returns the flag indicating the current mode in use for request - retries and influences the value returned from . - The default value is RequestRetryMode.Legacy. This flag can be configured - by using the AWS_RETRY_MODE environment variable, retry_mode in the - shared configuration file, or by setting this value directly. - - - - - Under Adaptive retry mode, this flag determines if the client should wait for - a send token to become available or don't block and fail the request immediately - if a send token is not available. - - - - - Throw an exception if the boxed TimeSpan parameter doesn't have a value or is out of range. - - - - - Returns the request timeout value if its value is set, - else returns client timeout value. - - - - - Overrides the default read-write timeout value. - On Unity platform, this value is not used as Unity HTTP client does not support timeouts, so - - - - If the value is set, the value is assigned to the ReadWriteTimeout property of the HttpWebRequest object used - to send requests. - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Gets and sets of the ProxyHost property. - - - - - Gets and sets the ProxyPort property. - - - - - Gets and sets the ProxyBypassList property; a collection - of regular expressions denoting the set of endpoints for - which the configured proxy host will be bypassed. - - - For more information on bypass lists - see https://msdn.microsoft.com/en-us/library/system.net.webproxy.bypasslist%28v=vs.110%29.aspx. - - - - - Gets and sets the ProxyBypassOnLocal property. - If set true requests to local addresses bypass the configured - proxy. - - - - - Returns a WebProxy instance configured to match the proxy settings - in the client configuration. - - - - - Unpacks the host, port and any credentials info into the instance's - proxy-related fields. - - The proxy details - - - - Gets and sets the max idle time set on the ServicePoint for the WebRequest. - Default value is 50 seconds (50,000 ms) unless ServicePointManager.MaxServicePointIdleTime is set, - in which case ServicePointManager.MaxServicePointIdleTime will be used as the default. - - - - - Gets and sets the connection limit set on the ServicePoint for the WebRequest. - Default value is 50 connections unless ServicePointManager.DefaultConnectionLimit is set in - which case ServicePointManager.DefaultConnectionLimit will be used as the default. - - - - - Gets or sets a Boolean value that determines whether the Nagle algorithm is used on connections managed by the ServicePoint object used - for requests to AWS. This is defaulted to false for lower latency with responses that return small amount of data. This is the opposite - default than ServicePoint.UseNagleAlgorithm which is optimized for large responses like web pages or images. - - - - - Base class for constant class that holds the value that will be sent to AWS for the static constants. - - - - - Gets the value that needs to be used when send the value to AWS - - - - - Attempt to find correct-cased constant value using whatever cased value the user - has provided. This is primarily useful for mapping any-cased values from a CLI - tool to the specific casing required by the service, avoiding the need for the - user to (a) remember the specific case and (b) actually type it correctly. - - The properly cased service constant matching the value - - - - Utility class that stores clock skew information. - - - - - GlobalClockCorrection should be only set by AWSConfigs.ManualClockCorrection property - and is only available to maintain backward compatibilty. This should override any - endpoint specific clockskew correction. - - - - - Return clock skew correction value for an endpoint if there is one. - - AWSConfigs.ManualClockCorrection overrides globally any calculated service endpoint specific - clock correction value. - - Endpoint should in a form such as "https://s3" - Clock correction value for an endpoint in TimeSpan. TimeSpan.Zero if no such clock correction is set. - - - - Get clock skew corrected UTC now value. If ManualClockCorrection is set, - use ManualClockCorrection instead of endpoint specific clock correction value. - - - - - - - Class to easily convert from Dictionary<string, string> to ProfileOptions and back. - - - - - Separate the profileDictionary into its parts. - profileDictionary = profileOptions + reservedProperties + userProperties - - Dictionary with everything in it - Keys to ignore - The resulting CredentialProfileOptions - The properties that are left - - - - Separate the profileDictionary into its parts. - profileDictionary = profileOptions + reservedProperties + userProperties - - Dictionary with everything in it - Keys for the reservedKeys dictionary - The resulting CredentialProfileOptions - The resulting reserved properties - The properties that are left - - - - Validate the userProperties and then combine profileOptions, reservedProperties, and userProperties into one Dictionary. - - - - - - - - - - Make sure the userProperties dictionary doesn't contain any keys that are reserved. - Check is case-insensitive for added safety. - - - - - - - Make sure the userProperties dictionary doesn't contain any keys that - overlap with the names of mapped names for CredentialProfileOptions property names. - Check is case-insensitive for added safety. - - - - - - This class is used internally and should not be accessed by SDK users. - - Provide access to internal properties of CredentialProfile to - PowerShell tools and the Visual Studio Toolkit. - - - - - Attempt to read a role session with the given name. - If the session is invalid or expired it will not be returned. - - The name of the role session to get. - The credentials for the session, if found. - True if the session was found, false otherwise. - - - - Factory to construct different types of AWSCredentials based on a profile. - - - - - Gets the AWSCredentials for this profile if CanCreateAWSCredentials is true - and AWSCredentials can be created. Throws an exception otherwise. - - See for a list of AWSCredentials returned by this method. - - The profile to get AWSCredentials for. - The profile source, for profiles that reference other profiles. - AWSCredentials for this profile. - - - - Gets the AWSCredentials for this profile if CanCreateAWSCredentials is true - and AWSCredentials can be created. Throws an exception otherwise. - - See for a list of AWSCredentials returned by this method. - - The options to get AWSCredentials for. - The profile source, for options that reference other profiles. - AWSCredentials for the options given. - - - - Gets the AWSCredentials for this profile if CanCreateAWSCredentials is true - and AWSCredentials can be created. Throws an exception otherwise. - - See for a list of AWSCredentials returned by this method. - - The profile to get AWSCredentials for. - The profile source, for profiles that reference other profiles. - If true, throw a descriptive exception for any credentials that would not operate as-is. - In other words, any credentials that require programmatic callbacks at runtime. - AWSCredentials for this profile. - - - - Gets the AWSCredentials for this profile if CanCreateAWSCredentials is true - and AWSCredentials can be created. Throws an exception otherwise. - - See for a list of AWSCredentials returned by this method. - - The options to get AWSCredentials for. - The profile source, for options that reference other profiles. - If true, throw a descriptive exception for any credentials that would not operate as-is. - In other words, any credentials that require programmatic callbacks at runtime. - AWSCredentials for the options given. - - - - Return the credentials for the profile if valid credentials can created. - - The profile to create credentials with. - The profile source, for profiles that reference other profiles. - The credentials for the profile. - True if credentials can be created from the profile, false otherwise. - - - - Return the credentials for the profile if valid credentials can created. - - The options to get AWSCredentials for. - The profile source, for profiles that reference other profiles. - The credentials for the profile. - True if credentials can be created from the profile, false otherwise. - - - - Determine if the profileType will generate AWSCredentials that require a callback to be set on them. - - - - - - - A named group of options that are persisted and used to obtain AWSCredentials. - - - - - The name of the CredentialProfile - - - - - The options to be used to create AWSCredentials. - - - - - The region to be used with this CredentialProfile - - - - - The unique key for this CredentialProfile. - This key is used by the Visual Studio Tooklit to associate external artifacts with this profile. - - - - - The endpoint discovery enabled value for this CredentialProfile - - - - - If true the region identified in the S3 access point arn will be used when making requests. - - - - - The Sts Regional Endpoints Value as either legacy or regional - - - - - The S3 Regional Endpoint Value as either legacy or regional - - - - - The request retry mode as legacy, standard, or adaptive - - - - - Specified how many HTTP requests an SDK should make for a single - SDK operation invocation before giving up. - - - - - An optional dictionary of name-value pairs stored with the CredentialProfile - - - - - True if the properties of the Options object can be converted into AWSCredentials, false otherwise. - See for more details about which options are available. - - - - - The that this is associated with. - Null if this is not associated with a . - - - - - If CanCreateAWSCredentials is true, returns a short description of the type of - credentials that would be created. - If CanCreateAWSCredentials is false, return null. - - - - - The CredentialProfileType of this CredentialProfile, if one applies. - - - - - Determine this CredentialProfile will generate AWSCredentials that require a callback to be set on them. - - - - - Construct a new CredentialProfile. - - - - - - - Gets the AWSCredentials for this profile if CanCreateAWSCredentials is true - and AWSCredentials can be created. Throws an exception otherwise. - - See for a list of AWSCredentials returned by this method. - - The profile source, for profiles that reference other profiles. - AWSCredentials for this profile. - - - - Gets the AWSCredentials for this profile if CanCreateAWSCredentials is true - and AWSCredentials can be created. Throws an exception otherwise. - - See for a list of AWSCredentials returned by this method. - - The profile source, for profiles that reference other profiles. - If true, throw a descriptive exception for any credentials that would not operate as-is. - In other words, any credentials that require programmatic callbacks at runtime. - AWSCredentials for this profile. - - - - The options that are available for creating AWSCredentials with the AWSCredentialsFactory. - The type of AWSCredentials that are created depends on which Options are set. - - Below are the different types of credentials returned, along with the options that are used to obtain them. - ([] denotes options that are not required) - - BasicAWSCredentials AccessKey SecretKey - SessionAWSCredentials AccessKey SecretKey Token - AssmeRoleAWSCredentials SourceProfile RoleArn [ExternalID] [MfaSerial] - FederatedAWSCredentials EndpointName RoleArn [UserIdentity] - - - - - The access key to be used in the AWSCredentials. - - - - - The source of credentials to be used to obtain AWSCredentials. - - - - - The endpoint name to be used for federated AWSCredentials. - - - - - The external id to use in assume role AWSCredentials. - - - - - The serial number of the MFA to use in assume role AWSCredentials. - - - - The role ARN to use when creating assume role or federated AWSCredentials. - - - - An identifier for the assumed role session. - - - - - The secret key to use when creating AWSCredentials. - - - - - When this CredentialProfileOptions object references another CredentialProfile, - the name of the referenced CredentialProfile. - - - - - The session token to be used to create AWSCredentials. - - - - - The user identity to use when creating federated AWSCredentials. - If not set, the user identity that the code is running under will be used. - - - - - Contains the executable information to be used by the process credential retriever - to either fetch Basic or Session credentials - - - - - Absolute path to the file on disk containing an OIDC token. - - - - - Return true the properties are all null or empty, false otherwise. - - - - - Class to abstract the combined use of NetSDKCredentialsFile and SharedCredentialsFile where possible. - - - - - - The location of the shared credentials file, or null to use the default location. - - - - - Construct a CredentialProfileChain. - - - - - Construct a CredentialProfileChain. - - The path to the aws credentials file to look at. - - - - - Try to get from a profile. - - - If ProfilesLocation is non-null and non-empty search the shared credentials - file at the disk path in the ProfilesLocation property. - - - If ProfilesLocation is null or empty and the platform supports the .NET SDK credentials file - search the SDK credentials file. If the profile is not found search the shared credentials file in the default location. - - - If ProfilesLocation is null or empty and the platform doesn't support the .NET SDK credentials file - search the shared credentials file in the default location. - - - The name of the profile to get credentials from. - The credentials, if the profile is found and credentials can be created. - True if the profile was found and credentials could be created, false otherwise. - - - - - Try to get a - - - If ProfilesLocation is non-null and non-empty search the shared credentials - file at the disk path in the ProfilesLocation property. - - - If ProfilesLocation is null or empty and the platform supports the .NET SDK credentials file - search the SDK credentials file. If the profile is not found search the shared credentials file in the default location. - - - If ProfilesLocation is null or empty and the platform doesn't support the .NET SDK credentials file - search the shared credentials file in the default location. - - - The name of the profile to get. - The profile, if found - True if the profile was found, false otherwise. - - - - - Get a list of available objects. - - - If ProfilesLocation is non-null and non-empty include profiles in the shared credentials - file at the disk path in the ProfilesLocation property. - - - If ProfilesLocation is null or empty and the platform supports the .NET SDK credentials file - include profiles from the SDK credentials file and from the shared credentials file in the default location. - - - If ProfilesLocation is null or empty and the platform doesn't support the .NET SDK credentials file - include profiles from the shared credentials file in the default location. - - - A list of objects. - - - - - Register a - - - If ProfilesLocation is non-null and non-empty register the profile in the shared credentials - file at the disk path in the ProfilesLocation property. - - - If ProfilesLocation is null or empty and the platform supports the .NET SDK credentials file - register the profile in the SDK credentials file. - - - If ProfilesLocation is null or empty and the platform doesn't support the .NET SDK credentials file - register the profile in the shared credentials file in the default location. - - - The profile to register. - - - - - Unregister a - - - If ProfilesLocation is non-null and non-empty unregister the profile from the shared credentials - file at the disk path in the ProfilesLocation property. - - - If ProfilesLocation is null or empty and the platform supports the .NET SDK credentials file - search the SDK credentials file. If the profile is found there unregister it. - If the profile was not found search the shared credentials file in the default location. - If the profile is found in the shared credentials file in the default location unregister it. - - - If ProfilesLocation is null or empty and the platform doesn't support the .NET SDK credentials file - search the shared credentials file in the default location. If the profile is found in the - shared credentials file in the default location unregister it. - - - The name of the profile to unregister. - - - - Interface to define the necessary operations for a CredentialProfile lookup mechanism. - - - - - Get the profile with the given name, if one exists. - - The name of the profile to get. - The profile, if it was found, null otherwise. - True if the profile was found, false otherwise. - - - - Interface to define the necessary operations for a CredentialProfile storage mechanism. - - - - - Rename the profile with oldProfileName to newProfileName. - - The profile to rename. - The new name for the profile. - - - - Rename the profile with oldProfileName to newProfileName. - - The profile to rename. - The new name for the profile. - If true and the destination profile exists it will be overwritten. - - - - Make a copy of the profile with fromProfileName called toProfileName. - - The name of the profile to copy from. - The name of the new profile. - - - - Make a copy of the profile with fromProfileName called toProfileName. - - The name of the profile to copy from. - The name of the new profile. - If true and the destination profile exists it will be overwritten. - - - - Add the given profile to the store, or update it if one with the same name already exists. - - - - - - Delete the profile with profileName if it exists. - - The name of the profile to delete. - - - - Get a list of valid profile names from this store. - Invalid profiles are ignored. - See for more information - about valid profiles. - - - - - - Get a list of valid profiles from this store. - Invalid profiles are ignored. - See for more information - about valid profiles. - - - - - - This class allows profiles supporting AWSCredentials to be registered with - the SDK so that they can later be reference by a profile name. The credential profiles will be available - for use in the AWS Toolkit for Visual Studio and the AWS Tools for Windows PowerShell. - - The credentials are stored under the current users AppData folder encrypted using Windows Data Protection API. - - - This class is not threadsafe. - - - - - - Get the profile with the name given, if it exists in this store. - - The name of the profile to find. - The profile, if it was found, null otherwise - True if the profile was found, false otherwise. - - - - Add the profile to this store, if it's valid. - - The profile to add. - - - - If there is a profile in the store with the given name, delete it. - - The name of the profile to delete. - - - - Rename the profile with oldProfileName to newProfileName. - - The profile to rename. - The new name for the profile. - - - - Rename the profile with oldProfileName to newProfileName. - - The profile to rename. - The new name for the profile. - If true and the destination profile exists it will be overwritten. - - - - Make a copy of the profile with fromProfileName called toProfileName. - - The name of the profile to copy from. - The name of the new profile. - - - - Make a copy of the profile with fromProfileName called toProfileName. - - The name of the profile to copy from. - The name of the new profile. - If true and the destination profile exists it will be overwritten. - - - - Set the ProfileType field to maintain backward compatibility with ProfileManager. - The value is ignored when it's read back in. - - - - - - - Represents the different types of authentication available for SAML endpoints. - - - - - Representation of a SAML Endpoint. - - - - - The name given to this SAMLEndpoint. - - - - - The URI of the SAML endnpoint. - - - - - The authentication type associated with the SAML endpoint. - - - - - Internal constructor. Used by SAMLEndpointManager when reading endpoints from the encrypted store. - - - - - - - - Construct a SAMLEndpoint using the default SAMLAuthenticationType - Kerberos. - - The name of the endpoint. - The URI of the endpoint. - - - - Construct a SAMLEndpoint. - - The name of the endpoint. - The URI of the endpoint. - The authentication type of the endpoint. - - - - Manages endpoints to be used in conjunction with SAML role profiles. The role profiles - reference the endpoint to obtain the actual endpoint and any customization settings - needed to perform authentication. - - - - - Construct a SAMLEndpointManager. - - - - - True if the SAMLEndpointManager is available on the current platform, false otherwise. - - - - - Register an endpoint, or update an existing one. - - The endpoint to register. - - - - Get an endpoint, if it exists and is valid. - - The name of the endpoint to get. - The endpoint, or null if it's invalid or doesn't exist. - True if the endpoint exists and is valid, false otherwise. - - - - Get an endpoint from the store. - Throws an exception if there's an error reading the endpoint, or if it doesn't exist. - - The name of the endpoint to get. - The endpoint with the given name. - - - - Delete an endpoint from the store, if it exists. - - The name of the endpoint to delete. - - - - List the names of valid endpoints in the store. - - - - - - List valid endopints that can be read from the store. - - - - - - Provides access to read and write to the shared credentials INI file. - The file is read, parsed, and validated at construction time. - Changes can be made using the RegisterProfile() and - UnregisterProfile() methods. - - This class is not threadsafe. - - - - - To maintain compatibility with the CLI, - SharedCredentialsFile doesn't support the SAML profileTypes. - - - - - Construct a new SharedCredentialsFile in the default location. - - - - - Construct a new SharedCredentialsFile. - - The path of the shared credentials file. - - - - Add the profile given. If the profile already exists, update it. - - The profile to be written. - - - - Update the profile on disk regardless of the profile type. - - - - - - Deletes the section with the given ProfileName from the SharedCredentialsFile, if one exists. - - The ProfileName of the section to delete. - - - - Rename the profile with oldProfileName to newProfileName. - - The profile to rename. - The new name for the profile. - - - - Rename the profile with oldProfileName to newProfileName. - - The profile to rename. - The new name for the profile. - If true and the destination profile exists it will be overwritten. - - - - Make a copy of the profile with fromProfileName called toProfileName. - - The name of the profile to copy from. - The name of the new profile. - - - - Make a copy of the profile with fromProfileName called toProfileName. - - The name of the profile to copy from. - The name of the new profile. - If true and the destination profile exists it will be overwritten. - - - - Try to get a profile that may be partially in the credentials file and partially in the config file. - If there are identically named properties in both files, the properties in the credentials file take precedence. - - - - - - - - Anonymous credentials. - Using these credentials, the client does not sign the request. - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - AWS Credentials that automatically refresh by calling AssumeRole on - the Amazon Security Token Service. - - - - - The credentials of the user that will be used to call AssumeRole. - - - - - The Amazon Resource Name (ARN) of the role to assume. - - - - - An identifier for the assumed role session. - - - - - Options to be used in the call to AssumeRole. - - - - - Constructs an AssumeRoleAWSCredentials object. - - The credentials of the user that will be used to call AssumeRole. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - - - - Constructs an AssumeRoleAWSCredentials object. - - The credentials of the user that will be used to call AssumeRole. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRole. - - - - A unique identifier that is used by third parties when assuming roles in their customers' accounts. - - - - - An IAM policy in JSON format. - - - - - The length of time in seconds before the credentials will expire. - - - - - The proxy settings to use when calling AssumeRole. - - - - - The identification number of the MFA device that is associated with the user who is making the assume-role call. - - - - - The value provided by the MFA device, if the trust policy of the role being assumed requires MFA. - - - - - A callback that's used to obtain the MFA token code when the AssumeRoleAWSCredentials are refreshed. - - - - - Immutable representation of AWS credentials obtained as a result of - authenticating with the AssumeRole method of the Security Token Service. - - - - - The expiry time of the credentials, obtained from the AssumeRoleResponse. - - - - - Constructs an instance with supplied keys, token, and expiration. - - The AccessKey for the credentials. - The SecretKey for the credentials. - The security token for the credentials. - The expiration time for the credentials. - - - - Get a copy of this AssumeRoleImmutableCredentials object. - - A copy of this object. - - - - Abstract class that represents a credentials object for AWS services. - - - - - Returns a copy of ImmutableCredentials - - - - - - Called by AmazonServiceClient to validate the credential state - on client construction. - - - - - Basic set of credentials consisting of an AccessKey and SecretKey - - - - - Constructs a BasicAWSCredentials object for the specified accessKey and secretKey. - - - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - When running in an ECS container and AWS_CONTAINER_CREDENTIALS_RELATIVE_URI is set, - use the given end point to retrieve the credentials. - - - - - These constants should not be consumed by client code. They are only relevant - in the context of ECS container and, especially, AWS_CONTAINER_CREDENTIALS_RELATIVE_URI - environment variable should not be overriden by the client code. - - - - If AWS_CONTAINER_CREDENTIALS_RELATIVE_URI environment variable is set, we want to attempt to retrieve credentials - using ECS endpoint instead of referring to instance profile credentials. - - - If AWS_CONTAINER_CREDENTIALS_RELATIVE_URI environment variable is set, we want to attempt to retrieve credentials - using ECS endpoint instead of referring to instance profile credentials. - - - - Immutable representation of AWS credentials. - - - - - Gets the AccessKey property for the current credentials. - - - - - Gets the SecretKey property for the current credentials. - - - - - Gets the Token property for the current credentials. - - - - - Gets the UseToken property for the current credentials. - Specifies if Token property is non-emtpy. - - - - - Constructs an ImmutableCredentials object with supplied accessKey, secretKey. - - - - Optional. Can be set to null or empty for non-session credentials. - - - - Returns a copy of the current credentials. - - - - - - Abstract class for automatically refreshing AWS credentials - - - - - Refresh state container consisting of credentials - and the date of the their expiration - - - - - Represents the current state of the Credentials. - - This can be cleared without synchronization. - - - - Semaphore to control thread access to GetCredentialsAsync method. - The semaphore will allow only one thread to generate new credentials and - update the current state. - - - - - The time before actual expiration to expire the credentials. - Property cannot be set to a negative TimeSpan. - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - Test credentials existence and expiration time - should update if: - credentials have not been loaded yet - it's past the expiration time. At this point currentState.Expiration may - have the PreemptExpiryTime baked into to the expiration from a call to - UpdateToGeneratedCredentials but it may not if this is new application load. - - - - - When overridden in a derived class, generates new credentials and new expiration date. - - Called on first credentials request and when expiration date is in the past. - - - - - - When overridden in a derived class, generates new credentials and new expiration date. - - Called on first credentials request and when expiration date is in the past. - - - - - - Clears currently-stored credentials, forcing the next GetCredentials call to generate new credentials. - - - - - Immutable representation of AWS credentials obtained as a result of - authenticating against a SAML-supporting federated identity provider. - - - - - The expiry time of the credentials, obtained from the AssumeRoleWithSAML response. - - - - - The value of the NameID element in the Subject element of the SAML assertion, as returned in the - AssumeRoleWithSAML response from the Security Token Service. - - - - - Constructs an instance with supplied keys and SAML assertion data. - - - - - - - - - - Constructs an instance with supplied keys and SAML assertion data. - - - - - - - - Returns a copy of the current credentials. - - - - - - Serializes the instance to a json-format string for external storage - - The serialized object in json - - - - Instantiates an instance from persisted json data - - The serialized data - Deserialized instance corresponding to the json data - - - - Session credentials consisting of AccessKey, SecretKey and Token - - - - - Constructs a SessionAWSCredentials object for the specified accessKey, secretKey. - - - - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - AWS Credentials that automatically refresh by calling AssumeRole on - the Amazon Security Token Service. - - - - - As established by STS, the regex used to validate the role session names is a string of 2-64 characters consisting of - upper- and lower-case alphanumeric characters with no spaces. You can also include - underscores or any of the following characters: =,.@- - - - - - Options to be used in the call to AssumeRole. - - - - - The absolute path to the file on disk containing an OIDC token - - - - - The Amazon Resource Name (ARN) of the role to assume. - - - - - An identifier for the assumed role session. - - - - - Constructs an AssumeRoleWithWebIdentityCredentials object. - - The absolute path to the file on disk containing an OIDC token. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - - - - Constructs an AssumeRoleWithWebIdentityCredentials object. - - The absolute path to the file on disk containing an OIDC token. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRole. - - - - Creates an instance of from environment variables. - - Throws an if the needed environment variables are not set. - The new credentials. - - - - Gets a client to be used for AssumeRoleWithWebIdentity requests. - - The STS client. - - - - Options for using a credentials object to make AssumeRoleWithWebIdentity calls. - - - - - Gets and sets the property DurationSeconds. - - The duration, in seconds, of the role session. The value can range from 900 seconds - (15 minutes) up to the maximum session duration setting for the role. This setting - can have a value from 1 hour to 12 hours. If you specify a value higher than this - setting, the operation fails. For example, if you specify a session duration of 12 - hours, but your administrator set the maximum session duration to 6 hours, your operation - fails. To learn how to view the maximum value for your role, see View - the Maximum Session Duration Setting for a Role in the IAM User Guide. - - - - By default, the value is set to 3600 seconds. - - - - The DurationSeconds parameter is separate from the duration of a console - session that you might request using the returned credentials. The request to the - federation endpoint for a console sign-in token takes a SessionDuration - parameter that specifies the maximum length of the console session. For more information, - see Creating - a URL that Enables Federated Users to Access the AWS Management Console in the - IAM User Guide. - - - - - - - Gets and sets the property ProviderId. - - The fully qualified host component of the domain name of the identity provider. - - - - Specify this value only for OAuth 2.0 access tokens. Currently www.amazon.com - and graph.facebook.com are the only supported identity providers for - OAuth 2.0 access tokens. Do not include URL schemes and port numbers. - - - - Do not specify this value for OpenID Connect ID tokens. - - - - - - Gets and sets the property Policy. - - An IAM policy in JSON format that you want to use as an inline session policy. - - - - This parameter is optional. Passing policies to this operation returns new temporary - credentials. The resulting session's permissions are the intersection of the role's - identity-based policy and the session policies. You can use the role's temporary credentials - in subsequent AWS API calls to access resources in the account that owns the role. - You cannot use session policies to grant more permissions than those allowed by the - identity-based policy of the role that is being assumed. For more information, see - Session - Policies in the IAM User Guide. - - - - The plain text that you use for both inline and managed session policies shouldn't - exceed 2048 characters. The JSON policy characters can be any ASCII character from - the space character to the end of the valid character list (\u0020 through \u00FF). - It can also include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D) - characters. - - - - The characters in this parameter count towards the 2048 character session policy guideline. - However, an AWS conversion compresses the session policies into a packed binary format - that has a separate limit. This is the enforced limit. The PackedPolicySize - response element indicates by percentage how close the policy is to the upper size - limit. - - - - - - - Gets and sets the property PolicyArns. - - The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use - as managed session policies. The policies must exist in the same account as the role. - - - - This parameter is optional. You can provide up to 10 managed policy ARNs. However, - the plain text that you use for both inline and managed session policies shouldn't - exceed 2048 characters. For more information about ARNs, see Amazon - Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference. - - - - The characters in this parameter count towards the 2048 character session policy guideline. - However, an AWS conversion compresses the session policies into a packed binary format - that has a separate limit. This is the enforced limit. The PackedPolicySize - response element indicates by percentage how close the policy is to the upper size - limit. - - - - Passing policies to this operation returns new temporary credentials. The resulting - session's permissions are the intersection of the role's identity-based policy and - the session policies. You can use the role's temporary credentials in subsequent AWS - API calls to access resources in the account that owns the role. You cannot use session - policies to grant more permissions than those allowed by the identity-based policy - of the role that is being assumed. For more information, see Session - Policies in the IAM User Guide. - - - - - - The proxy settings to use when calling AssumeRoleWithWebIdentity. - - This parameter is optional. - - - - - - State class passed on callback to demand user credentials when authentication - needs to be performed using a non-default identity. - - - - - If the current authentication callback is associated with - a credential profile, this can be used to give the user - some context on the request for his/her authentication. - - - - - Contains the user identity that the user should supply a password - for. The user can ignore if they choose and return credentials for - an alternate account. - - - - - Any custom state that was registered with the callback. - - - - - Set if the callback was due to a failed authentication attempt. - If false we are beginning to obtain or refresh credentials. - - - - - InstanceProfileAWSCredentials allows configuring Roles and every instance hits IMDS individually. - This class has a singleton timer task that caches instance profile credentials every 2 minutes. - - - - - Returns a copy of the most recent instance profile credentials. - - - - - Returns a copy of the most recent instance profile credentials. - - - - - Dispose this object and all related resources. - - - - - Uses aws credentials stored in environment variables to construct the credentials object. - AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY are used for the access key id and secret key. - If the variable AWS_SESSION_TOKEN exists then it will be used to create temporary session - credentials. - - - For backwards compatibility the class will also attempt to discover the secret key from - the AWS_SECRET_KEY variable, if a value cannot be obtained using the standard - AWS_SECRET_ACCESS_KEY variable. - - - - - Constructs an instance of EnvironmentVariablesAWSCredentials. If no credentials are found in - the environment variables then an InvalidOperationException is thrown. - - - - - Creates immutable credentials from environment variables. - - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - Custom exception type thrown when a role profile with user identity is used - in conjunction with a credential request callback. This exception is thrown - if the callback returns null, indicating the user declined to supply credentials. - - - - - Initializes a new exception instance. - - - - - - Initializes a new exception instance. - - - - - - - Constructs a new instance of the FederatedAuthenticationCancelledException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Custom exception type thrown when authentication for a user fails due to - invalid credentials. - - - - - Initializes a new exception instance. - - - - - - Initializes a new exception instance. - - - - - - - Constructs a new instance of the FederatedAuthenticationFailureException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Temporary credentials that are created following successful authentication with - a federated endpoint supporting SAML. - - - In order to use the FederatedAWSCredentials class the AWSSDK.SecurityToken assembly - must be available to your application at runtime. - - - - - Constructs an instance of FederatedAWSCredentials. After construction call GetCredentials - to authenticate the user/process and obtain temporary AWS credentials. - - The SAML endpoint used for authentication. - The role ARN used for authentication. - - - - Constructs an instance of FederatedAWSCredentials. After construction call GetCredentials - to authenticate the user/process and obtain temporary AWS credentials. - - The SAML endpoint used for authentication. - The role ARN used for authentication. - The options used for authentication. - See for details about available options. - - - - The SAML Endpoint used for authentication. - - - - - The role ARN used for authentication. - - - - - The options used for authentication. - See for details about available options. - - - - - Refresh credentials after expiry. If the role profile is configured with user identity - information and a callback has been registered to obtain the user credential, the callback - will be invoked ahead of authentication. For role profiles configured with user identity - but no callback registration, the SDK will fall back to attempting to use the default - user identity of the current process. - - - - - - Clears currently-stored credentials, forcing the next GetCredentials call to generate new credentials. - - - - - Options that control the behavior of . - - - - - The identity to use when authenticating. - This is in the form domain\username, or just username. - If this option is not set, the current user's identity will be used. - - - - - uses this callback to get credentials if the UserIdentity is set. - - - - - When makes a callback for credentials, - this state will be included for use by the callback handler. - - - - - The proxy settings to use when calling the - Secure Token Service and the ADFS endpoint. - - - - - Set this property when a region-specific STS endpoint must be used (eg cn-north-1). - If left empty/null, the global sts.amazonaws.com endpoint will be used when credentials are obtained. - - - - - The profile name, if this FederatedAWSCredentialsOptions - is associated with a CredentialProfile. - - - - - Credentials that are retrieved from the Instance Profile service on an EC2 instance - - - - - Role for which the credentials are retrieved - - - - - Constructs a InstanceProfileAWSCredentials object for specific role - - Role to use - - - - Constructs a InstanceProfileAWSCredentials object for specific role - - Role to use - - - - Constructs a InstanceProfileAWSCredentials object for the first found role - - - - - Constructs a InstanceProfileAWSCredentials object for the first found role - - - - - Retrieves a list of all roles available through current InstanceProfile service - - - - - - Retrieves a list of all roles available through current InstanceProfile service - - - - - - Return true if string is null or whitespace, false otherwise. - We can't use String.IsNullOrWhitespace because it doesn't exist - in all frameworks we support. - - - - - - - Process Credentials can retrieve credentials by running a process and reading its stdout. - A new config option, "credential_process" is added to the shared config file that allows customers - to specify which process to run. The credentials retrieved by running this process could be either - Basic or Session credentials. - - - - - Generates new credentials by running the "credential_process" process. - - - - - Exception class to capture all exceptions encountered when starting or - executing the "credential_process" process. If the user has specified an executable - and the SDK is unable to execute it, the exception should be surfaces to the user - instead of moving on to the next credential provider. - - - - - - Credentials that are retrieved using a stored profile. - - - Unless otherwise specified priority is given to loading credentials from the SDK credential store - file which is shared between the SDK, PowerShell CLI and Toolkit. Credentials in profiles in this - file are encrypted and can only be used by the user account on the current machine that stored the - profile. Credentials can also be loaded from the plain-text ini-format credential file which is - shared with other AWS SDKs. This file is expected to exist in a '.aws' folder in the user's home - directory but alternate locations can be specified using either the AWSProfilesLocation setting in - the application configuration file, or by using the AWS_SHARED_CREDENTIALS_FILE environment variable. - - - The profile name can be specified in the App.config using the AWSProfileName setting. - - - - - - Constructs an instance for credentials stored in a profile. This constructor searches for credentials - using the account name specified using the AWSProfileName setting, if set, in the application configuration - file. If the configuration file setting is not set the SDK will attempt to locate a profile with the name - 'default'. - - - - - Constructs an instance for credentials stored in a profile with the specified name. The SDK will - check the SDK credential store file first before looking for the shared ini-format credentials - file unless the application configuration file contains a setting for the 'AWSProfilesLocation' - indicating the search should be constrained to the shared credentials file at the specified - location. - - The name of the profile in which the credentials were stored. - - - - Constructs an instance for credentials stored in a profile with the specified name. - - The profile name to search for credentials for - - Optional; instructs the SDK to check for the profile in the shared credentials file at the - specified location. If not set, the SDK will inspect its own credential store file first before - attempting to locate a shared credential file using either the default location beneath the user's - home profile folder or the location specified in the AWS_SHARED_CREDENTIALS_FILE environment - variable. - - - If credential materials cannot be read or are invalid due to missing data an InvalidDataException - is thrown. If no credentials can be located with the specified profile name, an ArgumentException - is thrown. - - - - - Name of the profile being used. - - - - - Location of the profiles, if used. - - - - - Tests if a profile has been registered in either the SDK store or the specified credential - file. - - The name of the profile to test - - Optional; instructs the SDK to check for the profile in the shared credentials file at the - specified location. If not set, the SDK will inspect its own credential store file first before - attempting to locate a shared credential file using either the default location beneath the user's - home profile folder or the location specified in the AWS_SHARED_CREDENTIALS_FILE environment - variable. - - True if a profile with the specified name has been registered. - - - - Tests if an instance can be created from the persisted profile data. - If profilesLocation is null/empty, the SDK store is searched for the - profile data before probing for the profile in the shared the ini-format - credential file. - - The name of the profile to test - - If null/empty, the SDK store is searched for the named profile otherwise - the ini-format credential file at the specified location is inspected. - - True if the persisted data would yield a valid credentials instance. - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - Helper routiners for AWS and Federated credential profiles. Probes the - profile type for the supplied profile name and returns the appropriate profile - instance. - - - - - Determines the type of the requested profile and returns the - appropriate profile instance. - - The name of the profile (AWS or federated) to be loaded. - Instantiated profile type. - - - - Determines the type of the requested profile and returns the - appropriate profile instance. - - The name of the profile (AWS or federated) to be loaded. - - The location of the shared credentials (.ini) file, for profiles that are not stored in the - SDK credential store. - - Instantiated profile type. - - - - Probes for and returns the fully qualified name of the shared ini-format credentials - file. - - - Contains the file or folder name of the credential file. If not specified, the - routine will first check the application configuration file for a setting indicating - the file location or filename. If the configuration file does not yield a credential - file location then an environment variable is examined. Finally the routine will - inspect the fallback default location beneath the user's home folder location. - - - The fully qualified name to the credential file that was located, or null - if no credential file could be found. - - - - - Obtains credentials from access key/secret key or AWSProfileName settings - in the application's app.config or web.config file. - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - Exception thrown on validation of a StoredProfileFederatedCredentials instance if the role profile - is configured to use a non-default user identity and the QueryUserCredentialCallback on the - instance has not been set. - - - - - Initializes a new exception instance. - - - - - - Initializes a new exception instance. - - - - - - - Initializes a new exception instance. - - - - - - Constructs a new instance of the CredentialRequestCallbackRequiredException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Credentials that are retrieved from ConfigurationManager.AppSettings - - - - - Constructs an instance of EnvironmentAWSCredentials and attempts - to load AccessKey and SecretKey from ConfigurationManager.AppSettings - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - Temporary credentials that are created following successful authentication with - a federated endpoint supporting SAML. - - - 1. Currently only the SDK store supports profiles that contain the necessary data to support - authentication and role-based credential generation. The ini-format files used by the AWS CLI - and some other SDKs are not supported at this time. -
- 2. In order to use the StoredProfileFederatedCredentials class the AWSSDK.SecurityToken assembly - must be available to your application at runtime. - - - - - Custom state to return to the registered callback to handle credential requests. - The data will be contained in the CredentialRequestCallbackArgs instance supplied - to the callback. - - - - - The minimum allowed timespan for generated credentials, per STS documentation. - - - - - The maximum allowed timespan for generated credentials, per STS documentation. - - - - - Name of the profile being used. - - - - - Location of the profiles, if used. - - - - - The data about the SAML endpoint and any required user credentials parsed from the - profile. - - - - - Callback signature for obtaining user credentials that may be needed for authentication. - - - Data about the credential demand including any custom state data that was supplied - when the callback was registered. - - - The network credential to use in user authentication. Return null to signal the user - declined to provide credentials and authentication should not proceed. - - - - - Constructs an instance of StoredProfileFederatedCredentials using the profile name specified - in the App.config. If no profile name is specified then the default credentials are used. - - - - - Constructs an instance of StoredProfileFederatedCredentials. Credentials will be searched - for using the profileName parameter. - - The profile name to search for credentials for - - - - - Constructs an instance of StoredProfileFederatedCredentials. After construction call one of the Authenticate - methods to authenticate the user/process and obtain temporary AWS credentials. - - - For users who are domain joined (the role profile does not contain user identity information) the temporary - credentials will be refreshed automatically as needed. Non domain-joined users (those with user identity - data in the profile) are required to re-authenticate when credential refresh is required. An exception is - thrown when attempt is made to refresh credentials in this scenario. The consuming code of this class - should catch the exception and prompt the user for credentials, then call Authenticate to re-initialize - with a new set of temporary AWS credentials. - - - - The name of the profile holding the necessary role data to enable authentication and credential generation. - - Reserved for future use. - - The ini-format credentials file is not currently supported for SAML role profiles. - - - - - - Constructs an instance of StoredProfileFederatedCredentials. After construction call one of the Authenticate - methods to authenticate the user/process and obtain temporary AWS credentials. - - - For users who are domain joined (the role profile does not contain user identity information) the temporary - credentials will be refreshed automatically as needed. Non domain-joined users (those with user identity - data in the profile) are required to re-authenticate when credential refresh is required. An exception is - thrown when attempt is made to refresh credentials in this scenario. The consuming code of this class - should catch the exception and prompt the user for credentials, then call Authenticate to re-initialize - with a new set of temporary AWS credentials. - - - - The name of the profile holding the necessary role data to enable authentication and credential generation. - - Reserved for future use. - - Null or proxy settings to be used during the HHTPS authentication calls when generating credentials. - /// - The ini-format credentials file is not currently supported for SAML role profiles. - - - - - Registers a callback handler for scenarios where credentials need to be supplied - during user authentication (primarily the non-domain-joined use case). Custom data, - which will be supplied in the CredentialRequestCallbackArgs instance passed to the - callback, can also be supplied. - - - The callback will only be invoked if the underlying SAML role profile indicates it - was set up for use with a specific identity. For profiles that do not contain any user - identity the SDK will default to using the identity of the current process during - authentication. Additionally, if the profile contain user identity information but no - callback has been registered, the SDK will also attempt to use the current process - identity during authentication. - - - The handler to be called - - Custom state data to be supplied in the arguments to the callback. - - - Only one callback handler can be registered. The call to the handler will be made on - whatever thread is executing at the time a demand to provide AWS credentials is made. - If the handler code requires that UI need to be displayed, the handler should - transition to the UI thread as appropriate. - - - - - Tests if an instance can be created from the persisted profile data. - - The name of the profile to test. - The location of the shared ini-format credential file. - True if the persisted data would yield a valid credentials instance. - - This profile type is currently only supported in the SDK credential store file. - The shared ini-format file is not currently supported; any value supplied - for the profilesLocation value is ignored. - - - - - Performs any additional validation we may require on the profile content. - - - - - Refresh credentials after expiry. If the role profile is configured with user identity - information and a callback has been registered to obtain the user credential the callback - will be invoked ahead of authentication. For role profiles configured with user identity - but no callback registration, the SDK will fall back to attempting to use the default - user identity of the current process. - - - - - - Determines the endpoint discovery enabled value based on an environment variable. If no value is found in the - environment then an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of EnvironmentVariable AWS_ENABLED_ENDPOINT_DISCOVERY. If no value is found in the - environment then an InvalidOperationException is thrown. - - - - - Determines endpoint discovery enabled based on a stored in an . - If the profile doesn't exist or there is no endpoint discovery enabled information an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of . - If the AWS_PROFILE environment variable is set the instance will be constructed using that profile, - otherwise it will use the default profile. - - If the profile doesn't exist or there is no endpoint discovery enabled information an InvalidOperationException is thrown. - - The ICredentialProfileSource to read the profile from. - - - - Attempts to construct an instance of . - If the profile doesn't exist or there is no endpoint discovery enabled information an InvalidOperationException is thrown. - - The ICredentialProfileSource to read the profile from. - The name of the profile. - - - - Probing mechanism to determine the endpoint discovery enabled value from various sources. - - - - - The valid hashing algorithm supported by the sdk for request signing. - - - - - Which end of a request was responsible for a service error response. - - - - - The sender was responsible for the error, i.e. the client - request failed validation or was improperly formatted. - - - - - The error occured within the service. - - - - - An unrecognized error type was returned. - - - - - Sts Regional Endpoints Value determines whether or not - to send the sts request to the regional endpoint or to - the global sts endpoint - - - - - Send the request to the global sts endpoint - if the region is a legacy global region - - - - - Send the request to the regional endpoint - - - - - S3 US East 1 endpoint value determines wheter or not - to send the us-east-1 s3 requests to the regional endpoint or to - the legacy global endpoint - - - - - Sends the requests to the legacy global s3 endpoint for us-east-1 - - - - - Sends the request to the regional s3 endpoint for us-east-1 - - - - - RetryMode determines which request retry mode is used for requests that do - not complete successfully. - - - - - Legacy request retry strategy. - - - - - Standardized request retry strategy that is consistent across all SDKs. - - - - - An experimental request retry strategy that builds on the Standard strategy - and introduces congestion control through client side rate limiting. - - - - - Superclass for Exceptions that come over the event stream, or to wrap other kinds of generic exceptions. - - - - - The numeric code identifier for the type of error. - - - - - Constructs an EventStreamError. - - - - - Constructs an EventStreamError. - - The error code. - The error message. - - - - Constructs a new instance of the EventStreamErrorCodeException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Event args that contain an . - - The - - - - The EventStream Event. - - - - - Constructs an EventStreamEventReceivedArgs. - - The EventStream Event. - - - - Event args that contain an . - - The . - - - - The EventStream Exception. - - - - - Constructs an EventStreamExceptionReceivedArgs. - - The EventStream Exception. - - - - Supported Header types for vnd.amazon.event-stream - - - - - Name for the Header. Maximum of 255 bytes. - - - - - Header type id - - - - - Computes the amount of memory neccesary to serialize this Header. - - - - - Writes this Header to buffer starting at offset - Keep in mind, this API assumes buffer is large enough - for the operation. - - buffer to serialize this Header to - offset to begin writing at. - - the new offset. - - - - - Returns the current value as a bool - - - - - Sets the current value - - - - - Returns the current value as a byte - - - - - Sets the current value - - - - - Gets the current value as a 16 bit integer. (Host Order). - - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a 32 bit integer. (Host Order) - - - - - Sets the current value - - - - - returns the current value as a 64-bit integer. (Host Order) - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a byte buffer. - - - - - - Sets the current value. Max length is 2^15 - 1 - - - - - Returns the current value as a utf-8 string. - - - - - Sets the current value. Utf-8 encoded. Max byte size is 2^16 - 1 - - - - - Gets the current value as a DateTime. - Note: You do not need to compensate for unix epoch on this API. - - - - - - Sets the current value. - Note: You do not need to compensate for unix epoch on this API. - - - - - Returns the current value as a Guid (UUID) - - - - - Sets the current value - - - - - Header Data for an EventStreamMessage - - Each header is of format: - [name len] (1) | [utf-8 name] (v) - [type (1)] - [value (v)] - - - - - Name for the Header. Maximum of 255 bytes. - - - - - Header type id - - - - - Initializes this Header with name. - - utf-8 string, max length is 255 - - - - Deserializes the header in buffer. - - buffer constaining the header - index to start from in the buffer. - updated offset with new value for offset - - - - Writes this Header to buffer starting at offset - Keep in mind, this API assumes buffer is large enough - for the operation. - - buffer to serialize this Header to - offset to begin writing at. - - the new offset. - - - - - Computes the amount of memory neccesary to serialize this Header. - - - - - Returns the current value as a bool - - - - - Sets the current value - - - - - Returns the current value as a byte - - - - - Sets the current value - - - - - Gets the current value as a 16 bit integer. (Host Order). - - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a 32 bit integer. (Host Order) - - - - - Sets the current value - - - - - returns the current value as a 64-bit integer. (Host Order) - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a byte buffer. - - - - - - Sets the current value. Max length is 2^15 - 1 - - - - - Returns the current value as a utf-8 string. - - - - - Sets the current value. Utf-8 encoded. Max byte size is 2^16 - 1 - - - - - Gets the current value as a DateTime. - Note: You do not need to compensate for unix epoch on this API. - - - - - - Sets the current value. - Note: You do not need to compensate for unix epoch on this API. - - - - - Returns the current value as a Guid (UUID) - - - - - Sets the current value - - - - - Constructs a new instance of the EventStreamParseException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Constructs a new instance of the EventStreamChecksumFailureException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Headers for the message. Can be null. - - - - - Payload for the message. Can be null. - - - - - Converts a message into a byte buffer (usually for network transmission). - - - - - Message is a single datagram. The format is as follows: - [ total length (4) ] | [ headers_length (4)] | [ prelude crc(4)] - [ headers (v)] - [ payload (v)} - [ trailing crc ] - - CRCs use the CRC32 algorithm. - - - - - Content type for EventStreams. - - - - - Headers for the message. Can be null. - - - - - Payload for the message. Can be null. - - - - - Initialize a message with headers and a payload. - - list of headers for the message, can be null. - payload for the message, can be null. - - - - Builds a message from buffer. - - buffer to read - offset to start reading - buffer length. - - parsed instance of EventStreamMessage. Doesn't return null, - does throw if CRCs don't match. - - - - - Converts a message into a byte buffer (usually for network transmission). - - - - - Defines exceptions that arise from an not conforming to specification. - - - - - Constructs an EventStreamValidationException. - - - - - Constructs an EventStreamValidationException. - - The exception message. - - - - Constructs an EventStreamValidationException. - - The exception message. - The inner exception. - - - - Constructs a new instance of the EventStreamValidationException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - The contract for the . - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - A subclass of that enables an enumerable interface for interacting with Events. - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - Flag if the stream was chosen to be enumerated. - - - - - A Stream of Events. Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treated as mutually exclusive. - - - - - A Stream of Events. Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treated as mutually exclusive. - - - - - Returns an enumerator that iterates through the collection. - - An enumerator that can be used to iterate through the collection. - - - - Returns an enumerator that iterates through a collection. - - An object that can be used to iterate through the collection. - - - - Starts the background thread to start reading events from the network stream. - - - - - The contract for the . - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - The size of the buffer for reading from the network stream. - - - - - Fires when an event is received. - - - - - Fired when an exception or error is raised. - - - - - Starts the background thread to start reading events from the network stream. - - - - - The superclass for all EventStreams. It contains the common processing logic needed to retreive events from a network Stream. It - also contains the mechanisms needed to have a background loop raise events. - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - "Unique" key for unknown event lookup. - - - - - Header key for message type. - - - - - Header key for event type. - - - - - Header key for exception type. - - - - - Header key for error code. - - - - - Header key for error message. - - - - - Value of when the message is an event. - - - - - Value of when the message is an exception. - - - - - Value of when the message is an error. - - - - - The size of the buffer for reading from the network stream. - Default is 8192. - - - - - The underlying stream to read events from. - - - - - Responsible for decoding events from sequences of bytes. - - - - - Fires when an event is recieved. - - - - - Fired when an exception or error is raised. - - - - - The mapping of event message to a generator function to construct the matching Event Stream event. - - - - - The mapping of event message to a generator function to construct the matching Event Stream exception. - - - - - Whether the Stream is currently being processed. - - - - - A Stream of Events. Events can be retrieved from this stream by attaching handlers to listen events, and then calling StartProcessing. - - - - - A Stream of Events. Events can be retrieved from this stream by attaching handlers to listen events, and then calling StartProcessing. - - - - - Converts an EventStreamMessage to an event. - - The event stream message to be converted. - The event - - - - Abstraction for cross-framework initiation of the background thread. - - - - - The background thread main loop. It will constantly read from the network stream until IsProcessing is false, or an error occurs. - - This stub exists due to FXCop. - - - - - The background thread main loop. It will constantly read from the network stream until IsProcessing is false, or an error occurs. - - Needed for 3.5 support. Not used. - - - - Reads from the stream into the buffer. It then passes the buffer to the decoder, which raises an event for - each message it decodes. - - The buffer to store the read bytes from the stream. - - - - Wraps exceptions in an outer exception so they can be passed to event handlers. If the Exception is already of a compatable type, - the method returns what it was given. - - The exception to wrap. - An exception of type TE - - - - Starts the background thread to start reading events from the network stream. - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Disposes the resources of this stream. - - Should dispose of unmanged resources. - - - - Event Arguments for EventStreamDecoder.MessageReceived. - - - - - Received message. - - - - - Additional object context - - - - - Initialize this with message - - - - - Initialize this with message and object conetext - - - - - Exception thrown when a request is made of the Decoder, but the internal state - machine is an invalid state. This is usually the result of an interanl exception - being thrown during parsing of the network stream. - - - - - Constructs a new instance of the EventStreamDecoderIllegalStateException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Contract for EventStreamDecoder - - - - - Invoked anytime an EventStreamMessage is found. - - - - - Processes data starting at offset up to length. - Invokes MessageRecieved for each message encountered. - If an exception is thrown, this object is not safe for reuse. - - buffer to read - offset in buffer to start reading. - length of data. - - - - Streaming decoder for listening for incoming EventStreamMessage datagrams. - - - - - Invoked anytime an EventStreamMessage is found. - - - - - Object data (optional) that can be passed to the event handler for MessageReceived. - - - - - Default constructor. Initializes internal _state machine. - - - - - Processes data starting at offset up to length. - Invokes MessageRecieved for each message encountered. - If an exception is thrown, this object is not safe for reuse. - - buffer to read - offset in buffer to start reading. - length of data. - - - - Superclass for Exceptions that come over the event stream, or to wrap other kinds of generic exceptions. - - - - - Constructs an EventStreamException. - - - - - Constructs an EventStreamException. - - The exception message. - - - - Constructs an EventStreamException. - - The exception message. - The inner exception. - - - - Constructs a new instance of the EventStreamException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - The contract for EventStream events. - - - - - The contract for EventStream terminal events. - - - - - This Event is returned if an event is retrieved from the event stream, but a generator function - for the event is not defined. This can occur if the SDK is not updated after a new event type is introduced. - - - - - The Message recieved from the event stream before conversion. - - - - - The event type. - - - - - Constructs an UnknownEventStreamEvent. - - - - - Constructs an UnknownEventStreamEvent. - - The Message recieved from the event stream before conversion. - The event type. - - - - Signals that an an has an unknown message type. These exceptions whould be - swallowed to allow future expansion of the EventStream specification without breaking existing clients. - - - - - Constructs an UnknownEventStreamMessageTypeException. - - - - - Constructs a new instance of the UnknownEventStreamMessageTypeException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - This exception is thrown if an exception is retrieved from the event stream and should be modeled, - but a generator function for the strongly-typed exception is not defined. - - - - - The exception type. - - - - - Constructs an EventStreamException. - - The exception type. - - - - Constructs a new instance of the UnknownEventStreamException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - All Amazon service interfaces like IAmazonS3 extend from this interface. This allows all the - Amazon service interfaces be identified by this base interface and helps with generic constraints. - - - - - A readonly view of the configuration for the service client. - - - - - This interface is the read only access to the ClientConfig object used when setting up service clients. Once service clients - are initiated the config object should not be changed to avoid issues with using a service client in a multi threaded environment. - - - - - Gets the RegionEndpoint property. The region constant to use that - determines the endpoint to use. If this is not set - then the client will fallback to the value of ServiceURL. - - - - - The constant used to lookup in the region hash the endpoint. - - - - - Gets and sets of the ServiceURL property. - This is an optional property if you need to set a specific service URL - instead setting the region with the RegionEndpoint property. - - - - - Gets the UseHttp property. - If this property is set to true, the client attempts - to use HTTP protocol. - By default, this property is set to false. - - - - - Gets Service Version - - - - - Gets the signatureMethod property. - - - - - Gets the SignatureVersion property. - - Note: This property exists for backward compatibility but is no longer - used by any service other than S3. - - - - - Gets the AuthenticationRegion property. - Used in AWS4 request signing, this is an optional property; - change it only if the region cannot be determined from the - service endpoint. - - - - - Gets the AuthenticationServiceName property. - Used in AWS4 request signing, this is the short-form - name of the service being called. - - - - - Gets the UserAgent property. - - - - - Gets the DisableLogging. If true logging for this client will be disabled. - - - - - Flag on whether to log metrics for service calls. - - This can be set in the application's configs, as below: - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSLogMetrics" value"true"/> - </appSettings> - </configuration> - - - - - - Gets the LogResponse property. - If this property is set to true, the service response - is read in its entirety and logged. - - - - - Gets the ReadEntireResponse. - If this property is set to true, the service response - is read in its entirety before being processed. - - - - - This flag controls if .NET HTTP infrastructure should follow redirection - responses (e.g. HTTP 307 - temporary redirect). - - - - - Gets the BufferSize property. - The BufferSize controls the buffer used to read in from input streams and write - out to the request. - - - - - Returns the flag indicating how many retry HTTP requests an SDK should - make for a single SDK operation invocation before giving up. This flag will - return 4 when the RetryMode is set to "Legacy" which is the default. For - RetryMode values of "Standard" or "Adaptive" this flag will return 2. In - addition to the values returned that are dependant on the RetryMode, the - value can be set to a specific value by using the AWS_MAX_ATTEMPTS environment - variable, max_attempts in the shared configuration file, or by setting a - value directly on this property. When using AWS_MAX_ATTEMPTS or max_attempts - the value returned from this property will be one less than the value entered - because this flag is the number of retry requests, not total requests. To - learn more about the RetryMode property that affects the values returned by - this flag, see . - - - - - Determines if MaxErrorRetry has been manually set. - - - - - Gets the interval at which progress update events are raised - for upload operations. By default, the progress update events are - raised at every 100KB of data transferred. - - - - - Flag on whether to resign requests on retry or not. - - - - - Credentials to use with a proxy. - - - - - Gets the default request timeout value. - - - - If the value is set, the value is assigned to the Timeout property of the HTTPWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - - - - Configures the endpoint calculation for a service to go to a dual stack (ipv6 enabled) endpoint - for the configured region. - - - Note: AWS services are enabling dualstack endpoints over time. It is your responsibility to check - that the service actually supports a dualstack endpoint in the configured region before enabling - this option for a service. - - - - - Configures a flag enabling to either opt in or opt out of the retry throttling service. - Note: set value to true to enable retry throttling feature. The Default value for this flag is false. - - - - - Using either the RegionEndpoint or the ServiceURL determine what the URL to the service is. - - The URL to the service. - - - - Performs validation on this config object. - Throws exception if any of the required values are missing/invalid. - - The timeout specified is null. - - - - Returns the clock skew adjusted utc now. This value is affected by AWSConfigs.ManualClockCorrection - - - - - Returns the calculated clock skew value for this config's service endpoint. If AWSConfigs.CorrectForClockSkew is false, - this value won't be used to construct service requests. - - - - - Gets the DisableHostPrefixInjection flag. If true, host prefix injection will be disabled for this client, the default value of this flag is false. - Host prefix injection prefixes the service endpoint with request members from APIs which use this feature. - Example: for a hostPrefix of "foo-name." and a endpoint of "service.region.amazonaws.com" the default behavior is to - prefix the endpoint with the hostPrefix resulting in a final endpoint of "foo-name.service.region.amazonaws.com". Setting - DisableHostPrefixInjection to true will disable hostPrefix injection resulting in a final endpoint of - "service.region.amazonaws.com" regardless of the value of hostPrefix. E.g. You may want to disable host prefix injection for testing against a local mock endpoint. - - - - - Returns the flag indicating if endpoint discovery should be enabled or disabled for operations that are not required to use endpoint discovery. - - - - - Returns the maximum number of discovered endpoints that can be stored within the cache for the client. The default limit is 1000 cache entries. - - - - - Returns the flag indicating the current mode in use for request - retries and influences the value returned from . - The default value is RequestRetryMode.Legacy. This flag can be configured - by using the AWS_RETRY_MODE environment variable, retry_mode in the - shared configuration file, or by setting this value directly. - - - - - Under Adaptive retry mode, this flag determines if the client should wait for - a send token to become available or don't block and fail the request immediately - if a send token is not available. - - - - - Gets the TCP keep-alive values to use for service requests. Enabling TCP keep-alive sends periodic TCP keep-alive probe packets, to prevent disconnection due to - network inactivity. This is useful when you make API calls that take a long time to respond. In this case, the connection could be dropped by an intermediate - node (e.g. proxy) as the connection is inactive for a long time. Timeout controls the duration of inactivity before a keep-alive probe packet is sent. - Interval controls the amount of time to wait before retrying a keep-alive probe packet in the event the server doesn't respond to a keep-alive probe. - - - - - Gets the ProxyHost property. - - - - - Gets the ProxyPort property. - - - - - Gets the max idle time set on the ServicePoint for the WebRequest. - Default value is 50 seconds (50,000 ms) unless ServicePointManager.MaxServicePointIdleTime is set, - in which case ServicePointManager.MaxServicePointIdleTime will be used as the default. - - - - - Gets the default read-write timeout value. - - - - - - - Gets the connection limit set on the ServicePoint for the WebRequest. - Default value is 50 connections unless ServicePointManager.DefaultConnectionLimit is set in - which case ServicePointManager.DefaultConnectionLimit will be used as the default. - - - - - Gets whether the Nagle algorithm is used on connections managed by the ServicePoint object used - for requests to AWS. This is defaulted to false for lower latency with responses that return small amount of data. This is the opposite - default than ServicePoint.UseNagleAlgorithm which is optimized for large responses like web pages or images. - - - - - Returns a WebProxy instance configured to match the proxy settings - in the client configuration. - - - - - Interface for a single logged message. - - - - - Log message format. - - - - - Log message arguments. - - - - - Culture-specific formatting provider. - - - - - Abstract parameter value. - - - - - String parameter value. - - - - - String value of the parameter. - - - - - Constructs ParameterValue for a single string. - - - - - - String list parameter value. - - - - - List of strings value of the parameter. - - - - - Constructs ParameterValue for a list of strings. - - - - - - The interface for an exception handler. - - - - - Handles an exception for the given execution context. - - The execution context, it contains the - request and response context. - The exception to handle. - - Returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception to replace the original exception. - - - - - The interface for an exception handler with a generic parameter for the exception type. - - The exception type. - - - - Handles an exception for the given execution context. - - The execution context, it contains the - request and response context. - The exception to handle. - - Returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception to replace the original exception. - - - - - The interface for a HTTP request factory. - - The type used by the underlying HTTP API to represent the request body. - - - - Creates an HTTP request for the given URI. - - The request URI. - An HTTP request. - - - - The interface for an HTTP request that is agnostic of the underlying HTTP API. - - The type used by the underlying HTTP API to represent the HTTP request content. - - - - The HTTP method or verb. - - - - - The request URI. - - - - - Configures a request as per the request context. - - The request context. - - - - Sets the headers on the request. - - A dictionary of header names and values. - - - - Gets a handle to the request content. - - The request content. - - - - Returns the HTTP response. - - The HTTP response. - - - - Writes a stream to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - The request context. - - - - Writes a byte array to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - - - - Sets up the progress listeners - - The content stream - The interval at which progress needs to be published - The objects which is trigerring the progress changes - The callback which will be invoked when the progress changed event is trigerred - an object, incase the progress is setup, else returns the original stream - - - - Aborts the HTTP request. - - - - - Gets a handle to the request content. - - - - - - Returns the HTTP response. - - A cancellation token that can be used to cancel the asynchronous operation. - - - - - Interface for a handler in a pipeline. - - - - - The logger used to log messages. - - - - - The inner handler which is called after the current - handler completes it's processing. - - - - - The outer handler which encapsulates the current handler. - - - - - Contains the processing logic for a synchronous request invocation. - This method should call InnerHandler.InvokeSync to continue processing of the - request by the pipeline, unless it's a terminating handler. - - The execution context which contains both the - requests and response context. - - - - Contains the processing logic for an asynchronous request invocation. - This method should call InnerHandler.InvokeSync to continue processing of the - request by the pipeline, unless it's a terminating handler. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - A retry policy specifies all aspects of retry behavior. This includes conditions when the request should be retried, - checks of retry limit, preparing the request before retry and introducing delay (backoff) before retries. - - - A retry policy specifies all aspects of retry behavior. This includes conditions when the request should be retried, - checks of retry limit, preparing the request before retry and introducing delay (backoff) before retries. - - - - - Maximum number of retries to be performed. - This does not count the initial request. - - - - - The logger used to log messages. - - - - - The standard set of throttling error codes - - - - - The standard set of timeout error codes to retry on. - - - - - List of AWS specific error codes which are returned as part of the error response. - These error codes will be retried. - - - - - The standard set of transient error, HTTP status codes to retry on. - 502 and 504 are returned by proxies. These can also be returned for - S3 accelerate requests which are served by CloudFront. - - - - - Set of web exception status codes to retry on. - - - - - This parameter serves as the value to the CapacityManager.Container datastructure. - Its properties include the available capacity left for making a retry request and the maximum - capacity size. - - - - - Checks if a retry should be performed with the given execution context and exception. - - The execution context which contains both the - requests and response context. - The exception thrown after issuing the request. - Returns true if the request should be retried, else false. The exception is retried if it matches with clockskew error codes. - - - - Returns true if the request is in a state where it can be retried, else false. - - The execution context which contains both the - requests and response context. - Returns true if the request is in a state where it can be retried, else false. - - - - Return true if the request should be retried for the given exception. - - The execution context which contains both the - requests and response context. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Checks if the retry limit is reached. - - The execution context which contains both the - requests and response context. - Return false if the request can be retried, based on number of retries. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called on a successful request response. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called before a retry request is initiated. The value - returned is True by default(retry throttling feature is disabled). - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called before a retry request is initiated. The value - returned is True by default(retry throttling feature is disabled). - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - - - - Virtual method that gets called before a retry request is initiated. The value - returned is True by default(retry throttling feature is disabled). - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - true if the error that will be retried is a throttling error - - - - This method uses a token bucket to enforce the maximum sending rate. - - The execution context which contains both the - requests and response context. - If the prior request failed, this exception is expected to be - the exception that occurred during the prior request failure. - - - - Determines if an AmazonServiceException is a throttling error - - The current exception to check. - true if it is a throttling error else false. - - - - Determines if an AmazonServiceException is a transient error that - should be retried. - - The current execution context - The current exception to check. - true if the exception is a transient error else false. - - - - Determines if the exception is a known timeout error code that - should be retried under the timeout error category. - - The current exception to check. - true if the exception is considered a timeout else false - - - - Checks if a retry should be performed with the given execution context and exception. - - The execution context which contains both the - requests and response context. - The exception throw after issuing the request. - Returns true if the request should be retried, else false. The exception is retried if it matches with clockskew error codes. - - - - This method uses a token bucket to enforce the maximum sending rate. - - The execution context which contains both the - requests and response context. - If the prior request failed, this exception is expected to be - the exception that occurred during the prior request failure. - - - - Return true if the request should be retried for the given exception. - - The execution context which contains both the - requests and response context. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - Metrics collected by the SDK on a per-request basis. - - - Each request made to an AWS service by the SDK can have metrics - collected and logged. This interface represents the collected - metrics for a request. The metrics include properties (i.e. request id - and other metadata), timings for each stage of the request, and counters. - - - - - Collection of properties being tracked - - - - - Timings for metrics being tracked - - - - - Counters being tracked - - - - - Whether metrics are enabled for the request - - - - - JSON representation of the current metrics - - JSON string - - - - Represents how long a phase of an SDK request took. - - - - - Whether the timing has been stopped - - - - - Elapsed ticks from start to stop. - If timing hasn't been stopped yet, returns 0. - - - - - Elapsed time from start to stop. - If timing hasn't been stopped yet, returns TimeSpan.Zero - - - - - User supplied type to perform metrics formatting. - - - - - Produce custom formatting for SDK metrics. - - - If defined, this method will be called for every request made by the SDK. - - An instance of IRequestMetrics produced by the SDK - formatted string representation of the metrics - - - - Predefined request metrics that are collected by the SDK. - - - - - Information about the request. - - - - - Gets and sets the RequestId property. - ID that uniquely identifies a request. Amazon keeps track of request IDs. If you have a question about a request, include the request ID in your correspondence. - - - - - ICoreAmazonKMS is not meant to be used directly. It defines Key Management Service - with basic .NET types and allows other services to be able to use the service as - a runtime dependency. This interface is implemented by the AmazonKeyManagementServiceClient - defined in the AWSSDK.KeyManagementService assembly. - - - - - The result of the GenerateDataKey and GenerateDataKeyAsync operations. - - - - - The plaintext for the data key. - - - - - The ciphertext for the data key. - - - - - ICoreAmazonS3 is not meant to use directly. It defines S3 with basic .NET types - and allows other services to be able to use S3 as a runtime dependency. This interface - is implemented by the AmazonS3Client defined in the S3 assembly. - - - ICoreAmazonS3 is not meant to use directly. It defines S3 with basic .NET types - and allows other services to be able to use S3 as a runtime dependency. This interface - is implemented by the AmazonS3Client defined in the S3 assembly. - - - ICoreAmazonS3 is not meant to use directly. It defines S3 with basic .NET types - and allows other services to be able to use S3 as a runtime dependency. This interface - is implemented by the AmazonS3Client defined in the S3 assembly. - - - - - Generate a presigned URL. - - - - - - - - - - Get all the object keys for the particular bucket and key prefix. - - - - - - - - - Upload an object from a stream. - - - - - - - - - - - Delete an object. - - - - - - - - - - Delete an object. - - - - - - - - - - Open a stream to an object in S3. - - - - - - - - - - Upload an object from a file path. - - - - - - - - - - - Download an object in S3 to a file path. - - - - - - - - - - - Set the ACL on the object to public readable. - - - - - - - - Check to see if the bucket exists and if it doesn't create the bucket. - - - - - - Check to see if the bucket exists. - - - - - - - Get all the object keys for the particular bucket and key prefix. - - - - - - - - - Delete the object. - - - - - - - - Deletes the ojects. - - - - - - - - Upload an object from a stream. - - - - - - - - - Upload an object from a file path. - - - - - - - - - Download object to a file path. - - - - - - - - - Get stream for an object. - - - - - - - - - Set the ACL on the object to public readable. - - - - - - - - Check to see if the bucket exists and if it doesn't create the bucket. - - - - - - Check to see if the bucket exists. - - - - - - - ICoreAmazonSQS is not meant to use directly. It defines SQS with basic .NET types - and allows other services to be able to use SQS as a runtime dependency. This interface - is implemented by the AmazonSQSClient defined in the SQS assembly. - - - - - - This method is used internally to access the Amazon SQS service within other service assemblies. - Please use AmazonSQSClient to access Amazon SQS instead. - - Get the attributes for the queue identified by the queue URL. - - The queue URL to get attributes for. - The attributes for the queue. - - - - Get the attributes for the queue identified by the queue URL asynchronously. - - The queue URL to get attributes for. - A Task containing the result of a dictionary of attributes for the queue. - - - - - This method is used internally to access the Amazon SQS service within other service assemblies. - Please use AmazonSQSClient to access Amazon SQS instead. - - Set the attributes on the queue identified by the queue URL. - - The queue URL to set the attributues. - The attributes to set. - - - - Set the attributes on the queue identified by the queue URL asynchronously. - - The queue URL to set the attributues. - The attributes to set. - A Task - - - - ICoreAmazonSTS is not meant to be used directly. It defines Security Token - service with basic .NET types and allows other services to be able to use the service as - a runtime dependency. This interface is implemented by the AmazonSecurityTokenServiceClient - defined in the AWSSDK.SecurityToken assembly. - - - - - - This method is used internally to access the Amazon Security Token - service within other service assemblies. - Please use AmazonSecurityTokenServiceClient to access the Amazon Security Token - service instead. - - Use Amazon Security Token Service to assume a role. - - Proxy settings that are required for the HTTPS and STS calls made during the authentication/credential - generation process are supported and should have been configured on the STS ClientConfig instance - associated with the STS client instance exposing this interface. - - - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRole. - - - - - - This method is used internally to access the Amazon Security Token - service within other service assemblies. - Please use AmazonSecurityTokenServiceClient to access the Amazon Security Token - service instead. - - Authenticates against a federated identity endpoint supporting SAML and returns - temporary AWS credentials for the supplied role. - - The endpoint for the federated identity provider - The authentication type to use (NTLM, Kerberos etc) - The ARN of the role the user is to assume following authentication - TTL duration for the generated credentials. - - Optional; alternate user credential for authentication. If null the identity of the - current process is used. - - Generated credential data, including SAML-related information such as subject. - - Proxy settings that are required for the HTTPS and STS calls made during the authentication/credential - generation process are supported and should have been configured on the STS ClientConfig instance - associated with the STS client instance exposing this interface. - - - - - - This method is used internally to access the Amazon Security Token - service within other service assemblies. - Please use AmazonSecurityTokenServiceClient to access the Amazon Security Token - service instead. - - Use Amazon Security Token Service to assume a role. - - Proxy settings that are required for the HTTPS and STS calls made during the authentication/credential - generation process are supported and should have been configured on the STS ClientConfig instance - associated with the STS client instance exposing this interface. - - - The web identity token used to assume the role. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRoleWithWebIdentity - - - - - - This method is used internally to access the Amazon Security Token - service within other service assemblies. - Please use AmazonSecurityTokenServiceClient to access the Amazon Security Token - service instead. - - Use Amazon Security Token Service to assume a role. - - Proxy settings that are required for the HTTPS and STS calls made during the authentication/credential - generation process are supported and should have been configured on the STS ClientConfig instance - associated with the STS client instance exposing this interface. - - - The web identity token used to assume the role. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRoleWithWebIdentity - - - - - CoreAmazonKMS is not meant to use directly. It implements ICoreAmazonKMS - and allows other service clients to be able to use the KMS service as a runtime dependency. - - This class waits until a method is actually called on the ICoreAmazonKMS interface - before requiring the KMS assembly to be present and loaded. - - - - - This exception is thrown if there are problems signing the request. - - - - - Constructs a new instance of the SignatureException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - - - - Gets the percentage of transfer completed - - - - - Gets the number of bytes transferred since last event - - - - - Gets the number of bytes transferred - - - - - Gets the total number of bytes to be transferred - - - - - Returns a string representation of this object - - - - - - Class that posts the CSM event to a UDP portconfig - This is a singleton class and is created once - per AmazonServiceClient. - - - - - The CSMevents are always posted to the localhost - - - - - Method to post UDP datagram for sync calls - - - - - Method to post UDP datagram for async calls - - - - - Method to post UDP datagram for bcl35 async calls - - - - - TcpKeepAlive class used to group all the different properties used for working with TCP keep-alives. - - - - - Specifies if TCP keep-alive is enabled or disabled. The default value is false for all services except Lambda. - - - - - The timeout before a TCP keep-alive packet will be sent. The timeout value must be greater - than 0 seconds and not null if Enabled is set to true. The default value is 5 minutes. - - - - - The interval before retrying a TCP keep-alive packet that did not receive an acknowledgement. The - interval must be greater than 0 seconds and not null if Enabled is set to true. The default value is 15 seconds. - - - - - Root AWS config section - - - - - Gets and sets the proxy settings for the SDK to use. - - - - - Settings for configuring a proxy for the SDK to use. - - - - - Gets and sets the host name or IP address of the proxy server. - - - - - Gets and sets the port number of the proxy. - - - - - Gets and sets the username to authenticate with the proxy server. - - - - - Gets and sets the password to authenticate with the proxy server. - - - - - Gets and set the proxy bypass list. A set of semi-colon - delimited regular expressions denoting the addresses that - should bypass the proxy. - - - - - Gets and sets the proxy option to bypass local addresses. - - - - - Logging section - - - - - Easy-to-use generic collection - - - - - - Configuration element that serializes properly when used with collections - - - - - ConfigurationElement class which returns false for IsReadOnly - - - - - Settings for configuring a proxy for the SDK to use. - - - Settings for configuring a proxy for the SDK to use. - - - - - The host name or IP address of the proxy server. - - - - - The port number of the proxy. - - - - - The username to authenticate with the proxy server. - - - - - The password to authenticate with the proxy server. - - - - - Collection of one or more regular expressions denoting addresses - for which the proxy will not be used. - - - For more information on bypass lists - see https://msdn.microsoft.com/en-us/library/system.net.webproxy.bypasslist%28v=vs.110%29.aspx. - - - - - If true requests to local addresses bypass the configured - proxy. - - - - - Settings for logging in the SDK. - - - Settings for logging in the SDK. - - - - - Logging destination. - - - - - When to log responses. - - - - - Gets or sets the size limit in bytes for logged responses. - If logging for response body is enabled, logged response - body is limited to this size. The default limit is 1KB. - - - - - Whether or not to log SDK metrics. - - - - - A custom formatter added through Configuration - - - - - Settings for configuring CSM in the SDK. - - - - - This class can be used to discover the public address ranges for AWS. The - information is retrieved from the publicly accessible - https://ip-ranges.amazonaws.com/ip-ranges.json file. - - - The information in this file is generated from our internal system-of-record and - is authoritative. You can expect it to change several times per week and should - poll accordingly. - - - - - Region identifier string for ROUTE53 and CLOUDFRONT ranges - - - - - Collection of service keys found in the data file. - - - - - The publication date and time of the file that was downloaded and parsed. - - - - - Collection of all public IP ranges. - - - - - Filtered collection of public IP ranges for the given service key - - - - - Filtered collection of public IP ranges for the given region (us-east-1 etc) or GLOBAL. - - - - - Filtered collection of public IP ranges for the given network border group. - - - - - Downloads the most recent copy of the endpoint address file and - parses it to a collection of address range objects. - - - - - Downloads the most recent copy of the endpoint address file and - parses it to a collection of address range objects. - - - - - Represents the IP address range for a single region and service key. - - - - - The public IPv4 or Ipv6 address range, in CIDR notation. - - - - - Indicates ipv4 or v6 format of the address - - - - - The AWS region or GLOBAL for edge locations. Note that the CLOUDFRONT and ROUTE53 - ranges are GLOBAL. - - - - - The subset of IP address ranges. Specify AMAZON to get all IP address ranges - (for example, the ranges in the EC2 subset are also in the AMAZON subset). Note - that some IP address ranges are only in the AMAZON subset. - - - Valid values for the service key include "AMAZON", "EC2", "ROUTE53", - "ROUTE53_HEALTHCHECKS", and "CLOUDFRONT." If you need to know all of - the ranges and don't care about the service, use the "AMAZON" entries. - The other entries are subsets of this one. Also, some of the services, - such as S3, are represented in "AMAZON" and do not have an entry that - is specific to the service. We plan to add additional values over time; - code accordingly! - - - - - The network border group the IP address range belongs to. - - - AWS Local Zones allow you to seamlessly connect to the full range of services in the AWS Region such - as Amazon Simple Storage Service and Amazon DynamoDB through the same APIs and tool sets. You can extend - your VPC Region by creating a new subnet that has a Local Zone assignment. When you create a subnet in - a Local Zone, the VPC is also extended to that Local Zone. - - A network border group is a unique set of Availability Zones or Local Zones from where AWS advertises - public IP addresses. - - When you create a VPC that has IPv6 addresses, you can choose to assign a set of Amazon-provided public - IP addresses to the VPC and also set a network border group for the addresses that limits the addresses - to the group. When you set a network border group, the IP addresses cannot move between network - border groups. The us-west-2 network border group contains the four US West (Oregon) Availability Zones. - The us-west-2-lax-1 network border group contains the Los Angeles Local Zones. - - - - - This class defines utilities and constants that can be used by - all the client libraries of the SDK. - - - - - The user agent string header - - - - - The Set of accepted and valid Url characters per RFC3986. - Characters outside of this set will be encoded. - - - - - The Set of accepted and valid Url characters per RFC1738. - Characters outside of this set will be encoded. - - - - - The set of accepted and valid Url path characters per RFC3986. - - - - - The string representing Url Encoded Content in HTTP requests - - - - - The GMT Date Format string. Used when parsing date objects - - - - - The ISO8601Date Format string. Used when parsing date objects - - - - - The ISO8601Date Format string. Used when parsing date objects - - - - - The ISO8601 Basic date/time format string. Used when parsing date objects - - - - - The ISO8601 basic date format. Used during AWS4 signature computation. - - - - - The RFC822Date Format string. Used when parsing date objects - - - - - Returns an extension of a path. - This has the same behavior as System.IO.Path.GetExtension, but does not - check the path for invalid characters. - - - - - - Convert request parameters to Url encoded query string - - - Convert Dictionary of parameters to Url encoded query string - - - - Returns the canonicalized resource path for the service endpoint with single URL encoded path segments. - - Endpoint URL for the request - Resource path for the request - - If resourcePath begins or ends with slash, the resulting canonicalized - path will follow suit. - - Canonicalized resource path for the endpoint - - - - Returns the canonicalized resource path for the service endpoint - - Endpoint URL for the request - Resource path for the request - If true pre URL encode path segments if necessary. - S3 is currently the only service that does not expect pre URL encoded segments. - - If resourcePath begins or ends with slash, the resulting canonicalized - path will follow suit. - - Canonicalized resource path for the endpoint - - - - Returns the canonicalized resource path for the service endpoint - - Endpoint URL for the request - Resource path for the request - If true pre URL encode path segments if necessary. - S3 is currently the only service that does not expect pre URL encoded segments. - Dictionary of key/value parameters containing the values for the ResourcePath key replacements - The version of the marshaller that constructed the request object. - - If resourcePath begins or ends with slash, the resulting canonicalized - path will follow suit. - - Canonicalized resource path for the endpoint - - - - Splits the resourcePath at / into segments then resolves any keys with the path resource values. Greedy - key values will be split into multiple segments at each /. - - The patterned resourcePath - The key/value lookup for the patterned resourcePath - A list of path segments where all keys in the resourcePath have been resolved to one or more path segment values - - - - Joins all path segments with the / character and encodes each segment before joining. - - The segments of a URL path split at each / character - If the path property is specified, - the accepted path characters {/+:} are not encoded. - A joined URL with encoded segments - - - - Takes a patterned resource path and resolves it using the key/value path resources into - a segmented encoded URL. - - The patterned resourcePath - The key/value lookup for the patterned resourcePath - A segmented encoded URL - - - - Returns a new string created by joining each of the strings in the - specified list together, with a comma between them. - - The list of strings to join into a single, comma delimited - string list. - A new string created by joining each of the strings in the - specified list together, with a comma between strings. - - - - Attempt to infer the region for a service request based on the endpoint - - Endpoint to the service to be called - - Region parsed from the endpoint; DefaultRegion (or DefaultGovRegion) - if it cannot be determined/is not explicit - - - - - Attempt to infer the service name for a request (in short form, eg 'iam') from the - service endpoint. - - Endpoint to the service to be called - - Short-form name of the service parsed from the endpoint; empty string if it cannot - be determined - - - - - Utility method for converting Unix epoch seconds to DateTime structure. - - The number of seconds since January 1, 1970. - Converted DateTime structure - - - - Helper function to format a byte array into string - - The data blob to process - If true, returns hex digits in lower case form - String version of the data - - - - Calls a specific EventHandler in a background thread - - - - - - - - Parses a query string of a URL and returns the parameters as a string-to-string dictionary. - - - - - - - Utility method for converting a string to a MemoryStream. - - - - - - - Utility method for copy the contents of the source stream to the destination stream. - - - - - - - Utility method for copy the contents of the source stream to the destination stream. - - - - - - - - Formats the current date as a GMT timestamp - - A GMT formatted string representation - of the current date and time - - - - - Formats the current date as ISO 8601 timestamp - - An ISO 8601 formatted string representation - of the current date and time - - - - - Gets the ISO8601 formatted timestamp that is minutesFromNow - in the future. - - The number of minutes from the current instant - for which the timestamp is needed. - The ISO8601 formatted future timestamp. - - - - Formats the current date as ISO 8601 timestamp - - An ISO 8601 formatted string representation - of the current date and time - - - - - Gets the RFC822 formatted timestamp that is minutesFromNow - in the future. - - The number of minutes from the current instant - for which the timestamp is needed. - The ISO8601 formatted future timestamp. - - - - Determines whether the given string is an absolute path to a root. - - The hypothetical absolute path. - True if is an absolute path. - - - - Returns true if the path specified is relative to the current drive or working directory. - Returns false if the path is fixed to a specific drive or UNC path. This method does no - validation of the path (URIs will be returned as relative as a result). - - - Handles paths that use the alternate directory separator. It is a frequent mistake to - assume that rooted paths (Path.IsPathRooted) are not relative. This isn't the case. - "C:a" is drive relative- meaning that it will be resolved against the current directory - for C: (rooted, but relative). "C:\a" is rooted and not relative (the current directory - will not be used to modify the path). - - - - - True if the given character is a directory separator. - - - - - Returns true if the given character is a valid drive letter - - - - - URL encodes a string per RFC3986. If the path property is specified, - the accepted path characters {/+:} are not encoded. - - The string to encode - Whether the string is a URL path or not - The encoded string - - - - URL encodes a string per the specified RFC. If the path property is specified, - the accepted path characters {/+:} are not encoded. - - RFC number determing safe characters - The string to encode - Whether the string is a URL path or not - The encoded string - - Currently recognised RFC versions are 1738 (Dec '94) and 3986 (Jan '05). - If the specified RFC is not recognised, 3986 is used by default. - - - - - URL encodes a string per the specified RFC with the exception of preserving the encoding of previously encoded slashes. - If the path property is specified, the accepted path characters {/+:} are not encoded. - - The string to encode - Whether the string is a URL path or not - The encoded string with any previously encoded %2F preserved - - - - Convert bytes to a hex string - - Bytes to convert. - Hexadecimal string representing the byte array. - - - - Convert a hex string to bytes - - Hexadecimal string - Byte array corresponding to the hex string. - - - - Returns DateTime.UtcNow + ManualClockCorrection when - is set. - This value should be used instead of DateTime.UtcNow to factor in manual clock correction - - - - - Returns true if the string has any bidirectional control characters. - - - - - - - Executes an HTTP request and returns the response as a string. This method - throws WebException and HttpRequestException. In the event HttpRequestException - is thrown the StatusCode is sent as user defined data on the exception under - the key "StatusCode". - - The URI to make the request to - The request type: GET, PUT, POST - null or the content to send with the request - Timeout for the request - Proxy for the request - null or any headers to send with the request - The response as a string. - - - - Utility method that accepts a string and replaces white spaces with a space. - - - - - - - Runs a process with the below input parameters. - - - - - - - This method allows to check whether a property of an object returned by a service call - is set. This method is needed to discriminate whether a field is not set (not present in - the service response) or if it is set to the default value for its type. Using this - method is not required for nullable properties (non-ValueType and Nullable) because - they will be simply set to null when not included in the service response. - This method can also be used on objects used as part of service requests. - This method doesn't support objects that are part of the S3 service model. - - An object that is used in an AWS service request or is - returned as part of an AWS service response. - The name of the property of awsServiceObject to check. - True if the property is set, otherwise false. - - - - This method is used preserve the stacktrace used from clients that support async calls. This - make sure that exceptions thrown during EndXXX methods has the orignal stacktrace that happen - in the background thread. - - - - - - Root AWS config - - - - - Wrapper class which invokes the static method - public static string GetEnvironmentVariable(string variable) - underneath. This class is added as a property on the singleton class - EnvironmentVariableSource. This change was done for testability. - - - - - Singleton class that holds the property of type IEnvironmentVariableRetreiver. - This property can hold an instance of type EnvironmentVariableRetreiver which has a wrapper - method for - public static string GetEnvironmentVariable(string variable) - or can be mocked for testing purposes. - - - - - Interface for EnvironmentVariableRetriever. - This serves as a property for the singleton EnvironmentVariableSource - - - - - Manager to access a settings store file. Objects are primarily accessed by DisplayName rather than unique key. - Settings store files are located under the current user's AppData\Local\AWSToolkit folder. - Select keys in these files are encrypted on a per user, per machine basis using the Windows Data Protection API; - the encrypted values cannot be used by any other user or on any other machine. - - This class is not threadsafe. - - - - - True if the encrypted store is availble, false otherwise. - - - - - Construct an NamedSettingsManager. - - The base filename to read/write. - - - - Register an object. Let the uniqueKey be assigned automatically. - - The display name for the object. - The property names and values for the object. - The unique key that was assigned to the object. - - - - Try to get an object form the store. - - The display name for the object. - The property names and values for the object. - True if the object was found, false otherwise. - - - - Try to get an object form the store. - - The display name for the object. - The uniqueKey of the object in the store - The property names and values for the object. - True if the object was found, false otherwise. - - - - Unregister an object from the store. - - The display name for the object. - - - - Rename an object in the store. - - - - if true and destination object already exists overwrite it - - - - Copy an object in the store. - The new object will be a copy of the original, except it will be assigned a new unique key. - - - - if true and destination object already exists overwrite it - - - - Get a list of the display names for the objects in the store. - - A list of display names. - - - - Manager to access a settings store file. - Settings store files are located under the current user's AppData\Local\AWSToolkit folder. - Select keys in these files are encrypted on a per user, per machine basis using the Windows Data Protection API; - the encrypted values cannot be used by any other user or on any other machine. - - This class is not threadsafe. - - - - - True if the encrypted store is availble, false otherwise. - - - - - Construct a SettingsManager. - - The base filename to read/write. - - - - The base filename to read/write. - - - - - Register an object. Let the uniqueKey be assigned automatically. - - The property names and values for the object. - The unique key that was assigned to the object. - - - - Register an object. - - The uniqueKey for the object, or null if one should be assigned automatically. - The property names and values for the object. - The unique key that was assigned to the object. - - - - Try to get an object form the store. - - The uniqueKey of the object in the store - The property names and values for the object. - True if the object was found, false otherwise. - - - - Try to get an object form the store based on the value of a specific property. - If multiple objects with the same property value exist, return the first one. - - The name of the property to search on. - The value of the property to search on. - The unique key of the object. - The properties of the object. - - - - - Get a list of the unique keys of all the objects in the store. - - - - - - Get the value of a specific property for each object in the store. - - - - - - - Unregister an object from the store. - - The unique key for the object. - - - - Class that contains result of executing an external process through the SDKs - AWSSDKUtils.RunProcess/AWSSDKUtils.RunProcessAsync - - - - - The exit code with which the process exited - - - - - The output of the process read till the end - - - - - The error output of the process read till the end - - - - - Object to track circular references in nested types. - At each level of nesting, make a call to Track to retrieve Tracker, - a tracking object implementing the IDisposable interface. - Dispose of this tracker when leaving the context of the tracked object. - - - - - Tracker. Must be disposed. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Adds the current target to a reference list and returns a tracker. - The tracker removes the target from the reference list when the - tracker is disposed. - - - - - - - Provides access to EC2 instance metadata when running on an EC2 instance. - If this class is used on a non-EC2 instance, the properties in this class - will return null. - - - - Amazon EC2 instances can access instance-specific metadata, as well as data supplied when launching the instances, using a specific URI. - - - You can use this data to build more generic AMIs that can be modified by configuration files supplied at launch time. - For example, if you run web servers for various small businesses, they can all use the same AMI and retrieve their content from the - Amazon S3 bucket you specify at launch. To add a new customer at any time, simply create a bucket for the customer, add their content, - and launch your AMI. - - - More information about EC2 Metadata - - - - - - - - - - Allows to configure the proxy used for HTTP requests. The default value is null. - - - - - The AMI ID used to launch the instance. - - - - - The index of this instance in the reservation. - - - - - The manifest path of the AMI with which the instance was launched. - - - - - The AMI IDs of any instances that were rebundled to create this AMI. - Will only exist if the AMI manifest file contained an ancestor-amis key. - - - - - The private hostname of the instance. - In cases where multiple network interfaces are present, - this refers to the eth0 device (the device for which the device number is 0). - - - - - Notifies the instance that it should reboot in preparation for bundling. - Valid values: none | shutdown | bundle-pending. - - - - - The ID of this instance. - - - - - The type of instance. - - - - - The ID of the kernel launched with this instance, if applicable. - - - - - The local hostname of the instance. In cases where multiple network interfaces are present, - this refers to the eth0 device (the device for which device-number is 0). - - - - - The instance's MAC address. In cases where multiple network interfaces are present, - this refers to the eth0 device (the device for which device-number is 0). - - - - - The private IP address of the instance. In cases where multiple network interfaces are present, - this refers to the eth0 device (the device for which device-number is 0). - - - - - The Availability Zone in which the instance launched. - - - - - Product codes associated with the instance, if any. - - - - - Public key. Only available if supplied at instance launch time. - - - - - The ID of the RAM disk specified at launch time, if applicable. - - - - - The region in which the instance is running, extracted from the identity - document data. - - - - - ID of the reservation. - - - - - The names of the security groups applied to the instance. - - - - - Returns information about the last time the instance profile was updated, - including the instance's LastUpdated date, InstanceProfileArn, and InstanceProfileId. - - - - - Returns the temporary security credentials (AccessKeyId, SecretAccessKey, SessionToken, and Expiration) - associated with the IAM roles on the instance. - - - - - The virtual devices associated with the ami, root, ebs, and swap. - - - - - The network interfaces on the instance. - - - - - The metadata sent to the instance. - - - - - Value showing whether the customer has enabled detailed - one-minute monitoring in CloudWatch. - - - - - JSON containing instance attributes, such as instance-id, private IP - address, etc - - - - - Data that can be used by other parties to verify its origin and authenticity. - - - - - Used to verify the document's authenticity and content against the signature. - - - - - Return the list of items in the metadata at path. - - Path at which to query the metadata; may be relative or absolute. - List of items returned by the metadata service - - - - Return the metadata at the path - - Path at which to query the metadata; may be relative or absolute. - Data returned by the metadata service - - - - Return the metadata at the path - - Path at which to query the metadata; may be relative or absolute. - Number of attempts to make - Data returned by the metadata service - - - - Return the list of items in the metadata at path. - - Path at which to query the metadata; may be relative or absolute. - Number of attempts to make - List of items returned by the metadata service - - - - Fetches the api token to use with metadata requests. - - The API token or null - - - - Fetches the api token to use with metadata requests. - - The number of tries to fetch the api token before giving up and throwing the web exception - The API token or null if an API token couldn't be obtained and doesn't need to be used - - - - Exponentially sleeps based on the current retry value. A lower - value will sleep shorter than a larger value - - Base 0 retry index - - - - Returns information about the last time the instance profile was updated, - including the instance's LastUpdated date, InstanceProfileArn, and InstanceProfileId. - - - - - The status of the instance profile - - - - - Further information about the status of the instance profile - - - - - The date and time the instance profile was updated - - - - - The Amazon Resource Name (ARN) of the instance profile - - - - - The Id of the instance profile - - - - - The temporary security credentials (AccessKeyId, SecretAccessKey, SessionToken, and Expiration) associated with the IAM role. - - - - - The status of the security credential - - - - - Further information about the status of the instance profile - - - - - The date and time the security credential was last updated - - - - - The type of the security credential - - - - - The uniqe id of the security credential - - - - - The secret key used to sign requests - - - - - The security token - - - - - The date and time when these credentials expire - - - - - All of the metadata associated with a network interface on the instance. - - - - - Construct an instance of NetworkInterface - - - - - - The interface's Media Access Control (mac) address. - - - - - The ID of the owner of the network interface. - - - In multiple-interface environments, an interface can be attached by a third party, such as Elastic Load Balancing. - Traffic on an interface is always billed to the interface owner. - - - - - The interface's profile - - - - - The interface's local hostname. - - - - - The private IP addresses associated with the interface. - - - - - The interface's public hostname. - - - - - The elastic IP addresses associated with the interface. - - - There may be multiple IP addresses on an instance. - - - - - Security groups to which the network interface belongs. - - - - - IDs of the security groups to which the network interface belongs. Returned only for Amazon EC2 instances launched into a VPC. - - - - - The ID of the Amazon EC2-VPC subnet in which the interface resides. - - - Returned only for Amazon EC2 instances launched into a VPC. - - - - - The CIDR block of the Amazon EC2-VPC subnet in which the interface resides. - - - Returned only for Amazon EC2 instances launched into a VPC. - - - - - The CIDR block of the Amazon EC2-VPC subnet in which the interface resides. - - - Returned only for Amazon EC2 instances launched into a VPC. - - - - - Get the private IPv4 address(es) that are associated with the public-ip address and assigned to that interface. - - The public IP address - Private IPv4 address(es) associated with the public IP address - - - - This class allows profiles supporting AWS credentials and SAML-based authentication to be registered with - the SDK so that they can later be reference by a profile name. The credential profiles will be available - for use in the AWS Toolkit for Visual Studio and the AWS Tools for Windows PowerShell. - - The credentials are stored under the current users AppData folder encrypted using Windows Data Protection API. - - - To reference a profile from an application's App.config or Web.config use the AWSProfileName setting. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="development"/> - </appSettings> - </configuration> - - - - - - - Registers an AWS credentials profile that can later be referenced by the profileName. - This profile will only be visible for the current user. - - Name given to the AWS credentials. - The AWS access key id - The AWS secret key - - - - - Registers a role-based profile to be used with SAML authentication. The profile contains - details of the role to be assumed when AWS credentials are requested based on the role and - a reference to a SAML endpoint profile containing details of the endpoint to be called to - authenticate the user. - - - If user identity information is not supplied then the identity of the logged-in user will - be used when authenticaton is performed against the endpoint referenced in the SAML endpoint - profile. If identity is provided, no password information is stored in the role profile and - the user must supply the password for the identity prior to authentication with the endpoint. - - - Name to be assigned to the profile - - The name assigned to the endpoint settings, previously saved with RegisterSAMLEndpoint. - - - The arn of the role that the user wants to assume when using this profile. This - must be one of the set returned by the saml endpoint when the user authenticates. - - - Optional. By default the identity of the logged-in user will be used when authentication - is performed - the user will not be prompted to supply a password. By supplying a custom - identity for this parameter, the user will be prompted to supply the password for the - identity prior to authentication. - - - - - - Registers a role-based profile to be used with SAML authentication. The profile contains - details of the role to be assumed when AWS credentials are requested based on the role and - a reference to a SAML endpoint profile containing details of the endpoint to be called to - authenticate the user. - - - If user identity information is not supplied then the identity of the logged-in user will - be used when authenticaton is performed against the endpoint referenced in the SAML endpoint - profile. If identity is provided, no password information is stored in the role profile and - the user must supply the password for the identity prior to authentication with the endpoint. - - - Name to be assigned to the profile - - The name assigned to the endpoint settings, previously saved with RegisterSAMLEndpoint. - - - The arn of the role that the user wants to assume when using this profile. This - must be one of the set returned by the saml endpoint when the user authenticates. - - - Optional. By default the identity of the logged-in user will be used when authentication - is performed - the user will not be prompted to supply a password. By supplying a custom - identity for this parameter, the user will be prompted to supply the password for the - identity prior to authentication. - - - Set for profiles intended to be used in regions where a region-specific STS endpoint - must be used (eg cn-north-1). If left empty/null, the global sts.amazonaws.com endpoint - will be used when credentials are obtained for this profile. - - - - - Registers an endpoint to be used in conjunction with SAML role profiles. The role profiles - reference the endpoint settings to obtain the actual endpoint and any customization settings - needed to perform authentication. - - Name to be assigned to the endpoint settings. - The full uri of the authentication endpoint. - - The authentication type to use when performing calls against the endpoint. Valid values are 'NTLM', - 'Digest', 'Kerberos' and 'Negotiate'. The default if not configured (null/empty string) is 'Kerberos'. - - The unique id assigned to the new settings. - - - - Deletes the settings for an AWS credentials or SAML role profile from the SDK account store. - - The name of the profile to remove. - - - - Lists all profile names registered with the SDK account store. - - The profile names. - - - - Loads and returns all available credential profiles registered in the store. - - Collection of profiles. - - - - Checks if a given profile is known in the SDK credential store. - - The name of the profile to test for existence - True if the profile exists. - - - - Copies the contents of the source profile to the destination. If the destination - profile does not exist a new profile is created. Note that if the destination - profile exists, all keys it contains are removed and replaced with keys from the - source profile. - - The name of the profile to copy from. - The name of the profile to create or update. - The unique id assigned to the destination settings. - - - - Copies the contents of the source profile to the destination. If the destination - profile does not exist a new profile is created. Note that if the destination - profile exists, all keys it contains are removed and replaced with keys from the - source profile. - - The source profile to copy keys and values from. - The name of the profile to create or update. - The unique id assigned to the destination settings. - - - - Tries to get the AWS credentials from a profile in the SDK account store. - - The profile to get the credentials for. - Outputs the credentials for the profile. - Returns true if the profile exists otherwise false is returned. - - - - Gets the AWS credentials from a profile in the SDK account store. - - The profile to get the credentials for. - The AWS credentials for the profile. - Thrown if the profile does not exist - - - - Returns the profile with the specified name, if it has been registered in the SDK store. - - The name of the registered profile - The loaded profile data - - - - Returns the persisted data in the SDK store as a profile of the specified type T. - - The name of the profile holding the settings. - The loaded profile. An exception is thrown if the profile could not be loaded. - Thrown if the profile does not exist - - Currently supported profile types: AWSCredentialsProfile and SAMLRoleProfile. - - - - - Tries to load the specified profile data corresponding to profile type T from a named - profile in the SDK account store. - - The name of the profile holding the settings. - The loaded profile data. - Returns true if the profile exists otherwise false is returned. - - Currently supported profile types: AWSCredentialsProfile and SAMLRoleProfile. - - - - - Attempts to load the settings defining a SAML endpoint. - - The name assigned to the settings for the endpoint. - The instantiated endpoint. - True if the settings were successfully loaded. - - - - Loads the settings defining a SAML endpoint. - - The name assigned to the settings for the endpoint. - The loaded settings. An exception is thrown if they could not be loaded. - Thrown if the endpoint settings do not exist. - - - - Common base contract for all types of credential and role profiles. - - - - - The user-defined name for the settings. - - - - - The unique id of the profile in the backing store. - - - - - Saves the profile data to backing store, returning the unique id - assigned to the data. - - - - - The persisted data for a set of AWS credentials. At a minimum this - is access key and secret key data. - - - - - Tests if an AWSCredentialsProfile instance could be instantiated from - the persisted settings data. - - The name given to the persisted settings (previously verified as existing). - True if the settings are compatible with an AWSCredentialsProfile type. - - - - Tests if an AWSCredentialsProfile instance could be instantiated from - the persisted settings data. - - The persisted settings. - True if the settings are compatible with an AWSCredentialsProfile type. - - - - Instantiates an AWSCredentialsProfile instance from the specified profile name. - - The name of the profile holding the settings. - New credentials profile instance. An exception is thrown if the profile data is invalid. - - - - Instantiates an AWSCredentialsProfile instance from the supplied settings collection. - - The settings representing the stored profile. - New credentials profile instance. An exception is thrown if the profile data is invalid. - - - - Validates the contents of the specified profile. - - The name of the AWS credentials profile to validate. - Thrown if the profile settings fail to validate. - - - - Verifies that the persisted settings contains the minimal viable data to - instantiate an AWSCredentialsProfile instance. - - The persisted settings. - Thrown if the profile settings fail to validate. - - - - Persists the profile data to the store file. - - The unique ID assigned to the settings. - - - - Creates or updates the profile data in the store file. - - The unique ID assigned to the settings. - - - - The persisted data for a SAML endpoint. One or more role profiles - will reference this to obtain the common endpoint and other data needed - to perform authentication with a set of user credentials. - - - - - The default authentication type to use when attempting to perform an - authentication call against the configured endpoint. - - - - - The authentication endpoint which must be a HTTPS scheme. - - - - - The authentication type to use when calling the endpoint. - - - - - Tests if a SAMLEndpointSettings instance could be instantiated from - the persisted settings data. - - The name given to the persisted settings. - True if the settings are compatible. - - - - Tests if a SAMLEndpointSettings instance could be instantiated from - the persisted settings data. - - The persisted settings. - True if the settings are compatible. - - - - Instantiates an instance from settings stored with the specified name. - - The name of the endpoint settings in the store. - Profile instance or an exception if the profile data does not exist/contains invalid data. - - - - Instantiates an instance from the supplied settings. - - The persisted settings. - Profile instance or an exception if the profile data is invalid. - - - - Validates the contents of the specified endpoint settings. - - The name of the SAML endpoint settings to validate. - Thrown if the settings fail to validate. - - - - Verifies that the persisted settings contains the minimal viable data to - instantiate a SAMLEndpointSettings instance. - - The persisted settings. - Thrown if the settings fail to validate. - - - - Persists the settings to the storage file. - - The unique id assigned to the profile - - - - Creates or updates the settings data for a SAML endpoint in the backing store file. An error is - thrown if the scheme for the endpoint is not https. - - The name of the settings to create or update - The authentication endpoint - Optional authentication type to use when performing calls against the endpoint - The unique id assigned to the profile - - - - Constructs an endpoint settings instance. - - The user-defined name to assign to the settings. - - The absolute uri, including any query and relyingParty data, of the endpoint. - - - The authentication type to use when performing requests against the endpoint. - - - - - - The persisted data for a saml role profile for a user. This profile - references an endpoint profile containing the actual endpoint to be used, and - adds details of the role to be assumed when the profile is selected. - - - Optionally the profile can store a username and domain to be used during - authentication (default behavior, if this is not specified, is to use the user's - default network credentials). - - - - - - The ARN of the role that is to be assumed. - - - - - If non-default network credentials are to used contains - the user identity (in domain\user format, domain optional) that - should be used to supply credentials when the profile is used in - authentication. The user must be prompted to supply the - corresponding password prior to authentication. - - - - - If a specific user identity was specified in the profile, - returns true to indicate a password needs to be obtained from - the user before obtaining network credentials to be used on - authentication. The default is to use the credentials - associated with the currently logged-in user or process to - perform authentication, which does not require the user to be - prompted. - - - - - - For regions with a region-specific endpoint for STS (eg cn-north-1) this - field can be set to ensure calls to obtain temporary credentials - after successful authentication are forwarded to the correct regional - endpoint. - - - This field does not need to be set when running in a region for - which the sts.amazonaws.com endpoint is valid. - - - - - - Retrieves the active credential session, if any, associated with the - role profile. - - - The current credentials valid for the role specified in the profile. Returns - null if no active session is available, or the active session has expired. - - - When a user successfully authenticates and receives temporary AWS - credentials for a role, the profile is updated with details of the - session. When the profile is loaded by other processes or tools, if - session data is present and still valid it can be retrieved using this - method avoiding the need to re-authenticate and get additional temporary - credentials. - - - - - Persists the current credentials to a 'session' key in the RoleSessions.json file. - This enables external applications and tools using the same profile to obtain credentials - without needing to separately re-authenticate the user prior to expiry of the current - credentials. After persisting the session data it can be retrieved using GetCurrentSession(). - - - Although the credentials are temporary we still encrypt the stored data when at rest in - the sdk credential store. - - - The current credentials valid for the role specified in the profile. - - - - - Stores or clears the persisted session data. - - - - - - The endpoint settings from which the actual endpoint to use in authentication - is obtained. - - - - - Tests if a SAMLRoleProfile instance could be instantiated from - the persisted settings data. - - The name given to the persisted settings. - True if the settings are compatible with a SAMLRoleProfile type. - - - - Tests if a SAMLRoleProfile instance could be instantiated from - the persisted settings data. - - The persisted settings. - True if the settings are compatible with a SAMLRoleProfile type. - - - - Instantiates an instance from settings stored with the specified name. - - The name of the endpoint profile. - Profile instance or an exception if the profile data does not exist/contains invalid data. - - - - Instantiates an instance from the supplied settings. In addition to the profile settings - the SDK will inspect for a RoleSessions.json file containing active session data and if - an entry for the profile is present, will add the session data to the returned profile - object. - - The persisted settings. - Profile instance or an exception if the profile data is invalid. - - - - Validates the contents of the specified profile. - - The name of the SAML role profile to validate. - Thrown if the profile settings fail to validate. - - - - Validates that the presented settings would result in a valid role profile - instance. - - The persisted settings. - Thrown if the profile settings fail to validate. - - - - Stores the data in the role profile to the backing store file. - - - - - - Registers a role-based profile to be used with SAML authentication. The profile contains - details of the role to be assumed when AWS credentials are requested based on the role and - a reference to a SAML endpoint profile containing details of the endpoint to be called to - authenticate the user. - - - If user identity information is not supplied then the identity of the logged-in user will - be used when authenticaton is performed against the endpoint referenced in the SAML endpoint - profile. If identity is provided, no password information is stored in the role profile and - the user must supply the password for the identity prior to authentication with the endpoint. - - - Name to be assigned to the profile - - The name of the settings in the SAML endpoints file containing details of the - endpoint to authenticate with. - - - The arn of the role that the user wants to assume when using this profile. This - must be one of the set returned by the saml endpoint when the user authenticates. - - - Optional, can be used to prompt the user for a password for the account when authentication - is performed from a system that is not domain-joined. - - - Optional, details of the currently active credentials for the role that we want to - persist into the profile for other tools or processes to pick up, avoiding the need - to continually re-authenticate the user as they switch between tools. The active session, - if any, is stored separately from the profile using the file RoleSessions.json. - - - Set for profiles intended to be used in regions where a region-specific STS endpoint - must be used (eg cn-north-1). If left empty/null, the global sts.amazonaws.com endpoint - will be used when credentials are obtained for this profile. - - The unique id assigned to the profile. - - - - Tests for and loads any active session credentials for the specified profile. The session data - exists in a separate file from the profile, RoleSessions.json. - - - - - - - Stores the supplied session data into the RoleSessions.json backing file. - - - - - - - Constructs a profile data instance that will use the specified network identity - during authentication with configured endpoint. - - The user-defined name of the profile that sourced this data. - The settings for the authentication endpoint. - The role that should be assumed on successful authentication. - The credentials to supply in authentication, in domain\user format. - - Deserialized credential data from the profile, if still valid. Null if the profile does not - contain any active credentials, or the credentials it did hold are now invalid. - - - Set for profiles intended to be used in regions where a region-specific STS endpoint - must be used (eg cn-north-1). If left empty/null, the global sts.amazonaws.com endpoint - will be used when credentials are obtained for this profile. - - - - - AwsHttpClient is a wrapper around HttpClient class of the System.Net.Http library. - The wrapper has been added so as to remove System.Net.Http dependencies from the Services - and migrate it to a Core level dependecy only. This avoids version clashes when a service - and the Core depends on different versions of the System.Net.Http library. This is a Service - level utility method - - - - - AWSHttpClient wrapper that is wrapped around - HttpClient default wrapper. - - - - - AWSHttpClient BaseAddress property that is wrapper for - HttpClient BaseAddress property. - - - - - AWSHttpClient Timeout property that is wrapper for - HttpClient Timeout property. - - - - - AWSHttpClient MaxResponseContentBufferSize property that is wrapper for - HttpClient MaxResponseContentBufferSize property. - - - - - AWSHttpClient GetStreamAsync that accepts the requester's URI - and make a HttpClient.GetStreamAsync call. - - Requester Uri - - - - Wrapper method that accepts a request uri, stream content and headers and makes a sendAsync call. - - - - - - - Wrapper for HttpClient's HttpRequestMessage and SendAsync methods. - - - - Returns response headers information- header name,value and status code - - - - Wrapper for HttpClient Dispose. - - - - - Method that checks if the passed exception is of type - HttpRequestException - - - - - - - AWSStreamContent is a wrapper for StreamContent class in - the System.Net.Http library.The wrapper has been added so as to - remove System.Net.Http dependencies from the Services - and migrate it to a Core level dependecy only. This avoids version clashes when a service - and the Core depends on different versions of the System.Net.Http library. This is a Service - level utility method - - - - - Wrapper for StreamContent constructor - for stream content - - - - - - Wrapper for StreamContent constructor - for stream content and bufferSize - - - - - - - Wrapper to allow Services to remove StreamContent Headers - - - - - - - Wrapper to allow Services to add StreamContent Headers - - - - - - - Wrapper for StreamContent Dispose. - - - - - Utility class to parse Amazon resource names more commonly known as an ARN. - - - - - Gets and sets the partition associated with the ARN (e.g.: 'aws'). - - - - - Gets and sets the AWS service associated with the ARN (e.g.: 's3'). - - - - - Gets and sets the region associated with the ARN (e.g.: 'us-east-1'). - - - - - Gets and sets the account ID associated with the ARN. - - - - - Gets and sets the resource associated with the ARN (e.g.: 'mybucket/myobject'). - - - - - Returns true if the string appears to be an ARN by seeing if the string starts with "arn:". This method - doesn't guarantee the string is a valid ARN. To validate the string call TryParse. - - - - - - - Parses the string into an ARN object. - - String to parse into an ARN. - The out parameter for the ARN object created by TryParse. - True if the string was parsed into an ARN object. - - - - Parses the string into an ARN object. - - String to parse into an Arn. - The Arn object created from the passed in string. - Thrown if arnString is null. - Thrown if the string passed in not valid ARN. - - - - Turns the Arn object into a string representation of an ARN. - - - - - - Configuration options that apply to the entire SDK. - - These settings can be configured through app.config or web.config. - Below is a full sample configuration that illustrates all the possible options. - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws region="us-west-2"> - <logging logTo="Log4Net, SystemDiagnostics" logResponses="Always" logMetrics="true" /> - <s3 useSignatureVersion4="true" /> - <proxy host="localhost" port="8888" username="1" password="1" /> - - <dynamoDB> - <dynamoDBContext tableNamePrefix="Prod-"> - - <tableAliases> - <alias fromTable="FakeTable" toTable="People" /> - <alias fromTable="Persons" toTable="People" /> - </tableAliases> - - <mappings> - <map type="Sample.Tests.Author, SampleDLL" targetTable="People" /> - <map type="Sample.Tests.Editor, SampleDLL" targetTable="People"> - <property name="FullName" attribute="Name" /> - <property name="EmployeeId" attribute="Id" /> - <property name="ComplexData" converter="Sample.Tests.ComplexDataConverter, SampleDLL" /> - <property name="Version" version="true" /> - <property name="Password" ignore="true" /> - </map> - </mappings> - - </dynamoDBContext> - </dynamoDB> - </aws> - - - - Configuration options that apply to the entire SDK. - - - - - Manual offset to apply to client clock. This is a global setting that overrides - ClockOffset value calculated for all service endpoints. - - - - - Determines if the SDK should correct for client clock skew - by determining the correct server time and reissuing the - request with the correct time. - Default value of this field is True. - will be updated with the calculated - offset even if this field is set to false, though requests - will not be corrected or retried. - Ignored if is set. - - - - - The calculated clock skew correction, if there is one. - This field will be set if a service call resulted in an exception - and the SDK has determined that there is a difference between local - and server times. - - If is set to true, this - value will be set to the correction, but it will not be used by the - SDK and clock skew errors will not be retried. - - - - - Key for the AWSRegion property. - - - - - - Configures the default AWS region for clients which have not explicitly specified a region. - Changes to this setting will only take effect for newly constructed instances of AWS clients. - - This setting can be configured through the App.config. For example: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws region="us-west-2" /> - - - - - - Key for the AWSProfileName property. - - - - - - Profile name for stored AWS credentials that will be used to make service calls. - Changes to this setting will only take effect in newly-constructed clients. - - To reference the account from an application's App.config or Web.config use the AWSProfileName setting. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="development"/> - </appSettings> - </configuration> - - - - - - - Key for the AWSProfilesLocation property. - - - - - - Location of the credentials file shared with other AWS SDKs. - By default, the credentials file is stored in the .aws directory in the current user's home directory. - - Changes to this setting will only take effect in newly-constructed clients. - - To reference the profile from an application's App.config or Web.config use the AWSProfileName setting. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfilesLocation" value="c:\config"/> - </appSettings> - </configuration> - - - - - - - Key for the Logging property. - - - - - - Configures how the SDK should log events, if at all. - Changes to this setting will only take effect in newly-constructed clients. - - The setting can be configured through App.config, for example: - - <appSettings> - <add key="AWSLogging" value="log4net"/> - </appSettings> - - - - - - Key for the ResponseLogging property. - - - - - - - Configures when the SDK should log service responses. - Changes to this setting will take effect immediately. - - The setting can be configured through App.config, for example: - - <appSettings> - <add key="AWSResponseLogging" value="OnError"/> - </appSettings> - - - - - - Key for the LogMetrics property. - - - - - - Configures if the SDK should log performance metrics. - This setting configures the default LogMetrics property for all clients/configs. - Changes to this setting will only take effect in newly-constructed clients. - - The setting can be configured through App.config, for example: - - <appSettings> - <add key="AWSLogMetrics" value="true"/> - </appSettings> - - - - - - Key for the EndpointDefinition property. - - - - - - Configures if the SDK should use a custom configuration file that defines the regions and endpoints. - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws endpointDefinition="c:\config\endpoints.json" /> - - - - - - Key for the UseSdkCache property. - - - - - - Configures if the SDK Cache should be used, the default value is true. - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws useSdkCache="true" /> - - - - - - Configuration for the Logging section of AWS configuration. - Changes to some settings may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws> - <logging logTo="Log4Net, SystemDiagnostics" logResponses="Always" logMetrics="true" /> - </aws> - - - - - - Configuration for the Proxy section of AWS configuration. - Changes to some settings may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws> - <proxy host="localhost" port="8888" username="1" password="1" bypassList="addressexpr1;addressexpr2;..." bypassOnLocal="true" /> - </aws> - - - - - - When set to true, the service client will use the x-amz-user-agent - header instead of the User-Agent header to report version and - environment information to the AWS service. - - Note: This is especially useful when using a platform like WebAssembly - which doesn't allow to specify the User-Agent header. - - - - - Configuration for the region endpoint section of AWS configuration. - Changes may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws region="us-west-2" /> - - - - - - Lock for SomeEvent delegate access. - - - - - This method should never be called directly. - Call AWSSDKUtils.CorrectedUtcNow instead. - - - - - - The unique application name for the current application. This values is currently used - by high level APIs (Mobile Analytics Manager and Cognito Sync Manager) to create a unique file - path to store local database files. - Changes to this setting will only take effect in newly-constructed objects using this property. - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws applicationName="" /> - - - - - - Add a listener for SDK logging. - - If the listener does not have a name, you will not be able to remove it later. - The source to log for, e.g. "Amazon", or "Amazon.DynamoDB". - The listener to add. - - - - Remove a trace listener from SDK logging. - - The source the listener was added to. - The name of the listener. - - - - Generates a sample XML representation of the SDK configuration section. - - - The XML returned has an example of every tag in the SDK configuration - section, and sample input for each attribute. This can be included in - an App.config or Web.config and edited to suit. Where a section contains - a collection, multiple of the same tag will be output. - - Sample XML configuration string. - - - - Logging options. - Can be combined to enable multiple loggers. - - - - - No logging - - - - - Log using log4net - - - - - Log using System.Diagnostics - - - - - Log to the console - - - - - Response logging option. - - - - - Never log service response - - - - - Only log service response when there's an error - - - - - Always log service response - - - - - Format for metrics data in the logs - - - - - Emit metrics in human-readable format - - - - - Emit metrics as JSON data - - - - - Allows to configure the proxy used for HTTP requests. The default value is null. - - - - - This class contains the endpoints available to the AWS clients. The static constants representing the - regions can be used while constructing the AWS client instead of looking up the exact endpoint URL. - - - - - Gets the endpoint for a service in a region. - - The services system name. - If true returns the endpoint for dualstack - Thrown when the request service does not have a valid endpoint in the region. - - - - - Enumerate through all the regions. - - - - - Gets the region based on its system name like "us-west-1" - - The system name of the service like "us-west-1" - - - - - This is a testing method and should not be called by production applications. - - - - - Gets the system name of a region. - - - - - Gets the display name of a region. - - - - - This region name is non-standard. Search the whole endpoints.json file to - determine the partition this region is in. - - - - - This class contains region information used to lazily compute the service endpoints. The static constants representing the - regions can be used while constructing the AWS client instead of looking up the exact endpoint URL. - - - - - The US East (Virginia) endpoint. - - - - - The US East (Virginia) regional endpoint. - - - - - The US East (Ohio) endpoint. - - - - - The US West (N. California) endpoint. - - - - - The US West (Oregon) endpoint. - - - - - The EU North (Stockholm) endpoint. - - - - - The EU West (Ireland) endpoint. - - - - - The EU West (London) endpoint. - - - - - The EU West (Paris) endpoint. - - - - - The EU Central (Frankfurt) endpoint. - - - - - The Europe (Milan) endpoint. - - - - - The Asia Pacific (Hong Kong) endpoint. - - - - - The Asia Pacific (Tokyo) endpoint. - - - - - The Asia Pacific (Seoul) endpoint. - - - - - The Asia Pacific (Osaka-Local) endpoint. - - - - - The Asia Pacific (Mumbai) endpoint. - - - - - The Asia Pacific (Singapore) endpoint. - - - - - The Asia Pacific (Sydney) endpoint. - - - - - The South America (Sao Paulo) endpoint. - - - - - The US GovCloud East (Virginia) endpoint. - - - - - The US GovCloud West (Oregon) endpoint. - - - - - The China (Beijing) endpoint. - - - - - The China (Ningxia) endpoint. - - - - - The Canada (Central) endpoint. - - - - - The Middle East (Bahrain) endpoint. - - - - - The Africa (Cape Town) endpoint. - - - - - Represents the endpoint overridding rules in the endpoints.json - Is used to map private region (ie us-east-1-regional) to public regions (us-east-1) - For signing purposes. - - - - - Enumerate through all the regions. - - - - - Gets the region based on its system name like "us-west-1" - - The system name of the service like "us-west-1" - - - - - Gets the region endpoint override if exists - - The region endpoint to find the possible override for - - - - - Gets the system name of a region. - - - - - Gets the display name of a region. - - - - - Gets the partition name the region is in. For example for us-east-1 the partition name is aws. For cn-northwest-1 the partition name is aws-cn. - - - - - Gets the dns suffix for the region endpoints in a partition. For example the aws partition's suffix is amazonaws.com. The aws-cn partition's suffix is amazonaws.com.cn. - - - - - Gets the endpoint for a service in a region. - - - The services system name. Service system names can be obtained from the - RegionEndpointServiceName member of the ClientConfig-derived class for the service. - - - For forwards compatibility, if the service being requested for isn't known in the region, this method - will generate an endpoint using the AWS endpoint heuristics. In this case, it is not guaranteed the - endpoint will point to a valid service endpoint. - - - - - - Gets the endpoint for a service in a region, optionally selecting a dualstack compatible endpoint. - - - The services system name. Service system names can be obtained from the - RegionEndpointServiceName member of the ClientConfig-derived class for the service. - - - If true a dualstack endpoint is returned. It is the user's responsibility to verify that the given service - supports a dualstack endpoint for the region. - - - For forwards compatibility, if the service being requested for isn't known in the region, this method - will generate an endpoint using the AWS endpoint heuristics. In this case, it is not guaranteed the - endpoint will point to a valid service endpoint. - - - - - - This class defines an endpoints hostname and which protocols it supports. - - - - - Gets the hostname for the service. - - - - - The authentication region to be used in request signing. - - - - - This property is only set for S3 endpoints. For all other services this property returns null. - For S3 endpoints, if the endpoint supports signature version 2 this property will be "2", otherwise it will be "4". - - - - - Calculates a 32bit Cyclic Redundancy Checksum (CRC) using the - same polynomial used by Zip. This type is used internally by DotNetZip; it is generally not used directly - by applications wishing to create, read, or manipulate zip archive files. - - - - - indicates the total number of bytes read on the CRC stream. - This is used when writing the ZipDirEntry when compressing files. - - - - - Indicates the current CRC for all blocks slurped in. - - - - - Returns the CRC32 for the specified stream. - - The stream over which to calculate the CRC32 - the CRC32 calculation - - - - Returns the CRC32 for the specified stream, and writes the input into the output stream. - - The stream over which to calculate the CRC32 - The stream into which to deflate the input - the CRC32 calculation - - - - Get the CRC32 for the given (word,byte) combo. - This is a computation defined by PKzip. - - The word to start with. - The byte to combine it with. - The CRC-ized result. - - - - Update the value for the running CRC32 using the given block of bytes. - This is useful when using the CRC32() class in a Stream. - - block of bytes to slurp - starting point in the block - how many bytes within the block to slurp - - - - A Stream that calculates a CRC32 (a checksum) on all bytes read, - or on all bytes written. - - - - - This class can be used to verify the CRC of a ZipEntry when reading from a stream, - or to calculate a CRC when writing to a stream. The stream should be used to either - read, or write, but not both. If you intermix reads and writes, the results are - not defined. - - This class is intended primarily for use internally by the DotNetZip library. - - - - - Gets the total number of bytes run through the CRC32 calculator. - - - - This is either the total number of bytes read, or the total number - of bytes written, depending on the direction of this stream. - - - - - The constructor. - - The underlying stream - - - - The constructor. - - The underlying stream - The length of the stream to slurp - - - - Provides the current CRC for all blocks slurped in. - - - - - Read from the stream - - the buffer to read - the offset at which to start - the number of bytes to read - the number of bytes actually read - - - - Write to the stream. - - the buffer from which to write - the offset at which to start writing - the number of bytes to write - - - - Indicates whether the stream supports reading. - - - - - Indicates whether the stream supports seeking. - - - - - Indicates whether the stream supports writing. - - - - - Flush the stream. - - - - - Not implemented. - - - - - Not implemented. - - - - - Not implemented. - - N/A - N/A - N/A - - - - Not implemented. - - N/A - - - a general purpose ASN.1 decoder - note: this class differs from the - others in that it returns null after it has read the last object in - the stream. If an ASN.1 Null is encountered a Der/BER Null object is - returned. - - - Create an ASN1InputStream where no DER object will be longer than limit. - - @param input stream containing ASN.1 encoded data. - @param limit maximum size of a DER encoded object. - - - Create an ASN1InputStream based on the input byte array. The length of DER objects in - the stream is automatically limited to the length of the input array. - - @param input array containing ASN.1 encoded data. - - - build an object given its tag and the number of bytes to construct it from. - - - Create a base ASN.1 object from a byte array. - The byte array to parse. - The base ASN.1 object represented by the byte array. - If there is a problem parsing the data. - - - Read a base ASN.1 object from a stream. - The stream to parse. - The base ASN.1 object represented by the byte array. - If there is a problem parsing the data. - - - return the object at the sequence position indicated by index. - - @param index the sequence number (starting at zero) of the object - @return the object at the sequence position indicated by index. - - - create an empty sequence - - - create a sequence containing one object - - - create a sequence containing a vector of objects. - - - - A - - - - - - A - - - A - - - - - - A - - - - - return a = a + b - b preserved. - - - unsigned comparison on two arrays - note the arrays may - start with leading zeros. - - - returns x = x - y - we assume x is >= y - - - diff --git a/packages/AWSSDK.Core.3.3.107.14/lib/netstandard1.3/AWSSDK.Core.dll b/packages/AWSSDK.Core.3.3.107.14/lib/netstandard1.3/AWSSDK.Core.dll deleted file mode 100644 index 34cf45a..0000000 Binary files a/packages/AWSSDK.Core.3.3.107.14/lib/netstandard1.3/AWSSDK.Core.dll and /dev/null differ diff --git a/packages/AWSSDK.Core.3.3.107.14/lib/netstandard1.3/AWSSDK.Core.xml b/packages/AWSSDK.Core.3.3.107.14/lib/netstandard1.3/AWSSDK.Core.xml deleted file mode 100644 index da32551..0000000 --- a/packages/AWSSDK.Core.3.3.107.14/lib/netstandard1.3/AWSSDK.Core.xml +++ /dev/null @@ -1,14348 +0,0 @@ - - - - AWSSDK.Core - - - - - An access control policy action identifies a specific action in a service - that can be performed on a resource. For example, sending a message to a - queue. - - ActionIdentifiers allow you to limit what your access control policy statement affects. - For example, you could create a policy statement that enables a certain group - of users to send messages to your queue, but not allow them to perform any - other actions on your queue. - - - The action is B in the statement - "A has permission to do B to C where D applies." - - Free form access control policy actions may include a wildcard (*) to match - multiple actions. - - - Constants for known actions can be found in the Amazon.Auth.AccessControlPolicy.ActionIdentifiers namespace. - - - - - - Constructs an Actionidentifer with the given action name. - - The name of the action - - - - Gets and sets the name of this action. For example, 'sqs:SendMessage' is the - name corresponding to the SQS action that enables users to send a message - to an SQS queue. - - - - - The available AWS access control policy actions for Amazon AppStream. - - - - - - The available AWS access control policy actions for Auto Scaling. - - - - - - The available AWS access control policy actions for AWS Billing. - - - - - - The available AWS access control policy actions for AWS CloudFormation. - - - - - - The available AWS access control policy actions for Amazon CloudFront. - - - - - - The available AWS access control policy actions for Amazon CloudSearch. - - - - - - The available AWS access control policy actions for AWS CloudTrail. - - - - - - The available AWS access control policy actions for Amazon CloudWatch. - - - - - - The available AWS access control policy actions for Amazon CloudWatch Logs. - - - - - - The available AWS access control policy actions for Amazon Cognito Identity. - - - - - - The available AWS access control policy actions for Amazon Cognito Sync. - - - - - - The available AWS access control policy actions for AWS Direct Connect. - - - - - - The available AWS access control policy actions for Amazon DynamoDB. - - - - - - The available AWS access control policy actions for Amazon EC2. - - - - - - The available AWS access control policy actions for AWS ElastiCache. - - - - - - The available AWS access control policy actions for AWS Elastic Beanstalk. - - - - - - The available AWS access control policy actions for Elastic Load Balancing. - - - - - - The available AWS access control policy actions for Amazon Elastic MapReduce. - - - - - - The available AWS access control policy actions for Amazon Elastic Transcoder. - - - - - - The available AWS access control policy actions for Amazon Glacier. - - - - - - The available AWS access control policy actions for AWS Identity and Access Management. - - - - - - The available AWS access control policy actions for AWS Import Export. - - - - - - The available AWS access control policy actions for Amazon Kinesis. - - - - - - The available AWS access control policy actions for AWS Marketplace. - - - - - - The available AWS access control policy actions for AWS Marketplace Management Portal. - - - - - - The available AWS access control policy actions for Amazon Mobile Analytics. - - - - - - The available AWS access control policy actions for AWS OpsWorks. - - - - - - The available AWS access control policy actions for Amazon RDS. - - - - - - The available AWS access control policy actions for Amazon Redshift. - - - - - - The available AWS access control policy actions for Amazon Route 53. - - - - - - The available AWS access control policy actions for Amazon S3. - - - - - - The available AWS access control policy actions for AWS Security Token Service. - - - - - - The available AWS access control policy actions for Amazon SES. - - - - - - The available AWS access control policy actions for Amazon SimpleDB. - - - - - - The available AWS access control policy actions for Amazon Simple Workflow Service. - - - - - - The available AWS access control policy actions for Amazon SNS. - - - - - - The available AWS access control policy actions for Amazon SQS. - - - - - - The available AWS access control policy actions for Amazon Storage Gateway. - - - - - - The available AWS access control policy actions for AWS Whispersync. - - - - - - The available AWS access control policy actions for Amazon Zocalo. - - - - - - AWS access control policy conditions are contained in - objects, and affect when a statement is applied. For example, a statement - that allows access to an Amazon SQS queue could use a condition to only apply - the effect of that statement for requests that are made before a certain - date, or that originate from a range of IP addresses. - - Multiple conditions can be included in a single statement, and all conditions - must evaluate to true in order for the statement to take effect. - - - The set of conditions is D in the statement - "A has permission to do B to C where D applies." - - - A condition is composed of three parts: - - - Condition Key - The condition key declares which value of a - request to pull in and compare against when a policy is evaluated by AWS. For - example, using will cause - AWS to pull in the current request's source IP as the first value to compare - against every time your policy is evaluated. - - - - Comparison Type - This is a static value used as the second value - in the comparison when your policy is evaluated. Depending on the comparison - type, this value can optionally use wildcards. See the documentation for - individual comparison types for more information. - - - - Comparison Value - This is a static value used as the second value - in the comparison when your policy is evaluated. Depending on the comparison - type, this value can optionally use wildcards. See the documentation for - individual comparison types for more information. - - - - - - - - - Gets the type of this condition. - - - - - Gets and Sets the name of the condition key involved in this condition. - Condition keys are predefined values supported by AWS that provide input - to a condition's evaluation, such as the current time, or the IP address - of the incoming request. - - Your policy is evaluated for each incoming request, and condition keys - specify what information to pull out of those incoming requests and plug - into the conditions in your policy. - - - - - - Gets and Sets the values specified for this access control policy condition. - For example, in a condition that compares the incoming IP address of a - request to a specified range of IP addresses, the range of IP addresses - is the single value in the condition. - - Most conditions accept only one value, but multiple values are possible. - - - - - - A factory for creating conditions to be used in the policy. - - - - - Condition key for the current time. - - This condition key should only be used with enum. - - - - - - Condition key for whether or not an incoming request is using a secure - transport to make the request (i.e. HTTPS instead of HTTP). - - This condition key should only be used with the boolean overload of NewCondition. - - - - - - Condition key for the source IP from which a request originates. - - This condition key should only be used with enum. - - - - - - Condition key for the user agent included in a request. - - This condition key should only be used with - enum. - - - - - - Condition key for the current time, in epoch seconds. - - This condition key should only be used with enum. - objects. - - - - - - Condition key for the referrer specified by a request. - - This condition key should only be used with - objects. - - - - - - Condition key for the Amazon Resource Name (ARN) of the source specified - in a request. The source ARN indicates which resource is affecting the - resource listed in your policy. For example, an SNS topic is the source - ARN when publishing messages from the topic to an SQS queue. - - This condition key should only be used with enum. - - - - - - Enumeration of the supported ways an ARN comparison can be evaluated. - - - - Exact matching - - - - Loose case-insensitive matching of the ARN. Each of the six - colon-delimited components of the ARN is checked separately and each - can include a multi-character match wildcard (*) or a - single-character match wildcard (?). - - - - Negated form of ArnEquals - - - Negated form of ArnLike - - - - Enumeration of the supported ways a date comparison can be evaluated. - - - - - Enumeration of the supported ways an IP address comparison can be evaluated. - - - - - Matches an IP address against a CIDR IP range, evaluating to true if - the IP address being tested is in the condition's specified CIDR IP - range. - - - - - Negated form of IpAddress - - - - - Enumeration of the supported ways a numeric comparison can be evaluated - - - - - Enumeration of the supported ways a string comparison can be evaluated. - - - - - Case-sensitive exact string matching - - - - - Case-insensitive string matching - - - - - Loose case-insensitive matching. The values can include a - multi-character match wildcard (*) or a single-character match - wildcard (?) anywhere in the string. - - - - - Negated form of StringEquals. - - - - - Negated form of StringEqualsIgnorecase. - - - - - Negated form of StringLike. - - - - - Constructs a new access control policy condition that compares ARNs (Amazon Resource Names). - - The access policy condition key specifying where to get the first ARN for the comparison - The type of comparison to perform. - The second ARN to compare against. When using ArnLike or ArnNotLike this may contain the - multi-character wildcard (*) or the single-character wildcard - - - - Constructs a new access policy condition that performs a boolean - comparison. - - The access policy condition key specifying where to get the - first boolean value for the comparison (ex: aws:SecureTransport). - The boolean to compare against. - - - - This method is deprecated. Invoking this method results in non-UTC DateTimes - not being marshalled correctly. Use NewConditionUtc instead. - Constructs a new access policy condition that compares the current time - (on the AWS servers) to the specified date. - - The type of comparison to perform. For example, - DateComparisonType.DateLessThan will cause this policy - condition to evaluate to true if the current date is less than - the date specified in the second argument. - The date to compare against. - - - - Constructs a new access policy condition that compares the current time - (on the AWS servers) to the specified date. - - The type of comparison to perform. For example, - DateComparisonType.DateLessThan will cause this policy - condition to evaluate to true if the current date is less than - the date specified in the second argument. - The date to compare against. - - - - Constructs a new access policy condition that compares the source IP - address of the incoming request to an AWS service against the specified - CIDR range. The condition evaluates to true (meaning the policy statement - containing it will be applied) if the incoming source IP address is - within that range. - - To achieve the opposite effect (i.e. cause the condition to evaluate to - true when the incoming source IP is not in the specified CIDR - range) use the alternate constructor form and specify - IpAddressComparisonType.NotIpAddress. - - - The CIDR IP range involved in the policy condition. - - - - Constructs a new access policy condition that compares the source IP - address of the incoming request to an AWS service against the specified - CIDR range. When the condition evaluates to true (i.e. when the incoming - source IP address is within the CIDR range or not) depends on the - specified IpAddressComparisonType. - - The type of comparison to to perform. - The CIDR IP range involved in the policy condition. - - - - Constructs a new access policy condition that compares two numbers. - - The type of comparison to perform. - The access policy condition key specifying where to get the - first number for the comparison. - The second number to compare against. - - - - Constructs a new access control policy condition that compares two - strings. - - The type of comparison to perform - The access policy condition key specifying where to get the - first string for the comparison (ex: aws:UserAgent). - - The second string to compare against. When using - StringComparisonType.StringLike or - StringComparisonType.StringNotLike this may contain - the multi-character wildcard (*) or the single-character - wildcard (?). - - - - - Constructs a new access policy condition that compares the Amazon - Resource Name (ARN) of the source of an AWS resource that is modifying - another AWS resource with the specified pattern. - - For example, the source ARN could be an Amazon SNS topic ARN that is - sending messages to an Amazon SQS queue. In that case, the SNS topic ARN - would be compared the ARN pattern specified here. - - - The endpoint pattern may optionally contain the multi-character wildcard - * (*) or the single-character wildcard (?). Each of the six colon-delimited - components of the ARN is checked separately and each can include a - wildcard. - - - Policy policy = new Policy("MyQueuePolicy"); - policy.WithStatements(new Statement(Statement.StatementEffect.Allow) - .WithPrincipals(new Principal("*")).WithActionIdentifiers(SQSActionIdentifiers.SendMessage) - .WithResources(new Resource(myQueueArn)) - .WithConditions(ConditionFactory.NewSourceArnCondition(myTopicArn))); - - - The ARN pattern against which the source ARN will be compared. - Each of the six colon-delimited components of the ARN is - checked separately and each can include a wildcard. - A new access control policy condition that compares the ARN of - the source specified in an incoming request with the ARN pattern - specified here. - - - - Constructs a new access control policy condition that tests if the - incoming request was sent over a secure transport (HTTPS). - - A new access control policy condition that tests if the incoming - request was sent over a secure transport (HTTPS). - - - - Condition key for the canned ACL specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the location constraint specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the prefix specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the delimiter specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the max keys specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the source object specified by a request to copy an - object. - - This condition key may only be used with enum. - - - - - - Condition key for the metadata directive specified by a request to copy - an object. - - This condition key may only be used with enum. - - - - - - Condition key for the version ID of an object version specified by a - request. - - This condition key may only be used with enum. - - - - - - Constructs a new access policy condition that compares an Amazon S3 - canned ACL with the canned ACL specified by an incoming request. - - You can use this condition to ensure that any objects uploaded to an - Amazon S3 bucket have a specific canned ACL set. - - - The Amazon S3 canned ACL to compare against. - A new access control policy condition that compares the Amazon S3 - canned ACL specified in incoming requests against the value - specified. - - - - Condition key for The URL, e-mail address, or ARN from a Subscribe - request or a previously confirmed subscription. Use with string - conditions to restrict access to specific endpoints (e.g., - *@mycompany.com). - - This condition key may only be used with enum. - - - - - - Condition key for the protocol value from a Subscribe request or a - previously confirmed subscription. Use with string conditions to restrict - publication to specific delivery protocols (e.g., HTTPS). - - This condition key may only be used with enum. - - - - - - Constructs a new access policy condition that compares the requested - endpoint used to subscribe to an Amazon SNS topic with the specified - endpoint pattern. The endpoint pattern may optionally contain the - multi-character wildcard (*) or the single-character wildcard (?). - - For example, this condition can restrict subscriptions to a topic to - email addresses in a certain domain ("*@my-company.com"). - - - Policy policy = new Policy("MyTopicPolicy"); - policy.WithStatements(new Statement(Statement.StatementEffect.Allow) - .WithPrincipals(new Principal("*")).WithActionIdentifiers(SNSActionIdentifiers.Subscribe) - .WithResources(new Resource(myTopicArn)) - .WithConditions(ConditionFactory.NewEndpointCondition("*@my-company.com"))); - - - The endpoint pattern against which to compare the requested - endpoint for an Amazon SNS topic subscription. - A new access control policy condition that compares the endpoint - used in a request to subscribe to an Amazon SNS topic with the - endpoint pattern specified. - - - - Constructs a new AWS access control policy condition that allows an - access control statement to restrict subscriptions to an Amazon SNS topic - based on the protocol being used for the subscription. For example, this - condition can restrict subscriptions to a topic to endpoints using HTTPS - to ensure that messages are securely delivered. - - The protocol against which to compare the requested protocol - for an Amazon SNS topic subscription. - A new access control policy condition that compares the - notification protocol requested in a request to subscribe to an - Amazon SNS topic with the protocol value specified. - - - - Deserializes a JSON string into a AWS policy object. - - - - - Serializes an AWS policy object to a JSON string, suitable for sending to an - AWS service. - - - - Converts the specified AWS policy object to a JSON string, suitable for - passing to an AWS service. - - @param policy - The AWS policy object to convert to a JSON string. - - @return The JSON string representation of the specified policy object. - - @throws IllegalArgumentException - If the specified policy is null or invalid and cannot be - serialized to a JSON string. - - - - Uses the specified generator to write the JSON data for the principals in - the specified policy statement. - - - - - This sorts the conditions by condition type and key with the list of values for that combination. - - The list of conditions to be sorted. - - - - - An AWS access control policy is a object that acts as a container for one or - more statements, which specify fine grained rules for allowing or denying - various types of actions from being performed on your AWS resources. - - By default, all requests to use your resource coming from anyone but you are - denied. Access control polices can override that by allowing different types - of access to your resources, or by explicitly denying different types of - access. - - - Each statement in an AWS access control policy takes the form: - "A has permission to do B to C where D applies". - - - A is the prinicpal - The AWS account that is making a request to - access or modify one of your AWS resources. - - - - B is the action - the way in which your AWS resource is being accessed or modified, such - as sending a message to an Amazon SQS queue, or storing an object in an Amazon S3 bucket. - - - - C is the resource - your AWS entity that the principal wants to access, such - as an Amazon SQS queue, or an object stored in Amazon S3. - - - - D is the set of conditions - optional constraints that specify when to allow or deny - access for the principal to access your resource. Many expressive conditions are available, - some specific to each service. For example you can use date conditions to allow access to - your resources only after or before a specific time. - - - - - - Note that an AWS access control policy should not be confused with the - similarly named "POST form policy" concept used in Amazon S3. - - - - - - The default policy version - - - - - Constructs an empty AWS access control policy ready to be populated with - statements. - - - - - Constructs a new AWS access control policy with the specified policy ID. - The policy ID is a user specified string that serves to help developers - keep track of multiple polices. Policy IDs are often used as a human - readable name for a policy. - - The policy ID for the new policy object. Policy IDs serve to - help developers keep track of multiple policies, and are often - used to give the policy a meaningful, human readable name. - - - - Constructs a new AWS access control policy with the specified policy ID - and collection of statements. The policy ID is a user specified string - that serves to help developers keep track of multiple polices. Policy IDs - are often used as a human readable name for a policy. - - The policy ID for the new policy object. Policy IDs serve to - help developers keep track of multiple policies, and are often - used to give the policy a meaningful, human readable name. - The statements to include in the new policy. - - - - Gets and Sets the policy ID for this policy. Policy IDs serve to help - developers keep track of multiple policies, and are often used as human - readable name for a policy. - - - - - Sets the policy ID for this policy and returns the updated policy so that - multiple calls can be chained together. - - Policy IDs serve to help developers keep track of multiple policies, and - are often used as human readable name for a policy. - - - The polich ID for this policy - this instance - - - - Gets and sets the version of this AWS policy. - - - - - Gets and Sets the collection of statements contained by this policy. Individual - statements in a policy are what specify the rules that enable or disable - access to your AWS resources. - - - - - Checks to see if the permissions set in the statement are already set by another - statement in the policy. - - The statement to verify - True if the statement's permissions are already allowed by the statement - - - - Sets the collection of statements contained by this policy and returns - this policy object so that additional method calls can be chained - together. - - Individual statements in a policy are what specify the rules that enable - or disable access to your AWS resources. - - - The collection of statements included in this policy. - this instance - - - - Returns a JSON string representation of this AWS access control policy, - suitable to be sent to an AWS service as part of a request to set an - access control policy. - - A JSON string representation of this AWS access control policy. - - - - Returns a JSON string representation of this AWS access control policy, - suitable to be sent to an AWS service as part of a request to set an - access control policy. - - Toggle pretty print for the generated JSON document - A JSON string representation of this AWS access control policy. - - - - Parses a JSON document of a policy and creates a Policy object. - - JSON document of a policy. - - - - - A principal is an AWS account which is being allowed or denied access to a - resource through an access control policy. The principal is a property of the - Statement object, not directly the object. - - The principal is A in the statement - "A has permission to do B to C where D applies." - - - In an access control policy statement, you can set the principal to all - authenticated AWS users through the member. This - is useful when you don't want to restrict access based on the identity of the - requester, but instead on other identifying characteristics such as the - requester's IP address. - - - - - - Principal instance that includes all authenticated AWS users. - - This is useful when you don't want to restrict access based on the - identity of the requester, but instead on other identifying - characteristics such as the requester's IP address. - - - - - - The anonymous Principal. - - - - - The default Principal provider for AWS accounts. - - - - - Principal provider for Canonical User IDs. - - - - - Principal provider for federated users (using a SAML identity provider) - - - - - Principal provider for assume role policies that will be assumed by an AWS service - (e.g. "ec2.amazonaws.com"). - - - - - Dummy principal provider for anonynous. - - - - - Constructs a new principal with the specified AWS account ID. - - An AWS account ID. - - - - Constructs a new principal with the specified provider and id - - The provider of the principal - The unique ID of the Principal within the provider - - - - Constructs a new principal with the specified provider and id - and optionally strips hyphens from the id - - The provider of the principal - The unique ID of the Principal within the provider - Strip hyphen - - - - Gets and sets the provider for this principal, which indicates in what group of - users this principal resides. - - - - - Gets the unique ID for this principal. - - - - - Represents a resource involved in an AWS access control policy statement. - Resources are the service specific AWS entities owned by your account. Amazon - SQS queues, Amazon S3 buckets and objects, and Amazon SNS topics are all - examples of AWS resources. - - The standard way of specifying an AWS resource is with an Amazon Resource - Name (ARN). - - - The resource is C in the statement - "A has permission to do B to C where D applies." - - - - - - Constructs a new AWS access control policy resource. Resources are - typically specified as Amazon Resource Names (ARNs). - - You specify the resource using the following Amazon Resource Name (ARN) - format: arn:aws:<vendor>:<region>:<namespace>:<relative-id> - - - >vendor identifies the AWS product (e.g., sns) - - - region is the AWS Region the resource resides in (e.g., us-east-1), if any - - - namespace is the AWS account ID with no hyphens (e.g., 123456789012) - - - relative-id is the service specific portion that identifies the specific resource - - - - - For example, an Amazon SQS queue might be addressed with the following - ARN: arn:aws:sqs:us-east-1:987654321000:MyQueue - - - Some resources may not use every field in an ARN. For example, resources - in Amazon S3 are global, so they omit the region field: - arn:aws:s3:::bucket/* - - - The Amazon Resource Name (ARN) uniquely identifying the desired AWS resource. - - - - Gets the resource ID, typically an Amazon Resource Name (ARN), - identifying this resource. - - - - - A factory for creating resources to be used in the policy. - - - - - Constructs a new bucket resource that represents the the specified bucket - but not any of the contained objects. - - The name of the bucket represented by this AWS access control - policy resource. - - - - Constructs a new object resource that represents the specified objects. - The keyPattern argument may contain the '*' wildcard to match multiple - objects. For example, an object resource created for bucket 'mybucket' - and key pattern 'foo*' will match any object stored in 'mybucket' with a - key that starts with 'foo'. - - The name of the bucket containing the object or objects - represented by this resource. - The key or key pattern, which can optionally contain the '*' - wildcard to include multiple objects in the resource. - - - - Constructs a new SQS queue resource for an access control policy. A - policy statement using this resource will allow or deny actions on the - specified queue. - - The AWS account ID of the queue owner. - The name of the Amazon SQS queue. - - - - A statement is the formal description of a single permission, and is always - contained within a policy object. - - A statement describes a rule for allowing or denying access to a specific AWS - resource based on how the resource is being accessed, and who is attempting - to access the resource. Statements can also optionally contain a list of - conditions that specify when a statement is to be honored. - - - For example, consider a statement that: - - - A is the prinicpal - The AWS account that is making a request to - access or modify one of your AWS resources. - - - - B is the action - the way in which your AWS resource is being accessed or modified, such - as sending a message to an Amazon SQS queue, or storing an object in an Amazon S3 bucket. - - - - C is the resource - your AWS entity that the principal wants to access, such - as an Amazon SQS queue, or an object stored in Amazon S3. - - - - D is the set of conditions - optional constraints that specify when to allow or deny - access for the principal to access your resource. Many expressive conditions are available, - some specific to each service. For example you can use date conditions to allow access to - your resources only after or before a specific time. - - - - - - There are many resources and conditions available for use in statements, and - you can combine them to form fine grained custom access control polices. - - - - - - The effect is the result that you want a policy statement to return at - evaluation time. A policy statement can either allow access or explicitly - deny access. - - - - - Constructs a new access control policy statement with the specified - effect. - - Before a statement is valid and can be sent to AWS, callers must set the - principals, resources, and actions (as well as any optional conditions) - involved in the statement. - - - The effect this statement has (allowing access or denying - access) when all conditions, resources, principals, and - actions are matched. - - - - Gets and Sets the ID for this statement. Statement IDs serve to help keep track - of multiple statements, and are often used to give the statement a - meaningful, human readable name. - - Developers should be careful to not use the same statement ID for - multiple statements in the same policy. Reusing the same statement ID in - different policies is not a problem. - - - - - - Sets the ID for this statement and returns the updated statement so - multiple calls can be chained together. - - Statement IDs serve to help keep track of multiple statements, and are - often used to give the statement a meaningful, human readable name. - - - Developers should be careful to not use the same statement ID for - multiple statements in the same policy. Reusing the same statement ID in - different policies is not a problem. - - - The new statement ID for this statement. - this instance - - - - Gets and Sets the result effect of this policy statement when it is evaluated. - A policy statement can either allow access or explicitly - - - - - Gets and Sets the list of actions to which this policy statement applies. - Actions limit a policy statement to specific service operations that are - being allowed or denied by the policy statement. For example, you might - want to allow any AWS user to post messages to your SQS queue using the - SendMessage action, but you don't want to allow those users other actions - such as ReceiveMessage or DeleteQueue. - - - - - Sets the list of actions to which this policy statement applies and - returns this updated Statement object so that additional method calls can - be chained together. - - Actions limit a policy statement to specific service operations that are - being allowed or denied by the policy statement. For example, you might - want to allow any AWS user to post messages to your SQS queue using the - SendMessage action, but you don't want to allow those users other actions - such as ReceiveMessage or DeleteQueue. - - - The list of actions to which this statement applies. - this instance - - - - Gets and Sets the resources associated with this policy statement. Resources - are what a policy statement is allowing or denying access to, such as an - Amazon SQS queue or an Amazon SNS topic. - - Note that some services allow only one resource to be specified per - policy statement. - - - - - - Sets the resources associated with this policy statement and returns this - updated Statement object so that additional method calls can be chained - together. - - Resources are what a policy statement is allowing or denying access to, - such as an Amazon SQS queue or an Amazon SNS topic. - - - Note that some services allow only one resource to be specified per - policy statement. - - - The resources associated with this policy statement. - this instance - - - - Gets and Sets the conditions associated with this policy statement. Conditions - allow policy statements to be conditionally evaluated based on the many - available condition types. - - For example, a statement that allows access to an Amazon SQS queue could - use a condition to only apply the effect of that statement for requests - that are made before a certain date, or that originate from a range of IP - addresses. - - - When multiple conditions are included in a single statement, all - conditions must evaluate to true in order for the statement to take - effect. - - - - - - Sets the conditions associated with this policy statement, and returns - this updated Statement object so that additional method calls can be - chained together. - - Conditions allow policy statements to be conditionally evaluated based on - the many available condition types. - - - For example, a statement that allows access to an Amazon SQS queue could - use a condition to only apply the effect of that statement for requests - that are made before a certain date, or that originate from a range of IP - addresses. - - - Multiple conditions can be included in a single statement, and all - conditions must evaluate to true in order for the statement to take - effect. - - - The conditions associated with this policy statement. - this instance - - - - Gets and Sets the principals associated with this policy statement, indicating - which AWS accounts are affected by this policy statement. - - - - - Sets the principals associated with this policy statement, and returns - this updated Statement object. Principals control which AWS accounts are - affected by this policy statement. - - If you don't want to restrict your policy to specific users, you can use - to apply the policy to any user trying to - access your resource. - - - The list of principals associated with this policy statement. - this instance - - - - Exception thrown by the SDK for errors that occur within the SDK. - - - - - This exception is thrown when there is a parse error on the response back from AWS. - - - - - The string value which could not be converted into a valid DateTime instance. - - - - - Occurs before a request is marshalled. - - - - - Occurs before a request is issued against the service. - - - - - Occurs after a response is received from the service. - - - - - Occurs after an exception is encountered. - - - - - Patches the in-flight uri to stop it unescaping the path etc (what Uri did before - Microsoft deprecated the constructor flag). This is particularly important for - Amazon S3 customers who want to use backslash (\) in their key names. - - - Different behavior in the various runtimes has been observed and in addition some - 'documented' ways of doing this between 2.x and 4.x runtimes has also been observed - to not be reliable. - - This patch effectively emulates what adding a schemesettings element to the - app.config file with value 'name="http" genericUriParserOptions="DontUnescapePathDotsAndSlashes"' - does. As we're a dll, that avenue is not open to us. - - - - - - Used to create a copy of the config for a different service than the current instance. - - Target service ClientConfig - The new ClientConfig for the desired service - - - - A base exception for some Amazon Web Services. - - Most exceptions thrown to client code will be service-specific exceptions, though some services - may throw this exception if there is a problem which is caught in the core client code. - - - - - - Whether the error was attributable to Sender or Reciever. - - - - - The error code returned by the service - - - - - The id of the request which generated the exception. - - - - - The HTTP status code from the service response - - - - - Flag indicating if the exception is retryable and the associated retry - details. A null value indicates that the exception is not retryable. - - - - - Class containing the retryable details for an AmazonServiceException - - - - - This property indicates that this exception is a - throttling exception and should be subject to congestion - control throttling. - - - - - This exception is thrown when there is a parse error on the response back from AWS. - - - - - Last known location in the response that was parsed, if available. - - - - - The entire response body that caused this exception, if available. - - - - - Base class for request used by some of the services. - - - - - This flag specifies if SigV4 will be used for the current request. - - - - - Gets or Sets a value indicating if "Expect: 100-continue" HTTP header will be - sent by the client for this request. The default value is false. - - - - - Gets the signer to use for this request. - A null return value indicates to use the configured - signer for the service that this request is part of. - - A signer for this request, or null. - - - - Abstract class for Response objects, contains only metadata, - and no result information. - - - - - Contains additional information about the request, such as the - Request Id. - - - - - Returns the content length of the HTTP response. - - - - - Returns the status code of the HTTP response. - - - - - Base class for determining region based on inspection. - - - - - Sets the Region property by looking up the corresponding RegionEndpoint - from the supplied region system name (us-east-1, us-west-2 etc). - - The system name of the region. - - - - Determines region based on application configuration settings. If the configuration does not contain - the region setting key an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of ApplicationConfigAWSRegion. If no region is found in the - application configuration file then an InvalidOperationException is thrown. - - - - - Determines region based on an environment variable. If the environment does not contain - the region setting key an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of EnvironmentVariableAWSRegion. If no region is found in the - environment then an InvalidOperationException is thrown. - - - - - Determines region based on inspection of the instance metadata if running on an EC2 instance. - If instance metadata cannot be read or does not contain region information an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of InstanceProfileAWSRegion. If no region is found in the - metadata or we are not running on an EC2 instance an InvalidOperationException is thrown. - - - - - Determines region based on a stored in an . - If the profile doesn't exist or there is no region information an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of . - If the AWS_PROFILE environment variable is set the instance will be constructed using that profile, - otherwise it will use the default profile. - - If the profile doesn't exist or there is no region information an InvalidOperationException is thrown. - - The ICredentialProfileSource to read the profile from. - - - - Attempts to construct an instance of . - If the profile doesn't exist or there is no region information an InvalidOperationException is thrown. - - The ICredentialProfileSource to read the profile from. - The name of the profile. - - - - Probing mechanism to determine region from various sources. - - - - - This class is responsible for keeping track of Retry capacity across different ServiceURLs. - - - - - CapacityType determines the type of capacity to obtain or use. - - - - - The increment capacity type adds capacity. - - - - - The default retry capacity type uses the default capacity amount. - - - - - The timeout capacity type uses the timeout capacity amount. - - - - - This method acquires a said retry capacity if the container has the capacity. - - Contains the RetryCapacity object for the said ServiceURL. - - - - This method acquires a said retry capacity if the container has the capacity. - - Contains the RetryCapacity object for the said ServiceURL. - Specifies what capacity type cost to use for obtaining capacity - - - - This method calls a method to release capacity back - based on whether it was a successful response or a successful retry response. This is invoked by a retry request response. - - if this request is a retry, use a different capacity cost - Contains the RetryCapacity object for the said ServiceURL. - - - - This method calls a method to release capacity back - based on whether it was a successful response or a successful retry response. This is invoked by a retry request response. - - Specifies what capacity type cost to use for adding capacity - Contains the RetryCapacity object for the said ServiceURL. - - - - Ths method fetches the RetryCapacity for the given ServiceURL from CapacityManager.CapacityContainer - - - - - This method releases capacity back. This is invoked by the TryReleaseCapacity method. - - Contains the RetryCapacity object for the said ServiceURL. - The capacity that needs to be released based on whether it was a successful response or a successful retry response. - - - - This class is the RetryCapacity class for a given ServiceURL. - - - - - This class composes Client Context header for Amazon Web Service client. - It contains information like app title, version code, version name, client id, OS platform etc. - - - - - Adds the custom attributes to the Client Context. - - Key. - Value. - - - - Gets a Json Representation of the Client Context. - - Json Representation of Client Context - - - - Class to which the Json stdout from credential process is - de-serialized into. - - - - - Version of the Json payload - - - - - AWS Access key - - - - - AWS Secret key - - - - - AWS Session token for session credentials - - - - - ISO8601 formatted timestamp till when the credential is valid. - - - - - Computes RFC 2104-compliant HMAC signature. - - - - - Computes RFC 2104-compliant HMAC signature. - - - - - Inspects the supplied evidence to return the signer appropriate for the operation - - Global setting for the service - The request. - Configuration for the client - True if signature v4 request signing should be used - - - - Signs the specified request with the AWS3 signing protocol by using the - AWS account credentials given in the method parameters. - - The AWS public key - The AWS secret key used to sign the request in clear text - Request metrics - The configuration that specifies which hashing algorithm to use - The request to have the signature compute for - If any problems are encountered while signing the request - - - - AWS4 protocol signer for service calls that transmit authorization in the header field "Authorization". - - - - - Calculates and signs the specified request using the AWS4 signing protocol by using the - AWS account credentials given in the method parameters. The resulting signature is added - to the request headers as 'Authorization'. Parameters supplied in the request, either in - the resource path as a query string or in the Parameters collection must not have been - uri encoded. If they have, use the SignRequest method to obtain a signature. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. - - - Client configuration data encompassing the service call (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text. - - - If any problems are encountered while signing the request. - - - - - Calculates and signs the specified request using the AWS4 signing protocol by using the - AWS account credentials given in the method parameters. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. - - - Client configuration data encompassing the service call (notably authentication - region, endpoint and service name). - - - Metrics for the request. - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text. - - - If any problems are encountered while signing the request. - - - Parameters passed as part of the resource path should be uri-encoded prior to - entry to the signer. Parameters passed in the request.Parameters collection should - be not be encoded; encoding will be done for these parameters as part of the - construction of the canonical request. - - - - - Sets the AWS4 mandated 'host' and 'x-amz-date' headers, returning the date/time that will - be used throughout the signing process in various elements and formats. - - The current set of headers - - Date and time used for x-amz-date, in UTC - - - - Sets the AWS4 mandated 'host' and 'x-amz-date' headers, accepting and returning the date/time that will - be used throughout the signing process in various elements and formats. - - The current set of headers - - - Date and time used for x-amz-date, in UTC - - - - Computes and returns an AWS4 signature for the specified canonicalized request - - - - - - - - - - - - Computes and returns an AWS4 signature for the specified canonicalized request - - - - - - - - - - - - - Computes and returns an AWS4 signature for the specified canonicalized request - - - - - - - - - - - - - - Formats the supplied date and time for use in AWS4 signing, where various formats are used. - - - The required format - The UTC date/time in the requested format - - - - Compute and return the multi-stage signing key for the request. - - The clear-text AWS secret key, if not held in secureKey - The region in which the service request will be processed - Date of the request, in yyyyMMdd format - The name of the service being called by the request - Computed signing key - - - - If the caller has already set the x-amz-content-sha256 header with a pre-computed - content hash, or it is present as ContentStreamHash on the request instance, return - the value to be used in request canonicalization. - If not set as a header or in the request, attempt to compute a hash based on - inspection of the style of the request content. - - - - The computed hash, whether already set in headers or computed here. Null - if we were not able to compute a hash. - - - - - If signPayload is false set the x-amz-content-sha256 header to - the UNSIGNED-PAYLOAD magic string and return it. - Otherwise, if the caller has already set the x-amz-content-sha256 header with a pre-computed - content hash, or it is present as ContentStreamHash on the request instance, return - the value to be used in request canonicalization. - If not set as a header or in the request, attempt to compute a hash based on - inspection of the style of the request content. - - - - - The computed hash, whether already set in headers or computed here. Null - if we were not able to compute a hash. - - - - - Returns the HMAC256 for an arbitrary blob using the specified key - - - - - - - - Returns the HMAC256 for an arbitrary blob using the specified key - - - - - - - - Compute and return the hash of a data blob using the specified key - - Algorithm to use for hashing - Hash key - Data blob - Hash of the data - - - - Compute and return the hash of a data blob using the specified key - - Algorithm to use for hashing - Hash key - Data blob - Hash of the data - - - - Computes the non-keyed hash of the supplied data - - - - - - - Computes the non-keyed hash of the supplied data - - - - - - - Computes and returns the canonical request - - The endpoint URL - the path of the resource being operated on - The http method used for the request - The full request headers, sorted into canonical order - The query parameters for the request - - The hash of the binary request body if present. If not supplied, the routine - will look for the hash as a header on the request. - - Canonicalised request as a string - - - - Computes and returns the canonical request - - The endpoint URL - the path of the resource being operated on - The http method used for the request - The full request headers, sorted into canonical order - The query parameters for the request - - The path resource values lookup to use to replace the keys within resourcePath - The hash of the binary request body if present. If not supplied, the routine - will look for the hash as a header on the request. - - The version of the marshaller that constructed the request object. - Canonicalised request as a string - - - - Computes and returns the canonical request - - The endpoint URL - the path of the resource being operated on - The http method used for the request - The full request headers, sorted into canonical order - The query parameters for the request - - The path resource values lookup to use to replace the keys within resourcePath - The hash of the binary request body if present. If not supplied, the routine - will look for the hash as a header on the request. - - The version of the marshaller that constructed the request object. - The service being called for the request - Canonicalised request as a string - - - - Reorders the headers for the request for canonicalization. - - The set of proposed headers for the request - List of headers that must be included in the signature - For AWS4 signing, all headers are considered viable for inclusion - - - - Computes the canonical headers with values for the request. Only headers included in the signature - are included in the canonicalization process. - - All request headers, sorted into canonical order - Canonicalized string of headers, with the header names in lower case. - - - - Returns the set of headers included in the signature as a flattened, ;-delimited string - - The headers included in the signature - Formatted string of header names - - - - Collects the subresource and query string parameters into one collection - ready for canonicalization - - The in-flight request being signed - The fused set of parameters - - - - Computes and returns the canonicalized query string, if query parameters have been supplied. - Parameters with no value will be canonicalized as 'param='. The expectation is that parameters - have not already been url encoded prior to canonicalization. - - The set of parameters being passed on the uri - - Parameters must be uri encoded into the canonical request and by default the signer expects - that the supplied collection contains non-encoded data. Set this to false if the encoding was - done prior to signer entry. - - The uri encoded query string parameters in canonical ordering - - - - Computes and returns the canonicalized query string, if query parameters have been supplied. - Parameters with no value will be canonicalized as 'param='. The expectation is that parameters - have not already been url encoded prior to canonicalization. - - The set of parameters to be encoded in the query string - - Parameters must be uri encoded into the canonical request and by default the signer expects - that the supplied collection contains non-encoded data. Set this to false if the encoding was - done prior to signer entry. - - The uri encoded query string parameters in canonical ordering - - - - Returns the request parameters in the form of a query string. - - The request instance - Request parameters in query string format - - - - AWS4 protocol signer for Amazon S3 presigned urls. - - - - - Calculates and signs the specified request using the AWS4 signing protocol by using the - AWS account credentials given in the method parameters. The resulting signature is added - to the request headers as 'Authorization'. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. - - - Adding supporting data for the service call required by the signer (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text - - - If any problems are encountered while signing the request. - - - - - Calculates the AWS4 signature for a presigned url. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. If the Expires parameter - is present, it is renamed to 'X-Amz-Expires' before signing. - - - Adding supporting data for the service call required by the signer (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text - - - If any problems are encountered while signing the request. - - - Parameters passed as part of the resource path should be uri-encoded prior to - entry to the signer. Parameters passed in the request.Parameters collection should - be not be encoded; encoding will be done for these parameters as part of the - construction of the canonical request. - - - - - Calculates the AWS4 signature for a presigned url. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. If the Expires parameter - is present, it is renamed to 'X-Amz-Expires' before signing. - - - Adding supporting data for the service call required by the signer (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text - - - The service to sign for - - - The region to sign to, if null then the region the client is configured for will be used. - - - If any problems are encountered while signing the request. - - - Parameters passed as part of the resource path should be uri-encoded prior to - entry to the signer. Parameters passed in the request.Parameters collection should - be not be encoded; encoding will be done for these parameters as part of the - construction of the canonical request. - - The X-Amz-Content-SHA256 is cleared out of the request. - If the request is for S3 then the UNSIGNED_PAYLOAD value is used to generate the canonical request. - If the request isn't for S3 then the empty body SHA is used to generate the canonical request. - - - - - Encapsulates the various fields and eventual signing value that makes up - an AWS4 signature. This can be used to retrieve the required authorization string - or authorization query parameters for the final request as well as hold ongoing - signature computations for subsequent calls related to the initial signing. - - - - - Constructs a new signing result instance for a computed signature - - The access key that was included in the signature - Date/time (UTC) that the signature was computed - The collection of headers names that were included in the signature - Formatted 'scope' value for signing (YYYYMMDD/region/service/aws4_request) - Returns the key that was used to compute the signature - Computed signature - - - - The access key that was used in signature computation. - - - - - ISO8601 formatted date/time that the signature was computed - - - - - ISO8601 formatted date that the signature was computed - - - - - The ;-delimited collection of header names that were included in the signature computation - - - - - Formatted 'scope' value for signing (YYYYMMDD/region/service/aws4_request) - - - - - Returns a copy of the key that was used to compute the signature - - - - - Returns the hex string representing the signature - - - - - Returns a copy of the byte array containing the signature - - - - - Returns the signature in a form usable as an 'Authorization' header value. - - - - - Returns the signature in a form usable as a set of query string parameters. - - - - - Null Signer which does a no-op. - - - - - Signs the specified request with the AWS2 signing protocol by using the - AWS account credentials given in the method parameters. - - The AWS public key - The AWS secret key used to sign the request in clear text - Request metrics - The configuration that specifies which hashing algorithm to use - The request to have the signature compute for - If any problems are encountered while signing the request - - - - S3 signer constructor - - - - - S3 signer constructor - - - - - This exception is thrown if there are problems signing the request. - - - - - Collection used to indicate if the property was initialized was created by the SDK. - - - - - - Collection used to indicate if the property was initialized was created by the SDK. - - - - - - - Default implementation of the IRequest interface. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Constructs a new DefaultRequest with the specified service name and the - original, user facing request object. - - The orignal request that is being wrapped - The service name - - - - The name of the request - - - - - Gets and sets the type of http request to make, whether it should be POST,GET or DELETE - - - - - Gets and sets a flag that indicates whether the request is sent as a query string instead of the request body. - - - - - Returns the original, user facing request object which this internal - request object is representing. - - - - - Returns a dictionary of the headers included in this request. - - - - - Returns a dictionary of the parameters included in this request. - - - - - Collection of parameters included in this request. - - - - - Returns the subresources that should be appended to the resource path. - This is used primarily for Amazon S3, where object keys can contain '?' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new null entry to the SubResources collection for the request - - The name of the subresource - - - - Adds a new entry to the SubResources collection for the request - - The name of the subresource - Value of the entry - - - - Gets and Sets the endpoint for this request. - - - - - Gets and Sets the resource path added on to the endpoint. - - - - - Returns the path resources that should be used within the resource path. - This is used for services where path keys can contain '/' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new entry to the PathResources collection for the request - - The name of the pathresource with potential greedy syntax: {key+} - Value of the entry - - - - Gets and Sets the version number for the marshaller used to create this request. The version number - is used to support backward compatible changes that would otherwise be breaking changes when a - newer core is used with an older service assembly. - Versions: - 1 - Default version - 2 - Support for path segments - - - - - Gets and Sets the content for this request. - - - - - Flag that signals that Content was and should be set - from the Parameters collection. - - - - - Gets and sets the content stream. - - - - - Gets and sets the original stream position. - If ContentStream is null or does not support seek, this propery - should be equal to -1. - - - - - Computes the SHA 256 hash of the content stream. If the stream is not - seekable, it searches the parent stream hierarchy to find a seekable - stream prior to computation. Once computed, the hash is cached for future - use. If a suitable stream cannot be found to use, null is returned. - - - - - The name of the service to which this request is being sent. - - - - - Alternate endpoint to use for this request, if any. - - - - - Host prefix value to prepend to the endpoint for this request, if any. - - - - - Gets and sets the Suppress404Exceptions property. If true then 404s return back from AWS will not cause an exception and - an empty response object will be returned. - - - - - If using AWS4 signing protocol, contains the resultant parts of the - signature that we may need to make use of if we elect to do a chunked - encoding upload. - - - - - Determine whether to use a chunked encoding upload for the request - (applies to Amazon S3 PutObject and UploadPart requests only). - - - - - - Used for Amazon S3 requests where the bucket name is removed from - the marshalled resource path into the host header. To comply with - AWS2 signature calculation, we need to recover the bucket name - and include it in the resource canonicalization, which we do using - this field. - - - - - This flag specifies if SigV4 is required for the current request. - - - - - The authentication region to use for the request. - Set from Config.AuthenticationRegion. - - - - - The region in which the service request was signed. - - - - - Checks if the request stream can be rewinded. - - Returns true if the request stream can be rewinded , - else false. - - - - Returns true if the request can contain a request body, else false. - - Returns true if the currect request can contain a request body, else false. - - - - Returns true if the request has a body, else false. - - Returns true if the request has a body, else false. - - - - Class containing the data for one endpoint returned from a endpoint discovery request - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Constructs a new DiscoveryEndpoint - - The address of the endpoint - The cache period for the endpoint in minutes - - - - The address of the endpoint. - - - - - The cache period for the endpoint in minutes - - - - - Calculates if this endpoint has expired - - A boolean value indicating if the cache period has expired - - - - Extends the endpoint expiration by the specified number of minutes from now. - - - - - Class containing the data for one endpoint returned from a endpoint discovery request - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class containing the data to use with endpoint discovery - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Gets/sets and flag indicating if endpoint discovery is required for the request. - - - - - Sorted dictionary of the identifiers that must be sent with the endpoint discovery request. These - identifiers are used to construct the cache key for the cache that stores discovered endpoints. A - sorted dictionary is used instead of a dictionary to ensure the cache key comes out in the same order - each time it is constructed. - - - - - Represents the data to be used with endpoint discovery operations - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class used to resolve endpoints using Endpoint Discovery. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Method that performs endpoint discovery for the current operation - - Context information used in calculations for endpoint discovery - The operation to fetch endpoints from the server - - - - - Gets the number of cache keys in the cache - - - - - Class used to resolve endpoints using Endpoint Discovery. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class containing context information to use with endpoint discovery - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Gets the customer credential information. - - - - - Gets the operation name. - - - - - Gets the current marshalled endpoint discovery data. - - - - - Gets the flag indicating if the specified key should be evicted from the cache. - - - - - Gets the Uri that should be evicted if EvictCacheKey is set to true. - - - - - Class containing context information to use with endpoint discovery - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Error type, one of Sender, Receiver, Unknown - Only applies to XML-based services. - - - - - Name of the exception class to return - - - - - Error message - - - - - RequestId of the error. - Only applies to XML-based services. - - - - - InternalConfiguration holds the cached SDK configuration values - obtained from the environment and profile configuration - factories. These configuration values are loaded internally and - are not the same as user exposed AWSConfigs. - - - - - Flag indicating if Endpoint Discovery is enabled. - - - - - The retry mode to use: Legacy, Standard, or Adaptive. - - - - - The max number of request attempts. - - - - - Determines the configuration values based on environment variables. If - no values is found for a configuration the value will be set to null. - - - - - Filler for netstandard 1.3 not supporting TypeConverter. - - - - - Attempts to construct a configuration instance of configuration environment - variables. If an environment variable value isn't found then the individual value - for that environment variable will be null. If unable to obtain a value converter - to convert a configuration string to the appropriate type a InvalidOperationException - is thrown. - - - - - Determines configuration values based on a stored in an . - If the profile doesn't exist, the status will be logged and no value will be set in the configuration. - - - - - Attempts to construct an instance of . - If the AWS_PROFILE environment variable is set the instance will be constructed using that profile, - otherwise it will use the default profile. - - If the profile doesn't exist status will be logged and no value will be set in the configuration. - - The ICredentialProfileSource to read the profile from. - - - - Attempts to construct an instance of . - If the profile doesn't exist status will be logged and no value will be set in the configuration. - - The ICredentialProfileSource to read the profile from. - The name of the profile. - - - - Probing mechanism to determine the configuration values from various sources. - - - - - Resets all the configuration values reloading as needed. This method will use - the AWS_PROFILE environment variable if set to construct the instance. Otherwise - the default profile will be used. - - - - - Flag that specifies if endpoint discovery is enabled, disabled, - or not set. - - - - - Flag that specifies which retry mode to use or if retry mode has - not been set. - - - - - Flag that specifies the max number of request attempts or if max - attempts has not been set. - - - - - Class containing the members used to invoke service calls - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class containing the members used to invoke service calls - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Represents a request being sent to an Amazon Web Service, including the - parameters being sent as part of the request, the endpoint to which the - request should be sent, etc. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - The name of the request - - - - - Returns a dictionary of the headers included in this request. - - - - - Gets and sets a flag that indicates whether the request is sent as a query string instead of the request body. - - - - - Returns a dictionary of the parameters included in this request. - - - - - Collection of parameters included in this request. - - - - - Returns the subresources that should be appended to the resource path. - This is used primarily for Amazon S3, where object keys can contain '?' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new null entry to the SubResources collection for the request - - The name of the subresource - - - - Adds a new entry to the SubResources collection for the request - - The name of the subresource - Value of the entry - - - - Gets and sets the type of http request to make, whether it should be POST,GET or DELETE - - - - - Gets and Sets the endpoint for this request. - - - - - Gets and Sets the resource path added on to the endpoint. - - - - - Returns the path resources that should be used within the resource path. - This is used for services where path keys can contain '/' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new entry to the PathResources collection for the request - - The name of the pathresource with potential greedy syntax: {key+} - Value of the entry - - - - Gets and Sets the version number for the marshaller used to create this request. The version number - is used to support backward compatible changes that would otherwise be breaking changes when a - newer core is used with an older service assembly. - - - - - Gets and Sets the content for this request. - - - - - Gets the header value from the request. - - - - - Flag that signals that Content was and should be set - from the Parameters collection. - - - - - Gets and sets the content stream. - - - - - Gets and sets the original stream position. - If ContentStream is null or does not support seek, this propery - should be equal to -1. - - - - - Computes the SHA 256 hash of the content stream. If the stream is not - seekable, it searches the parent stream hierarchy to find a seekable - stream prior to computation. Once computed, the hash is cached for future - use. - - - - - The name of the service to which this request is being sent. - - - - - Returns the original, user facing request object which this internal - request object is representing. - - - - - Alternate endpoint to use for this request, if any. - - - - - Host prefix value to prepend to the endpoint for this request, if any. - - - - - Gets and sets the Suppress404Exceptions property. If true then 404s return back from AWS will not cause an exception and - an empty response object will be returned. - - - - - If using AWS4 signing protocol, contains the resultant parts of the - signature that we may need to make use of if we elect to do a chunked - encoding upload. - - - - - Determine whether to use a chunked encoding upload for the request - (applies to Amazon S3 PutObject and UploadPart requests only). - - - - - - Used for Amazon S3 requests where the bucket name is removed from - the marshalled resource path into the host header. To comply with - AWS2 signature calculation, we need to recover the bucket name - and include it in the resource canonicalization, which we do using - this field. - - - - - This flag specifies if SigV4 is required for the current request. - - - - - The authentication region to use for the request. - Set from Config.AuthenticationRegion. - - - - - The region in which the service request was signed. - - - - - Checks if the request stream can be rewinded. - - Returns true if the request stream can be rewinded , - else false. - - - - Returns true if the request can contain a request body, else false. - - Returns true if the currect request can contain a request body, else false. - - - - Returns true if the request has a body, else false. - - Returns true if the request has a body, else false. - - - - Gets the value of the Service Id. - - - - - Gets the dictionary that gives mapping of renamed operations - - - - - IDictionary{String, String} access to ParameterCollection. - TODO: remove this class in version 3.4 of the SDK. - - - - - Constructs ParametersDictionaryFacade for a ParameterCollection - - - - - - A registry of object that will manipulate the runtime pipeline used by service clients. - - - - - Registers a customizer that will be applied for all service clients created. Each customizer has a unique name associated with it. If a customizer is registered more - than once with the same unique name then the calls after the first will be ignored. - - - - - - Deregistered the runtime pipeline customizer - - - - - - Deregistered the runtime pipeline customizer - - - - - - Applies all of the registered customizers on the runtime pipeline - - The service clients runtime pipeline. - Type object for the service client being created - - - - Interface for objects that will customize the runtime pipleine for newly created service clients. - - - - - The unique name for the customizer that identifies the customizer in the registry. The name is also used to identify the customizer on the SDK logs. - - - - - Called on service clients as they are being constructed to customize their runtime pipeline. - - - Type object for the service client being created - - - - Default ServiceMetadata implementation. - This implementation will be used if the service doesn't have a - IServiceMetadata implementation. - - - - - Gets the value of the Service Id. - - - - - Gets the dictionary that gives mapping of renamed operations - - - - - Response Unmarshaller for all Errors - - - - - Build an ErrorResponse from XML - - The XML parsing context. - Usually an Amazon.Runtime.Internal.UnmarshallerContext. - An ErrorResponse object. - - - - Return an instance of and ErrorResponseUnmarshaller. - - - - - - Interface for unmarshallers which unmarshall objects from response data. - The Unmarshallers are stateless, and only encode the rules for what data - in the XML stream goes into what members of an object. - - The type of object the unmarshaller returns - The type of the XML unmashaller context, which contains the - state during parsing of the XML stream. Usually an instance of - Amazon.Runtime.Internal.Transform.UnmarshallerContext. - - - - Given the current position in the XML stream, extract a T. - - The XML parsing context - An object of type T populated with data from the XML stream. - - - - Interface for unmarshallers which unmarshall service responses. - The Unmarshallers are stateless, and only encode the rules for what data - in the XML stream goes into what members of an object. - - The type of object the unmarshaller returns - The type of the XML unmashaller context, which contains the - state of parsing the XML stream. Uaually an instance of - Amazon.Runtime.Internal.Transform.UnmarshallerContext. - - - - Extracts an exeption with data from an ErrorResponse. - - The XML parsing context. - An inner exception to be included with the returned exception - The HttpStatusCode from the ErrorResponse - Either an exception based on the ErrorCode from the ErrorResponse, or the - general service exception for the service in question. - - - - Interface for unmarshallers which unmarshall objects from response data. - The Unmarshallers are stateless, and only encode the rules for what data - in the XML stream goes into what members of an object. - - The type of object the unmarshaller returns - The type of the XML unmashaller context, which contains the - state during parsing of the XML stream. Usually an instance of - Amazon.Runtime.Internal.Transform.UnmarshallerContext. - - - - Given the current position in the XML stream, extract a T. - - The XML parsing context - An object of type T populated with data from the XML stream. - - - - First-pass unmarshaller for all errors - - - - - Build an ErrorResponse from json - - The json parsing context. - Usually an Amazon.Runtime.Internal.JsonUnmarshallerContext. - An ErrorResponse object. - - - - Return an instance of JsonErrorResponseUnmarshaller. - - - - - - Wraps a json string for unmarshalling. - - Each Read() operation gets the next token. - TestExpression() is used to match the current key-chain - to an xpath expression. The general pattern looks like this: - - JsonUnmarshallerContext context = new JsonUnmarshallerContext(jsonString); - while (context.Read()) - { - if (context.IsKey) - { - if (context.TestExpresion("path/to/element")) - { - myObject.stringMember = stringUnmarshaller.GetInstance().Unmarshall(context); - continue; - } - } - } - - - - - - Wrap the jsonstring for unmarshalling. - - Stream that contains the JSON for unmarshalling - If set to true, maintains a copy of the complete response body constraint to log response size as the stream is being read. - Response data coming back from the request - If set to true, maintains a copy of the complete response body as the stream is being read. - - - - Are we at the start of the json document. - - - - - Is the current token the end of an object - - - - - Is the current token the start of an object - - - - - Returns the element depth of the parser's current position in the json - document being parsed. - - - - - The current Json path that is being unmarshalled. - - - - - Reads to the next token in the json document, and updates the context - accordingly. - - - True if a token was read, false if there are no more tokens to read. - - - - - Peeks at the next token. This peek implementation - reads the next token and makes the subsequent Read() return the same data. - If Peek is called successively, it will return the same data. - Only the first one calls Read(), subsequent calls - will return the same data until a Read() call is made. - - Token to peek. - Returns true if the peeked token matches given token. - - - - Returns the text contents of the current token being parsed. - - - The text contents of the current token being parsed. - - - - - The type of the current token - - - - - Get the base stream of the jsonStream. - - - - - Peeks at the next (non-whitespace) character in the jsonStream. - - The next (non-whitespace) character in the jsonStream, or -1 if at the end. - - - - Peeks at the next character in the stream. - If the data isn't buffered into the StreamReader (Peek() returns -1), - we flush the buffered data and try one more time. - - - - - - Abstract class for unmarshalling service responses. - - - - - Class for unmarshalling XML service responses. - - - - - Class for unmarshalling EC2 service responses. - - - - - Class for unmarshalling JSON service responses. - - - - - Unmarshaller for int fields - - - - - Unmarshaller for nullable int fields. Implemented only for JSON context - to handle cases where value can be null e.g. {'Priority': null}. - This unmarshaller is not implemented for XML context, as XML responses - will null elements (xsi:nil='true') will be skipped by the XML parser. - - - - - Unmarshaller for long fields - - - - - Unmarshaller for float fields - - - - - Unmarshaller for double fields - - - - - Unmarshaller for decimal fields - - - - - Unmarshaller for bool fields - - - - - Unmarshaller for string fields - - - - - Unmarshaller for byte fields - - - - - Unmarshaller for DateTime fields - - - - - Unmarshalls given string as a DateTime. Handles cases where we want to unmarshall - as just a DateTime or a nullable Datetime. - - Value to be parsed - If true, the method will return null if text is null. - If false, the method will return default(DateTime), if text is null. - - - - - Unmarshaller for nullable DateTime fields. Implemented only for JSON context - to handle cases where value can be null e.g. {'Priority': null}. - This unmarshaller is not implemented for XML context, as XML responses - will null elements (xsi:nil='true') will be skipped by the XML parser. - - - - - Unmarshaller for MemoryStream fields - - - - - Unmarshaller for ResponseMetadata - - - - - Base class for the UnmarshallerContext objects that are used - to unmarshall a web-service response. - - - - - Tests the specified expression against the current position in the XML - document - - The pseudo-XPath expression to test. - - True if the expression matches the current position in the document, - false otherwise. - - - - Tests the specified expression against the current position in the XML - document being parsed, and restricts the expression to matching at the - specified stack depth. - - The pseudo-XPath expression to test. - - The depth in the stack representing where the expression must - start matching in order for this method to return true. - - True if the specified expression matches the current position in - the XML document, starting from the specified depth. - - - - Reads the next token at depth greater than or equal to target depth. - - Tokens are read at depth greater than or equal to target depth. - True if a token was read and current depth is greater than or equal to target depth. - - - - The current path that is being unmarshalled. - - - - - Returns the element depth of the parser's current position in the - document being parsed. - - - - - Reads to the next node in the document, and updates the context accordingly. - - - True if a node was read, false if there are no more elements to read. - - - - - Returns the text contents of the current element being parsed. - - - The text contents of the current element being parsed. - - - - - True if NodeType is Element. - - - - - True if NodeType is EndElement. - - - - - True if the context is at the start of the document. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Wrap an XmltextReader for simulating an event stream. - - Each Read() operation goes either to the next element or next attribute within - the current element. TestExpression() is used to match the current event - to an xpath expression. The general pattern looks like this: - - UnmarshallerContext context = new UnmarshallerContext(...); - while (context.Read()) - { - if (context.TestExpresion("path/to/element")) - { - myObject.stringMember = stringUnmarshaller.GetInstance().Unmarshall(context); - continue; - } - if (context.TestExpression("path/to/@attribute")) - myObject.MyComplexTypeMember = MyComplexTypeUnmarshaller.GetInstance().Unmarshall(context); - } - - - - - - Wrap an XmlTextReader with state for event-based parsing of an XML stream. - - Stream with the XML from a service response. - If set to true, maintains a copy of the complete response body constraint to log response size as the stream is being read. - Response data coming back from the request - If set to true, maintains a copy of the complete response body as the stream is being read. - - - - The current XML path that is being unmarshalled. - - - - - Returns the element depth of the parser's current position in the XML - document being parsed. - - - - - Reads to the next node in the XML document, and updates the context accordingly. - - - True if a node was read, false if there are no more elements to read./ - - - - - Returns the text contents of the current element being parsed. - - - The text contents of the current element being parsed. - - - - - True if NodeType is Element. - - - - - True if NodeType is EndElement. - - - - - True if the context is at the start of the document. - - - - - True if NodeType is Attribute. - - - - - Wrap an XmlTextReader with state for event-based parsing of an XML stream. - - Stream with the XML from a service response. - If set to true, maintains a copy of the complete response body constraint to log response size as the stream is being read. - Response data coming back from the request - If set to true, maintains a copy of the complete response body as the stream is being read. - - - - RequestId value, if found in response - - - - - Reads to the next node in the XML document, and updates the context accordingly. - If node is RequestId, reads the contents and stores in RequestId property. - - - True if a node was read, false if there are no more elements to read./ - - - - - A stream which caches the contents of the underlying stream as it reads it. - - - - - All the bytes read by the stream. - - - - - All the bytes read by the stream constrained with _cacheLimit - - - - - Initializes the CachingWrapperStream with a base stream. - - The stream to be wrapped. - Maximum number of bytes to be cached. - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Gets a value indicating whether the current stream supports seeking. - CachingWrapperStream does not support seeking, this will always be false. - - - - - Gets or sets the position within the current stream. - CachingWrapperStream does not support seeking, attempting to set Position - will throw NotSupportedException. - - - - - Sets the position within the current stream. - CachingWrapperStream does not support seeking, attempting to call Seek - will throw NotSupportedException. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Stream wrapper that double-buffers from a wrapped stream and - returns the buffered content as a series of signed 'chunks' - for the AWS4 ('Signature V4') protocol. - - - - - Reads some or all of the processed chunk to the consumer, constructing - and streaming a new chunk if more input data is available. - - - - - - - - - Attempt to read sufficient data for a whole chunk from the wrapped stream, - returning the number of bytes successfully read to be processed into a chunk - - - - - Results of the header-signing portion of the request - - - - - Computed signature of the chunk prior to the one in-flight, in - hex - - - - - Computes the derived signature for a chunk of data of given length in the input buffer, - placing a formatted chunk with headers, signature and data into the output buffer - ready for streaming back to the consumer. - - - - - - Length override to return the true length of the payload plus the metainfo - supplied with each chunk - - - - - Computes the total size of the data payload, including the chunk metadata. - Called externally so as to be able to set the correct Content-Length header - value. - - - - - - - Computes the size of the header data for each chunk. - - - - - - - Attempt to read sufficient data for a whole chunk from the wrapped stream, - returning the number of bytes successfully read to be processed into a chunk - - - - - A list object that will always be sent to AWS services, - even if it is empty. - The AWS .NET SDK does not send empty collections to services, unless - the collection is of this type. - - - - - - A dictionary object that will always be sent to AWS services, - even if it is empty. - The AWS .NET SDK does not send empty collections to services, unless - the collection is of this type. - - - - - - - Class to perform actions on a background thread. - Uses a single background thread and performs actions - on it in the order the data was sent through the instance. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Class to invoke actions on a background thread. - Uses a single background thread and invokes actions - on it in the order they were invoked through the instance. - - - - - PCL doesn't have IPAddress. These methods are copied from the Microsoft source code. - - - - - Returns true if the Content is set or there are - query parameters. - - This request - True if data is present; false otherwise. - - - - Utilities for dealing with Guids - - - - - Hashes a set of objects. - - - - - - - Combines a set of hashses. - - - - - - - Combines two hashes. - - - - - - - - Disposes of all managed and unmanaged resources. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - A wrapper stream that calculates a hash of the base stream as it - is being read. - The calculated hash is only available after the stream is closed or - CalculateHash is called. After calling CalculateHash, any further reads - on the streams will not change the CalculatedHash. - If an ExpectedHash is specified and is not equal to the calculated hash, - Close or CalculateHash methods will throw an AmazonClientException. - If CalculatedHash is calculated for only the portion of the stream that - is read. - - - Exception thrown during Close() or CalculateHash(), if ExpectedHash is set and - is different from CalculateHash that the stream calculates, provided that - CalculatedHash is not a zero-length byte array. - - - - - Algorithm to use to calculate hash. - - - - - True if hashing is finished and no more hashing should be done; - otherwise false. - - - - - Current position in the stream. - - - - - Calculated hash for the stream. - This value is set only after the stream is closed. - - - - - Expected hash value. Compared against CalculatedHash upon Close(). - If the hashes are different, an AmazonClientException is thrown. - - - - - Expected length of stream. - - - - - Initializes an HashStream with a hash algorithm and a base stream. - - Stream to calculate hash for. - - Expected hash. Will be compared against calculated hash on stream close. - Pass in null to disable check. - - - Expected length of the stream. If the reading stops before reaching this - position, CalculatedHash will be set to empty array. - - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Asynchronously reads a sequence of bytes from the current stream, advances - the position within the stream by the number of bytes read, and monitors - cancellation requests. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous read operation. The value of the TResult - parameter contains the total number of bytes read into the buffer. This can be - less than the number of bytes requested if that many bytes are not currently - available, or zero (0) if the end of the stream has been reached. - - - - - Gets a value indicating whether the current stream supports seeking. - HashStream does not support seeking, this will always be false. - - - - - Gets or sets the position within the current stream. - HashStream does not support seeking, attempting to set Position - will throw NotSupportedException. - - - - - Sets the position within the current stream. - HashStream does not support seeking, attempting to call Seek - will throw NotSupportedException. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Gets the overridden length used to construct the HashStream - - - - - Calculates the hash for the stream so far and disables any further - hashing. - - - - - Resets the hash stream to starting state. - Use this if the underlying stream has been modified and needs - to be rehashed without reconstructing the hierarchy. - - - - - Validates the underlying stream. - - - - - Compares two hashes (arrays of bytes). - - Expected hash. - Actual hash. - - True if the hashes are identical; otherwise false. - - - - - A wrapper stream that calculates a hash of the base stream as it - is being read or written. - The calculated hash is only available after the stream is closed or - CalculateHash is called. After calling CalculateHash, any further reads - on the streams will not change the CalculatedHash. - If an ExpectedHash is specified and is not equal to the calculated hash, - Close or CalculateHash methods will throw an AmazonClientException. - If base stream's position is not 0 or HashOnReads is true and the entire stream is - not read, the CalculatedHash will be set to an empty byte array and - comparison to ExpectedHash will not be made. - - - Exception thrown during Close() or CalculateHash(), if ExpectedHash is set and - is different from CalculateHash that the stream calculates, provided that - CalculatedHash is not a zero-length byte array. - - - - - Initializes an HashStream with a hash algorithm and a base stream. - - Stream to calculate hash for. - - Expected hash. Will be compared against calculated hash on stream close. - Pass in null to disable check. - - - Expected length of the stream. If the reading stops before reaching this - position, CalculatedHash will be set to empty array. - - - - - A wrapper stream that calculates an MD5 hash of the base stream as it - is being read or written. - The calculated hash is only available after the stream is closed or - CalculateHash is called. After calling CalculateHash, any further reads - on the streams will not change the CalculatedHash. - If an ExpectedHash is specified and is not equal to the calculated hash, - Close or CalculateHash methods will throw an AmazonClientException. - If base stream's position is not 0 or HashOnReads is true and the entire stream is - not read, the CalculatedHash will be set to an empty byte array and - comparison to ExpectedHash will not be made. - - - Exception thrown during Close() or CalculateHash(), if ExpectedHash is set and - is different from CalculateHash that the stream calculates, provided that - CalculatedHash is not a zero-length byte array. - - - - - Initializes an MD5Stream with a base stream. - - Stream to calculate hash for. - - Expected hash. Will be compared against calculated hash on stream close. - Pass in null to disable check. - - - Expected length of the stream. If the reading stops before reaching this - position, CalculatedHash will be set to empty array. - - - - - Utilities for validating label values for host prefix templates - - - - - Validates a label value - - - - - Simple wrapper around the log4net Error method. - - - - - - - - Write debug message to Console - - - - - - - - Write debug message to Console - - - - - - - Simple wrapper around the log4net InfoFormat method. - - - - - - - This is a dynamic wrapper around log4net so we can avoid log4net being required - to be distributed with the SDK. - - - - - Abstract logger class, base for any custom/specific loggers. - - - - - Flushes the logger contents. - - - - - Simple wrapper around the log4net IsErrorEnabled property. - - - - - Simple wrapper around the log4net IsDebugEnabled property. - - - - - Simple wrapper around the log4net IsInfoEnabled property. - - - - - Simple wrapper around the log4net Error method. - - - - - - - - Simple wrapper around the log4net Debug method. - - - - - - - - Simple wrapper around the log4net DebugFormat method. - - - - - - - Simple wrapper around the log4net InfoFormat method. - - - - - - - Logger wrapper for reflected log4net logging methods. - - - - - This should be a one time call to use reflection to find all the types and methods - needed for the logging API. - - - - - Simple wrapper around the log4net IsErrorEnabled property. - - - - - Simple wrapper around the log4net Error method. - - - - - - - - Simple wrapper around the log4net IsDebugEnabled property. - - - - - Simple wrapper around the log4net Debug method. - - - - - - - - Simple wrapper around the log4net DebugFormat method. - - - - - - - Simple wrapper around the log4net IsInfoEnabled property. - - - - - Simple wrapper around the log4net InfoFormat method. - - - - - - - A single logged message - - - - - Log message arguments. - - - - - Culture-specific formatting provider. - - - - - Log message format. - - - - - a size-limited cache of key value pairs - - Once the maximum size has been reached, the least recently - used pairs will be evicted to make room for any new items. - - - - - - - the maximum number of entries this LruCache will hold - before items begin getting evicted - - - - - the number of items in the cache - - - - - Construct a new LruCache. - - maximum number of entries before items are evicted - - - - Add the key/value pair to the cache, or update - the value if the key already exists. - - If the cache is full, evicts the least recently used item. - - - - - - - Evicts a specific key out of the cache if it exists - - the key to evict from the cache - - - - Try to get the value associated with the key. - - the key to look up - the value, if the key exists - true if there is a value associated with the key, or false if no value is associated with the key - - - - Try to get the value associated with the key, if it doesn't exist, use the provided factory method to - create a new value and tries adding it to the cache. - - the key to look up - the factory method used in case the key is not present in the cache - the looked up value or the value created by the factory - - - - Clear the LruCache of all entries. - - - - - Helper class to support LruCache. - Does not implement the error checking and synchronization that - would be necessary for it to stand alone. - - - - - Item to be stored in the LruList - linked list structure. - - - - - Collection of properties being tracked - - - - - Timings for metrics being tracked - - - - - Counters being tracked - - - - - Whether metrics are enabled for the request - - - - - Constructs an empty, disabled metrics object - - - - - Starts timing an event. Logs an exception if an event - of the same type was started but not stopped. - - - - - - - Stops timing an event. Logs an exception if the event wasn't started. - - - - - - - Adds a property for a metric. If there are multiple, the - object is added as a new item in a list. - - - - - - - Sets a counter for a specific metric. - - - - - - - Increments a specific metric counter. - If counter doesn't exist yet, it is set to 1. - - - - - - Returns errors associated with the metric, including - if there are still any timing events in-flight. - - - - - - Returns a string representation of the current metrics. - - - - - - Return a JSON represenation of the current metrics - - - - - - Timing information for a metric - - - - - Empty, stopped timing object - - - - - Timing object in a started state - - - - - - Stops timing - - - - - - Whether the timing has been stopped - - - - - Elapsed ticks from start to stop. - If timing hasn't been stopped yet, returns 0. - - - - - Elapsed time from start to stop. - If timing hasn't been stopped yet, returns TimeSpan.Zero - - - - - Timing event, stops timing of a metric when disposed - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - The destructor for the client class. - - - - - A wrapper stream which supresses disposal of the underlying stream. - - - - - Constructor for NonDisposingWrapperStream. - - The base stream to wrap. - - - - The Dispose implementation for this wrapper stream - does not close the underlying stream. - - - - - This class is used to wrap a stream for a particular segment of a stream. It - makes that segment look like you are reading from beginning to end of the stream. - - - - - Asynchronously reads a sequence of bytes from the current stream, advances - the position within the stream by the number of bytes read, and monitors - cancellation requests. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous read operation. The value of the TResult - parameter contains the total number of bytes read into the buffer. This can be - less than the number of bytes requested if that many bytes are not currently - available, or zero (0) if the end of the stream has been reached. - - - - - Asynchronously writes a sequence of bytes to the current stream and advances the - current position within this stream by the number of bytes written. - - - An array of bytes. This method copies count bytes from buffer to the current stream. - - - The zero-based byte offset in buffer at which to begin copying bytes to the - current stream. - - The number of bytes to be written to the current stream. - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - A task that represents the asynchronous write operation. - - - - Wrapper stream that only supports reading - - - - - Asynchronously clears all buffers for this stream and causes any buffered data - to be written to the underlying device. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous flush operation. - - - - - Asynchronously writes a sequence of bytes to the current stream and advances the - current position within this stream by the number of bytes written. - - - An array of bytes. This method copies count bytes from buffer to the current stream. - - - The zero-based byte offset in buffer at which to begin copying bytes to the - current stream. - - The number of bytes to be written to the current stream. - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - A task that represents the asynchronous write operation. - - - - Partial wrapper stream that only supports reading - - - - - Uri wrapper that can parse out information (bucket, key, region, style) from an - S3 URI. - - - - - True if the URI contains the bucket in the path, false if it contains the bucket in the authority. - - - - - The bucket name parsed from the URI (or null if no bucket specified). - - - - - The key parsed from the URI (or null if no key specified). - - - - - The region parsed from the URI (or null if no region specified). - - - - - Constructs a parser for the S3 URI specified as a string. - - The S3 URI to be parsed. - - - - Constructs a parser for the S3 URI specified as a Uri instance. - - The S3 URI to be parsed. - - - - Percent-decodes the given string, with a fast path for strings that are not - percent-encoded. - - The string to decode - The decoded string - - - - Percent-decodes the given string. - - The string to decode - The index of the first '%' in the string - The decoded string - - - - Decodes the percent-encoded character at the given index in the string - and appends the decoded value to the string under construction. - - - The string under construction to which the decoded character will be - appended. - - The string being decoded. - The index of the '%' character in the string. - - - - Converts a hex character (0-9A-Fa-f) into its corresponding quad value. - - The hex character - The quad value - - - - Interface for a non-generic cache. - - - - - Clears the entire cache. - - - - - Maximum time to keep an item around after its last use. - - - - - How often should the cache be cleared of old items. - - - - - The number of items in the cache. - - - - - Interface for a generic cache. - - - - - - - Retrieves a value out of the cache or from the source. - - - - - - - - Retrieves a value out of the cache or from the source. - If the item was in the cache, isStaleItem is set to true; - otherwise, if the item comes from the source, isStaleItem is false. - - - - - - - - - Clears a specific value from the cache if it's there. - - - - - - Returns the keys for all items in the cache. - - - - - - Executes specified operation, catches exception, clears the cache for - the given key, retries the operation. - - - - - - - - - - - SDK-wide cache. - Provides access to caches specific to a particular set of credentials - and target region. - - - - - Clear all caches - - - - - Clear all caches of a particular type - - - - - - Retrieve a cache of a specific type for a client object. - The client object can be null in cases where a cache does - not correspond to a specific AWS account or target region. - - - - - - - - - - - Retrieve a cache of a specific type for a client object. - The client object can be null in cases where a cache does - not correspond to a specific AWS account or target region. - - - - - - - - - - - Utilities for converting objects to strings. Used by the marshaller classes. - - - - - Converts a DateTime to ISO8601 formatted string. - - - - - Converts a DateTime to RFC822 formatted string. - - - - - Converts a DateTime to Unix epoch time formatted string. - - - - - A wrapper stream. - - - - - Base stream. - - - - - Initializes WrapperStream with a base stream. - - - - - - Returns the first base non-WrapperStream. - - First base stream that is non-WrapperStream. - - - - Returns the first base non-WrapperStream. - - First base stream that is non-WrapperStream. - - - - Returns the first base non-WrapperStream. - - Potential WrapperStream - Base non-WrapperStream. - - - - Gets a value indicating whether the current stream supports reading. - True if the stream supports reading; otherwise, false. - - - - - Gets a value indicating whether the current stream supports seeking. - True if the stream supports seeking; otherwise, false. - - - - - Gets a value indicating whether the current stream supports writing. - True if the stream supports writing; otherwise, false. - - - - - Closes the current stream and releases any resources (such as sockets and - file handles) associated with the current stream. - - - - - Gets the length in bytes of the stream. - - - - - Gets or sets the position within the current stream. - - - - - Gets or sets a value, in miliseconds, that determines how long the stream - will attempt to read before timing out. - - - - - Gets or sets a value, in miliseconds, that determines how long the stream - will attempt to write before timing out. - - - - - Clears all buffers for this stream and causes any buffered data to be written - to the underlying device. - - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Sets the position within the current stream. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Sets the length of the current stream. - - The desired length of the current stream in bytes. - - - - Writes a sequence of bytes to the current stream and advances the current - position within this stream by the number of bytes written. - - - An array of bytes. This method copies count bytes from buffer to the current stream. - - - The zero-based byte offset in buffer at which to begin copying bytes to the - current stream. - - The number of bytes to be written to the current stream. - - - - Asynchronously clears all buffers for this stream and causes any buffered data - to be written to the underlying device. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous flush operation. - - - - - Asynchronously reads a sequence of bytes from the current stream, advances - the position within the stream by the number of bytes read, and monitors - cancellation requests. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous read operation. The value of the TResult - parameter contains the total number of bytes read into the buffer. This can be - less than the number of bytes requested if that many bytes are not currently - available, or zero (0) if the end of the stream has been reached. - - - - - Asynchronously writes a sequence of bytes to the current stream and advances the - current position within this stream by the number of bytes written. - - - An array of bytes. This method copies count bytes from buffer to the current stream. - - - The zero-based byte offset in buffer at which to begin copying bytes to the - current stream. - - The number of bytes to be written to the current stream. - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - A task that represents the asynchronous write operation. - - - - A wrapper stream that decrypts the base stream as it - is being read. - - - - - Initializes an DecryptStream with an decryption algorithm and a base stream. - - Stream to perform encryption on.. - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Asynchronously reads a sequence of bytes from the current stream and advances - the position within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Gets a value indicating whether the current stream supports seeking. - DecryptStream does not support seeking, this will always be false. - - - - - Gets or sets the position within the current stream. - DecryptStream does not support seeking, attempting to set Position - will throw NotSupportedException. - - - - - Sets the position within the current stream. - DecryptStream does not support seeking, attempting to call Seek - will throw NotSupportedException. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Validates the underlying stream. - - - - - A wrapper stream that decrypts the base stream as it - is being read. - - - - - Initializes an DecryptStream with an decryption algorithm and a base stream. - - Stream to perform encryption on.. - Symmetric key to perform decryption - Initialization vector to perform decryption - - - - A wrapper stream that decrypts the base stream using AES algorithm as it - is being read. - - - - - Initializes an AESDecryptionStream with a base stream. - - Stream to perform decryption on.. - Symmetric key to perform decryption - Initialization vector to perform decryption - - - - A wrapper stream that encrypts the base stream as it - is being read. - - - - - Initializes an EncryptStream with an encryption algorithm and a base stream. - - Stream to perform encryption on.. - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Asynchronously reads a sequence of bytes from the current stream, advances - the position within the stream by the number of bytes read, and monitors - cancellation requests. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous read operation. The value of the TResult - parameter contains the total number of bytes read into the buffer. This can be - less than the number of bytes requested if that many bytes are not currently - available, or zero (0) if the end of the stream has been reached. - - - - - Gets a value indicating whether the current stream supports seeking. - - - - - Returns encrypted content length. - - - - - Gets or sets the position within the current stream. - - - - - Sets the position within the current stream. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Validates the underlying stream. - - - - - A wrapper stream that encrypts the base stream as it - is being read. - - - - - Initializes an EncryptStream with an encryption algorithm and a base stream. - - Stream to perform encryption on.. - Symmetric key to perform encryption - Initialization vector to perform encryption - - - - A wrapper stream that encrypts the base stream using AES algorithm as it - is being read. - - - - - Initializes an AESEncryptionStream with a base stream. - - Stream to perform encryption on.. - Symmetric key to perform encryption - Initialization vector to perform encryption - - - - A wrapper stream that encrypts the base stream as it - is being read. - - - - - Initializes an EncryptStream for Multipart uploads with an encryption algorithm and a base stream. - - Stream to perform encryption on.. - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Asynchronously reads a sequence of bytes from the current stream, advances - the position within the stream by the number of bytes read, and monitors - cancellation requests. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous read operation. The value of the TResult - parameter contains the total number of bytes read into the buffer. This can be - less than the number of bytes requested if that many bytes are not currently - available, or zero (0) if the end of the stream has been reached. - - - - - Gets a value indicating whether the current stream supports seeking. - - - - - Returns encrypted content length. - - - - - Gets or sets the position within the current stream. - - - - - Sets the position within the current stream. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Validates the underlying stream. - - - - - A wrapper stream that encrypts the base stream as it - is being read. - - - - - Initializes an EncryptStream with an encryption algorithm and a base stream. - - Stream to perform encryption on.. - Symmetric key to perform encryption - Initialization vector to perform encryption - - - - A wrapper stream that encrypts the base stream as it - is being read. - - - - - Initializes an AESEncryptionStream with a base stream. - - Stream to perform encryption on.. - Symmetric key to perform encryption - Initialization vector to perform encryption - - - - Provides read/write access to a file in the INI format. - - This class is not threadsafe. - - - - - Construct a new IniFile. - - path of the IniFile - - - - the path of the file - - - - - helper to access the lines of the file - - - - - Persist the changes to this INI file to disk. - - - - - Rename the section fromSectionName to toSectionName - - - - - - - Rename the section fromSectionName to toSectionName - - - - if true and destination section already exists overwrite it - - - - Copy the section fromSectionName to toSectionName - - - - Any properties in the original section that are also in this dictionary will - be replaced by the value from this dictionary. - - - - Copy the section fromSectionName to toSectionName - - - - Any properties in the original section that are also in this dictionary will - be replaced by the value from this dictionary. - if true and destination section already exists overwrite it - - - - Update the section with the properties given. - If the section doesn't exist, it will be appended to the file. - - Notes: - 1. Any properties that do exist in the section will be updated. - 2. A null value for a property denotes that it should be deleted from the section - 3. If any properties don't exist they will be appended to the end of the section - in the same order they appear in the SortedDictionary. - - name of the section to operate on - properties to add/update/delete - - - - Check if the section exists. If not, append it to the end of the file. - - section to ensure exists - - - - If the section exists, delete it from the INI file. - - section to delete - - - - Determine if a section exists in the INI file. - - name of section to look for - true if the section exists, false otherwise - - - - Return the properties for the section if it exists. - - name of section to get - properties contained in the section - True if the section was found, false otherwise - - - - Return the properties for the section if it exists. - - Regex to match name of section to get - properties contained in the section - True if the section was found, false otherwise - - - - Return the properties for the section if it exists. - - Regex to match name of section to get - name of section if regex matches - properties contained in the section - True if the section was found, false otherwise - - - - Provides line-based read/write access to a file. - The file can be read into memory, changed, then written back to disk. - When the file is persisted back to disk, an optimistic concurrency - check is performed to make sure the file hasn't changed since it was - originally read. - - This class is not threadsafe. - - - - - a full copy of the original file - This is used for optimistic concurrency. - Note that this assumes a small file and does not scale large files. - - - - - path of the file - - - - - Read/write access to the lines that make up the file. - Any changes to this List are persisted back to disk when Persist() is called. - - NOTE: - The lines have the original line endings on them to preserve the - original text as much as possible. - - - - - Construct a new OptimisticLockedTextFile. - - path of the file - - - - Persist changes to disk after an optimistic concurrency check is completed. - - - - - Subclass of IniFile that allows INI sections to be read with the profile keyword in front of the section name. - - - - - This is a utility class to be used in last resort for code paths that are synchronous but need to call an asynchronous method. - This should never be used for methods that are called at high volume as this utility class has a performance cost. For example this - class was added for the refreshing credentials like Cognito which would need to use this about once an hour. - - - - - Custom WebProxy implementation that creates a webproxy based on - user inputs(Host name and port number) - - - - - Set the ProxyUri - - - - - Create a Uri based on the user inputs(Host name and port number) - - - - - Proxy Uri property - - - - - Proxy Credentials property - - - - - Getter to fetch the set proxy - - - - - Method to determine if the proxy should be bypassed when accessing an internet source - - - - - This class is no longer used anymore and should be avoided as it is just meant - as a last resort when blending async and sync operations. The code is still - here to support versions before 3.3.9.0 of AWSSDK.DynamoDBv2. - - - - - Collection of parameters that an SDK client will send to a service. - - - - - Constructs empty ParameterCollection. - - - - - Adds a parameter with a string value. - - - - - - - Adds a parameter with a list-of-strings value. - - - - - - - Converts the current parameters into a list of key-value pairs. - - - - - - Property to denote that the last exception returned by an AWS Service - was retryable or not. - - - - - This handler processes exceptions thrown from the HTTP handler and - unmarshalls error responses. - - - - - Default set of exception handlers. - - - - - Default set of exception handlers. - - - - - Constructor for ErrorHandler. - - an ILogger instance. - - - - Handles and processes any exception thrown from underlying handlers. - - The execution context which contains both the - requests and response context. - - - - Handles and processes any exception thrown from underlying handlers. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Disposes the response body. - - The response context. - - - - Processes an exception by invoking a matching exception handler - for the given exception. - - The execution context, it contains the - request and response context. - The exception to be processed. - - This method returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception that may be thrown by exception - processing by a matching exception handler. - - - - - The abstract base class for exception handlers. - - The exception type. - - - - The exception handler for HttpErrorResponseException exception. - - - - - The constructor for HttpErrorResponseExceptionHandler. - - in instance of ILogger. - - - - Handles an exception for the given execution context. - - The execution context, it contains the - request and response context. - The exception to handle. - - Returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception to replace the original exception. - - - - - Checks if a HTTP 404 status code is returned which needs to be suppressed and - processes it. - If a suppressed 404 is present, it unmarshalls the response and returns true to - indicate that a suppressed 404 was processed, else returns false. - - The execution context, it contains the - request and response context. - - - If a suppressed 404 is present, returns true, else returns false. - - - - - A pipeline handler which provides hooks to run - external code in the pre-invoke and post-invoke phases. - - - - - Action to execute on the pre invoke phase. - - - - - Action to execute on the post invoke phase. - - - - - Calls the PreInvoke and PostInvoke methods before and after calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls the PreInvoke and PostInvoke methods before and after calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Executes the OnPreInvoke action as part of pre-invoke. - - The execution context, it contains the - request and response context. - - - - Executes the OnPreInvoke action as part of post-invoke. - - The execution context, it contains the - request and response context. - - - - This handler retrieved the AWS credentials to be used for the current call. - - - - - The constructor for CredentialsRetriever. - - An AWSCredentials instance. - - - - Retrieves the credentials to be used for the current call before - invoking the next handler. - - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - This handler resolves the endpoint to be used for the current request. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Resolves the endpoint to be used for the current request - before invoking the next handler. - - The execution context, it contains the - request and response context. - - - - This handler resolves the endpoint to be used for the current request. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Resolves the endpoint to be used for the current request - before invoking the next handler. - - The execution context, it contains the - request and response context. - - - - Determines the endpoint for the request. - - The request context. - - - - - This handler provides an OnError action that can be used as hook for - external code to handle exceptions in the runtime pipeline. - - - - - Action to execute if an exception occurs during the - execution of any underlying handlers. - - - - - Executes the OnError action if an exception occurs during the - execution of any underlying handlers. - - - - - - - This handler marshalls the request before calling invoking the next handler. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Marshalls the request before calling invoking the next handler. - - The execution context, it contains the - request and response context. - - - - This handler manages the metrics used to time the complete call and - logs the final metrics. - - - - - Captures the overall execution time and logs final metrics. - - The execution context which contains both the - requests and response context. - - - - Captures the overall execution time and logs final metrics. - - The response type for the current request. - - The execution context, it contains the request and response context. - - A task that represents the asynchronous operation. - - - - This handler processes HTTP redirects and reissues the call to the - redirected location. - - - - - Processes HTTP redirects and reissues the call to the - redirected location. - - The execution context which contains both the - requests and response context. - - - - Processes HTTP redirects and reissues the call to the - redirected location. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Checks if an HTTP 307 (temporary redirect) has occured and changes the - request endpoint to the redirected location. - - - The execution context, it contains the request and response context. - - - A boolean value that indicates if a redirect has occured. - - - - - This handler signs the request. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Signs the request before invoking the next handler. - - - The execution context, it contains the request and response context. - - - - - Determines if the request should be signed. - - The request context. - A boolean value that indicated if the request should be signed. - - - - Signs the request. - - The request context. - - - - This handler unmarshalls the HTTP response. - - - - - The constructor for Unmarshaller. - - - Boolean value which indicated if the unmarshaller - handler supports response logging. - - - - - Unmarshalls the response returned by the HttpHandler. - - The execution context which contains both the - requests and response context. - - - - Unmarshalls the response returned by the HttpHandler. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Unmarshalls the HTTP response. - - - The execution context, it contains the request and response context. - - - - - Unmarshalls the HTTP response. - - - The execution context, it contains the request and response context. - - - - - The HTTP handler contains common logic for issuing an HTTP request that is - independent of the underlying HTTP infrastructure. - - - - - - The sender parameter used in any events raised by this handler. - - - - - The constructor for HttpHandler. - - The request factory used to create HTTP Requests. - The sender parameter used in any events raised by this handler. - - - - Issues an HTTP request for the current request context. - - The execution context which contains both the - requests and response context. - - - - Issues an HTTP request for the current request context. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Determines the content for request body and uses the HTTP request - to write the content to the HTTP request body. - - Content to be written. - The HTTP request. - The request context. - - - - Creates the HttpWebRequest and configures the end point, content, user agent and proxy settings. - - The async request. - The web request that actually makes the call. - - - - Disposes the HTTP handler. - - - - - An abstract pipeline handler that has implements IPipelineHandler, - and has the default implmentation. This is the base class for most of - the handler implementations. - - - - - The logger used to log messages. - - - - - The inner handler which is called after the current - handler completes it's processing. - - - - - The outer handler which encapsulates the current handler. - - - - - Contains the processing logic for a synchronous request invocation. - This method calls InnerHandler.InvokeSync to continue processing of the - request by the pipeline. - - The execution context which contains both the - requests and response context. - - - - Contains the processing logic for an asynchronous request invocation. - This method calls InnerHandler.InvokeSync to continue processing of the - request by the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Logs the metrics for the current execution context. - - The execution context, it contains the - request and response context. - - - - The default implementation of the adaptive retry policy. - - - The default implementation of the adaptive policy. - - - - - Constructor for AdaptiveRetryPolicy. - - The maximum number of retries before throwing - back a exception. This does not count the initial request. - - - - Constructor for AdaptiveRetryPolicy. - - The Client config object. This is used to - retrieve the maximum number of retries before throwing - back a exception(This does not count the initial request) and - the service URL for the request. - - - - OnRetry is called when a retry request is initiated to determine if the request will be retried. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - true if the error that will be retried is a throtting error - True if retry throttling is disabled or retry throttling is enabled and capacity can be obtained. - - - - This method uses a token bucket to enforce the maximum sending rate. - - The execution context which contains both the - requests and response context. - If the prior request failed, this exception is expected to be - the exception that occurred during the prior request failure. - - - - Virtual method that gets called on a success Response. If its a retry success response, the entire - retry acquired capacity is released(default is 5). If its just a success response a lesser value capacity - is released(default is 1). - - Request context containing the state of the request. - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - This method uses a token bucket to enforce the maximum sending rate. - - The execution context which contains both the - requests and response context. - If the prior request failed, this exception is expected to be - the exception that occurred during the prior request failure. - - - - The default implementation of the legacy retry policy. - - - The default implementation of the legacy retry policy. - - - - - The maximum value of exponential backoff in milliseconds, which will be used to wait - before retrying a request. The default is 30000 milliseconds. - - - - - Constructor for DefaultRetryPolicy. - - The maximum number of retries before throwing - back a exception. This does not count the initial request. - - - - Constructor for DefaultRetryPolicy. - - The Client config object. This is used to - retrieve the maximum number of retries before throwing - back a exception(This does not count the initial request) and - the service URL for the request. - - - - Returns true if the request is in a state where it can be retried, else false. - - Request context containing the state of the request. - Returns true if the request is in a state where it can be retried, else false. - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - true if the error that will be retried is a throtting error - - - - Virtual method that gets called on a success Response. If its a retry success response, the entire - retry acquired capacity is released(default is 5). If its just a success response a lesser value capacity - is released(default is 1). - - Request context containing the state of the request. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Request context containing the state of the request. - Return true if the request should be retried. - - - - Checks if the retry limit is reached. - - Request context containing the state of the request. - Return false if the request can be retried, based on number of retries. - - - - Waits before retrying a request. The default policy implements a exponential backoff. - - Request context containing the state of the request. - - - - Waits for an amount of time using an exponential backoff algorithm. - - The request retry index. The first request is expected to be 0 while - the first retry will be 1. - The max number of milliseconds to wait - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - The retry handler has the generic logic for retrying requests. - It uses a retry policy which specifies when - a retry should be performed. - - - - - The logger used to log messages. - - - - - The retry policy which specifies when - a retry should be performed. - - - - - Constructor which takes in a retry policy. - - Retry Policy - - - - Invokes the inner handler and performs a retry, if required as per the - retry policy. - - The execution context which contains both the - requests and response context. - - - - Invokes the inner handler and performs a retry, if required as per the - retry policy. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Prepares the request for retry. - - Request context containing the state of the request. - - - - The default implementation of the standard retry policy. - - - The default implementation of the standard policy. - - - - - The maximum value of exponential backoff in milliseconds, which will be used to wait - before retrying a request. The default is 20000 milliseconds. - - - - - Constructor for StandardRetryPolicy. - - The maximum number of retries before throwing - back a exception. This does not count the initial request. - - - - Constructor for StandardRetryPolicy. - - The Client config object. This is used to - retrieve the maximum number of retries before throwing - back a exception(This does not count the initial request) and - the service URL for the request. - - - - Returns true if the request is in a state where it can be retried, else false. - - Request context containing the state of the request. - Returns true if the request is in a state where it can be retried, else false. - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - true if the error that will be retried is a throtting error - - - - Virtual method that gets called on a success Response. If its a retry success response, the entire - retry acquired capacity is released(default is 5). If its just a success response a lesser value capacity - is released(default is 1). - - Request context containing the state of the request. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Request context containing the state of the request. - Return true if the request should be retried. - - - - Checks if the retry limit is reached. - - Request context containing the state of the request. - Return false if the request can be retried, based on number of retries. - - - - Waits before retrying a request. The default policy implements a exponential backoff with - jitter algorithm. - - Request context containing the state of the request. - - - - Waits for an amount of time using an exponential backoff with jitter algorithm. - - The request retry index. The first request is expected to be 0 while - the first retry will be 1. - The max number of milliseconds to wait - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - A runtime pipeline contains a collection of handlers which represent - different stages of request and response processing. - - - - - The top-most handler in the pipeline. - - - - - Constructor for RuntimePipeline. - - The handler with which the pipeline is initalized. - - - - Constructor for RuntimePipeline. - - List of handlers with which the pipeline is initalized. - - - - Constructor for RuntimePipeline. - - List of handlers with which the pipeline is initalized. - The logger used to log messages. - - - - Constructor for RuntimePipeline. - - The handler with which the pipeline is initalized. - The logger used to log messages. - - - - Invokes the pipeline synchronously. - - Request context - Response context - - - - Invokes the pipeline asynchronously. - - Request context - Response context - - - - Adds a new handler to the top of the pipeline. - - The handler to be added to the pipeline. - - - - Adds a handler after the first instance of handler of type T. - - Type of the handler after which the given handler instance is added. - The handler to be added to the pipeline. - - - - Adds a handler before the first instance of handler of type T. - - Type of the handler before which the given handler instance is added. - The handler to be added to the pipeline. - - - - Removes the first occurance of a handler of type T. - - Type of the handler which will be removed. - - - - Replaces the first occurance of a handler of type T with the given handler. - - Type of the handler which will be replaced. - The handler to be added to the pipeline. - - - - Inserts the given handler after current handler in the pipeline. - - Handler to be inserted in the pipeline. - Handler after which the given handler is inserted. - - - - Gets the innermost handler by traversing the inner handler till - it reaches the last one. - - - - - Retrieves a list of handlers, in the order of their execution. - - Handlers in the current pipeline. - - - - Retrieves current handlers, in the order of their execution. - - Handlers in the current pipeline. - - - - The CSM handler has the logic for capturing data for CSM attempts when enabled. - - - - - Invokes the CSM handler and captures data for the CSM attempts. - - - - - Calls the PreInvoke and PostInvoke methods before and after calling the next handler - in the pipeline. - - - - - Method that gets called in the final clause that captures data for each http request - from the request and response context. - - - - - Executes the OnPreInvoke action as part of pre-invoke. - - - - - Method to collect data in case of connection exception - - - - - Method to collect data in case of Amazon service exception - - - - - The CSM handler has the logic for capturing data for CSM events when enabled. - - - - - Invokes the CSM handler and captures data for the CSM events. - - - - - Calls the PreInvoke and PostInvoke methods before and after calling the next handler - in the pipeline. - - - - - Invoked from the finally block of CSMCallEventHandler's Invoke method. - This method is used to capture CSM Call event metrics. - - - - - - Method that gets invoked in case of an exception in the API request completion. - - - - - - - This class is responsible for managing adaptive retry mode client rate limiting. - - - - - The rate at which token are replenished. - - - - - The maximum capacity allowed in the token - - - - - The current capacity of the token - - - - - The last time the token bucket was refilled. - - - - - The smoothed rate which tokens are being retrieved. - - - - - The last half second time bucket used. - - - - - The number of requests seen within the current time - - - - - The maximum rate when the client was last throttled. - - - - - The last time when the client was throttled. - - - - - The cached time window calculation - - - - - Boolean indicating if the token bucket is enabled. - - - - - This method attempts to acquire capacity from the client's token - - The amount of capacity to obtain from the token bucket - Indicates that the client should or shouldn't sleep and - try again if capacity cannot be obtained. - - - - - This method attempts to acquire capacity from the client's token - - The amount of capacity to obtain from the token bucket - Indicates that the client should or shouldn't sleep and - try again if capacity cannot be obtained. - - Token which can be used to cancel the task. - - - - Updates the sending rate within the client's token bucket - - Indicates if the request resulted in a throttling error. - - - - Calculates the rate - - - Returns the calculated rate for a successful call - - - - Calculates the rate. - - The rate to use in the calculation - Returns the calculated rate for a throttled call - - - - This class gets the CSM configuration if set. - The priority goes - 1. App.config / instantiate on the AWSConfigs class - 2. Environment variable - 3. Shared Profile - - - - - Determine CSM configs from shared profile file. - - - - - Determine CSM configs from environment variables. - - - - - Determine CSM configs from AWSConfigs class. - - - - - Utility class for CSM. - Contains logic to serialize CSM events to Json. - - - - - Method to retrieve the API name from the request name. - - - - - Method to serialize MonitoringAPICallAttempt CSM event to json. - - - - - Method to serialize MonitoringAPICallEvent CSM event to json. - - - - - Method to serialize MonitoringAPICall CSM event to json. - - - - - Internal class that has the CSM configurations for the Monitoring Listener - after being derived from the CSMConfigChain class. - - - - - CSM event base class - - - - - Contains the operation name for the api call being made - - - - - Contains the service id ServiceId Sep of the service - against which the call is being made - - - - - Contains the "ClientId" configuration value - computed from the CSMConfigChain class - - - - - Contains the elapsed time, in milliseconds, - since January 1st, 1970, for the time point - at which the event occurred - - - - - Contains "ApiCall" or "ApiCallAttempt" - based on what the monitoring event is describing - - - - - Contains the enum of the above CSM type property - - - - - Contains the "Version" configuration value - computed from the CSMConfigChain class - Defaults to 1. - - - - - Contains the signing region used by the - service client that made the request attempt. - - - - - Contains the full value of the SDK's default - user agent header for http requests. - - - - - Class that captures the CSM Api Call Attempt Monitoring Events - for each http request and its subsequent response. - - - - - Contains the fully-qualified domain name of the endpoint that - the request attempt was submitted to. - - - - - Contains the session token passed - in the x-amz-security-token header. - - - - - Contains the aws_access_key value that - was used to sign the http request. - - - - - Contains the attempt's response status code, - as returned by the http client. - - - - - Contains the full text (exception object converted to String, - for example) for any attempt-level failure that is due to - something other than an Aws exception. The value of this entry - has a maximum length of 512. - - - - - Contains the short error name (exception class name, for example) - for any attempt-level failure that is due to something other - than an Aws exception.The value of this entry has a maximum length of 128. - - - - - Contains the Aws exception code returned in the response. - - - - - Contains the full text of the Aws exception message. - - - - - Contains the value of the response's x-amzn-RequestId header. - - - - - Contains the value of the response's x-amz-request-id header. - - - - - Contains the value of the response's x-amz-id-2 header. - - - - - Contains the elapsed time, in milliseconds, - between the construction of the http request and the - point in time where the http response has been parsed - or the attempt has definitively failed. - - - - - Class that captures the CSM Api Call Monitoring Events - for the entire SDK call. This is processed once. - - - - - Contains the total number of attempts that were made - by the service client to fulfill this request before succeeding or failing - - - - - Contains the elapsed time, in milliseconds, - between when the Api Call was begun and when a - final response or error is manifested to the caller - - - - - a boolean (0/1) value that is 0 unless the Api call failed - and the final attempt returned a retryable error.This entry should be - serialized as a numeric 0/1 value. This is mapped to MaxRetriesExceeded - when serialized to a UDP datagram. - - - - - Contains the full text (exception object - converted to String, for example) for an attempt-level failure that is due to - something other than an Aws exception that occurred on the last attempt to - fulfill the Api call.The value of this entry has a maximum length of 512. - - - - - Contains the short error name (exception - class name, for example) for a failure that is due to something other than an - Aws exception that occurred on the last attempt to fulfill an Api call.See - the SdkException entry for more details.The value of this entry has a - maximum length of 128. - - - - - Contains the Aws exception code - returned in the response to the final attempt at fulfilling this API call. - The value of this entry has a maximum length of 128. - - - - - - Contains the attempt's response status code, - as returned by the http client. - - - - - This class is the base class of all the configurations settings to connect - to a service. - - - This class is the base class of all the configurations settings to connect - to a service. - - - - - Gets Service Version - - - - - Gets and sets of the signatureMethod property. - - - - - Gets and sets of the SignatureVersion property. - - Note: This property exists for backward compatibility but is no longer - used by any service other than S3. - - - - - Gets and sets of the UserAgent property. - - - - - When set to true, the service client will use the x-amz-user-agent - header instead of the User-Agent header to report version and - environment information to the AWS service. - - Note: This is especially useful when using a platform like WebAssembly - which doesn't allow to specify the User-Agent header. - - - - - Gets and sets the RegionEndpoint property. The region constant that - determines the endpoint to use. - - Setting this property to null will force the SDK to recalculate the - RegionEndpoint value based on App/WebConfig, environment variables, - profile, etc. - - - - - The constant used to lookup in the region hash the endpoint. - - - - - Gets and sets of the ServiceURL property. - This is an optional property; change it - only if you want to try a different service - endpoint. - - - - - Gets and sets the UseHttp. - If this property is set to true, the client attempts - to use HTTP protocol, if the target endpoint supports it. - By default, this property is set to false. - - - - - Given this client configuration, return a string form ofthe service endpoint url. - - - - - Gets and sets the AuthenticationRegion property. - Used in AWS4 request signing, this is an optional property; - change it only if the region cannot be determined from the - service endpoint. - - - - - Gets and sets the AuthenticationServiceName property. - Used in AWS4 request signing, this is the short-form - name of the service being called. - - - - - Returns the flag indicating how many retry HTTP requests an SDK should - make for a single SDK operation invocation before giving up. This flag will - return 4 when the RetryMode is set to "Legacy" which is the default. For - RetryMode values of "Standard" or "Adaptive" this flag will return 2. In - addition to the values returned that are dependant on the RetryMode, the - value can be set to a specific value by using the AWS_MAX_ATTEMPTS environment - variable, max_attempts in the shared configuration file, or by setting a - value directly on this property. When using AWS_MAX_ATTEMPTS or max_attempts - the value returned from this property will be one less than the value entered - because this flag is the number of retry requests, not total requests. To - learn more about the RetryMode property that affects the values returned by - this flag, see . - - - - - Determines if MaxErrorRetry has been manually set. - - - - - Gets and sets the LogResponse property. - If this property is set to true, the service response is logged. - The size of response being logged is controlled by the AWSConfigs.LoggingConfig.LogResponsesSizeLimit property. - - - - - Gets and sets the ReadEntireResponse property. - NOTE: This property does not effect response processing and is deprecated. - To enable response logging, the ClientConfig.LogResponse and AWSConfigs.LoggingConfig - properties can be used. - - - - - Gets and Sets the BufferSize property. - The BufferSize controls the buffer used to read in from input streams and write - out to the request. - - - - - - Gets or sets the interval at which progress update events are raised - for upload operations. By default, the progress update events are - raised at every 100KB of data transferred. - - - If the value of this property is set less than ClientConfig.BufferSize, - progress updates events will be raised at the interval specified by ClientConfig.BufferSize. - - - - - - Flag on whether to resign requests on retry or not. - For Amazon S3 and Amazon Glacier this value will always be set to true. - - - - - This flag controls if .NET HTTP infrastructure should follow redirection - responses (e.g. HTTP 307 - temporary redirect). - - - - - Flag on whether to log metrics for service calls. - - This can be set in the application's configs, as below: - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSLogMetrics" value"true"/> - </appSettings> - </configuration> - - - - - - Gets and sets the DisableLogging. If true logging for this client will be disabled. - - - - - Credentials to use with a proxy. - - - - - - If the value is set, the value is assigned to the Timeout property of the HttpWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Configures the endpoint calculation for a service to go to a dual stack (ipv6 enabled) endpoint - for the configured region. - - - Note: AWS services are enabling dualstack endpoints over time. It is your responsibility to check - that the service actually supports a dualstack endpoint in the configured region before enabling - this option for a service. - - - - - Enable or disable the Retry Throttling feature by setting the ThrottleRetries flag to True/False resepctively. - Retry Throttling is a feature that intelligently throttles retry attempts when a large precentage of requests - are failing and retries are unsuccessful as well. In such situations the allotted retry capacity for the service URL - will be drained until requests start to succeed again. Once the requisite capacity is available, retries would - be permitted again. When retries are throttled, the service enters a fail-fast behaviour as the traditional retry attempt - for the request would be circumvented. Hence, errors will resurface quickly. This will result in a greated number of exceptions - but prevents requests being tied up in unsuccessful retry attempts. - Note: Retry Throttling is enabled by default. Set the ThrottleRetries flag to false to switch off this feature. - - - - - Enable or disable the Nagle algorithm on the underlying http - client. - - This method is not intended to be called by consumers of the AWS SDK for .NET - - - - - - Performs validation on this config object. - Throws exception if any of the required values are missing/invalid. - - - - - Returns the current UTC now after clock correction for this endpoint. - - - - - The calculated clock skew correction for a specific endpoint, if there is one. - This field will be set if a service call resulted in an exception - and the SDK has determined that there is a difference between local - and server times. - - If is set to true, this - value will still be set to the correction, but it will not be used by the - SDK and clock skew errors will not be retried. - - - - - Gets and sets the DisableHostPrefixInjection flag. If true, host prefix injection will be disabled for this client, the default value of this flag is false. - Host prefix injection prefixes the service endpoint with request members from APIs which use this feature. - Example: for a hostPrefix of "foo-name." and a endpoint of "service.region.amazonaws.com" the default behavior is to - prefix the endpoint with the hostPrefix resulting in a final endpoint of "foo-name.service.region.amazonaws.com". Setting - DisableHostPrefixInjection to true will disable hostPrefix injection resulting in a final endpoint of - "service.region.amazonaws.com" regardless of the value of hostPrefix. E.g. You may want to disable host prefix injection for testing against a local mock endpoint. - - - - - Returns the flag indicating if endpoint discovery should be enabled or disabled for operations that are not required to use endpoint discovery. - - - - - Returns the maximum number of discovered endpoints that can be stored within the cache for the client. The default limit is 1000 cache entries. - - - - - Returns the flag indicating the current mode in use for request - retries and influences the value returned from . - The default value is RequestRetryMode.Legacy. This flag can be configured - by using the AWS_RETRY_MODE environment variable, retry_mode in the - shared configuration file, or by setting this value directly. - - - - - Under Adaptive retry mode, this flag determines if the client should wait for - a send token to become available or don't block and fail the request immediately - if a send token is not available. - - - - - Throw an exception if the boxed TimeSpan parameter doesn't have a value or is out of range. - - - - - Returns the request timeout value if its value is set, - else returns client timeout value. - - - - - - This is a switch used for performance testing and is not intended for production applications - to change. This switch may be removed in a future version of the SDK as the .NET Core platform matures. - - - If true, the HttpClient is cached and reused for every request made by the service client - and shared with other service clients. - - - For the .NET Core platform this is default to true because the HttpClient manages the connection - pool. - - - - - - If CacheHttpClient is set to true then HttpClientCacheSize controls the number of HttpClients cached. - - On Windows the default value is 1 since the underlying native implementation does not have throttling constraints - like the non Windows Curl based implementation. For non Windows based platforms the default is the value return from - System.Environment.ProcessorCount. - - - - - - Overrides the default read-write timeout value. - On Unity platform, this value is not used as Unity HTTP client does not support timeouts, so - - - - If the value is set, the value is assigned to the ReadWriteTimeout property of the HttpWebRequest object used - to send requests. - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Returns a WebProxy instance configured to match the proxy settings - in the client configuration. - - - - - Unpacks the host, port and any credentials info into the instance's - proxy-related fields. - Unlike the SetWebProxy implementation on .NET 3.5/4.5,the Host and the Port are not reconstructed from the - input proxyuri - - The proxy details - - - - Gets and sets of the ProxyHost property. - - - - - Gets and sets of the ProxyPort property. - - - - - Get or set the value to use for on requests. - If this property is null, - will be left at its default value of . - - - - - - Returns true if the clients should be cached by HttpRequestMessageFactory, false otherwise. - - - - - - - Returns true if the SDK should dispose HttpClients after one use, false otherwise. - - - - - - - Create a unique string used for caching the HttpClient based on the settings that are used from the ClientConfig that are set on the HttpClient. - - - - - - - Determines if HttpClients created with the given IClientConfig should be cached at the SDK - client level, or cached globally. - - If there is no HttpClientFactory assigned and proxy or proxy credentials are set - this returns false because those properties can't be serialized as part of the key in the global http client cache. - - - - - Base class for constant class that holds the value that will be sent to AWS for the static constants. - - - - - Gets the value that needs to be used when send the value to AWS - - - - - Attempt to find correct-cased constant value using whatever cased value the user - has provided. This is primarily useful for mapping any-cased values from a CLI - tool to the specific casing required by the service, avoiding the need for the - user to (a) remember the specific case and (b) actually type it correctly. - - The properly cased service constant matching the value - - - - Utility class that stores clock skew information. - - - - - GlobalClockCorrection should be only set by AWSConfigs.ManualClockCorrection property - and is only available to maintain backward compatibilty. This should override any - endpoint specific clockskew correction. - - - - - Return clock skew correction value for an endpoint if there is one. - - AWSConfigs.ManualClockCorrection overrides globally any calculated service endpoint specific - clock correction value. - - Endpoint should in a form such as "https://s3" - Clock correction value for an endpoint in TimeSpan. TimeSpan.Zero if no such clock correction is set. - - - - Get clock skew corrected UTC now value. If ManualClockCorrection is set, - use ManualClockCorrection instead of endpoint specific clock correction value. - - - - - - - Class to easily convert from Dictionary<string, string> to ProfileOptions and back. - - - - - Separate the profileDictionary into its parts. - profileDictionary = profileOptions + reservedProperties + userProperties - - Dictionary with everything in it - Keys to ignore - The resulting CredentialProfileOptions - The properties that are left - - - - Separate the profileDictionary into its parts. - profileDictionary = profileOptions + reservedProperties + userProperties - - Dictionary with everything in it - Keys for the reservedKeys dictionary - The resulting CredentialProfileOptions - The resulting reserved properties - The properties that are left - - - - Validate the userProperties and then combine profileOptions, reservedProperties, and userProperties into one Dictionary. - - - - - - - - - - Make sure the userProperties dictionary doesn't contain any keys that are reserved. - Check is case-insensitive for added safety. - - - - - - - Make sure the userProperties dictionary doesn't contain any keys that - overlap with the names of mapped names for CredentialProfileOptions property names. - Check is case-insensitive for added safety. - - - - - - This class is used internally and should not be accessed by SDK users. - - Provide access to internal properties of CredentialProfile to - PowerShell tools and the Visual Studio Toolkit. - - - - - Factory to construct different types of AWSCredentials based on a profile. - - - - - Gets the AWSCredentials for this profile if CanCreateAWSCredentials is true - and AWSCredentials can be created. Throws an exception otherwise. - - See for a list of AWSCredentials returned by this method. - - The profile to get AWSCredentials for. - The profile source, for profiles that reference other profiles. - AWSCredentials for this profile. - - - - Gets the AWSCredentials for this profile if CanCreateAWSCredentials is true - and AWSCredentials can be created. Throws an exception otherwise. - - See for a list of AWSCredentials returned by this method. - - The options to get AWSCredentials for. - The profile source, for options that reference other profiles. - AWSCredentials for the options given. - - - - Gets the AWSCredentials for this profile if CanCreateAWSCredentials is true - and AWSCredentials can be created. Throws an exception otherwise. - - See for a list of AWSCredentials returned by this method. - - The profile to get AWSCredentials for. - The profile source, for profiles that reference other profiles. - If true, throw a descriptive exception for any credentials that would not operate as-is. - In other words, any credentials that require programmatic callbacks at runtime. - AWSCredentials for this profile. - - - - Gets the AWSCredentials for this profile if CanCreateAWSCredentials is true - and AWSCredentials can be created. Throws an exception otherwise. - - See for a list of AWSCredentials returned by this method. - - The options to get AWSCredentials for. - The profile source, for options that reference other profiles. - If true, throw a descriptive exception for any credentials that would not operate as-is. - In other words, any credentials that require programmatic callbacks at runtime. - AWSCredentials for the options given. - - - - Return the credentials for the profile if valid credentials can created. - - The profile to create credentials with. - The profile source, for profiles that reference other profiles. - The credentials for the profile. - True if credentials can be created from the profile, false otherwise. - - - - Return the credentials for the profile if valid credentials can created. - - The options to get AWSCredentials for. - The profile source, for profiles that reference other profiles. - The credentials for the profile. - True if credentials can be created from the profile, false otherwise. - - - - Determine if the profileType will generate AWSCredentials that require a callback to be set on them. - - - - - - - A named group of options that are persisted and used to obtain AWSCredentials. - - - - - The name of the CredentialProfile - - - - - The options to be used to create AWSCredentials. - - - - - The region to be used with this CredentialProfile - - - - - The unique key for this CredentialProfile. - This key is used by the Visual Studio Tooklit to associate external artifacts with this profile. - - - - - The endpoint discovery enabled value for this CredentialProfile - - - - - If true the region identified in the S3 access point arn will be used when making requests. - - - - - The Sts Regional Endpoints Value as either legacy or regional - - - - - The S3 Regional Endpoint Value as either legacy or regional - - - - - The request retry mode as legacy, standard, or adaptive - - - - - Specified how many HTTP requests an SDK should make for a single - SDK operation invocation before giving up. - - - - - An optional dictionary of name-value pairs stored with the CredentialProfile - - - - - True if the properties of the Options object can be converted into AWSCredentials, false otherwise. - See for more details about which options are available. - - - - - The that this is associated with. - Null if this is not associated with a . - - - - - If CanCreateAWSCredentials is true, returns a short description of the type of - credentials that would be created. - If CanCreateAWSCredentials is false, return null. - - - - - The CredentialProfileType of this CredentialProfile, if one applies. - - - - - Determine this CredentialProfile will generate AWSCredentials that require a callback to be set on them. - - - - - Construct a new CredentialProfile. - - - - - - - Gets the AWSCredentials for this profile if CanCreateAWSCredentials is true - and AWSCredentials can be created. Throws an exception otherwise. - - See for a list of AWSCredentials returned by this method. - - The profile source, for profiles that reference other profiles. - AWSCredentials for this profile. - - - - Gets the AWSCredentials for this profile if CanCreateAWSCredentials is true - and AWSCredentials can be created. Throws an exception otherwise. - - See for a list of AWSCredentials returned by this method. - - The profile source, for profiles that reference other profiles. - If true, throw a descriptive exception for any credentials that would not operate as-is. - In other words, any credentials that require programmatic callbacks at runtime. - AWSCredentials for this profile. - - - - The options that are available for creating AWSCredentials with the AWSCredentialsFactory. - The type of AWSCredentials that are created depends on which Options are set. - - Below are the different types of credentials returned, along with the options that are used to obtain them. - ([] denotes options that are not required) - - BasicAWSCredentials AccessKey SecretKey - SessionAWSCredentials AccessKey SecretKey Token - AssmeRoleAWSCredentials SourceProfile RoleArn [ExternalID] [MfaSerial] - - - - - The access key to be used in the AWSCredentials. - - - - - The source of credentials to be used to obtain AWSCredentials. - - - - - The external id to use in assume role AWSCredentials. - - - - - The serial number of the MFA to use in assume role AWSCredentials. - - - - The role ARN to use when creating assume role AWSCredentials. - - - - An identifier for the assumed role session. - - - - - The secret key to use when creating AWSCredentials. - - - - - When this CredentialProfileOptions object references another CredentialProfile, - the name of the referenced CredentialProfile. - - - - - The session token to be used to create AWSCredentials. - - - - - Contains the executable information to be used by the process credential retriever - to either fetch Basic or Session credentials - - - - - Absolute path to the file on disk containing an OIDC token. - - - - - Return true the properties are all null or empty, false otherwise. - - - - - Class to abstract the combined use of NetSDKCredentialsFile and SharedCredentialsFile where possible. - - - - - - The location of the shared credentials file, or null to use the default location. - - - - - Construct a CredentialProfileChain. - - - - - Construct a CredentialProfileChain. - - The path to the aws credentials file to look at. - - - - - Try to get from a profile. - - - If ProfilesLocation is non-null and non-empty search the shared credentials - file at the disk path in the ProfilesLocation property. - - - If ProfilesLocation is null or empty and the platform supports the .NET SDK credentials file - search the SDK credentials file. If the profile is not found search the shared credentials file in the default location. - - - If ProfilesLocation is null or empty and the platform doesn't support the .NET SDK credentials file - search the shared credentials file in the default location. - - - The name of the profile to get credentials from. - The credentials, if the profile is found and credentials can be created. - True if the profile was found and credentials could be created, false otherwise. - - - - - Try to get a - - - If ProfilesLocation is non-null and non-empty search the shared credentials - file at the disk path in the ProfilesLocation property. - - - If ProfilesLocation is null or empty and the platform supports the .NET SDK credentials file - search the SDK credentials file. If the profile is not found search the shared credentials file in the default location. - - - If ProfilesLocation is null or empty and the platform doesn't support the .NET SDK credentials file - search the shared credentials file in the default location. - - - The name of the profile to get. - The profile, if found - True if the profile was found, false otherwise. - - - - - Get a list of available objects. - - - If ProfilesLocation is non-null and non-empty include profiles in the shared credentials - file at the disk path in the ProfilesLocation property. - - - If ProfilesLocation is null or empty and the platform supports the .NET SDK credentials file - include profiles from the SDK credentials file and from the shared credentials file in the default location. - - - If ProfilesLocation is null or empty and the platform doesn't support the .NET SDK credentials file - include profiles from the shared credentials file in the default location. - - - A list of objects. - - - - - Register a - - - If ProfilesLocation is non-null and non-empty register the profile in the shared credentials - file at the disk path in the ProfilesLocation property. - - - If ProfilesLocation is null or empty and the platform supports the .NET SDK credentials file - register the profile in the SDK credentials file. - - - If ProfilesLocation is null or empty and the platform doesn't support the .NET SDK credentials file - register the profile in the shared credentials file in the default location. - - - The profile to register. - - - - - Unregister a - - - If ProfilesLocation is non-null and non-empty unregister the profile from the shared credentials - file at the disk path in the ProfilesLocation property. - - - If ProfilesLocation is null or empty and the platform supports the .NET SDK credentials file - search the SDK credentials file. If the profile is found there unregister it. - If the profile was not found search the shared credentials file in the default location. - If the profile is found in the shared credentials file in the default location unregister it. - - - If ProfilesLocation is null or empty and the platform doesn't support the .NET SDK credentials file - search the shared credentials file in the default location. If the profile is found in the - shared credentials file in the default location unregister it. - - - The name of the profile to unregister. - - - - Interface to define the necessary operations for a CredentialProfile lookup mechanism. - - - - - Get the profile with the given name, if one exists. - - The name of the profile to get. - The profile, if it was found, null otherwise. - True if the profile was found, false otherwise. - - - - Interface to define the necessary operations for a CredentialProfile storage mechanism. - - - - - Rename the profile with oldProfileName to newProfileName. - - The profile to rename. - The new name for the profile. - - - - Rename the profile with oldProfileName to newProfileName. - - The profile to rename. - The new name for the profile. - If true and the destination profile exists it will be overwritten. - - - - Make a copy of the profile with fromProfileName called toProfileName. - - The name of the profile to copy from. - The name of the new profile. - - - - Make a copy of the profile with fromProfileName called toProfileName. - - The name of the profile to copy from. - The name of the new profile. - If true and the destination profile exists it will be overwritten. - - - - Add the given profile to the store, or update it if one with the same name already exists. - - - - - - Delete the profile with profileName if it exists. - - The name of the profile to delete. - - - - Get a list of valid profile names from this store. - Invalid profiles are ignored. - See for more information - about valid profiles. - - - - - - Get a list of valid profiles from this store. - Invalid profiles are ignored. - See for more information - about valid profiles. - - - - - - This class allows profiles supporting AWSCredentials to be registered with - the SDK so that they can later be reference by a profile name. The credential profiles will be available - for use in the AWS Toolkit for Visual Studio and the AWS Tools for Windows PowerShell. - - The credentials are stored under the current users AppData folder encrypted using Windows Data Protection API. - - - This class is not threadsafe. - - - - - - Get the profile with the name given, if it exists in this store. - - The name of the profile to find. - The profile, if it was found, null otherwise - True if the profile was found, false otherwise. - - - - Add the profile to this store, if it's valid. - - The profile to add. - - - - If there is a profile in the store with the given name, delete it. - - The name of the profile to delete. - - - - Rename the profile with oldProfileName to newProfileName. - - The profile to rename. - The new name for the profile. - - - - Rename the profile with oldProfileName to newProfileName. - - The profile to rename. - The new name for the profile. - If true and the destination profile exists it will be overwritten. - - - - Make a copy of the profile with fromProfileName called toProfileName. - - The name of the profile to copy from. - The name of the new profile. - - - - Make a copy of the profile with fromProfileName called toProfileName. - - The name of the profile to copy from. - The name of the new profile. - If true and the destination profile exists it will be overwritten. - - - - Set the ProfileType field to maintain backward compatibility with ProfileManager. - The value is ignored when it's read back in. - - - - - - - Provides access to read and write to the shared credentials INI file. - The file is read, parsed, and validated at construction time. - Changes can be made using the RegisterProfile() and - UnregisterProfile() methods. - - This class is not threadsafe. - - - - - To maintain compatibility with the CLI, - SharedCredentialsFile doesn't support the SAML profileTypes. - - - - - Construct a new SharedCredentialsFile in the default location. - - - - - Construct a new SharedCredentialsFile. - - The path of the shared credentials file. - - - - Add the profile given. If the profile already exists, update it. - - The profile to be written. - - - - Update the profile on disk regardless of the profile type. - - - - - - Deletes the section with the given ProfileName from the SharedCredentialsFile, if one exists. - - The ProfileName of the section to delete. - - - - Rename the profile with oldProfileName to newProfileName. - - The profile to rename. - The new name for the profile. - - - - Rename the profile with oldProfileName to newProfileName. - - The profile to rename. - The new name for the profile. - If true and the destination profile exists it will be overwritten. - - - - Make a copy of the profile with fromProfileName called toProfileName. - - The name of the profile to copy from. - The name of the new profile. - - - - Make a copy of the profile with fromProfileName called toProfileName. - - The name of the profile to copy from. - The name of the new profile. - If true and the destination profile exists it will be overwritten. - - - - Try to get a profile that may be partially in the credentials file and partially in the config file. - If there are identically named properties in both files, the properties in the credentials file take precedence. - - - - - - - - Anonymous credentials. - Using these credentials, the client does not sign the request. - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - AWS Credentials that automatically refresh by calling AssumeRole on - the Amazon Security Token Service. - - - - - The credentials of the user that will be used to call AssumeRole. - - - - - The Amazon Resource Name (ARN) of the role to assume. - - - - - An identifier for the assumed role session. - - - - - Options to be used in the call to AssumeRole. - - - - - Constructs an AssumeRoleAWSCredentials object. - - The credentials of the user that will be used to call AssumeRole. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - - - - Constructs an AssumeRoleAWSCredentials object. - - The credentials of the user that will be used to call AssumeRole. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRole. - - - - A unique identifier that is used by third parties when assuming roles in their customers' accounts. - - - - - An IAM policy in JSON format. - - - - - The length of time in seconds before the credentials will expire. - - - - - The proxy settings to use when calling AssumeRole. - - - - - The identification number of the MFA device that is associated with the user who is making the assume-role call. - - - - - The value provided by the MFA device, if the trust policy of the role being assumed requires MFA. - - - - - A callback that's used to obtain the MFA token code when the AssumeRoleAWSCredentials are refreshed. - - - - - Immutable representation of AWS credentials obtained as a result of - authenticating with the AssumeRole method of the Security Token Service. - - - - - The expiry time of the credentials, obtained from the AssumeRoleResponse. - - - - - Constructs an instance with supplied keys, token, and expiration. - - The AccessKey for the credentials. - The SecretKey for the credentials. - The security token for the credentials. - The expiration time for the credentials. - - - - Get a copy of this AssumeRoleImmutableCredentials object. - - A copy of this object. - - - - Abstract class that represents a credentials object for AWS services. - - - - - Returns a copy of ImmutableCredentials - - - - - - Called by AmazonServiceClient to validate the credential state - on client construction. - - - - - Basic set of credentials consisting of an AccessKey and SecretKey - - - - - Constructs a BasicAWSCredentials object for the specified accessKey and secretKey. - - - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - When running in an ECS container and AWS_CONTAINER_CREDENTIALS_RELATIVE_URI is set, - use the given end point to retrieve the credentials. - - - - - These constants should not be consumed by client code. They are only relevant - in the context of ECS container and, especially, AWS_CONTAINER_CREDENTIALS_RELATIVE_URI - environment variable should not be overriden by the client code. - - - - If AWS_CONTAINER_CREDENTIALS_RELATIVE_URI environment variable is set, we want to attempt to retrieve credentials - using ECS endpoint instead of referring to instance profile credentials. - - - If AWS_CONTAINER_CREDENTIALS_RELATIVE_URI environment variable is set, we want to attempt to retrieve credentials - using ECS endpoint instead of referring to instance profile credentials. - - - - Immutable representation of AWS credentials. - - - - - Gets the AccessKey property for the current credentials. - - - - - Gets the SecretKey property for the current credentials. - - - - - Gets the Token property for the current credentials. - - - - - Gets the UseToken property for the current credentials. - Specifies if Token property is non-emtpy. - - - - - Constructs an ImmutableCredentials object with supplied accessKey, secretKey. - - - - Optional. Can be set to null or empty for non-session credentials. - - - - Returns a copy of the current credentials. - - - - - - Abstract class for automatically refreshing AWS credentials - - - - - Refresh state container consisting of credentials - and the date of the their expiration - - - - - Represents the current state of the Credentials. - - This can be cleared without synchronization. - - - - Semaphore to control thread access to GetCredentialsAsync method. - The semaphore will allow only one thread to generate new credentials and - update the current state. - - - - - The time before actual expiration to expire the credentials. - Property cannot be set to a negative TimeSpan. - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - Test credentials existence and expiration time - should update if: - credentials have not been loaded yet - it's past the expiration time. At this point currentState.Expiration may - have the PreemptExpiryTime baked into to the expiration from a call to - UpdateToGeneratedCredentials but it may not if this is new application load. - - - - - When overridden in a derived class, generates new credentials and new expiration date. - - Called on first credentials request and when expiration date is in the past. - - - - - - When overridden in a derived class, generates new credentials and new expiration date. - - Called on first credentials request and when expiration date is in the past. - - - - - - Clears currently-stored credentials, forcing the next GetCredentials call to generate new credentials. - - - - - Immutable representation of AWS credentials obtained as a result of - authenticating against a SAML-supporting federated identity provider. - - - - - The expiry time of the credentials, obtained from the AssumeRoleWithSAML response. - - - - - The value of the NameID element in the Subject element of the SAML assertion, as returned in the - AssumeRoleWithSAML response from the Security Token Service. - - - - - Constructs an instance with supplied keys and SAML assertion data. - - - - - - - - - - Constructs an instance with supplied keys and SAML assertion data. - - - - - - - - Returns a copy of the current credentials. - - - - - - Serializes the instance to a json-format string for external storage - - The serialized object in json - - - - Instantiates an instance from persisted json data - - The serialized data - Deserialized instance corresponding to the json data - - - - Session credentials consisting of AccessKey, SecretKey and Token - - - - - Constructs a SessionAWSCredentials object for the specified accessKey, secretKey. - - - - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - AWS Credentials that automatically refresh by calling AssumeRole on - the Amazon Security Token Service. - - - - - As established by STS, the regex used to validate the role session names is a string of 2-64 characters consisting of - upper- and lower-case alphanumeric characters with no spaces. You can also include - underscores or any of the following characters: =,.@- - - - - - Options to be used in the call to AssumeRole. - - - - - The absolute path to the file on disk containing an OIDC token - - - - - The Amazon Resource Name (ARN) of the role to assume. - - - - - An identifier for the assumed role session. - - - - - Constructs an AssumeRoleWithWebIdentityCredentials object. - - The absolute path to the file on disk containing an OIDC token. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - - - - Constructs an AssumeRoleWithWebIdentityCredentials object. - - The absolute path to the file on disk containing an OIDC token. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRole. - - - - Creates an instance of from environment variables. - - Throws an if the needed environment variables are not set. - The new credentials. - - - - Gets a client to be used for AssumeRoleWithWebIdentity requests. - - The STS client. - - - - Options for using a credentials object to make AssumeRoleWithWebIdentity calls. - - - - - Gets and sets the property DurationSeconds. - - The duration, in seconds, of the role session. The value can range from 900 seconds - (15 minutes) up to the maximum session duration setting for the role. This setting - can have a value from 1 hour to 12 hours. If you specify a value higher than this - setting, the operation fails. For example, if you specify a session duration of 12 - hours, but your administrator set the maximum session duration to 6 hours, your operation - fails. To learn how to view the maximum value for your role, see View - the Maximum Session Duration Setting for a Role in the IAM User Guide. - - - - By default, the value is set to 3600 seconds. - - - - The DurationSeconds parameter is separate from the duration of a console - session that you might request using the returned credentials. The request to the - federation endpoint for a console sign-in token takes a SessionDuration - parameter that specifies the maximum length of the console session. For more information, - see Creating - a URL that Enables Federated Users to Access the AWS Management Console in the - IAM User Guide. - - - - - - - Gets and sets the property ProviderId. - - The fully qualified host component of the domain name of the identity provider. - - - - Specify this value only for OAuth 2.0 access tokens. Currently www.amazon.com - and graph.facebook.com are the only supported identity providers for - OAuth 2.0 access tokens. Do not include URL schemes and port numbers. - - - - Do not specify this value for OpenID Connect ID tokens. - - - - - - Gets and sets the property Policy. - - An IAM policy in JSON format that you want to use as an inline session policy. - - - - This parameter is optional. Passing policies to this operation returns new temporary - credentials. The resulting session's permissions are the intersection of the role's - identity-based policy and the session policies. You can use the role's temporary credentials - in subsequent AWS API calls to access resources in the account that owns the role. - You cannot use session policies to grant more permissions than those allowed by the - identity-based policy of the role that is being assumed. For more information, see - Session - Policies in the IAM User Guide. - - - - The plain text that you use for both inline and managed session policies shouldn't - exceed 2048 characters. The JSON policy characters can be any ASCII character from - the space character to the end of the valid character list (\u0020 through \u00FF). - It can also include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D) - characters. - - - - The characters in this parameter count towards the 2048 character session policy guideline. - However, an AWS conversion compresses the session policies into a packed binary format - that has a separate limit. This is the enforced limit. The PackedPolicySize - response element indicates by percentage how close the policy is to the upper size - limit. - - - - - - - Gets and sets the property PolicyArns. - - The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use - as managed session policies. The policies must exist in the same account as the role. - - - - This parameter is optional. You can provide up to 10 managed policy ARNs. However, - the plain text that you use for both inline and managed session policies shouldn't - exceed 2048 characters. For more information about ARNs, see Amazon - Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference. - - - - The characters in this parameter count towards the 2048 character session policy guideline. - However, an AWS conversion compresses the session policies into a packed binary format - that has a separate limit. This is the enforced limit. The PackedPolicySize - response element indicates by percentage how close the policy is to the upper size - limit. - - - - Passing policies to this operation returns new temporary credentials. The resulting - session's permissions are the intersection of the role's identity-based policy and - the session policies. You can use the role's temporary credentials in subsequent AWS - API calls to access resources in the account that owns the role. You cannot use session - policies to grant more permissions than those allowed by the identity-based policy - of the role that is being assumed. For more information, see Session - Policies in the IAM User Guide. - - - - - - The proxy settings to use when calling AssumeRoleWithWebIdentity. - - This parameter is optional. - - - - - - InstanceProfileAWSCredentials allows configuring Roles and every instance hits IMDS individually. - This class has a singleton timer task that caches instance profile credentials every 2 minutes. - - - - - Returns a copy of the most recent instance profile credentials. - - - - - Returns a copy of the most recent instance profile credentials. - - - - - Dispose this object and all related resources. - - - - - Uses aws credentials stored in environment variables to construct the credentials object. - AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY are used for the access key id and secret key. - If the variable AWS_SESSION_TOKEN exists then it will be used to create temporary session - credentials. - - - For backwards compatibility the class will also attempt to discover the secret key from - the AWS_SECRET_KEY variable, if a value cannot be obtained using the standard - AWS_SECRET_ACCESS_KEY variable. - - - - - Constructs an instance of EnvironmentVariablesAWSCredentials. If no credentials are found in - the environment variables then an InvalidOperationException is thrown. - - - - - Creates immutable credentials from environment variables. - - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - Credentials that are retrieved from the Instance Profile service on an EC2 instance - - - - - Role for which the credentials are retrieved - - - - - Constructs a InstanceProfileAWSCredentials object for specific role - - Role to use - - - - Constructs a InstanceProfileAWSCredentials object for specific role - - Role to use - - - - Constructs a InstanceProfileAWSCredentials object for the first found role - - - - - Constructs a InstanceProfileAWSCredentials object for the first found role - - - - - Retrieves a list of all roles available through current InstanceProfile service - - - - - - Retrieves a list of all roles available through current InstanceProfile service - - - - - - Return true if string is null or whitespace, false otherwise. - We can't use String.IsNullOrWhitespace because it doesn't exist - in all frameworks we support. - - - - - - - Process Credentials can retrieve credentials by running a process and reading its stdout. - A new config option, "credential_process" is added to the shared config file that allows customers - to specify which process to run. The credentials retrieved by running this process could be either - Basic or Session credentials. - - - - - Generates new credentials by running the "credential_process" process. - - - - - Exception class to capture all exceptions encountered when starting or - executing the "credential_process" process. If the user has specified an executable - and the SDK is unable to execute it, the exception should be surfaces to the user - instead of moving on to the next credential provider. - - - - - - Credentials that are retrieved using a stored profile. - - - Unless otherwise specified priority is given to loading credentials from the SDK credential store - file which is shared between the SDK, PowerShell CLI and Toolkit. Credentials in profiles in this - file are encrypted and can only be used by the user account on the current machine that stored the - profile. Credentials can also be loaded from the plain-text ini-format credential file which is - shared with other AWS SDKs. This file is expected to exist in a '.aws' folder in the user's home - directory but alternate locations can be specified using either the AWSProfilesLocation setting in - the application configuration file, or by using the AWS_SHARED_CREDENTIALS_FILE environment variable. - - - The profile name can be specified in the App.config using the AWSProfileName setting. - - - - - - Constructs an instance for credentials stored in a profile. This constructor searches for credentials - using the account name specified using the AWSProfileName setting, if set, in the application configuration - file. If the configuration file setting is not set the SDK will attempt to locate a profile with the name - 'default'. - - - - - Constructs an instance for credentials stored in a profile with the specified name. The SDK will - check the SDK credential store file first before looking for the shared ini-format credentials - file unless the application configuration file contains a setting for the 'AWSProfilesLocation' - indicating the search should be constrained to the shared credentials file at the specified - location. - - The name of the profile in which the credentials were stored. - - - - Constructs an instance for credentials stored in a profile with the specified name. - - The profile name to search for credentials for - - Optional; instructs the SDK to check for the profile in the shared credentials file at the - specified location. If not set, the SDK will inspect its own credential store file first before - attempting to locate a shared credential file using either the default location beneath the user's - home profile folder or the location specified in the AWS_SHARED_CREDENTIALS_FILE environment - variable. - - - If credential materials cannot be read or are invalid due to missing data an InvalidDataException - is thrown. If no credentials can be located with the specified profile name, an ArgumentException - is thrown. - - - - - Name of the profile being used. - - - - - Location of the profiles, if used. - - - - - Tests if a profile has been registered in either the SDK store or the specified credential - file. - - The name of the profile to test - - Optional; instructs the SDK to check for the profile in the shared credentials file at the - specified location. If not set, the SDK will inspect its own credential store file first before - attempting to locate a shared credential file using either the default location beneath the user's - home profile folder or the location specified in the AWS_SHARED_CREDENTIALS_FILE environment - variable. - - True if a profile with the specified name has been registered. - - - - Tests if an instance can be created from the persisted profile data. - If profilesLocation is null/empty, the SDK store is searched for the - profile data before probing for the profile in the shared the ini-format - credential file. - - The name of the profile to test - - If null/empty, the SDK store is searched for the named profile otherwise - the ini-format credential file at the specified location is inspected. - - True if the persisted data would yield a valid credentials instance. - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - Helper routiners for AWS and Federated credential profiles. Probes the - profile type for the supplied profile name and returns the appropriate profile - instance. - - - - - Determines the type of the requested profile and returns the - appropriate profile instance. - - The name of the profile (AWS or federated) to be loaded. - Instantiated profile type. - - - - Determines the type of the requested profile and returns the - appropriate profile instance. - - The name of the profile (AWS or federated) to be loaded. - - The location of the shared credentials (.ini) file, for profiles that are not stored in the - SDK credential store. - - Instantiated profile type. - - - - Probes for and returns the fully qualified name of the shared ini-format credentials - file. - - - Contains the file or folder name of the credential file. If not specified, the - routine will first check the application configuration file for a setting indicating - the file location or filename. If the configuration file does not yield a credential - file location then an environment variable is examined. Finally the routine will - inspect the fallback default location beneath the user's home folder location. - - - The fully qualified name to the credential file that was located, or null - if no credential file could be found. - - - - - Determines the endpoint discovery enabled value based on an environment variable. If no value is found in the - environment then an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of EnvironmentVariable AWS_ENABLED_ENDPOINT_DISCOVERY. If no value is found in the - environment then an InvalidOperationException is thrown. - - - - - Determines endpoint discovery enabled based on a stored in an . - If the profile doesn't exist or there is no endpoint discovery enabled information an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of . - If the AWS_PROFILE environment variable is set the instance will be constructed using that profile, - otherwise it will use the default profile. - - If the profile doesn't exist or there is no endpoint discovery enabled information an InvalidOperationException is thrown. - - The ICredentialProfileSource to read the profile from. - - - - Attempts to construct an instance of . - If the profile doesn't exist or there is no endpoint discovery enabled information an InvalidOperationException is thrown. - - The ICredentialProfileSource to read the profile from. - The name of the profile. - - - - Probing mechanism to determine the endpoint discovery enabled value from various sources. - - - - - The valid hashing algorithm supported by the sdk for request signing. - - - - - Which end of a request was responsible for a service error response. - - - - - The sender was responsible for the error, i.e. the client - request failed validation or was improperly formatted. - - - - - The error occured within the service. - - - - - An unrecognized error type was returned. - - - - - Sts Regional Endpoints Value determines whether or not - to send the sts request to the regional endpoint or to - the global sts endpoint - - - - - Send the request to the global sts endpoint - if the region is a legacy global region - - - - - Send the request to the regional endpoint - - - - - S3 US East 1 endpoint value determines wheter or not - to send the us-east-1 s3 requests to the regional endpoint or to - the legacy global endpoint - - - - - Sends the requests to the legacy global s3 endpoint for us-east-1 - - - - - Sends the request to the regional s3 endpoint for us-east-1 - - - - - RetryMode determines which request retry mode is used for requests that do - not complete successfully. - - - - - Legacy request retry strategy. - - - - - Standardized request retry strategy that is consistent across all SDKs. - - - - - An experimental request retry strategy that builds on the Standard strategy - and introduces congestion control through client side rate limiting. - - - - - Superclass for Exceptions that come over the event stream, or to wrap other kinds of generic exceptions. - - - - - The numeric code identifier for the type of error. - - - - - Constructs an EventStreamError. - - - - - Constructs an EventStreamError. - - The error code. - The error message. - - - - Event args that contain an . - - The - - - - The EventStream Event. - - - - - Constructs an EventStreamEventReceivedArgs. - - The EventStream Event. - - - - Event args that contain an . - - The . - - - - The EventStream Exception. - - - - - Constructs an EventStreamExceptionReceivedArgs. - - The EventStream Exception. - - - - Supported Header types for vnd.amazon.event-stream - - - - - Name for the Header. Maximum of 255 bytes. - - - - - Header type id - - - - - Computes the amount of memory neccesary to serialize this Header. - - - - - Writes this Header to buffer starting at offset - Keep in mind, this API assumes buffer is large enough - for the operation. - - buffer to serialize this Header to - offset to begin writing at. - - the new offset. - - - - - Returns the current value as a bool - - - - - Sets the current value - - - - - Returns the current value as a byte - - - - - Sets the current value - - - - - Gets the current value as a 16 bit integer. (Host Order). - - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a 32 bit integer. (Host Order) - - - - - Sets the current value - - - - - returns the current value as a 64-bit integer. (Host Order) - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a byte buffer. - - - - - - Sets the current value. Max length is 2^15 - 1 - - - - - Returns the current value as a utf-8 string. - - - - - Sets the current value. Utf-8 encoded. Max byte size is 2^16 - 1 - - - - - Gets the current value as a DateTime. - Note: You do not need to compensate for unix epoch on this API. - - - - - - Sets the current value. - Note: You do not need to compensate for unix epoch on this API. - - - - - Returns the current value as a Guid (UUID) - - - - - Sets the current value - - - - - Header Data for an EventStreamMessage - - Each header is of format: - [name len] (1) | [utf-8 name] (v) - [type (1)] - [value (v)] - - - - - Name for the Header. Maximum of 255 bytes. - - - - - Header type id - - - - - Initializes this Header with name. - - utf-8 string, max length is 255 - - - - Deserializes the header in buffer. - - buffer constaining the header - index to start from in the buffer. - updated offset with new value for offset - - - - Writes this Header to buffer starting at offset - Keep in mind, this API assumes buffer is large enough - for the operation. - - buffer to serialize this Header to - offset to begin writing at. - - the new offset. - - - - - Computes the amount of memory neccesary to serialize this Header. - - - - - Returns the current value as a bool - - - - - Sets the current value - - - - - Returns the current value as a byte - - - - - Sets the current value - - - - - Gets the current value as a 16 bit integer. (Host Order). - - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a 32 bit integer. (Host Order) - - - - - Sets the current value - - - - - returns the current value as a 64-bit integer. (Host Order) - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a byte buffer. - - - - - - Sets the current value. Max length is 2^15 - 1 - - - - - Returns the current value as a utf-8 string. - - - - - Sets the current value. Utf-8 encoded. Max byte size is 2^16 - 1 - - - - - Gets the current value as a DateTime. - Note: You do not need to compensate for unix epoch on this API. - - - - - - Sets the current value. - Note: You do not need to compensate for unix epoch on this API. - - - - - Returns the current value as a Guid (UUID) - - - - - Sets the current value - - - - - Headers for the message. Can be null. - - - - - Payload for the message. Can be null. - - - - - Converts a message into a byte buffer (usually for network transmission). - - - - - Message is a single datagram. The format is as follows: - [ total length (4) ] | [ headers_length (4)] | [ prelude crc(4)] - [ headers (v)] - [ payload (v)} - [ trailing crc ] - - CRCs use the CRC32 algorithm. - - - - - Content type for EventStreams. - - - - - Headers for the message. Can be null. - - - - - Payload for the message. Can be null. - - - - - Initialize a message with headers and a payload. - - list of headers for the message, can be null. - payload for the message, can be null. - - - - Builds a message from buffer. - - buffer to read - offset to start reading - buffer length. - - parsed instance of EventStreamMessage. Doesn't return null, - does throw if CRCs don't match. - - - - - Converts a message into a byte buffer (usually for network transmission). - - - - - Defines exceptions that arise from an not conforming to specification. - - - - - Constructs an EventStreamValidationException. - - - - - Constructs an EventStreamValidationException. - - The exception message. - - - - Constructs an EventStreamValidationException. - - The exception message. - The inner exception. - - - - The contract for the . - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - A subclass of that enables an enumerable interface for interacting with Events. - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - Flag if the stream was chosen to be enumerated. - - - - - A Stream of Events. Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treated as mutually exclusive. - - - - - A Stream of Events. Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treated as mutually exclusive. - - - - - Returns an enumerator that iterates through the collection. - - An enumerator that can be used to iterate through the collection. - - - - Returns an enumerator that iterates through a collection. - - An object that can be used to iterate through the collection. - - - - Starts the background thread to start reading events from the network stream. - - - - - The contract for the . - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - The size of the buffer for reading from the network stream. - - - - - Fires when an event is received. - - - - - Fired when an exception or error is raised. - - - - - Starts the background thread to start reading events from the network stream. - - - - - The superclass for all EventStreams. It contains the common processing logic needed to retreive events from a network Stream. It - also contains the mechanisms needed to have a background loop raise events. - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - "Unique" key for unknown event lookup. - - - - - Header key for message type. - - - - - Header key for event type. - - - - - Header key for exception type. - - - - - Header key for error code. - - - - - Header key for error message. - - - - - Value of when the message is an event. - - - - - Value of when the message is an exception. - - - - - Value of when the message is an error. - - - - - The size of the buffer for reading from the network stream. - Default is 8192. - - - - - The underlying stream to read events from. - - - - - Responsible for decoding events from sequences of bytes. - - - - - Fires when an event is recieved. - - - - - Fired when an exception or error is raised. - - - - - The mapping of event message to a generator function to construct the matching Event Stream event. - - - - - The mapping of event message to a generator function to construct the matching Event Stream exception. - - - - - Whether the Stream is currently being processed. - - - - - A Stream of Events. Events can be retrieved from this stream by attaching handlers to listen events, and then calling StartProcessing. - - - - - A Stream of Events. Events can be retrieved from this stream by attaching handlers to listen events, and then calling StartProcessing. - - - - - Converts an EventStreamMessage to an event. - - The event stream message to be converted. - The event - - - - Abstraction for cross-framework initiation of the background thread. - - - - - The background thread main loop. It will constantly read from the network stream until IsProcessing is false, or an error occurs. - - This stub exists due to FXCop. - - - - - The background thread main loop. It will constantly read from the network stream until IsProcessing is false, or an error occurs. - - Needed for 3.5 support. Not used. - - - - Reads from the stream into the buffer. It then passes the buffer to the decoder, which raises an event for - each message it decodes. - - The buffer to store the read bytes from the stream. - - - - Wraps exceptions in an outer exception so they can be passed to event handlers. If the Exception is already of a compatable type, - the method returns what it was given. - - The exception to wrap. - An exception of type TE - - - - Starts the background thread to start reading events from the network stream. - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Disposes the resources of this stream. - - Should dispose of unmanged resources. - - - - Event Arguments for EventStreamDecoder.MessageReceived. - - - - - Received message. - - - - - Additional object context - - - - - Initialize this with message - - - - - Initialize this with message and object conetext - - - - - Exception thrown when a request is made of the Decoder, but the internal state - machine is an invalid state. This is usually the result of an interanl exception - being thrown during parsing of the network stream. - - - - - Contract for EventStreamDecoder - - - - - Invoked anytime an EventStreamMessage is found. - - - - - Processes data starting at offset up to length. - Invokes MessageRecieved for each message encountered. - If an exception is thrown, this object is not safe for reuse. - - buffer to read - offset in buffer to start reading. - length of data. - - - - Streaming decoder for listening for incoming EventStreamMessage datagrams. - - - - - Invoked anytime an EventStreamMessage is found. - - - - - Object data (optional) that can be passed to the event handler for MessageReceived. - - - - - Default constructor. Initializes internal _state machine. - - - - - Processes data starting at offset up to length. - Invokes MessageRecieved for each message encountered. - If an exception is thrown, this object is not safe for reuse. - - buffer to read - offset in buffer to start reading. - length of data. - - - - Superclass for Exceptions that come over the event stream, or to wrap other kinds of generic exceptions. - - - - - Constructs an EventStreamException. - - - - - Constructs an EventStreamException. - - The exception message. - - - - Constructs an EventStreamException. - - The exception message. - The inner exception. - - - - The contract for EventStream events. - - - - - The contract for EventStream terminal events. - - - - - This Event is returned if an event is retrieved from the event stream, but a generator function - for the event is not defined. This can occur if the SDK is not updated after a new event type is introduced. - - - - - The Message recieved from the event stream before conversion. - - - - - The event type. - - - - - Constructs an UnknownEventStreamEvent. - - - - - Constructs an UnknownEventStreamEvent. - - The Message recieved from the event stream before conversion. - The event type. - - - - Signals that an an has an unknown message type. These exceptions whould be - swallowed to allow future expansion of the EventStream specification without breaking existing clients. - - - - - Constructs an UnknownEventStreamMessageTypeException. - - - - - This exception is thrown if an exception is retrieved from the event stream and should be modeled, - but a generator function for the strongly-typed exception is not defined. - - - - - The exception type. - - - - - Constructs an EventStreamException. - - The exception type. - - - - All Amazon service interfaces like IAmazonS3 extend from this interface. This allows all the - Amazon service interfaces be identified by this base interface and helps with generic constraints. - - - - - A readonly view of the configuration for the service client. - - - - - This interface is the read only access to the ClientConfig object used when setting up service clients. Once service clients - are initiated the config object should not be changed to avoid issues with using a service client in a multi threaded environment. - - - - - Gets the RegionEndpoint property. The region constant to use that - determines the endpoint to use. If this is not set - then the client will fallback to the value of ServiceURL. - - - - - The constant used to lookup in the region hash the endpoint. - - - - - Gets and sets of the ServiceURL property. - This is an optional property if you need to set a specific service URL - instead setting the region with the RegionEndpoint property. - - - - - Gets the UseHttp property. - If this property is set to true, the client attempts - to use HTTP protocol. - By default, this property is set to false. - - - - - Gets Service Version - - - - - Gets the signatureMethod property. - - - - - Gets the SignatureVersion property. - - Note: This property exists for backward compatibility but is no longer - used by any service other than S3. - - - - - Gets the AuthenticationRegion property. - Used in AWS4 request signing, this is an optional property; - change it only if the region cannot be determined from the - service endpoint. - - - - - Gets the AuthenticationServiceName property. - Used in AWS4 request signing, this is the short-form - name of the service being called. - - - - - Gets the UserAgent property. - - - - - Gets the DisableLogging. If true logging for this client will be disabled. - - - - - Flag on whether to log metrics for service calls. - - This can be set in the application's configs, as below: - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSLogMetrics" value"true"/> - </appSettings> - </configuration> - - - - - - Gets the LogResponse property. - If this property is set to true, the service response - is read in its entirety and logged. - - - - - Gets the ReadEntireResponse. - If this property is set to true, the service response - is read in its entirety before being processed. - - - - - This flag controls if .NET HTTP infrastructure should follow redirection - responses (e.g. HTTP 307 - temporary redirect). - - - - - Gets the BufferSize property. - The BufferSize controls the buffer used to read in from input streams and write - out to the request. - - - - - Returns the flag indicating how many retry HTTP requests an SDK should - make for a single SDK operation invocation before giving up. This flag will - return 4 when the RetryMode is set to "Legacy" which is the default. For - RetryMode values of "Standard" or "Adaptive" this flag will return 2. In - addition to the values returned that are dependant on the RetryMode, the - value can be set to a specific value by using the AWS_MAX_ATTEMPTS environment - variable, max_attempts in the shared configuration file, or by setting a - value directly on this property. When using AWS_MAX_ATTEMPTS or max_attempts - the value returned from this property will be one less than the value entered - because this flag is the number of retry requests, not total requests. To - learn more about the RetryMode property that affects the values returned by - this flag, see . - - - - - Determines if MaxErrorRetry has been manually set. - - - - - Gets the interval at which progress update events are raised - for upload operations. By default, the progress update events are - raised at every 100KB of data transferred. - - - - - Flag on whether to resign requests on retry or not. - - - - - Credentials to use with a proxy. - - - - - Gets the default request timeout value. - - - - If the value is set, the value is assigned to the Timeout property of the HTTPWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - - - - Configures the endpoint calculation for a service to go to a dual stack (ipv6 enabled) endpoint - for the configured region. - - - Note: AWS services are enabling dualstack endpoints over time. It is your responsibility to check - that the service actually supports a dualstack endpoint in the configured region before enabling - this option for a service. - - - - - Configures a flag enabling to either opt in or opt out of the retry throttling service. - Note: set value to true to enable retry throttling feature. The Default value for this flag is false. - - - - - Using either the RegionEndpoint or the ServiceURL determine what the URL to the service is. - - The URL to the service. - - - - Performs validation on this config object. - Throws exception if any of the required values are missing/invalid. - - The timeout specified is null. - - - - Returns the clock skew adjusted utc now. This value is affected by AWSConfigs.ManualClockCorrection - - - - - Returns the calculated clock skew value for this config's service endpoint. If AWSConfigs.CorrectForClockSkew is false, - this value won't be used to construct service requests. - - - - - Gets the DisableHostPrefixInjection flag. If true, host prefix injection will be disabled for this client, the default value of this flag is false. - Host prefix injection prefixes the service endpoint with request members from APIs which use this feature. - Example: for a hostPrefix of "foo-name." and a endpoint of "service.region.amazonaws.com" the default behavior is to - prefix the endpoint with the hostPrefix resulting in a final endpoint of "foo-name.service.region.amazonaws.com". Setting - DisableHostPrefixInjection to true will disable hostPrefix injection resulting in a final endpoint of - "service.region.amazonaws.com" regardless of the value of hostPrefix. E.g. You may want to disable host prefix injection for testing against a local mock endpoint. - - - - - Returns the flag indicating if endpoint discovery should be enabled or disabled for operations that are not required to use endpoint discovery. - - - - - Returns the maximum number of discovered endpoints that can be stored within the cache for the client. The default limit is 1000 cache entries. - - - - - Returns the flag indicating the current mode in use for request - retries and influences the value returned from . - The default value is RequestRetryMode.Legacy. This flag can be configured - by using the AWS_RETRY_MODE environment variable, retry_mode in the - shared configuration file, or by setting this value directly. - - - - - Under Adaptive retry mode, this flag determines if the client should wait for - a send token to become available or don't block and fail the request immediately - if a send token is not available. - - - - - Get the value to use for on requests. - If this property is null, - will be left at its default value of . - - - - - - This is a switch used for performance testing and is not intended for production applications - to change. This switch may be removed in a future version of the SDK as the .NET Core platform matures. - - - If true, the HttpClient is cached and reused for every request made by the service client - and shared with other service clients. - - - For the .NET Core platform this is default to true because the HttpClient manages the connection - pool. - - - - - - If CacheHttpClient is set to true then HttpClientCacheSize controls the number of HttpClients cached. - - - - - Gets the ProxyHost property. - - - - - Gets the ProxyPort property. - - - - - Returns a WebProxy instance configured to match the proxy settings - in the client configuration. - - - - - - Interface for a single logged message. - - - - - Log message format. - - - - - Log message arguments. - - - - - Culture-specific formatting provider. - - - - - Abstract parameter value. - - - - - String parameter value. - - - - - String value of the parameter. - - - - - Constructs ParameterValue for a single string. - - - - - - String list parameter value. - - - - - List of strings value of the parameter. - - - - - Constructs ParameterValue for a list of strings. - - - - - - The interface for an exception handler. - - - - - Handles an exception for the given execution context. - - The execution context, it contains the - request and response context. - The exception to handle. - - Returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception to replace the original exception. - - - - - The interface for an exception handler with a generic parameter for the exception type. - - The exception type. - - - - Handles an exception for the given execution context. - - The execution context, it contains the - request and response context. - The exception to handle. - - Returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception to replace the original exception. - - - - - The interface for a HTTP request factory. - - The type used by the underlying HTTP API to represent the request body. - - - - Creates an HTTP request for the given URI. - - The request URI. - An HTTP request. - - - - The interface for an HTTP request that is agnostic of the underlying HTTP API. - - The type used by the underlying HTTP API to represent the HTTP request content. - - - - The HTTP method or verb. - - - - - The request URI. - - - - - Configures a request as per the request context. - - The request context. - - - - Sets the headers on the request. - - A dictionary of header names and values. - - - - Gets a handle to the request content. - - The request content. - - - - Returns the HTTP response. - - The HTTP response. - - - - Writes a stream to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - The request context. - - - - Writes a byte array to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - - - - Sets up the progress listeners - - The content stream - The interval at which progress needs to be published - The objects which is trigerring the progress changes - The callback which will be invoked when the progress changed event is trigerred - an object, incase the progress is setup, else returns the original stream - - - - Aborts the HTTP request. - - - - - Gets a handle to the request content. - - - - - - Returns the HTTP response. - - A cancellation token that can be used to cancel the asynchronous operation. - - - - - A factory which creates HTTP clients. - - - - - Create and configure an HttpClient. - - - - - - If true the SDK will internally cache the clients created by CreateHttpClient. - If false the sdk will not cache the clients. - Override this method to return false if your HttpClientFactory will handle its own caching - or if you don't want clients to be cached. - - - - - - - Determines if the SDK will dispose clients after they're used. - If HttpClients are cached, either by the SDK or by your HttpClientFactory, this should be false. - If there is no caching then this should be true. - - - - - - - Returns a string that's used to group equivalent HttpClients into caches. - This method isn't used unless UseSDKHttpClientCaching returns true; - - A null return value signals the SDK caching mechanism to cache HttpClients per SDK client. - So when the SDK client is disposed, the HttpClients are as well. - - A non-null return value signals the SDK that HttpClients created with the given clientConfig - should be cached and reused globally. ClientConfigs that produce the same result for - GetConfigUniqueString will be grouped together and considered equivalent for caching purposes. - - - - - - - A factory which creates HTTP requests which uses System.Net.Http.HttpClient. - - - - - The constructor for HttpRequestMessageFactory. - - Configuration setting for a client. - - - - Creates an HTTP request for the given URI. - - The request URI. - An HTTP request. - - - - Disposes the HttpRequestMessageFactory. - - - - - Dispose the factory - - - - - - Create and configure a managed HttpClient instance. - The use of HttpClientHandler in the constructor for HttpClient implicitly creates a managed HttpClient. - If a native HttpClient is required the SDK user must implement IHttpClientFactory and provide an - instance via IClientConfig.HttpClientFactory (only available in PCL). - - - - - - - A cache of HttpClient objects. The GetNextClient method does a round robin cycle through the clients - to distribute the load even across. - - - - - Constructs a container for a cache of HttpClient objects - - The HttpClient to cache - - - - Returns the next HttpClient using a round robin rotation. It is expected that individual clients will be used - by more then one Thread. - - - - - - Disposes the HttpClientCache. - - - - - Dispose the HttpClientCache - - - - - - HTTP request wrapper for System.Net.Http.HttpRequestMessage. - - - - - Set of content header names. - - - - - The constructor for HttpWebRequestMessage. - - The HttpClient used to make the request. - The request URI. - The service client config. - - - - The underlying HttpClient - - - - - The underlying HTTP web request. - - - - - The HTTP method or verb. - - - - - The request URI. - - - - - Configures a request as per the request context. - - The request context. - - - - Sets the headers on the request. - - A dictionary of header names and values. - - - - Gets a handle to the request content. - - The request content. - - - - Returns the HTTP response. - - The HTTP response. - - - - Aborts the HTTP request. - - - - - Returns the HTTP response. - - A cancellation token that can be used to cancel the asynchronous operation. - - - - - Writes a stream to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - The request context. - - - - Writes a byte array to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - - - - Gets a handle to the request content. - - - - - - Disposes the HttpWebRequestMessage. - - - - - - - - - - - Sets up the progress listeners - - The content stream - The interval at which progress needs to be published - The objects which is trigerring the progress changes - The callback which will be invoked when the progress changed event is trigerred - an object, incase the progress is setup, else returns the original stream - - - - Interface for a handler in a pipeline. - - - - - The logger used to log messages. - - - - - The inner handler which is called after the current - handler completes it's processing. - - - - - The outer handler which encapsulates the current handler. - - - - - Contains the processing logic for a synchronous request invocation. - This method should call InnerHandler.InvokeSync to continue processing of the - request by the pipeline, unless it's a terminating handler. - - The execution context which contains both the - requests and response context. - - - - Contains the processing logic for an asynchronous request invocation. - This method should call InnerHandler.InvokeSync to continue processing of the - request by the pipeline, unless it's a terminating handler. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - A retry policy specifies all aspects of retry behavior. This includes conditions when the request should be retried, - checks of retry limit, preparing the request before retry and introducing delay (backoff) before retries. - - - A retry policy specifies all aspects of retry behavior. This includes conditions when the request should be retried, - checks of retry limit, preparing the request before retry and introducing delay (backoff) before retries. - - - - - Maximum number of retries to be performed. - This does not count the initial request. - - - - - The logger used to log messages. - - - - - The standard set of throttling error codes - - - - - The standard set of timeout error codes to retry on. - - - - - List of AWS specific error codes which are returned as part of the error response. - These error codes will be retried. - - - - - The standard set of transient error, HTTP status codes to retry on. - 502 and 504 are returned by proxies. These can also be returned for - S3 accelerate requests which are served by CloudFront. - - - - - Set of web exception status codes to retry on. - - - - - This parameter serves as the value to the CapacityManager.Container datastructure. - Its properties include the available capacity left for making a retry request and the maximum - capacity size. - - - - - Checks if a retry should be performed with the given execution context and exception. - - The execution context which contains both the - requests and response context. - The exception thrown after issuing the request. - Returns true if the request should be retried, else false. The exception is retried if it matches with clockskew error codes. - - - - Returns true if the request is in a state where it can be retried, else false. - - The execution context which contains both the - requests and response context. - Returns true if the request is in a state where it can be retried, else false. - - - - Return true if the request should be retried for the given exception. - - The execution context which contains both the - requests and response context. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Checks if the retry limit is reached. - - The execution context which contains both the - requests and response context. - Return false if the request can be retried, based on number of retries. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called on a successful request response. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called before a retry request is initiated. The value - returned is True by default(retry throttling feature is disabled). - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called before a retry request is initiated. The value - returned is True by default(retry throttling feature is disabled). - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - - - - Virtual method that gets called before a retry request is initiated. The value - returned is True by default(retry throttling feature is disabled). - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - true if the error that will be retried is a throttling error - - - - This method uses a token bucket to enforce the maximum sending rate. - - The execution context which contains both the - requests and response context. - If the prior request failed, this exception is expected to be - the exception that occurred during the prior request failure. - - - - Determines if an AmazonServiceException is a throttling error - - The current exception to check. - true if it is a throttling error else false. - - - - Determines if an AmazonServiceException is a transient error that - should be retried. - - The current execution context - The current exception to check. - true if the exception is a transient error else false. - - - - Determines if the exception is a known timeout error code that - should be retried under the timeout error category. - - The current exception to check. - true if the exception is considered a timeout else false - - - - Checks if a retry should be performed with the given execution context and exception. - - The execution context which contains both the - requests and response context. - The exception throw after issuing the request. - Returns true if the request should be retried, else false. The exception is retried if it matches with clockskew error codes. - - - - This method uses a token bucket to enforce the maximum sending rate. - - The execution context which contains both the - requests and response context. - If the prior request failed, this exception is expected to be - the exception that occurred during the prior request failure. - - - - Return true if the request should be retried for the given exception. - - The execution context which contains both the - requests and response context. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - Metrics collected by the SDK on a per-request basis. - - - Each request made to an AWS service by the SDK can have metrics - collected and logged. This interface represents the collected - metrics for a request. The metrics include properties (i.e. request id - and other metadata), timings for each stage of the request, and counters. - - - - - Collection of properties being tracked - - - - - Timings for metrics being tracked - - - - - Counters being tracked - - - - - Whether metrics are enabled for the request - - - - - JSON representation of the current metrics - - JSON string - - - - Represents how long a phase of an SDK request took. - - - - - Whether the timing has been stopped - - - - - Elapsed ticks from start to stop. - If timing hasn't been stopped yet, returns 0. - - - - - Elapsed time from start to stop. - If timing hasn't been stopped yet, returns TimeSpan.Zero - - - - - User supplied type to perform metrics formatting. - - - - - Produce custom formatting for SDK metrics. - - - If defined, this method will be called for every request made by the SDK. - - An instance of IRequestMetrics produced by the SDK - formatted string representation of the metrics - - - - Predefined request metrics that are collected by the SDK. - - - - - Information about the request. - - - - - Gets and sets the RequestId property. - ID that uniquely identifies a request. Amazon keeps track of request IDs. If you have a question about a request, include the request ID in your correspondence. - - - - - ICoreAmazonKMS is not meant to be used directly. It defines Key Management Service - with basic .NET types and allows other services to be able to use the service as - a runtime dependency. This interface is implemented by the AmazonKeyManagementServiceClient - defined in the AWSSDK.KeyManagementService assembly. - - - - - The result of the GenerateDataKey and GenerateDataKeyAsync operations. - - - - - The plaintext for the data key. - - - - - The ciphertext for the data key. - - - - - ICoreAmazonS3 is not meant to use directly. It defines S3 with basic .NET types - and allows other services to be able to use S3 as a runtime dependency. This interface - is implemented by the AmazonS3Client defined in the S3 assembly. - - - ICoreAmazonS3 is not meant to use directly. It defines S3 with basic .NET types - and allows other services to be able to use S3 as a runtime dependency. This interface - is implemented by the AmazonS3Client defined in the S3 assembly. - - - - - Generate a presigned URL. - - - - - - - - - - Get all the object keys for the particular bucket and key prefix. - - - - - - - - - Upload an object from a stream. - - - - - - - - - - - Delete an object. - - - - - - - - - - Delete an object. - - - - - - - - - - Open a stream to an object in S3. - - - - - - - - - - Upload an object from a file path. - - - - - - - - - - - Download an object in S3 to a file path. - - - - - - - - - - - Set the ACL on the object to public readable. - - - - - - - - Check to see if the bucket exists and if it doesn't create the bucket. - - - - - - Check to see if the bucket exists. - - - - - - - ICoreAmazonSQS is not meant to use directly. It defines SQS with basic .NET types - and allows other services to be able to use SQS as a runtime dependency. This interface - is implemented by the AmazonSQSClient defined in the SQS assembly. - - - - - Get the attributes for the queue identified by the queue URL asynchronously. - - The queue URL to get attributes for. - A Task containing the result of a dictionary of attributes for the queue. - - - - Set the attributes on the queue identified by the queue URL asynchronously. - - The queue URL to set the attributues. - The attributes to set. - A Task - - - - ICoreAmazonSTS is not meant to be used directly. It defines Security Token - service with basic .NET types and allows other services to be able to use the service as - a runtime dependency. This interface is implemented by the AmazonSecurityTokenServiceClient - defined in the AWSSDK.SecurityToken assembly. - - - - - - This method is used internally to access the Amazon Security Token - service within other service assemblies. - Please use AmazonSecurityTokenServiceClient to access the Amazon Security Token - service instead. - - Use Amazon Security Token Service to assume a role. - - Proxy settings that are required for the HTTPS and STS calls made during the authentication/credential - generation process are supported and should have been configured on the STS ClientConfig instance - associated with the STS client instance exposing this interface. - - - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRole. - - - - - - This method is used internally to access the Amazon Security Token - service within other service assemblies. - Please use AmazonSecurityTokenServiceClient to access the Amazon Security Token - service instead. - - Use Amazon Security Token Service to assume a role. - - Proxy settings that are required for the HTTPS and STS calls made during the authentication/credential - generation process are supported and should have been configured on the STS ClientConfig instance - associated with the STS client instance exposing this interface. - - - The web identity token used to assume the role. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRoleWithWebIdentity - - - - - - This method is used internally to access the Amazon Security Token - service within other service assemblies. - Please use AmazonSecurityTokenServiceClient to access the Amazon Security Token - service instead. - - Use Amazon Security Token Service to assume a role. - - Proxy settings that are required for the HTTPS and STS calls made during the authentication/credential - generation process are supported and should have been configured on the STS ClientConfig instance - associated with the STS client instance exposing this interface. - - - The web identity token used to assume the role. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRoleWithWebIdentity - - - - - CoreAmazonKMS is not meant to use directly. It implements ICoreAmazonKMS - and allows other service clients to be able to use the KMS service as a runtime dependency. - - This class waits until a method is actually called on the ICoreAmazonKMS interface - before requiring the KMS assembly to be present and loaded. - - - - - This exception is thrown if there are problems signing the request. - - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - - - - Gets the percentage of transfer completed - - - - - Gets the number of bytes transferred since last event - - - - - Gets the number of bytes transferred - - - - - Gets the total number of bytes to be transferred - - - - - Returns a string representation of this object - - - - - - Class that posts the CSM event to a UDP portconfig - This is a singleton class and is created once - per AmazonServiceClient. - - - - - The CSMevents are always posted to the localhost - - - - - Method to post UDP datagram for sync calls - - - - - Method to post UDP datagram for async calls - - - - - Method to post UDP datagram for bcl35 async calls - - - - - Settings for configuring a proxy for the SDK to use. - - - - - The host name or IP address of the proxy server. - - - - - The port number of the proxy. - - - - - The username to authenticate with the proxy server. - - - - - The password to authenticate with the proxy server. - - - - - Collection of one or more regular expressions denoting addresses - for which the proxy will not be used. - - - For more information on bypass lists - see https://msdn.microsoft.com/en-us/library/system.net.webproxy.bypasslist%28v=vs.110%29.aspx. - - - - - If true requests to local addresses bypass the configured - proxy. - - - - - Settings for logging in the SDK. - - - - - Logging destination. - - - - - When to log responses. - - - - - Gets or sets the size limit in bytes for logged responses. - If logging for response body is enabled, logged response - body is limited to this size. The default limit is 1KB. - - - - - Whether or not to log SDK metrics. - - - - - A custom formatter added through Configuration - - - - - This class can be used to discover the public address ranges for AWS. The - information is retrieved from the publicly accessible - https://ip-ranges.amazonaws.com/ip-ranges.json file. - - - The information in this file is generated from our internal system-of-record and - is authoritative. You can expect it to change several times per week and should - poll accordingly. - - - - - Region identifier string for ROUTE53 and CLOUDFRONT ranges - - - - - Collection of service keys found in the data file. - - - - - The publication date and time of the file that was downloaded and parsed. - - - - - Collection of all public IP ranges. - - - - - Filtered collection of public IP ranges for the given service key - - - - - Filtered collection of public IP ranges for the given region (us-east-1 etc) or GLOBAL. - - - - - Filtered collection of public IP ranges for the given network border group. - - - - - Downloads the most recent copy of the endpoint address file and - parses it to a collection of address range objects. - - - - - Downloads the most recent copy of the endpoint address file and - parses it to a collection of address range objects. - - - - - Represents the IP address range for a single region and service key. - - - - - The public IPv4 or Ipv6 address range, in CIDR notation. - - - - - Indicates ipv4 or v6 format of the address - - - - - The AWS region or GLOBAL for edge locations. Note that the CLOUDFRONT and ROUTE53 - ranges are GLOBAL. - - - - - The subset of IP address ranges. Specify AMAZON to get all IP address ranges - (for example, the ranges in the EC2 subset are also in the AMAZON subset). Note - that some IP address ranges are only in the AMAZON subset. - - - Valid values for the service key include "AMAZON", "EC2", "ROUTE53", - "ROUTE53_HEALTHCHECKS", and "CLOUDFRONT." If you need to know all of - the ranges and don't care about the service, use the "AMAZON" entries. - The other entries are subsets of this one. Also, some of the services, - such as S3, are represented in "AMAZON" and do not have an entry that - is specific to the service. We plan to add additional values over time; - code accordingly! - - - - - The network border group the IP address range belongs to. - - - AWS Local Zones allow you to seamlessly connect to the full range of services in the AWS Region such - as Amazon Simple Storage Service and Amazon DynamoDB through the same APIs and tool sets. You can extend - your VPC Region by creating a new subnet that has a Local Zone assignment. When you create a subnet in - a Local Zone, the VPC is also extended to that Local Zone. - - A network border group is a unique set of Availability Zones or Local Zones from where AWS advertises - public IP addresses. - - When you create a VPC that has IPv6 addresses, you can choose to assign a set of Amazon-provided public - IP addresses to the VPC and also set a network border group for the addresses that limits the addresses - to the group. When you set a network border group, the IP addresses cannot move between network - border groups. The us-west-2 network border group contains the four US West (Oregon) Availability Zones. - The us-west-2-lax-1 network border group contains the Los Angeles Local Zones. - - - - - This class defines utilities and constants that can be used by - all the client libraries of the SDK. - - - - - The user agent string header - - - - - The Set of accepted and valid Url characters per RFC3986. - Characters outside of this set will be encoded. - - - - - The Set of accepted and valid Url characters per RFC1738. - Characters outside of this set will be encoded. - - - - - The set of accepted and valid Url path characters per RFC3986. - - - - - The string representing Url Encoded Content in HTTP requests - - - - - The GMT Date Format string. Used when parsing date objects - - - - - The ISO8601Date Format string. Used when parsing date objects - - - - - The ISO8601Date Format string. Used when parsing date objects - - - - - The ISO8601 Basic date/time format string. Used when parsing date objects - - - - - The ISO8601 basic date format. Used during AWS4 signature computation. - - - - - The RFC822Date Format string. Used when parsing date objects - - - - - Returns an extension of a path. - This has the same behavior as System.IO.Path.GetExtension, but does not - check the path for invalid characters. - - - - - - Convert request parameters to Url encoded query string - - - Convert Dictionary of parameters to Url encoded query string - - - - Returns the canonicalized resource path for the service endpoint with single URL encoded path segments. - - Endpoint URL for the request - Resource path for the request - - If resourcePath begins or ends with slash, the resulting canonicalized - path will follow suit. - - Canonicalized resource path for the endpoint - - - - Returns the canonicalized resource path for the service endpoint - - Endpoint URL for the request - Resource path for the request - If true pre URL encode path segments if necessary. - S3 is currently the only service that does not expect pre URL encoded segments. - - If resourcePath begins or ends with slash, the resulting canonicalized - path will follow suit. - - Canonicalized resource path for the endpoint - - - - Returns the canonicalized resource path for the service endpoint - - Endpoint URL for the request - Resource path for the request - If true pre URL encode path segments if necessary. - S3 is currently the only service that does not expect pre URL encoded segments. - Dictionary of key/value parameters containing the values for the ResourcePath key replacements - The version of the marshaller that constructed the request object. - - If resourcePath begins or ends with slash, the resulting canonicalized - path will follow suit. - - Canonicalized resource path for the endpoint - - - - Splits the resourcePath at / into segments then resolves any keys with the path resource values. Greedy - key values will be split into multiple segments at each /. - - The patterned resourcePath - The key/value lookup for the patterned resourcePath - A list of path segments where all keys in the resourcePath have been resolved to one or more path segment values - - - - Joins all path segments with the / character and encodes each segment before joining. - - The segments of a URL path split at each / character - If the path property is specified, - the accepted path characters {/+:} are not encoded. - A joined URL with encoded segments - - - - Takes a patterned resource path and resolves it using the key/value path resources into - a segmented encoded URL. - - The patterned resourcePath - The key/value lookup for the patterned resourcePath - A segmented encoded URL - - - - Returns a new string created by joining each of the strings in the - specified list together, with a comma between them. - - The list of strings to join into a single, comma delimited - string list. - A new string created by joining each of the strings in the - specified list together, with a comma between strings. - - - - Attempt to infer the region for a service request based on the endpoint - - Endpoint to the service to be called - - Region parsed from the endpoint; DefaultRegion (or DefaultGovRegion) - if it cannot be determined/is not explicit - - - - - Attempt to infer the service name for a request (in short form, eg 'iam') from the - service endpoint. - - Endpoint to the service to be called - - Short-form name of the service parsed from the endpoint; empty string if it cannot - be determined - - - - - Utility method for converting Unix epoch seconds to DateTime structure. - - The number of seconds since January 1, 1970. - Converted DateTime structure - - - - Helper function to format a byte array into string - - The data blob to process - If true, returns hex digits in lower case form - String version of the data - - - - Calls a specific EventHandler in a background thread - - - - - - - - Parses a query string of a URL and returns the parameters as a string-to-string dictionary. - - - - - - - Utility method for converting a string to a MemoryStream. - - - - - - - Utility method for copy the contents of the source stream to the destination stream. - - - - - - - Utility method for copy the contents of the source stream to the destination stream. - - - - - - - - Formats the current date as a GMT timestamp - - A GMT formatted string representation - of the current date and time - - - - - Formats the current date as ISO 8601 timestamp - - An ISO 8601 formatted string representation - of the current date and time - - - - - Gets the ISO8601 formatted timestamp that is minutesFromNow - in the future. - - The number of minutes from the current instant - for which the timestamp is needed. - The ISO8601 formatted future timestamp. - - - - Formats the current date as ISO 8601 timestamp - - An ISO 8601 formatted string representation - of the current date and time - - - - - Gets the RFC822 formatted timestamp that is minutesFromNow - in the future. - - The number of minutes from the current instant - for which the timestamp is needed. - The ISO8601 formatted future timestamp. - - - - Determines whether the given string is an absolute path to a root. - - The hypothetical absolute path. - True if is an absolute path. - - - - Returns true if the path specified is relative to the current drive or working directory. - Returns false if the path is fixed to a specific drive or UNC path. This method does no - validation of the path (URIs will be returned as relative as a result). - - - Handles paths that use the alternate directory separator. It is a frequent mistake to - assume that rooted paths (Path.IsPathRooted) are not relative. This isn't the case. - "C:a" is drive relative- meaning that it will be resolved against the current directory - for C: (rooted, but relative). "C:\a" is rooted and not relative (the current directory - will not be used to modify the path). - - - - - True if the given character is a directory separator. - - - - - Returns true if the given character is a valid drive letter - - - - - URL encodes a string per RFC3986. If the path property is specified, - the accepted path characters {/+:} are not encoded. - - The string to encode - Whether the string is a URL path or not - The encoded string - - - - URL encodes a string per the specified RFC. If the path property is specified, - the accepted path characters {/+:} are not encoded. - - RFC number determing safe characters - The string to encode - Whether the string is a URL path or not - The encoded string - - Currently recognised RFC versions are 1738 (Dec '94) and 3986 (Jan '05). - If the specified RFC is not recognised, 3986 is used by default. - - - - - URL encodes a string per the specified RFC with the exception of preserving the encoding of previously encoded slashes. - If the path property is specified, the accepted path characters {/+:} are not encoded. - - The string to encode - Whether the string is a URL path or not - The encoded string with any previously encoded %2F preserved - - - - Convert bytes to a hex string - - Bytes to convert. - Hexadecimal string representing the byte array. - - - - Convert a hex string to bytes - - Hexadecimal string - Byte array corresponding to the hex string. - - - - Returns DateTime.UtcNow + ManualClockCorrection when - is set. - This value should be used instead of DateTime.UtcNow to factor in manual clock correction - - - - - Returns true if the string has any bidirectional control characters. - - - - - - - Executes an HTTP request and returns the response as a string. This method - throws WebException and HttpRequestException. In the event HttpRequestException - is thrown the StatusCode is sent as user defined data on the exception under - the key "StatusCode". - - The URI to make the request to - The request type: GET, PUT, POST - null or the content to send with the request - Timeout for the request - Proxy for the request - null or any headers to send with the request - The response as a string. - - - - Utility method that accepts a string and replaces white spaces with a space. - - - - - - - Runs a process with the below input parameters. - - - - - - - This method is used preserve the stacktrace used from clients that support async calls. This - make sure that exceptions thrown during EndXXX methods has the orignal stacktrace that happen - in the background thread. - - - - - - Root AWS config - - - - - Wrapper class which invokes the static method - public static string GetEnvironmentVariable(string variable) - underneath. This class is added as a property on the singleton class - EnvironmentVariableSource. This change was done for testability. - - - - - Singleton class that holds the property of type IEnvironmentVariableRetreiver. - This property can hold an instance of type EnvironmentVariableRetreiver which has a wrapper - method for - public static string GetEnvironmentVariable(string variable) - or can be mocked for testing purposes. - - - - - Interface for EnvironmentVariableRetriever. - This serves as a property for the singleton EnvironmentVariableSource - - - - - Manager to access a settings store file. Objects are primarily accessed by DisplayName rather than unique key. - Settings store files are located under the current user's AppData\Local\AWSToolkit folder. - Select keys in these files are encrypted on a per user, per machine basis using the Windows Data Protection API; - the encrypted values cannot be used by any other user or on any other machine. - - This class is not threadsafe. - - - - - True if the encrypted store is availble, false otherwise. - - - - - Construct an NamedSettingsManager. - - The base filename to read/write. - - - - Register an object. Let the uniqueKey be assigned automatically. - - The display name for the object. - The property names and values for the object. - The unique key that was assigned to the object. - - - - Try to get an object form the store. - - The display name for the object. - The property names and values for the object. - True if the object was found, false otherwise. - - - - Try to get an object form the store. - - The display name for the object. - The uniqueKey of the object in the store - The property names and values for the object. - True if the object was found, false otherwise. - - - - Unregister an object from the store. - - The display name for the object. - - - - Rename an object in the store. - - - - if true and destination object already exists overwrite it - - - - Copy an object in the store. - The new object will be a copy of the original, except it will be assigned a new unique key. - - - - if true and destination object already exists overwrite it - - - - Get a list of the display names for the objects in the store. - - A list of display names. - - - - Manager to access a settings store file. - Settings store files are located under the current user's AppData\Local\AWSToolkit folder. - Select keys in these files are encrypted on a per user, per machine basis using the Windows Data Protection API; - the encrypted values cannot be used by any other user or on any other machine. - - This class is not threadsafe. - - - - - True if the encrypted store is availble, false otherwise. - - - - - Construct a SettingsManager. - - The base filename to read/write. - - - - The base filename to read/write. - - - - - Register an object. Let the uniqueKey be assigned automatically. - - The property names and values for the object. - The unique key that was assigned to the object. - - - - Register an object. - - The uniqueKey for the object, or null if one should be assigned automatically. - The property names and values for the object. - The unique key that was assigned to the object. - - - - Try to get an object form the store. - - The uniqueKey of the object in the store - The property names and values for the object. - True if the object was found, false otherwise. - - - - Try to get an object form the store based on the value of a specific property. - If multiple objects with the same property value exist, return the first one. - - The name of the property to search on. - The value of the property to search on. - The unique key of the object. - The properties of the object. - - - - - Get a list of the unique keys of all the objects in the store. - - - - - - Get the value of a specific property for each object in the store. - - - - - - - Unregister an object from the store. - - The unique key for the object. - - - - Class that contains result of executing an external process through the SDKs - AWSSDKUtils.RunProcess/AWSSDKUtils.RunProcessAsync - - - - - The exit code with which the process exited - - - - - The output of the process read till the end - - - - - The error output of the process read till the end - - - - - Object to track circular references in nested types. - At each level of nesting, make a call to Track to retrieve Tracker, - a tracking object implementing the IDisposable interface. - Dispose of this tracker when leaving the context of the tracked object. - - - - - Tracker. Must be disposed. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Adds the current target to a reference list and returns a tracker. - The tracker removes the target from the reference list when the - tracker is disposed. - - - - - - - Provides access to EC2 instance metadata when running on an EC2 instance. - If this class is used on a non-EC2 instance, the properties in this class - will return null. - - - - Amazon EC2 instances can access instance-specific metadata, as well as data supplied when launching the instances, using a specific URI. - - - You can use this data to build more generic AMIs that can be modified by configuration files supplied at launch time. - For example, if you run web servers for various small businesses, they can all use the same AMI and retrieve their content from the - Amazon S3 bucket you specify at launch. To add a new customer at any time, simply create a bucket for the customer, add their content, - and launch your AMI. - - - More information about EC2 Metadata - - - - - - - - - - Allows to configure the proxy used for HTTP requests. The default value is null. - - - - - The AMI ID used to launch the instance. - - - - - The index of this instance in the reservation. - - - - - The manifest path of the AMI with which the instance was launched. - - - - - The AMI IDs of any instances that were rebundled to create this AMI. - Will only exist if the AMI manifest file contained an ancestor-amis key. - - - - - The private hostname of the instance. - In cases where multiple network interfaces are present, - this refers to the eth0 device (the device for which the device number is 0). - - - - - Notifies the instance that it should reboot in preparation for bundling. - Valid values: none | shutdown | bundle-pending. - - - - - The ID of this instance. - - - - - The type of instance. - - - - - The ID of the kernel launched with this instance, if applicable. - - - - - The local hostname of the instance. In cases where multiple network interfaces are present, - this refers to the eth0 device (the device for which device-number is 0). - - - - - The instance's MAC address. In cases where multiple network interfaces are present, - this refers to the eth0 device (the device for which device-number is 0). - - - - - The private IP address of the instance. In cases where multiple network interfaces are present, - this refers to the eth0 device (the device for which device-number is 0). - - - - - The Availability Zone in which the instance launched. - - - - - Product codes associated with the instance, if any. - - - - - Public key. Only available if supplied at instance launch time. - - - - - The ID of the RAM disk specified at launch time, if applicable. - - - - - The region in which the instance is running, extracted from the identity - document data. - - - - - ID of the reservation. - - - - - The names of the security groups applied to the instance. - - - - - Returns information about the last time the instance profile was updated, - including the instance's LastUpdated date, InstanceProfileArn, and InstanceProfileId. - - - - - Returns the temporary security credentials (AccessKeyId, SecretAccessKey, SessionToken, and Expiration) - associated with the IAM roles on the instance. - - - - - The virtual devices associated with the ami, root, ebs, and swap. - - - - - The network interfaces on the instance. - - - - - The metadata sent to the instance. - - - - - Value showing whether the customer has enabled detailed - one-minute monitoring in CloudWatch. - - - - - JSON containing instance attributes, such as instance-id, private IP - address, etc - - - - - Data that can be used by other parties to verify its origin and authenticity. - - - - - Used to verify the document's authenticity and content against the signature. - - - - - Return the list of items in the metadata at path. - - Path at which to query the metadata; may be relative or absolute. - List of items returned by the metadata service - - - - Return the metadata at the path - - Path at which to query the metadata; may be relative or absolute. - Data returned by the metadata service - - - - Return the metadata at the path - - Path at which to query the metadata; may be relative or absolute. - Number of attempts to make - Data returned by the metadata service - - - - Return the list of items in the metadata at path. - - Path at which to query the metadata; may be relative or absolute. - Number of attempts to make - List of items returned by the metadata service - - - - Fetches the api token to use with metadata requests. - - The API token or null - - - - Fetches the api token to use with metadata requests. - - The number of tries to fetch the api token before giving up and throwing the web exception - The API token or null if an API token couldn't be obtained and doesn't need to be used - - - - Exponentially sleeps based on the current retry value. A lower - value will sleep shorter than a larger value - - Base 0 retry index - - - - Returns information about the last time the instance profile was updated, - including the instance's LastUpdated date, InstanceProfileArn, and InstanceProfileId. - - - - - The status of the instance profile - - - - - Further information about the status of the instance profile - - - - - The date and time the instance profile was updated - - - - - The Amazon Resource Name (ARN) of the instance profile - - - - - The Id of the instance profile - - - - - The temporary security credentials (AccessKeyId, SecretAccessKey, SessionToken, and Expiration) associated with the IAM role. - - - - - The status of the security credential - - - - - Further information about the status of the instance profile - - - - - The date and time the security credential was last updated - - - - - The type of the security credential - - - - - The uniqe id of the security credential - - - - - The secret key used to sign requests - - - - - The security token - - - - - The date and time when these credentials expire - - - - - All of the metadata associated with a network interface on the instance. - - - - - Construct an instance of NetworkInterface - - - - - - The interface's Media Access Control (mac) address. - - - - - The ID of the owner of the network interface. - - - In multiple-interface environments, an interface can be attached by a third party, such as Elastic Load Balancing. - Traffic on an interface is always billed to the interface owner. - - - - - The interface's profile - - - - - The interface's local hostname. - - - - - The private IP addresses associated with the interface. - - - - - The interface's public hostname. - - - - - The elastic IP addresses associated with the interface. - - - There may be multiple IP addresses on an instance. - - - - - Security groups to which the network interface belongs. - - - - - IDs of the security groups to which the network interface belongs. Returned only for Amazon EC2 instances launched into a VPC. - - - - - The ID of the Amazon EC2-VPC subnet in which the interface resides. - - - Returned only for Amazon EC2 instances launched into a VPC. - - - - - The CIDR block of the Amazon EC2-VPC subnet in which the interface resides. - - - Returned only for Amazon EC2 instances launched into a VPC. - - - - - The CIDR block of the Amazon EC2-VPC subnet in which the interface resides. - - - Returned only for Amazon EC2 instances launched into a VPC. - - - - - Get the private IPv4 address(es) that are associated with the public-ip address and assigned to that interface. - - The public IP address - Private IPv4 address(es) associated with the public IP address - - - - This class allows profiles supporting AWS credentials and SAML-based authentication to be registered with - the SDK so that they can later be reference by a profile name. The credential profiles will be available - for use in the AWS Toolkit for Visual Studio and the AWS Tools for Windows PowerShell. - - The credentials are stored under the current users AppData folder encrypted using Windows Data Protection API. - - - To reference a profile from an application's App.config or Web.config use the AWSProfileName setting. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="development"/> - </appSettings> - </configuration> - - - - - - - Registers an AWS credentials profile that can later be referenced by the profileName. - This profile will only be visible for the current user. - - Name given to the AWS credentials. - The AWS access key id - The AWS secret key - - - - - Registers a role-based profile to be used with SAML authentication. The profile contains - details of the role to be assumed when AWS credentials are requested based on the role and - a reference to a SAML endpoint profile containing details of the endpoint to be called to - authenticate the user. - - - If user identity information is not supplied then the identity of the logged-in user will - be used when authenticaton is performed against the endpoint referenced in the SAML endpoint - profile. If identity is provided, no password information is stored in the role profile and - the user must supply the password for the identity prior to authentication with the endpoint. - - - Name to be assigned to the profile - - The name assigned to the endpoint settings, previously saved with RegisterSAMLEndpoint. - - - The arn of the role that the user wants to assume when using this profile. This - must be one of the set returned by the saml endpoint when the user authenticates. - - - Optional. By default the identity of the logged-in user will be used when authentication - is performed - the user will not be prompted to supply a password. By supplying a custom - identity for this parameter, the user will be prompted to supply the password for the - identity prior to authentication. - - - - - - Registers a role-based profile to be used with SAML authentication. The profile contains - details of the role to be assumed when AWS credentials are requested based on the role and - a reference to a SAML endpoint profile containing details of the endpoint to be called to - authenticate the user. - - - If user identity information is not supplied then the identity of the logged-in user will - be used when authenticaton is performed against the endpoint referenced in the SAML endpoint - profile. If identity is provided, no password information is stored in the role profile and - the user must supply the password for the identity prior to authentication with the endpoint. - - - Name to be assigned to the profile - - The name assigned to the endpoint settings, previously saved with RegisterSAMLEndpoint. - - - The arn of the role that the user wants to assume when using this profile. This - must be one of the set returned by the saml endpoint when the user authenticates. - - - Optional. By default the identity of the logged-in user will be used when authentication - is performed - the user will not be prompted to supply a password. By supplying a custom - identity for this parameter, the user will be prompted to supply the password for the - identity prior to authentication. - - - Set for profiles intended to be used in regions where a region-specific STS endpoint - must be used (eg cn-north-1). If left empty/null, the global sts.amazonaws.com endpoint - will be used when credentials are obtained for this profile. - - - - - Registers an endpoint to be used in conjunction with SAML role profiles. The role profiles - reference the endpoint settings to obtain the actual endpoint and any customization settings - needed to perform authentication. - - Name to be assigned to the endpoint settings. - The full uri of the authentication endpoint. - - The authentication type to use when performing calls against the endpoint. Valid values are 'NTLM', - 'Digest', 'Kerberos' and 'Negotiate'. The default if not configured (null/empty string) is 'Kerberos'. - - The unique id assigned to the new settings. - - - - Deletes the settings for an AWS credentials or SAML role profile from the SDK account store. - - The name of the profile to remove. - - - - Lists all profile names registered with the SDK account store. - - The profile names. - - - - Loads and returns all available credential profiles registered in the store. - - Collection of profiles. - - - - Checks if a given profile is known in the SDK credential store. - - The name of the profile to test for existence - True if the profile exists. - - - - Copies the contents of the source profile to the destination. If the destination - profile does not exist a new profile is created. Note that if the destination - profile exists, all keys it contains are removed and replaced with keys from the - source profile. - - The name of the profile to copy from. - The name of the profile to create or update. - The unique id assigned to the destination settings. - - - - Copies the contents of the source profile to the destination. If the destination - profile does not exist a new profile is created. Note that if the destination - profile exists, all keys it contains are removed and replaced with keys from the - source profile. - - The source profile to copy keys and values from. - The name of the profile to create or update. - The unique id assigned to the destination settings. - - - - Tries to get the AWS credentials from a profile in the SDK account store. - - The profile to get the credentials for. - Outputs the credentials for the profile. - Returns true if the profile exists otherwise false is returned. - - - - Gets the AWS credentials from a profile in the SDK account store. - - The profile to get the credentials for. - The AWS credentials for the profile. - Thrown if the profile does not exist - - - - Returns the profile with the specified name, if it has been registered in the SDK store. - - The name of the registered profile - The loaded profile data - - - - Returns the persisted data in the SDK store as a profile of the specified type T. - - The name of the profile holding the settings. - The loaded profile. An exception is thrown if the profile could not be loaded. - Thrown if the profile does not exist - - Currently supported profile types: AWSCredentialsProfile and SAMLRoleProfile. - - - - - Tries to load the specified profile data corresponding to profile type T from a named - profile in the SDK account store. - - The name of the profile holding the settings. - The loaded profile data. - Returns true if the profile exists otherwise false is returned. - - Currently supported profile types: AWSCredentialsProfile and SAMLRoleProfile. - - - - - Attempts to load the settings defining a SAML endpoint. - - The name assigned to the settings for the endpoint. - The instantiated endpoint. - True if the settings were successfully loaded. - - - - Loads the settings defining a SAML endpoint. - - The name assigned to the settings for the endpoint. - The loaded settings. An exception is thrown if they could not be loaded. - Thrown if the endpoint settings do not exist. - - - - Common base contract for all types of credential and role profiles. - - - - - The user-defined name for the settings. - - - - - The unique id of the profile in the backing store. - - - - - Saves the profile data to backing store, returning the unique id - assigned to the data. - - - - - The persisted data for a set of AWS credentials. At a minimum this - is access key and secret key data. - - - - - Tests if an AWSCredentialsProfile instance could be instantiated from - the persisted settings data. - - The name given to the persisted settings (previously verified as existing). - True if the settings are compatible with an AWSCredentialsProfile type. - - - - Tests if an AWSCredentialsProfile instance could be instantiated from - the persisted settings data. - - The persisted settings. - True if the settings are compatible with an AWSCredentialsProfile type. - - - - Instantiates an AWSCredentialsProfile instance from the specified profile name. - - The name of the profile holding the settings. - New credentials profile instance. An exception is thrown if the profile data is invalid. - - - - Instantiates an AWSCredentialsProfile instance from the supplied settings collection. - - The settings representing the stored profile. - New credentials profile instance. An exception is thrown if the profile data is invalid. - - - - Validates the contents of the specified profile. - - The name of the AWS credentials profile to validate. - Thrown if the profile settings fail to validate. - - - - Verifies that the persisted settings contains the minimal viable data to - instantiate an AWSCredentialsProfile instance. - - The persisted settings. - Thrown if the profile settings fail to validate. - - - - Persists the profile data to the store file. - - The unique ID assigned to the settings. - - - - Creates or updates the profile data in the store file. - - The unique ID assigned to the settings. - - - - The persisted data for a SAML endpoint. One or more role profiles - will reference this to obtain the common endpoint and other data needed - to perform authentication with a set of user credentials. - - - - - The default authentication type to use when attempting to perform an - authentication call against the configured endpoint. - - - - - The authentication endpoint which must be a HTTPS scheme. - - - - - The authentication type to use when calling the endpoint. - - - - - Tests if a SAMLEndpointSettings instance could be instantiated from - the persisted settings data. - - The name given to the persisted settings. - True if the settings are compatible. - - - - Tests if a SAMLEndpointSettings instance could be instantiated from - the persisted settings data. - - The persisted settings. - True if the settings are compatible. - - - - Instantiates an instance from settings stored with the specified name. - - The name of the endpoint settings in the store. - Profile instance or an exception if the profile data does not exist/contains invalid data. - - - - Instantiates an instance from the supplied settings. - - The persisted settings. - Profile instance or an exception if the profile data is invalid. - - - - Validates the contents of the specified endpoint settings. - - The name of the SAML endpoint settings to validate. - Thrown if the settings fail to validate. - - - - Verifies that the persisted settings contains the minimal viable data to - instantiate a SAMLEndpointSettings instance. - - The persisted settings. - Thrown if the settings fail to validate. - - - - Persists the settings to the storage file. - - The unique id assigned to the profile - - - - Creates or updates the settings data for a SAML endpoint in the backing store file. An error is - thrown if the scheme for the endpoint is not https. - - The name of the settings to create or update - The authentication endpoint - Optional authentication type to use when performing calls against the endpoint - The unique id assigned to the profile - - - - Constructs an endpoint settings instance. - - The user-defined name to assign to the settings. - - The absolute uri, including any query and relyingParty data, of the endpoint. - - - The authentication type to use when performing requests against the endpoint. - - - - - - The persisted data for a saml role profile for a user. This profile - references an endpoint profile containing the actual endpoint to be used, and - adds details of the role to be assumed when the profile is selected. - - - Optionally the profile can store a username and domain to be used during - authentication (default behavior, if this is not specified, is to use the user's - default network credentials). - - - - - - The ARN of the role that is to be assumed. - - - - - If non-default network credentials are to used contains - the user identity (in domain\user format, domain optional) that - should be used to supply credentials when the profile is used in - authentication. The user must be prompted to supply the - corresponding password prior to authentication. - - - - - If a specific user identity was specified in the profile, - returns true to indicate a password needs to be obtained from - the user before obtaining network credentials to be used on - authentication. The default is to use the credentials - associated with the currently logged-in user or process to - perform authentication, which does not require the user to be - prompted. - - - - - - For regions with a region-specific endpoint for STS (eg cn-north-1) this - field can be set to ensure calls to obtain temporary credentials - after successful authentication are forwarded to the correct regional - endpoint. - - - This field does not need to be set when running in a region for - which the sts.amazonaws.com endpoint is valid. - - - - - - Retrieves the active credential session, if any, associated with the - role profile. - - - The current credentials valid for the role specified in the profile. Returns - null if no active session is available, or the active session has expired. - - - When a user successfully authenticates and receives temporary AWS - credentials for a role, the profile is updated with details of the - session. When the profile is loaded by other processes or tools, if - session data is present and still valid it can be retrieved using this - method avoiding the need to re-authenticate and get additional temporary - credentials. - - - - - Persists the current credentials to a 'session' key in the RoleSessions.json file. - This enables external applications and tools using the same profile to obtain credentials - without needing to separately re-authenticate the user prior to expiry of the current - credentials. After persisting the session data it can be retrieved using GetCurrentSession(). - - - Although the credentials are temporary we still encrypt the stored data when at rest in - the sdk credential store. - - - The current credentials valid for the role specified in the profile. - - - - - Stores or clears the persisted session data. - - - - - - The endpoint settings from which the actual endpoint to use in authentication - is obtained. - - - - - Tests if a SAMLRoleProfile instance could be instantiated from - the persisted settings data. - - The name given to the persisted settings. - True if the settings are compatible with a SAMLRoleProfile type. - - - - Tests if a SAMLRoleProfile instance could be instantiated from - the persisted settings data. - - The persisted settings. - True if the settings are compatible with a SAMLRoleProfile type. - - - - Instantiates an instance from settings stored with the specified name. - - The name of the endpoint profile. - Profile instance or an exception if the profile data does not exist/contains invalid data. - - - - Instantiates an instance from the supplied settings. In addition to the profile settings - the SDK will inspect for a RoleSessions.json file containing active session data and if - an entry for the profile is present, will add the session data to the returned profile - object. - - The persisted settings. - Profile instance or an exception if the profile data is invalid. - - - - Validates the contents of the specified profile. - - The name of the SAML role profile to validate. - Thrown if the profile settings fail to validate. - - - - Validates that the presented settings would result in a valid role profile - instance. - - The persisted settings. - Thrown if the profile settings fail to validate. - - - - Stores the data in the role profile to the backing store file. - - - - - - Registers a role-based profile to be used with SAML authentication. The profile contains - details of the role to be assumed when AWS credentials are requested based on the role and - a reference to a SAML endpoint profile containing details of the endpoint to be called to - authenticate the user. - - - If user identity information is not supplied then the identity of the logged-in user will - be used when authenticaton is performed against the endpoint referenced in the SAML endpoint - profile. If identity is provided, no password information is stored in the role profile and - the user must supply the password for the identity prior to authentication with the endpoint. - - - Name to be assigned to the profile - - The name of the settings in the SAML endpoints file containing details of the - endpoint to authenticate with. - - - The arn of the role that the user wants to assume when using this profile. This - must be one of the set returned by the saml endpoint when the user authenticates. - - - Optional, can be used to prompt the user for a password for the account when authentication - is performed from a system that is not domain-joined. - - - Optional, details of the currently active credentials for the role that we want to - persist into the profile for other tools or processes to pick up, avoiding the need - to continually re-authenticate the user as they switch between tools. The active session, - if any, is stored separately from the profile using the file RoleSessions.json. - - - Set for profiles intended to be used in regions where a region-specific STS endpoint - must be used (eg cn-north-1). If left empty/null, the global sts.amazonaws.com endpoint - will be used when credentials are obtained for this profile. - - The unique id assigned to the profile. - - - - Tests for and loads any active session credentials for the specified profile. The session data - exists in a separate file from the profile, RoleSessions.json. - - - - - - - Stores the supplied session data into the RoleSessions.json backing file. - - - - - - - Constructs a profile data instance that will use the specified network identity - during authentication with configured endpoint. - - The user-defined name of the profile that sourced this data. - The settings for the authentication endpoint. - The role that should be assumed on successful authentication. - The credentials to supply in authentication, in domain\user format. - - Deserialized credential data from the profile, if still valid. Null if the profile does not - contain any active credentials, or the credentials it did hold are now invalid. - - - Set for profiles intended to be used in regions where a region-specific STS endpoint - must be used (eg cn-north-1). If left empty/null, the global sts.amazonaws.com endpoint - will be used when credentials are obtained for this profile. - - - - - AwsHttpClient is a wrapper around HttpClient class of the System.Net.Http library. - The wrapper has been added so as to remove System.Net.Http dependencies from the Services - and migrate it to a Core level dependecy only. This avoids version clashes when a service - and the Core depends on different versions of the System.Net.Http library. This is a Service - level utility method - - - - - AWSHttpClient wrapper that is wrapped around - HttpClient default wrapper. - - - - - AWSHttpClient BaseAddress property that is wrapper for - HttpClient BaseAddress property. - - - - - AWSHttpClient Timeout property that is wrapper for - HttpClient Timeout property. - - - - - AWSHttpClient MaxResponseContentBufferSize property that is wrapper for - HttpClient MaxResponseContentBufferSize property. - - - - - AWSHttpClient GetStreamAsync that accepts the requester's URI - and make a HttpClient.GetStreamAsync call. - - Requester Uri - - - - Wrapper method that accepts a request uri, stream content and headers and makes a sendAsync call. - - - - - - - Wrapper for HttpClient's HttpRequestMessage and SendAsync methods. - - - - Returns response headers information- header name,value and status code - - - - Wrapper for HttpClient Dispose. - - - - - Method that checks if the passed exception is of type - HttpRequestException - - - - - - - AWSStreamContent is a wrapper for StreamContent class in - the System.Net.Http library.The wrapper has been added so as to - remove System.Net.Http dependencies from the Services - and migrate it to a Core level dependecy only. This avoids version clashes when a service - and the Core depends on different versions of the System.Net.Http library. This is a Service - level utility method - - - - - Wrapper for StreamContent constructor - for stream content - - - - - - Wrapper for StreamContent constructor - for stream content and bufferSize - - - - - - - Wrapper to allow Services to remove StreamContent Headers - - - - - - - Wrapper to allow Services to add StreamContent Headers - - - - - - - Wrapper for StreamContent Dispose. - - - - - Utility class to parse Amazon resource names more commonly known as an ARN. - - - - - Gets and sets the partition associated with the ARN (e.g.: 'aws'). - - - - - Gets and sets the AWS service associated with the ARN (e.g.: 's3'). - - - - - Gets and sets the region associated with the ARN (e.g.: 'us-east-1'). - - - - - Gets and sets the account ID associated with the ARN. - - - - - Gets and sets the resource associated with the ARN (e.g.: 'mybucket/myobject'). - - - - - Returns true if the string appears to be an ARN by seeing if the string starts with "arn:". This method - doesn't guarantee the string is a valid ARN. To validate the string call TryParse. - - - - - - - Parses the string into an ARN object. - - String to parse into an ARN. - The out parameter for the ARN object created by TryParse. - True if the string was parsed into an ARN object. - - - - Parses the string into an ARN object. - - String to parse into an Arn. - The Arn object created from the passed in string. - Thrown if arnString is null. - Thrown if the string passed in not valid ARN. - - - - Turns the Arn object into a string representation of an ARN. - - - - - - Configuration options that apply to the entire SDK. - - These settings can be configured through app.config or web.config. - Below is a full sample configuration that illustrates all the possible options. - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws region="us-west-2"> - <logging logTo="Log4Net, SystemDiagnostics" logResponses="Always" logMetrics="true" /> - <s3 useSignatureVersion4="true" /> - <proxy host="localhost" port="8888" username="1" password="1" /> - - <dynamoDB> - <dynamoDBContext tableNamePrefix="Prod-"> - - <tableAliases> - <alias fromTable="FakeTable" toTable="People" /> - <alias fromTable="Persons" toTable="People" /> - </tableAliases> - - <mappings> - <map type="Sample.Tests.Author, SampleDLL" targetTable="People" /> - <map type="Sample.Tests.Editor, SampleDLL" targetTable="People"> - <property name="FullName" attribute="Name" /> - <property name="EmployeeId" attribute="Id" /> - <property name="ComplexData" converter="Sample.Tests.ComplexDataConverter, SampleDLL" /> - <property name="Version" version="true" /> - <property name="Password" ignore="true" /> - </map> - </mappings> - - </dynamoDBContext> - </dynamoDB> - </aws> - - - - Configuration options that apply to the entire SDK. - - - - - Manual offset to apply to client clock. This is a global setting that overrides - ClockOffset value calculated for all service endpoints. - - - - - Determines if the SDK should correct for client clock skew - by determining the correct server time and reissuing the - request with the correct time. - Default value of this field is True. - will be updated with the calculated - offset even if this field is set to false, though requests - will not be corrected or retried. - Ignored if is set. - - - - - The calculated clock skew correction, if there is one. - This field will be set if a service call resulted in an exception - and the SDK has determined that there is a difference between local - and server times. - - If is set to true, this - value will be set to the correction, but it will not be used by the - SDK and clock skew errors will not be retried. - - - - - Key for the AWSRegion property. - - - - - - Configures the default AWS region for clients which have not explicitly specified a region. - Changes to this setting will only take effect for newly constructed instances of AWS clients. - - This setting can be configured through the App.config. For example: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws region="us-west-2" /> - - - - - - Key for the AWSProfileName property. - - - - - - Profile name for stored AWS credentials that will be used to make service calls. - Changes to this setting will only take effect in newly-constructed clients. - - To reference the account from an application's App.config or Web.config use the AWSProfileName setting. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="development"/> - </appSettings> - </configuration> - - - - - - - Key for the AWSProfilesLocation property. - - - - - - Location of the credentials file shared with other AWS SDKs. - By default, the credentials file is stored in the .aws directory in the current user's home directory. - - Changes to this setting will only take effect in newly-constructed clients. - - To reference the profile from an application's App.config or Web.config use the AWSProfileName setting. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfilesLocation" value="c:\config"/> - </appSettings> - </configuration> - - - - - - - Key for the Logging property. - - - - - - Configures how the SDK should log events, if at all. - Changes to this setting will only take effect in newly-constructed clients. - - The setting can be configured through App.config, for example: - - <appSettings> - <add key="AWSLogging" value="log4net"/> - </appSettings> - - - - - - Key for the ResponseLogging property. - - - - - - - Configures when the SDK should log service responses. - Changes to this setting will take effect immediately. - - The setting can be configured through App.config, for example: - - <appSettings> - <add key="AWSResponseLogging" value="OnError"/> - </appSettings> - - - - - - Key for the LogMetrics property. - - - - - - Configures if the SDK should log performance metrics. - This setting configures the default LogMetrics property for all clients/configs. - Changes to this setting will only take effect in newly-constructed clients. - - The setting can be configured through App.config, for example: - - <appSettings> - <add key="AWSLogMetrics" value="true"/> - </appSettings> - - - - - - Key for the EndpointDefinition property. - - - - - - Configures if the SDK should use a custom configuration file that defines the regions and endpoints. - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws endpointDefinition="c:\config\endpoints.json" /> - - - - - - Key for the UseSdkCache property. - - - - - - Configures if the SDK Cache should be used, the default value is true. - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws useSdkCache="true" /> - - - - - - Configuration for the Logging section of AWS configuration. - Changes to some settings may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws> - <logging logTo="Log4Net, SystemDiagnostics" logResponses="Always" logMetrics="true" /> - </aws> - - - - - - Configuration for the Proxy section of AWS configuration. - Changes to some settings may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws> - <proxy host="localhost" port="8888" username="1" password="1" bypassList="addressexpr1;addressexpr2;..." bypassOnLocal="true" /> - </aws> - - - - - - When set to true, the service client will use the x-amz-user-agent - header instead of the User-Agent header to report version and - environment information to the AWS service. - - Note: This is especially useful when using a platform like WebAssembly - which doesn't allow to specify the User-Agent header. - - - - - Configuration for the region endpoint section of AWS configuration. - Changes may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws region="us-west-2" /> - - - - - - Lock for SomeEvent delegate access. - - - - - This method should never be called directly. - Call AWSSDKUtils.CorrectedUtcNow instead. - - - - - - Logging options. - Can be combined to enable multiple loggers. - - - - - No logging - - - - - Log using log4net - - - - - Log using System.Diagnostics - - - - - Log to the console - - - - - Response logging option. - - - - - Never log service response - - - - - Only log service response when there's an error - - - - - Always log service response - - - - - Format for metrics data in the logs - - - - - Emit metrics in human-readable format - - - - - Emit metrics as JSON data - - - - - Allows to configure the proxy used for HTTP requests. The default value is null. - - - - - This class contains the endpoints available to the AWS clients. The static constants representing the - regions can be used while constructing the AWS client instead of looking up the exact endpoint URL. - - - - - Gets the endpoint for a service in a region. - - The services system name. - If true returns the endpoint for dualstack - Thrown when the request service does not have a valid endpoint in the region. - - - - - Enumerate through all the regions. - - - - - Gets the region based on its system name like "us-west-1" - - The system name of the service like "us-west-1" - - - - - This is a testing method and should not be called by production applications. - - - - - Gets the system name of a region. - - - - - Gets the display name of a region. - - - - - This region name is non-standard. Search the whole endpoints.json file to - determine the partition this region is in. - - - - - This class contains region information used to lazily compute the service endpoints. The static constants representing the - regions can be used while constructing the AWS client instead of looking up the exact endpoint URL. - - - - - The US East (Virginia) endpoint. - - - - - The US East (Virginia) regional endpoint. - - - - - The US East (Ohio) endpoint. - - - - - The US West (N. California) endpoint. - - - - - The US West (Oregon) endpoint. - - - - - The EU North (Stockholm) endpoint. - - - - - The EU West (Ireland) endpoint. - - - - - The EU West (London) endpoint. - - - - - The EU West (Paris) endpoint. - - - - - The EU Central (Frankfurt) endpoint. - - - - - The Europe (Milan) endpoint. - - - - - The Asia Pacific (Hong Kong) endpoint. - - - - - The Asia Pacific (Tokyo) endpoint. - - - - - The Asia Pacific (Seoul) endpoint. - - - - - The Asia Pacific (Osaka-Local) endpoint. - - - - - The Asia Pacific (Mumbai) endpoint. - - - - - The Asia Pacific (Singapore) endpoint. - - - - - The Asia Pacific (Sydney) endpoint. - - - - - The South America (Sao Paulo) endpoint. - - - - - The US GovCloud East (Virginia) endpoint. - - - - - The US GovCloud West (Oregon) endpoint. - - - - - The China (Beijing) endpoint. - - - - - The China (Ningxia) endpoint. - - - - - The Canada (Central) endpoint. - - - - - The Middle East (Bahrain) endpoint. - - - - - The Africa (Cape Town) endpoint. - - - - - Represents the endpoint overridding rules in the endpoints.json - Is used to map private region (ie us-east-1-regional) to public regions (us-east-1) - For signing purposes. - - - - - Enumerate through all the regions. - - - - - Gets the region based on its system name like "us-west-1" - - The system name of the service like "us-west-1" - - - - - Gets the region endpoint override if exists - - The region endpoint to find the possible override for - - - - - Gets the system name of a region. - - - - - Gets the display name of a region. - - - - - Gets the partition name the region is in. For example for us-east-1 the partition name is aws. For cn-northwest-1 the partition name is aws-cn. - - - - - Gets the dns suffix for the region endpoints in a partition. For example the aws partition's suffix is amazonaws.com. The aws-cn partition's suffix is amazonaws.com.cn. - - - - - Gets the endpoint for a service in a region. - - - The services system name. Service system names can be obtained from the - RegionEndpointServiceName member of the ClientConfig-derived class for the service. - - - For forwards compatibility, if the service being requested for isn't known in the region, this method - will generate an endpoint using the AWS endpoint heuristics. In this case, it is not guaranteed the - endpoint will point to a valid service endpoint. - - - - - - Gets the endpoint for a service in a region, optionally selecting a dualstack compatible endpoint. - - - The services system name. Service system names can be obtained from the - RegionEndpointServiceName member of the ClientConfig-derived class for the service. - - - If true a dualstack endpoint is returned. It is the user's responsibility to verify that the given service - supports a dualstack endpoint for the region. - - - For forwards compatibility, if the service being requested for isn't known in the region, this method - will generate an endpoint using the AWS endpoint heuristics. In this case, it is not guaranteed the - endpoint will point to a valid service endpoint. - - - - - - This class defines an endpoints hostname and which protocols it supports. - - - - - Gets the hostname for the service. - - - - - The authentication region to be used in request signing. - - - - - This property is only set for S3 endpoints. For all other services this property returns null. - For S3 endpoints, if the endpoint supports signature version 2 this property will be "2", otherwise it will be "4". - - - - - Calculates a 32bit Cyclic Redundancy Checksum (CRC) using the - same polynomial used by Zip. This type is used internally by DotNetZip; it is generally not used directly - by applications wishing to create, read, or manipulate zip archive files. - - - - - indicates the total number of bytes read on the CRC stream. - This is used when writing the ZipDirEntry when compressing files. - - - - - Indicates the current CRC for all blocks slurped in. - - - - - Returns the CRC32 for the specified stream. - - The stream over which to calculate the CRC32 - the CRC32 calculation - - - - Returns the CRC32 for the specified stream, and writes the input into the output stream. - - The stream over which to calculate the CRC32 - The stream into which to deflate the input - the CRC32 calculation - - - - Get the CRC32 for the given (word,byte) combo. - This is a computation defined by PKzip. - - The word to start with. - The byte to combine it with. - The CRC-ized result. - - - - Update the value for the running CRC32 using the given block of bytes. - This is useful when using the CRC32() class in a Stream. - - block of bytes to slurp - starting point in the block - how many bytes within the block to slurp - - - - A Stream that calculates a CRC32 (a checksum) on all bytes read, - or on all bytes written. - - - - - This class can be used to verify the CRC of a ZipEntry when reading from a stream, - or to calculate a CRC when writing to a stream. The stream should be used to either - read, or write, but not both. If you intermix reads and writes, the results are - not defined. - - This class is intended primarily for use internally by the DotNetZip library. - - - - - Gets the total number of bytes run through the CRC32 calculator. - - - - This is either the total number of bytes read, or the total number - of bytes written, depending on the direction of this stream. - - - - - The constructor. - - The underlying stream - - - - The constructor. - - The underlying stream - The length of the stream to slurp - - - - Provides the current CRC for all blocks slurped in. - - - - - Read from the stream - - the buffer to read - the offset at which to start - the number of bytes to read - the number of bytes actually read - - - - Write to the stream. - - the buffer from which to write - the offset at which to start writing - the number of bytes to write - - - - Indicates whether the stream supports reading. - - - - - Indicates whether the stream supports seeking. - - - - - Indicates whether the stream supports writing. - - - - - Flush the stream. - - - - - Not implemented. - - - - - Not implemented. - - - - - Not implemented. - - N/A - N/A - N/A - - - - Not implemented. - - N/A - - - a general purpose ASN.1 decoder - note: this class differs from the - others in that it returns null after it has read the last object in - the stream. If an ASN.1 Null is encountered a Der/BER Null object is - returned. - - - Create an ASN1InputStream where no DER object will be longer than limit. - - @param input stream containing ASN.1 encoded data. - @param limit maximum size of a DER encoded object. - - - Create an ASN1InputStream based on the input byte array. The length of DER objects in - the stream is automatically limited to the length of the input array. - - @param input array containing ASN.1 encoded data. - - - build an object given its tag and the number of bytes to construct it from. - - - Create a base ASN.1 object from a byte array. - The byte array to parse. - The base ASN.1 object represented by the byte array. - If there is a problem parsing the data. - - - Read a base ASN.1 object from a stream. - The stream to parse. - The base ASN.1 object represented by the byte array. - If there is a problem parsing the data. - - - return the object at the sequence position indicated by index. - - @param index the sequence number (starting at zero) of the object - @return the object at the sequence position indicated by index. - - - create an empty sequence - - - create a sequence containing one object - - - create a sequence containing a vector of objects. - - - - A - - - - - - A - - - A - - - - - - A - - - - - return a = a + b - b preserved. - - - unsigned comparison on two arrays - note the arrays may - start with leading zeros. - - - returns x = x - y - we assume x is >= y - - - diff --git a/packages/AWSSDK.Core.3.3.107.14/lib/netstandard2.0/AWSSDK.Core.dll b/packages/AWSSDK.Core.3.3.107.14/lib/netstandard2.0/AWSSDK.Core.dll deleted file mode 100644 index 5aabf34..0000000 Binary files a/packages/AWSSDK.Core.3.3.107.14/lib/netstandard2.0/AWSSDK.Core.dll and /dev/null differ diff --git a/packages/AWSSDK.Core.3.3.107.14/lib/netstandard2.0/AWSSDK.Core.xml b/packages/AWSSDK.Core.3.3.107.14/lib/netstandard2.0/AWSSDK.Core.xml deleted file mode 100644 index 4de522e..0000000 --- a/packages/AWSSDK.Core.3.3.107.14/lib/netstandard2.0/AWSSDK.Core.xml +++ /dev/null @@ -1,14736 +0,0 @@ - - - - AWSSDK.Core - - - - - An access control policy action identifies a specific action in a service - that can be performed on a resource. For example, sending a message to a - queue. - - ActionIdentifiers allow you to limit what your access control policy statement affects. - For example, you could create a policy statement that enables a certain group - of users to send messages to your queue, but not allow them to perform any - other actions on your queue. - - - The action is B in the statement - "A has permission to do B to C where D applies." - - Free form access control policy actions may include a wildcard (*) to match - multiple actions. - - - Constants for known actions can be found in the Amazon.Auth.AccessControlPolicy.ActionIdentifiers namespace. - - - - - - Constructs an Actionidentifer with the given action name. - - The name of the action - - - - Gets and sets the name of this action. For example, 'sqs:SendMessage' is the - name corresponding to the SQS action that enables users to send a message - to an SQS queue. - - - - - The available AWS access control policy actions for Amazon AppStream. - - - - - - The available AWS access control policy actions for Auto Scaling. - - - - - - The available AWS access control policy actions for AWS Billing. - - - - - - The available AWS access control policy actions for AWS CloudFormation. - - - - - - The available AWS access control policy actions for Amazon CloudFront. - - - - - - The available AWS access control policy actions for Amazon CloudSearch. - - - - - - The available AWS access control policy actions for AWS CloudTrail. - - - - - - The available AWS access control policy actions for Amazon CloudWatch. - - - - - - The available AWS access control policy actions for Amazon CloudWatch Logs. - - - - - - The available AWS access control policy actions for Amazon Cognito Identity. - - - - - - The available AWS access control policy actions for Amazon Cognito Sync. - - - - - - The available AWS access control policy actions for AWS Direct Connect. - - - - - - The available AWS access control policy actions for Amazon DynamoDB. - - - - - - The available AWS access control policy actions for Amazon EC2. - - - - - - The available AWS access control policy actions for AWS ElastiCache. - - - - - - The available AWS access control policy actions for AWS Elastic Beanstalk. - - - - - - The available AWS access control policy actions for Elastic Load Balancing. - - - - - - The available AWS access control policy actions for Amazon Elastic MapReduce. - - - - - - The available AWS access control policy actions for Amazon Elastic Transcoder. - - - - - - The available AWS access control policy actions for Amazon Glacier. - - - - - - The available AWS access control policy actions for AWS Identity and Access Management. - - - - - - The available AWS access control policy actions for AWS Import Export. - - - - - - The available AWS access control policy actions for Amazon Kinesis. - - - - - - The available AWS access control policy actions for AWS Marketplace. - - - - - - The available AWS access control policy actions for AWS Marketplace Management Portal. - - - - - - The available AWS access control policy actions for Amazon Mobile Analytics. - - - - - - The available AWS access control policy actions for AWS OpsWorks. - - - - - - The available AWS access control policy actions for Amazon RDS. - - - - - - The available AWS access control policy actions for Amazon Redshift. - - - - - - The available AWS access control policy actions for Amazon Route 53. - - - - - - The available AWS access control policy actions for Amazon S3. - - - - - - The available AWS access control policy actions for AWS Security Token Service. - - - - - - The available AWS access control policy actions for Amazon SES. - - - - - - The available AWS access control policy actions for Amazon SimpleDB. - - - - - - The available AWS access control policy actions for Amazon Simple Workflow Service. - - - - - - The available AWS access control policy actions for Amazon SNS. - - - - - - The available AWS access control policy actions for Amazon SQS. - - - - - - The available AWS access control policy actions for Amazon Storage Gateway. - - - - - - The available AWS access control policy actions for AWS Whispersync. - - - - - - The available AWS access control policy actions for Amazon Zocalo. - - - - - - AWS access control policy conditions are contained in - objects, and affect when a statement is applied. For example, a statement - that allows access to an Amazon SQS queue could use a condition to only apply - the effect of that statement for requests that are made before a certain - date, or that originate from a range of IP addresses. - - Multiple conditions can be included in a single statement, and all conditions - must evaluate to true in order for the statement to take effect. - - - The set of conditions is D in the statement - "A has permission to do B to C where D applies." - - - A condition is composed of three parts: - - - Condition Key - The condition key declares which value of a - request to pull in and compare against when a policy is evaluated by AWS. For - example, using will cause - AWS to pull in the current request's source IP as the first value to compare - against every time your policy is evaluated. - - - - Comparison Type - This is a static value used as the second value - in the comparison when your policy is evaluated. Depending on the comparison - type, this value can optionally use wildcards. See the documentation for - individual comparison types for more information. - - - - Comparison Value - This is a static value used as the second value - in the comparison when your policy is evaluated. Depending on the comparison - type, this value can optionally use wildcards. See the documentation for - individual comparison types for more information. - - - - - - - - - Gets the type of this condition. - - - - - Gets and Sets the name of the condition key involved in this condition. - Condition keys are predefined values supported by AWS that provide input - to a condition's evaluation, such as the current time, or the IP address - of the incoming request. - - Your policy is evaluated for each incoming request, and condition keys - specify what information to pull out of those incoming requests and plug - into the conditions in your policy. - - - - - - Gets and Sets the values specified for this access control policy condition. - For example, in a condition that compares the incoming IP address of a - request to a specified range of IP addresses, the range of IP addresses - is the single value in the condition. - - Most conditions accept only one value, but multiple values are possible. - - - - - - A factory for creating conditions to be used in the policy. - - - - - Condition key for the current time. - - This condition key should only be used with enum. - - - - - - Condition key for whether or not an incoming request is using a secure - transport to make the request (i.e. HTTPS instead of HTTP). - - This condition key should only be used with the boolean overload of NewCondition. - - - - - - Condition key for the source IP from which a request originates. - - This condition key should only be used with enum. - - - - - - Condition key for the user agent included in a request. - - This condition key should only be used with - enum. - - - - - - Condition key for the current time, in epoch seconds. - - This condition key should only be used with enum. - objects. - - - - - - Condition key for the referrer specified by a request. - - This condition key should only be used with - objects. - - - - - - Condition key for the Amazon Resource Name (ARN) of the source specified - in a request. The source ARN indicates which resource is affecting the - resource listed in your policy. For example, an SNS topic is the source - ARN when publishing messages from the topic to an SQS queue. - - This condition key should only be used with enum. - - - - - - Enumeration of the supported ways an ARN comparison can be evaluated. - - - - Exact matching - - - - Loose case-insensitive matching of the ARN. Each of the six - colon-delimited components of the ARN is checked separately and each - can include a multi-character match wildcard (*) or a - single-character match wildcard (?). - - - - Negated form of ArnEquals - - - Negated form of ArnLike - - - - Enumeration of the supported ways a date comparison can be evaluated. - - - - - Enumeration of the supported ways an IP address comparison can be evaluated. - - - - - Matches an IP address against a CIDR IP range, evaluating to true if - the IP address being tested is in the condition's specified CIDR IP - range. - - - - - Negated form of IpAddress - - - - - Enumeration of the supported ways a numeric comparison can be evaluated - - - - - Enumeration of the supported ways a string comparison can be evaluated. - - - - - Case-sensitive exact string matching - - - - - Case-insensitive string matching - - - - - Loose case-insensitive matching. The values can include a - multi-character match wildcard (*) or a single-character match - wildcard (?) anywhere in the string. - - - - - Negated form of StringEquals. - - - - - Negated form of StringEqualsIgnorecase. - - - - - Negated form of StringLike. - - - - - Constructs a new access control policy condition that compares ARNs (Amazon Resource Names). - - The access policy condition key specifying where to get the first ARN for the comparison - The type of comparison to perform. - The second ARN to compare against. When using ArnLike or ArnNotLike this may contain the - multi-character wildcard (*) or the single-character wildcard - - - - Constructs a new access policy condition that performs a boolean - comparison. - - The access policy condition key specifying where to get the - first boolean value for the comparison (ex: aws:SecureTransport). - The boolean to compare against. - - - - This method is deprecated. Invoking this method results in non-UTC DateTimes - not being marshalled correctly. Use NewConditionUtc instead. - Constructs a new access policy condition that compares the current time - (on the AWS servers) to the specified date. - - The type of comparison to perform. For example, - DateComparisonType.DateLessThan will cause this policy - condition to evaluate to true if the current date is less than - the date specified in the second argument. - The date to compare against. - - - - Constructs a new access policy condition that compares the current time - (on the AWS servers) to the specified date. - - The type of comparison to perform. For example, - DateComparisonType.DateLessThan will cause this policy - condition to evaluate to true if the current date is less than - the date specified in the second argument. - The date to compare against. - - - - Constructs a new access policy condition that compares the source IP - address of the incoming request to an AWS service against the specified - CIDR range. The condition evaluates to true (meaning the policy statement - containing it will be applied) if the incoming source IP address is - within that range. - - To achieve the opposite effect (i.e. cause the condition to evaluate to - true when the incoming source IP is not in the specified CIDR - range) use the alternate constructor form and specify - IpAddressComparisonType.NotIpAddress. - - - The CIDR IP range involved in the policy condition. - - - - Constructs a new access policy condition that compares the source IP - address of the incoming request to an AWS service against the specified - CIDR range. When the condition evaluates to true (i.e. when the incoming - source IP address is within the CIDR range or not) depends on the - specified IpAddressComparisonType. - - The type of comparison to to perform. - The CIDR IP range involved in the policy condition. - - - - Constructs a new access policy condition that compares two numbers. - - The type of comparison to perform. - The access policy condition key specifying where to get the - first number for the comparison. - The second number to compare against. - - - - Constructs a new access control policy condition that compares two - strings. - - The type of comparison to perform - The access policy condition key specifying where to get the - first string for the comparison (ex: aws:UserAgent). - - The second string to compare against. When using - StringComparisonType.StringLike or - StringComparisonType.StringNotLike this may contain - the multi-character wildcard (*) or the single-character - wildcard (?). - - - - - Constructs a new access policy condition that compares the Amazon - Resource Name (ARN) of the source of an AWS resource that is modifying - another AWS resource with the specified pattern. - - For example, the source ARN could be an Amazon SNS topic ARN that is - sending messages to an Amazon SQS queue. In that case, the SNS topic ARN - would be compared the ARN pattern specified here. - - - The endpoint pattern may optionally contain the multi-character wildcard - * (*) or the single-character wildcard (?). Each of the six colon-delimited - components of the ARN is checked separately and each can include a - wildcard. - - - Policy policy = new Policy("MyQueuePolicy"); - policy.WithStatements(new Statement(Statement.StatementEffect.Allow) - .WithPrincipals(new Principal("*")).WithActionIdentifiers(SQSActionIdentifiers.SendMessage) - .WithResources(new Resource(myQueueArn)) - .WithConditions(ConditionFactory.NewSourceArnCondition(myTopicArn))); - - - The ARN pattern against which the source ARN will be compared. - Each of the six colon-delimited components of the ARN is - checked separately and each can include a wildcard. - A new access control policy condition that compares the ARN of - the source specified in an incoming request with the ARN pattern - specified here. - - - - Constructs a new access control policy condition that tests if the - incoming request was sent over a secure transport (HTTPS). - - A new access control policy condition that tests if the incoming - request was sent over a secure transport (HTTPS). - - - - Condition key for the canned ACL specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the location constraint specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the prefix specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the delimiter specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the max keys specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the source object specified by a request to copy an - object. - - This condition key may only be used with enum. - - - - - - Condition key for the metadata directive specified by a request to copy - an object. - - This condition key may only be used with enum. - - - - - - Condition key for the version ID of an object version specified by a - request. - - This condition key may only be used with enum. - - - - - - Constructs a new access policy condition that compares an Amazon S3 - canned ACL with the canned ACL specified by an incoming request. - - You can use this condition to ensure that any objects uploaded to an - Amazon S3 bucket have a specific canned ACL set. - - - The Amazon S3 canned ACL to compare against. - A new access control policy condition that compares the Amazon S3 - canned ACL specified in incoming requests against the value - specified. - - - - Condition key for The URL, e-mail address, or ARN from a Subscribe - request or a previously confirmed subscription. Use with string - conditions to restrict access to specific endpoints (e.g., - *@mycompany.com). - - This condition key may only be used with enum. - - - - - - Condition key for the protocol value from a Subscribe request or a - previously confirmed subscription. Use with string conditions to restrict - publication to specific delivery protocols (e.g., HTTPS). - - This condition key may only be used with enum. - - - - - - Constructs a new access policy condition that compares the requested - endpoint used to subscribe to an Amazon SNS topic with the specified - endpoint pattern. The endpoint pattern may optionally contain the - multi-character wildcard (*) or the single-character wildcard (?). - - For example, this condition can restrict subscriptions to a topic to - email addresses in a certain domain ("*@my-company.com"). - - - Policy policy = new Policy("MyTopicPolicy"); - policy.WithStatements(new Statement(Statement.StatementEffect.Allow) - .WithPrincipals(new Principal("*")).WithActionIdentifiers(SNSActionIdentifiers.Subscribe) - .WithResources(new Resource(myTopicArn)) - .WithConditions(ConditionFactory.NewEndpointCondition("*@my-company.com"))); - - - The endpoint pattern against which to compare the requested - endpoint for an Amazon SNS topic subscription. - A new access control policy condition that compares the endpoint - used in a request to subscribe to an Amazon SNS topic with the - endpoint pattern specified. - - - - Constructs a new AWS access control policy condition that allows an - access control statement to restrict subscriptions to an Amazon SNS topic - based on the protocol being used for the subscription. For example, this - condition can restrict subscriptions to a topic to endpoints using HTTPS - to ensure that messages are securely delivered. - - The protocol against which to compare the requested protocol - for an Amazon SNS topic subscription. - A new access control policy condition that compares the - notification protocol requested in a request to subscribe to an - Amazon SNS topic with the protocol value specified. - - - - Deserializes a JSON string into a AWS policy object. - - - - - Serializes an AWS policy object to a JSON string, suitable for sending to an - AWS service. - - - - Converts the specified AWS policy object to a JSON string, suitable for - passing to an AWS service. - - @param policy - The AWS policy object to convert to a JSON string. - - @return The JSON string representation of the specified policy object. - - @throws IllegalArgumentException - If the specified policy is null or invalid and cannot be - serialized to a JSON string. - - - - Uses the specified generator to write the JSON data for the principals in - the specified policy statement. - - - - - This sorts the conditions by condition type and key with the list of values for that combination. - - The list of conditions to be sorted. - - - - - An AWS access control policy is a object that acts as a container for one or - more statements, which specify fine grained rules for allowing or denying - various types of actions from being performed on your AWS resources. - - By default, all requests to use your resource coming from anyone but you are - denied. Access control polices can override that by allowing different types - of access to your resources, or by explicitly denying different types of - access. - - - Each statement in an AWS access control policy takes the form: - "A has permission to do B to C where D applies". - - - A is the prinicpal - The AWS account that is making a request to - access or modify one of your AWS resources. - - - - B is the action - the way in which your AWS resource is being accessed or modified, such - as sending a message to an Amazon SQS queue, or storing an object in an Amazon S3 bucket. - - - - C is the resource - your AWS entity that the principal wants to access, such - as an Amazon SQS queue, or an object stored in Amazon S3. - - - - D is the set of conditions - optional constraints that specify when to allow or deny - access for the principal to access your resource. Many expressive conditions are available, - some specific to each service. For example you can use date conditions to allow access to - your resources only after or before a specific time. - - - - - - Note that an AWS access control policy should not be confused with the - similarly named "POST form policy" concept used in Amazon S3. - - - - - - The default policy version - - - - - Constructs an empty AWS access control policy ready to be populated with - statements. - - - - - Constructs a new AWS access control policy with the specified policy ID. - The policy ID is a user specified string that serves to help developers - keep track of multiple polices. Policy IDs are often used as a human - readable name for a policy. - - The policy ID for the new policy object. Policy IDs serve to - help developers keep track of multiple policies, and are often - used to give the policy a meaningful, human readable name. - - - - Constructs a new AWS access control policy with the specified policy ID - and collection of statements. The policy ID is a user specified string - that serves to help developers keep track of multiple polices. Policy IDs - are often used as a human readable name for a policy. - - The policy ID for the new policy object. Policy IDs serve to - help developers keep track of multiple policies, and are often - used to give the policy a meaningful, human readable name. - The statements to include in the new policy. - - - - Gets and Sets the policy ID for this policy. Policy IDs serve to help - developers keep track of multiple policies, and are often used as human - readable name for a policy. - - - - - Sets the policy ID for this policy and returns the updated policy so that - multiple calls can be chained together. - - Policy IDs serve to help developers keep track of multiple policies, and - are often used as human readable name for a policy. - - - The polich ID for this policy - this instance - - - - Gets and sets the version of this AWS policy. - - - - - Gets and Sets the collection of statements contained by this policy. Individual - statements in a policy are what specify the rules that enable or disable - access to your AWS resources. - - - - - Checks to see if the permissions set in the statement are already set by another - statement in the policy. - - The statement to verify - True if the statement's permissions are already allowed by the statement - - - - Sets the collection of statements contained by this policy and returns - this policy object so that additional method calls can be chained - together. - - Individual statements in a policy are what specify the rules that enable - or disable access to your AWS resources. - - - The collection of statements included in this policy. - this instance - - - - Returns a JSON string representation of this AWS access control policy, - suitable to be sent to an AWS service as part of a request to set an - access control policy. - - A JSON string representation of this AWS access control policy. - - - - Returns a JSON string representation of this AWS access control policy, - suitable to be sent to an AWS service as part of a request to set an - access control policy. - - Toggle pretty print for the generated JSON document - A JSON string representation of this AWS access control policy. - - - - Parses a JSON document of a policy and creates a Policy object. - - JSON document of a policy. - - - - - A principal is an AWS account which is being allowed or denied access to a - resource through an access control policy. The principal is a property of the - Statement object, not directly the object. - - The principal is A in the statement - "A has permission to do B to C where D applies." - - - In an access control policy statement, you can set the principal to all - authenticated AWS users through the member. This - is useful when you don't want to restrict access based on the identity of the - requester, but instead on other identifying characteristics such as the - requester's IP address. - - - - - - Principal instance that includes all authenticated AWS users. - - This is useful when you don't want to restrict access based on the - identity of the requester, but instead on other identifying - characteristics such as the requester's IP address. - - - - - - The anonymous Principal. - - - - - The default Principal provider for AWS accounts. - - - - - Principal provider for Canonical User IDs. - - - - - Principal provider for federated users (using a SAML identity provider) - - - - - Principal provider for assume role policies that will be assumed by an AWS service - (e.g. "ec2.amazonaws.com"). - - - - - Dummy principal provider for anonynous. - - - - - Constructs a new principal with the specified AWS account ID. - - An AWS account ID. - - - - Constructs a new principal with the specified provider and id - - The provider of the principal - The unique ID of the Principal within the provider - - - - Constructs a new principal with the specified provider and id - and optionally strips hyphens from the id - - The provider of the principal - The unique ID of the Principal within the provider - Strip hyphen - - - - Gets and sets the provider for this principal, which indicates in what group of - users this principal resides. - - - - - Gets the unique ID for this principal. - - - - - Represents a resource involved in an AWS access control policy statement. - Resources are the service specific AWS entities owned by your account. Amazon - SQS queues, Amazon S3 buckets and objects, and Amazon SNS topics are all - examples of AWS resources. - - The standard way of specifying an AWS resource is with an Amazon Resource - Name (ARN). - - - The resource is C in the statement - "A has permission to do B to C where D applies." - - - - - - Constructs a new AWS access control policy resource. Resources are - typically specified as Amazon Resource Names (ARNs). - - You specify the resource using the following Amazon Resource Name (ARN) - format: arn:aws:<vendor>:<region>:<namespace>:<relative-id> - - - >vendor identifies the AWS product (e.g., sns) - - - region is the AWS Region the resource resides in (e.g., us-east-1), if any - - - namespace is the AWS account ID with no hyphens (e.g., 123456789012) - - - relative-id is the service specific portion that identifies the specific resource - - - - - For example, an Amazon SQS queue might be addressed with the following - ARN: arn:aws:sqs:us-east-1:987654321000:MyQueue - - - Some resources may not use every field in an ARN. For example, resources - in Amazon S3 are global, so they omit the region field: - arn:aws:s3:::bucket/* - - - The Amazon Resource Name (ARN) uniquely identifying the desired AWS resource. - - - - Gets the resource ID, typically an Amazon Resource Name (ARN), - identifying this resource. - - - - - A factory for creating resources to be used in the policy. - - - - - Constructs a new bucket resource that represents the the specified bucket - but not any of the contained objects. - - The name of the bucket represented by this AWS access control - policy resource. - - - - Constructs a new object resource that represents the specified objects. - The keyPattern argument may contain the '*' wildcard to match multiple - objects. For example, an object resource created for bucket 'mybucket' - and key pattern 'foo*' will match any object stored in 'mybucket' with a - key that starts with 'foo'. - - The name of the bucket containing the object or objects - represented by this resource. - The key or key pattern, which can optionally contain the '*' - wildcard to include multiple objects in the resource. - - - - Constructs a new SQS queue resource for an access control policy. A - policy statement using this resource will allow or deny actions on the - specified queue. - - The AWS account ID of the queue owner. - The name of the Amazon SQS queue. - - - - A statement is the formal description of a single permission, and is always - contained within a policy object. - - A statement describes a rule for allowing or denying access to a specific AWS - resource based on how the resource is being accessed, and who is attempting - to access the resource. Statements can also optionally contain a list of - conditions that specify when a statement is to be honored. - - - For example, consider a statement that: - - - A is the prinicpal - The AWS account that is making a request to - access or modify one of your AWS resources. - - - - B is the action - the way in which your AWS resource is being accessed or modified, such - as sending a message to an Amazon SQS queue, or storing an object in an Amazon S3 bucket. - - - - C is the resource - your AWS entity that the principal wants to access, such - as an Amazon SQS queue, or an object stored in Amazon S3. - - - - D is the set of conditions - optional constraints that specify when to allow or deny - access for the principal to access your resource. Many expressive conditions are available, - some specific to each service. For example you can use date conditions to allow access to - your resources only after or before a specific time. - - - - - - There are many resources and conditions available for use in statements, and - you can combine them to form fine grained custom access control polices. - - - - - - The effect is the result that you want a policy statement to return at - evaluation time. A policy statement can either allow access or explicitly - deny access. - - - - - Constructs a new access control policy statement with the specified - effect. - - Before a statement is valid and can be sent to AWS, callers must set the - principals, resources, and actions (as well as any optional conditions) - involved in the statement. - - - The effect this statement has (allowing access or denying - access) when all conditions, resources, principals, and - actions are matched. - - - - Gets and Sets the ID for this statement. Statement IDs serve to help keep track - of multiple statements, and are often used to give the statement a - meaningful, human readable name. - - Developers should be careful to not use the same statement ID for - multiple statements in the same policy. Reusing the same statement ID in - different policies is not a problem. - - - - - - Sets the ID for this statement and returns the updated statement so - multiple calls can be chained together. - - Statement IDs serve to help keep track of multiple statements, and are - often used to give the statement a meaningful, human readable name. - - - Developers should be careful to not use the same statement ID for - multiple statements in the same policy. Reusing the same statement ID in - different policies is not a problem. - - - The new statement ID for this statement. - this instance - - - - Gets and Sets the result effect of this policy statement when it is evaluated. - A policy statement can either allow access or explicitly - - - - - Gets and Sets the list of actions to which this policy statement applies. - Actions limit a policy statement to specific service operations that are - being allowed or denied by the policy statement. For example, you might - want to allow any AWS user to post messages to your SQS queue using the - SendMessage action, but you don't want to allow those users other actions - such as ReceiveMessage or DeleteQueue. - - - - - Sets the list of actions to which this policy statement applies and - returns this updated Statement object so that additional method calls can - be chained together. - - Actions limit a policy statement to specific service operations that are - being allowed or denied by the policy statement. For example, you might - want to allow any AWS user to post messages to your SQS queue using the - SendMessage action, but you don't want to allow those users other actions - such as ReceiveMessage or DeleteQueue. - - - The list of actions to which this statement applies. - this instance - - - - Gets and Sets the resources associated with this policy statement. Resources - are what a policy statement is allowing or denying access to, such as an - Amazon SQS queue or an Amazon SNS topic. - - Note that some services allow only one resource to be specified per - policy statement. - - - - - - Sets the resources associated with this policy statement and returns this - updated Statement object so that additional method calls can be chained - together. - - Resources are what a policy statement is allowing or denying access to, - such as an Amazon SQS queue or an Amazon SNS topic. - - - Note that some services allow only one resource to be specified per - policy statement. - - - The resources associated with this policy statement. - this instance - - - - Gets and Sets the conditions associated with this policy statement. Conditions - allow policy statements to be conditionally evaluated based on the many - available condition types. - - For example, a statement that allows access to an Amazon SQS queue could - use a condition to only apply the effect of that statement for requests - that are made before a certain date, or that originate from a range of IP - addresses. - - - When multiple conditions are included in a single statement, all - conditions must evaluate to true in order for the statement to take - effect. - - - - - - Sets the conditions associated with this policy statement, and returns - this updated Statement object so that additional method calls can be - chained together. - - Conditions allow policy statements to be conditionally evaluated based on - the many available condition types. - - - For example, a statement that allows access to an Amazon SQS queue could - use a condition to only apply the effect of that statement for requests - that are made before a certain date, or that originate from a range of IP - addresses. - - - Multiple conditions can be included in a single statement, and all - conditions must evaluate to true in order for the statement to take - effect. - - - The conditions associated with this policy statement. - this instance - - - - Gets and Sets the principals associated with this policy statement, indicating - which AWS accounts are affected by this policy statement. - - - - - Sets the principals associated with this policy statement, and returns - this updated Statement object. Principals control which AWS accounts are - affected by this policy statement. - - If you don't want to restrict your policy to specific users, you can use - to apply the policy to any user trying to - access your resource. - - - The list of principals associated with this policy statement. - this instance - - - - Exception thrown by the SDK for errors that occur within the SDK. - - - - - This exception is thrown when there is a parse error on the response back from AWS. - - - - - The string value which could not be converted into a valid DateTime instance. - - - - - Occurs before a request is marshalled. - - - - - Occurs before a request is issued against the service. - - - - - Occurs after a response is received from the service. - - - - - Occurs after an exception is encountered. - - - - - Patches the in-flight uri to stop it unescaping the path etc (what Uri did before - Microsoft deprecated the constructor flag). This is particularly important for - Amazon S3 customers who want to use backslash (\) in their key names. - - - Different behavior in the various runtimes has been observed and in addition some - 'documented' ways of doing this between 2.x and 4.x runtimes has also been observed - to not be reliable. - - This patch effectively emulates what adding a schemesettings element to the - app.config file with value 'name="http" genericUriParserOptions="DontUnescapePathDotsAndSlashes"' - does. As we're a dll, that avenue is not open to us. - - - - - - Used to create a copy of the config for a different service than the current instance. - - Target service ClientConfig - The new ClientConfig for the desired service - - - - A base exception for some Amazon Web Services. - - Most exceptions thrown to client code will be service-specific exceptions, though some services - may throw this exception if there is a problem which is caught in the core client code. - - - - - - Whether the error was attributable to Sender or Reciever. - - - - - The error code returned by the service - - - - - The id of the request which generated the exception. - - - - - The HTTP status code from the service response - - - - - Flag indicating if the exception is retryable and the associated retry - details. A null value indicates that the exception is not retryable. - - - - - Class containing the retryable details for an AmazonServiceException - - - - - This property indicates that this exception is a - throttling exception and should be subject to congestion - control throttling. - - - - - This exception is thrown when there is a parse error on the response back from AWS. - - - - - Last known location in the response that was parsed, if available. - - - - - The entire response body that caused this exception, if available. - - - - - Base class for request used by some of the services. - - - - - This flag specifies if SigV4 will be used for the current request. - - - - - Gets or Sets a value indicating if "Expect: 100-continue" HTTP header will be - sent by the client for this request. The default value is false. - - - - - Gets the signer to use for this request. - A null return value indicates to use the configured - signer for the service that this request is part of. - - A signer for this request, or null. - - - - Abstract class for Response objects, contains only metadata, - and no result information. - - - - - Contains additional information about the request, such as the - Request Id. - - - - - Returns the content length of the HTTP response. - - - - - Returns the status code of the HTTP response. - - - - - Base class for determining region based on inspection. - - - - - Sets the Region property by looking up the corresponding RegionEndpoint - from the supplied region system name (us-east-1, us-west-2 etc). - - The system name of the region. - - - - Determines region based on application configuration settings. If the configuration does not contain - the region setting key an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of ApplicationConfigAWSRegion. If no region is found in the - application configuration file then an InvalidOperationException is thrown. - - - - - Determines region based on an environment variable. If the environment does not contain - the region setting key an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of EnvironmentVariableAWSRegion. If no region is found in the - environment then an InvalidOperationException is thrown. - - - - - Determines region based on inspection of the instance metadata if running on an EC2 instance. - If instance metadata cannot be read or does not contain region information an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of InstanceProfileAWSRegion. If no region is found in the - metadata or we are not running on an EC2 instance an InvalidOperationException is thrown. - - - - - Determines region based on a stored in an . - If the profile doesn't exist or there is no region information an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of . - If the AWS_PROFILE environment variable is set the instance will be constructed using that profile, - otherwise it will use the default profile. - - If the profile doesn't exist or there is no region information an InvalidOperationException is thrown. - - The ICredentialProfileSource to read the profile from. - - - - Attempts to construct an instance of . - If the profile doesn't exist or there is no region information an InvalidOperationException is thrown. - - The ICredentialProfileSource to read the profile from. - The name of the profile. - - - - Probing mechanism to determine region from various sources. - - - - - This class is responsible for keeping track of Retry capacity across different ServiceURLs. - - - - - CapacityType determines the type of capacity to obtain or use. - - - - - The increment capacity type adds capacity. - - - - - The default retry capacity type uses the default capacity amount. - - - - - The timeout capacity type uses the timeout capacity amount. - - - - - This method acquires a said retry capacity if the container has the capacity. - - Contains the RetryCapacity object for the said ServiceURL. - - - - This method acquires a said retry capacity if the container has the capacity. - - Contains the RetryCapacity object for the said ServiceURL. - Specifies what capacity type cost to use for obtaining capacity - - - - This method calls a method to release capacity back - based on whether it was a successful response or a successful retry response. This is invoked by a retry request response. - - if this request is a retry, use a different capacity cost - Contains the RetryCapacity object for the said ServiceURL. - - - - This method calls a method to release capacity back - based on whether it was a successful response or a successful retry response. This is invoked by a retry request response. - - Specifies what capacity type cost to use for adding capacity - Contains the RetryCapacity object for the said ServiceURL. - - - - Ths method fetches the RetryCapacity for the given ServiceURL from CapacityManager.CapacityContainer - - - - - This method releases capacity back. This is invoked by the TryReleaseCapacity method. - - Contains the RetryCapacity object for the said ServiceURL. - The capacity that needs to be released based on whether it was a successful response or a successful retry response. - - - - This class is the RetryCapacity class for a given ServiceURL. - - - - - This class composes Client Context header for Amazon Web Service client. - It contains information like app title, version code, version name, client id, OS platform etc. - - - - - Adds the custom attributes to the Client Context. - - Key. - Value. - - - - Gets a Json Representation of the Client Context. - - Json Representation of Client Context - - - - Class to which the Json stdout from credential process is - de-serialized into. - - - - - Version of the Json payload - - - - - AWS Access key - - - - - AWS Secret key - - - - - AWS Session token for session credentials - - - - - ISO8601 formatted timestamp till when the credential is valid. - - - - - Computes RFC 2104-compliant HMAC signature. - - - - - Computes RFC 2104-compliant HMAC signature. - - - - - Inspects the supplied evidence to return the signer appropriate for the operation - - Global setting for the service - The request. - Configuration for the client - True if signature v4 request signing should be used - - - - Signs the specified request with the AWS3 signing protocol by using the - AWS account credentials given in the method parameters. - - The AWS public key - The AWS secret key used to sign the request in clear text - Request metrics - The configuration that specifies which hashing algorithm to use - The request to have the signature compute for - If any problems are encountered while signing the request - - - - AWS4 protocol signer for service calls that transmit authorization in the header field "Authorization". - - - - - Calculates and signs the specified request using the AWS4 signing protocol by using the - AWS account credentials given in the method parameters. The resulting signature is added - to the request headers as 'Authorization'. Parameters supplied in the request, either in - the resource path as a query string or in the Parameters collection must not have been - uri encoded. If they have, use the SignRequest method to obtain a signature. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. - - - Client configuration data encompassing the service call (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text. - - - If any problems are encountered while signing the request. - - - - - Calculates and signs the specified request using the AWS4 signing protocol by using the - AWS account credentials given in the method parameters. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. - - - Client configuration data encompassing the service call (notably authentication - region, endpoint and service name). - - - Metrics for the request. - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text. - - - If any problems are encountered while signing the request. - - - Parameters passed as part of the resource path should be uri-encoded prior to - entry to the signer. Parameters passed in the request.Parameters collection should - be not be encoded; encoding will be done for these parameters as part of the - construction of the canonical request. - - - - - Sets the AWS4 mandated 'host' and 'x-amz-date' headers, returning the date/time that will - be used throughout the signing process in various elements and formats. - - The current set of headers - - Date and time used for x-amz-date, in UTC - - - - Sets the AWS4 mandated 'host' and 'x-amz-date' headers, accepting and returning the date/time that will - be used throughout the signing process in various elements and formats. - - The current set of headers - - - Date and time used for x-amz-date, in UTC - - - - Computes and returns an AWS4 signature for the specified canonicalized request - - - - - - - - - - - - Computes and returns an AWS4 signature for the specified canonicalized request - - - - - - - - - - - - - Computes and returns an AWS4 signature for the specified canonicalized request - - - - - - - - - - - - - - Formats the supplied date and time for use in AWS4 signing, where various formats are used. - - - The required format - The UTC date/time in the requested format - - - - Compute and return the multi-stage signing key for the request. - - The clear-text AWS secret key, if not held in secureKey - The region in which the service request will be processed - Date of the request, in yyyyMMdd format - The name of the service being called by the request - Computed signing key - - - - If the caller has already set the x-amz-content-sha256 header with a pre-computed - content hash, or it is present as ContentStreamHash on the request instance, return - the value to be used in request canonicalization. - If not set as a header or in the request, attempt to compute a hash based on - inspection of the style of the request content. - - - - The computed hash, whether already set in headers or computed here. Null - if we were not able to compute a hash. - - - - - If signPayload is false set the x-amz-content-sha256 header to - the UNSIGNED-PAYLOAD magic string and return it. - Otherwise, if the caller has already set the x-amz-content-sha256 header with a pre-computed - content hash, or it is present as ContentStreamHash on the request instance, return - the value to be used in request canonicalization. - If not set as a header or in the request, attempt to compute a hash based on - inspection of the style of the request content. - - - - - The computed hash, whether already set in headers or computed here. Null - if we were not able to compute a hash. - - - - - Returns the HMAC256 for an arbitrary blob using the specified key - - - - - - - - Returns the HMAC256 for an arbitrary blob using the specified key - - - - - - - - Compute and return the hash of a data blob using the specified key - - Algorithm to use for hashing - Hash key - Data blob - Hash of the data - - - - Compute and return the hash of a data blob using the specified key - - Algorithm to use for hashing - Hash key - Data blob - Hash of the data - - - - Computes the non-keyed hash of the supplied data - - - - - - - Computes the non-keyed hash of the supplied data - - - - - - - Computes and returns the canonical request - - The endpoint URL - the path of the resource being operated on - The http method used for the request - The full request headers, sorted into canonical order - The query parameters for the request - - The hash of the binary request body if present. If not supplied, the routine - will look for the hash as a header on the request. - - Canonicalised request as a string - - - - Computes and returns the canonical request - - The endpoint URL - the path of the resource being operated on - The http method used for the request - The full request headers, sorted into canonical order - The query parameters for the request - - The path resource values lookup to use to replace the keys within resourcePath - The hash of the binary request body if present. If not supplied, the routine - will look for the hash as a header on the request. - - The version of the marshaller that constructed the request object. - Canonicalised request as a string - - - - Computes and returns the canonical request - - The endpoint URL - the path of the resource being operated on - The http method used for the request - The full request headers, sorted into canonical order - The query parameters for the request - - The path resource values lookup to use to replace the keys within resourcePath - The hash of the binary request body if present. If not supplied, the routine - will look for the hash as a header on the request. - - The version of the marshaller that constructed the request object. - The service being called for the request - Canonicalised request as a string - - - - Reorders the headers for the request for canonicalization. - - The set of proposed headers for the request - List of headers that must be included in the signature - For AWS4 signing, all headers are considered viable for inclusion - - - - Computes the canonical headers with values for the request. Only headers included in the signature - are included in the canonicalization process. - - All request headers, sorted into canonical order - Canonicalized string of headers, with the header names in lower case. - - - - Returns the set of headers included in the signature as a flattened, ;-delimited string - - The headers included in the signature - Formatted string of header names - - - - Collects the subresource and query string parameters into one collection - ready for canonicalization - - The in-flight request being signed - The fused set of parameters - - - - Computes and returns the canonicalized query string, if query parameters have been supplied. - Parameters with no value will be canonicalized as 'param='. The expectation is that parameters - have not already been url encoded prior to canonicalization. - - The set of parameters being passed on the uri - - Parameters must be uri encoded into the canonical request and by default the signer expects - that the supplied collection contains non-encoded data. Set this to false if the encoding was - done prior to signer entry. - - The uri encoded query string parameters in canonical ordering - - - - Computes and returns the canonicalized query string, if query parameters have been supplied. - Parameters with no value will be canonicalized as 'param='. The expectation is that parameters - have not already been url encoded prior to canonicalization. - - The set of parameters to be encoded in the query string - - Parameters must be uri encoded into the canonical request and by default the signer expects - that the supplied collection contains non-encoded data. Set this to false if the encoding was - done prior to signer entry. - - The uri encoded query string parameters in canonical ordering - - - - Returns the request parameters in the form of a query string. - - The request instance - Request parameters in query string format - - - - AWS4 protocol signer for Amazon S3 presigned urls. - - - - - Calculates and signs the specified request using the AWS4 signing protocol by using the - AWS account credentials given in the method parameters. The resulting signature is added - to the request headers as 'Authorization'. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. - - - Adding supporting data for the service call required by the signer (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text - - - If any problems are encountered while signing the request. - - - - - Calculates the AWS4 signature for a presigned url. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. If the Expires parameter - is present, it is renamed to 'X-Amz-Expires' before signing. - - - Adding supporting data for the service call required by the signer (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text - - - If any problems are encountered while signing the request. - - - Parameters passed as part of the resource path should be uri-encoded prior to - entry to the signer. Parameters passed in the request.Parameters collection should - be not be encoded; encoding will be done for these parameters as part of the - construction of the canonical request. - - - - - Calculates the AWS4 signature for a presigned url. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. If the Expires parameter - is present, it is renamed to 'X-Amz-Expires' before signing. - - - Adding supporting data for the service call required by the signer (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text - - - The service to sign for - - - The region to sign to, if null then the region the client is configured for will be used. - - - If any problems are encountered while signing the request. - - - Parameters passed as part of the resource path should be uri-encoded prior to - entry to the signer. Parameters passed in the request.Parameters collection should - be not be encoded; encoding will be done for these parameters as part of the - construction of the canonical request. - - The X-Amz-Content-SHA256 is cleared out of the request. - If the request is for S3 then the UNSIGNED_PAYLOAD value is used to generate the canonical request. - If the request isn't for S3 then the empty body SHA is used to generate the canonical request. - - - - - Encapsulates the various fields and eventual signing value that makes up - an AWS4 signature. This can be used to retrieve the required authorization string - or authorization query parameters for the final request as well as hold ongoing - signature computations for subsequent calls related to the initial signing. - - - - - Constructs a new signing result instance for a computed signature - - The access key that was included in the signature - Date/time (UTC) that the signature was computed - The collection of headers names that were included in the signature - Formatted 'scope' value for signing (YYYYMMDD/region/service/aws4_request) - Returns the key that was used to compute the signature - Computed signature - - - - The access key that was used in signature computation. - - - - - ISO8601 formatted date/time that the signature was computed - - - - - ISO8601 formatted date that the signature was computed - - - - - The ;-delimited collection of header names that were included in the signature computation - - - - - Formatted 'scope' value for signing (YYYYMMDD/region/service/aws4_request) - - - - - Returns a copy of the key that was used to compute the signature - - - - - Returns the hex string representing the signature - - - - - Returns a copy of the byte array containing the signature - - - - - Returns the signature in a form usable as an 'Authorization' header value. - - - - - Returns the signature in a form usable as a set of query string parameters. - - - - - Null Signer which does a no-op. - - - - - Signs the specified request with the AWS2 signing protocol by using the - AWS account credentials given in the method parameters. - - The AWS public key - The AWS secret key used to sign the request in clear text - Request metrics - The configuration that specifies which hashing algorithm to use - The request to have the signature compute for - If any problems are encountered while signing the request - - - - S3 signer constructor - - - - - S3 signer constructor - - - - - This exception is thrown if there are problems signing the request. - - - - - Collection used to indicate if the property was initialized was created by the SDK. - - - - - - Collection used to indicate if the property was initialized was created by the SDK. - - - - - - - Default implementation of the IRequest interface. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Constructs a new DefaultRequest with the specified service name and the - original, user facing request object. - - The orignal request that is being wrapped - The service name - - - - The name of the request - - - - - Gets and sets the type of http request to make, whether it should be POST,GET or DELETE - - - - - Gets and sets a flag that indicates whether the request is sent as a query string instead of the request body. - - - - - Returns the original, user facing request object which this internal - request object is representing. - - - - - Returns a dictionary of the headers included in this request. - - - - - Returns a dictionary of the parameters included in this request. - - - - - Collection of parameters included in this request. - - - - - Returns the subresources that should be appended to the resource path. - This is used primarily for Amazon S3, where object keys can contain '?' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new null entry to the SubResources collection for the request - - The name of the subresource - - - - Adds a new entry to the SubResources collection for the request - - The name of the subresource - Value of the entry - - - - Gets and Sets the endpoint for this request. - - - - - Gets and Sets the resource path added on to the endpoint. - - - - - Returns the path resources that should be used within the resource path. - This is used for services where path keys can contain '/' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new entry to the PathResources collection for the request - - The name of the pathresource with potential greedy syntax: {key+} - Value of the entry - - - - Gets and Sets the version number for the marshaller used to create this request. The version number - is used to support backward compatible changes that would otherwise be breaking changes when a - newer core is used with an older service assembly. - Versions: - 1 - Default version - 2 - Support for path segments - - - - - Gets and Sets the content for this request. - - - - - Flag that signals that Content was and should be set - from the Parameters collection. - - - - - Gets and sets the content stream. - - - - - Gets and sets the original stream position. - If ContentStream is null or does not support seek, this propery - should be equal to -1. - - - - - Computes the SHA 256 hash of the content stream. If the stream is not - seekable, it searches the parent stream hierarchy to find a seekable - stream prior to computation. Once computed, the hash is cached for future - use. If a suitable stream cannot be found to use, null is returned. - - - - - The name of the service to which this request is being sent. - - - - - Alternate endpoint to use for this request, if any. - - - - - Host prefix value to prepend to the endpoint for this request, if any. - - - - - Gets and sets the Suppress404Exceptions property. If true then 404s return back from AWS will not cause an exception and - an empty response object will be returned. - - - - - If using AWS4 signing protocol, contains the resultant parts of the - signature that we may need to make use of if we elect to do a chunked - encoding upload. - - - - - Determine whether to use a chunked encoding upload for the request - (applies to Amazon S3 PutObject and UploadPart requests only). - - - - - - Used for Amazon S3 requests where the bucket name is removed from - the marshalled resource path into the host header. To comply with - AWS2 signature calculation, we need to recover the bucket name - and include it in the resource canonicalization, which we do using - this field. - - - - - This flag specifies if SigV4 is required for the current request. - - - - - The authentication region to use for the request. - Set from Config.AuthenticationRegion. - - - - - The region in which the service request was signed. - - - - - Checks if the request stream can be rewinded. - - Returns true if the request stream can be rewinded , - else false. - - - - Returns true if the request can contain a request body, else false. - - Returns true if the currect request can contain a request body, else false. - - - - Returns true if the request has a body, else false. - - Returns true if the request has a body, else false. - - - - Class containing the data for one endpoint returned from a endpoint discovery request - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Constructs a new DiscoveryEndpoint - - The address of the endpoint - The cache period for the endpoint in minutes - - - - The address of the endpoint. - - - - - The cache period for the endpoint in minutes - - - - - Calculates if this endpoint has expired - - A boolean value indicating if the cache period has expired - - - - Extends the endpoint expiration by the specified number of minutes from now. - - - - - Class containing the data for one endpoint returned from a endpoint discovery request - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class containing the data to use with endpoint discovery - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Gets/sets and flag indicating if endpoint discovery is required for the request. - - - - - Sorted dictionary of the identifiers that must be sent with the endpoint discovery request. These - identifiers are used to construct the cache key for the cache that stores discovered endpoints. A - sorted dictionary is used instead of a dictionary to ensure the cache key comes out in the same order - each time it is constructed. - - - - - Represents the data to be used with endpoint discovery operations - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class used to resolve endpoints using Endpoint Discovery. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Method that performs endpoint discovery for the current operation - - Context information used in calculations for endpoint discovery - The operation to fetch endpoints from the server - - - - - Gets the number of cache keys in the cache - - - - - Class used to resolve endpoints using Endpoint Discovery. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class containing context information to use with endpoint discovery - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Gets the customer credential information. - - - - - Gets the operation name. - - - - - Gets the current marshalled endpoint discovery data. - - - - - Gets the flag indicating if the specified key should be evicted from the cache. - - - - - Gets the Uri that should be evicted if EvictCacheKey is set to true. - - - - - Class containing context information to use with endpoint discovery - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Error type, one of Sender, Receiver, Unknown - Only applies to XML-based services. - - - - - Name of the exception class to return - - - - - Error message - - - - - RequestId of the error. - Only applies to XML-based services. - - - - - InternalConfiguration holds the cached SDK configuration values - obtained from the environment and profile configuration - factories. These configuration values are loaded internally and - are not the same as user exposed AWSConfigs. - - - - - Flag indicating if Endpoint Discovery is enabled. - - - - - The retry mode to use: Legacy, Standard, or Adaptive. - - - - - The max number of request attempts. - - - - - Determines the configuration values based on environment variables. If - no values is found for a configuration the value will be set to null. - - - - - Attempts to construct a configuration instance of configuration environment - variables. If an environment variable value isn't found then the individual value - for that environment variable will be null. If unable to obtain a value converter - to convert a configuration string to the appropriate type a InvalidOperationException - is thrown. - - - - - Determines configuration values based on a stored in an . - If the profile doesn't exist, the status will be logged and no value will be set in the configuration. - - - - - Attempts to construct an instance of . - If the AWS_PROFILE environment variable is set the instance will be constructed using that profile, - otherwise it will use the default profile. - - If the profile doesn't exist status will be logged and no value will be set in the configuration. - - The ICredentialProfileSource to read the profile from. - - - - Attempts to construct an instance of . - If the profile doesn't exist status will be logged and no value will be set in the configuration. - - The ICredentialProfileSource to read the profile from. - The name of the profile. - - - - Probing mechanism to determine the configuration values from various sources. - - - - - Resets all the configuration values reloading as needed. This method will use - the AWS_PROFILE environment variable if set to construct the instance. Otherwise - the default profile will be used. - - - - - Flag that specifies if endpoint discovery is enabled, disabled, - or not set. - - - - - Flag that specifies which retry mode to use or if retry mode has - not been set. - - - - - Flag that specifies the max number of request attempts or if max - attempts has not been set. - - - - - Class containing the members used to invoke service calls - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class containing the members used to invoke service calls - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Represents a request being sent to an Amazon Web Service, including the - parameters being sent as part of the request, the endpoint to which the - request should be sent, etc. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - The name of the request - - - - - Returns a dictionary of the headers included in this request. - - - - - Gets and sets a flag that indicates whether the request is sent as a query string instead of the request body. - - - - - Returns a dictionary of the parameters included in this request. - - - - - Collection of parameters included in this request. - - - - - Returns the subresources that should be appended to the resource path. - This is used primarily for Amazon S3, where object keys can contain '?' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new null entry to the SubResources collection for the request - - The name of the subresource - - - - Adds a new entry to the SubResources collection for the request - - The name of the subresource - Value of the entry - - - - Gets and sets the type of http request to make, whether it should be POST,GET or DELETE - - - - - Gets and Sets the endpoint for this request. - - - - - Gets and Sets the resource path added on to the endpoint. - - - - - Returns the path resources that should be used within the resource path. - This is used for services where path keys can contain '/' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new entry to the PathResources collection for the request - - The name of the pathresource with potential greedy syntax: {key+} - Value of the entry - - - - Gets and Sets the version number for the marshaller used to create this request. The version number - is used to support backward compatible changes that would otherwise be breaking changes when a - newer core is used with an older service assembly. - - - - - Gets and Sets the content for this request. - - - - - Gets the header value from the request. - - - - - Flag that signals that Content was and should be set - from the Parameters collection. - - - - - Gets and sets the content stream. - - - - - Gets and sets the original stream position. - If ContentStream is null or does not support seek, this propery - should be equal to -1. - - - - - Computes the SHA 256 hash of the content stream. If the stream is not - seekable, it searches the parent stream hierarchy to find a seekable - stream prior to computation. Once computed, the hash is cached for future - use. - - - - - The name of the service to which this request is being sent. - - - - - Returns the original, user facing request object which this internal - request object is representing. - - - - - Alternate endpoint to use for this request, if any. - - - - - Host prefix value to prepend to the endpoint for this request, if any. - - - - - Gets and sets the Suppress404Exceptions property. If true then 404s return back from AWS will not cause an exception and - an empty response object will be returned. - - - - - If using AWS4 signing protocol, contains the resultant parts of the - signature that we may need to make use of if we elect to do a chunked - encoding upload. - - - - - Determine whether to use a chunked encoding upload for the request - (applies to Amazon S3 PutObject and UploadPart requests only). - - - - - - Used for Amazon S3 requests where the bucket name is removed from - the marshalled resource path into the host header. To comply with - AWS2 signature calculation, we need to recover the bucket name - and include it in the resource canonicalization, which we do using - this field. - - - - - This flag specifies if SigV4 is required for the current request. - - - - - The authentication region to use for the request. - Set from Config.AuthenticationRegion. - - - - - The region in which the service request was signed. - - - - - Checks if the request stream can be rewinded. - - Returns true if the request stream can be rewinded , - else false. - - - - Returns true if the request can contain a request body, else false. - - Returns true if the currect request can contain a request body, else false. - - - - Returns true if the request has a body, else false. - - Returns true if the request has a body, else false. - - - - Gets the value of the Service Id. - - - - - Gets the dictionary that gives mapping of renamed operations - - - - - IDictionary{String, String} access to ParameterCollection. - TODO: remove this class in version 3.4 of the SDK. - - - - - Constructs ParametersDictionaryFacade for a ParameterCollection - - - - - - A registry of object that will manipulate the runtime pipeline used by service clients. - - - - - Registers a customizer that will be applied for all service clients created. Each customizer has a unique name associated with it. If a customizer is registered more - than once with the same unique name then the calls after the first will be ignored. - - - - - - Deregistered the runtime pipeline customizer - - - - - - Deregistered the runtime pipeline customizer - - - - - - Applies all of the registered customizers on the runtime pipeline - - The service clients runtime pipeline. - Type object for the service client being created - - - - Interface for objects that will customize the runtime pipleine for newly created service clients. - - - - - The unique name for the customizer that identifies the customizer in the registry. The name is also used to identify the customizer on the SDK logs. - - - - - Called on service clients as they are being constructed to customize their runtime pipeline. - - - Type object for the service client being created - - - - Default ServiceMetadata implementation. - This implementation will be used if the service doesn't have a - IServiceMetadata implementation. - - - - - Gets the value of the Service Id. - - - - - Gets the dictionary that gives mapping of renamed operations - - - - - Response Unmarshaller for all Errors - - - - - Build an ErrorResponse from XML - - The XML parsing context. - Usually an Amazon.Runtime.Internal.UnmarshallerContext. - An ErrorResponse object. - - - - Return an instance of and ErrorResponseUnmarshaller. - - - - - - Interface for unmarshallers which unmarshall objects from response data. - The Unmarshallers are stateless, and only encode the rules for what data - in the XML stream goes into what members of an object. - - The type of object the unmarshaller returns - The type of the XML unmashaller context, which contains the - state during parsing of the XML stream. Usually an instance of - Amazon.Runtime.Internal.Transform.UnmarshallerContext. - - - - Given the current position in the XML stream, extract a T. - - The XML parsing context - An object of type T populated with data from the XML stream. - - - - Interface for unmarshallers which unmarshall service responses. - The Unmarshallers are stateless, and only encode the rules for what data - in the XML stream goes into what members of an object. - - The type of object the unmarshaller returns - The type of the XML unmashaller context, which contains the - state of parsing the XML stream. Uaually an instance of - Amazon.Runtime.Internal.Transform.UnmarshallerContext. - - - - Extracts an exeption with data from an ErrorResponse. - - The XML parsing context. - An inner exception to be included with the returned exception - The HttpStatusCode from the ErrorResponse - Either an exception based on the ErrorCode from the ErrorResponse, or the - general service exception for the service in question. - - - - Interface for unmarshallers which unmarshall objects from response data. - The Unmarshallers are stateless, and only encode the rules for what data - in the XML stream goes into what members of an object. - - The type of object the unmarshaller returns - The type of the XML unmashaller context, which contains the - state during parsing of the XML stream. Usually an instance of - Amazon.Runtime.Internal.Transform.UnmarshallerContext. - - - - Given the current position in the XML stream, extract a T. - - The XML parsing context - An object of type T populated with data from the XML stream. - - - - First-pass unmarshaller for all errors - - - - - Build an ErrorResponse from json - - The json parsing context. - Usually an Amazon.Runtime.Internal.JsonUnmarshallerContext. - An ErrorResponse object. - - - - Return an instance of JsonErrorResponseUnmarshaller. - - - - - - Wraps a json string for unmarshalling. - - Each Read() operation gets the next token. - TestExpression() is used to match the current key-chain - to an xpath expression. The general pattern looks like this: - - JsonUnmarshallerContext context = new JsonUnmarshallerContext(jsonString); - while (context.Read()) - { - if (context.IsKey) - { - if (context.TestExpresion("path/to/element")) - { - myObject.stringMember = stringUnmarshaller.GetInstance().Unmarshall(context); - continue; - } - } - } - - - - - - Wrap the jsonstring for unmarshalling. - - Stream that contains the JSON for unmarshalling - If set to true, maintains a copy of the complete response body constraint to log response size as the stream is being read. - Response data coming back from the request - If set to true, maintains a copy of the complete response body as the stream is being read. - - - - Are we at the start of the json document. - - - - - Is the current token the end of an object - - - - - Is the current token the start of an object - - - - - Returns the element depth of the parser's current position in the json - document being parsed. - - - - - The current Json path that is being unmarshalled. - - - - - Reads to the next token in the json document, and updates the context - accordingly. - - - True if a token was read, false if there are no more tokens to read. - - - - - Peeks at the next token. This peek implementation - reads the next token and makes the subsequent Read() return the same data. - If Peek is called successively, it will return the same data. - Only the first one calls Read(), subsequent calls - will return the same data until a Read() call is made. - - Token to peek. - Returns true if the peeked token matches given token. - - - - Returns the text contents of the current token being parsed. - - - The text contents of the current token being parsed. - - - - - The type of the current token - - - - - Get the base stream of the jsonStream. - - - - - Peeks at the next (non-whitespace) character in the jsonStream. - - The next (non-whitespace) character in the jsonStream, or -1 if at the end. - - - - Peeks at the next character in the stream. - If the data isn't buffered into the StreamReader (Peek() returns -1), - we flush the buffered data and try one more time. - - - - - - Abstract class for unmarshalling service responses. - - - - - Class for unmarshalling XML service responses. - - - - - Class for unmarshalling EC2 service responses. - - - - - Class for unmarshalling JSON service responses. - - - - - Unmarshaller for int fields - - - - - Unmarshaller for nullable int fields. Implemented only for JSON context - to handle cases where value can be null e.g. {'Priority': null}. - This unmarshaller is not implemented for XML context, as XML responses - will null elements (xsi:nil='true') will be skipped by the XML parser. - - - - - Unmarshaller for long fields - - - - - Unmarshaller for float fields - - - - - Unmarshaller for double fields - - - - - Unmarshaller for decimal fields - - - - - Unmarshaller for bool fields - - - - - Unmarshaller for string fields - - - - - Unmarshaller for byte fields - - - - - Unmarshaller for DateTime fields - - - - - Unmarshalls given string as a DateTime. Handles cases where we want to unmarshall - as just a DateTime or a nullable Datetime. - - Value to be parsed - If true, the method will return null if text is null. - If false, the method will return default(DateTime), if text is null. - - - - - Unmarshaller for nullable DateTime fields. Implemented only for JSON context - to handle cases where value can be null e.g. {'Priority': null}. - This unmarshaller is not implemented for XML context, as XML responses - will null elements (xsi:nil='true') will be skipped by the XML parser. - - - - - Unmarshaller for MemoryStream fields - - - - - Unmarshaller for ResponseMetadata - - - - - Base class for the UnmarshallerContext objects that are used - to unmarshall a web-service response. - - - - - Tests the specified expression against the current position in the XML - document - - The pseudo-XPath expression to test. - - True if the expression matches the current position in the document, - false otherwise. - - - - Tests the specified expression against the current position in the XML - document being parsed, and restricts the expression to matching at the - specified stack depth. - - The pseudo-XPath expression to test. - - The depth in the stack representing where the expression must - start matching in order for this method to return true. - - True if the specified expression matches the current position in - the XML document, starting from the specified depth. - - - - Reads the next token at depth greater than or equal to target depth. - - Tokens are read at depth greater than or equal to target depth. - True if a token was read and current depth is greater than or equal to target depth. - - - - The current path that is being unmarshalled. - - - - - Returns the element depth of the parser's current position in the - document being parsed. - - - - - Reads to the next node in the document, and updates the context accordingly. - - - True if a node was read, false if there are no more elements to read. - - - - - Returns the text contents of the current element being parsed. - - - The text contents of the current element being parsed. - - - - - True if NodeType is Element. - - - - - True if NodeType is EndElement. - - - - - True if the context is at the start of the document. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Wrap an XmltextReader for simulating an event stream. - - Each Read() operation goes either to the next element or next attribute within - the current element. TestExpression() is used to match the current event - to an xpath expression. The general pattern looks like this: - - UnmarshallerContext context = new UnmarshallerContext(...); - while (context.Read()) - { - if (context.TestExpresion("path/to/element")) - { - myObject.stringMember = stringUnmarshaller.GetInstance().Unmarshall(context); - continue; - } - if (context.TestExpression("path/to/@attribute")) - myObject.MyComplexTypeMember = MyComplexTypeUnmarshaller.GetInstance().Unmarshall(context); - } - - - - - - Wrap an XmlTextReader with state for event-based parsing of an XML stream. - - Stream with the XML from a service response. - If set to true, maintains a copy of the complete response body constraint to log response size as the stream is being read. - Response data coming back from the request - If set to true, maintains a copy of the complete response body as the stream is being read. - - - - The current XML path that is being unmarshalled. - - - - - Returns the element depth of the parser's current position in the XML - document being parsed. - - - - - Reads to the next node in the XML document, and updates the context accordingly. - - - True if a node was read, false if there are no more elements to read./ - - - - - Returns the text contents of the current element being parsed. - - - The text contents of the current element being parsed. - - - - - True if NodeType is Element. - - - - - True if NodeType is EndElement. - - - - - True if the context is at the start of the document. - - - - - True if NodeType is Attribute. - - - - - Wrap an XmlTextReader with state for event-based parsing of an XML stream. - - Stream with the XML from a service response. - If set to true, maintains a copy of the complete response body constraint to log response size as the stream is being read. - Response data coming back from the request - If set to true, maintains a copy of the complete response body as the stream is being read. - - - - RequestId value, if found in response - - - - - Reads to the next node in the XML document, and updates the context accordingly. - If node is RequestId, reads the contents and stores in RequestId property. - - - True if a node was read, false if there are no more elements to read./ - - - - - A stream which caches the contents of the underlying stream as it reads it. - - - - - All the bytes read by the stream. - - - - - All the bytes read by the stream constrained with _cacheLimit - - - - - Initializes the CachingWrapperStream with a base stream. - - The stream to be wrapped. - Maximum number of bytes to be cached. - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Gets a value indicating whether the current stream supports seeking. - CachingWrapperStream does not support seeking, this will always be false. - - - - - Gets or sets the position within the current stream. - CachingWrapperStream does not support seeking, attempting to set Position - will throw NotSupportedException. - - - - - Sets the position within the current stream. - CachingWrapperStream does not support seeking, attempting to call Seek - will throw NotSupportedException. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Stream wrapper that double-buffers from a wrapped stream and - returns the buffered content as a series of signed 'chunks' - for the AWS4 ('Signature V4') protocol. - - - - - Reads some or all of the processed chunk to the consumer, constructing - and streaming a new chunk if more input data is available. - - - - - - - - - Attempt to read sufficient data for a whole chunk from the wrapped stream, - returning the number of bytes successfully read to be processed into a chunk - - - - - Results of the header-signing portion of the request - - - - - Computed signature of the chunk prior to the one in-flight, in - hex - - - - - Computes the derived signature for a chunk of data of given length in the input buffer, - placing a formatted chunk with headers, signature and data into the output buffer - ready for streaming back to the consumer. - - - - - - Length override to return the true length of the payload plus the metainfo - supplied with each chunk - - - - - Computes the total size of the data payload, including the chunk metadata. - Called externally so as to be able to set the correct Content-Length header - value. - - - - - - - Computes the size of the header data for each chunk. - - - - - - - Attempt to read sufficient data for a whole chunk from the wrapped stream, - returning the number of bytes successfully read to be processed into a chunk - - - - - A list object that will always be sent to AWS services, - even if it is empty. - The AWS .NET SDK does not send empty collections to services, unless - the collection is of this type. - - - - - - A dictionary object that will always be sent to AWS services, - even if it is empty. - The AWS .NET SDK does not send empty collections to services, unless - the collection is of this type. - - - - - - - Class to perform actions on a background thread. - Uses a single background thread and performs actions - on it in the order the data was sent through the instance. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Class to invoke actions on a background thread. - Uses a single background thread and invokes actions - on it in the order they were invoked through the instance. - - - - - PCL doesn't have IPAddress. These methods are copied from the Microsoft source code. - - - - - Returns true if the Content is set or there are - query parameters. - - This request - True if data is present; false otherwise. - - - - Utilities for dealing with Guids - - - - - Hashes a set of objects. - - - - - - - Combines a set of hashses. - - - - - - - Combines two hashes. - - - - - - - - Disposes of all managed and unmanaged resources. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - A wrapper stream that calculates a hash of the base stream as it - is being read. - The calculated hash is only available after the stream is closed or - CalculateHash is called. After calling CalculateHash, any further reads - on the streams will not change the CalculatedHash. - If an ExpectedHash is specified and is not equal to the calculated hash, - Close or CalculateHash methods will throw an AmazonClientException. - If CalculatedHash is calculated for only the portion of the stream that - is read. - - - Exception thrown during Close() or CalculateHash(), if ExpectedHash is set and - is different from CalculateHash that the stream calculates, provided that - CalculatedHash is not a zero-length byte array. - - - - - Algorithm to use to calculate hash. - - - - - True if hashing is finished and no more hashing should be done; - otherwise false. - - - - - Current position in the stream. - - - - - Calculated hash for the stream. - This value is set only after the stream is closed. - - - - - Expected hash value. Compared against CalculatedHash upon Close(). - If the hashes are different, an AmazonClientException is thrown. - - - - - Expected length of stream. - - - - - Initializes an HashStream with a hash algorithm and a base stream. - - Stream to calculate hash for. - - Expected hash. Will be compared against calculated hash on stream close. - Pass in null to disable check. - - - Expected length of the stream. If the reading stops before reaching this - position, CalculatedHash will be set to empty array. - - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Asynchronously reads a sequence of bytes from the current stream, advances - the position within the stream by the number of bytes read, and monitors - cancellation requests. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous read operation. The value of the TResult - parameter contains the total number of bytes read into the buffer. This can be - less than the number of bytes requested if that many bytes are not currently - available, or zero (0) if the end of the stream has been reached. - - - - - Gets a value indicating whether the current stream supports seeking. - HashStream does not support seeking, this will always be false. - - - - - Gets or sets the position within the current stream. - HashStream does not support seeking, attempting to set Position - will throw NotSupportedException. - - - - - Sets the position within the current stream. - HashStream does not support seeking, attempting to call Seek - will throw NotSupportedException. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Gets the overridden length used to construct the HashStream - - - - - Calculates the hash for the stream so far and disables any further - hashing. - - - - - Resets the hash stream to starting state. - Use this if the underlying stream has been modified and needs - to be rehashed without reconstructing the hierarchy. - - - - - Validates the underlying stream. - - - - - Compares two hashes (arrays of bytes). - - Expected hash. - Actual hash. - - True if the hashes are identical; otherwise false. - - - - - A wrapper stream that calculates a hash of the base stream as it - is being read or written. - The calculated hash is only available after the stream is closed or - CalculateHash is called. After calling CalculateHash, any further reads - on the streams will not change the CalculatedHash. - If an ExpectedHash is specified and is not equal to the calculated hash, - Close or CalculateHash methods will throw an AmazonClientException. - If base stream's position is not 0 or HashOnReads is true and the entire stream is - not read, the CalculatedHash will be set to an empty byte array and - comparison to ExpectedHash will not be made. - - - Exception thrown during Close() or CalculateHash(), if ExpectedHash is set and - is different from CalculateHash that the stream calculates, provided that - CalculatedHash is not a zero-length byte array. - - - - - Initializes an HashStream with a hash algorithm and a base stream. - - Stream to calculate hash for. - - Expected hash. Will be compared against calculated hash on stream close. - Pass in null to disable check. - - - Expected length of the stream. If the reading stops before reaching this - position, CalculatedHash will be set to empty array. - - - - - A wrapper stream that calculates an MD5 hash of the base stream as it - is being read or written. - The calculated hash is only available after the stream is closed or - CalculateHash is called. After calling CalculateHash, any further reads - on the streams will not change the CalculatedHash. - If an ExpectedHash is specified and is not equal to the calculated hash, - Close or CalculateHash methods will throw an AmazonClientException. - If base stream's position is not 0 or HashOnReads is true and the entire stream is - not read, the CalculatedHash will be set to an empty byte array and - comparison to ExpectedHash will not be made. - - - Exception thrown during Close() or CalculateHash(), if ExpectedHash is set and - is different from CalculateHash that the stream calculates, provided that - CalculatedHash is not a zero-length byte array. - - - - - Initializes an MD5Stream with a base stream. - - Stream to calculate hash for. - - Expected hash. Will be compared against calculated hash on stream close. - Pass in null to disable check. - - - Expected length of the stream. If the reading stops before reaching this - position, CalculatedHash will be set to empty array. - - - - - Utilities for validating label values for host prefix templates - - - - - Validates a label value - - - - - Simple wrapper around the log4net Error method. - - - - - - - - Write debug message to Console - - - - - - - - Write debug message to Console - - - - - - - Simple wrapper around the log4net InfoFormat method. - - - - - - - This is a dynamic wrapper around log4net so we can avoid log4net being required - to be distributed with the SDK. - - - - - Abstract logger class, base for any custom/specific loggers. - - - - - Flushes the logger contents. - - - - - Simple wrapper around the log4net IsErrorEnabled property. - - - - - Simple wrapper around the log4net IsDebugEnabled property. - - - - - Simple wrapper around the log4net IsInfoEnabled property. - - - - - Simple wrapper around the log4net Error method. - - - - - - - - Simple wrapper around the log4net Debug method. - - - - - - - - Simple wrapper around the log4net DebugFormat method. - - - - - - - Simple wrapper around the log4net InfoFormat method. - - - - - - - Logger wrapper for reflected log4net logging methods. - - - - - This should be a one time call to use reflection to find all the types and methods - needed for the logging API. - - - - - Simple wrapper around the log4net IsErrorEnabled property. - - - - - Simple wrapper around the log4net Error method. - - - - - - - - Simple wrapper around the log4net IsDebugEnabled property. - - - - - Simple wrapper around the log4net Debug method. - - - - - - - - Simple wrapper around the log4net DebugFormat method. - - - - - - - Simple wrapper around the log4net IsInfoEnabled property. - - - - - Simple wrapper around the log4net InfoFormat method. - - - - - - - A single logged message - - - - - Log message arguments. - - - - - Culture-specific formatting provider. - - - - - Log message format. - - - - - a size-limited cache of key value pairs - - Once the maximum size has been reached, the least recently - used pairs will be evicted to make room for any new items. - - - - - - - the maximum number of entries this LruCache will hold - before items begin getting evicted - - - - - the number of items in the cache - - - - - Construct a new LruCache. - - maximum number of entries before items are evicted - - - - Add the key/value pair to the cache, or update - the value if the key already exists. - - If the cache is full, evicts the least recently used item. - - - - - - - Evicts a specific key out of the cache if it exists - - the key to evict from the cache - - - - Try to get the value associated with the key. - - the key to look up - the value, if the key exists - true if there is a value associated with the key, or false if no value is associated with the key - - - - Try to get the value associated with the key, if it doesn't exist, use the provided factory method to - create a new value and tries adding it to the cache. - - the key to look up - the factory method used in case the key is not present in the cache - the looked up value or the value created by the factory - - - - Clear the LruCache of all entries. - - - - - Helper class to support LruCache. - Does not implement the error checking and synchronization that - would be necessary for it to stand alone. - - - - - Item to be stored in the LruList - linked list structure. - - - - - Collection of properties being tracked - - - - - Timings for metrics being tracked - - - - - Counters being tracked - - - - - Whether metrics are enabled for the request - - - - - Constructs an empty, disabled metrics object - - - - - Starts timing an event. Logs an exception if an event - of the same type was started but not stopped. - - - - - - - Stops timing an event. Logs an exception if the event wasn't started. - - - - - - - Adds a property for a metric. If there are multiple, the - object is added as a new item in a list. - - - - - - - Sets a counter for a specific metric. - - - - - - - Increments a specific metric counter. - If counter doesn't exist yet, it is set to 1. - - - - - - Returns errors associated with the metric, including - if there are still any timing events in-flight. - - - - - - Returns a string representation of the current metrics. - - - - - - Return a JSON represenation of the current metrics - - - - - - Timing information for a metric - - - - - Empty, stopped timing object - - - - - Timing object in a started state - - - - - - Stops timing - - - - - - Whether the timing has been stopped - - - - - Elapsed ticks from start to stop. - If timing hasn't been stopped yet, returns 0. - - - - - Elapsed time from start to stop. - If timing hasn't been stopped yet, returns TimeSpan.Zero - - - - - Timing event, stops timing of a metric when disposed - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - The destructor for the client class. - - - - - A wrapper stream which supresses disposal of the underlying stream. - - - - - Constructor for NonDisposingWrapperStream. - - The base stream to wrap. - - - - The Dispose implementation for this wrapper stream - does not close the underlying stream. - - - - - This class is used to wrap a stream for a particular segment of a stream. It - makes that segment look like you are reading from beginning to end of the stream. - - - - - Asynchronously reads a sequence of bytes from the current stream, advances - the position within the stream by the number of bytes read, and monitors - cancellation requests. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous read operation. The value of the TResult - parameter contains the total number of bytes read into the buffer. This can be - less than the number of bytes requested if that many bytes are not currently - available, or zero (0) if the end of the stream has been reached. - - - - - Asynchronously writes a sequence of bytes to the current stream and advances the - current position within this stream by the number of bytes written. - - - An array of bytes. This method copies count bytes from buffer to the current stream. - - - The zero-based byte offset in buffer at which to begin copying bytes to the - current stream. - - The number of bytes to be written to the current stream. - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - A task that represents the asynchronous write operation. - - - - Wrapper stream that only supports reading - - - - - Asynchronously clears all buffers for this stream and causes any buffered data - to be written to the underlying device. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous flush operation. - - - - - Asynchronously writes a sequence of bytes to the current stream and advances the - current position within this stream by the number of bytes written. - - - An array of bytes. This method copies count bytes from buffer to the current stream. - - - The zero-based byte offset in buffer at which to begin copying bytes to the - current stream. - - The number of bytes to be written to the current stream. - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - A task that represents the asynchronous write operation. - - - - Partial wrapper stream that only supports reading - - - - - Uri wrapper that can parse out information (bucket, key, region, style) from an - S3 URI. - - - - - True if the URI contains the bucket in the path, false if it contains the bucket in the authority. - - - - - The bucket name parsed from the URI (or null if no bucket specified). - - - - - The key parsed from the URI (or null if no key specified). - - - - - The region parsed from the URI (or null if no region specified). - - - - - Constructs a parser for the S3 URI specified as a string. - - The S3 URI to be parsed. - - - - Constructs a parser for the S3 URI specified as a Uri instance. - - The S3 URI to be parsed. - - - - Percent-decodes the given string, with a fast path for strings that are not - percent-encoded. - - The string to decode - The decoded string - - - - Percent-decodes the given string. - - The string to decode - The index of the first '%' in the string - The decoded string - - - - Decodes the percent-encoded character at the given index in the string - and appends the decoded value to the string under construction. - - - The string under construction to which the decoded character will be - appended. - - The string being decoded. - The index of the '%' character in the string. - - - - Converts a hex character (0-9A-Fa-f) into its corresponding quad value. - - The hex character - The quad value - - - - Interface for a non-generic cache. - - - - - Clears the entire cache. - - - - - Maximum time to keep an item around after its last use. - - - - - How often should the cache be cleared of old items. - - - - - The number of items in the cache. - - - - - Interface for a generic cache. - - - - - - - Retrieves a value out of the cache or from the source. - - - - - - - - Retrieves a value out of the cache or from the source. - If the item was in the cache, isStaleItem is set to true; - otherwise, if the item comes from the source, isStaleItem is false. - - - - - - - - - Clears a specific value from the cache if it's there. - - - - - - Returns the keys for all items in the cache. - - - - - - Executes specified operation, catches exception, clears the cache for - the given key, retries the operation. - - - - - - - - - - - SDK-wide cache. - Provides access to caches specific to a particular set of credentials - and target region. - - - - - Clear all caches - - - - - Clear all caches of a particular type - - - - - - Retrieve a cache of a specific type for a client object. - The client object can be null in cases where a cache does - not correspond to a specific AWS account or target region. - - - - - - - - - - - Retrieve a cache of a specific type for a client object. - The client object can be null in cases where a cache does - not correspond to a specific AWS account or target region. - - - - - - - - - - - Utilities for converting objects to strings. Used by the marshaller classes. - - - - - Converts a DateTime to ISO8601 formatted string. - - - - - Converts a DateTime to RFC822 formatted string. - - - - - Converts a DateTime to Unix epoch time formatted string. - - - - - A wrapper stream. - - - - - Base stream. - - - - - Initializes WrapperStream with a base stream. - - - - - - Returns the first base non-WrapperStream. - - First base stream that is non-WrapperStream. - - - - Returns the first base non-WrapperStream. - - First base stream that is non-WrapperStream. - - - - Returns the first base non-WrapperStream. - - Potential WrapperStream - Base non-WrapperStream. - - - - Gets a value indicating whether the current stream supports reading. - True if the stream supports reading; otherwise, false. - - - - - Gets a value indicating whether the current stream supports seeking. - True if the stream supports seeking; otherwise, false. - - - - - Gets a value indicating whether the current stream supports writing. - True if the stream supports writing; otherwise, false. - - - - - Closes the current stream and releases any resources (such as sockets and - file handles) associated with the current stream. - - - - - Gets the length in bytes of the stream. - - - - - Gets or sets the position within the current stream. - - - - - Gets or sets a value, in miliseconds, that determines how long the stream - will attempt to read before timing out. - - - - - Gets or sets a value, in miliseconds, that determines how long the stream - will attempt to write before timing out. - - - - - Clears all buffers for this stream and causes any buffered data to be written - to the underlying device. - - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Sets the position within the current stream. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Sets the length of the current stream. - - The desired length of the current stream in bytes. - - - - Writes a sequence of bytes to the current stream and advances the current - position within this stream by the number of bytes written. - - - An array of bytes. This method copies count bytes from buffer to the current stream. - - - The zero-based byte offset in buffer at which to begin copying bytes to the - current stream. - - The number of bytes to be written to the current stream. - - - - Asynchronously clears all buffers for this stream and causes any buffered data - to be written to the underlying device. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous flush operation. - - - - - Asynchronously reads a sequence of bytes from the current stream, advances - the position within the stream by the number of bytes read, and monitors - cancellation requests. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous read operation. The value of the TResult - parameter contains the total number of bytes read into the buffer. This can be - less than the number of bytes requested if that many bytes are not currently - available, or zero (0) if the end of the stream has been reached. - - - - - Asynchronously writes a sequence of bytes to the current stream and advances the - current position within this stream by the number of bytes written. - - - An array of bytes. This method copies count bytes from buffer to the current stream. - - - The zero-based byte offset in buffer at which to begin copying bytes to the - current stream. - - The number of bytes to be written to the current stream. - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - A task that represents the asynchronous write operation. - - - - A wrapper stream that decrypts the base stream as it - is being read. - - - - - Initializes an DecryptStream with an decryption algorithm and a base stream. - - Stream to perform encryption on.. - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Asynchronously reads a sequence of bytes from the current stream and advances - the position within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Gets a value indicating whether the current stream supports seeking. - DecryptStream does not support seeking, this will always be false. - - - - - Gets or sets the position within the current stream. - DecryptStream does not support seeking, attempting to set Position - will throw NotSupportedException. - - - - - Sets the position within the current stream. - DecryptStream does not support seeking, attempting to call Seek - will throw NotSupportedException. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Validates the underlying stream. - - - - - A wrapper stream that decrypts the base stream as it - is being read. - - - - - Initializes an DecryptStream with an decryption algorithm and a base stream. - - Stream to perform encryption on.. - Symmetric key to perform decryption - Initialization vector to perform decryption - - - - A wrapper stream that decrypts the base stream using AES algorithm as it - is being read. - - - - - Initializes an AESDecryptionStream with a base stream. - - Stream to perform decryption on.. - Symmetric key to perform decryption - Initialization vector to perform decryption - - - - A wrapper stream that encrypts the base stream as it - is being read. - - - - - Initializes an EncryptStream with an encryption algorithm and a base stream. - - Stream to perform encryption on.. - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Asynchronously reads a sequence of bytes from the current stream, advances - the position within the stream by the number of bytes read, and monitors - cancellation requests. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous read operation. The value of the TResult - parameter contains the total number of bytes read into the buffer. This can be - less than the number of bytes requested if that many bytes are not currently - available, or zero (0) if the end of the stream has been reached. - - - - - Gets a value indicating whether the current stream supports seeking. - - - - - Returns encrypted content length. - - - - - Gets or sets the position within the current stream. - - - - - Sets the position within the current stream. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Validates the underlying stream. - - - - - A wrapper stream that encrypts the base stream as it - is being read. - - - - - Initializes an EncryptStream with an encryption algorithm and a base stream. - - Stream to perform encryption on.. - Symmetric key to perform encryption - Initialization vector to perform encryption - - - - A wrapper stream that encrypts the base stream using AES algorithm as it - is being read. - - - - - Initializes an AESEncryptionStream with a base stream. - - Stream to perform encryption on.. - Symmetric key to perform encryption - Initialization vector to perform encryption - - - - A wrapper stream that encrypts the base stream as it - is being read. - - - - - Initializes an EncryptStream for Multipart uploads with an encryption algorithm and a base stream. - - Stream to perform encryption on.. - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Asynchronously reads a sequence of bytes from the current stream, advances - the position within the stream by the number of bytes read, and monitors - cancellation requests. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous read operation. The value of the TResult - parameter contains the total number of bytes read into the buffer. This can be - less than the number of bytes requested if that many bytes are not currently - available, or zero (0) if the end of the stream has been reached. - - - - - Gets a value indicating whether the current stream supports seeking. - - - - - Returns encrypted content length. - - - - - Gets or sets the position within the current stream. - - - - - Sets the position within the current stream. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Validates the underlying stream. - - - - - A wrapper stream that encrypts the base stream as it - is being read. - - - - - Initializes an EncryptStream with an encryption algorithm and a base stream. - - Stream to perform encryption on.. - Symmetric key to perform encryption - Initialization vector to perform encryption - - - - A wrapper stream that encrypts the base stream as it - is being read. - - - - - Initializes an AESEncryptionStream with a base stream. - - Stream to perform encryption on.. - Symmetric key to perform encryption - Initialization vector to perform encryption - - - - Provides read/write access to a file in the INI format. - - This class is not threadsafe. - - - - - Construct a new IniFile. - - path of the IniFile - - - - the path of the file - - - - - helper to access the lines of the file - - - - - Persist the changes to this INI file to disk. - - - - - Rename the section fromSectionName to toSectionName - - - - - - - Rename the section fromSectionName to toSectionName - - - - if true and destination section already exists overwrite it - - - - Copy the section fromSectionName to toSectionName - - - - Any properties in the original section that are also in this dictionary will - be replaced by the value from this dictionary. - - - - Copy the section fromSectionName to toSectionName - - - - Any properties in the original section that are also in this dictionary will - be replaced by the value from this dictionary. - if true and destination section already exists overwrite it - - - - Update the section with the properties given. - If the section doesn't exist, it will be appended to the file. - - Notes: - 1. Any properties that do exist in the section will be updated. - 2. A null value for a property denotes that it should be deleted from the section - 3. If any properties don't exist they will be appended to the end of the section - in the same order they appear in the SortedDictionary. - - name of the section to operate on - properties to add/update/delete - - - - Check if the section exists. If not, append it to the end of the file. - - section to ensure exists - - - - If the section exists, delete it from the INI file. - - section to delete - - - - Determine if a section exists in the INI file. - - name of section to look for - true if the section exists, false otherwise - - - - Return the properties for the section if it exists. - - name of section to get - properties contained in the section - True if the section was found, false otherwise - - - - Return the properties for the section if it exists. - - Regex to match name of section to get - properties contained in the section - True if the section was found, false otherwise - - - - Return the properties for the section if it exists. - - Regex to match name of section to get - name of section if regex matches - properties contained in the section - True if the section was found, false otherwise - - - - Logger wrapper for System.Diagnostics.TraceSource logger. - - - - - Creates TraceRoute for a given Type or the closest "parent" that has a listener configured. - Example: if type is Amazon.DynamoDB.AmazonDynamoDBClient, listeners can be configured for: - -Amazon.DynamoDB.AmazonDynamoDBClient - -Amazon.DynamoDB - -Amazon - The first matching TraceSource with listeners will be used. - If no listeners are configured for type or one of its "parents", will return null. - - - - - Gets a TraceSource for given Type with SourceLevels.All. - If there are no listeners configured for targetType or one of its "parents", returns null. - - - - - - - Gets a TraceSource for given Type and SourceLevels. - If there are no listeners configured for targetType or one of its "parents", returns null. - - - - - - - - Provides line-based read/write access to a file. - The file can be read into memory, changed, then written back to disk. - When the file is persisted back to disk, an optimistic concurrency - check is performed to make sure the file hasn't changed since it was - originally read. - - This class is not threadsafe. - - - - - a full copy of the original file - This is used for optimistic concurrency. - Note that this assumes a small file and does not scale large files. - - - - - path of the file - - - - - Read/write access to the lines that make up the file. - Any changes to this List are persisted back to disk when Persist() is called. - - NOTE: - The lines have the original line endings on them to preserve the - original text as much as possible. - - - - - Construct a new OptimisticLockedTextFile. - - path of the file - - - - Persist changes to disk after an optimistic concurrency check is completed. - - - - - Subclass of IniFile that allows INI sections to be read with the profile keyword in front of the section name. - - - - - This is a utility class to be used in last resort for code paths that are synchronous but need to call an asynchronous method. - This should never be used for methods that are called at high volume as this utility class has a performance cost. For example this - class was added for the refreshing credentials like Cognito which would need to use this about once an hour. - - - - - Custom WebProxy implementation that creates a webproxy based on - user inputs(Host name and port number) - - - - - Set the ProxyUri - - - - - Create a Uri based on the user inputs(Host name and port number) - - - - - Proxy Uri property - - - - - Proxy Credentials property - - - - - Getter to fetch the set proxy - - - - - Method to determine if the proxy should be bypassed when accessing an internet source - - - - - This class is no longer used anymore and should be avoided as it is just meant - as a last resort when blending async and sync operations. The code is still - here to support versions before 3.3.9.0 of AWSSDK.DynamoDBv2. - - - - - Collection of parameters that an SDK client will send to a service. - - - - - Constructs empty ParameterCollection. - - - - - Adds a parameter with a string value. - - - - - - - Adds a parameter with a list-of-strings value. - - - - - - - Converts the current parameters into a list of key-value pairs. - - - - - - Property to denote that the last exception returned by an AWS Service - was retryable or not. - - - - - This handler processes exceptions thrown from the HTTP handler and - unmarshalls error responses. - - - - - Default set of exception handlers. - - - - - Default set of exception handlers. - - - - - Constructor for ErrorHandler. - - an ILogger instance. - - - - Handles and processes any exception thrown from underlying handlers. - - The execution context which contains both the - requests and response context. - - - - Handles and processes any exception thrown from underlying handlers. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Disposes the response body. - - The response context. - - - - Processes an exception by invoking a matching exception handler - for the given exception. - - The execution context, it contains the - request and response context. - The exception to be processed. - - This method returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception that may be thrown by exception - processing by a matching exception handler. - - - - - The abstract base class for exception handlers. - - The exception type. - - - - The exception handler for HttpErrorResponseException exception. - - - - - The constructor for HttpErrorResponseExceptionHandler. - - in instance of ILogger. - - - - Handles an exception for the given execution context. - - The execution context, it contains the - request and response context. - The exception to handle. - - Returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception to replace the original exception. - - - - - Checks if a HTTP 404 status code is returned which needs to be suppressed and - processes it. - If a suppressed 404 is present, it unmarshalls the response and returns true to - indicate that a suppressed 404 was processed, else returns false. - - The execution context, it contains the - request and response context. - - - If a suppressed 404 is present, returns true, else returns false. - - - - - A pipeline handler which provides hooks to run - external code in the pre-invoke and post-invoke phases. - - - - - Action to execute on the pre invoke phase. - - - - - Action to execute on the post invoke phase. - - - - - Calls the PreInvoke and PostInvoke methods before and after calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls the PreInvoke and PostInvoke methods before and after calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Executes the OnPreInvoke action as part of pre-invoke. - - The execution context, it contains the - request and response context. - - - - Executes the OnPreInvoke action as part of post-invoke. - - The execution context, it contains the - request and response context. - - - - This handler retrieved the AWS credentials to be used for the current call. - - - - - The constructor for CredentialsRetriever. - - An AWSCredentials instance. - - - - Retrieves the credentials to be used for the current call before - invoking the next handler. - - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - This handler resolves the endpoint to be used for the current request. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Resolves the endpoint to be used for the current request - before invoking the next handler. - - The execution context, it contains the - request and response context. - - - - This handler resolves the endpoint to be used for the current request. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Resolves the endpoint to be used for the current request - before invoking the next handler. - - The execution context, it contains the - request and response context. - - - - Determines the endpoint for the request. - - The request context. - - - - - This handler provides an OnError action that can be used as hook for - external code to handle exceptions in the runtime pipeline. - - - - - Action to execute if an exception occurs during the - execution of any underlying handlers. - - - - - Executes the OnError action if an exception occurs during the - execution of any underlying handlers. - - - - - - - This handler marshalls the request before calling invoking the next handler. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Marshalls the request before calling invoking the next handler. - - The execution context, it contains the - request and response context. - - - - This handler manages the metrics used to time the complete call and - logs the final metrics. - - - - - Captures the overall execution time and logs final metrics. - - The execution context which contains both the - requests and response context. - - - - Captures the overall execution time and logs final metrics. - - The response type for the current request. - - The execution context, it contains the request and response context. - - A task that represents the asynchronous operation. - - - - This handler processes HTTP redirects and reissues the call to the - redirected location. - - - - - Processes HTTP redirects and reissues the call to the - redirected location. - - The execution context which contains both the - requests and response context. - - - - Processes HTTP redirects and reissues the call to the - redirected location. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Checks if an HTTP 307 (temporary redirect) has occured and changes the - request endpoint to the redirected location. - - - The execution context, it contains the request and response context. - - - A boolean value that indicates if a redirect has occured. - - - - - This handler signs the request. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Signs the request before invoking the next handler. - - - The execution context, it contains the request and response context. - - - - - Determines if the request should be signed. - - The request context. - A boolean value that indicated if the request should be signed. - - - - Signs the request. - - The request context. - - - - This handler unmarshalls the HTTP response. - - - - - The constructor for Unmarshaller. - - - Boolean value which indicated if the unmarshaller - handler supports response logging. - - - - - Unmarshalls the response returned by the HttpHandler. - - The execution context which contains both the - requests and response context. - - - - Unmarshalls the response returned by the HttpHandler. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Unmarshalls the HTTP response. - - - The execution context, it contains the request and response context. - - - - - Unmarshalls the HTTP response. - - - The execution context, it contains the request and response context. - - - - - The HTTP handler contains common logic for issuing an HTTP request that is - independent of the underlying HTTP infrastructure. - - - - - - The sender parameter used in any events raised by this handler. - - - - - The constructor for HttpHandler. - - The request factory used to create HTTP Requests. - The sender parameter used in any events raised by this handler. - - - - Issues an HTTP request for the current request context. - - The execution context which contains both the - requests and response context. - - - - Issues an HTTP request for the current request context. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Determines the content for request body and uses the HTTP request - to write the content to the HTTP request body. - - Content to be written. - The HTTP request. - The request context. - - - - Creates the HttpWebRequest and configures the end point, content, user agent and proxy settings. - - The async request. - The web request that actually makes the call. - - - - Disposes the HTTP handler. - - - - - An abstract pipeline handler that has implements IPipelineHandler, - and has the default implmentation. This is the base class for most of - the handler implementations. - - - - - The logger used to log messages. - - - - - The inner handler which is called after the current - handler completes it's processing. - - - - - The outer handler which encapsulates the current handler. - - - - - Contains the processing logic for a synchronous request invocation. - This method calls InnerHandler.InvokeSync to continue processing of the - request by the pipeline. - - The execution context which contains both the - requests and response context. - - - - Contains the processing logic for an asynchronous request invocation. - This method calls InnerHandler.InvokeSync to continue processing of the - request by the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Logs the metrics for the current execution context. - - The execution context, it contains the - request and response context. - - - - The default implementation of the adaptive retry policy. - - - The default implementation of the adaptive policy. - - - - - Constructor for AdaptiveRetryPolicy. - - The maximum number of retries before throwing - back a exception. This does not count the initial request. - - - - Constructor for AdaptiveRetryPolicy. - - The Client config object. This is used to - retrieve the maximum number of retries before throwing - back a exception(This does not count the initial request) and - the service URL for the request. - - - - OnRetry is called when a retry request is initiated to determine if the request will be retried. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - true if the error that will be retried is a throtting error - True if retry throttling is disabled or retry throttling is enabled and capacity can be obtained. - - - - This method uses a token bucket to enforce the maximum sending rate. - - The execution context which contains both the - requests and response context. - If the prior request failed, this exception is expected to be - the exception that occurred during the prior request failure. - - - - Virtual method that gets called on a success Response. If its a retry success response, the entire - retry acquired capacity is released(default is 5). If its just a success response a lesser value capacity - is released(default is 1). - - Request context containing the state of the request. - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - This method uses a token bucket to enforce the maximum sending rate. - - The execution context which contains both the - requests and response context. - If the prior request failed, this exception is expected to be - the exception that occurred during the prior request failure. - - - - The default implementation of the legacy retry policy. - - - The default implementation of the legacy retry policy. - - - - - The maximum value of exponential backoff in milliseconds, which will be used to wait - before retrying a request. The default is 30000 milliseconds. - - - - - Constructor for DefaultRetryPolicy. - - The maximum number of retries before throwing - back a exception. This does not count the initial request. - - - - Constructor for DefaultRetryPolicy. - - The Client config object. This is used to - retrieve the maximum number of retries before throwing - back a exception(This does not count the initial request) and - the service URL for the request. - - - - Returns true if the request is in a state where it can be retried, else false. - - Request context containing the state of the request. - Returns true if the request is in a state where it can be retried, else false. - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - true if the error that will be retried is a throtting error - - - - Virtual method that gets called on a success Response. If its a retry success response, the entire - retry acquired capacity is released(default is 5). If its just a success response a lesser value capacity - is released(default is 1). - - Request context containing the state of the request. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Request context containing the state of the request. - Return true if the request should be retried. - - - - Checks if the retry limit is reached. - - Request context containing the state of the request. - Return false if the request can be retried, based on number of retries. - - - - Waits before retrying a request. The default policy implements a exponential backoff. - - Request context containing the state of the request. - - - - Waits for an amount of time using an exponential backoff algorithm. - - The request retry index. The first request is expected to be 0 while - the first retry will be 1. - The max number of milliseconds to wait - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - The retry handler has the generic logic for retrying requests. - It uses a retry policy which specifies when - a retry should be performed. - - - - - The logger used to log messages. - - - - - The retry policy which specifies when - a retry should be performed. - - - - - Constructor which takes in a retry policy. - - Retry Policy - - - - Invokes the inner handler and performs a retry, if required as per the - retry policy. - - The execution context which contains both the - requests and response context. - - - - Invokes the inner handler and performs a retry, if required as per the - retry policy. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Prepares the request for retry. - - Request context containing the state of the request. - - - - The default implementation of the standard retry policy. - - - The default implementation of the standard policy. - - - - - The maximum value of exponential backoff in milliseconds, which will be used to wait - before retrying a request. The default is 20000 milliseconds. - - - - - Constructor for StandardRetryPolicy. - - The maximum number of retries before throwing - back a exception. This does not count the initial request. - - - - Constructor for StandardRetryPolicy. - - The Client config object. This is used to - retrieve the maximum number of retries before throwing - back a exception(This does not count the initial request) and - the service URL for the request. - - - - Returns true if the request is in a state where it can be retried, else false. - - Request context containing the state of the request. - Returns true if the request is in a state where it can be retried, else false. - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - true if the error that will be retried is a throtting error - - - - Virtual method that gets called on a success Response. If its a retry success response, the entire - retry acquired capacity is released(default is 5). If its just a success response a lesser value capacity - is released(default is 1). - - Request context containing the state of the request. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Request context containing the state of the request. - Return true if the request should be retried. - - - - Checks if the retry limit is reached. - - Request context containing the state of the request. - Return false if the request can be retried, based on number of retries. - - - - Waits before retrying a request. The default policy implements a exponential backoff with - jitter algorithm. - - Request context containing the state of the request. - - - - Waits for an amount of time using an exponential backoff with jitter algorithm. - - The request retry index. The first request is expected to be 0 while - the first retry will be 1. - The max number of milliseconds to wait - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - A runtime pipeline contains a collection of handlers which represent - different stages of request and response processing. - - - - - The top-most handler in the pipeline. - - - - - Constructor for RuntimePipeline. - - The handler with which the pipeline is initalized. - - - - Constructor for RuntimePipeline. - - List of handlers with which the pipeline is initalized. - - - - Constructor for RuntimePipeline. - - List of handlers with which the pipeline is initalized. - The logger used to log messages. - - - - Constructor for RuntimePipeline. - - The handler with which the pipeline is initalized. - The logger used to log messages. - - - - Invokes the pipeline synchronously. - - Request context - Response context - - - - Invokes the pipeline asynchronously. - - Request context - Response context - - - - Adds a new handler to the top of the pipeline. - - The handler to be added to the pipeline. - - - - Adds a handler after the first instance of handler of type T. - - Type of the handler after which the given handler instance is added. - The handler to be added to the pipeline. - - - - Adds a handler before the first instance of handler of type T. - - Type of the handler before which the given handler instance is added. - The handler to be added to the pipeline. - - - - Removes the first occurance of a handler of type T. - - Type of the handler which will be removed. - - - - Replaces the first occurance of a handler of type T with the given handler. - - Type of the handler which will be replaced. - The handler to be added to the pipeline. - - - - Inserts the given handler after current handler in the pipeline. - - Handler to be inserted in the pipeline. - Handler after which the given handler is inserted. - - - - Gets the innermost handler by traversing the inner handler till - it reaches the last one. - - - - - Retrieves a list of handlers, in the order of their execution. - - Handlers in the current pipeline. - - - - Retrieves current handlers, in the order of their execution. - - Handlers in the current pipeline. - - - - The CSM handler has the logic for capturing data for CSM attempts when enabled. - - - - - Invokes the CSM handler and captures data for the CSM attempts. - - - - - Calls the PreInvoke and PostInvoke methods before and after calling the next handler - in the pipeline. - - - - - Method that gets called in the final clause that captures data for each http request - from the request and response context. - - - - - Executes the OnPreInvoke action as part of pre-invoke. - - - - - Method to collect data in case of connection exception - - - - - Method to collect data in case of Amazon service exception - - - - - The CSM handler has the logic for capturing data for CSM events when enabled. - - - - - Invokes the CSM handler and captures data for the CSM events. - - - - - Calls the PreInvoke and PostInvoke methods before and after calling the next handler - in the pipeline. - - - - - Invoked from the finally block of CSMCallEventHandler's Invoke method. - This method is used to capture CSM Call event metrics. - - - - - - Method that gets invoked in case of an exception in the API request completion. - - - - - - - This class is responsible for managing adaptive retry mode client rate limiting. - - - - - The rate at which token are replenished. - - - - - The maximum capacity allowed in the token - - - - - The current capacity of the token - - - - - The last time the token bucket was refilled. - - - - - The smoothed rate which tokens are being retrieved. - - - - - The last half second time bucket used. - - - - - The number of requests seen within the current time - - - - - The maximum rate when the client was last throttled. - - - - - The last time when the client was throttled. - - - - - The cached time window calculation - - - - - Boolean indicating if the token bucket is enabled. - - - - - This method attempts to acquire capacity from the client's token - - The amount of capacity to obtain from the token bucket - Indicates that the client should or shouldn't sleep and - try again if capacity cannot be obtained. - - - - - This method attempts to acquire capacity from the client's token - - The amount of capacity to obtain from the token bucket - Indicates that the client should or shouldn't sleep and - try again if capacity cannot be obtained. - - Token which can be used to cancel the task. - - - - Updates the sending rate within the client's token bucket - - Indicates if the request resulted in a throttling error. - - - - Calculates the rate - - - Returns the calculated rate for a successful call - - - - Calculates the rate. - - The rate to use in the calculation - Returns the calculated rate for a throttled call - - - - This class gets the CSM configuration if set. - The priority goes - 1. App.config / instantiate on the AWSConfigs class - 2. Environment variable - 3. Shared Profile - - - - - Determine CSM configs from shared profile file. - - - - - Determine CSM configs from environment variables. - - - - - Determine CSM configs from AWSConfigs class. - - - - - Utility class for CSM. - Contains logic to serialize CSM events to Json. - - - - - Method to retrieve the API name from the request name. - - - - - Method to serialize MonitoringAPICallAttempt CSM event to json. - - - - - Method to serialize MonitoringAPICallEvent CSM event to json. - - - - - Method to serialize MonitoringAPICall CSM event to json. - - - - - Internal class that has the CSM configurations for the Monitoring Listener - after being derived from the CSMConfigChain class. - - - - - CSM event base class - - - - - Contains the operation name for the api call being made - - - - - Contains the service id ServiceId Sep of the service - against which the call is being made - - - - - Contains the "ClientId" configuration value - computed from the CSMConfigChain class - - - - - Contains the elapsed time, in milliseconds, - since January 1st, 1970, for the time point - at which the event occurred - - - - - Contains "ApiCall" or "ApiCallAttempt" - based on what the monitoring event is describing - - - - - Contains the enum of the above CSM type property - - - - - Contains the "Version" configuration value - computed from the CSMConfigChain class - Defaults to 1. - - - - - Contains the signing region used by the - service client that made the request attempt. - - - - - Contains the full value of the SDK's default - user agent header for http requests. - - - - - Class that captures the CSM Api Call Attempt Monitoring Events - for each http request and its subsequent response. - - - - - Contains the fully-qualified domain name of the endpoint that - the request attempt was submitted to. - - - - - Contains the session token passed - in the x-amz-security-token header. - - - - - Contains the aws_access_key value that - was used to sign the http request. - - - - - Contains the attempt's response status code, - as returned by the http client. - - - - - Contains the full text (exception object converted to String, - for example) for any attempt-level failure that is due to - something other than an Aws exception. The value of this entry - has a maximum length of 512. - - - - - Contains the short error name (exception class name, for example) - for any attempt-level failure that is due to something other - than an Aws exception.The value of this entry has a maximum length of 128. - - - - - Contains the Aws exception code returned in the response. - - - - - Contains the full text of the Aws exception message. - - - - - Contains the value of the response's x-amzn-RequestId header. - - - - - Contains the value of the response's x-amz-request-id header. - - - - - Contains the value of the response's x-amz-id-2 header. - - - - - Contains the elapsed time, in milliseconds, - between the construction of the http request and the - point in time where the http response has been parsed - or the attempt has definitively failed. - - - - - Class that captures the CSM Api Call Monitoring Events - for the entire SDK call. This is processed once. - - - - - Contains the total number of attempts that were made - by the service client to fulfill this request before succeeding or failing - - - - - Contains the elapsed time, in milliseconds, - between when the Api Call was begun and when a - final response or error is manifested to the caller - - - - - a boolean (0/1) value that is 0 unless the Api call failed - and the final attempt returned a retryable error.This entry should be - serialized as a numeric 0/1 value. This is mapped to MaxRetriesExceeded - when serialized to a UDP datagram. - - - - - Contains the full text (exception object - converted to String, for example) for an attempt-level failure that is due to - something other than an Aws exception that occurred on the last attempt to - fulfill the Api call.The value of this entry has a maximum length of 512. - - - - - Contains the short error name (exception - class name, for example) for a failure that is due to something other than an - Aws exception that occurred on the last attempt to fulfill an Api call.See - the SdkException entry for more details.The value of this entry has a - maximum length of 128. - - - - - Contains the Aws exception code - returned in the response to the final attempt at fulfilling this API call. - The value of this entry has a maximum length of 128. - - - - - - Contains the attempt's response status code, - as returned by the http client. - - - - - This class is the base class of all the configurations settings to connect - to a service. - - - This class is the base class of all the configurations settings to connect - to a service. - - - - - Gets Service Version - - - - - Gets and sets of the signatureMethod property. - - - - - Gets and sets of the SignatureVersion property. - - Note: This property exists for backward compatibility but is no longer - used by any service other than S3. - - - - - Gets and sets of the UserAgent property. - - - - - When set to true, the service client will use the x-amz-user-agent - header instead of the User-Agent header to report version and - environment information to the AWS service. - - Note: This is especially useful when using a platform like WebAssembly - which doesn't allow to specify the User-Agent header. - - - - - Gets and sets the RegionEndpoint property. The region constant that - determines the endpoint to use. - - Setting this property to null will force the SDK to recalculate the - RegionEndpoint value based on App/WebConfig, environment variables, - profile, etc. - - - - - The constant used to lookup in the region hash the endpoint. - - - - - Gets and sets of the ServiceURL property. - This is an optional property; change it - only if you want to try a different service - endpoint. - - - - - Gets and sets the UseHttp. - If this property is set to true, the client attempts - to use HTTP protocol, if the target endpoint supports it. - By default, this property is set to false. - - - - - Given this client configuration, return a string form ofthe service endpoint url. - - - - - Gets and sets the AuthenticationRegion property. - Used in AWS4 request signing, this is an optional property; - change it only if the region cannot be determined from the - service endpoint. - - - - - Gets and sets the AuthenticationServiceName property. - Used in AWS4 request signing, this is the short-form - name of the service being called. - - - - - Returns the flag indicating how many retry HTTP requests an SDK should - make for a single SDK operation invocation before giving up. This flag will - return 4 when the RetryMode is set to "Legacy" which is the default. For - RetryMode values of "Standard" or "Adaptive" this flag will return 2. In - addition to the values returned that are dependant on the RetryMode, the - value can be set to a specific value by using the AWS_MAX_ATTEMPTS environment - variable, max_attempts in the shared configuration file, or by setting a - value directly on this property. When using AWS_MAX_ATTEMPTS or max_attempts - the value returned from this property will be one less than the value entered - because this flag is the number of retry requests, not total requests. To - learn more about the RetryMode property that affects the values returned by - this flag, see . - - - - - Determines if MaxErrorRetry has been manually set. - - - - - Gets and sets the LogResponse property. - If this property is set to true, the service response is logged. - The size of response being logged is controlled by the AWSConfigs.LoggingConfig.LogResponsesSizeLimit property. - - - - - Gets and sets the ReadEntireResponse property. - NOTE: This property does not effect response processing and is deprecated. - To enable response logging, the ClientConfig.LogResponse and AWSConfigs.LoggingConfig - properties can be used. - - - - - Gets and Sets the BufferSize property. - The BufferSize controls the buffer used to read in from input streams and write - out to the request. - - - - - - Gets or sets the interval at which progress update events are raised - for upload operations. By default, the progress update events are - raised at every 100KB of data transferred. - - - If the value of this property is set less than ClientConfig.BufferSize, - progress updates events will be raised at the interval specified by ClientConfig.BufferSize. - - - - - - Flag on whether to resign requests on retry or not. - For Amazon S3 and Amazon Glacier this value will always be set to true. - - - - - This flag controls if .NET HTTP infrastructure should follow redirection - responses (e.g. HTTP 307 - temporary redirect). - - - - - Flag on whether to log metrics for service calls. - - This can be set in the application's configs, as below: - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSLogMetrics" value"true"/> - </appSettings> - </configuration> - - - - - - Gets and sets the DisableLogging. If true logging for this client will be disabled. - - - - - Credentials to use with a proxy. - - - - - - If the value is set, the value is assigned to the Timeout property of the HttpWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Configures the endpoint calculation for a service to go to a dual stack (ipv6 enabled) endpoint - for the configured region. - - - Note: AWS services are enabling dualstack endpoints over time. It is your responsibility to check - that the service actually supports a dualstack endpoint in the configured region before enabling - this option for a service. - - - - - Enable or disable the Retry Throttling feature by setting the ThrottleRetries flag to True/False resepctively. - Retry Throttling is a feature that intelligently throttles retry attempts when a large precentage of requests - are failing and retries are unsuccessful as well. In such situations the allotted retry capacity for the service URL - will be drained until requests start to succeed again. Once the requisite capacity is available, retries would - be permitted again. When retries are throttled, the service enters a fail-fast behaviour as the traditional retry attempt - for the request would be circumvented. Hence, errors will resurface quickly. This will result in a greated number of exceptions - but prevents requests being tied up in unsuccessful retry attempts. - Note: Retry Throttling is enabled by default. Set the ThrottleRetries flag to false to switch off this feature. - - - - - Enable or disable the Nagle algorithm on the underlying http - client. - - This method is not intended to be called by consumers of the AWS SDK for .NET - - - - - - Performs validation on this config object. - Throws exception if any of the required values are missing/invalid. - - - - - Returns the current UTC now after clock correction for this endpoint. - - - - - The calculated clock skew correction for a specific endpoint, if there is one. - This field will be set if a service call resulted in an exception - and the SDK has determined that there is a difference between local - and server times. - - If is set to true, this - value will still be set to the correction, but it will not be used by the - SDK and clock skew errors will not be retried. - - - - - Gets and sets the DisableHostPrefixInjection flag. If true, host prefix injection will be disabled for this client, the default value of this flag is false. - Host prefix injection prefixes the service endpoint with request members from APIs which use this feature. - Example: for a hostPrefix of "foo-name." and a endpoint of "service.region.amazonaws.com" the default behavior is to - prefix the endpoint with the hostPrefix resulting in a final endpoint of "foo-name.service.region.amazonaws.com". Setting - DisableHostPrefixInjection to true will disable hostPrefix injection resulting in a final endpoint of - "service.region.amazonaws.com" regardless of the value of hostPrefix. E.g. You may want to disable host prefix injection for testing against a local mock endpoint. - - - - - Returns the flag indicating if endpoint discovery should be enabled or disabled for operations that are not required to use endpoint discovery. - - - - - Returns the maximum number of discovered endpoints that can be stored within the cache for the client. The default limit is 1000 cache entries. - - - - - Returns the flag indicating the current mode in use for request - retries and influences the value returned from . - The default value is RequestRetryMode.Legacy. This flag can be configured - by using the AWS_RETRY_MODE environment variable, retry_mode in the - shared configuration file, or by setting this value directly. - - - - - Under Adaptive retry mode, this flag determines if the client should wait for - a send token to become available or don't block and fail the request immediately - if a send token is not available. - - - - - Throw an exception if the boxed TimeSpan parameter doesn't have a value or is out of range. - - - - - Returns the request timeout value if its value is set, - else returns client timeout value. - - - - - - This is a switch used for performance testing and is not intended for production applications - to change. This switch may be removed in a future version of the SDK as the .NET Core platform matures. - - - If true, the HttpClient is cached and reused for every request made by the service client - and shared with other service clients. - - - For the .NET Core platform this is default to true because the HttpClient manages the connection - pool. - - - - - - If CacheHttpClient is set to true then HttpClientCacheSize controls the number of HttpClients cached. - - On Windows the default value is 1 since the underlying native implementation does not have throttling constraints - like the non Windows Curl based implementation. For non Windows based platforms the default is the value return from - System.Environment.ProcessorCount. - - - - - - Overrides the default read-write timeout value. - On Unity platform, this value is not used as Unity HTTP client does not support timeouts, so - - - - If the value is set, the value is assigned to the ReadWriteTimeout property of the HttpWebRequest object used - to send requests. - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Returns a WebProxy instance configured to match the proxy settings - in the client configuration. - - - - - Unpacks the host, port and any credentials info into the instance's - proxy-related fields. - Unlike the SetWebProxy implementation on .NET 3.5/4.5,the Host and the Port are not reconstructed from the - input proxyuri - - The proxy details - - - - Gets and sets of the ProxyHost property. - - - - - Gets and sets of the ProxyPort property. - - - - - Get or set the value to use for on requests. - If this property is null, - will be left at its default value of . - - - - - - Returns true if the clients should be cached by HttpRequestMessageFactory, false otherwise. - - - - - - - Returns true if the SDK should dispose HttpClients after one use, false otherwise. - - - - - - - Create a unique string used for caching the HttpClient based on the settings that are used from the ClientConfig that are set on the HttpClient. - - - - - - - Determines if HttpClients created with the given IClientConfig should be cached at the SDK - client level, or cached globally. - - If there is no HttpClientFactory assigned and proxy or proxy credentials are set - this returns false because those properties can't be serialized as part of the key in the global http client cache. - - - - - Base class for constant class that holds the value that will be sent to AWS for the static constants. - - - - - Gets the value that needs to be used when send the value to AWS - - - - - Attempt to find correct-cased constant value using whatever cased value the user - has provided. This is primarily useful for mapping any-cased values from a CLI - tool to the specific casing required by the service, avoiding the need for the - user to (a) remember the specific case and (b) actually type it correctly. - - The properly cased service constant matching the value - - - - Utility class that stores clock skew information. - - - - - GlobalClockCorrection should be only set by AWSConfigs.ManualClockCorrection property - and is only available to maintain backward compatibilty. This should override any - endpoint specific clockskew correction. - - - - - Return clock skew correction value for an endpoint if there is one. - - AWSConfigs.ManualClockCorrection overrides globally any calculated service endpoint specific - clock correction value. - - Endpoint should in a form such as "https://s3" - Clock correction value for an endpoint in TimeSpan. TimeSpan.Zero if no such clock correction is set. - - - - Get clock skew corrected UTC now value. If ManualClockCorrection is set, - use ManualClockCorrection instead of endpoint specific clock correction value. - - - - - - - Class to easily convert from Dictionary<string, string> to ProfileOptions and back. - - - - - Separate the profileDictionary into its parts. - profileDictionary = profileOptions + reservedProperties + userProperties - - Dictionary with everything in it - Keys to ignore - The resulting CredentialProfileOptions - The properties that are left - - - - Separate the profileDictionary into its parts. - profileDictionary = profileOptions + reservedProperties + userProperties - - Dictionary with everything in it - Keys for the reservedKeys dictionary - The resulting CredentialProfileOptions - The resulting reserved properties - The properties that are left - - - - Validate the userProperties and then combine profileOptions, reservedProperties, and userProperties into one Dictionary. - - - - - - - - - - Make sure the userProperties dictionary doesn't contain any keys that are reserved. - Check is case-insensitive for added safety. - - - - - - - Make sure the userProperties dictionary doesn't contain any keys that - overlap with the names of mapped names for CredentialProfileOptions property names. - Check is case-insensitive for added safety. - - - - - - This class is used internally and should not be accessed by SDK users. - - Provide access to internal properties of CredentialProfile to - PowerShell tools and the Visual Studio Toolkit. - - - - - Attempt to read a role session with the given name. - If the session is invalid or expired it will not be returned. - - The name of the role session to get. - The credentials for the session, if found. - True if the session was found, false otherwise. - - - - Factory to construct different types of AWSCredentials based on a profile. - - - - - Gets the AWSCredentials for this profile if CanCreateAWSCredentials is true - and AWSCredentials can be created. Throws an exception otherwise. - - See for a list of AWSCredentials returned by this method. - - The profile to get AWSCredentials for. - The profile source, for profiles that reference other profiles. - AWSCredentials for this profile. - - - - Gets the AWSCredentials for this profile if CanCreateAWSCredentials is true - and AWSCredentials can be created. Throws an exception otherwise. - - See for a list of AWSCredentials returned by this method. - - The options to get AWSCredentials for. - The profile source, for options that reference other profiles. - AWSCredentials for the options given. - - - - Gets the AWSCredentials for this profile if CanCreateAWSCredentials is true - and AWSCredentials can be created. Throws an exception otherwise. - - See for a list of AWSCredentials returned by this method. - - The profile to get AWSCredentials for. - The profile source, for profiles that reference other profiles. - If true, throw a descriptive exception for any credentials that would not operate as-is. - In other words, any credentials that require programmatic callbacks at runtime. - AWSCredentials for this profile. - - - - Gets the AWSCredentials for this profile if CanCreateAWSCredentials is true - and AWSCredentials can be created. Throws an exception otherwise. - - See for a list of AWSCredentials returned by this method. - - The options to get AWSCredentials for. - The profile source, for options that reference other profiles. - If true, throw a descriptive exception for any credentials that would not operate as-is. - In other words, any credentials that require programmatic callbacks at runtime. - AWSCredentials for the options given. - - - - Return the credentials for the profile if valid credentials can created. - - The profile to create credentials with. - The profile source, for profiles that reference other profiles. - The credentials for the profile. - True if credentials can be created from the profile, false otherwise. - - - - Return the credentials for the profile if valid credentials can created. - - The options to get AWSCredentials for. - The profile source, for profiles that reference other profiles. - The credentials for the profile. - True if credentials can be created from the profile, false otherwise. - - - - Determine if the profileType will generate AWSCredentials that require a callback to be set on them. - - - - - - - A named group of options that are persisted and used to obtain AWSCredentials. - - - - - The name of the CredentialProfile - - - - - The options to be used to create AWSCredentials. - - - - - The region to be used with this CredentialProfile - - - - - The unique key for this CredentialProfile. - This key is used by the Visual Studio Tooklit to associate external artifacts with this profile. - - - - - The endpoint discovery enabled value for this CredentialProfile - - - - - If true the region identified in the S3 access point arn will be used when making requests. - - - - - The Sts Regional Endpoints Value as either legacy or regional - - - - - The S3 Regional Endpoint Value as either legacy or regional - - - - - The request retry mode as legacy, standard, or adaptive - - - - - Specified how many HTTP requests an SDK should make for a single - SDK operation invocation before giving up. - - - - - An optional dictionary of name-value pairs stored with the CredentialProfile - - - - - True if the properties of the Options object can be converted into AWSCredentials, false otherwise. - See for more details about which options are available. - - - - - The that this is associated with. - Null if this is not associated with a . - - - - - If CanCreateAWSCredentials is true, returns a short description of the type of - credentials that would be created. - If CanCreateAWSCredentials is false, return null. - - - - - The CredentialProfileType of this CredentialProfile, if one applies. - - - - - Determine this CredentialProfile will generate AWSCredentials that require a callback to be set on them. - - - - - Construct a new CredentialProfile. - - - - - - - Gets the AWSCredentials for this profile if CanCreateAWSCredentials is true - and AWSCredentials can be created. Throws an exception otherwise. - - See for a list of AWSCredentials returned by this method. - - The profile source, for profiles that reference other profiles. - AWSCredentials for this profile. - - - - Gets the AWSCredentials for this profile if CanCreateAWSCredentials is true - and AWSCredentials can be created. Throws an exception otherwise. - - See for a list of AWSCredentials returned by this method. - - The profile source, for profiles that reference other profiles. - If true, throw a descriptive exception for any credentials that would not operate as-is. - In other words, any credentials that require programmatic callbacks at runtime. - AWSCredentials for this profile. - - - - The options that are available for creating AWSCredentials with the AWSCredentialsFactory. - The type of AWSCredentials that are created depends on which Options are set. - - Below are the different types of credentials returned, along with the options that are used to obtain them. - ([] denotes options that are not required) - - BasicAWSCredentials AccessKey SecretKey - SessionAWSCredentials AccessKey SecretKey Token - AssmeRoleAWSCredentials SourceProfile RoleArn [ExternalID] [MfaSerial] - FederatedAWSCredentials EndpointName RoleArn [UserIdentity] - - - - - The access key to be used in the AWSCredentials. - - - - - The source of credentials to be used to obtain AWSCredentials. - - - - - The endpoint name to be used for federated AWSCredentials. - - - - - The external id to use in assume role AWSCredentials. - - - - - The serial number of the MFA to use in assume role AWSCredentials. - - - - The role ARN to use when creating assume role or federated AWSCredentials. - - - - An identifier for the assumed role session. - - - - - The secret key to use when creating AWSCredentials. - - - - - When this CredentialProfileOptions object references another CredentialProfile, - the name of the referenced CredentialProfile. - - - - - The session token to be used to create AWSCredentials. - - - - - The user identity to use when creating federated AWSCredentials. - If not set, the user identity that the code is running under will be used. - - - - - Contains the executable information to be used by the process credential retriever - to either fetch Basic or Session credentials - - - - - Absolute path to the file on disk containing an OIDC token. - - - - - Return true the properties are all null or empty, false otherwise. - - - - - Class to abstract the combined use of NetSDKCredentialsFile and SharedCredentialsFile where possible. - - - - - - The location of the shared credentials file, or null to use the default location. - - - - - Construct a CredentialProfileChain. - - - - - Construct a CredentialProfileChain. - - The path to the aws credentials file to look at. - - - - - Try to get from a profile. - - - If ProfilesLocation is non-null and non-empty search the shared credentials - file at the disk path in the ProfilesLocation property. - - - If ProfilesLocation is null or empty and the platform supports the .NET SDK credentials file - search the SDK credentials file. If the profile is not found search the shared credentials file in the default location. - - - If ProfilesLocation is null or empty and the platform doesn't support the .NET SDK credentials file - search the shared credentials file in the default location. - - - The name of the profile to get credentials from. - The credentials, if the profile is found and credentials can be created. - True if the profile was found and credentials could be created, false otherwise. - - - - - Try to get a - - - If ProfilesLocation is non-null and non-empty search the shared credentials - file at the disk path in the ProfilesLocation property. - - - If ProfilesLocation is null or empty and the platform supports the .NET SDK credentials file - search the SDK credentials file. If the profile is not found search the shared credentials file in the default location. - - - If ProfilesLocation is null or empty and the platform doesn't support the .NET SDK credentials file - search the shared credentials file in the default location. - - - The name of the profile to get. - The profile, if found - True if the profile was found, false otherwise. - - - - - Get a list of available objects. - - - If ProfilesLocation is non-null and non-empty include profiles in the shared credentials - file at the disk path in the ProfilesLocation property. - - - If ProfilesLocation is null or empty and the platform supports the .NET SDK credentials file - include profiles from the SDK credentials file and from the shared credentials file in the default location. - - - If ProfilesLocation is null or empty and the platform doesn't support the .NET SDK credentials file - include profiles from the shared credentials file in the default location. - - - A list of objects. - - - - - Register a - - - If ProfilesLocation is non-null and non-empty register the profile in the shared credentials - file at the disk path in the ProfilesLocation property. - - - If ProfilesLocation is null or empty and the platform supports the .NET SDK credentials file - register the profile in the SDK credentials file. - - - If ProfilesLocation is null or empty and the platform doesn't support the .NET SDK credentials file - register the profile in the shared credentials file in the default location. - - - The profile to register. - - - - - Unregister a - - - If ProfilesLocation is non-null and non-empty unregister the profile from the shared credentials - file at the disk path in the ProfilesLocation property. - - - If ProfilesLocation is null or empty and the platform supports the .NET SDK credentials file - search the SDK credentials file. If the profile is found there unregister it. - If the profile was not found search the shared credentials file in the default location. - If the profile is found in the shared credentials file in the default location unregister it. - - - If ProfilesLocation is null or empty and the platform doesn't support the .NET SDK credentials file - search the shared credentials file in the default location. If the profile is found in the - shared credentials file in the default location unregister it. - - - The name of the profile to unregister. - - - - Interface to define the necessary operations for a CredentialProfile lookup mechanism. - - - - - Get the profile with the given name, if one exists. - - The name of the profile to get. - The profile, if it was found, null otherwise. - True if the profile was found, false otherwise. - - - - Interface to define the necessary operations for a CredentialProfile storage mechanism. - - - - - Rename the profile with oldProfileName to newProfileName. - - The profile to rename. - The new name for the profile. - - - - Rename the profile with oldProfileName to newProfileName. - - The profile to rename. - The new name for the profile. - If true and the destination profile exists it will be overwritten. - - - - Make a copy of the profile with fromProfileName called toProfileName. - - The name of the profile to copy from. - The name of the new profile. - - - - Make a copy of the profile with fromProfileName called toProfileName. - - The name of the profile to copy from. - The name of the new profile. - If true and the destination profile exists it will be overwritten. - - - - Add the given profile to the store, or update it if one with the same name already exists. - - - - - - Delete the profile with profileName if it exists. - - The name of the profile to delete. - - - - Get a list of valid profile names from this store. - Invalid profiles are ignored. - See for more information - about valid profiles. - - - - - - Get a list of valid profiles from this store. - Invalid profiles are ignored. - See for more information - about valid profiles. - - - - - - This class allows profiles supporting AWSCredentials to be registered with - the SDK so that they can later be reference by a profile name. The credential profiles will be available - for use in the AWS Toolkit for Visual Studio and the AWS Tools for Windows PowerShell. - - The credentials are stored under the current users AppData folder encrypted using Windows Data Protection API. - - - This class is not threadsafe. - - - - - - Get the profile with the name given, if it exists in this store. - - The name of the profile to find. - The profile, if it was found, null otherwise - True if the profile was found, false otherwise. - - - - Add the profile to this store, if it's valid. - - The profile to add. - - - - If there is a profile in the store with the given name, delete it. - - The name of the profile to delete. - - - - Rename the profile with oldProfileName to newProfileName. - - The profile to rename. - The new name for the profile. - - - - Rename the profile with oldProfileName to newProfileName. - - The profile to rename. - The new name for the profile. - If true and the destination profile exists it will be overwritten. - - - - Make a copy of the profile with fromProfileName called toProfileName. - - The name of the profile to copy from. - The name of the new profile. - - - - Make a copy of the profile with fromProfileName called toProfileName. - - The name of the profile to copy from. - The name of the new profile. - If true and the destination profile exists it will be overwritten. - - - - Set the ProfileType field to maintain backward compatibility with ProfileManager. - The value is ignored when it's read back in. - - - - - - - Represents the different types of authentication available for SAML endpoints. - - - - - Representation of a SAML Endpoint. - - - - - The name given to this SAMLEndpoint. - - - - - The URI of the SAML endnpoint. - - - - - The authentication type associated with the SAML endpoint. - - - - - Internal constructor. Used by SAMLEndpointManager when reading endpoints from the encrypted store. - - - - - - - - Construct a SAMLEndpoint using the default SAMLAuthenticationType - Kerberos. - - The name of the endpoint. - The URI of the endpoint. - - - - Construct a SAMLEndpoint. - - The name of the endpoint. - The URI of the endpoint. - The authentication type of the endpoint. - - - - Manages endpoints to be used in conjunction with SAML role profiles. The role profiles - reference the endpoint to obtain the actual endpoint and any customization settings - needed to perform authentication. - - - - - Construct a SAMLEndpointManager. - - - - - True if the SAMLEndpointManager is available on the current platform, false otherwise. - - - - - Register an endpoint, or update an existing one. - - The endpoint to register. - - - - Get an endpoint, if it exists and is valid. - - The name of the endpoint to get. - The endpoint, or null if it's invalid or doesn't exist. - True if the endpoint exists and is valid, false otherwise. - - - - Get an endpoint from the store. - Throws an exception if there's an error reading the endpoint, or if it doesn't exist. - - The name of the endpoint to get. - The endpoint with the given name. - - - - Delete an endpoint from the store, if it exists. - - The name of the endpoint to delete. - - - - List the names of valid endpoints in the store. - - - - - - List valid endopints that can be read from the store. - - - - - - Provides access to read and write to the shared credentials INI file. - The file is read, parsed, and validated at construction time. - Changes can be made using the RegisterProfile() and - UnregisterProfile() methods. - - This class is not threadsafe. - - - - - To maintain compatibility with the CLI, - SharedCredentialsFile doesn't support the SAML profileTypes. - - - - - Construct a new SharedCredentialsFile in the default location. - - - - - Construct a new SharedCredentialsFile. - - The path of the shared credentials file. - - - - Add the profile given. If the profile already exists, update it. - - The profile to be written. - - - - Update the profile on disk regardless of the profile type. - - - - - - Deletes the section with the given ProfileName from the SharedCredentialsFile, if one exists. - - The ProfileName of the section to delete. - - - - Rename the profile with oldProfileName to newProfileName. - - The profile to rename. - The new name for the profile. - - - - Rename the profile with oldProfileName to newProfileName. - - The profile to rename. - The new name for the profile. - If true and the destination profile exists it will be overwritten. - - - - Make a copy of the profile with fromProfileName called toProfileName. - - The name of the profile to copy from. - The name of the new profile. - - - - Make a copy of the profile with fromProfileName called toProfileName. - - The name of the profile to copy from. - The name of the new profile. - If true and the destination profile exists it will be overwritten. - - - - Try to get a profile that may be partially in the credentials file and partially in the config file. - If there are identically named properties in both files, the properties in the credentials file take precedence. - - - - - - - - Anonymous credentials. - Using these credentials, the client does not sign the request. - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - AWS Credentials that automatically refresh by calling AssumeRole on - the Amazon Security Token Service. - - - - - The credentials of the user that will be used to call AssumeRole. - - - - - The Amazon Resource Name (ARN) of the role to assume. - - - - - An identifier for the assumed role session. - - - - - Options to be used in the call to AssumeRole. - - - - - Constructs an AssumeRoleAWSCredentials object. - - The credentials of the user that will be used to call AssumeRole. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - - - - Constructs an AssumeRoleAWSCredentials object. - - The credentials of the user that will be used to call AssumeRole. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRole. - - - - A unique identifier that is used by third parties when assuming roles in their customers' accounts. - - - - - An IAM policy in JSON format. - - - - - The length of time in seconds before the credentials will expire. - - - - - The proxy settings to use when calling AssumeRole. - - - - - The identification number of the MFA device that is associated with the user who is making the assume-role call. - - - - - The value provided by the MFA device, if the trust policy of the role being assumed requires MFA. - - - - - A callback that's used to obtain the MFA token code when the AssumeRoleAWSCredentials are refreshed. - - - - - Immutable representation of AWS credentials obtained as a result of - authenticating with the AssumeRole method of the Security Token Service. - - - - - The expiry time of the credentials, obtained from the AssumeRoleResponse. - - - - - Constructs an instance with supplied keys, token, and expiration. - - The AccessKey for the credentials. - The SecretKey for the credentials. - The security token for the credentials. - The expiration time for the credentials. - - - - Get a copy of this AssumeRoleImmutableCredentials object. - - A copy of this object. - - - - Abstract class that represents a credentials object for AWS services. - - - - - Returns a copy of ImmutableCredentials - - - - - - Called by AmazonServiceClient to validate the credential state - on client construction. - - - - - Basic set of credentials consisting of an AccessKey and SecretKey - - - - - Constructs a BasicAWSCredentials object for the specified accessKey and secretKey. - - - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - When running in an ECS container and AWS_CONTAINER_CREDENTIALS_RELATIVE_URI is set, - use the given end point to retrieve the credentials. - - - - - These constants should not be consumed by client code. They are only relevant - in the context of ECS container and, especially, AWS_CONTAINER_CREDENTIALS_RELATIVE_URI - environment variable should not be overriden by the client code. - - - - If AWS_CONTAINER_CREDENTIALS_RELATIVE_URI environment variable is set, we want to attempt to retrieve credentials - using ECS endpoint instead of referring to instance profile credentials. - - - If AWS_CONTAINER_CREDENTIALS_RELATIVE_URI environment variable is set, we want to attempt to retrieve credentials - using ECS endpoint instead of referring to instance profile credentials. - - - - Immutable representation of AWS credentials. - - - - - Gets the AccessKey property for the current credentials. - - - - - Gets the SecretKey property for the current credentials. - - - - - Gets the Token property for the current credentials. - - - - - Gets the UseToken property for the current credentials. - Specifies if Token property is non-emtpy. - - - - - Constructs an ImmutableCredentials object with supplied accessKey, secretKey. - - - - Optional. Can be set to null or empty for non-session credentials. - - - - Returns a copy of the current credentials. - - - - - - Abstract class for automatically refreshing AWS credentials - - - - - Refresh state container consisting of credentials - and the date of the their expiration - - - - - Represents the current state of the Credentials. - - This can be cleared without synchronization. - - - - Semaphore to control thread access to GetCredentialsAsync method. - The semaphore will allow only one thread to generate new credentials and - update the current state. - - - - - The time before actual expiration to expire the credentials. - Property cannot be set to a negative TimeSpan. - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - Test credentials existence and expiration time - should update if: - credentials have not been loaded yet - it's past the expiration time. At this point currentState.Expiration may - have the PreemptExpiryTime baked into to the expiration from a call to - UpdateToGeneratedCredentials but it may not if this is new application load. - - - - - When overridden in a derived class, generates new credentials and new expiration date. - - Called on first credentials request and when expiration date is in the past. - - - - - - When overridden in a derived class, generates new credentials and new expiration date. - - Called on first credentials request and when expiration date is in the past. - - - - - - Clears currently-stored credentials, forcing the next GetCredentials call to generate new credentials. - - - - - Immutable representation of AWS credentials obtained as a result of - authenticating against a SAML-supporting federated identity provider. - - - - - The expiry time of the credentials, obtained from the AssumeRoleWithSAML response. - - - - - The value of the NameID element in the Subject element of the SAML assertion, as returned in the - AssumeRoleWithSAML response from the Security Token Service. - - - - - Constructs an instance with supplied keys and SAML assertion data. - - - - - - - - - - Constructs an instance with supplied keys and SAML assertion data. - - - - - - - - Returns a copy of the current credentials. - - - - - - Serializes the instance to a json-format string for external storage - - The serialized object in json - - - - Instantiates an instance from persisted json data - - The serialized data - Deserialized instance corresponding to the json data - - - - Session credentials consisting of AccessKey, SecretKey and Token - - - - - Constructs a SessionAWSCredentials object for the specified accessKey, secretKey. - - - - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - AWS Credentials that automatically refresh by calling AssumeRole on - the Amazon Security Token Service. - - - - - As established by STS, the regex used to validate the role session names is a string of 2-64 characters consisting of - upper- and lower-case alphanumeric characters with no spaces. You can also include - underscores or any of the following characters: =,.@- - - - - - Options to be used in the call to AssumeRole. - - - - - The absolute path to the file on disk containing an OIDC token - - - - - The Amazon Resource Name (ARN) of the role to assume. - - - - - An identifier for the assumed role session. - - - - - Constructs an AssumeRoleWithWebIdentityCredentials object. - - The absolute path to the file on disk containing an OIDC token. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - - - - Constructs an AssumeRoleWithWebIdentityCredentials object. - - The absolute path to the file on disk containing an OIDC token. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRole. - - - - Creates an instance of from environment variables. - - Throws an if the needed environment variables are not set. - The new credentials. - - - - Gets a client to be used for AssumeRoleWithWebIdentity requests. - - The STS client. - - - - Options for using a credentials object to make AssumeRoleWithWebIdentity calls. - - - - - Gets and sets the property DurationSeconds. - - The duration, in seconds, of the role session. The value can range from 900 seconds - (15 minutes) up to the maximum session duration setting for the role. This setting - can have a value from 1 hour to 12 hours. If you specify a value higher than this - setting, the operation fails. For example, if you specify a session duration of 12 - hours, but your administrator set the maximum session duration to 6 hours, your operation - fails. To learn how to view the maximum value for your role, see View - the Maximum Session Duration Setting for a Role in the IAM User Guide. - - - - By default, the value is set to 3600 seconds. - - - - The DurationSeconds parameter is separate from the duration of a console - session that you might request using the returned credentials. The request to the - federation endpoint for a console sign-in token takes a SessionDuration - parameter that specifies the maximum length of the console session. For more information, - see Creating - a URL that Enables Federated Users to Access the AWS Management Console in the - IAM User Guide. - - - - - - - Gets and sets the property ProviderId. - - The fully qualified host component of the domain name of the identity provider. - - - - Specify this value only for OAuth 2.0 access tokens. Currently www.amazon.com - and graph.facebook.com are the only supported identity providers for - OAuth 2.0 access tokens. Do not include URL schemes and port numbers. - - - - Do not specify this value for OpenID Connect ID tokens. - - - - - - Gets and sets the property Policy. - - An IAM policy in JSON format that you want to use as an inline session policy. - - - - This parameter is optional. Passing policies to this operation returns new temporary - credentials. The resulting session's permissions are the intersection of the role's - identity-based policy and the session policies. You can use the role's temporary credentials - in subsequent AWS API calls to access resources in the account that owns the role. - You cannot use session policies to grant more permissions than those allowed by the - identity-based policy of the role that is being assumed. For more information, see - Session - Policies in the IAM User Guide. - - - - The plain text that you use for both inline and managed session policies shouldn't - exceed 2048 characters. The JSON policy characters can be any ASCII character from - the space character to the end of the valid character list (\u0020 through \u00FF). - It can also include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D) - characters. - - - - The characters in this parameter count towards the 2048 character session policy guideline. - However, an AWS conversion compresses the session policies into a packed binary format - that has a separate limit. This is the enforced limit. The PackedPolicySize - response element indicates by percentage how close the policy is to the upper size - limit. - - - - - - - Gets and sets the property PolicyArns. - - The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use - as managed session policies. The policies must exist in the same account as the role. - - - - This parameter is optional. You can provide up to 10 managed policy ARNs. However, - the plain text that you use for both inline and managed session policies shouldn't - exceed 2048 characters. For more information about ARNs, see Amazon - Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference. - - - - The characters in this parameter count towards the 2048 character session policy guideline. - However, an AWS conversion compresses the session policies into a packed binary format - that has a separate limit. This is the enforced limit. The PackedPolicySize - response element indicates by percentage how close the policy is to the upper size - limit. - - - - Passing policies to this operation returns new temporary credentials. The resulting - session's permissions are the intersection of the role's identity-based policy and - the session policies. You can use the role's temporary credentials in subsequent AWS - API calls to access resources in the account that owns the role. You cannot use session - policies to grant more permissions than those allowed by the identity-based policy - of the role that is being assumed. For more information, see Session - Policies in the IAM User Guide. - - - - - - The proxy settings to use when calling AssumeRoleWithWebIdentity. - - This parameter is optional. - - - - - - State class passed on callback to demand user credentials when authentication - needs to be performed using a non-default identity. - - - - - If the current authentication callback is associated with - a credential profile, this can be used to give the user - some context on the request for his/her authentication. - - - - - Contains the user identity that the user should supply a password - for. The user can ignore if they choose and return credentials for - an alternate account. - - - - - Any custom state that was registered with the callback. - - - - - Set if the callback was due to a failed authentication attempt. - If false we are beginning to obtain or refresh credentials. - - - - - InstanceProfileAWSCredentials allows configuring Roles and every instance hits IMDS individually. - This class has a singleton timer task that caches instance profile credentials every 2 minutes. - - - - - Returns a copy of the most recent instance profile credentials. - - - - - Returns a copy of the most recent instance profile credentials. - - - - - Dispose this object and all related resources. - - - - - Uses aws credentials stored in environment variables to construct the credentials object. - AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY are used for the access key id and secret key. - If the variable AWS_SESSION_TOKEN exists then it will be used to create temporary session - credentials. - - - For backwards compatibility the class will also attempt to discover the secret key from - the AWS_SECRET_KEY variable, if a value cannot be obtained using the standard - AWS_SECRET_ACCESS_KEY variable. - - - - - Constructs an instance of EnvironmentVariablesAWSCredentials. If no credentials are found in - the environment variables then an InvalidOperationException is thrown. - - - - - Creates immutable credentials from environment variables. - - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - Custom exception type thrown when a role profile with user identity is used - in conjunction with a credential request callback. This exception is thrown - if the callback returns null, indicating the user declined to supply credentials. - - - - - Initializes a new exception instance. - - - - - - Initializes a new exception instance. - - - - - - - Custom exception type thrown when authentication for a user fails due to - invalid credentials. - - - - - Initializes a new exception instance. - - - - - - Initializes a new exception instance. - - - - - - - Temporary credentials that are created following successful authentication with - a federated endpoint supporting SAML. - - - In order to use the FederatedAWSCredentials class the AWSSDK.SecurityToken assembly - must be available to your application at runtime. - - - - - Constructs an instance of FederatedAWSCredentials. After construction call GetCredentials - to authenticate the user/process and obtain temporary AWS credentials. - - The SAML endpoint used for authentication. - The role ARN used for authentication. - - - - Constructs an instance of FederatedAWSCredentials. After construction call GetCredentials - to authenticate the user/process and obtain temporary AWS credentials. - - The SAML endpoint used for authentication. - The role ARN used for authentication. - The options used for authentication. - See for details about available options. - - - - The SAML Endpoint used for authentication. - - - - - The role ARN used for authentication. - - - - - The options used for authentication. - See for details about available options. - - - - - Refresh credentials after expiry. If the role profile is configured with user identity - information and a callback has been registered to obtain the user credential, the callback - will be invoked ahead of authentication. For role profiles configured with user identity - but no callback registration, the SDK will fall back to attempting to use the default - user identity of the current process. - - - - - - Clears currently-stored credentials, forcing the next GetCredentials call to generate new credentials. - - - - - Options that control the behavior of . - - - - - The identity to use when authenticating. - This is in the form domain\username, or just username. - If this option is not set, the current user's identity will be used. - - - - - uses this callback to get credentials if the UserIdentity is set. - - - - - When makes a callback for credentials, - this state will be included for use by the callback handler. - - - - - The proxy settings to use when calling the - Secure Token Service and the ADFS endpoint. - - - - - Set this property when a region-specific STS endpoint must be used (eg cn-north-1). - If left empty/null, the global sts.amazonaws.com endpoint will be used when credentials are obtained. - - - - - The profile name, if this FederatedAWSCredentialsOptions - is associated with a CredentialProfile. - - - - - Credentials that are retrieved from the Instance Profile service on an EC2 instance - - - - - Role for which the credentials are retrieved - - - - - Constructs a InstanceProfileAWSCredentials object for specific role - - Role to use - - - - Constructs a InstanceProfileAWSCredentials object for specific role - - Role to use - - - - Constructs a InstanceProfileAWSCredentials object for the first found role - - - - - Constructs a InstanceProfileAWSCredentials object for the first found role - - - - - Retrieves a list of all roles available through current InstanceProfile service - - - - - - Retrieves a list of all roles available through current InstanceProfile service - - - - - - Return true if string is null or whitespace, false otherwise. - We can't use String.IsNullOrWhitespace because it doesn't exist - in all frameworks we support. - - - - - - - Process Credentials can retrieve credentials by running a process and reading its stdout. - A new config option, "credential_process" is added to the shared config file that allows customers - to specify which process to run. The credentials retrieved by running this process could be either - Basic or Session credentials. - - - - - Generates new credentials by running the "credential_process" process. - - - - - Exception class to capture all exceptions encountered when starting or - executing the "credential_process" process. If the user has specified an executable - and the SDK is unable to execute it, the exception should be surfaces to the user - instead of moving on to the next credential provider. - - - - - - Credentials that are retrieved using a stored profile. - - - Unless otherwise specified priority is given to loading credentials from the SDK credential store - file which is shared between the SDK, PowerShell CLI and Toolkit. Credentials in profiles in this - file are encrypted and can only be used by the user account on the current machine that stored the - profile. Credentials can also be loaded from the plain-text ini-format credential file which is - shared with other AWS SDKs. This file is expected to exist in a '.aws' folder in the user's home - directory but alternate locations can be specified using either the AWSProfilesLocation setting in - the application configuration file, or by using the AWS_SHARED_CREDENTIALS_FILE environment variable. - - - The profile name can be specified in the App.config using the AWSProfileName setting. - - - - - - Constructs an instance for credentials stored in a profile. This constructor searches for credentials - using the account name specified using the AWSProfileName setting, if set, in the application configuration - file. If the configuration file setting is not set the SDK will attempt to locate a profile with the name - 'default'. - - - - - Constructs an instance for credentials stored in a profile with the specified name. The SDK will - check the SDK credential store file first before looking for the shared ini-format credentials - file unless the application configuration file contains a setting for the 'AWSProfilesLocation' - indicating the search should be constrained to the shared credentials file at the specified - location. - - The name of the profile in which the credentials were stored. - - - - Constructs an instance for credentials stored in a profile with the specified name. - - The profile name to search for credentials for - - Optional; instructs the SDK to check for the profile in the shared credentials file at the - specified location. If not set, the SDK will inspect its own credential store file first before - attempting to locate a shared credential file using either the default location beneath the user's - home profile folder or the location specified in the AWS_SHARED_CREDENTIALS_FILE environment - variable. - - - If credential materials cannot be read or are invalid due to missing data an InvalidDataException - is thrown. If no credentials can be located with the specified profile name, an ArgumentException - is thrown. - - - - - Name of the profile being used. - - - - - Location of the profiles, if used. - - - - - Tests if a profile has been registered in either the SDK store or the specified credential - file. - - The name of the profile to test - - Optional; instructs the SDK to check for the profile in the shared credentials file at the - specified location. If not set, the SDK will inspect its own credential store file first before - attempting to locate a shared credential file using either the default location beneath the user's - home profile folder or the location specified in the AWS_SHARED_CREDENTIALS_FILE environment - variable. - - True if a profile with the specified name has been registered. - - - - Tests if an instance can be created from the persisted profile data. - If profilesLocation is null/empty, the SDK store is searched for the - profile data before probing for the profile in the shared the ini-format - credential file. - - The name of the profile to test - - If null/empty, the SDK store is searched for the named profile otherwise - the ini-format credential file at the specified location is inspected. - - True if the persisted data would yield a valid credentials instance. - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - Helper routiners for AWS and Federated credential profiles. Probes the - profile type for the supplied profile name and returns the appropriate profile - instance. - - - - - Determines the type of the requested profile and returns the - appropriate profile instance. - - The name of the profile (AWS or federated) to be loaded. - Instantiated profile type. - - - - Determines the type of the requested profile and returns the - appropriate profile instance. - - The name of the profile (AWS or federated) to be loaded. - - The location of the shared credentials (.ini) file, for profiles that are not stored in the - SDK credential store. - - Instantiated profile type. - - - - Probes for and returns the fully qualified name of the shared ini-format credentials - file. - - - Contains the file or folder name of the credential file. If not specified, the - routine will first check the application configuration file for a setting indicating - the file location or filename. If the configuration file does not yield a credential - file location then an environment variable is examined. Finally the routine will - inspect the fallback default location beneath the user's home folder location. - - - The fully qualified name to the credential file that was located, or null - if no credential file could be found. - - - - - Determines the endpoint discovery enabled value based on an environment variable. If no value is found in the - environment then an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of EnvironmentVariable AWS_ENABLED_ENDPOINT_DISCOVERY. If no value is found in the - environment then an InvalidOperationException is thrown. - - - - - Determines endpoint discovery enabled based on a stored in an . - If the profile doesn't exist or there is no endpoint discovery enabled information an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of . - If the AWS_PROFILE environment variable is set the instance will be constructed using that profile, - otherwise it will use the default profile. - - If the profile doesn't exist or there is no endpoint discovery enabled information an InvalidOperationException is thrown. - - The ICredentialProfileSource to read the profile from. - - - - Attempts to construct an instance of . - If the profile doesn't exist or there is no endpoint discovery enabled information an InvalidOperationException is thrown. - - The ICredentialProfileSource to read the profile from. - The name of the profile. - - - - Probing mechanism to determine the endpoint discovery enabled value from various sources. - - - - - The valid hashing algorithm supported by the sdk for request signing. - - - - - Which end of a request was responsible for a service error response. - - - - - The sender was responsible for the error, i.e. the client - request failed validation or was improperly formatted. - - - - - The error occured within the service. - - - - - An unrecognized error type was returned. - - - - - Sts Regional Endpoints Value determines whether or not - to send the sts request to the regional endpoint or to - the global sts endpoint - - - - - Send the request to the global sts endpoint - if the region is a legacy global region - - - - - Send the request to the regional endpoint - - - - - S3 US East 1 endpoint value determines wheter or not - to send the us-east-1 s3 requests to the regional endpoint or to - the legacy global endpoint - - - - - Sends the requests to the legacy global s3 endpoint for us-east-1 - - - - - Sends the request to the regional s3 endpoint for us-east-1 - - - - - RetryMode determines which request retry mode is used for requests that do - not complete successfully. - - - - - Legacy request retry strategy. - - - - - Standardized request retry strategy that is consistent across all SDKs. - - - - - An experimental request retry strategy that builds on the Standard strategy - and introduces congestion control through client side rate limiting. - - - - - Superclass for Exceptions that come over the event stream, or to wrap other kinds of generic exceptions. - - - - - The numeric code identifier for the type of error. - - - - - Constructs an EventStreamError. - - - - - Constructs an EventStreamError. - - The error code. - The error message. - - - - Event args that contain an . - - The - - - - The EventStream Event. - - - - - Constructs an EventStreamEventReceivedArgs. - - The EventStream Event. - - - - Event args that contain an . - - The . - - - - The EventStream Exception. - - - - - Constructs an EventStreamExceptionReceivedArgs. - - The EventStream Exception. - - - - Supported Header types for vnd.amazon.event-stream - - - - - Name for the Header. Maximum of 255 bytes. - - - - - Header type id - - - - - Computes the amount of memory neccesary to serialize this Header. - - - - - Writes this Header to buffer starting at offset - Keep in mind, this API assumes buffer is large enough - for the operation. - - buffer to serialize this Header to - offset to begin writing at. - - the new offset. - - - - - Returns the current value as a bool - - - - - Sets the current value - - - - - Returns the current value as a byte - - - - - Sets the current value - - - - - Gets the current value as a 16 bit integer. (Host Order). - - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a 32 bit integer. (Host Order) - - - - - Sets the current value - - - - - returns the current value as a 64-bit integer. (Host Order) - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a byte buffer. - - - - - - Sets the current value. Max length is 2^15 - 1 - - - - - Returns the current value as a utf-8 string. - - - - - Sets the current value. Utf-8 encoded. Max byte size is 2^16 - 1 - - - - - Gets the current value as a DateTime. - Note: You do not need to compensate for unix epoch on this API. - - - - - - Sets the current value. - Note: You do not need to compensate for unix epoch on this API. - - - - - Returns the current value as a Guid (UUID) - - - - - Sets the current value - - - - - Header Data for an EventStreamMessage - - Each header is of format: - [name len] (1) | [utf-8 name] (v) - [type (1)] - [value (v)] - - - - - Name for the Header. Maximum of 255 bytes. - - - - - Header type id - - - - - Initializes this Header with name. - - utf-8 string, max length is 255 - - - - Deserializes the header in buffer. - - buffer constaining the header - index to start from in the buffer. - updated offset with new value for offset - - - - Writes this Header to buffer starting at offset - Keep in mind, this API assumes buffer is large enough - for the operation. - - buffer to serialize this Header to - offset to begin writing at. - - the new offset. - - - - - Computes the amount of memory neccesary to serialize this Header. - - - - - Returns the current value as a bool - - - - - Sets the current value - - - - - Returns the current value as a byte - - - - - Sets the current value - - - - - Gets the current value as a 16 bit integer. (Host Order). - - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a 32 bit integer. (Host Order) - - - - - Sets the current value - - - - - returns the current value as a 64-bit integer. (Host Order) - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a byte buffer. - - - - - - Sets the current value. Max length is 2^15 - 1 - - - - - Returns the current value as a utf-8 string. - - - - - Sets the current value. Utf-8 encoded. Max byte size is 2^16 - 1 - - - - - Gets the current value as a DateTime. - Note: You do not need to compensate for unix epoch on this API. - - - - - - Sets the current value. - Note: You do not need to compensate for unix epoch on this API. - - - - - Returns the current value as a Guid (UUID) - - - - - Sets the current value - - - - - Headers for the message. Can be null. - - - - - Payload for the message. Can be null. - - - - - Converts a message into a byte buffer (usually for network transmission). - - - - - Message is a single datagram. The format is as follows: - [ total length (4) ] | [ headers_length (4)] | [ prelude crc(4)] - [ headers (v)] - [ payload (v)} - [ trailing crc ] - - CRCs use the CRC32 algorithm. - - - - - Content type for EventStreams. - - - - - Headers for the message. Can be null. - - - - - Payload for the message. Can be null. - - - - - Initialize a message with headers and a payload. - - list of headers for the message, can be null. - payload for the message, can be null. - - - - Builds a message from buffer. - - buffer to read - offset to start reading - buffer length. - - parsed instance of EventStreamMessage. Doesn't return null, - does throw if CRCs don't match. - - - - - Converts a message into a byte buffer (usually for network transmission). - - - - - Defines exceptions that arise from an not conforming to specification. - - - - - Constructs an EventStreamValidationException. - - - - - Constructs an EventStreamValidationException. - - The exception message. - - - - Constructs an EventStreamValidationException. - - The exception message. - The inner exception. - - - - The contract for the . - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - A subclass of that enables an enumerable interface for interacting with Events. - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - Flag if the stream was chosen to be enumerated. - - - - - A Stream of Events. Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treated as mutually exclusive. - - - - - A Stream of Events. Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treated as mutually exclusive. - - - - - Returns an enumerator that iterates through the collection. - - An enumerator that can be used to iterate through the collection. - - - - Returns an enumerator that iterates through a collection. - - An object that can be used to iterate through the collection. - - - - Starts the background thread to start reading events from the network stream. - - - - - The contract for the . - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - The size of the buffer for reading from the network stream. - - - - - Fires when an event is received. - - - - - Fired when an exception or error is raised. - - - - - Starts the background thread to start reading events from the network stream. - - - - - The superclass for all EventStreams. It contains the common processing logic needed to retreive events from a network Stream. It - also contains the mechanisms needed to have a background loop raise events. - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - "Unique" key for unknown event lookup. - - - - - Header key for message type. - - - - - Header key for event type. - - - - - Header key for exception type. - - - - - Header key for error code. - - - - - Header key for error message. - - - - - Value of when the message is an event. - - - - - Value of when the message is an exception. - - - - - Value of when the message is an error. - - - - - The size of the buffer for reading from the network stream. - Default is 8192. - - - - - The underlying stream to read events from. - - - - - Responsible for decoding events from sequences of bytes. - - - - - Fires when an event is recieved. - - - - - Fired when an exception or error is raised. - - - - - The mapping of event message to a generator function to construct the matching Event Stream event. - - - - - The mapping of event message to a generator function to construct the matching Event Stream exception. - - - - - Whether the Stream is currently being processed. - - - - - A Stream of Events. Events can be retrieved from this stream by attaching handlers to listen events, and then calling StartProcessing. - - - - - A Stream of Events. Events can be retrieved from this stream by attaching handlers to listen events, and then calling StartProcessing. - - - - - Converts an EventStreamMessage to an event. - - The event stream message to be converted. - The event - - - - Abstraction for cross-framework initiation of the background thread. - - - - - The background thread main loop. It will constantly read from the network stream until IsProcessing is false, or an error occurs. - - This stub exists due to FXCop. - - - - - The background thread main loop. It will constantly read from the network stream until IsProcessing is false, or an error occurs. - - Needed for 3.5 support. Not used. - - - - Reads from the stream into the buffer. It then passes the buffer to the decoder, which raises an event for - each message it decodes. - - The buffer to store the read bytes from the stream. - - - - Wraps exceptions in an outer exception so they can be passed to event handlers. If the Exception is already of a compatable type, - the method returns what it was given. - - The exception to wrap. - An exception of type TE - - - - Starts the background thread to start reading events from the network stream. - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Disposes the resources of this stream. - - Should dispose of unmanged resources. - - - - Event Arguments for EventStreamDecoder.MessageReceived. - - - - - Received message. - - - - - Additional object context - - - - - Initialize this with message - - - - - Initialize this with message and object conetext - - - - - Exception thrown when a request is made of the Decoder, but the internal state - machine is an invalid state. This is usually the result of an interanl exception - being thrown during parsing of the network stream. - - - - - Contract for EventStreamDecoder - - - - - Invoked anytime an EventStreamMessage is found. - - - - - Processes data starting at offset up to length. - Invokes MessageRecieved for each message encountered. - If an exception is thrown, this object is not safe for reuse. - - buffer to read - offset in buffer to start reading. - length of data. - - - - Streaming decoder for listening for incoming EventStreamMessage datagrams. - - - - - Invoked anytime an EventStreamMessage is found. - - - - - Object data (optional) that can be passed to the event handler for MessageReceived. - - - - - Default constructor. Initializes internal _state machine. - - - - - Processes data starting at offset up to length. - Invokes MessageRecieved for each message encountered. - If an exception is thrown, this object is not safe for reuse. - - buffer to read - offset in buffer to start reading. - length of data. - - - - Superclass for Exceptions that come over the event stream, or to wrap other kinds of generic exceptions. - - - - - Constructs an EventStreamException. - - - - - Constructs an EventStreamException. - - The exception message. - - - - Constructs an EventStreamException. - - The exception message. - The inner exception. - - - - The contract for EventStream events. - - - - - The contract for EventStream terminal events. - - - - - This Event is returned if an event is retrieved from the event stream, but a generator function - for the event is not defined. This can occur if the SDK is not updated after a new event type is introduced. - - - - - The Message recieved from the event stream before conversion. - - - - - The event type. - - - - - Constructs an UnknownEventStreamEvent. - - - - - Constructs an UnknownEventStreamEvent. - - The Message recieved from the event stream before conversion. - The event type. - - - - Signals that an an has an unknown message type. These exceptions whould be - swallowed to allow future expansion of the EventStream specification without breaking existing clients. - - - - - Constructs an UnknownEventStreamMessageTypeException. - - - - - This exception is thrown if an exception is retrieved from the event stream and should be modeled, - but a generator function for the strongly-typed exception is not defined. - - - - - The exception type. - - - - - Constructs an EventStreamException. - - The exception type. - - - - All Amazon service interfaces like IAmazonS3 extend from this interface. This allows all the - Amazon service interfaces be identified by this base interface and helps with generic constraints. - - - - - A readonly view of the configuration for the service client. - - - - - This interface is the read only access to the ClientConfig object used when setting up service clients. Once service clients - are initiated the config object should not be changed to avoid issues with using a service client in a multi threaded environment. - - - - - Gets the RegionEndpoint property. The region constant to use that - determines the endpoint to use. If this is not set - then the client will fallback to the value of ServiceURL. - - - - - The constant used to lookup in the region hash the endpoint. - - - - - Gets and sets of the ServiceURL property. - This is an optional property if you need to set a specific service URL - instead setting the region with the RegionEndpoint property. - - - - - Gets the UseHttp property. - If this property is set to true, the client attempts - to use HTTP protocol. - By default, this property is set to false. - - - - - Gets Service Version - - - - - Gets the signatureMethod property. - - - - - Gets the SignatureVersion property. - - Note: This property exists for backward compatibility but is no longer - used by any service other than S3. - - - - - Gets the AuthenticationRegion property. - Used in AWS4 request signing, this is an optional property; - change it only if the region cannot be determined from the - service endpoint. - - - - - Gets the AuthenticationServiceName property. - Used in AWS4 request signing, this is the short-form - name of the service being called. - - - - - Gets the UserAgent property. - - - - - Gets the DisableLogging. If true logging for this client will be disabled. - - - - - Flag on whether to log metrics for service calls. - - This can be set in the application's configs, as below: - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSLogMetrics" value"true"/> - </appSettings> - </configuration> - - - - - - Gets the LogResponse property. - If this property is set to true, the service response - is read in its entirety and logged. - - - - - Gets the ReadEntireResponse. - If this property is set to true, the service response - is read in its entirety before being processed. - - - - - This flag controls if .NET HTTP infrastructure should follow redirection - responses (e.g. HTTP 307 - temporary redirect). - - - - - Gets the BufferSize property. - The BufferSize controls the buffer used to read in from input streams and write - out to the request. - - - - - Returns the flag indicating how many retry HTTP requests an SDK should - make for a single SDK operation invocation before giving up. This flag will - return 4 when the RetryMode is set to "Legacy" which is the default. For - RetryMode values of "Standard" or "Adaptive" this flag will return 2. In - addition to the values returned that are dependant on the RetryMode, the - value can be set to a specific value by using the AWS_MAX_ATTEMPTS environment - variable, max_attempts in the shared configuration file, or by setting a - value directly on this property. When using AWS_MAX_ATTEMPTS or max_attempts - the value returned from this property will be one less than the value entered - because this flag is the number of retry requests, not total requests. To - learn more about the RetryMode property that affects the values returned by - this flag, see . - - - - - Determines if MaxErrorRetry has been manually set. - - - - - Gets the interval at which progress update events are raised - for upload operations. By default, the progress update events are - raised at every 100KB of data transferred. - - - - - Flag on whether to resign requests on retry or not. - - - - - Credentials to use with a proxy. - - - - - Gets the default request timeout value. - - - - If the value is set, the value is assigned to the Timeout property of the HTTPWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - - - - Configures the endpoint calculation for a service to go to a dual stack (ipv6 enabled) endpoint - for the configured region. - - - Note: AWS services are enabling dualstack endpoints over time. It is your responsibility to check - that the service actually supports a dualstack endpoint in the configured region before enabling - this option for a service. - - - - - Configures a flag enabling to either opt in or opt out of the retry throttling service. - Note: set value to true to enable retry throttling feature. The Default value for this flag is false. - - - - - Using either the RegionEndpoint or the ServiceURL determine what the URL to the service is. - - The URL to the service. - - - - Performs validation on this config object. - Throws exception if any of the required values are missing/invalid. - - The timeout specified is null. - - - - Returns the clock skew adjusted utc now. This value is affected by AWSConfigs.ManualClockCorrection - - - - - Returns the calculated clock skew value for this config's service endpoint. If AWSConfigs.CorrectForClockSkew is false, - this value won't be used to construct service requests. - - - - - Gets the DisableHostPrefixInjection flag. If true, host prefix injection will be disabled for this client, the default value of this flag is false. - Host prefix injection prefixes the service endpoint with request members from APIs which use this feature. - Example: for a hostPrefix of "foo-name." and a endpoint of "service.region.amazonaws.com" the default behavior is to - prefix the endpoint with the hostPrefix resulting in a final endpoint of "foo-name.service.region.amazonaws.com". Setting - DisableHostPrefixInjection to true will disable hostPrefix injection resulting in a final endpoint of - "service.region.amazonaws.com" regardless of the value of hostPrefix. E.g. You may want to disable host prefix injection for testing against a local mock endpoint. - - - - - Returns the flag indicating if endpoint discovery should be enabled or disabled for operations that are not required to use endpoint discovery. - - - - - Returns the maximum number of discovered endpoints that can be stored within the cache for the client. The default limit is 1000 cache entries. - - - - - Returns the flag indicating the current mode in use for request - retries and influences the value returned from . - The default value is RequestRetryMode.Legacy. This flag can be configured - by using the AWS_RETRY_MODE environment variable, retry_mode in the - shared configuration file, or by setting this value directly. - - - - - Under Adaptive retry mode, this flag determines if the client should wait for - a send token to become available or don't block and fail the request immediately - if a send token is not available. - - - - - Get the value to use for on requests. - If this property is null, - will be left at its default value of . - - - - - - This is a switch used for performance testing and is not intended for production applications - to change. This switch may be removed in a future version of the SDK as the .NET Core platform matures. - - - If true, the HttpClient is cached and reused for every request made by the service client - and shared with other service clients. - - - For the .NET Core platform this is default to true because the HttpClient manages the connection - pool. - - - - - - If CacheHttpClient is set to true then HttpClientCacheSize controls the number of HttpClients cached. - - - - - Gets the ProxyHost property. - - - - - Gets the ProxyPort property. - - - - - Returns a WebProxy instance configured to match the proxy settings - in the client configuration. - - - - - - Interface for a single logged message. - - - - - Log message format. - - - - - Log message arguments. - - - - - Culture-specific formatting provider. - - - - - Abstract parameter value. - - - - - String parameter value. - - - - - String value of the parameter. - - - - - Constructs ParameterValue for a single string. - - - - - - String list parameter value. - - - - - List of strings value of the parameter. - - - - - Constructs ParameterValue for a list of strings. - - - - - - The interface for an exception handler. - - - - - Handles an exception for the given execution context. - - The execution context, it contains the - request and response context. - The exception to handle. - - Returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception to replace the original exception. - - - - - The interface for an exception handler with a generic parameter for the exception type. - - The exception type. - - - - Handles an exception for the given execution context. - - The execution context, it contains the - request and response context. - The exception to handle. - - Returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception to replace the original exception. - - - - - The interface for a HTTP request factory. - - The type used by the underlying HTTP API to represent the request body. - - - - Creates an HTTP request for the given URI. - - The request URI. - An HTTP request. - - - - The interface for an HTTP request that is agnostic of the underlying HTTP API. - - The type used by the underlying HTTP API to represent the HTTP request content. - - - - The HTTP method or verb. - - - - - The request URI. - - - - - Configures a request as per the request context. - - The request context. - - - - Sets the headers on the request. - - A dictionary of header names and values. - - - - Gets a handle to the request content. - - The request content. - - - - Returns the HTTP response. - - The HTTP response. - - - - Writes a stream to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - The request context. - - - - Writes a byte array to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - - - - Sets up the progress listeners - - The content stream - The interval at which progress needs to be published - The objects which is trigerring the progress changes - The callback which will be invoked when the progress changed event is trigerred - an object, incase the progress is setup, else returns the original stream - - - - Aborts the HTTP request. - - - - - Gets a handle to the request content. - - - - - - Returns the HTTP response. - - A cancellation token that can be used to cancel the asynchronous operation. - - - - - A factory which creates HTTP clients. - - - - - Create and configure an HttpClient. - - - - - - If true the SDK will internally cache the clients created by CreateHttpClient. - If false the sdk will not cache the clients. - Override this method to return false if your HttpClientFactory will handle its own caching - or if you don't want clients to be cached. - - - - - - - Determines if the SDK will dispose clients after they're used. - If HttpClients are cached, either by the SDK or by your HttpClientFactory, this should be false. - If there is no caching then this should be true. - - - - - - - Returns a string that's used to group equivalent HttpClients into caches. - This method isn't used unless UseSDKHttpClientCaching returns true; - - A null return value signals the SDK caching mechanism to cache HttpClients per SDK client. - So when the SDK client is disposed, the HttpClients are as well. - - A non-null return value signals the SDK that HttpClients created with the given clientConfig - should be cached and reused globally. ClientConfigs that produce the same result for - GetConfigUniqueString will be grouped together and considered equivalent for caching purposes. - - - - - - - A factory which creates HTTP requests which uses System.Net.Http.HttpClient. - - - - - The constructor for HttpRequestMessageFactory. - - Configuration setting for a client. - - - - Creates an HTTP request for the given URI. - - The request URI. - An HTTP request. - - - - Disposes the HttpRequestMessageFactory. - - - - - Dispose the factory - - - - - - Create and configure a managed HttpClient instance. - The use of HttpClientHandler in the constructor for HttpClient implicitly creates a managed HttpClient. - If a native HttpClient is required the SDK user must implement IHttpClientFactory and provide an - instance via IClientConfig.HttpClientFactory (only available in PCL). - - - - - - - A cache of HttpClient objects. The GetNextClient method does a round robin cycle through the clients - to distribute the load even across. - - - - - Constructs a container for a cache of HttpClient objects - - The HttpClient to cache - - - - Returns the next HttpClient using a round robin rotation. It is expected that individual clients will be used - by more then one Thread. - - - - - - Disposes the HttpClientCache. - - - - - Dispose the HttpClientCache - - - - - - HTTP request wrapper for System.Net.Http.HttpRequestMessage. - - - - - Set of content header names. - - - - - The constructor for HttpWebRequestMessage. - - The HttpClient used to make the request. - The request URI. - The service client config. - - - - The underlying HttpClient - - - - - The underlying HTTP web request. - - - - - The HTTP method or verb. - - - - - The request URI. - - - - - Configures a request as per the request context. - - The request context. - - - - Sets the headers on the request. - - A dictionary of header names and values. - - - - Gets a handle to the request content. - - The request content. - - - - Returns the HTTP response. - - The HTTP response. - - - - Aborts the HTTP request. - - - - - Returns the HTTP response. - - A cancellation token that can be used to cancel the asynchronous operation. - - - - - Writes a stream to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - The request context. - - - - Writes a byte array to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - - - - Gets a handle to the request content. - - - - - - Disposes the HttpWebRequestMessage. - - - - - - - - - - - Sets up the progress listeners - - The content stream - The interval at which progress needs to be published - The objects which is trigerring the progress changes - The callback which will be invoked when the progress changed event is trigerred - an object, incase the progress is setup, else returns the original stream - - - - Interface for a handler in a pipeline. - - - - - The logger used to log messages. - - - - - The inner handler which is called after the current - handler completes it's processing. - - - - - The outer handler which encapsulates the current handler. - - - - - Contains the processing logic for a synchronous request invocation. - This method should call InnerHandler.InvokeSync to continue processing of the - request by the pipeline, unless it's a terminating handler. - - The execution context which contains both the - requests and response context. - - - - Contains the processing logic for an asynchronous request invocation. - This method should call InnerHandler.InvokeSync to continue processing of the - request by the pipeline, unless it's a terminating handler. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - A retry policy specifies all aspects of retry behavior. This includes conditions when the request should be retried, - checks of retry limit, preparing the request before retry and introducing delay (backoff) before retries. - - - A retry policy specifies all aspects of retry behavior. This includes conditions when the request should be retried, - checks of retry limit, preparing the request before retry and introducing delay (backoff) before retries. - - - - - Maximum number of retries to be performed. - This does not count the initial request. - - - - - The logger used to log messages. - - - - - The standard set of throttling error codes - - - - - The standard set of timeout error codes to retry on. - - - - - List of AWS specific error codes which are returned as part of the error response. - These error codes will be retried. - - - - - The standard set of transient error, HTTP status codes to retry on. - 502 and 504 are returned by proxies. These can also be returned for - S3 accelerate requests which are served by CloudFront. - - - - - Set of web exception status codes to retry on. - - - - - This parameter serves as the value to the CapacityManager.Container datastructure. - Its properties include the available capacity left for making a retry request and the maximum - capacity size. - - - - - Checks if a retry should be performed with the given execution context and exception. - - The execution context which contains both the - requests and response context. - The exception thrown after issuing the request. - Returns true if the request should be retried, else false. The exception is retried if it matches with clockskew error codes. - - - - Returns true if the request is in a state where it can be retried, else false. - - The execution context which contains both the - requests and response context. - Returns true if the request is in a state where it can be retried, else false. - - - - Return true if the request should be retried for the given exception. - - The execution context which contains both the - requests and response context. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Checks if the retry limit is reached. - - The execution context which contains both the - requests and response context. - Return false if the request can be retried, based on number of retries. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called on a successful request response. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called before a retry request is initiated. The value - returned is True by default(retry throttling feature is disabled). - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called before a retry request is initiated. The value - returned is True by default(retry throttling feature is disabled). - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - - - - Virtual method that gets called before a retry request is initiated. The value - returned is True by default(retry throttling feature is disabled). - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - true if the error that will be retried is a throttling error - - - - This method uses a token bucket to enforce the maximum sending rate. - - The execution context which contains both the - requests and response context. - If the prior request failed, this exception is expected to be - the exception that occurred during the prior request failure. - - - - Determines if an AmazonServiceException is a throttling error - - The current exception to check. - true if it is a throttling error else false. - - - - Determines if an AmazonServiceException is a transient error that - should be retried. - - The current execution context - The current exception to check. - true if the exception is a transient error else false. - - - - Determines if the exception is a known timeout error code that - should be retried under the timeout error category. - - The current exception to check. - true if the exception is considered a timeout else false - - - - Checks if a retry should be performed with the given execution context and exception. - - The execution context which contains both the - requests and response context. - The exception throw after issuing the request. - Returns true if the request should be retried, else false. The exception is retried if it matches with clockskew error codes. - - - - This method uses a token bucket to enforce the maximum sending rate. - - The execution context which contains both the - requests and response context. - If the prior request failed, this exception is expected to be - the exception that occurred during the prior request failure. - - - - Return true if the request should be retried for the given exception. - - The execution context which contains both the - requests and response context. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - Metrics collected by the SDK on a per-request basis. - - - Each request made to an AWS service by the SDK can have metrics - collected and logged. This interface represents the collected - metrics for a request. The metrics include properties (i.e. request id - and other metadata), timings for each stage of the request, and counters. - - - - - Collection of properties being tracked - - - - - Timings for metrics being tracked - - - - - Counters being tracked - - - - - Whether metrics are enabled for the request - - - - - JSON representation of the current metrics - - JSON string - - - - Represents how long a phase of an SDK request took. - - - - - Whether the timing has been stopped - - - - - Elapsed ticks from start to stop. - If timing hasn't been stopped yet, returns 0. - - - - - Elapsed time from start to stop. - If timing hasn't been stopped yet, returns TimeSpan.Zero - - - - - User supplied type to perform metrics formatting. - - - - - Produce custom formatting for SDK metrics. - - - If defined, this method will be called for every request made by the SDK. - - An instance of IRequestMetrics produced by the SDK - formatted string representation of the metrics - - - - Predefined request metrics that are collected by the SDK. - - - - - Information about the request. - - - - - Gets and sets the RequestId property. - ID that uniquely identifies a request. Amazon keeps track of request IDs. If you have a question about a request, include the request ID in your correspondence. - - - - - ICoreAmazonKMS is not meant to be used directly. It defines Key Management Service - with basic .NET types and allows other services to be able to use the service as - a runtime dependency. This interface is implemented by the AmazonKeyManagementServiceClient - defined in the AWSSDK.KeyManagementService assembly. - - - - - The result of the GenerateDataKey and GenerateDataKeyAsync operations. - - - - - The plaintext for the data key. - - - - - The ciphertext for the data key. - - - - - ICoreAmazonS3 is not meant to use directly. It defines S3 with basic .NET types - and allows other services to be able to use S3 as a runtime dependency. This interface - is implemented by the AmazonS3Client defined in the S3 assembly. - - - ICoreAmazonS3 is not meant to use directly. It defines S3 with basic .NET types - and allows other services to be able to use S3 as a runtime dependency. This interface - is implemented by the AmazonS3Client defined in the S3 assembly. - - - - - Generate a presigned URL. - - - - - - - - - - Get all the object keys for the particular bucket and key prefix. - - - - - - - - - Upload an object from a stream. - - - - - - - - - - - Delete an object. - - - - - - - - - - Delete an object. - - - - - - - - - - Open a stream to an object in S3. - - - - - - - - - - Upload an object from a file path. - - - - - - - - - - - Download an object in S3 to a file path. - - - - - - - - - - - Set the ACL on the object to public readable. - - - - - - - - Check to see if the bucket exists and if it doesn't create the bucket. - - - - - - Check to see if the bucket exists. - - - - - - - ICoreAmazonSQS is not meant to use directly. It defines SQS with basic .NET types - and allows other services to be able to use SQS as a runtime dependency. This interface - is implemented by the AmazonSQSClient defined in the SQS assembly. - - - - - Get the attributes for the queue identified by the queue URL asynchronously. - - The queue URL to get attributes for. - A Task containing the result of a dictionary of attributes for the queue. - - - - Set the attributes on the queue identified by the queue URL asynchronously. - - The queue URL to set the attributues. - The attributes to set. - A Task - - - - ICoreAmazonSTS is not meant to be used directly. It defines Security Token - service with basic .NET types and allows other services to be able to use the service as - a runtime dependency. This interface is implemented by the AmazonSecurityTokenServiceClient - defined in the AWSSDK.SecurityToken assembly. - - - - - - This method is used internally to access the Amazon Security Token - service within other service assemblies. - Please use AmazonSecurityTokenServiceClient to access the Amazon Security Token - service instead. - - Use Amazon Security Token Service to assume a role. - - Proxy settings that are required for the HTTPS and STS calls made during the authentication/credential - generation process are supported and should have been configured on the STS ClientConfig instance - associated with the STS client instance exposing this interface. - - - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRole. - - - - - ICoreAmazonSTS_SAML is not meant to be used directly. It defines Security Token - service with basic .NET types and allows other services to be able to use the service as - a runtime dependency. This interface is implemented by the AmazonSecurityTokenServiceClient - defined in the AWSSDK.SecurityToken assembly. - - - - - - This method is used internally to access the Amazon Security Token - service within other service assemblies. - Please use AmazonSecurityTokenServiceClient to access the Amazon Security Token - service instead. - - Authenticates against a federated identity endpoint supporting SAML and returns - temporary AWS credentials for the supplied role. - - The endpoint for the federated identity provider - The authentication type to use (NTLM, Kerberos etc) - The ARN of the role the user is to assume following authentication - TTL duration for the generated credentials. - - Optional; alternate user credential for authentication. If null the identity of the - current process is used. - - Generated credential data, including SAML-related information such as subject. - - Proxy settings that are required for the HTTPS and STS calls made during the authentication/credential - generation process are supported and should have been configured on the STS ClientConfig instance - associated with the STS client instance exposing this interface. - - - - - - This method is used internally to access the Amazon Security Token - service within other service assemblies. - Please use AmazonSecurityTokenServiceClient to access the Amazon Security Token - service instead. - - Use Amazon Security Token Service to assume a role. - - Proxy settings that are required for the HTTPS and STS calls made during the authentication/credential - generation process are supported and should have been configured on the STS ClientConfig instance - associated with the STS client instance exposing this interface. - - - The web identity token used to assume the role. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRoleWithWebIdentity - - - - - - This method is used internally to access the Amazon Security Token - service within other service assemblies. - Please use AmazonSecurityTokenServiceClient to access the Amazon Security Token - service instead. - - Use Amazon Security Token Service to assume a role. - - Proxy settings that are required for the HTTPS and STS calls made during the authentication/credential - generation process are supported and should have been configured on the STS ClientConfig instance - associated with the STS client instance exposing this interface. - - - The web identity token used to assume the role. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRoleWithWebIdentity - - - - - CoreAmazonKMS is not meant to use directly. It implements ICoreAmazonKMS - and allows other service clients to be able to use the KMS service as a runtime dependency. - - This class waits until a method is actually called on the ICoreAmazonKMS interface - before requiring the KMS assembly to be present and loaded. - - - - - This exception is thrown if there are problems signing the request. - - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - - - - Gets the percentage of transfer completed - - - - - Gets the number of bytes transferred since last event - - - - - Gets the number of bytes transferred - - - - - Gets the total number of bytes to be transferred - - - - - Returns a string representation of this object - - - - - - Class that posts the CSM event to a UDP portconfig - This is a singleton class and is created once - per AmazonServiceClient. - - - - - The CSMevents are always posted to the localhost - - - - - Method to post UDP datagram for sync calls - - - - - Method to post UDP datagram for async calls - - - - - Method to post UDP datagram for bcl35 async calls - - - - - Settings for configuring a proxy for the SDK to use. - - - - - The host name or IP address of the proxy server. - - - - - The port number of the proxy. - - - - - The username to authenticate with the proxy server. - - - - - The password to authenticate with the proxy server. - - - - - Collection of one or more regular expressions denoting addresses - for which the proxy will not be used. - - - For more information on bypass lists - see https://msdn.microsoft.com/en-us/library/system.net.webproxy.bypasslist%28v=vs.110%29.aspx. - - - - - If true requests to local addresses bypass the configured - proxy. - - - - - Settings for logging in the SDK. - - - - - Logging destination. - - - - - When to log responses. - - - - - Gets or sets the size limit in bytes for logged responses. - If logging for response body is enabled, logged response - body is limited to this size. The default limit is 1KB. - - - - - Whether or not to log SDK metrics. - - - - - A custom formatter added through Configuration - - - - - This class can be used to discover the public address ranges for AWS. The - information is retrieved from the publicly accessible - https://ip-ranges.amazonaws.com/ip-ranges.json file. - - - The information in this file is generated from our internal system-of-record and - is authoritative. You can expect it to change several times per week and should - poll accordingly. - - - - - Region identifier string for ROUTE53 and CLOUDFRONT ranges - - - - - Collection of service keys found in the data file. - - - - - The publication date and time of the file that was downloaded and parsed. - - - - - Collection of all public IP ranges. - - - - - Filtered collection of public IP ranges for the given service key - - - - - Filtered collection of public IP ranges for the given region (us-east-1 etc) or GLOBAL. - - - - - Filtered collection of public IP ranges for the given network border group. - - - - - Downloads the most recent copy of the endpoint address file and - parses it to a collection of address range objects. - - - - - Downloads the most recent copy of the endpoint address file and - parses it to a collection of address range objects. - - - - - Represents the IP address range for a single region and service key. - - - - - The public IPv4 or Ipv6 address range, in CIDR notation. - - - - - Indicates ipv4 or v6 format of the address - - - - - The AWS region or GLOBAL for edge locations. Note that the CLOUDFRONT and ROUTE53 - ranges are GLOBAL. - - - - - The subset of IP address ranges. Specify AMAZON to get all IP address ranges - (for example, the ranges in the EC2 subset are also in the AMAZON subset). Note - that some IP address ranges are only in the AMAZON subset. - - - Valid values for the service key include "AMAZON", "EC2", "ROUTE53", - "ROUTE53_HEALTHCHECKS", and "CLOUDFRONT." If you need to know all of - the ranges and don't care about the service, use the "AMAZON" entries. - The other entries are subsets of this one. Also, some of the services, - such as S3, are represented in "AMAZON" and do not have an entry that - is specific to the service. We plan to add additional values over time; - code accordingly! - - - - - The network border group the IP address range belongs to. - - - AWS Local Zones allow you to seamlessly connect to the full range of services in the AWS Region such - as Amazon Simple Storage Service and Amazon DynamoDB through the same APIs and tool sets. You can extend - your VPC Region by creating a new subnet that has a Local Zone assignment. When you create a subnet in - a Local Zone, the VPC is also extended to that Local Zone. - - A network border group is a unique set of Availability Zones or Local Zones from where AWS advertises - public IP addresses. - - When you create a VPC that has IPv6 addresses, you can choose to assign a set of Amazon-provided public - IP addresses to the VPC and also set a network border group for the addresses that limits the addresses - to the group. When you set a network border group, the IP addresses cannot move between network - border groups. The us-west-2 network border group contains the four US West (Oregon) Availability Zones. - The us-west-2-lax-1 network border group contains the Los Angeles Local Zones. - - - - - This class defines utilities and constants that can be used by - all the client libraries of the SDK. - - - - - The user agent string header - - - - - The Set of accepted and valid Url characters per RFC3986. - Characters outside of this set will be encoded. - - - - - The Set of accepted and valid Url characters per RFC1738. - Characters outside of this set will be encoded. - - - - - The set of accepted and valid Url path characters per RFC3986. - - - - - The string representing Url Encoded Content in HTTP requests - - - - - The GMT Date Format string. Used when parsing date objects - - - - - The ISO8601Date Format string. Used when parsing date objects - - - - - The ISO8601Date Format string. Used when parsing date objects - - - - - The ISO8601 Basic date/time format string. Used when parsing date objects - - - - - The ISO8601 basic date format. Used during AWS4 signature computation. - - - - - The RFC822Date Format string. Used when parsing date objects - - - - - Returns an extension of a path. - This has the same behavior as System.IO.Path.GetExtension, but does not - check the path for invalid characters. - - - - - - Convert request parameters to Url encoded query string - - - Convert Dictionary of parameters to Url encoded query string - - - - Returns the canonicalized resource path for the service endpoint with single URL encoded path segments. - - Endpoint URL for the request - Resource path for the request - - If resourcePath begins or ends with slash, the resulting canonicalized - path will follow suit. - - Canonicalized resource path for the endpoint - - - - Returns the canonicalized resource path for the service endpoint - - Endpoint URL for the request - Resource path for the request - If true pre URL encode path segments if necessary. - S3 is currently the only service that does not expect pre URL encoded segments. - - If resourcePath begins or ends with slash, the resulting canonicalized - path will follow suit. - - Canonicalized resource path for the endpoint - - - - Returns the canonicalized resource path for the service endpoint - - Endpoint URL for the request - Resource path for the request - If true pre URL encode path segments if necessary. - S3 is currently the only service that does not expect pre URL encoded segments. - Dictionary of key/value parameters containing the values for the ResourcePath key replacements - The version of the marshaller that constructed the request object. - - If resourcePath begins or ends with slash, the resulting canonicalized - path will follow suit. - - Canonicalized resource path for the endpoint - - - - Splits the resourcePath at / into segments then resolves any keys with the path resource values. Greedy - key values will be split into multiple segments at each /. - - The patterned resourcePath - The key/value lookup for the patterned resourcePath - A list of path segments where all keys in the resourcePath have been resolved to one or more path segment values - - - - Joins all path segments with the / character and encodes each segment before joining. - - The segments of a URL path split at each / character - If the path property is specified, - the accepted path characters {/+:} are not encoded. - A joined URL with encoded segments - - - - Takes a patterned resource path and resolves it using the key/value path resources into - a segmented encoded URL. - - The patterned resourcePath - The key/value lookup for the patterned resourcePath - A segmented encoded URL - - - - Returns a new string created by joining each of the strings in the - specified list together, with a comma between them. - - The list of strings to join into a single, comma delimited - string list. - A new string created by joining each of the strings in the - specified list together, with a comma between strings. - - - - Attempt to infer the region for a service request based on the endpoint - - Endpoint to the service to be called - - Region parsed from the endpoint; DefaultRegion (or DefaultGovRegion) - if it cannot be determined/is not explicit - - - - - Attempt to infer the service name for a request (in short form, eg 'iam') from the - service endpoint. - - Endpoint to the service to be called - - Short-form name of the service parsed from the endpoint; empty string if it cannot - be determined - - - - - Utility method for converting Unix epoch seconds to DateTime structure. - - The number of seconds since January 1, 1970. - Converted DateTime structure - - - - Helper function to format a byte array into string - - The data blob to process - If true, returns hex digits in lower case form - String version of the data - - - - Calls a specific EventHandler in a background thread - - - - - - - - Parses a query string of a URL and returns the parameters as a string-to-string dictionary. - - - - - - - Utility method for converting a string to a MemoryStream. - - - - - - - Utility method for copy the contents of the source stream to the destination stream. - - - - - - - Utility method for copy the contents of the source stream to the destination stream. - - - - - - - - Formats the current date as a GMT timestamp - - A GMT formatted string representation - of the current date and time - - - - - Formats the current date as ISO 8601 timestamp - - An ISO 8601 formatted string representation - of the current date and time - - - - - Gets the ISO8601 formatted timestamp that is minutesFromNow - in the future. - - The number of minutes from the current instant - for which the timestamp is needed. - The ISO8601 formatted future timestamp. - - - - Formats the current date as ISO 8601 timestamp - - An ISO 8601 formatted string representation - of the current date and time - - - - - Gets the RFC822 formatted timestamp that is minutesFromNow - in the future. - - The number of minutes from the current instant - for which the timestamp is needed. - The ISO8601 formatted future timestamp. - - - - Determines whether the given string is an absolute path to a root. - - The hypothetical absolute path. - True if is an absolute path. - - - - Returns true if the path specified is relative to the current drive or working directory. - Returns false if the path is fixed to a specific drive or UNC path. This method does no - validation of the path (URIs will be returned as relative as a result). - - - Handles paths that use the alternate directory separator. It is a frequent mistake to - assume that rooted paths (Path.IsPathRooted) are not relative. This isn't the case. - "C:a" is drive relative- meaning that it will be resolved against the current directory - for C: (rooted, but relative). "C:\a" is rooted and not relative (the current directory - will not be used to modify the path). - - - - - True if the given character is a directory separator. - - - - - Returns true if the given character is a valid drive letter - - - - - URL encodes a string per RFC3986. If the path property is specified, - the accepted path characters {/+:} are not encoded. - - The string to encode - Whether the string is a URL path or not - The encoded string - - - - URL encodes a string per the specified RFC. If the path property is specified, - the accepted path characters {/+:} are not encoded. - - RFC number determing safe characters - The string to encode - Whether the string is a URL path or not - The encoded string - - Currently recognised RFC versions are 1738 (Dec '94) and 3986 (Jan '05). - If the specified RFC is not recognised, 3986 is used by default. - - - - - URL encodes a string per the specified RFC with the exception of preserving the encoding of previously encoded slashes. - If the path property is specified, the accepted path characters {/+:} are not encoded. - - The string to encode - Whether the string is a URL path or not - The encoded string with any previously encoded %2F preserved - - - - Convert bytes to a hex string - - Bytes to convert. - Hexadecimal string representing the byte array. - - - - Convert a hex string to bytes - - Hexadecimal string - Byte array corresponding to the hex string. - - - - Returns DateTime.UtcNow + ManualClockCorrection when - is set. - This value should be used instead of DateTime.UtcNow to factor in manual clock correction - - - - - Returns true if the string has any bidirectional control characters. - - - - - - - Executes an HTTP request and returns the response as a string. This method - throws WebException and HttpRequestException. In the event HttpRequestException - is thrown the StatusCode is sent as user defined data on the exception under - the key "StatusCode". - - The URI to make the request to - The request type: GET, PUT, POST - null or the content to send with the request - Timeout for the request - Proxy for the request - null or any headers to send with the request - The response as a string. - - - - Utility method that accepts a string and replaces white spaces with a space. - - - - - - - Runs a process with the below input parameters. - - - - - - - This method allows to check whether a property of an object returned by a service call - is set. This method is needed to discriminate whether a field is not set (not present in - the service response) or if it is set to the default value for its type. Using this - method is not required for nullable properties (non-ValueType and Nullable) because - they will be simply set to null when not included in the service response. - This method can also be used on objects used as part of service requests. - This method doesn't support objects that are part of the S3 service model. - - An object that is used in an AWS service request or is - returned as part of an AWS service response. - The name of the property of awsServiceObject to check. - True if the property is set, otherwise false. - - - - This method is used preserve the stacktrace used from clients that support async calls. This - make sure that exceptions thrown during EndXXX methods has the orignal stacktrace that happen - in the background thread. - - - - - - Root AWS config - - - - - Wrapper class which invokes the static method - public static string GetEnvironmentVariable(string variable) - underneath. This class is added as a property on the singleton class - EnvironmentVariableSource. This change was done for testability. - - - - - Singleton class that holds the property of type IEnvironmentVariableRetreiver. - This property can hold an instance of type EnvironmentVariableRetreiver which has a wrapper - method for - public static string GetEnvironmentVariable(string variable) - or can be mocked for testing purposes. - - - - - Interface for EnvironmentVariableRetriever. - This serves as a property for the singleton EnvironmentVariableSource - - - - - Manager to access a settings store file. Objects are primarily accessed by DisplayName rather than unique key. - Settings store files are located under the current user's AppData\Local\AWSToolkit folder. - Select keys in these files are encrypted on a per user, per machine basis using the Windows Data Protection API; - the encrypted values cannot be used by any other user or on any other machine. - - This class is not threadsafe. - - - - - True if the encrypted store is availble, false otherwise. - - - - - Construct an NamedSettingsManager. - - The base filename to read/write. - - - - Register an object. Let the uniqueKey be assigned automatically. - - The display name for the object. - The property names and values for the object. - The unique key that was assigned to the object. - - - - Try to get an object form the store. - - The display name for the object. - The property names and values for the object. - True if the object was found, false otherwise. - - - - Try to get an object form the store. - - The display name for the object. - The uniqueKey of the object in the store - The property names and values for the object. - True if the object was found, false otherwise. - - - - Unregister an object from the store. - - The display name for the object. - - - - Rename an object in the store. - - - - if true and destination object already exists overwrite it - - - - Copy an object in the store. - The new object will be a copy of the original, except it will be assigned a new unique key. - - - - if true and destination object already exists overwrite it - - - - Get a list of the display names for the objects in the store. - - A list of display names. - - - - Manager to access a settings store file. - Settings store files are located under the current user's AppData\Local\AWSToolkit folder. - Select keys in these files are encrypted on a per user, per machine basis using the Windows Data Protection API; - the encrypted values cannot be used by any other user or on any other machine. - - This class is not threadsafe. - - - - - True if the encrypted store is availble, false otherwise. - - - - - Construct a SettingsManager. - - The base filename to read/write. - - - - The base filename to read/write. - - - - - Register an object. Let the uniqueKey be assigned automatically. - - The property names and values for the object. - The unique key that was assigned to the object. - - - - Register an object. - - The uniqueKey for the object, or null if one should be assigned automatically. - The property names and values for the object. - The unique key that was assigned to the object. - - - - Try to get an object form the store. - - The uniqueKey of the object in the store - The property names and values for the object. - True if the object was found, false otherwise. - - - - Try to get an object form the store based on the value of a specific property. - If multiple objects with the same property value exist, return the first one. - - The name of the property to search on. - The value of the property to search on. - The unique key of the object. - The properties of the object. - - - - - Get a list of the unique keys of all the objects in the store. - - - - - - Get the value of a specific property for each object in the store. - - - - - - - Unregister an object from the store. - - The unique key for the object. - - - - Class that contains result of executing an external process through the SDKs - AWSSDKUtils.RunProcess/AWSSDKUtils.RunProcessAsync - - - - - The exit code with which the process exited - - - - - The output of the process read till the end - - - - - The error output of the process read till the end - - - - - Object to track circular references in nested types. - At each level of nesting, make a call to Track to retrieve Tracker, - a tracking object implementing the IDisposable interface. - Dispose of this tracker when leaving the context of the tracked object. - - - - - Tracker. Must be disposed. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Adds the current target to a reference list and returns a tracker. - The tracker removes the target from the reference list when the - tracker is disposed. - - - - - - - Provides access to EC2 instance metadata when running on an EC2 instance. - If this class is used on a non-EC2 instance, the properties in this class - will return null. - - - - Amazon EC2 instances can access instance-specific metadata, as well as data supplied when launching the instances, using a specific URI. - - - You can use this data to build more generic AMIs that can be modified by configuration files supplied at launch time. - For example, if you run web servers for various small businesses, they can all use the same AMI and retrieve their content from the - Amazon S3 bucket you specify at launch. To add a new customer at any time, simply create a bucket for the customer, add their content, - and launch your AMI. - - - More information about EC2 Metadata - - - - - - - - - - Allows to configure the proxy used for HTTP requests. The default value is null. - - - - - The AMI ID used to launch the instance. - - - - - The index of this instance in the reservation. - - - - - The manifest path of the AMI with which the instance was launched. - - - - - The AMI IDs of any instances that were rebundled to create this AMI. - Will only exist if the AMI manifest file contained an ancestor-amis key. - - - - - The private hostname of the instance. - In cases where multiple network interfaces are present, - this refers to the eth0 device (the device for which the device number is 0). - - - - - Notifies the instance that it should reboot in preparation for bundling. - Valid values: none | shutdown | bundle-pending. - - - - - The ID of this instance. - - - - - The type of instance. - - - - - The ID of the kernel launched with this instance, if applicable. - - - - - The local hostname of the instance. In cases where multiple network interfaces are present, - this refers to the eth0 device (the device for which device-number is 0). - - - - - The instance's MAC address. In cases where multiple network interfaces are present, - this refers to the eth0 device (the device for which device-number is 0). - - - - - The private IP address of the instance. In cases where multiple network interfaces are present, - this refers to the eth0 device (the device for which device-number is 0). - - - - - The Availability Zone in which the instance launched. - - - - - Product codes associated with the instance, if any. - - - - - Public key. Only available if supplied at instance launch time. - - - - - The ID of the RAM disk specified at launch time, if applicable. - - - - - The region in which the instance is running, extracted from the identity - document data. - - - - - ID of the reservation. - - - - - The names of the security groups applied to the instance. - - - - - Returns information about the last time the instance profile was updated, - including the instance's LastUpdated date, InstanceProfileArn, and InstanceProfileId. - - - - - Returns the temporary security credentials (AccessKeyId, SecretAccessKey, SessionToken, and Expiration) - associated with the IAM roles on the instance. - - - - - The virtual devices associated with the ami, root, ebs, and swap. - - - - - The network interfaces on the instance. - - - - - The metadata sent to the instance. - - - - - Value showing whether the customer has enabled detailed - one-minute monitoring in CloudWatch. - - - - - JSON containing instance attributes, such as instance-id, private IP - address, etc - - - - - Data that can be used by other parties to verify its origin and authenticity. - - - - - Used to verify the document's authenticity and content against the signature. - - - - - Return the list of items in the metadata at path. - - Path at which to query the metadata; may be relative or absolute. - List of items returned by the metadata service - - - - Return the metadata at the path - - Path at which to query the metadata; may be relative or absolute. - Data returned by the metadata service - - - - Return the metadata at the path - - Path at which to query the metadata; may be relative or absolute. - Number of attempts to make - Data returned by the metadata service - - - - Return the list of items in the metadata at path. - - Path at which to query the metadata; may be relative or absolute. - Number of attempts to make - List of items returned by the metadata service - - - - Fetches the api token to use with metadata requests. - - The API token or null - - - - Fetches the api token to use with metadata requests. - - The number of tries to fetch the api token before giving up and throwing the web exception - The API token or null if an API token couldn't be obtained and doesn't need to be used - - - - Exponentially sleeps based on the current retry value. A lower - value will sleep shorter than a larger value - - Base 0 retry index - - - - Returns information about the last time the instance profile was updated, - including the instance's LastUpdated date, InstanceProfileArn, and InstanceProfileId. - - - - - The status of the instance profile - - - - - Further information about the status of the instance profile - - - - - The date and time the instance profile was updated - - - - - The Amazon Resource Name (ARN) of the instance profile - - - - - The Id of the instance profile - - - - - The temporary security credentials (AccessKeyId, SecretAccessKey, SessionToken, and Expiration) associated with the IAM role. - - - - - The status of the security credential - - - - - Further information about the status of the instance profile - - - - - The date and time the security credential was last updated - - - - - The type of the security credential - - - - - The uniqe id of the security credential - - - - - The secret key used to sign requests - - - - - The security token - - - - - The date and time when these credentials expire - - - - - All of the metadata associated with a network interface on the instance. - - - - - Construct an instance of NetworkInterface - - - - - - The interface's Media Access Control (mac) address. - - - - - The ID of the owner of the network interface. - - - In multiple-interface environments, an interface can be attached by a third party, such as Elastic Load Balancing. - Traffic on an interface is always billed to the interface owner. - - - - - The interface's profile - - - - - The interface's local hostname. - - - - - The private IP addresses associated with the interface. - - - - - The interface's public hostname. - - - - - The elastic IP addresses associated with the interface. - - - There may be multiple IP addresses on an instance. - - - - - Security groups to which the network interface belongs. - - - - - IDs of the security groups to which the network interface belongs. Returned only for Amazon EC2 instances launched into a VPC. - - - - - The ID of the Amazon EC2-VPC subnet in which the interface resides. - - - Returned only for Amazon EC2 instances launched into a VPC. - - - - - The CIDR block of the Amazon EC2-VPC subnet in which the interface resides. - - - Returned only for Amazon EC2 instances launched into a VPC. - - - - - The CIDR block of the Amazon EC2-VPC subnet in which the interface resides. - - - Returned only for Amazon EC2 instances launched into a VPC. - - - - - Get the private IPv4 address(es) that are associated with the public-ip address and assigned to that interface. - - The public IP address - Private IPv4 address(es) associated with the public IP address - - - - This class allows profiles supporting AWS credentials and SAML-based authentication to be registered with - the SDK so that they can later be reference by a profile name. The credential profiles will be available - for use in the AWS Toolkit for Visual Studio and the AWS Tools for Windows PowerShell. - - The credentials are stored under the current users AppData folder encrypted using Windows Data Protection API. - - - To reference a profile from an application's App.config or Web.config use the AWSProfileName setting. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="development"/> - </appSettings> - </configuration> - - - - - - - Registers an AWS credentials profile that can later be referenced by the profileName. - This profile will only be visible for the current user. - - Name given to the AWS credentials. - The AWS access key id - The AWS secret key - - - - - Registers a role-based profile to be used with SAML authentication. The profile contains - details of the role to be assumed when AWS credentials are requested based on the role and - a reference to a SAML endpoint profile containing details of the endpoint to be called to - authenticate the user. - - - If user identity information is not supplied then the identity of the logged-in user will - be used when authenticaton is performed against the endpoint referenced in the SAML endpoint - profile. If identity is provided, no password information is stored in the role profile and - the user must supply the password for the identity prior to authentication with the endpoint. - - - Name to be assigned to the profile - - The name assigned to the endpoint settings, previously saved with RegisterSAMLEndpoint. - - - The arn of the role that the user wants to assume when using this profile. This - must be one of the set returned by the saml endpoint when the user authenticates. - - - Optional. By default the identity of the logged-in user will be used when authentication - is performed - the user will not be prompted to supply a password. By supplying a custom - identity for this parameter, the user will be prompted to supply the password for the - identity prior to authentication. - - - - - - Registers a role-based profile to be used with SAML authentication. The profile contains - details of the role to be assumed when AWS credentials are requested based on the role and - a reference to a SAML endpoint profile containing details of the endpoint to be called to - authenticate the user. - - - If user identity information is not supplied then the identity of the logged-in user will - be used when authenticaton is performed against the endpoint referenced in the SAML endpoint - profile. If identity is provided, no password information is stored in the role profile and - the user must supply the password for the identity prior to authentication with the endpoint. - - - Name to be assigned to the profile - - The name assigned to the endpoint settings, previously saved with RegisterSAMLEndpoint. - - - The arn of the role that the user wants to assume when using this profile. This - must be one of the set returned by the saml endpoint when the user authenticates. - - - Optional. By default the identity of the logged-in user will be used when authentication - is performed - the user will not be prompted to supply a password. By supplying a custom - identity for this parameter, the user will be prompted to supply the password for the - identity prior to authentication. - - - Set for profiles intended to be used in regions where a region-specific STS endpoint - must be used (eg cn-north-1). If left empty/null, the global sts.amazonaws.com endpoint - will be used when credentials are obtained for this profile. - - - - - Registers an endpoint to be used in conjunction with SAML role profiles. The role profiles - reference the endpoint settings to obtain the actual endpoint and any customization settings - needed to perform authentication. - - Name to be assigned to the endpoint settings. - The full uri of the authentication endpoint. - - The authentication type to use when performing calls against the endpoint. Valid values are 'NTLM', - 'Digest', 'Kerberos' and 'Negotiate'. The default if not configured (null/empty string) is 'Kerberos'. - - The unique id assigned to the new settings. - - - - Deletes the settings for an AWS credentials or SAML role profile from the SDK account store. - - The name of the profile to remove. - - - - Lists all profile names registered with the SDK account store. - - The profile names. - - - - Loads and returns all available credential profiles registered in the store. - - Collection of profiles. - - - - Checks if a given profile is known in the SDK credential store. - - The name of the profile to test for existence - True if the profile exists. - - - - Copies the contents of the source profile to the destination. If the destination - profile does not exist a new profile is created. Note that if the destination - profile exists, all keys it contains are removed and replaced with keys from the - source profile. - - The name of the profile to copy from. - The name of the profile to create or update. - The unique id assigned to the destination settings. - - - - Copies the contents of the source profile to the destination. If the destination - profile does not exist a new profile is created. Note that if the destination - profile exists, all keys it contains are removed and replaced with keys from the - source profile. - - The source profile to copy keys and values from. - The name of the profile to create or update. - The unique id assigned to the destination settings. - - - - Tries to get the AWS credentials from a profile in the SDK account store. - - The profile to get the credentials for. - Outputs the credentials for the profile. - Returns true if the profile exists otherwise false is returned. - - - - Gets the AWS credentials from a profile in the SDK account store. - - The profile to get the credentials for. - The AWS credentials for the profile. - Thrown if the profile does not exist - - - - Returns the profile with the specified name, if it has been registered in the SDK store. - - The name of the registered profile - The loaded profile data - - - - Returns the persisted data in the SDK store as a profile of the specified type T. - - The name of the profile holding the settings. - The loaded profile. An exception is thrown if the profile could not be loaded. - Thrown if the profile does not exist - - Currently supported profile types: AWSCredentialsProfile and SAMLRoleProfile. - - - - - Tries to load the specified profile data corresponding to profile type T from a named - profile in the SDK account store. - - The name of the profile holding the settings. - The loaded profile data. - Returns true if the profile exists otherwise false is returned. - - Currently supported profile types: AWSCredentialsProfile and SAMLRoleProfile. - - - - - Attempts to load the settings defining a SAML endpoint. - - The name assigned to the settings for the endpoint. - The instantiated endpoint. - True if the settings were successfully loaded. - - - - Loads the settings defining a SAML endpoint. - - The name assigned to the settings for the endpoint. - The loaded settings. An exception is thrown if they could not be loaded. - Thrown if the endpoint settings do not exist. - - - - Common base contract for all types of credential and role profiles. - - - - - The user-defined name for the settings. - - - - - The unique id of the profile in the backing store. - - - - - Saves the profile data to backing store, returning the unique id - assigned to the data. - - - - - The persisted data for a set of AWS credentials. At a minimum this - is access key and secret key data. - - - - - Tests if an AWSCredentialsProfile instance could be instantiated from - the persisted settings data. - - The name given to the persisted settings (previously verified as existing). - True if the settings are compatible with an AWSCredentialsProfile type. - - - - Tests if an AWSCredentialsProfile instance could be instantiated from - the persisted settings data. - - The persisted settings. - True if the settings are compatible with an AWSCredentialsProfile type. - - - - Instantiates an AWSCredentialsProfile instance from the specified profile name. - - The name of the profile holding the settings. - New credentials profile instance. An exception is thrown if the profile data is invalid. - - - - Instantiates an AWSCredentialsProfile instance from the supplied settings collection. - - The settings representing the stored profile. - New credentials profile instance. An exception is thrown if the profile data is invalid. - - - - Validates the contents of the specified profile. - - The name of the AWS credentials profile to validate. - Thrown if the profile settings fail to validate. - - - - Verifies that the persisted settings contains the minimal viable data to - instantiate an AWSCredentialsProfile instance. - - The persisted settings. - Thrown if the profile settings fail to validate. - - - - Persists the profile data to the store file. - - The unique ID assigned to the settings. - - - - Creates or updates the profile data in the store file. - - The unique ID assigned to the settings. - - - - The persisted data for a SAML endpoint. One or more role profiles - will reference this to obtain the common endpoint and other data needed - to perform authentication with a set of user credentials. - - - - - The default authentication type to use when attempting to perform an - authentication call against the configured endpoint. - - - - - The authentication endpoint which must be a HTTPS scheme. - - - - - The authentication type to use when calling the endpoint. - - - - - Tests if a SAMLEndpointSettings instance could be instantiated from - the persisted settings data. - - The name given to the persisted settings. - True if the settings are compatible. - - - - Tests if a SAMLEndpointSettings instance could be instantiated from - the persisted settings data. - - The persisted settings. - True if the settings are compatible. - - - - Instantiates an instance from settings stored with the specified name. - - The name of the endpoint settings in the store. - Profile instance or an exception if the profile data does not exist/contains invalid data. - - - - Instantiates an instance from the supplied settings. - - The persisted settings. - Profile instance or an exception if the profile data is invalid. - - - - Validates the contents of the specified endpoint settings. - - The name of the SAML endpoint settings to validate. - Thrown if the settings fail to validate. - - - - Verifies that the persisted settings contains the minimal viable data to - instantiate a SAMLEndpointSettings instance. - - The persisted settings. - Thrown if the settings fail to validate. - - - - Persists the settings to the storage file. - - The unique id assigned to the profile - - - - Creates or updates the settings data for a SAML endpoint in the backing store file. An error is - thrown if the scheme for the endpoint is not https. - - The name of the settings to create or update - The authentication endpoint - Optional authentication type to use when performing calls against the endpoint - The unique id assigned to the profile - - - - Constructs an endpoint settings instance. - - The user-defined name to assign to the settings. - - The absolute uri, including any query and relyingParty data, of the endpoint. - - - The authentication type to use when performing requests against the endpoint. - - - - - - The persisted data for a saml role profile for a user. This profile - references an endpoint profile containing the actual endpoint to be used, and - adds details of the role to be assumed when the profile is selected. - - - Optionally the profile can store a username and domain to be used during - authentication (default behavior, if this is not specified, is to use the user's - default network credentials). - - - - - - The ARN of the role that is to be assumed. - - - - - If non-default network credentials are to used contains - the user identity (in domain\user format, domain optional) that - should be used to supply credentials when the profile is used in - authentication. The user must be prompted to supply the - corresponding password prior to authentication. - - - - - If a specific user identity was specified in the profile, - returns true to indicate a password needs to be obtained from - the user before obtaining network credentials to be used on - authentication. The default is to use the credentials - associated with the currently logged-in user or process to - perform authentication, which does not require the user to be - prompted. - - - - - - For regions with a region-specific endpoint for STS (eg cn-north-1) this - field can be set to ensure calls to obtain temporary credentials - after successful authentication are forwarded to the correct regional - endpoint. - - - This field does not need to be set when running in a region for - which the sts.amazonaws.com endpoint is valid. - - - - - - Retrieves the active credential session, if any, associated with the - role profile. - - - The current credentials valid for the role specified in the profile. Returns - null if no active session is available, or the active session has expired. - - - When a user successfully authenticates and receives temporary AWS - credentials for a role, the profile is updated with details of the - session. When the profile is loaded by other processes or tools, if - session data is present and still valid it can be retrieved using this - method avoiding the need to re-authenticate and get additional temporary - credentials. - - - - - Persists the current credentials to a 'session' key in the RoleSessions.json file. - This enables external applications and tools using the same profile to obtain credentials - without needing to separately re-authenticate the user prior to expiry of the current - credentials. After persisting the session data it can be retrieved using GetCurrentSession(). - - - Although the credentials are temporary we still encrypt the stored data when at rest in - the sdk credential store. - - - The current credentials valid for the role specified in the profile. - - - - - Stores or clears the persisted session data. - - - - - - The endpoint settings from which the actual endpoint to use in authentication - is obtained. - - - - - Tests if a SAMLRoleProfile instance could be instantiated from - the persisted settings data. - - The name given to the persisted settings. - True if the settings are compatible with a SAMLRoleProfile type. - - - - Tests if a SAMLRoleProfile instance could be instantiated from - the persisted settings data. - - The persisted settings. - True if the settings are compatible with a SAMLRoleProfile type. - - - - Instantiates an instance from settings stored with the specified name. - - The name of the endpoint profile. - Profile instance or an exception if the profile data does not exist/contains invalid data. - - - - Instantiates an instance from the supplied settings. In addition to the profile settings - the SDK will inspect for a RoleSessions.json file containing active session data and if - an entry for the profile is present, will add the session data to the returned profile - object. - - The persisted settings. - Profile instance or an exception if the profile data is invalid. - - - - Validates the contents of the specified profile. - - The name of the SAML role profile to validate. - Thrown if the profile settings fail to validate. - - - - Validates that the presented settings would result in a valid role profile - instance. - - The persisted settings. - Thrown if the profile settings fail to validate. - - - - Stores the data in the role profile to the backing store file. - - - - - - Registers a role-based profile to be used with SAML authentication. The profile contains - details of the role to be assumed when AWS credentials are requested based on the role and - a reference to a SAML endpoint profile containing details of the endpoint to be called to - authenticate the user. - - - If user identity information is not supplied then the identity of the logged-in user will - be used when authenticaton is performed against the endpoint referenced in the SAML endpoint - profile. If identity is provided, no password information is stored in the role profile and - the user must supply the password for the identity prior to authentication with the endpoint. - - - Name to be assigned to the profile - - The name of the settings in the SAML endpoints file containing details of the - endpoint to authenticate with. - - - The arn of the role that the user wants to assume when using this profile. This - must be one of the set returned by the saml endpoint when the user authenticates. - - - Optional, can be used to prompt the user for a password for the account when authentication - is performed from a system that is not domain-joined. - - - Optional, details of the currently active credentials for the role that we want to - persist into the profile for other tools or processes to pick up, avoiding the need - to continually re-authenticate the user as they switch between tools. The active session, - if any, is stored separately from the profile using the file RoleSessions.json. - - - Set for profiles intended to be used in regions where a region-specific STS endpoint - must be used (eg cn-north-1). If left empty/null, the global sts.amazonaws.com endpoint - will be used when credentials are obtained for this profile. - - The unique id assigned to the profile. - - - - Tests for and loads any active session credentials for the specified profile. The session data - exists in a separate file from the profile, RoleSessions.json. - - - - - - - Stores the supplied session data into the RoleSessions.json backing file. - - - - - - - Constructs a profile data instance that will use the specified network identity - during authentication with configured endpoint. - - The user-defined name of the profile that sourced this data. - The settings for the authentication endpoint. - The role that should be assumed on successful authentication. - The credentials to supply in authentication, in domain\user format. - - Deserialized credential data from the profile, if still valid. Null if the profile does not - contain any active credentials, or the credentials it did hold are now invalid. - - - Set for profiles intended to be used in regions where a region-specific STS endpoint - must be used (eg cn-north-1). If left empty/null, the global sts.amazonaws.com endpoint - will be used when credentials are obtained for this profile. - - - - - AwsHttpClient is a wrapper around HttpClient class of the System.Net.Http library. - The wrapper has been added so as to remove System.Net.Http dependencies from the Services - and migrate it to a Core level dependecy only. This avoids version clashes when a service - and the Core depends on different versions of the System.Net.Http library. This is a Service - level utility method - - - - - AWSHttpClient wrapper that is wrapped around - HttpClient default wrapper. - - - - - AWSHttpClient BaseAddress property that is wrapper for - HttpClient BaseAddress property. - - - - - AWSHttpClient Timeout property that is wrapper for - HttpClient Timeout property. - - - - - AWSHttpClient MaxResponseContentBufferSize property that is wrapper for - HttpClient MaxResponseContentBufferSize property. - - - - - AWSHttpClient GetStreamAsync that accepts the requester's URI - and make a HttpClient.GetStreamAsync call. - - Requester Uri - - - - Wrapper method that accepts a request uri, stream content and headers and makes a sendAsync call. - - - - - - - Wrapper for HttpClient's HttpRequestMessage and SendAsync methods. - - - - Returns response headers information- header name,value and status code - - - - Wrapper for HttpClient Dispose. - - - - - Method that checks if the passed exception is of type - HttpRequestException - - - - - - - AWSStreamContent is a wrapper for StreamContent class in - the System.Net.Http library.The wrapper has been added so as to - remove System.Net.Http dependencies from the Services - and migrate it to a Core level dependecy only. This avoids version clashes when a service - and the Core depends on different versions of the System.Net.Http library. This is a Service - level utility method - - - - - Wrapper for StreamContent constructor - for stream content - - - - - - Wrapper for StreamContent constructor - for stream content and bufferSize - - - - - - - Wrapper to allow Services to remove StreamContent Headers - - - - - - - Wrapper to allow Services to add StreamContent Headers - - - - - - - Wrapper for StreamContent Dispose. - - - - - Utility class to parse Amazon resource names more commonly known as an ARN. - - - - - Gets and sets the partition associated with the ARN (e.g.: 'aws'). - - - - - Gets and sets the AWS service associated with the ARN (e.g.: 's3'). - - - - - Gets and sets the region associated with the ARN (e.g.: 'us-east-1'). - - - - - Gets and sets the account ID associated with the ARN. - - - - - Gets and sets the resource associated with the ARN (e.g.: 'mybucket/myobject'). - - - - - Returns true if the string appears to be an ARN by seeing if the string starts with "arn:". This method - doesn't guarantee the string is a valid ARN. To validate the string call TryParse. - - - - - - - Parses the string into an ARN object. - - String to parse into an ARN. - The out parameter for the ARN object created by TryParse. - True if the string was parsed into an ARN object. - - - - Parses the string into an ARN object. - - String to parse into an Arn. - The Arn object created from the passed in string. - Thrown if arnString is null. - Thrown if the string passed in not valid ARN. - - - - Turns the Arn object into a string representation of an ARN. - - - - - - Configuration options that apply to the entire SDK. - - These settings can be configured through app.config or web.config. - Below is a full sample configuration that illustrates all the possible options. - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws region="us-west-2"> - <logging logTo="Log4Net, SystemDiagnostics" logResponses="Always" logMetrics="true" /> - <s3 useSignatureVersion4="true" /> - <proxy host="localhost" port="8888" username="1" password="1" /> - - <dynamoDB> - <dynamoDBContext tableNamePrefix="Prod-"> - - <tableAliases> - <alias fromTable="FakeTable" toTable="People" /> - <alias fromTable="Persons" toTable="People" /> - </tableAliases> - - <mappings> - <map type="Sample.Tests.Author, SampleDLL" targetTable="People" /> - <map type="Sample.Tests.Editor, SampleDLL" targetTable="People"> - <property name="FullName" attribute="Name" /> - <property name="EmployeeId" attribute="Id" /> - <property name="ComplexData" converter="Sample.Tests.ComplexDataConverter, SampleDLL" /> - <property name="Version" version="true" /> - <property name="Password" ignore="true" /> - </map> - </mappings> - - </dynamoDBContext> - </dynamoDB> - </aws> - - - - Configuration options that apply to the entire SDK. - - - - - Manual offset to apply to client clock. This is a global setting that overrides - ClockOffset value calculated for all service endpoints. - - - - - Determines if the SDK should correct for client clock skew - by determining the correct server time and reissuing the - request with the correct time. - Default value of this field is True. - will be updated with the calculated - offset even if this field is set to false, though requests - will not be corrected or retried. - Ignored if is set. - - - - - The calculated clock skew correction, if there is one. - This field will be set if a service call resulted in an exception - and the SDK has determined that there is a difference between local - and server times. - - If is set to true, this - value will be set to the correction, but it will not be used by the - SDK and clock skew errors will not be retried. - - - - - Key for the AWSRegion property. - - - - - - Configures the default AWS region for clients which have not explicitly specified a region. - Changes to this setting will only take effect for newly constructed instances of AWS clients. - - This setting can be configured through the App.config. For example: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws region="us-west-2" /> - - - - - - Key for the AWSProfileName property. - - - - - - Profile name for stored AWS credentials that will be used to make service calls. - Changes to this setting will only take effect in newly-constructed clients. - - To reference the account from an application's App.config or Web.config use the AWSProfileName setting. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="development"/> - </appSettings> - </configuration> - - - - - - - Key for the AWSProfilesLocation property. - - - - - - Location of the credentials file shared with other AWS SDKs. - By default, the credentials file is stored in the .aws directory in the current user's home directory. - - Changes to this setting will only take effect in newly-constructed clients. - - To reference the profile from an application's App.config or Web.config use the AWSProfileName setting. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfilesLocation" value="c:\config"/> - </appSettings> - </configuration> - - - - - - - Key for the Logging property. - - - - - - Configures how the SDK should log events, if at all. - Changes to this setting will only take effect in newly-constructed clients. - - The setting can be configured through App.config, for example: - - <appSettings> - <add key="AWSLogging" value="log4net"/> - </appSettings> - - - - - - Key for the ResponseLogging property. - - - - - - - Configures when the SDK should log service responses. - Changes to this setting will take effect immediately. - - The setting can be configured through App.config, for example: - - <appSettings> - <add key="AWSResponseLogging" value="OnError"/> - </appSettings> - - - - - - Key for the LogMetrics property. - - - - - - Configures if the SDK should log performance metrics. - This setting configures the default LogMetrics property for all clients/configs. - Changes to this setting will only take effect in newly-constructed clients. - - The setting can be configured through App.config, for example: - - <appSettings> - <add key="AWSLogMetrics" value="true"/> - </appSettings> - - - - - - Key for the EndpointDefinition property. - - - - - - Configures if the SDK should use a custom configuration file that defines the regions and endpoints. - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws endpointDefinition="c:\config\endpoints.json" /> - - - - - - Key for the UseSdkCache property. - - - - - - Configures if the SDK Cache should be used, the default value is true. - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws useSdkCache="true" /> - - - - - - Configuration for the Logging section of AWS configuration. - Changes to some settings may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws> - <logging logTo="Log4Net, SystemDiagnostics" logResponses="Always" logMetrics="true" /> - </aws> - - - - - - Configuration for the Proxy section of AWS configuration. - Changes to some settings may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws> - <proxy host="localhost" port="8888" username="1" password="1" bypassList="addressexpr1;addressexpr2;..." bypassOnLocal="true" /> - </aws> - - - - - - When set to true, the service client will use the x-amz-user-agent - header instead of the User-Agent header to report version and - environment information to the AWS service. - - Note: This is especially useful when using a platform like WebAssembly - which doesn't allow to specify the User-Agent header. - - - - - Configuration for the region endpoint section of AWS configuration. - Changes may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws region="us-west-2" /> - - - - - - Lock for SomeEvent delegate access. - - - - - This method should never be called directly. - Call AWSSDKUtils.CorrectedUtcNow instead. - - - - - - Add a listener for SDK logging. - - If the listener does not have a name, you will not be able to remove it later. - The source to log for, e.g. "Amazon", or "Amazon.DynamoDB". - The listener to add. - - - - Remove a trace listener from SDK logging. - - The source the listener was added to. - The name of the listener. - - - - Logging options. - Can be combined to enable multiple loggers. - - - - - No logging - - - - - Log using log4net - - - - - Log using System.Diagnostics - - - - - Log to the console - - - - - Response logging option. - - - - - Never log service response - - - - - Only log service response when there's an error - - - - - Always log service response - - - - - Format for metrics data in the logs - - - - - Emit metrics in human-readable format - - - - - Emit metrics as JSON data - - - - - Allows to configure the proxy used for HTTP requests. The default value is null. - - - - - This class contains the endpoints available to the AWS clients. The static constants representing the - regions can be used while constructing the AWS client instead of looking up the exact endpoint URL. - - - - - Gets the endpoint for a service in a region. - - The services system name. - If true returns the endpoint for dualstack - Thrown when the request service does not have a valid endpoint in the region. - - - - - Enumerate through all the regions. - - - - - Gets the region based on its system name like "us-west-1" - - The system name of the service like "us-west-1" - - - - - This is a testing method and should not be called by production applications. - - - - - Gets the system name of a region. - - - - - Gets the display name of a region. - - - - - This region name is non-standard. Search the whole endpoints.json file to - determine the partition this region is in. - - - - - This class contains region information used to lazily compute the service endpoints. The static constants representing the - regions can be used while constructing the AWS client instead of looking up the exact endpoint URL. - - - - - The US East (Virginia) endpoint. - - - - - The US East (Virginia) regional endpoint. - - - - - The US East (Ohio) endpoint. - - - - - The US West (N. California) endpoint. - - - - - The US West (Oregon) endpoint. - - - - - The EU North (Stockholm) endpoint. - - - - - The EU West (Ireland) endpoint. - - - - - The EU West (London) endpoint. - - - - - The EU West (Paris) endpoint. - - - - - The EU Central (Frankfurt) endpoint. - - - - - The Europe (Milan) endpoint. - - - - - The Asia Pacific (Hong Kong) endpoint. - - - - - The Asia Pacific (Tokyo) endpoint. - - - - - The Asia Pacific (Seoul) endpoint. - - - - - The Asia Pacific (Osaka-Local) endpoint. - - - - - The Asia Pacific (Mumbai) endpoint. - - - - - The Asia Pacific (Singapore) endpoint. - - - - - The Asia Pacific (Sydney) endpoint. - - - - - The South America (Sao Paulo) endpoint. - - - - - The US GovCloud East (Virginia) endpoint. - - - - - The US GovCloud West (Oregon) endpoint. - - - - - The China (Beijing) endpoint. - - - - - The China (Ningxia) endpoint. - - - - - The Canada (Central) endpoint. - - - - - The Middle East (Bahrain) endpoint. - - - - - The Africa (Cape Town) endpoint. - - - - - Represents the endpoint overridding rules in the endpoints.json - Is used to map private region (ie us-east-1-regional) to public regions (us-east-1) - For signing purposes. - - - - - Enumerate through all the regions. - - - - - Gets the region based on its system name like "us-west-1" - - The system name of the service like "us-west-1" - - - - - Gets the region endpoint override if exists - - The region endpoint to find the possible override for - - - - - Gets the system name of a region. - - - - - Gets the display name of a region. - - - - - Gets the partition name the region is in. For example for us-east-1 the partition name is aws. For cn-northwest-1 the partition name is aws-cn. - - - - - Gets the dns suffix for the region endpoints in a partition. For example the aws partition's suffix is amazonaws.com. The aws-cn partition's suffix is amazonaws.com.cn. - - - - - Gets the endpoint for a service in a region. - - - The services system name. Service system names can be obtained from the - RegionEndpointServiceName member of the ClientConfig-derived class for the service. - - - For forwards compatibility, if the service being requested for isn't known in the region, this method - will generate an endpoint using the AWS endpoint heuristics. In this case, it is not guaranteed the - endpoint will point to a valid service endpoint. - - - - - - Gets the endpoint for a service in a region, optionally selecting a dualstack compatible endpoint. - - - The services system name. Service system names can be obtained from the - RegionEndpointServiceName member of the ClientConfig-derived class for the service. - - - If true a dualstack endpoint is returned. It is the user's responsibility to verify that the given service - supports a dualstack endpoint for the region. - - - For forwards compatibility, if the service being requested for isn't known in the region, this method - will generate an endpoint using the AWS endpoint heuristics. In this case, it is not guaranteed the - endpoint will point to a valid service endpoint. - - - - - - This class defines an endpoints hostname and which protocols it supports. - - - - - Gets the hostname for the service. - - - - - The authentication region to be used in request signing. - - - - - This property is only set for S3 endpoints. For all other services this property returns null. - For S3 endpoints, if the endpoint supports signature version 2 this property will be "2", otherwise it will be "4". - - - - - Calculates a 32bit Cyclic Redundancy Checksum (CRC) using the - same polynomial used by Zip. This type is used internally by DotNetZip; it is generally not used directly - by applications wishing to create, read, or manipulate zip archive files. - - - - - indicates the total number of bytes read on the CRC stream. - This is used when writing the ZipDirEntry when compressing files. - - - - - Indicates the current CRC for all blocks slurped in. - - - - - Returns the CRC32 for the specified stream. - - The stream over which to calculate the CRC32 - the CRC32 calculation - - - - Returns the CRC32 for the specified stream, and writes the input into the output stream. - - The stream over which to calculate the CRC32 - The stream into which to deflate the input - the CRC32 calculation - - - - Get the CRC32 for the given (word,byte) combo. - This is a computation defined by PKzip. - - The word to start with. - The byte to combine it with. - The CRC-ized result. - - - - Update the value for the running CRC32 using the given block of bytes. - This is useful when using the CRC32() class in a Stream. - - block of bytes to slurp - starting point in the block - how many bytes within the block to slurp - - - - A Stream that calculates a CRC32 (a checksum) on all bytes read, - or on all bytes written. - - - - - This class can be used to verify the CRC of a ZipEntry when reading from a stream, - or to calculate a CRC when writing to a stream. The stream should be used to either - read, or write, but not both. If you intermix reads and writes, the results are - not defined. - - This class is intended primarily for use internally by the DotNetZip library. - - - - - Gets the total number of bytes run through the CRC32 calculator. - - - - This is either the total number of bytes read, or the total number - of bytes written, depending on the direction of this stream. - - - - - The constructor. - - The underlying stream - - - - The constructor. - - The underlying stream - The length of the stream to slurp - - - - Provides the current CRC for all blocks slurped in. - - - - - Read from the stream - - the buffer to read - the offset at which to start - the number of bytes to read - the number of bytes actually read - - - - Write to the stream. - - the buffer from which to write - the offset at which to start writing - the number of bytes to write - - - - Indicates whether the stream supports reading. - - - - - Indicates whether the stream supports seeking. - - - - - Indicates whether the stream supports writing. - - - - - Flush the stream. - - - - - Not implemented. - - - - - Not implemented. - - - - - Not implemented. - - N/A - N/A - N/A - - - - Not implemented. - - N/A - - - a general purpose ASN.1 decoder - note: this class differs from the - others in that it returns null after it has read the last object in - the stream. If an ASN.1 Null is encountered a Der/BER Null object is - returned. - - - Create an ASN1InputStream where no DER object will be longer than limit. - - @param input stream containing ASN.1 encoded data. - @param limit maximum size of a DER encoded object. - - - Create an ASN1InputStream based on the input byte array. The length of DER objects in - the stream is automatically limited to the length of the input array. - - @param input array containing ASN.1 encoded data. - - - build an object given its tag and the number of bytes to construct it from. - - - Create a base ASN.1 object from a byte array. - The byte array to parse. - The base ASN.1 object represented by the byte array. - If there is a problem parsing the data. - - - Read a base ASN.1 object from a stream. - The stream to parse. - The base ASN.1 object represented by the byte array. - If there is a problem parsing the data. - - - return the object at the sequence position indicated by index. - - @param index the sequence number (starting at zero) of the object - @return the object at the sequence position indicated by index. - - - create an empty sequence - - - create a sequence containing one object - - - create a sequence containing a vector of objects. - - - - A - - - - - - A - - - A - - - - - - A - - - - - return a = a + b - b preserved. - - - unsigned comparison on two arrays - note the arrays may - start with leading zeros. - - - returns x = x - y - we assume x is >= y - - - diff --git a/packages/AWSSDK.Core.3.3.107.14/lib/portable-net45+win8+wpa81+wp8/AWSSDK.Core.XML b/packages/AWSSDK.Core.3.3.107.14/lib/portable-net45+win8+wpa81+wp8/AWSSDK.Core.XML deleted file mode 100644 index 5323a9e..0000000 --- a/packages/AWSSDK.Core.3.3.107.14/lib/portable-net45+win8+wpa81+wp8/AWSSDK.Core.XML +++ /dev/null @@ -1,10800 +0,0 @@ - - - - AWSSDK.Core - - - - - Utility class to parse Amazon resource names more commonly known as an ARN. - - - - - Gets and sets the partition associated with the ARN (e.g.: 'aws'). - - - - - Gets and sets the AWS service associated with the ARN (e.g.: 's3'). - - - - - Gets and sets the region associated with the ARN (e.g.: 'us-east-1'). - - - - - Gets and sets the account ID associated with the ARN. - - - - - Gets and sets the resource associated with the ARN (e.g.: 'mybucket/myobject'). - - - - - Returns true if the string appears to be an ARN by seeing if the string starts with "arn:". This method - doesn't guarantee the string is a valid ARN. To validate the string call TryParse. - - - - - - - Parses the string into an ARN object. - - String to parse into an ARN. - The out parameter for the ARN object created by TryParse. - True if the string was parsed into an ARN object. - - - - Parses the string into an ARN object. - - String to parse into an Arn. - The Arn object created from the passed in string. - Thrown if arnString is null. - Thrown if the string passed in not valid ARN. - - - - Turns the Arn object into a string representation of an ARN. - - - - - - Configuration options that apply to the entire SDK. - - These settings can be configured through app.config or web.config. - Below is a full sample configuration that illustrates all the possible options. - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws region="us-west-2"> - <logging logTo="Log4Net, SystemDiagnostics" logResponses="Always" logMetrics="true" /> - <s3 useSignatureVersion4="true" /> - <proxy host="localhost" port="8888" username="1" password="1" /> - - <dynamoDB> - <dynamoDBContext tableNamePrefix="Prod-"> - - <tableAliases> - <alias fromTable="FakeTable" toTable="People" /> - <alias fromTable="Persons" toTable="People" /> - </tableAliases> - - <mappings> - <map type="Sample.Tests.Author, SampleDLL" targetTable="People" /> - <map type="Sample.Tests.Editor, SampleDLL" targetTable="People"> - <property name="FullName" attribute="Name" /> - <property name="EmployeeId" attribute="Id" /> - <property name="ComplexData" converter="Sample.Tests.ComplexDataConverter, SampleDLL" /> - <property name="Version" version="true" /> - <property name="Password" ignore="true" /> - </map> - </mappings> - - </dynamoDBContext> - </dynamoDB> - </aws> - - - - Configuration options that apply to the entire SDK. - - - - - Manual offset to apply to client clock. This is a global setting that overrides - ClockOffset value calculated for all service endpoints. - - - - - Determines if the SDK should correct for client clock skew - by determining the correct server time and reissuing the - request with the correct time. - Default value of this field is True. - will be updated with the calculated - offset even if this field is set to false, though requests - will not be corrected or retried. - Ignored if is set. - - - - - The calculated clock skew correction, if there is one. - This field will be set if a service call resulted in an exception - and the SDK has determined that there is a difference between local - and server times. - - If is set to true, this - value will be set to the correction, but it will not be used by the - SDK and clock skew errors will not be retried. - - - - - Key for the AWSRegion property. - - - - - - Configures the default AWS region for clients which have not explicitly specified a region. - Changes to this setting will only take effect for newly constructed instances of AWS clients. - - This setting can be configured through the App.config. For example: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws region="us-west-2" /> - - - - - - Key for the AWSProfileName property. - - - - - - Profile name for stored AWS credentials that will be used to make service calls. - Changes to this setting will only take effect in newly-constructed clients. - - To reference the account from an application's App.config or Web.config use the AWSProfileName setting. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="development"/> - </appSettings> - </configuration> - - - - - - - Key for the AWSProfilesLocation property. - - - - - - Location of the credentials file shared with other AWS SDKs. - By default, the credentials file is stored in the .aws directory in the current user's home directory. - - Changes to this setting will only take effect in newly-constructed clients. - - To reference the profile from an application's App.config or Web.config use the AWSProfileName setting. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfilesLocation" value="c:\config"/> - </appSettings> - </configuration> - - - - - - - Key for the Logging property. - - - - - - Configures how the SDK should log events, if at all. - Changes to this setting will only take effect in newly-constructed clients. - - The setting can be configured through App.config, for example: - - <appSettings> - <add key="AWSLogging" value="log4net"/> - </appSettings> - - - - - - Key for the ResponseLogging property. - - - - - - - Configures when the SDK should log service responses. - Changes to this setting will take effect immediately. - - The setting can be configured through App.config, for example: - - <appSettings> - <add key="AWSResponseLogging" value="OnError"/> - </appSettings> - - - - - - Key for the LogMetrics property. - - - - - - Configures if the SDK should log performance metrics. - This setting configures the default LogMetrics property for all clients/configs. - Changes to this setting will only take effect in newly-constructed clients. - - The setting can be configured through App.config, for example: - - <appSettings> - <add key="AWSLogMetrics" value="true"/> - </appSettings> - - - - - - Key for the EndpointDefinition property. - - - - - - Configures if the SDK should use a custom configuration file that defines the regions and endpoints. - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws endpointDefinition="c:\config\endpoints.json" /> - - - - - - Key for the UseSdkCache property. - - - - - - Configures if the SDK Cache should be used, the default value is true. - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws useSdkCache="true" /> - - - - - - Configuration for the Logging section of AWS configuration. - Changes to some settings may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws> - <logging logTo="Log4Net, SystemDiagnostics" logResponses="Always" logMetrics="true" /> - </aws> - - - - - - Configuration for the Proxy section of AWS configuration. - Changes to some settings may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws> - <proxy host="localhost" port="8888" username="1" password="1" bypassList="addressexpr1;addressexpr2;..." bypassOnLocal="true" /> - </aws> - - - - - - Configuration for the region endpoint section of AWS configuration. - Changes may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws region="us-west-2" /> - - - - - - Lock for SomeEvent delegate access. - - - - - This method should never be called directly. - Call AWSSDKUtils.CorrectedUtcNow instead. - - - - - - Logging options. - Can be combined to enable multiple loggers. - - - - - No logging - - - - - Log using log4net - - - - - Log using System.Diagnostics - - - - - Log to the console - - - - - Log to a file - - - - - Response logging option. - - - - - Never log service response - - - - - Only log service response when there's an error - - - - - Always log service response - - - - - Format for metrics data in the logs - - - - - Emit metrics in human-readable format - - - - - Emit metrics as JSON data - - - - - An access control policy action identifies a specific action in a service - that can be performed on a resource. For example, sending a message to a - queue. - - ActionIdentifiers allow you to limit what your access control policy statement affects. - For example, you could create a policy statement that enables a certain group - of users to send messages to your queue, but not allow them to perform any - other actions on your queue. - - - The action is B in the statement - "A has permission to do B to C where D applies." - - Free form access control policy actions may include a wildcard (*) to match - multiple actions. - - - Constants for known actions can be found in the Amazon.Auth.AccessControlPolicy.ActionIdentifiers namespace. - - - - - - Constructs an Actionidentifer with the given action name. - - The name of the action - - - - Gets and sets the name of this action. For example, 'sqs:SendMessage' is the - name corresponding to the SQS action that enables users to send a message - to an SQS queue. - - - - - AWS access control policy conditions are contained in - objects, and affect when a statement is applied. For example, a statement - that allows access to an Amazon SQS queue could use a condition to only apply - the effect of that statement for requests that are made before a certain - date, or that originate from a range of IP addresses. - - Multiple conditions can be included in a single statement, and all conditions - must evaluate to true in order for the statement to take effect. - - - The set of conditions is D in the statement - "A has permission to do B to C where D applies." - - - A condition is composed of three parts: - - - Condition Key - The condition key declares which value of a - request to pull in and compare against when a policy is evaluated by AWS. For - example, using will cause - AWS to pull in the current request's source IP as the first value to compare - against every time your policy is evaluated. - - - - Comparison Type - This is a static value used as the second value - in the comparison when your policy is evaluated. Depending on the comparison - type, this value can optionally use wildcards. See the documentation for - individual comparison types for more information. - - - - Comparison Value - This is a static value used as the second value - in the comparison when your policy is evaluated. Depending on the comparison - type, this value can optionally use wildcards. See the documentation for - individual comparison types for more information. - - - - - - - - - Gets the type of this condition. - - - - - Gets and Sets the name of the condition key involved in this condition. - Condition keys are predefined values supported by AWS that provide input - to a condition's evaluation, such as the current time, or the IP address - of the incoming request. - - Your policy is evaluated for each incoming request, and condition keys - specify what information to pull out of those incoming requests and plug - into the conditions in your policy. - - - - - - Gets and Sets the values specified for this access control policy condition. - For example, in a condition that compares the incoming IP address of a - request to a specified range of IP addresses, the range of IP addresses - is the single value in the condition. - - Most conditions accept only one value, but multiple values are possible. - - - - - - A factory for creating conditions to be used in the policy. - - - - - Condition key for the current time. - - This condition key should only be used with enum. - - - - - - Condition key for whether or not an incoming request is using a secure - transport to make the request (i.e. HTTPS instead of HTTP). - - This condition key should only be used with the boolean overload of NewCondition. - - - - - - Condition key for the source IP from which a request originates. - - This condition key should only be used with enum. - - - - - - Condition key for the user agent included in a request. - - This condition key should only be used with - enum. - - - - - - Condition key for the current time, in epoch seconds. - - This condition key should only be used with enum. - objects. - - - - - - Condition key for the referrer specified by a request. - - This condition key should only be used with - objects. - - - - - - Condition key for the Amazon Resource Name (ARN) of the source specified - in a request. The source ARN indicates which resource is affecting the - resource listed in your policy. For example, an SNS topic is the source - ARN when publishing messages from the topic to an SQS queue. - - This condition key should only be used with enum. - - - - - - Enumeration of the supported ways an ARN comparison can be evaluated. - - - - Exact matching - - - - Loose case-insensitive matching of the ARN. Each of the six - colon-delimited components of the ARN is checked separately and each - can include a multi-character match wildcard (*) or a - single-character match wildcard (?). - - - - Negated form of ArnEquals - - - Negated form of ArnLike - - - - Enumeration of the supported ways a date comparison can be evaluated. - - - - - Enumeration of the supported ways an IP address comparison can be evaluated. - - - - - Matches an IP address against a CIDR IP range, evaluating to true if - the IP address being tested is in the condition's specified CIDR IP - range. - - - - - Negated form of IpAddress - - - - - Enumeration of the supported ways a numeric comparison can be evaluated - - - - - Enumeration of the supported ways a string comparison can be evaluated. - - - - - Case-sensitive exact string matching - - - - - Case-insensitive string matching - - - - - Loose case-insensitive matching. The values can include a - multi-character match wildcard (*) or a single-character match - wildcard (?) anywhere in the string. - - - - - Negated form of StringEquals. - - - - - Negated form of StringEqualsIgnorecase. - - - - - Negated form of StringLike. - - - - - Constructs a new access control policy condition that compares ARNs (Amazon Resource Names). - - The access policy condition key specifying where to get the first ARN for the comparison - The type of comparison to perform. - The second ARN to compare against. When using ArnLike or ArnNotLike this may contain the - multi-character wildcard (*) or the single-character wildcard - - - - Constructs a new access policy condition that performs a boolean - comparison. - - The access policy condition key specifying where to get the - first boolean value for the comparison (ex: aws:SecureTransport). - The boolean to compare against. - - - - This method is deprecated. Invoking this method results in non-UTC DateTimes - not being marshalled correctly. Use NewConditionUtc instead. - Constructs a new access policy condition that compares the current time - (on the AWS servers) to the specified date. - - The type of comparison to perform. For example, - DateComparisonType.DateLessThan will cause this policy - condition to evaluate to true if the current date is less than - the date specified in the second argument. - The date to compare against. - - - - Constructs a new access policy condition that compares the current time - (on the AWS servers) to the specified date. - - The type of comparison to perform. For example, - DateComparisonType.DateLessThan will cause this policy - condition to evaluate to true if the current date is less than - the date specified in the second argument. - The date to compare against. - - - - Constructs a new access policy condition that compares the source IP - address of the incoming request to an AWS service against the specified - CIDR range. The condition evaluates to true (meaning the policy statement - containing it will be applied) if the incoming source IP address is - within that range. - - To achieve the opposite effect (i.e. cause the condition to evaluate to - true when the incoming source IP is not in the specified CIDR - range) use the alternate constructor form and specify - IpAddressComparisonType.NotIpAddress. - - - The CIDR IP range involved in the policy condition. - - - - Constructs a new access policy condition that compares the source IP - address of the incoming request to an AWS service against the specified - CIDR range. When the condition evaluates to true (i.e. when the incoming - source IP address is within the CIDR range or not) depends on the - specified IpAddressComparisonType. - - The type of comparison to to perform. - The CIDR IP range involved in the policy condition. - - - - Constructs a new access policy condition that compares two numbers. - - The type of comparison to perform. - The access policy condition key specifying where to get the - first number for the comparison. - The second number to compare against. - - - - Constructs a new access control policy condition that compares two - strings. - - The type of comparison to perform - The access policy condition key specifying where to get the - first string for the comparison (ex: aws:UserAgent). - - The second string to compare against. When using - StringComparisonType.StringLike or - StringComparisonType.StringNotLike this may contain - the multi-character wildcard (*) or the single-character - wildcard (?). - - - - - Constructs a new access policy condition that compares the Amazon - Resource Name (ARN) of the source of an AWS resource that is modifying - another AWS resource with the specified pattern. - - For example, the source ARN could be an Amazon SNS topic ARN that is - sending messages to an Amazon SQS queue. In that case, the SNS topic ARN - would be compared the ARN pattern specified here. - - - The endpoint pattern may optionally contain the multi-character wildcard - * (*) or the single-character wildcard (?). Each of the six colon-delimited - components of the ARN is checked separately and each can include a - wildcard. - - - Policy policy = new Policy("MyQueuePolicy"); - policy.WithStatements(new Statement(Statement.StatementEffect.Allow) - .WithPrincipals(new Principal("*")).WithActionIdentifiers(SQSActionIdentifiers.SendMessage) - .WithResources(new Resource(myQueueArn)) - .WithConditions(ConditionFactory.NewSourceArnCondition(myTopicArn))); - - - The ARN pattern against which the source ARN will be compared. - Each of the six colon-delimited components of the ARN is - checked separately and each can include a wildcard. - A new access control policy condition that compares the ARN of - the source specified in an incoming request with the ARN pattern - specified here. - - - - Constructs a new access control policy condition that tests if the - incoming request was sent over a secure transport (HTTPS). - - A new access control policy condition that tests if the incoming - request was sent over a secure transport (HTTPS). - - - - Condition key for the canned ACL specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the location constraint specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the prefix specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the delimiter specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the max keys specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the source object specified by a request to copy an - object. - - This condition key may only be used with enum. - - - - - - Condition key for the metadata directive specified by a request to copy - an object. - - This condition key may only be used with enum. - - - - - - Condition key for the version ID of an object version specified by a - request. - - This condition key may only be used with enum. - - - - - - Constructs a new access policy condition that compares an Amazon S3 - canned ACL with the canned ACL specified by an incoming request. - - You can use this condition to ensure that any objects uploaded to an - Amazon S3 bucket have a specific canned ACL set. - - - The Amazon S3 canned ACL to compare against. - A new access control policy condition that compares the Amazon S3 - canned ACL specified in incoming requests against the value - specified. - - - - Condition key for The URL, e-mail address, or ARN from a Subscribe - request or a previously confirmed subscription. Use with string - conditions to restrict access to specific endpoints (e.g., - *@mycompany.com). - - This condition key may only be used with enum. - - - - - - Condition key for the protocol value from a Subscribe request or a - previously confirmed subscription. Use with string conditions to restrict - publication to specific delivery protocols (e.g., HTTPS). - - This condition key may only be used with enum. - - - - - - Constructs a new access policy condition that compares the requested - endpoint used to subscribe to an Amazon SNS topic with the specified - endpoint pattern. The endpoint pattern may optionally contain the - multi-character wildcard (*) or the single-character wildcard (?). - - For example, this condition can restrict subscriptions to a topic to - email addresses in a certain domain ("*@my-company.com"). - - - Policy policy = new Policy("MyTopicPolicy"); - policy.WithStatements(new Statement(Statement.StatementEffect.Allow) - .WithPrincipals(new Principal("*")).WithActionIdentifiers(SNSActionIdentifiers.Subscribe) - .WithResources(new Resource(myTopicArn)) - .WithConditions(ConditionFactory.NewEndpointCondition("*@my-company.com"))); - - - The endpoint pattern against which to compare the requested - endpoint for an Amazon SNS topic subscription. - A new access control policy condition that compares the endpoint - used in a request to subscribe to an Amazon SNS topic with the - endpoint pattern specified. - - - - Constructs a new AWS access control policy condition that allows an - access control statement to restrict subscriptions to an Amazon SNS topic - based on the protocol being used for the subscription. For example, this - condition can restrict subscriptions to a topic to endpoints using HTTPS - to ensure that messages are securely delivered. - - The protocol against which to compare the requested protocol - for an Amazon SNS topic subscription. - A new access control policy condition that compares the - notification protocol requested in a request to subscribe to an - Amazon SNS topic with the protocol value specified. - - - - An AWS access control policy is a object that acts as a container for one or - more statements, which specify fine grained rules for allowing or denying - various types of actions from being performed on your AWS resources. - - By default, all requests to use your resource coming from anyone but you are - denied. Access control polices can override that by allowing different types - of access to your resources, or by explicitly denying different types of - access. - - - Each statement in an AWS access control policy takes the form: - "A has permission to do B to C where D applies". - - - A is the prinicpal - The AWS account that is making a request to - access or modify one of your AWS resources. - - - - B is the action - the way in which your AWS resource is being accessed or modified, such - as sending a message to an Amazon SQS queue, or storing an object in an Amazon S3 bucket. - - - - C is the resource - your AWS entity that the principal wants to access, such - as an Amazon SQS queue, or an object stored in Amazon S3. - - - - D is the set of conditions - optional constraints that specify when to allow or deny - access for the principal to access your resource. Many expressive conditions are available, - some specific to each service. For example you can use date conditions to allow access to - your resources only after or before a specific time. - - - - - - Note that an AWS access control policy should not be confused with the - similarly named "POST form policy" concept used in Amazon S3. - - - - - - The default policy version - - - - - Constructs an empty AWS access control policy ready to be populated with - statements. - - - - - Constructs a new AWS access control policy with the specified policy ID. - The policy ID is a user specified string that serves to help developers - keep track of multiple polices. Policy IDs are often used as a human - readable name for a policy. - - The policy ID for the new policy object. Policy IDs serve to - help developers keep track of multiple policies, and are often - used to give the policy a meaningful, human readable name. - - - - Constructs a new AWS access control policy with the specified policy ID - and collection of statements. The policy ID is a user specified string - that serves to help developers keep track of multiple polices. Policy IDs - are often used as a human readable name for a policy. - - The policy ID for the new policy object. Policy IDs serve to - help developers keep track of multiple policies, and are often - used to give the policy a meaningful, human readable name. - The statements to include in the new policy. - - - - Gets and Sets the policy ID for this policy. Policy IDs serve to help - developers keep track of multiple policies, and are often used as human - readable name for a policy. - - - - - Sets the policy ID for this policy and returns the updated policy so that - multiple calls can be chained together. - - Policy IDs serve to help developers keep track of multiple policies, and - are often used as human readable name for a policy. - - - The polich ID for this policy - this instance - - - - Gets and sets the version of this AWS policy. - - - - - Gets and Sets the collection of statements contained by this policy. Individual - statements in a policy are what specify the rules that enable or disable - access to your AWS resources. - - - - - Checks to see if the permissions set in the statement are already set by another - statement in the policy. - - The statement to verify - True if the statement's permissions are already allowed by the statement - - - - Sets the collection of statements contained by this policy and returns - this policy object so that additional method calls can be chained - together. - - Individual statements in a policy are what specify the rules that enable - or disable access to your AWS resources. - - - The collection of statements included in this policy. - this instance - - - - Returns a JSON string representation of this AWS access control policy, - suitable to be sent to an AWS service as part of a request to set an - access control policy. - - A JSON string representation of this AWS access control policy. - - - - Returns a JSON string representation of this AWS access control policy, - suitable to be sent to an AWS service as part of a request to set an - access control policy. - - Toggle pretty print for the generated JSON document - A JSON string representation of this AWS access control policy. - - - - Parses a JSON document of a policy and creates a Policy object. - - JSON document of a policy. - - - - - A principal is an AWS account which is being allowed or denied access to a - resource through an access control policy. The principal is a property of the - Statement object, not directly the object. - - The principal is A in the statement - "A has permission to do B to C where D applies." - - - In an access control policy statement, you can set the principal to all - authenticated AWS users through the member. This - is useful when you don't want to restrict access based on the identity of the - requester, but instead on other identifying characteristics such as the - requester's IP address. - - - - - - Principal instance that includes all authenticated AWS users. - - This is useful when you don't want to restrict access based on the - identity of the requester, but instead on other identifying - characteristics such as the requester's IP address. - - - - - - The anonymous Principal. - - - - - The default Principal provider for AWS accounts. - - - - - Principal provider for Canonical User IDs. - - - - - Principal provider for federated users (using a SAML identity provider) - - - - - Principal provider for assume role policies that will be assumed by an AWS service - (e.g. "ec2.amazonaws.com"). - - - - - Dummy principal provider for anonynous. - - - - - Constructs a new principal with the specified AWS account ID. - - An AWS account ID. - - - - Constructs a new principal with the specified provider and id - - The provider of the principal - The unique ID of the Principal within the provider - - - - Constructs a new principal with the specified provider and id - and optionally strips hyphens from the id - - The provider of the principal - The unique ID of the Principal within the provider - Strip hyphen - - - - Gets and sets the provider for this principal, which indicates in what group of - users this principal resides. - - - - - Gets the unique ID for this principal. - - - - - Represents a resource involved in an AWS access control policy statement. - Resources are the service specific AWS entities owned by your account. Amazon - SQS queues, Amazon S3 buckets and objects, and Amazon SNS topics are all - examples of AWS resources. - - The standard way of specifying an AWS resource is with an Amazon Resource - Name (ARN). - - - The resource is C in the statement - "A has permission to do B to C where D applies." - - - - - - Constructs a new AWS access control policy resource. Resources are - typically specified as Amazon Resource Names (ARNs). - - You specify the resource using the following Amazon Resource Name (ARN) - format: arn:aws:<vendor>:<region>:<namespace>:<relative-id> - - - >vendor identifies the AWS product (e.g., sns) - - - region is the AWS Region the resource resides in (e.g., us-east-1), if any - - - namespace is the AWS account ID with no hyphens (e.g., 123456789012) - - - relative-id is the service specific portion that identifies the specific resource - - - - - For example, an Amazon SQS queue might be addressed with the following - ARN: arn:aws:sqs:us-east-1:987654321000:MyQueue - - - Some resources may not use every field in an ARN. For example, resources - in Amazon S3 are global, so they omit the region field: - arn:aws:s3:::bucket/* - - - The Amazon Resource Name (ARN) uniquely identifying the desired AWS resource. - - - - Gets the resource ID, typically an Amazon Resource Name (ARN), - identifying this resource. - - - - - A factory for creating resources to be used in the policy. - - - - - Constructs a new bucket resource that represents the the specified bucket - but not any of the contained objects. - - The name of the bucket represented by this AWS access control - policy resource. - - - - Constructs a new object resource that represents the specified objects. - The keyPattern argument may contain the '*' wildcard to match multiple - objects. For example, an object resource created for bucket 'mybucket' - and key pattern 'foo*' will match any object stored in 'mybucket' with a - key that starts with 'foo'. - - The name of the bucket containing the object or objects - represented by this resource. - The key or key pattern, which can optionally contain the '*' - wildcard to include multiple objects in the resource. - - - - Constructs a new SQS queue resource for an access control policy. A - policy statement using this resource will allow or deny actions on the - specified queue. - - The AWS account ID of the queue owner. - The name of the Amazon SQS queue. - - - - A statement is the formal description of a single permission, and is always - contained within a policy object. - - A statement describes a rule for allowing or denying access to a specific AWS - resource based on how the resource is being accessed, and who is attempting - to access the resource. Statements can also optionally contain a list of - conditions that specify when a statement is to be honored. - - - For example, consider a statement that: - - - A is the prinicpal - The AWS account that is making a request to - access or modify one of your AWS resources. - - - - B is the action - the way in which your AWS resource is being accessed or modified, such - as sending a message to an Amazon SQS queue, or storing an object in an Amazon S3 bucket. - - - - C is the resource - your AWS entity that the principal wants to access, such - as an Amazon SQS queue, or an object stored in Amazon S3. - - - - D is the set of conditions - optional constraints that specify when to allow or deny - access for the principal to access your resource. Many expressive conditions are available, - some specific to each service. For example you can use date conditions to allow access to - your resources only after or before a specific time. - - - - - - There are many resources and conditions available for use in statements, and - you can combine them to form fine grained custom access control polices. - - - - - - The effect is the result that you want a policy statement to return at - evaluation time. A policy statement can either allow access or explicitly - deny access. - - - - - Constructs a new access control policy statement with the specified - effect. - - Before a statement is valid and can be sent to AWS, callers must set the - principals, resources, and actions (as well as any optional conditions) - involved in the statement. - - - The effect this statement has (allowing access or denying - access) when all conditions, resources, principals, and - actions are matched. - - - - Gets and Sets the ID for this statement. Statement IDs serve to help keep track - of multiple statements, and are often used to give the statement a - meaningful, human readable name. - - Developers should be careful to not use the same statement ID for - multiple statements in the same policy. Reusing the same statement ID in - different policies is not a problem. - - - - - - Sets the ID for this statement and returns the updated statement so - multiple calls can be chained together. - - Statement IDs serve to help keep track of multiple statements, and are - often used to give the statement a meaningful, human readable name. - - - Developers should be careful to not use the same statement ID for - multiple statements in the same policy. Reusing the same statement ID in - different policies is not a problem. - - - The new statement ID for this statement. - this instance - - - - Gets and Sets the result effect of this policy statement when it is evaluated. - A policy statement can either allow access or explicitly - - - - - Gets and Sets the list of actions to which this policy statement applies. - Actions limit a policy statement to specific service operations that are - being allowed or denied by the policy statement. For example, you might - want to allow any AWS user to post messages to your SQS queue using the - SendMessage action, but you don't want to allow those users other actions - such as ReceiveMessage or DeleteQueue. - - - - - Sets the list of actions to which this policy statement applies and - returns this updated Statement object so that additional method calls can - be chained together. - - Actions limit a policy statement to specific service operations that are - being allowed or denied by the policy statement. For example, you might - want to allow any AWS user to post messages to your SQS queue using the - SendMessage action, but you don't want to allow those users other actions - such as ReceiveMessage or DeleteQueue. - - - The list of actions to which this statement applies. - this instance - - - - Gets and Sets the resources associated with this policy statement. Resources - are what a policy statement is allowing or denying access to, such as an - Amazon SQS queue or an Amazon SNS topic. - - Note that some services allow only one resource to be specified per - policy statement. - - - - - - Sets the resources associated with this policy statement and returns this - updated Statement object so that additional method calls can be chained - together. - - Resources are what a policy statement is allowing or denying access to, - such as an Amazon SQS queue or an Amazon SNS topic. - - - Note that some services allow only one resource to be specified per - policy statement. - - - The resources associated with this policy statement. - this instance - - - - Gets and Sets the conditions associated with this policy statement. Conditions - allow policy statements to be conditionally evaluated based on the many - available condition types. - - For example, a statement that allows access to an Amazon SQS queue could - use a condition to only apply the effect of that statement for requests - that are made before a certain date, or that originate from a range of IP - addresses. - - - When multiple conditions are included in a single statement, all - conditions must evaluate to true in order for the statement to take - effect. - - - - - - Sets the conditions associated with this policy statement, and returns - this updated Statement object so that additional method calls can be - chained together. - - Conditions allow policy statements to be conditionally evaluated based on - the many available condition types. - - - For example, a statement that allows access to an Amazon SQS queue could - use a condition to only apply the effect of that statement for requests - that are made before a certain date, or that originate from a range of IP - addresses. - - - Multiple conditions can be included in a single statement, and all - conditions must evaluate to true in order for the statement to take - effect. - - - The conditions associated with this policy statement. - this instance - - - - Gets and Sets the principals associated with this policy statement, indicating - which AWS accounts are affected by this policy statement. - - - - - Sets the principals associated with this policy statement, and returns - this updated Statement object. Principals control which AWS accounts are - affected by this policy statement. - - If you don't want to restrict your policy to specific users, you can use - to apply the policy to any user trying to - access your resource. - - - The list of principals associated with this policy statement. - this instance - - - - The available AWS access control policy actions for Amazon AppStream. - - - - - - The available AWS access control policy actions for Auto Scaling. - - - - - - The available AWS access control policy actions for AWS Billing. - - - - - - The available AWS access control policy actions for AWS CloudFormation. - - - - - - The available AWS access control policy actions for Amazon CloudFront. - - - - - - The available AWS access control policy actions for Amazon CloudSearch. - - - - - - The available AWS access control policy actions for AWS CloudTrail. - - - - - - The available AWS access control policy actions for Amazon CloudWatch. - - - - - - The available AWS access control policy actions for Amazon CloudWatch Logs. - - - - - - The available AWS access control policy actions for Amazon Cognito Identity. - - - - - - The available AWS access control policy actions for Amazon Cognito Sync. - - - - - - The available AWS access control policy actions for AWS Direct Connect. - - - - - - The available AWS access control policy actions for Amazon DynamoDB. - - - - - - The available AWS access control policy actions for Amazon EC2. - - - - - - The available AWS access control policy actions for AWS ElastiCache. - - - - - - The available AWS access control policy actions for AWS Elastic Beanstalk. - - - - - - The available AWS access control policy actions for Elastic Load Balancing. - - - - - - The available AWS access control policy actions for Amazon Elastic MapReduce. - - - - - - The available AWS access control policy actions for Amazon Elastic Transcoder. - - - - - - The available AWS access control policy actions for Amazon Glacier. - - - - - - The available AWS access control policy actions for AWS Identity and Access Management. - - - - - - The available AWS access control policy actions for AWS Import Export. - - - - - - The available AWS access control policy actions for Amazon Kinesis. - - - - - - The available AWS access control policy actions for AWS Marketplace. - - - - - - The available AWS access control policy actions for AWS Marketplace Management Portal. - - - - - - The available AWS access control policy actions for Amazon Mobile Analytics. - - - - - - The available AWS access control policy actions for AWS OpsWorks. - - - - - - The available AWS access control policy actions for Amazon RDS. - - - - - - The available AWS access control policy actions for Amazon Redshift. - - - - - - The available AWS access control policy actions for Amazon Route 53. - - - - - - The available AWS access control policy actions for Amazon S3. - - - - - - The available AWS access control policy actions for AWS Security Token Service. - - - - - - The available AWS access control policy actions for Amazon SES. - - - - - - The available AWS access control policy actions for Amazon SimpleDB. - - - - - - The available AWS access control policy actions for Amazon Simple Workflow Service. - - - - - - The available AWS access control policy actions for Amazon SNS. - - - - - - The available AWS access control policy actions for Amazon SQS. - - - - - - The available AWS access control policy actions for Amazon Storage Gateway. - - - - - - The available AWS access control policy actions for AWS Whispersync. - - - - - - The available AWS access control policy actions for Amazon Zocalo. - - - - - - Deserializes a JSON string into a AWS policy object. - - - - - Serializes an AWS policy object to a JSON string, suitable for sending to an - AWS service. - - - - Converts the specified AWS policy object to a JSON string, suitable for - passing to an AWS service. - - @param policy - The AWS policy object to convert to a JSON string. - - @return The JSON string representation of the specified policy object. - - @throws IllegalArgumentException - If the specified policy is null or invalid and cannot be - serialized to a JSON string. - - - - Uses the specified generator to write the JSON data for the principals in - the specified policy statement. - - - - - This sorts the conditions by condition type and key with the list of values for that combination. - - The list of conditions to be sorted. - - - - - Exception thrown by the SDK for errors that occur within the SDK. - - - - - This exception is thrown when there is a parse error on the response back from AWS. - - - - - The string value which could not be converted into a valid DateTime instance. - - - - - Occurs before a request is marshalled. - - - - - Occurs before a request is issued against the service. - - - - - Occurs after a response is received from the service. - - - - - Occurs after an exception is encountered. - - - - - Patches the in-flight uri to stop it unescaping the path etc (what Uri did before - Microsoft deprecated the constructor flag). This is particularly important for - Amazon S3 customers who want to use backslash (\) in their key names. - - - Different behavior in the various runtimes has been observed and in addition some - 'documented' ways of doing this between 2.x and 4.x runtimes has also been observed - to not be reliable. - - This patch effectively emulates what adding a schemesettings element to the - app.config file with value 'name="http" genericUriParserOptions="DontUnescapePathDotsAndSlashes"' - does. As we're a dll, that avenue is not open to us. - - - - - - Used to create a copy of the config for a different service than the current instance. - - Target service ClientConfig - The new ClientConfig for the desired service - - - - A base exception for some Amazon Web Services. - - Most exceptions thrown to client code will be service-specific exceptions, though some services - may throw this exception if there is a problem which is caught in the core client code. - - - - - - Whether the error was attributable to Sender or Reciever. - - - - - The error code returned by the service - - - - - The id of the request which generated the exception. - - - - - The HTTP status code from the service response - - - - - Flag indicating if the exception is retryable and the associated retry - details. A null value indicates that the exception is not retryable. - - - - - Class containing the retryable details for an AmazonServiceException - - - - - This property indicates that this exception is a - throttling exception and should be subject to congestion - control throttling. - - - - - This exception is thrown when there is a parse error on the response back from AWS. - - - - - Last known location in the response that was parsed, if available. - - - - - The entire response body that caused this exception, if available. - - - - - Base class for request used by some of the services. - - - - - This flag specifies if SigV4 will be used for the current request. - - - - - Gets or Sets a value indicating if "Expect: 100-continue" HTTP header will be - sent by the client for this request. The default value is false. - - - - - Gets the signer to use for this request. - A null return value indicates to use the configured - signer for the service that this request is part of. - - A signer for this request, or null. - - - - Abstract class for Response objects, contains only metadata, - and no result information. - - - - - Contains additional information about the request, such as the - Request Id. - - - - - Returns the content length of the HTTP response. - - - - - Returns the status code of the HTTP response. - - - - - Base class for determining region based on inspection. - - - - - Sets the Region property by looking up the corresponding RegionEndpoint - from the supplied region system name (us-east-1, us-west-2 etc). - - The system name of the region. - - - - Determines region based on application configuration settings. If the configuration does not contain - the region setting key an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of ApplicationConfigAWSRegion. If no region is found in the - application configuration file then an InvalidOperationException is thrown. - - - - - Probing mechanism to determine region from various sources. - - - - - This class is responsible for keeping track of Retry capacity across different ServiceURLs. - - - - - CapacityType determines the type of capacity to obtain or use. - - - - - The increment capacity type adds capacity. - - - - - The default retry capacity type uses the default capacity amount. - - - - - The timeout capacity type uses the timeout capacity amount. - - - - - This method acquires a said retry capacity if the container has the capacity. - - Contains the RetryCapacity object for the said ServiceURL. - - - - This method acquires a said retry capacity if the container has the capacity. - - Contains the RetryCapacity object for the said ServiceURL. - Specifies what capacity type cost to use for obtaining capacity - - - - This method calls a method to release capacity back - based on whether it was a successful response or a successful retry response. This is invoked by a retry request response. - - if this request is a retry, use a different capacity cost - Contains the RetryCapacity object for the said ServiceURL. - - - - This method calls a method to release capacity back - based on whether it was a successful response or a successful retry response. This is invoked by a retry request response. - - Specifies what capacity type cost to use for adding capacity - Contains the RetryCapacity object for the said ServiceURL. - - - - Ths method fetches the RetryCapacity for the given ServiceURL from CapacityManager.CapacityContainer - - - - - This method releases capacity back. This is invoked by the TryReleaseCapacity method. - - Contains the RetryCapacity object for the said ServiceURL. - The capacity that needs to be released based on whether it was a successful response or a successful retry response. - - - - This class is the RetryCapacity class for a given ServiceURL. - - - - - This class composes Client Context header for Amazon Web Service client. - It contains information like app title, version code, version name, client id, OS platform etc. - - - This class composes Client Context header for Amazon Web Service client. - It contains information like app title, version code, version name, client id, OS platform etc. - - - - - Adds the custom attributes to the Client Context. - - Key. - Value. - - - - Gets a Json Representation of the Client Context. - - Json Representation of Client Context - - - - Collection of parameters that an SDK client will send to a service. - - - - - Constructs empty ParameterCollection. - - - - - Adds a parameter with a string value. - - - - - - - Adds a parameter with a list-of-strings value. - - - - - - - Converts the current parameters into a list of key-value pairs. - - - - - - This class is responsible for managing adaptive retry mode client rate limiting. - - - - - The rate at which token are replenished. - - - - - The maximum capacity allowed in the token - - - - - The current capacity of the token - - - - - The last time the token bucket was refilled. - - - - - The smoothed rate which tokens are being retrieved. - - - - - The last half second time bucket used. - - - - - The number of requests seen within the current time - - - - - The maximum rate when the client was last throttled. - - - - - The last time when the client was throttled. - - - - - The cached time window calculation - - - - - Boolean indicating if the token bucket is enabled. - - - - - This method attempts to acquire capacity from the client's token - - The amount of capacity to obtain from the token bucket - Indicates that the client should or shouldn't sleep and - try again if capacity cannot be obtained. - - - - - This method attempts to acquire capacity from the client's token - - The amount of capacity to obtain from the token bucket - Indicates that the client should or shouldn't sleep and - try again if capacity cannot be obtained. - - Token which can be used to cancel the task. - - - - Updates the sending rate within the client's token bucket - - Indicates if the request resulted in a throttling error. - - - - Calculates the rate - - - Returns the calculated rate for a successful call - - - - Calculates the rate. - - The rate to use in the calculation - Returns the calculated rate for a throttled call - - - - Collection used to indicate if the property was initialized was created by the SDK. - - - - - - Collection used to indicate if the property was initialized was created by the SDK. - - - - - - - Default implementation of the IRequest interface. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Constructs a new DefaultRequest with the specified service name and the - original, user facing request object. - - The orignal request that is being wrapped - The service name - - - - The name of the request - - - - - Gets and sets the type of http request to make, whether it should be POST,GET or DELETE - - - - - Gets and sets a flag that indicates whether the request is sent as a query string instead of the request body. - - - - - Returns the original, user facing request object which this internal - request object is representing. - - - - - Returns a dictionary of the headers included in this request. - - - - - Returns a dictionary of the parameters included in this request. - - - - - Collection of parameters included in this request. - - - - - Returns the subresources that should be appended to the resource path. - This is used primarily for Amazon S3, where object keys can contain '?' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new null entry to the SubResources collection for the request - - The name of the subresource - - - - Adds a new entry to the SubResources collection for the request - - The name of the subresource - Value of the entry - - - - Gets and Sets the endpoint for this request. - - - - - Gets and Sets the resource path added on to the endpoint. - - - - - Returns the path resources that should be used within the resource path. - This is used for services where path keys can contain '/' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new entry to the PathResources collection for the request - - The name of the pathresource with potential greedy syntax: {key+} - Value of the entry - - - - Gets and Sets the version number for the marshaller used to create this request. The version number - is used to support backward compatible changes that would otherwise be breaking changes when a - newer core is used with an older service assembly. - Versions: - 1 - Default version - 2 - Support for path segments - - - - - Gets and Sets the content for this request. - - - - - Flag that signals that Content was and should be set - from the Parameters collection. - - - - - Gets and sets the content stream. - - - - - Gets and sets the original stream position. - If ContentStream is null or does not support seek, this propery - should be equal to -1. - - - - - Computes the SHA 256 hash of the content stream. If the stream is not - seekable, it searches the parent stream hierarchy to find a seekable - stream prior to computation. Once computed, the hash is cached for future - use. If a suitable stream cannot be found to use, null is returned. - - - - - The name of the service to which this request is being sent. - - - - - Alternate endpoint to use for this request, if any. - - - - - Host prefix value to prepend to the endpoint for this request, if any. - - - - - Gets and sets the Suppress404Exceptions property. If true then 404s return back from AWS will not cause an exception and - an empty response object will be returned. - - - - - If using AWS4 signing protocol, contains the resultant parts of the - signature that we may need to make use of if we elect to do a chunked - encoding upload. - - - - - Determine whether to use a chunked encoding upload for the request - (applies to Amazon S3 PutObject and UploadPart requests only). - - - - - - Used for Amazon S3 requests where the bucket name is removed from - the marshalled resource path into the host header. To comply with - AWS2 signature calculation, we need to recover the bucket name - and include it in the resource canonicalization, which we do using - this field. - - - - - This flag specifies if SigV4 is required for the current request. - - - - - The authentication region to use for the request. - Set from Config.AuthenticationRegion. - - - - - The region in which the service request was signed. - - - - - Checks if the request stream can be rewinded. - - Returns true if the request stream can be rewinded , - else false. - - - - Returns true if the request can contain a request body, else false. - - Returns true if the currect request can contain a request body, else false. - - - - Returns true if the request has a body, else false. - - Returns true if the request has a body, else false. - - - - Class containing the data for one endpoint returned from a endpoint discovery request - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Constructs a new DiscoveryEndpoint - - The address of the endpoint - The cache period for the endpoint in minutes - - - - The address of the endpoint. - - - - - The cache period for the endpoint in minutes - - - - - Calculates if this endpoint has expired - - A boolean value indicating if the cache period has expired - - - - Extends the endpoint expiration by the specified number of minutes from now. - - - - - Class containing the data for one endpoint returned from a endpoint discovery request - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class containing the data to use with endpoint discovery - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Gets/sets and flag indicating if endpoint discovery is required for the request. - - - - - Sorted dictionary of the identifiers that must be sent with the endpoint discovery request. These - identifiers are used to construct the cache key for the cache that stores discovered endpoints. A - sorted dictionary is used instead of a dictionary to ensure the cache key comes out in the same order - each time it is constructed. - - - - - Represents the data to be used with endpoint discovery operations - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class used to resolve endpoints using Endpoint Discovery. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Method that performs endpoint discovery for the current operation - - Context information used in calculations for endpoint discovery - The operation to fetch endpoints from the server - - - - - Gets the number of cache keys in the cache - - - - - Class used to resolve endpoints using Endpoint Discovery. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class containing context information to use with endpoint discovery - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Gets the customer credential information. - - - - - Gets the operation name. - - - - - Gets the current marshalled endpoint discovery data. - - - - - Gets the flag indicating if the specified key should be evicted from the cache. - - - - - Gets the Uri that should be evicted if EvictCacheKey is set to true. - - - - - Class containing context information to use with endpoint discovery - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Error type, one of Sender, Receiver, Unknown - Only applies to XML-based services. - - - - - Name of the exception class to return - - - - - Error message - - - - - RequestId of the error. - Only applies to XML-based services. - - - - - InternalConfiguration holds the cached SDK configuration values - obtained from the environment and profile configuration - factories. These configuration values are loaded internally and - are not the same as user exposed AWSConfigs. - - - - - Flag indicating if Endpoint Discovery is enabled. - - - - - The retry mode to use: Legacy, Standard, or Adaptive. - - - - - The max number of request attempts. - - - - - Probing mechanism to determine the configuration values from various sources. - - - - - Resets all the configuration values reloading as needed. This method will use - the AWS_PROFILE environment variable if set to construct the instance. Otherwise - the default profile will be used. - - - - - Flag that specifies if endpoint discovery is enabled, disabled, - or not set. - - - - - Flag that specifies which retry mode to use or if retry mode has - not been set. - - - - - Flag that specifies the max number of request attempts or if max - attempts has not been set. - - - - - Class containing the members used to invoke service calls - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class containing the members used to invoke service calls - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Represents a request being sent to an Amazon Web Service, including the - parameters being sent as part of the request, the endpoint to which the - request should be sent, etc. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - The name of the request - - - - - Returns a dictionary of the headers included in this request. - - - - - Gets and sets a flag that indicates whether the request is sent as a query string instead of the request body. - - - - - Returns a dictionary of the parameters included in this request. - - - - - Collection of parameters included in this request. - - - - - Returns the subresources that should be appended to the resource path. - This is used primarily for Amazon S3, where object keys can contain '?' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new null entry to the SubResources collection for the request - - The name of the subresource - - - - Adds a new entry to the SubResources collection for the request - - The name of the subresource - Value of the entry - - - - Gets and sets the type of http request to make, whether it should be POST,GET or DELETE - - - - - Gets and Sets the endpoint for this request. - - - - - Gets and Sets the resource path added on to the endpoint. - - - - - Returns the path resources that should be used within the resource path. - This is used for services where path keys can contain '/' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new entry to the PathResources collection for the request - - The name of the pathresource with potential greedy syntax: {key+} - Value of the entry - - - - Gets and Sets the version number for the marshaller used to create this request. The version number - is used to support backward compatible changes that would otherwise be breaking changes when a - newer core is used with an older service assembly. - - - - - Gets and Sets the content for this request. - - - - - Gets the header value from the request. - - - - - Flag that signals that Content was and should be set - from the Parameters collection. - - - - - Gets and sets the content stream. - - - - - Gets and sets the original stream position. - If ContentStream is null or does not support seek, this propery - should be equal to -1. - - - - - Computes the SHA 256 hash of the content stream. If the stream is not - seekable, it searches the parent stream hierarchy to find a seekable - stream prior to computation. Once computed, the hash is cached for future - use. - - - - - The name of the service to which this request is being sent. - - - - - Returns the original, user facing request object which this internal - request object is representing. - - - - - Alternate endpoint to use for this request, if any. - - - - - Host prefix value to prepend to the endpoint for this request, if any. - - - - - Gets and sets the Suppress404Exceptions property. If true then 404s return back from AWS will not cause an exception and - an empty response object will be returned. - - - - - If using AWS4 signing protocol, contains the resultant parts of the - signature that we may need to make use of if we elect to do a chunked - encoding upload. - - - - - Determine whether to use a chunked encoding upload for the request - (applies to Amazon S3 PutObject and UploadPart requests only). - - - - - - Used for Amazon S3 requests where the bucket name is removed from - the marshalled resource path into the host header. To comply with - AWS2 signature calculation, we need to recover the bucket name - and include it in the resource canonicalization, which we do using - this field. - - - - - This flag specifies if SigV4 is required for the current request. - - - - - The authentication region to use for the request. - Set from Config.AuthenticationRegion. - - - - - The region in which the service request was signed. - - - - - Checks if the request stream can be rewinded. - - Returns true if the request stream can be rewinded , - else false. - - - - Returns true if the request can contain a request body, else false. - - Returns true if the currect request can contain a request body, else false. - - - - Returns true if the request has a body, else false. - - Returns true if the request has a body, else false. - - - - Gets the value of the Service Id. - - - - - Gets the dictionary that gives mapping of renamed operations - - - - - IDictionary{String, String} access to ParameterCollection. - TODO: remove this class in version 3.4 of the SDK. - - - - - Constructs ParametersDictionaryFacade for a ParameterCollection - - - - - - A registry of object that will manipulate the runtime pipeline used by service clients. - - - - - Registers a customizer that will be applied for all service clients created. Each customizer has a unique name associated with it. If a customizer is registered more - than once with the same unique name then the calls after the first will be ignored. - - - - - - Deregistered the runtime pipeline customizer - - - - - - Deregistered the runtime pipeline customizer - - - - - - Applies all of the registered customizers on the runtime pipeline - - The service clients runtime pipeline. - Type object for the service client being created - - - - Interface for objects that will customize the runtime pipleine for newly created service clients. - - - - - The unique name for the customizer that identifies the customizer in the registry. The name is also used to identify the customizer on the SDK logs. - - - - - Called on service clients as they are being constructed to customize their runtime pipeline. - - - Type object for the service client being created - - - - Default ServiceMetadata implementation. - This implementation will be used if the service doesn't have a - IServiceMetadata implementation. - - - - - Gets the value of the Service Id. - - - - - Gets the dictionary that gives mapping of renamed operations - - - - - Computes RFC 2104-compliant HMAC signature. - - - - - Computes RFC 2104-compliant HMAC signature. - - - - - Inspects the supplied evidence to return the signer appropriate for the operation - - Global setting for the service - The request. - Configuration for the client - True if signature v4 request signing should be used - - - - Signs the specified request with the AWS3 signing protocol by using the - AWS account credentials given in the method parameters. - - The AWS public key - The AWS secret key used to sign the request in clear text - Request metrics - The configuration that specifies which hashing algorithm to use - The request to have the signature compute for - If any problems are encountered while signing the request - - - - AWS4 protocol signer for service calls that transmit authorization in the header field "Authorization". - - - - - Calculates and signs the specified request using the AWS4 signing protocol by using the - AWS account credentials given in the method parameters. The resulting signature is added - to the request headers as 'Authorization'. Parameters supplied in the request, either in - the resource path as a query string or in the Parameters collection must not have been - uri encoded. If they have, use the SignRequest method to obtain a signature. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. - - - Client configuration data encompassing the service call (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text. - - - If any problems are encountered while signing the request. - - - - - Calculates and signs the specified request using the AWS4 signing protocol by using the - AWS account credentials given in the method parameters. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. - - - Client configuration data encompassing the service call (notably authentication - region, endpoint and service name). - - - Metrics for the request. - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text. - - - If any problems are encountered while signing the request. - - - Parameters passed as part of the resource path should be uri-encoded prior to - entry to the signer. Parameters passed in the request.Parameters collection should - be not be encoded; encoding will be done for these parameters as part of the - construction of the canonical request. - - - - - Sets the AWS4 mandated 'host' and 'x-amz-date' headers, returning the date/time that will - be used throughout the signing process in various elements and formats. - - The current set of headers - - Date and time used for x-amz-date, in UTC - - - - Sets the AWS4 mandated 'host' and 'x-amz-date' headers, accepting and returning the date/time that will - be used throughout the signing process in various elements and formats. - - The current set of headers - - - Date and time used for x-amz-date, in UTC - - - - Computes and returns an AWS4 signature for the specified canonicalized request - - - - - - - - - - - - Computes and returns an AWS4 signature for the specified canonicalized request - - - - - - - - - - - - - Computes and returns an AWS4 signature for the specified canonicalized request - - - - - - - - - - - - - - Formats the supplied date and time for use in AWS4 signing, where various formats are used. - - - The required format - The UTC date/time in the requested format - - - - Compute and return the multi-stage signing key for the request. - - The clear-text AWS secret key, if not held in secureKey - The region in which the service request will be processed - Date of the request, in yyyyMMdd format - The name of the service being called by the request - Computed signing key - - - - If the caller has already set the x-amz-content-sha256 header with a pre-computed - content hash, or it is present as ContentStreamHash on the request instance, return - the value to be used in request canonicalization. - If not set as a header or in the request, attempt to compute a hash based on - inspection of the style of the request content. - - - - The computed hash, whether already set in headers or computed here. Null - if we were not able to compute a hash. - - - - - If signPayload is false set the x-amz-content-sha256 header to - the UNSIGNED-PAYLOAD magic string and return it. - Otherwise, if the caller has already set the x-amz-content-sha256 header with a pre-computed - content hash, or it is present as ContentStreamHash on the request instance, return - the value to be used in request canonicalization. - If not set as a header or in the request, attempt to compute a hash based on - inspection of the style of the request content. - - - - - The computed hash, whether already set in headers or computed here. Null - if we were not able to compute a hash. - - - - - Returns the HMAC256 for an arbitrary blob using the specified key - - - - - - - - Returns the HMAC256 for an arbitrary blob using the specified key - - - - - - - - Compute and return the hash of a data blob using the specified key - - Algorithm to use for hashing - Hash key - Data blob - Hash of the data - - - - Compute and return the hash of a data blob using the specified key - - Algorithm to use for hashing - Hash key - Data blob - Hash of the data - - - - Computes the non-keyed hash of the supplied data - - - - - - - Computes the non-keyed hash of the supplied data - - - - - - - Computes and returns the canonical request - - The endpoint URL - the path of the resource being operated on - The http method used for the request - The full request headers, sorted into canonical order - The query parameters for the request - - The hash of the binary request body if present. If not supplied, the routine - will look for the hash as a header on the request. - - Canonicalised request as a string - - - - Computes and returns the canonical request - - The endpoint URL - the path of the resource being operated on - The http method used for the request - The full request headers, sorted into canonical order - The query parameters for the request - - The path resource values lookup to use to replace the keys within resourcePath - The hash of the binary request body if present. If not supplied, the routine - will look for the hash as a header on the request. - - The version of the marshaller that constructed the request object. - Canonicalised request as a string - - - - Computes and returns the canonical request - - The endpoint URL - the path of the resource being operated on - The http method used for the request - The full request headers, sorted into canonical order - The query parameters for the request - - The path resource values lookup to use to replace the keys within resourcePath - The hash of the binary request body if present. If not supplied, the routine - will look for the hash as a header on the request. - - The version of the marshaller that constructed the request object. - The service being called for the request - Canonicalised request as a string - - - - Reorders the headers for the request for canonicalization. - - The set of proposed headers for the request - List of headers that must be included in the signature - For AWS4 signing, all headers are considered viable for inclusion - - - - Computes the canonical headers with values for the request. Only headers included in the signature - are included in the canonicalization process. - - All request headers, sorted into canonical order - Canonicalized string of headers, with the header names in lower case. - - - - Returns the set of headers included in the signature as a flattened, ;-delimited string - - The headers included in the signature - Formatted string of header names - - - - Collects the subresource and query string parameters into one collection - ready for canonicalization - - The in-flight request being signed - The fused set of parameters - - - - Computes and returns the canonicalized query string, if query parameters have been supplied. - Parameters with no value will be canonicalized as 'param='. The expectation is that parameters - have not already been url encoded prior to canonicalization. - - The set of parameters being passed on the uri - - Parameters must be uri encoded into the canonical request and by default the signer expects - that the supplied collection contains non-encoded data. Set this to false if the encoding was - done prior to signer entry. - - The uri encoded query string parameters in canonical ordering - - - - Computes and returns the canonicalized query string, if query parameters have been supplied. - Parameters with no value will be canonicalized as 'param='. The expectation is that parameters - have not already been url encoded prior to canonicalization. - - The set of parameters to be encoded in the query string - - Parameters must be uri encoded into the canonical request and by default the signer expects - that the supplied collection contains non-encoded data. Set this to false if the encoding was - done prior to signer entry. - - The uri encoded query string parameters in canonical ordering - - - - Returns the request parameters in the form of a query string. - - The request instance - Request parameters in query string format - - - - AWS4 protocol signer for Amazon S3 presigned urls. - - - - - Calculates and signs the specified request using the AWS4 signing protocol by using the - AWS account credentials given in the method parameters. The resulting signature is added - to the request headers as 'Authorization'. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. - - - Adding supporting data for the service call required by the signer (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text - - - If any problems are encountered while signing the request. - - - - - Calculates the AWS4 signature for a presigned url. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. If the Expires parameter - is present, it is renamed to 'X-Amz-Expires' before signing. - - - Adding supporting data for the service call required by the signer (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text - - - If any problems are encountered while signing the request. - - - Parameters passed as part of the resource path should be uri-encoded prior to - entry to the signer. Parameters passed in the request.Parameters collection should - be not be encoded; encoding will be done for these parameters as part of the - construction of the canonical request. - - - - - Calculates the AWS4 signature for a presigned url. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. If the Expires parameter - is present, it is renamed to 'X-Amz-Expires' before signing. - - - Adding supporting data for the service call required by the signer (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text - - - The service to sign for - - - The region to sign to, if null then the region the client is configured for will be used. - - - If any problems are encountered while signing the request. - - - Parameters passed as part of the resource path should be uri-encoded prior to - entry to the signer. Parameters passed in the request.Parameters collection should - be not be encoded; encoding will be done for these parameters as part of the - construction of the canonical request. - - The X-Amz-Content-SHA256 is cleared out of the request. - If the request is for S3 then the UNSIGNED_PAYLOAD value is used to generate the canonical request. - If the request isn't for S3 then the empty body SHA is used to generate the canonical request. - - - - - Encapsulates the various fields and eventual signing value that makes up - an AWS4 signature. This can be used to retrieve the required authorization string - or authorization query parameters for the final request as well as hold ongoing - signature computations for subsequent calls related to the initial signing. - - - - - Constructs a new signing result instance for a computed signature - - The access key that was included in the signature - Date/time (UTC) that the signature was computed - The collection of headers names that were included in the signature - Formatted 'scope' value for signing (YYYYMMDD/region/service/aws4_request) - Returns the key that was used to compute the signature - Computed signature - - - - The access key that was used in signature computation. - - - - - ISO8601 formatted date/time that the signature was computed - - - - - ISO8601 formatted date that the signature was computed - - - - - The ;-delimited collection of header names that were included in the signature computation - - - - - Formatted 'scope' value for signing (YYYYMMDD/region/service/aws4_request) - - - - - Returns a copy of the key that was used to compute the signature - - - - - Returns the hex string representing the signature - - - - - Returns a copy of the byte array containing the signature - - - - - Returns the signature in a form usable as an 'Authorization' header value. - - - - - Returns the signature in a form usable as a set of query string parameters. - - - - - Null Signer which does a no-op. - - - - - Signs the specified request with the AWS2 signing protocol by using the - AWS account credentials given in the method parameters. - - The AWS public key - The AWS secret key used to sign the request in clear text - Request metrics - The configuration that specifies which hashing algorithm to use - The request to have the signature compute for - If any problems are encountered while signing the request - - - - S3 signer constructor - - - - - S3 signer constructor - - - - - This exception is thrown if there are problems signing the request. - - - - - Response Unmarshaller for all Errors - - - - - Build an ErrorResponse from XML - - The XML parsing context. - Usually an Amazon.Runtime.Internal.UnmarshallerContext. - An ErrorResponse object. - - - - Return an instance of and ErrorResponseUnmarshaller. - - - - - - Interface for unmarshallers which unmarshall objects from response data. - The Unmarshallers are stateless, and only encode the rules for what data - in the XML stream goes into what members of an object. - - The type of object the unmarshaller returns - The type of the XML unmashaller context, which contains the - state during parsing of the XML stream. Usually an instance of - Amazon.Runtime.Internal.Transform.UnmarshallerContext. - - - - Given the current position in the XML stream, extract a T. - - The XML parsing context - An object of type T populated with data from the XML stream. - - - - Interface for unmarshallers which unmarshall service responses. - The Unmarshallers are stateless, and only encode the rules for what data - in the XML stream goes into what members of an object. - - The type of object the unmarshaller returns - The type of the XML unmashaller context, which contains the - state of parsing the XML stream. Uaually an instance of - Amazon.Runtime.Internal.Transform.UnmarshallerContext. - - - - Extracts an exeption with data from an ErrorResponse. - - The XML parsing context. - An inner exception to be included with the returned exception - The HttpStatusCode from the ErrorResponse - Either an exception based on the ErrorCode from the ErrorResponse, or the - general service exception for the service in question. - - - - Interface for unmarshallers which unmarshall objects from response data. - The Unmarshallers are stateless, and only encode the rules for what data - in the XML stream goes into what members of an object. - - The type of object the unmarshaller returns - The type of the XML unmashaller context, which contains the - state during parsing of the XML stream. Usually an instance of - Amazon.Runtime.Internal.Transform.UnmarshallerContext. - - - - Given the current position in the XML stream, extract a T. - - The XML parsing context - An object of type T populated with data from the XML stream. - - - - First-pass unmarshaller for all errors - - - - - Build an ErrorResponse from json - - The json parsing context. - Usually an Amazon.Runtime.Internal.JsonUnmarshallerContext. - An ErrorResponse object. - - - - Return an instance of JsonErrorResponseUnmarshaller. - - - - - - Wraps a json string for unmarshalling. - - Each Read() operation gets the next token. - TestExpression() is used to match the current key-chain - to an xpath expression. The general pattern looks like this: - - JsonUnmarshallerContext context = new JsonUnmarshallerContext(jsonString); - while (context.Read()) - { - if (context.IsKey) - { - if (context.TestExpresion("path/to/element")) - { - myObject.stringMember = stringUnmarshaller.GetInstance().Unmarshall(context); - continue; - } - } - } - - - - - - Wrap the jsonstring for unmarshalling. - - Stream that contains the JSON for unmarshalling - If set to true, maintains a copy of the complete response body constraint to log response size as the stream is being read. - Response data coming back from the request - If set to true, maintains a copy of the complete response body as the stream is being read. - - - - Are we at the start of the json document. - - - - - Is the current token the end of an object - - - - - Is the current token the start of an object - - - - - Returns the element depth of the parser's current position in the json - document being parsed. - - - - - The current Json path that is being unmarshalled. - - - - - Reads to the next token in the json document, and updates the context - accordingly. - - - True if a token was read, false if there are no more tokens to read. - - - - - Peeks at the next token. This peek implementation - reads the next token and makes the subsequent Read() return the same data. - If Peek is called successively, it will return the same data. - Only the first one calls Read(), subsequent calls - will return the same data until a Read() call is made. - - Token to peek. - Returns true if the peeked token matches given token. - - - - Returns the text contents of the current token being parsed. - - - The text contents of the current token being parsed. - - - - - The type of the current token - - - - - Get the base stream of the jsonStream. - - - - - Peeks at the next (non-whitespace) character in the jsonStream. - - The next (non-whitespace) character in the jsonStream, or -1 if at the end. - - - - Peeks at the next character in the stream. - If the data isn't buffered into the StreamReader (Peek() returns -1), - we flush the buffered data and try one more time. - - - - - - Abstract class for unmarshalling service responses. - - - - - Class for unmarshalling XML service responses. - - - - - Class for unmarshalling EC2 service responses. - - - - - Class for unmarshalling JSON service responses. - - - - - Unmarshaller for int fields - - - - - Unmarshaller for nullable int fields. Implemented only for JSON context - to handle cases where value can be null e.g. {'Priority': null}. - This unmarshaller is not implemented for XML context, as XML responses - will null elements (xsi:nil='true') will be skipped by the XML parser. - - - - - Unmarshaller for long fields - - - - - Unmarshaller for float fields - - - - - Unmarshaller for double fields - - - - - Unmarshaller for decimal fields - - - - - Unmarshaller for bool fields - - - - - Unmarshaller for string fields - - - - - Unmarshaller for byte fields - - - - - Unmarshaller for DateTime fields - - - - - Unmarshalls given string as a DateTime. Handles cases where we want to unmarshall - as just a DateTime or a nullable Datetime. - - Value to be parsed - If true, the method will return null if text is null. - If false, the method will return default(DateTime), if text is null. - - - - - Unmarshaller for nullable DateTime fields. Implemented only for JSON context - to handle cases where value can be null e.g. {'Priority': null}. - This unmarshaller is not implemented for XML context, as XML responses - will null elements (xsi:nil='true') will be skipped by the XML parser. - - - - - Unmarshaller for MemoryStream fields - - - - - Unmarshaller for ResponseMetadata - - - - - Base class for the UnmarshallerContext objects that are used - to unmarshall a web-service response. - - - - - Tests the specified expression against the current position in the XML - document - - The pseudo-XPath expression to test. - - True if the expression matches the current position in the document, - false otherwise. - - - - Tests the specified expression against the current position in the XML - document being parsed, and restricts the expression to matching at the - specified stack depth. - - The pseudo-XPath expression to test. - - The depth in the stack representing where the expression must - start matching in order for this method to return true. - - True if the specified expression matches the current position in - the XML document, starting from the specified depth. - - - - Reads the next token at depth greater than or equal to target depth. - - Tokens are read at depth greater than or equal to target depth. - True if a token was read and current depth is greater than or equal to target depth. - - - - The current path that is being unmarshalled. - - - - - Returns the element depth of the parser's current position in the - document being parsed. - - - - - Reads to the next node in the document, and updates the context accordingly. - - - True if a node was read, false if there are no more elements to read. - - - - - Returns the text contents of the current element being parsed. - - - The text contents of the current element being parsed. - - - - - True if NodeType is Element. - - - - - True if NodeType is EndElement. - - - - - True if the context is at the start of the document. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Wrap an XmltextReader for simulating an event stream. - - Each Read() operation goes either to the next element or next attribute within - the current element. TestExpression() is used to match the current event - to an xpath expression. The general pattern looks like this: - - UnmarshallerContext context = new UnmarshallerContext(...); - while (context.Read()) - { - if (context.TestExpresion("path/to/element")) - { - myObject.stringMember = stringUnmarshaller.GetInstance().Unmarshall(context); - continue; - } - if (context.TestExpression("path/to/@attribute")) - myObject.MyComplexTypeMember = MyComplexTypeUnmarshaller.GetInstance().Unmarshall(context); - } - - - - - - Wrap an XmlTextReader with state for event-based parsing of an XML stream. - - Stream with the XML from a service response. - If set to true, maintains a copy of the complete response body constraint to log response size as the stream is being read. - Response data coming back from the request - If set to true, maintains a copy of the complete response body as the stream is being read. - - - - The current XML path that is being unmarshalled. - - - - - Returns the element depth of the parser's current position in the XML - document being parsed. - - - - - Reads to the next node in the XML document, and updates the context accordingly. - - - True if a node was read, false if there are no more elements to read./ - - - - - Returns the text contents of the current element being parsed. - - - The text contents of the current element being parsed. - - - - - True if NodeType is Element. - - - - - True if NodeType is EndElement. - - - - - True if the context is at the start of the document. - - - - - True if NodeType is Attribute. - - - - - Wrap an XmlTextReader with state for event-based parsing of an XML stream. - - Stream with the XML from a service response. - If set to true, maintains a copy of the complete response body constraint to log response size as the stream is being read. - Response data coming back from the request - If set to true, maintains a copy of the complete response body as the stream is being read. - - - - RequestId value, if found in response - - - - - Reads to the next node in the XML document, and updates the context accordingly. - If node is RequestId, reads the contents and stores in RequestId property. - - - True if a node was read, false if there are no more elements to read./ - - - - - A stream which caches the contents of the underlying stream as it reads it. - - - - - All the bytes read by the stream. - - - - - All the bytes read by the stream constrained with _cacheLimit - - - - - Initializes the CachingWrapperStream with a base stream. - - The stream to be wrapped. - Maximum number of bytes to be cached. - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Gets a value indicating whether the current stream supports seeking. - CachingWrapperStream does not support seeking, this will always be false. - - - - - Gets or sets the position within the current stream. - CachingWrapperStream does not support seeking, attempting to set Position - will throw NotSupportedException. - - - - - Sets the position within the current stream. - CachingWrapperStream does not support seeking, attempting to call Seek - will throw NotSupportedException. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Stream wrapper that double-buffers from a wrapped stream and - returns the buffered content as a series of signed 'chunks' - for the AWS4 ('Signature V4') protocol. - - - - - Reads some or all of the processed chunk to the consumer, constructing - and streaming a new chunk if more input data is available. - - - - - - - - - Attempt to read sufficient data for a whole chunk from the wrapped stream, - returning the number of bytes successfully read to be processed into a chunk - - - - - Results of the header-signing portion of the request - - - - - Computed signature of the chunk prior to the one in-flight, in - hex - - - - - Computes the derived signature for a chunk of data of given length in the input buffer, - placing a formatted chunk with headers, signature and data into the output buffer - ready for streaming back to the consumer. - - - - - - Length override to return the true length of the payload plus the metainfo - supplied with each chunk - - - - - Computes the total size of the data payload, including the chunk metadata. - Called externally so as to be able to set the correct Content-Length header - value. - - - - - - - Computes the size of the header data for each chunk. - - - - - - - Attempt to read sufficient data for a whole chunk from the wrapped stream, - returning the number of bytes successfully read to be processed into a chunk - - - - - A list object that will always be sent to AWS services, - even if it is empty. - The AWS .NET SDK does not send empty collections to services, unless - the collection is of this type. - - - - - - A dictionary object that will always be sent to AWS services, - even if it is empty. - The AWS .NET SDK does not send empty collections to services, unless - the collection is of this type. - - - - - - - Class to perform actions on a background thread. - Uses a single background thread and performs actions - on it in the order the data was sent through the instance. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Class to invoke actions on a background thread. - Uses a single background thread and invokes actions - on it in the order they were invoked through the instance. - - - - - PCL doesn't have IPAddress. These methods are copied from the Microsoft source code. - - - - - Returns true if the Content is set or there are - query parameters. - - This request - True if data is present; false otherwise. - - - - Utilities for dealing with Guids - - - - - Hashes a set of objects. - - - - - - - Combines a set of hashses. - - - - - - - Combines two hashes. - - - - - - - - Disposes of all managed and unmanaged resources. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - A wrapper stream that calculates a hash of the base stream as it - is being read. - The calculated hash is only available after the stream is closed or - CalculateHash is called. After calling CalculateHash, any further reads - on the streams will not change the CalculatedHash. - If an ExpectedHash is specified and is not equal to the calculated hash, - Close or CalculateHash methods will throw an AmazonClientException. - If CalculatedHash is calculated for only the portion of the stream that - is read. - - - Exception thrown during Close() or CalculateHash(), if ExpectedHash is set and - is different from CalculateHash that the stream calculates, provided that - CalculatedHash is not a zero-length byte array. - - - - - Algorithm to use to calculate hash. - - - - - True if hashing is finished and no more hashing should be done; - otherwise false. - - - - - Current position in the stream. - - - - - Calculated hash for the stream. - This value is set only after the stream is closed. - - - - - Expected hash value. Compared against CalculatedHash upon Close(). - If the hashes are different, an AmazonClientException is thrown. - - - - - Expected length of stream. - - - - - Initializes an HashStream with a hash algorithm and a base stream. - - Stream to calculate hash for. - - Expected hash. Will be compared against calculated hash on stream close. - Pass in null to disable check. - - - Expected length of the stream. If the reading stops before reaching this - position, CalculatedHash will be set to empty array. - - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Asynchronously reads a sequence of bytes from the current stream, advances - the position within the stream by the number of bytes read, and monitors - cancellation requests. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous read operation. The value of the TResult - parameter contains the total number of bytes read into the buffer. This can be - less than the number of bytes requested if that many bytes are not currently - available, or zero (0) if the end of the stream has been reached. - - - - - Gets a value indicating whether the current stream supports seeking. - HashStream does not support seeking, this will always be false. - - - - - Gets or sets the position within the current stream. - HashStream does not support seeking, attempting to set Position - will throw NotSupportedException. - - - - - Sets the position within the current stream. - HashStream does not support seeking, attempting to call Seek - will throw NotSupportedException. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Gets the overridden length used to construct the HashStream - - - - - Calculates the hash for the stream so far and disables any further - hashing. - - - - - Resets the hash stream to starting state. - Use this if the underlying stream has been modified and needs - to be rehashed without reconstructing the hierarchy. - - - - - Validates the underlying stream. - - - - - Compares two hashes (arrays of bytes). - - Expected hash. - Actual hash. - - True if the hashes are identical; otherwise false. - - - - - A wrapper stream that calculates a hash of the base stream as it - is being read or written. - The calculated hash is only available after the stream is closed or - CalculateHash is called. After calling CalculateHash, any further reads - on the streams will not change the CalculatedHash. - If an ExpectedHash is specified and is not equal to the calculated hash, - Close or CalculateHash methods will throw an AmazonClientException. - If base stream's position is not 0 or HashOnReads is true and the entire stream is - not read, the CalculatedHash will be set to an empty byte array and - comparison to ExpectedHash will not be made. - - - Exception thrown during Close() or CalculateHash(), if ExpectedHash is set and - is different from CalculateHash that the stream calculates, provided that - CalculatedHash is not a zero-length byte array. - - - - - Initializes an HashStream with a hash algorithm and a base stream. - - Stream to calculate hash for. - - Expected hash. Will be compared against calculated hash on stream close. - Pass in null to disable check. - - - Expected length of the stream. If the reading stops before reaching this - position, CalculatedHash will be set to empty array. - - - - - A wrapper stream that calculates an MD5 hash of the base stream as it - is being read or written. - The calculated hash is only available after the stream is closed or - CalculateHash is called. After calling CalculateHash, any further reads - on the streams will not change the CalculatedHash. - If an ExpectedHash is specified and is not equal to the calculated hash, - Close or CalculateHash methods will throw an AmazonClientException. - If base stream's position is not 0 or HashOnReads is true and the entire stream is - not read, the CalculatedHash will be set to an empty byte array and - comparison to ExpectedHash will not be made. - - - Exception thrown during Close() or CalculateHash(), if ExpectedHash is set and - is different from CalculateHash that the stream calculates, provided that - CalculatedHash is not a zero-length byte array. - - - - - Initializes an MD5Stream with a base stream. - - Stream to calculate hash for. - - Expected hash. Will be compared against calculated hash on stream close. - Pass in null to disable check. - - - Expected length of the stream. If the reading stops before reaching this - position, CalculatedHash will be set to empty array. - - - - - Utilities for validating label values for host prefix templates - - - - - Validates a label value - - - - - Simple wrapper around the log4net Error method. - - - - - - - - Write debug message to Console - - - - - - - - Write debug message to Console - - - - - - - Simple wrapper around the log4net InfoFormat method. - - - - - - - This is a dynamic wrapper around log4net so we can avoid log4net being required - to be distributed with the SDK. - - - - - Abstract logger class, base for any custom/specific loggers. - - - - - Flushes the logger contents. - - - - - Simple wrapper around the log4net IsErrorEnabled property. - - - - - Simple wrapper around the log4net IsDebugEnabled property. - - - - - Simple wrapper around the log4net IsInfoEnabled property. - - - - - Simple wrapper around the log4net Error method. - - - - - - - - Simple wrapper around the log4net Debug method. - - - - - - - - Simple wrapper around the log4net DebugFormat method. - - - - - - - Simple wrapper around the log4net InfoFormat method. - - - - - - - Logger wrapper for reflected log4net logging methods. - - - - - This should be a one time call to use reflection to find all the types and methods - needed for the logging API. - - - - - Simple wrapper around the log4net IsErrorEnabled property. - - - - - Simple wrapper around the log4net Error method. - - - - - - - - Simple wrapper around the log4net IsDebugEnabled property. - - - - - Simple wrapper around the log4net Debug method. - - - - - - - - Simple wrapper around the log4net DebugFormat method. - - - - - - - Simple wrapper around the log4net IsInfoEnabled property. - - - - - Simple wrapper around the log4net InfoFormat method. - - - - - - - A single logged message - - - - - Log message arguments. - - - - - Culture-specific formatting provider. - - - - - Log message format. - - - - - a size-limited cache of key value pairs - - Once the maximum size has been reached, the least recently - used pairs will be evicted to make room for any new items. - - - - - - - the maximum number of entries this LruCache will hold - before items begin getting evicted - - - - - the number of items in the cache - - - - - Construct a new LruCache. - - maximum number of entries before items are evicted - - - - Add the key/value pair to the cache, or update - the value if the key already exists. - - If the cache is full, evicts the least recently used item. - - - - - - - Evicts a specific key out of the cache if it exists - - the key to evict from the cache - - - - Try to get the value associated with the key. - - the key to look up - the value, if the key exists - true if there is a value associated with the key, or false if no value is associated with the key - - - - Try to get the value associated with the key, if it doesn't exist, use the provided factory method to - create a new value and tries adding it to the cache. - - the key to look up - the factory method used in case the key is not present in the cache - the looked up value or the value created by the factory - - - - Clear the LruCache of all entries. - - - - - Helper class to support LruCache. - Does not implement the error checking and synchronization that - would be necessary for it to stand alone. - - - - - Item to be stored in the LruList - linked list structure. - - - - - Collection of properties being tracked - - - - - Timings for metrics being tracked - - - - - Counters being tracked - - - - - Whether metrics are enabled for the request - - - - - Constructs an empty, disabled metrics object - - - - - Starts timing an event. Logs an exception if an event - of the same type was started but not stopped. - - - - - - - Stops timing an event. Logs an exception if the event wasn't started. - - - - - - - Adds a property for a metric. If there are multiple, the - object is added as a new item in a list. - - - - - - - Sets a counter for a specific metric. - - - - - - - Increments a specific metric counter. - If counter doesn't exist yet, it is set to 1. - - - - - - Returns errors associated with the metric, including - if there are still any timing events in-flight. - - - - - - Returns a string representation of the current metrics. - - - - - - Return a JSON represenation of the current metrics - - - - - - Timing information for a metric - - - - - Empty, stopped timing object - - - - - Timing object in a started state - - - - - - Stops timing - - - - - - Whether the timing has been stopped - - - - - Elapsed ticks from start to stop. - If timing hasn't been stopped yet, returns 0. - - - - - Elapsed time from start to stop. - If timing hasn't been stopped yet, returns TimeSpan.Zero - - - - - Timing event, stops timing of a metric when disposed - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - The destructor for the client class. - - - - - A wrapper stream which supresses disposal of the underlying stream. - - - - - Constructor for NonDisposingWrapperStream. - - The base stream to wrap. - - - - The Dispose implementation for this wrapper stream - does not close the underlying stream. - - - - - This class is used to wrap a stream for a particular segment of a stream. It - makes that segment look like you are reading from beginning to end of the stream. - - - - - Asynchronously reads a sequence of bytes from the current stream, advances - the position within the stream by the number of bytes read, and monitors - cancellation requests. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous read operation. The value of the TResult - parameter contains the total number of bytes read into the buffer. This can be - less than the number of bytes requested if that many bytes are not currently - available, or zero (0) if the end of the stream has been reached. - - - - - Asynchronously writes a sequence of bytes to the current stream and advances the - current position within this stream by the number of bytes written. - - - An array of bytes. This method copies count bytes from buffer to the current stream. - - - The zero-based byte offset in buffer at which to begin copying bytes to the - current stream. - - The number of bytes to be written to the current stream. - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - A task that represents the asynchronous write operation. - - - - Wrapper stream that only supports reading - - - - - Asynchronously clears all buffers for this stream and causes any buffered data - to be written to the underlying device. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous flush operation. - - - - - Asynchronously writes a sequence of bytes to the current stream and advances the - current position within this stream by the number of bytes written. - - - An array of bytes. This method copies count bytes from buffer to the current stream. - - - The zero-based byte offset in buffer at which to begin copying bytes to the - current stream. - - The number of bytes to be written to the current stream. - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - A task that represents the asynchronous write operation. - - - - Partial wrapper stream that only supports reading - - - - - Uri wrapper that can parse out information (bucket, key, region, style) from an - S3 URI. - - - - - True if the URI contains the bucket in the path, false if it contains the bucket in the authority. - - - - - The bucket name parsed from the URI (or null if no bucket specified). - - - - - The key parsed from the URI (or null if no key specified). - - - - - The region parsed from the URI (or null if no region specified). - - - - - Constructs a parser for the S3 URI specified as a string. - - The S3 URI to be parsed. - - - - Constructs a parser for the S3 URI specified as a Uri instance. - - The S3 URI to be parsed. - - - - Percent-decodes the given string, with a fast path for strings that are not - percent-encoded. - - The string to decode - The decoded string - - - - Percent-decodes the given string. - - The string to decode - The index of the first '%' in the string - The decoded string - - - - Decodes the percent-encoded character at the given index in the string - and appends the decoded value to the string under construction. - - - The string under construction to which the decoded character will be - appended. - - The string being decoded. - The index of the '%' character in the string. - - - - Converts a hex character (0-9A-Fa-f) into its corresponding quad value. - - The hex character - The quad value - - - - Interface for a non-generic cache. - - - - - Clears the entire cache. - - - - - Maximum time to keep an item around after its last use. - - - - - How often should the cache be cleared of old items. - - - - - The number of items in the cache. - - - - - Interface for a generic cache. - - - - - - - Retrieves a value out of the cache or from the source. - - - - - - - - Retrieves a value out of the cache or from the source. - If the item was in the cache, isStaleItem is set to true; - otherwise, if the item comes from the source, isStaleItem is false. - - - - - - - - - Clears a specific value from the cache if it's there. - - - - - - Returns the keys for all items in the cache. - - - - - - Executes specified operation, catches exception, clears the cache for - the given key, retries the operation. - - - - - - - - - - - SDK-wide cache. - Provides access to caches specific to a particular set of credentials - and target region. - - - - - Clear all caches - - - - - Clear all caches of a particular type - - - - - - Retrieve a cache of a specific type for a client object. - The client object can be null in cases where a cache does - not correspond to a specific AWS account or target region. - - - - - - - - - - - Retrieve a cache of a specific type for a client object. - The client object can be null in cases where a cache does - not correspond to a specific AWS account or target region. - - - - - - - - - - - Utilities for converting objects to strings. Used by the marshaller classes. - - - - - Converts a DateTime to ISO8601 formatted string. - - - - - Converts a DateTime to RFC822 formatted string. - - - - - Converts a DateTime to Unix epoch time formatted string. - - - - - A wrapper stream. - - - - - Base stream. - - - - - Initializes WrapperStream with a base stream. - - - - - - Returns the first base non-WrapperStream. - - First base stream that is non-WrapperStream. - - - - Returns the first base non-WrapperStream. - - First base stream that is non-WrapperStream. - - - - Returns the first base non-WrapperStream. - - Potential WrapperStream - Base non-WrapperStream. - - - - Gets a value indicating whether the current stream supports reading. - True if the stream supports reading; otherwise, false. - - - - - Gets a value indicating whether the current stream supports seeking. - True if the stream supports seeking; otherwise, false. - - - - - Gets a value indicating whether the current stream supports writing. - True if the stream supports writing; otherwise, false. - - - - - Closes the current stream and releases any resources (such as sockets and - file handles) associated with the current stream. - - - - - Gets the length in bytes of the stream. - - - - - Gets or sets the position within the current stream. - - - - - Gets or sets a value, in miliseconds, that determines how long the stream - will attempt to read before timing out. - - - - - Gets or sets a value, in miliseconds, that determines how long the stream - will attempt to write before timing out. - - - - - Clears all buffers for this stream and causes any buffered data to be written - to the underlying device. - - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Sets the position within the current stream. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Sets the length of the current stream. - - The desired length of the current stream in bytes. - - - - Writes a sequence of bytes to the current stream and advances the current - position within this stream by the number of bytes written. - - - An array of bytes. This method copies count bytes from buffer to the current stream. - - - The zero-based byte offset in buffer at which to begin copying bytes to the - current stream. - - The number of bytes to be written to the current stream. - - - - Asynchronously clears all buffers for this stream and causes any buffered data - to be written to the underlying device. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous flush operation. - - - - - Asynchronously reads a sequence of bytes from the current stream, advances - the position within the stream by the number of bytes read, and monitors - cancellation requests. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous read operation. The value of the TResult - parameter contains the total number of bytes read into the buffer. This can be - less than the number of bytes requested if that many bytes are not currently - available, or zero (0) if the end of the stream has been reached. - - - - - Asynchronously writes a sequence of bytes to the current stream and advances the - current position within this stream by the number of bytes written. - - - An array of bytes. This method copies count bytes from buffer to the current stream. - - - The zero-based byte offset in buffer at which to begin copying bytes to the - current stream. - - The number of bytes to be written to the current stream. - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - A task that represents the asynchronous write operation. - - - - This is a utility class to be used in last resort for code paths that are synchronous but need to call an asynchronous method. - This should never be used for methods that are called at high volume as this utility class has a performance cost. For example this - class was added for the refreshing credentials like Cognito which would need to use this about once an hour. - - - - - Custom WebProxy implementation that creates a webproxy based on - user inputs(Host name and port number) - - - - - Set the ProxyUri - - - - - Create a Uri based on the user inputs(Host name and port number) - - - - - Proxy Uri property - - - - - Proxy Credentials property - - - - - Getter to fetch the set proxy - - - - - Method to determine if the proxy should be bypassed when accessing an internet source - - - - - Error is always enabled - - - - - Debug logging is always enabled - - - - - Info logging is always enabled - - - - - Prints the Log With Error Level - - - - - - - - Prints the Log with Debug Level - - - - - - - - Prints the Log with Debug Level - - - - - - - Prints the Log With Info Level - - - - - - - This class is no longer used anymore and should be avoided as it is just meant - as a last resort when blending async and sync operations. The code is still - here to support versions before 3.3.9.0 of AWSSDK.DynamoDBv2. - - - - - Property to denote that the last exception returned by an AWS Service - was retryable or not. - - - - - An abstract pipeline handler that has implements IPipelineHandler, - and has the default implmentation. This is the base class for most of - the handler implementations. - - - - - The logger used to log messages. - - - - - The inner handler which is called after the current - handler completes it's processing. - - - - - The outer handler which encapsulates the current handler. - - - - - Contains the processing logic for a synchronous request invocation. - This method calls InnerHandler.InvokeSync to continue processing of the - request by the pipeline. - - The execution context which contains both the - requests and response context. - - - - Contains the processing logic for an asynchronous request invocation. - This method calls InnerHandler.InvokeSync to continue processing of the - request by the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Logs the metrics for the current execution context. - - The execution context, it contains the - request and response context. - - - - A runtime pipeline contains a collection of handlers which represent - different stages of request and response processing. - - - - - The top-most handler in the pipeline. - - - - - Constructor for RuntimePipeline. - - The handler with which the pipeline is initalized. - - - - Constructor for RuntimePipeline. - - List of handlers with which the pipeline is initalized. - - - - Constructor for RuntimePipeline. - - List of handlers with which the pipeline is initalized. - The logger used to log messages. - - - - Constructor for RuntimePipeline. - - The handler with which the pipeline is initalized. - The logger used to log messages. - - - - Invokes the pipeline synchronously. - - Request context - Response context - - - - Invokes the pipeline asynchronously. - - Request context - Response context - - - - Adds a new handler to the top of the pipeline. - - The handler to be added to the pipeline. - - - - Adds a handler after the first instance of handler of type T. - - Type of the handler after which the given handler instance is added. - The handler to be added to the pipeline. - - - - Adds a handler before the first instance of handler of type T. - - Type of the handler before which the given handler instance is added. - The handler to be added to the pipeline. - - - - Removes the first occurance of a handler of type T. - - Type of the handler which will be removed. - - - - Replaces the first occurance of a handler of type T with the given handler. - - Type of the handler which will be replaced. - The handler to be added to the pipeline. - - - - Inserts the given handler after current handler in the pipeline. - - Handler to be inserted in the pipeline. - Handler after which the given handler is inserted. - - - - Gets the innermost handler by traversing the inner handler till - it reaches the last one. - - - - - Retrieves a list of handlers, in the order of their execution. - - Handlers in the current pipeline. - - - - Retrieves current handlers, in the order of their execution. - - Handlers in the current pipeline. - - - - This handler processes exceptions thrown from the HTTP handler and - unmarshalls error responses. - - - - - Default set of exception handlers. - - - - - Default set of exception handlers. - - - - - Constructor for ErrorHandler. - - an ILogger instance. - - - - Handles and processes any exception thrown from underlying handlers. - - The execution context which contains both the - requests and response context. - - - - Handles and processes any exception thrown from underlying handlers. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Disposes the response body. - - The response context. - - - - Processes an exception by invoking a matching exception handler - for the given exception. - - The execution context, it contains the - request and response context. - The exception to be processed. - - This method returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception that may be thrown by exception - processing by a matching exception handler. - - - - - The abstract base class for exception handlers. - - The exception type. - - - - The exception handler for HttpErrorResponseException exception. - - - - - The constructor for HttpErrorResponseExceptionHandler. - - in instance of ILogger. - - - - Handles an exception for the given execution context. - - The execution context, it contains the - request and response context. - The exception to handle. - - Returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception to replace the original exception. - - - - - Checks if a HTTP 404 status code is returned which needs to be suppressed and - processes it. - If a suppressed 404 is present, it unmarshalls the response and returns true to - indicate that a suppressed 404 was processed, else returns false. - - The execution context, it contains the - request and response context. - - - If a suppressed 404 is present, returns true, else returns false. - - - - - A pipeline handler which provides hooks to run - external code in the pre-invoke and post-invoke phases. - - - - - Action to execute on the pre invoke phase. - - - - - Action to execute on the post invoke phase. - - - - - Calls the PreInvoke and PostInvoke methods before and after calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls the PreInvoke and PostInvoke methods before and after calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Executes the OnPreInvoke action as part of pre-invoke. - - The execution context, it contains the - request and response context. - - - - Executes the OnPreInvoke action as part of post-invoke. - - The execution context, it contains the - request and response context. - - - - This handler retrieved the AWS credentials to be used for the current call. - - - - - The constructor for CredentialsRetriever. - - An AWSCredentials instance. - - - - Retrieves the credentials to be used for the current call before - invoking the next handler. - - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - This handler resolves the endpoint to be used for the current request. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Resolves the endpoint to be used for the current request - before invoking the next handler. - - The execution context, it contains the - request and response context. - - - - This handler resolves the endpoint to be used for the current request. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Resolves the endpoint to be used for the current request - before invoking the next handler. - - The execution context, it contains the - request and response context. - - - - Determines the endpoint for the request. - - The request context. - - - - - This handler provides an OnError action that can be used as hook for - external code to handle exceptions in the runtime pipeline. - - - - - Action to execute if an exception occurs during the - execution of any underlying handlers. - - - - - Executes the OnError action if an exception occurs during the - execution of any underlying handlers. - - - - - - - This handler marshalls the request before calling invoking the next handler. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Marshalls the request before calling invoking the next handler. - - The execution context, it contains the - request and response context. - - - - This handler manages the metrics used to time the complete call and - logs the final metrics. - - - - - Captures the overall execution time and logs final metrics. - - The execution context which contains both the - requests and response context. - - - - Captures the overall execution time and logs final metrics. - - The response type for the current request. - - The execution context, it contains the request and response context. - - A task that represents the asynchronous operation. - - - - This handler processes HTTP redirects and reissues the call to the - redirected location. - - - - - Processes HTTP redirects and reissues the call to the - redirected location. - - The execution context which contains both the - requests and response context. - - - - Processes HTTP redirects and reissues the call to the - redirected location. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Checks if an HTTP 307 (temporary redirect) has occured and changes the - request endpoint to the redirected location. - - - The execution context, it contains the request and response context. - - - A boolean value that indicates if a redirect has occured. - - - - - This handler signs the request. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Signs the request before invoking the next handler. - - - The execution context, it contains the request and response context. - - - - - Determines if the request should be signed. - - The request context. - A boolean value that indicated if the request should be signed. - - - - Signs the request. - - The request context. - - - - This handler unmarshalls the HTTP response. - - - - - The constructor for Unmarshaller. - - - Boolean value which indicated if the unmarshaller - handler supports response logging. - - - - - Unmarshalls the response returned by the HttpHandler. - - The execution context which contains both the - requests and response context. - - - - Unmarshalls the response returned by the HttpHandler. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Unmarshalls the HTTP response. - - - The execution context, it contains the request and response context. - - - - - Unmarshalls the HTTP response. - - - The execution context, it contains the request and response context. - - - - - The HTTP handler contains common logic for issuing an HTTP request that is - independent of the underlying HTTP infrastructure. - - - - - - The sender parameter used in any events raised by this handler. - - - - - The constructor for HttpHandler. - - The request factory used to create HTTP Requests. - The sender parameter used in any events raised by this handler. - - - - Issues an HTTP request for the current request context. - - The execution context which contains both the - requests and response context. - - - - Issues an HTTP request for the current request context. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Determines the content for request body and uses the HTTP request - to write the content to the HTTP request body. - - Content to be written. - The HTTP request. - The request context. - - - - Creates the HttpWebRequest and configures the end point, content, user agent and proxy settings. - - The async request. - The web request that actually makes the call. - - - - Disposes the HTTP handler. - - - - - The default implementation of the adaptive retry policy. - - - The default implementation of the adaptive policy. - - - - - Constructor for AdaptiveRetryPolicy. - - The maximum number of retries before throwing - back a exception. This does not count the initial request. - - - - Constructor for AdaptiveRetryPolicy. - - The Client config object. This is used to - retrieve the maximum number of retries before throwing - back a exception(This does not count the initial request) and - the service URL for the request. - - - - OnRetry is called when a retry request is initiated to determine if the request will be retried. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - true if the error that will be retried is a throtting error - True if retry throttling is disabled or retry throttling is enabled and capacity can be obtained. - - - - This method uses a token bucket to enforce the maximum sending rate. - - The execution context which contains both the - requests and response context. - If the prior request failed, this exception is expected to be - the exception that occurred during the prior request failure. - - - - Virtual method that gets called on a success Response. If its a retry success response, the entire - retry acquired capacity is released(default is 5). If its just a success response a lesser value capacity - is released(default is 1). - - Request context containing the state of the request. - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - This method uses a token bucket to enforce the maximum sending rate. - - The execution context which contains both the - requests and response context. - If the prior request failed, this exception is expected to be - the exception that occurred during the prior request failure. - - - - The default implementation of the legacy retry policy. - - - The default implementation of the legacy retry policy. - - - - - The maximum value of exponential backoff in milliseconds, which will be used to wait - before retrying a request. The default is 30000 milliseconds. - - - - - Constructor for DefaultRetryPolicy. - - The maximum number of retries before throwing - back a exception. This does not count the initial request. - - - - Constructor for DefaultRetryPolicy. - - The Client config object. This is used to - retrieve the maximum number of retries before throwing - back a exception(This does not count the initial request) and - the service URL for the request. - - - - Returns true if the request is in a state where it can be retried, else false. - - Request context containing the state of the request. - Returns true if the request is in a state where it can be retried, else false. - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - true if the error that will be retried is a throtting error - - - - Virtual method that gets called on a success Response. If its a retry success response, the entire - retry acquired capacity is released(default is 5). If its just a success response a lesser value capacity - is released(default is 1). - - Request context containing the state of the request. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Request context containing the state of the request. - Return true if the request should be retried. - - - - Checks if the retry limit is reached. - - Request context containing the state of the request. - Return false if the request can be retried, based on number of retries. - - - - Waits before retrying a request. The default policy implements a exponential backoff. - - Request context containing the state of the request. - - - - Waits for an amount of time using an exponential backoff algorithm. - - The request retry index. The first request is expected to be 0 while - the first retry will be 1. - The max number of milliseconds to wait - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - The retry handler has the generic logic for retrying requests. - It uses a retry policy which specifies when - a retry should be performed. - - - - - The logger used to log messages. - - - - - The retry policy which specifies when - a retry should be performed. - - - - - Constructor which takes in a retry policy. - - Retry Policy - - - - Invokes the inner handler and performs a retry, if required as per the - retry policy. - - The execution context which contains both the - requests and response context. - - - - Invokes the inner handler and performs a retry, if required as per the - retry policy. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Prepares the request for retry. - - Request context containing the state of the request. - - - - The default implementation of the standard retry policy. - - - The default implementation of the standard policy. - - - - - The maximum value of exponential backoff in milliseconds, which will be used to wait - before retrying a request. The default is 20000 milliseconds. - - - - - Constructor for StandardRetryPolicy. - - The maximum number of retries before throwing - back a exception. This does not count the initial request. - - - - Constructor for StandardRetryPolicy. - - The Client config object. This is used to - retrieve the maximum number of retries before throwing - back a exception(This does not count the initial request) and - the service URL for the request. - - - - Returns true if the request is in a state where it can be retried, else false. - - Request context containing the state of the request. - Returns true if the request is in a state where it can be retried, else false. - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - true if the error that will be retried is a throtting error - - - - Virtual method that gets called on a success Response. If its a retry success response, the entire - retry acquired capacity is released(default is 5). If its just a success response a lesser value capacity - is released(default is 1). - - Request context containing the state of the request. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Request context containing the state of the request. - Return true if the request should be retried. - - - - Checks if the retry limit is reached. - - Request context containing the state of the request. - Return false if the request can be retried, based on number of retries. - - - - Waits before retrying a request. The default policy implements a exponential backoff with - jitter algorithm. - - Request context containing the state of the request. - - - - Waits for an amount of time using an exponential backoff with jitter algorithm. - - The request retry index. The first request is expected to be 0 while - the first retry will be 1. - The max number of milliseconds to wait - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - This class is the base class of all the configurations settings to connect - to a service. - - - This class is the base class of all the configurations settings to connect - to a service. - - - - - Gets Service Version - - - - - Gets and sets of the signatureMethod property. - - - - - Gets and sets of the SignatureVersion property. - - Note: This property exists for backward compatibility but is no longer - used by any service other than S3. - - - - - Gets and sets of the UserAgent property. - - - - - Gets and sets the RegionEndpoint property. The region constant that - determines the endpoint to use. - - Setting this property to null will force the SDK to recalculate the - RegionEndpoint value based on App/WebConfig, environment variables, - profile, etc. - - - - - The constant used to lookup in the region hash the endpoint. - - - - - Gets and sets of the ServiceURL property. - This is an optional property; change it - only if you want to try a different service - endpoint. - - - - - Gets and sets the UseHttp. - If this property is set to true, the client attempts - to use HTTP protocol, if the target endpoint supports it. - By default, this property is set to false. - - - - - Given this client configuration, return a string form ofthe service endpoint url. - - - - - Gets and sets the AuthenticationRegion property. - Used in AWS4 request signing, this is an optional property; - change it only if the region cannot be determined from the - service endpoint. - - - - - Gets and sets the AuthenticationServiceName property. - Used in AWS4 request signing, this is the short-form - name of the service being called. - - - - - Returns the flag indicating how many retry HTTP requests an SDK should - make for a single SDK operation invocation before giving up. This flag will - return 4 when the RetryMode is set to "Legacy" which is the default. For - RetryMode values of "Standard" or "Adaptive" this flag will return 2. In - addition to the values returned that are dependant on the RetryMode, the - value can be set to a specific value by using the AWS_MAX_ATTEMPTS environment - variable, max_attempts in the shared configuration file, or by setting a - value directly on this property. When using AWS_MAX_ATTEMPTS or max_attempts - the value returned from this property will be one less than the value entered - because this flag is the number of retry requests, not total requests. To - learn more about the RetryMode property that affects the values returned by - this flag, see . - - - - - Determines if MaxErrorRetry has been manually set. - - - - - Gets and sets the LogResponse property. - If this property is set to true, the service response is logged. - The size of response being logged is controlled by the AWSConfigs.LoggingConfig.LogResponsesSizeLimit property. - - - - - Gets and sets the ReadEntireResponse property. - NOTE: This property does not effect response processing and is deprecated. - To enable response logging, the ClientConfig.LogResponse and AWSConfigs.LoggingConfig - properties can be used. - - - - - Gets and Sets the BufferSize property. - The BufferSize controls the buffer used to read in from input streams and write - out to the request. - - - - - - Gets or sets the interval at which progress update events are raised - for upload operations. By default, the progress update events are - raised at every 100KB of data transferred. - - - If the value of this property is set less than ClientConfig.BufferSize, - progress updates events will be raised at the interval specified by ClientConfig.BufferSize. - - - - - - Flag on whether to resign requests on retry or not. - For Amazon S3 and Amazon Glacier this value will always be set to true. - - - - - This flag controls if .NET HTTP infrastructure should follow redirection - responses (e.g. HTTP 307 - temporary redirect). - - - - - Flag on whether to log metrics for service calls. - - This can be set in the application's configs, as below: - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSLogMetrics" value"true"/> - </appSettings> - </configuration> - - - - - - Gets and sets the DisableLogging. If true logging for this client will be disabled. - - - - - Credentials to use with a proxy. - - - - - - If the value is set, the value is assigned to the Timeout property of the HttpWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Configures the endpoint calculation for a service to go to a dual stack (ipv6 enabled) endpoint - for the configured region. - - - Note: AWS services are enabling dualstack endpoints over time. It is your responsibility to check - that the service actually supports a dualstack endpoint in the configured region before enabling - this option for a service. - - - - - Enable or disable the Retry Throttling feature by setting the ThrottleRetries flag to True/False resepctively. - Retry Throttling is a feature that intelligently throttles retry attempts when a large precentage of requests - are failing and retries are unsuccessful as well. In such situations the allotted retry capacity for the service URL - will be drained until requests start to succeed again. Once the requisite capacity is available, retries would - be permitted again. When retries are throttled, the service enters a fail-fast behaviour as the traditional retry attempt - for the request would be circumvented. Hence, errors will resurface quickly. This will result in a greated number of exceptions - but prevents requests being tied up in unsuccessful retry attempts. - Note: Retry Throttling is enabled by default. Set the ThrottleRetries flag to false to switch off this feature. - - - - - Enable or disable the Nagle algorithm on the underlying http - client. - - This method is not intended to be called by consumers of the AWS SDK for .NET - - - - - - Performs validation on this config object. - Throws exception if any of the required values are missing/invalid. - - - - - Returns the current UTC now after clock correction for this endpoint. - - - - - The calculated clock skew correction for a specific endpoint, if there is one. - This field will be set if a service call resulted in an exception - and the SDK has determined that there is a difference between local - and server times. - - If is set to true, this - value will still be set to the correction, but it will not be used by the - SDK and clock skew errors will not be retried. - - - - - Gets and sets the DisableHostPrefixInjection flag. If true, host prefix injection will be disabled for this client, the default value of this flag is false. - Host prefix injection prefixes the service endpoint with request members from APIs which use this feature. - Example: for a hostPrefix of "foo-name." and a endpoint of "service.region.amazonaws.com" the default behavior is to - prefix the endpoint with the hostPrefix resulting in a final endpoint of "foo-name.service.region.amazonaws.com". Setting - DisableHostPrefixInjection to true will disable hostPrefix injection resulting in a final endpoint of - "service.region.amazonaws.com" regardless of the value of hostPrefix. E.g. You may want to disable host prefix injection for testing against a local mock endpoint. - - - - - Returns the flag indicating if endpoint discovery should be enabled or disabled for operations that are not required to use endpoint discovery. - - - - - Returns the maximum number of discovered endpoints that can be stored within the cache for the client. The default limit is 1000 cache entries. - - - - - Returns the flag indicating the current mode in use for request - retries and influences the value returned from . - The default value is RequestRetryMode.Legacy. This flag can be configured - by using the AWS_RETRY_MODE environment variable, retry_mode in the - shared configuration file, or by setting this value directly. - - - - - Under Adaptive retry mode, this flag determines if the client should wait for - a send token to become available or don't block and fail the request immediately - if a send token is not available. - - - - - Throw an exception if the boxed TimeSpan parameter doesn't have a value or is out of range. - - - - - Returns the request timeout value if its value is set, - else returns client timeout value. - - - - - - This is a switch used for performance testing and is not intended for production applications - to change. This switch may be removed in a future version of the SDK as the .NET Core platform matures. - - - If true, the HttpClient is cached and reused for every request made by the service client - and shared with other service clients. - - - For the .NET Core platform this is default to true because the HttpClient manages the connection - pool. - - - - - - If CacheHttpClient is set to true then HttpClientCacheSize controls the number of HttpClients cached. - - On Windows the default value is 1 since the underlying native implementation does not have throttling constraints - like the non Windows Curl based implementation. For non Windows based platforms the default is the value return from - System.Environment.ProcessorCount. - - - - - - Overrides the default read-write timeout value. - On Unity platform, this value is not used as Unity HTTP client does not support timeouts, so - - - - If the value is set, the value is assigned to the ReadWriteTimeout property of the HttpWebRequest object used - to send requests. - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Returns a WebProxy instance configured to match the proxy settings - in the client configuration. - - - - - Unpacks the host, port and any credentials info into the instance's - proxy-related fields. - Unlike the SetWebProxy implementation on .NET 3.5/4.5,the Host and the Port are not reconstructed from the - input proxyuri - - The proxy details - - - - Gets and sets of the ProxyHost property. - - - - - Gets and sets of the ProxyPort property. - - - - - - Returns true if the clients should be cached by HttpRequestMessageFactory, false otherwise. - - - - - - - Returns true if the SDK should dispose HttpClients after one use, false otherwise. - - - - - - - Create a unique string used for caching the HttpClient based on the settings that are used from the ClientConfig that are set on the HttpClient. - - - - - - - Determines if HttpClients created with the given IClientConfig should be cached at the SDK - client level, or cached globally. - - If there is no HttpClientFactory assigned and proxy or proxy credentials are set - this returns false because those properties can't be serialized as part of the key in the global http client cache. - - - - - Base class for constant class that holds the value that will be sent to AWS for the static constants. - - - - - Gets the value that needs to be used when send the value to AWS - - - - - Attempt to find correct-cased constant value using whatever cased value the user - has provided. This is primarily useful for mapping any-cased values from a CLI - tool to the specific casing required by the service, avoiding the need for the - user to (a) remember the specific case and (b) actually type it correctly. - - The properly cased service constant matching the value - - - - Utility class that stores clock skew information. - - - - - GlobalClockCorrection should be only set by AWSConfigs.ManualClockCorrection property - and is only available to maintain backward compatibilty. This should override any - endpoint specific clockskew correction. - - - - - Return clock skew correction value for an endpoint if there is one. - - AWSConfigs.ManualClockCorrection overrides globally any calculated service endpoint specific - clock correction value. - - Endpoint should in a form such as "https://s3" - Clock correction value for an endpoint in TimeSpan. TimeSpan.Zero if no such clock correction is set. - - - - Get clock skew corrected UTC now value. If ManualClockCorrection is set, - use ManualClockCorrection instead of endpoint specific clock correction value. - - - - - - - Probing mechanism to determine the endpoint discovery enabled value from various sources. - - - - - The valid hashing algorithm supported by the sdk for request signing. - - - - - Which end of a request was responsible for a service error response. - - - - - The sender was responsible for the error, i.e. the client - request failed validation or was improperly formatted. - - - - - The error occured within the service. - - - - - An unrecognized error type was returned. - - - - - Sts Regional Endpoints Value determines whether or not - to send the sts request to the regional endpoint or to - the global sts endpoint - - - - - Send the request to the global sts endpoint - if the region is a legacy global region - - - - - Send the request to the regional endpoint - - - - - S3 US East 1 endpoint value determines wheter or not - to send the us-east-1 s3 requests to the regional endpoint or to - the legacy global endpoint - - - - - Sends the requests to the legacy global s3 endpoint for us-east-1 - - - - - Sends the request to the regional s3 endpoint for us-east-1 - - - - - RetryMode determines which request retry mode is used for requests that do - not complete successfully. - - - - - Legacy request retry strategy. - - - - - Standardized request retry strategy that is consistent across all SDKs. - - - - - An experimental request retry strategy that builds on the Standard strategy - and introduces congestion control through client side rate limiting. - - - - - All Amazon service interfaces like IAmazonS3 extend from this interface. This allows all the - Amazon service interfaces be identified by this base interface and helps with generic constraints. - - - - - A readonly view of the configuration for the service client. - - - - - This interface is the read only access to the ClientConfig object used when setting up service clients. Once service clients - are initiated the config object should not be changed to avoid issues with using a service client in a multi threaded environment. - - - - - Gets the RegionEndpoint property. The region constant to use that - determines the endpoint to use. If this is not set - then the client will fallback to the value of ServiceURL. - - - - - The constant used to lookup in the region hash the endpoint. - - - - - Gets and sets of the ServiceURL property. - This is an optional property if you need to set a specific service URL - instead setting the region with the RegionEndpoint property. - - - - - Gets the UseHttp property. - If this property is set to true, the client attempts - to use HTTP protocol. - By default, this property is set to false. - - - - - Gets Service Version - - - - - Gets the signatureMethod property. - - - - - Gets the SignatureVersion property. - - Note: This property exists for backward compatibility but is no longer - used by any service other than S3. - - - - - Gets the AuthenticationRegion property. - Used in AWS4 request signing, this is an optional property; - change it only if the region cannot be determined from the - service endpoint. - - - - - Gets the AuthenticationServiceName property. - Used in AWS4 request signing, this is the short-form - name of the service being called. - - - - - Gets the UserAgent property. - - - - - Gets the DisableLogging. If true logging for this client will be disabled. - - - - - Flag on whether to log metrics for service calls. - - This can be set in the application's configs, as below: - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSLogMetrics" value"true"/> - </appSettings> - </configuration> - - - - - - Gets the LogResponse property. - If this property is set to true, the service response - is read in its entirety and logged. - - - - - Gets the ReadEntireResponse. - If this property is set to true, the service response - is read in its entirety before being processed. - - - - - This flag controls if .NET HTTP infrastructure should follow redirection - responses (e.g. HTTP 307 - temporary redirect). - - - - - Gets the BufferSize property. - The BufferSize controls the buffer used to read in from input streams and write - out to the request. - - - - - Returns the flag indicating how many retry HTTP requests an SDK should - make for a single SDK operation invocation before giving up. This flag will - return 4 when the RetryMode is set to "Legacy" which is the default. For - RetryMode values of "Standard" or "Adaptive" this flag will return 2. In - addition to the values returned that are dependant on the RetryMode, the - value can be set to a specific value by using the AWS_MAX_ATTEMPTS environment - variable, max_attempts in the shared configuration file, or by setting a - value directly on this property. When using AWS_MAX_ATTEMPTS or max_attempts - the value returned from this property will be one less than the value entered - because this flag is the number of retry requests, not total requests. To - learn more about the RetryMode property that affects the values returned by - this flag, see . - - - - - Determines if MaxErrorRetry has been manually set. - - - - - Gets the interval at which progress update events are raised - for upload operations. By default, the progress update events are - raised at every 100KB of data transferred. - - - - - Flag on whether to resign requests on retry or not. - - - - - Credentials to use with a proxy. - - - - - Gets the default request timeout value. - - - - If the value is set, the value is assigned to the Timeout property of the HTTPWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - - - - Configures the endpoint calculation for a service to go to a dual stack (ipv6 enabled) endpoint - for the configured region. - - - Note: AWS services are enabling dualstack endpoints over time. It is your responsibility to check - that the service actually supports a dualstack endpoint in the configured region before enabling - this option for a service. - - - - - Configures a flag enabling to either opt in or opt out of the retry throttling service. - Note: set value to true to enable retry throttling feature. The Default value for this flag is false. - - - - - Using either the RegionEndpoint or the ServiceURL determine what the URL to the service is. - - The URL to the service. - - - - Performs validation on this config object. - Throws exception if any of the required values are missing/invalid. - - The timeout specified is null. - - - - Returns the clock skew adjusted utc now. This value is affected by AWSConfigs.ManualClockCorrection - - - - - Returns the calculated clock skew value for this config's service endpoint. If AWSConfigs.CorrectForClockSkew is false, - this value won't be used to construct service requests. - - - - - Gets the DisableHostPrefixInjection flag. If true, host prefix injection will be disabled for this client, the default value of this flag is false. - Host prefix injection prefixes the service endpoint with request members from APIs which use this feature. - Example: for a hostPrefix of "foo-name." and a endpoint of "service.region.amazonaws.com" the default behavior is to - prefix the endpoint with the hostPrefix resulting in a final endpoint of "foo-name.service.region.amazonaws.com". Setting - DisableHostPrefixInjection to true will disable hostPrefix injection resulting in a final endpoint of - "service.region.amazonaws.com" regardless of the value of hostPrefix. E.g. You may want to disable host prefix injection for testing against a local mock endpoint. - - - - - Returns the flag indicating if endpoint discovery should be enabled or disabled for operations that are not required to use endpoint discovery. - - - - - Returns the maximum number of discovered endpoints that can be stored within the cache for the client. The default limit is 1000 cache entries. - - - - - Returns the flag indicating the current mode in use for request - retries and influences the value returned from . - The default value is RequestRetryMode.Legacy. This flag can be configured - by using the AWS_RETRY_MODE environment variable, retry_mode in the - shared configuration file, or by setting this value directly. - - - - - Under Adaptive retry mode, this flag determines if the client should wait for - a send token to become available or don't block and fail the request immediately - if a send token is not available. - - - - - - This is a switch used for performance testing and is not intended for production applications - to change. This switch may be removed in a future version of the SDK as the .NET Core platform matures. - - - If true, the HttpClient is cached and reused for every request made by the service client - and shared with other service clients. - - - For the .NET Core platform this is default to true because the HttpClient manages the connection - pool. - - - - - - If CacheHttpClient is set to true then HttpClientCacheSize controls the number of HttpClients cached. - - - - - Gets the ProxyHost property. - - - - - Gets the ProxyPort property. - - - - - Returns a WebProxy instance configured to match the proxy settings - in the client configuration. - - - - - - Interface for a single logged message. - - - - - Log message format. - - - - - Log message arguments. - - - - - Culture-specific formatting provider. - - - - - Abstract parameter value. - - - - - String parameter value. - - - - - String value of the parameter. - - - - - Constructs ParameterValue for a single string. - - - - - - String list parameter value. - - - - - List of strings value of the parameter. - - - - - Constructs ParameterValue for a list of strings. - - - - - - Metrics collected by the SDK on a per-request basis. - - - Each request made to an AWS service by the SDK can have metrics - collected and logged. This interface represents the collected - metrics for a request. The metrics include properties (i.e. request id - and other metadata), timings for each stage of the request, and counters. - - - - - Collection of properties being tracked - - - - - Timings for metrics being tracked - - - - - Counters being tracked - - - - - Whether metrics are enabled for the request - - - - - JSON representation of the current metrics - - JSON string - - - - Represents how long a phase of an SDK request took. - - - - - Whether the timing has been stopped - - - - - Elapsed ticks from start to stop. - If timing hasn't been stopped yet, returns 0. - - - - - Elapsed time from start to stop. - If timing hasn't been stopped yet, returns TimeSpan.Zero - - - - - User supplied type to perform metrics formatting. - - - - - Produce custom formatting for SDK metrics. - - - If defined, this method will be called for every request made by the SDK. - - An instance of IRequestMetrics produced by the SDK - formatted string representation of the metrics - - - - Predefined request metrics that are collected by the SDK. - - - - - Information about the request. - - - - - Gets and sets the RequestId property. - ID that uniquely identifies a request. Amazon keeps track of request IDs. If you have a question about a request, include the request ID in your correspondence. - - - - - This exception is thrown if there are problems signing the request. - - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - - - - Gets the percentage of transfer completed - - - - - Gets the number of bytes transferred since last event - - - - - Gets the number of bytes transferred - - - - - Gets the total number of bytes to be transferred - - - - - Returns a string representation of this object - - - - - - Anonymous credentials. - Using these credentials, the client does not sign the request. - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - AWS Credentials that automatically refresh by calling AssumeRole on - the Amazon Security Token Service. - - - - - The credentials of the user that will be used to call AssumeRole. - - - - - The Amazon Resource Name (ARN) of the role to assume. - - - - - An identifier for the assumed role session. - - - - - Options to be used in the call to AssumeRole. - - - - - Constructs an AssumeRoleAWSCredentials object. - - The credentials of the user that will be used to call AssumeRole. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - - - - Constructs an AssumeRoleAWSCredentials object. - - The credentials of the user that will be used to call AssumeRole. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRole. - - - - A unique identifier that is used by third parties when assuming roles in their customers' accounts. - - - - - An IAM policy in JSON format. - - - - - The length of time in seconds before the credentials will expire. - - - - - The identification number of the MFA device that is associated with the user who is making the assume-role call. - - - - - The value provided by the MFA device, if the trust policy of the role being assumed requires MFA. - - - - - A callback that's used to obtain the MFA token code when the AssumeRoleAWSCredentials are refreshed. - - - - - Immutable representation of AWS credentials obtained as a result of - authenticating with the AssumeRole method of the Security Token Service. - - - - - The expiry time of the credentials, obtained from the AssumeRoleResponse. - - - - - Constructs an instance with supplied keys, token, and expiration. - - The AccessKey for the credentials. - The SecretKey for the credentials. - The security token for the credentials. - The expiration time for the credentials. - - - - Get a copy of this AssumeRoleImmutableCredentials object. - - A copy of this object. - - - - Abstract class that represents a credentials object for AWS services. - - - - - Returns a copy of ImmutableCredentials - - - - - - Called by AmazonServiceClient to validate the credential state - on client construction. - - - - - Basic set of credentials consisting of an AccessKey and SecretKey - - - - - Constructs a BasicAWSCredentials object for the specified accessKey and secretKey. - - - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - Immutable representation of AWS credentials. - - - - - Gets the AccessKey property for the current credentials. - - - - - Gets the SecretKey property for the current credentials. - - - - - Gets the Token property for the current credentials. - - - - - Gets the UseToken property for the current credentials. - Specifies if Token property is non-emtpy. - - - - - Constructs an ImmutableCredentials object with supplied accessKey, secretKey. - - - - Optional. Can be set to null or empty for non-session credentials. - - - - Returns a copy of the current credentials. - - - - - - Abstract class for automatically refreshing AWS credentials - - - - - Refresh state container consisting of credentials - and the date of the their expiration - - - - - Represents the current state of the Credentials. - - This can be cleared without synchronization. - - - - Semaphore to control thread access to GetCredentialsAsync method. - The semaphore will allow only one thread to generate new credentials and - update the current state. - - - - - The time before actual expiration to expire the credentials. - Property cannot be set to a negative TimeSpan. - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - Test credentials existence and expiration time - should update if: - credentials have not been loaded yet - it's past the expiration time. At this point currentState.Expiration may - have the PreemptExpiryTime baked into to the expiration from a call to - UpdateToGeneratedCredentials but it may not if this is new application load. - - - - - When overridden in a derived class, generates new credentials and new expiration date. - - Called on first credentials request and when expiration date is in the past. - - - - - - When overridden in a derived class, generates new credentials and new expiration date. - - Called on first credentials request and when expiration date is in the past. - - - - - - Clears currently-stored credentials, forcing the next GetCredentials call to generate new credentials. - - - - - Immutable representation of AWS credentials obtained as a result of - authenticating against a SAML-supporting federated identity provider. - - - - - The expiry time of the credentials, obtained from the AssumeRoleWithSAML response. - - - - - The value of the NameID element in the Subject element of the SAML assertion, as returned in the - AssumeRoleWithSAML response from the Security Token Service. - - - - - Constructs an instance with supplied keys and SAML assertion data. - - - - - - - - - - Constructs an instance with supplied keys and SAML assertion data. - - - - - - - - Returns a copy of the current credentials. - - - - - - Serializes the instance to a json-format string for external storage - - The serialized object in json - - - - Instantiates an instance from persisted json data - - The serialized data - Deserialized instance corresponding to the json data - - - - Session credentials consisting of AccessKey, SecretKey and Token - - - - - Constructs a SessionAWSCredentials object for the specified accessKey, secretKey. - - - - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - Credentials that are retrieved from the Instance Profile service on an EC2 instance - - - - - Constructs a InstanceProfileAWSCredentials object for specific role - - Role to use - - - - Constructs a InstanceProfileAWSCredentials object for the first found role - - - - - Retrieves a list of all roles available through current InstanceProfile service - - InstanceProfileAWSCredentials is no longer supported in PCL. - - - - - - Superclass for Exceptions that come over the event stream, or to wrap other kinds of generic exceptions. - - - - - The numeric code identifier for the type of error. - - - - - Constructs an EventStreamError. - - - - - Constructs an EventStreamError. - - The error code. - The error message. - - - - Event args that contain an . - - The - - - - The EventStream Event. - - - - - Constructs an EventStreamEventReceivedArgs. - - The EventStream Event. - - - - Event args that contain an . - - The . - - - - The EventStream Exception. - - - - - Constructs an EventStreamExceptionReceivedArgs. - - The EventStream Exception. - - - - Supported Header types for vnd.amazon.event-stream - - - - - Name for the Header. Maximum of 255 bytes. - - - - - Header type id - - - - - Computes the amount of memory neccesary to serialize this Header. - - - - - Writes this Header to buffer starting at offset - Keep in mind, this API assumes buffer is large enough - for the operation. - - buffer to serialize this Header to - offset to begin writing at. - - the new offset. - - - - - Returns the current value as a bool - - - - - Sets the current value - - - - - Returns the current value as a byte - - - - - Sets the current value - - - - - Gets the current value as a 16 bit integer. (Host Order). - - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a 32 bit integer. (Host Order) - - - - - Sets the current value - - - - - returns the current value as a 64-bit integer. (Host Order) - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a byte buffer. - - - - - - Sets the current value. Max length is 2^15 - 1 - - - - - Returns the current value as a utf-8 string. - - - - - Sets the current value. Utf-8 encoded. Max byte size is 2^16 - 1 - - - - - Gets the current value as a DateTime. - Note: You do not need to compensate for unix epoch on this API. - - - - - - Sets the current value. - Note: You do not need to compensate for unix epoch on this API. - - - - - Returns the current value as a Guid (UUID) - - - - - Sets the current value - - - - - Header Data for an EventStreamMessage - - Each header is of format: - [name len] (1) | [utf-8 name] (v) - [type (1)] - [value (v)] - - - - - Name for the Header. Maximum of 255 bytes. - - - - - Header type id - - - - - Initializes this Header with name. - - utf-8 string, max length is 255 - - - - Deserializes the header in buffer. - - buffer constaining the header - index to start from in the buffer. - updated offset with new value for offset - - - - Writes this Header to buffer starting at offset - Keep in mind, this API assumes buffer is large enough - for the operation. - - buffer to serialize this Header to - offset to begin writing at. - - the new offset. - - - - - Computes the amount of memory neccesary to serialize this Header. - - - - - Returns the current value as a bool - - - - - Sets the current value - - - - - Returns the current value as a byte - - - - - Sets the current value - - - - - Gets the current value as a 16 bit integer. (Host Order). - - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a 32 bit integer. (Host Order) - - - - - Sets the current value - - - - - returns the current value as a 64-bit integer. (Host Order) - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a byte buffer. - - - - - - Sets the current value. Max length is 2^15 - 1 - - - - - Returns the current value as a utf-8 string. - - - - - Sets the current value. Utf-8 encoded. Max byte size is 2^16 - 1 - - - - - Gets the current value as a DateTime. - Note: You do not need to compensate for unix epoch on this API. - - - - - - Sets the current value. - Note: You do not need to compensate for unix epoch on this API. - - - - - Returns the current value as a Guid (UUID) - - - - - Sets the current value - - - - - Headers for the message. Can be null. - - - - - Payload for the message. Can be null. - - - - - Converts a message into a byte buffer (usually for network transmission). - - - - - Message is a single datagram. The format is as follows: - [ total length (4) ] | [ headers_length (4)] | [ prelude crc(4)] - [ headers (v)] - [ payload (v)} - [ trailing crc ] - - CRCs use the CRC32 algorithm. - - - - - Content type for EventStreams. - - - - - Headers for the message. Can be null. - - - - - Payload for the message. Can be null. - - - - - Initialize a message with headers and a payload. - - list of headers for the message, can be null. - payload for the message, can be null. - - - - Builds a message from buffer. - - buffer to read - offset to start reading - buffer length. - - parsed instance of EventStreamMessage. Doesn't return null, - does throw if CRCs don't match. - - - - - Converts a message into a byte buffer (usually for network transmission). - - - - - Defines exceptions that arise from an not conforming to specification. - - - - - Constructs an EventStreamValidationException. - - - - - Constructs an EventStreamValidationException. - - The exception message. - - - - Constructs an EventStreamValidationException. - - The exception message. - The inner exception. - - - - This exception is thrown if an exception is retrieved from the event stream and should be modeled, - but a generator function for the strongly-typed exception is not defined. - - - - - The exception type. - - - - - Constructs an EventStreamException. - - The exception type. - - - - The contract for the . - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - A subclass of that enables an enumerable interface for interacting with Events. - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - Flag if the stream was chosen to be enumerated. - - - - - A Stream of Events. Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treated as mutually exclusive. - - - - - A Stream of Events. Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treated as mutually exclusive. - - - - - Returns an enumerator that iterates through the collection. - - An enumerator that can be used to iterate through the collection. - - - - Returns an enumerator that iterates through a collection. - - An object that can be used to iterate through the collection. - - - - Starts the background thread to start reading events from the network stream. - - - - - The contract for the . - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - The size of the buffer for reading from the network stream. - - - - - Fires when an event is received. - - - - - Fired when an exception or error is raised. - - - - - Starts the background thread to start reading events from the network stream. - - - - - The superclass for all EventStreams. It contains the common processing logic needed to retreive events from a network Stream. It - also contains the mechanisms needed to have a background loop raise events. - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - "Unique" key for unknown event lookup. - - - - - Header key for message type. - - - - - Header key for event type. - - - - - Header key for exception type. - - - - - Header key for error code. - - - - - Header key for error message. - - - - - Value of when the message is an event. - - - - - Value of when the message is an exception. - - - - - Value of when the message is an error. - - - - - The size of the buffer for reading from the network stream. - Default is 8192. - - - - - The underlying stream to read events from. - - - - - Responsible for decoding events from sequences of bytes. - - - - - Fires when an event is recieved. - - - - - Fired when an exception or error is raised. - - - - - The mapping of event message to a generator function to construct the matching Event Stream event. - - - - - The mapping of event message to a generator function to construct the matching Event Stream exception. - - - - - Whether the Stream is currently being processed. - - - - - A Stream of Events. Events can be retrieved from this stream by attaching handlers to listen events, and then calling StartProcessing. - - - - - A Stream of Events. Events can be retrieved from this stream by attaching handlers to listen events, and then calling StartProcessing. - - - - - Converts an EventStreamMessage to an event. - - The event stream message to be converted. - The event - - - - Abstraction for cross-framework initiation of the background thread. - - - - - The background thread main loop. It will constantly read from the network stream until IsProcessing is false, or an error occurs. - - This stub exists due to FXCop. - - - - - The background thread main loop. It will constantly read from the network stream until IsProcessing is false, or an error occurs. - - Needed for 3.5 support. Not used. - - - - Reads from the stream into the buffer. It then passes the buffer to the decoder, which raises an event for - each message it decodes. - - The buffer to store the read bytes from the stream. - - - - Wraps exceptions in an outer exception so they can be passed to event handlers. If the Exception is already of a compatable type, - the method returns what it was given. - - The exception to wrap. - An exception of type TE - - - - Starts the background thread to start reading events from the network stream. - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Disposes the resources of this stream. - - Should dispose of unmanged resources. - - - - Event Arguments for EventStreamDecoder.MessageReceived. - - - - - Received message. - - - - - Additional object context - - - - - Initialize this with message - - - - - Initialize this with message and object conetext - - - - - Exception thrown when a request is made of the Decoder, but the internal state - machine is an invalid state. This is usually the result of an interanl exception - being thrown during parsing of the network stream. - - - - - Contract for EventStreamDecoder - - - - - Invoked anytime an EventStreamMessage is found. - - - - - Processes data starting at offset up to length. - Invokes MessageRecieved for each message encountered. - If an exception is thrown, this object is not safe for reuse. - - buffer to read - offset in buffer to start reading. - length of data. - - - - Streaming decoder for listening for incoming EventStreamMessage datagrams. - - - - - Invoked anytime an EventStreamMessage is found. - - - - - Object data (optional) that can be passed to the event handler for MessageReceived. - - - - - Default constructor. Initializes internal _state machine. - - - - - Processes data starting at offset up to length. - Invokes MessageRecieved for each message encountered. - If an exception is thrown, this object is not safe for reuse. - - buffer to read - offset in buffer to start reading. - length of data. - - - - Superclass for Exceptions that come over the event stream, or to wrap other kinds of generic exceptions. - - - - - Constructs an EventStreamException. - - - - - Constructs an EventStreamException. - - The exception message. - - - - Constructs an EventStreamException. - - The exception message. - The inner exception. - - - - The contract for EventStream events. - - - - - The contract for EventStream terminal events. - - - - - This Event is returned if an event is retrieved from the event stream, but a generator function - for the event is not defined. This can occur if the SDK is not updated after a new event type is introduced. - - - - - The Message recieved from the event stream before conversion. - - - - - The event type. - - - - - Constructs an UnknownEventStreamEvent. - - - - - Constructs an UnknownEventStreamEvent. - - The Message recieved from the event stream before conversion. - The event type. - - - - Signals that an an has an unknown message type. These exceptions whould be - swallowed to allow future expansion of the EventStream specification without breaking existing clients. - - - - - Constructs an UnknownEventStreamMessageTypeException. - - - - - Interface for a handler in a pipeline. - - - - - The logger used to log messages. - - - - - The inner handler which is called after the current - handler completes it's processing. - - - - - The outer handler which encapsulates the current handler. - - - - - Contains the processing logic for a synchronous request invocation. - This method should call InnerHandler.InvokeSync to continue processing of the - request by the pipeline, unless it's a terminating handler. - - The execution context which contains both the - requests and response context. - - - - Contains the processing logic for an asynchronous request invocation. - This method should call InnerHandler.InvokeSync to continue processing of the - request by the pipeline, unless it's a terminating handler. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - The interface for an exception handler. - - - - - Handles an exception for the given execution context. - - The execution context, it contains the - request and response context. - The exception to handle. - - Returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception to replace the original exception. - - - - - The interface for an exception handler with a generic parameter for the exception type. - - The exception type. - - - - Handles an exception for the given execution context. - - The execution context, it contains the - request and response context. - The exception to handle. - - Returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception to replace the original exception. - - - - - The interface for a HTTP request factory. - - The type used by the underlying HTTP API to represent the request body. - - - - Creates an HTTP request for the given URI. - - The request URI. - An HTTP request. - - - - The interface for an HTTP request that is agnostic of the underlying HTTP API. - - The type used by the underlying HTTP API to represent the HTTP request content. - - - - The HTTP method or verb. - - - - - The request URI. - - - - - Configures a request as per the request context. - - The request context. - - - - Sets the headers on the request. - - A dictionary of header names and values. - - - - Gets a handle to the request content. - - The request content. - - - - Returns the HTTP response. - - The HTTP response. - - - - Writes a stream to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - The request context. - - - - Writes a byte array to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - - - - Sets up the progress listeners - - The content stream - The interval at which progress needs to be published - The objects which is trigerring the progress changes - The callback which will be invoked when the progress changed event is trigerred - an object, incase the progress is setup, else returns the original stream - - - - Aborts the HTTP request. - - - - - Gets a handle to the request content. - - - - - - Returns the HTTP response. - - A cancellation token that can be used to cancel the asynchronous operation. - - - - - A factory which creates HTTP clients. - - - - - Create and configure an HttpClient. - - - - - - A factory which creates HTTP requests which uses System.Net.Http.HttpClient. - - - - - The constructor for HttpRequestMessageFactory. - - Configuration setting for a client. - - - - Creates an HTTP request for the given URI. - - The request URI. - An HTTP request. - - - - Disposes the HttpRequestMessageFactory. - - - - - Dispose the factory - - - - - - Create and configure a managed HttpClient instance. - The use of HttpClientHandler in the constructor for HttpClient implicitly creates a managed HttpClient. - If a native HttpClient is required the SDK user must implement IHttpClientFactory and provide an - instance via IClientConfig.HttpClientFactory (only available in PCL). - - - - - - - A cache of HttpClient objects. The GetNextClient method does a round robin cycle through the clients - to distribute the load even across. - - - - - Constructs a container for a cache of HttpClient objects - - The HttpClient to cache - - - - Returns the next HttpClient using a round robin rotation. It is expected that individual clients will be used - by more then one Thread. - - - - - - Disposes the HttpClientCache. - - - - - Dispose the HttpClientCache - - - - - - HTTP request wrapper for System.Net.Http.HttpRequestMessage. - - - - - Set of content header names. - - - - - The constructor for HttpWebRequestMessage. - - The HttpClient used to make the request. - The request URI. - The service client config. - - - - The underlying HttpClient - - - - - The underlying HTTP web request. - - - - - The HTTP method or verb. - - - - - The request URI. - - - - - Configures a request as per the request context. - - The request context. - - - - Sets the headers on the request. - - A dictionary of header names and values. - - - - Gets a handle to the request content. - - The request content. - - - - Returns the HTTP response. - - The HTTP response. - - - - Aborts the HTTP request. - - - - - Returns the HTTP response. - - A cancellation token that can be used to cancel the asynchronous operation. - - - - - Writes a stream to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - The request context. - - - - Writes a byte array to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - - - - Gets a handle to the request content. - - - - - - Disposes the HttpWebRequestMessage. - - - - - - - - - - - Sets up the progress listeners - - The content stream - The interval at which progress needs to be published - The objects which is trigerring the progress changes - The callback which will be invoked when the progress changed event is trigerred - an object, incase the progress is setup, else returns the original stream - - - - A retry policy specifies all aspects of retry behavior. This includes conditions when the request should be retried, - checks of retry limit, preparing the request before retry and introducing delay (backoff) before retries. - - - A retry policy specifies all aspects of retry behavior. This includes conditions when the request should be retried, - checks of retry limit, preparing the request before retry and introducing delay (backoff) before retries. - - - - - Maximum number of retries to be performed. - This does not count the initial request. - - - - - The logger used to log messages. - - - - - The standard set of throttling error codes - - - - - The standard set of timeout error codes to retry on. - - - - - List of AWS specific error codes which are returned as part of the error response. - These error codes will be retried. - - - - - The standard set of transient error, HTTP status codes to retry on. - 502 and 504 are returned by proxies. These can also be returned for - S3 accelerate requests which are served by CloudFront. - - - - - Set of web exception status codes to retry on. - - - - - This parameter serves as the value to the CapacityManager.Container datastructure. - Its properties include the available capacity left for making a retry request and the maximum - capacity size. - - - - - Checks if a retry should be performed with the given execution context and exception. - - The execution context which contains both the - requests and response context. - The exception thrown after issuing the request. - Returns true if the request should be retried, else false. The exception is retried if it matches with clockskew error codes. - - - - Returns true if the request is in a state where it can be retried, else false. - - The execution context which contains both the - requests and response context. - Returns true if the request is in a state where it can be retried, else false. - - - - Return true if the request should be retried for the given exception. - - The execution context which contains both the - requests and response context. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Checks if the retry limit is reached. - - The execution context which contains both the - requests and response context. - Return false if the request can be retried, based on number of retries. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called on a successful request response. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called before a retry request is initiated. The value - returned is True by default(retry throttling feature is disabled). - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called before a retry request is initiated. The value - returned is True by default(retry throttling feature is disabled). - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - - - - Virtual method that gets called before a retry request is initiated. The value - returned is True by default(retry throttling feature is disabled). - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - true if the error that will be retried is a throttling error - - - - This method uses a token bucket to enforce the maximum sending rate. - - The execution context which contains both the - requests and response context. - If the prior request failed, this exception is expected to be - the exception that occurred during the prior request failure. - - - - Determines if an AmazonServiceException is a throttling error - - The current exception to check. - true if it is a throttling error else false. - - - - Determines if an AmazonServiceException is a transient error that - should be retried. - - The current execution context - The current exception to check. - true if the exception is a transient error else false. - - - - Determines if the exception is a known timeout error code that - should be retried under the timeout error category. - - The current exception to check. - true if the exception is considered a timeout else false - - - - Checks if a retry should be performed with the given execution context and exception. - - The execution context which contains both the - requests and response context. - The exception throw after issuing the request. - Returns true if the request should be retried, else false. The exception is retried if it matches with clockskew error codes. - - - - This method uses a token bucket to enforce the maximum sending rate. - - The execution context which contains both the - requests and response context. - If the prior request failed, this exception is expected to be - the exception that occurred during the prior request failure. - - - - Return true if the request should be retried for the given exception. - - The execution context which contains both the - requests and response context. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - ICoreAmazonKMS is not meant to be used directly. It defines Key Management Service - with basic .NET types and allows other services to be able to use the service as - a runtime dependency. This interface is implemented by the AmazonKeyManagementServiceClient - defined in the AWSSDK.KeyManagementService assembly. - - - - - The result of the GenerateDataKey and GenerateDataKeyAsync operations. - - - - - The plaintext for the data key. - - - - - The ciphertext for the data key. - - - - - ICoreAmazonS3 is not meant to use directly. It defines S3 with basic .NET types - and allows other services to be able to use S3 as a runtime dependency. This interface - is implemented by the AmazonS3Client defined in the S3 assembly. - - - ICoreAmazonS3 is not meant to use directly. It defines S3 with basic .NET types - and allows other services to be able to use S3 as a runtime dependency. This interface - is implemented by the AmazonS3Client defined in the S3 assembly. - - - - - Generate a presigned URL. - - - - - - - - - - Get all the object keys for the particular bucket and key prefix. - - - - - - - - - Upload an object from a stream. - - - - - - - - - - - Delete an object. - - - - - - - - - - Delete an object. - - - - - - - - - - Open a stream to an object in S3. - - - - - - - - - - Upload an object from a file path. - - - - - - - - - - - Download an object in S3 to a file path. - - - - - - - - - - - Set the ACL on the object to public readable. - - - - - - - - Check to see if the bucket exists and if it doesn't create the bucket. - - - - - - Check to see if the bucket exists. - - - - - - - ICoreAmazonSQS is not meant to use directly. It defines SQS with basic .NET types - and allows other services to be able to use SQS as a runtime dependency. This interface - is implemented by the AmazonSQSClient defined in the SQS assembly. - - - - - Get the attributes for the queue identified by the queue URL asynchronously. - - The queue URL to get attributes for. - A Task containing the result of a dictionary of attributes for the queue. - - - - Set the attributes on the queue identified by the queue URL asynchronously. - - The queue URL to set the attributues. - The attributes to set. - A Task - - - - ICoreAmazonSTS is not meant to be used directly. It defines Security Token - service with basic .NET types and allows other services to be able to use the service as - a runtime dependency. This interface is implemented by the AmazonSecurityTokenServiceClient - defined in the AWSSDK.SecurityToken assembly. - - - - - - This method is used internally to access the Amazon Security Token - service within other service assemblies. - Please use AmazonSecurityTokenServiceClient to access the Amazon Security Token - service instead. - - Use Amazon Security Token Service to assume a role. - - Proxy settings that are required for the HTTPS and STS calls made during the authentication/credential - generation process are supported and should have been configured on the STS ClientConfig instance - associated with the STS client instance exposing this interface. - - - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRole. - - - - - CoreAmazonKMS is not meant to use directly. It implements ICoreAmazonKMS - and allows other service clients to be able to use the KMS service as a runtime dependency. - - This class waits until a method is actually called on the ICoreAmazonKMS interface - before requiring the KMS assembly to be present and loaded. - - - - - Settings for configuring a proxy for the SDK to use. - - - - - The host name or IP address of the proxy server. - - - - - The port number of the proxy. - - - - - The username to authenticate with the proxy server. - - - - - The password to authenticate with the proxy server. - - - - - Collection of one or more regular expressions denoting addresses - for which the proxy will not be used. - - - For more information on bypass lists - see https://msdn.microsoft.com/en-us/library/system.net.webproxy.bypasslist%28v=vs.110%29.aspx. - - - - - If true requests to local addresses bypass the configured - proxy. - - - - - Settings for logging in the SDK. - - - - - Logging destination. - - - - - When to log responses. - - - - - Gets or sets the size limit in bytes for logged responses. - If logging for response body is enabled, logged response - body is limited to this size. The default limit is 1KB. - - - - - Whether or not to log SDK metrics. - - - - - A custom formatter added through Configuration - - - - - This class can be used to discover the public address ranges for AWS. The - information is retrieved from the publicly accessible - https://ip-ranges.amazonaws.com/ip-ranges.json file. - - - The information in this file is generated from our internal system-of-record and - is authoritative. You can expect it to change several times per week and should - poll accordingly. - - - - - Region identifier string for ROUTE53 and CLOUDFRONT ranges - - - - - Collection of service keys found in the data file. - - - - - The publication date and time of the file that was downloaded and parsed. - - - - - Collection of all public IP ranges. - - - - - Filtered collection of public IP ranges for the given service key - - - - - Filtered collection of public IP ranges for the given region (us-east-1 etc) or GLOBAL. - - - - - Filtered collection of public IP ranges for the given network border group. - - - - - Downloads the most recent copy of the endpoint address file and - parses it to a collection of address range objects. - - - - - Downloads the most recent copy of the endpoint address file and - parses it to a collection of address range objects. - - - - - Represents the IP address range for a single region and service key. - - - - - The public IPv4 or Ipv6 address range, in CIDR notation. - - - - - Indicates ipv4 or v6 format of the address - - - - - The AWS region or GLOBAL for edge locations. Note that the CLOUDFRONT and ROUTE53 - ranges are GLOBAL. - - - - - The subset of IP address ranges. Specify AMAZON to get all IP address ranges - (for example, the ranges in the EC2 subset are also in the AMAZON subset). Note - that some IP address ranges are only in the AMAZON subset. - - - Valid values for the service key include "AMAZON", "EC2", "ROUTE53", - "ROUTE53_HEALTHCHECKS", and "CLOUDFRONT." If you need to know all of - the ranges and don't care about the service, use the "AMAZON" entries. - The other entries are subsets of this one. Also, some of the services, - such as S3, are represented in "AMAZON" and do not have an entry that - is specific to the service. We plan to add additional values over time; - code accordingly! - - - - - The network border group the IP address range belongs to. - - - AWS Local Zones allow you to seamlessly connect to the full range of services in the AWS Region such - as Amazon Simple Storage Service and Amazon DynamoDB through the same APIs and tool sets. You can extend - your VPC Region by creating a new subnet that has a Local Zone assignment. When you create a subnet in - a Local Zone, the VPC is also extended to that Local Zone. - - A network border group is a unique set of Availability Zones or Local Zones from where AWS advertises - public IP addresses. - - When you create a VPC that has IPv6 addresses, you can choose to assign a set of Amazon-provided public - IP addresses to the VPC and also set a network border group for the addresses that limits the addresses - to the group. When you set a network border group, the IP addresses cannot move between network - border groups. The us-west-2 network border group contains the four US West (Oregon) Availability Zones. - The us-west-2-lax-1 network border group contains the Los Angeles Local Zones. - - - - - This class defines utilities and constants that can be used by - all the client libraries of the SDK. - - - - - The user agent string header - - - - - The Set of accepted and valid Url characters per RFC3986. - Characters outside of this set will be encoded. - - - - - The Set of accepted and valid Url characters per RFC1738. - Characters outside of this set will be encoded. - - - - - The set of accepted and valid Url path characters per RFC3986. - - - - - The string representing Url Encoded Content in HTTP requests - - - - - The GMT Date Format string. Used when parsing date objects - - - - - The ISO8601Date Format string. Used when parsing date objects - - - - - The ISO8601Date Format string. Used when parsing date objects - - - - - The ISO8601 Basic date/time format string. Used when parsing date objects - - - - - The ISO8601 basic date format. Used during AWS4 signature computation. - - - - - The RFC822Date Format string. Used when parsing date objects - - - - - Returns an extension of a path. - This has the same behavior as System.IO.Path.GetExtension, but does not - check the path for invalid characters. - - - - - - Convert request parameters to Url encoded query string - - - Convert Dictionary of parameters to Url encoded query string - - - - Returns the canonicalized resource path for the service endpoint with single URL encoded path segments. - - Endpoint URL for the request - Resource path for the request - - If resourcePath begins or ends with slash, the resulting canonicalized - path will follow suit. - - Canonicalized resource path for the endpoint - - - - Returns the canonicalized resource path for the service endpoint - - Endpoint URL for the request - Resource path for the request - If true pre URL encode path segments if necessary. - S3 is currently the only service that does not expect pre URL encoded segments. - - If resourcePath begins or ends with slash, the resulting canonicalized - path will follow suit. - - Canonicalized resource path for the endpoint - - - - Returns the canonicalized resource path for the service endpoint - - Endpoint URL for the request - Resource path for the request - If true pre URL encode path segments if necessary. - S3 is currently the only service that does not expect pre URL encoded segments. - Dictionary of key/value parameters containing the values for the ResourcePath key replacements - The version of the marshaller that constructed the request object. - - If resourcePath begins or ends with slash, the resulting canonicalized - path will follow suit. - - Canonicalized resource path for the endpoint - - - - Splits the resourcePath at / into segments then resolves any keys with the path resource values. Greedy - key values will be split into multiple segments at each /. - - The patterned resourcePath - The key/value lookup for the patterned resourcePath - A list of path segments where all keys in the resourcePath have been resolved to one or more path segment values - - - - Joins all path segments with the / character and encodes each segment before joining. - - The segments of a URL path split at each / character - If the path property is specified, - the accepted path characters {/+:} are not encoded. - A joined URL with encoded segments - - - - Takes a patterned resource path and resolves it using the key/value path resources into - a segmented encoded URL. - - The patterned resourcePath - The key/value lookup for the patterned resourcePath - A segmented encoded URL - - - - Returns a new string created by joining each of the strings in the - specified list together, with a comma between them. - - The list of strings to join into a single, comma delimited - string list. - A new string created by joining each of the strings in the - specified list together, with a comma between strings. - - - - Attempt to infer the region for a service request based on the endpoint - - Endpoint to the service to be called - - Region parsed from the endpoint; DefaultRegion (or DefaultGovRegion) - if it cannot be determined/is not explicit - - - - - Attempt to infer the service name for a request (in short form, eg 'iam') from the - service endpoint. - - Endpoint to the service to be called - - Short-form name of the service parsed from the endpoint; empty string if it cannot - be determined - - - - - Utility method for converting Unix epoch seconds to DateTime structure. - - The number of seconds since January 1, 1970. - Converted DateTime structure - - - - Helper function to format a byte array into string - - The data blob to process - If true, returns hex digits in lower case form - String version of the data - - - - Calls a specific EventHandler in a background thread - - - - - - - - Parses a query string of a URL and returns the parameters as a string-to-string dictionary. - - - - - - - Utility method for converting a string to a MemoryStream. - - - - - - - Utility method for copy the contents of the source stream to the destination stream. - - - - - - - Utility method for copy the contents of the source stream to the destination stream. - - - - - - - - Formats the current date as a GMT timestamp - - A GMT formatted string representation - of the current date and time - - - - - Formats the current date as ISO 8601 timestamp - - An ISO 8601 formatted string representation - of the current date and time - - - - - Gets the ISO8601 formatted timestamp that is minutesFromNow - in the future. - - The number of minutes from the current instant - for which the timestamp is needed. - The ISO8601 formatted future timestamp. - - - - Formats the current date as ISO 8601 timestamp - - An ISO 8601 formatted string representation - of the current date and time - - - - - Gets the RFC822 formatted timestamp that is minutesFromNow - in the future. - - The number of minutes from the current instant - for which the timestamp is needed. - The ISO8601 formatted future timestamp. - - - - Determines whether the given string is an absolute path to a root. - - The hypothetical absolute path. - True if is an absolute path. - - - - Returns true if the path specified is relative to the current drive or working directory. - Returns false if the path is fixed to a specific drive or UNC path. This method does no - validation of the path (URIs will be returned as relative as a result). - - - Handles paths that use the alternate directory separator. It is a frequent mistake to - assume that rooted paths (Path.IsPathRooted) are not relative. This isn't the case. - "C:a" is drive relative- meaning that it will be resolved against the current directory - for C: (rooted, but relative). "C:\a" is rooted and not relative (the current directory - will not be used to modify the path). - - - - - True if the given character is a directory separator. - - - - - Returns true if the given character is a valid drive letter - - - - - URL encodes a string per RFC3986. If the path property is specified, - the accepted path characters {/+:} are not encoded. - - The string to encode - Whether the string is a URL path or not - The encoded string - - - - URL encodes a string per the specified RFC. If the path property is specified, - the accepted path characters {/+:} are not encoded. - - RFC number determing safe characters - The string to encode - Whether the string is a URL path or not - The encoded string - - Currently recognised RFC versions are 1738 (Dec '94) and 3986 (Jan '05). - If the specified RFC is not recognised, 3986 is used by default. - - - - - URL encodes a string per the specified RFC with the exception of preserving the encoding of previously encoded slashes. - If the path property is specified, the accepted path characters {/+:} are not encoded. - - The string to encode - Whether the string is a URL path or not - The encoded string with any previously encoded %2F preserved - - - - Convert bytes to a hex string - - Bytes to convert. - Hexadecimal string representing the byte array. - - - - Convert a hex string to bytes - - Hexadecimal string - Byte array corresponding to the hex string. - - - - Returns DateTime.UtcNow + ManualClockCorrection when - is set. - This value should be used instead of DateTime.UtcNow to factor in manual clock correction - - - - - Returns true if the string has any bidirectional control characters. - - - - - - - Executes an HTTP request and returns the response as a string. This method - throws WebException and HttpRequestException. In the event HttpRequestException - is thrown the StatusCode is sent as user defined data on the exception under - the key "StatusCode". - - The URI to make the request to - The request type: GET, PUT, POST - null or the content to send with the request - Timeout for the request - Proxy for the request - null or any headers to send with the request - The response as a string. - - - - Utility method that accepts a string and replaces white spaces with a space. - - - - - - - Class that contains result of executing an external process through the SDKs - AWSSDKUtils.RunProcess/AWSSDKUtils.RunProcessAsync - - - - - The exit code with which the process exited - - - - - The output of the process read till the end - - - - - The error output of the process read till the end - - - - - Object to track circular references in nested types. - At each level of nesting, make a call to Track to retrieve Tracker, - a tracking object implementing the IDisposable interface. - Dispose of this tracker when leaving the context of the tracked object. - - - - - Tracker. Must be disposed. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Adds the current target to a reference list and returns a tracker. - The tracker removes the target from the reference list when the - tracker is disposed. - - - - - - - Root AWS config - - - - - AwsHttpClient is a wrapper around HttpClient class of the System.Net.Http library. - The wrapper has been added so as to remove System.Net.Http dependencies from the Services - and migrate it to a Core level dependecy only. This avoids version clashes when a service - and the Core depends on different versions of the System.Net.Http library. This is a Service - level utility method - - - - - AWSHttpClient wrapper that is wrapped around - HttpClient default wrapper. - - - - - AWSHttpClient BaseAddress property that is wrapper for - HttpClient BaseAddress property. - - - - - AWSHttpClient Timeout property that is wrapper for - HttpClient Timeout property. - - - - - AWSHttpClient MaxResponseContentBufferSize property that is wrapper for - HttpClient MaxResponseContentBufferSize property. - - - - - AWSHttpClient GetStreamAsync that accepts the requester's URI - and make a HttpClient.GetStreamAsync call. - - Requester Uri - - - - Wrapper method that accepts a request uri, stream content and headers and makes a sendAsync call. - - - - - - - Wrapper for HttpClient's HttpRequestMessage and SendAsync methods. - - - - Returns response headers information- header name,value and status code - - - - Wrapper for HttpClient Dispose. - - - - - Method that checks if the passed exception is of type - HttpRequestException - - - - - - - AWSStreamContent is a wrapper for StreamContent class in - the System.Net.Http library.The wrapper has been added so as to - remove System.Net.Http dependencies from the Services - and migrate it to a Core level dependecy only. This avoids version clashes when a service - and the Core depends on different versions of the System.Net.Http library. This is a Service - level utility method - - - - - Wrapper for StreamContent constructor - for stream content - - - - - - Wrapper for StreamContent constructor - for stream content and bufferSize - - - - - - - Wrapper to allow Services to remove StreamContent Headers - - - - - - - Wrapper to allow Services to add StreamContent Headers - - - - - - - Wrapper for StreamContent Dispose. - - - - - Allows to configure the proxy used for HTTP requests. The default value is null. - - - - - This class contains the endpoints available to the AWS clients. The static constants representing the - regions can be used while constructing the AWS client instead of looking up the exact endpoint URL. - - - - - Gets the endpoint for a service in a region. - - The services system name. - If true returns the endpoint for dualstack - Thrown when the request service does not have a valid endpoint in the region. - - - - - Enumerate through all the regions. - - - - - Gets the region based on its system name like "us-west-1" - - The system name of the service like "us-west-1" - - - - - This is a testing method and should not be called by production applications. - - - - - Gets the system name of a region. - - - - - Gets the display name of a region. - - - - - This region name is non-standard. Search the whole endpoints.json file to - determine the partition this region is in. - - - - - This class contains region information used to lazily compute the service endpoints. The static constants representing the - regions can be used while constructing the AWS client instead of looking up the exact endpoint URL. - - - - - The US East (Virginia) endpoint. - - - - - The US East (Virginia) regional endpoint. - - - - - The US East (Ohio) endpoint. - - - - - The US West (N. California) endpoint. - - - - - The US West (Oregon) endpoint. - - - - - The EU North (Stockholm) endpoint. - - - - - The EU West (Ireland) endpoint. - - - - - The EU West (London) endpoint. - - - - - The EU West (Paris) endpoint. - - - - - The EU Central (Frankfurt) endpoint. - - - - - The Europe (Milan) endpoint. - - - - - The Asia Pacific (Hong Kong) endpoint. - - - - - The Asia Pacific (Tokyo) endpoint. - - - - - The Asia Pacific (Seoul) endpoint. - - - - - The Asia Pacific (Osaka-Local) endpoint. - - - - - The Asia Pacific (Mumbai) endpoint. - - - - - The Asia Pacific (Singapore) endpoint. - - - - - The Asia Pacific (Sydney) endpoint. - - - - - The South America (Sao Paulo) endpoint. - - - - - The US GovCloud East (Virginia) endpoint. - - - - - The US GovCloud West (Oregon) endpoint. - - - - - The China (Beijing) endpoint. - - - - - The China (Ningxia) endpoint. - - - - - The Canada (Central) endpoint. - - - - - The Middle East (Bahrain) endpoint. - - - - - The Africa (Cape Town) endpoint. - - - - - Represents the endpoint overridding rules in the endpoints.json - Is used to map private region (ie us-east-1-regional) to public regions (us-east-1) - For signing purposes. - - - - - Enumerate through all the regions. - - - - - Gets the region based on its system name like "us-west-1" - - The system name of the service like "us-west-1" - - - - - Gets the region endpoint override if exists - - The region endpoint to find the possible override for - - - - - Gets the system name of a region. - - - - - Gets the display name of a region. - - - - - Gets the partition name the region is in. For example for us-east-1 the partition name is aws. For cn-northwest-1 the partition name is aws-cn. - - - - - Gets the dns suffix for the region endpoints in a partition. For example the aws partition's suffix is amazonaws.com. The aws-cn partition's suffix is amazonaws.com.cn. - - - - - Gets the endpoint for a service in a region. - - - The services system name. Service system names can be obtained from the - RegionEndpointServiceName member of the ClientConfig-derived class for the service. - - - For forwards compatibility, if the service being requested for isn't known in the region, this method - will generate an endpoint using the AWS endpoint heuristics. In this case, it is not guaranteed the - endpoint will point to a valid service endpoint. - - - - - - Gets the endpoint for a service in a region, optionally selecting a dualstack compatible endpoint. - - - The services system name. Service system names can be obtained from the - RegionEndpointServiceName member of the ClientConfig-derived class for the service. - - - If true a dualstack endpoint is returned. It is the user's responsibility to verify that the given service - supports a dualstack endpoint for the region. - - - For forwards compatibility, if the service being requested for isn't known in the region, this method - will generate an endpoint using the AWS endpoint heuristics. In this case, it is not guaranteed the - endpoint will point to a valid service endpoint. - - - - - - This class defines an endpoints hostname and which protocols it supports. - - - - - Gets the hostname for the service. - - - - - The authentication region to be used in request signing. - - - - - This property is only set for S3 endpoints. For all other services this property returns null. - For S3 endpoints, if the endpoint supports signature version 2 this property will be "2", otherwise it will be "4". - - - - - Calculates a 32bit Cyclic Redundancy Checksum (CRC) using the - same polynomial used by Zip. This type is used internally by DotNetZip; it is generally not used directly - by applications wishing to create, read, or manipulate zip archive files. - - - - - indicates the total number of bytes read on the CRC stream. - This is used when writing the ZipDirEntry when compressing files. - - - - - Indicates the current CRC for all blocks slurped in. - - - - - Returns the CRC32 for the specified stream. - - The stream over which to calculate the CRC32 - the CRC32 calculation - - - - Returns the CRC32 for the specified stream, and writes the input into the output stream. - - The stream over which to calculate the CRC32 - The stream into which to deflate the input - the CRC32 calculation - - - - Get the CRC32 for the given (word,byte) combo. - This is a computation defined by PKzip. - - The word to start with. - The byte to combine it with. - The CRC-ized result. - - - - Update the value for the running CRC32 using the given block of bytes. - This is useful when using the CRC32() class in a Stream. - - block of bytes to slurp - starting point in the block - how many bytes within the block to slurp - - - - A Stream that calculates a CRC32 (a checksum) on all bytes read, - or on all bytes written. - - - - - This class can be used to verify the CRC of a ZipEntry when reading from a stream, - or to calculate a CRC when writing to a stream. The stream should be used to either - read, or write, but not both. If you intermix reads and writes, the results are - not defined. - - This class is intended primarily for use internally by the DotNetZip library. - - - - - Gets the total number of bytes run through the CRC32 calculator. - - - - This is either the total number of bytes read, or the total number - of bytes written, depending on the direction of this stream. - - - - - The constructor. - - The underlying stream - - - - The constructor. - - The underlying stream - The length of the stream to slurp - - - - Provides the current CRC for all blocks slurped in. - - - - - Read from the stream - - the buffer to read - the offset at which to start - the number of bytes to read - the number of bytes actually read - - - - Write to the stream. - - the buffer from which to write - the offset at which to start writing - the number of bytes to write - - - - Indicates whether the stream supports reading. - - - - - Indicates whether the stream supports seeking. - - - - - Indicates whether the stream supports writing. - - - - - Flush the stream. - - - - - Not implemented. - - - - - Not implemented. - - - - - Not implemented. - - N/A - N/A - N/A - - - - Not implemented. - - N/A - - - diff --git a/packages/AWSSDK.Core.3.3.107.14/lib/portable-net45+win8+wpa81+wp8/AWSSDK.Core.dll b/packages/AWSSDK.Core.3.3.107.14/lib/portable-net45+win8+wpa81+wp8/AWSSDK.Core.dll deleted file mode 100644 index e773c7e..0000000 Binary files a/packages/AWSSDK.Core.3.3.107.14/lib/portable-net45+win8+wpa81+wp8/AWSSDK.Core.dll and /dev/null differ diff --git a/packages/AWSSDK.Core.3.3.107.14/lib/uap/AWSSDK.Core.XML b/packages/AWSSDK.Core.3.3.107.14/lib/uap/AWSSDK.Core.XML deleted file mode 100644 index 5323a9e..0000000 --- a/packages/AWSSDK.Core.3.3.107.14/lib/uap/AWSSDK.Core.XML +++ /dev/null @@ -1,10800 +0,0 @@ - - - - AWSSDK.Core - - - - - Utility class to parse Amazon resource names more commonly known as an ARN. - - - - - Gets and sets the partition associated with the ARN (e.g.: 'aws'). - - - - - Gets and sets the AWS service associated with the ARN (e.g.: 's3'). - - - - - Gets and sets the region associated with the ARN (e.g.: 'us-east-1'). - - - - - Gets and sets the account ID associated with the ARN. - - - - - Gets and sets the resource associated with the ARN (e.g.: 'mybucket/myobject'). - - - - - Returns true if the string appears to be an ARN by seeing if the string starts with "arn:". This method - doesn't guarantee the string is a valid ARN. To validate the string call TryParse. - - - - - - - Parses the string into an ARN object. - - String to parse into an ARN. - The out parameter for the ARN object created by TryParse. - True if the string was parsed into an ARN object. - - - - Parses the string into an ARN object. - - String to parse into an Arn. - The Arn object created from the passed in string. - Thrown if arnString is null. - Thrown if the string passed in not valid ARN. - - - - Turns the Arn object into a string representation of an ARN. - - - - - - Configuration options that apply to the entire SDK. - - These settings can be configured through app.config or web.config. - Below is a full sample configuration that illustrates all the possible options. - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws region="us-west-2"> - <logging logTo="Log4Net, SystemDiagnostics" logResponses="Always" logMetrics="true" /> - <s3 useSignatureVersion4="true" /> - <proxy host="localhost" port="8888" username="1" password="1" /> - - <dynamoDB> - <dynamoDBContext tableNamePrefix="Prod-"> - - <tableAliases> - <alias fromTable="FakeTable" toTable="People" /> - <alias fromTable="Persons" toTable="People" /> - </tableAliases> - - <mappings> - <map type="Sample.Tests.Author, SampleDLL" targetTable="People" /> - <map type="Sample.Tests.Editor, SampleDLL" targetTable="People"> - <property name="FullName" attribute="Name" /> - <property name="EmployeeId" attribute="Id" /> - <property name="ComplexData" converter="Sample.Tests.ComplexDataConverter, SampleDLL" /> - <property name="Version" version="true" /> - <property name="Password" ignore="true" /> - </map> - </mappings> - - </dynamoDBContext> - </dynamoDB> - </aws> - - - - Configuration options that apply to the entire SDK. - - - - - Manual offset to apply to client clock. This is a global setting that overrides - ClockOffset value calculated for all service endpoints. - - - - - Determines if the SDK should correct for client clock skew - by determining the correct server time and reissuing the - request with the correct time. - Default value of this field is True. - will be updated with the calculated - offset even if this field is set to false, though requests - will not be corrected or retried. - Ignored if is set. - - - - - The calculated clock skew correction, if there is one. - This field will be set if a service call resulted in an exception - and the SDK has determined that there is a difference between local - and server times. - - If is set to true, this - value will be set to the correction, but it will not be used by the - SDK and clock skew errors will not be retried. - - - - - Key for the AWSRegion property. - - - - - - Configures the default AWS region for clients which have not explicitly specified a region. - Changes to this setting will only take effect for newly constructed instances of AWS clients. - - This setting can be configured through the App.config. For example: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws region="us-west-2" /> - - - - - - Key for the AWSProfileName property. - - - - - - Profile name for stored AWS credentials that will be used to make service calls. - Changes to this setting will only take effect in newly-constructed clients. - - To reference the account from an application's App.config or Web.config use the AWSProfileName setting. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="development"/> - </appSettings> - </configuration> - - - - - - - Key for the AWSProfilesLocation property. - - - - - - Location of the credentials file shared with other AWS SDKs. - By default, the credentials file is stored in the .aws directory in the current user's home directory. - - Changes to this setting will only take effect in newly-constructed clients. - - To reference the profile from an application's App.config or Web.config use the AWSProfileName setting. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfilesLocation" value="c:\config"/> - </appSettings> - </configuration> - - - - - - - Key for the Logging property. - - - - - - Configures how the SDK should log events, if at all. - Changes to this setting will only take effect in newly-constructed clients. - - The setting can be configured through App.config, for example: - - <appSettings> - <add key="AWSLogging" value="log4net"/> - </appSettings> - - - - - - Key for the ResponseLogging property. - - - - - - - Configures when the SDK should log service responses. - Changes to this setting will take effect immediately. - - The setting can be configured through App.config, for example: - - <appSettings> - <add key="AWSResponseLogging" value="OnError"/> - </appSettings> - - - - - - Key for the LogMetrics property. - - - - - - Configures if the SDK should log performance metrics. - This setting configures the default LogMetrics property for all clients/configs. - Changes to this setting will only take effect in newly-constructed clients. - - The setting can be configured through App.config, for example: - - <appSettings> - <add key="AWSLogMetrics" value="true"/> - </appSettings> - - - - - - Key for the EndpointDefinition property. - - - - - - Configures if the SDK should use a custom configuration file that defines the regions and endpoints. - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws endpointDefinition="c:\config\endpoints.json" /> - - - - - - Key for the UseSdkCache property. - - - - - - Configures if the SDK Cache should be used, the default value is true. - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws useSdkCache="true" /> - - - - - - Configuration for the Logging section of AWS configuration. - Changes to some settings may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws> - <logging logTo="Log4Net, SystemDiagnostics" logResponses="Always" logMetrics="true" /> - </aws> - - - - - - Configuration for the Proxy section of AWS configuration. - Changes to some settings may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws> - <proxy host="localhost" port="8888" username="1" password="1" bypassList="addressexpr1;addressexpr2;..." bypassOnLocal="true" /> - </aws> - - - - - - Configuration for the region endpoint section of AWS configuration. - Changes may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws region="us-west-2" /> - - - - - - Lock for SomeEvent delegate access. - - - - - This method should never be called directly. - Call AWSSDKUtils.CorrectedUtcNow instead. - - - - - - Logging options. - Can be combined to enable multiple loggers. - - - - - No logging - - - - - Log using log4net - - - - - Log using System.Diagnostics - - - - - Log to the console - - - - - Log to a file - - - - - Response logging option. - - - - - Never log service response - - - - - Only log service response when there's an error - - - - - Always log service response - - - - - Format for metrics data in the logs - - - - - Emit metrics in human-readable format - - - - - Emit metrics as JSON data - - - - - An access control policy action identifies a specific action in a service - that can be performed on a resource. For example, sending a message to a - queue. - - ActionIdentifiers allow you to limit what your access control policy statement affects. - For example, you could create a policy statement that enables a certain group - of users to send messages to your queue, but not allow them to perform any - other actions on your queue. - - - The action is B in the statement - "A has permission to do B to C where D applies." - - Free form access control policy actions may include a wildcard (*) to match - multiple actions. - - - Constants for known actions can be found in the Amazon.Auth.AccessControlPolicy.ActionIdentifiers namespace. - - - - - - Constructs an Actionidentifer with the given action name. - - The name of the action - - - - Gets and sets the name of this action. For example, 'sqs:SendMessage' is the - name corresponding to the SQS action that enables users to send a message - to an SQS queue. - - - - - AWS access control policy conditions are contained in - objects, and affect when a statement is applied. For example, a statement - that allows access to an Amazon SQS queue could use a condition to only apply - the effect of that statement for requests that are made before a certain - date, or that originate from a range of IP addresses. - - Multiple conditions can be included in a single statement, and all conditions - must evaluate to true in order for the statement to take effect. - - - The set of conditions is D in the statement - "A has permission to do B to C where D applies." - - - A condition is composed of three parts: - - - Condition Key - The condition key declares which value of a - request to pull in and compare against when a policy is evaluated by AWS. For - example, using will cause - AWS to pull in the current request's source IP as the first value to compare - against every time your policy is evaluated. - - - - Comparison Type - This is a static value used as the second value - in the comparison when your policy is evaluated. Depending on the comparison - type, this value can optionally use wildcards. See the documentation for - individual comparison types for more information. - - - - Comparison Value - This is a static value used as the second value - in the comparison when your policy is evaluated. Depending on the comparison - type, this value can optionally use wildcards. See the documentation for - individual comparison types for more information. - - - - - - - - - Gets the type of this condition. - - - - - Gets and Sets the name of the condition key involved in this condition. - Condition keys are predefined values supported by AWS that provide input - to a condition's evaluation, such as the current time, or the IP address - of the incoming request. - - Your policy is evaluated for each incoming request, and condition keys - specify what information to pull out of those incoming requests and plug - into the conditions in your policy. - - - - - - Gets and Sets the values specified for this access control policy condition. - For example, in a condition that compares the incoming IP address of a - request to a specified range of IP addresses, the range of IP addresses - is the single value in the condition. - - Most conditions accept only one value, but multiple values are possible. - - - - - - A factory for creating conditions to be used in the policy. - - - - - Condition key for the current time. - - This condition key should only be used with enum. - - - - - - Condition key for whether or not an incoming request is using a secure - transport to make the request (i.e. HTTPS instead of HTTP). - - This condition key should only be used with the boolean overload of NewCondition. - - - - - - Condition key for the source IP from which a request originates. - - This condition key should only be used with enum. - - - - - - Condition key for the user agent included in a request. - - This condition key should only be used with - enum. - - - - - - Condition key for the current time, in epoch seconds. - - This condition key should only be used with enum. - objects. - - - - - - Condition key for the referrer specified by a request. - - This condition key should only be used with - objects. - - - - - - Condition key for the Amazon Resource Name (ARN) of the source specified - in a request. The source ARN indicates which resource is affecting the - resource listed in your policy. For example, an SNS topic is the source - ARN when publishing messages from the topic to an SQS queue. - - This condition key should only be used with enum. - - - - - - Enumeration of the supported ways an ARN comparison can be evaluated. - - - - Exact matching - - - - Loose case-insensitive matching of the ARN. Each of the six - colon-delimited components of the ARN is checked separately and each - can include a multi-character match wildcard (*) or a - single-character match wildcard (?). - - - - Negated form of ArnEquals - - - Negated form of ArnLike - - - - Enumeration of the supported ways a date comparison can be evaluated. - - - - - Enumeration of the supported ways an IP address comparison can be evaluated. - - - - - Matches an IP address against a CIDR IP range, evaluating to true if - the IP address being tested is in the condition's specified CIDR IP - range. - - - - - Negated form of IpAddress - - - - - Enumeration of the supported ways a numeric comparison can be evaluated - - - - - Enumeration of the supported ways a string comparison can be evaluated. - - - - - Case-sensitive exact string matching - - - - - Case-insensitive string matching - - - - - Loose case-insensitive matching. The values can include a - multi-character match wildcard (*) or a single-character match - wildcard (?) anywhere in the string. - - - - - Negated form of StringEquals. - - - - - Negated form of StringEqualsIgnorecase. - - - - - Negated form of StringLike. - - - - - Constructs a new access control policy condition that compares ARNs (Amazon Resource Names). - - The access policy condition key specifying where to get the first ARN for the comparison - The type of comparison to perform. - The second ARN to compare against. When using ArnLike or ArnNotLike this may contain the - multi-character wildcard (*) or the single-character wildcard - - - - Constructs a new access policy condition that performs a boolean - comparison. - - The access policy condition key specifying where to get the - first boolean value for the comparison (ex: aws:SecureTransport). - The boolean to compare against. - - - - This method is deprecated. Invoking this method results in non-UTC DateTimes - not being marshalled correctly. Use NewConditionUtc instead. - Constructs a new access policy condition that compares the current time - (on the AWS servers) to the specified date. - - The type of comparison to perform. For example, - DateComparisonType.DateLessThan will cause this policy - condition to evaluate to true if the current date is less than - the date specified in the second argument. - The date to compare against. - - - - Constructs a new access policy condition that compares the current time - (on the AWS servers) to the specified date. - - The type of comparison to perform. For example, - DateComparisonType.DateLessThan will cause this policy - condition to evaluate to true if the current date is less than - the date specified in the second argument. - The date to compare against. - - - - Constructs a new access policy condition that compares the source IP - address of the incoming request to an AWS service against the specified - CIDR range. The condition evaluates to true (meaning the policy statement - containing it will be applied) if the incoming source IP address is - within that range. - - To achieve the opposite effect (i.e. cause the condition to evaluate to - true when the incoming source IP is not in the specified CIDR - range) use the alternate constructor form and specify - IpAddressComparisonType.NotIpAddress. - - - The CIDR IP range involved in the policy condition. - - - - Constructs a new access policy condition that compares the source IP - address of the incoming request to an AWS service against the specified - CIDR range. When the condition evaluates to true (i.e. when the incoming - source IP address is within the CIDR range or not) depends on the - specified IpAddressComparisonType. - - The type of comparison to to perform. - The CIDR IP range involved in the policy condition. - - - - Constructs a new access policy condition that compares two numbers. - - The type of comparison to perform. - The access policy condition key specifying where to get the - first number for the comparison. - The second number to compare against. - - - - Constructs a new access control policy condition that compares two - strings. - - The type of comparison to perform - The access policy condition key specifying where to get the - first string for the comparison (ex: aws:UserAgent). - - The second string to compare against. When using - StringComparisonType.StringLike or - StringComparisonType.StringNotLike this may contain - the multi-character wildcard (*) or the single-character - wildcard (?). - - - - - Constructs a new access policy condition that compares the Amazon - Resource Name (ARN) of the source of an AWS resource that is modifying - another AWS resource with the specified pattern. - - For example, the source ARN could be an Amazon SNS topic ARN that is - sending messages to an Amazon SQS queue. In that case, the SNS topic ARN - would be compared the ARN pattern specified here. - - - The endpoint pattern may optionally contain the multi-character wildcard - * (*) or the single-character wildcard (?). Each of the six colon-delimited - components of the ARN is checked separately and each can include a - wildcard. - - - Policy policy = new Policy("MyQueuePolicy"); - policy.WithStatements(new Statement(Statement.StatementEffect.Allow) - .WithPrincipals(new Principal("*")).WithActionIdentifiers(SQSActionIdentifiers.SendMessage) - .WithResources(new Resource(myQueueArn)) - .WithConditions(ConditionFactory.NewSourceArnCondition(myTopicArn))); - - - The ARN pattern against which the source ARN will be compared. - Each of the six colon-delimited components of the ARN is - checked separately and each can include a wildcard. - A new access control policy condition that compares the ARN of - the source specified in an incoming request with the ARN pattern - specified here. - - - - Constructs a new access control policy condition that tests if the - incoming request was sent over a secure transport (HTTPS). - - A new access control policy condition that tests if the incoming - request was sent over a secure transport (HTTPS). - - - - Condition key for the canned ACL specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the location constraint specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the prefix specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the delimiter specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the max keys specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the source object specified by a request to copy an - object. - - This condition key may only be used with enum. - - - - - - Condition key for the metadata directive specified by a request to copy - an object. - - This condition key may only be used with enum. - - - - - - Condition key for the version ID of an object version specified by a - request. - - This condition key may only be used with enum. - - - - - - Constructs a new access policy condition that compares an Amazon S3 - canned ACL with the canned ACL specified by an incoming request. - - You can use this condition to ensure that any objects uploaded to an - Amazon S3 bucket have a specific canned ACL set. - - - The Amazon S3 canned ACL to compare against. - A new access control policy condition that compares the Amazon S3 - canned ACL specified in incoming requests against the value - specified. - - - - Condition key for The URL, e-mail address, or ARN from a Subscribe - request or a previously confirmed subscription. Use with string - conditions to restrict access to specific endpoints (e.g., - *@mycompany.com). - - This condition key may only be used with enum. - - - - - - Condition key for the protocol value from a Subscribe request or a - previously confirmed subscription. Use with string conditions to restrict - publication to specific delivery protocols (e.g., HTTPS). - - This condition key may only be used with enum. - - - - - - Constructs a new access policy condition that compares the requested - endpoint used to subscribe to an Amazon SNS topic with the specified - endpoint pattern. The endpoint pattern may optionally contain the - multi-character wildcard (*) or the single-character wildcard (?). - - For example, this condition can restrict subscriptions to a topic to - email addresses in a certain domain ("*@my-company.com"). - - - Policy policy = new Policy("MyTopicPolicy"); - policy.WithStatements(new Statement(Statement.StatementEffect.Allow) - .WithPrincipals(new Principal("*")).WithActionIdentifiers(SNSActionIdentifiers.Subscribe) - .WithResources(new Resource(myTopicArn)) - .WithConditions(ConditionFactory.NewEndpointCondition("*@my-company.com"))); - - - The endpoint pattern against which to compare the requested - endpoint for an Amazon SNS topic subscription. - A new access control policy condition that compares the endpoint - used in a request to subscribe to an Amazon SNS topic with the - endpoint pattern specified. - - - - Constructs a new AWS access control policy condition that allows an - access control statement to restrict subscriptions to an Amazon SNS topic - based on the protocol being used for the subscription. For example, this - condition can restrict subscriptions to a topic to endpoints using HTTPS - to ensure that messages are securely delivered. - - The protocol against which to compare the requested protocol - for an Amazon SNS topic subscription. - A new access control policy condition that compares the - notification protocol requested in a request to subscribe to an - Amazon SNS topic with the protocol value specified. - - - - An AWS access control policy is a object that acts as a container for one or - more statements, which specify fine grained rules for allowing or denying - various types of actions from being performed on your AWS resources. - - By default, all requests to use your resource coming from anyone but you are - denied. Access control polices can override that by allowing different types - of access to your resources, or by explicitly denying different types of - access. - - - Each statement in an AWS access control policy takes the form: - "A has permission to do B to C where D applies". - - - A is the prinicpal - The AWS account that is making a request to - access or modify one of your AWS resources. - - - - B is the action - the way in which your AWS resource is being accessed or modified, such - as sending a message to an Amazon SQS queue, or storing an object in an Amazon S3 bucket. - - - - C is the resource - your AWS entity that the principal wants to access, such - as an Amazon SQS queue, or an object stored in Amazon S3. - - - - D is the set of conditions - optional constraints that specify when to allow or deny - access for the principal to access your resource. Many expressive conditions are available, - some specific to each service. For example you can use date conditions to allow access to - your resources only after or before a specific time. - - - - - - Note that an AWS access control policy should not be confused with the - similarly named "POST form policy" concept used in Amazon S3. - - - - - - The default policy version - - - - - Constructs an empty AWS access control policy ready to be populated with - statements. - - - - - Constructs a new AWS access control policy with the specified policy ID. - The policy ID is a user specified string that serves to help developers - keep track of multiple polices. Policy IDs are often used as a human - readable name for a policy. - - The policy ID for the new policy object. Policy IDs serve to - help developers keep track of multiple policies, and are often - used to give the policy a meaningful, human readable name. - - - - Constructs a new AWS access control policy with the specified policy ID - and collection of statements. The policy ID is a user specified string - that serves to help developers keep track of multiple polices. Policy IDs - are often used as a human readable name for a policy. - - The policy ID for the new policy object. Policy IDs serve to - help developers keep track of multiple policies, and are often - used to give the policy a meaningful, human readable name. - The statements to include in the new policy. - - - - Gets and Sets the policy ID for this policy. Policy IDs serve to help - developers keep track of multiple policies, and are often used as human - readable name for a policy. - - - - - Sets the policy ID for this policy and returns the updated policy so that - multiple calls can be chained together. - - Policy IDs serve to help developers keep track of multiple policies, and - are often used as human readable name for a policy. - - - The polich ID for this policy - this instance - - - - Gets and sets the version of this AWS policy. - - - - - Gets and Sets the collection of statements contained by this policy. Individual - statements in a policy are what specify the rules that enable or disable - access to your AWS resources. - - - - - Checks to see if the permissions set in the statement are already set by another - statement in the policy. - - The statement to verify - True if the statement's permissions are already allowed by the statement - - - - Sets the collection of statements contained by this policy and returns - this policy object so that additional method calls can be chained - together. - - Individual statements in a policy are what specify the rules that enable - or disable access to your AWS resources. - - - The collection of statements included in this policy. - this instance - - - - Returns a JSON string representation of this AWS access control policy, - suitable to be sent to an AWS service as part of a request to set an - access control policy. - - A JSON string representation of this AWS access control policy. - - - - Returns a JSON string representation of this AWS access control policy, - suitable to be sent to an AWS service as part of a request to set an - access control policy. - - Toggle pretty print for the generated JSON document - A JSON string representation of this AWS access control policy. - - - - Parses a JSON document of a policy and creates a Policy object. - - JSON document of a policy. - - - - - A principal is an AWS account which is being allowed or denied access to a - resource through an access control policy. The principal is a property of the - Statement object, not directly the object. - - The principal is A in the statement - "A has permission to do B to C where D applies." - - - In an access control policy statement, you can set the principal to all - authenticated AWS users through the member. This - is useful when you don't want to restrict access based on the identity of the - requester, but instead on other identifying characteristics such as the - requester's IP address. - - - - - - Principal instance that includes all authenticated AWS users. - - This is useful when you don't want to restrict access based on the - identity of the requester, but instead on other identifying - characteristics such as the requester's IP address. - - - - - - The anonymous Principal. - - - - - The default Principal provider for AWS accounts. - - - - - Principal provider for Canonical User IDs. - - - - - Principal provider for federated users (using a SAML identity provider) - - - - - Principal provider for assume role policies that will be assumed by an AWS service - (e.g. "ec2.amazonaws.com"). - - - - - Dummy principal provider for anonynous. - - - - - Constructs a new principal with the specified AWS account ID. - - An AWS account ID. - - - - Constructs a new principal with the specified provider and id - - The provider of the principal - The unique ID of the Principal within the provider - - - - Constructs a new principal with the specified provider and id - and optionally strips hyphens from the id - - The provider of the principal - The unique ID of the Principal within the provider - Strip hyphen - - - - Gets and sets the provider for this principal, which indicates in what group of - users this principal resides. - - - - - Gets the unique ID for this principal. - - - - - Represents a resource involved in an AWS access control policy statement. - Resources are the service specific AWS entities owned by your account. Amazon - SQS queues, Amazon S3 buckets and objects, and Amazon SNS topics are all - examples of AWS resources. - - The standard way of specifying an AWS resource is with an Amazon Resource - Name (ARN). - - - The resource is C in the statement - "A has permission to do B to C where D applies." - - - - - - Constructs a new AWS access control policy resource. Resources are - typically specified as Amazon Resource Names (ARNs). - - You specify the resource using the following Amazon Resource Name (ARN) - format: arn:aws:<vendor>:<region>:<namespace>:<relative-id> - - - >vendor identifies the AWS product (e.g., sns) - - - region is the AWS Region the resource resides in (e.g., us-east-1), if any - - - namespace is the AWS account ID with no hyphens (e.g., 123456789012) - - - relative-id is the service specific portion that identifies the specific resource - - - - - For example, an Amazon SQS queue might be addressed with the following - ARN: arn:aws:sqs:us-east-1:987654321000:MyQueue - - - Some resources may not use every field in an ARN. For example, resources - in Amazon S3 are global, so they omit the region field: - arn:aws:s3:::bucket/* - - - The Amazon Resource Name (ARN) uniquely identifying the desired AWS resource. - - - - Gets the resource ID, typically an Amazon Resource Name (ARN), - identifying this resource. - - - - - A factory for creating resources to be used in the policy. - - - - - Constructs a new bucket resource that represents the the specified bucket - but not any of the contained objects. - - The name of the bucket represented by this AWS access control - policy resource. - - - - Constructs a new object resource that represents the specified objects. - The keyPattern argument may contain the '*' wildcard to match multiple - objects. For example, an object resource created for bucket 'mybucket' - and key pattern 'foo*' will match any object stored in 'mybucket' with a - key that starts with 'foo'. - - The name of the bucket containing the object or objects - represented by this resource. - The key or key pattern, which can optionally contain the '*' - wildcard to include multiple objects in the resource. - - - - Constructs a new SQS queue resource for an access control policy. A - policy statement using this resource will allow or deny actions on the - specified queue. - - The AWS account ID of the queue owner. - The name of the Amazon SQS queue. - - - - A statement is the formal description of a single permission, and is always - contained within a policy object. - - A statement describes a rule for allowing or denying access to a specific AWS - resource based on how the resource is being accessed, and who is attempting - to access the resource. Statements can also optionally contain a list of - conditions that specify when a statement is to be honored. - - - For example, consider a statement that: - - - A is the prinicpal - The AWS account that is making a request to - access or modify one of your AWS resources. - - - - B is the action - the way in which your AWS resource is being accessed or modified, such - as sending a message to an Amazon SQS queue, or storing an object in an Amazon S3 bucket. - - - - C is the resource - your AWS entity that the principal wants to access, such - as an Amazon SQS queue, or an object stored in Amazon S3. - - - - D is the set of conditions - optional constraints that specify when to allow or deny - access for the principal to access your resource. Many expressive conditions are available, - some specific to each service. For example you can use date conditions to allow access to - your resources only after or before a specific time. - - - - - - There are many resources and conditions available for use in statements, and - you can combine them to form fine grained custom access control polices. - - - - - - The effect is the result that you want a policy statement to return at - evaluation time. A policy statement can either allow access or explicitly - deny access. - - - - - Constructs a new access control policy statement with the specified - effect. - - Before a statement is valid and can be sent to AWS, callers must set the - principals, resources, and actions (as well as any optional conditions) - involved in the statement. - - - The effect this statement has (allowing access or denying - access) when all conditions, resources, principals, and - actions are matched. - - - - Gets and Sets the ID for this statement. Statement IDs serve to help keep track - of multiple statements, and are often used to give the statement a - meaningful, human readable name. - - Developers should be careful to not use the same statement ID for - multiple statements in the same policy. Reusing the same statement ID in - different policies is not a problem. - - - - - - Sets the ID for this statement and returns the updated statement so - multiple calls can be chained together. - - Statement IDs serve to help keep track of multiple statements, and are - often used to give the statement a meaningful, human readable name. - - - Developers should be careful to not use the same statement ID for - multiple statements in the same policy. Reusing the same statement ID in - different policies is not a problem. - - - The new statement ID for this statement. - this instance - - - - Gets and Sets the result effect of this policy statement when it is evaluated. - A policy statement can either allow access or explicitly - - - - - Gets and Sets the list of actions to which this policy statement applies. - Actions limit a policy statement to specific service operations that are - being allowed or denied by the policy statement. For example, you might - want to allow any AWS user to post messages to your SQS queue using the - SendMessage action, but you don't want to allow those users other actions - such as ReceiveMessage or DeleteQueue. - - - - - Sets the list of actions to which this policy statement applies and - returns this updated Statement object so that additional method calls can - be chained together. - - Actions limit a policy statement to specific service operations that are - being allowed or denied by the policy statement. For example, you might - want to allow any AWS user to post messages to your SQS queue using the - SendMessage action, but you don't want to allow those users other actions - such as ReceiveMessage or DeleteQueue. - - - The list of actions to which this statement applies. - this instance - - - - Gets and Sets the resources associated with this policy statement. Resources - are what a policy statement is allowing or denying access to, such as an - Amazon SQS queue or an Amazon SNS topic. - - Note that some services allow only one resource to be specified per - policy statement. - - - - - - Sets the resources associated with this policy statement and returns this - updated Statement object so that additional method calls can be chained - together. - - Resources are what a policy statement is allowing or denying access to, - such as an Amazon SQS queue or an Amazon SNS topic. - - - Note that some services allow only one resource to be specified per - policy statement. - - - The resources associated with this policy statement. - this instance - - - - Gets and Sets the conditions associated with this policy statement. Conditions - allow policy statements to be conditionally evaluated based on the many - available condition types. - - For example, a statement that allows access to an Amazon SQS queue could - use a condition to only apply the effect of that statement for requests - that are made before a certain date, or that originate from a range of IP - addresses. - - - When multiple conditions are included in a single statement, all - conditions must evaluate to true in order for the statement to take - effect. - - - - - - Sets the conditions associated with this policy statement, and returns - this updated Statement object so that additional method calls can be - chained together. - - Conditions allow policy statements to be conditionally evaluated based on - the many available condition types. - - - For example, a statement that allows access to an Amazon SQS queue could - use a condition to only apply the effect of that statement for requests - that are made before a certain date, or that originate from a range of IP - addresses. - - - Multiple conditions can be included in a single statement, and all - conditions must evaluate to true in order for the statement to take - effect. - - - The conditions associated with this policy statement. - this instance - - - - Gets and Sets the principals associated with this policy statement, indicating - which AWS accounts are affected by this policy statement. - - - - - Sets the principals associated with this policy statement, and returns - this updated Statement object. Principals control which AWS accounts are - affected by this policy statement. - - If you don't want to restrict your policy to specific users, you can use - to apply the policy to any user trying to - access your resource. - - - The list of principals associated with this policy statement. - this instance - - - - The available AWS access control policy actions for Amazon AppStream. - - - - - - The available AWS access control policy actions for Auto Scaling. - - - - - - The available AWS access control policy actions for AWS Billing. - - - - - - The available AWS access control policy actions for AWS CloudFormation. - - - - - - The available AWS access control policy actions for Amazon CloudFront. - - - - - - The available AWS access control policy actions for Amazon CloudSearch. - - - - - - The available AWS access control policy actions for AWS CloudTrail. - - - - - - The available AWS access control policy actions for Amazon CloudWatch. - - - - - - The available AWS access control policy actions for Amazon CloudWatch Logs. - - - - - - The available AWS access control policy actions for Amazon Cognito Identity. - - - - - - The available AWS access control policy actions for Amazon Cognito Sync. - - - - - - The available AWS access control policy actions for AWS Direct Connect. - - - - - - The available AWS access control policy actions for Amazon DynamoDB. - - - - - - The available AWS access control policy actions for Amazon EC2. - - - - - - The available AWS access control policy actions for AWS ElastiCache. - - - - - - The available AWS access control policy actions for AWS Elastic Beanstalk. - - - - - - The available AWS access control policy actions for Elastic Load Balancing. - - - - - - The available AWS access control policy actions for Amazon Elastic MapReduce. - - - - - - The available AWS access control policy actions for Amazon Elastic Transcoder. - - - - - - The available AWS access control policy actions for Amazon Glacier. - - - - - - The available AWS access control policy actions for AWS Identity and Access Management. - - - - - - The available AWS access control policy actions for AWS Import Export. - - - - - - The available AWS access control policy actions for Amazon Kinesis. - - - - - - The available AWS access control policy actions for AWS Marketplace. - - - - - - The available AWS access control policy actions for AWS Marketplace Management Portal. - - - - - - The available AWS access control policy actions for Amazon Mobile Analytics. - - - - - - The available AWS access control policy actions for AWS OpsWorks. - - - - - - The available AWS access control policy actions for Amazon RDS. - - - - - - The available AWS access control policy actions for Amazon Redshift. - - - - - - The available AWS access control policy actions for Amazon Route 53. - - - - - - The available AWS access control policy actions for Amazon S3. - - - - - - The available AWS access control policy actions for AWS Security Token Service. - - - - - - The available AWS access control policy actions for Amazon SES. - - - - - - The available AWS access control policy actions for Amazon SimpleDB. - - - - - - The available AWS access control policy actions for Amazon Simple Workflow Service. - - - - - - The available AWS access control policy actions for Amazon SNS. - - - - - - The available AWS access control policy actions for Amazon SQS. - - - - - - The available AWS access control policy actions for Amazon Storage Gateway. - - - - - - The available AWS access control policy actions for AWS Whispersync. - - - - - - The available AWS access control policy actions for Amazon Zocalo. - - - - - - Deserializes a JSON string into a AWS policy object. - - - - - Serializes an AWS policy object to a JSON string, suitable for sending to an - AWS service. - - - - Converts the specified AWS policy object to a JSON string, suitable for - passing to an AWS service. - - @param policy - The AWS policy object to convert to a JSON string. - - @return The JSON string representation of the specified policy object. - - @throws IllegalArgumentException - If the specified policy is null or invalid and cannot be - serialized to a JSON string. - - - - Uses the specified generator to write the JSON data for the principals in - the specified policy statement. - - - - - This sorts the conditions by condition type and key with the list of values for that combination. - - The list of conditions to be sorted. - - - - - Exception thrown by the SDK for errors that occur within the SDK. - - - - - This exception is thrown when there is a parse error on the response back from AWS. - - - - - The string value which could not be converted into a valid DateTime instance. - - - - - Occurs before a request is marshalled. - - - - - Occurs before a request is issued against the service. - - - - - Occurs after a response is received from the service. - - - - - Occurs after an exception is encountered. - - - - - Patches the in-flight uri to stop it unescaping the path etc (what Uri did before - Microsoft deprecated the constructor flag). This is particularly important for - Amazon S3 customers who want to use backslash (\) in their key names. - - - Different behavior in the various runtimes has been observed and in addition some - 'documented' ways of doing this between 2.x and 4.x runtimes has also been observed - to not be reliable. - - This patch effectively emulates what adding a schemesettings element to the - app.config file with value 'name="http" genericUriParserOptions="DontUnescapePathDotsAndSlashes"' - does. As we're a dll, that avenue is not open to us. - - - - - - Used to create a copy of the config for a different service than the current instance. - - Target service ClientConfig - The new ClientConfig for the desired service - - - - A base exception for some Amazon Web Services. - - Most exceptions thrown to client code will be service-specific exceptions, though some services - may throw this exception if there is a problem which is caught in the core client code. - - - - - - Whether the error was attributable to Sender or Reciever. - - - - - The error code returned by the service - - - - - The id of the request which generated the exception. - - - - - The HTTP status code from the service response - - - - - Flag indicating if the exception is retryable and the associated retry - details. A null value indicates that the exception is not retryable. - - - - - Class containing the retryable details for an AmazonServiceException - - - - - This property indicates that this exception is a - throttling exception and should be subject to congestion - control throttling. - - - - - This exception is thrown when there is a parse error on the response back from AWS. - - - - - Last known location in the response that was parsed, if available. - - - - - The entire response body that caused this exception, if available. - - - - - Base class for request used by some of the services. - - - - - This flag specifies if SigV4 will be used for the current request. - - - - - Gets or Sets a value indicating if "Expect: 100-continue" HTTP header will be - sent by the client for this request. The default value is false. - - - - - Gets the signer to use for this request. - A null return value indicates to use the configured - signer for the service that this request is part of. - - A signer for this request, or null. - - - - Abstract class for Response objects, contains only metadata, - and no result information. - - - - - Contains additional information about the request, such as the - Request Id. - - - - - Returns the content length of the HTTP response. - - - - - Returns the status code of the HTTP response. - - - - - Base class for determining region based on inspection. - - - - - Sets the Region property by looking up the corresponding RegionEndpoint - from the supplied region system name (us-east-1, us-west-2 etc). - - The system name of the region. - - - - Determines region based on application configuration settings. If the configuration does not contain - the region setting key an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of ApplicationConfigAWSRegion. If no region is found in the - application configuration file then an InvalidOperationException is thrown. - - - - - Probing mechanism to determine region from various sources. - - - - - This class is responsible for keeping track of Retry capacity across different ServiceURLs. - - - - - CapacityType determines the type of capacity to obtain or use. - - - - - The increment capacity type adds capacity. - - - - - The default retry capacity type uses the default capacity amount. - - - - - The timeout capacity type uses the timeout capacity amount. - - - - - This method acquires a said retry capacity if the container has the capacity. - - Contains the RetryCapacity object for the said ServiceURL. - - - - This method acquires a said retry capacity if the container has the capacity. - - Contains the RetryCapacity object for the said ServiceURL. - Specifies what capacity type cost to use for obtaining capacity - - - - This method calls a method to release capacity back - based on whether it was a successful response or a successful retry response. This is invoked by a retry request response. - - if this request is a retry, use a different capacity cost - Contains the RetryCapacity object for the said ServiceURL. - - - - This method calls a method to release capacity back - based on whether it was a successful response or a successful retry response. This is invoked by a retry request response. - - Specifies what capacity type cost to use for adding capacity - Contains the RetryCapacity object for the said ServiceURL. - - - - Ths method fetches the RetryCapacity for the given ServiceURL from CapacityManager.CapacityContainer - - - - - This method releases capacity back. This is invoked by the TryReleaseCapacity method. - - Contains the RetryCapacity object for the said ServiceURL. - The capacity that needs to be released based on whether it was a successful response or a successful retry response. - - - - This class is the RetryCapacity class for a given ServiceURL. - - - - - This class composes Client Context header for Amazon Web Service client. - It contains information like app title, version code, version name, client id, OS platform etc. - - - This class composes Client Context header for Amazon Web Service client. - It contains information like app title, version code, version name, client id, OS platform etc. - - - - - Adds the custom attributes to the Client Context. - - Key. - Value. - - - - Gets a Json Representation of the Client Context. - - Json Representation of Client Context - - - - Collection of parameters that an SDK client will send to a service. - - - - - Constructs empty ParameterCollection. - - - - - Adds a parameter with a string value. - - - - - - - Adds a parameter with a list-of-strings value. - - - - - - - Converts the current parameters into a list of key-value pairs. - - - - - - This class is responsible for managing adaptive retry mode client rate limiting. - - - - - The rate at which token are replenished. - - - - - The maximum capacity allowed in the token - - - - - The current capacity of the token - - - - - The last time the token bucket was refilled. - - - - - The smoothed rate which tokens are being retrieved. - - - - - The last half second time bucket used. - - - - - The number of requests seen within the current time - - - - - The maximum rate when the client was last throttled. - - - - - The last time when the client was throttled. - - - - - The cached time window calculation - - - - - Boolean indicating if the token bucket is enabled. - - - - - This method attempts to acquire capacity from the client's token - - The amount of capacity to obtain from the token bucket - Indicates that the client should or shouldn't sleep and - try again if capacity cannot be obtained. - - - - - This method attempts to acquire capacity from the client's token - - The amount of capacity to obtain from the token bucket - Indicates that the client should or shouldn't sleep and - try again if capacity cannot be obtained. - - Token which can be used to cancel the task. - - - - Updates the sending rate within the client's token bucket - - Indicates if the request resulted in a throttling error. - - - - Calculates the rate - - - Returns the calculated rate for a successful call - - - - Calculates the rate. - - The rate to use in the calculation - Returns the calculated rate for a throttled call - - - - Collection used to indicate if the property was initialized was created by the SDK. - - - - - - Collection used to indicate if the property was initialized was created by the SDK. - - - - - - - Default implementation of the IRequest interface. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Constructs a new DefaultRequest with the specified service name and the - original, user facing request object. - - The orignal request that is being wrapped - The service name - - - - The name of the request - - - - - Gets and sets the type of http request to make, whether it should be POST,GET or DELETE - - - - - Gets and sets a flag that indicates whether the request is sent as a query string instead of the request body. - - - - - Returns the original, user facing request object which this internal - request object is representing. - - - - - Returns a dictionary of the headers included in this request. - - - - - Returns a dictionary of the parameters included in this request. - - - - - Collection of parameters included in this request. - - - - - Returns the subresources that should be appended to the resource path. - This is used primarily for Amazon S3, where object keys can contain '?' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new null entry to the SubResources collection for the request - - The name of the subresource - - - - Adds a new entry to the SubResources collection for the request - - The name of the subresource - Value of the entry - - - - Gets and Sets the endpoint for this request. - - - - - Gets and Sets the resource path added on to the endpoint. - - - - - Returns the path resources that should be used within the resource path. - This is used for services where path keys can contain '/' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new entry to the PathResources collection for the request - - The name of the pathresource with potential greedy syntax: {key+} - Value of the entry - - - - Gets and Sets the version number for the marshaller used to create this request. The version number - is used to support backward compatible changes that would otherwise be breaking changes when a - newer core is used with an older service assembly. - Versions: - 1 - Default version - 2 - Support for path segments - - - - - Gets and Sets the content for this request. - - - - - Flag that signals that Content was and should be set - from the Parameters collection. - - - - - Gets and sets the content stream. - - - - - Gets and sets the original stream position. - If ContentStream is null or does not support seek, this propery - should be equal to -1. - - - - - Computes the SHA 256 hash of the content stream. If the stream is not - seekable, it searches the parent stream hierarchy to find a seekable - stream prior to computation. Once computed, the hash is cached for future - use. If a suitable stream cannot be found to use, null is returned. - - - - - The name of the service to which this request is being sent. - - - - - Alternate endpoint to use for this request, if any. - - - - - Host prefix value to prepend to the endpoint for this request, if any. - - - - - Gets and sets the Suppress404Exceptions property. If true then 404s return back from AWS will not cause an exception and - an empty response object will be returned. - - - - - If using AWS4 signing protocol, contains the resultant parts of the - signature that we may need to make use of if we elect to do a chunked - encoding upload. - - - - - Determine whether to use a chunked encoding upload for the request - (applies to Amazon S3 PutObject and UploadPart requests only). - - - - - - Used for Amazon S3 requests where the bucket name is removed from - the marshalled resource path into the host header. To comply with - AWS2 signature calculation, we need to recover the bucket name - and include it in the resource canonicalization, which we do using - this field. - - - - - This flag specifies if SigV4 is required for the current request. - - - - - The authentication region to use for the request. - Set from Config.AuthenticationRegion. - - - - - The region in which the service request was signed. - - - - - Checks if the request stream can be rewinded. - - Returns true if the request stream can be rewinded , - else false. - - - - Returns true if the request can contain a request body, else false. - - Returns true if the currect request can contain a request body, else false. - - - - Returns true if the request has a body, else false. - - Returns true if the request has a body, else false. - - - - Class containing the data for one endpoint returned from a endpoint discovery request - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Constructs a new DiscoveryEndpoint - - The address of the endpoint - The cache period for the endpoint in minutes - - - - The address of the endpoint. - - - - - The cache period for the endpoint in minutes - - - - - Calculates if this endpoint has expired - - A boolean value indicating if the cache period has expired - - - - Extends the endpoint expiration by the specified number of minutes from now. - - - - - Class containing the data for one endpoint returned from a endpoint discovery request - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class containing the data to use with endpoint discovery - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Gets/sets and flag indicating if endpoint discovery is required for the request. - - - - - Sorted dictionary of the identifiers that must be sent with the endpoint discovery request. These - identifiers are used to construct the cache key for the cache that stores discovered endpoints. A - sorted dictionary is used instead of a dictionary to ensure the cache key comes out in the same order - each time it is constructed. - - - - - Represents the data to be used with endpoint discovery operations - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class used to resolve endpoints using Endpoint Discovery. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Method that performs endpoint discovery for the current operation - - Context information used in calculations for endpoint discovery - The operation to fetch endpoints from the server - - - - - Gets the number of cache keys in the cache - - - - - Class used to resolve endpoints using Endpoint Discovery. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class containing context information to use with endpoint discovery - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Gets the customer credential information. - - - - - Gets the operation name. - - - - - Gets the current marshalled endpoint discovery data. - - - - - Gets the flag indicating if the specified key should be evicted from the cache. - - - - - Gets the Uri that should be evicted if EvictCacheKey is set to true. - - - - - Class containing context information to use with endpoint discovery - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Error type, one of Sender, Receiver, Unknown - Only applies to XML-based services. - - - - - Name of the exception class to return - - - - - Error message - - - - - RequestId of the error. - Only applies to XML-based services. - - - - - InternalConfiguration holds the cached SDK configuration values - obtained from the environment and profile configuration - factories. These configuration values are loaded internally and - are not the same as user exposed AWSConfigs. - - - - - Flag indicating if Endpoint Discovery is enabled. - - - - - The retry mode to use: Legacy, Standard, or Adaptive. - - - - - The max number of request attempts. - - - - - Probing mechanism to determine the configuration values from various sources. - - - - - Resets all the configuration values reloading as needed. This method will use - the AWS_PROFILE environment variable if set to construct the instance. Otherwise - the default profile will be used. - - - - - Flag that specifies if endpoint discovery is enabled, disabled, - or not set. - - - - - Flag that specifies which retry mode to use or if retry mode has - not been set. - - - - - Flag that specifies the max number of request attempts or if max - attempts has not been set. - - - - - Class containing the members used to invoke service calls - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class containing the members used to invoke service calls - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Represents a request being sent to an Amazon Web Service, including the - parameters being sent as part of the request, the endpoint to which the - request should be sent, etc. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - The name of the request - - - - - Returns a dictionary of the headers included in this request. - - - - - Gets and sets a flag that indicates whether the request is sent as a query string instead of the request body. - - - - - Returns a dictionary of the parameters included in this request. - - - - - Collection of parameters included in this request. - - - - - Returns the subresources that should be appended to the resource path. - This is used primarily for Amazon S3, where object keys can contain '?' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new null entry to the SubResources collection for the request - - The name of the subresource - - - - Adds a new entry to the SubResources collection for the request - - The name of the subresource - Value of the entry - - - - Gets and sets the type of http request to make, whether it should be POST,GET or DELETE - - - - - Gets and Sets the endpoint for this request. - - - - - Gets and Sets the resource path added on to the endpoint. - - - - - Returns the path resources that should be used within the resource path. - This is used for services where path keys can contain '/' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new entry to the PathResources collection for the request - - The name of the pathresource with potential greedy syntax: {key+} - Value of the entry - - - - Gets and Sets the version number for the marshaller used to create this request. The version number - is used to support backward compatible changes that would otherwise be breaking changes when a - newer core is used with an older service assembly. - - - - - Gets and Sets the content for this request. - - - - - Gets the header value from the request. - - - - - Flag that signals that Content was and should be set - from the Parameters collection. - - - - - Gets and sets the content stream. - - - - - Gets and sets the original stream position. - If ContentStream is null or does not support seek, this propery - should be equal to -1. - - - - - Computes the SHA 256 hash of the content stream. If the stream is not - seekable, it searches the parent stream hierarchy to find a seekable - stream prior to computation. Once computed, the hash is cached for future - use. - - - - - The name of the service to which this request is being sent. - - - - - Returns the original, user facing request object which this internal - request object is representing. - - - - - Alternate endpoint to use for this request, if any. - - - - - Host prefix value to prepend to the endpoint for this request, if any. - - - - - Gets and sets the Suppress404Exceptions property. If true then 404s return back from AWS will not cause an exception and - an empty response object will be returned. - - - - - If using AWS4 signing protocol, contains the resultant parts of the - signature that we may need to make use of if we elect to do a chunked - encoding upload. - - - - - Determine whether to use a chunked encoding upload for the request - (applies to Amazon S3 PutObject and UploadPart requests only). - - - - - - Used for Amazon S3 requests where the bucket name is removed from - the marshalled resource path into the host header. To comply with - AWS2 signature calculation, we need to recover the bucket name - and include it in the resource canonicalization, which we do using - this field. - - - - - This flag specifies if SigV4 is required for the current request. - - - - - The authentication region to use for the request. - Set from Config.AuthenticationRegion. - - - - - The region in which the service request was signed. - - - - - Checks if the request stream can be rewinded. - - Returns true if the request stream can be rewinded , - else false. - - - - Returns true if the request can contain a request body, else false. - - Returns true if the currect request can contain a request body, else false. - - - - Returns true if the request has a body, else false. - - Returns true if the request has a body, else false. - - - - Gets the value of the Service Id. - - - - - Gets the dictionary that gives mapping of renamed operations - - - - - IDictionary{String, String} access to ParameterCollection. - TODO: remove this class in version 3.4 of the SDK. - - - - - Constructs ParametersDictionaryFacade for a ParameterCollection - - - - - - A registry of object that will manipulate the runtime pipeline used by service clients. - - - - - Registers a customizer that will be applied for all service clients created. Each customizer has a unique name associated with it. If a customizer is registered more - than once with the same unique name then the calls after the first will be ignored. - - - - - - Deregistered the runtime pipeline customizer - - - - - - Deregistered the runtime pipeline customizer - - - - - - Applies all of the registered customizers on the runtime pipeline - - The service clients runtime pipeline. - Type object for the service client being created - - - - Interface for objects that will customize the runtime pipleine for newly created service clients. - - - - - The unique name for the customizer that identifies the customizer in the registry. The name is also used to identify the customizer on the SDK logs. - - - - - Called on service clients as they are being constructed to customize their runtime pipeline. - - - Type object for the service client being created - - - - Default ServiceMetadata implementation. - This implementation will be used if the service doesn't have a - IServiceMetadata implementation. - - - - - Gets the value of the Service Id. - - - - - Gets the dictionary that gives mapping of renamed operations - - - - - Computes RFC 2104-compliant HMAC signature. - - - - - Computes RFC 2104-compliant HMAC signature. - - - - - Inspects the supplied evidence to return the signer appropriate for the operation - - Global setting for the service - The request. - Configuration for the client - True if signature v4 request signing should be used - - - - Signs the specified request with the AWS3 signing protocol by using the - AWS account credentials given in the method parameters. - - The AWS public key - The AWS secret key used to sign the request in clear text - Request metrics - The configuration that specifies which hashing algorithm to use - The request to have the signature compute for - If any problems are encountered while signing the request - - - - AWS4 protocol signer for service calls that transmit authorization in the header field "Authorization". - - - - - Calculates and signs the specified request using the AWS4 signing protocol by using the - AWS account credentials given in the method parameters. The resulting signature is added - to the request headers as 'Authorization'. Parameters supplied in the request, either in - the resource path as a query string or in the Parameters collection must not have been - uri encoded. If they have, use the SignRequest method to obtain a signature. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. - - - Client configuration data encompassing the service call (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text. - - - If any problems are encountered while signing the request. - - - - - Calculates and signs the specified request using the AWS4 signing protocol by using the - AWS account credentials given in the method parameters. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. - - - Client configuration data encompassing the service call (notably authentication - region, endpoint and service name). - - - Metrics for the request. - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text. - - - If any problems are encountered while signing the request. - - - Parameters passed as part of the resource path should be uri-encoded prior to - entry to the signer. Parameters passed in the request.Parameters collection should - be not be encoded; encoding will be done for these parameters as part of the - construction of the canonical request. - - - - - Sets the AWS4 mandated 'host' and 'x-amz-date' headers, returning the date/time that will - be used throughout the signing process in various elements and formats. - - The current set of headers - - Date and time used for x-amz-date, in UTC - - - - Sets the AWS4 mandated 'host' and 'x-amz-date' headers, accepting and returning the date/time that will - be used throughout the signing process in various elements and formats. - - The current set of headers - - - Date and time used for x-amz-date, in UTC - - - - Computes and returns an AWS4 signature for the specified canonicalized request - - - - - - - - - - - - Computes and returns an AWS4 signature for the specified canonicalized request - - - - - - - - - - - - - Computes and returns an AWS4 signature for the specified canonicalized request - - - - - - - - - - - - - - Formats the supplied date and time for use in AWS4 signing, where various formats are used. - - - The required format - The UTC date/time in the requested format - - - - Compute and return the multi-stage signing key for the request. - - The clear-text AWS secret key, if not held in secureKey - The region in which the service request will be processed - Date of the request, in yyyyMMdd format - The name of the service being called by the request - Computed signing key - - - - If the caller has already set the x-amz-content-sha256 header with a pre-computed - content hash, or it is present as ContentStreamHash on the request instance, return - the value to be used in request canonicalization. - If not set as a header or in the request, attempt to compute a hash based on - inspection of the style of the request content. - - - - The computed hash, whether already set in headers or computed here. Null - if we were not able to compute a hash. - - - - - If signPayload is false set the x-amz-content-sha256 header to - the UNSIGNED-PAYLOAD magic string and return it. - Otherwise, if the caller has already set the x-amz-content-sha256 header with a pre-computed - content hash, or it is present as ContentStreamHash on the request instance, return - the value to be used in request canonicalization. - If not set as a header or in the request, attempt to compute a hash based on - inspection of the style of the request content. - - - - - The computed hash, whether already set in headers or computed here. Null - if we were not able to compute a hash. - - - - - Returns the HMAC256 for an arbitrary blob using the specified key - - - - - - - - Returns the HMAC256 for an arbitrary blob using the specified key - - - - - - - - Compute and return the hash of a data blob using the specified key - - Algorithm to use for hashing - Hash key - Data blob - Hash of the data - - - - Compute and return the hash of a data blob using the specified key - - Algorithm to use for hashing - Hash key - Data blob - Hash of the data - - - - Computes the non-keyed hash of the supplied data - - - - - - - Computes the non-keyed hash of the supplied data - - - - - - - Computes and returns the canonical request - - The endpoint URL - the path of the resource being operated on - The http method used for the request - The full request headers, sorted into canonical order - The query parameters for the request - - The hash of the binary request body if present. If not supplied, the routine - will look for the hash as a header on the request. - - Canonicalised request as a string - - - - Computes and returns the canonical request - - The endpoint URL - the path of the resource being operated on - The http method used for the request - The full request headers, sorted into canonical order - The query parameters for the request - - The path resource values lookup to use to replace the keys within resourcePath - The hash of the binary request body if present. If not supplied, the routine - will look for the hash as a header on the request. - - The version of the marshaller that constructed the request object. - Canonicalised request as a string - - - - Computes and returns the canonical request - - The endpoint URL - the path of the resource being operated on - The http method used for the request - The full request headers, sorted into canonical order - The query parameters for the request - - The path resource values lookup to use to replace the keys within resourcePath - The hash of the binary request body if present. If not supplied, the routine - will look for the hash as a header on the request. - - The version of the marshaller that constructed the request object. - The service being called for the request - Canonicalised request as a string - - - - Reorders the headers for the request for canonicalization. - - The set of proposed headers for the request - List of headers that must be included in the signature - For AWS4 signing, all headers are considered viable for inclusion - - - - Computes the canonical headers with values for the request. Only headers included in the signature - are included in the canonicalization process. - - All request headers, sorted into canonical order - Canonicalized string of headers, with the header names in lower case. - - - - Returns the set of headers included in the signature as a flattened, ;-delimited string - - The headers included in the signature - Formatted string of header names - - - - Collects the subresource and query string parameters into one collection - ready for canonicalization - - The in-flight request being signed - The fused set of parameters - - - - Computes and returns the canonicalized query string, if query parameters have been supplied. - Parameters with no value will be canonicalized as 'param='. The expectation is that parameters - have not already been url encoded prior to canonicalization. - - The set of parameters being passed on the uri - - Parameters must be uri encoded into the canonical request and by default the signer expects - that the supplied collection contains non-encoded data. Set this to false if the encoding was - done prior to signer entry. - - The uri encoded query string parameters in canonical ordering - - - - Computes and returns the canonicalized query string, if query parameters have been supplied. - Parameters with no value will be canonicalized as 'param='. The expectation is that parameters - have not already been url encoded prior to canonicalization. - - The set of parameters to be encoded in the query string - - Parameters must be uri encoded into the canonical request and by default the signer expects - that the supplied collection contains non-encoded data. Set this to false if the encoding was - done prior to signer entry. - - The uri encoded query string parameters in canonical ordering - - - - Returns the request parameters in the form of a query string. - - The request instance - Request parameters in query string format - - - - AWS4 protocol signer for Amazon S3 presigned urls. - - - - - Calculates and signs the specified request using the AWS4 signing protocol by using the - AWS account credentials given in the method parameters. The resulting signature is added - to the request headers as 'Authorization'. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. - - - Adding supporting data for the service call required by the signer (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text - - - If any problems are encountered while signing the request. - - - - - Calculates the AWS4 signature for a presigned url. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. If the Expires parameter - is present, it is renamed to 'X-Amz-Expires' before signing. - - - Adding supporting data for the service call required by the signer (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text - - - If any problems are encountered while signing the request. - - - Parameters passed as part of the resource path should be uri-encoded prior to - entry to the signer. Parameters passed in the request.Parameters collection should - be not be encoded; encoding will be done for these parameters as part of the - construction of the canonical request. - - - - - Calculates the AWS4 signature for a presigned url. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. If the Expires parameter - is present, it is renamed to 'X-Amz-Expires' before signing. - - - Adding supporting data for the service call required by the signer (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text - - - The service to sign for - - - The region to sign to, if null then the region the client is configured for will be used. - - - If any problems are encountered while signing the request. - - - Parameters passed as part of the resource path should be uri-encoded prior to - entry to the signer. Parameters passed in the request.Parameters collection should - be not be encoded; encoding will be done for these parameters as part of the - construction of the canonical request. - - The X-Amz-Content-SHA256 is cleared out of the request. - If the request is for S3 then the UNSIGNED_PAYLOAD value is used to generate the canonical request. - If the request isn't for S3 then the empty body SHA is used to generate the canonical request. - - - - - Encapsulates the various fields and eventual signing value that makes up - an AWS4 signature. This can be used to retrieve the required authorization string - or authorization query parameters for the final request as well as hold ongoing - signature computations for subsequent calls related to the initial signing. - - - - - Constructs a new signing result instance for a computed signature - - The access key that was included in the signature - Date/time (UTC) that the signature was computed - The collection of headers names that were included in the signature - Formatted 'scope' value for signing (YYYYMMDD/region/service/aws4_request) - Returns the key that was used to compute the signature - Computed signature - - - - The access key that was used in signature computation. - - - - - ISO8601 formatted date/time that the signature was computed - - - - - ISO8601 formatted date that the signature was computed - - - - - The ;-delimited collection of header names that were included in the signature computation - - - - - Formatted 'scope' value for signing (YYYYMMDD/region/service/aws4_request) - - - - - Returns a copy of the key that was used to compute the signature - - - - - Returns the hex string representing the signature - - - - - Returns a copy of the byte array containing the signature - - - - - Returns the signature in a form usable as an 'Authorization' header value. - - - - - Returns the signature in a form usable as a set of query string parameters. - - - - - Null Signer which does a no-op. - - - - - Signs the specified request with the AWS2 signing protocol by using the - AWS account credentials given in the method parameters. - - The AWS public key - The AWS secret key used to sign the request in clear text - Request metrics - The configuration that specifies which hashing algorithm to use - The request to have the signature compute for - If any problems are encountered while signing the request - - - - S3 signer constructor - - - - - S3 signer constructor - - - - - This exception is thrown if there are problems signing the request. - - - - - Response Unmarshaller for all Errors - - - - - Build an ErrorResponse from XML - - The XML parsing context. - Usually an Amazon.Runtime.Internal.UnmarshallerContext. - An ErrorResponse object. - - - - Return an instance of and ErrorResponseUnmarshaller. - - - - - - Interface for unmarshallers which unmarshall objects from response data. - The Unmarshallers are stateless, and only encode the rules for what data - in the XML stream goes into what members of an object. - - The type of object the unmarshaller returns - The type of the XML unmashaller context, which contains the - state during parsing of the XML stream. Usually an instance of - Amazon.Runtime.Internal.Transform.UnmarshallerContext. - - - - Given the current position in the XML stream, extract a T. - - The XML parsing context - An object of type T populated with data from the XML stream. - - - - Interface for unmarshallers which unmarshall service responses. - The Unmarshallers are stateless, and only encode the rules for what data - in the XML stream goes into what members of an object. - - The type of object the unmarshaller returns - The type of the XML unmashaller context, which contains the - state of parsing the XML stream. Uaually an instance of - Amazon.Runtime.Internal.Transform.UnmarshallerContext. - - - - Extracts an exeption with data from an ErrorResponse. - - The XML parsing context. - An inner exception to be included with the returned exception - The HttpStatusCode from the ErrorResponse - Either an exception based on the ErrorCode from the ErrorResponse, or the - general service exception for the service in question. - - - - Interface for unmarshallers which unmarshall objects from response data. - The Unmarshallers are stateless, and only encode the rules for what data - in the XML stream goes into what members of an object. - - The type of object the unmarshaller returns - The type of the XML unmashaller context, which contains the - state during parsing of the XML stream. Usually an instance of - Amazon.Runtime.Internal.Transform.UnmarshallerContext. - - - - Given the current position in the XML stream, extract a T. - - The XML parsing context - An object of type T populated with data from the XML stream. - - - - First-pass unmarshaller for all errors - - - - - Build an ErrorResponse from json - - The json parsing context. - Usually an Amazon.Runtime.Internal.JsonUnmarshallerContext. - An ErrorResponse object. - - - - Return an instance of JsonErrorResponseUnmarshaller. - - - - - - Wraps a json string for unmarshalling. - - Each Read() operation gets the next token. - TestExpression() is used to match the current key-chain - to an xpath expression. The general pattern looks like this: - - JsonUnmarshallerContext context = new JsonUnmarshallerContext(jsonString); - while (context.Read()) - { - if (context.IsKey) - { - if (context.TestExpresion("path/to/element")) - { - myObject.stringMember = stringUnmarshaller.GetInstance().Unmarshall(context); - continue; - } - } - } - - - - - - Wrap the jsonstring for unmarshalling. - - Stream that contains the JSON for unmarshalling - If set to true, maintains a copy of the complete response body constraint to log response size as the stream is being read. - Response data coming back from the request - If set to true, maintains a copy of the complete response body as the stream is being read. - - - - Are we at the start of the json document. - - - - - Is the current token the end of an object - - - - - Is the current token the start of an object - - - - - Returns the element depth of the parser's current position in the json - document being parsed. - - - - - The current Json path that is being unmarshalled. - - - - - Reads to the next token in the json document, and updates the context - accordingly. - - - True if a token was read, false if there are no more tokens to read. - - - - - Peeks at the next token. This peek implementation - reads the next token and makes the subsequent Read() return the same data. - If Peek is called successively, it will return the same data. - Only the first one calls Read(), subsequent calls - will return the same data until a Read() call is made. - - Token to peek. - Returns true if the peeked token matches given token. - - - - Returns the text contents of the current token being parsed. - - - The text contents of the current token being parsed. - - - - - The type of the current token - - - - - Get the base stream of the jsonStream. - - - - - Peeks at the next (non-whitespace) character in the jsonStream. - - The next (non-whitespace) character in the jsonStream, or -1 if at the end. - - - - Peeks at the next character in the stream. - If the data isn't buffered into the StreamReader (Peek() returns -1), - we flush the buffered data and try one more time. - - - - - - Abstract class for unmarshalling service responses. - - - - - Class for unmarshalling XML service responses. - - - - - Class for unmarshalling EC2 service responses. - - - - - Class for unmarshalling JSON service responses. - - - - - Unmarshaller for int fields - - - - - Unmarshaller for nullable int fields. Implemented only for JSON context - to handle cases where value can be null e.g. {'Priority': null}. - This unmarshaller is not implemented for XML context, as XML responses - will null elements (xsi:nil='true') will be skipped by the XML parser. - - - - - Unmarshaller for long fields - - - - - Unmarshaller for float fields - - - - - Unmarshaller for double fields - - - - - Unmarshaller for decimal fields - - - - - Unmarshaller for bool fields - - - - - Unmarshaller for string fields - - - - - Unmarshaller for byte fields - - - - - Unmarshaller for DateTime fields - - - - - Unmarshalls given string as a DateTime. Handles cases where we want to unmarshall - as just a DateTime or a nullable Datetime. - - Value to be parsed - If true, the method will return null if text is null. - If false, the method will return default(DateTime), if text is null. - - - - - Unmarshaller for nullable DateTime fields. Implemented only for JSON context - to handle cases where value can be null e.g. {'Priority': null}. - This unmarshaller is not implemented for XML context, as XML responses - will null elements (xsi:nil='true') will be skipped by the XML parser. - - - - - Unmarshaller for MemoryStream fields - - - - - Unmarshaller for ResponseMetadata - - - - - Base class for the UnmarshallerContext objects that are used - to unmarshall a web-service response. - - - - - Tests the specified expression against the current position in the XML - document - - The pseudo-XPath expression to test. - - True if the expression matches the current position in the document, - false otherwise. - - - - Tests the specified expression against the current position in the XML - document being parsed, and restricts the expression to matching at the - specified stack depth. - - The pseudo-XPath expression to test. - - The depth in the stack representing where the expression must - start matching in order for this method to return true. - - True if the specified expression matches the current position in - the XML document, starting from the specified depth. - - - - Reads the next token at depth greater than or equal to target depth. - - Tokens are read at depth greater than or equal to target depth. - True if a token was read and current depth is greater than or equal to target depth. - - - - The current path that is being unmarshalled. - - - - - Returns the element depth of the parser's current position in the - document being parsed. - - - - - Reads to the next node in the document, and updates the context accordingly. - - - True if a node was read, false if there are no more elements to read. - - - - - Returns the text contents of the current element being parsed. - - - The text contents of the current element being parsed. - - - - - True if NodeType is Element. - - - - - True if NodeType is EndElement. - - - - - True if the context is at the start of the document. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Wrap an XmltextReader for simulating an event stream. - - Each Read() operation goes either to the next element or next attribute within - the current element. TestExpression() is used to match the current event - to an xpath expression. The general pattern looks like this: - - UnmarshallerContext context = new UnmarshallerContext(...); - while (context.Read()) - { - if (context.TestExpresion("path/to/element")) - { - myObject.stringMember = stringUnmarshaller.GetInstance().Unmarshall(context); - continue; - } - if (context.TestExpression("path/to/@attribute")) - myObject.MyComplexTypeMember = MyComplexTypeUnmarshaller.GetInstance().Unmarshall(context); - } - - - - - - Wrap an XmlTextReader with state for event-based parsing of an XML stream. - - Stream with the XML from a service response. - If set to true, maintains a copy of the complete response body constraint to log response size as the stream is being read. - Response data coming back from the request - If set to true, maintains a copy of the complete response body as the stream is being read. - - - - The current XML path that is being unmarshalled. - - - - - Returns the element depth of the parser's current position in the XML - document being parsed. - - - - - Reads to the next node in the XML document, and updates the context accordingly. - - - True if a node was read, false if there are no more elements to read./ - - - - - Returns the text contents of the current element being parsed. - - - The text contents of the current element being parsed. - - - - - True if NodeType is Element. - - - - - True if NodeType is EndElement. - - - - - True if the context is at the start of the document. - - - - - True if NodeType is Attribute. - - - - - Wrap an XmlTextReader with state for event-based parsing of an XML stream. - - Stream with the XML from a service response. - If set to true, maintains a copy of the complete response body constraint to log response size as the stream is being read. - Response data coming back from the request - If set to true, maintains a copy of the complete response body as the stream is being read. - - - - RequestId value, if found in response - - - - - Reads to the next node in the XML document, and updates the context accordingly. - If node is RequestId, reads the contents and stores in RequestId property. - - - True if a node was read, false if there are no more elements to read./ - - - - - A stream which caches the contents of the underlying stream as it reads it. - - - - - All the bytes read by the stream. - - - - - All the bytes read by the stream constrained with _cacheLimit - - - - - Initializes the CachingWrapperStream with a base stream. - - The stream to be wrapped. - Maximum number of bytes to be cached. - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Gets a value indicating whether the current stream supports seeking. - CachingWrapperStream does not support seeking, this will always be false. - - - - - Gets or sets the position within the current stream. - CachingWrapperStream does not support seeking, attempting to set Position - will throw NotSupportedException. - - - - - Sets the position within the current stream. - CachingWrapperStream does not support seeking, attempting to call Seek - will throw NotSupportedException. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Stream wrapper that double-buffers from a wrapped stream and - returns the buffered content as a series of signed 'chunks' - for the AWS4 ('Signature V4') protocol. - - - - - Reads some or all of the processed chunk to the consumer, constructing - and streaming a new chunk if more input data is available. - - - - - - - - - Attempt to read sufficient data for a whole chunk from the wrapped stream, - returning the number of bytes successfully read to be processed into a chunk - - - - - Results of the header-signing portion of the request - - - - - Computed signature of the chunk prior to the one in-flight, in - hex - - - - - Computes the derived signature for a chunk of data of given length in the input buffer, - placing a formatted chunk with headers, signature and data into the output buffer - ready for streaming back to the consumer. - - - - - - Length override to return the true length of the payload plus the metainfo - supplied with each chunk - - - - - Computes the total size of the data payload, including the chunk metadata. - Called externally so as to be able to set the correct Content-Length header - value. - - - - - - - Computes the size of the header data for each chunk. - - - - - - - Attempt to read sufficient data for a whole chunk from the wrapped stream, - returning the number of bytes successfully read to be processed into a chunk - - - - - A list object that will always be sent to AWS services, - even if it is empty. - The AWS .NET SDK does not send empty collections to services, unless - the collection is of this type. - - - - - - A dictionary object that will always be sent to AWS services, - even if it is empty. - The AWS .NET SDK does not send empty collections to services, unless - the collection is of this type. - - - - - - - Class to perform actions on a background thread. - Uses a single background thread and performs actions - on it in the order the data was sent through the instance. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Class to invoke actions on a background thread. - Uses a single background thread and invokes actions - on it in the order they were invoked through the instance. - - - - - PCL doesn't have IPAddress. These methods are copied from the Microsoft source code. - - - - - Returns true if the Content is set or there are - query parameters. - - This request - True if data is present; false otherwise. - - - - Utilities for dealing with Guids - - - - - Hashes a set of objects. - - - - - - - Combines a set of hashses. - - - - - - - Combines two hashes. - - - - - - - - Disposes of all managed and unmanaged resources. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - A wrapper stream that calculates a hash of the base stream as it - is being read. - The calculated hash is only available after the stream is closed or - CalculateHash is called. After calling CalculateHash, any further reads - on the streams will not change the CalculatedHash. - If an ExpectedHash is specified and is not equal to the calculated hash, - Close or CalculateHash methods will throw an AmazonClientException. - If CalculatedHash is calculated for only the portion of the stream that - is read. - - - Exception thrown during Close() or CalculateHash(), if ExpectedHash is set and - is different from CalculateHash that the stream calculates, provided that - CalculatedHash is not a zero-length byte array. - - - - - Algorithm to use to calculate hash. - - - - - True if hashing is finished and no more hashing should be done; - otherwise false. - - - - - Current position in the stream. - - - - - Calculated hash for the stream. - This value is set only after the stream is closed. - - - - - Expected hash value. Compared against CalculatedHash upon Close(). - If the hashes are different, an AmazonClientException is thrown. - - - - - Expected length of stream. - - - - - Initializes an HashStream with a hash algorithm and a base stream. - - Stream to calculate hash for. - - Expected hash. Will be compared against calculated hash on stream close. - Pass in null to disable check. - - - Expected length of the stream. If the reading stops before reaching this - position, CalculatedHash will be set to empty array. - - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Asynchronously reads a sequence of bytes from the current stream, advances - the position within the stream by the number of bytes read, and monitors - cancellation requests. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous read operation. The value of the TResult - parameter contains the total number of bytes read into the buffer. This can be - less than the number of bytes requested if that many bytes are not currently - available, or zero (0) if the end of the stream has been reached. - - - - - Gets a value indicating whether the current stream supports seeking. - HashStream does not support seeking, this will always be false. - - - - - Gets or sets the position within the current stream. - HashStream does not support seeking, attempting to set Position - will throw NotSupportedException. - - - - - Sets the position within the current stream. - HashStream does not support seeking, attempting to call Seek - will throw NotSupportedException. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Gets the overridden length used to construct the HashStream - - - - - Calculates the hash for the stream so far and disables any further - hashing. - - - - - Resets the hash stream to starting state. - Use this if the underlying stream has been modified and needs - to be rehashed without reconstructing the hierarchy. - - - - - Validates the underlying stream. - - - - - Compares two hashes (arrays of bytes). - - Expected hash. - Actual hash. - - True if the hashes are identical; otherwise false. - - - - - A wrapper stream that calculates a hash of the base stream as it - is being read or written. - The calculated hash is only available after the stream is closed or - CalculateHash is called. After calling CalculateHash, any further reads - on the streams will not change the CalculatedHash. - If an ExpectedHash is specified and is not equal to the calculated hash, - Close or CalculateHash methods will throw an AmazonClientException. - If base stream's position is not 0 or HashOnReads is true and the entire stream is - not read, the CalculatedHash will be set to an empty byte array and - comparison to ExpectedHash will not be made. - - - Exception thrown during Close() or CalculateHash(), if ExpectedHash is set and - is different from CalculateHash that the stream calculates, provided that - CalculatedHash is not a zero-length byte array. - - - - - Initializes an HashStream with a hash algorithm and a base stream. - - Stream to calculate hash for. - - Expected hash. Will be compared against calculated hash on stream close. - Pass in null to disable check. - - - Expected length of the stream. If the reading stops before reaching this - position, CalculatedHash will be set to empty array. - - - - - A wrapper stream that calculates an MD5 hash of the base stream as it - is being read or written. - The calculated hash is only available after the stream is closed or - CalculateHash is called. After calling CalculateHash, any further reads - on the streams will not change the CalculatedHash. - If an ExpectedHash is specified and is not equal to the calculated hash, - Close or CalculateHash methods will throw an AmazonClientException. - If base stream's position is not 0 or HashOnReads is true and the entire stream is - not read, the CalculatedHash will be set to an empty byte array and - comparison to ExpectedHash will not be made. - - - Exception thrown during Close() or CalculateHash(), if ExpectedHash is set and - is different from CalculateHash that the stream calculates, provided that - CalculatedHash is not a zero-length byte array. - - - - - Initializes an MD5Stream with a base stream. - - Stream to calculate hash for. - - Expected hash. Will be compared against calculated hash on stream close. - Pass in null to disable check. - - - Expected length of the stream. If the reading stops before reaching this - position, CalculatedHash will be set to empty array. - - - - - Utilities for validating label values for host prefix templates - - - - - Validates a label value - - - - - Simple wrapper around the log4net Error method. - - - - - - - - Write debug message to Console - - - - - - - - Write debug message to Console - - - - - - - Simple wrapper around the log4net InfoFormat method. - - - - - - - This is a dynamic wrapper around log4net so we can avoid log4net being required - to be distributed with the SDK. - - - - - Abstract logger class, base for any custom/specific loggers. - - - - - Flushes the logger contents. - - - - - Simple wrapper around the log4net IsErrorEnabled property. - - - - - Simple wrapper around the log4net IsDebugEnabled property. - - - - - Simple wrapper around the log4net IsInfoEnabled property. - - - - - Simple wrapper around the log4net Error method. - - - - - - - - Simple wrapper around the log4net Debug method. - - - - - - - - Simple wrapper around the log4net DebugFormat method. - - - - - - - Simple wrapper around the log4net InfoFormat method. - - - - - - - Logger wrapper for reflected log4net logging methods. - - - - - This should be a one time call to use reflection to find all the types and methods - needed for the logging API. - - - - - Simple wrapper around the log4net IsErrorEnabled property. - - - - - Simple wrapper around the log4net Error method. - - - - - - - - Simple wrapper around the log4net IsDebugEnabled property. - - - - - Simple wrapper around the log4net Debug method. - - - - - - - - Simple wrapper around the log4net DebugFormat method. - - - - - - - Simple wrapper around the log4net IsInfoEnabled property. - - - - - Simple wrapper around the log4net InfoFormat method. - - - - - - - A single logged message - - - - - Log message arguments. - - - - - Culture-specific formatting provider. - - - - - Log message format. - - - - - a size-limited cache of key value pairs - - Once the maximum size has been reached, the least recently - used pairs will be evicted to make room for any new items. - - - - - - - the maximum number of entries this LruCache will hold - before items begin getting evicted - - - - - the number of items in the cache - - - - - Construct a new LruCache. - - maximum number of entries before items are evicted - - - - Add the key/value pair to the cache, or update - the value if the key already exists. - - If the cache is full, evicts the least recently used item. - - - - - - - Evicts a specific key out of the cache if it exists - - the key to evict from the cache - - - - Try to get the value associated with the key. - - the key to look up - the value, if the key exists - true if there is a value associated with the key, or false if no value is associated with the key - - - - Try to get the value associated with the key, if it doesn't exist, use the provided factory method to - create a new value and tries adding it to the cache. - - the key to look up - the factory method used in case the key is not present in the cache - the looked up value or the value created by the factory - - - - Clear the LruCache of all entries. - - - - - Helper class to support LruCache. - Does not implement the error checking and synchronization that - would be necessary for it to stand alone. - - - - - Item to be stored in the LruList - linked list structure. - - - - - Collection of properties being tracked - - - - - Timings for metrics being tracked - - - - - Counters being tracked - - - - - Whether metrics are enabled for the request - - - - - Constructs an empty, disabled metrics object - - - - - Starts timing an event. Logs an exception if an event - of the same type was started but not stopped. - - - - - - - Stops timing an event. Logs an exception if the event wasn't started. - - - - - - - Adds a property for a metric. If there are multiple, the - object is added as a new item in a list. - - - - - - - Sets a counter for a specific metric. - - - - - - - Increments a specific metric counter. - If counter doesn't exist yet, it is set to 1. - - - - - - Returns errors associated with the metric, including - if there are still any timing events in-flight. - - - - - - Returns a string representation of the current metrics. - - - - - - Return a JSON represenation of the current metrics - - - - - - Timing information for a metric - - - - - Empty, stopped timing object - - - - - Timing object in a started state - - - - - - Stops timing - - - - - - Whether the timing has been stopped - - - - - Elapsed ticks from start to stop. - If timing hasn't been stopped yet, returns 0. - - - - - Elapsed time from start to stop. - If timing hasn't been stopped yet, returns TimeSpan.Zero - - - - - Timing event, stops timing of a metric when disposed - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - The destructor for the client class. - - - - - A wrapper stream which supresses disposal of the underlying stream. - - - - - Constructor for NonDisposingWrapperStream. - - The base stream to wrap. - - - - The Dispose implementation for this wrapper stream - does not close the underlying stream. - - - - - This class is used to wrap a stream for a particular segment of a stream. It - makes that segment look like you are reading from beginning to end of the stream. - - - - - Asynchronously reads a sequence of bytes from the current stream, advances - the position within the stream by the number of bytes read, and monitors - cancellation requests. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous read operation. The value of the TResult - parameter contains the total number of bytes read into the buffer. This can be - less than the number of bytes requested if that many bytes are not currently - available, or zero (0) if the end of the stream has been reached. - - - - - Asynchronously writes a sequence of bytes to the current stream and advances the - current position within this stream by the number of bytes written. - - - An array of bytes. This method copies count bytes from buffer to the current stream. - - - The zero-based byte offset in buffer at which to begin copying bytes to the - current stream. - - The number of bytes to be written to the current stream. - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - A task that represents the asynchronous write operation. - - - - Wrapper stream that only supports reading - - - - - Asynchronously clears all buffers for this stream and causes any buffered data - to be written to the underlying device. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous flush operation. - - - - - Asynchronously writes a sequence of bytes to the current stream and advances the - current position within this stream by the number of bytes written. - - - An array of bytes. This method copies count bytes from buffer to the current stream. - - - The zero-based byte offset in buffer at which to begin copying bytes to the - current stream. - - The number of bytes to be written to the current stream. - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - A task that represents the asynchronous write operation. - - - - Partial wrapper stream that only supports reading - - - - - Uri wrapper that can parse out information (bucket, key, region, style) from an - S3 URI. - - - - - True if the URI contains the bucket in the path, false if it contains the bucket in the authority. - - - - - The bucket name parsed from the URI (or null if no bucket specified). - - - - - The key parsed from the URI (or null if no key specified). - - - - - The region parsed from the URI (or null if no region specified). - - - - - Constructs a parser for the S3 URI specified as a string. - - The S3 URI to be parsed. - - - - Constructs a parser for the S3 URI specified as a Uri instance. - - The S3 URI to be parsed. - - - - Percent-decodes the given string, with a fast path for strings that are not - percent-encoded. - - The string to decode - The decoded string - - - - Percent-decodes the given string. - - The string to decode - The index of the first '%' in the string - The decoded string - - - - Decodes the percent-encoded character at the given index in the string - and appends the decoded value to the string under construction. - - - The string under construction to which the decoded character will be - appended. - - The string being decoded. - The index of the '%' character in the string. - - - - Converts a hex character (0-9A-Fa-f) into its corresponding quad value. - - The hex character - The quad value - - - - Interface for a non-generic cache. - - - - - Clears the entire cache. - - - - - Maximum time to keep an item around after its last use. - - - - - How often should the cache be cleared of old items. - - - - - The number of items in the cache. - - - - - Interface for a generic cache. - - - - - - - Retrieves a value out of the cache or from the source. - - - - - - - - Retrieves a value out of the cache or from the source. - If the item was in the cache, isStaleItem is set to true; - otherwise, if the item comes from the source, isStaleItem is false. - - - - - - - - - Clears a specific value from the cache if it's there. - - - - - - Returns the keys for all items in the cache. - - - - - - Executes specified operation, catches exception, clears the cache for - the given key, retries the operation. - - - - - - - - - - - SDK-wide cache. - Provides access to caches specific to a particular set of credentials - and target region. - - - - - Clear all caches - - - - - Clear all caches of a particular type - - - - - - Retrieve a cache of a specific type for a client object. - The client object can be null in cases where a cache does - not correspond to a specific AWS account or target region. - - - - - - - - - - - Retrieve a cache of a specific type for a client object. - The client object can be null in cases where a cache does - not correspond to a specific AWS account or target region. - - - - - - - - - - - Utilities for converting objects to strings. Used by the marshaller classes. - - - - - Converts a DateTime to ISO8601 formatted string. - - - - - Converts a DateTime to RFC822 formatted string. - - - - - Converts a DateTime to Unix epoch time formatted string. - - - - - A wrapper stream. - - - - - Base stream. - - - - - Initializes WrapperStream with a base stream. - - - - - - Returns the first base non-WrapperStream. - - First base stream that is non-WrapperStream. - - - - Returns the first base non-WrapperStream. - - First base stream that is non-WrapperStream. - - - - Returns the first base non-WrapperStream. - - Potential WrapperStream - Base non-WrapperStream. - - - - Gets a value indicating whether the current stream supports reading. - True if the stream supports reading; otherwise, false. - - - - - Gets a value indicating whether the current stream supports seeking. - True if the stream supports seeking; otherwise, false. - - - - - Gets a value indicating whether the current stream supports writing. - True if the stream supports writing; otherwise, false. - - - - - Closes the current stream and releases any resources (such as sockets and - file handles) associated with the current stream. - - - - - Gets the length in bytes of the stream. - - - - - Gets or sets the position within the current stream. - - - - - Gets or sets a value, in miliseconds, that determines how long the stream - will attempt to read before timing out. - - - - - Gets or sets a value, in miliseconds, that determines how long the stream - will attempt to write before timing out. - - - - - Clears all buffers for this stream and causes any buffered data to be written - to the underlying device. - - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Sets the position within the current stream. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Sets the length of the current stream. - - The desired length of the current stream in bytes. - - - - Writes a sequence of bytes to the current stream and advances the current - position within this stream by the number of bytes written. - - - An array of bytes. This method copies count bytes from buffer to the current stream. - - - The zero-based byte offset in buffer at which to begin copying bytes to the - current stream. - - The number of bytes to be written to the current stream. - - - - Asynchronously clears all buffers for this stream and causes any buffered data - to be written to the underlying device. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous flush operation. - - - - - Asynchronously reads a sequence of bytes from the current stream, advances - the position within the stream by the number of bytes read, and monitors - cancellation requests. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous read operation. The value of the TResult - parameter contains the total number of bytes read into the buffer. This can be - less than the number of bytes requested if that many bytes are not currently - available, or zero (0) if the end of the stream has been reached. - - - - - Asynchronously writes a sequence of bytes to the current stream and advances the - current position within this stream by the number of bytes written. - - - An array of bytes. This method copies count bytes from buffer to the current stream. - - - The zero-based byte offset in buffer at which to begin copying bytes to the - current stream. - - The number of bytes to be written to the current stream. - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - A task that represents the asynchronous write operation. - - - - This is a utility class to be used in last resort for code paths that are synchronous but need to call an asynchronous method. - This should never be used for methods that are called at high volume as this utility class has a performance cost. For example this - class was added for the refreshing credentials like Cognito which would need to use this about once an hour. - - - - - Custom WebProxy implementation that creates a webproxy based on - user inputs(Host name and port number) - - - - - Set the ProxyUri - - - - - Create a Uri based on the user inputs(Host name and port number) - - - - - Proxy Uri property - - - - - Proxy Credentials property - - - - - Getter to fetch the set proxy - - - - - Method to determine if the proxy should be bypassed when accessing an internet source - - - - - Error is always enabled - - - - - Debug logging is always enabled - - - - - Info logging is always enabled - - - - - Prints the Log With Error Level - - - - - - - - Prints the Log with Debug Level - - - - - - - - Prints the Log with Debug Level - - - - - - - Prints the Log With Info Level - - - - - - - This class is no longer used anymore and should be avoided as it is just meant - as a last resort when blending async and sync operations. The code is still - here to support versions before 3.3.9.0 of AWSSDK.DynamoDBv2. - - - - - Property to denote that the last exception returned by an AWS Service - was retryable or not. - - - - - An abstract pipeline handler that has implements IPipelineHandler, - and has the default implmentation. This is the base class for most of - the handler implementations. - - - - - The logger used to log messages. - - - - - The inner handler which is called after the current - handler completes it's processing. - - - - - The outer handler which encapsulates the current handler. - - - - - Contains the processing logic for a synchronous request invocation. - This method calls InnerHandler.InvokeSync to continue processing of the - request by the pipeline. - - The execution context which contains both the - requests and response context. - - - - Contains the processing logic for an asynchronous request invocation. - This method calls InnerHandler.InvokeSync to continue processing of the - request by the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Logs the metrics for the current execution context. - - The execution context, it contains the - request and response context. - - - - A runtime pipeline contains a collection of handlers which represent - different stages of request and response processing. - - - - - The top-most handler in the pipeline. - - - - - Constructor for RuntimePipeline. - - The handler with which the pipeline is initalized. - - - - Constructor for RuntimePipeline. - - List of handlers with which the pipeline is initalized. - - - - Constructor for RuntimePipeline. - - List of handlers with which the pipeline is initalized. - The logger used to log messages. - - - - Constructor for RuntimePipeline. - - The handler with which the pipeline is initalized. - The logger used to log messages. - - - - Invokes the pipeline synchronously. - - Request context - Response context - - - - Invokes the pipeline asynchronously. - - Request context - Response context - - - - Adds a new handler to the top of the pipeline. - - The handler to be added to the pipeline. - - - - Adds a handler after the first instance of handler of type T. - - Type of the handler after which the given handler instance is added. - The handler to be added to the pipeline. - - - - Adds a handler before the first instance of handler of type T. - - Type of the handler before which the given handler instance is added. - The handler to be added to the pipeline. - - - - Removes the first occurance of a handler of type T. - - Type of the handler which will be removed. - - - - Replaces the first occurance of a handler of type T with the given handler. - - Type of the handler which will be replaced. - The handler to be added to the pipeline. - - - - Inserts the given handler after current handler in the pipeline. - - Handler to be inserted in the pipeline. - Handler after which the given handler is inserted. - - - - Gets the innermost handler by traversing the inner handler till - it reaches the last one. - - - - - Retrieves a list of handlers, in the order of their execution. - - Handlers in the current pipeline. - - - - Retrieves current handlers, in the order of their execution. - - Handlers in the current pipeline. - - - - This handler processes exceptions thrown from the HTTP handler and - unmarshalls error responses. - - - - - Default set of exception handlers. - - - - - Default set of exception handlers. - - - - - Constructor for ErrorHandler. - - an ILogger instance. - - - - Handles and processes any exception thrown from underlying handlers. - - The execution context which contains both the - requests and response context. - - - - Handles and processes any exception thrown from underlying handlers. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Disposes the response body. - - The response context. - - - - Processes an exception by invoking a matching exception handler - for the given exception. - - The execution context, it contains the - request and response context. - The exception to be processed. - - This method returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception that may be thrown by exception - processing by a matching exception handler. - - - - - The abstract base class for exception handlers. - - The exception type. - - - - The exception handler for HttpErrorResponseException exception. - - - - - The constructor for HttpErrorResponseExceptionHandler. - - in instance of ILogger. - - - - Handles an exception for the given execution context. - - The execution context, it contains the - request and response context. - The exception to handle. - - Returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception to replace the original exception. - - - - - Checks if a HTTP 404 status code is returned which needs to be suppressed and - processes it. - If a suppressed 404 is present, it unmarshalls the response and returns true to - indicate that a suppressed 404 was processed, else returns false. - - The execution context, it contains the - request and response context. - - - If a suppressed 404 is present, returns true, else returns false. - - - - - A pipeline handler which provides hooks to run - external code in the pre-invoke and post-invoke phases. - - - - - Action to execute on the pre invoke phase. - - - - - Action to execute on the post invoke phase. - - - - - Calls the PreInvoke and PostInvoke methods before and after calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls the PreInvoke and PostInvoke methods before and after calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Executes the OnPreInvoke action as part of pre-invoke. - - The execution context, it contains the - request and response context. - - - - Executes the OnPreInvoke action as part of post-invoke. - - The execution context, it contains the - request and response context. - - - - This handler retrieved the AWS credentials to be used for the current call. - - - - - The constructor for CredentialsRetriever. - - An AWSCredentials instance. - - - - Retrieves the credentials to be used for the current call before - invoking the next handler. - - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - This handler resolves the endpoint to be used for the current request. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Resolves the endpoint to be used for the current request - before invoking the next handler. - - The execution context, it contains the - request and response context. - - - - This handler resolves the endpoint to be used for the current request. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Resolves the endpoint to be used for the current request - before invoking the next handler. - - The execution context, it contains the - request and response context. - - - - Determines the endpoint for the request. - - The request context. - - - - - This handler provides an OnError action that can be used as hook for - external code to handle exceptions in the runtime pipeline. - - - - - Action to execute if an exception occurs during the - execution of any underlying handlers. - - - - - Executes the OnError action if an exception occurs during the - execution of any underlying handlers. - - - - - - - This handler marshalls the request before calling invoking the next handler. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Marshalls the request before calling invoking the next handler. - - The execution context, it contains the - request and response context. - - - - This handler manages the metrics used to time the complete call and - logs the final metrics. - - - - - Captures the overall execution time and logs final metrics. - - The execution context which contains both the - requests and response context. - - - - Captures the overall execution time and logs final metrics. - - The response type for the current request. - - The execution context, it contains the request and response context. - - A task that represents the asynchronous operation. - - - - This handler processes HTTP redirects and reissues the call to the - redirected location. - - - - - Processes HTTP redirects and reissues the call to the - redirected location. - - The execution context which contains both the - requests and response context. - - - - Processes HTTP redirects and reissues the call to the - redirected location. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Checks if an HTTP 307 (temporary redirect) has occured and changes the - request endpoint to the redirected location. - - - The execution context, it contains the request and response context. - - - A boolean value that indicates if a redirect has occured. - - - - - This handler signs the request. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Signs the request before invoking the next handler. - - - The execution context, it contains the request and response context. - - - - - Determines if the request should be signed. - - The request context. - A boolean value that indicated if the request should be signed. - - - - Signs the request. - - The request context. - - - - This handler unmarshalls the HTTP response. - - - - - The constructor for Unmarshaller. - - - Boolean value which indicated if the unmarshaller - handler supports response logging. - - - - - Unmarshalls the response returned by the HttpHandler. - - The execution context which contains both the - requests and response context. - - - - Unmarshalls the response returned by the HttpHandler. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Unmarshalls the HTTP response. - - - The execution context, it contains the request and response context. - - - - - Unmarshalls the HTTP response. - - - The execution context, it contains the request and response context. - - - - - The HTTP handler contains common logic for issuing an HTTP request that is - independent of the underlying HTTP infrastructure. - - - - - - The sender parameter used in any events raised by this handler. - - - - - The constructor for HttpHandler. - - The request factory used to create HTTP Requests. - The sender parameter used in any events raised by this handler. - - - - Issues an HTTP request for the current request context. - - The execution context which contains both the - requests and response context. - - - - Issues an HTTP request for the current request context. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Determines the content for request body and uses the HTTP request - to write the content to the HTTP request body. - - Content to be written. - The HTTP request. - The request context. - - - - Creates the HttpWebRequest and configures the end point, content, user agent and proxy settings. - - The async request. - The web request that actually makes the call. - - - - Disposes the HTTP handler. - - - - - The default implementation of the adaptive retry policy. - - - The default implementation of the adaptive policy. - - - - - Constructor for AdaptiveRetryPolicy. - - The maximum number of retries before throwing - back a exception. This does not count the initial request. - - - - Constructor for AdaptiveRetryPolicy. - - The Client config object. This is used to - retrieve the maximum number of retries before throwing - back a exception(This does not count the initial request) and - the service URL for the request. - - - - OnRetry is called when a retry request is initiated to determine if the request will be retried. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - true if the error that will be retried is a throtting error - True if retry throttling is disabled or retry throttling is enabled and capacity can be obtained. - - - - This method uses a token bucket to enforce the maximum sending rate. - - The execution context which contains both the - requests and response context. - If the prior request failed, this exception is expected to be - the exception that occurred during the prior request failure. - - - - Virtual method that gets called on a success Response. If its a retry success response, the entire - retry acquired capacity is released(default is 5). If its just a success response a lesser value capacity - is released(default is 1). - - Request context containing the state of the request. - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - This method uses a token bucket to enforce the maximum sending rate. - - The execution context which contains both the - requests and response context. - If the prior request failed, this exception is expected to be - the exception that occurred during the prior request failure. - - - - The default implementation of the legacy retry policy. - - - The default implementation of the legacy retry policy. - - - - - The maximum value of exponential backoff in milliseconds, which will be used to wait - before retrying a request. The default is 30000 milliseconds. - - - - - Constructor for DefaultRetryPolicy. - - The maximum number of retries before throwing - back a exception. This does not count the initial request. - - - - Constructor for DefaultRetryPolicy. - - The Client config object. This is used to - retrieve the maximum number of retries before throwing - back a exception(This does not count the initial request) and - the service URL for the request. - - - - Returns true if the request is in a state where it can be retried, else false. - - Request context containing the state of the request. - Returns true if the request is in a state where it can be retried, else false. - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - true if the error that will be retried is a throtting error - - - - Virtual method that gets called on a success Response. If its a retry success response, the entire - retry acquired capacity is released(default is 5). If its just a success response a lesser value capacity - is released(default is 1). - - Request context containing the state of the request. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Request context containing the state of the request. - Return true if the request should be retried. - - - - Checks if the retry limit is reached. - - Request context containing the state of the request. - Return false if the request can be retried, based on number of retries. - - - - Waits before retrying a request. The default policy implements a exponential backoff. - - Request context containing the state of the request. - - - - Waits for an amount of time using an exponential backoff algorithm. - - The request retry index. The first request is expected to be 0 while - the first retry will be 1. - The max number of milliseconds to wait - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - The retry handler has the generic logic for retrying requests. - It uses a retry policy which specifies when - a retry should be performed. - - - - - The logger used to log messages. - - - - - The retry policy which specifies when - a retry should be performed. - - - - - Constructor which takes in a retry policy. - - Retry Policy - - - - Invokes the inner handler and performs a retry, if required as per the - retry policy. - - The execution context which contains both the - requests and response context. - - - - Invokes the inner handler and performs a retry, if required as per the - retry policy. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Prepares the request for retry. - - Request context containing the state of the request. - - - - The default implementation of the standard retry policy. - - - The default implementation of the standard policy. - - - - - The maximum value of exponential backoff in milliseconds, which will be used to wait - before retrying a request. The default is 20000 milliseconds. - - - - - Constructor for StandardRetryPolicy. - - The maximum number of retries before throwing - back a exception. This does not count the initial request. - - - - Constructor for StandardRetryPolicy. - - The Client config object. This is used to - retrieve the maximum number of retries before throwing - back a exception(This does not count the initial request) and - the service URL for the request. - - - - Returns true if the request is in a state where it can be retried, else false. - - Request context containing the state of the request. - Returns true if the request is in a state where it can be retried, else false. - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - true if the error that will be retried is a throtting error - - - - Virtual method that gets called on a success Response. If its a retry success response, the entire - retry acquired capacity is released(default is 5). If its just a success response a lesser value capacity - is released(default is 1). - - Request context containing the state of the request. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Request context containing the state of the request. - Return true if the request should be retried. - - - - Checks if the retry limit is reached. - - Request context containing the state of the request. - Return false if the request can be retried, based on number of retries. - - - - Waits before retrying a request. The default policy implements a exponential backoff with - jitter algorithm. - - Request context containing the state of the request. - - - - Waits for an amount of time using an exponential backoff with jitter algorithm. - - The request retry index. The first request is expected to be 0 while - the first retry will be 1. - The max number of milliseconds to wait - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - This class is the base class of all the configurations settings to connect - to a service. - - - This class is the base class of all the configurations settings to connect - to a service. - - - - - Gets Service Version - - - - - Gets and sets of the signatureMethod property. - - - - - Gets and sets of the SignatureVersion property. - - Note: This property exists for backward compatibility but is no longer - used by any service other than S3. - - - - - Gets and sets of the UserAgent property. - - - - - Gets and sets the RegionEndpoint property. The region constant that - determines the endpoint to use. - - Setting this property to null will force the SDK to recalculate the - RegionEndpoint value based on App/WebConfig, environment variables, - profile, etc. - - - - - The constant used to lookup in the region hash the endpoint. - - - - - Gets and sets of the ServiceURL property. - This is an optional property; change it - only if you want to try a different service - endpoint. - - - - - Gets and sets the UseHttp. - If this property is set to true, the client attempts - to use HTTP protocol, if the target endpoint supports it. - By default, this property is set to false. - - - - - Given this client configuration, return a string form ofthe service endpoint url. - - - - - Gets and sets the AuthenticationRegion property. - Used in AWS4 request signing, this is an optional property; - change it only if the region cannot be determined from the - service endpoint. - - - - - Gets and sets the AuthenticationServiceName property. - Used in AWS4 request signing, this is the short-form - name of the service being called. - - - - - Returns the flag indicating how many retry HTTP requests an SDK should - make for a single SDK operation invocation before giving up. This flag will - return 4 when the RetryMode is set to "Legacy" which is the default. For - RetryMode values of "Standard" or "Adaptive" this flag will return 2. In - addition to the values returned that are dependant on the RetryMode, the - value can be set to a specific value by using the AWS_MAX_ATTEMPTS environment - variable, max_attempts in the shared configuration file, or by setting a - value directly on this property. When using AWS_MAX_ATTEMPTS or max_attempts - the value returned from this property will be one less than the value entered - because this flag is the number of retry requests, not total requests. To - learn more about the RetryMode property that affects the values returned by - this flag, see . - - - - - Determines if MaxErrorRetry has been manually set. - - - - - Gets and sets the LogResponse property. - If this property is set to true, the service response is logged. - The size of response being logged is controlled by the AWSConfigs.LoggingConfig.LogResponsesSizeLimit property. - - - - - Gets and sets the ReadEntireResponse property. - NOTE: This property does not effect response processing and is deprecated. - To enable response logging, the ClientConfig.LogResponse and AWSConfigs.LoggingConfig - properties can be used. - - - - - Gets and Sets the BufferSize property. - The BufferSize controls the buffer used to read in from input streams and write - out to the request. - - - - - - Gets or sets the interval at which progress update events are raised - for upload operations. By default, the progress update events are - raised at every 100KB of data transferred. - - - If the value of this property is set less than ClientConfig.BufferSize, - progress updates events will be raised at the interval specified by ClientConfig.BufferSize. - - - - - - Flag on whether to resign requests on retry or not. - For Amazon S3 and Amazon Glacier this value will always be set to true. - - - - - This flag controls if .NET HTTP infrastructure should follow redirection - responses (e.g. HTTP 307 - temporary redirect). - - - - - Flag on whether to log metrics for service calls. - - This can be set in the application's configs, as below: - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSLogMetrics" value"true"/> - </appSettings> - </configuration> - - - - - - Gets and sets the DisableLogging. If true logging for this client will be disabled. - - - - - Credentials to use with a proxy. - - - - - - If the value is set, the value is assigned to the Timeout property of the HttpWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Configures the endpoint calculation for a service to go to a dual stack (ipv6 enabled) endpoint - for the configured region. - - - Note: AWS services are enabling dualstack endpoints over time. It is your responsibility to check - that the service actually supports a dualstack endpoint in the configured region before enabling - this option for a service. - - - - - Enable or disable the Retry Throttling feature by setting the ThrottleRetries flag to True/False resepctively. - Retry Throttling is a feature that intelligently throttles retry attempts when a large precentage of requests - are failing and retries are unsuccessful as well. In such situations the allotted retry capacity for the service URL - will be drained until requests start to succeed again. Once the requisite capacity is available, retries would - be permitted again. When retries are throttled, the service enters a fail-fast behaviour as the traditional retry attempt - for the request would be circumvented. Hence, errors will resurface quickly. This will result in a greated number of exceptions - but prevents requests being tied up in unsuccessful retry attempts. - Note: Retry Throttling is enabled by default. Set the ThrottleRetries flag to false to switch off this feature. - - - - - Enable or disable the Nagle algorithm on the underlying http - client. - - This method is not intended to be called by consumers of the AWS SDK for .NET - - - - - - Performs validation on this config object. - Throws exception if any of the required values are missing/invalid. - - - - - Returns the current UTC now after clock correction for this endpoint. - - - - - The calculated clock skew correction for a specific endpoint, if there is one. - This field will be set if a service call resulted in an exception - and the SDK has determined that there is a difference between local - and server times. - - If is set to true, this - value will still be set to the correction, but it will not be used by the - SDK and clock skew errors will not be retried. - - - - - Gets and sets the DisableHostPrefixInjection flag. If true, host prefix injection will be disabled for this client, the default value of this flag is false. - Host prefix injection prefixes the service endpoint with request members from APIs which use this feature. - Example: for a hostPrefix of "foo-name." and a endpoint of "service.region.amazonaws.com" the default behavior is to - prefix the endpoint with the hostPrefix resulting in a final endpoint of "foo-name.service.region.amazonaws.com". Setting - DisableHostPrefixInjection to true will disable hostPrefix injection resulting in a final endpoint of - "service.region.amazonaws.com" regardless of the value of hostPrefix. E.g. You may want to disable host prefix injection for testing against a local mock endpoint. - - - - - Returns the flag indicating if endpoint discovery should be enabled or disabled for operations that are not required to use endpoint discovery. - - - - - Returns the maximum number of discovered endpoints that can be stored within the cache for the client. The default limit is 1000 cache entries. - - - - - Returns the flag indicating the current mode in use for request - retries and influences the value returned from . - The default value is RequestRetryMode.Legacy. This flag can be configured - by using the AWS_RETRY_MODE environment variable, retry_mode in the - shared configuration file, or by setting this value directly. - - - - - Under Adaptive retry mode, this flag determines if the client should wait for - a send token to become available or don't block and fail the request immediately - if a send token is not available. - - - - - Throw an exception if the boxed TimeSpan parameter doesn't have a value or is out of range. - - - - - Returns the request timeout value if its value is set, - else returns client timeout value. - - - - - - This is a switch used for performance testing and is not intended for production applications - to change. This switch may be removed in a future version of the SDK as the .NET Core platform matures. - - - If true, the HttpClient is cached and reused for every request made by the service client - and shared with other service clients. - - - For the .NET Core platform this is default to true because the HttpClient manages the connection - pool. - - - - - - If CacheHttpClient is set to true then HttpClientCacheSize controls the number of HttpClients cached. - - On Windows the default value is 1 since the underlying native implementation does not have throttling constraints - like the non Windows Curl based implementation. For non Windows based platforms the default is the value return from - System.Environment.ProcessorCount. - - - - - - Overrides the default read-write timeout value. - On Unity platform, this value is not used as Unity HTTP client does not support timeouts, so - - - - If the value is set, the value is assigned to the ReadWriteTimeout property of the HttpWebRequest object used - to send requests. - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Returns a WebProxy instance configured to match the proxy settings - in the client configuration. - - - - - Unpacks the host, port and any credentials info into the instance's - proxy-related fields. - Unlike the SetWebProxy implementation on .NET 3.5/4.5,the Host and the Port are not reconstructed from the - input proxyuri - - The proxy details - - - - Gets and sets of the ProxyHost property. - - - - - Gets and sets of the ProxyPort property. - - - - - - Returns true if the clients should be cached by HttpRequestMessageFactory, false otherwise. - - - - - - - Returns true if the SDK should dispose HttpClients after one use, false otherwise. - - - - - - - Create a unique string used for caching the HttpClient based on the settings that are used from the ClientConfig that are set on the HttpClient. - - - - - - - Determines if HttpClients created with the given IClientConfig should be cached at the SDK - client level, or cached globally. - - If there is no HttpClientFactory assigned and proxy or proxy credentials are set - this returns false because those properties can't be serialized as part of the key in the global http client cache. - - - - - Base class for constant class that holds the value that will be sent to AWS for the static constants. - - - - - Gets the value that needs to be used when send the value to AWS - - - - - Attempt to find correct-cased constant value using whatever cased value the user - has provided. This is primarily useful for mapping any-cased values from a CLI - tool to the specific casing required by the service, avoiding the need for the - user to (a) remember the specific case and (b) actually type it correctly. - - The properly cased service constant matching the value - - - - Utility class that stores clock skew information. - - - - - GlobalClockCorrection should be only set by AWSConfigs.ManualClockCorrection property - and is only available to maintain backward compatibilty. This should override any - endpoint specific clockskew correction. - - - - - Return clock skew correction value for an endpoint if there is one. - - AWSConfigs.ManualClockCorrection overrides globally any calculated service endpoint specific - clock correction value. - - Endpoint should in a form such as "https://s3" - Clock correction value for an endpoint in TimeSpan. TimeSpan.Zero if no such clock correction is set. - - - - Get clock skew corrected UTC now value. If ManualClockCorrection is set, - use ManualClockCorrection instead of endpoint specific clock correction value. - - - - - - - Probing mechanism to determine the endpoint discovery enabled value from various sources. - - - - - The valid hashing algorithm supported by the sdk for request signing. - - - - - Which end of a request was responsible for a service error response. - - - - - The sender was responsible for the error, i.e. the client - request failed validation or was improperly formatted. - - - - - The error occured within the service. - - - - - An unrecognized error type was returned. - - - - - Sts Regional Endpoints Value determines whether or not - to send the sts request to the regional endpoint or to - the global sts endpoint - - - - - Send the request to the global sts endpoint - if the region is a legacy global region - - - - - Send the request to the regional endpoint - - - - - S3 US East 1 endpoint value determines wheter or not - to send the us-east-1 s3 requests to the regional endpoint or to - the legacy global endpoint - - - - - Sends the requests to the legacy global s3 endpoint for us-east-1 - - - - - Sends the request to the regional s3 endpoint for us-east-1 - - - - - RetryMode determines which request retry mode is used for requests that do - not complete successfully. - - - - - Legacy request retry strategy. - - - - - Standardized request retry strategy that is consistent across all SDKs. - - - - - An experimental request retry strategy that builds on the Standard strategy - and introduces congestion control through client side rate limiting. - - - - - All Amazon service interfaces like IAmazonS3 extend from this interface. This allows all the - Amazon service interfaces be identified by this base interface and helps with generic constraints. - - - - - A readonly view of the configuration for the service client. - - - - - This interface is the read only access to the ClientConfig object used when setting up service clients. Once service clients - are initiated the config object should not be changed to avoid issues with using a service client in a multi threaded environment. - - - - - Gets the RegionEndpoint property. The region constant to use that - determines the endpoint to use. If this is not set - then the client will fallback to the value of ServiceURL. - - - - - The constant used to lookup in the region hash the endpoint. - - - - - Gets and sets of the ServiceURL property. - This is an optional property if you need to set a specific service URL - instead setting the region with the RegionEndpoint property. - - - - - Gets the UseHttp property. - If this property is set to true, the client attempts - to use HTTP protocol. - By default, this property is set to false. - - - - - Gets Service Version - - - - - Gets the signatureMethod property. - - - - - Gets the SignatureVersion property. - - Note: This property exists for backward compatibility but is no longer - used by any service other than S3. - - - - - Gets the AuthenticationRegion property. - Used in AWS4 request signing, this is an optional property; - change it only if the region cannot be determined from the - service endpoint. - - - - - Gets the AuthenticationServiceName property. - Used in AWS4 request signing, this is the short-form - name of the service being called. - - - - - Gets the UserAgent property. - - - - - Gets the DisableLogging. If true logging for this client will be disabled. - - - - - Flag on whether to log metrics for service calls. - - This can be set in the application's configs, as below: - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSLogMetrics" value"true"/> - </appSettings> - </configuration> - - - - - - Gets the LogResponse property. - If this property is set to true, the service response - is read in its entirety and logged. - - - - - Gets the ReadEntireResponse. - If this property is set to true, the service response - is read in its entirety before being processed. - - - - - This flag controls if .NET HTTP infrastructure should follow redirection - responses (e.g. HTTP 307 - temporary redirect). - - - - - Gets the BufferSize property. - The BufferSize controls the buffer used to read in from input streams and write - out to the request. - - - - - Returns the flag indicating how many retry HTTP requests an SDK should - make for a single SDK operation invocation before giving up. This flag will - return 4 when the RetryMode is set to "Legacy" which is the default. For - RetryMode values of "Standard" or "Adaptive" this flag will return 2. In - addition to the values returned that are dependant on the RetryMode, the - value can be set to a specific value by using the AWS_MAX_ATTEMPTS environment - variable, max_attempts in the shared configuration file, or by setting a - value directly on this property. When using AWS_MAX_ATTEMPTS or max_attempts - the value returned from this property will be one less than the value entered - because this flag is the number of retry requests, not total requests. To - learn more about the RetryMode property that affects the values returned by - this flag, see . - - - - - Determines if MaxErrorRetry has been manually set. - - - - - Gets the interval at which progress update events are raised - for upload operations. By default, the progress update events are - raised at every 100KB of data transferred. - - - - - Flag on whether to resign requests on retry or not. - - - - - Credentials to use with a proxy. - - - - - Gets the default request timeout value. - - - - If the value is set, the value is assigned to the Timeout property of the HTTPWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - - - - Configures the endpoint calculation for a service to go to a dual stack (ipv6 enabled) endpoint - for the configured region. - - - Note: AWS services are enabling dualstack endpoints over time. It is your responsibility to check - that the service actually supports a dualstack endpoint in the configured region before enabling - this option for a service. - - - - - Configures a flag enabling to either opt in or opt out of the retry throttling service. - Note: set value to true to enable retry throttling feature. The Default value for this flag is false. - - - - - Using either the RegionEndpoint or the ServiceURL determine what the URL to the service is. - - The URL to the service. - - - - Performs validation on this config object. - Throws exception if any of the required values are missing/invalid. - - The timeout specified is null. - - - - Returns the clock skew adjusted utc now. This value is affected by AWSConfigs.ManualClockCorrection - - - - - Returns the calculated clock skew value for this config's service endpoint. If AWSConfigs.CorrectForClockSkew is false, - this value won't be used to construct service requests. - - - - - Gets the DisableHostPrefixInjection flag. If true, host prefix injection will be disabled for this client, the default value of this flag is false. - Host prefix injection prefixes the service endpoint with request members from APIs which use this feature. - Example: for a hostPrefix of "foo-name." and a endpoint of "service.region.amazonaws.com" the default behavior is to - prefix the endpoint with the hostPrefix resulting in a final endpoint of "foo-name.service.region.amazonaws.com". Setting - DisableHostPrefixInjection to true will disable hostPrefix injection resulting in a final endpoint of - "service.region.amazonaws.com" regardless of the value of hostPrefix. E.g. You may want to disable host prefix injection for testing against a local mock endpoint. - - - - - Returns the flag indicating if endpoint discovery should be enabled or disabled for operations that are not required to use endpoint discovery. - - - - - Returns the maximum number of discovered endpoints that can be stored within the cache for the client. The default limit is 1000 cache entries. - - - - - Returns the flag indicating the current mode in use for request - retries and influences the value returned from . - The default value is RequestRetryMode.Legacy. This flag can be configured - by using the AWS_RETRY_MODE environment variable, retry_mode in the - shared configuration file, or by setting this value directly. - - - - - Under Adaptive retry mode, this flag determines if the client should wait for - a send token to become available or don't block and fail the request immediately - if a send token is not available. - - - - - - This is a switch used for performance testing and is not intended for production applications - to change. This switch may be removed in a future version of the SDK as the .NET Core platform matures. - - - If true, the HttpClient is cached and reused for every request made by the service client - and shared with other service clients. - - - For the .NET Core platform this is default to true because the HttpClient manages the connection - pool. - - - - - - If CacheHttpClient is set to true then HttpClientCacheSize controls the number of HttpClients cached. - - - - - Gets the ProxyHost property. - - - - - Gets the ProxyPort property. - - - - - Returns a WebProxy instance configured to match the proxy settings - in the client configuration. - - - - - - Interface for a single logged message. - - - - - Log message format. - - - - - Log message arguments. - - - - - Culture-specific formatting provider. - - - - - Abstract parameter value. - - - - - String parameter value. - - - - - String value of the parameter. - - - - - Constructs ParameterValue for a single string. - - - - - - String list parameter value. - - - - - List of strings value of the parameter. - - - - - Constructs ParameterValue for a list of strings. - - - - - - Metrics collected by the SDK on a per-request basis. - - - Each request made to an AWS service by the SDK can have metrics - collected and logged. This interface represents the collected - metrics for a request. The metrics include properties (i.e. request id - and other metadata), timings for each stage of the request, and counters. - - - - - Collection of properties being tracked - - - - - Timings for metrics being tracked - - - - - Counters being tracked - - - - - Whether metrics are enabled for the request - - - - - JSON representation of the current metrics - - JSON string - - - - Represents how long a phase of an SDK request took. - - - - - Whether the timing has been stopped - - - - - Elapsed ticks from start to stop. - If timing hasn't been stopped yet, returns 0. - - - - - Elapsed time from start to stop. - If timing hasn't been stopped yet, returns TimeSpan.Zero - - - - - User supplied type to perform metrics formatting. - - - - - Produce custom formatting for SDK metrics. - - - If defined, this method will be called for every request made by the SDK. - - An instance of IRequestMetrics produced by the SDK - formatted string representation of the metrics - - - - Predefined request metrics that are collected by the SDK. - - - - - Information about the request. - - - - - Gets and sets the RequestId property. - ID that uniquely identifies a request. Amazon keeps track of request IDs. If you have a question about a request, include the request ID in your correspondence. - - - - - This exception is thrown if there are problems signing the request. - - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - - - - Gets the percentage of transfer completed - - - - - Gets the number of bytes transferred since last event - - - - - Gets the number of bytes transferred - - - - - Gets the total number of bytes to be transferred - - - - - Returns a string representation of this object - - - - - - Anonymous credentials. - Using these credentials, the client does not sign the request. - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - AWS Credentials that automatically refresh by calling AssumeRole on - the Amazon Security Token Service. - - - - - The credentials of the user that will be used to call AssumeRole. - - - - - The Amazon Resource Name (ARN) of the role to assume. - - - - - An identifier for the assumed role session. - - - - - Options to be used in the call to AssumeRole. - - - - - Constructs an AssumeRoleAWSCredentials object. - - The credentials of the user that will be used to call AssumeRole. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - - - - Constructs an AssumeRoleAWSCredentials object. - - The credentials of the user that will be used to call AssumeRole. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRole. - - - - A unique identifier that is used by third parties when assuming roles in their customers' accounts. - - - - - An IAM policy in JSON format. - - - - - The length of time in seconds before the credentials will expire. - - - - - The identification number of the MFA device that is associated with the user who is making the assume-role call. - - - - - The value provided by the MFA device, if the trust policy of the role being assumed requires MFA. - - - - - A callback that's used to obtain the MFA token code when the AssumeRoleAWSCredentials are refreshed. - - - - - Immutable representation of AWS credentials obtained as a result of - authenticating with the AssumeRole method of the Security Token Service. - - - - - The expiry time of the credentials, obtained from the AssumeRoleResponse. - - - - - Constructs an instance with supplied keys, token, and expiration. - - The AccessKey for the credentials. - The SecretKey for the credentials. - The security token for the credentials. - The expiration time for the credentials. - - - - Get a copy of this AssumeRoleImmutableCredentials object. - - A copy of this object. - - - - Abstract class that represents a credentials object for AWS services. - - - - - Returns a copy of ImmutableCredentials - - - - - - Called by AmazonServiceClient to validate the credential state - on client construction. - - - - - Basic set of credentials consisting of an AccessKey and SecretKey - - - - - Constructs a BasicAWSCredentials object for the specified accessKey and secretKey. - - - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - Immutable representation of AWS credentials. - - - - - Gets the AccessKey property for the current credentials. - - - - - Gets the SecretKey property for the current credentials. - - - - - Gets the Token property for the current credentials. - - - - - Gets the UseToken property for the current credentials. - Specifies if Token property is non-emtpy. - - - - - Constructs an ImmutableCredentials object with supplied accessKey, secretKey. - - - - Optional. Can be set to null or empty for non-session credentials. - - - - Returns a copy of the current credentials. - - - - - - Abstract class for automatically refreshing AWS credentials - - - - - Refresh state container consisting of credentials - and the date of the their expiration - - - - - Represents the current state of the Credentials. - - This can be cleared without synchronization. - - - - Semaphore to control thread access to GetCredentialsAsync method. - The semaphore will allow only one thread to generate new credentials and - update the current state. - - - - - The time before actual expiration to expire the credentials. - Property cannot be set to a negative TimeSpan. - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - Test credentials existence and expiration time - should update if: - credentials have not been loaded yet - it's past the expiration time. At this point currentState.Expiration may - have the PreemptExpiryTime baked into to the expiration from a call to - UpdateToGeneratedCredentials but it may not if this is new application load. - - - - - When overridden in a derived class, generates new credentials and new expiration date. - - Called on first credentials request and when expiration date is in the past. - - - - - - When overridden in a derived class, generates new credentials and new expiration date. - - Called on first credentials request and when expiration date is in the past. - - - - - - Clears currently-stored credentials, forcing the next GetCredentials call to generate new credentials. - - - - - Immutable representation of AWS credentials obtained as a result of - authenticating against a SAML-supporting federated identity provider. - - - - - The expiry time of the credentials, obtained from the AssumeRoleWithSAML response. - - - - - The value of the NameID element in the Subject element of the SAML assertion, as returned in the - AssumeRoleWithSAML response from the Security Token Service. - - - - - Constructs an instance with supplied keys and SAML assertion data. - - - - - - - - - - Constructs an instance with supplied keys and SAML assertion data. - - - - - - - - Returns a copy of the current credentials. - - - - - - Serializes the instance to a json-format string for external storage - - The serialized object in json - - - - Instantiates an instance from persisted json data - - The serialized data - Deserialized instance corresponding to the json data - - - - Session credentials consisting of AccessKey, SecretKey and Token - - - - - Constructs a SessionAWSCredentials object for the specified accessKey, secretKey. - - - - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - Credentials that are retrieved from the Instance Profile service on an EC2 instance - - - - - Constructs a InstanceProfileAWSCredentials object for specific role - - Role to use - - - - Constructs a InstanceProfileAWSCredentials object for the first found role - - - - - Retrieves a list of all roles available through current InstanceProfile service - - InstanceProfileAWSCredentials is no longer supported in PCL. - - - - - - Superclass for Exceptions that come over the event stream, or to wrap other kinds of generic exceptions. - - - - - The numeric code identifier for the type of error. - - - - - Constructs an EventStreamError. - - - - - Constructs an EventStreamError. - - The error code. - The error message. - - - - Event args that contain an . - - The - - - - The EventStream Event. - - - - - Constructs an EventStreamEventReceivedArgs. - - The EventStream Event. - - - - Event args that contain an . - - The . - - - - The EventStream Exception. - - - - - Constructs an EventStreamExceptionReceivedArgs. - - The EventStream Exception. - - - - Supported Header types for vnd.amazon.event-stream - - - - - Name for the Header. Maximum of 255 bytes. - - - - - Header type id - - - - - Computes the amount of memory neccesary to serialize this Header. - - - - - Writes this Header to buffer starting at offset - Keep in mind, this API assumes buffer is large enough - for the operation. - - buffer to serialize this Header to - offset to begin writing at. - - the new offset. - - - - - Returns the current value as a bool - - - - - Sets the current value - - - - - Returns the current value as a byte - - - - - Sets the current value - - - - - Gets the current value as a 16 bit integer. (Host Order). - - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a 32 bit integer. (Host Order) - - - - - Sets the current value - - - - - returns the current value as a 64-bit integer. (Host Order) - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a byte buffer. - - - - - - Sets the current value. Max length is 2^15 - 1 - - - - - Returns the current value as a utf-8 string. - - - - - Sets the current value. Utf-8 encoded. Max byte size is 2^16 - 1 - - - - - Gets the current value as a DateTime. - Note: You do not need to compensate for unix epoch on this API. - - - - - - Sets the current value. - Note: You do not need to compensate for unix epoch on this API. - - - - - Returns the current value as a Guid (UUID) - - - - - Sets the current value - - - - - Header Data for an EventStreamMessage - - Each header is of format: - [name len] (1) | [utf-8 name] (v) - [type (1)] - [value (v)] - - - - - Name for the Header. Maximum of 255 bytes. - - - - - Header type id - - - - - Initializes this Header with name. - - utf-8 string, max length is 255 - - - - Deserializes the header in buffer. - - buffer constaining the header - index to start from in the buffer. - updated offset with new value for offset - - - - Writes this Header to buffer starting at offset - Keep in mind, this API assumes buffer is large enough - for the operation. - - buffer to serialize this Header to - offset to begin writing at. - - the new offset. - - - - - Computes the amount of memory neccesary to serialize this Header. - - - - - Returns the current value as a bool - - - - - Sets the current value - - - - - Returns the current value as a byte - - - - - Sets the current value - - - - - Gets the current value as a 16 bit integer. (Host Order). - - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a 32 bit integer. (Host Order) - - - - - Sets the current value - - - - - returns the current value as a 64-bit integer. (Host Order) - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a byte buffer. - - - - - - Sets the current value. Max length is 2^15 - 1 - - - - - Returns the current value as a utf-8 string. - - - - - Sets the current value. Utf-8 encoded. Max byte size is 2^16 - 1 - - - - - Gets the current value as a DateTime. - Note: You do not need to compensate for unix epoch on this API. - - - - - - Sets the current value. - Note: You do not need to compensate for unix epoch on this API. - - - - - Returns the current value as a Guid (UUID) - - - - - Sets the current value - - - - - Headers for the message. Can be null. - - - - - Payload for the message. Can be null. - - - - - Converts a message into a byte buffer (usually for network transmission). - - - - - Message is a single datagram. The format is as follows: - [ total length (4) ] | [ headers_length (4)] | [ prelude crc(4)] - [ headers (v)] - [ payload (v)} - [ trailing crc ] - - CRCs use the CRC32 algorithm. - - - - - Content type for EventStreams. - - - - - Headers for the message. Can be null. - - - - - Payload for the message. Can be null. - - - - - Initialize a message with headers and a payload. - - list of headers for the message, can be null. - payload for the message, can be null. - - - - Builds a message from buffer. - - buffer to read - offset to start reading - buffer length. - - parsed instance of EventStreamMessage. Doesn't return null, - does throw if CRCs don't match. - - - - - Converts a message into a byte buffer (usually for network transmission). - - - - - Defines exceptions that arise from an not conforming to specification. - - - - - Constructs an EventStreamValidationException. - - - - - Constructs an EventStreamValidationException. - - The exception message. - - - - Constructs an EventStreamValidationException. - - The exception message. - The inner exception. - - - - This exception is thrown if an exception is retrieved from the event stream and should be modeled, - but a generator function for the strongly-typed exception is not defined. - - - - - The exception type. - - - - - Constructs an EventStreamException. - - The exception type. - - - - The contract for the . - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - A subclass of that enables an enumerable interface for interacting with Events. - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - Flag if the stream was chosen to be enumerated. - - - - - A Stream of Events. Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treated as mutually exclusive. - - - - - A Stream of Events. Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treated as mutually exclusive. - - - - - Returns an enumerator that iterates through the collection. - - An enumerator that can be used to iterate through the collection. - - - - Returns an enumerator that iterates through a collection. - - An object that can be used to iterate through the collection. - - - - Starts the background thread to start reading events from the network stream. - - - - - The contract for the . - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - The size of the buffer for reading from the network stream. - - - - - Fires when an event is received. - - - - - Fired when an exception or error is raised. - - - - - Starts the background thread to start reading events from the network stream. - - - - - The superclass for all EventStreams. It contains the common processing logic needed to retreive events from a network Stream. It - also contains the mechanisms needed to have a background loop raise events. - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - "Unique" key for unknown event lookup. - - - - - Header key for message type. - - - - - Header key for event type. - - - - - Header key for exception type. - - - - - Header key for error code. - - - - - Header key for error message. - - - - - Value of when the message is an event. - - - - - Value of when the message is an exception. - - - - - Value of when the message is an error. - - - - - The size of the buffer for reading from the network stream. - Default is 8192. - - - - - The underlying stream to read events from. - - - - - Responsible for decoding events from sequences of bytes. - - - - - Fires when an event is recieved. - - - - - Fired when an exception or error is raised. - - - - - The mapping of event message to a generator function to construct the matching Event Stream event. - - - - - The mapping of event message to a generator function to construct the matching Event Stream exception. - - - - - Whether the Stream is currently being processed. - - - - - A Stream of Events. Events can be retrieved from this stream by attaching handlers to listen events, and then calling StartProcessing. - - - - - A Stream of Events. Events can be retrieved from this stream by attaching handlers to listen events, and then calling StartProcessing. - - - - - Converts an EventStreamMessage to an event. - - The event stream message to be converted. - The event - - - - Abstraction for cross-framework initiation of the background thread. - - - - - The background thread main loop. It will constantly read from the network stream until IsProcessing is false, or an error occurs. - - This stub exists due to FXCop. - - - - - The background thread main loop. It will constantly read from the network stream until IsProcessing is false, or an error occurs. - - Needed for 3.5 support. Not used. - - - - Reads from the stream into the buffer. It then passes the buffer to the decoder, which raises an event for - each message it decodes. - - The buffer to store the read bytes from the stream. - - - - Wraps exceptions in an outer exception so they can be passed to event handlers. If the Exception is already of a compatable type, - the method returns what it was given. - - The exception to wrap. - An exception of type TE - - - - Starts the background thread to start reading events from the network stream. - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Disposes the resources of this stream. - - Should dispose of unmanged resources. - - - - Event Arguments for EventStreamDecoder.MessageReceived. - - - - - Received message. - - - - - Additional object context - - - - - Initialize this with message - - - - - Initialize this with message and object conetext - - - - - Exception thrown when a request is made of the Decoder, but the internal state - machine is an invalid state. This is usually the result of an interanl exception - being thrown during parsing of the network stream. - - - - - Contract for EventStreamDecoder - - - - - Invoked anytime an EventStreamMessage is found. - - - - - Processes data starting at offset up to length. - Invokes MessageRecieved for each message encountered. - If an exception is thrown, this object is not safe for reuse. - - buffer to read - offset in buffer to start reading. - length of data. - - - - Streaming decoder for listening for incoming EventStreamMessage datagrams. - - - - - Invoked anytime an EventStreamMessage is found. - - - - - Object data (optional) that can be passed to the event handler for MessageReceived. - - - - - Default constructor. Initializes internal _state machine. - - - - - Processes data starting at offset up to length. - Invokes MessageRecieved for each message encountered. - If an exception is thrown, this object is not safe for reuse. - - buffer to read - offset in buffer to start reading. - length of data. - - - - Superclass for Exceptions that come over the event stream, or to wrap other kinds of generic exceptions. - - - - - Constructs an EventStreamException. - - - - - Constructs an EventStreamException. - - The exception message. - - - - Constructs an EventStreamException. - - The exception message. - The inner exception. - - - - The contract for EventStream events. - - - - - The contract for EventStream terminal events. - - - - - This Event is returned if an event is retrieved from the event stream, but a generator function - for the event is not defined. This can occur if the SDK is not updated after a new event type is introduced. - - - - - The Message recieved from the event stream before conversion. - - - - - The event type. - - - - - Constructs an UnknownEventStreamEvent. - - - - - Constructs an UnknownEventStreamEvent. - - The Message recieved from the event stream before conversion. - The event type. - - - - Signals that an an has an unknown message type. These exceptions whould be - swallowed to allow future expansion of the EventStream specification without breaking existing clients. - - - - - Constructs an UnknownEventStreamMessageTypeException. - - - - - Interface for a handler in a pipeline. - - - - - The logger used to log messages. - - - - - The inner handler which is called after the current - handler completes it's processing. - - - - - The outer handler which encapsulates the current handler. - - - - - Contains the processing logic for a synchronous request invocation. - This method should call InnerHandler.InvokeSync to continue processing of the - request by the pipeline, unless it's a terminating handler. - - The execution context which contains both the - requests and response context. - - - - Contains the processing logic for an asynchronous request invocation. - This method should call InnerHandler.InvokeSync to continue processing of the - request by the pipeline, unless it's a terminating handler. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - The interface for an exception handler. - - - - - Handles an exception for the given execution context. - - The execution context, it contains the - request and response context. - The exception to handle. - - Returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception to replace the original exception. - - - - - The interface for an exception handler with a generic parameter for the exception type. - - The exception type. - - - - Handles an exception for the given execution context. - - The execution context, it contains the - request and response context. - The exception to handle. - - Returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception to replace the original exception. - - - - - The interface for a HTTP request factory. - - The type used by the underlying HTTP API to represent the request body. - - - - Creates an HTTP request for the given URI. - - The request URI. - An HTTP request. - - - - The interface for an HTTP request that is agnostic of the underlying HTTP API. - - The type used by the underlying HTTP API to represent the HTTP request content. - - - - The HTTP method or verb. - - - - - The request URI. - - - - - Configures a request as per the request context. - - The request context. - - - - Sets the headers on the request. - - A dictionary of header names and values. - - - - Gets a handle to the request content. - - The request content. - - - - Returns the HTTP response. - - The HTTP response. - - - - Writes a stream to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - The request context. - - - - Writes a byte array to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - - - - Sets up the progress listeners - - The content stream - The interval at which progress needs to be published - The objects which is trigerring the progress changes - The callback which will be invoked when the progress changed event is trigerred - an object, incase the progress is setup, else returns the original stream - - - - Aborts the HTTP request. - - - - - Gets a handle to the request content. - - - - - - Returns the HTTP response. - - A cancellation token that can be used to cancel the asynchronous operation. - - - - - A factory which creates HTTP clients. - - - - - Create and configure an HttpClient. - - - - - - A factory which creates HTTP requests which uses System.Net.Http.HttpClient. - - - - - The constructor for HttpRequestMessageFactory. - - Configuration setting for a client. - - - - Creates an HTTP request for the given URI. - - The request URI. - An HTTP request. - - - - Disposes the HttpRequestMessageFactory. - - - - - Dispose the factory - - - - - - Create and configure a managed HttpClient instance. - The use of HttpClientHandler in the constructor for HttpClient implicitly creates a managed HttpClient. - If a native HttpClient is required the SDK user must implement IHttpClientFactory and provide an - instance via IClientConfig.HttpClientFactory (only available in PCL). - - - - - - - A cache of HttpClient objects. The GetNextClient method does a round robin cycle through the clients - to distribute the load even across. - - - - - Constructs a container for a cache of HttpClient objects - - The HttpClient to cache - - - - Returns the next HttpClient using a round robin rotation. It is expected that individual clients will be used - by more then one Thread. - - - - - - Disposes the HttpClientCache. - - - - - Dispose the HttpClientCache - - - - - - HTTP request wrapper for System.Net.Http.HttpRequestMessage. - - - - - Set of content header names. - - - - - The constructor for HttpWebRequestMessage. - - The HttpClient used to make the request. - The request URI. - The service client config. - - - - The underlying HttpClient - - - - - The underlying HTTP web request. - - - - - The HTTP method or verb. - - - - - The request URI. - - - - - Configures a request as per the request context. - - The request context. - - - - Sets the headers on the request. - - A dictionary of header names and values. - - - - Gets a handle to the request content. - - The request content. - - - - Returns the HTTP response. - - The HTTP response. - - - - Aborts the HTTP request. - - - - - Returns the HTTP response. - - A cancellation token that can be used to cancel the asynchronous operation. - - - - - Writes a stream to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - The request context. - - - - Writes a byte array to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - - - - Gets a handle to the request content. - - - - - - Disposes the HttpWebRequestMessage. - - - - - - - - - - - Sets up the progress listeners - - The content stream - The interval at which progress needs to be published - The objects which is trigerring the progress changes - The callback which will be invoked when the progress changed event is trigerred - an object, incase the progress is setup, else returns the original stream - - - - A retry policy specifies all aspects of retry behavior. This includes conditions when the request should be retried, - checks of retry limit, preparing the request before retry and introducing delay (backoff) before retries. - - - A retry policy specifies all aspects of retry behavior. This includes conditions when the request should be retried, - checks of retry limit, preparing the request before retry and introducing delay (backoff) before retries. - - - - - Maximum number of retries to be performed. - This does not count the initial request. - - - - - The logger used to log messages. - - - - - The standard set of throttling error codes - - - - - The standard set of timeout error codes to retry on. - - - - - List of AWS specific error codes which are returned as part of the error response. - These error codes will be retried. - - - - - The standard set of transient error, HTTP status codes to retry on. - 502 and 504 are returned by proxies. These can also be returned for - S3 accelerate requests which are served by CloudFront. - - - - - Set of web exception status codes to retry on. - - - - - This parameter serves as the value to the CapacityManager.Container datastructure. - Its properties include the available capacity left for making a retry request and the maximum - capacity size. - - - - - Checks if a retry should be performed with the given execution context and exception. - - The execution context which contains both the - requests and response context. - The exception thrown after issuing the request. - Returns true if the request should be retried, else false. The exception is retried if it matches with clockskew error codes. - - - - Returns true if the request is in a state where it can be retried, else false. - - The execution context which contains both the - requests and response context. - Returns true if the request is in a state where it can be retried, else false. - - - - Return true if the request should be retried for the given exception. - - The execution context which contains both the - requests and response context. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Checks if the retry limit is reached. - - The execution context which contains both the - requests and response context. - Return false if the request can be retried, based on number of retries. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called on a successful request response. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called before a retry request is initiated. The value - returned is True by default(retry throttling feature is disabled). - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called before a retry request is initiated. The value - returned is True by default(retry throttling feature is disabled). - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - - - - Virtual method that gets called before a retry request is initiated. The value - returned is True by default(retry throttling feature is disabled). - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - true if the error that will be retried is a throttling error - - - - This method uses a token bucket to enforce the maximum sending rate. - - The execution context which contains both the - requests and response context. - If the prior request failed, this exception is expected to be - the exception that occurred during the prior request failure. - - - - Determines if an AmazonServiceException is a throttling error - - The current exception to check. - true if it is a throttling error else false. - - - - Determines if an AmazonServiceException is a transient error that - should be retried. - - The current execution context - The current exception to check. - true if the exception is a transient error else false. - - - - Determines if the exception is a known timeout error code that - should be retried under the timeout error category. - - The current exception to check. - true if the exception is considered a timeout else false - - - - Checks if a retry should be performed with the given execution context and exception. - - The execution context which contains both the - requests and response context. - The exception throw after issuing the request. - Returns true if the request should be retried, else false. The exception is retried if it matches with clockskew error codes. - - - - This method uses a token bucket to enforce the maximum sending rate. - - The execution context which contains both the - requests and response context. - If the prior request failed, this exception is expected to be - the exception that occurred during the prior request failure. - - - - Return true if the request should be retried for the given exception. - - The execution context which contains both the - requests and response context. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - ICoreAmazonKMS is not meant to be used directly. It defines Key Management Service - with basic .NET types and allows other services to be able to use the service as - a runtime dependency. This interface is implemented by the AmazonKeyManagementServiceClient - defined in the AWSSDK.KeyManagementService assembly. - - - - - The result of the GenerateDataKey and GenerateDataKeyAsync operations. - - - - - The plaintext for the data key. - - - - - The ciphertext for the data key. - - - - - ICoreAmazonS3 is not meant to use directly. It defines S3 with basic .NET types - and allows other services to be able to use S3 as a runtime dependency. This interface - is implemented by the AmazonS3Client defined in the S3 assembly. - - - ICoreAmazonS3 is not meant to use directly. It defines S3 with basic .NET types - and allows other services to be able to use S3 as a runtime dependency. This interface - is implemented by the AmazonS3Client defined in the S3 assembly. - - - - - Generate a presigned URL. - - - - - - - - - - Get all the object keys for the particular bucket and key prefix. - - - - - - - - - Upload an object from a stream. - - - - - - - - - - - Delete an object. - - - - - - - - - - Delete an object. - - - - - - - - - - Open a stream to an object in S3. - - - - - - - - - - Upload an object from a file path. - - - - - - - - - - - Download an object in S3 to a file path. - - - - - - - - - - - Set the ACL on the object to public readable. - - - - - - - - Check to see if the bucket exists and if it doesn't create the bucket. - - - - - - Check to see if the bucket exists. - - - - - - - ICoreAmazonSQS is not meant to use directly. It defines SQS with basic .NET types - and allows other services to be able to use SQS as a runtime dependency. This interface - is implemented by the AmazonSQSClient defined in the SQS assembly. - - - - - Get the attributes for the queue identified by the queue URL asynchronously. - - The queue URL to get attributes for. - A Task containing the result of a dictionary of attributes for the queue. - - - - Set the attributes on the queue identified by the queue URL asynchronously. - - The queue URL to set the attributues. - The attributes to set. - A Task - - - - ICoreAmazonSTS is not meant to be used directly. It defines Security Token - service with basic .NET types and allows other services to be able to use the service as - a runtime dependency. This interface is implemented by the AmazonSecurityTokenServiceClient - defined in the AWSSDK.SecurityToken assembly. - - - - - - This method is used internally to access the Amazon Security Token - service within other service assemblies. - Please use AmazonSecurityTokenServiceClient to access the Amazon Security Token - service instead. - - Use Amazon Security Token Service to assume a role. - - Proxy settings that are required for the HTTPS and STS calls made during the authentication/credential - generation process are supported and should have been configured on the STS ClientConfig instance - associated with the STS client instance exposing this interface. - - - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRole. - - - - - CoreAmazonKMS is not meant to use directly. It implements ICoreAmazonKMS - and allows other service clients to be able to use the KMS service as a runtime dependency. - - This class waits until a method is actually called on the ICoreAmazonKMS interface - before requiring the KMS assembly to be present and loaded. - - - - - Settings for configuring a proxy for the SDK to use. - - - - - The host name or IP address of the proxy server. - - - - - The port number of the proxy. - - - - - The username to authenticate with the proxy server. - - - - - The password to authenticate with the proxy server. - - - - - Collection of one or more regular expressions denoting addresses - for which the proxy will not be used. - - - For more information on bypass lists - see https://msdn.microsoft.com/en-us/library/system.net.webproxy.bypasslist%28v=vs.110%29.aspx. - - - - - If true requests to local addresses bypass the configured - proxy. - - - - - Settings for logging in the SDK. - - - - - Logging destination. - - - - - When to log responses. - - - - - Gets or sets the size limit in bytes for logged responses. - If logging for response body is enabled, logged response - body is limited to this size. The default limit is 1KB. - - - - - Whether or not to log SDK metrics. - - - - - A custom formatter added through Configuration - - - - - This class can be used to discover the public address ranges for AWS. The - information is retrieved from the publicly accessible - https://ip-ranges.amazonaws.com/ip-ranges.json file. - - - The information in this file is generated from our internal system-of-record and - is authoritative. You can expect it to change several times per week and should - poll accordingly. - - - - - Region identifier string for ROUTE53 and CLOUDFRONT ranges - - - - - Collection of service keys found in the data file. - - - - - The publication date and time of the file that was downloaded and parsed. - - - - - Collection of all public IP ranges. - - - - - Filtered collection of public IP ranges for the given service key - - - - - Filtered collection of public IP ranges for the given region (us-east-1 etc) or GLOBAL. - - - - - Filtered collection of public IP ranges for the given network border group. - - - - - Downloads the most recent copy of the endpoint address file and - parses it to a collection of address range objects. - - - - - Downloads the most recent copy of the endpoint address file and - parses it to a collection of address range objects. - - - - - Represents the IP address range for a single region and service key. - - - - - The public IPv4 or Ipv6 address range, in CIDR notation. - - - - - Indicates ipv4 or v6 format of the address - - - - - The AWS region or GLOBAL for edge locations. Note that the CLOUDFRONT and ROUTE53 - ranges are GLOBAL. - - - - - The subset of IP address ranges. Specify AMAZON to get all IP address ranges - (for example, the ranges in the EC2 subset are also in the AMAZON subset). Note - that some IP address ranges are only in the AMAZON subset. - - - Valid values for the service key include "AMAZON", "EC2", "ROUTE53", - "ROUTE53_HEALTHCHECKS", and "CLOUDFRONT." If you need to know all of - the ranges and don't care about the service, use the "AMAZON" entries. - The other entries are subsets of this one. Also, some of the services, - such as S3, are represented in "AMAZON" and do not have an entry that - is specific to the service. We plan to add additional values over time; - code accordingly! - - - - - The network border group the IP address range belongs to. - - - AWS Local Zones allow you to seamlessly connect to the full range of services in the AWS Region such - as Amazon Simple Storage Service and Amazon DynamoDB through the same APIs and tool sets. You can extend - your VPC Region by creating a new subnet that has a Local Zone assignment. When you create a subnet in - a Local Zone, the VPC is also extended to that Local Zone. - - A network border group is a unique set of Availability Zones or Local Zones from where AWS advertises - public IP addresses. - - When you create a VPC that has IPv6 addresses, you can choose to assign a set of Amazon-provided public - IP addresses to the VPC and also set a network border group for the addresses that limits the addresses - to the group. When you set a network border group, the IP addresses cannot move between network - border groups. The us-west-2 network border group contains the four US West (Oregon) Availability Zones. - The us-west-2-lax-1 network border group contains the Los Angeles Local Zones. - - - - - This class defines utilities and constants that can be used by - all the client libraries of the SDK. - - - - - The user agent string header - - - - - The Set of accepted and valid Url characters per RFC3986. - Characters outside of this set will be encoded. - - - - - The Set of accepted and valid Url characters per RFC1738. - Characters outside of this set will be encoded. - - - - - The set of accepted and valid Url path characters per RFC3986. - - - - - The string representing Url Encoded Content in HTTP requests - - - - - The GMT Date Format string. Used when parsing date objects - - - - - The ISO8601Date Format string. Used when parsing date objects - - - - - The ISO8601Date Format string. Used when parsing date objects - - - - - The ISO8601 Basic date/time format string. Used when parsing date objects - - - - - The ISO8601 basic date format. Used during AWS4 signature computation. - - - - - The RFC822Date Format string. Used when parsing date objects - - - - - Returns an extension of a path. - This has the same behavior as System.IO.Path.GetExtension, but does not - check the path for invalid characters. - - - - - - Convert request parameters to Url encoded query string - - - Convert Dictionary of parameters to Url encoded query string - - - - Returns the canonicalized resource path for the service endpoint with single URL encoded path segments. - - Endpoint URL for the request - Resource path for the request - - If resourcePath begins or ends with slash, the resulting canonicalized - path will follow suit. - - Canonicalized resource path for the endpoint - - - - Returns the canonicalized resource path for the service endpoint - - Endpoint URL for the request - Resource path for the request - If true pre URL encode path segments if necessary. - S3 is currently the only service that does not expect pre URL encoded segments. - - If resourcePath begins or ends with slash, the resulting canonicalized - path will follow suit. - - Canonicalized resource path for the endpoint - - - - Returns the canonicalized resource path for the service endpoint - - Endpoint URL for the request - Resource path for the request - If true pre URL encode path segments if necessary. - S3 is currently the only service that does not expect pre URL encoded segments. - Dictionary of key/value parameters containing the values for the ResourcePath key replacements - The version of the marshaller that constructed the request object. - - If resourcePath begins or ends with slash, the resulting canonicalized - path will follow suit. - - Canonicalized resource path for the endpoint - - - - Splits the resourcePath at / into segments then resolves any keys with the path resource values. Greedy - key values will be split into multiple segments at each /. - - The patterned resourcePath - The key/value lookup for the patterned resourcePath - A list of path segments where all keys in the resourcePath have been resolved to one or more path segment values - - - - Joins all path segments with the / character and encodes each segment before joining. - - The segments of a URL path split at each / character - If the path property is specified, - the accepted path characters {/+:} are not encoded. - A joined URL with encoded segments - - - - Takes a patterned resource path and resolves it using the key/value path resources into - a segmented encoded URL. - - The patterned resourcePath - The key/value lookup for the patterned resourcePath - A segmented encoded URL - - - - Returns a new string created by joining each of the strings in the - specified list together, with a comma between them. - - The list of strings to join into a single, comma delimited - string list. - A new string created by joining each of the strings in the - specified list together, with a comma between strings. - - - - Attempt to infer the region for a service request based on the endpoint - - Endpoint to the service to be called - - Region parsed from the endpoint; DefaultRegion (or DefaultGovRegion) - if it cannot be determined/is not explicit - - - - - Attempt to infer the service name for a request (in short form, eg 'iam') from the - service endpoint. - - Endpoint to the service to be called - - Short-form name of the service parsed from the endpoint; empty string if it cannot - be determined - - - - - Utility method for converting Unix epoch seconds to DateTime structure. - - The number of seconds since January 1, 1970. - Converted DateTime structure - - - - Helper function to format a byte array into string - - The data blob to process - If true, returns hex digits in lower case form - String version of the data - - - - Calls a specific EventHandler in a background thread - - - - - - - - Parses a query string of a URL and returns the parameters as a string-to-string dictionary. - - - - - - - Utility method for converting a string to a MemoryStream. - - - - - - - Utility method for copy the contents of the source stream to the destination stream. - - - - - - - Utility method for copy the contents of the source stream to the destination stream. - - - - - - - - Formats the current date as a GMT timestamp - - A GMT formatted string representation - of the current date and time - - - - - Formats the current date as ISO 8601 timestamp - - An ISO 8601 formatted string representation - of the current date and time - - - - - Gets the ISO8601 formatted timestamp that is minutesFromNow - in the future. - - The number of minutes from the current instant - for which the timestamp is needed. - The ISO8601 formatted future timestamp. - - - - Formats the current date as ISO 8601 timestamp - - An ISO 8601 formatted string representation - of the current date and time - - - - - Gets the RFC822 formatted timestamp that is minutesFromNow - in the future. - - The number of minutes from the current instant - for which the timestamp is needed. - The ISO8601 formatted future timestamp. - - - - Determines whether the given string is an absolute path to a root. - - The hypothetical absolute path. - True if is an absolute path. - - - - Returns true if the path specified is relative to the current drive or working directory. - Returns false if the path is fixed to a specific drive or UNC path. This method does no - validation of the path (URIs will be returned as relative as a result). - - - Handles paths that use the alternate directory separator. It is a frequent mistake to - assume that rooted paths (Path.IsPathRooted) are not relative. This isn't the case. - "C:a" is drive relative- meaning that it will be resolved against the current directory - for C: (rooted, but relative). "C:\a" is rooted and not relative (the current directory - will not be used to modify the path). - - - - - True if the given character is a directory separator. - - - - - Returns true if the given character is a valid drive letter - - - - - URL encodes a string per RFC3986. If the path property is specified, - the accepted path characters {/+:} are not encoded. - - The string to encode - Whether the string is a URL path or not - The encoded string - - - - URL encodes a string per the specified RFC. If the path property is specified, - the accepted path characters {/+:} are not encoded. - - RFC number determing safe characters - The string to encode - Whether the string is a URL path or not - The encoded string - - Currently recognised RFC versions are 1738 (Dec '94) and 3986 (Jan '05). - If the specified RFC is not recognised, 3986 is used by default. - - - - - URL encodes a string per the specified RFC with the exception of preserving the encoding of previously encoded slashes. - If the path property is specified, the accepted path characters {/+:} are not encoded. - - The string to encode - Whether the string is a URL path or not - The encoded string with any previously encoded %2F preserved - - - - Convert bytes to a hex string - - Bytes to convert. - Hexadecimal string representing the byte array. - - - - Convert a hex string to bytes - - Hexadecimal string - Byte array corresponding to the hex string. - - - - Returns DateTime.UtcNow + ManualClockCorrection when - is set. - This value should be used instead of DateTime.UtcNow to factor in manual clock correction - - - - - Returns true if the string has any bidirectional control characters. - - - - - - - Executes an HTTP request and returns the response as a string. This method - throws WebException and HttpRequestException. In the event HttpRequestException - is thrown the StatusCode is sent as user defined data on the exception under - the key "StatusCode". - - The URI to make the request to - The request type: GET, PUT, POST - null or the content to send with the request - Timeout for the request - Proxy for the request - null or any headers to send with the request - The response as a string. - - - - Utility method that accepts a string and replaces white spaces with a space. - - - - - - - Class that contains result of executing an external process through the SDKs - AWSSDKUtils.RunProcess/AWSSDKUtils.RunProcessAsync - - - - - The exit code with which the process exited - - - - - The output of the process read till the end - - - - - The error output of the process read till the end - - - - - Object to track circular references in nested types. - At each level of nesting, make a call to Track to retrieve Tracker, - a tracking object implementing the IDisposable interface. - Dispose of this tracker when leaving the context of the tracked object. - - - - - Tracker. Must be disposed. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Adds the current target to a reference list and returns a tracker. - The tracker removes the target from the reference list when the - tracker is disposed. - - - - - - - Root AWS config - - - - - AwsHttpClient is a wrapper around HttpClient class of the System.Net.Http library. - The wrapper has been added so as to remove System.Net.Http dependencies from the Services - and migrate it to a Core level dependecy only. This avoids version clashes when a service - and the Core depends on different versions of the System.Net.Http library. This is a Service - level utility method - - - - - AWSHttpClient wrapper that is wrapped around - HttpClient default wrapper. - - - - - AWSHttpClient BaseAddress property that is wrapper for - HttpClient BaseAddress property. - - - - - AWSHttpClient Timeout property that is wrapper for - HttpClient Timeout property. - - - - - AWSHttpClient MaxResponseContentBufferSize property that is wrapper for - HttpClient MaxResponseContentBufferSize property. - - - - - AWSHttpClient GetStreamAsync that accepts the requester's URI - and make a HttpClient.GetStreamAsync call. - - Requester Uri - - - - Wrapper method that accepts a request uri, stream content and headers and makes a sendAsync call. - - - - - - - Wrapper for HttpClient's HttpRequestMessage and SendAsync methods. - - - - Returns response headers information- header name,value and status code - - - - Wrapper for HttpClient Dispose. - - - - - Method that checks if the passed exception is of type - HttpRequestException - - - - - - - AWSStreamContent is a wrapper for StreamContent class in - the System.Net.Http library.The wrapper has been added so as to - remove System.Net.Http dependencies from the Services - and migrate it to a Core level dependecy only. This avoids version clashes when a service - and the Core depends on different versions of the System.Net.Http library. This is a Service - level utility method - - - - - Wrapper for StreamContent constructor - for stream content - - - - - - Wrapper for StreamContent constructor - for stream content and bufferSize - - - - - - - Wrapper to allow Services to remove StreamContent Headers - - - - - - - Wrapper to allow Services to add StreamContent Headers - - - - - - - Wrapper for StreamContent Dispose. - - - - - Allows to configure the proxy used for HTTP requests. The default value is null. - - - - - This class contains the endpoints available to the AWS clients. The static constants representing the - regions can be used while constructing the AWS client instead of looking up the exact endpoint URL. - - - - - Gets the endpoint for a service in a region. - - The services system name. - If true returns the endpoint for dualstack - Thrown when the request service does not have a valid endpoint in the region. - - - - - Enumerate through all the regions. - - - - - Gets the region based on its system name like "us-west-1" - - The system name of the service like "us-west-1" - - - - - This is a testing method and should not be called by production applications. - - - - - Gets the system name of a region. - - - - - Gets the display name of a region. - - - - - This region name is non-standard. Search the whole endpoints.json file to - determine the partition this region is in. - - - - - This class contains region information used to lazily compute the service endpoints. The static constants representing the - regions can be used while constructing the AWS client instead of looking up the exact endpoint URL. - - - - - The US East (Virginia) endpoint. - - - - - The US East (Virginia) regional endpoint. - - - - - The US East (Ohio) endpoint. - - - - - The US West (N. California) endpoint. - - - - - The US West (Oregon) endpoint. - - - - - The EU North (Stockholm) endpoint. - - - - - The EU West (Ireland) endpoint. - - - - - The EU West (London) endpoint. - - - - - The EU West (Paris) endpoint. - - - - - The EU Central (Frankfurt) endpoint. - - - - - The Europe (Milan) endpoint. - - - - - The Asia Pacific (Hong Kong) endpoint. - - - - - The Asia Pacific (Tokyo) endpoint. - - - - - The Asia Pacific (Seoul) endpoint. - - - - - The Asia Pacific (Osaka-Local) endpoint. - - - - - The Asia Pacific (Mumbai) endpoint. - - - - - The Asia Pacific (Singapore) endpoint. - - - - - The Asia Pacific (Sydney) endpoint. - - - - - The South America (Sao Paulo) endpoint. - - - - - The US GovCloud East (Virginia) endpoint. - - - - - The US GovCloud West (Oregon) endpoint. - - - - - The China (Beijing) endpoint. - - - - - The China (Ningxia) endpoint. - - - - - The Canada (Central) endpoint. - - - - - The Middle East (Bahrain) endpoint. - - - - - The Africa (Cape Town) endpoint. - - - - - Represents the endpoint overridding rules in the endpoints.json - Is used to map private region (ie us-east-1-regional) to public regions (us-east-1) - For signing purposes. - - - - - Enumerate through all the regions. - - - - - Gets the region based on its system name like "us-west-1" - - The system name of the service like "us-west-1" - - - - - Gets the region endpoint override if exists - - The region endpoint to find the possible override for - - - - - Gets the system name of a region. - - - - - Gets the display name of a region. - - - - - Gets the partition name the region is in. For example for us-east-1 the partition name is aws. For cn-northwest-1 the partition name is aws-cn. - - - - - Gets the dns suffix for the region endpoints in a partition. For example the aws partition's suffix is amazonaws.com. The aws-cn partition's suffix is amazonaws.com.cn. - - - - - Gets the endpoint for a service in a region. - - - The services system name. Service system names can be obtained from the - RegionEndpointServiceName member of the ClientConfig-derived class for the service. - - - For forwards compatibility, if the service being requested for isn't known in the region, this method - will generate an endpoint using the AWS endpoint heuristics. In this case, it is not guaranteed the - endpoint will point to a valid service endpoint. - - - - - - Gets the endpoint for a service in a region, optionally selecting a dualstack compatible endpoint. - - - The services system name. Service system names can be obtained from the - RegionEndpointServiceName member of the ClientConfig-derived class for the service. - - - If true a dualstack endpoint is returned. It is the user's responsibility to verify that the given service - supports a dualstack endpoint for the region. - - - For forwards compatibility, if the service being requested for isn't known in the region, this method - will generate an endpoint using the AWS endpoint heuristics. In this case, it is not guaranteed the - endpoint will point to a valid service endpoint. - - - - - - This class defines an endpoints hostname and which protocols it supports. - - - - - Gets the hostname for the service. - - - - - The authentication region to be used in request signing. - - - - - This property is only set for S3 endpoints. For all other services this property returns null. - For S3 endpoints, if the endpoint supports signature version 2 this property will be "2", otherwise it will be "4". - - - - - Calculates a 32bit Cyclic Redundancy Checksum (CRC) using the - same polynomial used by Zip. This type is used internally by DotNetZip; it is generally not used directly - by applications wishing to create, read, or manipulate zip archive files. - - - - - indicates the total number of bytes read on the CRC stream. - This is used when writing the ZipDirEntry when compressing files. - - - - - Indicates the current CRC for all blocks slurped in. - - - - - Returns the CRC32 for the specified stream. - - The stream over which to calculate the CRC32 - the CRC32 calculation - - - - Returns the CRC32 for the specified stream, and writes the input into the output stream. - - The stream over which to calculate the CRC32 - The stream into which to deflate the input - the CRC32 calculation - - - - Get the CRC32 for the given (word,byte) combo. - This is a computation defined by PKzip. - - The word to start with. - The byte to combine it with. - The CRC-ized result. - - - - Update the value for the running CRC32 using the given block of bytes. - This is useful when using the CRC32() class in a Stream. - - block of bytes to slurp - starting point in the block - how many bytes within the block to slurp - - - - A Stream that calculates a CRC32 (a checksum) on all bytes read, - or on all bytes written. - - - - - This class can be used to verify the CRC of a ZipEntry when reading from a stream, - or to calculate a CRC when writing to a stream. The stream should be used to either - read, or write, but not both. If you intermix reads and writes, the results are - not defined. - - This class is intended primarily for use internally by the DotNetZip library. - - - - - Gets the total number of bytes run through the CRC32 calculator. - - - - This is either the total number of bytes read, or the total number - of bytes written, depending on the direction of this stream. - - - - - The constructor. - - The underlying stream - - - - The constructor. - - The underlying stream - The length of the stream to slurp - - - - Provides the current CRC for all blocks slurped in. - - - - - Read from the stream - - the buffer to read - the offset at which to start - the number of bytes to read - the number of bytes actually read - - - - Write to the stream. - - the buffer from which to write - the offset at which to start writing - the number of bytes to write - - - - Indicates whether the stream supports reading. - - - - - Indicates whether the stream supports seeking. - - - - - Indicates whether the stream supports writing. - - - - - Flush the stream. - - - - - Not implemented. - - - - - Not implemented. - - - - - Not implemented. - - N/A - N/A - N/A - - - - Not implemented. - - N/A - - - diff --git a/packages/AWSSDK.Core.3.3.107.14/lib/uap/AWSSDK.Core.dll b/packages/AWSSDK.Core.3.3.107.14/lib/uap/AWSSDK.Core.dll deleted file mode 100644 index e3bf0c4..0000000 Binary files a/packages/AWSSDK.Core.3.3.107.14/lib/uap/AWSSDK.Core.dll and /dev/null differ diff --git a/packages/AWSSDK.Core.3.3.107.14/lib/win8/AWSSDK.Core.XML b/packages/AWSSDK.Core.3.3.107.14/lib/win8/AWSSDK.Core.XML deleted file mode 100644 index 5323a9e..0000000 --- a/packages/AWSSDK.Core.3.3.107.14/lib/win8/AWSSDK.Core.XML +++ /dev/null @@ -1,10800 +0,0 @@ - - - - AWSSDK.Core - - - - - Utility class to parse Amazon resource names more commonly known as an ARN. - - - - - Gets and sets the partition associated with the ARN (e.g.: 'aws'). - - - - - Gets and sets the AWS service associated with the ARN (e.g.: 's3'). - - - - - Gets and sets the region associated with the ARN (e.g.: 'us-east-1'). - - - - - Gets and sets the account ID associated with the ARN. - - - - - Gets and sets the resource associated with the ARN (e.g.: 'mybucket/myobject'). - - - - - Returns true if the string appears to be an ARN by seeing if the string starts with "arn:". This method - doesn't guarantee the string is a valid ARN. To validate the string call TryParse. - - - - - - - Parses the string into an ARN object. - - String to parse into an ARN. - The out parameter for the ARN object created by TryParse. - True if the string was parsed into an ARN object. - - - - Parses the string into an ARN object. - - String to parse into an Arn. - The Arn object created from the passed in string. - Thrown if arnString is null. - Thrown if the string passed in not valid ARN. - - - - Turns the Arn object into a string representation of an ARN. - - - - - - Configuration options that apply to the entire SDK. - - These settings can be configured through app.config or web.config. - Below is a full sample configuration that illustrates all the possible options. - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws region="us-west-2"> - <logging logTo="Log4Net, SystemDiagnostics" logResponses="Always" logMetrics="true" /> - <s3 useSignatureVersion4="true" /> - <proxy host="localhost" port="8888" username="1" password="1" /> - - <dynamoDB> - <dynamoDBContext tableNamePrefix="Prod-"> - - <tableAliases> - <alias fromTable="FakeTable" toTable="People" /> - <alias fromTable="Persons" toTable="People" /> - </tableAliases> - - <mappings> - <map type="Sample.Tests.Author, SampleDLL" targetTable="People" /> - <map type="Sample.Tests.Editor, SampleDLL" targetTable="People"> - <property name="FullName" attribute="Name" /> - <property name="EmployeeId" attribute="Id" /> - <property name="ComplexData" converter="Sample.Tests.ComplexDataConverter, SampleDLL" /> - <property name="Version" version="true" /> - <property name="Password" ignore="true" /> - </map> - </mappings> - - </dynamoDBContext> - </dynamoDB> - </aws> - - - - Configuration options that apply to the entire SDK. - - - - - Manual offset to apply to client clock. This is a global setting that overrides - ClockOffset value calculated for all service endpoints. - - - - - Determines if the SDK should correct for client clock skew - by determining the correct server time and reissuing the - request with the correct time. - Default value of this field is True. - will be updated with the calculated - offset even if this field is set to false, though requests - will not be corrected or retried. - Ignored if is set. - - - - - The calculated clock skew correction, if there is one. - This field will be set if a service call resulted in an exception - and the SDK has determined that there is a difference between local - and server times. - - If is set to true, this - value will be set to the correction, but it will not be used by the - SDK and clock skew errors will not be retried. - - - - - Key for the AWSRegion property. - - - - - - Configures the default AWS region for clients which have not explicitly specified a region. - Changes to this setting will only take effect for newly constructed instances of AWS clients. - - This setting can be configured through the App.config. For example: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws region="us-west-2" /> - - - - - - Key for the AWSProfileName property. - - - - - - Profile name for stored AWS credentials that will be used to make service calls. - Changes to this setting will only take effect in newly-constructed clients. - - To reference the account from an application's App.config or Web.config use the AWSProfileName setting. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="development"/> - </appSettings> - </configuration> - - - - - - - Key for the AWSProfilesLocation property. - - - - - - Location of the credentials file shared with other AWS SDKs. - By default, the credentials file is stored in the .aws directory in the current user's home directory. - - Changes to this setting will only take effect in newly-constructed clients. - - To reference the profile from an application's App.config or Web.config use the AWSProfileName setting. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfilesLocation" value="c:\config"/> - </appSettings> - </configuration> - - - - - - - Key for the Logging property. - - - - - - Configures how the SDK should log events, if at all. - Changes to this setting will only take effect in newly-constructed clients. - - The setting can be configured through App.config, for example: - - <appSettings> - <add key="AWSLogging" value="log4net"/> - </appSettings> - - - - - - Key for the ResponseLogging property. - - - - - - - Configures when the SDK should log service responses. - Changes to this setting will take effect immediately. - - The setting can be configured through App.config, for example: - - <appSettings> - <add key="AWSResponseLogging" value="OnError"/> - </appSettings> - - - - - - Key for the LogMetrics property. - - - - - - Configures if the SDK should log performance metrics. - This setting configures the default LogMetrics property for all clients/configs. - Changes to this setting will only take effect in newly-constructed clients. - - The setting can be configured through App.config, for example: - - <appSettings> - <add key="AWSLogMetrics" value="true"/> - </appSettings> - - - - - - Key for the EndpointDefinition property. - - - - - - Configures if the SDK should use a custom configuration file that defines the regions and endpoints. - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws endpointDefinition="c:\config\endpoints.json" /> - - - - - - Key for the UseSdkCache property. - - - - - - Configures if the SDK Cache should be used, the default value is true. - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws useSdkCache="true" /> - - - - - - Configuration for the Logging section of AWS configuration. - Changes to some settings may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws> - <logging logTo="Log4Net, SystemDiagnostics" logResponses="Always" logMetrics="true" /> - </aws> - - - - - - Configuration for the Proxy section of AWS configuration. - Changes to some settings may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws> - <proxy host="localhost" port="8888" username="1" password="1" bypassList="addressexpr1;addressexpr2;..." bypassOnLocal="true" /> - </aws> - - - - - - Configuration for the region endpoint section of AWS configuration. - Changes may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws region="us-west-2" /> - - - - - - Lock for SomeEvent delegate access. - - - - - This method should never be called directly. - Call AWSSDKUtils.CorrectedUtcNow instead. - - - - - - Logging options. - Can be combined to enable multiple loggers. - - - - - No logging - - - - - Log using log4net - - - - - Log using System.Diagnostics - - - - - Log to the console - - - - - Log to a file - - - - - Response logging option. - - - - - Never log service response - - - - - Only log service response when there's an error - - - - - Always log service response - - - - - Format for metrics data in the logs - - - - - Emit metrics in human-readable format - - - - - Emit metrics as JSON data - - - - - An access control policy action identifies a specific action in a service - that can be performed on a resource. For example, sending a message to a - queue. - - ActionIdentifiers allow you to limit what your access control policy statement affects. - For example, you could create a policy statement that enables a certain group - of users to send messages to your queue, but not allow them to perform any - other actions on your queue. - - - The action is B in the statement - "A has permission to do B to C where D applies." - - Free form access control policy actions may include a wildcard (*) to match - multiple actions. - - - Constants for known actions can be found in the Amazon.Auth.AccessControlPolicy.ActionIdentifiers namespace. - - - - - - Constructs an Actionidentifer with the given action name. - - The name of the action - - - - Gets and sets the name of this action. For example, 'sqs:SendMessage' is the - name corresponding to the SQS action that enables users to send a message - to an SQS queue. - - - - - AWS access control policy conditions are contained in - objects, and affect when a statement is applied. For example, a statement - that allows access to an Amazon SQS queue could use a condition to only apply - the effect of that statement for requests that are made before a certain - date, or that originate from a range of IP addresses. - - Multiple conditions can be included in a single statement, and all conditions - must evaluate to true in order for the statement to take effect. - - - The set of conditions is D in the statement - "A has permission to do B to C where D applies." - - - A condition is composed of three parts: - - - Condition Key - The condition key declares which value of a - request to pull in and compare against when a policy is evaluated by AWS. For - example, using will cause - AWS to pull in the current request's source IP as the first value to compare - against every time your policy is evaluated. - - - - Comparison Type - This is a static value used as the second value - in the comparison when your policy is evaluated. Depending on the comparison - type, this value can optionally use wildcards. See the documentation for - individual comparison types for more information. - - - - Comparison Value - This is a static value used as the second value - in the comparison when your policy is evaluated. Depending on the comparison - type, this value can optionally use wildcards. See the documentation for - individual comparison types for more information. - - - - - - - - - Gets the type of this condition. - - - - - Gets and Sets the name of the condition key involved in this condition. - Condition keys are predefined values supported by AWS that provide input - to a condition's evaluation, such as the current time, or the IP address - of the incoming request. - - Your policy is evaluated for each incoming request, and condition keys - specify what information to pull out of those incoming requests and plug - into the conditions in your policy. - - - - - - Gets and Sets the values specified for this access control policy condition. - For example, in a condition that compares the incoming IP address of a - request to a specified range of IP addresses, the range of IP addresses - is the single value in the condition. - - Most conditions accept only one value, but multiple values are possible. - - - - - - A factory for creating conditions to be used in the policy. - - - - - Condition key for the current time. - - This condition key should only be used with enum. - - - - - - Condition key for whether or not an incoming request is using a secure - transport to make the request (i.e. HTTPS instead of HTTP). - - This condition key should only be used with the boolean overload of NewCondition. - - - - - - Condition key for the source IP from which a request originates. - - This condition key should only be used with enum. - - - - - - Condition key for the user agent included in a request. - - This condition key should only be used with - enum. - - - - - - Condition key for the current time, in epoch seconds. - - This condition key should only be used with enum. - objects. - - - - - - Condition key for the referrer specified by a request. - - This condition key should only be used with - objects. - - - - - - Condition key for the Amazon Resource Name (ARN) of the source specified - in a request. The source ARN indicates which resource is affecting the - resource listed in your policy. For example, an SNS topic is the source - ARN when publishing messages from the topic to an SQS queue. - - This condition key should only be used with enum. - - - - - - Enumeration of the supported ways an ARN comparison can be evaluated. - - - - Exact matching - - - - Loose case-insensitive matching of the ARN. Each of the six - colon-delimited components of the ARN is checked separately and each - can include a multi-character match wildcard (*) or a - single-character match wildcard (?). - - - - Negated form of ArnEquals - - - Negated form of ArnLike - - - - Enumeration of the supported ways a date comparison can be evaluated. - - - - - Enumeration of the supported ways an IP address comparison can be evaluated. - - - - - Matches an IP address against a CIDR IP range, evaluating to true if - the IP address being tested is in the condition's specified CIDR IP - range. - - - - - Negated form of IpAddress - - - - - Enumeration of the supported ways a numeric comparison can be evaluated - - - - - Enumeration of the supported ways a string comparison can be evaluated. - - - - - Case-sensitive exact string matching - - - - - Case-insensitive string matching - - - - - Loose case-insensitive matching. The values can include a - multi-character match wildcard (*) or a single-character match - wildcard (?) anywhere in the string. - - - - - Negated form of StringEquals. - - - - - Negated form of StringEqualsIgnorecase. - - - - - Negated form of StringLike. - - - - - Constructs a new access control policy condition that compares ARNs (Amazon Resource Names). - - The access policy condition key specifying where to get the first ARN for the comparison - The type of comparison to perform. - The second ARN to compare against. When using ArnLike or ArnNotLike this may contain the - multi-character wildcard (*) or the single-character wildcard - - - - Constructs a new access policy condition that performs a boolean - comparison. - - The access policy condition key specifying where to get the - first boolean value for the comparison (ex: aws:SecureTransport). - The boolean to compare against. - - - - This method is deprecated. Invoking this method results in non-UTC DateTimes - not being marshalled correctly. Use NewConditionUtc instead. - Constructs a new access policy condition that compares the current time - (on the AWS servers) to the specified date. - - The type of comparison to perform. For example, - DateComparisonType.DateLessThan will cause this policy - condition to evaluate to true if the current date is less than - the date specified in the second argument. - The date to compare against. - - - - Constructs a new access policy condition that compares the current time - (on the AWS servers) to the specified date. - - The type of comparison to perform. For example, - DateComparisonType.DateLessThan will cause this policy - condition to evaluate to true if the current date is less than - the date specified in the second argument. - The date to compare against. - - - - Constructs a new access policy condition that compares the source IP - address of the incoming request to an AWS service against the specified - CIDR range. The condition evaluates to true (meaning the policy statement - containing it will be applied) if the incoming source IP address is - within that range. - - To achieve the opposite effect (i.e. cause the condition to evaluate to - true when the incoming source IP is not in the specified CIDR - range) use the alternate constructor form and specify - IpAddressComparisonType.NotIpAddress. - - - The CIDR IP range involved in the policy condition. - - - - Constructs a new access policy condition that compares the source IP - address of the incoming request to an AWS service against the specified - CIDR range. When the condition evaluates to true (i.e. when the incoming - source IP address is within the CIDR range or not) depends on the - specified IpAddressComparisonType. - - The type of comparison to to perform. - The CIDR IP range involved in the policy condition. - - - - Constructs a new access policy condition that compares two numbers. - - The type of comparison to perform. - The access policy condition key specifying where to get the - first number for the comparison. - The second number to compare against. - - - - Constructs a new access control policy condition that compares two - strings. - - The type of comparison to perform - The access policy condition key specifying where to get the - first string for the comparison (ex: aws:UserAgent). - - The second string to compare against. When using - StringComparisonType.StringLike or - StringComparisonType.StringNotLike this may contain - the multi-character wildcard (*) or the single-character - wildcard (?). - - - - - Constructs a new access policy condition that compares the Amazon - Resource Name (ARN) of the source of an AWS resource that is modifying - another AWS resource with the specified pattern. - - For example, the source ARN could be an Amazon SNS topic ARN that is - sending messages to an Amazon SQS queue. In that case, the SNS topic ARN - would be compared the ARN pattern specified here. - - - The endpoint pattern may optionally contain the multi-character wildcard - * (*) or the single-character wildcard (?). Each of the six colon-delimited - components of the ARN is checked separately and each can include a - wildcard. - - - Policy policy = new Policy("MyQueuePolicy"); - policy.WithStatements(new Statement(Statement.StatementEffect.Allow) - .WithPrincipals(new Principal("*")).WithActionIdentifiers(SQSActionIdentifiers.SendMessage) - .WithResources(new Resource(myQueueArn)) - .WithConditions(ConditionFactory.NewSourceArnCondition(myTopicArn))); - - - The ARN pattern against which the source ARN will be compared. - Each of the six colon-delimited components of the ARN is - checked separately and each can include a wildcard. - A new access control policy condition that compares the ARN of - the source specified in an incoming request with the ARN pattern - specified here. - - - - Constructs a new access control policy condition that tests if the - incoming request was sent over a secure transport (HTTPS). - - A new access control policy condition that tests if the incoming - request was sent over a secure transport (HTTPS). - - - - Condition key for the canned ACL specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the location constraint specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the prefix specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the delimiter specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the max keys specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the source object specified by a request to copy an - object. - - This condition key may only be used with enum. - - - - - - Condition key for the metadata directive specified by a request to copy - an object. - - This condition key may only be used with enum. - - - - - - Condition key for the version ID of an object version specified by a - request. - - This condition key may only be used with enum. - - - - - - Constructs a new access policy condition that compares an Amazon S3 - canned ACL with the canned ACL specified by an incoming request. - - You can use this condition to ensure that any objects uploaded to an - Amazon S3 bucket have a specific canned ACL set. - - - The Amazon S3 canned ACL to compare against. - A new access control policy condition that compares the Amazon S3 - canned ACL specified in incoming requests against the value - specified. - - - - Condition key for The URL, e-mail address, or ARN from a Subscribe - request or a previously confirmed subscription. Use with string - conditions to restrict access to specific endpoints (e.g., - *@mycompany.com). - - This condition key may only be used with enum. - - - - - - Condition key for the protocol value from a Subscribe request or a - previously confirmed subscription. Use with string conditions to restrict - publication to specific delivery protocols (e.g., HTTPS). - - This condition key may only be used with enum. - - - - - - Constructs a new access policy condition that compares the requested - endpoint used to subscribe to an Amazon SNS topic with the specified - endpoint pattern. The endpoint pattern may optionally contain the - multi-character wildcard (*) or the single-character wildcard (?). - - For example, this condition can restrict subscriptions to a topic to - email addresses in a certain domain ("*@my-company.com"). - - - Policy policy = new Policy("MyTopicPolicy"); - policy.WithStatements(new Statement(Statement.StatementEffect.Allow) - .WithPrincipals(new Principal("*")).WithActionIdentifiers(SNSActionIdentifiers.Subscribe) - .WithResources(new Resource(myTopicArn)) - .WithConditions(ConditionFactory.NewEndpointCondition("*@my-company.com"))); - - - The endpoint pattern against which to compare the requested - endpoint for an Amazon SNS topic subscription. - A new access control policy condition that compares the endpoint - used in a request to subscribe to an Amazon SNS topic with the - endpoint pattern specified. - - - - Constructs a new AWS access control policy condition that allows an - access control statement to restrict subscriptions to an Amazon SNS topic - based on the protocol being used for the subscription. For example, this - condition can restrict subscriptions to a topic to endpoints using HTTPS - to ensure that messages are securely delivered. - - The protocol against which to compare the requested protocol - for an Amazon SNS topic subscription. - A new access control policy condition that compares the - notification protocol requested in a request to subscribe to an - Amazon SNS topic with the protocol value specified. - - - - An AWS access control policy is a object that acts as a container for one or - more statements, which specify fine grained rules for allowing or denying - various types of actions from being performed on your AWS resources. - - By default, all requests to use your resource coming from anyone but you are - denied. Access control polices can override that by allowing different types - of access to your resources, or by explicitly denying different types of - access. - - - Each statement in an AWS access control policy takes the form: - "A has permission to do B to C where D applies". - - - A is the prinicpal - The AWS account that is making a request to - access or modify one of your AWS resources. - - - - B is the action - the way in which your AWS resource is being accessed or modified, such - as sending a message to an Amazon SQS queue, or storing an object in an Amazon S3 bucket. - - - - C is the resource - your AWS entity that the principal wants to access, such - as an Amazon SQS queue, or an object stored in Amazon S3. - - - - D is the set of conditions - optional constraints that specify when to allow or deny - access for the principal to access your resource. Many expressive conditions are available, - some specific to each service. For example you can use date conditions to allow access to - your resources only after or before a specific time. - - - - - - Note that an AWS access control policy should not be confused with the - similarly named "POST form policy" concept used in Amazon S3. - - - - - - The default policy version - - - - - Constructs an empty AWS access control policy ready to be populated with - statements. - - - - - Constructs a new AWS access control policy with the specified policy ID. - The policy ID is a user specified string that serves to help developers - keep track of multiple polices. Policy IDs are often used as a human - readable name for a policy. - - The policy ID for the new policy object. Policy IDs serve to - help developers keep track of multiple policies, and are often - used to give the policy a meaningful, human readable name. - - - - Constructs a new AWS access control policy with the specified policy ID - and collection of statements. The policy ID is a user specified string - that serves to help developers keep track of multiple polices. Policy IDs - are often used as a human readable name for a policy. - - The policy ID for the new policy object. Policy IDs serve to - help developers keep track of multiple policies, and are often - used to give the policy a meaningful, human readable name. - The statements to include in the new policy. - - - - Gets and Sets the policy ID for this policy. Policy IDs serve to help - developers keep track of multiple policies, and are often used as human - readable name for a policy. - - - - - Sets the policy ID for this policy and returns the updated policy so that - multiple calls can be chained together. - - Policy IDs serve to help developers keep track of multiple policies, and - are often used as human readable name for a policy. - - - The polich ID for this policy - this instance - - - - Gets and sets the version of this AWS policy. - - - - - Gets and Sets the collection of statements contained by this policy. Individual - statements in a policy are what specify the rules that enable or disable - access to your AWS resources. - - - - - Checks to see if the permissions set in the statement are already set by another - statement in the policy. - - The statement to verify - True if the statement's permissions are already allowed by the statement - - - - Sets the collection of statements contained by this policy and returns - this policy object so that additional method calls can be chained - together. - - Individual statements in a policy are what specify the rules that enable - or disable access to your AWS resources. - - - The collection of statements included in this policy. - this instance - - - - Returns a JSON string representation of this AWS access control policy, - suitable to be sent to an AWS service as part of a request to set an - access control policy. - - A JSON string representation of this AWS access control policy. - - - - Returns a JSON string representation of this AWS access control policy, - suitable to be sent to an AWS service as part of a request to set an - access control policy. - - Toggle pretty print for the generated JSON document - A JSON string representation of this AWS access control policy. - - - - Parses a JSON document of a policy and creates a Policy object. - - JSON document of a policy. - - - - - A principal is an AWS account which is being allowed or denied access to a - resource through an access control policy. The principal is a property of the - Statement object, not directly the object. - - The principal is A in the statement - "A has permission to do B to C where D applies." - - - In an access control policy statement, you can set the principal to all - authenticated AWS users through the member. This - is useful when you don't want to restrict access based on the identity of the - requester, but instead on other identifying characteristics such as the - requester's IP address. - - - - - - Principal instance that includes all authenticated AWS users. - - This is useful when you don't want to restrict access based on the - identity of the requester, but instead on other identifying - characteristics such as the requester's IP address. - - - - - - The anonymous Principal. - - - - - The default Principal provider for AWS accounts. - - - - - Principal provider for Canonical User IDs. - - - - - Principal provider for federated users (using a SAML identity provider) - - - - - Principal provider for assume role policies that will be assumed by an AWS service - (e.g. "ec2.amazonaws.com"). - - - - - Dummy principal provider for anonynous. - - - - - Constructs a new principal with the specified AWS account ID. - - An AWS account ID. - - - - Constructs a new principal with the specified provider and id - - The provider of the principal - The unique ID of the Principal within the provider - - - - Constructs a new principal with the specified provider and id - and optionally strips hyphens from the id - - The provider of the principal - The unique ID of the Principal within the provider - Strip hyphen - - - - Gets and sets the provider for this principal, which indicates in what group of - users this principal resides. - - - - - Gets the unique ID for this principal. - - - - - Represents a resource involved in an AWS access control policy statement. - Resources are the service specific AWS entities owned by your account. Amazon - SQS queues, Amazon S3 buckets and objects, and Amazon SNS topics are all - examples of AWS resources. - - The standard way of specifying an AWS resource is with an Amazon Resource - Name (ARN). - - - The resource is C in the statement - "A has permission to do B to C where D applies." - - - - - - Constructs a new AWS access control policy resource. Resources are - typically specified as Amazon Resource Names (ARNs). - - You specify the resource using the following Amazon Resource Name (ARN) - format: arn:aws:<vendor>:<region>:<namespace>:<relative-id> - - - >vendor identifies the AWS product (e.g., sns) - - - region is the AWS Region the resource resides in (e.g., us-east-1), if any - - - namespace is the AWS account ID with no hyphens (e.g., 123456789012) - - - relative-id is the service specific portion that identifies the specific resource - - - - - For example, an Amazon SQS queue might be addressed with the following - ARN: arn:aws:sqs:us-east-1:987654321000:MyQueue - - - Some resources may not use every field in an ARN. For example, resources - in Amazon S3 are global, so they omit the region field: - arn:aws:s3:::bucket/* - - - The Amazon Resource Name (ARN) uniquely identifying the desired AWS resource. - - - - Gets the resource ID, typically an Amazon Resource Name (ARN), - identifying this resource. - - - - - A factory for creating resources to be used in the policy. - - - - - Constructs a new bucket resource that represents the the specified bucket - but not any of the contained objects. - - The name of the bucket represented by this AWS access control - policy resource. - - - - Constructs a new object resource that represents the specified objects. - The keyPattern argument may contain the '*' wildcard to match multiple - objects. For example, an object resource created for bucket 'mybucket' - and key pattern 'foo*' will match any object stored in 'mybucket' with a - key that starts with 'foo'. - - The name of the bucket containing the object or objects - represented by this resource. - The key or key pattern, which can optionally contain the '*' - wildcard to include multiple objects in the resource. - - - - Constructs a new SQS queue resource for an access control policy. A - policy statement using this resource will allow or deny actions on the - specified queue. - - The AWS account ID of the queue owner. - The name of the Amazon SQS queue. - - - - A statement is the formal description of a single permission, and is always - contained within a policy object. - - A statement describes a rule for allowing or denying access to a specific AWS - resource based on how the resource is being accessed, and who is attempting - to access the resource. Statements can also optionally contain a list of - conditions that specify when a statement is to be honored. - - - For example, consider a statement that: - - - A is the prinicpal - The AWS account that is making a request to - access or modify one of your AWS resources. - - - - B is the action - the way in which your AWS resource is being accessed or modified, such - as sending a message to an Amazon SQS queue, or storing an object in an Amazon S3 bucket. - - - - C is the resource - your AWS entity that the principal wants to access, such - as an Amazon SQS queue, or an object stored in Amazon S3. - - - - D is the set of conditions - optional constraints that specify when to allow or deny - access for the principal to access your resource. Many expressive conditions are available, - some specific to each service. For example you can use date conditions to allow access to - your resources only after or before a specific time. - - - - - - There are many resources and conditions available for use in statements, and - you can combine them to form fine grained custom access control polices. - - - - - - The effect is the result that you want a policy statement to return at - evaluation time. A policy statement can either allow access or explicitly - deny access. - - - - - Constructs a new access control policy statement with the specified - effect. - - Before a statement is valid and can be sent to AWS, callers must set the - principals, resources, and actions (as well as any optional conditions) - involved in the statement. - - - The effect this statement has (allowing access or denying - access) when all conditions, resources, principals, and - actions are matched. - - - - Gets and Sets the ID for this statement. Statement IDs serve to help keep track - of multiple statements, and are often used to give the statement a - meaningful, human readable name. - - Developers should be careful to not use the same statement ID for - multiple statements in the same policy. Reusing the same statement ID in - different policies is not a problem. - - - - - - Sets the ID for this statement and returns the updated statement so - multiple calls can be chained together. - - Statement IDs serve to help keep track of multiple statements, and are - often used to give the statement a meaningful, human readable name. - - - Developers should be careful to not use the same statement ID for - multiple statements in the same policy. Reusing the same statement ID in - different policies is not a problem. - - - The new statement ID for this statement. - this instance - - - - Gets and Sets the result effect of this policy statement when it is evaluated. - A policy statement can either allow access or explicitly - - - - - Gets and Sets the list of actions to which this policy statement applies. - Actions limit a policy statement to specific service operations that are - being allowed or denied by the policy statement. For example, you might - want to allow any AWS user to post messages to your SQS queue using the - SendMessage action, but you don't want to allow those users other actions - such as ReceiveMessage or DeleteQueue. - - - - - Sets the list of actions to which this policy statement applies and - returns this updated Statement object so that additional method calls can - be chained together. - - Actions limit a policy statement to specific service operations that are - being allowed or denied by the policy statement. For example, you might - want to allow any AWS user to post messages to your SQS queue using the - SendMessage action, but you don't want to allow those users other actions - such as ReceiveMessage or DeleteQueue. - - - The list of actions to which this statement applies. - this instance - - - - Gets and Sets the resources associated with this policy statement. Resources - are what a policy statement is allowing or denying access to, such as an - Amazon SQS queue or an Amazon SNS topic. - - Note that some services allow only one resource to be specified per - policy statement. - - - - - - Sets the resources associated with this policy statement and returns this - updated Statement object so that additional method calls can be chained - together. - - Resources are what a policy statement is allowing or denying access to, - such as an Amazon SQS queue or an Amazon SNS topic. - - - Note that some services allow only one resource to be specified per - policy statement. - - - The resources associated with this policy statement. - this instance - - - - Gets and Sets the conditions associated with this policy statement. Conditions - allow policy statements to be conditionally evaluated based on the many - available condition types. - - For example, a statement that allows access to an Amazon SQS queue could - use a condition to only apply the effect of that statement for requests - that are made before a certain date, or that originate from a range of IP - addresses. - - - When multiple conditions are included in a single statement, all - conditions must evaluate to true in order for the statement to take - effect. - - - - - - Sets the conditions associated with this policy statement, and returns - this updated Statement object so that additional method calls can be - chained together. - - Conditions allow policy statements to be conditionally evaluated based on - the many available condition types. - - - For example, a statement that allows access to an Amazon SQS queue could - use a condition to only apply the effect of that statement for requests - that are made before a certain date, or that originate from a range of IP - addresses. - - - Multiple conditions can be included in a single statement, and all - conditions must evaluate to true in order for the statement to take - effect. - - - The conditions associated with this policy statement. - this instance - - - - Gets and Sets the principals associated with this policy statement, indicating - which AWS accounts are affected by this policy statement. - - - - - Sets the principals associated with this policy statement, and returns - this updated Statement object. Principals control which AWS accounts are - affected by this policy statement. - - If you don't want to restrict your policy to specific users, you can use - to apply the policy to any user trying to - access your resource. - - - The list of principals associated with this policy statement. - this instance - - - - The available AWS access control policy actions for Amazon AppStream. - - - - - - The available AWS access control policy actions for Auto Scaling. - - - - - - The available AWS access control policy actions for AWS Billing. - - - - - - The available AWS access control policy actions for AWS CloudFormation. - - - - - - The available AWS access control policy actions for Amazon CloudFront. - - - - - - The available AWS access control policy actions for Amazon CloudSearch. - - - - - - The available AWS access control policy actions for AWS CloudTrail. - - - - - - The available AWS access control policy actions for Amazon CloudWatch. - - - - - - The available AWS access control policy actions for Amazon CloudWatch Logs. - - - - - - The available AWS access control policy actions for Amazon Cognito Identity. - - - - - - The available AWS access control policy actions for Amazon Cognito Sync. - - - - - - The available AWS access control policy actions for AWS Direct Connect. - - - - - - The available AWS access control policy actions for Amazon DynamoDB. - - - - - - The available AWS access control policy actions for Amazon EC2. - - - - - - The available AWS access control policy actions for AWS ElastiCache. - - - - - - The available AWS access control policy actions for AWS Elastic Beanstalk. - - - - - - The available AWS access control policy actions for Elastic Load Balancing. - - - - - - The available AWS access control policy actions for Amazon Elastic MapReduce. - - - - - - The available AWS access control policy actions for Amazon Elastic Transcoder. - - - - - - The available AWS access control policy actions for Amazon Glacier. - - - - - - The available AWS access control policy actions for AWS Identity and Access Management. - - - - - - The available AWS access control policy actions for AWS Import Export. - - - - - - The available AWS access control policy actions for Amazon Kinesis. - - - - - - The available AWS access control policy actions for AWS Marketplace. - - - - - - The available AWS access control policy actions for AWS Marketplace Management Portal. - - - - - - The available AWS access control policy actions for Amazon Mobile Analytics. - - - - - - The available AWS access control policy actions for AWS OpsWorks. - - - - - - The available AWS access control policy actions for Amazon RDS. - - - - - - The available AWS access control policy actions for Amazon Redshift. - - - - - - The available AWS access control policy actions for Amazon Route 53. - - - - - - The available AWS access control policy actions for Amazon S3. - - - - - - The available AWS access control policy actions for AWS Security Token Service. - - - - - - The available AWS access control policy actions for Amazon SES. - - - - - - The available AWS access control policy actions for Amazon SimpleDB. - - - - - - The available AWS access control policy actions for Amazon Simple Workflow Service. - - - - - - The available AWS access control policy actions for Amazon SNS. - - - - - - The available AWS access control policy actions for Amazon SQS. - - - - - - The available AWS access control policy actions for Amazon Storage Gateway. - - - - - - The available AWS access control policy actions for AWS Whispersync. - - - - - - The available AWS access control policy actions for Amazon Zocalo. - - - - - - Deserializes a JSON string into a AWS policy object. - - - - - Serializes an AWS policy object to a JSON string, suitable for sending to an - AWS service. - - - - Converts the specified AWS policy object to a JSON string, suitable for - passing to an AWS service. - - @param policy - The AWS policy object to convert to a JSON string. - - @return The JSON string representation of the specified policy object. - - @throws IllegalArgumentException - If the specified policy is null or invalid and cannot be - serialized to a JSON string. - - - - Uses the specified generator to write the JSON data for the principals in - the specified policy statement. - - - - - This sorts the conditions by condition type and key with the list of values for that combination. - - The list of conditions to be sorted. - - - - - Exception thrown by the SDK for errors that occur within the SDK. - - - - - This exception is thrown when there is a parse error on the response back from AWS. - - - - - The string value which could not be converted into a valid DateTime instance. - - - - - Occurs before a request is marshalled. - - - - - Occurs before a request is issued against the service. - - - - - Occurs after a response is received from the service. - - - - - Occurs after an exception is encountered. - - - - - Patches the in-flight uri to stop it unescaping the path etc (what Uri did before - Microsoft deprecated the constructor flag). This is particularly important for - Amazon S3 customers who want to use backslash (\) in their key names. - - - Different behavior in the various runtimes has been observed and in addition some - 'documented' ways of doing this between 2.x and 4.x runtimes has also been observed - to not be reliable. - - This patch effectively emulates what adding a schemesettings element to the - app.config file with value 'name="http" genericUriParserOptions="DontUnescapePathDotsAndSlashes"' - does. As we're a dll, that avenue is not open to us. - - - - - - Used to create a copy of the config for a different service than the current instance. - - Target service ClientConfig - The new ClientConfig for the desired service - - - - A base exception for some Amazon Web Services. - - Most exceptions thrown to client code will be service-specific exceptions, though some services - may throw this exception if there is a problem which is caught in the core client code. - - - - - - Whether the error was attributable to Sender or Reciever. - - - - - The error code returned by the service - - - - - The id of the request which generated the exception. - - - - - The HTTP status code from the service response - - - - - Flag indicating if the exception is retryable and the associated retry - details. A null value indicates that the exception is not retryable. - - - - - Class containing the retryable details for an AmazonServiceException - - - - - This property indicates that this exception is a - throttling exception and should be subject to congestion - control throttling. - - - - - This exception is thrown when there is a parse error on the response back from AWS. - - - - - Last known location in the response that was parsed, if available. - - - - - The entire response body that caused this exception, if available. - - - - - Base class for request used by some of the services. - - - - - This flag specifies if SigV4 will be used for the current request. - - - - - Gets or Sets a value indicating if "Expect: 100-continue" HTTP header will be - sent by the client for this request. The default value is false. - - - - - Gets the signer to use for this request. - A null return value indicates to use the configured - signer for the service that this request is part of. - - A signer for this request, or null. - - - - Abstract class for Response objects, contains only metadata, - and no result information. - - - - - Contains additional information about the request, such as the - Request Id. - - - - - Returns the content length of the HTTP response. - - - - - Returns the status code of the HTTP response. - - - - - Base class for determining region based on inspection. - - - - - Sets the Region property by looking up the corresponding RegionEndpoint - from the supplied region system name (us-east-1, us-west-2 etc). - - The system name of the region. - - - - Determines region based on application configuration settings. If the configuration does not contain - the region setting key an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of ApplicationConfigAWSRegion. If no region is found in the - application configuration file then an InvalidOperationException is thrown. - - - - - Probing mechanism to determine region from various sources. - - - - - This class is responsible for keeping track of Retry capacity across different ServiceURLs. - - - - - CapacityType determines the type of capacity to obtain or use. - - - - - The increment capacity type adds capacity. - - - - - The default retry capacity type uses the default capacity amount. - - - - - The timeout capacity type uses the timeout capacity amount. - - - - - This method acquires a said retry capacity if the container has the capacity. - - Contains the RetryCapacity object for the said ServiceURL. - - - - This method acquires a said retry capacity if the container has the capacity. - - Contains the RetryCapacity object for the said ServiceURL. - Specifies what capacity type cost to use for obtaining capacity - - - - This method calls a method to release capacity back - based on whether it was a successful response or a successful retry response. This is invoked by a retry request response. - - if this request is a retry, use a different capacity cost - Contains the RetryCapacity object for the said ServiceURL. - - - - This method calls a method to release capacity back - based on whether it was a successful response or a successful retry response. This is invoked by a retry request response. - - Specifies what capacity type cost to use for adding capacity - Contains the RetryCapacity object for the said ServiceURL. - - - - Ths method fetches the RetryCapacity for the given ServiceURL from CapacityManager.CapacityContainer - - - - - This method releases capacity back. This is invoked by the TryReleaseCapacity method. - - Contains the RetryCapacity object for the said ServiceURL. - The capacity that needs to be released based on whether it was a successful response or a successful retry response. - - - - This class is the RetryCapacity class for a given ServiceURL. - - - - - This class composes Client Context header for Amazon Web Service client. - It contains information like app title, version code, version name, client id, OS platform etc. - - - This class composes Client Context header for Amazon Web Service client. - It contains information like app title, version code, version name, client id, OS platform etc. - - - - - Adds the custom attributes to the Client Context. - - Key. - Value. - - - - Gets a Json Representation of the Client Context. - - Json Representation of Client Context - - - - Collection of parameters that an SDK client will send to a service. - - - - - Constructs empty ParameterCollection. - - - - - Adds a parameter with a string value. - - - - - - - Adds a parameter with a list-of-strings value. - - - - - - - Converts the current parameters into a list of key-value pairs. - - - - - - This class is responsible for managing adaptive retry mode client rate limiting. - - - - - The rate at which token are replenished. - - - - - The maximum capacity allowed in the token - - - - - The current capacity of the token - - - - - The last time the token bucket was refilled. - - - - - The smoothed rate which tokens are being retrieved. - - - - - The last half second time bucket used. - - - - - The number of requests seen within the current time - - - - - The maximum rate when the client was last throttled. - - - - - The last time when the client was throttled. - - - - - The cached time window calculation - - - - - Boolean indicating if the token bucket is enabled. - - - - - This method attempts to acquire capacity from the client's token - - The amount of capacity to obtain from the token bucket - Indicates that the client should or shouldn't sleep and - try again if capacity cannot be obtained. - - - - - This method attempts to acquire capacity from the client's token - - The amount of capacity to obtain from the token bucket - Indicates that the client should or shouldn't sleep and - try again if capacity cannot be obtained. - - Token which can be used to cancel the task. - - - - Updates the sending rate within the client's token bucket - - Indicates if the request resulted in a throttling error. - - - - Calculates the rate - - - Returns the calculated rate for a successful call - - - - Calculates the rate. - - The rate to use in the calculation - Returns the calculated rate for a throttled call - - - - Collection used to indicate if the property was initialized was created by the SDK. - - - - - - Collection used to indicate if the property was initialized was created by the SDK. - - - - - - - Default implementation of the IRequest interface. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Constructs a new DefaultRequest with the specified service name and the - original, user facing request object. - - The orignal request that is being wrapped - The service name - - - - The name of the request - - - - - Gets and sets the type of http request to make, whether it should be POST,GET or DELETE - - - - - Gets and sets a flag that indicates whether the request is sent as a query string instead of the request body. - - - - - Returns the original, user facing request object which this internal - request object is representing. - - - - - Returns a dictionary of the headers included in this request. - - - - - Returns a dictionary of the parameters included in this request. - - - - - Collection of parameters included in this request. - - - - - Returns the subresources that should be appended to the resource path. - This is used primarily for Amazon S3, where object keys can contain '?' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new null entry to the SubResources collection for the request - - The name of the subresource - - - - Adds a new entry to the SubResources collection for the request - - The name of the subresource - Value of the entry - - - - Gets and Sets the endpoint for this request. - - - - - Gets and Sets the resource path added on to the endpoint. - - - - - Returns the path resources that should be used within the resource path. - This is used for services where path keys can contain '/' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new entry to the PathResources collection for the request - - The name of the pathresource with potential greedy syntax: {key+} - Value of the entry - - - - Gets and Sets the version number for the marshaller used to create this request. The version number - is used to support backward compatible changes that would otherwise be breaking changes when a - newer core is used with an older service assembly. - Versions: - 1 - Default version - 2 - Support for path segments - - - - - Gets and Sets the content for this request. - - - - - Flag that signals that Content was and should be set - from the Parameters collection. - - - - - Gets and sets the content stream. - - - - - Gets and sets the original stream position. - If ContentStream is null or does not support seek, this propery - should be equal to -1. - - - - - Computes the SHA 256 hash of the content stream. If the stream is not - seekable, it searches the parent stream hierarchy to find a seekable - stream prior to computation. Once computed, the hash is cached for future - use. If a suitable stream cannot be found to use, null is returned. - - - - - The name of the service to which this request is being sent. - - - - - Alternate endpoint to use for this request, if any. - - - - - Host prefix value to prepend to the endpoint for this request, if any. - - - - - Gets and sets the Suppress404Exceptions property. If true then 404s return back from AWS will not cause an exception and - an empty response object will be returned. - - - - - If using AWS4 signing protocol, contains the resultant parts of the - signature that we may need to make use of if we elect to do a chunked - encoding upload. - - - - - Determine whether to use a chunked encoding upload for the request - (applies to Amazon S3 PutObject and UploadPart requests only). - - - - - - Used for Amazon S3 requests where the bucket name is removed from - the marshalled resource path into the host header. To comply with - AWS2 signature calculation, we need to recover the bucket name - and include it in the resource canonicalization, which we do using - this field. - - - - - This flag specifies if SigV4 is required for the current request. - - - - - The authentication region to use for the request. - Set from Config.AuthenticationRegion. - - - - - The region in which the service request was signed. - - - - - Checks if the request stream can be rewinded. - - Returns true if the request stream can be rewinded , - else false. - - - - Returns true if the request can contain a request body, else false. - - Returns true if the currect request can contain a request body, else false. - - - - Returns true if the request has a body, else false. - - Returns true if the request has a body, else false. - - - - Class containing the data for one endpoint returned from a endpoint discovery request - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Constructs a new DiscoveryEndpoint - - The address of the endpoint - The cache period for the endpoint in minutes - - - - The address of the endpoint. - - - - - The cache period for the endpoint in minutes - - - - - Calculates if this endpoint has expired - - A boolean value indicating if the cache period has expired - - - - Extends the endpoint expiration by the specified number of minutes from now. - - - - - Class containing the data for one endpoint returned from a endpoint discovery request - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class containing the data to use with endpoint discovery - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Gets/sets and flag indicating if endpoint discovery is required for the request. - - - - - Sorted dictionary of the identifiers that must be sent with the endpoint discovery request. These - identifiers are used to construct the cache key for the cache that stores discovered endpoints. A - sorted dictionary is used instead of a dictionary to ensure the cache key comes out in the same order - each time it is constructed. - - - - - Represents the data to be used with endpoint discovery operations - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class used to resolve endpoints using Endpoint Discovery. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Method that performs endpoint discovery for the current operation - - Context information used in calculations for endpoint discovery - The operation to fetch endpoints from the server - - - - - Gets the number of cache keys in the cache - - - - - Class used to resolve endpoints using Endpoint Discovery. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class containing context information to use with endpoint discovery - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Gets the customer credential information. - - - - - Gets the operation name. - - - - - Gets the current marshalled endpoint discovery data. - - - - - Gets the flag indicating if the specified key should be evicted from the cache. - - - - - Gets the Uri that should be evicted if EvictCacheKey is set to true. - - - - - Class containing context information to use with endpoint discovery - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Error type, one of Sender, Receiver, Unknown - Only applies to XML-based services. - - - - - Name of the exception class to return - - - - - Error message - - - - - RequestId of the error. - Only applies to XML-based services. - - - - - InternalConfiguration holds the cached SDK configuration values - obtained from the environment and profile configuration - factories. These configuration values are loaded internally and - are not the same as user exposed AWSConfigs. - - - - - Flag indicating if Endpoint Discovery is enabled. - - - - - The retry mode to use: Legacy, Standard, or Adaptive. - - - - - The max number of request attempts. - - - - - Probing mechanism to determine the configuration values from various sources. - - - - - Resets all the configuration values reloading as needed. This method will use - the AWS_PROFILE environment variable if set to construct the instance. Otherwise - the default profile will be used. - - - - - Flag that specifies if endpoint discovery is enabled, disabled, - or not set. - - - - - Flag that specifies which retry mode to use or if retry mode has - not been set. - - - - - Flag that specifies the max number of request attempts or if max - attempts has not been set. - - - - - Class containing the members used to invoke service calls - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class containing the members used to invoke service calls - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Represents a request being sent to an Amazon Web Service, including the - parameters being sent as part of the request, the endpoint to which the - request should be sent, etc. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - The name of the request - - - - - Returns a dictionary of the headers included in this request. - - - - - Gets and sets a flag that indicates whether the request is sent as a query string instead of the request body. - - - - - Returns a dictionary of the parameters included in this request. - - - - - Collection of parameters included in this request. - - - - - Returns the subresources that should be appended to the resource path. - This is used primarily for Amazon S3, where object keys can contain '?' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new null entry to the SubResources collection for the request - - The name of the subresource - - - - Adds a new entry to the SubResources collection for the request - - The name of the subresource - Value of the entry - - - - Gets and sets the type of http request to make, whether it should be POST,GET or DELETE - - - - - Gets and Sets the endpoint for this request. - - - - - Gets and Sets the resource path added on to the endpoint. - - - - - Returns the path resources that should be used within the resource path. - This is used for services where path keys can contain '/' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new entry to the PathResources collection for the request - - The name of the pathresource with potential greedy syntax: {key+} - Value of the entry - - - - Gets and Sets the version number for the marshaller used to create this request. The version number - is used to support backward compatible changes that would otherwise be breaking changes when a - newer core is used with an older service assembly. - - - - - Gets and Sets the content for this request. - - - - - Gets the header value from the request. - - - - - Flag that signals that Content was and should be set - from the Parameters collection. - - - - - Gets and sets the content stream. - - - - - Gets and sets the original stream position. - If ContentStream is null or does not support seek, this propery - should be equal to -1. - - - - - Computes the SHA 256 hash of the content stream. If the stream is not - seekable, it searches the parent stream hierarchy to find a seekable - stream prior to computation. Once computed, the hash is cached for future - use. - - - - - The name of the service to which this request is being sent. - - - - - Returns the original, user facing request object which this internal - request object is representing. - - - - - Alternate endpoint to use for this request, if any. - - - - - Host prefix value to prepend to the endpoint for this request, if any. - - - - - Gets and sets the Suppress404Exceptions property. If true then 404s return back from AWS will not cause an exception and - an empty response object will be returned. - - - - - If using AWS4 signing protocol, contains the resultant parts of the - signature that we may need to make use of if we elect to do a chunked - encoding upload. - - - - - Determine whether to use a chunked encoding upload for the request - (applies to Amazon S3 PutObject and UploadPart requests only). - - - - - - Used for Amazon S3 requests where the bucket name is removed from - the marshalled resource path into the host header. To comply with - AWS2 signature calculation, we need to recover the bucket name - and include it in the resource canonicalization, which we do using - this field. - - - - - This flag specifies if SigV4 is required for the current request. - - - - - The authentication region to use for the request. - Set from Config.AuthenticationRegion. - - - - - The region in which the service request was signed. - - - - - Checks if the request stream can be rewinded. - - Returns true if the request stream can be rewinded , - else false. - - - - Returns true if the request can contain a request body, else false. - - Returns true if the currect request can contain a request body, else false. - - - - Returns true if the request has a body, else false. - - Returns true if the request has a body, else false. - - - - Gets the value of the Service Id. - - - - - Gets the dictionary that gives mapping of renamed operations - - - - - IDictionary{String, String} access to ParameterCollection. - TODO: remove this class in version 3.4 of the SDK. - - - - - Constructs ParametersDictionaryFacade for a ParameterCollection - - - - - - A registry of object that will manipulate the runtime pipeline used by service clients. - - - - - Registers a customizer that will be applied for all service clients created. Each customizer has a unique name associated with it. If a customizer is registered more - than once with the same unique name then the calls after the first will be ignored. - - - - - - Deregistered the runtime pipeline customizer - - - - - - Deregistered the runtime pipeline customizer - - - - - - Applies all of the registered customizers on the runtime pipeline - - The service clients runtime pipeline. - Type object for the service client being created - - - - Interface for objects that will customize the runtime pipleine for newly created service clients. - - - - - The unique name for the customizer that identifies the customizer in the registry. The name is also used to identify the customizer on the SDK logs. - - - - - Called on service clients as they are being constructed to customize their runtime pipeline. - - - Type object for the service client being created - - - - Default ServiceMetadata implementation. - This implementation will be used if the service doesn't have a - IServiceMetadata implementation. - - - - - Gets the value of the Service Id. - - - - - Gets the dictionary that gives mapping of renamed operations - - - - - Computes RFC 2104-compliant HMAC signature. - - - - - Computes RFC 2104-compliant HMAC signature. - - - - - Inspects the supplied evidence to return the signer appropriate for the operation - - Global setting for the service - The request. - Configuration for the client - True if signature v4 request signing should be used - - - - Signs the specified request with the AWS3 signing protocol by using the - AWS account credentials given in the method parameters. - - The AWS public key - The AWS secret key used to sign the request in clear text - Request metrics - The configuration that specifies which hashing algorithm to use - The request to have the signature compute for - If any problems are encountered while signing the request - - - - AWS4 protocol signer for service calls that transmit authorization in the header field "Authorization". - - - - - Calculates and signs the specified request using the AWS4 signing protocol by using the - AWS account credentials given in the method parameters. The resulting signature is added - to the request headers as 'Authorization'. Parameters supplied in the request, either in - the resource path as a query string or in the Parameters collection must not have been - uri encoded. If they have, use the SignRequest method to obtain a signature. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. - - - Client configuration data encompassing the service call (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text. - - - If any problems are encountered while signing the request. - - - - - Calculates and signs the specified request using the AWS4 signing protocol by using the - AWS account credentials given in the method parameters. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. - - - Client configuration data encompassing the service call (notably authentication - region, endpoint and service name). - - - Metrics for the request. - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text. - - - If any problems are encountered while signing the request. - - - Parameters passed as part of the resource path should be uri-encoded prior to - entry to the signer. Parameters passed in the request.Parameters collection should - be not be encoded; encoding will be done for these parameters as part of the - construction of the canonical request. - - - - - Sets the AWS4 mandated 'host' and 'x-amz-date' headers, returning the date/time that will - be used throughout the signing process in various elements and formats. - - The current set of headers - - Date and time used for x-amz-date, in UTC - - - - Sets the AWS4 mandated 'host' and 'x-amz-date' headers, accepting and returning the date/time that will - be used throughout the signing process in various elements and formats. - - The current set of headers - - - Date and time used for x-amz-date, in UTC - - - - Computes and returns an AWS4 signature for the specified canonicalized request - - - - - - - - - - - - Computes and returns an AWS4 signature for the specified canonicalized request - - - - - - - - - - - - - Computes and returns an AWS4 signature for the specified canonicalized request - - - - - - - - - - - - - - Formats the supplied date and time for use in AWS4 signing, where various formats are used. - - - The required format - The UTC date/time in the requested format - - - - Compute and return the multi-stage signing key for the request. - - The clear-text AWS secret key, if not held in secureKey - The region in which the service request will be processed - Date of the request, in yyyyMMdd format - The name of the service being called by the request - Computed signing key - - - - If the caller has already set the x-amz-content-sha256 header with a pre-computed - content hash, or it is present as ContentStreamHash on the request instance, return - the value to be used in request canonicalization. - If not set as a header or in the request, attempt to compute a hash based on - inspection of the style of the request content. - - - - The computed hash, whether already set in headers or computed here. Null - if we were not able to compute a hash. - - - - - If signPayload is false set the x-amz-content-sha256 header to - the UNSIGNED-PAYLOAD magic string and return it. - Otherwise, if the caller has already set the x-amz-content-sha256 header with a pre-computed - content hash, or it is present as ContentStreamHash on the request instance, return - the value to be used in request canonicalization. - If not set as a header or in the request, attempt to compute a hash based on - inspection of the style of the request content. - - - - - The computed hash, whether already set in headers or computed here. Null - if we were not able to compute a hash. - - - - - Returns the HMAC256 for an arbitrary blob using the specified key - - - - - - - - Returns the HMAC256 for an arbitrary blob using the specified key - - - - - - - - Compute and return the hash of a data blob using the specified key - - Algorithm to use for hashing - Hash key - Data blob - Hash of the data - - - - Compute and return the hash of a data blob using the specified key - - Algorithm to use for hashing - Hash key - Data blob - Hash of the data - - - - Computes the non-keyed hash of the supplied data - - - - - - - Computes the non-keyed hash of the supplied data - - - - - - - Computes and returns the canonical request - - The endpoint URL - the path of the resource being operated on - The http method used for the request - The full request headers, sorted into canonical order - The query parameters for the request - - The hash of the binary request body if present. If not supplied, the routine - will look for the hash as a header on the request. - - Canonicalised request as a string - - - - Computes and returns the canonical request - - The endpoint URL - the path of the resource being operated on - The http method used for the request - The full request headers, sorted into canonical order - The query parameters for the request - - The path resource values lookup to use to replace the keys within resourcePath - The hash of the binary request body if present. If not supplied, the routine - will look for the hash as a header on the request. - - The version of the marshaller that constructed the request object. - Canonicalised request as a string - - - - Computes and returns the canonical request - - The endpoint URL - the path of the resource being operated on - The http method used for the request - The full request headers, sorted into canonical order - The query parameters for the request - - The path resource values lookup to use to replace the keys within resourcePath - The hash of the binary request body if present. If not supplied, the routine - will look for the hash as a header on the request. - - The version of the marshaller that constructed the request object. - The service being called for the request - Canonicalised request as a string - - - - Reorders the headers for the request for canonicalization. - - The set of proposed headers for the request - List of headers that must be included in the signature - For AWS4 signing, all headers are considered viable for inclusion - - - - Computes the canonical headers with values for the request. Only headers included in the signature - are included in the canonicalization process. - - All request headers, sorted into canonical order - Canonicalized string of headers, with the header names in lower case. - - - - Returns the set of headers included in the signature as a flattened, ;-delimited string - - The headers included in the signature - Formatted string of header names - - - - Collects the subresource and query string parameters into one collection - ready for canonicalization - - The in-flight request being signed - The fused set of parameters - - - - Computes and returns the canonicalized query string, if query parameters have been supplied. - Parameters with no value will be canonicalized as 'param='. The expectation is that parameters - have not already been url encoded prior to canonicalization. - - The set of parameters being passed on the uri - - Parameters must be uri encoded into the canonical request and by default the signer expects - that the supplied collection contains non-encoded data. Set this to false if the encoding was - done prior to signer entry. - - The uri encoded query string parameters in canonical ordering - - - - Computes and returns the canonicalized query string, if query parameters have been supplied. - Parameters with no value will be canonicalized as 'param='. The expectation is that parameters - have not already been url encoded prior to canonicalization. - - The set of parameters to be encoded in the query string - - Parameters must be uri encoded into the canonical request and by default the signer expects - that the supplied collection contains non-encoded data. Set this to false if the encoding was - done prior to signer entry. - - The uri encoded query string parameters in canonical ordering - - - - Returns the request parameters in the form of a query string. - - The request instance - Request parameters in query string format - - - - AWS4 protocol signer for Amazon S3 presigned urls. - - - - - Calculates and signs the specified request using the AWS4 signing protocol by using the - AWS account credentials given in the method parameters. The resulting signature is added - to the request headers as 'Authorization'. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. - - - Adding supporting data for the service call required by the signer (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text - - - If any problems are encountered while signing the request. - - - - - Calculates the AWS4 signature for a presigned url. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. If the Expires parameter - is present, it is renamed to 'X-Amz-Expires' before signing. - - - Adding supporting data for the service call required by the signer (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text - - - If any problems are encountered while signing the request. - - - Parameters passed as part of the resource path should be uri-encoded prior to - entry to the signer. Parameters passed in the request.Parameters collection should - be not be encoded; encoding will be done for these parameters as part of the - construction of the canonical request. - - - - - Calculates the AWS4 signature for a presigned url. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. If the Expires parameter - is present, it is renamed to 'X-Amz-Expires' before signing. - - - Adding supporting data for the service call required by the signer (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text - - - The service to sign for - - - The region to sign to, if null then the region the client is configured for will be used. - - - If any problems are encountered while signing the request. - - - Parameters passed as part of the resource path should be uri-encoded prior to - entry to the signer. Parameters passed in the request.Parameters collection should - be not be encoded; encoding will be done for these parameters as part of the - construction of the canonical request. - - The X-Amz-Content-SHA256 is cleared out of the request. - If the request is for S3 then the UNSIGNED_PAYLOAD value is used to generate the canonical request. - If the request isn't for S3 then the empty body SHA is used to generate the canonical request. - - - - - Encapsulates the various fields and eventual signing value that makes up - an AWS4 signature. This can be used to retrieve the required authorization string - or authorization query parameters for the final request as well as hold ongoing - signature computations for subsequent calls related to the initial signing. - - - - - Constructs a new signing result instance for a computed signature - - The access key that was included in the signature - Date/time (UTC) that the signature was computed - The collection of headers names that were included in the signature - Formatted 'scope' value for signing (YYYYMMDD/region/service/aws4_request) - Returns the key that was used to compute the signature - Computed signature - - - - The access key that was used in signature computation. - - - - - ISO8601 formatted date/time that the signature was computed - - - - - ISO8601 formatted date that the signature was computed - - - - - The ;-delimited collection of header names that were included in the signature computation - - - - - Formatted 'scope' value for signing (YYYYMMDD/region/service/aws4_request) - - - - - Returns a copy of the key that was used to compute the signature - - - - - Returns the hex string representing the signature - - - - - Returns a copy of the byte array containing the signature - - - - - Returns the signature in a form usable as an 'Authorization' header value. - - - - - Returns the signature in a form usable as a set of query string parameters. - - - - - Null Signer which does a no-op. - - - - - Signs the specified request with the AWS2 signing protocol by using the - AWS account credentials given in the method parameters. - - The AWS public key - The AWS secret key used to sign the request in clear text - Request metrics - The configuration that specifies which hashing algorithm to use - The request to have the signature compute for - If any problems are encountered while signing the request - - - - S3 signer constructor - - - - - S3 signer constructor - - - - - This exception is thrown if there are problems signing the request. - - - - - Response Unmarshaller for all Errors - - - - - Build an ErrorResponse from XML - - The XML parsing context. - Usually an Amazon.Runtime.Internal.UnmarshallerContext. - An ErrorResponse object. - - - - Return an instance of and ErrorResponseUnmarshaller. - - - - - - Interface for unmarshallers which unmarshall objects from response data. - The Unmarshallers are stateless, and only encode the rules for what data - in the XML stream goes into what members of an object. - - The type of object the unmarshaller returns - The type of the XML unmashaller context, which contains the - state during parsing of the XML stream. Usually an instance of - Amazon.Runtime.Internal.Transform.UnmarshallerContext. - - - - Given the current position in the XML stream, extract a T. - - The XML parsing context - An object of type T populated with data from the XML stream. - - - - Interface for unmarshallers which unmarshall service responses. - The Unmarshallers are stateless, and only encode the rules for what data - in the XML stream goes into what members of an object. - - The type of object the unmarshaller returns - The type of the XML unmashaller context, which contains the - state of parsing the XML stream. Uaually an instance of - Amazon.Runtime.Internal.Transform.UnmarshallerContext. - - - - Extracts an exeption with data from an ErrorResponse. - - The XML parsing context. - An inner exception to be included with the returned exception - The HttpStatusCode from the ErrorResponse - Either an exception based on the ErrorCode from the ErrorResponse, or the - general service exception for the service in question. - - - - Interface for unmarshallers which unmarshall objects from response data. - The Unmarshallers are stateless, and only encode the rules for what data - in the XML stream goes into what members of an object. - - The type of object the unmarshaller returns - The type of the XML unmashaller context, which contains the - state during parsing of the XML stream. Usually an instance of - Amazon.Runtime.Internal.Transform.UnmarshallerContext. - - - - Given the current position in the XML stream, extract a T. - - The XML parsing context - An object of type T populated with data from the XML stream. - - - - First-pass unmarshaller for all errors - - - - - Build an ErrorResponse from json - - The json parsing context. - Usually an Amazon.Runtime.Internal.JsonUnmarshallerContext. - An ErrorResponse object. - - - - Return an instance of JsonErrorResponseUnmarshaller. - - - - - - Wraps a json string for unmarshalling. - - Each Read() operation gets the next token. - TestExpression() is used to match the current key-chain - to an xpath expression. The general pattern looks like this: - - JsonUnmarshallerContext context = new JsonUnmarshallerContext(jsonString); - while (context.Read()) - { - if (context.IsKey) - { - if (context.TestExpresion("path/to/element")) - { - myObject.stringMember = stringUnmarshaller.GetInstance().Unmarshall(context); - continue; - } - } - } - - - - - - Wrap the jsonstring for unmarshalling. - - Stream that contains the JSON for unmarshalling - If set to true, maintains a copy of the complete response body constraint to log response size as the stream is being read. - Response data coming back from the request - If set to true, maintains a copy of the complete response body as the stream is being read. - - - - Are we at the start of the json document. - - - - - Is the current token the end of an object - - - - - Is the current token the start of an object - - - - - Returns the element depth of the parser's current position in the json - document being parsed. - - - - - The current Json path that is being unmarshalled. - - - - - Reads to the next token in the json document, and updates the context - accordingly. - - - True if a token was read, false if there are no more tokens to read. - - - - - Peeks at the next token. This peek implementation - reads the next token and makes the subsequent Read() return the same data. - If Peek is called successively, it will return the same data. - Only the first one calls Read(), subsequent calls - will return the same data until a Read() call is made. - - Token to peek. - Returns true if the peeked token matches given token. - - - - Returns the text contents of the current token being parsed. - - - The text contents of the current token being parsed. - - - - - The type of the current token - - - - - Get the base stream of the jsonStream. - - - - - Peeks at the next (non-whitespace) character in the jsonStream. - - The next (non-whitespace) character in the jsonStream, or -1 if at the end. - - - - Peeks at the next character in the stream. - If the data isn't buffered into the StreamReader (Peek() returns -1), - we flush the buffered data and try one more time. - - - - - - Abstract class for unmarshalling service responses. - - - - - Class for unmarshalling XML service responses. - - - - - Class for unmarshalling EC2 service responses. - - - - - Class for unmarshalling JSON service responses. - - - - - Unmarshaller for int fields - - - - - Unmarshaller for nullable int fields. Implemented only for JSON context - to handle cases where value can be null e.g. {'Priority': null}. - This unmarshaller is not implemented for XML context, as XML responses - will null elements (xsi:nil='true') will be skipped by the XML parser. - - - - - Unmarshaller for long fields - - - - - Unmarshaller for float fields - - - - - Unmarshaller for double fields - - - - - Unmarshaller for decimal fields - - - - - Unmarshaller for bool fields - - - - - Unmarshaller for string fields - - - - - Unmarshaller for byte fields - - - - - Unmarshaller for DateTime fields - - - - - Unmarshalls given string as a DateTime. Handles cases where we want to unmarshall - as just a DateTime or a nullable Datetime. - - Value to be parsed - If true, the method will return null if text is null. - If false, the method will return default(DateTime), if text is null. - - - - - Unmarshaller for nullable DateTime fields. Implemented only for JSON context - to handle cases where value can be null e.g. {'Priority': null}. - This unmarshaller is not implemented for XML context, as XML responses - will null elements (xsi:nil='true') will be skipped by the XML parser. - - - - - Unmarshaller for MemoryStream fields - - - - - Unmarshaller for ResponseMetadata - - - - - Base class for the UnmarshallerContext objects that are used - to unmarshall a web-service response. - - - - - Tests the specified expression against the current position in the XML - document - - The pseudo-XPath expression to test. - - True if the expression matches the current position in the document, - false otherwise. - - - - Tests the specified expression against the current position in the XML - document being parsed, and restricts the expression to matching at the - specified stack depth. - - The pseudo-XPath expression to test. - - The depth in the stack representing where the expression must - start matching in order for this method to return true. - - True if the specified expression matches the current position in - the XML document, starting from the specified depth. - - - - Reads the next token at depth greater than or equal to target depth. - - Tokens are read at depth greater than or equal to target depth. - True if a token was read and current depth is greater than or equal to target depth. - - - - The current path that is being unmarshalled. - - - - - Returns the element depth of the parser's current position in the - document being parsed. - - - - - Reads to the next node in the document, and updates the context accordingly. - - - True if a node was read, false if there are no more elements to read. - - - - - Returns the text contents of the current element being parsed. - - - The text contents of the current element being parsed. - - - - - True if NodeType is Element. - - - - - True if NodeType is EndElement. - - - - - True if the context is at the start of the document. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Wrap an XmltextReader for simulating an event stream. - - Each Read() operation goes either to the next element or next attribute within - the current element. TestExpression() is used to match the current event - to an xpath expression. The general pattern looks like this: - - UnmarshallerContext context = new UnmarshallerContext(...); - while (context.Read()) - { - if (context.TestExpresion("path/to/element")) - { - myObject.stringMember = stringUnmarshaller.GetInstance().Unmarshall(context); - continue; - } - if (context.TestExpression("path/to/@attribute")) - myObject.MyComplexTypeMember = MyComplexTypeUnmarshaller.GetInstance().Unmarshall(context); - } - - - - - - Wrap an XmlTextReader with state for event-based parsing of an XML stream. - - Stream with the XML from a service response. - If set to true, maintains a copy of the complete response body constraint to log response size as the stream is being read. - Response data coming back from the request - If set to true, maintains a copy of the complete response body as the stream is being read. - - - - The current XML path that is being unmarshalled. - - - - - Returns the element depth of the parser's current position in the XML - document being parsed. - - - - - Reads to the next node in the XML document, and updates the context accordingly. - - - True if a node was read, false if there are no more elements to read./ - - - - - Returns the text contents of the current element being parsed. - - - The text contents of the current element being parsed. - - - - - True if NodeType is Element. - - - - - True if NodeType is EndElement. - - - - - True if the context is at the start of the document. - - - - - True if NodeType is Attribute. - - - - - Wrap an XmlTextReader with state for event-based parsing of an XML stream. - - Stream with the XML from a service response. - If set to true, maintains a copy of the complete response body constraint to log response size as the stream is being read. - Response data coming back from the request - If set to true, maintains a copy of the complete response body as the stream is being read. - - - - RequestId value, if found in response - - - - - Reads to the next node in the XML document, and updates the context accordingly. - If node is RequestId, reads the contents and stores in RequestId property. - - - True if a node was read, false if there are no more elements to read./ - - - - - A stream which caches the contents of the underlying stream as it reads it. - - - - - All the bytes read by the stream. - - - - - All the bytes read by the stream constrained with _cacheLimit - - - - - Initializes the CachingWrapperStream with a base stream. - - The stream to be wrapped. - Maximum number of bytes to be cached. - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Gets a value indicating whether the current stream supports seeking. - CachingWrapperStream does not support seeking, this will always be false. - - - - - Gets or sets the position within the current stream. - CachingWrapperStream does not support seeking, attempting to set Position - will throw NotSupportedException. - - - - - Sets the position within the current stream. - CachingWrapperStream does not support seeking, attempting to call Seek - will throw NotSupportedException. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Stream wrapper that double-buffers from a wrapped stream and - returns the buffered content as a series of signed 'chunks' - for the AWS4 ('Signature V4') protocol. - - - - - Reads some or all of the processed chunk to the consumer, constructing - and streaming a new chunk if more input data is available. - - - - - - - - - Attempt to read sufficient data for a whole chunk from the wrapped stream, - returning the number of bytes successfully read to be processed into a chunk - - - - - Results of the header-signing portion of the request - - - - - Computed signature of the chunk prior to the one in-flight, in - hex - - - - - Computes the derived signature for a chunk of data of given length in the input buffer, - placing a formatted chunk with headers, signature and data into the output buffer - ready for streaming back to the consumer. - - - - - - Length override to return the true length of the payload plus the metainfo - supplied with each chunk - - - - - Computes the total size of the data payload, including the chunk metadata. - Called externally so as to be able to set the correct Content-Length header - value. - - - - - - - Computes the size of the header data for each chunk. - - - - - - - Attempt to read sufficient data for a whole chunk from the wrapped stream, - returning the number of bytes successfully read to be processed into a chunk - - - - - A list object that will always be sent to AWS services, - even if it is empty. - The AWS .NET SDK does not send empty collections to services, unless - the collection is of this type. - - - - - - A dictionary object that will always be sent to AWS services, - even if it is empty. - The AWS .NET SDK does not send empty collections to services, unless - the collection is of this type. - - - - - - - Class to perform actions on a background thread. - Uses a single background thread and performs actions - on it in the order the data was sent through the instance. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Class to invoke actions on a background thread. - Uses a single background thread and invokes actions - on it in the order they were invoked through the instance. - - - - - PCL doesn't have IPAddress. These methods are copied from the Microsoft source code. - - - - - Returns true if the Content is set or there are - query parameters. - - This request - True if data is present; false otherwise. - - - - Utilities for dealing with Guids - - - - - Hashes a set of objects. - - - - - - - Combines a set of hashses. - - - - - - - Combines two hashes. - - - - - - - - Disposes of all managed and unmanaged resources. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - A wrapper stream that calculates a hash of the base stream as it - is being read. - The calculated hash is only available after the stream is closed or - CalculateHash is called. After calling CalculateHash, any further reads - on the streams will not change the CalculatedHash. - If an ExpectedHash is specified and is not equal to the calculated hash, - Close or CalculateHash methods will throw an AmazonClientException. - If CalculatedHash is calculated for only the portion of the stream that - is read. - - - Exception thrown during Close() or CalculateHash(), if ExpectedHash is set and - is different from CalculateHash that the stream calculates, provided that - CalculatedHash is not a zero-length byte array. - - - - - Algorithm to use to calculate hash. - - - - - True if hashing is finished and no more hashing should be done; - otherwise false. - - - - - Current position in the stream. - - - - - Calculated hash for the stream. - This value is set only after the stream is closed. - - - - - Expected hash value. Compared against CalculatedHash upon Close(). - If the hashes are different, an AmazonClientException is thrown. - - - - - Expected length of stream. - - - - - Initializes an HashStream with a hash algorithm and a base stream. - - Stream to calculate hash for. - - Expected hash. Will be compared against calculated hash on stream close. - Pass in null to disable check. - - - Expected length of the stream. If the reading stops before reaching this - position, CalculatedHash will be set to empty array. - - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Asynchronously reads a sequence of bytes from the current stream, advances - the position within the stream by the number of bytes read, and monitors - cancellation requests. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous read operation. The value of the TResult - parameter contains the total number of bytes read into the buffer. This can be - less than the number of bytes requested if that many bytes are not currently - available, or zero (0) if the end of the stream has been reached. - - - - - Gets a value indicating whether the current stream supports seeking. - HashStream does not support seeking, this will always be false. - - - - - Gets or sets the position within the current stream. - HashStream does not support seeking, attempting to set Position - will throw NotSupportedException. - - - - - Sets the position within the current stream. - HashStream does not support seeking, attempting to call Seek - will throw NotSupportedException. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Gets the overridden length used to construct the HashStream - - - - - Calculates the hash for the stream so far and disables any further - hashing. - - - - - Resets the hash stream to starting state. - Use this if the underlying stream has been modified and needs - to be rehashed without reconstructing the hierarchy. - - - - - Validates the underlying stream. - - - - - Compares two hashes (arrays of bytes). - - Expected hash. - Actual hash. - - True if the hashes are identical; otherwise false. - - - - - A wrapper stream that calculates a hash of the base stream as it - is being read or written. - The calculated hash is only available after the stream is closed or - CalculateHash is called. After calling CalculateHash, any further reads - on the streams will not change the CalculatedHash. - If an ExpectedHash is specified and is not equal to the calculated hash, - Close or CalculateHash methods will throw an AmazonClientException. - If base stream's position is not 0 or HashOnReads is true and the entire stream is - not read, the CalculatedHash will be set to an empty byte array and - comparison to ExpectedHash will not be made. - - - Exception thrown during Close() or CalculateHash(), if ExpectedHash is set and - is different from CalculateHash that the stream calculates, provided that - CalculatedHash is not a zero-length byte array. - - - - - Initializes an HashStream with a hash algorithm and a base stream. - - Stream to calculate hash for. - - Expected hash. Will be compared against calculated hash on stream close. - Pass in null to disable check. - - - Expected length of the stream. If the reading stops before reaching this - position, CalculatedHash will be set to empty array. - - - - - A wrapper stream that calculates an MD5 hash of the base stream as it - is being read or written. - The calculated hash is only available after the stream is closed or - CalculateHash is called. After calling CalculateHash, any further reads - on the streams will not change the CalculatedHash. - If an ExpectedHash is specified and is not equal to the calculated hash, - Close or CalculateHash methods will throw an AmazonClientException. - If base stream's position is not 0 or HashOnReads is true and the entire stream is - not read, the CalculatedHash will be set to an empty byte array and - comparison to ExpectedHash will not be made. - - - Exception thrown during Close() or CalculateHash(), if ExpectedHash is set and - is different from CalculateHash that the stream calculates, provided that - CalculatedHash is not a zero-length byte array. - - - - - Initializes an MD5Stream with a base stream. - - Stream to calculate hash for. - - Expected hash. Will be compared against calculated hash on stream close. - Pass in null to disable check. - - - Expected length of the stream. If the reading stops before reaching this - position, CalculatedHash will be set to empty array. - - - - - Utilities for validating label values for host prefix templates - - - - - Validates a label value - - - - - Simple wrapper around the log4net Error method. - - - - - - - - Write debug message to Console - - - - - - - - Write debug message to Console - - - - - - - Simple wrapper around the log4net InfoFormat method. - - - - - - - This is a dynamic wrapper around log4net so we can avoid log4net being required - to be distributed with the SDK. - - - - - Abstract logger class, base for any custom/specific loggers. - - - - - Flushes the logger contents. - - - - - Simple wrapper around the log4net IsErrorEnabled property. - - - - - Simple wrapper around the log4net IsDebugEnabled property. - - - - - Simple wrapper around the log4net IsInfoEnabled property. - - - - - Simple wrapper around the log4net Error method. - - - - - - - - Simple wrapper around the log4net Debug method. - - - - - - - - Simple wrapper around the log4net DebugFormat method. - - - - - - - Simple wrapper around the log4net InfoFormat method. - - - - - - - Logger wrapper for reflected log4net logging methods. - - - - - This should be a one time call to use reflection to find all the types and methods - needed for the logging API. - - - - - Simple wrapper around the log4net IsErrorEnabled property. - - - - - Simple wrapper around the log4net Error method. - - - - - - - - Simple wrapper around the log4net IsDebugEnabled property. - - - - - Simple wrapper around the log4net Debug method. - - - - - - - - Simple wrapper around the log4net DebugFormat method. - - - - - - - Simple wrapper around the log4net IsInfoEnabled property. - - - - - Simple wrapper around the log4net InfoFormat method. - - - - - - - A single logged message - - - - - Log message arguments. - - - - - Culture-specific formatting provider. - - - - - Log message format. - - - - - a size-limited cache of key value pairs - - Once the maximum size has been reached, the least recently - used pairs will be evicted to make room for any new items. - - - - - - - the maximum number of entries this LruCache will hold - before items begin getting evicted - - - - - the number of items in the cache - - - - - Construct a new LruCache. - - maximum number of entries before items are evicted - - - - Add the key/value pair to the cache, or update - the value if the key already exists. - - If the cache is full, evicts the least recently used item. - - - - - - - Evicts a specific key out of the cache if it exists - - the key to evict from the cache - - - - Try to get the value associated with the key. - - the key to look up - the value, if the key exists - true if there is a value associated with the key, or false if no value is associated with the key - - - - Try to get the value associated with the key, if it doesn't exist, use the provided factory method to - create a new value and tries adding it to the cache. - - the key to look up - the factory method used in case the key is not present in the cache - the looked up value or the value created by the factory - - - - Clear the LruCache of all entries. - - - - - Helper class to support LruCache. - Does not implement the error checking and synchronization that - would be necessary for it to stand alone. - - - - - Item to be stored in the LruList - linked list structure. - - - - - Collection of properties being tracked - - - - - Timings for metrics being tracked - - - - - Counters being tracked - - - - - Whether metrics are enabled for the request - - - - - Constructs an empty, disabled metrics object - - - - - Starts timing an event. Logs an exception if an event - of the same type was started but not stopped. - - - - - - - Stops timing an event. Logs an exception if the event wasn't started. - - - - - - - Adds a property for a metric. If there are multiple, the - object is added as a new item in a list. - - - - - - - Sets a counter for a specific metric. - - - - - - - Increments a specific metric counter. - If counter doesn't exist yet, it is set to 1. - - - - - - Returns errors associated with the metric, including - if there are still any timing events in-flight. - - - - - - Returns a string representation of the current metrics. - - - - - - Return a JSON represenation of the current metrics - - - - - - Timing information for a metric - - - - - Empty, stopped timing object - - - - - Timing object in a started state - - - - - - Stops timing - - - - - - Whether the timing has been stopped - - - - - Elapsed ticks from start to stop. - If timing hasn't been stopped yet, returns 0. - - - - - Elapsed time from start to stop. - If timing hasn't been stopped yet, returns TimeSpan.Zero - - - - - Timing event, stops timing of a metric when disposed - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - The destructor for the client class. - - - - - A wrapper stream which supresses disposal of the underlying stream. - - - - - Constructor for NonDisposingWrapperStream. - - The base stream to wrap. - - - - The Dispose implementation for this wrapper stream - does not close the underlying stream. - - - - - This class is used to wrap a stream for a particular segment of a stream. It - makes that segment look like you are reading from beginning to end of the stream. - - - - - Asynchronously reads a sequence of bytes from the current stream, advances - the position within the stream by the number of bytes read, and monitors - cancellation requests. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous read operation. The value of the TResult - parameter contains the total number of bytes read into the buffer. This can be - less than the number of bytes requested if that many bytes are not currently - available, or zero (0) if the end of the stream has been reached. - - - - - Asynchronously writes a sequence of bytes to the current stream and advances the - current position within this stream by the number of bytes written. - - - An array of bytes. This method copies count bytes from buffer to the current stream. - - - The zero-based byte offset in buffer at which to begin copying bytes to the - current stream. - - The number of bytes to be written to the current stream. - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - A task that represents the asynchronous write operation. - - - - Wrapper stream that only supports reading - - - - - Asynchronously clears all buffers for this stream and causes any buffered data - to be written to the underlying device. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous flush operation. - - - - - Asynchronously writes a sequence of bytes to the current stream and advances the - current position within this stream by the number of bytes written. - - - An array of bytes. This method copies count bytes from buffer to the current stream. - - - The zero-based byte offset in buffer at which to begin copying bytes to the - current stream. - - The number of bytes to be written to the current stream. - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - A task that represents the asynchronous write operation. - - - - Partial wrapper stream that only supports reading - - - - - Uri wrapper that can parse out information (bucket, key, region, style) from an - S3 URI. - - - - - True if the URI contains the bucket in the path, false if it contains the bucket in the authority. - - - - - The bucket name parsed from the URI (or null if no bucket specified). - - - - - The key parsed from the URI (or null if no key specified). - - - - - The region parsed from the URI (or null if no region specified). - - - - - Constructs a parser for the S3 URI specified as a string. - - The S3 URI to be parsed. - - - - Constructs a parser for the S3 URI specified as a Uri instance. - - The S3 URI to be parsed. - - - - Percent-decodes the given string, with a fast path for strings that are not - percent-encoded. - - The string to decode - The decoded string - - - - Percent-decodes the given string. - - The string to decode - The index of the first '%' in the string - The decoded string - - - - Decodes the percent-encoded character at the given index in the string - and appends the decoded value to the string under construction. - - - The string under construction to which the decoded character will be - appended. - - The string being decoded. - The index of the '%' character in the string. - - - - Converts a hex character (0-9A-Fa-f) into its corresponding quad value. - - The hex character - The quad value - - - - Interface for a non-generic cache. - - - - - Clears the entire cache. - - - - - Maximum time to keep an item around after its last use. - - - - - How often should the cache be cleared of old items. - - - - - The number of items in the cache. - - - - - Interface for a generic cache. - - - - - - - Retrieves a value out of the cache or from the source. - - - - - - - - Retrieves a value out of the cache or from the source. - If the item was in the cache, isStaleItem is set to true; - otherwise, if the item comes from the source, isStaleItem is false. - - - - - - - - - Clears a specific value from the cache if it's there. - - - - - - Returns the keys for all items in the cache. - - - - - - Executes specified operation, catches exception, clears the cache for - the given key, retries the operation. - - - - - - - - - - - SDK-wide cache. - Provides access to caches specific to a particular set of credentials - and target region. - - - - - Clear all caches - - - - - Clear all caches of a particular type - - - - - - Retrieve a cache of a specific type for a client object. - The client object can be null in cases where a cache does - not correspond to a specific AWS account or target region. - - - - - - - - - - - Retrieve a cache of a specific type for a client object. - The client object can be null in cases where a cache does - not correspond to a specific AWS account or target region. - - - - - - - - - - - Utilities for converting objects to strings. Used by the marshaller classes. - - - - - Converts a DateTime to ISO8601 formatted string. - - - - - Converts a DateTime to RFC822 formatted string. - - - - - Converts a DateTime to Unix epoch time formatted string. - - - - - A wrapper stream. - - - - - Base stream. - - - - - Initializes WrapperStream with a base stream. - - - - - - Returns the first base non-WrapperStream. - - First base stream that is non-WrapperStream. - - - - Returns the first base non-WrapperStream. - - First base stream that is non-WrapperStream. - - - - Returns the first base non-WrapperStream. - - Potential WrapperStream - Base non-WrapperStream. - - - - Gets a value indicating whether the current stream supports reading. - True if the stream supports reading; otherwise, false. - - - - - Gets a value indicating whether the current stream supports seeking. - True if the stream supports seeking; otherwise, false. - - - - - Gets a value indicating whether the current stream supports writing. - True if the stream supports writing; otherwise, false. - - - - - Closes the current stream and releases any resources (such as sockets and - file handles) associated with the current stream. - - - - - Gets the length in bytes of the stream. - - - - - Gets or sets the position within the current stream. - - - - - Gets or sets a value, in miliseconds, that determines how long the stream - will attempt to read before timing out. - - - - - Gets or sets a value, in miliseconds, that determines how long the stream - will attempt to write before timing out. - - - - - Clears all buffers for this stream and causes any buffered data to be written - to the underlying device. - - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Sets the position within the current stream. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Sets the length of the current stream. - - The desired length of the current stream in bytes. - - - - Writes a sequence of bytes to the current stream and advances the current - position within this stream by the number of bytes written. - - - An array of bytes. This method copies count bytes from buffer to the current stream. - - - The zero-based byte offset in buffer at which to begin copying bytes to the - current stream. - - The number of bytes to be written to the current stream. - - - - Asynchronously clears all buffers for this stream and causes any buffered data - to be written to the underlying device. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous flush operation. - - - - - Asynchronously reads a sequence of bytes from the current stream, advances - the position within the stream by the number of bytes read, and monitors - cancellation requests. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous read operation. The value of the TResult - parameter contains the total number of bytes read into the buffer. This can be - less than the number of bytes requested if that many bytes are not currently - available, or zero (0) if the end of the stream has been reached. - - - - - Asynchronously writes a sequence of bytes to the current stream and advances the - current position within this stream by the number of bytes written. - - - An array of bytes. This method copies count bytes from buffer to the current stream. - - - The zero-based byte offset in buffer at which to begin copying bytes to the - current stream. - - The number of bytes to be written to the current stream. - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - A task that represents the asynchronous write operation. - - - - This is a utility class to be used in last resort for code paths that are synchronous but need to call an asynchronous method. - This should never be used for methods that are called at high volume as this utility class has a performance cost. For example this - class was added for the refreshing credentials like Cognito which would need to use this about once an hour. - - - - - Custom WebProxy implementation that creates a webproxy based on - user inputs(Host name and port number) - - - - - Set the ProxyUri - - - - - Create a Uri based on the user inputs(Host name and port number) - - - - - Proxy Uri property - - - - - Proxy Credentials property - - - - - Getter to fetch the set proxy - - - - - Method to determine if the proxy should be bypassed when accessing an internet source - - - - - Error is always enabled - - - - - Debug logging is always enabled - - - - - Info logging is always enabled - - - - - Prints the Log With Error Level - - - - - - - - Prints the Log with Debug Level - - - - - - - - Prints the Log with Debug Level - - - - - - - Prints the Log With Info Level - - - - - - - This class is no longer used anymore and should be avoided as it is just meant - as a last resort when blending async and sync operations. The code is still - here to support versions before 3.3.9.0 of AWSSDK.DynamoDBv2. - - - - - Property to denote that the last exception returned by an AWS Service - was retryable or not. - - - - - An abstract pipeline handler that has implements IPipelineHandler, - and has the default implmentation. This is the base class for most of - the handler implementations. - - - - - The logger used to log messages. - - - - - The inner handler which is called after the current - handler completes it's processing. - - - - - The outer handler which encapsulates the current handler. - - - - - Contains the processing logic for a synchronous request invocation. - This method calls InnerHandler.InvokeSync to continue processing of the - request by the pipeline. - - The execution context which contains both the - requests and response context. - - - - Contains the processing logic for an asynchronous request invocation. - This method calls InnerHandler.InvokeSync to continue processing of the - request by the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Logs the metrics for the current execution context. - - The execution context, it contains the - request and response context. - - - - A runtime pipeline contains a collection of handlers which represent - different stages of request and response processing. - - - - - The top-most handler in the pipeline. - - - - - Constructor for RuntimePipeline. - - The handler with which the pipeline is initalized. - - - - Constructor for RuntimePipeline. - - List of handlers with which the pipeline is initalized. - - - - Constructor for RuntimePipeline. - - List of handlers with which the pipeline is initalized. - The logger used to log messages. - - - - Constructor for RuntimePipeline. - - The handler with which the pipeline is initalized. - The logger used to log messages. - - - - Invokes the pipeline synchronously. - - Request context - Response context - - - - Invokes the pipeline asynchronously. - - Request context - Response context - - - - Adds a new handler to the top of the pipeline. - - The handler to be added to the pipeline. - - - - Adds a handler after the first instance of handler of type T. - - Type of the handler after which the given handler instance is added. - The handler to be added to the pipeline. - - - - Adds a handler before the first instance of handler of type T. - - Type of the handler before which the given handler instance is added. - The handler to be added to the pipeline. - - - - Removes the first occurance of a handler of type T. - - Type of the handler which will be removed. - - - - Replaces the first occurance of a handler of type T with the given handler. - - Type of the handler which will be replaced. - The handler to be added to the pipeline. - - - - Inserts the given handler after current handler in the pipeline. - - Handler to be inserted in the pipeline. - Handler after which the given handler is inserted. - - - - Gets the innermost handler by traversing the inner handler till - it reaches the last one. - - - - - Retrieves a list of handlers, in the order of their execution. - - Handlers in the current pipeline. - - - - Retrieves current handlers, in the order of their execution. - - Handlers in the current pipeline. - - - - This handler processes exceptions thrown from the HTTP handler and - unmarshalls error responses. - - - - - Default set of exception handlers. - - - - - Default set of exception handlers. - - - - - Constructor for ErrorHandler. - - an ILogger instance. - - - - Handles and processes any exception thrown from underlying handlers. - - The execution context which contains both the - requests and response context. - - - - Handles and processes any exception thrown from underlying handlers. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Disposes the response body. - - The response context. - - - - Processes an exception by invoking a matching exception handler - for the given exception. - - The execution context, it contains the - request and response context. - The exception to be processed. - - This method returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception that may be thrown by exception - processing by a matching exception handler. - - - - - The abstract base class for exception handlers. - - The exception type. - - - - The exception handler for HttpErrorResponseException exception. - - - - - The constructor for HttpErrorResponseExceptionHandler. - - in instance of ILogger. - - - - Handles an exception for the given execution context. - - The execution context, it contains the - request and response context. - The exception to handle. - - Returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception to replace the original exception. - - - - - Checks if a HTTP 404 status code is returned which needs to be suppressed and - processes it. - If a suppressed 404 is present, it unmarshalls the response and returns true to - indicate that a suppressed 404 was processed, else returns false. - - The execution context, it contains the - request and response context. - - - If a suppressed 404 is present, returns true, else returns false. - - - - - A pipeline handler which provides hooks to run - external code in the pre-invoke and post-invoke phases. - - - - - Action to execute on the pre invoke phase. - - - - - Action to execute on the post invoke phase. - - - - - Calls the PreInvoke and PostInvoke methods before and after calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls the PreInvoke and PostInvoke methods before and after calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Executes the OnPreInvoke action as part of pre-invoke. - - The execution context, it contains the - request and response context. - - - - Executes the OnPreInvoke action as part of post-invoke. - - The execution context, it contains the - request and response context. - - - - This handler retrieved the AWS credentials to be used for the current call. - - - - - The constructor for CredentialsRetriever. - - An AWSCredentials instance. - - - - Retrieves the credentials to be used for the current call before - invoking the next handler. - - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - This handler resolves the endpoint to be used for the current request. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Resolves the endpoint to be used for the current request - before invoking the next handler. - - The execution context, it contains the - request and response context. - - - - This handler resolves the endpoint to be used for the current request. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Resolves the endpoint to be used for the current request - before invoking the next handler. - - The execution context, it contains the - request and response context. - - - - Determines the endpoint for the request. - - The request context. - - - - - This handler provides an OnError action that can be used as hook for - external code to handle exceptions in the runtime pipeline. - - - - - Action to execute if an exception occurs during the - execution of any underlying handlers. - - - - - Executes the OnError action if an exception occurs during the - execution of any underlying handlers. - - - - - - - This handler marshalls the request before calling invoking the next handler. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Marshalls the request before calling invoking the next handler. - - The execution context, it contains the - request and response context. - - - - This handler manages the metrics used to time the complete call and - logs the final metrics. - - - - - Captures the overall execution time and logs final metrics. - - The execution context which contains both the - requests and response context. - - - - Captures the overall execution time and logs final metrics. - - The response type for the current request. - - The execution context, it contains the request and response context. - - A task that represents the asynchronous operation. - - - - This handler processes HTTP redirects and reissues the call to the - redirected location. - - - - - Processes HTTP redirects and reissues the call to the - redirected location. - - The execution context which contains both the - requests and response context. - - - - Processes HTTP redirects and reissues the call to the - redirected location. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Checks if an HTTP 307 (temporary redirect) has occured and changes the - request endpoint to the redirected location. - - - The execution context, it contains the request and response context. - - - A boolean value that indicates if a redirect has occured. - - - - - This handler signs the request. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Signs the request before invoking the next handler. - - - The execution context, it contains the request and response context. - - - - - Determines if the request should be signed. - - The request context. - A boolean value that indicated if the request should be signed. - - - - Signs the request. - - The request context. - - - - This handler unmarshalls the HTTP response. - - - - - The constructor for Unmarshaller. - - - Boolean value which indicated if the unmarshaller - handler supports response logging. - - - - - Unmarshalls the response returned by the HttpHandler. - - The execution context which contains both the - requests and response context. - - - - Unmarshalls the response returned by the HttpHandler. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Unmarshalls the HTTP response. - - - The execution context, it contains the request and response context. - - - - - Unmarshalls the HTTP response. - - - The execution context, it contains the request and response context. - - - - - The HTTP handler contains common logic for issuing an HTTP request that is - independent of the underlying HTTP infrastructure. - - - - - - The sender parameter used in any events raised by this handler. - - - - - The constructor for HttpHandler. - - The request factory used to create HTTP Requests. - The sender parameter used in any events raised by this handler. - - - - Issues an HTTP request for the current request context. - - The execution context which contains both the - requests and response context. - - - - Issues an HTTP request for the current request context. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Determines the content for request body and uses the HTTP request - to write the content to the HTTP request body. - - Content to be written. - The HTTP request. - The request context. - - - - Creates the HttpWebRequest and configures the end point, content, user agent and proxy settings. - - The async request. - The web request that actually makes the call. - - - - Disposes the HTTP handler. - - - - - The default implementation of the adaptive retry policy. - - - The default implementation of the adaptive policy. - - - - - Constructor for AdaptiveRetryPolicy. - - The maximum number of retries before throwing - back a exception. This does not count the initial request. - - - - Constructor for AdaptiveRetryPolicy. - - The Client config object. This is used to - retrieve the maximum number of retries before throwing - back a exception(This does not count the initial request) and - the service URL for the request. - - - - OnRetry is called when a retry request is initiated to determine if the request will be retried. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - true if the error that will be retried is a throtting error - True if retry throttling is disabled or retry throttling is enabled and capacity can be obtained. - - - - This method uses a token bucket to enforce the maximum sending rate. - - The execution context which contains both the - requests and response context. - If the prior request failed, this exception is expected to be - the exception that occurred during the prior request failure. - - - - Virtual method that gets called on a success Response. If its a retry success response, the entire - retry acquired capacity is released(default is 5). If its just a success response a lesser value capacity - is released(default is 1). - - Request context containing the state of the request. - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - This method uses a token bucket to enforce the maximum sending rate. - - The execution context which contains both the - requests and response context. - If the prior request failed, this exception is expected to be - the exception that occurred during the prior request failure. - - - - The default implementation of the legacy retry policy. - - - The default implementation of the legacy retry policy. - - - - - The maximum value of exponential backoff in milliseconds, which will be used to wait - before retrying a request. The default is 30000 milliseconds. - - - - - Constructor for DefaultRetryPolicy. - - The maximum number of retries before throwing - back a exception. This does not count the initial request. - - - - Constructor for DefaultRetryPolicy. - - The Client config object. This is used to - retrieve the maximum number of retries before throwing - back a exception(This does not count the initial request) and - the service URL for the request. - - - - Returns true if the request is in a state where it can be retried, else false. - - Request context containing the state of the request. - Returns true if the request is in a state where it can be retried, else false. - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - true if the error that will be retried is a throtting error - - - - Virtual method that gets called on a success Response. If its a retry success response, the entire - retry acquired capacity is released(default is 5). If its just a success response a lesser value capacity - is released(default is 1). - - Request context containing the state of the request. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Request context containing the state of the request. - Return true if the request should be retried. - - - - Checks if the retry limit is reached. - - Request context containing the state of the request. - Return false if the request can be retried, based on number of retries. - - - - Waits before retrying a request. The default policy implements a exponential backoff. - - Request context containing the state of the request. - - - - Waits for an amount of time using an exponential backoff algorithm. - - The request retry index. The first request is expected to be 0 while - the first retry will be 1. - The max number of milliseconds to wait - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - The retry handler has the generic logic for retrying requests. - It uses a retry policy which specifies when - a retry should be performed. - - - - - The logger used to log messages. - - - - - The retry policy which specifies when - a retry should be performed. - - - - - Constructor which takes in a retry policy. - - Retry Policy - - - - Invokes the inner handler and performs a retry, if required as per the - retry policy. - - The execution context which contains both the - requests and response context. - - - - Invokes the inner handler and performs a retry, if required as per the - retry policy. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Prepares the request for retry. - - Request context containing the state of the request. - - - - The default implementation of the standard retry policy. - - - The default implementation of the standard policy. - - - - - The maximum value of exponential backoff in milliseconds, which will be used to wait - before retrying a request. The default is 20000 milliseconds. - - - - - Constructor for StandardRetryPolicy. - - The maximum number of retries before throwing - back a exception. This does not count the initial request. - - - - Constructor for StandardRetryPolicy. - - The Client config object. This is used to - retrieve the maximum number of retries before throwing - back a exception(This does not count the initial request) and - the service URL for the request. - - - - Returns true if the request is in a state where it can be retried, else false. - - Request context containing the state of the request. - Returns true if the request is in a state where it can be retried, else false. - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - true if the error that will be retried is a throtting error - - - - Virtual method that gets called on a success Response. If its a retry success response, the entire - retry acquired capacity is released(default is 5). If its just a success response a lesser value capacity - is released(default is 1). - - Request context containing the state of the request. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Request context containing the state of the request. - Return true if the request should be retried. - - - - Checks if the retry limit is reached. - - Request context containing the state of the request. - Return false if the request can be retried, based on number of retries. - - - - Waits before retrying a request. The default policy implements a exponential backoff with - jitter algorithm. - - Request context containing the state of the request. - - - - Waits for an amount of time using an exponential backoff with jitter algorithm. - - The request retry index. The first request is expected to be 0 while - the first retry will be 1. - The max number of milliseconds to wait - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - This class is the base class of all the configurations settings to connect - to a service. - - - This class is the base class of all the configurations settings to connect - to a service. - - - - - Gets Service Version - - - - - Gets and sets of the signatureMethod property. - - - - - Gets and sets of the SignatureVersion property. - - Note: This property exists for backward compatibility but is no longer - used by any service other than S3. - - - - - Gets and sets of the UserAgent property. - - - - - Gets and sets the RegionEndpoint property. The region constant that - determines the endpoint to use. - - Setting this property to null will force the SDK to recalculate the - RegionEndpoint value based on App/WebConfig, environment variables, - profile, etc. - - - - - The constant used to lookup in the region hash the endpoint. - - - - - Gets and sets of the ServiceURL property. - This is an optional property; change it - only if you want to try a different service - endpoint. - - - - - Gets and sets the UseHttp. - If this property is set to true, the client attempts - to use HTTP protocol, if the target endpoint supports it. - By default, this property is set to false. - - - - - Given this client configuration, return a string form ofthe service endpoint url. - - - - - Gets and sets the AuthenticationRegion property. - Used in AWS4 request signing, this is an optional property; - change it only if the region cannot be determined from the - service endpoint. - - - - - Gets and sets the AuthenticationServiceName property. - Used in AWS4 request signing, this is the short-form - name of the service being called. - - - - - Returns the flag indicating how many retry HTTP requests an SDK should - make for a single SDK operation invocation before giving up. This flag will - return 4 when the RetryMode is set to "Legacy" which is the default. For - RetryMode values of "Standard" or "Adaptive" this flag will return 2. In - addition to the values returned that are dependant on the RetryMode, the - value can be set to a specific value by using the AWS_MAX_ATTEMPTS environment - variable, max_attempts in the shared configuration file, or by setting a - value directly on this property. When using AWS_MAX_ATTEMPTS or max_attempts - the value returned from this property will be one less than the value entered - because this flag is the number of retry requests, not total requests. To - learn more about the RetryMode property that affects the values returned by - this flag, see . - - - - - Determines if MaxErrorRetry has been manually set. - - - - - Gets and sets the LogResponse property. - If this property is set to true, the service response is logged. - The size of response being logged is controlled by the AWSConfigs.LoggingConfig.LogResponsesSizeLimit property. - - - - - Gets and sets the ReadEntireResponse property. - NOTE: This property does not effect response processing and is deprecated. - To enable response logging, the ClientConfig.LogResponse and AWSConfigs.LoggingConfig - properties can be used. - - - - - Gets and Sets the BufferSize property. - The BufferSize controls the buffer used to read in from input streams and write - out to the request. - - - - - - Gets or sets the interval at which progress update events are raised - for upload operations. By default, the progress update events are - raised at every 100KB of data transferred. - - - If the value of this property is set less than ClientConfig.BufferSize, - progress updates events will be raised at the interval specified by ClientConfig.BufferSize. - - - - - - Flag on whether to resign requests on retry or not. - For Amazon S3 and Amazon Glacier this value will always be set to true. - - - - - This flag controls if .NET HTTP infrastructure should follow redirection - responses (e.g. HTTP 307 - temporary redirect). - - - - - Flag on whether to log metrics for service calls. - - This can be set in the application's configs, as below: - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSLogMetrics" value"true"/> - </appSettings> - </configuration> - - - - - - Gets and sets the DisableLogging. If true logging for this client will be disabled. - - - - - Credentials to use with a proxy. - - - - - - If the value is set, the value is assigned to the Timeout property of the HttpWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Configures the endpoint calculation for a service to go to a dual stack (ipv6 enabled) endpoint - for the configured region. - - - Note: AWS services are enabling dualstack endpoints over time. It is your responsibility to check - that the service actually supports a dualstack endpoint in the configured region before enabling - this option for a service. - - - - - Enable or disable the Retry Throttling feature by setting the ThrottleRetries flag to True/False resepctively. - Retry Throttling is a feature that intelligently throttles retry attempts when a large precentage of requests - are failing and retries are unsuccessful as well. In such situations the allotted retry capacity for the service URL - will be drained until requests start to succeed again. Once the requisite capacity is available, retries would - be permitted again. When retries are throttled, the service enters a fail-fast behaviour as the traditional retry attempt - for the request would be circumvented. Hence, errors will resurface quickly. This will result in a greated number of exceptions - but prevents requests being tied up in unsuccessful retry attempts. - Note: Retry Throttling is enabled by default. Set the ThrottleRetries flag to false to switch off this feature. - - - - - Enable or disable the Nagle algorithm on the underlying http - client. - - This method is not intended to be called by consumers of the AWS SDK for .NET - - - - - - Performs validation on this config object. - Throws exception if any of the required values are missing/invalid. - - - - - Returns the current UTC now after clock correction for this endpoint. - - - - - The calculated clock skew correction for a specific endpoint, if there is one. - This field will be set if a service call resulted in an exception - and the SDK has determined that there is a difference between local - and server times. - - If is set to true, this - value will still be set to the correction, but it will not be used by the - SDK and clock skew errors will not be retried. - - - - - Gets and sets the DisableHostPrefixInjection flag. If true, host prefix injection will be disabled for this client, the default value of this flag is false. - Host prefix injection prefixes the service endpoint with request members from APIs which use this feature. - Example: for a hostPrefix of "foo-name." and a endpoint of "service.region.amazonaws.com" the default behavior is to - prefix the endpoint with the hostPrefix resulting in a final endpoint of "foo-name.service.region.amazonaws.com". Setting - DisableHostPrefixInjection to true will disable hostPrefix injection resulting in a final endpoint of - "service.region.amazonaws.com" regardless of the value of hostPrefix. E.g. You may want to disable host prefix injection for testing against a local mock endpoint. - - - - - Returns the flag indicating if endpoint discovery should be enabled or disabled for operations that are not required to use endpoint discovery. - - - - - Returns the maximum number of discovered endpoints that can be stored within the cache for the client. The default limit is 1000 cache entries. - - - - - Returns the flag indicating the current mode in use for request - retries and influences the value returned from . - The default value is RequestRetryMode.Legacy. This flag can be configured - by using the AWS_RETRY_MODE environment variable, retry_mode in the - shared configuration file, or by setting this value directly. - - - - - Under Adaptive retry mode, this flag determines if the client should wait for - a send token to become available or don't block and fail the request immediately - if a send token is not available. - - - - - Throw an exception if the boxed TimeSpan parameter doesn't have a value or is out of range. - - - - - Returns the request timeout value if its value is set, - else returns client timeout value. - - - - - - This is a switch used for performance testing and is not intended for production applications - to change. This switch may be removed in a future version of the SDK as the .NET Core platform matures. - - - If true, the HttpClient is cached and reused for every request made by the service client - and shared with other service clients. - - - For the .NET Core platform this is default to true because the HttpClient manages the connection - pool. - - - - - - If CacheHttpClient is set to true then HttpClientCacheSize controls the number of HttpClients cached. - - On Windows the default value is 1 since the underlying native implementation does not have throttling constraints - like the non Windows Curl based implementation. For non Windows based platforms the default is the value return from - System.Environment.ProcessorCount. - - - - - - Overrides the default read-write timeout value. - On Unity platform, this value is not used as Unity HTTP client does not support timeouts, so - - - - If the value is set, the value is assigned to the ReadWriteTimeout property of the HttpWebRequest object used - to send requests. - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Returns a WebProxy instance configured to match the proxy settings - in the client configuration. - - - - - Unpacks the host, port and any credentials info into the instance's - proxy-related fields. - Unlike the SetWebProxy implementation on .NET 3.5/4.5,the Host and the Port are not reconstructed from the - input proxyuri - - The proxy details - - - - Gets and sets of the ProxyHost property. - - - - - Gets and sets of the ProxyPort property. - - - - - - Returns true if the clients should be cached by HttpRequestMessageFactory, false otherwise. - - - - - - - Returns true if the SDK should dispose HttpClients after one use, false otherwise. - - - - - - - Create a unique string used for caching the HttpClient based on the settings that are used from the ClientConfig that are set on the HttpClient. - - - - - - - Determines if HttpClients created with the given IClientConfig should be cached at the SDK - client level, or cached globally. - - If there is no HttpClientFactory assigned and proxy or proxy credentials are set - this returns false because those properties can't be serialized as part of the key in the global http client cache. - - - - - Base class for constant class that holds the value that will be sent to AWS for the static constants. - - - - - Gets the value that needs to be used when send the value to AWS - - - - - Attempt to find correct-cased constant value using whatever cased value the user - has provided. This is primarily useful for mapping any-cased values from a CLI - tool to the specific casing required by the service, avoiding the need for the - user to (a) remember the specific case and (b) actually type it correctly. - - The properly cased service constant matching the value - - - - Utility class that stores clock skew information. - - - - - GlobalClockCorrection should be only set by AWSConfigs.ManualClockCorrection property - and is only available to maintain backward compatibilty. This should override any - endpoint specific clockskew correction. - - - - - Return clock skew correction value for an endpoint if there is one. - - AWSConfigs.ManualClockCorrection overrides globally any calculated service endpoint specific - clock correction value. - - Endpoint should in a form such as "https://s3" - Clock correction value for an endpoint in TimeSpan. TimeSpan.Zero if no such clock correction is set. - - - - Get clock skew corrected UTC now value. If ManualClockCorrection is set, - use ManualClockCorrection instead of endpoint specific clock correction value. - - - - - - - Probing mechanism to determine the endpoint discovery enabled value from various sources. - - - - - The valid hashing algorithm supported by the sdk for request signing. - - - - - Which end of a request was responsible for a service error response. - - - - - The sender was responsible for the error, i.e. the client - request failed validation or was improperly formatted. - - - - - The error occured within the service. - - - - - An unrecognized error type was returned. - - - - - Sts Regional Endpoints Value determines whether or not - to send the sts request to the regional endpoint or to - the global sts endpoint - - - - - Send the request to the global sts endpoint - if the region is a legacy global region - - - - - Send the request to the regional endpoint - - - - - S3 US East 1 endpoint value determines wheter or not - to send the us-east-1 s3 requests to the regional endpoint or to - the legacy global endpoint - - - - - Sends the requests to the legacy global s3 endpoint for us-east-1 - - - - - Sends the request to the regional s3 endpoint for us-east-1 - - - - - RetryMode determines which request retry mode is used for requests that do - not complete successfully. - - - - - Legacy request retry strategy. - - - - - Standardized request retry strategy that is consistent across all SDKs. - - - - - An experimental request retry strategy that builds on the Standard strategy - and introduces congestion control through client side rate limiting. - - - - - All Amazon service interfaces like IAmazonS3 extend from this interface. This allows all the - Amazon service interfaces be identified by this base interface and helps with generic constraints. - - - - - A readonly view of the configuration for the service client. - - - - - This interface is the read only access to the ClientConfig object used when setting up service clients. Once service clients - are initiated the config object should not be changed to avoid issues with using a service client in a multi threaded environment. - - - - - Gets the RegionEndpoint property. The region constant to use that - determines the endpoint to use. If this is not set - then the client will fallback to the value of ServiceURL. - - - - - The constant used to lookup in the region hash the endpoint. - - - - - Gets and sets of the ServiceURL property. - This is an optional property if you need to set a specific service URL - instead setting the region with the RegionEndpoint property. - - - - - Gets the UseHttp property. - If this property is set to true, the client attempts - to use HTTP protocol. - By default, this property is set to false. - - - - - Gets Service Version - - - - - Gets the signatureMethod property. - - - - - Gets the SignatureVersion property. - - Note: This property exists for backward compatibility but is no longer - used by any service other than S3. - - - - - Gets the AuthenticationRegion property. - Used in AWS4 request signing, this is an optional property; - change it only if the region cannot be determined from the - service endpoint. - - - - - Gets the AuthenticationServiceName property. - Used in AWS4 request signing, this is the short-form - name of the service being called. - - - - - Gets the UserAgent property. - - - - - Gets the DisableLogging. If true logging for this client will be disabled. - - - - - Flag on whether to log metrics for service calls. - - This can be set in the application's configs, as below: - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSLogMetrics" value"true"/> - </appSettings> - </configuration> - - - - - - Gets the LogResponse property. - If this property is set to true, the service response - is read in its entirety and logged. - - - - - Gets the ReadEntireResponse. - If this property is set to true, the service response - is read in its entirety before being processed. - - - - - This flag controls if .NET HTTP infrastructure should follow redirection - responses (e.g. HTTP 307 - temporary redirect). - - - - - Gets the BufferSize property. - The BufferSize controls the buffer used to read in from input streams and write - out to the request. - - - - - Returns the flag indicating how many retry HTTP requests an SDK should - make for a single SDK operation invocation before giving up. This flag will - return 4 when the RetryMode is set to "Legacy" which is the default. For - RetryMode values of "Standard" or "Adaptive" this flag will return 2. In - addition to the values returned that are dependant on the RetryMode, the - value can be set to a specific value by using the AWS_MAX_ATTEMPTS environment - variable, max_attempts in the shared configuration file, or by setting a - value directly on this property. When using AWS_MAX_ATTEMPTS or max_attempts - the value returned from this property will be one less than the value entered - because this flag is the number of retry requests, not total requests. To - learn more about the RetryMode property that affects the values returned by - this flag, see . - - - - - Determines if MaxErrorRetry has been manually set. - - - - - Gets the interval at which progress update events are raised - for upload operations. By default, the progress update events are - raised at every 100KB of data transferred. - - - - - Flag on whether to resign requests on retry or not. - - - - - Credentials to use with a proxy. - - - - - Gets the default request timeout value. - - - - If the value is set, the value is assigned to the Timeout property of the HTTPWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - - - - Configures the endpoint calculation for a service to go to a dual stack (ipv6 enabled) endpoint - for the configured region. - - - Note: AWS services are enabling dualstack endpoints over time. It is your responsibility to check - that the service actually supports a dualstack endpoint in the configured region before enabling - this option for a service. - - - - - Configures a flag enabling to either opt in or opt out of the retry throttling service. - Note: set value to true to enable retry throttling feature. The Default value for this flag is false. - - - - - Using either the RegionEndpoint or the ServiceURL determine what the URL to the service is. - - The URL to the service. - - - - Performs validation on this config object. - Throws exception if any of the required values are missing/invalid. - - The timeout specified is null. - - - - Returns the clock skew adjusted utc now. This value is affected by AWSConfigs.ManualClockCorrection - - - - - Returns the calculated clock skew value for this config's service endpoint. If AWSConfigs.CorrectForClockSkew is false, - this value won't be used to construct service requests. - - - - - Gets the DisableHostPrefixInjection flag. If true, host prefix injection will be disabled for this client, the default value of this flag is false. - Host prefix injection prefixes the service endpoint with request members from APIs which use this feature. - Example: for a hostPrefix of "foo-name." and a endpoint of "service.region.amazonaws.com" the default behavior is to - prefix the endpoint with the hostPrefix resulting in a final endpoint of "foo-name.service.region.amazonaws.com". Setting - DisableHostPrefixInjection to true will disable hostPrefix injection resulting in a final endpoint of - "service.region.amazonaws.com" regardless of the value of hostPrefix. E.g. You may want to disable host prefix injection for testing against a local mock endpoint. - - - - - Returns the flag indicating if endpoint discovery should be enabled or disabled for operations that are not required to use endpoint discovery. - - - - - Returns the maximum number of discovered endpoints that can be stored within the cache for the client. The default limit is 1000 cache entries. - - - - - Returns the flag indicating the current mode in use for request - retries and influences the value returned from . - The default value is RequestRetryMode.Legacy. This flag can be configured - by using the AWS_RETRY_MODE environment variable, retry_mode in the - shared configuration file, or by setting this value directly. - - - - - Under Adaptive retry mode, this flag determines if the client should wait for - a send token to become available or don't block and fail the request immediately - if a send token is not available. - - - - - - This is a switch used for performance testing and is not intended for production applications - to change. This switch may be removed in a future version of the SDK as the .NET Core platform matures. - - - If true, the HttpClient is cached and reused for every request made by the service client - and shared with other service clients. - - - For the .NET Core platform this is default to true because the HttpClient manages the connection - pool. - - - - - - If CacheHttpClient is set to true then HttpClientCacheSize controls the number of HttpClients cached. - - - - - Gets the ProxyHost property. - - - - - Gets the ProxyPort property. - - - - - Returns a WebProxy instance configured to match the proxy settings - in the client configuration. - - - - - - Interface for a single logged message. - - - - - Log message format. - - - - - Log message arguments. - - - - - Culture-specific formatting provider. - - - - - Abstract parameter value. - - - - - String parameter value. - - - - - String value of the parameter. - - - - - Constructs ParameterValue for a single string. - - - - - - String list parameter value. - - - - - List of strings value of the parameter. - - - - - Constructs ParameterValue for a list of strings. - - - - - - Metrics collected by the SDK on a per-request basis. - - - Each request made to an AWS service by the SDK can have metrics - collected and logged. This interface represents the collected - metrics for a request. The metrics include properties (i.e. request id - and other metadata), timings for each stage of the request, and counters. - - - - - Collection of properties being tracked - - - - - Timings for metrics being tracked - - - - - Counters being tracked - - - - - Whether metrics are enabled for the request - - - - - JSON representation of the current metrics - - JSON string - - - - Represents how long a phase of an SDK request took. - - - - - Whether the timing has been stopped - - - - - Elapsed ticks from start to stop. - If timing hasn't been stopped yet, returns 0. - - - - - Elapsed time from start to stop. - If timing hasn't been stopped yet, returns TimeSpan.Zero - - - - - User supplied type to perform metrics formatting. - - - - - Produce custom formatting for SDK metrics. - - - If defined, this method will be called for every request made by the SDK. - - An instance of IRequestMetrics produced by the SDK - formatted string representation of the metrics - - - - Predefined request metrics that are collected by the SDK. - - - - - Information about the request. - - - - - Gets and sets the RequestId property. - ID that uniquely identifies a request. Amazon keeps track of request IDs. If you have a question about a request, include the request ID in your correspondence. - - - - - This exception is thrown if there are problems signing the request. - - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - - - - Gets the percentage of transfer completed - - - - - Gets the number of bytes transferred since last event - - - - - Gets the number of bytes transferred - - - - - Gets the total number of bytes to be transferred - - - - - Returns a string representation of this object - - - - - - Anonymous credentials. - Using these credentials, the client does not sign the request. - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - AWS Credentials that automatically refresh by calling AssumeRole on - the Amazon Security Token Service. - - - - - The credentials of the user that will be used to call AssumeRole. - - - - - The Amazon Resource Name (ARN) of the role to assume. - - - - - An identifier for the assumed role session. - - - - - Options to be used in the call to AssumeRole. - - - - - Constructs an AssumeRoleAWSCredentials object. - - The credentials of the user that will be used to call AssumeRole. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - - - - Constructs an AssumeRoleAWSCredentials object. - - The credentials of the user that will be used to call AssumeRole. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRole. - - - - A unique identifier that is used by third parties when assuming roles in their customers' accounts. - - - - - An IAM policy in JSON format. - - - - - The length of time in seconds before the credentials will expire. - - - - - The identification number of the MFA device that is associated with the user who is making the assume-role call. - - - - - The value provided by the MFA device, if the trust policy of the role being assumed requires MFA. - - - - - A callback that's used to obtain the MFA token code when the AssumeRoleAWSCredentials are refreshed. - - - - - Immutable representation of AWS credentials obtained as a result of - authenticating with the AssumeRole method of the Security Token Service. - - - - - The expiry time of the credentials, obtained from the AssumeRoleResponse. - - - - - Constructs an instance with supplied keys, token, and expiration. - - The AccessKey for the credentials. - The SecretKey for the credentials. - The security token for the credentials. - The expiration time for the credentials. - - - - Get a copy of this AssumeRoleImmutableCredentials object. - - A copy of this object. - - - - Abstract class that represents a credentials object for AWS services. - - - - - Returns a copy of ImmutableCredentials - - - - - - Called by AmazonServiceClient to validate the credential state - on client construction. - - - - - Basic set of credentials consisting of an AccessKey and SecretKey - - - - - Constructs a BasicAWSCredentials object for the specified accessKey and secretKey. - - - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - Immutable representation of AWS credentials. - - - - - Gets the AccessKey property for the current credentials. - - - - - Gets the SecretKey property for the current credentials. - - - - - Gets the Token property for the current credentials. - - - - - Gets the UseToken property for the current credentials. - Specifies if Token property is non-emtpy. - - - - - Constructs an ImmutableCredentials object with supplied accessKey, secretKey. - - - - Optional. Can be set to null or empty for non-session credentials. - - - - Returns a copy of the current credentials. - - - - - - Abstract class for automatically refreshing AWS credentials - - - - - Refresh state container consisting of credentials - and the date of the their expiration - - - - - Represents the current state of the Credentials. - - This can be cleared without synchronization. - - - - Semaphore to control thread access to GetCredentialsAsync method. - The semaphore will allow only one thread to generate new credentials and - update the current state. - - - - - The time before actual expiration to expire the credentials. - Property cannot be set to a negative TimeSpan. - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - Test credentials existence and expiration time - should update if: - credentials have not been loaded yet - it's past the expiration time. At this point currentState.Expiration may - have the PreemptExpiryTime baked into to the expiration from a call to - UpdateToGeneratedCredentials but it may not if this is new application load. - - - - - When overridden in a derived class, generates new credentials and new expiration date. - - Called on first credentials request and when expiration date is in the past. - - - - - - When overridden in a derived class, generates new credentials and new expiration date. - - Called on first credentials request and when expiration date is in the past. - - - - - - Clears currently-stored credentials, forcing the next GetCredentials call to generate new credentials. - - - - - Immutable representation of AWS credentials obtained as a result of - authenticating against a SAML-supporting federated identity provider. - - - - - The expiry time of the credentials, obtained from the AssumeRoleWithSAML response. - - - - - The value of the NameID element in the Subject element of the SAML assertion, as returned in the - AssumeRoleWithSAML response from the Security Token Service. - - - - - Constructs an instance with supplied keys and SAML assertion data. - - - - - - - - - - Constructs an instance with supplied keys and SAML assertion data. - - - - - - - - Returns a copy of the current credentials. - - - - - - Serializes the instance to a json-format string for external storage - - The serialized object in json - - - - Instantiates an instance from persisted json data - - The serialized data - Deserialized instance corresponding to the json data - - - - Session credentials consisting of AccessKey, SecretKey and Token - - - - - Constructs a SessionAWSCredentials object for the specified accessKey, secretKey. - - - - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - Credentials that are retrieved from the Instance Profile service on an EC2 instance - - - - - Constructs a InstanceProfileAWSCredentials object for specific role - - Role to use - - - - Constructs a InstanceProfileAWSCredentials object for the first found role - - - - - Retrieves a list of all roles available through current InstanceProfile service - - InstanceProfileAWSCredentials is no longer supported in PCL. - - - - - - Superclass for Exceptions that come over the event stream, or to wrap other kinds of generic exceptions. - - - - - The numeric code identifier for the type of error. - - - - - Constructs an EventStreamError. - - - - - Constructs an EventStreamError. - - The error code. - The error message. - - - - Event args that contain an . - - The - - - - The EventStream Event. - - - - - Constructs an EventStreamEventReceivedArgs. - - The EventStream Event. - - - - Event args that contain an . - - The . - - - - The EventStream Exception. - - - - - Constructs an EventStreamExceptionReceivedArgs. - - The EventStream Exception. - - - - Supported Header types for vnd.amazon.event-stream - - - - - Name for the Header. Maximum of 255 bytes. - - - - - Header type id - - - - - Computes the amount of memory neccesary to serialize this Header. - - - - - Writes this Header to buffer starting at offset - Keep in mind, this API assumes buffer is large enough - for the operation. - - buffer to serialize this Header to - offset to begin writing at. - - the new offset. - - - - - Returns the current value as a bool - - - - - Sets the current value - - - - - Returns the current value as a byte - - - - - Sets the current value - - - - - Gets the current value as a 16 bit integer. (Host Order). - - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a 32 bit integer. (Host Order) - - - - - Sets the current value - - - - - returns the current value as a 64-bit integer. (Host Order) - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a byte buffer. - - - - - - Sets the current value. Max length is 2^15 - 1 - - - - - Returns the current value as a utf-8 string. - - - - - Sets the current value. Utf-8 encoded. Max byte size is 2^16 - 1 - - - - - Gets the current value as a DateTime. - Note: You do not need to compensate for unix epoch on this API. - - - - - - Sets the current value. - Note: You do not need to compensate for unix epoch on this API. - - - - - Returns the current value as a Guid (UUID) - - - - - Sets the current value - - - - - Header Data for an EventStreamMessage - - Each header is of format: - [name len] (1) | [utf-8 name] (v) - [type (1)] - [value (v)] - - - - - Name for the Header. Maximum of 255 bytes. - - - - - Header type id - - - - - Initializes this Header with name. - - utf-8 string, max length is 255 - - - - Deserializes the header in buffer. - - buffer constaining the header - index to start from in the buffer. - updated offset with new value for offset - - - - Writes this Header to buffer starting at offset - Keep in mind, this API assumes buffer is large enough - for the operation. - - buffer to serialize this Header to - offset to begin writing at. - - the new offset. - - - - - Computes the amount of memory neccesary to serialize this Header. - - - - - Returns the current value as a bool - - - - - Sets the current value - - - - - Returns the current value as a byte - - - - - Sets the current value - - - - - Gets the current value as a 16 bit integer. (Host Order). - - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a 32 bit integer. (Host Order) - - - - - Sets the current value - - - - - returns the current value as a 64-bit integer. (Host Order) - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a byte buffer. - - - - - - Sets the current value. Max length is 2^15 - 1 - - - - - Returns the current value as a utf-8 string. - - - - - Sets the current value. Utf-8 encoded. Max byte size is 2^16 - 1 - - - - - Gets the current value as a DateTime. - Note: You do not need to compensate for unix epoch on this API. - - - - - - Sets the current value. - Note: You do not need to compensate for unix epoch on this API. - - - - - Returns the current value as a Guid (UUID) - - - - - Sets the current value - - - - - Headers for the message. Can be null. - - - - - Payload for the message. Can be null. - - - - - Converts a message into a byte buffer (usually for network transmission). - - - - - Message is a single datagram. The format is as follows: - [ total length (4) ] | [ headers_length (4)] | [ prelude crc(4)] - [ headers (v)] - [ payload (v)} - [ trailing crc ] - - CRCs use the CRC32 algorithm. - - - - - Content type for EventStreams. - - - - - Headers for the message. Can be null. - - - - - Payload for the message. Can be null. - - - - - Initialize a message with headers and a payload. - - list of headers for the message, can be null. - payload for the message, can be null. - - - - Builds a message from buffer. - - buffer to read - offset to start reading - buffer length. - - parsed instance of EventStreamMessage. Doesn't return null, - does throw if CRCs don't match. - - - - - Converts a message into a byte buffer (usually for network transmission). - - - - - Defines exceptions that arise from an not conforming to specification. - - - - - Constructs an EventStreamValidationException. - - - - - Constructs an EventStreamValidationException. - - The exception message. - - - - Constructs an EventStreamValidationException. - - The exception message. - The inner exception. - - - - This exception is thrown if an exception is retrieved from the event stream and should be modeled, - but a generator function for the strongly-typed exception is not defined. - - - - - The exception type. - - - - - Constructs an EventStreamException. - - The exception type. - - - - The contract for the . - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - A subclass of that enables an enumerable interface for interacting with Events. - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - Flag if the stream was chosen to be enumerated. - - - - - A Stream of Events. Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treated as mutually exclusive. - - - - - A Stream of Events. Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treated as mutually exclusive. - - - - - Returns an enumerator that iterates through the collection. - - An enumerator that can be used to iterate through the collection. - - - - Returns an enumerator that iterates through a collection. - - An object that can be used to iterate through the collection. - - - - Starts the background thread to start reading events from the network stream. - - - - - The contract for the . - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - The size of the buffer for reading from the network stream. - - - - - Fires when an event is received. - - - - - Fired when an exception or error is raised. - - - - - Starts the background thread to start reading events from the network stream. - - - - - The superclass for all EventStreams. It contains the common processing logic needed to retreive events from a network Stream. It - also contains the mechanisms needed to have a background loop raise events. - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - "Unique" key for unknown event lookup. - - - - - Header key for message type. - - - - - Header key for event type. - - - - - Header key for exception type. - - - - - Header key for error code. - - - - - Header key for error message. - - - - - Value of when the message is an event. - - - - - Value of when the message is an exception. - - - - - Value of when the message is an error. - - - - - The size of the buffer for reading from the network stream. - Default is 8192. - - - - - The underlying stream to read events from. - - - - - Responsible for decoding events from sequences of bytes. - - - - - Fires when an event is recieved. - - - - - Fired when an exception or error is raised. - - - - - The mapping of event message to a generator function to construct the matching Event Stream event. - - - - - The mapping of event message to a generator function to construct the matching Event Stream exception. - - - - - Whether the Stream is currently being processed. - - - - - A Stream of Events. Events can be retrieved from this stream by attaching handlers to listen events, and then calling StartProcessing. - - - - - A Stream of Events. Events can be retrieved from this stream by attaching handlers to listen events, and then calling StartProcessing. - - - - - Converts an EventStreamMessage to an event. - - The event stream message to be converted. - The event - - - - Abstraction for cross-framework initiation of the background thread. - - - - - The background thread main loop. It will constantly read from the network stream until IsProcessing is false, or an error occurs. - - This stub exists due to FXCop. - - - - - The background thread main loop. It will constantly read from the network stream until IsProcessing is false, or an error occurs. - - Needed for 3.5 support. Not used. - - - - Reads from the stream into the buffer. It then passes the buffer to the decoder, which raises an event for - each message it decodes. - - The buffer to store the read bytes from the stream. - - - - Wraps exceptions in an outer exception so they can be passed to event handlers. If the Exception is already of a compatable type, - the method returns what it was given. - - The exception to wrap. - An exception of type TE - - - - Starts the background thread to start reading events from the network stream. - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Disposes the resources of this stream. - - Should dispose of unmanged resources. - - - - Event Arguments for EventStreamDecoder.MessageReceived. - - - - - Received message. - - - - - Additional object context - - - - - Initialize this with message - - - - - Initialize this with message and object conetext - - - - - Exception thrown when a request is made of the Decoder, but the internal state - machine is an invalid state. This is usually the result of an interanl exception - being thrown during parsing of the network stream. - - - - - Contract for EventStreamDecoder - - - - - Invoked anytime an EventStreamMessage is found. - - - - - Processes data starting at offset up to length. - Invokes MessageRecieved for each message encountered. - If an exception is thrown, this object is not safe for reuse. - - buffer to read - offset in buffer to start reading. - length of data. - - - - Streaming decoder for listening for incoming EventStreamMessage datagrams. - - - - - Invoked anytime an EventStreamMessage is found. - - - - - Object data (optional) that can be passed to the event handler for MessageReceived. - - - - - Default constructor. Initializes internal _state machine. - - - - - Processes data starting at offset up to length. - Invokes MessageRecieved for each message encountered. - If an exception is thrown, this object is not safe for reuse. - - buffer to read - offset in buffer to start reading. - length of data. - - - - Superclass for Exceptions that come over the event stream, or to wrap other kinds of generic exceptions. - - - - - Constructs an EventStreamException. - - - - - Constructs an EventStreamException. - - The exception message. - - - - Constructs an EventStreamException. - - The exception message. - The inner exception. - - - - The contract for EventStream events. - - - - - The contract for EventStream terminal events. - - - - - This Event is returned if an event is retrieved from the event stream, but a generator function - for the event is not defined. This can occur if the SDK is not updated after a new event type is introduced. - - - - - The Message recieved from the event stream before conversion. - - - - - The event type. - - - - - Constructs an UnknownEventStreamEvent. - - - - - Constructs an UnknownEventStreamEvent. - - The Message recieved from the event stream before conversion. - The event type. - - - - Signals that an an has an unknown message type. These exceptions whould be - swallowed to allow future expansion of the EventStream specification without breaking existing clients. - - - - - Constructs an UnknownEventStreamMessageTypeException. - - - - - Interface for a handler in a pipeline. - - - - - The logger used to log messages. - - - - - The inner handler which is called after the current - handler completes it's processing. - - - - - The outer handler which encapsulates the current handler. - - - - - Contains the processing logic for a synchronous request invocation. - This method should call InnerHandler.InvokeSync to continue processing of the - request by the pipeline, unless it's a terminating handler. - - The execution context which contains both the - requests and response context. - - - - Contains the processing logic for an asynchronous request invocation. - This method should call InnerHandler.InvokeSync to continue processing of the - request by the pipeline, unless it's a terminating handler. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - The interface for an exception handler. - - - - - Handles an exception for the given execution context. - - The execution context, it contains the - request and response context. - The exception to handle. - - Returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception to replace the original exception. - - - - - The interface for an exception handler with a generic parameter for the exception type. - - The exception type. - - - - Handles an exception for the given execution context. - - The execution context, it contains the - request and response context. - The exception to handle. - - Returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception to replace the original exception. - - - - - The interface for a HTTP request factory. - - The type used by the underlying HTTP API to represent the request body. - - - - Creates an HTTP request for the given URI. - - The request URI. - An HTTP request. - - - - The interface for an HTTP request that is agnostic of the underlying HTTP API. - - The type used by the underlying HTTP API to represent the HTTP request content. - - - - The HTTP method or verb. - - - - - The request URI. - - - - - Configures a request as per the request context. - - The request context. - - - - Sets the headers on the request. - - A dictionary of header names and values. - - - - Gets a handle to the request content. - - The request content. - - - - Returns the HTTP response. - - The HTTP response. - - - - Writes a stream to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - The request context. - - - - Writes a byte array to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - - - - Sets up the progress listeners - - The content stream - The interval at which progress needs to be published - The objects which is trigerring the progress changes - The callback which will be invoked when the progress changed event is trigerred - an object, incase the progress is setup, else returns the original stream - - - - Aborts the HTTP request. - - - - - Gets a handle to the request content. - - - - - - Returns the HTTP response. - - A cancellation token that can be used to cancel the asynchronous operation. - - - - - A factory which creates HTTP clients. - - - - - Create and configure an HttpClient. - - - - - - A factory which creates HTTP requests which uses System.Net.Http.HttpClient. - - - - - The constructor for HttpRequestMessageFactory. - - Configuration setting for a client. - - - - Creates an HTTP request for the given URI. - - The request URI. - An HTTP request. - - - - Disposes the HttpRequestMessageFactory. - - - - - Dispose the factory - - - - - - Create and configure a managed HttpClient instance. - The use of HttpClientHandler in the constructor for HttpClient implicitly creates a managed HttpClient. - If a native HttpClient is required the SDK user must implement IHttpClientFactory and provide an - instance via IClientConfig.HttpClientFactory (only available in PCL). - - - - - - - A cache of HttpClient objects. The GetNextClient method does a round robin cycle through the clients - to distribute the load even across. - - - - - Constructs a container for a cache of HttpClient objects - - The HttpClient to cache - - - - Returns the next HttpClient using a round robin rotation. It is expected that individual clients will be used - by more then one Thread. - - - - - - Disposes the HttpClientCache. - - - - - Dispose the HttpClientCache - - - - - - HTTP request wrapper for System.Net.Http.HttpRequestMessage. - - - - - Set of content header names. - - - - - The constructor for HttpWebRequestMessage. - - The HttpClient used to make the request. - The request URI. - The service client config. - - - - The underlying HttpClient - - - - - The underlying HTTP web request. - - - - - The HTTP method or verb. - - - - - The request URI. - - - - - Configures a request as per the request context. - - The request context. - - - - Sets the headers on the request. - - A dictionary of header names and values. - - - - Gets a handle to the request content. - - The request content. - - - - Returns the HTTP response. - - The HTTP response. - - - - Aborts the HTTP request. - - - - - Returns the HTTP response. - - A cancellation token that can be used to cancel the asynchronous operation. - - - - - Writes a stream to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - The request context. - - - - Writes a byte array to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - - - - Gets a handle to the request content. - - - - - - Disposes the HttpWebRequestMessage. - - - - - - - - - - - Sets up the progress listeners - - The content stream - The interval at which progress needs to be published - The objects which is trigerring the progress changes - The callback which will be invoked when the progress changed event is trigerred - an object, incase the progress is setup, else returns the original stream - - - - A retry policy specifies all aspects of retry behavior. This includes conditions when the request should be retried, - checks of retry limit, preparing the request before retry and introducing delay (backoff) before retries. - - - A retry policy specifies all aspects of retry behavior. This includes conditions when the request should be retried, - checks of retry limit, preparing the request before retry and introducing delay (backoff) before retries. - - - - - Maximum number of retries to be performed. - This does not count the initial request. - - - - - The logger used to log messages. - - - - - The standard set of throttling error codes - - - - - The standard set of timeout error codes to retry on. - - - - - List of AWS specific error codes which are returned as part of the error response. - These error codes will be retried. - - - - - The standard set of transient error, HTTP status codes to retry on. - 502 and 504 are returned by proxies. These can also be returned for - S3 accelerate requests which are served by CloudFront. - - - - - Set of web exception status codes to retry on. - - - - - This parameter serves as the value to the CapacityManager.Container datastructure. - Its properties include the available capacity left for making a retry request and the maximum - capacity size. - - - - - Checks if a retry should be performed with the given execution context and exception. - - The execution context which contains both the - requests and response context. - The exception thrown after issuing the request. - Returns true if the request should be retried, else false. The exception is retried if it matches with clockskew error codes. - - - - Returns true if the request is in a state where it can be retried, else false. - - The execution context which contains both the - requests and response context. - Returns true if the request is in a state where it can be retried, else false. - - - - Return true if the request should be retried for the given exception. - - The execution context which contains both the - requests and response context. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Checks if the retry limit is reached. - - The execution context which contains both the - requests and response context. - Return false if the request can be retried, based on number of retries. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called on a successful request response. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called before a retry request is initiated. The value - returned is True by default(retry throttling feature is disabled). - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called before a retry request is initiated. The value - returned is True by default(retry throttling feature is disabled). - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - - - - Virtual method that gets called before a retry request is initiated. The value - returned is True by default(retry throttling feature is disabled). - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - true if the error that will be retried is a throttling error - - - - This method uses a token bucket to enforce the maximum sending rate. - - The execution context which contains both the - requests and response context. - If the prior request failed, this exception is expected to be - the exception that occurred during the prior request failure. - - - - Determines if an AmazonServiceException is a throttling error - - The current exception to check. - true if it is a throttling error else false. - - - - Determines if an AmazonServiceException is a transient error that - should be retried. - - The current execution context - The current exception to check. - true if the exception is a transient error else false. - - - - Determines if the exception is a known timeout error code that - should be retried under the timeout error category. - - The current exception to check. - true if the exception is considered a timeout else false - - - - Checks if a retry should be performed with the given execution context and exception. - - The execution context which contains both the - requests and response context. - The exception throw after issuing the request. - Returns true if the request should be retried, else false. The exception is retried if it matches with clockskew error codes. - - - - This method uses a token bucket to enforce the maximum sending rate. - - The execution context which contains both the - requests and response context. - If the prior request failed, this exception is expected to be - the exception that occurred during the prior request failure. - - - - Return true if the request should be retried for the given exception. - - The execution context which contains both the - requests and response context. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - ICoreAmazonKMS is not meant to be used directly. It defines Key Management Service - with basic .NET types and allows other services to be able to use the service as - a runtime dependency. This interface is implemented by the AmazonKeyManagementServiceClient - defined in the AWSSDK.KeyManagementService assembly. - - - - - The result of the GenerateDataKey and GenerateDataKeyAsync operations. - - - - - The plaintext for the data key. - - - - - The ciphertext for the data key. - - - - - ICoreAmazonS3 is not meant to use directly. It defines S3 with basic .NET types - and allows other services to be able to use S3 as a runtime dependency. This interface - is implemented by the AmazonS3Client defined in the S3 assembly. - - - ICoreAmazonS3 is not meant to use directly. It defines S3 with basic .NET types - and allows other services to be able to use S3 as a runtime dependency. This interface - is implemented by the AmazonS3Client defined in the S3 assembly. - - - - - Generate a presigned URL. - - - - - - - - - - Get all the object keys for the particular bucket and key prefix. - - - - - - - - - Upload an object from a stream. - - - - - - - - - - - Delete an object. - - - - - - - - - - Delete an object. - - - - - - - - - - Open a stream to an object in S3. - - - - - - - - - - Upload an object from a file path. - - - - - - - - - - - Download an object in S3 to a file path. - - - - - - - - - - - Set the ACL on the object to public readable. - - - - - - - - Check to see if the bucket exists and if it doesn't create the bucket. - - - - - - Check to see if the bucket exists. - - - - - - - ICoreAmazonSQS is not meant to use directly. It defines SQS with basic .NET types - and allows other services to be able to use SQS as a runtime dependency. This interface - is implemented by the AmazonSQSClient defined in the SQS assembly. - - - - - Get the attributes for the queue identified by the queue URL asynchronously. - - The queue URL to get attributes for. - A Task containing the result of a dictionary of attributes for the queue. - - - - Set the attributes on the queue identified by the queue URL asynchronously. - - The queue URL to set the attributues. - The attributes to set. - A Task - - - - ICoreAmazonSTS is not meant to be used directly. It defines Security Token - service with basic .NET types and allows other services to be able to use the service as - a runtime dependency. This interface is implemented by the AmazonSecurityTokenServiceClient - defined in the AWSSDK.SecurityToken assembly. - - - - - - This method is used internally to access the Amazon Security Token - service within other service assemblies. - Please use AmazonSecurityTokenServiceClient to access the Amazon Security Token - service instead. - - Use Amazon Security Token Service to assume a role. - - Proxy settings that are required for the HTTPS and STS calls made during the authentication/credential - generation process are supported and should have been configured on the STS ClientConfig instance - associated with the STS client instance exposing this interface. - - - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRole. - - - - - CoreAmazonKMS is not meant to use directly. It implements ICoreAmazonKMS - and allows other service clients to be able to use the KMS service as a runtime dependency. - - This class waits until a method is actually called on the ICoreAmazonKMS interface - before requiring the KMS assembly to be present and loaded. - - - - - Settings for configuring a proxy for the SDK to use. - - - - - The host name or IP address of the proxy server. - - - - - The port number of the proxy. - - - - - The username to authenticate with the proxy server. - - - - - The password to authenticate with the proxy server. - - - - - Collection of one or more regular expressions denoting addresses - for which the proxy will not be used. - - - For more information on bypass lists - see https://msdn.microsoft.com/en-us/library/system.net.webproxy.bypasslist%28v=vs.110%29.aspx. - - - - - If true requests to local addresses bypass the configured - proxy. - - - - - Settings for logging in the SDK. - - - - - Logging destination. - - - - - When to log responses. - - - - - Gets or sets the size limit in bytes for logged responses. - If logging for response body is enabled, logged response - body is limited to this size. The default limit is 1KB. - - - - - Whether or not to log SDK metrics. - - - - - A custom formatter added through Configuration - - - - - This class can be used to discover the public address ranges for AWS. The - information is retrieved from the publicly accessible - https://ip-ranges.amazonaws.com/ip-ranges.json file. - - - The information in this file is generated from our internal system-of-record and - is authoritative. You can expect it to change several times per week and should - poll accordingly. - - - - - Region identifier string for ROUTE53 and CLOUDFRONT ranges - - - - - Collection of service keys found in the data file. - - - - - The publication date and time of the file that was downloaded and parsed. - - - - - Collection of all public IP ranges. - - - - - Filtered collection of public IP ranges for the given service key - - - - - Filtered collection of public IP ranges for the given region (us-east-1 etc) or GLOBAL. - - - - - Filtered collection of public IP ranges for the given network border group. - - - - - Downloads the most recent copy of the endpoint address file and - parses it to a collection of address range objects. - - - - - Downloads the most recent copy of the endpoint address file and - parses it to a collection of address range objects. - - - - - Represents the IP address range for a single region and service key. - - - - - The public IPv4 or Ipv6 address range, in CIDR notation. - - - - - Indicates ipv4 or v6 format of the address - - - - - The AWS region or GLOBAL for edge locations. Note that the CLOUDFRONT and ROUTE53 - ranges are GLOBAL. - - - - - The subset of IP address ranges. Specify AMAZON to get all IP address ranges - (for example, the ranges in the EC2 subset are also in the AMAZON subset). Note - that some IP address ranges are only in the AMAZON subset. - - - Valid values for the service key include "AMAZON", "EC2", "ROUTE53", - "ROUTE53_HEALTHCHECKS", and "CLOUDFRONT." If you need to know all of - the ranges and don't care about the service, use the "AMAZON" entries. - The other entries are subsets of this one. Also, some of the services, - such as S3, are represented in "AMAZON" and do not have an entry that - is specific to the service. We plan to add additional values over time; - code accordingly! - - - - - The network border group the IP address range belongs to. - - - AWS Local Zones allow you to seamlessly connect to the full range of services in the AWS Region such - as Amazon Simple Storage Service and Amazon DynamoDB through the same APIs and tool sets. You can extend - your VPC Region by creating a new subnet that has a Local Zone assignment. When you create a subnet in - a Local Zone, the VPC is also extended to that Local Zone. - - A network border group is a unique set of Availability Zones or Local Zones from where AWS advertises - public IP addresses. - - When you create a VPC that has IPv6 addresses, you can choose to assign a set of Amazon-provided public - IP addresses to the VPC and also set a network border group for the addresses that limits the addresses - to the group. When you set a network border group, the IP addresses cannot move between network - border groups. The us-west-2 network border group contains the four US West (Oregon) Availability Zones. - The us-west-2-lax-1 network border group contains the Los Angeles Local Zones. - - - - - This class defines utilities and constants that can be used by - all the client libraries of the SDK. - - - - - The user agent string header - - - - - The Set of accepted and valid Url characters per RFC3986. - Characters outside of this set will be encoded. - - - - - The Set of accepted and valid Url characters per RFC1738. - Characters outside of this set will be encoded. - - - - - The set of accepted and valid Url path characters per RFC3986. - - - - - The string representing Url Encoded Content in HTTP requests - - - - - The GMT Date Format string. Used when parsing date objects - - - - - The ISO8601Date Format string. Used when parsing date objects - - - - - The ISO8601Date Format string. Used when parsing date objects - - - - - The ISO8601 Basic date/time format string. Used when parsing date objects - - - - - The ISO8601 basic date format. Used during AWS4 signature computation. - - - - - The RFC822Date Format string. Used when parsing date objects - - - - - Returns an extension of a path. - This has the same behavior as System.IO.Path.GetExtension, but does not - check the path for invalid characters. - - - - - - Convert request parameters to Url encoded query string - - - Convert Dictionary of parameters to Url encoded query string - - - - Returns the canonicalized resource path for the service endpoint with single URL encoded path segments. - - Endpoint URL for the request - Resource path for the request - - If resourcePath begins or ends with slash, the resulting canonicalized - path will follow suit. - - Canonicalized resource path for the endpoint - - - - Returns the canonicalized resource path for the service endpoint - - Endpoint URL for the request - Resource path for the request - If true pre URL encode path segments if necessary. - S3 is currently the only service that does not expect pre URL encoded segments. - - If resourcePath begins or ends with slash, the resulting canonicalized - path will follow suit. - - Canonicalized resource path for the endpoint - - - - Returns the canonicalized resource path for the service endpoint - - Endpoint URL for the request - Resource path for the request - If true pre URL encode path segments if necessary. - S3 is currently the only service that does not expect pre URL encoded segments. - Dictionary of key/value parameters containing the values for the ResourcePath key replacements - The version of the marshaller that constructed the request object. - - If resourcePath begins or ends with slash, the resulting canonicalized - path will follow suit. - - Canonicalized resource path for the endpoint - - - - Splits the resourcePath at / into segments then resolves any keys with the path resource values. Greedy - key values will be split into multiple segments at each /. - - The patterned resourcePath - The key/value lookup for the patterned resourcePath - A list of path segments where all keys in the resourcePath have been resolved to one or more path segment values - - - - Joins all path segments with the / character and encodes each segment before joining. - - The segments of a URL path split at each / character - If the path property is specified, - the accepted path characters {/+:} are not encoded. - A joined URL with encoded segments - - - - Takes a patterned resource path and resolves it using the key/value path resources into - a segmented encoded URL. - - The patterned resourcePath - The key/value lookup for the patterned resourcePath - A segmented encoded URL - - - - Returns a new string created by joining each of the strings in the - specified list together, with a comma between them. - - The list of strings to join into a single, comma delimited - string list. - A new string created by joining each of the strings in the - specified list together, with a comma between strings. - - - - Attempt to infer the region for a service request based on the endpoint - - Endpoint to the service to be called - - Region parsed from the endpoint; DefaultRegion (or DefaultGovRegion) - if it cannot be determined/is not explicit - - - - - Attempt to infer the service name for a request (in short form, eg 'iam') from the - service endpoint. - - Endpoint to the service to be called - - Short-form name of the service parsed from the endpoint; empty string if it cannot - be determined - - - - - Utility method for converting Unix epoch seconds to DateTime structure. - - The number of seconds since January 1, 1970. - Converted DateTime structure - - - - Helper function to format a byte array into string - - The data blob to process - If true, returns hex digits in lower case form - String version of the data - - - - Calls a specific EventHandler in a background thread - - - - - - - - Parses a query string of a URL and returns the parameters as a string-to-string dictionary. - - - - - - - Utility method for converting a string to a MemoryStream. - - - - - - - Utility method for copy the contents of the source stream to the destination stream. - - - - - - - Utility method for copy the contents of the source stream to the destination stream. - - - - - - - - Formats the current date as a GMT timestamp - - A GMT formatted string representation - of the current date and time - - - - - Formats the current date as ISO 8601 timestamp - - An ISO 8601 formatted string representation - of the current date and time - - - - - Gets the ISO8601 formatted timestamp that is minutesFromNow - in the future. - - The number of minutes from the current instant - for which the timestamp is needed. - The ISO8601 formatted future timestamp. - - - - Formats the current date as ISO 8601 timestamp - - An ISO 8601 formatted string representation - of the current date and time - - - - - Gets the RFC822 formatted timestamp that is minutesFromNow - in the future. - - The number of minutes from the current instant - for which the timestamp is needed. - The ISO8601 formatted future timestamp. - - - - Determines whether the given string is an absolute path to a root. - - The hypothetical absolute path. - True if is an absolute path. - - - - Returns true if the path specified is relative to the current drive or working directory. - Returns false if the path is fixed to a specific drive or UNC path. This method does no - validation of the path (URIs will be returned as relative as a result). - - - Handles paths that use the alternate directory separator. It is a frequent mistake to - assume that rooted paths (Path.IsPathRooted) are not relative. This isn't the case. - "C:a" is drive relative- meaning that it will be resolved against the current directory - for C: (rooted, but relative). "C:\a" is rooted and not relative (the current directory - will not be used to modify the path). - - - - - True if the given character is a directory separator. - - - - - Returns true if the given character is a valid drive letter - - - - - URL encodes a string per RFC3986. If the path property is specified, - the accepted path characters {/+:} are not encoded. - - The string to encode - Whether the string is a URL path or not - The encoded string - - - - URL encodes a string per the specified RFC. If the path property is specified, - the accepted path characters {/+:} are not encoded. - - RFC number determing safe characters - The string to encode - Whether the string is a URL path or not - The encoded string - - Currently recognised RFC versions are 1738 (Dec '94) and 3986 (Jan '05). - If the specified RFC is not recognised, 3986 is used by default. - - - - - URL encodes a string per the specified RFC with the exception of preserving the encoding of previously encoded slashes. - If the path property is specified, the accepted path characters {/+:} are not encoded. - - The string to encode - Whether the string is a URL path or not - The encoded string with any previously encoded %2F preserved - - - - Convert bytes to a hex string - - Bytes to convert. - Hexadecimal string representing the byte array. - - - - Convert a hex string to bytes - - Hexadecimal string - Byte array corresponding to the hex string. - - - - Returns DateTime.UtcNow + ManualClockCorrection when - is set. - This value should be used instead of DateTime.UtcNow to factor in manual clock correction - - - - - Returns true if the string has any bidirectional control characters. - - - - - - - Executes an HTTP request and returns the response as a string. This method - throws WebException and HttpRequestException. In the event HttpRequestException - is thrown the StatusCode is sent as user defined data on the exception under - the key "StatusCode". - - The URI to make the request to - The request type: GET, PUT, POST - null or the content to send with the request - Timeout for the request - Proxy for the request - null or any headers to send with the request - The response as a string. - - - - Utility method that accepts a string and replaces white spaces with a space. - - - - - - - Class that contains result of executing an external process through the SDKs - AWSSDKUtils.RunProcess/AWSSDKUtils.RunProcessAsync - - - - - The exit code with which the process exited - - - - - The output of the process read till the end - - - - - The error output of the process read till the end - - - - - Object to track circular references in nested types. - At each level of nesting, make a call to Track to retrieve Tracker, - a tracking object implementing the IDisposable interface. - Dispose of this tracker when leaving the context of the tracked object. - - - - - Tracker. Must be disposed. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Adds the current target to a reference list and returns a tracker. - The tracker removes the target from the reference list when the - tracker is disposed. - - - - - - - Root AWS config - - - - - AwsHttpClient is a wrapper around HttpClient class of the System.Net.Http library. - The wrapper has been added so as to remove System.Net.Http dependencies from the Services - and migrate it to a Core level dependecy only. This avoids version clashes when a service - and the Core depends on different versions of the System.Net.Http library. This is a Service - level utility method - - - - - AWSHttpClient wrapper that is wrapped around - HttpClient default wrapper. - - - - - AWSHttpClient BaseAddress property that is wrapper for - HttpClient BaseAddress property. - - - - - AWSHttpClient Timeout property that is wrapper for - HttpClient Timeout property. - - - - - AWSHttpClient MaxResponseContentBufferSize property that is wrapper for - HttpClient MaxResponseContentBufferSize property. - - - - - AWSHttpClient GetStreamAsync that accepts the requester's URI - and make a HttpClient.GetStreamAsync call. - - Requester Uri - - - - Wrapper method that accepts a request uri, stream content and headers and makes a sendAsync call. - - - - - - - Wrapper for HttpClient's HttpRequestMessage and SendAsync methods. - - - - Returns response headers information- header name,value and status code - - - - Wrapper for HttpClient Dispose. - - - - - Method that checks if the passed exception is of type - HttpRequestException - - - - - - - AWSStreamContent is a wrapper for StreamContent class in - the System.Net.Http library.The wrapper has been added so as to - remove System.Net.Http dependencies from the Services - and migrate it to a Core level dependecy only. This avoids version clashes when a service - and the Core depends on different versions of the System.Net.Http library. This is a Service - level utility method - - - - - Wrapper for StreamContent constructor - for stream content - - - - - - Wrapper for StreamContent constructor - for stream content and bufferSize - - - - - - - Wrapper to allow Services to remove StreamContent Headers - - - - - - - Wrapper to allow Services to add StreamContent Headers - - - - - - - Wrapper for StreamContent Dispose. - - - - - Allows to configure the proxy used for HTTP requests. The default value is null. - - - - - This class contains the endpoints available to the AWS clients. The static constants representing the - regions can be used while constructing the AWS client instead of looking up the exact endpoint URL. - - - - - Gets the endpoint for a service in a region. - - The services system name. - If true returns the endpoint for dualstack - Thrown when the request service does not have a valid endpoint in the region. - - - - - Enumerate through all the regions. - - - - - Gets the region based on its system name like "us-west-1" - - The system name of the service like "us-west-1" - - - - - This is a testing method and should not be called by production applications. - - - - - Gets the system name of a region. - - - - - Gets the display name of a region. - - - - - This region name is non-standard. Search the whole endpoints.json file to - determine the partition this region is in. - - - - - This class contains region information used to lazily compute the service endpoints. The static constants representing the - regions can be used while constructing the AWS client instead of looking up the exact endpoint URL. - - - - - The US East (Virginia) endpoint. - - - - - The US East (Virginia) regional endpoint. - - - - - The US East (Ohio) endpoint. - - - - - The US West (N. California) endpoint. - - - - - The US West (Oregon) endpoint. - - - - - The EU North (Stockholm) endpoint. - - - - - The EU West (Ireland) endpoint. - - - - - The EU West (London) endpoint. - - - - - The EU West (Paris) endpoint. - - - - - The EU Central (Frankfurt) endpoint. - - - - - The Europe (Milan) endpoint. - - - - - The Asia Pacific (Hong Kong) endpoint. - - - - - The Asia Pacific (Tokyo) endpoint. - - - - - The Asia Pacific (Seoul) endpoint. - - - - - The Asia Pacific (Osaka-Local) endpoint. - - - - - The Asia Pacific (Mumbai) endpoint. - - - - - The Asia Pacific (Singapore) endpoint. - - - - - The Asia Pacific (Sydney) endpoint. - - - - - The South America (Sao Paulo) endpoint. - - - - - The US GovCloud East (Virginia) endpoint. - - - - - The US GovCloud West (Oregon) endpoint. - - - - - The China (Beijing) endpoint. - - - - - The China (Ningxia) endpoint. - - - - - The Canada (Central) endpoint. - - - - - The Middle East (Bahrain) endpoint. - - - - - The Africa (Cape Town) endpoint. - - - - - Represents the endpoint overridding rules in the endpoints.json - Is used to map private region (ie us-east-1-regional) to public regions (us-east-1) - For signing purposes. - - - - - Enumerate through all the regions. - - - - - Gets the region based on its system name like "us-west-1" - - The system name of the service like "us-west-1" - - - - - Gets the region endpoint override if exists - - The region endpoint to find the possible override for - - - - - Gets the system name of a region. - - - - - Gets the display name of a region. - - - - - Gets the partition name the region is in. For example for us-east-1 the partition name is aws. For cn-northwest-1 the partition name is aws-cn. - - - - - Gets the dns suffix for the region endpoints in a partition. For example the aws partition's suffix is amazonaws.com. The aws-cn partition's suffix is amazonaws.com.cn. - - - - - Gets the endpoint for a service in a region. - - - The services system name. Service system names can be obtained from the - RegionEndpointServiceName member of the ClientConfig-derived class for the service. - - - For forwards compatibility, if the service being requested for isn't known in the region, this method - will generate an endpoint using the AWS endpoint heuristics. In this case, it is not guaranteed the - endpoint will point to a valid service endpoint. - - - - - - Gets the endpoint for a service in a region, optionally selecting a dualstack compatible endpoint. - - - The services system name. Service system names can be obtained from the - RegionEndpointServiceName member of the ClientConfig-derived class for the service. - - - If true a dualstack endpoint is returned. It is the user's responsibility to verify that the given service - supports a dualstack endpoint for the region. - - - For forwards compatibility, if the service being requested for isn't known in the region, this method - will generate an endpoint using the AWS endpoint heuristics. In this case, it is not guaranteed the - endpoint will point to a valid service endpoint. - - - - - - This class defines an endpoints hostname and which protocols it supports. - - - - - Gets the hostname for the service. - - - - - The authentication region to be used in request signing. - - - - - This property is only set for S3 endpoints. For all other services this property returns null. - For S3 endpoints, if the endpoint supports signature version 2 this property will be "2", otherwise it will be "4". - - - - - Calculates a 32bit Cyclic Redundancy Checksum (CRC) using the - same polynomial used by Zip. This type is used internally by DotNetZip; it is generally not used directly - by applications wishing to create, read, or manipulate zip archive files. - - - - - indicates the total number of bytes read on the CRC stream. - This is used when writing the ZipDirEntry when compressing files. - - - - - Indicates the current CRC for all blocks slurped in. - - - - - Returns the CRC32 for the specified stream. - - The stream over which to calculate the CRC32 - the CRC32 calculation - - - - Returns the CRC32 for the specified stream, and writes the input into the output stream. - - The stream over which to calculate the CRC32 - The stream into which to deflate the input - the CRC32 calculation - - - - Get the CRC32 for the given (word,byte) combo. - This is a computation defined by PKzip. - - The word to start with. - The byte to combine it with. - The CRC-ized result. - - - - Update the value for the running CRC32 using the given block of bytes. - This is useful when using the CRC32() class in a Stream. - - block of bytes to slurp - starting point in the block - how many bytes within the block to slurp - - - - A Stream that calculates a CRC32 (a checksum) on all bytes read, - or on all bytes written. - - - - - This class can be used to verify the CRC of a ZipEntry when reading from a stream, - or to calculate a CRC when writing to a stream. The stream should be used to either - read, or write, but not both. If you intermix reads and writes, the results are - not defined. - - This class is intended primarily for use internally by the DotNetZip library. - - - - - Gets the total number of bytes run through the CRC32 calculator. - - - - This is either the total number of bytes read, or the total number - of bytes written, depending on the direction of this stream. - - - - - The constructor. - - The underlying stream - - - - The constructor. - - The underlying stream - The length of the stream to slurp - - - - Provides the current CRC for all blocks slurped in. - - - - - Read from the stream - - the buffer to read - the offset at which to start - the number of bytes to read - the number of bytes actually read - - - - Write to the stream. - - the buffer from which to write - the offset at which to start writing - the number of bytes to write - - - - Indicates whether the stream supports reading. - - - - - Indicates whether the stream supports seeking. - - - - - Indicates whether the stream supports writing. - - - - - Flush the stream. - - - - - Not implemented. - - - - - Not implemented. - - - - - Not implemented. - - N/A - N/A - N/A - - - - Not implemented. - - N/A - - - diff --git a/packages/AWSSDK.Core.3.3.107.14/lib/win8/AWSSDK.Core.dll b/packages/AWSSDK.Core.3.3.107.14/lib/win8/AWSSDK.Core.dll deleted file mode 100644 index e3b57c3..0000000 Binary files a/packages/AWSSDK.Core.3.3.107.14/lib/win8/AWSSDK.Core.dll and /dev/null differ diff --git a/packages/AWSSDK.Core.3.3.107.14/lib/wp8/AWSSDK.Core.XML b/packages/AWSSDK.Core.3.3.107.14/lib/wp8/AWSSDK.Core.XML deleted file mode 100644 index 5323a9e..0000000 --- a/packages/AWSSDK.Core.3.3.107.14/lib/wp8/AWSSDK.Core.XML +++ /dev/null @@ -1,10800 +0,0 @@ - - - - AWSSDK.Core - - - - - Utility class to parse Amazon resource names more commonly known as an ARN. - - - - - Gets and sets the partition associated with the ARN (e.g.: 'aws'). - - - - - Gets and sets the AWS service associated with the ARN (e.g.: 's3'). - - - - - Gets and sets the region associated with the ARN (e.g.: 'us-east-1'). - - - - - Gets and sets the account ID associated with the ARN. - - - - - Gets and sets the resource associated with the ARN (e.g.: 'mybucket/myobject'). - - - - - Returns true if the string appears to be an ARN by seeing if the string starts with "arn:". This method - doesn't guarantee the string is a valid ARN. To validate the string call TryParse. - - - - - - - Parses the string into an ARN object. - - String to parse into an ARN. - The out parameter for the ARN object created by TryParse. - True if the string was parsed into an ARN object. - - - - Parses the string into an ARN object. - - String to parse into an Arn. - The Arn object created from the passed in string. - Thrown if arnString is null. - Thrown if the string passed in not valid ARN. - - - - Turns the Arn object into a string representation of an ARN. - - - - - - Configuration options that apply to the entire SDK. - - These settings can be configured through app.config or web.config. - Below is a full sample configuration that illustrates all the possible options. - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws region="us-west-2"> - <logging logTo="Log4Net, SystemDiagnostics" logResponses="Always" logMetrics="true" /> - <s3 useSignatureVersion4="true" /> - <proxy host="localhost" port="8888" username="1" password="1" /> - - <dynamoDB> - <dynamoDBContext tableNamePrefix="Prod-"> - - <tableAliases> - <alias fromTable="FakeTable" toTable="People" /> - <alias fromTable="Persons" toTable="People" /> - </tableAliases> - - <mappings> - <map type="Sample.Tests.Author, SampleDLL" targetTable="People" /> - <map type="Sample.Tests.Editor, SampleDLL" targetTable="People"> - <property name="FullName" attribute="Name" /> - <property name="EmployeeId" attribute="Id" /> - <property name="ComplexData" converter="Sample.Tests.ComplexDataConverter, SampleDLL" /> - <property name="Version" version="true" /> - <property name="Password" ignore="true" /> - </map> - </mappings> - - </dynamoDBContext> - </dynamoDB> - </aws> - - - - Configuration options that apply to the entire SDK. - - - - - Manual offset to apply to client clock. This is a global setting that overrides - ClockOffset value calculated for all service endpoints. - - - - - Determines if the SDK should correct for client clock skew - by determining the correct server time and reissuing the - request with the correct time. - Default value of this field is True. - will be updated with the calculated - offset even if this field is set to false, though requests - will not be corrected or retried. - Ignored if is set. - - - - - The calculated clock skew correction, if there is one. - This field will be set if a service call resulted in an exception - and the SDK has determined that there is a difference between local - and server times. - - If is set to true, this - value will be set to the correction, but it will not be used by the - SDK and clock skew errors will not be retried. - - - - - Key for the AWSRegion property. - - - - - - Configures the default AWS region for clients which have not explicitly specified a region. - Changes to this setting will only take effect for newly constructed instances of AWS clients. - - This setting can be configured through the App.config. For example: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws region="us-west-2" /> - - - - - - Key for the AWSProfileName property. - - - - - - Profile name for stored AWS credentials that will be used to make service calls. - Changes to this setting will only take effect in newly-constructed clients. - - To reference the account from an application's App.config or Web.config use the AWSProfileName setting. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="development"/> - </appSettings> - </configuration> - - - - - - - Key for the AWSProfilesLocation property. - - - - - - Location of the credentials file shared with other AWS SDKs. - By default, the credentials file is stored in the .aws directory in the current user's home directory. - - Changes to this setting will only take effect in newly-constructed clients. - - To reference the profile from an application's App.config or Web.config use the AWSProfileName setting. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfilesLocation" value="c:\config"/> - </appSettings> - </configuration> - - - - - - - Key for the Logging property. - - - - - - Configures how the SDK should log events, if at all. - Changes to this setting will only take effect in newly-constructed clients. - - The setting can be configured through App.config, for example: - - <appSettings> - <add key="AWSLogging" value="log4net"/> - </appSettings> - - - - - - Key for the ResponseLogging property. - - - - - - - Configures when the SDK should log service responses. - Changes to this setting will take effect immediately. - - The setting can be configured through App.config, for example: - - <appSettings> - <add key="AWSResponseLogging" value="OnError"/> - </appSettings> - - - - - - Key for the LogMetrics property. - - - - - - Configures if the SDK should log performance metrics. - This setting configures the default LogMetrics property for all clients/configs. - Changes to this setting will only take effect in newly-constructed clients. - - The setting can be configured through App.config, for example: - - <appSettings> - <add key="AWSLogMetrics" value="true"/> - </appSettings> - - - - - - Key for the EndpointDefinition property. - - - - - - Configures if the SDK should use a custom configuration file that defines the regions and endpoints. - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws endpointDefinition="c:\config\endpoints.json" /> - - - - - - Key for the UseSdkCache property. - - - - - - Configures if the SDK Cache should be used, the default value is true. - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws useSdkCache="true" /> - - - - - - Configuration for the Logging section of AWS configuration. - Changes to some settings may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws> - <logging logTo="Log4Net, SystemDiagnostics" logResponses="Always" logMetrics="true" /> - </aws> - - - - - - Configuration for the Proxy section of AWS configuration. - Changes to some settings may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws> - <proxy host="localhost" port="8888" username="1" password="1" bypassList="addressexpr1;addressexpr2;..." bypassOnLocal="true" /> - </aws> - - - - - - Configuration for the region endpoint section of AWS configuration. - Changes may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws region="us-west-2" /> - - - - - - Lock for SomeEvent delegate access. - - - - - This method should never be called directly. - Call AWSSDKUtils.CorrectedUtcNow instead. - - - - - - Logging options. - Can be combined to enable multiple loggers. - - - - - No logging - - - - - Log using log4net - - - - - Log using System.Diagnostics - - - - - Log to the console - - - - - Log to a file - - - - - Response logging option. - - - - - Never log service response - - - - - Only log service response when there's an error - - - - - Always log service response - - - - - Format for metrics data in the logs - - - - - Emit metrics in human-readable format - - - - - Emit metrics as JSON data - - - - - An access control policy action identifies a specific action in a service - that can be performed on a resource. For example, sending a message to a - queue. - - ActionIdentifiers allow you to limit what your access control policy statement affects. - For example, you could create a policy statement that enables a certain group - of users to send messages to your queue, but not allow them to perform any - other actions on your queue. - - - The action is B in the statement - "A has permission to do B to C where D applies." - - Free form access control policy actions may include a wildcard (*) to match - multiple actions. - - - Constants for known actions can be found in the Amazon.Auth.AccessControlPolicy.ActionIdentifiers namespace. - - - - - - Constructs an Actionidentifer with the given action name. - - The name of the action - - - - Gets and sets the name of this action. For example, 'sqs:SendMessage' is the - name corresponding to the SQS action that enables users to send a message - to an SQS queue. - - - - - AWS access control policy conditions are contained in - objects, and affect when a statement is applied. For example, a statement - that allows access to an Amazon SQS queue could use a condition to only apply - the effect of that statement for requests that are made before a certain - date, or that originate from a range of IP addresses. - - Multiple conditions can be included in a single statement, and all conditions - must evaluate to true in order for the statement to take effect. - - - The set of conditions is D in the statement - "A has permission to do B to C where D applies." - - - A condition is composed of three parts: - - - Condition Key - The condition key declares which value of a - request to pull in and compare against when a policy is evaluated by AWS. For - example, using will cause - AWS to pull in the current request's source IP as the first value to compare - against every time your policy is evaluated. - - - - Comparison Type - This is a static value used as the second value - in the comparison when your policy is evaluated. Depending on the comparison - type, this value can optionally use wildcards. See the documentation for - individual comparison types for more information. - - - - Comparison Value - This is a static value used as the second value - in the comparison when your policy is evaluated. Depending on the comparison - type, this value can optionally use wildcards. See the documentation for - individual comparison types for more information. - - - - - - - - - Gets the type of this condition. - - - - - Gets and Sets the name of the condition key involved in this condition. - Condition keys are predefined values supported by AWS that provide input - to a condition's evaluation, such as the current time, or the IP address - of the incoming request. - - Your policy is evaluated for each incoming request, and condition keys - specify what information to pull out of those incoming requests and plug - into the conditions in your policy. - - - - - - Gets and Sets the values specified for this access control policy condition. - For example, in a condition that compares the incoming IP address of a - request to a specified range of IP addresses, the range of IP addresses - is the single value in the condition. - - Most conditions accept only one value, but multiple values are possible. - - - - - - A factory for creating conditions to be used in the policy. - - - - - Condition key for the current time. - - This condition key should only be used with enum. - - - - - - Condition key for whether or not an incoming request is using a secure - transport to make the request (i.e. HTTPS instead of HTTP). - - This condition key should only be used with the boolean overload of NewCondition. - - - - - - Condition key for the source IP from which a request originates. - - This condition key should only be used with enum. - - - - - - Condition key for the user agent included in a request. - - This condition key should only be used with - enum. - - - - - - Condition key for the current time, in epoch seconds. - - This condition key should only be used with enum. - objects. - - - - - - Condition key for the referrer specified by a request. - - This condition key should only be used with - objects. - - - - - - Condition key for the Amazon Resource Name (ARN) of the source specified - in a request. The source ARN indicates which resource is affecting the - resource listed in your policy. For example, an SNS topic is the source - ARN when publishing messages from the topic to an SQS queue. - - This condition key should only be used with enum. - - - - - - Enumeration of the supported ways an ARN comparison can be evaluated. - - - - Exact matching - - - - Loose case-insensitive matching of the ARN. Each of the six - colon-delimited components of the ARN is checked separately and each - can include a multi-character match wildcard (*) or a - single-character match wildcard (?). - - - - Negated form of ArnEquals - - - Negated form of ArnLike - - - - Enumeration of the supported ways a date comparison can be evaluated. - - - - - Enumeration of the supported ways an IP address comparison can be evaluated. - - - - - Matches an IP address against a CIDR IP range, evaluating to true if - the IP address being tested is in the condition's specified CIDR IP - range. - - - - - Negated form of IpAddress - - - - - Enumeration of the supported ways a numeric comparison can be evaluated - - - - - Enumeration of the supported ways a string comparison can be evaluated. - - - - - Case-sensitive exact string matching - - - - - Case-insensitive string matching - - - - - Loose case-insensitive matching. The values can include a - multi-character match wildcard (*) or a single-character match - wildcard (?) anywhere in the string. - - - - - Negated form of StringEquals. - - - - - Negated form of StringEqualsIgnorecase. - - - - - Negated form of StringLike. - - - - - Constructs a new access control policy condition that compares ARNs (Amazon Resource Names). - - The access policy condition key specifying where to get the first ARN for the comparison - The type of comparison to perform. - The second ARN to compare against. When using ArnLike or ArnNotLike this may contain the - multi-character wildcard (*) or the single-character wildcard - - - - Constructs a new access policy condition that performs a boolean - comparison. - - The access policy condition key specifying where to get the - first boolean value for the comparison (ex: aws:SecureTransport). - The boolean to compare against. - - - - This method is deprecated. Invoking this method results in non-UTC DateTimes - not being marshalled correctly. Use NewConditionUtc instead. - Constructs a new access policy condition that compares the current time - (on the AWS servers) to the specified date. - - The type of comparison to perform. For example, - DateComparisonType.DateLessThan will cause this policy - condition to evaluate to true if the current date is less than - the date specified in the second argument. - The date to compare against. - - - - Constructs a new access policy condition that compares the current time - (on the AWS servers) to the specified date. - - The type of comparison to perform. For example, - DateComparisonType.DateLessThan will cause this policy - condition to evaluate to true if the current date is less than - the date specified in the second argument. - The date to compare against. - - - - Constructs a new access policy condition that compares the source IP - address of the incoming request to an AWS service against the specified - CIDR range. The condition evaluates to true (meaning the policy statement - containing it will be applied) if the incoming source IP address is - within that range. - - To achieve the opposite effect (i.e. cause the condition to evaluate to - true when the incoming source IP is not in the specified CIDR - range) use the alternate constructor form and specify - IpAddressComparisonType.NotIpAddress. - - - The CIDR IP range involved in the policy condition. - - - - Constructs a new access policy condition that compares the source IP - address of the incoming request to an AWS service against the specified - CIDR range. When the condition evaluates to true (i.e. when the incoming - source IP address is within the CIDR range or not) depends on the - specified IpAddressComparisonType. - - The type of comparison to to perform. - The CIDR IP range involved in the policy condition. - - - - Constructs a new access policy condition that compares two numbers. - - The type of comparison to perform. - The access policy condition key specifying where to get the - first number for the comparison. - The second number to compare against. - - - - Constructs a new access control policy condition that compares two - strings. - - The type of comparison to perform - The access policy condition key specifying where to get the - first string for the comparison (ex: aws:UserAgent). - - The second string to compare against. When using - StringComparisonType.StringLike or - StringComparisonType.StringNotLike this may contain - the multi-character wildcard (*) or the single-character - wildcard (?). - - - - - Constructs a new access policy condition that compares the Amazon - Resource Name (ARN) of the source of an AWS resource that is modifying - another AWS resource with the specified pattern. - - For example, the source ARN could be an Amazon SNS topic ARN that is - sending messages to an Amazon SQS queue. In that case, the SNS topic ARN - would be compared the ARN pattern specified here. - - - The endpoint pattern may optionally contain the multi-character wildcard - * (*) or the single-character wildcard (?). Each of the six colon-delimited - components of the ARN is checked separately and each can include a - wildcard. - - - Policy policy = new Policy("MyQueuePolicy"); - policy.WithStatements(new Statement(Statement.StatementEffect.Allow) - .WithPrincipals(new Principal("*")).WithActionIdentifiers(SQSActionIdentifiers.SendMessage) - .WithResources(new Resource(myQueueArn)) - .WithConditions(ConditionFactory.NewSourceArnCondition(myTopicArn))); - - - The ARN pattern against which the source ARN will be compared. - Each of the six colon-delimited components of the ARN is - checked separately and each can include a wildcard. - A new access control policy condition that compares the ARN of - the source specified in an incoming request with the ARN pattern - specified here. - - - - Constructs a new access control policy condition that tests if the - incoming request was sent over a secure transport (HTTPS). - - A new access control policy condition that tests if the incoming - request was sent over a secure transport (HTTPS). - - - - Condition key for the canned ACL specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the location constraint specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the prefix specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the delimiter specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the max keys specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the source object specified by a request to copy an - object. - - This condition key may only be used with enum. - - - - - - Condition key for the metadata directive specified by a request to copy - an object. - - This condition key may only be used with enum. - - - - - - Condition key for the version ID of an object version specified by a - request. - - This condition key may only be used with enum. - - - - - - Constructs a new access policy condition that compares an Amazon S3 - canned ACL with the canned ACL specified by an incoming request. - - You can use this condition to ensure that any objects uploaded to an - Amazon S3 bucket have a specific canned ACL set. - - - The Amazon S3 canned ACL to compare against. - A new access control policy condition that compares the Amazon S3 - canned ACL specified in incoming requests against the value - specified. - - - - Condition key for The URL, e-mail address, or ARN from a Subscribe - request or a previously confirmed subscription. Use with string - conditions to restrict access to specific endpoints (e.g., - *@mycompany.com). - - This condition key may only be used with enum. - - - - - - Condition key for the protocol value from a Subscribe request or a - previously confirmed subscription. Use with string conditions to restrict - publication to specific delivery protocols (e.g., HTTPS). - - This condition key may only be used with enum. - - - - - - Constructs a new access policy condition that compares the requested - endpoint used to subscribe to an Amazon SNS topic with the specified - endpoint pattern. The endpoint pattern may optionally contain the - multi-character wildcard (*) or the single-character wildcard (?). - - For example, this condition can restrict subscriptions to a topic to - email addresses in a certain domain ("*@my-company.com"). - - - Policy policy = new Policy("MyTopicPolicy"); - policy.WithStatements(new Statement(Statement.StatementEffect.Allow) - .WithPrincipals(new Principal("*")).WithActionIdentifiers(SNSActionIdentifiers.Subscribe) - .WithResources(new Resource(myTopicArn)) - .WithConditions(ConditionFactory.NewEndpointCondition("*@my-company.com"))); - - - The endpoint pattern against which to compare the requested - endpoint for an Amazon SNS topic subscription. - A new access control policy condition that compares the endpoint - used in a request to subscribe to an Amazon SNS topic with the - endpoint pattern specified. - - - - Constructs a new AWS access control policy condition that allows an - access control statement to restrict subscriptions to an Amazon SNS topic - based on the protocol being used for the subscription. For example, this - condition can restrict subscriptions to a topic to endpoints using HTTPS - to ensure that messages are securely delivered. - - The protocol against which to compare the requested protocol - for an Amazon SNS topic subscription. - A new access control policy condition that compares the - notification protocol requested in a request to subscribe to an - Amazon SNS topic with the protocol value specified. - - - - An AWS access control policy is a object that acts as a container for one or - more statements, which specify fine grained rules for allowing or denying - various types of actions from being performed on your AWS resources. - - By default, all requests to use your resource coming from anyone but you are - denied. Access control polices can override that by allowing different types - of access to your resources, or by explicitly denying different types of - access. - - - Each statement in an AWS access control policy takes the form: - "A has permission to do B to C where D applies". - - - A is the prinicpal - The AWS account that is making a request to - access or modify one of your AWS resources. - - - - B is the action - the way in which your AWS resource is being accessed or modified, such - as sending a message to an Amazon SQS queue, or storing an object in an Amazon S3 bucket. - - - - C is the resource - your AWS entity that the principal wants to access, such - as an Amazon SQS queue, or an object stored in Amazon S3. - - - - D is the set of conditions - optional constraints that specify when to allow or deny - access for the principal to access your resource. Many expressive conditions are available, - some specific to each service. For example you can use date conditions to allow access to - your resources only after or before a specific time. - - - - - - Note that an AWS access control policy should not be confused with the - similarly named "POST form policy" concept used in Amazon S3. - - - - - - The default policy version - - - - - Constructs an empty AWS access control policy ready to be populated with - statements. - - - - - Constructs a new AWS access control policy with the specified policy ID. - The policy ID is a user specified string that serves to help developers - keep track of multiple polices. Policy IDs are often used as a human - readable name for a policy. - - The policy ID for the new policy object. Policy IDs serve to - help developers keep track of multiple policies, and are often - used to give the policy a meaningful, human readable name. - - - - Constructs a new AWS access control policy with the specified policy ID - and collection of statements. The policy ID is a user specified string - that serves to help developers keep track of multiple polices. Policy IDs - are often used as a human readable name for a policy. - - The policy ID for the new policy object. Policy IDs serve to - help developers keep track of multiple policies, and are often - used to give the policy a meaningful, human readable name. - The statements to include in the new policy. - - - - Gets and Sets the policy ID for this policy. Policy IDs serve to help - developers keep track of multiple policies, and are often used as human - readable name for a policy. - - - - - Sets the policy ID for this policy and returns the updated policy so that - multiple calls can be chained together. - - Policy IDs serve to help developers keep track of multiple policies, and - are often used as human readable name for a policy. - - - The polich ID for this policy - this instance - - - - Gets and sets the version of this AWS policy. - - - - - Gets and Sets the collection of statements contained by this policy. Individual - statements in a policy are what specify the rules that enable or disable - access to your AWS resources. - - - - - Checks to see if the permissions set in the statement are already set by another - statement in the policy. - - The statement to verify - True if the statement's permissions are already allowed by the statement - - - - Sets the collection of statements contained by this policy and returns - this policy object so that additional method calls can be chained - together. - - Individual statements in a policy are what specify the rules that enable - or disable access to your AWS resources. - - - The collection of statements included in this policy. - this instance - - - - Returns a JSON string representation of this AWS access control policy, - suitable to be sent to an AWS service as part of a request to set an - access control policy. - - A JSON string representation of this AWS access control policy. - - - - Returns a JSON string representation of this AWS access control policy, - suitable to be sent to an AWS service as part of a request to set an - access control policy. - - Toggle pretty print for the generated JSON document - A JSON string representation of this AWS access control policy. - - - - Parses a JSON document of a policy and creates a Policy object. - - JSON document of a policy. - - - - - A principal is an AWS account which is being allowed or denied access to a - resource through an access control policy. The principal is a property of the - Statement object, not directly the object. - - The principal is A in the statement - "A has permission to do B to C where D applies." - - - In an access control policy statement, you can set the principal to all - authenticated AWS users through the member. This - is useful when you don't want to restrict access based on the identity of the - requester, but instead on other identifying characteristics such as the - requester's IP address. - - - - - - Principal instance that includes all authenticated AWS users. - - This is useful when you don't want to restrict access based on the - identity of the requester, but instead on other identifying - characteristics such as the requester's IP address. - - - - - - The anonymous Principal. - - - - - The default Principal provider for AWS accounts. - - - - - Principal provider for Canonical User IDs. - - - - - Principal provider for federated users (using a SAML identity provider) - - - - - Principal provider for assume role policies that will be assumed by an AWS service - (e.g. "ec2.amazonaws.com"). - - - - - Dummy principal provider for anonynous. - - - - - Constructs a new principal with the specified AWS account ID. - - An AWS account ID. - - - - Constructs a new principal with the specified provider and id - - The provider of the principal - The unique ID of the Principal within the provider - - - - Constructs a new principal with the specified provider and id - and optionally strips hyphens from the id - - The provider of the principal - The unique ID of the Principal within the provider - Strip hyphen - - - - Gets and sets the provider for this principal, which indicates in what group of - users this principal resides. - - - - - Gets the unique ID for this principal. - - - - - Represents a resource involved in an AWS access control policy statement. - Resources are the service specific AWS entities owned by your account. Amazon - SQS queues, Amazon S3 buckets and objects, and Amazon SNS topics are all - examples of AWS resources. - - The standard way of specifying an AWS resource is with an Amazon Resource - Name (ARN). - - - The resource is C in the statement - "A has permission to do B to C where D applies." - - - - - - Constructs a new AWS access control policy resource. Resources are - typically specified as Amazon Resource Names (ARNs). - - You specify the resource using the following Amazon Resource Name (ARN) - format: arn:aws:<vendor>:<region>:<namespace>:<relative-id> - - - >vendor identifies the AWS product (e.g., sns) - - - region is the AWS Region the resource resides in (e.g., us-east-1), if any - - - namespace is the AWS account ID with no hyphens (e.g., 123456789012) - - - relative-id is the service specific portion that identifies the specific resource - - - - - For example, an Amazon SQS queue might be addressed with the following - ARN: arn:aws:sqs:us-east-1:987654321000:MyQueue - - - Some resources may not use every field in an ARN. For example, resources - in Amazon S3 are global, so they omit the region field: - arn:aws:s3:::bucket/* - - - The Amazon Resource Name (ARN) uniquely identifying the desired AWS resource. - - - - Gets the resource ID, typically an Amazon Resource Name (ARN), - identifying this resource. - - - - - A factory for creating resources to be used in the policy. - - - - - Constructs a new bucket resource that represents the the specified bucket - but not any of the contained objects. - - The name of the bucket represented by this AWS access control - policy resource. - - - - Constructs a new object resource that represents the specified objects. - The keyPattern argument may contain the '*' wildcard to match multiple - objects. For example, an object resource created for bucket 'mybucket' - and key pattern 'foo*' will match any object stored in 'mybucket' with a - key that starts with 'foo'. - - The name of the bucket containing the object or objects - represented by this resource. - The key or key pattern, which can optionally contain the '*' - wildcard to include multiple objects in the resource. - - - - Constructs a new SQS queue resource for an access control policy. A - policy statement using this resource will allow or deny actions on the - specified queue. - - The AWS account ID of the queue owner. - The name of the Amazon SQS queue. - - - - A statement is the formal description of a single permission, and is always - contained within a policy object. - - A statement describes a rule for allowing or denying access to a specific AWS - resource based on how the resource is being accessed, and who is attempting - to access the resource. Statements can also optionally contain a list of - conditions that specify when a statement is to be honored. - - - For example, consider a statement that: - - - A is the prinicpal - The AWS account that is making a request to - access or modify one of your AWS resources. - - - - B is the action - the way in which your AWS resource is being accessed or modified, such - as sending a message to an Amazon SQS queue, or storing an object in an Amazon S3 bucket. - - - - C is the resource - your AWS entity that the principal wants to access, such - as an Amazon SQS queue, or an object stored in Amazon S3. - - - - D is the set of conditions - optional constraints that specify when to allow or deny - access for the principal to access your resource. Many expressive conditions are available, - some specific to each service. For example you can use date conditions to allow access to - your resources only after or before a specific time. - - - - - - There are many resources and conditions available for use in statements, and - you can combine them to form fine grained custom access control polices. - - - - - - The effect is the result that you want a policy statement to return at - evaluation time. A policy statement can either allow access or explicitly - deny access. - - - - - Constructs a new access control policy statement with the specified - effect. - - Before a statement is valid and can be sent to AWS, callers must set the - principals, resources, and actions (as well as any optional conditions) - involved in the statement. - - - The effect this statement has (allowing access or denying - access) when all conditions, resources, principals, and - actions are matched. - - - - Gets and Sets the ID for this statement. Statement IDs serve to help keep track - of multiple statements, and are often used to give the statement a - meaningful, human readable name. - - Developers should be careful to not use the same statement ID for - multiple statements in the same policy. Reusing the same statement ID in - different policies is not a problem. - - - - - - Sets the ID for this statement and returns the updated statement so - multiple calls can be chained together. - - Statement IDs serve to help keep track of multiple statements, and are - often used to give the statement a meaningful, human readable name. - - - Developers should be careful to not use the same statement ID for - multiple statements in the same policy. Reusing the same statement ID in - different policies is not a problem. - - - The new statement ID for this statement. - this instance - - - - Gets and Sets the result effect of this policy statement when it is evaluated. - A policy statement can either allow access or explicitly - - - - - Gets and Sets the list of actions to which this policy statement applies. - Actions limit a policy statement to specific service operations that are - being allowed or denied by the policy statement. For example, you might - want to allow any AWS user to post messages to your SQS queue using the - SendMessage action, but you don't want to allow those users other actions - such as ReceiveMessage or DeleteQueue. - - - - - Sets the list of actions to which this policy statement applies and - returns this updated Statement object so that additional method calls can - be chained together. - - Actions limit a policy statement to specific service operations that are - being allowed or denied by the policy statement. For example, you might - want to allow any AWS user to post messages to your SQS queue using the - SendMessage action, but you don't want to allow those users other actions - such as ReceiveMessage or DeleteQueue. - - - The list of actions to which this statement applies. - this instance - - - - Gets and Sets the resources associated with this policy statement. Resources - are what a policy statement is allowing or denying access to, such as an - Amazon SQS queue or an Amazon SNS topic. - - Note that some services allow only one resource to be specified per - policy statement. - - - - - - Sets the resources associated with this policy statement and returns this - updated Statement object so that additional method calls can be chained - together. - - Resources are what a policy statement is allowing or denying access to, - such as an Amazon SQS queue or an Amazon SNS topic. - - - Note that some services allow only one resource to be specified per - policy statement. - - - The resources associated with this policy statement. - this instance - - - - Gets and Sets the conditions associated with this policy statement. Conditions - allow policy statements to be conditionally evaluated based on the many - available condition types. - - For example, a statement that allows access to an Amazon SQS queue could - use a condition to only apply the effect of that statement for requests - that are made before a certain date, or that originate from a range of IP - addresses. - - - When multiple conditions are included in a single statement, all - conditions must evaluate to true in order for the statement to take - effect. - - - - - - Sets the conditions associated with this policy statement, and returns - this updated Statement object so that additional method calls can be - chained together. - - Conditions allow policy statements to be conditionally evaluated based on - the many available condition types. - - - For example, a statement that allows access to an Amazon SQS queue could - use a condition to only apply the effect of that statement for requests - that are made before a certain date, or that originate from a range of IP - addresses. - - - Multiple conditions can be included in a single statement, and all - conditions must evaluate to true in order for the statement to take - effect. - - - The conditions associated with this policy statement. - this instance - - - - Gets and Sets the principals associated with this policy statement, indicating - which AWS accounts are affected by this policy statement. - - - - - Sets the principals associated with this policy statement, and returns - this updated Statement object. Principals control which AWS accounts are - affected by this policy statement. - - If you don't want to restrict your policy to specific users, you can use - to apply the policy to any user trying to - access your resource. - - - The list of principals associated with this policy statement. - this instance - - - - The available AWS access control policy actions for Amazon AppStream. - - - - - - The available AWS access control policy actions for Auto Scaling. - - - - - - The available AWS access control policy actions for AWS Billing. - - - - - - The available AWS access control policy actions for AWS CloudFormation. - - - - - - The available AWS access control policy actions for Amazon CloudFront. - - - - - - The available AWS access control policy actions for Amazon CloudSearch. - - - - - - The available AWS access control policy actions for AWS CloudTrail. - - - - - - The available AWS access control policy actions for Amazon CloudWatch. - - - - - - The available AWS access control policy actions for Amazon CloudWatch Logs. - - - - - - The available AWS access control policy actions for Amazon Cognito Identity. - - - - - - The available AWS access control policy actions for Amazon Cognito Sync. - - - - - - The available AWS access control policy actions for AWS Direct Connect. - - - - - - The available AWS access control policy actions for Amazon DynamoDB. - - - - - - The available AWS access control policy actions for Amazon EC2. - - - - - - The available AWS access control policy actions for AWS ElastiCache. - - - - - - The available AWS access control policy actions for AWS Elastic Beanstalk. - - - - - - The available AWS access control policy actions for Elastic Load Balancing. - - - - - - The available AWS access control policy actions for Amazon Elastic MapReduce. - - - - - - The available AWS access control policy actions for Amazon Elastic Transcoder. - - - - - - The available AWS access control policy actions for Amazon Glacier. - - - - - - The available AWS access control policy actions for AWS Identity and Access Management. - - - - - - The available AWS access control policy actions for AWS Import Export. - - - - - - The available AWS access control policy actions for Amazon Kinesis. - - - - - - The available AWS access control policy actions for AWS Marketplace. - - - - - - The available AWS access control policy actions for AWS Marketplace Management Portal. - - - - - - The available AWS access control policy actions for Amazon Mobile Analytics. - - - - - - The available AWS access control policy actions for AWS OpsWorks. - - - - - - The available AWS access control policy actions for Amazon RDS. - - - - - - The available AWS access control policy actions for Amazon Redshift. - - - - - - The available AWS access control policy actions for Amazon Route 53. - - - - - - The available AWS access control policy actions for Amazon S3. - - - - - - The available AWS access control policy actions for AWS Security Token Service. - - - - - - The available AWS access control policy actions for Amazon SES. - - - - - - The available AWS access control policy actions for Amazon SimpleDB. - - - - - - The available AWS access control policy actions for Amazon Simple Workflow Service. - - - - - - The available AWS access control policy actions for Amazon SNS. - - - - - - The available AWS access control policy actions for Amazon SQS. - - - - - - The available AWS access control policy actions for Amazon Storage Gateway. - - - - - - The available AWS access control policy actions for AWS Whispersync. - - - - - - The available AWS access control policy actions for Amazon Zocalo. - - - - - - Deserializes a JSON string into a AWS policy object. - - - - - Serializes an AWS policy object to a JSON string, suitable for sending to an - AWS service. - - - - Converts the specified AWS policy object to a JSON string, suitable for - passing to an AWS service. - - @param policy - The AWS policy object to convert to a JSON string. - - @return The JSON string representation of the specified policy object. - - @throws IllegalArgumentException - If the specified policy is null or invalid and cannot be - serialized to a JSON string. - - - - Uses the specified generator to write the JSON data for the principals in - the specified policy statement. - - - - - This sorts the conditions by condition type and key with the list of values for that combination. - - The list of conditions to be sorted. - - - - - Exception thrown by the SDK for errors that occur within the SDK. - - - - - This exception is thrown when there is a parse error on the response back from AWS. - - - - - The string value which could not be converted into a valid DateTime instance. - - - - - Occurs before a request is marshalled. - - - - - Occurs before a request is issued against the service. - - - - - Occurs after a response is received from the service. - - - - - Occurs after an exception is encountered. - - - - - Patches the in-flight uri to stop it unescaping the path etc (what Uri did before - Microsoft deprecated the constructor flag). This is particularly important for - Amazon S3 customers who want to use backslash (\) in their key names. - - - Different behavior in the various runtimes has been observed and in addition some - 'documented' ways of doing this between 2.x and 4.x runtimes has also been observed - to not be reliable. - - This patch effectively emulates what adding a schemesettings element to the - app.config file with value 'name="http" genericUriParserOptions="DontUnescapePathDotsAndSlashes"' - does. As we're a dll, that avenue is not open to us. - - - - - - Used to create a copy of the config for a different service than the current instance. - - Target service ClientConfig - The new ClientConfig for the desired service - - - - A base exception for some Amazon Web Services. - - Most exceptions thrown to client code will be service-specific exceptions, though some services - may throw this exception if there is a problem which is caught in the core client code. - - - - - - Whether the error was attributable to Sender or Reciever. - - - - - The error code returned by the service - - - - - The id of the request which generated the exception. - - - - - The HTTP status code from the service response - - - - - Flag indicating if the exception is retryable and the associated retry - details. A null value indicates that the exception is not retryable. - - - - - Class containing the retryable details for an AmazonServiceException - - - - - This property indicates that this exception is a - throttling exception and should be subject to congestion - control throttling. - - - - - This exception is thrown when there is a parse error on the response back from AWS. - - - - - Last known location in the response that was parsed, if available. - - - - - The entire response body that caused this exception, if available. - - - - - Base class for request used by some of the services. - - - - - This flag specifies if SigV4 will be used for the current request. - - - - - Gets or Sets a value indicating if "Expect: 100-continue" HTTP header will be - sent by the client for this request. The default value is false. - - - - - Gets the signer to use for this request. - A null return value indicates to use the configured - signer for the service that this request is part of. - - A signer for this request, or null. - - - - Abstract class for Response objects, contains only metadata, - and no result information. - - - - - Contains additional information about the request, such as the - Request Id. - - - - - Returns the content length of the HTTP response. - - - - - Returns the status code of the HTTP response. - - - - - Base class for determining region based on inspection. - - - - - Sets the Region property by looking up the corresponding RegionEndpoint - from the supplied region system name (us-east-1, us-west-2 etc). - - The system name of the region. - - - - Determines region based on application configuration settings. If the configuration does not contain - the region setting key an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of ApplicationConfigAWSRegion. If no region is found in the - application configuration file then an InvalidOperationException is thrown. - - - - - Probing mechanism to determine region from various sources. - - - - - This class is responsible for keeping track of Retry capacity across different ServiceURLs. - - - - - CapacityType determines the type of capacity to obtain or use. - - - - - The increment capacity type adds capacity. - - - - - The default retry capacity type uses the default capacity amount. - - - - - The timeout capacity type uses the timeout capacity amount. - - - - - This method acquires a said retry capacity if the container has the capacity. - - Contains the RetryCapacity object for the said ServiceURL. - - - - This method acquires a said retry capacity if the container has the capacity. - - Contains the RetryCapacity object for the said ServiceURL. - Specifies what capacity type cost to use for obtaining capacity - - - - This method calls a method to release capacity back - based on whether it was a successful response or a successful retry response. This is invoked by a retry request response. - - if this request is a retry, use a different capacity cost - Contains the RetryCapacity object for the said ServiceURL. - - - - This method calls a method to release capacity back - based on whether it was a successful response or a successful retry response. This is invoked by a retry request response. - - Specifies what capacity type cost to use for adding capacity - Contains the RetryCapacity object for the said ServiceURL. - - - - Ths method fetches the RetryCapacity for the given ServiceURL from CapacityManager.CapacityContainer - - - - - This method releases capacity back. This is invoked by the TryReleaseCapacity method. - - Contains the RetryCapacity object for the said ServiceURL. - The capacity that needs to be released based on whether it was a successful response or a successful retry response. - - - - This class is the RetryCapacity class for a given ServiceURL. - - - - - This class composes Client Context header for Amazon Web Service client. - It contains information like app title, version code, version name, client id, OS platform etc. - - - This class composes Client Context header for Amazon Web Service client. - It contains information like app title, version code, version name, client id, OS platform etc. - - - - - Adds the custom attributes to the Client Context. - - Key. - Value. - - - - Gets a Json Representation of the Client Context. - - Json Representation of Client Context - - - - Collection of parameters that an SDK client will send to a service. - - - - - Constructs empty ParameterCollection. - - - - - Adds a parameter with a string value. - - - - - - - Adds a parameter with a list-of-strings value. - - - - - - - Converts the current parameters into a list of key-value pairs. - - - - - - This class is responsible for managing adaptive retry mode client rate limiting. - - - - - The rate at which token are replenished. - - - - - The maximum capacity allowed in the token - - - - - The current capacity of the token - - - - - The last time the token bucket was refilled. - - - - - The smoothed rate which tokens are being retrieved. - - - - - The last half second time bucket used. - - - - - The number of requests seen within the current time - - - - - The maximum rate when the client was last throttled. - - - - - The last time when the client was throttled. - - - - - The cached time window calculation - - - - - Boolean indicating if the token bucket is enabled. - - - - - This method attempts to acquire capacity from the client's token - - The amount of capacity to obtain from the token bucket - Indicates that the client should or shouldn't sleep and - try again if capacity cannot be obtained. - - - - - This method attempts to acquire capacity from the client's token - - The amount of capacity to obtain from the token bucket - Indicates that the client should or shouldn't sleep and - try again if capacity cannot be obtained. - - Token which can be used to cancel the task. - - - - Updates the sending rate within the client's token bucket - - Indicates if the request resulted in a throttling error. - - - - Calculates the rate - - - Returns the calculated rate for a successful call - - - - Calculates the rate. - - The rate to use in the calculation - Returns the calculated rate for a throttled call - - - - Collection used to indicate if the property was initialized was created by the SDK. - - - - - - Collection used to indicate if the property was initialized was created by the SDK. - - - - - - - Default implementation of the IRequest interface. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Constructs a new DefaultRequest with the specified service name and the - original, user facing request object. - - The orignal request that is being wrapped - The service name - - - - The name of the request - - - - - Gets and sets the type of http request to make, whether it should be POST,GET or DELETE - - - - - Gets and sets a flag that indicates whether the request is sent as a query string instead of the request body. - - - - - Returns the original, user facing request object which this internal - request object is representing. - - - - - Returns a dictionary of the headers included in this request. - - - - - Returns a dictionary of the parameters included in this request. - - - - - Collection of parameters included in this request. - - - - - Returns the subresources that should be appended to the resource path. - This is used primarily for Amazon S3, where object keys can contain '?' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new null entry to the SubResources collection for the request - - The name of the subresource - - - - Adds a new entry to the SubResources collection for the request - - The name of the subresource - Value of the entry - - - - Gets and Sets the endpoint for this request. - - - - - Gets and Sets the resource path added on to the endpoint. - - - - - Returns the path resources that should be used within the resource path. - This is used for services where path keys can contain '/' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new entry to the PathResources collection for the request - - The name of the pathresource with potential greedy syntax: {key+} - Value of the entry - - - - Gets and Sets the version number for the marshaller used to create this request. The version number - is used to support backward compatible changes that would otherwise be breaking changes when a - newer core is used with an older service assembly. - Versions: - 1 - Default version - 2 - Support for path segments - - - - - Gets and Sets the content for this request. - - - - - Flag that signals that Content was and should be set - from the Parameters collection. - - - - - Gets and sets the content stream. - - - - - Gets and sets the original stream position. - If ContentStream is null or does not support seek, this propery - should be equal to -1. - - - - - Computes the SHA 256 hash of the content stream. If the stream is not - seekable, it searches the parent stream hierarchy to find a seekable - stream prior to computation. Once computed, the hash is cached for future - use. If a suitable stream cannot be found to use, null is returned. - - - - - The name of the service to which this request is being sent. - - - - - Alternate endpoint to use for this request, if any. - - - - - Host prefix value to prepend to the endpoint for this request, if any. - - - - - Gets and sets the Suppress404Exceptions property. If true then 404s return back from AWS will not cause an exception and - an empty response object will be returned. - - - - - If using AWS4 signing protocol, contains the resultant parts of the - signature that we may need to make use of if we elect to do a chunked - encoding upload. - - - - - Determine whether to use a chunked encoding upload for the request - (applies to Amazon S3 PutObject and UploadPart requests only). - - - - - - Used for Amazon S3 requests where the bucket name is removed from - the marshalled resource path into the host header. To comply with - AWS2 signature calculation, we need to recover the bucket name - and include it in the resource canonicalization, which we do using - this field. - - - - - This flag specifies if SigV4 is required for the current request. - - - - - The authentication region to use for the request. - Set from Config.AuthenticationRegion. - - - - - The region in which the service request was signed. - - - - - Checks if the request stream can be rewinded. - - Returns true if the request stream can be rewinded , - else false. - - - - Returns true if the request can contain a request body, else false. - - Returns true if the currect request can contain a request body, else false. - - - - Returns true if the request has a body, else false. - - Returns true if the request has a body, else false. - - - - Class containing the data for one endpoint returned from a endpoint discovery request - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Constructs a new DiscoveryEndpoint - - The address of the endpoint - The cache period for the endpoint in minutes - - - - The address of the endpoint. - - - - - The cache period for the endpoint in minutes - - - - - Calculates if this endpoint has expired - - A boolean value indicating if the cache period has expired - - - - Extends the endpoint expiration by the specified number of minutes from now. - - - - - Class containing the data for one endpoint returned from a endpoint discovery request - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class containing the data to use with endpoint discovery - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Gets/sets and flag indicating if endpoint discovery is required for the request. - - - - - Sorted dictionary of the identifiers that must be sent with the endpoint discovery request. These - identifiers are used to construct the cache key for the cache that stores discovered endpoints. A - sorted dictionary is used instead of a dictionary to ensure the cache key comes out in the same order - each time it is constructed. - - - - - Represents the data to be used with endpoint discovery operations - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class used to resolve endpoints using Endpoint Discovery. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Method that performs endpoint discovery for the current operation - - Context information used in calculations for endpoint discovery - The operation to fetch endpoints from the server - - - - - Gets the number of cache keys in the cache - - - - - Class used to resolve endpoints using Endpoint Discovery. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class containing context information to use with endpoint discovery - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Gets the customer credential information. - - - - - Gets the operation name. - - - - - Gets the current marshalled endpoint discovery data. - - - - - Gets the flag indicating if the specified key should be evicted from the cache. - - - - - Gets the Uri that should be evicted if EvictCacheKey is set to true. - - - - - Class containing context information to use with endpoint discovery - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Error type, one of Sender, Receiver, Unknown - Only applies to XML-based services. - - - - - Name of the exception class to return - - - - - Error message - - - - - RequestId of the error. - Only applies to XML-based services. - - - - - InternalConfiguration holds the cached SDK configuration values - obtained from the environment and profile configuration - factories. These configuration values are loaded internally and - are not the same as user exposed AWSConfigs. - - - - - Flag indicating if Endpoint Discovery is enabled. - - - - - The retry mode to use: Legacy, Standard, or Adaptive. - - - - - The max number of request attempts. - - - - - Probing mechanism to determine the configuration values from various sources. - - - - - Resets all the configuration values reloading as needed. This method will use - the AWS_PROFILE environment variable if set to construct the instance. Otherwise - the default profile will be used. - - - - - Flag that specifies if endpoint discovery is enabled, disabled, - or not set. - - - - - Flag that specifies which retry mode to use or if retry mode has - not been set. - - - - - Flag that specifies the max number of request attempts or if max - attempts has not been set. - - - - - Class containing the members used to invoke service calls - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class containing the members used to invoke service calls - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Represents a request being sent to an Amazon Web Service, including the - parameters being sent as part of the request, the endpoint to which the - request should be sent, etc. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - The name of the request - - - - - Returns a dictionary of the headers included in this request. - - - - - Gets and sets a flag that indicates whether the request is sent as a query string instead of the request body. - - - - - Returns a dictionary of the parameters included in this request. - - - - - Collection of parameters included in this request. - - - - - Returns the subresources that should be appended to the resource path. - This is used primarily for Amazon S3, where object keys can contain '?' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new null entry to the SubResources collection for the request - - The name of the subresource - - - - Adds a new entry to the SubResources collection for the request - - The name of the subresource - Value of the entry - - - - Gets and sets the type of http request to make, whether it should be POST,GET or DELETE - - - - - Gets and Sets the endpoint for this request. - - - - - Gets and Sets the resource path added on to the endpoint. - - - - - Returns the path resources that should be used within the resource path. - This is used for services where path keys can contain '/' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new entry to the PathResources collection for the request - - The name of the pathresource with potential greedy syntax: {key+} - Value of the entry - - - - Gets and Sets the version number for the marshaller used to create this request. The version number - is used to support backward compatible changes that would otherwise be breaking changes when a - newer core is used with an older service assembly. - - - - - Gets and Sets the content for this request. - - - - - Gets the header value from the request. - - - - - Flag that signals that Content was and should be set - from the Parameters collection. - - - - - Gets and sets the content stream. - - - - - Gets and sets the original stream position. - If ContentStream is null or does not support seek, this propery - should be equal to -1. - - - - - Computes the SHA 256 hash of the content stream. If the stream is not - seekable, it searches the parent stream hierarchy to find a seekable - stream prior to computation. Once computed, the hash is cached for future - use. - - - - - The name of the service to which this request is being sent. - - - - - Returns the original, user facing request object which this internal - request object is representing. - - - - - Alternate endpoint to use for this request, if any. - - - - - Host prefix value to prepend to the endpoint for this request, if any. - - - - - Gets and sets the Suppress404Exceptions property. If true then 404s return back from AWS will not cause an exception and - an empty response object will be returned. - - - - - If using AWS4 signing protocol, contains the resultant parts of the - signature that we may need to make use of if we elect to do a chunked - encoding upload. - - - - - Determine whether to use a chunked encoding upload for the request - (applies to Amazon S3 PutObject and UploadPart requests only). - - - - - - Used for Amazon S3 requests where the bucket name is removed from - the marshalled resource path into the host header. To comply with - AWS2 signature calculation, we need to recover the bucket name - and include it in the resource canonicalization, which we do using - this field. - - - - - This flag specifies if SigV4 is required for the current request. - - - - - The authentication region to use for the request. - Set from Config.AuthenticationRegion. - - - - - The region in which the service request was signed. - - - - - Checks if the request stream can be rewinded. - - Returns true if the request stream can be rewinded , - else false. - - - - Returns true if the request can contain a request body, else false. - - Returns true if the currect request can contain a request body, else false. - - - - Returns true if the request has a body, else false. - - Returns true if the request has a body, else false. - - - - Gets the value of the Service Id. - - - - - Gets the dictionary that gives mapping of renamed operations - - - - - IDictionary{String, String} access to ParameterCollection. - TODO: remove this class in version 3.4 of the SDK. - - - - - Constructs ParametersDictionaryFacade for a ParameterCollection - - - - - - A registry of object that will manipulate the runtime pipeline used by service clients. - - - - - Registers a customizer that will be applied for all service clients created. Each customizer has a unique name associated with it. If a customizer is registered more - than once with the same unique name then the calls after the first will be ignored. - - - - - - Deregistered the runtime pipeline customizer - - - - - - Deregistered the runtime pipeline customizer - - - - - - Applies all of the registered customizers on the runtime pipeline - - The service clients runtime pipeline. - Type object for the service client being created - - - - Interface for objects that will customize the runtime pipleine for newly created service clients. - - - - - The unique name for the customizer that identifies the customizer in the registry. The name is also used to identify the customizer on the SDK logs. - - - - - Called on service clients as they are being constructed to customize their runtime pipeline. - - - Type object for the service client being created - - - - Default ServiceMetadata implementation. - This implementation will be used if the service doesn't have a - IServiceMetadata implementation. - - - - - Gets the value of the Service Id. - - - - - Gets the dictionary that gives mapping of renamed operations - - - - - Computes RFC 2104-compliant HMAC signature. - - - - - Computes RFC 2104-compliant HMAC signature. - - - - - Inspects the supplied evidence to return the signer appropriate for the operation - - Global setting for the service - The request. - Configuration for the client - True if signature v4 request signing should be used - - - - Signs the specified request with the AWS3 signing protocol by using the - AWS account credentials given in the method parameters. - - The AWS public key - The AWS secret key used to sign the request in clear text - Request metrics - The configuration that specifies which hashing algorithm to use - The request to have the signature compute for - If any problems are encountered while signing the request - - - - AWS4 protocol signer for service calls that transmit authorization in the header field "Authorization". - - - - - Calculates and signs the specified request using the AWS4 signing protocol by using the - AWS account credentials given in the method parameters. The resulting signature is added - to the request headers as 'Authorization'. Parameters supplied in the request, either in - the resource path as a query string or in the Parameters collection must not have been - uri encoded. If they have, use the SignRequest method to obtain a signature. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. - - - Client configuration data encompassing the service call (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text. - - - If any problems are encountered while signing the request. - - - - - Calculates and signs the specified request using the AWS4 signing protocol by using the - AWS account credentials given in the method parameters. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. - - - Client configuration data encompassing the service call (notably authentication - region, endpoint and service name). - - - Metrics for the request. - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text. - - - If any problems are encountered while signing the request. - - - Parameters passed as part of the resource path should be uri-encoded prior to - entry to the signer. Parameters passed in the request.Parameters collection should - be not be encoded; encoding will be done for these parameters as part of the - construction of the canonical request. - - - - - Sets the AWS4 mandated 'host' and 'x-amz-date' headers, returning the date/time that will - be used throughout the signing process in various elements and formats. - - The current set of headers - - Date and time used for x-amz-date, in UTC - - - - Sets the AWS4 mandated 'host' and 'x-amz-date' headers, accepting and returning the date/time that will - be used throughout the signing process in various elements and formats. - - The current set of headers - - - Date and time used for x-amz-date, in UTC - - - - Computes and returns an AWS4 signature for the specified canonicalized request - - - - - - - - - - - - Computes and returns an AWS4 signature for the specified canonicalized request - - - - - - - - - - - - - Computes and returns an AWS4 signature for the specified canonicalized request - - - - - - - - - - - - - - Formats the supplied date and time for use in AWS4 signing, where various formats are used. - - - The required format - The UTC date/time in the requested format - - - - Compute and return the multi-stage signing key for the request. - - The clear-text AWS secret key, if not held in secureKey - The region in which the service request will be processed - Date of the request, in yyyyMMdd format - The name of the service being called by the request - Computed signing key - - - - If the caller has already set the x-amz-content-sha256 header with a pre-computed - content hash, or it is present as ContentStreamHash on the request instance, return - the value to be used in request canonicalization. - If not set as a header or in the request, attempt to compute a hash based on - inspection of the style of the request content. - - - - The computed hash, whether already set in headers or computed here. Null - if we were not able to compute a hash. - - - - - If signPayload is false set the x-amz-content-sha256 header to - the UNSIGNED-PAYLOAD magic string and return it. - Otherwise, if the caller has already set the x-amz-content-sha256 header with a pre-computed - content hash, or it is present as ContentStreamHash on the request instance, return - the value to be used in request canonicalization. - If not set as a header or in the request, attempt to compute a hash based on - inspection of the style of the request content. - - - - - The computed hash, whether already set in headers or computed here. Null - if we were not able to compute a hash. - - - - - Returns the HMAC256 for an arbitrary blob using the specified key - - - - - - - - Returns the HMAC256 for an arbitrary blob using the specified key - - - - - - - - Compute and return the hash of a data blob using the specified key - - Algorithm to use for hashing - Hash key - Data blob - Hash of the data - - - - Compute and return the hash of a data blob using the specified key - - Algorithm to use for hashing - Hash key - Data blob - Hash of the data - - - - Computes the non-keyed hash of the supplied data - - - - - - - Computes the non-keyed hash of the supplied data - - - - - - - Computes and returns the canonical request - - The endpoint URL - the path of the resource being operated on - The http method used for the request - The full request headers, sorted into canonical order - The query parameters for the request - - The hash of the binary request body if present. If not supplied, the routine - will look for the hash as a header on the request. - - Canonicalised request as a string - - - - Computes and returns the canonical request - - The endpoint URL - the path of the resource being operated on - The http method used for the request - The full request headers, sorted into canonical order - The query parameters for the request - - The path resource values lookup to use to replace the keys within resourcePath - The hash of the binary request body if present. If not supplied, the routine - will look for the hash as a header on the request. - - The version of the marshaller that constructed the request object. - Canonicalised request as a string - - - - Computes and returns the canonical request - - The endpoint URL - the path of the resource being operated on - The http method used for the request - The full request headers, sorted into canonical order - The query parameters for the request - - The path resource values lookup to use to replace the keys within resourcePath - The hash of the binary request body if present. If not supplied, the routine - will look for the hash as a header on the request. - - The version of the marshaller that constructed the request object. - The service being called for the request - Canonicalised request as a string - - - - Reorders the headers for the request for canonicalization. - - The set of proposed headers for the request - List of headers that must be included in the signature - For AWS4 signing, all headers are considered viable for inclusion - - - - Computes the canonical headers with values for the request. Only headers included in the signature - are included in the canonicalization process. - - All request headers, sorted into canonical order - Canonicalized string of headers, with the header names in lower case. - - - - Returns the set of headers included in the signature as a flattened, ;-delimited string - - The headers included in the signature - Formatted string of header names - - - - Collects the subresource and query string parameters into one collection - ready for canonicalization - - The in-flight request being signed - The fused set of parameters - - - - Computes and returns the canonicalized query string, if query parameters have been supplied. - Parameters with no value will be canonicalized as 'param='. The expectation is that parameters - have not already been url encoded prior to canonicalization. - - The set of parameters being passed on the uri - - Parameters must be uri encoded into the canonical request and by default the signer expects - that the supplied collection contains non-encoded data. Set this to false if the encoding was - done prior to signer entry. - - The uri encoded query string parameters in canonical ordering - - - - Computes and returns the canonicalized query string, if query parameters have been supplied. - Parameters with no value will be canonicalized as 'param='. The expectation is that parameters - have not already been url encoded prior to canonicalization. - - The set of parameters to be encoded in the query string - - Parameters must be uri encoded into the canonical request and by default the signer expects - that the supplied collection contains non-encoded data. Set this to false if the encoding was - done prior to signer entry. - - The uri encoded query string parameters in canonical ordering - - - - Returns the request parameters in the form of a query string. - - The request instance - Request parameters in query string format - - - - AWS4 protocol signer for Amazon S3 presigned urls. - - - - - Calculates and signs the specified request using the AWS4 signing protocol by using the - AWS account credentials given in the method parameters. The resulting signature is added - to the request headers as 'Authorization'. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. - - - Adding supporting data for the service call required by the signer (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text - - - If any problems are encountered while signing the request. - - - - - Calculates the AWS4 signature for a presigned url. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. If the Expires parameter - is present, it is renamed to 'X-Amz-Expires' before signing. - - - Adding supporting data for the service call required by the signer (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text - - - If any problems are encountered while signing the request. - - - Parameters passed as part of the resource path should be uri-encoded prior to - entry to the signer. Parameters passed in the request.Parameters collection should - be not be encoded; encoding will be done for these parameters as part of the - construction of the canonical request. - - - - - Calculates the AWS4 signature for a presigned url. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. If the Expires parameter - is present, it is renamed to 'X-Amz-Expires' before signing. - - - Adding supporting data for the service call required by the signer (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text - - - The service to sign for - - - The region to sign to, if null then the region the client is configured for will be used. - - - If any problems are encountered while signing the request. - - - Parameters passed as part of the resource path should be uri-encoded prior to - entry to the signer. Parameters passed in the request.Parameters collection should - be not be encoded; encoding will be done for these parameters as part of the - construction of the canonical request. - - The X-Amz-Content-SHA256 is cleared out of the request. - If the request is for S3 then the UNSIGNED_PAYLOAD value is used to generate the canonical request. - If the request isn't for S3 then the empty body SHA is used to generate the canonical request. - - - - - Encapsulates the various fields and eventual signing value that makes up - an AWS4 signature. This can be used to retrieve the required authorization string - or authorization query parameters for the final request as well as hold ongoing - signature computations for subsequent calls related to the initial signing. - - - - - Constructs a new signing result instance for a computed signature - - The access key that was included in the signature - Date/time (UTC) that the signature was computed - The collection of headers names that were included in the signature - Formatted 'scope' value for signing (YYYYMMDD/region/service/aws4_request) - Returns the key that was used to compute the signature - Computed signature - - - - The access key that was used in signature computation. - - - - - ISO8601 formatted date/time that the signature was computed - - - - - ISO8601 formatted date that the signature was computed - - - - - The ;-delimited collection of header names that were included in the signature computation - - - - - Formatted 'scope' value for signing (YYYYMMDD/region/service/aws4_request) - - - - - Returns a copy of the key that was used to compute the signature - - - - - Returns the hex string representing the signature - - - - - Returns a copy of the byte array containing the signature - - - - - Returns the signature in a form usable as an 'Authorization' header value. - - - - - Returns the signature in a form usable as a set of query string parameters. - - - - - Null Signer which does a no-op. - - - - - Signs the specified request with the AWS2 signing protocol by using the - AWS account credentials given in the method parameters. - - The AWS public key - The AWS secret key used to sign the request in clear text - Request metrics - The configuration that specifies which hashing algorithm to use - The request to have the signature compute for - If any problems are encountered while signing the request - - - - S3 signer constructor - - - - - S3 signer constructor - - - - - This exception is thrown if there are problems signing the request. - - - - - Response Unmarshaller for all Errors - - - - - Build an ErrorResponse from XML - - The XML parsing context. - Usually an Amazon.Runtime.Internal.UnmarshallerContext. - An ErrorResponse object. - - - - Return an instance of and ErrorResponseUnmarshaller. - - - - - - Interface for unmarshallers which unmarshall objects from response data. - The Unmarshallers are stateless, and only encode the rules for what data - in the XML stream goes into what members of an object. - - The type of object the unmarshaller returns - The type of the XML unmashaller context, which contains the - state during parsing of the XML stream. Usually an instance of - Amazon.Runtime.Internal.Transform.UnmarshallerContext. - - - - Given the current position in the XML stream, extract a T. - - The XML parsing context - An object of type T populated with data from the XML stream. - - - - Interface for unmarshallers which unmarshall service responses. - The Unmarshallers are stateless, and only encode the rules for what data - in the XML stream goes into what members of an object. - - The type of object the unmarshaller returns - The type of the XML unmashaller context, which contains the - state of parsing the XML stream. Uaually an instance of - Amazon.Runtime.Internal.Transform.UnmarshallerContext. - - - - Extracts an exeption with data from an ErrorResponse. - - The XML parsing context. - An inner exception to be included with the returned exception - The HttpStatusCode from the ErrorResponse - Either an exception based on the ErrorCode from the ErrorResponse, or the - general service exception for the service in question. - - - - Interface for unmarshallers which unmarshall objects from response data. - The Unmarshallers are stateless, and only encode the rules for what data - in the XML stream goes into what members of an object. - - The type of object the unmarshaller returns - The type of the XML unmashaller context, which contains the - state during parsing of the XML stream. Usually an instance of - Amazon.Runtime.Internal.Transform.UnmarshallerContext. - - - - Given the current position in the XML stream, extract a T. - - The XML parsing context - An object of type T populated with data from the XML stream. - - - - First-pass unmarshaller for all errors - - - - - Build an ErrorResponse from json - - The json parsing context. - Usually an Amazon.Runtime.Internal.JsonUnmarshallerContext. - An ErrorResponse object. - - - - Return an instance of JsonErrorResponseUnmarshaller. - - - - - - Wraps a json string for unmarshalling. - - Each Read() operation gets the next token. - TestExpression() is used to match the current key-chain - to an xpath expression. The general pattern looks like this: - - JsonUnmarshallerContext context = new JsonUnmarshallerContext(jsonString); - while (context.Read()) - { - if (context.IsKey) - { - if (context.TestExpresion("path/to/element")) - { - myObject.stringMember = stringUnmarshaller.GetInstance().Unmarshall(context); - continue; - } - } - } - - - - - - Wrap the jsonstring for unmarshalling. - - Stream that contains the JSON for unmarshalling - If set to true, maintains a copy of the complete response body constraint to log response size as the stream is being read. - Response data coming back from the request - If set to true, maintains a copy of the complete response body as the stream is being read. - - - - Are we at the start of the json document. - - - - - Is the current token the end of an object - - - - - Is the current token the start of an object - - - - - Returns the element depth of the parser's current position in the json - document being parsed. - - - - - The current Json path that is being unmarshalled. - - - - - Reads to the next token in the json document, and updates the context - accordingly. - - - True if a token was read, false if there are no more tokens to read. - - - - - Peeks at the next token. This peek implementation - reads the next token and makes the subsequent Read() return the same data. - If Peek is called successively, it will return the same data. - Only the first one calls Read(), subsequent calls - will return the same data until a Read() call is made. - - Token to peek. - Returns true if the peeked token matches given token. - - - - Returns the text contents of the current token being parsed. - - - The text contents of the current token being parsed. - - - - - The type of the current token - - - - - Get the base stream of the jsonStream. - - - - - Peeks at the next (non-whitespace) character in the jsonStream. - - The next (non-whitespace) character in the jsonStream, or -1 if at the end. - - - - Peeks at the next character in the stream. - If the data isn't buffered into the StreamReader (Peek() returns -1), - we flush the buffered data and try one more time. - - - - - - Abstract class for unmarshalling service responses. - - - - - Class for unmarshalling XML service responses. - - - - - Class for unmarshalling EC2 service responses. - - - - - Class for unmarshalling JSON service responses. - - - - - Unmarshaller for int fields - - - - - Unmarshaller for nullable int fields. Implemented only for JSON context - to handle cases where value can be null e.g. {'Priority': null}. - This unmarshaller is not implemented for XML context, as XML responses - will null elements (xsi:nil='true') will be skipped by the XML parser. - - - - - Unmarshaller for long fields - - - - - Unmarshaller for float fields - - - - - Unmarshaller for double fields - - - - - Unmarshaller for decimal fields - - - - - Unmarshaller for bool fields - - - - - Unmarshaller for string fields - - - - - Unmarshaller for byte fields - - - - - Unmarshaller for DateTime fields - - - - - Unmarshalls given string as a DateTime. Handles cases where we want to unmarshall - as just a DateTime or a nullable Datetime. - - Value to be parsed - If true, the method will return null if text is null. - If false, the method will return default(DateTime), if text is null. - - - - - Unmarshaller for nullable DateTime fields. Implemented only for JSON context - to handle cases where value can be null e.g. {'Priority': null}. - This unmarshaller is not implemented for XML context, as XML responses - will null elements (xsi:nil='true') will be skipped by the XML parser. - - - - - Unmarshaller for MemoryStream fields - - - - - Unmarshaller for ResponseMetadata - - - - - Base class for the UnmarshallerContext objects that are used - to unmarshall a web-service response. - - - - - Tests the specified expression against the current position in the XML - document - - The pseudo-XPath expression to test. - - True if the expression matches the current position in the document, - false otherwise. - - - - Tests the specified expression against the current position in the XML - document being parsed, and restricts the expression to matching at the - specified stack depth. - - The pseudo-XPath expression to test. - - The depth in the stack representing where the expression must - start matching in order for this method to return true. - - True if the specified expression matches the current position in - the XML document, starting from the specified depth. - - - - Reads the next token at depth greater than or equal to target depth. - - Tokens are read at depth greater than or equal to target depth. - True if a token was read and current depth is greater than or equal to target depth. - - - - The current path that is being unmarshalled. - - - - - Returns the element depth of the parser's current position in the - document being parsed. - - - - - Reads to the next node in the document, and updates the context accordingly. - - - True if a node was read, false if there are no more elements to read. - - - - - Returns the text contents of the current element being parsed. - - - The text contents of the current element being parsed. - - - - - True if NodeType is Element. - - - - - True if NodeType is EndElement. - - - - - True if the context is at the start of the document. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Wrap an XmltextReader for simulating an event stream. - - Each Read() operation goes either to the next element or next attribute within - the current element. TestExpression() is used to match the current event - to an xpath expression. The general pattern looks like this: - - UnmarshallerContext context = new UnmarshallerContext(...); - while (context.Read()) - { - if (context.TestExpresion("path/to/element")) - { - myObject.stringMember = stringUnmarshaller.GetInstance().Unmarshall(context); - continue; - } - if (context.TestExpression("path/to/@attribute")) - myObject.MyComplexTypeMember = MyComplexTypeUnmarshaller.GetInstance().Unmarshall(context); - } - - - - - - Wrap an XmlTextReader with state for event-based parsing of an XML stream. - - Stream with the XML from a service response. - If set to true, maintains a copy of the complete response body constraint to log response size as the stream is being read. - Response data coming back from the request - If set to true, maintains a copy of the complete response body as the stream is being read. - - - - The current XML path that is being unmarshalled. - - - - - Returns the element depth of the parser's current position in the XML - document being parsed. - - - - - Reads to the next node in the XML document, and updates the context accordingly. - - - True if a node was read, false if there are no more elements to read./ - - - - - Returns the text contents of the current element being parsed. - - - The text contents of the current element being parsed. - - - - - True if NodeType is Element. - - - - - True if NodeType is EndElement. - - - - - True if the context is at the start of the document. - - - - - True if NodeType is Attribute. - - - - - Wrap an XmlTextReader with state for event-based parsing of an XML stream. - - Stream with the XML from a service response. - If set to true, maintains a copy of the complete response body constraint to log response size as the stream is being read. - Response data coming back from the request - If set to true, maintains a copy of the complete response body as the stream is being read. - - - - RequestId value, if found in response - - - - - Reads to the next node in the XML document, and updates the context accordingly. - If node is RequestId, reads the contents and stores in RequestId property. - - - True if a node was read, false if there are no more elements to read./ - - - - - A stream which caches the contents of the underlying stream as it reads it. - - - - - All the bytes read by the stream. - - - - - All the bytes read by the stream constrained with _cacheLimit - - - - - Initializes the CachingWrapperStream with a base stream. - - The stream to be wrapped. - Maximum number of bytes to be cached. - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Gets a value indicating whether the current stream supports seeking. - CachingWrapperStream does not support seeking, this will always be false. - - - - - Gets or sets the position within the current stream. - CachingWrapperStream does not support seeking, attempting to set Position - will throw NotSupportedException. - - - - - Sets the position within the current stream. - CachingWrapperStream does not support seeking, attempting to call Seek - will throw NotSupportedException. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Stream wrapper that double-buffers from a wrapped stream and - returns the buffered content as a series of signed 'chunks' - for the AWS4 ('Signature V4') protocol. - - - - - Reads some or all of the processed chunk to the consumer, constructing - and streaming a new chunk if more input data is available. - - - - - - - - - Attempt to read sufficient data for a whole chunk from the wrapped stream, - returning the number of bytes successfully read to be processed into a chunk - - - - - Results of the header-signing portion of the request - - - - - Computed signature of the chunk prior to the one in-flight, in - hex - - - - - Computes the derived signature for a chunk of data of given length in the input buffer, - placing a formatted chunk with headers, signature and data into the output buffer - ready for streaming back to the consumer. - - - - - - Length override to return the true length of the payload plus the metainfo - supplied with each chunk - - - - - Computes the total size of the data payload, including the chunk metadata. - Called externally so as to be able to set the correct Content-Length header - value. - - - - - - - Computes the size of the header data for each chunk. - - - - - - - Attempt to read sufficient data for a whole chunk from the wrapped stream, - returning the number of bytes successfully read to be processed into a chunk - - - - - A list object that will always be sent to AWS services, - even if it is empty. - The AWS .NET SDK does not send empty collections to services, unless - the collection is of this type. - - - - - - A dictionary object that will always be sent to AWS services, - even if it is empty. - The AWS .NET SDK does not send empty collections to services, unless - the collection is of this type. - - - - - - - Class to perform actions on a background thread. - Uses a single background thread and performs actions - on it in the order the data was sent through the instance. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Class to invoke actions on a background thread. - Uses a single background thread and invokes actions - on it in the order they were invoked through the instance. - - - - - PCL doesn't have IPAddress. These methods are copied from the Microsoft source code. - - - - - Returns true if the Content is set or there are - query parameters. - - This request - True if data is present; false otherwise. - - - - Utilities for dealing with Guids - - - - - Hashes a set of objects. - - - - - - - Combines a set of hashses. - - - - - - - Combines two hashes. - - - - - - - - Disposes of all managed and unmanaged resources. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - A wrapper stream that calculates a hash of the base stream as it - is being read. - The calculated hash is only available after the stream is closed or - CalculateHash is called. After calling CalculateHash, any further reads - on the streams will not change the CalculatedHash. - If an ExpectedHash is specified and is not equal to the calculated hash, - Close or CalculateHash methods will throw an AmazonClientException. - If CalculatedHash is calculated for only the portion of the stream that - is read. - - - Exception thrown during Close() or CalculateHash(), if ExpectedHash is set and - is different from CalculateHash that the stream calculates, provided that - CalculatedHash is not a zero-length byte array. - - - - - Algorithm to use to calculate hash. - - - - - True if hashing is finished and no more hashing should be done; - otherwise false. - - - - - Current position in the stream. - - - - - Calculated hash for the stream. - This value is set only after the stream is closed. - - - - - Expected hash value. Compared against CalculatedHash upon Close(). - If the hashes are different, an AmazonClientException is thrown. - - - - - Expected length of stream. - - - - - Initializes an HashStream with a hash algorithm and a base stream. - - Stream to calculate hash for. - - Expected hash. Will be compared against calculated hash on stream close. - Pass in null to disable check. - - - Expected length of the stream. If the reading stops before reaching this - position, CalculatedHash will be set to empty array. - - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Asynchronously reads a sequence of bytes from the current stream, advances - the position within the stream by the number of bytes read, and monitors - cancellation requests. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous read operation. The value of the TResult - parameter contains the total number of bytes read into the buffer. This can be - less than the number of bytes requested if that many bytes are not currently - available, or zero (0) if the end of the stream has been reached. - - - - - Gets a value indicating whether the current stream supports seeking. - HashStream does not support seeking, this will always be false. - - - - - Gets or sets the position within the current stream. - HashStream does not support seeking, attempting to set Position - will throw NotSupportedException. - - - - - Sets the position within the current stream. - HashStream does not support seeking, attempting to call Seek - will throw NotSupportedException. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Gets the overridden length used to construct the HashStream - - - - - Calculates the hash for the stream so far and disables any further - hashing. - - - - - Resets the hash stream to starting state. - Use this if the underlying stream has been modified and needs - to be rehashed without reconstructing the hierarchy. - - - - - Validates the underlying stream. - - - - - Compares two hashes (arrays of bytes). - - Expected hash. - Actual hash. - - True if the hashes are identical; otherwise false. - - - - - A wrapper stream that calculates a hash of the base stream as it - is being read or written. - The calculated hash is only available after the stream is closed or - CalculateHash is called. After calling CalculateHash, any further reads - on the streams will not change the CalculatedHash. - If an ExpectedHash is specified and is not equal to the calculated hash, - Close or CalculateHash methods will throw an AmazonClientException. - If base stream's position is not 0 or HashOnReads is true and the entire stream is - not read, the CalculatedHash will be set to an empty byte array and - comparison to ExpectedHash will not be made. - - - Exception thrown during Close() or CalculateHash(), if ExpectedHash is set and - is different from CalculateHash that the stream calculates, provided that - CalculatedHash is not a zero-length byte array. - - - - - Initializes an HashStream with a hash algorithm and a base stream. - - Stream to calculate hash for. - - Expected hash. Will be compared against calculated hash on stream close. - Pass in null to disable check. - - - Expected length of the stream. If the reading stops before reaching this - position, CalculatedHash will be set to empty array. - - - - - A wrapper stream that calculates an MD5 hash of the base stream as it - is being read or written. - The calculated hash is only available after the stream is closed or - CalculateHash is called. After calling CalculateHash, any further reads - on the streams will not change the CalculatedHash. - If an ExpectedHash is specified and is not equal to the calculated hash, - Close or CalculateHash methods will throw an AmazonClientException. - If base stream's position is not 0 or HashOnReads is true and the entire stream is - not read, the CalculatedHash will be set to an empty byte array and - comparison to ExpectedHash will not be made. - - - Exception thrown during Close() or CalculateHash(), if ExpectedHash is set and - is different from CalculateHash that the stream calculates, provided that - CalculatedHash is not a zero-length byte array. - - - - - Initializes an MD5Stream with a base stream. - - Stream to calculate hash for. - - Expected hash. Will be compared against calculated hash on stream close. - Pass in null to disable check. - - - Expected length of the stream. If the reading stops before reaching this - position, CalculatedHash will be set to empty array. - - - - - Utilities for validating label values for host prefix templates - - - - - Validates a label value - - - - - Simple wrapper around the log4net Error method. - - - - - - - - Write debug message to Console - - - - - - - - Write debug message to Console - - - - - - - Simple wrapper around the log4net InfoFormat method. - - - - - - - This is a dynamic wrapper around log4net so we can avoid log4net being required - to be distributed with the SDK. - - - - - Abstract logger class, base for any custom/specific loggers. - - - - - Flushes the logger contents. - - - - - Simple wrapper around the log4net IsErrorEnabled property. - - - - - Simple wrapper around the log4net IsDebugEnabled property. - - - - - Simple wrapper around the log4net IsInfoEnabled property. - - - - - Simple wrapper around the log4net Error method. - - - - - - - - Simple wrapper around the log4net Debug method. - - - - - - - - Simple wrapper around the log4net DebugFormat method. - - - - - - - Simple wrapper around the log4net InfoFormat method. - - - - - - - Logger wrapper for reflected log4net logging methods. - - - - - This should be a one time call to use reflection to find all the types and methods - needed for the logging API. - - - - - Simple wrapper around the log4net IsErrorEnabled property. - - - - - Simple wrapper around the log4net Error method. - - - - - - - - Simple wrapper around the log4net IsDebugEnabled property. - - - - - Simple wrapper around the log4net Debug method. - - - - - - - - Simple wrapper around the log4net DebugFormat method. - - - - - - - Simple wrapper around the log4net IsInfoEnabled property. - - - - - Simple wrapper around the log4net InfoFormat method. - - - - - - - A single logged message - - - - - Log message arguments. - - - - - Culture-specific formatting provider. - - - - - Log message format. - - - - - a size-limited cache of key value pairs - - Once the maximum size has been reached, the least recently - used pairs will be evicted to make room for any new items. - - - - - - - the maximum number of entries this LruCache will hold - before items begin getting evicted - - - - - the number of items in the cache - - - - - Construct a new LruCache. - - maximum number of entries before items are evicted - - - - Add the key/value pair to the cache, or update - the value if the key already exists. - - If the cache is full, evicts the least recently used item. - - - - - - - Evicts a specific key out of the cache if it exists - - the key to evict from the cache - - - - Try to get the value associated with the key. - - the key to look up - the value, if the key exists - true if there is a value associated with the key, or false if no value is associated with the key - - - - Try to get the value associated with the key, if it doesn't exist, use the provided factory method to - create a new value and tries adding it to the cache. - - the key to look up - the factory method used in case the key is not present in the cache - the looked up value or the value created by the factory - - - - Clear the LruCache of all entries. - - - - - Helper class to support LruCache. - Does not implement the error checking and synchronization that - would be necessary for it to stand alone. - - - - - Item to be stored in the LruList - linked list structure. - - - - - Collection of properties being tracked - - - - - Timings for metrics being tracked - - - - - Counters being tracked - - - - - Whether metrics are enabled for the request - - - - - Constructs an empty, disabled metrics object - - - - - Starts timing an event. Logs an exception if an event - of the same type was started but not stopped. - - - - - - - Stops timing an event. Logs an exception if the event wasn't started. - - - - - - - Adds a property for a metric. If there are multiple, the - object is added as a new item in a list. - - - - - - - Sets a counter for a specific metric. - - - - - - - Increments a specific metric counter. - If counter doesn't exist yet, it is set to 1. - - - - - - Returns errors associated with the metric, including - if there are still any timing events in-flight. - - - - - - Returns a string representation of the current metrics. - - - - - - Return a JSON represenation of the current metrics - - - - - - Timing information for a metric - - - - - Empty, stopped timing object - - - - - Timing object in a started state - - - - - - Stops timing - - - - - - Whether the timing has been stopped - - - - - Elapsed ticks from start to stop. - If timing hasn't been stopped yet, returns 0. - - - - - Elapsed time from start to stop. - If timing hasn't been stopped yet, returns TimeSpan.Zero - - - - - Timing event, stops timing of a metric when disposed - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - The destructor for the client class. - - - - - A wrapper stream which supresses disposal of the underlying stream. - - - - - Constructor for NonDisposingWrapperStream. - - The base stream to wrap. - - - - The Dispose implementation for this wrapper stream - does not close the underlying stream. - - - - - This class is used to wrap a stream for a particular segment of a stream. It - makes that segment look like you are reading from beginning to end of the stream. - - - - - Asynchronously reads a sequence of bytes from the current stream, advances - the position within the stream by the number of bytes read, and monitors - cancellation requests. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous read operation. The value of the TResult - parameter contains the total number of bytes read into the buffer. This can be - less than the number of bytes requested if that many bytes are not currently - available, or zero (0) if the end of the stream has been reached. - - - - - Asynchronously writes a sequence of bytes to the current stream and advances the - current position within this stream by the number of bytes written. - - - An array of bytes. This method copies count bytes from buffer to the current stream. - - - The zero-based byte offset in buffer at which to begin copying bytes to the - current stream. - - The number of bytes to be written to the current stream. - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - A task that represents the asynchronous write operation. - - - - Wrapper stream that only supports reading - - - - - Asynchronously clears all buffers for this stream and causes any buffered data - to be written to the underlying device. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous flush operation. - - - - - Asynchronously writes a sequence of bytes to the current stream and advances the - current position within this stream by the number of bytes written. - - - An array of bytes. This method copies count bytes from buffer to the current stream. - - - The zero-based byte offset in buffer at which to begin copying bytes to the - current stream. - - The number of bytes to be written to the current stream. - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - A task that represents the asynchronous write operation. - - - - Partial wrapper stream that only supports reading - - - - - Uri wrapper that can parse out information (bucket, key, region, style) from an - S3 URI. - - - - - True if the URI contains the bucket in the path, false if it contains the bucket in the authority. - - - - - The bucket name parsed from the URI (or null if no bucket specified). - - - - - The key parsed from the URI (or null if no key specified). - - - - - The region parsed from the URI (or null if no region specified). - - - - - Constructs a parser for the S3 URI specified as a string. - - The S3 URI to be parsed. - - - - Constructs a parser for the S3 URI specified as a Uri instance. - - The S3 URI to be parsed. - - - - Percent-decodes the given string, with a fast path for strings that are not - percent-encoded. - - The string to decode - The decoded string - - - - Percent-decodes the given string. - - The string to decode - The index of the first '%' in the string - The decoded string - - - - Decodes the percent-encoded character at the given index in the string - and appends the decoded value to the string under construction. - - - The string under construction to which the decoded character will be - appended. - - The string being decoded. - The index of the '%' character in the string. - - - - Converts a hex character (0-9A-Fa-f) into its corresponding quad value. - - The hex character - The quad value - - - - Interface for a non-generic cache. - - - - - Clears the entire cache. - - - - - Maximum time to keep an item around after its last use. - - - - - How often should the cache be cleared of old items. - - - - - The number of items in the cache. - - - - - Interface for a generic cache. - - - - - - - Retrieves a value out of the cache or from the source. - - - - - - - - Retrieves a value out of the cache or from the source. - If the item was in the cache, isStaleItem is set to true; - otherwise, if the item comes from the source, isStaleItem is false. - - - - - - - - - Clears a specific value from the cache if it's there. - - - - - - Returns the keys for all items in the cache. - - - - - - Executes specified operation, catches exception, clears the cache for - the given key, retries the operation. - - - - - - - - - - - SDK-wide cache. - Provides access to caches specific to a particular set of credentials - and target region. - - - - - Clear all caches - - - - - Clear all caches of a particular type - - - - - - Retrieve a cache of a specific type for a client object. - The client object can be null in cases where a cache does - not correspond to a specific AWS account or target region. - - - - - - - - - - - Retrieve a cache of a specific type for a client object. - The client object can be null in cases where a cache does - not correspond to a specific AWS account or target region. - - - - - - - - - - - Utilities for converting objects to strings. Used by the marshaller classes. - - - - - Converts a DateTime to ISO8601 formatted string. - - - - - Converts a DateTime to RFC822 formatted string. - - - - - Converts a DateTime to Unix epoch time formatted string. - - - - - A wrapper stream. - - - - - Base stream. - - - - - Initializes WrapperStream with a base stream. - - - - - - Returns the first base non-WrapperStream. - - First base stream that is non-WrapperStream. - - - - Returns the first base non-WrapperStream. - - First base stream that is non-WrapperStream. - - - - Returns the first base non-WrapperStream. - - Potential WrapperStream - Base non-WrapperStream. - - - - Gets a value indicating whether the current stream supports reading. - True if the stream supports reading; otherwise, false. - - - - - Gets a value indicating whether the current stream supports seeking. - True if the stream supports seeking; otherwise, false. - - - - - Gets a value indicating whether the current stream supports writing. - True if the stream supports writing; otherwise, false. - - - - - Closes the current stream and releases any resources (such as sockets and - file handles) associated with the current stream. - - - - - Gets the length in bytes of the stream. - - - - - Gets or sets the position within the current stream. - - - - - Gets or sets a value, in miliseconds, that determines how long the stream - will attempt to read before timing out. - - - - - Gets or sets a value, in miliseconds, that determines how long the stream - will attempt to write before timing out. - - - - - Clears all buffers for this stream and causes any buffered data to be written - to the underlying device. - - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Sets the position within the current stream. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Sets the length of the current stream. - - The desired length of the current stream in bytes. - - - - Writes a sequence of bytes to the current stream and advances the current - position within this stream by the number of bytes written. - - - An array of bytes. This method copies count bytes from buffer to the current stream. - - - The zero-based byte offset in buffer at which to begin copying bytes to the - current stream. - - The number of bytes to be written to the current stream. - - - - Asynchronously clears all buffers for this stream and causes any buffered data - to be written to the underlying device. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous flush operation. - - - - - Asynchronously reads a sequence of bytes from the current stream, advances - the position within the stream by the number of bytes read, and monitors - cancellation requests. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous read operation. The value of the TResult - parameter contains the total number of bytes read into the buffer. This can be - less than the number of bytes requested if that many bytes are not currently - available, or zero (0) if the end of the stream has been reached. - - - - - Asynchronously writes a sequence of bytes to the current stream and advances the - current position within this stream by the number of bytes written. - - - An array of bytes. This method copies count bytes from buffer to the current stream. - - - The zero-based byte offset in buffer at which to begin copying bytes to the - current stream. - - The number of bytes to be written to the current stream. - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - A task that represents the asynchronous write operation. - - - - This is a utility class to be used in last resort for code paths that are synchronous but need to call an asynchronous method. - This should never be used for methods that are called at high volume as this utility class has a performance cost. For example this - class was added for the refreshing credentials like Cognito which would need to use this about once an hour. - - - - - Custom WebProxy implementation that creates a webproxy based on - user inputs(Host name and port number) - - - - - Set the ProxyUri - - - - - Create a Uri based on the user inputs(Host name and port number) - - - - - Proxy Uri property - - - - - Proxy Credentials property - - - - - Getter to fetch the set proxy - - - - - Method to determine if the proxy should be bypassed when accessing an internet source - - - - - Error is always enabled - - - - - Debug logging is always enabled - - - - - Info logging is always enabled - - - - - Prints the Log With Error Level - - - - - - - - Prints the Log with Debug Level - - - - - - - - Prints the Log with Debug Level - - - - - - - Prints the Log With Info Level - - - - - - - This class is no longer used anymore and should be avoided as it is just meant - as a last resort when blending async and sync operations. The code is still - here to support versions before 3.3.9.0 of AWSSDK.DynamoDBv2. - - - - - Property to denote that the last exception returned by an AWS Service - was retryable or not. - - - - - An abstract pipeline handler that has implements IPipelineHandler, - and has the default implmentation. This is the base class for most of - the handler implementations. - - - - - The logger used to log messages. - - - - - The inner handler which is called after the current - handler completes it's processing. - - - - - The outer handler which encapsulates the current handler. - - - - - Contains the processing logic for a synchronous request invocation. - This method calls InnerHandler.InvokeSync to continue processing of the - request by the pipeline. - - The execution context which contains both the - requests and response context. - - - - Contains the processing logic for an asynchronous request invocation. - This method calls InnerHandler.InvokeSync to continue processing of the - request by the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Logs the metrics for the current execution context. - - The execution context, it contains the - request and response context. - - - - A runtime pipeline contains a collection of handlers which represent - different stages of request and response processing. - - - - - The top-most handler in the pipeline. - - - - - Constructor for RuntimePipeline. - - The handler with which the pipeline is initalized. - - - - Constructor for RuntimePipeline. - - List of handlers with which the pipeline is initalized. - - - - Constructor for RuntimePipeline. - - List of handlers with which the pipeline is initalized. - The logger used to log messages. - - - - Constructor for RuntimePipeline. - - The handler with which the pipeline is initalized. - The logger used to log messages. - - - - Invokes the pipeline synchronously. - - Request context - Response context - - - - Invokes the pipeline asynchronously. - - Request context - Response context - - - - Adds a new handler to the top of the pipeline. - - The handler to be added to the pipeline. - - - - Adds a handler after the first instance of handler of type T. - - Type of the handler after which the given handler instance is added. - The handler to be added to the pipeline. - - - - Adds a handler before the first instance of handler of type T. - - Type of the handler before which the given handler instance is added. - The handler to be added to the pipeline. - - - - Removes the first occurance of a handler of type T. - - Type of the handler which will be removed. - - - - Replaces the first occurance of a handler of type T with the given handler. - - Type of the handler which will be replaced. - The handler to be added to the pipeline. - - - - Inserts the given handler after current handler in the pipeline. - - Handler to be inserted in the pipeline. - Handler after which the given handler is inserted. - - - - Gets the innermost handler by traversing the inner handler till - it reaches the last one. - - - - - Retrieves a list of handlers, in the order of their execution. - - Handlers in the current pipeline. - - - - Retrieves current handlers, in the order of their execution. - - Handlers in the current pipeline. - - - - This handler processes exceptions thrown from the HTTP handler and - unmarshalls error responses. - - - - - Default set of exception handlers. - - - - - Default set of exception handlers. - - - - - Constructor for ErrorHandler. - - an ILogger instance. - - - - Handles and processes any exception thrown from underlying handlers. - - The execution context which contains both the - requests and response context. - - - - Handles and processes any exception thrown from underlying handlers. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Disposes the response body. - - The response context. - - - - Processes an exception by invoking a matching exception handler - for the given exception. - - The execution context, it contains the - request and response context. - The exception to be processed. - - This method returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception that may be thrown by exception - processing by a matching exception handler. - - - - - The abstract base class for exception handlers. - - The exception type. - - - - The exception handler for HttpErrorResponseException exception. - - - - - The constructor for HttpErrorResponseExceptionHandler. - - in instance of ILogger. - - - - Handles an exception for the given execution context. - - The execution context, it contains the - request and response context. - The exception to handle. - - Returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception to replace the original exception. - - - - - Checks if a HTTP 404 status code is returned which needs to be suppressed and - processes it. - If a suppressed 404 is present, it unmarshalls the response and returns true to - indicate that a suppressed 404 was processed, else returns false. - - The execution context, it contains the - request and response context. - - - If a suppressed 404 is present, returns true, else returns false. - - - - - A pipeline handler which provides hooks to run - external code in the pre-invoke and post-invoke phases. - - - - - Action to execute on the pre invoke phase. - - - - - Action to execute on the post invoke phase. - - - - - Calls the PreInvoke and PostInvoke methods before and after calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls the PreInvoke and PostInvoke methods before and after calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Executes the OnPreInvoke action as part of pre-invoke. - - The execution context, it contains the - request and response context. - - - - Executes the OnPreInvoke action as part of post-invoke. - - The execution context, it contains the - request and response context. - - - - This handler retrieved the AWS credentials to be used for the current call. - - - - - The constructor for CredentialsRetriever. - - An AWSCredentials instance. - - - - Retrieves the credentials to be used for the current call before - invoking the next handler. - - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - This handler resolves the endpoint to be used for the current request. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Resolves the endpoint to be used for the current request - before invoking the next handler. - - The execution context, it contains the - request and response context. - - - - This handler resolves the endpoint to be used for the current request. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Resolves the endpoint to be used for the current request - before invoking the next handler. - - The execution context, it contains the - request and response context. - - - - Determines the endpoint for the request. - - The request context. - - - - - This handler provides an OnError action that can be used as hook for - external code to handle exceptions in the runtime pipeline. - - - - - Action to execute if an exception occurs during the - execution of any underlying handlers. - - - - - Executes the OnError action if an exception occurs during the - execution of any underlying handlers. - - - - - - - This handler marshalls the request before calling invoking the next handler. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Marshalls the request before calling invoking the next handler. - - The execution context, it contains the - request and response context. - - - - This handler manages the metrics used to time the complete call and - logs the final metrics. - - - - - Captures the overall execution time and logs final metrics. - - The execution context which contains both the - requests and response context. - - - - Captures the overall execution time and logs final metrics. - - The response type for the current request. - - The execution context, it contains the request and response context. - - A task that represents the asynchronous operation. - - - - This handler processes HTTP redirects and reissues the call to the - redirected location. - - - - - Processes HTTP redirects and reissues the call to the - redirected location. - - The execution context which contains both the - requests and response context. - - - - Processes HTTP redirects and reissues the call to the - redirected location. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Checks if an HTTP 307 (temporary redirect) has occured and changes the - request endpoint to the redirected location. - - - The execution context, it contains the request and response context. - - - A boolean value that indicates if a redirect has occured. - - - - - This handler signs the request. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Signs the request before invoking the next handler. - - - The execution context, it contains the request and response context. - - - - - Determines if the request should be signed. - - The request context. - A boolean value that indicated if the request should be signed. - - - - Signs the request. - - The request context. - - - - This handler unmarshalls the HTTP response. - - - - - The constructor for Unmarshaller. - - - Boolean value which indicated if the unmarshaller - handler supports response logging. - - - - - Unmarshalls the response returned by the HttpHandler. - - The execution context which contains both the - requests and response context. - - - - Unmarshalls the response returned by the HttpHandler. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Unmarshalls the HTTP response. - - - The execution context, it contains the request and response context. - - - - - Unmarshalls the HTTP response. - - - The execution context, it contains the request and response context. - - - - - The HTTP handler contains common logic for issuing an HTTP request that is - independent of the underlying HTTP infrastructure. - - - - - - The sender parameter used in any events raised by this handler. - - - - - The constructor for HttpHandler. - - The request factory used to create HTTP Requests. - The sender parameter used in any events raised by this handler. - - - - Issues an HTTP request for the current request context. - - The execution context which contains both the - requests and response context. - - - - Issues an HTTP request for the current request context. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Determines the content for request body and uses the HTTP request - to write the content to the HTTP request body. - - Content to be written. - The HTTP request. - The request context. - - - - Creates the HttpWebRequest and configures the end point, content, user agent and proxy settings. - - The async request. - The web request that actually makes the call. - - - - Disposes the HTTP handler. - - - - - The default implementation of the adaptive retry policy. - - - The default implementation of the adaptive policy. - - - - - Constructor for AdaptiveRetryPolicy. - - The maximum number of retries before throwing - back a exception. This does not count the initial request. - - - - Constructor for AdaptiveRetryPolicy. - - The Client config object. This is used to - retrieve the maximum number of retries before throwing - back a exception(This does not count the initial request) and - the service URL for the request. - - - - OnRetry is called when a retry request is initiated to determine if the request will be retried. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - true if the error that will be retried is a throtting error - True if retry throttling is disabled or retry throttling is enabled and capacity can be obtained. - - - - This method uses a token bucket to enforce the maximum sending rate. - - The execution context which contains both the - requests and response context. - If the prior request failed, this exception is expected to be - the exception that occurred during the prior request failure. - - - - Virtual method that gets called on a success Response. If its a retry success response, the entire - retry acquired capacity is released(default is 5). If its just a success response a lesser value capacity - is released(default is 1). - - Request context containing the state of the request. - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - This method uses a token bucket to enforce the maximum sending rate. - - The execution context which contains both the - requests and response context. - If the prior request failed, this exception is expected to be - the exception that occurred during the prior request failure. - - - - The default implementation of the legacy retry policy. - - - The default implementation of the legacy retry policy. - - - - - The maximum value of exponential backoff in milliseconds, which will be used to wait - before retrying a request. The default is 30000 milliseconds. - - - - - Constructor for DefaultRetryPolicy. - - The maximum number of retries before throwing - back a exception. This does not count the initial request. - - - - Constructor for DefaultRetryPolicy. - - The Client config object. This is used to - retrieve the maximum number of retries before throwing - back a exception(This does not count the initial request) and - the service URL for the request. - - - - Returns true if the request is in a state where it can be retried, else false. - - Request context containing the state of the request. - Returns true if the request is in a state where it can be retried, else false. - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - true if the error that will be retried is a throtting error - - - - Virtual method that gets called on a success Response. If its a retry success response, the entire - retry acquired capacity is released(default is 5). If its just a success response a lesser value capacity - is released(default is 1). - - Request context containing the state of the request. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Request context containing the state of the request. - Return true if the request should be retried. - - - - Checks if the retry limit is reached. - - Request context containing the state of the request. - Return false if the request can be retried, based on number of retries. - - - - Waits before retrying a request. The default policy implements a exponential backoff. - - Request context containing the state of the request. - - - - Waits for an amount of time using an exponential backoff algorithm. - - The request retry index. The first request is expected to be 0 while - the first retry will be 1. - The max number of milliseconds to wait - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - The retry handler has the generic logic for retrying requests. - It uses a retry policy which specifies when - a retry should be performed. - - - - - The logger used to log messages. - - - - - The retry policy which specifies when - a retry should be performed. - - - - - Constructor which takes in a retry policy. - - Retry Policy - - - - Invokes the inner handler and performs a retry, if required as per the - retry policy. - - The execution context which contains both the - requests and response context. - - - - Invokes the inner handler and performs a retry, if required as per the - retry policy. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Prepares the request for retry. - - Request context containing the state of the request. - - - - The default implementation of the standard retry policy. - - - The default implementation of the standard policy. - - - - - The maximum value of exponential backoff in milliseconds, which will be used to wait - before retrying a request. The default is 20000 milliseconds. - - - - - Constructor for StandardRetryPolicy. - - The maximum number of retries before throwing - back a exception. This does not count the initial request. - - - - Constructor for StandardRetryPolicy. - - The Client config object. This is used to - retrieve the maximum number of retries before throwing - back a exception(This does not count the initial request) and - the service URL for the request. - - - - Returns true if the request is in a state where it can be retried, else false. - - Request context containing the state of the request. - Returns true if the request is in a state where it can be retried, else false. - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - true if the error that will be retried is a throtting error - - - - Virtual method that gets called on a success Response. If its a retry success response, the entire - retry acquired capacity is released(default is 5). If its just a success response a lesser value capacity - is released(default is 1). - - Request context containing the state of the request. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Request context containing the state of the request. - Return true if the request should be retried. - - - - Checks if the retry limit is reached. - - Request context containing the state of the request. - Return false if the request can be retried, based on number of retries. - - - - Waits before retrying a request. The default policy implements a exponential backoff with - jitter algorithm. - - Request context containing the state of the request. - - - - Waits for an amount of time using an exponential backoff with jitter algorithm. - - The request retry index. The first request is expected to be 0 while - the first retry will be 1. - The max number of milliseconds to wait - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - This class is the base class of all the configurations settings to connect - to a service. - - - This class is the base class of all the configurations settings to connect - to a service. - - - - - Gets Service Version - - - - - Gets and sets of the signatureMethod property. - - - - - Gets and sets of the SignatureVersion property. - - Note: This property exists for backward compatibility but is no longer - used by any service other than S3. - - - - - Gets and sets of the UserAgent property. - - - - - Gets and sets the RegionEndpoint property. The region constant that - determines the endpoint to use. - - Setting this property to null will force the SDK to recalculate the - RegionEndpoint value based on App/WebConfig, environment variables, - profile, etc. - - - - - The constant used to lookup in the region hash the endpoint. - - - - - Gets and sets of the ServiceURL property. - This is an optional property; change it - only if you want to try a different service - endpoint. - - - - - Gets and sets the UseHttp. - If this property is set to true, the client attempts - to use HTTP protocol, if the target endpoint supports it. - By default, this property is set to false. - - - - - Given this client configuration, return a string form ofthe service endpoint url. - - - - - Gets and sets the AuthenticationRegion property. - Used in AWS4 request signing, this is an optional property; - change it only if the region cannot be determined from the - service endpoint. - - - - - Gets and sets the AuthenticationServiceName property. - Used in AWS4 request signing, this is the short-form - name of the service being called. - - - - - Returns the flag indicating how many retry HTTP requests an SDK should - make for a single SDK operation invocation before giving up. This flag will - return 4 when the RetryMode is set to "Legacy" which is the default. For - RetryMode values of "Standard" or "Adaptive" this flag will return 2. In - addition to the values returned that are dependant on the RetryMode, the - value can be set to a specific value by using the AWS_MAX_ATTEMPTS environment - variable, max_attempts in the shared configuration file, or by setting a - value directly on this property. When using AWS_MAX_ATTEMPTS or max_attempts - the value returned from this property will be one less than the value entered - because this flag is the number of retry requests, not total requests. To - learn more about the RetryMode property that affects the values returned by - this flag, see . - - - - - Determines if MaxErrorRetry has been manually set. - - - - - Gets and sets the LogResponse property. - If this property is set to true, the service response is logged. - The size of response being logged is controlled by the AWSConfigs.LoggingConfig.LogResponsesSizeLimit property. - - - - - Gets and sets the ReadEntireResponse property. - NOTE: This property does not effect response processing and is deprecated. - To enable response logging, the ClientConfig.LogResponse and AWSConfigs.LoggingConfig - properties can be used. - - - - - Gets and Sets the BufferSize property. - The BufferSize controls the buffer used to read in from input streams and write - out to the request. - - - - - - Gets or sets the interval at which progress update events are raised - for upload operations. By default, the progress update events are - raised at every 100KB of data transferred. - - - If the value of this property is set less than ClientConfig.BufferSize, - progress updates events will be raised at the interval specified by ClientConfig.BufferSize. - - - - - - Flag on whether to resign requests on retry or not. - For Amazon S3 and Amazon Glacier this value will always be set to true. - - - - - This flag controls if .NET HTTP infrastructure should follow redirection - responses (e.g. HTTP 307 - temporary redirect). - - - - - Flag on whether to log metrics for service calls. - - This can be set in the application's configs, as below: - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSLogMetrics" value"true"/> - </appSettings> - </configuration> - - - - - - Gets and sets the DisableLogging. If true logging for this client will be disabled. - - - - - Credentials to use with a proxy. - - - - - - If the value is set, the value is assigned to the Timeout property of the HttpWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Configures the endpoint calculation for a service to go to a dual stack (ipv6 enabled) endpoint - for the configured region. - - - Note: AWS services are enabling dualstack endpoints over time. It is your responsibility to check - that the service actually supports a dualstack endpoint in the configured region before enabling - this option for a service. - - - - - Enable or disable the Retry Throttling feature by setting the ThrottleRetries flag to True/False resepctively. - Retry Throttling is a feature that intelligently throttles retry attempts when a large precentage of requests - are failing and retries are unsuccessful as well. In such situations the allotted retry capacity for the service URL - will be drained until requests start to succeed again. Once the requisite capacity is available, retries would - be permitted again. When retries are throttled, the service enters a fail-fast behaviour as the traditional retry attempt - for the request would be circumvented. Hence, errors will resurface quickly. This will result in a greated number of exceptions - but prevents requests being tied up in unsuccessful retry attempts. - Note: Retry Throttling is enabled by default. Set the ThrottleRetries flag to false to switch off this feature. - - - - - Enable or disable the Nagle algorithm on the underlying http - client. - - This method is not intended to be called by consumers of the AWS SDK for .NET - - - - - - Performs validation on this config object. - Throws exception if any of the required values are missing/invalid. - - - - - Returns the current UTC now after clock correction for this endpoint. - - - - - The calculated clock skew correction for a specific endpoint, if there is one. - This field will be set if a service call resulted in an exception - and the SDK has determined that there is a difference between local - and server times. - - If is set to true, this - value will still be set to the correction, but it will not be used by the - SDK and clock skew errors will not be retried. - - - - - Gets and sets the DisableHostPrefixInjection flag. If true, host prefix injection will be disabled for this client, the default value of this flag is false. - Host prefix injection prefixes the service endpoint with request members from APIs which use this feature. - Example: for a hostPrefix of "foo-name." and a endpoint of "service.region.amazonaws.com" the default behavior is to - prefix the endpoint with the hostPrefix resulting in a final endpoint of "foo-name.service.region.amazonaws.com". Setting - DisableHostPrefixInjection to true will disable hostPrefix injection resulting in a final endpoint of - "service.region.amazonaws.com" regardless of the value of hostPrefix. E.g. You may want to disable host prefix injection for testing against a local mock endpoint. - - - - - Returns the flag indicating if endpoint discovery should be enabled or disabled for operations that are not required to use endpoint discovery. - - - - - Returns the maximum number of discovered endpoints that can be stored within the cache for the client. The default limit is 1000 cache entries. - - - - - Returns the flag indicating the current mode in use for request - retries and influences the value returned from . - The default value is RequestRetryMode.Legacy. This flag can be configured - by using the AWS_RETRY_MODE environment variable, retry_mode in the - shared configuration file, or by setting this value directly. - - - - - Under Adaptive retry mode, this flag determines if the client should wait for - a send token to become available or don't block and fail the request immediately - if a send token is not available. - - - - - Throw an exception if the boxed TimeSpan parameter doesn't have a value or is out of range. - - - - - Returns the request timeout value if its value is set, - else returns client timeout value. - - - - - - This is a switch used for performance testing and is not intended for production applications - to change. This switch may be removed in a future version of the SDK as the .NET Core platform matures. - - - If true, the HttpClient is cached and reused for every request made by the service client - and shared with other service clients. - - - For the .NET Core platform this is default to true because the HttpClient manages the connection - pool. - - - - - - If CacheHttpClient is set to true then HttpClientCacheSize controls the number of HttpClients cached. - - On Windows the default value is 1 since the underlying native implementation does not have throttling constraints - like the non Windows Curl based implementation. For non Windows based platforms the default is the value return from - System.Environment.ProcessorCount. - - - - - - Overrides the default read-write timeout value. - On Unity platform, this value is not used as Unity HTTP client does not support timeouts, so - - - - If the value is set, the value is assigned to the ReadWriteTimeout property of the HttpWebRequest object used - to send requests. - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Returns a WebProxy instance configured to match the proxy settings - in the client configuration. - - - - - Unpacks the host, port and any credentials info into the instance's - proxy-related fields. - Unlike the SetWebProxy implementation on .NET 3.5/4.5,the Host and the Port are not reconstructed from the - input proxyuri - - The proxy details - - - - Gets and sets of the ProxyHost property. - - - - - Gets and sets of the ProxyPort property. - - - - - - Returns true if the clients should be cached by HttpRequestMessageFactory, false otherwise. - - - - - - - Returns true if the SDK should dispose HttpClients after one use, false otherwise. - - - - - - - Create a unique string used for caching the HttpClient based on the settings that are used from the ClientConfig that are set on the HttpClient. - - - - - - - Determines if HttpClients created with the given IClientConfig should be cached at the SDK - client level, or cached globally. - - If there is no HttpClientFactory assigned and proxy or proxy credentials are set - this returns false because those properties can't be serialized as part of the key in the global http client cache. - - - - - Base class for constant class that holds the value that will be sent to AWS for the static constants. - - - - - Gets the value that needs to be used when send the value to AWS - - - - - Attempt to find correct-cased constant value using whatever cased value the user - has provided. This is primarily useful for mapping any-cased values from a CLI - tool to the specific casing required by the service, avoiding the need for the - user to (a) remember the specific case and (b) actually type it correctly. - - The properly cased service constant matching the value - - - - Utility class that stores clock skew information. - - - - - GlobalClockCorrection should be only set by AWSConfigs.ManualClockCorrection property - and is only available to maintain backward compatibilty. This should override any - endpoint specific clockskew correction. - - - - - Return clock skew correction value for an endpoint if there is one. - - AWSConfigs.ManualClockCorrection overrides globally any calculated service endpoint specific - clock correction value. - - Endpoint should in a form such as "https://s3" - Clock correction value for an endpoint in TimeSpan. TimeSpan.Zero if no such clock correction is set. - - - - Get clock skew corrected UTC now value. If ManualClockCorrection is set, - use ManualClockCorrection instead of endpoint specific clock correction value. - - - - - - - Probing mechanism to determine the endpoint discovery enabled value from various sources. - - - - - The valid hashing algorithm supported by the sdk for request signing. - - - - - Which end of a request was responsible for a service error response. - - - - - The sender was responsible for the error, i.e. the client - request failed validation or was improperly formatted. - - - - - The error occured within the service. - - - - - An unrecognized error type was returned. - - - - - Sts Regional Endpoints Value determines whether or not - to send the sts request to the regional endpoint or to - the global sts endpoint - - - - - Send the request to the global sts endpoint - if the region is a legacy global region - - - - - Send the request to the regional endpoint - - - - - S3 US East 1 endpoint value determines wheter or not - to send the us-east-1 s3 requests to the regional endpoint or to - the legacy global endpoint - - - - - Sends the requests to the legacy global s3 endpoint for us-east-1 - - - - - Sends the request to the regional s3 endpoint for us-east-1 - - - - - RetryMode determines which request retry mode is used for requests that do - not complete successfully. - - - - - Legacy request retry strategy. - - - - - Standardized request retry strategy that is consistent across all SDKs. - - - - - An experimental request retry strategy that builds on the Standard strategy - and introduces congestion control through client side rate limiting. - - - - - All Amazon service interfaces like IAmazonS3 extend from this interface. This allows all the - Amazon service interfaces be identified by this base interface and helps with generic constraints. - - - - - A readonly view of the configuration for the service client. - - - - - This interface is the read only access to the ClientConfig object used when setting up service clients. Once service clients - are initiated the config object should not be changed to avoid issues with using a service client in a multi threaded environment. - - - - - Gets the RegionEndpoint property. The region constant to use that - determines the endpoint to use. If this is not set - then the client will fallback to the value of ServiceURL. - - - - - The constant used to lookup in the region hash the endpoint. - - - - - Gets and sets of the ServiceURL property. - This is an optional property if you need to set a specific service URL - instead setting the region with the RegionEndpoint property. - - - - - Gets the UseHttp property. - If this property is set to true, the client attempts - to use HTTP protocol. - By default, this property is set to false. - - - - - Gets Service Version - - - - - Gets the signatureMethod property. - - - - - Gets the SignatureVersion property. - - Note: This property exists for backward compatibility but is no longer - used by any service other than S3. - - - - - Gets the AuthenticationRegion property. - Used in AWS4 request signing, this is an optional property; - change it only if the region cannot be determined from the - service endpoint. - - - - - Gets the AuthenticationServiceName property. - Used in AWS4 request signing, this is the short-form - name of the service being called. - - - - - Gets the UserAgent property. - - - - - Gets the DisableLogging. If true logging for this client will be disabled. - - - - - Flag on whether to log metrics for service calls. - - This can be set in the application's configs, as below: - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSLogMetrics" value"true"/> - </appSettings> - </configuration> - - - - - - Gets the LogResponse property. - If this property is set to true, the service response - is read in its entirety and logged. - - - - - Gets the ReadEntireResponse. - If this property is set to true, the service response - is read in its entirety before being processed. - - - - - This flag controls if .NET HTTP infrastructure should follow redirection - responses (e.g. HTTP 307 - temporary redirect). - - - - - Gets the BufferSize property. - The BufferSize controls the buffer used to read in from input streams and write - out to the request. - - - - - Returns the flag indicating how many retry HTTP requests an SDK should - make for a single SDK operation invocation before giving up. This flag will - return 4 when the RetryMode is set to "Legacy" which is the default. For - RetryMode values of "Standard" or "Adaptive" this flag will return 2. In - addition to the values returned that are dependant on the RetryMode, the - value can be set to a specific value by using the AWS_MAX_ATTEMPTS environment - variable, max_attempts in the shared configuration file, or by setting a - value directly on this property. When using AWS_MAX_ATTEMPTS or max_attempts - the value returned from this property will be one less than the value entered - because this flag is the number of retry requests, not total requests. To - learn more about the RetryMode property that affects the values returned by - this flag, see . - - - - - Determines if MaxErrorRetry has been manually set. - - - - - Gets the interval at which progress update events are raised - for upload operations. By default, the progress update events are - raised at every 100KB of data transferred. - - - - - Flag on whether to resign requests on retry or not. - - - - - Credentials to use with a proxy. - - - - - Gets the default request timeout value. - - - - If the value is set, the value is assigned to the Timeout property of the HTTPWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - - - - Configures the endpoint calculation for a service to go to a dual stack (ipv6 enabled) endpoint - for the configured region. - - - Note: AWS services are enabling dualstack endpoints over time. It is your responsibility to check - that the service actually supports a dualstack endpoint in the configured region before enabling - this option for a service. - - - - - Configures a flag enabling to either opt in or opt out of the retry throttling service. - Note: set value to true to enable retry throttling feature. The Default value for this flag is false. - - - - - Using either the RegionEndpoint or the ServiceURL determine what the URL to the service is. - - The URL to the service. - - - - Performs validation on this config object. - Throws exception if any of the required values are missing/invalid. - - The timeout specified is null. - - - - Returns the clock skew adjusted utc now. This value is affected by AWSConfigs.ManualClockCorrection - - - - - Returns the calculated clock skew value for this config's service endpoint. If AWSConfigs.CorrectForClockSkew is false, - this value won't be used to construct service requests. - - - - - Gets the DisableHostPrefixInjection flag. If true, host prefix injection will be disabled for this client, the default value of this flag is false. - Host prefix injection prefixes the service endpoint with request members from APIs which use this feature. - Example: for a hostPrefix of "foo-name." and a endpoint of "service.region.amazonaws.com" the default behavior is to - prefix the endpoint with the hostPrefix resulting in a final endpoint of "foo-name.service.region.amazonaws.com". Setting - DisableHostPrefixInjection to true will disable hostPrefix injection resulting in a final endpoint of - "service.region.amazonaws.com" regardless of the value of hostPrefix. E.g. You may want to disable host prefix injection for testing against a local mock endpoint. - - - - - Returns the flag indicating if endpoint discovery should be enabled or disabled for operations that are not required to use endpoint discovery. - - - - - Returns the maximum number of discovered endpoints that can be stored within the cache for the client. The default limit is 1000 cache entries. - - - - - Returns the flag indicating the current mode in use for request - retries and influences the value returned from . - The default value is RequestRetryMode.Legacy. This flag can be configured - by using the AWS_RETRY_MODE environment variable, retry_mode in the - shared configuration file, or by setting this value directly. - - - - - Under Adaptive retry mode, this flag determines if the client should wait for - a send token to become available or don't block and fail the request immediately - if a send token is not available. - - - - - - This is a switch used for performance testing and is not intended for production applications - to change. This switch may be removed in a future version of the SDK as the .NET Core platform matures. - - - If true, the HttpClient is cached and reused for every request made by the service client - and shared with other service clients. - - - For the .NET Core platform this is default to true because the HttpClient manages the connection - pool. - - - - - - If CacheHttpClient is set to true then HttpClientCacheSize controls the number of HttpClients cached. - - - - - Gets the ProxyHost property. - - - - - Gets the ProxyPort property. - - - - - Returns a WebProxy instance configured to match the proxy settings - in the client configuration. - - - - - - Interface for a single logged message. - - - - - Log message format. - - - - - Log message arguments. - - - - - Culture-specific formatting provider. - - - - - Abstract parameter value. - - - - - String parameter value. - - - - - String value of the parameter. - - - - - Constructs ParameterValue for a single string. - - - - - - String list parameter value. - - - - - List of strings value of the parameter. - - - - - Constructs ParameterValue for a list of strings. - - - - - - Metrics collected by the SDK on a per-request basis. - - - Each request made to an AWS service by the SDK can have metrics - collected and logged. This interface represents the collected - metrics for a request. The metrics include properties (i.e. request id - and other metadata), timings for each stage of the request, and counters. - - - - - Collection of properties being tracked - - - - - Timings for metrics being tracked - - - - - Counters being tracked - - - - - Whether metrics are enabled for the request - - - - - JSON representation of the current metrics - - JSON string - - - - Represents how long a phase of an SDK request took. - - - - - Whether the timing has been stopped - - - - - Elapsed ticks from start to stop. - If timing hasn't been stopped yet, returns 0. - - - - - Elapsed time from start to stop. - If timing hasn't been stopped yet, returns TimeSpan.Zero - - - - - User supplied type to perform metrics formatting. - - - - - Produce custom formatting for SDK metrics. - - - If defined, this method will be called for every request made by the SDK. - - An instance of IRequestMetrics produced by the SDK - formatted string representation of the metrics - - - - Predefined request metrics that are collected by the SDK. - - - - - Information about the request. - - - - - Gets and sets the RequestId property. - ID that uniquely identifies a request. Amazon keeps track of request IDs. If you have a question about a request, include the request ID in your correspondence. - - - - - This exception is thrown if there are problems signing the request. - - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - - - - Gets the percentage of transfer completed - - - - - Gets the number of bytes transferred since last event - - - - - Gets the number of bytes transferred - - - - - Gets the total number of bytes to be transferred - - - - - Returns a string representation of this object - - - - - - Anonymous credentials. - Using these credentials, the client does not sign the request. - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - AWS Credentials that automatically refresh by calling AssumeRole on - the Amazon Security Token Service. - - - - - The credentials of the user that will be used to call AssumeRole. - - - - - The Amazon Resource Name (ARN) of the role to assume. - - - - - An identifier for the assumed role session. - - - - - Options to be used in the call to AssumeRole. - - - - - Constructs an AssumeRoleAWSCredentials object. - - The credentials of the user that will be used to call AssumeRole. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - - - - Constructs an AssumeRoleAWSCredentials object. - - The credentials of the user that will be used to call AssumeRole. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRole. - - - - A unique identifier that is used by third parties when assuming roles in their customers' accounts. - - - - - An IAM policy in JSON format. - - - - - The length of time in seconds before the credentials will expire. - - - - - The identification number of the MFA device that is associated with the user who is making the assume-role call. - - - - - The value provided by the MFA device, if the trust policy of the role being assumed requires MFA. - - - - - A callback that's used to obtain the MFA token code when the AssumeRoleAWSCredentials are refreshed. - - - - - Immutable representation of AWS credentials obtained as a result of - authenticating with the AssumeRole method of the Security Token Service. - - - - - The expiry time of the credentials, obtained from the AssumeRoleResponse. - - - - - Constructs an instance with supplied keys, token, and expiration. - - The AccessKey for the credentials. - The SecretKey for the credentials. - The security token for the credentials. - The expiration time for the credentials. - - - - Get a copy of this AssumeRoleImmutableCredentials object. - - A copy of this object. - - - - Abstract class that represents a credentials object for AWS services. - - - - - Returns a copy of ImmutableCredentials - - - - - - Called by AmazonServiceClient to validate the credential state - on client construction. - - - - - Basic set of credentials consisting of an AccessKey and SecretKey - - - - - Constructs a BasicAWSCredentials object for the specified accessKey and secretKey. - - - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - Immutable representation of AWS credentials. - - - - - Gets the AccessKey property for the current credentials. - - - - - Gets the SecretKey property for the current credentials. - - - - - Gets the Token property for the current credentials. - - - - - Gets the UseToken property for the current credentials. - Specifies if Token property is non-emtpy. - - - - - Constructs an ImmutableCredentials object with supplied accessKey, secretKey. - - - - Optional. Can be set to null or empty for non-session credentials. - - - - Returns a copy of the current credentials. - - - - - - Abstract class for automatically refreshing AWS credentials - - - - - Refresh state container consisting of credentials - and the date of the their expiration - - - - - Represents the current state of the Credentials. - - This can be cleared without synchronization. - - - - Semaphore to control thread access to GetCredentialsAsync method. - The semaphore will allow only one thread to generate new credentials and - update the current state. - - - - - The time before actual expiration to expire the credentials. - Property cannot be set to a negative TimeSpan. - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - Test credentials existence and expiration time - should update if: - credentials have not been loaded yet - it's past the expiration time. At this point currentState.Expiration may - have the PreemptExpiryTime baked into to the expiration from a call to - UpdateToGeneratedCredentials but it may not if this is new application load. - - - - - When overridden in a derived class, generates new credentials and new expiration date. - - Called on first credentials request and when expiration date is in the past. - - - - - - When overridden in a derived class, generates new credentials and new expiration date. - - Called on first credentials request and when expiration date is in the past. - - - - - - Clears currently-stored credentials, forcing the next GetCredentials call to generate new credentials. - - - - - Immutable representation of AWS credentials obtained as a result of - authenticating against a SAML-supporting federated identity provider. - - - - - The expiry time of the credentials, obtained from the AssumeRoleWithSAML response. - - - - - The value of the NameID element in the Subject element of the SAML assertion, as returned in the - AssumeRoleWithSAML response from the Security Token Service. - - - - - Constructs an instance with supplied keys and SAML assertion data. - - - - - - - - - - Constructs an instance with supplied keys and SAML assertion data. - - - - - - - - Returns a copy of the current credentials. - - - - - - Serializes the instance to a json-format string for external storage - - The serialized object in json - - - - Instantiates an instance from persisted json data - - The serialized data - Deserialized instance corresponding to the json data - - - - Session credentials consisting of AccessKey, SecretKey and Token - - - - - Constructs a SessionAWSCredentials object for the specified accessKey, secretKey. - - - - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - Credentials that are retrieved from the Instance Profile service on an EC2 instance - - - - - Constructs a InstanceProfileAWSCredentials object for specific role - - Role to use - - - - Constructs a InstanceProfileAWSCredentials object for the first found role - - - - - Retrieves a list of all roles available through current InstanceProfile service - - InstanceProfileAWSCredentials is no longer supported in PCL. - - - - - - Superclass for Exceptions that come over the event stream, or to wrap other kinds of generic exceptions. - - - - - The numeric code identifier for the type of error. - - - - - Constructs an EventStreamError. - - - - - Constructs an EventStreamError. - - The error code. - The error message. - - - - Event args that contain an . - - The - - - - The EventStream Event. - - - - - Constructs an EventStreamEventReceivedArgs. - - The EventStream Event. - - - - Event args that contain an . - - The . - - - - The EventStream Exception. - - - - - Constructs an EventStreamExceptionReceivedArgs. - - The EventStream Exception. - - - - Supported Header types for vnd.amazon.event-stream - - - - - Name for the Header. Maximum of 255 bytes. - - - - - Header type id - - - - - Computes the amount of memory neccesary to serialize this Header. - - - - - Writes this Header to buffer starting at offset - Keep in mind, this API assumes buffer is large enough - for the operation. - - buffer to serialize this Header to - offset to begin writing at. - - the new offset. - - - - - Returns the current value as a bool - - - - - Sets the current value - - - - - Returns the current value as a byte - - - - - Sets the current value - - - - - Gets the current value as a 16 bit integer. (Host Order). - - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a 32 bit integer. (Host Order) - - - - - Sets the current value - - - - - returns the current value as a 64-bit integer. (Host Order) - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a byte buffer. - - - - - - Sets the current value. Max length is 2^15 - 1 - - - - - Returns the current value as a utf-8 string. - - - - - Sets the current value. Utf-8 encoded. Max byte size is 2^16 - 1 - - - - - Gets the current value as a DateTime. - Note: You do not need to compensate for unix epoch on this API. - - - - - - Sets the current value. - Note: You do not need to compensate for unix epoch on this API. - - - - - Returns the current value as a Guid (UUID) - - - - - Sets the current value - - - - - Header Data for an EventStreamMessage - - Each header is of format: - [name len] (1) | [utf-8 name] (v) - [type (1)] - [value (v)] - - - - - Name for the Header. Maximum of 255 bytes. - - - - - Header type id - - - - - Initializes this Header with name. - - utf-8 string, max length is 255 - - - - Deserializes the header in buffer. - - buffer constaining the header - index to start from in the buffer. - updated offset with new value for offset - - - - Writes this Header to buffer starting at offset - Keep in mind, this API assumes buffer is large enough - for the operation. - - buffer to serialize this Header to - offset to begin writing at. - - the new offset. - - - - - Computes the amount of memory neccesary to serialize this Header. - - - - - Returns the current value as a bool - - - - - Sets the current value - - - - - Returns the current value as a byte - - - - - Sets the current value - - - - - Gets the current value as a 16 bit integer. (Host Order). - - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a 32 bit integer. (Host Order) - - - - - Sets the current value - - - - - returns the current value as a 64-bit integer. (Host Order) - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a byte buffer. - - - - - - Sets the current value. Max length is 2^15 - 1 - - - - - Returns the current value as a utf-8 string. - - - - - Sets the current value. Utf-8 encoded. Max byte size is 2^16 - 1 - - - - - Gets the current value as a DateTime. - Note: You do not need to compensate for unix epoch on this API. - - - - - - Sets the current value. - Note: You do not need to compensate for unix epoch on this API. - - - - - Returns the current value as a Guid (UUID) - - - - - Sets the current value - - - - - Headers for the message. Can be null. - - - - - Payload for the message. Can be null. - - - - - Converts a message into a byte buffer (usually for network transmission). - - - - - Message is a single datagram. The format is as follows: - [ total length (4) ] | [ headers_length (4)] | [ prelude crc(4)] - [ headers (v)] - [ payload (v)} - [ trailing crc ] - - CRCs use the CRC32 algorithm. - - - - - Content type for EventStreams. - - - - - Headers for the message. Can be null. - - - - - Payload for the message. Can be null. - - - - - Initialize a message with headers and a payload. - - list of headers for the message, can be null. - payload for the message, can be null. - - - - Builds a message from buffer. - - buffer to read - offset to start reading - buffer length. - - parsed instance of EventStreamMessage. Doesn't return null, - does throw if CRCs don't match. - - - - - Converts a message into a byte buffer (usually for network transmission). - - - - - Defines exceptions that arise from an not conforming to specification. - - - - - Constructs an EventStreamValidationException. - - - - - Constructs an EventStreamValidationException. - - The exception message. - - - - Constructs an EventStreamValidationException. - - The exception message. - The inner exception. - - - - This exception is thrown if an exception is retrieved from the event stream and should be modeled, - but a generator function for the strongly-typed exception is not defined. - - - - - The exception type. - - - - - Constructs an EventStreamException. - - The exception type. - - - - The contract for the . - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - A subclass of that enables an enumerable interface for interacting with Events. - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - Flag if the stream was chosen to be enumerated. - - - - - A Stream of Events. Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treated as mutually exclusive. - - - - - A Stream of Events. Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treated as mutually exclusive. - - - - - Returns an enumerator that iterates through the collection. - - An enumerator that can be used to iterate through the collection. - - - - Returns an enumerator that iterates through a collection. - - An object that can be used to iterate through the collection. - - - - Starts the background thread to start reading events from the network stream. - - - - - The contract for the . - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - The size of the buffer for reading from the network stream. - - - - - Fires when an event is received. - - - - - Fired when an exception or error is raised. - - - - - Starts the background thread to start reading events from the network stream. - - - - - The superclass for all EventStreams. It contains the common processing logic needed to retreive events from a network Stream. It - also contains the mechanisms needed to have a background loop raise events. - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - "Unique" key for unknown event lookup. - - - - - Header key for message type. - - - - - Header key for event type. - - - - - Header key for exception type. - - - - - Header key for error code. - - - - - Header key for error message. - - - - - Value of when the message is an event. - - - - - Value of when the message is an exception. - - - - - Value of when the message is an error. - - - - - The size of the buffer for reading from the network stream. - Default is 8192. - - - - - The underlying stream to read events from. - - - - - Responsible for decoding events from sequences of bytes. - - - - - Fires when an event is recieved. - - - - - Fired when an exception or error is raised. - - - - - The mapping of event message to a generator function to construct the matching Event Stream event. - - - - - The mapping of event message to a generator function to construct the matching Event Stream exception. - - - - - Whether the Stream is currently being processed. - - - - - A Stream of Events. Events can be retrieved from this stream by attaching handlers to listen events, and then calling StartProcessing. - - - - - A Stream of Events. Events can be retrieved from this stream by attaching handlers to listen events, and then calling StartProcessing. - - - - - Converts an EventStreamMessage to an event. - - The event stream message to be converted. - The event - - - - Abstraction for cross-framework initiation of the background thread. - - - - - The background thread main loop. It will constantly read from the network stream until IsProcessing is false, or an error occurs. - - This stub exists due to FXCop. - - - - - The background thread main loop. It will constantly read from the network stream until IsProcessing is false, or an error occurs. - - Needed for 3.5 support. Not used. - - - - Reads from the stream into the buffer. It then passes the buffer to the decoder, which raises an event for - each message it decodes. - - The buffer to store the read bytes from the stream. - - - - Wraps exceptions in an outer exception so they can be passed to event handlers. If the Exception is already of a compatable type, - the method returns what it was given. - - The exception to wrap. - An exception of type TE - - - - Starts the background thread to start reading events from the network stream. - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Disposes the resources of this stream. - - Should dispose of unmanged resources. - - - - Event Arguments for EventStreamDecoder.MessageReceived. - - - - - Received message. - - - - - Additional object context - - - - - Initialize this with message - - - - - Initialize this with message and object conetext - - - - - Exception thrown when a request is made of the Decoder, but the internal state - machine is an invalid state. This is usually the result of an interanl exception - being thrown during parsing of the network stream. - - - - - Contract for EventStreamDecoder - - - - - Invoked anytime an EventStreamMessage is found. - - - - - Processes data starting at offset up to length. - Invokes MessageRecieved for each message encountered. - If an exception is thrown, this object is not safe for reuse. - - buffer to read - offset in buffer to start reading. - length of data. - - - - Streaming decoder for listening for incoming EventStreamMessage datagrams. - - - - - Invoked anytime an EventStreamMessage is found. - - - - - Object data (optional) that can be passed to the event handler for MessageReceived. - - - - - Default constructor. Initializes internal _state machine. - - - - - Processes data starting at offset up to length. - Invokes MessageRecieved for each message encountered. - If an exception is thrown, this object is not safe for reuse. - - buffer to read - offset in buffer to start reading. - length of data. - - - - Superclass for Exceptions that come over the event stream, or to wrap other kinds of generic exceptions. - - - - - Constructs an EventStreamException. - - - - - Constructs an EventStreamException. - - The exception message. - - - - Constructs an EventStreamException. - - The exception message. - The inner exception. - - - - The contract for EventStream events. - - - - - The contract for EventStream terminal events. - - - - - This Event is returned if an event is retrieved from the event stream, but a generator function - for the event is not defined. This can occur if the SDK is not updated after a new event type is introduced. - - - - - The Message recieved from the event stream before conversion. - - - - - The event type. - - - - - Constructs an UnknownEventStreamEvent. - - - - - Constructs an UnknownEventStreamEvent. - - The Message recieved from the event stream before conversion. - The event type. - - - - Signals that an an has an unknown message type. These exceptions whould be - swallowed to allow future expansion of the EventStream specification without breaking existing clients. - - - - - Constructs an UnknownEventStreamMessageTypeException. - - - - - Interface for a handler in a pipeline. - - - - - The logger used to log messages. - - - - - The inner handler which is called after the current - handler completes it's processing. - - - - - The outer handler which encapsulates the current handler. - - - - - Contains the processing logic for a synchronous request invocation. - This method should call InnerHandler.InvokeSync to continue processing of the - request by the pipeline, unless it's a terminating handler. - - The execution context which contains both the - requests and response context. - - - - Contains the processing logic for an asynchronous request invocation. - This method should call InnerHandler.InvokeSync to continue processing of the - request by the pipeline, unless it's a terminating handler. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - The interface for an exception handler. - - - - - Handles an exception for the given execution context. - - The execution context, it contains the - request and response context. - The exception to handle. - - Returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception to replace the original exception. - - - - - The interface for an exception handler with a generic parameter for the exception type. - - The exception type. - - - - Handles an exception for the given execution context. - - The execution context, it contains the - request and response context. - The exception to handle. - - Returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception to replace the original exception. - - - - - The interface for a HTTP request factory. - - The type used by the underlying HTTP API to represent the request body. - - - - Creates an HTTP request for the given URI. - - The request URI. - An HTTP request. - - - - The interface for an HTTP request that is agnostic of the underlying HTTP API. - - The type used by the underlying HTTP API to represent the HTTP request content. - - - - The HTTP method or verb. - - - - - The request URI. - - - - - Configures a request as per the request context. - - The request context. - - - - Sets the headers on the request. - - A dictionary of header names and values. - - - - Gets a handle to the request content. - - The request content. - - - - Returns the HTTP response. - - The HTTP response. - - - - Writes a stream to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - The request context. - - - - Writes a byte array to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - - - - Sets up the progress listeners - - The content stream - The interval at which progress needs to be published - The objects which is trigerring the progress changes - The callback which will be invoked when the progress changed event is trigerred - an object, incase the progress is setup, else returns the original stream - - - - Aborts the HTTP request. - - - - - Gets a handle to the request content. - - - - - - Returns the HTTP response. - - A cancellation token that can be used to cancel the asynchronous operation. - - - - - A factory which creates HTTP clients. - - - - - Create and configure an HttpClient. - - - - - - A factory which creates HTTP requests which uses System.Net.Http.HttpClient. - - - - - The constructor for HttpRequestMessageFactory. - - Configuration setting for a client. - - - - Creates an HTTP request for the given URI. - - The request URI. - An HTTP request. - - - - Disposes the HttpRequestMessageFactory. - - - - - Dispose the factory - - - - - - Create and configure a managed HttpClient instance. - The use of HttpClientHandler in the constructor for HttpClient implicitly creates a managed HttpClient. - If a native HttpClient is required the SDK user must implement IHttpClientFactory and provide an - instance via IClientConfig.HttpClientFactory (only available in PCL). - - - - - - - A cache of HttpClient objects. The GetNextClient method does a round robin cycle through the clients - to distribute the load even across. - - - - - Constructs a container for a cache of HttpClient objects - - The HttpClient to cache - - - - Returns the next HttpClient using a round robin rotation. It is expected that individual clients will be used - by more then one Thread. - - - - - - Disposes the HttpClientCache. - - - - - Dispose the HttpClientCache - - - - - - HTTP request wrapper for System.Net.Http.HttpRequestMessage. - - - - - Set of content header names. - - - - - The constructor for HttpWebRequestMessage. - - The HttpClient used to make the request. - The request URI. - The service client config. - - - - The underlying HttpClient - - - - - The underlying HTTP web request. - - - - - The HTTP method or verb. - - - - - The request URI. - - - - - Configures a request as per the request context. - - The request context. - - - - Sets the headers on the request. - - A dictionary of header names and values. - - - - Gets a handle to the request content. - - The request content. - - - - Returns the HTTP response. - - The HTTP response. - - - - Aborts the HTTP request. - - - - - Returns the HTTP response. - - A cancellation token that can be used to cancel the asynchronous operation. - - - - - Writes a stream to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - The request context. - - - - Writes a byte array to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - - - - Gets a handle to the request content. - - - - - - Disposes the HttpWebRequestMessage. - - - - - - - - - - - Sets up the progress listeners - - The content stream - The interval at which progress needs to be published - The objects which is trigerring the progress changes - The callback which will be invoked when the progress changed event is trigerred - an object, incase the progress is setup, else returns the original stream - - - - A retry policy specifies all aspects of retry behavior. This includes conditions when the request should be retried, - checks of retry limit, preparing the request before retry and introducing delay (backoff) before retries. - - - A retry policy specifies all aspects of retry behavior. This includes conditions when the request should be retried, - checks of retry limit, preparing the request before retry and introducing delay (backoff) before retries. - - - - - Maximum number of retries to be performed. - This does not count the initial request. - - - - - The logger used to log messages. - - - - - The standard set of throttling error codes - - - - - The standard set of timeout error codes to retry on. - - - - - List of AWS specific error codes which are returned as part of the error response. - These error codes will be retried. - - - - - The standard set of transient error, HTTP status codes to retry on. - 502 and 504 are returned by proxies. These can also be returned for - S3 accelerate requests which are served by CloudFront. - - - - - Set of web exception status codes to retry on. - - - - - This parameter serves as the value to the CapacityManager.Container datastructure. - Its properties include the available capacity left for making a retry request and the maximum - capacity size. - - - - - Checks if a retry should be performed with the given execution context and exception. - - The execution context which contains both the - requests and response context. - The exception thrown after issuing the request. - Returns true if the request should be retried, else false. The exception is retried if it matches with clockskew error codes. - - - - Returns true if the request is in a state where it can be retried, else false. - - The execution context which contains both the - requests and response context. - Returns true if the request is in a state where it can be retried, else false. - - - - Return true if the request should be retried for the given exception. - - The execution context which contains both the - requests and response context. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Checks if the retry limit is reached. - - The execution context which contains both the - requests and response context. - Return false if the request can be retried, based on number of retries. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called on a successful request response. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called before a retry request is initiated. The value - returned is True by default(retry throttling feature is disabled). - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called before a retry request is initiated. The value - returned is True by default(retry throttling feature is disabled). - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - - - - Virtual method that gets called before a retry request is initiated. The value - returned is True by default(retry throttling feature is disabled). - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - true if the error that will be retried is a throttling error - - - - This method uses a token bucket to enforce the maximum sending rate. - - The execution context which contains both the - requests and response context. - If the prior request failed, this exception is expected to be - the exception that occurred during the prior request failure. - - - - Determines if an AmazonServiceException is a throttling error - - The current exception to check. - true if it is a throttling error else false. - - - - Determines if an AmazonServiceException is a transient error that - should be retried. - - The current execution context - The current exception to check. - true if the exception is a transient error else false. - - - - Determines if the exception is a known timeout error code that - should be retried under the timeout error category. - - The current exception to check. - true if the exception is considered a timeout else false - - - - Checks if a retry should be performed with the given execution context and exception. - - The execution context which contains both the - requests and response context. - The exception throw after issuing the request. - Returns true if the request should be retried, else false. The exception is retried if it matches with clockskew error codes. - - - - This method uses a token bucket to enforce the maximum sending rate. - - The execution context which contains both the - requests and response context. - If the prior request failed, this exception is expected to be - the exception that occurred during the prior request failure. - - - - Return true if the request should be retried for the given exception. - - The execution context which contains both the - requests and response context. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - ICoreAmazonKMS is not meant to be used directly. It defines Key Management Service - with basic .NET types and allows other services to be able to use the service as - a runtime dependency. This interface is implemented by the AmazonKeyManagementServiceClient - defined in the AWSSDK.KeyManagementService assembly. - - - - - The result of the GenerateDataKey and GenerateDataKeyAsync operations. - - - - - The plaintext for the data key. - - - - - The ciphertext for the data key. - - - - - ICoreAmazonS3 is not meant to use directly. It defines S3 with basic .NET types - and allows other services to be able to use S3 as a runtime dependency. This interface - is implemented by the AmazonS3Client defined in the S3 assembly. - - - ICoreAmazonS3 is not meant to use directly. It defines S3 with basic .NET types - and allows other services to be able to use S3 as a runtime dependency. This interface - is implemented by the AmazonS3Client defined in the S3 assembly. - - - - - Generate a presigned URL. - - - - - - - - - - Get all the object keys for the particular bucket and key prefix. - - - - - - - - - Upload an object from a stream. - - - - - - - - - - - Delete an object. - - - - - - - - - - Delete an object. - - - - - - - - - - Open a stream to an object in S3. - - - - - - - - - - Upload an object from a file path. - - - - - - - - - - - Download an object in S3 to a file path. - - - - - - - - - - - Set the ACL on the object to public readable. - - - - - - - - Check to see if the bucket exists and if it doesn't create the bucket. - - - - - - Check to see if the bucket exists. - - - - - - - ICoreAmazonSQS is not meant to use directly. It defines SQS with basic .NET types - and allows other services to be able to use SQS as a runtime dependency. This interface - is implemented by the AmazonSQSClient defined in the SQS assembly. - - - - - Get the attributes for the queue identified by the queue URL asynchronously. - - The queue URL to get attributes for. - A Task containing the result of a dictionary of attributes for the queue. - - - - Set the attributes on the queue identified by the queue URL asynchronously. - - The queue URL to set the attributues. - The attributes to set. - A Task - - - - ICoreAmazonSTS is not meant to be used directly. It defines Security Token - service with basic .NET types and allows other services to be able to use the service as - a runtime dependency. This interface is implemented by the AmazonSecurityTokenServiceClient - defined in the AWSSDK.SecurityToken assembly. - - - - - - This method is used internally to access the Amazon Security Token - service within other service assemblies. - Please use AmazonSecurityTokenServiceClient to access the Amazon Security Token - service instead. - - Use Amazon Security Token Service to assume a role. - - Proxy settings that are required for the HTTPS and STS calls made during the authentication/credential - generation process are supported and should have been configured on the STS ClientConfig instance - associated with the STS client instance exposing this interface. - - - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRole. - - - - - CoreAmazonKMS is not meant to use directly. It implements ICoreAmazonKMS - and allows other service clients to be able to use the KMS service as a runtime dependency. - - This class waits until a method is actually called on the ICoreAmazonKMS interface - before requiring the KMS assembly to be present and loaded. - - - - - Settings for configuring a proxy for the SDK to use. - - - - - The host name or IP address of the proxy server. - - - - - The port number of the proxy. - - - - - The username to authenticate with the proxy server. - - - - - The password to authenticate with the proxy server. - - - - - Collection of one or more regular expressions denoting addresses - for which the proxy will not be used. - - - For more information on bypass lists - see https://msdn.microsoft.com/en-us/library/system.net.webproxy.bypasslist%28v=vs.110%29.aspx. - - - - - If true requests to local addresses bypass the configured - proxy. - - - - - Settings for logging in the SDK. - - - - - Logging destination. - - - - - When to log responses. - - - - - Gets or sets the size limit in bytes for logged responses. - If logging for response body is enabled, logged response - body is limited to this size. The default limit is 1KB. - - - - - Whether or not to log SDK metrics. - - - - - A custom formatter added through Configuration - - - - - This class can be used to discover the public address ranges for AWS. The - information is retrieved from the publicly accessible - https://ip-ranges.amazonaws.com/ip-ranges.json file. - - - The information in this file is generated from our internal system-of-record and - is authoritative. You can expect it to change several times per week and should - poll accordingly. - - - - - Region identifier string for ROUTE53 and CLOUDFRONT ranges - - - - - Collection of service keys found in the data file. - - - - - The publication date and time of the file that was downloaded and parsed. - - - - - Collection of all public IP ranges. - - - - - Filtered collection of public IP ranges for the given service key - - - - - Filtered collection of public IP ranges for the given region (us-east-1 etc) or GLOBAL. - - - - - Filtered collection of public IP ranges for the given network border group. - - - - - Downloads the most recent copy of the endpoint address file and - parses it to a collection of address range objects. - - - - - Downloads the most recent copy of the endpoint address file and - parses it to a collection of address range objects. - - - - - Represents the IP address range for a single region and service key. - - - - - The public IPv4 or Ipv6 address range, in CIDR notation. - - - - - Indicates ipv4 or v6 format of the address - - - - - The AWS region or GLOBAL for edge locations. Note that the CLOUDFRONT and ROUTE53 - ranges are GLOBAL. - - - - - The subset of IP address ranges. Specify AMAZON to get all IP address ranges - (for example, the ranges in the EC2 subset are also in the AMAZON subset). Note - that some IP address ranges are only in the AMAZON subset. - - - Valid values for the service key include "AMAZON", "EC2", "ROUTE53", - "ROUTE53_HEALTHCHECKS", and "CLOUDFRONT." If you need to know all of - the ranges and don't care about the service, use the "AMAZON" entries. - The other entries are subsets of this one. Also, some of the services, - such as S3, are represented in "AMAZON" and do not have an entry that - is specific to the service. We plan to add additional values over time; - code accordingly! - - - - - The network border group the IP address range belongs to. - - - AWS Local Zones allow you to seamlessly connect to the full range of services in the AWS Region such - as Amazon Simple Storage Service and Amazon DynamoDB through the same APIs and tool sets. You can extend - your VPC Region by creating a new subnet that has a Local Zone assignment. When you create a subnet in - a Local Zone, the VPC is also extended to that Local Zone. - - A network border group is a unique set of Availability Zones or Local Zones from where AWS advertises - public IP addresses. - - When you create a VPC that has IPv6 addresses, you can choose to assign a set of Amazon-provided public - IP addresses to the VPC and also set a network border group for the addresses that limits the addresses - to the group. When you set a network border group, the IP addresses cannot move between network - border groups. The us-west-2 network border group contains the four US West (Oregon) Availability Zones. - The us-west-2-lax-1 network border group contains the Los Angeles Local Zones. - - - - - This class defines utilities and constants that can be used by - all the client libraries of the SDK. - - - - - The user agent string header - - - - - The Set of accepted and valid Url characters per RFC3986. - Characters outside of this set will be encoded. - - - - - The Set of accepted and valid Url characters per RFC1738. - Characters outside of this set will be encoded. - - - - - The set of accepted and valid Url path characters per RFC3986. - - - - - The string representing Url Encoded Content in HTTP requests - - - - - The GMT Date Format string. Used when parsing date objects - - - - - The ISO8601Date Format string. Used when parsing date objects - - - - - The ISO8601Date Format string. Used when parsing date objects - - - - - The ISO8601 Basic date/time format string. Used when parsing date objects - - - - - The ISO8601 basic date format. Used during AWS4 signature computation. - - - - - The RFC822Date Format string. Used when parsing date objects - - - - - Returns an extension of a path. - This has the same behavior as System.IO.Path.GetExtension, but does not - check the path for invalid characters. - - - - - - Convert request parameters to Url encoded query string - - - Convert Dictionary of parameters to Url encoded query string - - - - Returns the canonicalized resource path for the service endpoint with single URL encoded path segments. - - Endpoint URL for the request - Resource path for the request - - If resourcePath begins or ends with slash, the resulting canonicalized - path will follow suit. - - Canonicalized resource path for the endpoint - - - - Returns the canonicalized resource path for the service endpoint - - Endpoint URL for the request - Resource path for the request - If true pre URL encode path segments if necessary. - S3 is currently the only service that does not expect pre URL encoded segments. - - If resourcePath begins or ends with slash, the resulting canonicalized - path will follow suit. - - Canonicalized resource path for the endpoint - - - - Returns the canonicalized resource path for the service endpoint - - Endpoint URL for the request - Resource path for the request - If true pre URL encode path segments if necessary. - S3 is currently the only service that does not expect pre URL encoded segments. - Dictionary of key/value parameters containing the values for the ResourcePath key replacements - The version of the marshaller that constructed the request object. - - If resourcePath begins or ends with slash, the resulting canonicalized - path will follow suit. - - Canonicalized resource path for the endpoint - - - - Splits the resourcePath at / into segments then resolves any keys with the path resource values. Greedy - key values will be split into multiple segments at each /. - - The patterned resourcePath - The key/value lookup for the patterned resourcePath - A list of path segments where all keys in the resourcePath have been resolved to one or more path segment values - - - - Joins all path segments with the / character and encodes each segment before joining. - - The segments of a URL path split at each / character - If the path property is specified, - the accepted path characters {/+:} are not encoded. - A joined URL with encoded segments - - - - Takes a patterned resource path and resolves it using the key/value path resources into - a segmented encoded URL. - - The patterned resourcePath - The key/value lookup for the patterned resourcePath - A segmented encoded URL - - - - Returns a new string created by joining each of the strings in the - specified list together, with a comma between them. - - The list of strings to join into a single, comma delimited - string list. - A new string created by joining each of the strings in the - specified list together, with a comma between strings. - - - - Attempt to infer the region for a service request based on the endpoint - - Endpoint to the service to be called - - Region parsed from the endpoint; DefaultRegion (or DefaultGovRegion) - if it cannot be determined/is not explicit - - - - - Attempt to infer the service name for a request (in short form, eg 'iam') from the - service endpoint. - - Endpoint to the service to be called - - Short-form name of the service parsed from the endpoint; empty string if it cannot - be determined - - - - - Utility method for converting Unix epoch seconds to DateTime structure. - - The number of seconds since January 1, 1970. - Converted DateTime structure - - - - Helper function to format a byte array into string - - The data blob to process - If true, returns hex digits in lower case form - String version of the data - - - - Calls a specific EventHandler in a background thread - - - - - - - - Parses a query string of a URL and returns the parameters as a string-to-string dictionary. - - - - - - - Utility method for converting a string to a MemoryStream. - - - - - - - Utility method for copy the contents of the source stream to the destination stream. - - - - - - - Utility method for copy the contents of the source stream to the destination stream. - - - - - - - - Formats the current date as a GMT timestamp - - A GMT formatted string representation - of the current date and time - - - - - Formats the current date as ISO 8601 timestamp - - An ISO 8601 formatted string representation - of the current date and time - - - - - Gets the ISO8601 formatted timestamp that is minutesFromNow - in the future. - - The number of minutes from the current instant - for which the timestamp is needed. - The ISO8601 formatted future timestamp. - - - - Formats the current date as ISO 8601 timestamp - - An ISO 8601 formatted string representation - of the current date and time - - - - - Gets the RFC822 formatted timestamp that is minutesFromNow - in the future. - - The number of minutes from the current instant - for which the timestamp is needed. - The ISO8601 formatted future timestamp. - - - - Determines whether the given string is an absolute path to a root. - - The hypothetical absolute path. - True if is an absolute path. - - - - Returns true if the path specified is relative to the current drive or working directory. - Returns false if the path is fixed to a specific drive or UNC path. This method does no - validation of the path (URIs will be returned as relative as a result). - - - Handles paths that use the alternate directory separator. It is a frequent mistake to - assume that rooted paths (Path.IsPathRooted) are not relative. This isn't the case. - "C:a" is drive relative- meaning that it will be resolved against the current directory - for C: (rooted, but relative). "C:\a" is rooted and not relative (the current directory - will not be used to modify the path). - - - - - True if the given character is a directory separator. - - - - - Returns true if the given character is a valid drive letter - - - - - URL encodes a string per RFC3986. If the path property is specified, - the accepted path characters {/+:} are not encoded. - - The string to encode - Whether the string is a URL path or not - The encoded string - - - - URL encodes a string per the specified RFC. If the path property is specified, - the accepted path characters {/+:} are not encoded. - - RFC number determing safe characters - The string to encode - Whether the string is a URL path or not - The encoded string - - Currently recognised RFC versions are 1738 (Dec '94) and 3986 (Jan '05). - If the specified RFC is not recognised, 3986 is used by default. - - - - - URL encodes a string per the specified RFC with the exception of preserving the encoding of previously encoded slashes. - If the path property is specified, the accepted path characters {/+:} are not encoded. - - The string to encode - Whether the string is a URL path or not - The encoded string with any previously encoded %2F preserved - - - - Convert bytes to a hex string - - Bytes to convert. - Hexadecimal string representing the byte array. - - - - Convert a hex string to bytes - - Hexadecimal string - Byte array corresponding to the hex string. - - - - Returns DateTime.UtcNow + ManualClockCorrection when - is set. - This value should be used instead of DateTime.UtcNow to factor in manual clock correction - - - - - Returns true if the string has any bidirectional control characters. - - - - - - - Executes an HTTP request and returns the response as a string. This method - throws WebException and HttpRequestException. In the event HttpRequestException - is thrown the StatusCode is sent as user defined data on the exception under - the key "StatusCode". - - The URI to make the request to - The request type: GET, PUT, POST - null or the content to send with the request - Timeout for the request - Proxy for the request - null or any headers to send with the request - The response as a string. - - - - Utility method that accepts a string and replaces white spaces with a space. - - - - - - - Class that contains result of executing an external process through the SDKs - AWSSDKUtils.RunProcess/AWSSDKUtils.RunProcessAsync - - - - - The exit code with which the process exited - - - - - The output of the process read till the end - - - - - The error output of the process read till the end - - - - - Object to track circular references in nested types. - At each level of nesting, make a call to Track to retrieve Tracker, - a tracking object implementing the IDisposable interface. - Dispose of this tracker when leaving the context of the tracked object. - - - - - Tracker. Must be disposed. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Adds the current target to a reference list and returns a tracker. - The tracker removes the target from the reference list when the - tracker is disposed. - - - - - - - Root AWS config - - - - - AwsHttpClient is a wrapper around HttpClient class of the System.Net.Http library. - The wrapper has been added so as to remove System.Net.Http dependencies from the Services - and migrate it to a Core level dependecy only. This avoids version clashes when a service - and the Core depends on different versions of the System.Net.Http library. This is a Service - level utility method - - - - - AWSHttpClient wrapper that is wrapped around - HttpClient default wrapper. - - - - - AWSHttpClient BaseAddress property that is wrapper for - HttpClient BaseAddress property. - - - - - AWSHttpClient Timeout property that is wrapper for - HttpClient Timeout property. - - - - - AWSHttpClient MaxResponseContentBufferSize property that is wrapper for - HttpClient MaxResponseContentBufferSize property. - - - - - AWSHttpClient GetStreamAsync that accepts the requester's URI - and make a HttpClient.GetStreamAsync call. - - Requester Uri - - - - Wrapper method that accepts a request uri, stream content and headers and makes a sendAsync call. - - - - - - - Wrapper for HttpClient's HttpRequestMessage and SendAsync methods. - - - - Returns response headers information- header name,value and status code - - - - Wrapper for HttpClient Dispose. - - - - - Method that checks if the passed exception is of type - HttpRequestException - - - - - - - AWSStreamContent is a wrapper for StreamContent class in - the System.Net.Http library.The wrapper has been added so as to - remove System.Net.Http dependencies from the Services - and migrate it to a Core level dependecy only. This avoids version clashes when a service - and the Core depends on different versions of the System.Net.Http library. This is a Service - level utility method - - - - - Wrapper for StreamContent constructor - for stream content - - - - - - Wrapper for StreamContent constructor - for stream content and bufferSize - - - - - - - Wrapper to allow Services to remove StreamContent Headers - - - - - - - Wrapper to allow Services to add StreamContent Headers - - - - - - - Wrapper for StreamContent Dispose. - - - - - Allows to configure the proxy used for HTTP requests. The default value is null. - - - - - This class contains the endpoints available to the AWS clients. The static constants representing the - regions can be used while constructing the AWS client instead of looking up the exact endpoint URL. - - - - - Gets the endpoint for a service in a region. - - The services system name. - If true returns the endpoint for dualstack - Thrown when the request service does not have a valid endpoint in the region. - - - - - Enumerate through all the regions. - - - - - Gets the region based on its system name like "us-west-1" - - The system name of the service like "us-west-1" - - - - - This is a testing method and should not be called by production applications. - - - - - Gets the system name of a region. - - - - - Gets the display name of a region. - - - - - This region name is non-standard. Search the whole endpoints.json file to - determine the partition this region is in. - - - - - This class contains region information used to lazily compute the service endpoints. The static constants representing the - regions can be used while constructing the AWS client instead of looking up the exact endpoint URL. - - - - - The US East (Virginia) endpoint. - - - - - The US East (Virginia) regional endpoint. - - - - - The US East (Ohio) endpoint. - - - - - The US West (N. California) endpoint. - - - - - The US West (Oregon) endpoint. - - - - - The EU North (Stockholm) endpoint. - - - - - The EU West (Ireland) endpoint. - - - - - The EU West (London) endpoint. - - - - - The EU West (Paris) endpoint. - - - - - The EU Central (Frankfurt) endpoint. - - - - - The Europe (Milan) endpoint. - - - - - The Asia Pacific (Hong Kong) endpoint. - - - - - The Asia Pacific (Tokyo) endpoint. - - - - - The Asia Pacific (Seoul) endpoint. - - - - - The Asia Pacific (Osaka-Local) endpoint. - - - - - The Asia Pacific (Mumbai) endpoint. - - - - - The Asia Pacific (Singapore) endpoint. - - - - - The Asia Pacific (Sydney) endpoint. - - - - - The South America (Sao Paulo) endpoint. - - - - - The US GovCloud East (Virginia) endpoint. - - - - - The US GovCloud West (Oregon) endpoint. - - - - - The China (Beijing) endpoint. - - - - - The China (Ningxia) endpoint. - - - - - The Canada (Central) endpoint. - - - - - The Middle East (Bahrain) endpoint. - - - - - The Africa (Cape Town) endpoint. - - - - - Represents the endpoint overridding rules in the endpoints.json - Is used to map private region (ie us-east-1-regional) to public regions (us-east-1) - For signing purposes. - - - - - Enumerate through all the regions. - - - - - Gets the region based on its system name like "us-west-1" - - The system name of the service like "us-west-1" - - - - - Gets the region endpoint override if exists - - The region endpoint to find the possible override for - - - - - Gets the system name of a region. - - - - - Gets the display name of a region. - - - - - Gets the partition name the region is in. For example for us-east-1 the partition name is aws. For cn-northwest-1 the partition name is aws-cn. - - - - - Gets the dns suffix for the region endpoints in a partition. For example the aws partition's suffix is amazonaws.com. The aws-cn partition's suffix is amazonaws.com.cn. - - - - - Gets the endpoint for a service in a region. - - - The services system name. Service system names can be obtained from the - RegionEndpointServiceName member of the ClientConfig-derived class for the service. - - - For forwards compatibility, if the service being requested for isn't known in the region, this method - will generate an endpoint using the AWS endpoint heuristics. In this case, it is not guaranteed the - endpoint will point to a valid service endpoint. - - - - - - Gets the endpoint for a service in a region, optionally selecting a dualstack compatible endpoint. - - - The services system name. Service system names can be obtained from the - RegionEndpointServiceName member of the ClientConfig-derived class for the service. - - - If true a dualstack endpoint is returned. It is the user's responsibility to verify that the given service - supports a dualstack endpoint for the region. - - - For forwards compatibility, if the service being requested for isn't known in the region, this method - will generate an endpoint using the AWS endpoint heuristics. In this case, it is not guaranteed the - endpoint will point to a valid service endpoint. - - - - - - This class defines an endpoints hostname and which protocols it supports. - - - - - Gets the hostname for the service. - - - - - The authentication region to be used in request signing. - - - - - This property is only set for S3 endpoints. For all other services this property returns null. - For S3 endpoints, if the endpoint supports signature version 2 this property will be "2", otherwise it will be "4". - - - - - Calculates a 32bit Cyclic Redundancy Checksum (CRC) using the - same polynomial used by Zip. This type is used internally by DotNetZip; it is generally not used directly - by applications wishing to create, read, or manipulate zip archive files. - - - - - indicates the total number of bytes read on the CRC stream. - This is used when writing the ZipDirEntry when compressing files. - - - - - Indicates the current CRC for all blocks slurped in. - - - - - Returns the CRC32 for the specified stream. - - The stream over which to calculate the CRC32 - the CRC32 calculation - - - - Returns the CRC32 for the specified stream, and writes the input into the output stream. - - The stream over which to calculate the CRC32 - The stream into which to deflate the input - the CRC32 calculation - - - - Get the CRC32 for the given (word,byte) combo. - This is a computation defined by PKzip. - - The word to start with. - The byte to combine it with. - The CRC-ized result. - - - - Update the value for the running CRC32 using the given block of bytes. - This is useful when using the CRC32() class in a Stream. - - block of bytes to slurp - starting point in the block - how many bytes within the block to slurp - - - - A Stream that calculates a CRC32 (a checksum) on all bytes read, - or on all bytes written. - - - - - This class can be used to verify the CRC of a ZipEntry when reading from a stream, - or to calculate a CRC when writing to a stream. The stream should be used to either - read, or write, but not both. If you intermix reads and writes, the results are - not defined. - - This class is intended primarily for use internally by the DotNetZip library. - - - - - Gets the total number of bytes run through the CRC32 calculator. - - - - This is either the total number of bytes read, or the total number - of bytes written, depending on the direction of this stream. - - - - - The constructor. - - The underlying stream - - - - The constructor. - - The underlying stream - The length of the stream to slurp - - - - Provides the current CRC for all blocks slurped in. - - - - - Read from the stream - - the buffer to read - the offset at which to start - the number of bytes to read - the number of bytes actually read - - - - Write to the stream. - - the buffer from which to write - the offset at which to start writing - the number of bytes to write - - - - Indicates whether the stream supports reading. - - - - - Indicates whether the stream supports seeking. - - - - - Indicates whether the stream supports writing. - - - - - Flush the stream. - - - - - Not implemented. - - - - - Not implemented. - - - - - Not implemented. - - N/A - N/A - N/A - - - - Not implemented. - - N/A - - - diff --git a/packages/AWSSDK.Core.3.3.107.14/lib/wp8/AWSSDK.Core.dll b/packages/AWSSDK.Core.3.3.107.14/lib/wp8/AWSSDK.Core.dll deleted file mode 100644 index 1a46660..0000000 Binary files a/packages/AWSSDK.Core.3.3.107.14/lib/wp8/AWSSDK.Core.dll and /dev/null differ diff --git a/packages/AWSSDK.Core.3.3.107.14/lib/wpa81/AWSSDK.Core.XML b/packages/AWSSDK.Core.3.3.107.14/lib/wpa81/AWSSDK.Core.XML deleted file mode 100644 index 5323a9e..0000000 --- a/packages/AWSSDK.Core.3.3.107.14/lib/wpa81/AWSSDK.Core.XML +++ /dev/null @@ -1,10800 +0,0 @@ - - - - AWSSDK.Core - - - - - Utility class to parse Amazon resource names more commonly known as an ARN. - - - - - Gets and sets the partition associated with the ARN (e.g.: 'aws'). - - - - - Gets and sets the AWS service associated with the ARN (e.g.: 's3'). - - - - - Gets and sets the region associated with the ARN (e.g.: 'us-east-1'). - - - - - Gets and sets the account ID associated with the ARN. - - - - - Gets and sets the resource associated with the ARN (e.g.: 'mybucket/myobject'). - - - - - Returns true if the string appears to be an ARN by seeing if the string starts with "arn:". This method - doesn't guarantee the string is a valid ARN. To validate the string call TryParse. - - - - - - - Parses the string into an ARN object. - - String to parse into an ARN. - The out parameter for the ARN object created by TryParse. - True if the string was parsed into an ARN object. - - - - Parses the string into an ARN object. - - String to parse into an Arn. - The Arn object created from the passed in string. - Thrown if arnString is null. - Thrown if the string passed in not valid ARN. - - - - Turns the Arn object into a string representation of an ARN. - - - - - - Configuration options that apply to the entire SDK. - - These settings can be configured through app.config or web.config. - Below is a full sample configuration that illustrates all the possible options. - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws region="us-west-2"> - <logging logTo="Log4Net, SystemDiagnostics" logResponses="Always" logMetrics="true" /> - <s3 useSignatureVersion4="true" /> - <proxy host="localhost" port="8888" username="1" password="1" /> - - <dynamoDB> - <dynamoDBContext tableNamePrefix="Prod-"> - - <tableAliases> - <alias fromTable="FakeTable" toTable="People" /> - <alias fromTable="Persons" toTable="People" /> - </tableAliases> - - <mappings> - <map type="Sample.Tests.Author, SampleDLL" targetTable="People" /> - <map type="Sample.Tests.Editor, SampleDLL" targetTable="People"> - <property name="FullName" attribute="Name" /> - <property name="EmployeeId" attribute="Id" /> - <property name="ComplexData" converter="Sample.Tests.ComplexDataConverter, SampleDLL" /> - <property name="Version" version="true" /> - <property name="Password" ignore="true" /> - </map> - </mappings> - - </dynamoDBContext> - </dynamoDB> - </aws> - - - - Configuration options that apply to the entire SDK. - - - - - Manual offset to apply to client clock. This is a global setting that overrides - ClockOffset value calculated for all service endpoints. - - - - - Determines if the SDK should correct for client clock skew - by determining the correct server time and reissuing the - request with the correct time. - Default value of this field is True. - will be updated with the calculated - offset even if this field is set to false, though requests - will not be corrected or retried. - Ignored if is set. - - - - - The calculated clock skew correction, if there is one. - This field will be set if a service call resulted in an exception - and the SDK has determined that there is a difference between local - and server times. - - If is set to true, this - value will be set to the correction, but it will not be used by the - SDK and clock skew errors will not be retried. - - - - - Key for the AWSRegion property. - - - - - - Configures the default AWS region for clients which have not explicitly specified a region. - Changes to this setting will only take effect for newly constructed instances of AWS clients. - - This setting can be configured through the App.config. For example: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws region="us-west-2" /> - - - - - - Key for the AWSProfileName property. - - - - - - Profile name for stored AWS credentials that will be used to make service calls. - Changes to this setting will only take effect in newly-constructed clients. - - To reference the account from an application's App.config or Web.config use the AWSProfileName setting. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="development"/> - </appSettings> - </configuration> - - - - - - - Key for the AWSProfilesLocation property. - - - - - - Location of the credentials file shared with other AWS SDKs. - By default, the credentials file is stored in the .aws directory in the current user's home directory. - - Changes to this setting will only take effect in newly-constructed clients. - - To reference the profile from an application's App.config or Web.config use the AWSProfileName setting. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfilesLocation" value="c:\config"/> - </appSettings> - </configuration> - - - - - - - Key for the Logging property. - - - - - - Configures how the SDK should log events, if at all. - Changes to this setting will only take effect in newly-constructed clients. - - The setting can be configured through App.config, for example: - - <appSettings> - <add key="AWSLogging" value="log4net"/> - </appSettings> - - - - - - Key for the ResponseLogging property. - - - - - - - Configures when the SDK should log service responses. - Changes to this setting will take effect immediately. - - The setting can be configured through App.config, for example: - - <appSettings> - <add key="AWSResponseLogging" value="OnError"/> - </appSettings> - - - - - - Key for the LogMetrics property. - - - - - - Configures if the SDK should log performance metrics. - This setting configures the default LogMetrics property for all clients/configs. - Changes to this setting will only take effect in newly-constructed clients. - - The setting can be configured through App.config, for example: - - <appSettings> - <add key="AWSLogMetrics" value="true"/> - </appSettings> - - - - - - Key for the EndpointDefinition property. - - - - - - Configures if the SDK should use a custom configuration file that defines the regions and endpoints. - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws endpointDefinition="c:\config\endpoints.json" /> - - - - - - Key for the UseSdkCache property. - - - - - - Configures if the SDK Cache should be used, the default value is true. - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws useSdkCache="true" /> - - - - - - Configuration for the Logging section of AWS configuration. - Changes to some settings may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws> - <logging logTo="Log4Net, SystemDiagnostics" logResponses="Always" logMetrics="true" /> - </aws> - - - - - - Configuration for the Proxy section of AWS configuration. - Changes to some settings may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws> - <proxy host="localhost" port="8888" username="1" password="1" bypassList="addressexpr1;addressexpr2;..." bypassOnLocal="true" /> - </aws> - - - - - - Configuration for the region endpoint section of AWS configuration. - Changes may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws region="us-west-2" /> - - - - - - Lock for SomeEvent delegate access. - - - - - This method should never be called directly. - Call AWSSDKUtils.CorrectedUtcNow instead. - - - - - - Logging options. - Can be combined to enable multiple loggers. - - - - - No logging - - - - - Log using log4net - - - - - Log using System.Diagnostics - - - - - Log to the console - - - - - Log to a file - - - - - Response logging option. - - - - - Never log service response - - - - - Only log service response when there's an error - - - - - Always log service response - - - - - Format for metrics data in the logs - - - - - Emit metrics in human-readable format - - - - - Emit metrics as JSON data - - - - - An access control policy action identifies a specific action in a service - that can be performed on a resource. For example, sending a message to a - queue. - - ActionIdentifiers allow you to limit what your access control policy statement affects. - For example, you could create a policy statement that enables a certain group - of users to send messages to your queue, but not allow them to perform any - other actions on your queue. - - - The action is B in the statement - "A has permission to do B to C where D applies." - - Free form access control policy actions may include a wildcard (*) to match - multiple actions. - - - Constants for known actions can be found in the Amazon.Auth.AccessControlPolicy.ActionIdentifiers namespace. - - - - - - Constructs an Actionidentifer with the given action name. - - The name of the action - - - - Gets and sets the name of this action. For example, 'sqs:SendMessage' is the - name corresponding to the SQS action that enables users to send a message - to an SQS queue. - - - - - AWS access control policy conditions are contained in - objects, and affect when a statement is applied. For example, a statement - that allows access to an Amazon SQS queue could use a condition to only apply - the effect of that statement for requests that are made before a certain - date, or that originate from a range of IP addresses. - - Multiple conditions can be included in a single statement, and all conditions - must evaluate to true in order for the statement to take effect. - - - The set of conditions is D in the statement - "A has permission to do B to C where D applies." - - - A condition is composed of three parts: - - - Condition Key - The condition key declares which value of a - request to pull in and compare against when a policy is evaluated by AWS. For - example, using will cause - AWS to pull in the current request's source IP as the first value to compare - against every time your policy is evaluated. - - - - Comparison Type - This is a static value used as the second value - in the comparison when your policy is evaluated. Depending on the comparison - type, this value can optionally use wildcards. See the documentation for - individual comparison types for more information. - - - - Comparison Value - This is a static value used as the second value - in the comparison when your policy is evaluated. Depending on the comparison - type, this value can optionally use wildcards. See the documentation for - individual comparison types for more information. - - - - - - - - - Gets the type of this condition. - - - - - Gets and Sets the name of the condition key involved in this condition. - Condition keys are predefined values supported by AWS that provide input - to a condition's evaluation, such as the current time, or the IP address - of the incoming request. - - Your policy is evaluated for each incoming request, and condition keys - specify what information to pull out of those incoming requests and plug - into the conditions in your policy. - - - - - - Gets and Sets the values specified for this access control policy condition. - For example, in a condition that compares the incoming IP address of a - request to a specified range of IP addresses, the range of IP addresses - is the single value in the condition. - - Most conditions accept only one value, but multiple values are possible. - - - - - - A factory for creating conditions to be used in the policy. - - - - - Condition key for the current time. - - This condition key should only be used with enum. - - - - - - Condition key for whether or not an incoming request is using a secure - transport to make the request (i.e. HTTPS instead of HTTP). - - This condition key should only be used with the boolean overload of NewCondition. - - - - - - Condition key for the source IP from which a request originates. - - This condition key should only be used with enum. - - - - - - Condition key for the user agent included in a request. - - This condition key should only be used with - enum. - - - - - - Condition key for the current time, in epoch seconds. - - This condition key should only be used with enum. - objects. - - - - - - Condition key for the referrer specified by a request. - - This condition key should only be used with - objects. - - - - - - Condition key for the Amazon Resource Name (ARN) of the source specified - in a request. The source ARN indicates which resource is affecting the - resource listed in your policy. For example, an SNS topic is the source - ARN when publishing messages from the topic to an SQS queue. - - This condition key should only be used with enum. - - - - - - Enumeration of the supported ways an ARN comparison can be evaluated. - - - - Exact matching - - - - Loose case-insensitive matching of the ARN. Each of the six - colon-delimited components of the ARN is checked separately and each - can include a multi-character match wildcard (*) or a - single-character match wildcard (?). - - - - Negated form of ArnEquals - - - Negated form of ArnLike - - - - Enumeration of the supported ways a date comparison can be evaluated. - - - - - Enumeration of the supported ways an IP address comparison can be evaluated. - - - - - Matches an IP address against a CIDR IP range, evaluating to true if - the IP address being tested is in the condition's specified CIDR IP - range. - - - - - Negated form of IpAddress - - - - - Enumeration of the supported ways a numeric comparison can be evaluated - - - - - Enumeration of the supported ways a string comparison can be evaluated. - - - - - Case-sensitive exact string matching - - - - - Case-insensitive string matching - - - - - Loose case-insensitive matching. The values can include a - multi-character match wildcard (*) or a single-character match - wildcard (?) anywhere in the string. - - - - - Negated form of StringEquals. - - - - - Negated form of StringEqualsIgnorecase. - - - - - Negated form of StringLike. - - - - - Constructs a new access control policy condition that compares ARNs (Amazon Resource Names). - - The access policy condition key specifying where to get the first ARN for the comparison - The type of comparison to perform. - The second ARN to compare against. When using ArnLike or ArnNotLike this may contain the - multi-character wildcard (*) or the single-character wildcard - - - - Constructs a new access policy condition that performs a boolean - comparison. - - The access policy condition key specifying where to get the - first boolean value for the comparison (ex: aws:SecureTransport). - The boolean to compare against. - - - - This method is deprecated. Invoking this method results in non-UTC DateTimes - not being marshalled correctly. Use NewConditionUtc instead. - Constructs a new access policy condition that compares the current time - (on the AWS servers) to the specified date. - - The type of comparison to perform. For example, - DateComparisonType.DateLessThan will cause this policy - condition to evaluate to true if the current date is less than - the date specified in the second argument. - The date to compare against. - - - - Constructs a new access policy condition that compares the current time - (on the AWS servers) to the specified date. - - The type of comparison to perform. For example, - DateComparisonType.DateLessThan will cause this policy - condition to evaluate to true if the current date is less than - the date specified in the second argument. - The date to compare against. - - - - Constructs a new access policy condition that compares the source IP - address of the incoming request to an AWS service against the specified - CIDR range. The condition evaluates to true (meaning the policy statement - containing it will be applied) if the incoming source IP address is - within that range. - - To achieve the opposite effect (i.e. cause the condition to evaluate to - true when the incoming source IP is not in the specified CIDR - range) use the alternate constructor form and specify - IpAddressComparisonType.NotIpAddress. - - - The CIDR IP range involved in the policy condition. - - - - Constructs a new access policy condition that compares the source IP - address of the incoming request to an AWS service against the specified - CIDR range. When the condition evaluates to true (i.e. when the incoming - source IP address is within the CIDR range or not) depends on the - specified IpAddressComparisonType. - - The type of comparison to to perform. - The CIDR IP range involved in the policy condition. - - - - Constructs a new access policy condition that compares two numbers. - - The type of comparison to perform. - The access policy condition key specifying where to get the - first number for the comparison. - The second number to compare against. - - - - Constructs a new access control policy condition that compares two - strings. - - The type of comparison to perform - The access policy condition key specifying where to get the - first string for the comparison (ex: aws:UserAgent). - - The second string to compare against. When using - StringComparisonType.StringLike or - StringComparisonType.StringNotLike this may contain - the multi-character wildcard (*) or the single-character - wildcard (?). - - - - - Constructs a new access policy condition that compares the Amazon - Resource Name (ARN) of the source of an AWS resource that is modifying - another AWS resource with the specified pattern. - - For example, the source ARN could be an Amazon SNS topic ARN that is - sending messages to an Amazon SQS queue. In that case, the SNS topic ARN - would be compared the ARN pattern specified here. - - - The endpoint pattern may optionally contain the multi-character wildcard - * (*) or the single-character wildcard (?). Each of the six colon-delimited - components of the ARN is checked separately and each can include a - wildcard. - - - Policy policy = new Policy("MyQueuePolicy"); - policy.WithStatements(new Statement(Statement.StatementEffect.Allow) - .WithPrincipals(new Principal("*")).WithActionIdentifiers(SQSActionIdentifiers.SendMessage) - .WithResources(new Resource(myQueueArn)) - .WithConditions(ConditionFactory.NewSourceArnCondition(myTopicArn))); - - - The ARN pattern against which the source ARN will be compared. - Each of the six colon-delimited components of the ARN is - checked separately and each can include a wildcard. - A new access control policy condition that compares the ARN of - the source specified in an incoming request with the ARN pattern - specified here. - - - - Constructs a new access control policy condition that tests if the - incoming request was sent over a secure transport (HTTPS). - - A new access control policy condition that tests if the incoming - request was sent over a secure transport (HTTPS). - - - - Condition key for the canned ACL specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the location constraint specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the prefix specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the delimiter specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the max keys specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the source object specified by a request to copy an - object. - - This condition key may only be used with enum. - - - - - - Condition key for the metadata directive specified by a request to copy - an object. - - This condition key may only be used with enum. - - - - - - Condition key for the version ID of an object version specified by a - request. - - This condition key may only be used with enum. - - - - - - Constructs a new access policy condition that compares an Amazon S3 - canned ACL with the canned ACL specified by an incoming request. - - You can use this condition to ensure that any objects uploaded to an - Amazon S3 bucket have a specific canned ACL set. - - - The Amazon S3 canned ACL to compare against. - A new access control policy condition that compares the Amazon S3 - canned ACL specified in incoming requests against the value - specified. - - - - Condition key for The URL, e-mail address, or ARN from a Subscribe - request or a previously confirmed subscription. Use with string - conditions to restrict access to specific endpoints (e.g., - *@mycompany.com). - - This condition key may only be used with enum. - - - - - - Condition key for the protocol value from a Subscribe request or a - previously confirmed subscription. Use with string conditions to restrict - publication to specific delivery protocols (e.g., HTTPS). - - This condition key may only be used with enum. - - - - - - Constructs a new access policy condition that compares the requested - endpoint used to subscribe to an Amazon SNS topic with the specified - endpoint pattern. The endpoint pattern may optionally contain the - multi-character wildcard (*) or the single-character wildcard (?). - - For example, this condition can restrict subscriptions to a topic to - email addresses in a certain domain ("*@my-company.com"). - - - Policy policy = new Policy("MyTopicPolicy"); - policy.WithStatements(new Statement(Statement.StatementEffect.Allow) - .WithPrincipals(new Principal("*")).WithActionIdentifiers(SNSActionIdentifiers.Subscribe) - .WithResources(new Resource(myTopicArn)) - .WithConditions(ConditionFactory.NewEndpointCondition("*@my-company.com"))); - - - The endpoint pattern against which to compare the requested - endpoint for an Amazon SNS topic subscription. - A new access control policy condition that compares the endpoint - used in a request to subscribe to an Amazon SNS topic with the - endpoint pattern specified. - - - - Constructs a new AWS access control policy condition that allows an - access control statement to restrict subscriptions to an Amazon SNS topic - based on the protocol being used for the subscription. For example, this - condition can restrict subscriptions to a topic to endpoints using HTTPS - to ensure that messages are securely delivered. - - The protocol against which to compare the requested protocol - for an Amazon SNS topic subscription. - A new access control policy condition that compares the - notification protocol requested in a request to subscribe to an - Amazon SNS topic with the protocol value specified. - - - - An AWS access control policy is a object that acts as a container for one or - more statements, which specify fine grained rules for allowing or denying - various types of actions from being performed on your AWS resources. - - By default, all requests to use your resource coming from anyone but you are - denied. Access control polices can override that by allowing different types - of access to your resources, or by explicitly denying different types of - access. - - - Each statement in an AWS access control policy takes the form: - "A has permission to do B to C where D applies". - - - A is the prinicpal - The AWS account that is making a request to - access or modify one of your AWS resources. - - - - B is the action - the way in which your AWS resource is being accessed or modified, such - as sending a message to an Amazon SQS queue, or storing an object in an Amazon S3 bucket. - - - - C is the resource - your AWS entity that the principal wants to access, such - as an Amazon SQS queue, or an object stored in Amazon S3. - - - - D is the set of conditions - optional constraints that specify when to allow or deny - access for the principal to access your resource. Many expressive conditions are available, - some specific to each service. For example you can use date conditions to allow access to - your resources only after or before a specific time. - - - - - - Note that an AWS access control policy should not be confused with the - similarly named "POST form policy" concept used in Amazon S3. - - - - - - The default policy version - - - - - Constructs an empty AWS access control policy ready to be populated with - statements. - - - - - Constructs a new AWS access control policy with the specified policy ID. - The policy ID is a user specified string that serves to help developers - keep track of multiple polices. Policy IDs are often used as a human - readable name for a policy. - - The policy ID for the new policy object. Policy IDs serve to - help developers keep track of multiple policies, and are often - used to give the policy a meaningful, human readable name. - - - - Constructs a new AWS access control policy with the specified policy ID - and collection of statements. The policy ID is a user specified string - that serves to help developers keep track of multiple polices. Policy IDs - are often used as a human readable name for a policy. - - The policy ID for the new policy object. Policy IDs serve to - help developers keep track of multiple policies, and are often - used to give the policy a meaningful, human readable name. - The statements to include in the new policy. - - - - Gets and Sets the policy ID for this policy. Policy IDs serve to help - developers keep track of multiple policies, and are often used as human - readable name for a policy. - - - - - Sets the policy ID for this policy and returns the updated policy so that - multiple calls can be chained together. - - Policy IDs serve to help developers keep track of multiple policies, and - are often used as human readable name for a policy. - - - The polich ID for this policy - this instance - - - - Gets and sets the version of this AWS policy. - - - - - Gets and Sets the collection of statements contained by this policy. Individual - statements in a policy are what specify the rules that enable or disable - access to your AWS resources. - - - - - Checks to see if the permissions set in the statement are already set by another - statement in the policy. - - The statement to verify - True if the statement's permissions are already allowed by the statement - - - - Sets the collection of statements contained by this policy and returns - this policy object so that additional method calls can be chained - together. - - Individual statements in a policy are what specify the rules that enable - or disable access to your AWS resources. - - - The collection of statements included in this policy. - this instance - - - - Returns a JSON string representation of this AWS access control policy, - suitable to be sent to an AWS service as part of a request to set an - access control policy. - - A JSON string representation of this AWS access control policy. - - - - Returns a JSON string representation of this AWS access control policy, - suitable to be sent to an AWS service as part of a request to set an - access control policy. - - Toggle pretty print for the generated JSON document - A JSON string representation of this AWS access control policy. - - - - Parses a JSON document of a policy and creates a Policy object. - - JSON document of a policy. - - - - - A principal is an AWS account which is being allowed or denied access to a - resource through an access control policy. The principal is a property of the - Statement object, not directly the object. - - The principal is A in the statement - "A has permission to do B to C where D applies." - - - In an access control policy statement, you can set the principal to all - authenticated AWS users through the member. This - is useful when you don't want to restrict access based on the identity of the - requester, but instead on other identifying characteristics such as the - requester's IP address. - - - - - - Principal instance that includes all authenticated AWS users. - - This is useful when you don't want to restrict access based on the - identity of the requester, but instead on other identifying - characteristics such as the requester's IP address. - - - - - - The anonymous Principal. - - - - - The default Principal provider for AWS accounts. - - - - - Principal provider for Canonical User IDs. - - - - - Principal provider for federated users (using a SAML identity provider) - - - - - Principal provider for assume role policies that will be assumed by an AWS service - (e.g. "ec2.amazonaws.com"). - - - - - Dummy principal provider for anonynous. - - - - - Constructs a new principal with the specified AWS account ID. - - An AWS account ID. - - - - Constructs a new principal with the specified provider and id - - The provider of the principal - The unique ID of the Principal within the provider - - - - Constructs a new principal with the specified provider and id - and optionally strips hyphens from the id - - The provider of the principal - The unique ID of the Principal within the provider - Strip hyphen - - - - Gets and sets the provider for this principal, which indicates in what group of - users this principal resides. - - - - - Gets the unique ID for this principal. - - - - - Represents a resource involved in an AWS access control policy statement. - Resources are the service specific AWS entities owned by your account. Amazon - SQS queues, Amazon S3 buckets and objects, and Amazon SNS topics are all - examples of AWS resources. - - The standard way of specifying an AWS resource is with an Amazon Resource - Name (ARN). - - - The resource is C in the statement - "A has permission to do B to C where D applies." - - - - - - Constructs a new AWS access control policy resource. Resources are - typically specified as Amazon Resource Names (ARNs). - - You specify the resource using the following Amazon Resource Name (ARN) - format: arn:aws:<vendor>:<region>:<namespace>:<relative-id> - - - >vendor identifies the AWS product (e.g., sns) - - - region is the AWS Region the resource resides in (e.g., us-east-1), if any - - - namespace is the AWS account ID with no hyphens (e.g., 123456789012) - - - relative-id is the service specific portion that identifies the specific resource - - - - - For example, an Amazon SQS queue might be addressed with the following - ARN: arn:aws:sqs:us-east-1:987654321000:MyQueue - - - Some resources may not use every field in an ARN. For example, resources - in Amazon S3 are global, so they omit the region field: - arn:aws:s3:::bucket/* - - - The Amazon Resource Name (ARN) uniquely identifying the desired AWS resource. - - - - Gets the resource ID, typically an Amazon Resource Name (ARN), - identifying this resource. - - - - - A factory for creating resources to be used in the policy. - - - - - Constructs a new bucket resource that represents the the specified bucket - but not any of the contained objects. - - The name of the bucket represented by this AWS access control - policy resource. - - - - Constructs a new object resource that represents the specified objects. - The keyPattern argument may contain the '*' wildcard to match multiple - objects. For example, an object resource created for bucket 'mybucket' - and key pattern 'foo*' will match any object stored in 'mybucket' with a - key that starts with 'foo'. - - The name of the bucket containing the object or objects - represented by this resource. - The key or key pattern, which can optionally contain the '*' - wildcard to include multiple objects in the resource. - - - - Constructs a new SQS queue resource for an access control policy. A - policy statement using this resource will allow or deny actions on the - specified queue. - - The AWS account ID of the queue owner. - The name of the Amazon SQS queue. - - - - A statement is the formal description of a single permission, and is always - contained within a policy object. - - A statement describes a rule for allowing or denying access to a specific AWS - resource based on how the resource is being accessed, and who is attempting - to access the resource. Statements can also optionally contain a list of - conditions that specify when a statement is to be honored. - - - For example, consider a statement that: - - - A is the prinicpal - The AWS account that is making a request to - access or modify one of your AWS resources. - - - - B is the action - the way in which your AWS resource is being accessed or modified, such - as sending a message to an Amazon SQS queue, or storing an object in an Amazon S3 bucket. - - - - C is the resource - your AWS entity that the principal wants to access, such - as an Amazon SQS queue, or an object stored in Amazon S3. - - - - D is the set of conditions - optional constraints that specify when to allow or deny - access for the principal to access your resource. Many expressive conditions are available, - some specific to each service. For example you can use date conditions to allow access to - your resources only after or before a specific time. - - - - - - There are many resources and conditions available for use in statements, and - you can combine them to form fine grained custom access control polices. - - - - - - The effect is the result that you want a policy statement to return at - evaluation time. A policy statement can either allow access or explicitly - deny access. - - - - - Constructs a new access control policy statement with the specified - effect. - - Before a statement is valid and can be sent to AWS, callers must set the - principals, resources, and actions (as well as any optional conditions) - involved in the statement. - - - The effect this statement has (allowing access or denying - access) when all conditions, resources, principals, and - actions are matched. - - - - Gets and Sets the ID for this statement. Statement IDs serve to help keep track - of multiple statements, and are often used to give the statement a - meaningful, human readable name. - - Developers should be careful to not use the same statement ID for - multiple statements in the same policy. Reusing the same statement ID in - different policies is not a problem. - - - - - - Sets the ID for this statement and returns the updated statement so - multiple calls can be chained together. - - Statement IDs serve to help keep track of multiple statements, and are - often used to give the statement a meaningful, human readable name. - - - Developers should be careful to not use the same statement ID for - multiple statements in the same policy. Reusing the same statement ID in - different policies is not a problem. - - - The new statement ID for this statement. - this instance - - - - Gets and Sets the result effect of this policy statement when it is evaluated. - A policy statement can either allow access or explicitly - - - - - Gets and Sets the list of actions to which this policy statement applies. - Actions limit a policy statement to specific service operations that are - being allowed or denied by the policy statement. For example, you might - want to allow any AWS user to post messages to your SQS queue using the - SendMessage action, but you don't want to allow those users other actions - such as ReceiveMessage or DeleteQueue. - - - - - Sets the list of actions to which this policy statement applies and - returns this updated Statement object so that additional method calls can - be chained together. - - Actions limit a policy statement to specific service operations that are - being allowed or denied by the policy statement. For example, you might - want to allow any AWS user to post messages to your SQS queue using the - SendMessage action, but you don't want to allow those users other actions - such as ReceiveMessage or DeleteQueue. - - - The list of actions to which this statement applies. - this instance - - - - Gets and Sets the resources associated with this policy statement. Resources - are what a policy statement is allowing or denying access to, such as an - Amazon SQS queue or an Amazon SNS topic. - - Note that some services allow only one resource to be specified per - policy statement. - - - - - - Sets the resources associated with this policy statement and returns this - updated Statement object so that additional method calls can be chained - together. - - Resources are what a policy statement is allowing or denying access to, - such as an Amazon SQS queue or an Amazon SNS topic. - - - Note that some services allow only one resource to be specified per - policy statement. - - - The resources associated with this policy statement. - this instance - - - - Gets and Sets the conditions associated with this policy statement. Conditions - allow policy statements to be conditionally evaluated based on the many - available condition types. - - For example, a statement that allows access to an Amazon SQS queue could - use a condition to only apply the effect of that statement for requests - that are made before a certain date, or that originate from a range of IP - addresses. - - - When multiple conditions are included in a single statement, all - conditions must evaluate to true in order for the statement to take - effect. - - - - - - Sets the conditions associated with this policy statement, and returns - this updated Statement object so that additional method calls can be - chained together. - - Conditions allow policy statements to be conditionally evaluated based on - the many available condition types. - - - For example, a statement that allows access to an Amazon SQS queue could - use a condition to only apply the effect of that statement for requests - that are made before a certain date, or that originate from a range of IP - addresses. - - - Multiple conditions can be included in a single statement, and all - conditions must evaluate to true in order for the statement to take - effect. - - - The conditions associated with this policy statement. - this instance - - - - Gets and Sets the principals associated with this policy statement, indicating - which AWS accounts are affected by this policy statement. - - - - - Sets the principals associated with this policy statement, and returns - this updated Statement object. Principals control which AWS accounts are - affected by this policy statement. - - If you don't want to restrict your policy to specific users, you can use - to apply the policy to any user trying to - access your resource. - - - The list of principals associated with this policy statement. - this instance - - - - The available AWS access control policy actions for Amazon AppStream. - - - - - - The available AWS access control policy actions for Auto Scaling. - - - - - - The available AWS access control policy actions for AWS Billing. - - - - - - The available AWS access control policy actions for AWS CloudFormation. - - - - - - The available AWS access control policy actions for Amazon CloudFront. - - - - - - The available AWS access control policy actions for Amazon CloudSearch. - - - - - - The available AWS access control policy actions for AWS CloudTrail. - - - - - - The available AWS access control policy actions for Amazon CloudWatch. - - - - - - The available AWS access control policy actions for Amazon CloudWatch Logs. - - - - - - The available AWS access control policy actions for Amazon Cognito Identity. - - - - - - The available AWS access control policy actions for Amazon Cognito Sync. - - - - - - The available AWS access control policy actions for AWS Direct Connect. - - - - - - The available AWS access control policy actions for Amazon DynamoDB. - - - - - - The available AWS access control policy actions for Amazon EC2. - - - - - - The available AWS access control policy actions for AWS ElastiCache. - - - - - - The available AWS access control policy actions for AWS Elastic Beanstalk. - - - - - - The available AWS access control policy actions for Elastic Load Balancing. - - - - - - The available AWS access control policy actions for Amazon Elastic MapReduce. - - - - - - The available AWS access control policy actions for Amazon Elastic Transcoder. - - - - - - The available AWS access control policy actions for Amazon Glacier. - - - - - - The available AWS access control policy actions for AWS Identity and Access Management. - - - - - - The available AWS access control policy actions for AWS Import Export. - - - - - - The available AWS access control policy actions for Amazon Kinesis. - - - - - - The available AWS access control policy actions for AWS Marketplace. - - - - - - The available AWS access control policy actions for AWS Marketplace Management Portal. - - - - - - The available AWS access control policy actions for Amazon Mobile Analytics. - - - - - - The available AWS access control policy actions for AWS OpsWorks. - - - - - - The available AWS access control policy actions for Amazon RDS. - - - - - - The available AWS access control policy actions for Amazon Redshift. - - - - - - The available AWS access control policy actions for Amazon Route 53. - - - - - - The available AWS access control policy actions for Amazon S3. - - - - - - The available AWS access control policy actions for AWS Security Token Service. - - - - - - The available AWS access control policy actions for Amazon SES. - - - - - - The available AWS access control policy actions for Amazon SimpleDB. - - - - - - The available AWS access control policy actions for Amazon Simple Workflow Service. - - - - - - The available AWS access control policy actions for Amazon SNS. - - - - - - The available AWS access control policy actions for Amazon SQS. - - - - - - The available AWS access control policy actions for Amazon Storage Gateway. - - - - - - The available AWS access control policy actions for AWS Whispersync. - - - - - - The available AWS access control policy actions for Amazon Zocalo. - - - - - - Deserializes a JSON string into a AWS policy object. - - - - - Serializes an AWS policy object to a JSON string, suitable for sending to an - AWS service. - - - - Converts the specified AWS policy object to a JSON string, suitable for - passing to an AWS service. - - @param policy - The AWS policy object to convert to a JSON string. - - @return The JSON string representation of the specified policy object. - - @throws IllegalArgumentException - If the specified policy is null or invalid and cannot be - serialized to a JSON string. - - - - Uses the specified generator to write the JSON data for the principals in - the specified policy statement. - - - - - This sorts the conditions by condition type and key with the list of values for that combination. - - The list of conditions to be sorted. - - - - - Exception thrown by the SDK for errors that occur within the SDK. - - - - - This exception is thrown when there is a parse error on the response back from AWS. - - - - - The string value which could not be converted into a valid DateTime instance. - - - - - Occurs before a request is marshalled. - - - - - Occurs before a request is issued against the service. - - - - - Occurs after a response is received from the service. - - - - - Occurs after an exception is encountered. - - - - - Patches the in-flight uri to stop it unescaping the path etc (what Uri did before - Microsoft deprecated the constructor flag). This is particularly important for - Amazon S3 customers who want to use backslash (\) in their key names. - - - Different behavior in the various runtimes has been observed and in addition some - 'documented' ways of doing this between 2.x and 4.x runtimes has also been observed - to not be reliable. - - This patch effectively emulates what adding a schemesettings element to the - app.config file with value 'name="http" genericUriParserOptions="DontUnescapePathDotsAndSlashes"' - does. As we're a dll, that avenue is not open to us. - - - - - - Used to create a copy of the config for a different service than the current instance. - - Target service ClientConfig - The new ClientConfig for the desired service - - - - A base exception for some Amazon Web Services. - - Most exceptions thrown to client code will be service-specific exceptions, though some services - may throw this exception if there is a problem which is caught in the core client code. - - - - - - Whether the error was attributable to Sender or Reciever. - - - - - The error code returned by the service - - - - - The id of the request which generated the exception. - - - - - The HTTP status code from the service response - - - - - Flag indicating if the exception is retryable and the associated retry - details. A null value indicates that the exception is not retryable. - - - - - Class containing the retryable details for an AmazonServiceException - - - - - This property indicates that this exception is a - throttling exception and should be subject to congestion - control throttling. - - - - - This exception is thrown when there is a parse error on the response back from AWS. - - - - - Last known location in the response that was parsed, if available. - - - - - The entire response body that caused this exception, if available. - - - - - Base class for request used by some of the services. - - - - - This flag specifies if SigV4 will be used for the current request. - - - - - Gets or Sets a value indicating if "Expect: 100-continue" HTTP header will be - sent by the client for this request. The default value is false. - - - - - Gets the signer to use for this request. - A null return value indicates to use the configured - signer for the service that this request is part of. - - A signer for this request, or null. - - - - Abstract class for Response objects, contains only metadata, - and no result information. - - - - - Contains additional information about the request, such as the - Request Id. - - - - - Returns the content length of the HTTP response. - - - - - Returns the status code of the HTTP response. - - - - - Base class for determining region based on inspection. - - - - - Sets the Region property by looking up the corresponding RegionEndpoint - from the supplied region system name (us-east-1, us-west-2 etc). - - The system name of the region. - - - - Determines region based on application configuration settings. If the configuration does not contain - the region setting key an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of ApplicationConfigAWSRegion. If no region is found in the - application configuration file then an InvalidOperationException is thrown. - - - - - Probing mechanism to determine region from various sources. - - - - - This class is responsible for keeping track of Retry capacity across different ServiceURLs. - - - - - CapacityType determines the type of capacity to obtain or use. - - - - - The increment capacity type adds capacity. - - - - - The default retry capacity type uses the default capacity amount. - - - - - The timeout capacity type uses the timeout capacity amount. - - - - - This method acquires a said retry capacity if the container has the capacity. - - Contains the RetryCapacity object for the said ServiceURL. - - - - This method acquires a said retry capacity if the container has the capacity. - - Contains the RetryCapacity object for the said ServiceURL. - Specifies what capacity type cost to use for obtaining capacity - - - - This method calls a method to release capacity back - based on whether it was a successful response or a successful retry response. This is invoked by a retry request response. - - if this request is a retry, use a different capacity cost - Contains the RetryCapacity object for the said ServiceURL. - - - - This method calls a method to release capacity back - based on whether it was a successful response or a successful retry response. This is invoked by a retry request response. - - Specifies what capacity type cost to use for adding capacity - Contains the RetryCapacity object for the said ServiceURL. - - - - Ths method fetches the RetryCapacity for the given ServiceURL from CapacityManager.CapacityContainer - - - - - This method releases capacity back. This is invoked by the TryReleaseCapacity method. - - Contains the RetryCapacity object for the said ServiceURL. - The capacity that needs to be released based on whether it was a successful response or a successful retry response. - - - - This class is the RetryCapacity class for a given ServiceURL. - - - - - This class composes Client Context header for Amazon Web Service client. - It contains information like app title, version code, version name, client id, OS platform etc. - - - This class composes Client Context header for Amazon Web Service client. - It contains information like app title, version code, version name, client id, OS platform etc. - - - - - Adds the custom attributes to the Client Context. - - Key. - Value. - - - - Gets a Json Representation of the Client Context. - - Json Representation of Client Context - - - - Collection of parameters that an SDK client will send to a service. - - - - - Constructs empty ParameterCollection. - - - - - Adds a parameter with a string value. - - - - - - - Adds a parameter with a list-of-strings value. - - - - - - - Converts the current parameters into a list of key-value pairs. - - - - - - This class is responsible for managing adaptive retry mode client rate limiting. - - - - - The rate at which token are replenished. - - - - - The maximum capacity allowed in the token - - - - - The current capacity of the token - - - - - The last time the token bucket was refilled. - - - - - The smoothed rate which tokens are being retrieved. - - - - - The last half second time bucket used. - - - - - The number of requests seen within the current time - - - - - The maximum rate when the client was last throttled. - - - - - The last time when the client was throttled. - - - - - The cached time window calculation - - - - - Boolean indicating if the token bucket is enabled. - - - - - This method attempts to acquire capacity from the client's token - - The amount of capacity to obtain from the token bucket - Indicates that the client should or shouldn't sleep and - try again if capacity cannot be obtained. - - - - - This method attempts to acquire capacity from the client's token - - The amount of capacity to obtain from the token bucket - Indicates that the client should or shouldn't sleep and - try again if capacity cannot be obtained. - - Token which can be used to cancel the task. - - - - Updates the sending rate within the client's token bucket - - Indicates if the request resulted in a throttling error. - - - - Calculates the rate - - - Returns the calculated rate for a successful call - - - - Calculates the rate. - - The rate to use in the calculation - Returns the calculated rate for a throttled call - - - - Collection used to indicate if the property was initialized was created by the SDK. - - - - - - Collection used to indicate if the property was initialized was created by the SDK. - - - - - - - Default implementation of the IRequest interface. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Constructs a new DefaultRequest with the specified service name and the - original, user facing request object. - - The orignal request that is being wrapped - The service name - - - - The name of the request - - - - - Gets and sets the type of http request to make, whether it should be POST,GET or DELETE - - - - - Gets and sets a flag that indicates whether the request is sent as a query string instead of the request body. - - - - - Returns the original, user facing request object which this internal - request object is representing. - - - - - Returns a dictionary of the headers included in this request. - - - - - Returns a dictionary of the parameters included in this request. - - - - - Collection of parameters included in this request. - - - - - Returns the subresources that should be appended to the resource path. - This is used primarily for Amazon S3, where object keys can contain '?' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new null entry to the SubResources collection for the request - - The name of the subresource - - - - Adds a new entry to the SubResources collection for the request - - The name of the subresource - Value of the entry - - - - Gets and Sets the endpoint for this request. - - - - - Gets and Sets the resource path added on to the endpoint. - - - - - Returns the path resources that should be used within the resource path. - This is used for services where path keys can contain '/' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new entry to the PathResources collection for the request - - The name of the pathresource with potential greedy syntax: {key+} - Value of the entry - - - - Gets and Sets the version number for the marshaller used to create this request. The version number - is used to support backward compatible changes that would otherwise be breaking changes when a - newer core is used with an older service assembly. - Versions: - 1 - Default version - 2 - Support for path segments - - - - - Gets and Sets the content for this request. - - - - - Flag that signals that Content was and should be set - from the Parameters collection. - - - - - Gets and sets the content stream. - - - - - Gets and sets the original stream position. - If ContentStream is null or does not support seek, this propery - should be equal to -1. - - - - - Computes the SHA 256 hash of the content stream. If the stream is not - seekable, it searches the parent stream hierarchy to find a seekable - stream prior to computation. Once computed, the hash is cached for future - use. If a suitable stream cannot be found to use, null is returned. - - - - - The name of the service to which this request is being sent. - - - - - Alternate endpoint to use for this request, if any. - - - - - Host prefix value to prepend to the endpoint for this request, if any. - - - - - Gets and sets the Suppress404Exceptions property. If true then 404s return back from AWS will not cause an exception and - an empty response object will be returned. - - - - - If using AWS4 signing protocol, contains the resultant parts of the - signature that we may need to make use of if we elect to do a chunked - encoding upload. - - - - - Determine whether to use a chunked encoding upload for the request - (applies to Amazon S3 PutObject and UploadPart requests only). - - - - - - Used for Amazon S3 requests where the bucket name is removed from - the marshalled resource path into the host header. To comply with - AWS2 signature calculation, we need to recover the bucket name - and include it in the resource canonicalization, which we do using - this field. - - - - - This flag specifies if SigV4 is required for the current request. - - - - - The authentication region to use for the request. - Set from Config.AuthenticationRegion. - - - - - The region in which the service request was signed. - - - - - Checks if the request stream can be rewinded. - - Returns true if the request stream can be rewinded , - else false. - - - - Returns true if the request can contain a request body, else false. - - Returns true if the currect request can contain a request body, else false. - - - - Returns true if the request has a body, else false. - - Returns true if the request has a body, else false. - - - - Class containing the data for one endpoint returned from a endpoint discovery request - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Constructs a new DiscoveryEndpoint - - The address of the endpoint - The cache period for the endpoint in minutes - - - - The address of the endpoint. - - - - - The cache period for the endpoint in minutes - - - - - Calculates if this endpoint has expired - - A boolean value indicating if the cache period has expired - - - - Extends the endpoint expiration by the specified number of minutes from now. - - - - - Class containing the data for one endpoint returned from a endpoint discovery request - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class containing the data to use with endpoint discovery - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Gets/sets and flag indicating if endpoint discovery is required for the request. - - - - - Sorted dictionary of the identifiers that must be sent with the endpoint discovery request. These - identifiers are used to construct the cache key for the cache that stores discovered endpoints. A - sorted dictionary is used instead of a dictionary to ensure the cache key comes out in the same order - each time it is constructed. - - - - - Represents the data to be used with endpoint discovery operations - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class used to resolve endpoints using Endpoint Discovery. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Method that performs endpoint discovery for the current operation - - Context information used in calculations for endpoint discovery - The operation to fetch endpoints from the server - - - - - Gets the number of cache keys in the cache - - - - - Class used to resolve endpoints using Endpoint Discovery. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class containing context information to use with endpoint discovery - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Gets the customer credential information. - - - - - Gets the operation name. - - - - - Gets the current marshalled endpoint discovery data. - - - - - Gets the flag indicating if the specified key should be evicted from the cache. - - - - - Gets the Uri that should be evicted if EvictCacheKey is set to true. - - - - - Class containing context information to use with endpoint discovery - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Error type, one of Sender, Receiver, Unknown - Only applies to XML-based services. - - - - - Name of the exception class to return - - - - - Error message - - - - - RequestId of the error. - Only applies to XML-based services. - - - - - InternalConfiguration holds the cached SDK configuration values - obtained from the environment and profile configuration - factories. These configuration values are loaded internally and - are not the same as user exposed AWSConfigs. - - - - - Flag indicating if Endpoint Discovery is enabled. - - - - - The retry mode to use: Legacy, Standard, or Adaptive. - - - - - The max number of request attempts. - - - - - Probing mechanism to determine the configuration values from various sources. - - - - - Resets all the configuration values reloading as needed. This method will use - the AWS_PROFILE environment variable if set to construct the instance. Otherwise - the default profile will be used. - - - - - Flag that specifies if endpoint discovery is enabled, disabled, - or not set. - - - - - Flag that specifies which retry mode to use or if retry mode has - not been set. - - - - - Flag that specifies the max number of request attempts or if max - attempts has not been set. - - - - - Class containing the members used to invoke service calls - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class containing the members used to invoke service calls - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Represents a request being sent to an Amazon Web Service, including the - parameters being sent as part of the request, the endpoint to which the - request should be sent, etc. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - The name of the request - - - - - Returns a dictionary of the headers included in this request. - - - - - Gets and sets a flag that indicates whether the request is sent as a query string instead of the request body. - - - - - Returns a dictionary of the parameters included in this request. - - - - - Collection of parameters included in this request. - - - - - Returns the subresources that should be appended to the resource path. - This is used primarily for Amazon S3, where object keys can contain '?' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new null entry to the SubResources collection for the request - - The name of the subresource - - - - Adds a new entry to the SubResources collection for the request - - The name of the subresource - Value of the entry - - - - Gets and sets the type of http request to make, whether it should be POST,GET or DELETE - - - - - Gets and Sets the endpoint for this request. - - - - - Gets and Sets the resource path added on to the endpoint. - - - - - Returns the path resources that should be used within the resource path. - This is used for services where path keys can contain '/' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new entry to the PathResources collection for the request - - The name of the pathresource with potential greedy syntax: {key+} - Value of the entry - - - - Gets and Sets the version number for the marshaller used to create this request. The version number - is used to support backward compatible changes that would otherwise be breaking changes when a - newer core is used with an older service assembly. - - - - - Gets and Sets the content for this request. - - - - - Gets the header value from the request. - - - - - Flag that signals that Content was and should be set - from the Parameters collection. - - - - - Gets and sets the content stream. - - - - - Gets and sets the original stream position. - If ContentStream is null or does not support seek, this propery - should be equal to -1. - - - - - Computes the SHA 256 hash of the content stream. If the stream is not - seekable, it searches the parent stream hierarchy to find a seekable - stream prior to computation. Once computed, the hash is cached for future - use. - - - - - The name of the service to which this request is being sent. - - - - - Returns the original, user facing request object which this internal - request object is representing. - - - - - Alternate endpoint to use for this request, if any. - - - - - Host prefix value to prepend to the endpoint for this request, if any. - - - - - Gets and sets the Suppress404Exceptions property. If true then 404s return back from AWS will not cause an exception and - an empty response object will be returned. - - - - - If using AWS4 signing protocol, contains the resultant parts of the - signature that we may need to make use of if we elect to do a chunked - encoding upload. - - - - - Determine whether to use a chunked encoding upload for the request - (applies to Amazon S3 PutObject and UploadPart requests only). - - - - - - Used for Amazon S3 requests where the bucket name is removed from - the marshalled resource path into the host header. To comply with - AWS2 signature calculation, we need to recover the bucket name - and include it in the resource canonicalization, which we do using - this field. - - - - - This flag specifies if SigV4 is required for the current request. - - - - - The authentication region to use for the request. - Set from Config.AuthenticationRegion. - - - - - The region in which the service request was signed. - - - - - Checks if the request stream can be rewinded. - - Returns true if the request stream can be rewinded , - else false. - - - - Returns true if the request can contain a request body, else false. - - Returns true if the currect request can contain a request body, else false. - - - - Returns true if the request has a body, else false. - - Returns true if the request has a body, else false. - - - - Gets the value of the Service Id. - - - - - Gets the dictionary that gives mapping of renamed operations - - - - - IDictionary{String, String} access to ParameterCollection. - TODO: remove this class in version 3.4 of the SDK. - - - - - Constructs ParametersDictionaryFacade for a ParameterCollection - - - - - - A registry of object that will manipulate the runtime pipeline used by service clients. - - - - - Registers a customizer that will be applied for all service clients created. Each customizer has a unique name associated with it. If a customizer is registered more - than once with the same unique name then the calls after the first will be ignored. - - - - - - Deregistered the runtime pipeline customizer - - - - - - Deregistered the runtime pipeline customizer - - - - - - Applies all of the registered customizers on the runtime pipeline - - The service clients runtime pipeline. - Type object for the service client being created - - - - Interface for objects that will customize the runtime pipleine for newly created service clients. - - - - - The unique name for the customizer that identifies the customizer in the registry. The name is also used to identify the customizer on the SDK logs. - - - - - Called on service clients as they are being constructed to customize their runtime pipeline. - - - Type object for the service client being created - - - - Default ServiceMetadata implementation. - This implementation will be used if the service doesn't have a - IServiceMetadata implementation. - - - - - Gets the value of the Service Id. - - - - - Gets the dictionary that gives mapping of renamed operations - - - - - Computes RFC 2104-compliant HMAC signature. - - - - - Computes RFC 2104-compliant HMAC signature. - - - - - Inspects the supplied evidence to return the signer appropriate for the operation - - Global setting for the service - The request. - Configuration for the client - True if signature v4 request signing should be used - - - - Signs the specified request with the AWS3 signing protocol by using the - AWS account credentials given in the method parameters. - - The AWS public key - The AWS secret key used to sign the request in clear text - Request metrics - The configuration that specifies which hashing algorithm to use - The request to have the signature compute for - If any problems are encountered while signing the request - - - - AWS4 protocol signer for service calls that transmit authorization in the header field "Authorization". - - - - - Calculates and signs the specified request using the AWS4 signing protocol by using the - AWS account credentials given in the method parameters. The resulting signature is added - to the request headers as 'Authorization'. Parameters supplied in the request, either in - the resource path as a query string or in the Parameters collection must not have been - uri encoded. If they have, use the SignRequest method to obtain a signature. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. - - - Client configuration data encompassing the service call (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text. - - - If any problems are encountered while signing the request. - - - - - Calculates and signs the specified request using the AWS4 signing protocol by using the - AWS account credentials given in the method parameters. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. - - - Client configuration data encompassing the service call (notably authentication - region, endpoint and service name). - - - Metrics for the request. - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text. - - - If any problems are encountered while signing the request. - - - Parameters passed as part of the resource path should be uri-encoded prior to - entry to the signer. Parameters passed in the request.Parameters collection should - be not be encoded; encoding will be done for these parameters as part of the - construction of the canonical request. - - - - - Sets the AWS4 mandated 'host' and 'x-amz-date' headers, returning the date/time that will - be used throughout the signing process in various elements and formats. - - The current set of headers - - Date and time used for x-amz-date, in UTC - - - - Sets the AWS4 mandated 'host' and 'x-amz-date' headers, accepting and returning the date/time that will - be used throughout the signing process in various elements and formats. - - The current set of headers - - - Date and time used for x-amz-date, in UTC - - - - Computes and returns an AWS4 signature for the specified canonicalized request - - - - - - - - - - - - Computes and returns an AWS4 signature for the specified canonicalized request - - - - - - - - - - - - - Computes and returns an AWS4 signature for the specified canonicalized request - - - - - - - - - - - - - - Formats the supplied date and time for use in AWS4 signing, where various formats are used. - - - The required format - The UTC date/time in the requested format - - - - Compute and return the multi-stage signing key for the request. - - The clear-text AWS secret key, if not held in secureKey - The region in which the service request will be processed - Date of the request, in yyyyMMdd format - The name of the service being called by the request - Computed signing key - - - - If the caller has already set the x-amz-content-sha256 header with a pre-computed - content hash, or it is present as ContentStreamHash on the request instance, return - the value to be used in request canonicalization. - If not set as a header or in the request, attempt to compute a hash based on - inspection of the style of the request content. - - - - The computed hash, whether already set in headers or computed here. Null - if we were not able to compute a hash. - - - - - If signPayload is false set the x-amz-content-sha256 header to - the UNSIGNED-PAYLOAD magic string and return it. - Otherwise, if the caller has already set the x-amz-content-sha256 header with a pre-computed - content hash, or it is present as ContentStreamHash on the request instance, return - the value to be used in request canonicalization. - If not set as a header or in the request, attempt to compute a hash based on - inspection of the style of the request content. - - - - - The computed hash, whether already set in headers or computed here. Null - if we were not able to compute a hash. - - - - - Returns the HMAC256 for an arbitrary blob using the specified key - - - - - - - - Returns the HMAC256 for an arbitrary blob using the specified key - - - - - - - - Compute and return the hash of a data blob using the specified key - - Algorithm to use for hashing - Hash key - Data blob - Hash of the data - - - - Compute and return the hash of a data blob using the specified key - - Algorithm to use for hashing - Hash key - Data blob - Hash of the data - - - - Computes the non-keyed hash of the supplied data - - - - - - - Computes the non-keyed hash of the supplied data - - - - - - - Computes and returns the canonical request - - The endpoint URL - the path of the resource being operated on - The http method used for the request - The full request headers, sorted into canonical order - The query parameters for the request - - The hash of the binary request body if present. If not supplied, the routine - will look for the hash as a header on the request. - - Canonicalised request as a string - - - - Computes and returns the canonical request - - The endpoint URL - the path of the resource being operated on - The http method used for the request - The full request headers, sorted into canonical order - The query parameters for the request - - The path resource values lookup to use to replace the keys within resourcePath - The hash of the binary request body if present. If not supplied, the routine - will look for the hash as a header on the request. - - The version of the marshaller that constructed the request object. - Canonicalised request as a string - - - - Computes and returns the canonical request - - The endpoint URL - the path of the resource being operated on - The http method used for the request - The full request headers, sorted into canonical order - The query parameters for the request - - The path resource values lookup to use to replace the keys within resourcePath - The hash of the binary request body if present. If not supplied, the routine - will look for the hash as a header on the request. - - The version of the marshaller that constructed the request object. - The service being called for the request - Canonicalised request as a string - - - - Reorders the headers for the request for canonicalization. - - The set of proposed headers for the request - List of headers that must be included in the signature - For AWS4 signing, all headers are considered viable for inclusion - - - - Computes the canonical headers with values for the request. Only headers included in the signature - are included in the canonicalization process. - - All request headers, sorted into canonical order - Canonicalized string of headers, with the header names in lower case. - - - - Returns the set of headers included in the signature as a flattened, ;-delimited string - - The headers included in the signature - Formatted string of header names - - - - Collects the subresource and query string parameters into one collection - ready for canonicalization - - The in-flight request being signed - The fused set of parameters - - - - Computes and returns the canonicalized query string, if query parameters have been supplied. - Parameters with no value will be canonicalized as 'param='. The expectation is that parameters - have not already been url encoded prior to canonicalization. - - The set of parameters being passed on the uri - - Parameters must be uri encoded into the canonical request and by default the signer expects - that the supplied collection contains non-encoded data. Set this to false if the encoding was - done prior to signer entry. - - The uri encoded query string parameters in canonical ordering - - - - Computes and returns the canonicalized query string, if query parameters have been supplied. - Parameters with no value will be canonicalized as 'param='. The expectation is that parameters - have not already been url encoded prior to canonicalization. - - The set of parameters to be encoded in the query string - - Parameters must be uri encoded into the canonical request and by default the signer expects - that the supplied collection contains non-encoded data. Set this to false if the encoding was - done prior to signer entry. - - The uri encoded query string parameters in canonical ordering - - - - Returns the request parameters in the form of a query string. - - The request instance - Request parameters in query string format - - - - AWS4 protocol signer for Amazon S3 presigned urls. - - - - - Calculates and signs the specified request using the AWS4 signing protocol by using the - AWS account credentials given in the method parameters. The resulting signature is added - to the request headers as 'Authorization'. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. - - - Adding supporting data for the service call required by the signer (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text - - - If any problems are encountered while signing the request. - - - - - Calculates the AWS4 signature for a presigned url. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. If the Expires parameter - is present, it is renamed to 'X-Amz-Expires' before signing. - - - Adding supporting data for the service call required by the signer (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text - - - If any problems are encountered while signing the request. - - - Parameters passed as part of the resource path should be uri-encoded prior to - entry to the signer. Parameters passed in the request.Parameters collection should - be not be encoded; encoding will be done for these parameters as part of the - construction of the canonical request. - - - - - Calculates the AWS4 signature for a presigned url. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. If the Expires parameter - is present, it is renamed to 'X-Amz-Expires' before signing. - - - Adding supporting data for the service call required by the signer (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text - - - The service to sign for - - - The region to sign to, if null then the region the client is configured for will be used. - - - If any problems are encountered while signing the request. - - - Parameters passed as part of the resource path should be uri-encoded prior to - entry to the signer. Parameters passed in the request.Parameters collection should - be not be encoded; encoding will be done for these parameters as part of the - construction of the canonical request. - - The X-Amz-Content-SHA256 is cleared out of the request. - If the request is for S3 then the UNSIGNED_PAYLOAD value is used to generate the canonical request. - If the request isn't for S3 then the empty body SHA is used to generate the canonical request. - - - - - Encapsulates the various fields and eventual signing value that makes up - an AWS4 signature. This can be used to retrieve the required authorization string - or authorization query parameters for the final request as well as hold ongoing - signature computations for subsequent calls related to the initial signing. - - - - - Constructs a new signing result instance for a computed signature - - The access key that was included in the signature - Date/time (UTC) that the signature was computed - The collection of headers names that were included in the signature - Formatted 'scope' value for signing (YYYYMMDD/region/service/aws4_request) - Returns the key that was used to compute the signature - Computed signature - - - - The access key that was used in signature computation. - - - - - ISO8601 formatted date/time that the signature was computed - - - - - ISO8601 formatted date that the signature was computed - - - - - The ;-delimited collection of header names that were included in the signature computation - - - - - Formatted 'scope' value for signing (YYYYMMDD/region/service/aws4_request) - - - - - Returns a copy of the key that was used to compute the signature - - - - - Returns the hex string representing the signature - - - - - Returns a copy of the byte array containing the signature - - - - - Returns the signature in a form usable as an 'Authorization' header value. - - - - - Returns the signature in a form usable as a set of query string parameters. - - - - - Null Signer which does a no-op. - - - - - Signs the specified request with the AWS2 signing protocol by using the - AWS account credentials given in the method parameters. - - The AWS public key - The AWS secret key used to sign the request in clear text - Request metrics - The configuration that specifies which hashing algorithm to use - The request to have the signature compute for - If any problems are encountered while signing the request - - - - S3 signer constructor - - - - - S3 signer constructor - - - - - This exception is thrown if there are problems signing the request. - - - - - Response Unmarshaller for all Errors - - - - - Build an ErrorResponse from XML - - The XML parsing context. - Usually an Amazon.Runtime.Internal.UnmarshallerContext. - An ErrorResponse object. - - - - Return an instance of and ErrorResponseUnmarshaller. - - - - - - Interface for unmarshallers which unmarshall objects from response data. - The Unmarshallers are stateless, and only encode the rules for what data - in the XML stream goes into what members of an object. - - The type of object the unmarshaller returns - The type of the XML unmashaller context, which contains the - state during parsing of the XML stream. Usually an instance of - Amazon.Runtime.Internal.Transform.UnmarshallerContext. - - - - Given the current position in the XML stream, extract a T. - - The XML parsing context - An object of type T populated with data from the XML stream. - - - - Interface for unmarshallers which unmarshall service responses. - The Unmarshallers are stateless, and only encode the rules for what data - in the XML stream goes into what members of an object. - - The type of object the unmarshaller returns - The type of the XML unmashaller context, which contains the - state of parsing the XML stream. Uaually an instance of - Amazon.Runtime.Internal.Transform.UnmarshallerContext. - - - - Extracts an exeption with data from an ErrorResponse. - - The XML parsing context. - An inner exception to be included with the returned exception - The HttpStatusCode from the ErrorResponse - Either an exception based on the ErrorCode from the ErrorResponse, or the - general service exception for the service in question. - - - - Interface for unmarshallers which unmarshall objects from response data. - The Unmarshallers are stateless, and only encode the rules for what data - in the XML stream goes into what members of an object. - - The type of object the unmarshaller returns - The type of the XML unmashaller context, which contains the - state during parsing of the XML stream. Usually an instance of - Amazon.Runtime.Internal.Transform.UnmarshallerContext. - - - - Given the current position in the XML stream, extract a T. - - The XML parsing context - An object of type T populated with data from the XML stream. - - - - First-pass unmarshaller for all errors - - - - - Build an ErrorResponse from json - - The json parsing context. - Usually an Amazon.Runtime.Internal.JsonUnmarshallerContext. - An ErrorResponse object. - - - - Return an instance of JsonErrorResponseUnmarshaller. - - - - - - Wraps a json string for unmarshalling. - - Each Read() operation gets the next token. - TestExpression() is used to match the current key-chain - to an xpath expression. The general pattern looks like this: - - JsonUnmarshallerContext context = new JsonUnmarshallerContext(jsonString); - while (context.Read()) - { - if (context.IsKey) - { - if (context.TestExpresion("path/to/element")) - { - myObject.stringMember = stringUnmarshaller.GetInstance().Unmarshall(context); - continue; - } - } - } - - - - - - Wrap the jsonstring for unmarshalling. - - Stream that contains the JSON for unmarshalling - If set to true, maintains a copy of the complete response body constraint to log response size as the stream is being read. - Response data coming back from the request - If set to true, maintains a copy of the complete response body as the stream is being read. - - - - Are we at the start of the json document. - - - - - Is the current token the end of an object - - - - - Is the current token the start of an object - - - - - Returns the element depth of the parser's current position in the json - document being parsed. - - - - - The current Json path that is being unmarshalled. - - - - - Reads to the next token in the json document, and updates the context - accordingly. - - - True if a token was read, false if there are no more tokens to read. - - - - - Peeks at the next token. This peek implementation - reads the next token and makes the subsequent Read() return the same data. - If Peek is called successively, it will return the same data. - Only the first one calls Read(), subsequent calls - will return the same data until a Read() call is made. - - Token to peek. - Returns true if the peeked token matches given token. - - - - Returns the text contents of the current token being parsed. - - - The text contents of the current token being parsed. - - - - - The type of the current token - - - - - Get the base stream of the jsonStream. - - - - - Peeks at the next (non-whitespace) character in the jsonStream. - - The next (non-whitespace) character in the jsonStream, or -1 if at the end. - - - - Peeks at the next character in the stream. - If the data isn't buffered into the StreamReader (Peek() returns -1), - we flush the buffered data and try one more time. - - - - - - Abstract class for unmarshalling service responses. - - - - - Class for unmarshalling XML service responses. - - - - - Class for unmarshalling EC2 service responses. - - - - - Class for unmarshalling JSON service responses. - - - - - Unmarshaller for int fields - - - - - Unmarshaller for nullable int fields. Implemented only for JSON context - to handle cases where value can be null e.g. {'Priority': null}. - This unmarshaller is not implemented for XML context, as XML responses - will null elements (xsi:nil='true') will be skipped by the XML parser. - - - - - Unmarshaller for long fields - - - - - Unmarshaller for float fields - - - - - Unmarshaller for double fields - - - - - Unmarshaller for decimal fields - - - - - Unmarshaller for bool fields - - - - - Unmarshaller for string fields - - - - - Unmarshaller for byte fields - - - - - Unmarshaller for DateTime fields - - - - - Unmarshalls given string as a DateTime. Handles cases where we want to unmarshall - as just a DateTime or a nullable Datetime. - - Value to be parsed - If true, the method will return null if text is null. - If false, the method will return default(DateTime), if text is null. - - - - - Unmarshaller for nullable DateTime fields. Implemented only for JSON context - to handle cases where value can be null e.g. {'Priority': null}. - This unmarshaller is not implemented for XML context, as XML responses - will null elements (xsi:nil='true') will be skipped by the XML parser. - - - - - Unmarshaller for MemoryStream fields - - - - - Unmarshaller for ResponseMetadata - - - - - Base class for the UnmarshallerContext objects that are used - to unmarshall a web-service response. - - - - - Tests the specified expression against the current position in the XML - document - - The pseudo-XPath expression to test. - - True if the expression matches the current position in the document, - false otherwise. - - - - Tests the specified expression against the current position in the XML - document being parsed, and restricts the expression to matching at the - specified stack depth. - - The pseudo-XPath expression to test. - - The depth in the stack representing where the expression must - start matching in order for this method to return true. - - True if the specified expression matches the current position in - the XML document, starting from the specified depth. - - - - Reads the next token at depth greater than or equal to target depth. - - Tokens are read at depth greater than or equal to target depth. - True if a token was read and current depth is greater than or equal to target depth. - - - - The current path that is being unmarshalled. - - - - - Returns the element depth of the parser's current position in the - document being parsed. - - - - - Reads to the next node in the document, and updates the context accordingly. - - - True if a node was read, false if there are no more elements to read. - - - - - Returns the text contents of the current element being parsed. - - - The text contents of the current element being parsed. - - - - - True if NodeType is Element. - - - - - True if NodeType is EndElement. - - - - - True if the context is at the start of the document. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Wrap an XmltextReader for simulating an event stream. - - Each Read() operation goes either to the next element or next attribute within - the current element. TestExpression() is used to match the current event - to an xpath expression. The general pattern looks like this: - - UnmarshallerContext context = new UnmarshallerContext(...); - while (context.Read()) - { - if (context.TestExpresion("path/to/element")) - { - myObject.stringMember = stringUnmarshaller.GetInstance().Unmarshall(context); - continue; - } - if (context.TestExpression("path/to/@attribute")) - myObject.MyComplexTypeMember = MyComplexTypeUnmarshaller.GetInstance().Unmarshall(context); - } - - - - - - Wrap an XmlTextReader with state for event-based parsing of an XML stream. - - Stream with the XML from a service response. - If set to true, maintains a copy of the complete response body constraint to log response size as the stream is being read. - Response data coming back from the request - If set to true, maintains a copy of the complete response body as the stream is being read. - - - - The current XML path that is being unmarshalled. - - - - - Returns the element depth of the parser's current position in the XML - document being parsed. - - - - - Reads to the next node in the XML document, and updates the context accordingly. - - - True if a node was read, false if there are no more elements to read./ - - - - - Returns the text contents of the current element being parsed. - - - The text contents of the current element being parsed. - - - - - True if NodeType is Element. - - - - - True if NodeType is EndElement. - - - - - True if the context is at the start of the document. - - - - - True if NodeType is Attribute. - - - - - Wrap an XmlTextReader with state for event-based parsing of an XML stream. - - Stream with the XML from a service response. - If set to true, maintains a copy of the complete response body constraint to log response size as the stream is being read. - Response data coming back from the request - If set to true, maintains a copy of the complete response body as the stream is being read. - - - - RequestId value, if found in response - - - - - Reads to the next node in the XML document, and updates the context accordingly. - If node is RequestId, reads the contents and stores in RequestId property. - - - True if a node was read, false if there are no more elements to read./ - - - - - A stream which caches the contents of the underlying stream as it reads it. - - - - - All the bytes read by the stream. - - - - - All the bytes read by the stream constrained with _cacheLimit - - - - - Initializes the CachingWrapperStream with a base stream. - - The stream to be wrapped. - Maximum number of bytes to be cached. - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Gets a value indicating whether the current stream supports seeking. - CachingWrapperStream does not support seeking, this will always be false. - - - - - Gets or sets the position within the current stream. - CachingWrapperStream does not support seeking, attempting to set Position - will throw NotSupportedException. - - - - - Sets the position within the current stream. - CachingWrapperStream does not support seeking, attempting to call Seek - will throw NotSupportedException. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Stream wrapper that double-buffers from a wrapped stream and - returns the buffered content as a series of signed 'chunks' - for the AWS4 ('Signature V4') protocol. - - - - - Reads some or all of the processed chunk to the consumer, constructing - and streaming a new chunk if more input data is available. - - - - - - - - - Attempt to read sufficient data for a whole chunk from the wrapped stream, - returning the number of bytes successfully read to be processed into a chunk - - - - - Results of the header-signing portion of the request - - - - - Computed signature of the chunk prior to the one in-flight, in - hex - - - - - Computes the derived signature for a chunk of data of given length in the input buffer, - placing a formatted chunk with headers, signature and data into the output buffer - ready for streaming back to the consumer. - - - - - - Length override to return the true length of the payload plus the metainfo - supplied with each chunk - - - - - Computes the total size of the data payload, including the chunk metadata. - Called externally so as to be able to set the correct Content-Length header - value. - - - - - - - Computes the size of the header data for each chunk. - - - - - - - Attempt to read sufficient data for a whole chunk from the wrapped stream, - returning the number of bytes successfully read to be processed into a chunk - - - - - A list object that will always be sent to AWS services, - even if it is empty. - The AWS .NET SDK does not send empty collections to services, unless - the collection is of this type. - - - - - - A dictionary object that will always be sent to AWS services, - even if it is empty. - The AWS .NET SDK does not send empty collections to services, unless - the collection is of this type. - - - - - - - Class to perform actions on a background thread. - Uses a single background thread and performs actions - on it in the order the data was sent through the instance. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Class to invoke actions on a background thread. - Uses a single background thread and invokes actions - on it in the order they were invoked through the instance. - - - - - PCL doesn't have IPAddress. These methods are copied from the Microsoft source code. - - - - - Returns true if the Content is set or there are - query parameters. - - This request - True if data is present; false otherwise. - - - - Utilities for dealing with Guids - - - - - Hashes a set of objects. - - - - - - - Combines a set of hashses. - - - - - - - Combines two hashes. - - - - - - - - Disposes of all managed and unmanaged resources. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - A wrapper stream that calculates a hash of the base stream as it - is being read. - The calculated hash is only available after the stream is closed or - CalculateHash is called. After calling CalculateHash, any further reads - on the streams will not change the CalculatedHash. - If an ExpectedHash is specified and is not equal to the calculated hash, - Close or CalculateHash methods will throw an AmazonClientException. - If CalculatedHash is calculated for only the portion of the stream that - is read. - - - Exception thrown during Close() or CalculateHash(), if ExpectedHash is set and - is different from CalculateHash that the stream calculates, provided that - CalculatedHash is not a zero-length byte array. - - - - - Algorithm to use to calculate hash. - - - - - True if hashing is finished and no more hashing should be done; - otherwise false. - - - - - Current position in the stream. - - - - - Calculated hash for the stream. - This value is set only after the stream is closed. - - - - - Expected hash value. Compared against CalculatedHash upon Close(). - If the hashes are different, an AmazonClientException is thrown. - - - - - Expected length of stream. - - - - - Initializes an HashStream with a hash algorithm and a base stream. - - Stream to calculate hash for. - - Expected hash. Will be compared against calculated hash on stream close. - Pass in null to disable check. - - - Expected length of the stream. If the reading stops before reaching this - position, CalculatedHash will be set to empty array. - - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Asynchronously reads a sequence of bytes from the current stream, advances - the position within the stream by the number of bytes read, and monitors - cancellation requests. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous read operation. The value of the TResult - parameter contains the total number of bytes read into the buffer. This can be - less than the number of bytes requested if that many bytes are not currently - available, or zero (0) if the end of the stream has been reached. - - - - - Gets a value indicating whether the current stream supports seeking. - HashStream does not support seeking, this will always be false. - - - - - Gets or sets the position within the current stream. - HashStream does not support seeking, attempting to set Position - will throw NotSupportedException. - - - - - Sets the position within the current stream. - HashStream does not support seeking, attempting to call Seek - will throw NotSupportedException. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Gets the overridden length used to construct the HashStream - - - - - Calculates the hash for the stream so far and disables any further - hashing. - - - - - Resets the hash stream to starting state. - Use this if the underlying stream has been modified and needs - to be rehashed without reconstructing the hierarchy. - - - - - Validates the underlying stream. - - - - - Compares two hashes (arrays of bytes). - - Expected hash. - Actual hash. - - True if the hashes are identical; otherwise false. - - - - - A wrapper stream that calculates a hash of the base stream as it - is being read or written. - The calculated hash is only available after the stream is closed or - CalculateHash is called. After calling CalculateHash, any further reads - on the streams will not change the CalculatedHash. - If an ExpectedHash is specified and is not equal to the calculated hash, - Close or CalculateHash methods will throw an AmazonClientException. - If base stream's position is not 0 or HashOnReads is true and the entire stream is - not read, the CalculatedHash will be set to an empty byte array and - comparison to ExpectedHash will not be made. - - - Exception thrown during Close() or CalculateHash(), if ExpectedHash is set and - is different from CalculateHash that the stream calculates, provided that - CalculatedHash is not a zero-length byte array. - - - - - Initializes an HashStream with a hash algorithm and a base stream. - - Stream to calculate hash for. - - Expected hash. Will be compared against calculated hash on stream close. - Pass in null to disable check. - - - Expected length of the stream. If the reading stops before reaching this - position, CalculatedHash will be set to empty array. - - - - - A wrapper stream that calculates an MD5 hash of the base stream as it - is being read or written. - The calculated hash is only available after the stream is closed or - CalculateHash is called. After calling CalculateHash, any further reads - on the streams will not change the CalculatedHash. - If an ExpectedHash is specified and is not equal to the calculated hash, - Close or CalculateHash methods will throw an AmazonClientException. - If base stream's position is not 0 or HashOnReads is true and the entire stream is - not read, the CalculatedHash will be set to an empty byte array and - comparison to ExpectedHash will not be made. - - - Exception thrown during Close() or CalculateHash(), if ExpectedHash is set and - is different from CalculateHash that the stream calculates, provided that - CalculatedHash is not a zero-length byte array. - - - - - Initializes an MD5Stream with a base stream. - - Stream to calculate hash for. - - Expected hash. Will be compared against calculated hash on stream close. - Pass in null to disable check. - - - Expected length of the stream. If the reading stops before reaching this - position, CalculatedHash will be set to empty array. - - - - - Utilities for validating label values for host prefix templates - - - - - Validates a label value - - - - - Simple wrapper around the log4net Error method. - - - - - - - - Write debug message to Console - - - - - - - - Write debug message to Console - - - - - - - Simple wrapper around the log4net InfoFormat method. - - - - - - - This is a dynamic wrapper around log4net so we can avoid log4net being required - to be distributed with the SDK. - - - - - Abstract logger class, base for any custom/specific loggers. - - - - - Flushes the logger contents. - - - - - Simple wrapper around the log4net IsErrorEnabled property. - - - - - Simple wrapper around the log4net IsDebugEnabled property. - - - - - Simple wrapper around the log4net IsInfoEnabled property. - - - - - Simple wrapper around the log4net Error method. - - - - - - - - Simple wrapper around the log4net Debug method. - - - - - - - - Simple wrapper around the log4net DebugFormat method. - - - - - - - Simple wrapper around the log4net InfoFormat method. - - - - - - - Logger wrapper for reflected log4net logging methods. - - - - - This should be a one time call to use reflection to find all the types and methods - needed for the logging API. - - - - - Simple wrapper around the log4net IsErrorEnabled property. - - - - - Simple wrapper around the log4net Error method. - - - - - - - - Simple wrapper around the log4net IsDebugEnabled property. - - - - - Simple wrapper around the log4net Debug method. - - - - - - - - Simple wrapper around the log4net DebugFormat method. - - - - - - - Simple wrapper around the log4net IsInfoEnabled property. - - - - - Simple wrapper around the log4net InfoFormat method. - - - - - - - A single logged message - - - - - Log message arguments. - - - - - Culture-specific formatting provider. - - - - - Log message format. - - - - - a size-limited cache of key value pairs - - Once the maximum size has been reached, the least recently - used pairs will be evicted to make room for any new items. - - - - - - - the maximum number of entries this LruCache will hold - before items begin getting evicted - - - - - the number of items in the cache - - - - - Construct a new LruCache. - - maximum number of entries before items are evicted - - - - Add the key/value pair to the cache, or update - the value if the key already exists. - - If the cache is full, evicts the least recently used item. - - - - - - - Evicts a specific key out of the cache if it exists - - the key to evict from the cache - - - - Try to get the value associated with the key. - - the key to look up - the value, if the key exists - true if there is a value associated with the key, or false if no value is associated with the key - - - - Try to get the value associated with the key, if it doesn't exist, use the provided factory method to - create a new value and tries adding it to the cache. - - the key to look up - the factory method used in case the key is not present in the cache - the looked up value or the value created by the factory - - - - Clear the LruCache of all entries. - - - - - Helper class to support LruCache. - Does not implement the error checking and synchronization that - would be necessary for it to stand alone. - - - - - Item to be stored in the LruList - linked list structure. - - - - - Collection of properties being tracked - - - - - Timings for metrics being tracked - - - - - Counters being tracked - - - - - Whether metrics are enabled for the request - - - - - Constructs an empty, disabled metrics object - - - - - Starts timing an event. Logs an exception if an event - of the same type was started but not stopped. - - - - - - - Stops timing an event. Logs an exception if the event wasn't started. - - - - - - - Adds a property for a metric. If there are multiple, the - object is added as a new item in a list. - - - - - - - Sets a counter for a specific metric. - - - - - - - Increments a specific metric counter. - If counter doesn't exist yet, it is set to 1. - - - - - - Returns errors associated with the metric, including - if there are still any timing events in-flight. - - - - - - Returns a string representation of the current metrics. - - - - - - Return a JSON represenation of the current metrics - - - - - - Timing information for a metric - - - - - Empty, stopped timing object - - - - - Timing object in a started state - - - - - - Stops timing - - - - - - Whether the timing has been stopped - - - - - Elapsed ticks from start to stop. - If timing hasn't been stopped yet, returns 0. - - - - - Elapsed time from start to stop. - If timing hasn't been stopped yet, returns TimeSpan.Zero - - - - - Timing event, stops timing of a metric when disposed - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - The destructor for the client class. - - - - - A wrapper stream which supresses disposal of the underlying stream. - - - - - Constructor for NonDisposingWrapperStream. - - The base stream to wrap. - - - - The Dispose implementation for this wrapper stream - does not close the underlying stream. - - - - - This class is used to wrap a stream for a particular segment of a stream. It - makes that segment look like you are reading from beginning to end of the stream. - - - - - Asynchronously reads a sequence of bytes from the current stream, advances - the position within the stream by the number of bytes read, and monitors - cancellation requests. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous read operation. The value of the TResult - parameter contains the total number of bytes read into the buffer. This can be - less than the number of bytes requested if that many bytes are not currently - available, or zero (0) if the end of the stream has been reached. - - - - - Asynchronously writes a sequence of bytes to the current stream and advances the - current position within this stream by the number of bytes written. - - - An array of bytes. This method copies count bytes from buffer to the current stream. - - - The zero-based byte offset in buffer at which to begin copying bytes to the - current stream. - - The number of bytes to be written to the current stream. - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - A task that represents the asynchronous write operation. - - - - Wrapper stream that only supports reading - - - - - Asynchronously clears all buffers for this stream and causes any buffered data - to be written to the underlying device. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous flush operation. - - - - - Asynchronously writes a sequence of bytes to the current stream and advances the - current position within this stream by the number of bytes written. - - - An array of bytes. This method copies count bytes from buffer to the current stream. - - - The zero-based byte offset in buffer at which to begin copying bytes to the - current stream. - - The number of bytes to be written to the current stream. - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - A task that represents the asynchronous write operation. - - - - Partial wrapper stream that only supports reading - - - - - Uri wrapper that can parse out information (bucket, key, region, style) from an - S3 URI. - - - - - True if the URI contains the bucket in the path, false if it contains the bucket in the authority. - - - - - The bucket name parsed from the URI (or null if no bucket specified). - - - - - The key parsed from the URI (or null if no key specified). - - - - - The region parsed from the URI (or null if no region specified). - - - - - Constructs a parser for the S3 URI specified as a string. - - The S3 URI to be parsed. - - - - Constructs a parser for the S3 URI specified as a Uri instance. - - The S3 URI to be parsed. - - - - Percent-decodes the given string, with a fast path for strings that are not - percent-encoded. - - The string to decode - The decoded string - - - - Percent-decodes the given string. - - The string to decode - The index of the first '%' in the string - The decoded string - - - - Decodes the percent-encoded character at the given index in the string - and appends the decoded value to the string under construction. - - - The string under construction to which the decoded character will be - appended. - - The string being decoded. - The index of the '%' character in the string. - - - - Converts a hex character (0-9A-Fa-f) into its corresponding quad value. - - The hex character - The quad value - - - - Interface for a non-generic cache. - - - - - Clears the entire cache. - - - - - Maximum time to keep an item around after its last use. - - - - - How often should the cache be cleared of old items. - - - - - The number of items in the cache. - - - - - Interface for a generic cache. - - - - - - - Retrieves a value out of the cache or from the source. - - - - - - - - Retrieves a value out of the cache or from the source. - If the item was in the cache, isStaleItem is set to true; - otherwise, if the item comes from the source, isStaleItem is false. - - - - - - - - - Clears a specific value from the cache if it's there. - - - - - - Returns the keys for all items in the cache. - - - - - - Executes specified operation, catches exception, clears the cache for - the given key, retries the operation. - - - - - - - - - - - SDK-wide cache. - Provides access to caches specific to a particular set of credentials - and target region. - - - - - Clear all caches - - - - - Clear all caches of a particular type - - - - - - Retrieve a cache of a specific type for a client object. - The client object can be null in cases where a cache does - not correspond to a specific AWS account or target region. - - - - - - - - - - - Retrieve a cache of a specific type for a client object. - The client object can be null in cases where a cache does - not correspond to a specific AWS account or target region. - - - - - - - - - - - Utilities for converting objects to strings. Used by the marshaller classes. - - - - - Converts a DateTime to ISO8601 formatted string. - - - - - Converts a DateTime to RFC822 formatted string. - - - - - Converts a DateTime to Unix epoch time formatted string. - - - - - A wrapper stream. - - - - - Base stream. - - - - - Initializes WrapperStream with a base stream. - - - - - - Returns the first base non-WrapperStream. - - First base stream that is non-WrapperStream. - - - - Returns the first base non-WrapperStream. - - First base stream that is non-WrapperStream. - - - - Returns the first base non-WrapperStream. - - Potential WrapperStream - Base non-WrapperStream. - - - - Gets a value indicating whether the current stream supports reading. - True if the stream supports reading; otherwise, false. - - - - - Gets a value indicating whether the current stream supports seeking. - True if the stream supports seeking; otherwise, false. - - - - - Gets a value indicating whether the current stream supports writing. - True if the stream supports writing; otherwise, false. - - - - - Closes the current stream and releases any resources (such as sockets and - file handles) associated with the current stream. - - - - - Gets the length in bytes of the stream. - - - - - Gets or sets the position within the current stream. - - - - - Gets or sets a value, in miliseconds, that determines how long the stream - will attempt to read before timing out. - - - - - Gets or sets a value, in miliseconds, that determines how long the stream - will attempt to write before timing out. - - - - - Clears all buffers for this stream and causes any buffered data to be written - to the underlying device. - - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Sets the position within the current stream. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Sets the length of the current stream. - - The desired length of the current stream in bytes. - - - - Writes a sequence of bytes to the current stream and advances the current - position within this stream by the number of bytes written. - - - An array of bytes. This method copies count bytes from buffer to the current stream. - - - The zero-based byte offset in buffer at which to begin copying bytes to the - current stream. - - The number of bytes to be written to the current stream. - - - - Asynchronously clears all buffers for this stream and causes any buffered data - to be written to the underlying device. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous flush operation. - - - - - Asynchronously reads a sequence of bytes from the current stream, advances - the position within the stream by the number of bytes read, and monitors - cancellation requests. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - - A task that represents the asynchronous read operation. The value of the TResult - parameter contains the total number of bytes read into the buffer. This can be - less than the number of bytes requested if that many bytes are not currently - available, or zero (0) if the end of the stream has been reached. - - - - - Asynchronously writes a sequence of bytes to the current stream and advances the - current position within this stream by the number of bytes written. - - - An array of bytes. This method copies count bytes from buffer to the current stream. - - - The zero-based byte offset in buffer at which to begin copying bytes to the - current stream. - - The number of bytes to be written to the current stream. - - The token to monitor for cancellation requests. The default value is - System.Threading.CancellationToken.None. - - A task that represents the asynchronous write operation. - - - - This is a utility class to be used in last resort for code paths that are synchronous but need to call an asynchronous method. - This should never be used for methods that are called at high volume as this utility class has a performance cost. For example this - class was added for the refreshing credentials like Cognito which would need to use this about once an hour. - - - - - Custom WebProxy implementation that creates a webproxy based on - user inputs(Host name and port number) - - - - - Set the ProxyUri - - - - - Create a Uri based on the user inputs(Host name and port number) - - - - - Proxy Uri property - - - - - Proxy Credentials property - - - - - Getter to fetch the set proxy - - - - - Method to determine if the proxy should be bypassed when accessing an internet source - - - - - Error is always enabled - - - - - Debug logging is always enabled - - - - - Info logging is always enabled - - - - - Prints the Log With Error Level - - - - - - - - Prints the Log with Debug Level - - - - - - - - Prints the Log with Debug Level - - - - - - - Prints the Log With Info Level - - - - - - - This class is no longer used anymore and should be avoided as it is just meant - as a last resort when blending async and sync operations. The code is still - here to support versions before 3.3.9.0 of AWSSDK.DynamoDBv2. - - - - - Property to denote that the last exception returned by an AWS Service - was retryable or not. - - - - - An abstract pipeline handler that has implements IPipelineHandler, - and has the default implmentation. This is the base class for most of - the handler implementations. - - - - - The logger used to log messages. - - - - - The inner handler which is called after the current - handler completes it's processing. - - - - - The outer handler which encapsulates the current handler. - - - - - Contains the processing logic for a synchronous request invocation. - This method calls InnerHandler.InvokeSync to continue processing of the - request by the pipeline. - - The execution context which contains both the - requests and response context. - - - - Contains the processing logic for an asynchronous request invocation. - This method calls InnerHandler.InvokeSync to continue processing of the - request by the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Logs the metrics for the current execution context. - - The execution context, it contains the - request and response context. - - - - A runtime pipeline contains a collection of handlers which represent - different stages of request and response processing. - - - - - The top-most handler in the pipeline. - - - - - Constructor for RuntimePipeline. - - The handler with which the pipeline is initalized. - - - - Constructor for RuntimePipeline. - - List of handlers with which the pipeline is initalized. - - - - Constructor for RuntimePipeline. - - List of handlers with which the pipeline is initalized. - The logger used to log messages. - - - - Constructor for RuntimePipeline. - - The handler with which the pipeline is initalized. - The logger used to log messages. - - - - Invokes the pipeline synchronously. - - Request context - Response context - - - - Invokes the pipeline asynchronously. - - Request context - Response context - - - - Adds a new handler to the top of the pipeline. - - The handler to be added to the pipeline. - - - - Adds a handler after the first instance of handler of type T. - - Type of the handler after which the given handler instance is added. - The handler to be added to the pipeline. - - - - Adds a handler before the first instance of handler of type T. - - Type of the handler before which the given handler instance is added. - The handler to be added to the pipeline. - - - - Removes the first occurance of a handler of type T. - - Type of the handler which will be removed. - - - - Replaces the first occurance of a handler of type T with the given handler. - - Type of the handler which will be replaced. - The handler to be added to the pipeline. - - - - Inserts the given handler after current handler in the pipeline. - - Handler to be inserted in the pipeline. - Handler after which the given handler is inserted. - - - - Gets the innermost handler by traversing the inner handler till - it reaches the last one. - - - - - Retrieves a list of handlers, in the order of their execution. - - Handlers in the current pipeline. - - - - Retrieves current handlers, in the order of their execution. - - Handlers in the current pipeline. - - - - This handler processes exceptions thrown from the HTTP handler and - unmarshalls error responses. - - - - - Default set of exception handlers. - - - - - Default set of exception handlers. - - - - - Constructor for ErrorHandler. - - an ILogger instance. - - - - Handles and processes any exception thrown from underlying handlers. - - The execution context which contains both the - requests and response context. - - - - Handles and processes any exception thrown from underlying handlers. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Disposes the response body. - - The response context. - - - - Processes an exception by invoking a matching exception handler - for the given exception. - - The execution context, it contains the - request and response context. - The exception to be processed. - - This method returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception that may be thrown by exception - processing by a matching exception handler. - - - - - The abstract base class for exception handlers. - - The exception type. - - - - The exception handler for HttpErrorResponseException exception. - - - - - The constructor for HttpErrorResponseExceptionHandler. - - in instance of ILogger. - - - - Handles an exception for the given execution context. - - The execution context, it contains the - request and response context. - The exception to handle. - - Returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception to replace the original exception. - - - - - Checks if a HTTP 404 status code is returned which needs to be suppressed and - processes it. - If a suppressed 404 is present, it unmarshalls the response and returns true to - indicate that a suppressed 404 was processed, else returns false. - - The execution context, it contains the - request and response context. - - - If a suppressed 404 is present, returns true, else returns false. - - - - - A pipeline handler which provides hooks to run - external code in the pre-invoke and post-invoke phases. - - - - - Action to execute on the pre invoke phase. - - - - - Action to execute on the post invoke phase. - - - - - Calls the PreInvoke and PostInvoke methods before and after calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls the PreInvoke and PostInvoke methods before and after calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Executes the OnPreInvoke action as part of pre-invoke. - - The execution context, it contains the - request and response context. - - - - Executes the OnPreInvoke action as part of post-invoke. - - The execution context, it contains the - request and response context. - - - - This handler retrieved the AWS credentials to be used for the current call. - - - - - The constructor for CredentialsRetriever. - - An AWSCredentials instance. - - - - Retrieves the credentials to be used for the current call before - invoking the next handler. - - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - This handler resolves the endpoint to be used for the current request. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Resolves the endpoint to be used for the current request - before invoking the next handler. - - The execution context, it contains the - request and response context. - - - - This handler resolves the endpoint to be used for the current request. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Resolves the endpoint to be used for the current request - before invoking the next handler. - - The execution context, it contains the - request and response context. - - - - Determines the endpoint for the request. - - The request context. - - - - - This handler provides an OnError action that can be used as hook for - external code to handle exceptions in the runtime pipeline. - - - - - Action to execute if an exception occurs during the - execution of any underlying handlers. - - - - - Executes the OnError action if an exception occurs during the - execution of any underlying handlers. - - - - - - - This handler marshalls the request before calling invoking the next handler. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Marshalls the request before calling invoking the next handler. - - The execution context, it contains the - request and response context. - - - - This handler manages the metrics used to time the complete call and - logs the final metrics. - - - - - Captures the overall execution time and logs final metrics. - - The execution context which contains both the - requests and response context. - - - - Captures the overall execution time and logs final metrics. - - The response type for the current request. - - The execution context, it contains the request and response context. - - A task that represents the asynchronous operation. - - - - This handler processes HTTP redirects and reissues the call to the - redirected location. - - - - - Processes HTTP redirects and reissues the call to the - redirected location. - - The execution context which contains both the - requests and response context. - - - - Processes HTTP redirects and reissues the call to the - redirected location. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Checks if an HTTP 307 (temporary redirect) has occured and changes the - request endpoint to the redirected location. - - - The execution context, it contains the request and response context. - - - A boolean value that indicates if a redirect has occured. - - - - - This handler signs the request. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Signs the request before invoking the next handler. - - - The execution context, it contains the request and response context. - - - - - Determines if the request should be signed. - - The request context. - A boolean value that indicated if the request should be signed. - - - - Signs the request. - - The request context. - - - - This handler unmarshalls the HTTP response. - - - - - The constructor for Unmarshaller. - - - Boolean value which indicated if the unmarshaller - handler supports response logging. - - - - - Unmarshalls the response returned by the HttpHandler. - - The execution context which contains both the - requests and response context. - - - - Unmarshalls the response returned by the HttpHandler. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Unmarshalls the HTTP response. - - - The execution context, it contains the request and response context. - - - - - Unmarshalls the HTTP response. - - - The execution context, it contains the request and response context. - - - - - The HTTP handler contains common logic for issuing an HTTP request that is - independent of the underlying HTTP infrastructure. - - - - - - The sender parameter used in any events raised by this handler. - - - - - The constructor for HttpHandler. - - The request factory used to create HTTP Requests. - The sender parameter used in any events raised by this handler. - - - - Issues an HTTP request for the current request context. - - The execution context which contains both the - requests and response context. - - - - Issues an HTTP request for the current request context. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Determines the content for request body and uses the HTTP request - to write the content to the HTTP request body. - - Content to be written. - The HTTP request. - The request context. - - - - Creates the HttpWebRequest and configures the end point, content, user agent and proxy settings. - - The async request. - The web request that actually makes the call. - - - - Disposes the HTTP handler. - - - - - The default implementation of the adaptive retry policy. - - - The default implementation of the adaptive policy. - - - - - Constructor for AdaptiveRetryPolicy. - - The maximum number of retries before throwing - back a exception. This does not count the initial request. - - - - Constructor for AdaptiveRetryPolicy. - - The Client config object. This is used to - retrieve the maximum number of retries before throwing - back a exception(This does not count the initial request) and - the service URL for the request. - - - - OnRetry is called when a retry request is initiated to determine if the request will be retried. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - true if the error that will be retried is a throtting error - True if retry throttling is disabled or retry throttling is enabled and capacity can be obtained. - - - - This method uses a token bucket to enforce the maximum sending rate. - - The execution context which contains both the - requests and response context. - If the prior request failed, this exception is expected to be - the exception that occurred during the prior request failure. - - - - Virtual method that gets called on a success Response. If its a retry success response, the entire - retry acquired capacity is released(default is 5). If its just a success response a lesser value capacity - is released(default is 1). - - Request context containing the state of the request. - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - This method uses a token bucket to enforce the maximum sending rate. - - The execution context which contains both the - requests and response context. - If the prior request failed, this exception is expected to be - the exception that occurred during the prior request failure. - - - - The default implementation of the legacy retry policy. - - - The default implementation of the legacy retry policy. - - - - - The maximum value of exponential backoff in milliseconds, which will be used to wait - before retrying a request. The default is 30000 milliseconds. - - - - - Constructor for DefaultRetryPolicy. - - The maximum number of retries before throwing - back a exception. This does not count the initial request. - - - - Constructor for DefaultRetryPolicy. - - The Client config object. This is used to - retrieve the maximum number of retries before throwing - back a exception(This does not count the initial request) and - the service URL for the request. - - - - Returns true if the request is in a state where it can be retried, else false. - - Request context containing the state of the request. - Returns true if the request is in a state where it can be retried, else false. - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - true if the error that will be retried is a throtting error - - - - Virtual method that gets called on a success Response. If its a retry success response, the entire - retry acquired capacity is released(default is 5). If its just a success response a lesser value capacity - is released(default is 1). - - Request context containing the state of the request. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Request context containing the state of the request. - Return true if the request should be retried. - - - - Checks if the retry limit is reached. - - Request context containing the state of the request. - Return false if the request can be retried, based on number of retries. - - - - Waits before retrying a request. The default policy implements a exponential backoff. - - Request context containing the state of the request. - - - - Waits for an amount of time using an exponential backoff algorithm. - - The request retry index. The first request is expected to be 0 while - the first retry will be 1. - The max number of milliseconds to wait - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - The retry handler has the generic logic for retrying requests. - It uses a retry policy which specifies when - a retry should be performed. - - - - - The logger used to log messages. - - - - - The retry policy which specifies when - a retry should be performed. - - - - - Constructor which takes in a retry policy. - - Retry Policy - - - - Invokes the inner handler and performs a retry, if required as per the - retry policy. - - The execution context which contains both the - requests and response context. - - - - Invokes the inner handler and performs a retry, if required as per the - retry policy. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Prepares the request for retry. - - Request context containing the state of the request. - - - - The default implementation of the standard retry policy. - - - The default implementation of the standard policy. - - - - - The maximum value of exponential backoff in milliseconds, which will be used to wait - before retrying a request. The default is 20000 milliseconds. - - - - - Constructor for StandardRetryPolicy. - - The maximum number of retries before throwing - back a exception. This does not count the initial request. - - - - Constructor for StandardRetryPolicy. - - The Client config object. This is used to - retrieve the maximum number of retries before throwing - back a exception(This does not count the initial request) and - the service URL for the request. - - - - Returns true if the request is in a state where it can be retried, else false. - - Request context containing the state of the request. - Returns true if the request is in a state where it can be retried, else false. - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - true if the error that will be retried is a throtting error - - - - Virtual method that gets called on a success Response. If its a retry success response, the entire - retry acquired capacity is released(default is 5). If its just a success response a lesser value capacity - is released(default is 1). - - Request context containing the state of the request. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Request context containing the state of the request. - Return true if the request should be retried. - - - - Checks if the retry limit is reached. - - Request context containing the state of the request. - Return false if the request can be retried, based on number of retries. - - - - Waits before retrying a request. The default policy implements a exponential backoff with - jitter algorithm. - - Request context containing the state of the request. - - - - Waits for an amount of time using an exponential backoff with jitter algorithm. - - The request retry index. The first request is expected to be 0 while - the first retry will be 1. - The max number of milliseconds to wait - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - This class is the base class of all the configurations settings to connect - to a service. - - - This class is the base class of all the configurations settings to connect - to a service. - - - - - Gets Service Version - - - - - Gets and sets of the signatureMethod property. - - - - - Gets and sets of the SignatureVersion property. - - Note: This property exists for backward compatibility but is no longer - used by any service other than S3. - - - - - Gets and sets of the UserAgent property. - - - - - Gets and sets the RegionEndpoint property. The region constant that - determines the endpoint to use. - - Setting this property to null will force the SDK to recalculate the - RegionEndpoint value based on App/WebConfig, environment variables, - profile, etc. - - - - - The constant used to lookup in the region hash the endpoint. - - - - - Gets and sets of the ServiceURL property. - This is an optional property; change it - only if you want to try a different service - endpoint. - - - - - Gets and sets the UseHttp. - If this property is set to true, the client attempts - to use HTTP protocol, if the target endpoint supports it. - By default, this property is set to false. - - - - - Given this client configuration, return a string form ofthe service endpoint url. - - - - - Gets and sets the AuthenticationRegion property. - Used in AWS4 request signing, this is an optional property; - change it only if the region cannot be determined from the - service endpoint. - - - - - Gets and sets the AuthenticationServiceName property. - Used in AWS4 request signing, this is the short-form - name of the service being called. - - - - - Returns the flag indicating how many retry HTTP requests an SDK should - make for a single SDK operation invocation before giving up. This flag will - return 4 when the RetryMode is set to "Legacy" which is the default. For - RetryMode values of "Standard" or "Adaptive" this flag will return 2. In - addition to the values returned that are dependant on the RetryMode, the - value can be set to a specific value by using the AWS_MAX_ATTEMPTS environment - variable, max_attempts in the shared configuration file, or by setting a - value directly on this property. When using AWS_MAX_ATTEMPTS or max_attempts - the value returned from this property will be one less than the value entered - because this flag is the number of retry requests, not total requests. To - learn more about the RetryMode property that affects the values returned by - this flag, see . - - - - - Determines if MaxErrorRetry has been manually set. - - - - - Gets and sets the LogResponse property. - If this property is set to true, the service response is logged. - The size of response being logged is controlled by the AWSConfigs.LoggingConfig.LogResponsesSizeLimit property. - - - - - Gets and sets the ReadEntireResponse property. - NOTE: This property does not effect response processing and is deprecated. - To enable response logging, the ClientConfig.LogResponse and AWSConfigs.LoggingConfig - properties can be used. - - - - - Gets and Sets the BufferSize property. - The BufferSize controls the buffer used to read in from input streams and write - out to the request. - - - - - - Gets or sets the interval at which progress update events are raised - for upload operations. By default, the progress update events are - raised at every 100KB of data transferred. - - - If the value of this property is set less than ClientConfig.BufferSize, - progress updates events will be raised at the interval specified by ClientConfig.BufferSize. - - - - - - Flag on whether to resign requests on retry or not. - For Amazon S3 and Amazon Glacier this value will always be set to true. - - - - - This flag controls if .NET HTTP infrastructure should follow redirection - responses (e.g. HTTP 307 - temporary redirect). - - - - - Flag on whether to log metrics for service calls. - - This can be set in the application's configs, as below: - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSLogMetrics" value"true"/> - </appSettings> - </configuration> - - - - - - Gets and sets the DisableLogging. If true logging for this client will be disabled. - - - - - Credentials to use with a proxy. - - - - - - If the value is set, the value is assigned to the Timeout property of the HttpWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Configures the endpoint calculation for a service to go to a dual stack (ipv6 enabled) endpoint - for the configured region. - - - Note: AWS services are enabling dualstack endpoints over time. It is your responsibility to check - that the service actually supports a dualstack endpoint in the configured region before enabling - this option for a service. - - - - - Enable or disable the Retry Throttling feature by setting the ThrottleRetries flag to True/False resepctively. - Retry Throttling is a feature that intelligently throttles retry attempts when a large precentage of requests - are failing and retries are unsuccessful as well. In such situations the allotted retry capacity for the service URL - will be drained until requests start to succeed again. Once the requisite capacity is available, retries would - be permitted again. When retries are throttled, the service enters a fail-fast behaviour as the traditional retry attempt - for the request would be circumvented. Hence, errors will resurface quickly. This will result in a greated number of exceptions - but prevents requests being tied up in unsuccessful retry attempts. - Note: Retry Throttling is enabled by default. Set the ThrottleRetries flag to false to switch off this feature. - - - - - Enable or disable the Nagle algorithm on the underlying http - client. - - This method is not intended to be called by consumers of the AWS SDK for .NET - - - - - - Performs validation on this config object. - Throws exception if any of the required values are missing/invalid. - - - - - Returns the current UTC now after clock correction for this endpoint. - - - - - The calculated clock skew correction for a specific endpoint, if there is one. - This field will be set if a service call resulted in an exception - and the SDK has determined that there is a difference between local - and server times. - - If is set to true, this - value will still be set to the correction, but it will not be used by the - SDK and clock skew errors will not be retried. - - - - - Gets and sets the DisableHostPrefixInjection flag. If true, host prefix injection will be disabled for this client, the default value of this flag is false. - Host prefix injection prefixes the service endpoint with request members from APIs which use this feature. - Example: for a hostPrefix of "foo-name." and a endpoint of "service.region.amazonaws.com" the default behavior is to - prefix the endpoint with the hostPrefix resulting in a final endpoint of "foo-name.service.region.amazonaws.com". Setting - DisableHostPrefixInjection to true will disable hostPrefix injection resulting in a final endpoint of - "service.region.amazonaws.com" regardless of the value of hostPrefix. E.g. You may want to disable host prefix injection for testing against a local mock endpoint. - - - - - Returns the flag indicating if endpoint discovery should be enabled or disabled for operations that are not required to use endpoint discovery. - - - - - Returns the maximum number of discovered endpoints that can be stored within the cache for the client. The default limit is 1000 cache entries. - - - - - Returns the flag indicating the current mode in use for request - retries and influences the value returned from . - The default value is RequestRetryMode.Legacy. This flag can be configured - by using the AWS_RETRY_MODE environment variable, retry_mode in the - shared configuration file, or by setting this value directly. - - - - - Under Adaptive retry mode, this flag determines if the client should wait for - a send token to become available or don't block and fail the request immediately - if a send token is not available. - - - - - Throw an exception if the boxed TimeSpan parameter doesn't have a value or is out of range. - - - - - Returns the request timeout value if its value is set, - else returns client timeout value. - - - - - - This is a switch used for performance testing and is not intended for production applications - to change. This switch may be removed in a future version of the SDK as the .NET Core platform matures. - - - If true, the HttpClient is cached and reused for every request made by the service client - and shared with other service clients. - - - For the .NET Core platform this is default to true because the HttpClient manages the connection - pool. - - - - - - If CacheHttpClient is set to true then HttpClientCacheSize controls the number of HttpClients cached. - - On Windows the default value is 1 since the underlying native implementation does not have throttling constraints - like the non Windows Curl based implementation. For non Windows based platforms the default is the value return from - System.Environment.ProcessorCount. - - - - - - Overrides the default read-write timeout value. - On Unity platform, this value is not used as Unity HTTP client does not support timeouts, so - - - - If the value is set, the value is assigned to the ReadWriteTimeout property of the HttpWebRequest object used - to send requests. - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Returns a WebProxy instance configured to match the proxy settings - in the client configuration. - - - - - Unpacks the host, port and any credentials info into the instance's - proxy-related fields. - Unlike the SetWebProxy implementation on .NET 3.5/4.5,the Host and the Port are not reconstructed from the - input proxyuri - - The proxy details - - - - Gets and sets of the ProxyHost property. - - - - - Gets and sets of the ProxyPort property. - - - - - - Returns true if the clients should be cached by HttpRequestMessageFactory, false otherwise. - - - - - - - Returns true if the SDK should dispose HttpClients after one use, false otherwise. - - - - - - - Create a unique string used for caching the HttpClient based on the settings that are used from the ClientConfig that are set on the HttpClient. - - - - - - - Determines if HttpClients created with the given IClientConfig should be cached at the SDK - client level, or cached globally. - - If there is no HttpClientFactory assigned and proxy or proxy credentials are set - this returns false because those properties can't be serialized as part of the key in the global http client cache. - - - - - Base class for constant class that holds the value that will be sent to AWS for the static constants. - - - - - Gets the value that needs to be used when send the value to AWS - - - - - Attempt to find correct-cased constant value using whatever cased value the user - has provided. This is primarily useful for mapping any-cased values from a CLI - tool to the specific casing required by the service, avoiding the need for the - user to (a) remember the specific case and (b) actually type it correctly. - - The properly cased service constant matching the value - - - - Utility class that stores clock skew information. - - - - - GlobalClockCorrection should be only set by AWSConfigs.ManualClockCorrection property - and is only available to maintain backward compatibilty. This should override any - endpoint specific clockskew correction. - - - - - Return clock skew correction value for an endpoint if there is one. - - AWSConfigs.ManualClockCorrection overrides globally any calculated service endpoint specific - clock correction value. - - Endpoint should in a form such as "https://s3" - Clock correction value for an endpoint in TimeSpan. TimeSpan.Zero if no such clock correction is set. - - - - Get clock skew corrected UTC now value. If ManualClockCorrection is set, - use ManualClockCorrection instead of endpoint specific clock correction value. - - - - - - - Probing mechanism to determine the endpoint discovery enabled value from various sources. - - - - - The valid hashing algorithm supported by the sdk for request signing. - - - - - Which end of a request was responsible for a service error response. - - - - - The sender was responsible for the error, i.e. the client - request failed validation or was improperly formatted. - - - - - The error occured within the service. - - - - - An unrecognized error type was returned. - - - - - Sts Regional Endpoints Value determines whether or not - to send the sts request to the regional endpoint or to - the global sts endpoint - - - - - Send the request to the global sts endpoint - if the region is a legacy global region - - - - - Send the request to the regional endpoint - - - - - S3 US East 1 endpoint value determines wheter or not - to send the us-east-1 s3 requests to the regional endpoint or to - the legacy global endpoint - - - - - Sends the requests to the legacy global s3 endpoint for us-east-1 - - - - - Sends the request to the regional s3 endpoint for us-east-1 - - - - - RetryMode determines which request retry mode is used for requests that do - not complete successfully. - - - - - Legacy request retry strategy. - - - - - Standardized request retry strategy that is consistent across all SDKs. - - - - - An experimental request retry strategy that builds on the Standard strategy - and introduces congestion control through client side rate limiting. - - - - - All Amazon service interfaces like IAmazonS3 extend from this interface. This allows all the - Amazon service interfaces be identified by this base interface and helps with generic constraints. - - - - - A readonly view of the configuration for the service client. - - - - - This interface is the read only access to the ClientConfig object used when setting up service clients. Once service clients - are initiated the config object should not be changed to avoid issues with using a service client in a multi threaded environment. - - - - - Gets the RegionEndpoint property. The region constant to use that - determines the endpoint to use. If this is not set - then the client will fallback to the value of ServiceURL. - - - - - The constant used to lookup in the region hash the endpoint. - - - - - Gets and sets of the ServiceURL property. - This is an optional property if you need to set a specific service URL - instead setting the region with the RegionEndpoint property. - - - - - Gets the UseHttp property. - If this property is set to true, the client attempts - to use HTTP protocol. - By default, this property is set to false. - - - - - Gets Service Version - - - - - Gets the signatureMethod property. - - - - - Gets the SignatureVersion property. - - Note: This property exists for backward compatibility but is no longer - used by any service other than S3. - - - - - Gets the AuthenticationRegion property. - Used in AWS4 request signing, this is an optional property; - change it only if the region cannot be determined from the - service endpoint. - - - - - Gets the AuthenticationServiceName property. - Used in AWS4 request signing, this is the short-form - name of the service being called. - - - - - Gets the UserAgent property. - - - - - Gets the DisableLogging. If true logging for this client will be disabled. - - - - - Flag on whether to log metrics for service calls. - - This can be set in the application's configs, as below: - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSLogMetrics" value"true"/> - </appSettings> - </configuration> - - - - - - Gets the LogResponse property. - If this property is set to true, the service response - is read in its entirety and logged. - - - - - Gets the ReadEntireResponse. - If this property is set to true, the service response - is read in its entirety before being processed. - - - - - This flag controls if .NET HTTP infrastructure should follow redirection - responses (e.g. HTTP 307 - temporary redirect). - - - - - Gets the BufferSize property. - The BufferSize controls the buffer used to read in from input streams and write - out to the request. - - - - - Returns the flag indicating how many retry HTTP requests an SDK should - make for a single SDK operation invocation before giving up. This flag will - return 4 when the RetryMode is set to "Legacy" which is the default. For - RetryMode values of "Standard" or "Adaptive" this flag will return 2. In - addition to the values returned that are dependant on the RetryMode, the - value can be set to a specific value by using the AWS_MAX_ATTEMPTS environment - variable, max_attempts in the shared configuration file, or by setting a - value directly on this property. When using AWS_MAX_ATTEMPTS or max_attempts - the value returned from this property will be one less than the value entered - because this flag is the number of retry requests, not total requests. To - learn more about the RetryMode property that affects the values returned by - this flag, see . - - - - - Determines if MaxErrorRetry has been manually set. - - - - - Gets the interval at which progress update events are raised - for upload operations. By default, the progress update events are - raised at every 100KB of data transferred. - - - - - Flag on whether to resign requests on retry or not. - - - - - Credentials to use with a proxy. - - - - - Gets the default request timeout value. - - - - If the value is set, the value is assigned to the Timeout property of the HTTPWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - - - - Configures the endpoint calculation for a service to go to a dual stack (ipv6 enabled) endpoint - for the configured region. - - - Note: AWS services are enabling dualstack endpoints over time. It is your responsibility to check - that the service actually supports a dualstack endpoint in the configured region before enabling - this option for a service. - - - - - Configures a flag enabling to either opt in or opt out of the retry throttling service. - Note: set value to true to enable retry throttling feature. The Default value for this flag is false. - - - - - Using either the RegionEndpoint or the ServiceURL determine what the URL to the service is. - - The URL to the service. - - - - Performs validation on this config object. - Throws exception if any of the required values are missing/invalid. - - The timeout specified is null. - - - - Returns the clock skew adjusted utc now. This value is affected by AWSConfigs.ManualClockCorrection - - - - - Returns the calculated clock skew value for this config's service endpoint. If AWSConfigs.CorrectForClockSkew is false, - this value won't be used to construct service requests. - - - - - Gets the DisableHostPrefixInjection flag. If true, host prefix injection will be disabled for this client, the default value of this flag is false. - Host prefix injection prefixes the service endpoint with request members from APIs which use this feature. - Example: for a hostPrefix of "foo-name." and a endpoint of "service.region.amazonaws.com" the default behavior is to - prefix the endpoint with the hostPrefix resulting in a final endpoint of "foo-name.service.region.amazonaws.com". Setting - DisableHostPrefixInjection to true will disable hostPrefix injection resulting in a final endpoint of - "service.region.amazonaws.com" regardless of the value of hostPrefix. E.g. You may want to disable host prefix injection for testing against a local mock endpoint. - - - - - Returns the flag indicating if endpoint discovery should be enabled or disabled for operations that are not required to use endpoint discovery. - - - - - Returns the maximum number of discovered endpoints that can be stored within the cache for the client. The default limit is 1000 cache entries. - - - - - Returns the flag indicating the current mode in use for request - retries and influences the value returned from . - The default value is RequestRetryMode.Legacy. This flag can be configured - by using the AWS_RETRY_MODE environment variable, retry_mode in the - shared configuration file, or by setting this value directly. - - - - - Under Adaptive retry mode, this flag determines if the client should wait for - a send token to become available or don't block and fail the request immediately - if a send token is not available. - - - - - - This is a switch used for performance testing and is not intended for production applications - to change. This switch may be removed in a future version of the SDK as the .NET Core platform matures. - - - If true, the HttpClient is cached and reused for every request made by the service client - and shared with other service clients. - - - For the .NET Core platform this is default to true because the HttpClient manages the connection - pool. - - - - - - If CacheHttpClient is set to true then HttpClientCacheSize controls the number of HttpClients cached. - - - - - Gets the ProxyHost property. - - - - - Gets the ProxyPort property. - - - - - Returns a WebProxy instance configured to match the proxy settings - in the client configuration. - - - - - - Interface for a single logged message. - - - - - Log message format. - - - - - Log message arguments. - - - - - Culture-specific formatting provider. - - - - - Abstract parameter value. - - - - - String parameter value. - - - - - String value of the parameter. - - - - - Constructs ParameterValue for a single string. - - - - - - String list parameter value. - - - - - List of strings value of the parameter. - - - - - Constructs ParameterValue for a list of strings. - - - - - - Metrics collected by the SDK on a per-request basis. - - - Each request made to an AWS service by the SDK can have metrics - collected and logged. This interface represents the collected - metrics for a request. The metrics include properties (i.e. request id - and other metadata), timings for each stage of the request, and counters. - - - - - Collection of properties being tracked - - - - - Timings for metrics being tracked - - - - - Counters being tracked - - - - - Whether metrics are enabled for the request - - - - - JSON representation of the current metrics - - JSON string - - - - Represents how long a phase of an SDK request took. - - - - - Whether the timing has been stopped - - - - - Elapsed ticks from start to stop. - If timing hasn't been stopped yet, returns 0. - - - - - Elapsed time from start to stop. - If timing hasn't been stopped yet, returns TimeSpan.Zero - - - - - User supplied type to perform metrics formatting. - - - - - Produce custom formatting for SDK metrics. - - - If defined, this method will be called for every request made by the SDK. - - An instance of IRequestMetrics produced by the SDK - formatted string representation of the metrics - - - - Predefined request metrics that are collected by the SDK. - - - - - Information about the request. - - - - - Gets and sets the RequestId property. - ID that uniquely identifies a request. Amazon keeps track of request IDs. If you have a question about a request, include the request ID in your correspondence. - - - - - This exception is thrown if there are problems signing the request. - - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - - - - Gets the percentage of transfer completed - - - - - Gets the number of bytes transferred since last event - - - - - Gets the number of bytes transferred - - - - - Gets the total number of bytes to be transferred - - - - - Returns a string representation of this object - - - - - - Anonymous credentials. - Using these credentials, the client does not sign the request. - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - AWS Credentials that automatically refresh by calling AssumeRole on - the Amazon Security Token Service. - - - - - The credentials of the user that will be used to call AssumeRole. - - - - - The Amazon Resource Name (ARN) of the role to assume. - - - - - An identifier for the assumed role session. - - - - - Options to be used in the call to AssumeRole. - - - - - Constructs an AssumeRoleAWSCredentials object. - - The credentials of the user that will be used to call AssumeRole. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - - - - Constructs an AssumeRoleAWSCredentials object. - - The credentials of the user that will be used to call AssumeRole. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRole. - - - - A unique identifier that is used by third parties when assuming roles in their customers' accounts. - - - - - An IAM policy in JSON format. - - - - - The length of time in seconds before the credentials will expire. - - - - - The identification number of the MFA device that is associated with the user who is making the assume-role call. - - - - - The value provided by the MFA device, if the trust policy of the role being assumed requires MFA. - - - - - A callback that's used to obtain the MFA token code when the AssumeRoleAWSCredentials are refreshed. - - - - - Immutable representation of AWS credentials obtained as a result of - authenticating with the AssumeRole method of the Security Token Service. - - - - - The expiry time of the credentials, obtained from the AssumeRoleResponse. - - - - - Constructs an instance with supplied keys, token, and expiration. - - The AccessKey for the credentials. - The SecretKey for the credentials. - The security token for the credentials. - The expiration time for the credentials. - - - - Get a copy of this AssumeRoleImmutableCredentials object. - - A copy of this object. - - - - Abstract class that represents a credentials object for AWS services. - - - - - Returns a copy of ImmutableCredentials - - - - - - Called by AmazonServiceClient to validate the credential state - on client construction. - - - - - Basic set of credentials consisting of an AccessKey and SecretKey - - - - - Constructs a BasicAWSCredentials object for the specified accessKey and secretKey. - - - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - Immutable representation of AWS credentials. - - - - - Gets the AccessKey property for the current credentials. - - - - - Gets the SecretKey property for the current credentials. - - - - - Gets the Token property for the current credentials. - - - - - Gets the UseToken property for the current credentials. - Specifies if Token property is non-emtpy. - - - - - Constructs an ImmutableCredentials object with supplied accessKey, secretKey. - - - - Optional. Can be set to null or empty for non-session credentials. - - - - Returns a copy of the current credentials. - - - - - - Abstract class for automatically refreshing AWS credentials - - - - - Refresh state container consisting of credentials - and the date of the their expiration - - - - - Represents the current state of the Credentials. - - This can be cleared without synchronization. - - - - Semaphore to control thread access to GetCredentialsAsync method. - The semaphore will allow only one thread to generate new credentials and - update the current state. - - - - - The time before actual expiration to expire the credentials. - Property cannot be set to a negative TimeSpan. - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - Test credentials existence and expiration time - should update if: - credentials have not been loaded yet - it's past the expiration time. At this point currentState.Expiration may - have the PreemptExpiryTime baked into to the expiration from a call to - UpdateToGeneratedCredentials but it may not if this is new application load. - - - - - When overridden in a derived class, generates new credentials and new expiration date. - - Called on first credentials request and when expiration date is in the past. - - - - - - When overridden in a derived class, generates new credentials and new expiration date. - - Called on first credentials request and when expiration date is in the past. - - - - - - Clears currently-stored credentials, forcing the next GetCredentials call to generate new credentials. - - - - - Immutable representation of AWS credentials obtained as a result of - authenticating against a SAML-supporting federated identity provider. - - - - - The expiry time of the credentials, obtained from the AssumeRoleWithSAML response. - - - - - The value of the NameID element in the Subject element of the SAML assertion, as returned in the - AssumeRoleWithSAML response from the Security Token Service. - - - - - Constructs an instance with supplied keys and SAML assertion data. - - - - - - - - - - Constructs an instance with supplied keys and SAML assertion data. - - - - - - - - Returns a copy of the current credentials. - - - - - - Serializes the instance to a json-format string for external storage - - The serialized object in json - - - - Instantiates an instance from persisted json data - - The serialized data - Deserialized instance corresponding to the json data - - - - Session credentials consisting of AccessKey, SecretKey and Token - - - - - Constructs a SessionAWSCredentials object for the specified accessKey, secretKey. - - - - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - Credentials that are retrieved from the Instance Profile service on an EC2 instance - - - - - Constructs a InstanceProfileAWSCredentials object for specific role - - Role to use - - - - Constructs a InstanceProfileAWSCredentials object for the first found role - - - - - Retrieves a list of all roles available through current InstanceProfile service - - InstanceProfileAWSCredentials is no longer supported in PCL. - - - - - - Superclass for Exceptions that come over the event stream, or to wrap other kinds of generic exceptions. - - - - - The numeric code identifier for the type of error. - - - - - Constructs an EventStreamError. - - - - - Constructs an EventStreamError. - - The error code. - The error message. - - - - Event args that contain an . - - The - - - - The EventStream Event. - - - - - Constructs an EventStreamEventReceivedArgs. - - The EventStream Event. - - - - Event args that contain an . - - The . - - - - The EventStream Exception. - - - - - Constructs an EventStreamExceptionReceivedArgs. - - The EventStream Exception. - - - - Supported Header types for vnd.amazon.event-stream - - - - - Name for the Header. Maximum of 255 bytes. - - - - - Header type id - - - - - Computes the amount of memory neccesary to serialize this Header. - - - - - Writes this Header to buffer starting at offset - Keep in mind, this API assumes buffer is large enough - for the operation. - - buffer to serialize this Header to - offset to begin writing at. - - the new offset. - - - - - Returns the current value as a bool - - - - - Sets the current value - - - - - Returns the current value as a byte - - - - - Sets the current value - - - - - Gets the current value as a 16 bit integer. (Host Order). - - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a 32 bit integer. (Host Order) - - - - - Sets the current value - - - - - returns the current value as a 64-bit integer. (Host Order) - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a byte buffer. - - - - - - Sets the current value. Max length is 2^15 - 1 - - - - - Returns the current value as a utf-8 string. - - - - - Sets the current value. Utf-8 encoded. Max byte size is 2^16 - 1 - - - - - Gets the current value as a DateTime. - Note: You do not need to compensate for unix epoch on this API. - - - - - - Sets the current value. - Note: You do not need to compensate for unix epoch on this API. - - - - - Returns the current value as a Guid (UUID) - - - - - Sets the current value - - - - - Header Data for an EventStreamMessage - - Each header is of format: - [name len] (1) | [utf-8 name] (v) - [type (1)] - [value (v)] - - - - - Name for the Header. Maximum of 255 bytes. - - - - - Header type id - - - - - Initializes this Header with name. - - utf-8 string, max length is 255 - - - - Deserializes the header in buffer. - - buffer constaining the header - index to start from in the buffer. - updated offset with new value for offset - - - - Writes this Header to buffer starting at offset - Keep in mind, this API assumes buffer is large enough - for the operation. - - buffer to serialize this Header to - offset to begin writing at. - - the new offset. - - - - - Computes the amount of memory neccesary to serialize this Header. - - - - - Returns the current value as a bool - - - - - Sets the current value - - - - - Returns the current value as a byte - - - - - Sets the current value - - - - - Gets the current value as a 16 bit integer. (Host Order). - - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a 32 bit integer. (Host Order) - - - - - Sets the current value - - - - - returns the current value as a 64-bit integer. (Host Order) - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a byte buffer. - - - - - - Sets the current value. Max length is 2^15 - 1 - - - - - Returns the current value as a utf-8 string. - - - - - Sets the current value. Utf-8 encoded. Max byte size is 2^16 - 1 - - - - - Gets the current value as a DateTime. - Note: You do not need to compensate for unix epoch on this API. - - - - - - Sets the current value. - Note: You do not need to compensate for unix epoch on this API. - - - - - Returns the current value as a Guid (UUID) - - - - - Sets the current value - - - - - Headers for the message. Can be null. - - - - - Payload for the message. Can be null. - - - - - Converts a message into a byte buffer (usually for network transmission). - - - - - Message is a single datagram. The format is as follows: - [ total length (4) ] | [ headers_length (4)] | [ prelude crc(4)] - [ headers (v)] - [ payload (v)} - [ trailing crc ] - - CRCs use the CRC32 algorithm. - - - - - Content type for EventStreams. - - - - - Headers for the message. Can be null. - - - - - Payload for the message. Can be null. - - - - - Initialize a message with headers and a payload. - - list of headers for the message, can be null. - payload for the message, can be null. - - - - Builds a message from buffer. - - buffer to read - offset to start reading - buffer length. - - parsed instance of EventStreamMessage. Doesn't return null, - does throw if CRCs don't match. - - - - - Converts a message into a byte buffer (usually for network transmission). - - - - - Defines exceptions that arise from an not conforming to specification. - - - - - Constructs an EventStreamValidationException. - - - - - Constructs an EventStreamValidationException. - - The exception message. - - - - Constructs an EventStreamValidationException. - - The exception message. - The inner exception. - - - - This exception is thrown if an exception is retrieved from the event stream and should be modeled, - but a generator function for the strongly-typed exception is not defined. - - - - - The exception type. - - - - - Constructs an EventStreamException. - - The exception type. - - - - The contract for the . - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - A subclass of that enables an enumerable interface for interacting with Events. - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - Flag if the stream was chosen to be enumerated. - - - - - A Stream of Events. Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treated as mutually exclusive. - - - - - A Stream of Events. Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treated as mutually exclusive. - - - - - Returns an enumerator that iterates through the collection. - - An enumerator that can be used to iterate through the collection. - - - - Returns an enumerator that iterates through a collection. - - An object that can be used to iterate through the collection. - - - - Starts the background thread to start reading events from the network stream. - - - - - The contract for the . - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - The size of the buffer for reading from the network stream. - - - - - Fires when an event is received. - - - - - Fired when an exception or error is raised. - - - - - Starts the background thread to start reading events from the network stream. - - - - - The superclass for all EventStreams. It contains the common processing logic needed to retreive events from a network Stream. It - also contains the mechanisms needed to have a background loop raise events. - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - "Unique" key for unknown event lookup. - - - - - Header key for message type. - - - - - Header key for event type. - - - - - Header key for exception type. - - - - - Header key for error code. - - - - - Header key for error message. - - - - - Value of when the message is an event. - - - - - Value of when the message is an exception. - - - - - Value of when the message is an error. - - - - - The size of the buffer for reading from the network stream. - Default is 8192. - - - - - The underlying stream to read events from. - - - - - Responsible for decoding events from sequences of bytes. - - - - - Fires when an event is recieved. - - - - - Fired when an exception or error is raised. - - - - - The mapping of event message to a generator function to construct the matching Event Stream event. - - - - - The mapping of event message to a generator function to construct the matching Event Stream exception. - - - - - Whether the Stream is currently being processed. - - - - - A Stream of Events. Events can be retrieved from this stream by attaching handlers to listen events, and then calling StartProcessing. - - - - - A Stream of Events. Events can be retrieved from this stream by attaching handlers to listen events, and then calling StartProcessing. - - - - - Converts an EventStreamMessage to an event. - - The event stream message to be converted. - The event - - - - Abstraction for cross-framework initiation of the background thread. - - - - - The background thread main loop. It will constantly read from the network stream until IsProcessing is false, or an error occurs. - - This stub exists due to FXCop. - - - - - The background thread main loop. It will constantly read from the network stream until IsProcessing is false, or an error occurs. - - Needed for 3.5 support. Not used. - - - - Reads from the stream into the buffer. It then passes the buffer to the decoder, which raises an event for - each message it decodes. - - The buffer to store the read bytes from the stream. - - - - Wraps exceptions in an outer exception so they can be passed to event handlers. If the Exception is already of a compatable type, - the method returns what it was given. - - The exception to wrap. - An exception of type TE - - - - Starts the background thread to start reading events from the network stream. - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Disposes the resources of this stream. - - Should dispose of unmanged resources. - - - - Event Arguments for EventStreamDecoder.MessageReceived. - - - - - Received message. - - - - - Additional object context - - - - - Initialize this with message - - - - - Initialize this with message and object conetext - - - - - Exception thrown when a request is made of the Decoder, but the internal state - machine is an invalid state. This is usually the result of an interanl exception - being thrown during parsing of the network stream. - - - - - Contract for EventStreamDecoder - - - - - Invoked anytime an EventStreamMessage is found. - - - - - Processes data starting at offset up to length. - Invokes MessageRecieved for each message encountered. - If an exception is thrown, this object is not safe for reuse. - - buffer to read - offset in buffer to start reading. - length of data. - - - - Streaming decoder for listening for incoming EventStreamMessage datagrams. - - - - - Invoked anytime an EventStreamMessage is found. - - - - - Object data (optional) that can be passed to the event handler for MessageReceived. - - - - - Default constructor. Initializes internal _state machine. - - - - - Processes data starting at offset up to length. - Invokes MessageRecieved for each message encountered. - If an exception is thrown, this object is not safe for reuse. - - buffer to read - offset in buffer to start reading. - length of data. - - - - Superclass for Exceptions that come over the event stream, or to wrap other kinds of generic exceptions. - - - - - Constructs an EventStreamException. - - - - - Constructs an EventStreamException. - - The exception message. - - - - Constructs an EventStreamException. - - The exception message. - The inner exception. - - - - The contract for EventStream events. - - - - - The contract for EventStream terminal events. - - - - - This Event is returned if an event is retrieved from the event stream, but a generator function - for the event is not defined. This can occur if the SDK is not updated after a new event type is introduced. - - - - - The Message recieved from the event stream before conversion. - - - - - The event type. - - - - - Constructs an UnknownEventStreamEvent. - - - - - Constructs an UnknownEventStreamEvent. - - The Message recieved from the event stream before conversion. - The event type. - - - - Signals that an an has an unknown message type. These exceptions whould be - swallowed to allow future expansion of the EventStream specification without breaking existing clients. - - - - - Constructs an UnknownEventStreamMessageTypeException. - - - - - Interface for a handler in a pipeline. - - - - - The logger used to log messages. - - - - - The inner handler which is called after the current - handler completes it's processing. - - - - - The outer handler which encapsulates the current handler. - - - - - Contains the processing logic for a synchronous request invocation. - This method should call InnerHandler.InvokeSync to continue processing of the - request by the pipeline, unless it's a terminating handler. - - The execution context which contains both the - requests and response context. - - - - Contains the processing logic for an asynchronous request invocation. - This method should call InnerHandler.InvokeSync to continue processing of the - request by the pipeline, unless it's a terminating handler. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - The interface for an exception handler. - - - - - Handles an exception for the given execution context. - - The execution context, it contains the - request and response context. - The exception to handle. - - Returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception to replace the original exception. - - - - - The interface for an exception handler with a generic parameter for the exception type. - - The exception type. - - - - Handles an exception for the given execution context. - - The execution context, it contains the - request and response context. - The exception to handle. - - Returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception to replace the original exception. - - - - - The interface for a HTTP request factory. - - The type used by the underlying HTTP API to represent the request body. - - - - Creates an HTTP request for the given URI. - - The request URI. - An HTTP request. - - - - The interface for an HTTP request that is agnostic of the underlying HTTP API. - - The type used by the underlying HTTP API to represent the HTTP request content. - - - - The HTTP method or verb. - - - - - The request URI. - - - - - Configures a request as per the request context. - - The request context. - - - - Sets the headers on the request. - - A dictionary of header names and values. - - - - Gets a handle to the request content. - - The request content. - - - - Returns the HTTP response. - - The HTTP response. - - - - Writes a stream to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - The request context. - - - - Writes a byte array to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - - - - Sets up the progress listeners - - The content stream - The interval at which progress needs to be published - The objects which is trigerring the progress changes - The callback which will be invoked when the progress changed event is trigerred - an object, incase the progress is setup, else returns the original stream - - - - Aborts the HTTP request. - - - - - Gets a handle to the request content. - - - - - - Returns the HTTP response. - - A cancellation token that can be used to cancel the asynchronous operation. - - - - - A factory which creates HTTP clients. - - - - - Create and configure an HttpClient. - - - - - - A factory which creates HTTP requests which uses System.Net.Http.HttpClient. - - - - - The constructor for HttpRequestMessageFactory. - - Configuration setting for a client. - - - - Creates an HTTP request for the given URI. - - The request URI. - An HTTP request. - - - - Disposes the HttpRequestMessageFactory. - - - - - Dispose the factory - - - - - - Create and configure a managed HttpClient instance. - The use of HttpClientHandler in the constructor for HttpClient implicitly creates a managed HttpClient. - If a native HttpClient is required the SDK user must implement IHttpClientFactory and provide an - instance via IClientConfig.HttpClientFactory (only available in PCL). - - - - - - - A cache of HttpClient objects. The GetNextClient method does a round robin cycle through the clients - to distribute the load even across. - - - - - Constructs a container for a cache of HttpClient objects - - The HttpClient to cache - - - - Returns the next HttpClient using a round robin rotation. It is expected that individual clients will be used - by more then one Thread. - - - - - - Disposes the HttpClientCache. - - - - - Dispose the HttpClientCache - - - - - - HTTP request wrapper for System.Net.Http.HttpRequestMessage. - - - - - Set of content header names. - - - - - The constructor for HttpWebRequestMessage. - - The HttpClient used to make the request. - The request URI. - The service client config. - - - - The underlying HttpClient - - - - - The underlying HTTP web request. - - - - - The HTTP method or verb. - - - - - The request URI. - - - - - Configures a request as per the request context. - - The request context. - - - - Sets the headers on the request. - - A dictionary of header names and values. - - - - Gets a handle to the request content. - - The request content. - - - - Returns the HTTP response. - - The HTTP response. - - - - Aborts the HTTP request. - - - - - Returns the HTTP response. - - A cancellation token that can be used to cancel the asynchronous operation. - - - - - Writes a stream to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - The request context. - - - - Writes a byte array to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - - - - Gets a handle to the request content. - - - - - - Disposes the HttpWebRequestMessage. - - - - - - - - - - - Sets up the progress listeners - - The content stream - The interval at which progress needs to be published - The objects which is trigerring the progress changes - The callback which will be invoked when the progress changed event is trigerred - an object, incase the progress is setup, else returns the original stream - - - - A retry policy specifies all aspects of retry behavior. This includes conditions when the request should be retried, - checks of retry limit, preparing the request before retry and introducing delay (backoff) before retries. - - - A retry policy specifies all aspects of retry behavior. This includes conditions when the request should be retried, - checks of retry limit, preparing the request before retry and introducing delay (backoff) before retries. - - - - - Maximum number of retries to be performed. - This does not count the initial request. - - - - - The logger used to log messages. - - - - - The standard set of throttling error codes - - - - - The standard set of timeout error codes to retry on. - - - - - List of AWS specific error codes which are returned as part of the error response. - These error codes will be retried. - - - - - The standard set of transient error, HTTP status codes to retry on. - 502 and 504 are returned by proxies. These can also be returned for - S3 accelerate requests which are served by CloudFront. - - - - - Set of web exception status codes to retry on. - - - - - This parameter serves as the value to the CapacityManager.Container datastructure. - Its properties include the available capacity left for making a retry request and the maximum - capacity size. - - - - - Checks if a retry should be performed with the given execution context and exception. - - The execution context which contains both the - requests and response context. - The exception thrown after issuing the request. - Returns true if the request should be retried, else false. The exception is retried if it matches with clockskew error codes. - - - - Returns true if the request is in a state where it can be retried, else false. - - The execution context which contains both the - requests and response context. - Returns true if the request is in a state where it can be retried, else false. - - - - Return true if the request should be retried for the given exception. - - The execution context which contains both the - requests and response context. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Checks if the retry limit is reached. - - The execution context which contains both the - requests and response context. - Return false if the request can be retried, based on number of retries. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called on a successful request response. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called before a retry request is initiated. The value - returned is True by default(retry throttling feature is disabled). - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called before a retry request is initiated. The value - returned is True by default(retry throttling feature is disabled). - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - - - - Virtual method that gets called before a retry request is initiated. The value - returned is True by default(retry throttling feature is disabled). - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - true if the error that will be retried is a throttling error - - - - This method uses a token bucket to enforce the maximum sending rate. - - The execution context which contains both the - requests and response context. - If the prior request failed, this exception is expected to be - the exception that occurred during the prior request failure. - - - - Determines if an AmazonServiceException is a throttling error - - The current exception to check. - true if it is a throttling error else false. - - - - Determines if an AmazonServiceException is a transient error that - should be retried. - - The current execution context - The current exception to check. - true if the exception is a transient error else false. - - - - Determines if the exception is a known timeout error code that - should be retried under the timeout error category. - - The current exception to check. - true if the exception is considered a timeout else false - - - - Checks if a retry should be performed with the given execution context and exception. - - The execution context which contains both the - requests and response context. - The exception throw after issuing the request. - Returns true if the request should be retried, else false. The exception is retried if it matches with clockskew error codes. - - - - This method uses a token bucket to enforce the maximum sending rate. - - The execution context which contains both the - requests and response context. - If the prior request failed, this exception is expected to be - the exception that occurred during the prior request failure. - - - - Return true if the request should be retried for the given exception. - - The execution context which contains both the - requests and response context. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - ICoreAmazonKMS is not meant to be used directly. It defines Key Management Service - with basic .NET types and allows other services to be able to use the service as - a runtime dependency. This interface is implemented by the AmazonKeyManagementServiceClient - defined in the AWSSDK.KeyManagementService assembly. - - - - - The result of the GenerateDataKey and GenerateDataKeyAsync operations. - - - - - The plaintext for the data key. - - - - - The ciphertext for the data key. - - - - - ICoreAmazonS3 is not meant to use directly. It defines S3 with basic .NET types - and allows other services to be able to use S3 as a runtime dependency. This interface - is implemented by the AmazonS3Client defined in the S3 assembly. - - - ICoreAmazonS3 is not meant to use directly. It defines S3 with basic .NET types - and allows other services to be able to use S3 as a runtime dependency. This interface - is implemented by the AmazonS3Client defined in the S3 assembly. - - - - - Generate a presigned URL. - - - - - - - - - - Get all the object keys for the particular bucket and key prefix. - - - - - - - - - Upload an object from a stream. - - - - - - - - - - - Delete an object. - - - - - - - - - - Delete an object. - - - - - - - - - - Open a stream to an object in S3. - - - - - - - - - - Upload an object from a file path. - - - - - - - - - - - Download an object in S3 to a file path. - - - - - - - - - - - Set the ACL on the object to public readable. - - - - - - - - Check to see if the bucket exists and if it doesn't create the bucket. - - - - - - Check to see if the bucket exists. - - - - - - - ICoreAmazonSQS is not meant to use directly. It defines SQS with basic .NET types - and allows other services to be able to use SQS as a runtime dependency. This interface - is implemented by the AmazonSQSClient defined in the SQS assembly. - - - - - Get the attributes for the queue identified by the queue URL asynchronously. - - The queue URL to get attributes for. - A Task containing the result of a dictionary of attributes for the queue. - - - - Set the attributes on the queue identified by the queue URL asynchronously. - - The queue URL to set the attributues. - The attributes to set. - A Task - - - - ICoreAmazonSTS is not meant to be used directly. It defines Security Token - service with basic .NET types and allows other services to be able to use the service as - a runtime dependency. This interface is implemented by the AmazonSecurityTokenServiceClient - defined in the AWSSDK.SecurityToken assembly. - - - - - - This method is used internally to access the Amazon Security Token - service within other service assemblies. - Please use AmazonSecurityTokenServiceClient to access the Amazon Security Token - service instead. - - Use Amazon Security Token Service to assume a role. - - Proxy settings that are required for the HTTPS and STS calls made during the authentication/credential - generation process are supported and should have been configured on the STS ClientConfig instance - associated with the STS client instance exposing this interface. - - - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRole. - - - - - CoreAmazonKMS is not meant to use directly. It implements ICoreAmazonKMS - and allows other service clients to be able to use the KMS service as a runtime dependency. - - This class waits until a method is actually called on the ICoreAmazonKMS interface - before requiring the KMS assembly to be present and loaded. - - - - - Settings for configuring a proxy for the SDK to use. - - - - - The host name or IP address of the proxy server. - - - - - The port number of the proxy. - - - - - The username to authenticate with the proxy server. - - - - - The password to authenticate with the proxy server. - - - - - Collection of one or more regular expressions denoting addresses - for which the proxy will not be used. - - - For more information on bypass lists - see https://msdn.microsoft.com/en-us/library/system.net.webproxy.bypasslist%28v=vs.110%29.aspx. - - - - - If true requests to local addresses bypass the configured - proxy. - - - - - Settings for logging in the SDK. - - - - - Logging destination. - - - - - When to log responses. - - - - - Gets or sets the size limit in bytes for logged responses. - If logging for response body is enabled, logged response - body is limited to this size. The default limit is 1KB. - - - - - Whether or not to log SDK metrics. - - - - - A custom formatter added through Configuration - - - - - This class can be used to discover the public address ranges for AWS. The - information is retrieved from the publicly accessible - https://ip-ranges.amazonaws.com/ip-ranges.json file. - - - The information in this file is generated from our internal system-of-record and - is authoritative. You can expect it to change several times per week and should - poll accordingly. - - - - - Region identifier string for ROUTE53 and CLOUDFRONT ranges - - - - - Collection of service keys found in the data file. - - - - - The publication date and time of the file that was downloaded and parsed. - - - - - Collection of all public IP ranges. - - - - - Filtered collection of public IP ranges for the given service key - - - - - Filtered collection of public IP ranges for the given region (us-east-1 etc) or GLOBAL. - - - - - Filtered collection of public IP ranges for the given network border group. - - - - - Downloads the most recent copy of the endpoint address file and - parses it to a collection of address range objects. - - - - - Downloads the most recent copy of the endpoint address file and - parses it to a collection of address range objects. - - - - - Represents the IP address range for a single region and service key. - - - - - The public IPv4 or Ipv6 address range, in CIDR notation. - - - - - Indicates ipv4 or v6 format of the address - - - - - The AWS region or GLOBAL for edge locations. Note that the CLOUDFRONT and ROUTE53 - ranges are GLOBAL. - - - - - The subset of IP address ranges. Specify AMAZON to get all IP address ranges - (for example, the ranges in the EC2 subset are also in the AMAZON subset). Note - that some IP address ranges are only in the AMAZON subset. - - - Valid values for the service key include "AMAZON", "EC2", "ROUTE53", - "ROUTE53_HEALTHCHECKS", and "CLOUDFRONT." If you need to know all of - the ranges and don't care about the service, use the "AMAZON" entries. - The other entries are subsets of this one. Also, some of the services, - such as S3, are represented in "AMAZON" and do not have an entry that - is specific to the service. We plan to add additional values over time; - code accordingly! - - - - - The network border group the IP address range belongs to. - - - AWS Local Zones allow you to seamlessly connect to the full range of services in the AWS Region such - as Amazon Simple Storage Service and Amazon DynamoDB through the same APIs and tool sets. You can extend - your VPC Region by creating a new subnet that has a Local Zone assignment. When you create a subnet in - a Local Zone, the VPC is also extended to that Local Zone. - - A network border group is a unique set of Availability Zones or Local Zones from where AWS advertises - public IP addresses. - - When you create a VPC that has IPv6 addresses, you can choose to assign a set of Amazon-provided public - IP addresses to the VPC and also set a network border group for the addresses that limits the addresses - to the group. When you set a network border group, the IP addresses cannot move between network - border groups. The us-west-2 network border group contains the four US West (Oregon) Availability Zones. - The us-west-2-lax-1 network border group contains the Los Angeles Local Zones. - - - - - This class defines utilities and constants that can be used by - all the client libraries of the SDK. - - - - - The user agent string header - - - - - The Set of accepted and valid Url characters per RFC3986. - Characters outside of this set will be encoded. - - - - - The Set of accepted and valid Url characters per RFC1738. - Characters outside of this set will be encoded. - - - - - The set of accepted and valid Url path characters per RFC3986. - - - - - The string representing Url Encoded Content in HTTP requests - - - - - The GMT Date Format string. Used when parsing date objects - - - - - The ISO8601Date Format string. Used when parsing date objects - - - - - The ISO8601Date Format string. Used when parsing date objects - - - - - The ISO8601 Basic date/time format string. Used when parsing date objects - - - - - The ISO8601 basic date format. Used during AWS4 signature computation. - - - - - The RFC822Date Format string. Used when parsing date objects - - - - - Returns an extension of a path. - This has the same behavior as System.IO.Path.GetExtension, but does not - check the path for invalid characters. - - - - - - Convert request parameters to Url encoded query string - - - Convert Dictionary of parameters to Url encoded query string - - - - Returns the canonicalized resource path for the service endpoint with single URL encoded path segments. - - Endpoint URL for the request - Resource path for the request - - If resourcePath begins or ends with slash, the resulting canonicalized - path will follow suit. - - Canonicalized resource path for the endpoint - - - - Returns the canonicalized resource path for the service endpoint - - Endpoint URL for the request - Resource path for the request - If true pre URL encode path segments if necessary. - S3 is currently the only service that does not expect pre URL encoded segments. - - If resourcePath begins or ends with slash, the resulting canonicalized - path will follow suit. - - Canonicalized resource path for the endpoint - - - - Returns the canonicalized resource path for the service endpoint - - Endpoint URL for the request - Resource path for the request - If true pre URL encode path segments if necessary. - S3 is currently the only service that does not expect pre URL encoded segments. - Dictionary of key/value parameters containing the values for the ResourcePath key replacements - The version of the marshaller that constructed the request object. - - If resourcePath begins or ends with slash, the resulting canonicalized - path will follow suit. - - Canonicalized resource path for the endpoint - - - - Splits the resourcePath at / into segments then resolves any keys with the path resource values. Greedy - key values will be split into multiple segments at each /. - - The patterned resourcePath - The key/value lookup for the patterned resourcePath - A list of path segments where all keys in the resourcePath have been resolved to one or more path segment values - - - - Joins all path segments with the / character and encodes each segment before joining. - - The segments of a URL path split at each / character - If the path property is specified, - the accepted path characters {/+:} are not encoded. - A joined URL with encoded segments - - - - Takes a patterned resource path and resolves it using the key/value path resources into - a segmented encoded URL. - - The patterned resourcePath - The key/value lookup for the patterned resourcePath - A segmented encoded URL - - - - Returns a new string created by joining each of the strings in the - specified list together, with a comma between them. - - The list of strings to join into a single, comma delimited - string list. - A new string created by joining each of the strings in the - specified list together, with a comma between strings. - - - - Attempt to infer the region for a service request based on the endpoint - - Endpoint to the service to be called - - Region parsed from the endpoint; DefaultRegion (or DefaultGovRegion) - if it cannot be determined/is not explicit - - - - - Attempt to infer the service name for a request (in short form, eg 'iam') from the - service endpoint. - - Endpoint to the service to be called - - Short-form name of the service parsed from the endpoint; empty string if it cannot - be determined - - - - - Utility method for converting Unix epoch seconds to DateTime structure. - - The number of seconds since January 1, 1970. - Converted DateTime structure - - - - Helper function to format a byte array into string - - The data blob to process - If true, returns hex digits in lower case form - String version of the data - - - - Calls a specific EventHandler in a background thread - - - - - - - - Parses a query string of a URL and returns the parameters as a string-to-string dictionary. - - - - - - - Utility method for converting a string to a MemoryStream. - - - - - - - Utility method for copy the contents of the source stream to the destination stream. - - - - - - - Utility method for copy the contents of the source stream to the destination stream. - - - - - - - - Formats the current date as a GMT timestamp - - A GMT formatted string representation - of the current date and time - - - - - Formats the current date as ISO 8601 timestamp - - An ISO 8601 formatted string representation - of the current date and time - - - - - Gets the ISO8601 formatted timestamp that is minutesFromNow - in the future. - - The number of minutes from the current instant - for which the timestamp is needed. - The ISO8601 formatted future timestamp. - - - - Formats the current date as ISO 8601 timestamp - - An ISO 8601 formatted string representation - of the current date and time - - - - - Gets the RFC822 formatted timestamp that is minutesFromNow - in the future. - - The number of minutes from the current instant - for which the timestamp is needed. - The ISO8601 formatted future timestamp. - - - - Determines whether the given string is an absolute path to a root. - - The hypothetical absolute path. - True if is an absolute path. - - - - Returns true if the path specified is relative to the current drive or working directory. - Returns false if the path is fixed to a specific drive or UNC path. This method does no - validation of the path (URIs will be returned as relative as a result). - - - Handles paths that use the alternate directory separator. It is a frequent mistake to - assume that rooted paths (Path.IsPathRooted) are not relative. This isn't the case. - "C:a" is drive relative- meaning that it will be resolved against the current directory - for C: (rooted, but relative). "C:\a" is rooted and not relative (the current directory - will not be used to modify the path). - - - - - True if the given character is a directory separator. - - - - - Returns true if the given character is a valid drive letter - - - - - URL encodes a string per RFC3986. If the path property is specified, - the accepted path characters {/+:} are not encoded. - - The string to encode - Whether the string is a URL path or not - The encoded string - - - - URL encodes a string per the specified RFC. If the path property is specified, - the accepted path characters {/+:} are not encoded. - - RFC number determing safe characters - The string to encode - Whether the string is a URL path or not - The encoded string - - Currently recognised RFC versions are 1738 (Dec '94) and 3986 (Jan '05). - If the specified RFC is not recognised, 3986 is used by default. - - - - - URL encodes a string per the specified RFC with the exception of preserving the encoding of previously encoded slashes. - If the path property is specified, the accepted path characters {/+:} are not encoded. - - The string to encode - Whether the string is a URL path or not - The encoded string with any previously encoded %2F preserved - - - - Convert bytes to a hex string - - Bytes to convert. - Hexadecimal string representing the byte array. - - - - Convert a hex string to bytes - - Hexadecimal string - Byte array corresponding to the hex string. - - - - Returns DateTime.UtcNow + ManualClockCorrection when - is set. - This value should be used instead of DateTime.UtcNow to factor in manual clock correction - - - - - Returns true if the string has any bidirectional control characters. - - - - - - - Executes an HTTP request and returns the response as a string. This method - throws WebException and HttpRequestException. In the event HttpRequestException - is thrown the StatusCode is sent as user defined data on the exception under - the key "StatusCode". - - The URI to make the request to - The request type: GET, PUT, POST - null or the content to send with the request - Timeout for the request - Proxy for the request - null or any headers to send with the request - The response as a string. - - - - Utility method that accepts a string and replaces white spaces with a space. - - - - - - - Class that contains result of executing an external process through the SDKs - AWSSDKUtils.RunProcess/AWSSDKUtils.RunProcessAsync - - - - - The exit code with which the process exited - - - - - The output of the process read till the end - - - - - The error output of the process read till the end - - - - - Object to track circular references in nested types. - At each level of nesting, make a call to Track to retrieve Tracker, - a tracking object implementing the IDisposable interface. - Dispose of this tracker when leaving the context of the tracked object. - - - - - Tracker. Must be disposed. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Adds the current target to a reference list and returns a tracker. - The tracker removes the target from the reference list when the - tracker is disposed. - - - - - - - Root AWS config - - - - - AwsHttpClient is a wrapper around HttpClient class of the System.Net.Http library. - The wrapper has been added so as to remove System.Net.Http dependencies from the Services - and migrate it to a Core level dependecy only. This avoids version clashes when a service - and the Core depends on different versions of the System.Net.Http library. This is a Service - level utility method - - - - - AWSHttpClient wrapper that is wrapped around - HttpClient default wrapper. - - - - - AWSHttpClient BaseAddress property that is wrapper for - HttpClient BaseAddress property. - - - - - AWSHttpClient Timeout property that is wrapper for - HttpClient Timeout property. - - - - - AWSHttpClient MaxResponseContentBufferSize property that is wrapper for - HttpClient MaxResponseContentBufferSize property. - - - - - AWSHttpClient GetStreamAsync that accepts the requester's URI - and make a HttpClient.GetStreamAsync call. - - Requester Uri - - - - Wrapper method that accepts a request uri, stream content and headers and makes a sendAsync call. - - - - - - - Wrapper for HttpClient's HttpRequestMessage and SendAsync methods. - - - - Returns response headers information- header name,value and status code - - - - Wrapper for HttpClient Dispose. - - - - - Method that checks if the passed exception is of type - HttpRequestException - - - - - - - AWSStreamContent is a wrapper for StreamContent class in - the System.Net.Http library.The wrapper has been added so as to - remove System.Net.Http dependencies from the Services - and migrate it to a Core level dependecy only. This avoids version clashes when a service - and the Core depends on different versions of the System.Net.Http library. This is a Service - level utility method - - - - - Wrapper for StreamContent constructor - for stream content - - - - - - Wrapper for StreamContent constructor - for stream content and bufferSize - - - - - - - Wrapper to allow Services to remove StreamContent Headers - - - - - - - Wrapper to allow Services to add StreamContent Headers - - - - - - - Wrapper for StreamContent Dispose. - - - - - Allows to configure the proxy used for HTTP requests. The default value is null. - - - - - This class contains the endpoints available to the AWS clients. The static constants representing the - regions can be used while constructing the AWS client instead of looking up the exact endpoint URL. - - - - - Gets the endpoint for a service in a region. - - The services system name. - If true returns the endpoint for dualstack - Thrown when the request service does not have a valid endpoint in the region. - - - - - Enumerate through all the regions. - - - - - Gets the region based on its system name like "us-west-1" - - The system name of the service like "us-west-1" - - - - - This is a testing method and should not be called by production applications. - - - - - Gets the system name of a region. - - - - - Gets the display name of a region. - - - - - This region name is non-standard. Search the whole endpoints.json file to - determine the partition this region is in. - - - - - This class contains region information used to lazily compute the service endpoints. The static constants representing the - regions can be used while constructing the AWS client instead of looking up the exact endpoint URL. - - - - - The US East (Virginia) endpoint. - - - - - The US East (Virginia) regional endpoint. - - - - - The US East (Ohio) endpoint. - - - - - The US West (N. California) endpoint. - - - - - The US West (Oregon) endpoint. - - - - - The EU North (Stockholm) endpoint. - - - - - The EU West (Ireland) endpoint. - - - - - The EU West (London) endpoint. - - - - - The EU West (Paris) endpoint. - - - - - The EU Central (Frankfurt) endpoint. - - - - - The Europe (Milan) endpoint. - - - - - The Asia Pacific (Hong Kong) endpoint. - - - - - The Asia Pacific (Tokyo) endpoint. - - - - - The Asia Pacific (Seoul) endpoint. - - - - - The Asia Pacific (Osaka-Local) endpoint. - - - - - The Asia Pacific (Mumbai) endpoint. - - - - - The Asia Pacific (Singapore) endpoint. - - - - - The Asia Pacific (Sydney) endpoint. - - - - - The South America (Sao Paulo) endpoint. - - - - - The US GovCloud East (Virginia) endpoint. - - - - - The US GovCloud West (Oregon) endpoint. - - - - - The China (Beijing) endpoint. - - - - - The China (Ningxia) endpoint. - - - - - The Canada (Central) endpoint. - - - - - The Middle East (Bahrain) endpoint. - - - - - The Africa (Cape Town) endpoint. - - - - - Represents the endpoint overridding rules in the endpoints.json - Is used to map private region (ie us-east-1-regional) to public regions (us-east-1) - For signing purposes. - - - - - Enumerate through all the regions. - - - - - Gets the region based on its system name like "us-west-1" - - The system name of the service like "us-west-1" - - - - - Gets the region endpoint override if exists - - The region endpoint to find the possible override for - - - - - Gets the system name of a region. - - - - - Gets the display name of a region. - - - - - Gets the partition name the region is in. For example for us-east-1 the partition name is aws. For cn-northwest-1 the partition name is aws-cn. - - - - - Gets the dns suffix for the region endpoints in a partition. For example the aws partition's suffix is amazonaws.com. The aws-cn partition's suffix is amazonaws.com.cn. - - - - - Gets the endpoint for a service in a region. - - - The services system name. Service system names can be obtained from the - RegionEndpointServiceName member of the ClientConfig-derived class for the service. - - - For forwards compatibility, if the service being requested for isn't known in the region, this method - will generate an endpoint using the AWS endpoint heuristics. In this case, it is not guaranteed the - endpoint will point to a valid service endpoint. - - - - - - Gets the endpoint for a service in a region, optionally selecting a dualstack compatible endpoint. - - - The services system name. Service system names can be obtained from the - RegionEndpointServiceName member of the ClientConfig-derived class for the service. - - - If true a dualstack endpoint is returned. It is the user's responsibility to verify that the given service - supports a dualstack endpoint for the region. - - - For forwards compatibility, if the service being requested for isn't known in the region, this method - will generate an endpoint using the AWS endpoint heuristics. In this case, it is not guaranteed the - endpoint will point to a valid service endpoint. - - - - - - This class defines an endpoints hostname and which protocols it supports. - - - - - Gets the hostname for the service. - - - - - The authentication region to be used in request signing. - - - - - This property is only set for S3 endpoints. For all other services this property returns null. - For S3 endpoints, if the endpoint supports signature version 2 this property will be "2", otherwise it will be "4". - - - - - Calculates a 32bit Cyclic Redundancy Checksum (CRC) using the - same polynomial used by Zip. This type is used internally by DotNetZip; it is generally not used directly - by applications wishing to create, read, or manipulate zip archive files. - - - - - indicates the total number of bytes read on the CRC stream. - This is used when writing the ZipDirEntry when compressing files. - - - - - Indicates the current CRC for all blocks slurped in. - - - - - Returns the CRC32 for the specified stream. - - The stream over which to calculate the CRC32 - the CRC32 calculation - - - - Returns the CRC32 for the specified stream, and writes the input into the output stream. - - The stream over which to calculate the CRC32 - The stream into which to deflate the input - the CRC32 calculation - - - - Get the CRC32 for the given (word,byte) combo. - This is a computation defined by PKzip. - - The word to start with. - The byte to combine it with. - The CRC-ized result. - - - - Update the value for the running CRC32 using the given block of bytes. - This is useful when using the CRC32() class in a Stream. - - block of bytes to slurp - starting point in the block - how many bytes within the block to slurp - - - - A Stream that calculates a CRC32 (a checksum) on all bytes read, - or on all bytes written. - - - - - This class can be used to verify the CRC of a ZipEntry when reading from a stream, - or to calculate a CRC when writing to a stream. The stream should be used to either - read, or write, but not both. If you intermix reads and writes, the results are - not defined. - - This class is intended primarily for use internally by the DotNetZip library. - - - - - Gets the total number of bytes run through the CRC32 calculator. - - - - This is either the total number of bytes read, or the total number - of bytes written, depending on the direction of this stream. - - - - - The constructor. - - The underlying stream - - - - The constructor. - - The underlying stream - The length of the stream to slurp - - - - Provides the current CRC for all blocks slurped in. - - - - - Read from the stream - - the buffer to read - the offset at which to start - the number of bytes to read - the number of bytes actually read - - - - Write to the stream. - - the buffer from which to write - the offset at which to start writing - the number of bytes to write - - - - Indicates whether the stream supports reading. - - - - - Indicates whether the stream supports seeking. - - - - - Indicates whether the stream supports writing. - - - - - Flush the stream. - - - - - Not implemented. - - - - - Not implemented. - - - - - Not implemented. - - N/A - N/A - N/A - - - - Not implemented. - - N/A - - - diff --git a/packages/AWSSDK.Core.3.3.107.14/lib/wpa81/AWSSDK.Core.dll b/packages/AWSSDK.Core.3.3.107.14/lib/wpa81/AWSSDK.Core.dll deleted file mode 100644 index e3bf0c4..0000000 Binary files a/packages/AWSSDK.Core.3.3.107.14/lib/wpa81/AWSSDK.Core.dll and /dev/null differ diff --git a/packages/AWSSDK.Core.3.3.107.14/tools/account-management.ps1 b/packages/AWSSDK.Core.3.3.107.14/tools/account-management.ps1 deleted file mode 100644 index d74de22..0000000 --- a/packages/AWSSDK.Core.3.3.107.14/tools/account-management.ps1 +++ /dev/null @@ -1,64 +0,0 @@ - -function RegisterProfile() -{ - $dllpath = "..\lib\net35\AWSSDK.Core.dll" - $sdkassembly = [System.Reflection.Assembly]::LoadFrom($dllpath) - - $completed = $FALSE - do - { - Write-Host "1) Add/Update new profile credentials" - Write-Host "2) List registered profiles" - Write-Host "3) Remove profile credentials" - Write-Host "4) Exit" - - Write-Host "" - $choose = Read-Host "Choose an option" - - If ($choose -eq "1") - { - $profileName = Read-Host "Profile name: " - $accessKey = Read-Host "Access key: " - $secretKey = Read-Host "Secret key: " - [Amazon.Util.ProfileManager]::RegisterProfile($profileName, $accessKey, $secretKey) - } - ElseIf($choose -eq "2") - { - Write-Host "" - - $profiles = [Amazon.Util.ProfileManager]::ListProfileNames() | sort - foreach($profile in $profiles) - { - Write-Host "*" $profile - } - Write-Host "" - } - ElseIf($choose -eq "3") - { - Write-Host "" - - $i = 1 - $profiles = [Amazon.Util.ProfileManager]::ListProfileNames() | sort - foreach($profile in $profiles) - { - Write-Host $i")" $profile - $i++ - } - Write-Host "" - $pick = Read-Host "Select a profile to unregister" - [Amazon.Util.ProfileManager]::UnregisterProfile($profiles[$pick - 1]) - } - ElseIf($choose -eq "4") - { - $completed = $TRUE - } - Else - { - Write-Host "" - Write-Host "Unknown choose" - Write-Host "" - } - }while($completed -ne $TRUE) -} - -RegisterProfile \ No newline at end of file diff --git a/packages/AWSSDK.Core.3.5.0-beta/.signature.p7s b/packages/AWSSDK.Core.3.5.0-beta/.signature.p7s deleted file mode 100644 index 27bf190..0000000 Binary files a/packages/AWSSDK.Core.3.5.0-beta/.signature.p7s and /dev/null differ diff --git a/packages/AWSSDK.Core.3.5.0-beta/AWSSDK.Core.3.5.0-beta.nupkg b/packages/AWSSDK.Core.3.5.0-beta/AWSSDK.Core.3.5.0-beta.nupkg deleted file mode 100644 index e97d5ed..0000000 Binary files a/packages/AWSSDK.Core.3.5.0-beta/AWSSDK.Core.3.5.0-beta.nupkg and /dev/null differ diff --git a/packages/AWSSDK.Core.3.5.0-beta/lib/net35/AWSSDK.Core.dll b/packages/AWSSDK.Core.3.5.0-beta/lib/net35/AWSSDK.Core.dll deleted file mode 100644 index 61ad9a0..0000000 Binary files a/packages/AWSSDK.Core.3.5.0-beta/lib/net35/AWSSDK.Core.dll and /dev/null differ diff --git a/packages/AWSSDK.Core.3.5.0-beta/lib/net35/AWSSDK.Core.xml b/packages/AWSSDK.Core.3.5.0-beta/lib/net35/AWSSDK.Core.xml deleted file mode 100644 index ca41918..0000000 --- a/packages/AWSSDK.Core.3.5.0-beta/lib/net35/AWSSDK.Core.xml +++ /dev/null @@ -1,14203 +0,0 @@ - - - - AWSSDK.Core - - - - - An access control policy action identifies a specific action in a service - that can be performed on a resource. For example, sending a message to a - queue. - - ActionIdentifiers allow you to limit what your access control policy statement affects. - For example, you could create a policy statement that enables a certain group - of users to send messages to your queue, but not allow them to perform any - other actions on your queue. - - - The action is B in the statement - "A has permission to do B to C where D applies." - - Free form access control policy actions may include a wildcard (*) to match - multiple actions. - - - Constants for known actions can be found in the Amazon.Auth.AccessControlPolicy.ActionIdentifiers namespace. - - - - - - Constructs an Actionidentifer with the given action name. - - The name of the action - - - - Gets and sets the name of this action. For example, 'sqs:SendMessage' is the - name corresponding to the SQS action that enables users to send a message - to an SQS queue. - - - - - The available AWS access control policy actions for Amazon AppStream. - - - - - - The available AWS access control policy actions for Auto Scaling. - - - - - - The available AWS access control policy actions for AWS Billing. - - - - - - The available AWS access control policy actions for AWS CloudFormation. - - - - - - The available AWS access control policy actions for Amazon CloudFront. - - - - - - The available AWS access control policy actions for Amazon CloudSearch. - - - - - - The available AWS access control policy actions for AWS CloudTrail. - - - - - - The available AWS access control policy actions for Amazon CloudWatch. - - - - - - The available AWS access control policy actions for Amazon CloudWatch Logs. - - - - - - The available AWS access control policy actions for Amazon Cognito Identity. - - - - - - The available AWS access control policy actions for Amazon Cognito Sync. - - - - - - The available AWS access control policy actions for AWS Direct Connect. - - - - - - The available AWS access control policy actions for Amazon DynamoDB. - - - - - - The available AWS access control policy actions for Amazon EC2. - - - - - - The available AWS access control policy actions for AWS ElastiCache. - - - - - - The available AWS access control policy actions for AWS Elastic Beanstalk. - - - - - - The available AWS access control policy actions for Elastic Load Balancing. - - - - - - The available AWS access control policy actions for Amazon Elastic MapReduce. - - - - - - The available AWS access control policy actions for Amazon Elastic Transcoder. - - - - - - The available AWS access control policy actions for Amazon Glacier. - - - - - - The available AWS access control policy actions for AWS Identity and Access Management. - - - - - - The available AWS access control policy actions for AWS Import Export. - - - - - - The available AWS access control policy actions for Amazon Kinesis. - - - - - - The available AWS access control policy actions for AWS Marketplace. - - - - - - The available AWS access control policy actions for AWS Marketplace Management Portal. - - - - - - The available AWS access control policy actions for Amazon Mobile Analytics. - - - - - - The available AWS access control policy actions for AWS OpsWorks. - - - - - - The available AWS access control policy actions for Amazon RDS. - - - - - - The available AWS access control policy actions for Amazon Redshift. - - - - - - The available AWS access control policy actions for Amazon Route 53. - - - - - - The available AWS access control policy actions for Amazon S3. - - - - - - The available AWS access control policy actions for AWS Security Token Service. - - - - - - The available AWS access control policy actions for Amazon SES. - - - - - - The available AWS access control policy actions for Amazon SimpleDB. - - - - - - The available AWS access control policy actions for Amazon Simple Workflow Service. - - - - - - The available AWS access control policy actions for Amazon SNS. - - - - - - The available AWS access control policy actions for Amazon SQS. - - - - - - The available AWS access control policy actions for Amazon Storage Gateway. - - - - - - The available AWS access control policy actions for AWS Whispersync. - - - - - - The available AWS access control policy actions for Amazon Zocalo. - - - - - - AWS access control policy conditions are contained in - objects, and affect when a statement is applied. For example, a statement - that allows access to an Amazon SQS queue could use a condition to only apply - the effect of that statement for requests that are made before a certain - date, or that originate from a range of IP addresses. - - Multiple conditions can be included in a single statement, and all conditions - must evaluate to true in order for the statement to take effect. - - - The set of conditions is D in the statement - "A has permission to do B to C where D applies." - - - A condition is composed of three parts: - - - Condition Key - The condition key declares which value of a - request to pull in and compare against when a policy is evaluated by AWS. For - example, using will cause - AWS to pull in the current request's source IP as the first value to compare - against every time your policy is evaluated. - - - - Comparison Type - This is a static value used as the second value - in the comparison when your policy is evaluated. Depending on the comparison - type, this value can optionally use wildcards. See the documentation for - individual comparison types for more information. - - - - Comparison Value - This is a static value used as the second value - in the comparison when your policy is evaluated. Depending on the comparison - type, this value can optionally use wildcards. See the documentation for - individual comparison types for more information. - - - - - - - - - Gets the type of this condition. - - - - - Gets and Sets the name of the condition key involved in this condition. - Condition keys are predefined values supported by AWS that provide input - to a condition's evaluation, such as the current time, or the IP address - of the incoming request. - - Your policy is evaluated for each incoming request, and condition keys - specify what information to pull out of those incoming requests and plug - into the conditions in your policy. - - - - - - Gets and Sets the values specified for this access control policy condition. - For example, in a condition that compares the incoming IP address of a - request to a specified range of IP addresses, the range of IP addresses - is the single value in the condition. - - Most conditions accept only one value, but multiple values are possible. - - - - - - A factory for creating conditions to be used in the policy. - - - - - Condition key for the current time. - - This condition key should only be used with enum. - - - - - - Condition key for whether or not an incoming request is using a secure - transport to make the request (i.e. HTTPS instead of HTTP). - - This condition key should only be used with the boolean overload of NewCondition. - - - - - - Condition key for the source IP from which a request originates. - - This condition key should only be used with enum. - - - - - - Condition key for the user agent included in a request. - - This condition key should only be used with - enum. - - - - - - Condition key for the current time, in epoch seconds. - - This condition key should only be used with enum. - objects. - - - - - - Condition key for the referrer specified by a request. - - This condition key should only be used with - objects. - - - - - - Condition key for the Amazon Resource Name (ARN) of the source specified - in a request. The source ARN indicates which resource is affecting the - resource listed in your policy. For example, an SNS topic is the source - ARN when publishing messages from the topic to an SQS queue. - - This condition key should only be used with enum. - - - - - - Enumeration of the supported ways an ARN comparison can be evaluated. - - - - Exact matching - - - - Loose case-insensitive matching of the ARN. Each of the six - colon-delimited components of the ARN is checked separately and each - can include a multi-character match wildcard (*) or a - single-character match wildcard (?). - - - - Negated form of ArnEquals - - - Negated form of ArnLike - - - - Enumeration of the supported ways a date comparison can be evaluated. - - - - - Enumeration of the supported ways an IP address comparison can be evaluated. - - - - - Matches an IP address against a CIDR IP range, evaluating to true if - the IP address being tested is in the condition's specified CIDR IP - range. - - - - - Negated form of IpAddress - - - - - Enumeration of the supported ways a numeric comparison can be evaluated - - - - - Enumeration of the supported ways a string comparison can be evaluated. - - - - - Case-sensitive exact string matching - - - - - Case-insensitive string matching - - - - - Loose case-insensitive matching. The values can include a - multi-character match wildcard (*) or a single-character match - wildcard (?) anywhere in the string. - - - - - Negated form of StringEquals. - - - - - Negated form of StringEqualsIgnorecase. - - - - - Negated form of StringLike. - - - - - Constructs a new access control policy condition that compares ARNs (Amazon Resource Names). - - The access policy condition key specifying where to get the first ARN for the comparison - The type of comparison to perform. - The second ARN to compare against. When using ArnLike or ArnNotLike this may contain the - multi-character wildcard (*) or the single-character wildcard - - - - Constructs a new access policy condition that performs a boolean - comparison. - - The access policy condition key specifying where to get the - first boolean value for the comparison (ex: aws:SecureTransport). - The boolean to compare against. - - - - This method is deprecated. Invoking this method results in non-UTC DateTimes - not being marshalled correctly. Use NewConditionUtc instead. - Constructs a new access policy condition that compares the current time - (on the AWS servers) to the specified date. - - The type of comparison to perform. For example, - DateComparisonType.DateLessThan will cause this policy - condition to evaluate to true if the current date is less than - the date specified in the second argument. - The date to compare against. - - - - Constructs a new access policy condition that compares the current time - (on the AWS servers) to the specified date. - - The type of comparison to perform. For example, - DateComparisonType.DateLessThan will cause this policy - condition to evaluate to true if the current date is less than - the date specified in the second argument. - The date to compare against. - - - - Constructs a new access policy condition that compares the source IP - address of the incoming request to an AWS service against the specified - CIDR range. The condition evaluates to true (meaning the policy statement - containing it will be applied) if the incoming source IP address is - within that range. - - To achieve the opposite effect (i.e. cause the condition to evaluate to - true when the incoming source IP is not in the specified CIDR - range) use the alternate constructor form and specify - IpAddressComparisonType.NotIpAddress. - - - The CIDR IP range involved in the policy condition. - - - - Constructs a new access policy condition that compares the source IP - address of the incoming request to an AWS service against the specified - CIDR range. When the condition evaluates to true (i.e. when the incoming - source IP address is within the CIDR range or not) depends on the - specified IpAddressComparisonType. - - The type of comparison to to perform. - The CIDR IP range involved in the policy condition. - - - - Constructs a new access policy condition that compares two numbers. - - The type of comparison to perform. - The access policy condition key specifying where to get the - first number for the comparison. - The second number to compare against. - - - - Constructs a new access control policy condition that compares two - strings. - - The type of comparison to perform - The access policy condition key specifying where to get the - first string for the comparison (ex: aws:UserAgent). - - The second string to compare against. When using - StringComparisonType.StringLike or - StringComparisonType.StringNotLike this may contain - the multi-character wildcard (*) or the single-character - wildcard (?). - - - - - Constructs a new access policy condition that compares the Amazon - Resource Name (ARN) of the source of an AWS resource that is modifying - another AWS resource with the specified pattern. - - For example, the source ARN could be an Amazon SNS topic ARN that is - sending messages to an Amazon SQS queue. In that case, the SNS topic ARN - would be compared the ARN pattern specified here. - - - The endpoint pattern may optionally contain the multi-character wildcard - * (*) or the single-character wildcard (?). Each of the six colon-delimited - components of the ARN is checked separately and each can include a - wildcard. - - - Policy policy = new Policy("MyQueuePolicy"); - policy.WithStatements(new Statement(Statement.StatementEffect.Allow) - .WithPrincipals(new Principal("*")).WithActionIdentifiers(SQSActionIdentifiers.SendMessage) - .WithResources(new Resource(myQueueArn)) - .WithConditions(ConditionFactory.NewSourceArnCondition(myTopicArn))); - - - The ARN pattern against which the source ARN will be compared. - Each of the six colon-delimited components of the ARN is - checked separately and each can include a wildcard. - A new access control policy condition that compares the ARN of - the source specified in an incoming request with the ARN pattern - specified here. - - - - Constructs a new access control policy condition that tests if the - incoming request was sent over a secure transport (HTTPS). - - A new access control policy condition that tests if the incoming - request was sent over a secure transport (HTTPS). - - - - Condition key for the canned ACL specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the location constraint specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the prefix specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the delimiter specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the max keys specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the source object specified by a request to copy an - object. - - This condition key may only be used with enum. - - - - - - Condition key for the metadata directive specified by a request to copy - an object. - - This condition key may only be used with enum. - - - - - - Condition key for the version ID of an object version specified by a - request. - - This condition key may only be used with enum. - - - - - - Constructs a new access policy condition that compares an Amazon S3 - canned ACL with the canned ACL specified by an incoming request. - - You can use this condition to ensure that any objects uploaded to an - Amazon S3 bucket have a specific canned ACL set. - - - The Amazon S3 canned ACL to compare against. - A new access control policy condition that compares the Amazon S3 - canned ACL specified in incoming requests against the value - specified. - - - - Condition key for The URL, e-mail address, or ARN from a Subscribe - request or a previously confirmed subscription. Use with string - conditions to restrict access to specific endpoints (e.g., - *@mycompany.com). - - This condition key may only be used with enum. - - - - - - Condition key for the protocol value from a Subscribe request or a - previously confirmed subscription. Use with string conditions to restrict - publication to specific delivery protocols (e.g., HTTPS). - - This condition key may only be used with enum. - - - - - - Constructs a new access policy condition that compares the requested - endpoint used to subscribe to an Amazon SNS topic with the specified - endpoint pattern. The endpoint pattern may optionally contain the - multi-character wildcard (*) or the single-character wildcard (?). - - For example, this condition can restrict subscriptions to a topic to - email addresses in a certain domain ("*@my-company.com"). - - - Policy policy = new Policy("MyTopicPolicy"); - policy.WithStatements(new Statement(Statement.StatementEffect.Allow) - .WithPrincipals(new Principal("*")).WithActionIdentifiers(SNSActionIdentifiers.Subscribe) - .WithResources(new Resource(myTopicArn)) - .WithConditions(ConditionFactory.NewEndpointCondition("*@my-company.com"))); - - - The endpoint pattern against which to compare the requested - endpoint for an Amazon SNS topic subscription. - A new access control policy condition that compares the endpoint - used in a request to subscribe to an Amazon SNS topic with the - endpoint pattern specified. - - - - Constructs a new AWS access control policy condition that allows an - access control statement to restrict subscriptions to an Amazon SNS topic - based on the protocol being used for the subscription. For example, this - condition can restrict subscriptions to a topic to endpoints using HTTPS - to ensure that messages are securely delivered. - - The protocol against which to compare the requested protocol - for an Amazon SNS topic subscription. - A new access control policy condition that compares the - notification protocol requested in a request to subscribe to an - Amazon SNS topic with the protocol value specified. - - - - Deserializes a JSON string into a AWS policy object. - - - - - Serializes an AWS policy object to a JSON string, suitable for sending to an - AWS service. - - - - Converts the specified AWS policy object to a JSON string, suitable for - passing to an AWS service. - - @param policy - The AWS policy object to convert to a JSON string. - - @return The JSON string representation of the specified policy object. - - @throws IllegalArgumentException - If the specified policy is null or invalid and cannot be - serialized to a JSON string. - - - - Uses the specified generator to write the JSON data for the principals in - the specified policy statement. - - - - - This sorts the conditions by condition type and key with the list of values for that combination. - - The list of conditions to be sorted. - - - - - An AWS access control policy is a object that acts as a container for one or - more statements, which specify fine grained rules for allowing or denying - various types of actions from being performed on your AWS resources. - - By default, all requests to use your resource coming from anyone but you are - denied. Access control polices can override that by allowing different types - of access to your resources, or by explicitly denying different types of - access. - - - Each statement in an AWS access control policy takes the form: - "A has permission to do B to C where D applies". - - - A is the prinicpal - The AWS account that is making a request to - access or modify one of your AWS resources. - - - - B is the action - the way in which your AWS resource is being accessed or modified, such - as sending a message to an Amazon SQS queue, or storing an object in an Amazon S3 bucket. - - - - C is the resource - your AWS entity that the principal wants to access, such - as an Amazon SQS queue, or an object stored in Amazon S3. - - - - D is the set of conditions - optional constraints that specify when to allow or deny - access for the principal to access your resource. Many expressive conditions are available, - some specific to each service. For example you can use date conditions to allow access to - your resources only after or before a specific time. - - - - - - Note that an AWS access control policy should not be confused with the - similarly named "POST form policy" concept used in Amazon S3. - - - - - - The default policy version - - - - - Constructs an empty AWS access control policy ready to be populated with - statements. - - - - - Constructs a new AWS access control policy with the specified policy ID. - The policy ID is a user specified string that serves to help developers - keep track of multiple polices. Policy IDs are often used as a human - readable name for a policy. - - The policy ID for the new policy object. Policy IDs serve to - help developers keep track of multiple policies, and are often - used to give the policy a meaningful, human readable name. - - - - Constructs a new AWS access control policy with the specified policy ID - and collection of statements. The policy ID is a user specified string - that serves to help developers keep track of multiple polices. Policy IDs - are often used as a human readable name for a policy. - - The policy ID for the new policy object. Policy IDs serve to - help developers keep track of multiple policies, and are often - used to give the policy a meaningful, human readable name. - The statements to include in the new policy. - - - - Gets and Sets the policy ID for this policy. Policy IDs serve to help - developers keep track of multiple policies, and are often used as human - readable name for a policy. - - - - - Sets the policy ID for this policy and returns the updated policy so that - multiple calls can be chained together. - - Policy IDs serve to help developers keep track of multiple policies, and - are often used as human readable name for a policy. - - - The polich ID for this policy - this instance - - - - Gets and sets the version of this AWS policy. - - - - - Gets and Sets the collection of statements contained by this policy. Individual - statements in a policy are what specify the rules that enable or disable - access to your AWS resources. - - - - - Checks to see if the permissions set in the statement are already set by another - statement in the policy. - - The statement to verify - True if the statement's permissions are already allowed by the statement - - - - Sets the collection of statements contained by this policy and returns - this policy object so that additional method calls can be chained - together. - - Individual statements in a policy are what specify the rules that enable - or disable access to your AWS resources. - - - The collection of statements included in this policy. - this instance - - - - Returns a JSON string representation of this AWS access control policy, - suitable to be sent to an AWS service as part of a request to set an - access control policy. - - A JSON string representation of this AWS access control policy. - - - - Returns a JSON string representation of this AWS access control policy, - suitable to be sent to an AWS service as part of a request to set an - access control policy. - - Toggle pretty print for the generated JSON document - A JSON string representation of this AWS access control policy. - - - - Parses a JSON document of a policy and creates a Policy object. - - JSON document of a policy. - - - - - A principal is an AWS account which is being allowed or denied access to a - resource through an access control policy. The principal is a property of the - Statement object, not directly the object. - - The principal is A in the statement - "A has permission to do B to C where D applies." - - - In an access control policy statement, you can set the principal to all - authenticated AWS users through the member. This - is useful when you don't want to restrict access based on the identity of the - requester, but instead on other identifying characteristics such as the - requester's IP address. - - - - - - Principal instance that includes all authenticated AWS users. - - This is useful when you don't want to restrict access based on the - identity of the requester, but instead on other identifying - characteristics such as the requester's IP address. - - - - - - The anonymous Principal. - - - - - The default Principal provider for AWS accounts. - - - - - Principal provider for Canonical User IDs. - - - - - Principal provider for federated users (using a SAML identity provider) - - - - - Principal provider for assume role policies that will be assumed by an AWS service - (e.g. "ec2.amazonaws.com"). - - - - - Dummy principal provider for anonynous. - - - - - Constructs a new principal with the specified AWS account ID. - - An AWS account ID. - - - - Constructs a new principal with the specified provider and id - - The provider of the principal - The unique ID of the Principal within the provider - - - - Constructs a new principal with the specified provider and id - and optionally strips hyphens from the id - - The provider of the principal - The unique ID of the Principal within the provider - Strip hyphen - - - - Gets and sets the provider for this principal, which indicates in what group of - users this principal resides. - - - - - Gets the unique ID for this principal. - - - - - Represents a resource involved in an AWS access control policy statement. - Resources are the service specific AWS entities owned by your account. Amazon - SQS queues, Amazon S3 buckets and objects, and Amazon SNS topics are all - examples of AWS resources. - - The standard way of specifying an AWS resource is with an Amazon Resource - Name (ARN). - - - The resource is C in the statement - "A has permission to do B to C where D applies." - - - - - - Constructs a new AWS access control policy resource. Resources are - typically specified as Amazon Resource Names (ARNs). - - You specify the resource using the following Amazon Resource Name (ARN) - format: arn:aws:<vendor>:<region>:<namespace>:<relative-id> - - - >vendor identifies the AWS product (e.g., sns) - - - region is the AWS Region the resource resides in (e.g., us-east-1), if any - - - namespace is the AWS account ID with no hyphens (e.g., 123456789012) - - - relative-id is the service specific portion that identifies the specific resource - - - - - For example, an Amazon SQS queue might be addressed with the following - ARN: arn:aws:sqs:us-east-1:987654321000:MyQueue - - - Some resources may not use every field in an ARN. For example, resources - in Amazon S3 are global, so they omit the region field: - arn:aws:s3:::bucket/* - - - The Amazon Resource Name (ARN) uniquely identifying the desired AWS resource. - - - - Gets the resource ID, typically an Amazon Resource Name (ARN), - identifying this resource. - - - - - A factory for creating resources to be used in the policy. - - - - - Constructs a new bucket resource that represents the the specified bucket - but not any of the contained objects. - - The name of the bucket represented by this AWS access control - policy resource. - - - - Constructs a new object resource that represents the specified objects. - The keyPattern argument may contain the '*' wildcard to match multiple - objects. For example, an object resource created for bucket 'mybucket' - and key pattern 'foo*' will match any object stored in 'mybucket' with a - key that starts with 'foo'. - - The name of the bucket containing the object or objects - represented by this resource. - The key or key pattern, which can optionally contain the '*' - wildcard to include multiple objects in the resource. - - - - Constructs a new SQS queue resource for an access control policy. A - policy statement using this resource will allow or deny actions on the - specified queue. - - The AWS account ID of the queue owner. - The name of the Amazon SQS queue. - - - - A statement is the formal description of a single permission, and is always - contained within a policy object. - - A statement describes a rule for allowing or denying access to a specific AWS - resource based on how the resource is being accessed, and who is attempting - to access the resource. Statements can also optionally contain a list of - conditions that specify when a statement is to be honored. - - - For example, consider a statement that: - - - A is the prinicpal - The AWS account that is making a request to - access or modify one of your AWS resources. - - - - B is the action - the way in which your AWS resource is being accessed or modified, such - as sending a message to an Amazon SQS queue, or storing an object in an Amazon S3 bucket. - - - - C is the resource - your AWS entity that the principal wants to access, such - as an Amazon SQS queue, or an object stored in Amazon S3. - - - - D is the set of conditions - optional constraints that specify when to allow or deny - access for the principal to access your resource. Many expressive conditions are available, - some specific to each service. For example you can use date conditions to allow access to - your resources only after or before a specific time. - - - - - - There are many resources and conditions available for use in statements, and - you can combine them to form fine grained custom access control polices. - - - - - - The effect is the result that you want a policy statement to return at - evaluation time. A policy statement can either allow access or explicitly - deny access. - - - - - Constructs a new access control policy statement with the specified - effect. - - Before a statement is valid and can be sent to AWS, callers must set the - principals, resources, and actions (as well as any optional conditions) - involved in the statement. - - - The effect this statement has (allowing access or denying - access) when all conditions, resources, principals, and - actions are matched. - - - - Gets and Sets the ID for this statement. Statement IDs serve to help keep track - of multiple statements, and are often used to give the statement a - meaningful, human readable name. - - Developers should be careful to not use the same statement ID for - multiple statements in the same policy. Reusing the same statement ID in - different policies is not a problem. - - - - - - Sets the ID for this statement and returns the updated statement so - multiple calls can be chained together. - - Statement IDs serve to help keep track of multiple statements, and are - often used to give the statement a meaningful, human readable name. - - - Developers should be careful to not use the same statement ID for - multiple statements in the same policy. Reusing the same statement ID in - different policies is not a problem. - - - The new statement ID for this statement. - this instance - - - - Gets and Sets the result effect of this policy statement when it is evaluated. - A policy statement can either allow access or explicitly - - - - - Gets and Sets the list of actions to which this policy statement applies. - Actions limit a policy statement to specific service operations that are - being allowed or denied by the policy statement. For example, you might - want to allow any AWS user to post messages to your SQS queue using the - SendMessage action, but you don't want to allow those users other actions - such as ReceiveMessage or DeleteQueue. - - - - - Sets the list of actions to which this policy statement applies and - returns this updated Statement object so that additional method calls can - be chained together. - - Actions limit a policy statement to specific service operations that are - being allowed or denied by the policy statement. For example, you might - want to allow any AWS user to post messages to your SQS queue using the - SendMessage action, but you don't want to allow those users other actions - such as ReceiveMessage or DeleteQueue. - - - The list of actions to which this statement applies. - this instance - - - - Gets and Sets the resources associated with this policy statement. Resources - are what a policy statement is allowing or denying access to, such as an - Amazon SQS queue or an Amazon SNS topic. - - Note that some services allow only one resource to be specified per - policy statement. - - - - - - Sets the resources associated with this policy statement and returns this - updated Statement object so that additional method calls can be chained - together. - - Resources are what a policy statement is allowing or denying access to, - such as an Amazon SQS queue or an Amazon SNS topic. - - - Note that some services allow only one resource to be specified per - policy statement. - - - The resources associated with this policy statement. - this instance - - - - Gets and Sets the conditions associated with this policy statement. Conditions - allow policy statements to be conditionally evaluated based on the many - available condition types. - - For example, a statement that allows access to an Amazon SQS queue could - use a condition to only apply the effect of that statement for requests - that are made before a certain date, or that originate from a range of IP - addresses. - - - When multiple conditions are included in a single statement, all - conditions must evaluate to true in order for the statement to take - effect. - - - - - - Sets the conditions associated with this policy statement, and returns - this updated Statement object so that additional method calls can be - chained together. - - Conditions allow policy statements to be conditionally evaluated based on - the many available condition types. - - - For example, a statement that allows access to an Amazon SQS queue could - use a condition to only apply the effect of that statement for requests - that are made before a certain date, or that originate from a range of IP - addresses. - - - Multiple conditions can be included in a single statement, and all - conditions must evaluate to true in order for the statement to take - effect. - - - The conditions associated with this policy statement. - this instance - - - - Gets and Sets the principals associated with this policy statement, indicating - which AWS accounts are affected by this policy statement. - - - - - Sets the principals associated with this policy statement, and returns - this updated Statement object. Principals control which AWS accounts are - affected by this policy statement. - - If you don't want to restrict your policy to specific users, you can use - to apply the policy to any user trying to - access your resource. - - - The list of principals associated with this policy statement. - this instance - - - - Exception thrown by the SDK for errors that occur within the SDK. - - - - - Constructs a new instance of the AmazonClientException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - This exception is thrown when there is a parse error on the response back from AWS. - - - - - The string value which could not be converted into a valid DateTime instance. - - - - - Constructs a new instance of the AmazonDateTimeUnmarshallingException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - Occurs before a request is marshalled. - - - - - Occurs before a request is issued against the service. - - - - - Occurs after a response is received from the service. - - - - - Occurs after an exception is encountered. - - - - - Patches the in-flight uri to stop it unescaping the path etc (what Uri did before - Microsoft deprecated the constructor flag). This is particularly important for - Amazon S3 customers who want to use backslash (\) in their key names. - - - Different behavior in the various runtimes has been observed and in addition some - 'documented' ways of doing this between 2.x and 4.x runtimes has also been observed - to not be reliable. - - This patch effectively emulates what adding a schemesettings element to the - app.config file with value 'name="http" genericUriParserOptions="DontUnescapePathDotsAndSlashes"' - does. As we're a dll, that avenue is not open to us. - - - - - - Used to create a copy of the config for a different service than the current instance. - - Target service ClientConfig - The new ClientConfig for the desired service - - - - A base exception for some Amazon Web Services. - - Most exceptions thrown to client code will be service-specific exceptions, though some services - may throw this exception if there is a problem which is caught in the core client code. - - - - - - Whether the error was attributable to Sender or Reciever. - - - - - The error code returned by the service - - - - - The id of the request which generated the exception. - - - - - The HTTP status code from the service response - - - - - Constructs a new instance of the AmazonServiceException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - This exception is thrown when there is a parse error on the response back from AWS. - - - - - Last known location in the response that was parsed, if available. - - - - - The entire response body that caused this exception, if available. - - - - - Constructs a new instance of the AmazonSimpleDBException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - Base class for request used by some of the services. - - - - - This flag specifies if SigV4 will be used for the current request. - - - - - Gets or Sets a value indicating if "Expect: 100-continue" HTTP header will be - sent by the client for this request. The default value is false. - - - - - Gets the signer to use for this request. - A null return value indicates to use the configured - signer for the service that this request is part of. - - A signer for this request, or null. - - - - Overrides the default request timeout value. - - - - If the value is set, the value is assigned to the Timeout property of the HTTPWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Overrides the default read-write timeout value. - - - - If the value is set, the value is assigned to the ReadWriteTimeout property of the HTTPWebRequest/WebRequestHandler object used - to send requests. - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - - Abstract class for Response objects, contains only metadata, - and no result information. - - - - - Contains additional information about the request, such as the - Request Id. - - - - - Returns the content length of the HTTP response. - - - - - Returns the status code of the HTTP response. - - - - - Base class for determining region based on inspection. - - - - - Sets the Region property by looking up the corresponding RegionEndpoint - from the supplied region system name (us-east-1, us-west-2 etc). - - The system name of the region. - - - - Determines region based on application configuration settings. If the configuration does not contain - the region setting key an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of ApplicationConfigAWSRegion. If no region is found in the - application configuration file then an InvalidOperationException is thrown. - - - - - Determines region based on an environment variable. If the environment does not contain - the region setting key an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of EnvironmentVariableAWSRegion. If no region is found in the - environment then an InvalidOperationException is thrown. - - - - - Determines region based on inspection of the instance metadata if running on an EC2 instance. - If instance metadata cannot be read or does not contain region information an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of InstanceProfileAWSRegion. If no region is found in the - metadata or we are not running on an EC2 instance an InvalidOperationException is thrown. - - - - - Determines region based on a stored in an . - If the profile doesn't exist or there is no region information an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of . - If the AWS_PROFILE environment variable is set the instance will be constructed using that profile, - otherwise it will use the default profile. - - If the profile doesn't exist or there is no region information an InvalidOperationException is thrown. - - The ICredentialProfileSource to read the profile from. - - - - Attempts to construct an instance of . - If the profile doesn't exist or there is no region information an InvalidOperationException is thrown. - - The ICredentialProfileSource to read the profile from. - The name of the profile. - - - - Probing mechanism to determine region from various sources. - - - - - This class is responsible for keeping track of Retry capacity across different ServiceURLs. - - - - - This method acquires a said retry capacity if the container has the capacity. - - Contains the RetryCapacity object for the said ServiceURL. - - - - This method calls a method to release capacity back - based on whether it was a successful response or a successful retry response. This is invoked by a retry request response. - - if this request is a retry, use a different capacity cost - Contains the RetryCapacity object for the said ServiceURL. - - - - Ths method fetches the RetryCapacity for the given ServiceURL from CapacityManager.CapacityContainer - - - - - This method releases capacity back. This is invoked by the TryReleaseCapacity method. - - Contains the RetryCapacity object for the said ServiceURL. - The capacity that needs to be released based on whether it was a successful response or a successful retry response. - - - - This class is the RetryCapacity class for a given ServiceURL. - - - - - This class composes Client Context header for Amazon Web Service client. - It contains information like app title, version code, version name, client id, OS platform etc. - - - This class composes Client Context header for Amazon Web Service client. - It contains information like app title, version code, version name, client id, OS platform etc. - - - - - Adds the custom attributes to the Client Context. - - Key. - Value. - - - - Gets a Json Representation of the Client Context. - - Json Representation of Client Context - - - - Class to which the Json stdout from credential process is - de-serialized into. - - - - - Version of the Json payload - - - - - AWS Access key - - - - - AWS Secret key - - - - - AWS Session token for session credentials - - - - - ISO8601 formatted timestamp till when the credential is valid. - - - - - This class gets the CSM configuration if set. - The priority goes - 1. App.config / instantiate on the AWSConfigs class - 2. Environment variable - 3. Shared Profile - - - - - Determine CSM configs from shared profile file. - - - - - Determine CSM configs from environment variables. - - - - - Determine CSM configs from AWSConfigs class. - - - - - Utility class for CSM. - Contains logic to serialize CSM events to Json. - - - - - Method to retrieve the API name from the request name. - - - - - Method to serialize MonitoringAPICallAttempt CSM event to json. - - - - - Method to serialize MonitoringAPICallEvent CSM event to json. - - - - - Method to serialize MonitoringAPICall CSM event to json. - - - - - Internal class that has the CSM configurations for the Monitoring Listener - after being derived from the CSMConfigChain class. - - - - - CSM event base class - - - - - Contains the operation name for the api call being made - - - - - Contains the service id ServiceId Sep of the service - against which the call is being made - - - - - Contains the "ClientId" configuration value - computed from the CSMConfigChain class - - - - - Contains the elapsed time, in milliseconds, - since January 1st, 1970, for the time point - at which the event occurred - - - - - Contains "ApiCall" or "ApiCallAttempt" - based on what the monitoring event is describing - - - - - Contains the enum of the above CSM type property - - - - - Contains the "Version" configuration value - computed from the CSMConfigChain class - Defaults to 1. - - - - - Contains the signing region used by the - service client that made the request attempt. - - - - - Contains the full value of the SDK's default - user agent header for http requests. - - - - - Class that captures the CSM Api Call Attempt Monitoring Events - for each http request and its subsequent response. - - - - - Contains the fully-qualified domain name of the endpoint that - the request attempt was submitted to. - - - - - Contains the session token passed - in the x-amz-security-token header. - - - - - Contains the aws_access_key value that - was used to sign the http request. - - - - - Contains the attempt's response status code, - as returned by the http client. - - - - - Contains the full text (exception object converted to String, - for example) for any attempt-level failure that is due to - something other than an Aws exception. The value of this entry - has a maximum length of 512. - - - - - Contains the short error name (exception class name, for example) - for any attempt-level failure that is due to something other - than an Aws exception.The value of this entry has a maximum length of 128. - - - - - Contains the Aws exception code returned in the response. - - - - - Contains the full text of the Aws exception message. - - - - - Contains the value of the response's x-amzn-RequestId header. - - - - - Contains the value of the response's x-amz-request-id header. - - - - - Contains the value of the response's x-amz-id-2 header. - - - - - Contains the elapsed time, in milliseconds, - between the construction of the http request and the - point in time where the http response has been parsed - or the attempt has definitively failed. - - - - - Class that captures the CSM Api Call Monitoring Events - for the entire SDK call. This is processed once. - - - - - Contains the total number of attempts that were made - by the service client to fulfill this request before succeeding or failing - - - - - Contains the elapsed time, in milliseconds, - between when the Api Call was begun and when a - final response or error is manifested to the caller - - - - - a boolean (0/1) value that is 0 unless the Api call failed - and the final attempt returned a retryable error.This entry should be - serialized as a numeric 0/1 value. This is mapped to MaxRetriesExceeded - when serialized to a UDP datagram. - - - - - Contains the full text (exception object - converted to String, for example) for an attempt-level failure that is due to - something other than an Aws exception that occurred on the last attempt to - fulfill the Api call.The value of this entry has a maximum length of 512. - - - - - Contains the short error name (exception - class name, for example) for a failure that is due to something other than an - Aws exception that occurred on the last attempt to fulfill an Api call.See - the SdkException entry for more details.The value of this entry has a - maximum length of 128. - - - - - Contains the Aws exception code - returned in the response to the final attempt at fulfilling this API call. - The value of this entry has a maximum length of 128. - - - - - - Contains the attempt's response status code, - as returned by the http client. - - - - - Computes RFC 2104-compliant HMAC signature. - - - - - Computes RFC 2104-compliant HMAC signature. - - - - - Inspects the supplied evidence to return the signer appropriate for the operation - - Global setting for the service - The request. - Configuration for the client - True if signature v4 request signing should be used - - - - Signs the specified request with the AWS3 signing protocol by using the - AWS account credentials given in the method parameters. - - The AWS public key - The AWS secret key used to sign the request in clear text - Request metrics - The configuration that specifies which hashing algorithm to use - The request to have the signature compute for - If any problems are encountered while signing the request - - - - AWS4 protocol signer for service calls that transmit authorization in the header field "Authorization". - - - - - Calculates and signs the specified request using the AWS4 signing protocol by using the - AWS account credentials given in the method parameters. The resulting signature is added - to the request headers as 'Authorization'. Parameters supplied in the request, either in - the resource path as a query string or in the Parameters collection must not have been - uri encoded. If they have, use the SignRequest method to obtain a signature. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. - - - Client configuration data encompassing the service call (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text. - - - If any problems are encountered while signing the request. - - - - - Calculates and signs the specified request using the AWS4 signing protocol by using the - AWS account credentials given in the method parameters. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. - - - Client configuration data encompassing the service call (notably authentication - region, endpoint and service name). - - - Metrics for the request. - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text. - - - If any problems are encountered while signing the request. - - - Parameters passed as part of the resource path should be uri-encoded prior to - entry to the signer. Parameters passed in the request.Parameters collection should - be not be encoded; encoding will be done for these parameters as part of the - construction of the canonical request. - - - - - Sets the AWS4 mandated 'host' and 'x-amz-date' headers, returning the date/time that will - be used throughout the signing process in various elements and formats. - - The current set of headers - - Date and time used for x-amz-date, in UTC - - - - Sets the AWS4 mandated 'host' and 'x-amz-date' headers, accepting and returning the date/time that will - be used throughout the signing process in various elements and formats. - - The current set of headers - - - Date and time used for x-amz-date, in UTC - - - - Computes and returns an AWS4 signature for the specified canonicalized request - - - - - - - - - - - - Computes and returns an AWS4 signature for the specified canonicalized request - - - - - - - - - - - - - Computes and returns an AWS4 signature for the specified canonicalized request - - - - - - - - - - - - - - Formats the supplied date and time for use in AWS4 signing, where various formats are used. - - - The required format - The UTC date/time in the requested format - - - - Compute and return the multi-stage signing key for the request. - - The clear-text AWS secret key, if not held in secureKey - The region in which the service request will be processed - Date of the request, in yyyyMMdd format - The name of the service being called by the request - Computed signing key - - - - If the caller has already set the x-amz-content-sha256 header with a pre-computed - content hash, or it is present as ContentStreamHash on the request instance, return - the value to be used in request canonicalization. - If not set as a header or in the request, attempt to compute a hash based on - inspection of the style of the request content. - - - - The computed hash, whether already set in headers or computed here. Null - if we were not able to compute a hash. - - - - - If signPayload is false set the x-amz-content-sha256 header to - the UNSIGNED-PAYLOAD magic string and return it. - Otherwise, if the caller has already set the x-amz-content-sha256 header with a pre-computed - content hash, or it is present as ContentStreamHash on the request instance, return - the value to be used in request canonicalization. - If not set as a header or in the request, attempt to compute a hash based on - inspection of the style of the request content. - - - - - The computed hash, whether already set in headers or computed here. Null - if we were not able to compute a hash. - - - - - Returns the HMAC256 for an arbitrary blob using the specified key - - - - - - - - Returns the HMAC256 for an arbitrary blob using the specified key - - - - - - - - Compute and return the hash of a data blob using the specified key - - Algorithm to use for hashing - Hash key - Data blob - Hash of the data - - - - Compute and return the hash of a data blob using the specified key - - Algorithm to use for hashing - Hash key - Data blob - Hash of the data - - - - Computes the non-keyed hash of the supplied data - - - - - - - Computes the non-keyed hash of the supplied data - - - - - - - Computes and returns the canonical request - - The endpoint URL - the path of the resource being operated on - The http method used for the request - The full request headers, sorted into canonical order - The query parameters for the request - - The hash of the binary request body if present. If not supplied, the routine - will look for the hash as a header on the request. - - Canonicalised request as a string - - - - Computes and returns the canonical request - - The endpoint URL - the path of the resource being operated on - The http method used for the request - The full request headers, sorted into canonical order - The query parameters for the request - - The path resource values lookup to use to replace the keys within resourcePath - The hash of the binary request body if present. If not supplied, the routine - will look for the hash as a header on the request. - - The version of the marshaller that constructed the request object. - Canonicalised request as a string - - - - Reorders the headers for the request for canonicalization. - - The set of proposed headers for the request - List of headers that must be included in the signature - For AWS4 signing, all headers are considered viable for inclusion - - - - Computes the canonical headers with values for the request. Only headers included in the signature - are included in the canonicalization process. - - All request headers, sorted into canonical order - Canonicalized string of headers, with the header names in lower case. - - - - Returns the set of headers included in the signature as a flattened, ;-delimited string - - The headers included in the signature - Formatted string of header names - - - - Collects the subresource and query string parameters into one collection - ready for canonicalization - - The in-flight request being signed - The fused set of parameters - - - - Computes and returns the canonicalized query string, if query parameters have been supplied. - Parameters with no value will be canonicalized as 'param='. The expectation is that parameters - have not already been url encoded prior to canonicalization. - - The set of parameters being passed on the uri - - Parameters must be uri encoded into the canonical request and by default the signer expects - that the supplied collection contains non-encoded data. Set this to false if the encoding was - done prior to signer entry. - - The uri encoded query string parameters in canonical ordering - - - - Computes and returns the canonicalized query string, if query parameters have been supplied. - Parameters with no value will be canonicalized as 'param='. The expectation is that parameters - have not already been url encoded prior to canonicalization. - - The set of parameters to be encoded in the query string - - Parameters must be uri encoded into the canonical request and by default the signer expects - that the supplied collection contains non-encoded data. Set this to false if the encoding was - done prior to signer entry. - - The uri encoded query string parameters in canonical ordering - - - - Returns the request parameters in the form of a query string. - - The request instance - Request parameters in query string format - - - - AWS4 protocol signer for Amazon S3 presigned urls. - - - - - Calculates and signs the specified request using the AWS4 signing protocol by using the - AWS account credentials given in the method parameters. The resulting signature is added - to the request headers as 'Authorization'. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. - - - Adding supporting data for the service call required by the signer (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text - - - If any problems are encountered while signing the request. - - - - - Calculates the AWS4 signature for a presigned url. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. If the Expires parameter - is present, it is renamed to 'X-Amz-Expires' before signing. - - - Adding supporting data for the service call required by the signer (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text - - - If any problems are encountered while signing the request. - - - Parameters passed as part of the resource path should be uri-encoded prior to - entry to the signer. Parameters passed in the request.Parameters collection should - be not be encoded; encoding will be done for these parameters as part of the - construction of the canonical request. - - - - - Calculates the AWS4 signature for a presigned url. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. If the Expires parameter - is present, it is renamed to 'X-Amz-Expires' before signing. - - - Adding supporting data for the service call required by the signer (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text - - - The service to sign for - - - The region to sign to, if null then the region the client is configured for will be used. - - - If any problems are encountered while signing the request. - - - Parameters passed as part of the resource path should be uri-encoded prior to - entry to the signer. Parameters passed in the request.Parameters collection should - be not be encoded; encoding will be done for these parameters as part of the - construction of the canonical request. - - The X-Amz-Content-SHA256 is cleared out of the request. - If the request is for S3 then the UNSIGNED_PAYLOAD value is used to generate the canonical request. - If the request isn't for S3 then the empty body SHA is used to generate the canonical request. - - - - - Encapsulates the various fields and eventual signing value that makes up - an AWS4 signature. This can be used to retrieve the required authorization string - or authorization query parameters for the final request as well as hold ongoing - signature computations for subsequent calls related to the initial signing. - - - - - Constructs a new signing result instance for a computed signature - - The access key that was included in the signature - Date/time (UTC) that the signature was computed - The collection of headers names that were included in the signature - Formatted 'scope' value for signing (YYYYMMDD/region/service/aws4_request) - Returns the key that was used to compute the signature - Computed signature - - - - The access key that was used in signature computation. - - - - - ISO8601 formatted date/time that the signature was computed - - - - - ISO8601 formatted date that the signature was computed - - - - - The ;-delimited collection of header names that were included in the signature computation - - - - - Formatted 'scope' value for signing (YYYYMMDD/region/service/aws4_request) - - - - - Returns a copy of the key that was used to compute the signature - - - - - Returns the hex string representing the signature - - - - - Returns a copy of the byte array containing the signature - - - - - Returns the signature in a form usable as an 'Authorization' header value. - - - - - Returns the signature in a form usable as a set of query string parameters. - - - - - Null Signer which does a no-op. - - - - - Signs the specified request with the AWS2 signing protocol by using the - AWS account credentials given in the method parameters. - - The AWS public key - The AWS secret key used to sign the request in clear text - Request metrics - The configuration that specifies which hashing algorithm to use - The request to have the signature compute for - If any problems are encountered while signing the request - - - - S3 signer constructor - - - - - S3 signer constructor - - - - - This exception is thrown if there are problems signing the request. - - - - - Constructs a new instance of the SignatureException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Collection used to indicate if the property was initialized was created by the SDK. - - - - - - Collection used to indicate if the property was initialized was created by the SDK. - - - - - - - Default implementation of the IRequest interface. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Constructs a new DefaultRequest with the specified service name and the - original, user facing request object. - - The orignal request that is being wrapped - The service name - - - - The name of the request - - - - - Gets and sets the type of http request to make, whether it should be POST,GET or DELETE - - - - - Gets and sets a flag that indicates whether the request is sent as a query string instead of the request body. - - - - - Returns the original, user facing request object which this internal - request object is representing. - - - - - Returns a dictionary of the headers included in this request. - - - - - Returns a dictionary of the parameters included in this request. - - - - - Collection of parameters included in this request. - - - - - Returns the subresources that should be appended to the resource path. - This is used primarily for Amazon S3, where object keys can contain '?' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new null entry to the SubResources collection for the request - - The name of the subresource - - - - Adds a new entry to the SubResources collection for the request - - The name of the subresource - Value of the entry - - - - Gets and Sets the endpoint for this request. - - - - - Gets and Sets the resource path added on to the endpoint. - - - - - Returns the path resources that should be used within the resource path. - This is used for services where path keys can contain '/' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new entry to the PathResources collection for the request - - The name of the pathresource with potential greedy syntax: {key+} - Value of the entry - - - - Gets and Sets the version number for the marshaller used to create this request. The version number - is used to support backward compatible changes that would otherwise be breaking changes when a - newer core is used with an older service assembly. - Versions: - 1 - Default version - 2 - Support for path segments - - - - - Gets and Sets the content for this request. - - - - - Flag that signals that Content was and should be set - from the Parameters collection. - - - - - Gets and sets the content stream. - - - - - Gets and sets the original stream position. - If ContentStream is null or does not support seek, this propery - should be equal to -1. - - - - - Computes the SHA 256 hash of the content stream. If the stream is not - seekable, it searches the parent stream hierarchy to find a seekable - stream prior to computation. Once computed, the hash is cached for future - use. If a suitable stream cannot be found to use, null is returned. - - - - - The name of the service to which this request is being sent. - - - - - Alternate endpoint to use for this request, if any. - - - - - Host prefix value to prepend to the endpoint for this request, if any. - - - - - Gets and sets the Suppress404Exceptions property. If true then 404s return back from AWS will not cause an exception and - an empty response object will be returned. - - - - - If using AWS4 signing protocol, contains the resultant parts of the - signature that we may need to make use of if we elect to do a chunked - encoding upload. - - - - - Determine whether to use a chunked encoding upload for the request - (applies to Amazon S3 PutObject and UploadPart requests only). - - - - - - Used for Amazon S3 requests where the bucket name is removed from - the marshalled resource path into the host header. To comply with - AWS2 signature calculation, we need to recover the bucket name - and include it in the resource canonicalization, which we do using - this field. - - - - - This flag specifies if SigV4 is required for the current request. - - - - - The authentication region to use for the request. - Set from Config.AuthenticationRegion. - - - - - The region in which the service request was signed. - - - - - Checks if the request stream can be rewinded. - - Returns true if the request stream can be rewinded , - else false. - - - - Returns true if the request can contain a request body, else false. - - Returns true if the currect request can contain a request body, else false. - - - - Returns true if the request has a body, else false. - - Returns true if the request has a body, else false. - - - - Class containing the data for one endpoint returned from a endpoint discovery request - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Constructs a new DiscoveryEndpoint - - The address of the endpoint - The cache period for the endpoint in minutes - - - - The address of the endpoint. - - - - - The cache period for the endpoint in minutes - - - - - Calculates if this endpoint has expired - - A boolean value indicating if the cache period has expired - - - - Extends the endpoint expiration by the specified number of minutes from now. - - - - - Class containing the data for one endpoint returned from a endpoint discovery request - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class containing the data to use with endpoint discovery - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Gets/sets and flag indicating if endpoint discovery is required for the request. - - - - - Sorted dictionary of the identifiers that must be sent with the endpoint discovery request. These - identifiers are used to construct the cache key for the cache that stores discovered endpoints. A - sorted dictionary is used instead of a dictionary to ensure the cache key comes out in the same order - each time it is constructed. - - - - - Represents the data to be used with endpoint discovery operations - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class used to resolve endpoints using Endpoint Discovery. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Method that performs endpoint discovery for the current operation - - Context information used in calculations for endpoint discovery - The operation to fetch endpoints from the server - - - - - Gets the number of cache keys in the cache - - - - - Class used to resolve endpoints using Endpoint Discovery. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class containing context information to use with endpoint discovery - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Gets the customer credential information. - - - - - Gets the operation name. - - - - - Gets the current marshalled endpoint discovery data. - - - - - Gets the flag indicating if the specified key should be evicted from the cache. - - - - - Gets the Uri that should be evicted if EvictCacheKey is set to true. - - - - - Class containing context information to use with endpoint discovery - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Error type, one of Sender, Receiver, Unknown - Only applies to XML-based services. - - - - - Name of the exception class to return - - - - - Error message - - - - - RequestId of the error. - Only applies to XML-based services. - - - - - Class containing the members used to invoke service calls - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class containing the members used to invoke service calls - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Represents a request being sent to an Amazon Web Service, including the - parameters being sent as part of the request, the endpoint to which the - request should be sent, etc. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - The name of the request - - - - - Returns a dictionary of the headers included in this request. - - - - - Gets and sets a flag that indicates whether the request is sent as a query string instead of the request body. - - - - - Returns a dictionary of the parameters included in this request. - - - - - Collection of parameters included in this request. - - - - - Returns the subresources that should be appended to the resource path. - This is used primarily for Amazon S3, where object keys can contain '?' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new null entry to the SubResources collection for the request - - The name of the subresource - - - - Adds a new entry to the SubResources collection for the request - - The name of the subresource - Value of the entry - - - - Gets and sets the type of http request to make, whether it should be POST,GET or DELETE - - - - - Gets and Sets the endpoint for this request. - - - - - Gets and Sets the resource path added on to the endpoint. - - - - - Returns the path resources that should be used within the resource path. - This is used for services where path keys can contain '/' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new entry to the PathResources collection for the request - - The name of the pathresource with potential greedy syntax: {key+} - Value of the entry - - - - Gets and Sets the version number for the marshaller used to create this request. The version number - is used to support backward compatible changes that would otherwise be breaking changes when a - newer core is used with an older service assembly. - - - - - Gets and Sets the content for this request. - - - - - Gets the header value from the request. - - - - - Flag that signals that Content was and should be set - from the Parameters collection. - - - - - Gets and sets the content stream. - - - - - Gets and sets the original stream position. - If ContentStream is null or does not support seek, this propery - should be equal to -1. - - - - - Computes the SHA 256 hash of the content stream. If the stream is not - seekable, it searches the parent stream hierarchy to find a seekable - stream prior to computation. Once computed, the hash is cached for future - use. - - - - - The name of the service to which this request is being sent. - - - - - Returns the original, user facing request object which this internal - request object is representing. - - - - - Alternate endpoint to use for this request, if any. - - - - - Host prefix value to prepend to the endpoint for this request, if any. - - - - - Gets and sets the Suppress404Exceptions property. If true then 404s return back from AWS will not cause an exception and - an empty response object will be returned. - - - - - If using AWS4 signing protocol, contains the resultant parts of the - signature that we may need to make use of if we elect to do a chunked - encoding upload. - - - - - Determine whether to use a chunked encoding upload for the request - (applies to Amazon S3 PutObject and UploadPart requests only). - - - - - - Used for Amazon S3 requests where the bucket name is removed from - the marshalled resource path into the host header. To comply with - AWS2 signature calculation, we need to recover the bucket name - and include it in the resource canonicalization, which we do using - this field. - - - - - This flag specifies if SigV4 is required for the current request. - - - - - The authentication region to use for the request. - Set from Config.AuthenticationRegion. - - - - - The region in which the service request was signed. - - - - - Checks if the request stream can be rewinded. - - Returns true if the request stream can be rewinded , - else false. - - - - Returns true if the request can contain a request body, else false. - - Returns true if the currect request can contain a request body, else false. - - - - Returns true if the request has a body, else false. - - Returns true if the request has a body, else false. - - - - Gets the value of the Service Id. - - - - - Gets the dictionary that gives mapping of renamed operations - - - - - IDictionary{String, String} access to ParameterCollection. - TODO: remove this class in version 3.4 of the SDK. - - - - - Constructs ParametersDictionaryFacade for a ParameterCollection - - - - - - A registry of object that will manipulate the runtime pipeline used by service clients. - - - - - Registers a customizer that will be applied for all service clients created. Each customizer has a unique name associated with it. If a customizer is registered more - than once with the same unique name then the calls after the first will be ignored. - - - - - - Deregistered the runtime pipeline customizer - - - - - - Deregistered the runtime pipeline customizer - - - - - - Applies all of the registered customizers on the runtime pipeline - - The service clients runtime pipeline. - Type object for the service client being created - - - - Interface for objects that will customize the runtime pipleine for newly created service clients. - - - - - The unique name for the customizer that identifies the customizer in the registry. The name is also used to identify the customizer on the SDK logs. - - - - - Called on service clients as they are being constructed to customize their runtime pipeline. - - - Type object for the service client being created - - - - Default ServiceMetadata implementation. - This implementation will be used if the service doesn't have a - IServiceMetadata implementation. - - - - - Gets the value of the Service Id. - - - - - Gets the dictionary that gives mapping of renamed operations - - - - - Response Unmarshaller for all Errors - - - - - Build an ErrorResponse from XML - - The XML parsing context. - Usually an Amazon.Runtime.Internal.UnmarshallerContext. - An ErrorResponse object. - - - - Return an instance of and ErrorResponseUnmarshaller. - - - - - - Interface for unmarshallers which unmarshall service responses. - The Unmarshallers are stateless, and only encode the rules for what data - in the XML stream goes into what members of an object. - - The type of object the unmarshaller returns - The type of the XML unmashaller context, which contains the - state of parsing the XML stream. Uaually an instance of - Amazon.Runtime.Internal.Transform.UnmarshallerContext. - - - - Extracts an exeption with data from an ErrorResponse. - - The XML parsing context. - An inner exception to be included with the returned exception - The HttpStatusCode from the ErrorResponse - Either an exception based on the ErrorCode from the ErrorResponse, or the - general service exception for the service in question. - - - - Interface for unmarshallers which unmarshall objects from response data. - The Unmarshallers are stateless, and only encode the rules for what data - in the XML stream goes into what members of an object. - - The type of object the unmarshaller returns - The type of the XML unmashaller context, which contains the - state during parsing of the XML stream. Usually an instance of - Amazon.Runtime.Internal.Transform.UnmarshallerContext. - - - - Given the current position in the XML stream, extract a T. - - The XML parsing context - An object of type T populated with data from the XML stream. - - - - Response Unmarshaller for all Errors - - - - - Build an ErrorResponse from json - - The json parsing context. - Usually an Amazon.Runtime.Internal.JsonUnmarshallerContext. - An ErrorResponse object. - - - - Return an instance of JsonErrorResponseUnmarshaller. - - - - - - Wraps a json string for unmarshalling. - - Each Read() operation gets the next token. - TestExpression() is used to match the current key-chain - to an xpath expression. The general pattern looks like this: - - JsonUnmarshallerContext context = new JsonUnmarshallerContext(jsonString); - while (context.Read()) - { - if (context.IsKey) - { - if (context.TestExpresion("path/to/element")) - { - myObject.stringMember = stringUnmarshaller.GetInstance().Unmarshall(context); - continue; - } - } - } - - - - - - Wrap the jsonstring for unmarshalling. - - Stream that contains the JSON for unmarshalling - If set to true, maintains a copy of the complete response body as the stream is being read. - Response data coming back from the request - - - - Are we at the start of the json document. - - - - - Is the current token the end of an object - - - - - Is the current token the start of an object - - - - - Returns the element depth of the parser's current position in the json - document being parsed. - - - - - The current Json path that is being unmarshalled. - - - - - Reads to the next token in the json document, and updates the context - accordingly. - - - True if a token was read, false if there are no more tokens to read. - - - - - Peeks at the next token. This peek implementation - reads the next token and makes the subsequent Read() return the same data. - If Peek is called successively, it will return the same data. - Only the first one calls Read(), subsequent calls - will return the same data until a Read() call is made. - - Token to peek. - Returns true if the peeked token matches given token. - - - - Returns the text contents of the current token being parsed. - - - The text contents of the current token being parsed. - - - - - The type of the current token - - - - - Get the base stream of the jsonStream. - - - - - Peeks at the next (non-whitespace) character in the jsonStream. - - The next (non-whitespace) character in the jsonStream, or -1 if at the end. - - - - Peeks at the next character in the stream. - If the data isn't buffered into the StreamReader (Peek() returns -1), - we flush the buffered data and try one more time. - - - - - - Abstract class for unmarshalling service responses. - - - - - Class for unmarshalling XML service responses. - - - - - Class for unmarshalling EC2 service responses. - - - - - Class for unmarshalling JSON service responses. - - - - - Unmarshaller for int fields - - - - - Unmarshaller for nullable int fields. Implemented only for JSON context - to handle cases where value can be null e.g. {'Priority': null}. - This unmarshaller is not implemented for XML context, as XML responses - will null elements (xsi:nil='true') will be skipped by the XML parser. - - - - - Unmarshaller for long fields - - - - - Unmarshaller for float fields - - - - - Unmarshaller for double fields - - - - - Unmarshaller for decimal fields - - - - - Unmarshaller for bool fields - - - - - Unmarshaller for string fields - - - - - Unmarshaller for byte fields - - - - - Unmarshaller for DateTime fields - - - - - Unmarshalls given string as a DateTime. Handles cases where we want to unmarshall - as just a DateTime or a nullable Datetime. - - Value to be parsed - If true, the method will return null if text is null. - If false, the method will return default(DateTime), if text is null. - - - - - Unmarshaller for nullable DateTime fields. Implemented only for JSON context - to handle cases where value can be null e.g. {'Priority': null}. - This unmarshaller is not implemented for XML context, as XML responses - will null elements (xsi:nil='true') will be skipped by the XML parser. - - - - - Unmarshaller for MemoryStream fields - - - - - Unmarshaller for ResponseMetadata - - - - - Base class for the UnmarshallerContext objects that are used - to unmarshall a web-service response. - - - - - Tests the specified expression against the current position in the XML - document - - The pseudo-XPath expression to test. - - True if the expression matches the current position in the document, - false otherwise. - - - - Tests the specified expression against the current position in the XML - document being parsed, and restricts the expression to matching at the - specified stack depth. - - The pseudo-XPath expression to test. - - The depth in the stack representing where the expression must - start matching in order for this method to return true. - - True if the specified expression matches the current position in - the XML document, starting from the specified depth. - - - - Reads the next token at depth greater than or equal to target depth. - - Tokens are read at depth greater than or equal to target depth. - True if a token was read and current depth is greater than or equal to target depth. - - - - The current path that is being unmarshalled. - - - - - Returns the element depth of the parser's current position in the - document being parsed. - - - - - Reads to the next node in the document, and updates the context accordingly. - - - True if a node was read, false if there are no more elements to read. - - - - - Returns the text contents of the current element being parsed. - - - The text contents of the current element being parsed. - - - - - True if NodeType is Element. - - - - - True if NodeType is EndElement. - - - - - True if the context is at the start of the document. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Wrap an XmltextReader for simulating an event stream. - - Each Read() operation goes either to the next element or next attribute within - the current element. TestExpression() is used to match the current event - to an xpath expression. The general pattern looks like this: - - UnmarshallerContext context = new UnmarshallerContext(...); - while (context.Read()) - { - if (context.TestExpresion("path/to/element")) - { - myObject.stringMember = stringUnmarshaller.GetInstance().Unmarshall(context); - continue; - } - if (context.TestExpression("path/to/@attribute")) - myObject.MyComplexTypeMember = MyComplexTypeUnmarshaller.GetInstance().Unmarshall(context); - } - - - - - - Wrap an XmlTextReader with state for event-based parsing of an XML stream. - - Stream with the XML from a service response. - If set to true, maintains a copy of the complete response body as the stream is being read. - Response data coming back from the request - - - - The current XML path that is being unmarshalled. - - - - - Returns the element depth of the parser's current position in the XML - document being parsed. - - - - - Reads to the next node in the XML document, and updates the context accordingly. - - - True if a node was read, false if there are no more elements to read./ - - - - - Returns the text contents of the current element being parsed. - - - The text contents of the current element being parsed. - - - - - True if NodeType is Element. - - - - - True if NodeType is EndElement. - - - - - True if the context is at the start of the document. - - - - - True if NodeType is Attribute. - - - - - Wrap an XmlTextReader with state for event-based parsing of an XML stream. - - Stream with the XML from a service response. - If set to true, maintains a copy of the complete response body as the stream is being read. - Response data coming back from the request - - - - RequestId value, if found in response - - - - - Reads to the next node in the XML document, and updates the context accordingly. - If node is RequestId, reads the contents and stores in RequestId property. - - - True if a node was read, false if there are no more elements to read./ - - - - - Constructs a new instance of the HttpWebRequestResponseData class with serialized data. - - The that holds the serialized object data. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - A stream which caches the contents of the underlying stream as it reads it. - - - - - All the bytes read by the stream. - - - - - Initializes the CachingWrapperStream with a base stream. - - The stream to be wrapped. - Maximum number of bytes to be cached. - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Gets a value indicating whether the current stream supports seeking. - CachingWrapperStream does not support seeking, this will always be false. - - - - - Gets or sets the position within the current stream. - CachingWrapperStream does not support seeking, attempting to set Position - will throw NotSupportedException. - - - - - Sets the position within the current stream. - CachingWrapperStream does not support seeking, attempting to call Seek - will throw NotSupportedException. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Stream wrapper that double-buffers from a wrapped stream and - returns the buffered content as a series of signed 'chunks' - for the AWS4 ('Signature V4') protocol. - - - - - Reads some or all of the processed chunk to the consumer, constructing - and streaming a new chunk if more input data is available. - - - - - - - - - Results of the header-signing portion of the request - - - - - Computed signature of the chunk prior to the one in-flight, in - hex - - - - - Computes the derived signature for a chunk of data of given length in the input buffer, - placing a formatted chunk with headers, signature and data into the output buffer - ready for streaming back to the consumer. - - - - - - Length override to return the true length of the payload plus the metainfo - supplied with each chunk - - - - - Computes the total size of the data payload, including the chunk metadata. - Called externally so as to be able to set the correct Content-Length header - value. - - - - - - - Computes the size of the header data for each chunk. - - - - - - - Attempt to read sufficient data for a whole chunk from the wrapped stream, - returning the number of bytes successfully read to be processed into a chunk - - - - - A list object that will always be sent to AWS services, - even if it is empty. - The AWS .NET SDK does not send empty collections to services, unless - the collection is of this type. - - - - - - A dictionary object that will always be sent to AWS services, - even if it is empty. - The AWS .NET SDK does not send empty collections to services, unless - the collection is of this type. - - - - - - - A wrapper stream that decrypts the base stream as it - is being read. - - - - - Initializes an DecryptStream with an decryption algorithm and a base stream. - - Stream to perform encryption on.. - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Gets a value indicating whether the current stream supports seeking. - DecryptStream does not support seeking, this will always be false. - - - - - Gets or sets the position within the current stream. - DecryptStream does not support seeking, attempting to set Position - will throw NotSupportedException. - - - - - Sets the position within the current stream. - DecryptStream does not support seeking, attempting to call Seek - will throw NotSupportedException. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Validates the underlying stream. - - - - - A wrapper stream that decrypts the base stream as it - is being read. - - - - - Initializes an DecryptStream with an decryption algorithm and a base stream. - - Stream to perform encryption on.. - Symmetric key to perform decryption - Initialization vector to perform decryption - - - - A wrapper stream that decrypts the base stream using AES algorithm as it - is being read. - - - - - Initializes an AESDecryptionStream with a base stream. - - Stream to perform decryption on.. - Symmetric key to perform decryption - Initialization vector to perform decryption - - - - Class to perform actions on a background thread. - Uses a single background thread and performs actions - on it in the order the data was sent through the instance. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Class to invoke actions on a background thread. - Uses a single background thread and invokes actions - on it in the order they were invoked through the instance. - - - - - A wrapper stream that encrypts the base stream as it - is being read. - - - - - Initializes an EncryptStream with an encryption algorithm and a base stream. - - Stream to perform encryption on.. - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Gets a value indicating whether the current stream supports seeking. - - - - - Returns encrypted content length. - - - - - Gets or sets the position within the current stream. - - - - - Sets the position within the current stream. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Validates the underlying stream. - - - - - A wrapper stream that encrypts the base stream as it - is being read. - - - - - Initializes an EncryptStream with an encryption algorithm and a base stream. - - Stream to perform encryption on.. - Symmetric key to perform encryption - Initialization vector to perform encryption - - - - A wrapper stream that encrypts the base stream using AES algorithm as it - is being read. - - - - - Initializes an AESEncryptionStream with a base stream. - - Stream to perform encryption on.. - Symmetric key to perform encryption - Initialization vector to perform encryption - - - - A wrapper stream that encrypts the base stream as it - is being read. - - - - - Initializes an EncryptStream for Multipart uploads with an encryption algorithm and a base stream. - - Stream to perform encryption on.. - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Gets a value indicating whether the current stream supports seeking. - - - - - Returns encrypted content length. - - - - - Gets or sets the position within the current stream. - - - - - Sets the position within the current stream. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Validates the underlying stream. - - - - - A wrapper stream that encrypts the base stream as it - is being read. - - - - - Initializes an EncryptStream with an encryption algorithm and a base stream. - - Stream to perform encryption on.. - Symmetric key to perform encryption - Initialization vector to perform encryption - - - - A wrapper stream that encrypts the base stream as it - is being read. - - - - - Initializes an AESEncryptionStream with a base stream. - - Stream to perform encryption on.. - Symmetric key to perform encryption - Initialization vector to perform encryption - - - - Returns true if the Content is set or there are - query parameters. - - This request - True if data is present; false otherwise. - - - - Utilities for dealing with Guids - - - - - Hashes a set of objects. - - - - - - - Combines a set of hashses. - - - - - - - Combines two hashes. - - - - - - - - Disposes of all managed and unmanaged resources. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - A wrapper stream that calculates a hash of the base stream as it - is being read. - The calculated hash is only available after the stream is closed or - CalculateHash is called. After calling CalculateHash, any further reads - on the streams will not change the CalculatedHash. - If an ExpectedHash is specified and is not equal to the calculated hash, - Close or CalculateHash methods will throw an AmazonClientException. - If CalculatedHash is calculated for only the portion of the stream that - is read. - - - Exception thrown during Close() or CalculateHash(), if ExpectedHash is set and - is different from CalculateHash that the stream calculates, provided that - CalculatedHash is not a zero-length byte array. - - - - - Algorithm to use to calculate hash. - - - - - True if hashing is finished and no more hashing should be done; - otherwise false. - - - - - Current position in the stream. - - - - - Calculated hash for the stream. - This value is set only after the stream is closed. - - - - - Expected hash value. Compared against CalculatedHash upon Close(). - If the hashes are different, an AmazonClientException is thrown. - - - - - Expected length of stream. - - - - - Initializes an HashStream with a hash algorithm and a base stream. - - Stream to calculate hash for. - - Expected hash. Will be compared against calculated hash on stream close. - Pass in null to disable check. - - - Expected length of the stream. If the reading stops before reaching this - position, CalculatedHash will be set to empty array. - - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Closes the underlying stream and finishes calculating the hash. - If an ExpectedHash is specified and is not equal to the calculated hash, - this method will throw an AmazonClientException. - - - If ExpectedHash is set and is different from CalculateHash that the stream calculates. - - - - - Gets a value indicating whether the current stream supports seeking. - HashStream does not support seeking, this will always be false. - - - - - Gets or sets the position within the current stream. - HashStream does not support seeking, attempting to set Position - will throw NotSupportedException. - - - - - Sets the position within the current stream. - HashStream does not support seeking, attempting to call Seek - will throw NotSupportedException. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Gets the overridden length used to construct the HashStream - - - - - Calculates the hash for the stream so far and disables any further - hashing. - - - - - Resets the hash stream to starting state. - Use this if the underlying stream has been modified and needs - to be rehashed without reconstructing the hierarchy. - - - - - Validates the underlying stream. - - - - - Compares two hashes (arrays of bytes). - - Expected hash. - Actual hash. - - True if the hashes are identical; otherwise false. - - - - - A wrapper stream that calculates a hash of the base stream as it - is being read or written. - The calculated hash is only available after the stream is closed or - CalculateHash is called. After calling CalculateHash, any further reads - on the streams will not change the CalculatedHash. - If an ExpectedHash is specified and is not equal to the calculated hash, - Close or CalculateHash methods will throw an AmazonClientException. - If base stream's position is not 0 or HashOnReads is true and the entire stream is - not read, the CalculatedHash will be set to an empty byte array and - comparison to ExpectedHash will not be made. - - - Exception thrown during Close() or CalculateHash(), if ExpectedHash is set and - is different from CalculateHash that the stream calculates, provided that - CalculatedHash is not a zero-length byte array. - - - - - Initializes an HashStream with a hash algorithm and a base stream. - - Stream to calculate hash for. - - Expected hash. Will be compared against calculated hash on stream close. - Pass in null to disable check. - - - Expected length of the stream. If the reading stops before reaching this - position, CalculatedHash will be set to empty array. - - - - - A wrapper stream that calculates an MD5 hash of the base stream as it - is being read or written. - The calculated hash is only available after the stream is closed or - CalculateHash is called. After calling CalculateHash, any further reads - on the streams will not change the CalculatedHash. - If an ExpectedHash is specified and is not equal to the calculated hash, - Close or CalculateHash methods will throw an AmazonClientException. - If base stream's position is not 0 or HashOnReads is true and the entire stream is - not read, the CalculatedHash will be set to an empty byte array and - comparison to ExpectedHash will not be made. - - - Exception thrown during Close() or CalculateHash(), if ExpectedHash is set and - is different from CalculateHash that the stream calculates, provided that - CalculatedHash is not a zero-length byte array. - - - - - Initializes an MD5Stream with a base stream. - - Stream to calculate hash for. - - Expected hash. Will be compared against calculated hash on stream close. - Pass in null to disable check. - - - Expected length of the stream. If the reading stops before reaching this - position, CalculatedHash will be set to empty array. - - - - - Utilities for validating label values for host prefix templates - - - - - Validates a label value - - - - - Provides read/write access to a file in the INI format. - - This class is not threadsafe. - - - - - Construct a new IniFile. - - path of the IniFile - - - - the path of the file - - - - - helper to access the lines of the file - - - - - Persist the changes to this INI file to disk. - - - - - Rename the section fromSectionName to toSectionName - - - - - - - Rename the section fromSectionName to toSectionName - - - - if true and destination section already exists overwrite it - - - - Copy the section fromSectionName to toSectionName - - - - Any properties in the original section that are also in this dictionary will - be replaced by the value from this dictionary. - - - - Copy the section fromSectionName to toSectionName - - - - Any properties in the original section that are also in this dictionary will - be replaced by the value from this dictionary. - if true and destination section already exists overwrite it - - - - Update the section with the properties given. - If the section doesn't exist, it will be appended to the file. - - Notes: - 1. Any properties that do exist in the section will be updated. - 2. A null value for a property denotes that it should be deleted from the section - 3. If any properties don't exist they will be appended to the end of the section - in the same order they appear in the SortedDictionary. - - name of the section to operate on - properties to add/update/delete - - - - Check if the section exists. If not, append it to the end of the file. - - section to ensure exists - - - - If the section exists, delete it from the INI file. - - section to delete - - - - Determine if a section exists in the INI file. - - name of section to look for - true if the section exists, false otherwise - - - - Return the properties for the section if it exists. - - name of section to get - properties contained in the section - True if the section was found, false otherwise - - - - Return the properties for the section if it exists. - - Regex to match name of section to get - properties contained in the section - True if the section was found, false otherwise - - - - Return the properties for the section if it exists. - - Regex to match name of section to get - name of section if regex matches - properties contained in the section - True if the section was found, false otherwise - - - - Simple wrapper around the log4net Error method. - - - - - - - - Write debug message to Console - - - - - - - - Write debug message to Console - - - - - - - Simple wrapper around the log4net InfoFormat method. - - - - - - - This is a dynamic wrapper around log4net so we can avoid log4net being required - to be distributed with the SDK. - - - - - Abstract logger class, base for any custom/specific loggers. - - - - - Flushes the logger contents. - - - - - Simple wrapper around the log4net IsErrorEnabled property. - - - - - Simple wrapper around the log4net IsDebugEnabled property. - - - - - Simple wrapper around the log4net IsInfoEnabled property. - - - - - Simple wrapper around the log4net Error method. - - - - - - - - Simple wrapper around the log4net Debug method. - - - - - - - - Simple wrapper around the log4net DebugFormat method. - - - - - - - Simple wrapper around the log4net InfoFormat method. - - - - - - - Logger wrapper for System.Diagnostics.TraceSource logger. - - - - - Creates TraceRoute for a given Type or the closest "parent" that has a listener configured. - Example: if type is Amazon.DynamoDB.AmazonDynamoDBClient, listeners can be configured for: - -Amazon.DynamoDB.AmazonDynamoDBClient - -Amazon.DynamoDB - -Amazon - The first matching TraceSource with listeners will be used. - If no listeners are configured for type or one of its "parents", will return null. - - - - - Gets a TraceSource for given Type with SourceLevels.All. - If there are no listeners configured for targetType or one of its "parents", returns null. - - - - - - - Gets a TraceSource for given Type and SourceLevels. - If there are no listeners configured for targetType or one of its "parents", returns null. - - - - - - - - Logger wrapper for reflected log4net logging methods. - - - - - This should be a one time call to use reflection to find all the types and methods - needed for the logging API. - - - - - Simple wrapper around the log4net IsErrorEnabled property. - - - - - Simple wrapper around the log4net Error method. - - - - - - - - Simple wrapper around the log4net IsDebugEnabled property. - - - - - Simple wrapper around the log4net Debug method. - - - - - - - - Simple wrapper around the log4net DebugFormat method. - - - - - - - Simple wrapper around the log4net IsInfoEnabled property. - - - - - Simple wrapper around the log4net InfoFormat method. - - - - - - - A single logged message - - - - - Log message arguments. - - - - - Culture-specific formatting provider. - - - - - Log message format. - - - - - a size-limited cache of key value pairs - - Once the maximum size has been reached, the least recently - used pairs will be evicted to make room for any new items. - - - - - - - the maximum number of entries this LruCache will hold - before items begin getting evicted - - - - - the number of items in the cache - - - - - Construct a new LruCache. - - maximum number of entries before items are evicted - - - - Add the key/value pair to the cache, or update - the value if the key already exists. - - If the cache is full, evicts the least recently used item. - - - - - - - Evicts a specific key out of the cache if it exists - - the key to evict from the cache - - - - Try to get the value associated with the key. - - the key to look up - the value, if the key exists - true if there is a value associated with the key, or false if no value is associated with the key - - - - Try to get the value associated with the key, if it doesn't exist, use the provided factory method to - create a new value and tries adding it to the cache. - - the key to look up - the factory method used in case the key is not present in the cache - the looked up value or the value created by the factory - - - - Clear the LruCache of all entries. - - - - - Helper class to support LruCache. - Does not implement the error checking and synchronization that - would be necessary for it to stand alone. - - - - - Item to be stored in the LruList - linked list structure. - - - - - Collection of properties being tracked - - - - - Timings for metrics being tracked - - - - - Counters being tracked - - - - - Whether metrics are enabled for the request - - - - - Constructs an empty, disabled metrics object - - - - - Starts timing an event. Logs an exception if an event - of the same type was started but not stopped. - - - - - - - Stops timing an event. Logs an exception if the event wasn't started. - - - - - - - Adds a property for a metric. If there are multiple, the - object is added as a new item in a list. - - - - - - - Sets a counter for a specific metric. - - - - - - - Increments a specific metric counter. - If counter doesn't exist yet, it is set to 1. - - - - - - Returns errors associated with the metric, including - if there are still any timing events in-flight. - - - - - - Returns a string representation of the current metrics. - - - - - - Return a JSON represenation of the current metrics - - - - - - Timing information for a metric - - - - - Empty, stopped timing object - - - - - Timing object in a started state - - - - - - Stops timing - - - - - - Whether the timing has been stopped - - - - - Elapsed ticks from start to stop. - If timing hasn't been stopped yet, returns 0. - - - - - Elapsed time from start to stop. - If timing hasn't been stopped yet, returns TimeSpan.Zero - - - - - Timing event, stops timing of a metric when disposed - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - The destructor for the client class. - - - - - A wrapper stream which supresses disposal of the underlying stream. - - - - - Constructor for NonDisposingWrapperStream. - - The base stream to wrap. - - - - The Close implementation for this wrapper stream - does not close the underlying stream. - - - - - The Dispose implementation for this wrapper stream - does not close the underlying stream. - - - - - Provides line-based read/write access to a file. - The file can be read into memory, changed, then written back to disk. - When the file is persisted back to disk, an optimistic concurrency - check is performed to make sure the file hasn't changed since it was - originally read. - - This class is not threadsafe. - - - - - a full copy of the original file - This is used for optimistic concurrency. - Note that this assumes a small file and does not scale large files. - - - - - path of the file - - - - - Read/write access to the lines that make up the file. - Any changes to this List are persisted back to disk when Persist() is called. - - NOTE: - The lines have the original line endings on them to preserve the - original text as much as possible. - - - - - Construct a new OptimisticLockedTextFile. - - path of the file - - - - Persist changes to disk after an optimistic concurrency check is completed. - - - - - This class is used to wrap a stream for a particular segment of a stream. It - makes that segment look like you are reading from beginning to end of the stream. - - - - - Subclass of IniFile that allows INI sections to be read with the profile keyword in front of the section name. - - - - - Wrapper stream that only supports reading - - - - - Partial wrapper stream that only supports reading - - - - - Uri wrapper that can parse out information (bucket, key, region, style) from an - S3 URI. - - - - - True if the URI contains the bucket in the path, false if it contains the bucket in the authority. - - - - - The bucket name parsed from the URI (or null if no bucket specified). - - - - - The key parsed from the URI (or null if no key specified). - - - - - The region parsed from the URI (or null if no region specified). - - - - - Constructs a parser for the S3 URI specified as a string. - - The S3 URI to be parsed. - - - - Constructs a parser for the S3 URI specified as a Uri instance. - - The S3 URI to be parsed. - - - - Percent-decodes the given string, with a fast path for strings that are not - percent-encoded. - - The string to decode - The decoded string - - - - Percent-decodes the given string. - - The string to decode - The index of the first '%' in the string - The decoded string - - - - Decodes the percent-encoded character at the given index in the string - and appends the decoded value to the string under construction. - - - The string under construction to which the decoded character will be - appended. - - The string being decoded. - The index of the '%' character in the string. - - - - Converts a hex character (0-9A-Fa-f) into its corresponding quad value. - - The hex character - The quad value - - - - Interface for a non-generic cache. - - - - - Clears the entire cache. - - - - - Maximum time to keep an item around after its last use. - - - - - How often should the cache be cleared of old items. - - - - - The number of items in the cache. - - - - - Interface for a generic cache. - - - - - - - Retrieves a value out of the cache or from the source. - - - - - - - - Retrieves a value out of the cache or from the source. - If the item was in the cache, isStaleItem is set to true; - otherwise, if the item comes from the source, isStaleItem is false. - - - - - - - - - Clears a specific value from the cache if it's there. - - - - - - Returns the keys for all items in the cache. - - - - - - Executes specified operation, catches exception, clears the cache for - the given key, retries the operation. - - - - - - - - - - - SDK-wide cache. - Provides access to caches specific to a particular set of credentials - and target region. - - - - - Clear all caches - - - - - Clear all caches of a particular type - - - - - - Retrieve a cache of a specific type for a client object. - The client object can be null in cases where a cache does - not correspond to a specific AWS account or target region. - - - - - - - - - - - Retrieve a cache of a specific type for a client object. - The client object can be null in cases where a cache does - not correspond to a specific AWS account or target region. - - - - - - - - - - - Utilities for converting objects to strings. Used by the marshaller classes. - - - - - Converts a DateTime to ISO8601 formatted string. - - - - - Converts a DateTime to RFC822 formatted string. - - - - - Converts a DateTime to Unix epoch time formatted string. - - - - - A wrapper stream. - - - - - Base stream. - - - - - Initializes WrapperStream with a base stream. - - - - - - Returns the first base non-WrapperStream. - - First base stream that is non-WrapperStream. - - - - Returns the first base non-WrapperStream. - - First base stream that is non-WrapperStream. - - - - Returns the first base non-WrapperStream. - - Potential WrapperStream - Base non-WrapperStream. - - - - Gets a value indicating whether the current stream supports reading. - True if the stream supports reading; otherwise, false. - - - - - Gets a value indicating whether the current stream supports seeking. - True if the stream supports seeking; otherwise, false. - - - - - Gets a value indicating whether the current stream supports writing. - True if the stream supports writing; otherwise, false. - - - - - Closes the current stream and releases any resources (such as sockets and - file handles) associated with the current stream. - - - - - Gets the length in bytes of the stream. - - - - - Gets or sets the position within the current stream. - - - - - Gets or sets a value, in miliseconds, that determines how long the stream - will attempt to read before timing out. - - - - - Gets or sets a value, in miliseconds, that determines how long the stream - will attempt to write before timing out. - - - - - Clears all buffers for this stream and causes any buffered data to be written - to the underlying device. - - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Sets the position within the current stream. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Sets the length of the current stream. - - The desired length of the current stream in bytes. - - - - Writes a sequence of bytes to the current stream and advances the current - position within this stream by the number of bytes written. - - - An array of bytes. This method copies count bytes from buffer to the current stream. - - - The zero-based byte offset in buffer at which to begin copying bytes to the - current stream. - - The number of bytes to be written to the current stream. - - - - Collection of parameters that an SDK client will send to a service. - - - - - Constructs empty ParameterCollection. - - - - - Adds a parameter with a string value. - - - - - - - Adds a parameter with a list-of-strings value. - - - - - - - Converts the current parameters into a list of key-value pairs. - - - - - - Property to denote that the last exception returned by an AWS Service - was retryable or not. - - - - - This handler processes exceptions thrown from the HTTP handler and - unmarshalls error responses. - - - - - Default set of exception handlers. - - - - - Default set of exception handlers. - - - - - Constructor for ErrorHandler. - - an ILogger instance. - - - - Handles and processes any exception thrown from underlying handlers. - - The execution context which contains both the - requests and response context. - - - - Handles and processes any exception thrown from underlying handlers. - - The execution context, it contains the - request and response context. - - - - Disposes the response body. - - The response context. - - - - Processes an exception by invoking a matching exception handler - for the given exception. - - The execution context, it contains the - request and response context. - The exception to be processed. - - This method returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception that may be thrown by exception - processing by a matching exception handler. - - - - - The abstract base class for exception handlers. - - The exception type. - - - - The exception handler for HttpErrorResponseException exception. - - - - - The constructor for HttpErrorResponseExceptionHandler. - - in instance of ILogger. - - - - Handles an exception for the given execution context. - - The execution context, it contains the - request and response context. - The exception to handle. - - Returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception to replace the original exception. - - - - - Checks if a HTTP 404 status code is returned which needs to be suppressed and - processes it. - If a suppressed 404 is present, it unmarshalls the response and returns true to - indicate that a suppressed 404 was processed, else returns false. - - The execution context, it contains the - request and response context. - - - If a suppressed 404 is present, returns true, else returns false. - - - - - The exception handler for HttpErrorResponseException exception. - - - - - A pipeline handler which provides hooks to run - external code in the pre-invoke and post-invoke phases. - - - - - Action to execute on the pre invoke phase. - - - - - Action to execute on the post invoke phase. - - - - - Calls the PreInvoke and PostInvoke methods before and after calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls the PreInvoke method before calling the next handler in the pipeline. - - The execution context which contains both the - requests and response context. - IAsyncResult which represent an async operation. - - - - Calls the PostInvoke methods after calling the next handler - in the pipeline. - - The execution context, it contains the - request and response context. - - - - Executes the OnPreInvoke action as part of pre-invoke. - - The execution context, it contains the - request and response context. - - - - Executes the OnPreInvoke action as part of post-invoke. - - The execution context, it contains the - request and response context. - - - - This handler retrieved the AWS credentials to be used for the current call. - - - - - The constructor for CredentialsRetriever. - - An AWSCredentials instance. - - - - Retrieves the credentials to be used for the current call before - invoking the next handler. - - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - IAsyncResult which represent an async operation. - - - - The CSM handler has the logic for capturing data for CSM attempts when enabled. - - - - - Invokes the CSM handler and captures data for the CSM attempts. - - - - - Invokes the CSM handler and captures data for the CSM attempts. - - - - - Method that gets called in the final clause that captures data for each http request - from the request and response context. - - - - - Executes the OnPreInvoke action as part of pre-invoke. - - - - - Method to collect data in case of connection exception - - - - - Method to collect data in case of Amazon service exception - - - - - The CSM handler has the logic for capturing data for CSM events when enabled. - - - - - Invokes the CSM handler and captures data for the CSM events. - - - - - Invokes the CSM handler and captures data for the CSM events. - - - - - Invoked from the finally block of CSMCallEventHandler's Invoke method. - This method is used to capture CSM Call event metrics. - - - - - - Method that gets invoked in case of an exception in the API request completion. - - - - - - - This handler resolves the endpoint to be used for the current request. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Invokes the inner handler - - The execution context which contains both the - requests and response context. - - - - Resolves the endpoint to be used for the current request - before invoking the next handler. - - The execution context, it contains the - request and response context. - - - - This handler resolves the endpoint to be used for the current request. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - IAsyncResult which represent an async operation. - - - - Resolves the endpoint to be used for the current request - before invoking the next handler. - - The execution context, it contains the - request and response context. - - - - Determines the endpoint for the request. - - The request context. - - - - - This handler provides an OnError action that can be used as hook for - external code to handle exceptions in the runtime pipeline. - - - - - Action to execute if an exception occurs during the - execution of any underlying handlers. - - - - - Executes the OnError action if an exception occurs during the - execution of any underlying handlers. - - - - - - - This handler marshalls the request before calling invoking the next handler. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - IAsyncResult which represent an async operation. - - - - Marshalls the request before calling invoking the next handler. - - The execution context, it contains the - request and response context. - - - - This handler manages the metrics used to time the complete call and - logs the final metrics. - - - - - Captures the overall execution time and logs final metrics. - - The execution context which contains both the - requests and response context. - - - - Captures the overall execution time. - - The execution context which contains both the - requests and response context. - IAsyncResult which represent an async operation. - - - - Captures the overall execution time and logs final metrics. - - The execution context, it contains the - request and response context. - - - - This handler processes HTTP redirects and reissues the call to the - redirected location. - - - - - Processes HTTP redirects and reissues the call to the - redirected location. - - The execution context which contains both the - requests and response context. - - - - Processes HTTP redirects and reissues the call to the - redirected location. - - The execution context, it contains the - request and response context. - - - - Checks if an HTTP 307 (temporary redirect) has occured and changes the - request endpoint to the redirected location. - - - The execution context, it contains the request and response context. - - - A boolean value that indicates if a redirect has occured. - - - - - This handler signs the request. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - IAsyncResult which represent an async operation. - - - - Signs the request before invoking the next handler. - - - The execution context, it contains the request and response context. - - - - - Determines if the request should be signed. - - The request context. - A boolean value that indicated if the request should be signed. - - - - Signs the request. - - The request context. - - - - This handler unmarshalls the HTTP response. - - - - - The constructor for Unmarshaller. - - - Boolean value which indicated if the unmarshaller - handler supports response logging. - - - - - Unmarshalls the response returned by the HttpHandler. - - The execution context which contains both the - requests and response context. - - - - Unmarshalls the response returned by the HttpHandler. - - The execution context, it contains the - request and response context. - - - - Unmarshalls the HTTP response. - - - The execution context, it contains the request and response context. - - - - - Constructs a new instance of the HttpErrorResponseException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - The HTTP handler contains common logic for issuing an HTTP request that is - independent of the underlying HTTP infrastructure. - - - - - - The sender parameter used in any events raised by this handler. - - - - - The constructor for HttpHandler. - - The request factory used to create HTTP Requests. - The sender parameter used in any events raised by this handler. - - - - Issues an HTTP request for the current request context. - - The execution context which contains both the - requests and response context. - - - - Issues an HTTP request for the current request context. - - The execution context which contains both the - requests and response context. - IAsyncResult which represent an async operation. - - - - Determines the content for request body and uses the HTTP request - to write the content to the HTTP request body. - - Content to be written. - The HTTP request. - The request context. - - - - Creates the HttpWebRequest and configures the end point, content, user agent and proxy settings. - - The async request. - The web request that actually makes the call. - - - - Disposes the HTTP handler. - - - - - The request factory for System.Net.HttpWebRequest. - - - - - Some AWS services like Cloud 9 require at least TLS 1.1. Version of .NET Framework 4.5 and earlier - do not eanble TLS 1.1 and TLS 1.2 by default. This code adds those protocols if using an earlier - version of .NET that explicitly set the protocol and didn't have TLS 1.1 and TLS 1.2. - - - - - - Some AWS services like Cloud 9 require at least TLS 1.1. Version of .NET Framework 4.5 and earlier - do not eanble TLS 1.1 and TLS 1.2 by default. This code adds those protocols if using an earlier - version of .NET that explicitly set the protocol and didn't have TLS 1.1 and TLS 1.2. - - - - - - - Creates an HTTP request for the given URI. - - The request URI. - An HTTP request. - - - - This method is used for unit testing purposes. It allows setting of the flag - that indicates protocol setting was attempted. - - The new value - - - - Disposes the HttpWebRequestFactory. - - - - - HTTP request wrapper for System.Net.HttpWebRequest. - - - - - Constructor for HttpRequest. - - The request URI. - - - - The underlying HTTP web request. - - - - - The HTTP method or verb. - - - - - The request URI. - - - - - Returns the HTTP response. - - The HTTP response. - - - - Gets a handle to the request content. - - The request content. - - - - Writes a stream to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - The request context. - - - - Writes a byte array to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - - - - Aborts the HTTP request. - - - - - Initiates the operation to gets a handle to the request content. - - The async callback invoked when the operation completes. - The state object to be passed to the async callback. - IAsyncResult that represents an async operation. - - - - Ends the operation to gets a handle to the request content. - - IAsyncResult that represents an async operation. - The request content. - - - - Initiates the operation to Returns the HTTP response. - - The async callback invoked when the operation completes. - The state object to be passed to the async callback. - IAsyncResult that represents an async operation. - - - - Ends the operation to Returns the HTTP response. - - IAsyncResult that represents an async operation. - The HTTP response. - - - - Configures a request as per the request context. - - The request context. - - - - Sets the headers on the request. - - A dictionary of header names and values. - - - - Disposes the HttpRequest. - - - - - Sets up the progress listeners - - The content stream - The interval at which progress needs to be published - The objects which is trigerring the progress changes - The callback which will be invoked when the progress changed event is trigerred - an object, incase the progress is setup, else returns the original stream - - - - An abstract pipeline handler that has implements IPipelineHandler, - and has the default implmentation. This is the base class for most of - the handler implementations. - - - - - The logger used to log messages. - - - - - The inner handler which is called after the current - handler completes it's processing. - - - - - The outer handler which encapsulates the current handler. - - - - - Contains the processing logic for a synchronous request invocation. - This method calls InnerHandler.InvokeSync to continue processing of the - request by the pipeline. - - The execution context which contains both the - requests and response context. - - - - Contains the processing logic for an asynchronous request invocation. - This method should calls InnerHandler.InvokeSync to continue processing of the - request by the pipeline. - - The execution context which contains both the - requests and response context. - IAsyncResult which represent an async operation. - - - - This callback method is called by the callback method of the inner handler - as part of asynchronous processing after any underlying asynchronous - operations complete. - - The execution context, it contains the - request and response context. - - - - This callback method contains the processing logic that should be executed - after the underlying asynchronous operation completes. - This method is called as part of a callback chain which starts - from the InvokeAsyncCallback method of the bottommost handler and then invokes - each callback method of the handler above it. - This method calls OuterHandler.AsyncCallback to continue processing of the - request by the pipeline, unless it's the topmost handler. - - The execution context, it contains the - request and response context. - - - - Logs the metrics for the current execution context. - - The execution context, it contains the - request and response context. - - - - The default implementation of the retry policy. - - - - - The maximum value of exponential backoff in milliseconds, which will be used to wait - before retrying a request. - - - - - List of HTTP Status codes codes which are returned as part of the error response. - These status codes will be retried. - - - - - List of AWS specific error codes which are returned as part of the error response. - These error codes will be retried. - - - - - List of WebExceptionStatus for a WebException which will be retried. - - - - - Constructor for DefaultRetryPolicy. - - The maximum number of retries before throwing - back a exception. This does not count the initial request. - - - - Constructor for DefaultRetryPolicy. - - The Client config object. This is used to - retrieve the maximum number of retries before throwing - back a exception(This does not count the initial request) and - the service URL for the request. - - - - Returns true if the request is in a state where it can be retried, else false. - - Request context containing the state of the request. - Returns true if the request is in a state where it can be retried, else false. - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - - - - Virtual method that gets called on a success Response. If its a retry success response, the entire - retry acquired capacity is released(default is 5). If its just a success response a lesser value capacity - is released(default is 1). - - Request context containing the state of the request. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Request context containing the state of the request. - Return true if the request should be retried. - - - - Checks if the retry limit is reached. - - Request context containing the state of the request. - Return false if the request can be retried, based on number of retries. - - - - Waits before retrying a request. The default policy implements a exponential backoff. - - Request context containing the state of the request. - - - - The retry handler has the generic logic for retrying requests. - It uses a retry policy which specifies when - a retry should be performed. - - - - - The logger used to log messages. - - - - - The retry policy which specifies when - a retry should be performed. - - - - - Constructor which takes in a retry policy. - - Retry Policy - - - - Invokes the inner handler and performs a retry, if required as per the - retry policy. - - The execution context which contains both the - requests and response context. - - - - Invokes the inner handler and performs a retry, if required as per the - retry policy. - - The execution context which contains both the - requests and response context. - - - - Prepares the request for retry. - - Request context containing the state of the request. - - - - A runtime pipeline contains a collection of handlers which represent - different stages of request and response processing. - - - - - The top-most handler in the pipeline. - - - - - Constructor for RuntimePipeline. - - The handler with which the pipeline is initalized. - - - - Constructor for RuntimePipeline. - - List of handlers with which the pipeline is initalized. - - - - Constructor for RuntimePipeline. - - List of handlers with which the pipeline is initalized. - The logger used to log messages. - - - - Constructor for RuntimePipeline. - - The handler with which the pipeline is initalized. - The logger used to log messages. - - - - Invokes the pipeline synchronously. - - Request context - Response context - - - - Invokes the pipeline asynchronously. - - Request context - IAsyncResult which represents the in progress asynchronous operation. - - - - Adds a new handler to the top of the pipeline. - - The handler to be added to the pipeline. - - - - Adds a handler after the first instance of handler of type T. - - Type of the handler after which the given handler instance is added. - The handler to be added to the pipeline. - - - - Adds a handler before the first instance of handler of type T. - - Type of the handler before which the given handler instance is added. - The handler to be added to the pipeline. - - - - Removes the first occurance of a handler of type T. - - Type of the handler which will be removed. - - - - Replaces the first occurance of a handler of type T with the given handler. - - Type of the handler which will be replaced. - The handler to be added to the pipeline. - - - - Inserts the given handler after current handler in the pipeline. - - Handler to be inserted in the pipeline. - Handler after which the given handler is inserted. - - - - Gets the innermost handler by traversing the inner handler till - it reaches the last one. - - - - - Retrieves a list of handlers, in the order of their execution. - - Handlers in the current pipeline. - - - - Retrieves current handlers, in the order of their execution. - - Handlers in the current pipeline. - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Provides information for Client Context header. - Client Context header needs information like App title, version code, version name, package name etc. - - - - - The title of your app. For example, "My App". - If this property is not null, the value would be used in Client Context header. - - - - - The version for your app. For example, V3.0. - If this property is not null, the value would be used in Client Context header. - - - - - The version code of your app. For example, 3.0. - If this property is not null, the value would be used in Client Context header. - - - - - The name of your app package. For example, com.your_company.your_app. - If this property is not null, the value would be used in Client Context header. - - - - - The operating system of the device. For example, iPhoneOS. - If this property is not null, the value would be used in Client Context header. - - - - - The version of the operating system of the device. For example, 8.1. - If this property is not null, the value would be used in Client Context header. - - - - - The locale of the device. For example, en_US. - If this property is not null, the value would be used in Client Context header. - - - - - The manufacturer of the device. For example, Samsung. - If this property is not null, the value would be used in Client Context header. - - - - - The model of the device. For example, Nexus. - If this property is not null, the value would be used in Client Context header. - - - - - This class is the base class of all the configurations settings to connect - to a service. - - - This class is the base class of all the configurations settings to connect - to a service. - - - - - Gets Service Version - - - - - Gets and sets of the signatureMethod property. - - - - - Gets and sets of the SignatureVersion property. - - Note: This property exists for backward compatibility but is no longer - used by any service other than S3. - - - - - Gets and sets of the UserAgent property. - - - - - Gets and sets the RegionEndpoint property. The region constant that - determines the endpoint to use. - - Setting this property to null will force the SDK to recalculate the - RegionEndpoint value based on App/WebConfig, environment variables, - profile, etc. - - - - - The constant used to lookup in the region hash the endpoint. - - - - - Gets and sets of the ServiceURL property. - This is an optional property; change it - only if you want to try a different service - endpoint. - - - - - Gets and sets the UseHttp. - If this property is set to true, the client attempts - to use HTTP protocol, if the target endpoint supports it. - By default, this property is set to false. - - - - - Given this client configuration, return a string form ofthe service endpoint url. - - - - - Gets and sets the AuthenticationRegion property. - Used in AWS4 request signing, this is an optional property; - change it only if the region cannot be determined from the - service endpoint. - - - - - Gets and sets the AuthenticationServiceName property. - Used in AWS4 request signing, this is the short-form - name of the service being called. - - - - - Gets and sets of the MaxErrorRetry property. - - - - - Gets and sets the LogResponse property. - If this property is set to true, the service response is logged. - The size of response being logged is controlled by the AWSConfigs.LoggingConfig.LogResponsesSizeLimit property. - - - - - Gets and sets the ReadEntireResponse property. - NOTE: This property does not effect response processing and is deprecated. - To enable response logging, the ClientConfig.LogResponse and AWSConfigs.LoggingConfig - properties can be used. - - - - - Gets and Sets the BufferSize property. - The BufferSize controls the buffer used to read in from input streams and write - out to the request. - - - - - - Gets or sets the interval at which progress update events are raised - for upload operations. By default, the progress update events are - raised at every 100KB of data transferred. - - - If the value of this property is set less than ClientConfig.BufferSize, - progress updates events will be raised at the interval specified by ClientConfig.BufferSize. - - - - - - Flag on whether to resign requests on retry or not. - For Amazon S3 and Amazon Glacier this value will always be set to true. - - - - - This flag controls if .NET HTTP infrastructure should follow redirection - responses (e.g. HTTP 307 - temporary redirect). - - - - - Flag on whether to log metrics for service calls. - - This can be set in the application's configs, as below: - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSLogMetrics" value"true"/> - </appSettings> - </configuration> - - - - - - Gets and sets the DisableLogging. If true logging for this client will be disabled. - - - - - Credentials to use with a proxy. - - - - - Specifies the TCP keep-alive values to use for service requests. - - - - - - If the value is set, the value is assigned to the Timeout property of the HttpWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Configures the endpoint calculation for a service to go to a dual stack (ipv6 enabled) endpoint - for the configured region. - - - Note: AWS services are enabling dualstack endpoints over time. It is your responsibility to check - that the service actually supports a dualstack endpoint in the configured region before enabling - this option for a service. - - - - - Enable or disable the Retry Throttling feature by setting the ThrottleRetries flag to True/False resepctively. - Retry Throttling is a feature that intelligently throttles retry attempts when a large precentage of requests - are failing and retries are unsuccessful as well. In such situations the allotted retry capacity for the service URL - will be drained until requests start to succeed again. Once the requisite capacity is available, retries would - be permitted again. When retries are throttled, the service enters a fail-fast behaviour as the traditional retry attempt - for the request would be circumvented. Hence, errors will resurface quickly. This will result in a greated number of exceptions - but prevents requests being tied up in unsuccessful retry attempts. - Note: Retry Throttling is enabled by default. Set the ThrottleRetries flag to false to switch off this feature. - - - - - Enable or disable the Nagle algorithm on the underlying http - client. - - This method is not intended to be called by consumers of the AWS SDK for .NET - - - - - - Performs validation on this config object. - Throws exception if any of the required values are missing/invalid. - - - - - Returns the current UTC now after clock correction for this endpoint. - - - - - The calculated clock skew correction for a specific endpoint, if there is one. - This field will be set if a service call resulted in an exception - and the SDK has determined that there is a difference between local - and server times. - - If is set to true, this - value will still be set to the correction, but it will not be used by the - SDK and clock skew errors will not be retried. - - - - - Gets and sets the DisableHostPrefixInjection flag. If true, host prefix injection will be disabled for this client, the default value of this flag is false. - Host prefix injection prefixes the service endpoint with request members from APIs which use this feature. - Example: for a hostPrefix of "foo-name." and a endpoint of "service.region.amazonaws.com" the default behavior is to - prefix the endpoint with the hostPrefix resulting in a final endpoint of "foo-name.service.region.amazonaws.com". Setting - DisableHostPrefixInjection to true will disable hostPrefix injection resulting in a final endpoint of - "service.region.amazonaws.com" regardless of the value of hostPrefix. E.g. You may want to disable host prefix injection for testing against a local mock endpoint. - - - - - Returns the flag indicating if endpoint discovery should be enabled or disabled for operations that are not required to use endpoint discovery. - - - - - Returns the maximum number of discovered endpoints that can be stored within the cache for the client. The default limit is 1000 cache entries. - - - - - Throw an exception if the boxed TimeSpan parameter doesn't have a value or is out of range. - - - - - Returns the request timeout value if its value is set, - else returns client timeout value. - - - - - Overrides the default read-write timeout value. - - - - If the value is set, the value is assigned to the ReadWriteTimeout property of the HttpWebRequest object used - to send requests. - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Gets and sets of the ProxyHost property. - - - - - Gets and sets the ProxyPort property. - - - - - Gets and sets the ProxyBypassList property; a collection - of regular expressions denoting the set of endpoints for - which the configured proxy host will be bypassed. - - - For more information on bypass lists - see https://msdn.microsoft.com/en-us/library/system.net.webproxy.bypasslist%28v=vs.110%29.aspx. - - - - - Gets and sets the ProxyBypassOnLocal property. - If set true requests to local addresses bypass the configured - proxy. - - - - - Returns a WebProxy instance configured to match the proxy settings - in the client configuration. - - - - - Unpacks the host, port and any credentials info into the instance's - proxy-related fields. - - The proxy details - - - - Gets and sets the max idle time set on the ServicePoint for the WebRequest. - Default value is 50 seconds (50,000 ms) unless ServicePointManager.MaxServicePointIdleTime is set, - in which case ServicePointManager.MaxServicePointIdleTime will be used as the default. - - - - - Gets and sets the connection limit set on the ServicePoint for the WebRequest. - Default value is 50 connections unless ServicePointManager.DefaultConnectionLimit is set in - which case ServicePointManager.DefaultConnectionLimit will be used as the default. - - - - - Gets or sets a Boolean value that determines whether the Nagle algorithm is used on connections managed by the ServicePoint object used - for requests to AWS. This is defaulted to false for lower latency with responses that return small amount of data. This is the opposite - default than ServicePoint.UseNagleAlgorithm which is optimized for large responses like web pages or images. - - - - - Base class for constant class that holds the value that will be sent to AWS for the static constants. - - - - - Gets the value that needs to be used when send the value to AWS - - - - - Attempt to find correct-cased constant value using whatever cased value the user - has provided. This is primarily useful for mapping any-cased values from a CLI - tool to the specific casing required by the service, avoiding the need for the - user to (a) remember the specific case and (b) actually type it correctly. - - The properly cased service constant matching the value - - - - Utility class that stores clock skew information. - - - - - GlobalClockCorrection should be only set by AWSConfigs.ManualClockCorrection property - and is only available to maintain backward compatibilty. This should override any - endpoint specific clockskew correction. - - - - - Return clock skew correction value for an endpoint if there is one. - - AWSConfigs.ManualClockCorrection overrides globally any calculated service endpoint specific - clock correction value. - - Endpoint should in a form such as "https://s3" - Clock correction value for an endpoint in TimeSpan. TimeSpan.Zero if no such clock correction is set. - - - - Get clock skew corrected UTC now value. If ManualClockCorrection is set, - use ManualClockCorrection instead of endpoint specific clock correction value. - - - - - - - Factory to construct different types of AWSCredentials based on a profile. - - - - - Gets the AWSCredentials for this profile if CanCreateAWSCredentials is true - and AWSCredentials can be created. Throws an exception otherwise. - - See for a list of AWSCredentials returned by this method. - - The profile to get AWSCredentials for. - The profile source, for profiles that reference other profiles. - AWSCredentials for this profile. - - - - Gets the AWSCredentials for this profile if CanCreateAWSCredentials is true - and AWSCredentials can be created. Throws an exception otherwise. - - See for a list of AWSCredentials returned by this method. - - The options to get AWSCredentials for. - The profile source, for options that reference other profiles. - AWSCredentials for the options given. - - - - Gets the AWSCredentials for this profile if CanCreateAWSCredentials is true - and AWSCredentials can be created. Throws an exception otherwise. - - See for a list of AWSCredentials returned by this method. - - The profile to get AWSCredentials for. - The profile source, for profiles that reference other profiles. - If true, throw a descriptive exception for any credentials that would not operate as-is. - In other words, any credentials that require programmatic callbacks at runtime. - AWSCredentials for this profile. - - - - Gets the AWSCredentials for this profile if CanCreateAWSCredentials is true - and AWSCredentials can be created. Throws an exception otherwise. - - See for a list of AWSCredentials returned by this method. - - The options to get AWSCredentials for. - The profile source, for options that reference other profiles. - If true, throw a descriptive exception for any credentials that would not operate as-is. - In other words, any credentials that require programmatic callbacks at runtime. - AWSCredentials for the options given. - - - - Return the credentials for the profile if valid credentials can created. - - The profile to create credentials with. - The profile source, for profiles that reference other profiles. - The credentials for the profile. - True if credentials can be created from the profile, false otherwise. - - - - Return the credentials for the profile if valid credentials can created. - - The options to get AWSCredentials for. - The profile source, for profiles that reference other profiles. - The credentials for the profile. - True if credentials can be created from the profile, false otherwise. - - - - Determine if the profileType will generate AWSCredentials that require a callback to be set on them. - - - - - - - A named group of options that are persisted and used to obtain AWSCredentials. - - - - - The name of the CredentialProfile - - - - - The options to be used to create AWSCredentials. - - - - - The region to be used with this CredentialProfile - - - - - The unique key for this CredentialProfile. - This key is used by the Visual Studio Tooklit to associate external artifacts with this profile. - - - - - The endpoint discovery enabled value for this CredentialProfile - - - - - If true the region identified in the S3 access point arn will be used when making requests. - - - - - The Sts Regional Endpoints Value as either legacy or regional - - - - - The S3 Regional Endpoint Value as either legacy or regional - - - - - An optional dictionary of name-value pairs stored with the CredentialProfile - - - - - True if the properties of the Options object can be converted into AWSCredentials, false otherwise. - See for more details about which options are available. - - - - - The that this is associated with. - Null if this is not associated with a . - - - - - If CanCreateAWSCredentials is true, returns a short description of the type of - credentials that would be created. - If CanCreateAWSCredentials is false, return null. - - - - - The CredentialProfileType of this CredentialProfile, if one applies. - - - - - Determine this CredentialProfile will generate AWSCredentials that require a callback to be set on them. - - - - - Construct a new CredentialProfile. - - - - - - - Gets the AWSCredentials for this profile if CanCreateAWSCredentials is true - and AWSCredentials can be created. Throws an exception otherwise. - - See for a list of AWSCredentials returned by this method. - - The profile source, for profiles that reference other profiles. - AWSCredentials for this profile. - - - - Gets the AWSCredentials for this profile if CanCreateAWSCredentials is true - and AWSCredentials can be created. Throws an exception otherwise. - - See for a list of AWSCredentials returned by this method. - - The profile source, for profiles that reference other profiles. - If true, throw a descriptive exception for any credentials that would not operate as-is. - In other words, any credentials that require programmatic callbacks at runtime. - AWSCredentials for this profile. - - - - The options that are available for creating AWSCredentials with the AWSCredentialsFactory. - The type of AWSCredentials that are created depends on which Options are set. - - Below are the different types of credentials returned, along with the options that are used to obtain them. - ([] denotes options that are not required) - - BasicAWSCredentials AccessKey SecretKey - SessionAWSCredentials AccessKey SecretKey Token - AssmeRoleAWSCredentials SourceProfile RoleArn [ExternalID] [MfaSerial] - FederatedAWSCredentials EndpointName RoleArn [UserIdentity] - - - - - The access key to be used in the AWSCredentials. - - - - - The source of credentials to be used to obtain AWSCredentials. - - - - - The endpoint name to be used for federated AWSCredentials. - - - - - The external id to use in assume role AWSCredentials. - - - - - The serial number of the MFA to use in assume role AWSCredentials. - - - - The role ARN to use when creating assume role or federated AWSCredentials. - - - - An identifier for the assumed role session. - - - - - The secret key to use when creating AWSCredentials. - - - - - When this CredentialProfileOptions object references another CredentialProfile, - the name of the referenced CredentialProfile. - - - - - The session token to be used to create AWSCredentials. - - - - - The user identity to use when creating federated AWSCredentials. - If not set, the user identity that the code is running under will be used. - - - - - Contains the executable information to be used by the process credential retriever - to either fetch Basic or Session credentials - - - - - Absolute path to the file on disk containing an OIDC token. - - - - - Return true the properties are all null or empty, false otherwise. - - - - - Class to abstract the combined use of NetSDKCredentialsFile and SharedCredentialsFile where possible. - - - - - - The location of the shared credentials file, or null to use the default location. - - - - - Construct a CredentialProfileChain. - - - - - Construct a CredentialProfileChain. - - The path to the aws credentials file to look at. - - - - - Try to get from a profile. - - - If ProfilesLocation is non-null and non-empty search the shared credentials - file at the disk path in the ProfilesLocation property. - - - If ProfilesLocation is null or empty and the platform supports the .NET SDK credentials file - search the SDK credentials file. If the profile is not found search the shared credentials file in the default location. - - - If ProfilesLocation is null or empty and the platform doesn't support the .NET SDK credentials file - search the shared credentials file in the default location. - - - The name of the profile to get credentials from. - The credentials, if the profile is found and credentials can be created. - True if the profile was found and credentials could be created, false otherwise. - - - - - Try to get a - - - If ProfilesLocation is non-null and non-empty search the shared credentials - file at the disk path in the ProfilesLocation property. - - - If ProfilesLocation is null or empty and the platform supports the .NET SDK credentials file - search the SDK credentials file. If the profile is not found search the shared credentials file in the default location. - - - If ProfilesLocation is null or empty and the platform doesn't support the .NET SDK credentials file - search the shared credentials file in the default location. - - - The name of the profile to get. - The profile, if found - True if the profile was found, false otherwise. - - - - - Get a list of available objects. - - - If ProfilesLocation is non-null and non-empty include profiles in the shared credentials - file at the disk path in the ProfilesLocation property. - - - If ProfilesLocation is null or empty and the platform supports the .NET SDK credentials file - include profiles from the SDK credentials file and from the shared credentials file in the default location. - - - If ProfilesLocation is null or empty and the platform doesn't support the .NET SDK credentials file - include profiles from the shared credentials file in the default location. - - - A list of objects. - - - - - Register a - - - If ProfilesLocation is non-null and non-empty register the profile in the shared credentials - file at the disk path in the ProfilesLocation property. - - - If ProfilesLocation is null or empty and the platform supports the .NET SDK credentials file - register the profile in the SDK credentials file. - - - If ProfilesLocation is null or empty and the platform doesn't support the .NET SDK credentials file - register the profile in the shared credentials file in the default location. - - - The profile to register. - - - - - Unregister a - - - If ProfilesLocation is non-null and non-empty unregister the profile from the shared credentials - file at the disk path in the ProfilesLocation property. - - - If ProfilesLocation is null or empty and the platform supports the .NET SDK credentials file - search the SDK credentials file. If the profile is found there unregister it. - If the profile was not found search the shared credentials file in the default location. - If the profile is found in the shared credentials file in the default location unregister it. - - - If ProfilesLocation is null or empty and the platform doesn't support the .NET SDK credentials file - search the shared credentials file in the default location. If the profile is found in the - shared credentials file in the default location unregister it. - - - The name of the profile to unregister. - - - - Interface to define the necessary operations for a CredentialProfile lookup mechanism. - - - - - Get the profile with the given name, if one exists. - - The name of the profile to get. - The profile, if it was found, null otherwise. - True if the profile was found, false otherwise. - - - - Interface to define the necessary operations for a CredentialProfile storage mechanism. - - - - - Rename the profile with oldProfileName to newProfileName. - - The profile to rename. - The new name for the profile. - - - - Rename the profile with oldProfileName to newProfileName. - - The profile to rename. - The new name for the profile. - If true and the destination profile exists it will be overwritten. - - - - Make a copy of the profile with fromProfileName called toProfileName. - - The name of the profile to copy from. - The name of the new profile. - - - - Make a copy of the profile with fromProfileName called toProfileName. - - The name of the profile to copy from. - The name of the new profile. - If true and the destination profile exists it will be overwritten. - - - - Add the given profile to the store, or update it if one with the same name already exists. - - - - - - Delete the profile with profileName if it exists. - - The name of the profile to delete. - - - - Get a list of valid profile names from this store. - Invalid profiles are ignored. - See for more information - about valid profiles. - - - - - - Get a list of valid profiles from this store. - Invalid profiles are ignored. - See for more information - about valid profiles. - - - - - - Class to easily convert from Dictionary<string, string> to ProfileOptions and back. - - - - - Separate the profileDictionary into its parts. - profileDictionary = profileOptions + reservedProperties + userProperties - - Dictionary with everything in it - Keys to ignore - The resulting CredentialProfileOptions - The properties that are left - - - - Separate the profileDictionary into its parts. - profileDictionary = profileOptions + reservedProperties + userProperties - - Dictionary with everything in it - Keys for the reservedKeys dictionary - The resulting CredentialProfileOptions - The resulting reserved properties - The properties that are left - - - - Validate the userProperties and then combine profileOptions, reservedProperties, and userProperties into one Dictionary. - - - - - - - - - - Make sure the userProperties dictionary doesn't contain any keys that are reserved. - Check is case-insensitive for added safety. - - - - - - - Make sure the userProperties dictionary doesn't contain any keys that - overlap with the names of mapped names for CredentialProfileOptions property names. - Check is case-insensitive for added safety. - - - - - - This class is used internally and should not be accessed by SDK users. - - Provide access to internal properties of CredentialProfile to - PowerShell tools and the Visual Studio Toolkit. - - - - - Attempt to read a role session with the given name. - If the session is invalid or expired it will not be returned. - - The name of the role session to get. - The credentials for the session, if found. - True if the session was found, false otherwise. - - - - This class allows profiles supporting AWSCredentials to be registered with - the SDK so that they can later be reference by a profile name. The credential profiles will be available - for use in the AWS Toolkit for Visual Studio and the AWS Tools for Windows PowerShell. - - The credentials are stored under the current users AppData folder encrypted using Windows Data Protection API. - - - This class is not threadsafe. - - - - - - Get the profile with the name given, if it exists in this store. - - The name of the profile to find. - The profile, if it was found, null otherwise - True if the profile was found, false otherwise. - - - - Add the profile to this store, if it's valid. - - The profile to add. - - - - If there is a profile in the store with the given name, delete it. - - The name of the profile to delete. - - - - Rename the profile with oldProfileName to newProfileName. - - The profile to rename. - The new name for the profile. - - - - Rename the profile with oldProfileName to newProfileName. - - The profile to rename. - The new name for the profile. - If true and the destination profile exists it will be overwritten. - - - - Make a copy of the profile with fromProfileName called toProfileName. - - The name of the profile to copy from. - The name of the new profile. - - - - Make a copy of the profile with fromProfileName called toProfileName. - - The name of the profile to copy from. - The name of the new profile. - If true and the destination profile exists it will be overwritten. - - - - Set the ProfileType field to maintain backward compatibility with ProfileManager. - The value is ignored when it's read back in. - - - - - - - Represents the different types of authentication available for SAML endpoints. - - - - - Representation of a SAML Endpoint. - - - - - The name given to this SAMLEndpoint. - - - - - The URI of the SAML endnpoint. - - - - - The authentication type associated with the SAML endpoint. - - - - - Internal constructor. Used by SAMLEndpointManager when reading endpoints from the encrypted store. - - - - - - - - Construct a SAMLEndpoint using the default SAMLAuthenticationType - Kerberos. - - The name of the endpoint. - The URI of the endpoint. - - - - Construct a SAMLEndpoint. - - The name of the endpoint. - The URI of the endpoint. - The authentication type of the endpoint. - - - - Manages endpoints to be used in conjunction with SAML role profiles. The role profiles - reference the endpoint to obtain the actual endpoint and any customization settings - needed to perform authentication. - - - - - Construct a SAMLEndpointManager. - - - - - True if the SAMLEndpointManager is available on the current platform, false otherwise. - - - - - Register an endpoint, or update an existing one. - - The endpoint to register. - - - - Get an endpoint, if it exists and is valid. - - The name of the endpoint to get. - The endpoint, or null if it's invalid or doesn't exist. - True if the endpoint exists and is valid, false otherwise. - - - - Get an endpoint from the store. - Throws an exception if there's an error reading the endpoint, or if it doesn't exist. - - The name of the endpoint to get. - The endpoint with the given name. - - - - Delete an endpoint from the store, if it exists. - - The name of the endpoint to delete. - - - - List the names of valid endpoints in the store. - - - - - - List valid endopints that can be read from the store. - - - - - - Provides access to read and write to the shared credentials INI file. - The file is read, parsed, and validated at construction time. - Changes can be made using the RegisterProfile() and - UnregisterProfile() methods. - - This class is not threadsafe. - - - - - To maintain compatibility with the CLI, - SharedCredentialsFile doesn't support the SAML profileTypes. - - - - - Construct a new SharedCredentialsFile in the default location. - - - - - Construct a new SharedCredentialsFile. - - The path of the shared credentials file. - - - - Add the profile given. If the profile already exists, update it. - - The profile to be written. - - - - Update the profile on disk regardless of the profile type. - - - - - - Deletes the section with the given ProfileName from the SharedCredentialsFile, if one exists. - - The ProfileName of the section to delete. - - - - Rename the profile with oldProfileName to newProfileName. - - The profile to rename. - The new name for the profile. - - - - Rename the profile with oldProfileName to newProfileName. - - The profile to rename. - The new name for the profile. - If true and the destination profile exists it will be overwritten. - - - - Make a copy of the profile with fromProfileName called toProfileName. - - The name of the profile to copy from. - The name of the new profile. - - - - Make a copy of the profile with fromProfileName called toProfileName. - - The name of the profile to copy from. - The name of the new profile. - If true and the destination profile exists it will be overwritten. - - - - Try to get a profile that may be partially in the credentials file and partially in the config file. - If there are identically named properties in both files, the properties in the credentials file take precedence. - - - - - - - - Anonymous credentials. - Using these credentials, the client does not sign the request. - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - AWS Credentials that automatically refresh by calling AssumeRole on - the Amazon Security Token Service. - - - - - The credentials of the user that will be used to call AssumeRole. - - - - - The Amazon Resource Name (ARN) of the role to assume. - - - - - An identifier for the assumed role session. - - - - - Options to be used in the call to AssumeRole. - - - - - Constructs an AssumeRoleAWSCredentials object. - - The credentials of the user that will be used to call AssumeRole. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - - - - Constructs an AssumeRoleAWSCredentials object. - - The credentials of the user that will be used to call AssumeRole. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRole. - - - - A unique identifier that is used by third parties when assuming roles in their customers' accounts. - - - - - An IAM policy in JSON format. - - - - - The length of time in seconds before the credentials will expire. - - - - - The proxy settings to use when calling AssumeRole. - - - - - The identification number of the MFA device that is associated with the user who is making the assume-role call. - - - - - The value provided by the MFA device, if the trust policy of the role being assumed requires MFA. - - - - - A callback that's used to obtain the MFA token code when the AssumeRoleAWSCredentials are refreshed. - - - - - Immutable representation of AWS credentials obtained as a result of - authenticating with the AssumeRole method of the Security Token Service. - - - - - The expiry time of the credentials, obtained from the AssumeRoleResponse. - - - - - Constructs an instance with supplied keys, token, and expiration. - - The AccessKey for the credentials. - The SecretKey for the credentials. - The security token for the credentials. - The expiration time for the credentials. - - - - Get a copy of this AssumeRoleImmutableCredentials object. - - A copy of this object. - - - - AWS Credentials that automatically refresh by calling AssumeRole on - the Amazon Security Token Service. - - - - - As established by STS, the regex used to validate the role session names is a string of 2-64 characters consisting of - upper- and lower-case alphanumeric characters with no spaces. You can also include - underscores or any of the following characters: =,.@- - - - - - Options to be used in the call to AssumeRole. - - - - - The absolute path to the file on disk containing an OIDC token - - - - - The Amazon Resource Name (ARN) of the role to assume. - - - - - An identifier for the assumed role session. - - - - - Constructs an AssumeRoleWithWebIdentityCredentials object. - - The absolute path to the file on disk containing an OIDC token. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - - - - Constructs an AssumeRoleWithWebIdentityCredentials object. - - The absolute path to the file on disk containing an OIDC token. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRole. - - - - Creates an instance of from environment variables. - - Throws an if the needed environment variables are not set. - The new credentials. - - - - Gets a client to be used for AssumeRoleWithWebIdentity requests. - - The STS client. - - - - Options for using a credentials object to make AssumeRoleWithWebIdentity calls. - - - - - Gets and sets the property DurationSeconds. - - The duration, in seconds, of the role session. The value can range from 900 seconds - (15 minutes) up to the maximum session duration setting for the role. This setting - can have a value from 1 hour to 12 hours. If you specify a value higher than this - setting, the operation fails. For example, if you specify a session duration of 12 - hours, but your administrator set the maximum session duration to 6 hours, your operation - fails. To learn how to view the maximum value for your role, see View - the Maximum Session Duration Setting for a Role in the IAM User Guide. - - - - By default, the value is set to 3600 seconds. - - - - The DurationSeconds parameter is separate from the duration of a console - session that you might request using the returned credentials. The request to the - federation endpoint for a console sign-in token takes a SessionDuration - parameter that specifies the maximum length of the console session. For more information, - see Creating - a URL that Enables Federated Users to Access the AWS Management Console in the - IAM User Guide. - - - - - - - Gets and sets the property ProviderId. - - The fully qualified host component of the domain name of the identity provider. - - - - Specify this value only for OAuth 2.0 access tokens. Currently www.amazon.com - and graph.facebook.com are the only supported identity providers for - OAuth 2.0 access tokens. Do not include URL schemes and port numbers. - - - - Do not specify this value for OpenID Connect ID tokens. - - - - - - Gets and sets the property Policy. - - An IAM policy in JSON format that you want to use as an inline session policy. - - - - This parameter is optional. Passing policies to this operation returns new temporary - credentials. The resulting session's permissions are the intersection of the role's - identity-based policy and the session policies. You can use the role's temporary credentials - in subsequent AWS API calls to access resources in the account that owns the role. - You cannot use session policies to grant more permissions than those allowed by the - identity-based policy of the role that is being assumed. For more information, see - Session - Policies in the IAM User Guide. - - - - The plain text that you use for both inline and managed session policies shouldn't - exceed 2048 characters. The JSON policy characters can be any ASCII character from - the space character to the end of the valid character list (\u0020 through \u00FF). - It can also include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D) - characters. - - - - The characters in this parameter count towards the 2048 character session policy guideline. - However, an AWS conversion compresses the session policies into a packed binary format - that has a separate limit. This is the enforced limit. The PackedPolicySize - response element indicates by percentage how close the policy is to the upper size - limit. - - - - - - - Gets and sets the property PolicyArns. - - The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use - as managed session policies. The policies must exist in the same account as the role. - - - - This parameter is optional. You can provide up to 10 managed policy ARNs. However, - the plain text that you use for both inline and managed session policies shouldn't - exceed 2048 characters. For more information about ARNs, see Amazon - Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference. - - - - The characters in this parameter count towards the 2048 character session policy guideline. - However, an AWS conversion compresses the session policies into a packed binary format - that has a separate limit. This is the enforced limit. The PackedPolicySize - response element indicates by percentage how close the policy is to the upper size - limit. - - - - Passing policies to this operation returns new temporary credentials. The resulting - session's permissions are the intersection of the role's identity-based policy and - the session policies. You can use the role's temporary credentials in subsequent AWS - API calls to access resources in the account that owns the role. You cannot use session - policies to grant more permissions than those allowed by the identity-based policy - of the role that is being assumed. For more information, see Session - Policies in the IAM User Guide. - - - - - - The proxy settings to use when calling AssumeRoleWithWebIdentity. - - This parameter is optional. - - - - - - Abstract class that represents a credentials object for AWS services. - - - - - Returns a copy of ImmutableCredentials - - - - - - Called by AmazonServiceClient to validate the credential state - on client construction. - - - - - Basic set of credentials consisting of an AccessKey and SecretKey - - - - - Constructs a BasicAWSCredentials object for the specified accessKey and secretKey. - - - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - State class passed on callback to demand user credentials when authentication - needs to be performed using a non-default identity. - - - - - If the current authentication callback is associated with - a credential profile, this can be used to give the user - some context on the request for his/her authentication. - - - - - Contains the user identity that the user should supply a password - for. The user can ignore if they choose and return credentials for - an alternate account. - - - - - Any custom state that was registered with the callback. - - - - - Set if the callback was due to a failed authentication attempt. - If false we are beginning to obtain or refresh credentials. - - - - - InstanceProfileAWSCredentials allows configuring Roles and every instance hits IMDS individually. - This class has a singleton timer task that caches instance profile credentials every 2 minutes. - - - - - Returns a copy of the most recent instance profile credentials. - - - - - Dispose this object and all related resources. - - - - - When running in an ECS container and AWS_CONTAINER_CREDENTIALS_RELATIVE_URI is set, - use the given end point to retrieve the credentials. - - - - - These constants should not be consumed by client code. They are only relevant - in the context of ECS container and, especially, AWS_CONTAINER_CREDENTIALS_RELATIVE_URI - environment variable should not be overriden by the client code. - - - - - Uses aws credentials stored in environment variables to construct the credentials object. - AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY are used for the access key id and secret key. - If the variable AWS_SESSION_TOKEN exists then it will be used to create temporary session - credentials. - - - For backwards compatibility the class will also attempt to discover the secret key from - the AWS_SECRET_KEY variable, if a value cannot be obtained using the standard - AWS_SECRET_ACCESS_KEY variable. - - - - - Constructs an instance of EnvironmentVariablesAWSCredentials. If no credentials are found in - the environment variables then an InvalidOperationException is thrown. - - - - - Creates immutable credentials from environment variables. - - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - If AWS_CONTAINER_CREDENTIALS_RELATIVE_URI environment variable is set, we want to attempt to retrieve credentials - using ECS endpoint instead of referring to instance profile credentials. - - - If AWS_CONTAINER_CREDENTIALS_RELATIVE_URI environment variable is set, we want to attempt to retrieve credentials - using ECS endpoint instead of referring to instance profile credentials. - - - - Custom exception type thrown when a role profile with user identity is used - in conjunction with a credential request callback. This exception is thrown - if the callback returns null, indicating the user declined to supply credentials. - - - - - Initializes a new exception instance. - - - - - - Initializes a new exception instance. - - - - - - - Constructs a new instance of the FederatedAuthenticationCancelledException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Custom exception type thrown when authentication for a user fails due to - invalid credentials. - - - - - Initializes a new exception instance. - - - - - - Initializes a new exception instance. - - - - - - - Constructs a new instance of the FederatedAuthenticationFailureException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Temporary credentials that are created following successful authentication with - a federated endpoint supporting SAML. - - - In order to use the FederatedAWSCredentials class the AWSSDK.SecurityToken assembly - must be available to your application at runtime. - - - - - Constructs an instance of FederatedAWSCredentials. After construction call GetCredentials - to authenticate the user/process and obtain temporary AWS credentials. - - The SAML endpoint used for authentication. - The role ARN used for authentication. - - - - Constructs an instance of FederatedAWSCredentials. After construction call GetCredentials - to authenticate the user/process and obtain temporary AWS credentials. - - The SAML endpoint used for authentication. - The role ARN used for authentication. - The options used for authentication. - See for details about available options. - - - - The SAML Endpoint used for authentication. - - - - - The role ARN used for authentication. - - - - - The options used for authentication. - See for details about available options. - - - - - Refresh credentials after expiry. If the role profile is configured with user identity - information and a callback has been registered to obtain the user credential, the callback - will be invoked ahead of authentication. For role profiles configured with user identity - but no callback registration, the SDK will fall back to attempting to use the default - user identity of the current process. - - - - - - Clears currently-stored credentials, forcing the next GetCredentials call to generate new credentials. - - - - - Options that control the behavior of . - - - - - The identity to use when authenticating. - This is in the form domain\username, or just username. - If this option is not set, the current user's identity will be used. - - - - - uses this callback to get credentials if the UserIdentity is set. - - - - - When makes a callback for credentials, - this state will be included for use by the callback handler. - - - - - The proxy settings to use when calling the - Secure Token Service and the ADFS endpoint. - - - - - Set this property when a region-specific STS endpoint must be used (eg cn-north-1). - If left empty/null, the global sts.amazonaws.com endpoint will be used when credentials are obtained. - - - - - The profile name, if this FederatedAWSCredentialsOptions - is associated with a CredentialProfile. - - - - - Immutable representation of AWS credentials. - - - - - Gets the AccessKey property for the current credentials. - - - - - Gets the SecretKey property for the current credentials. - - - - - Gets the Token property for the current credentials. - - - - - Gets the UseToken property for the current credentials. - Specifies if Token property is non-emtpy. - - - - - Constructs an ImmutableCredentials object with supplied accessKey, secretKey. - - - - Optional. Can be set to null or empty for non-session credentials. - - - - Returns a copy of the current credentials. - - - - - - Credentials that are retrieved from the Instance Profile service on an EC2 instance - - - - - Role for which the credentials are retrieved - - - - - Constructs a InstanceProfileAWSCredentials object for specific role - - Role to use - - - - Constructs a InstanceProfileAWSCredentials object for specific role - - Role to use - - - - Constructs a InstanceProfileAWSCredentials object for the first found role - - - - - Constructs a InstanceProfileAWSCredentials object for the first found role - - - - - Retrieves a list of all roles available through current InstanceProfile service - - - - - - Retrieves a list of all roles available through current InstanceProfile service - - - - - - Return true if string is null or whitespace, false otherwise. - We can't use String.IsNullOrWhitespace because it doesn't exist - in all frameworks we support. - - - - - - - Process Credentials can retrieve credentials by running a process and reading its stdout. - A new config option, "credential_process" is added to the shared config file that allows customers - to specify which process to run. The credentials retrieved by running this process could be either - Basic or Session credentials. - - - - - Generates new credentials by running the "credential_process" process. - - - - - Exception class to capture all exceptions encountered when starting or - executing the "credential_process" process. If the user has specified an executable - and the SDK is unable to execute it, the exception should be surfaces to the user - instead of moving on to the next credential provider. - - - - - Abstract class for automatically refreshing AWS credentials - - - - - Refresh state container consisting of credentials - and the date of the their expiration - - - - - Represents the current state of the Credentials. - - This can be cleared without synchronization. - - - - Semaphore to control thread access to GetCredentialsAsync method. - The semaphore will allow only one thread to generate new credentials and - update the current state. - - - - - The time before actual expiration to expire the credentials. - Property cannot be set to a negative TimeSpan. - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - Test credentials existence and expiration time - should update if: - credentials have not been loaded yet - it's past the expiration time. At this point currentState.Expiration may - have the PreemptExpiryTime baked into to the expiration from a call to - UpdateToGeneratedCredentials but it may not if this is new application load. - - - - - When overridden in a derived class, generates new credentials and new expiration date. - - Called on first credentials request and when expiration date is in the past. - - - - - - Clears currently-stored credentials, forcing the next GetCredentials call to generate new credentials. - - - - - Immutable representation of AWS credentials obtained as a result of - authenticating against a SAML-supporting federated identity provider. - - - - - The expiry time of the credentials, obtained from the AssumeRoleWithSAML response. - - - - - The value of the NameID element in the Subject element of the SAML assertion, as returned in the - AssumeRoleWithSAML response from the Security Token Service. - - - - - Constructs an instance with supplied keys and SAML assertion data. - - - - - - - - - - Constructs an instance with supplied keys and SAML assertion data. - - - - - - - - Returns a copy of the current credentials. - - - - - - Serializes the instance to a json-format string for external storage - - The serialized object in json - - - - Instantiates an instance from persisted json data - - The serialized data - Deserialized instance corresponding to the json data - - - - Session credentials consisting of AccessKey, SecretKey and Token - - - - - Constructs a SessionAWSCredentials object for the specified accessKey, secretKey. - - - - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - - Credentials that are retrieved using a stored profile. - - - Unless otherwise specified priority is given to loading credentials from the SDK credential store - file which is shared between the SDK, PowerShell CLI and Toolkit. Credentials in profiles in this - file are encrypted and can only be used by the user account on the current machine that stored the - profile. Credentials can also be loaded from the plain-text ini-format credential file which is - shared with other AWS SDKs. This file is expected to exist in a '.aws' folder in the user's home - directory but alternate locations can be specified using either the AWSProfilesLocation setting in - the application configuration file, or by using the AWS_SHARED_CREDENTIALS_FILE environment variable. - - - The profile name can be specified in the App.config using the AWSProfileName setting. - - - - - - Constructs an instance for credentials stored in a profile. This constructor searches for credentials - using the account name specified using the AWSProfileName setting, if set, in the application configuration - file. If the configuration file setting is not set the SDK will attempt to locate a profile with the name - 'default'. - - - - - Constructs an instance for credentials stored in a profile with the specified name. The SDK will - check the SDK credential store file first before looking for the shared ini-format credentials - file unless the application configuration file contains a setting for the 'AWSProfilesLocation' - indicating the search should be constrained to the shared credentials file at the specified - location. - - The name of the profile in which the credentials were stored. - - - - Constructs an instance for credentials stored in a profile with the specified name. - - The profile name to search for credentials for - - Optional; instructs the SDK to check for the profile in the shared credentials file at the - specified location. If not set, the SDK will inspect its own credential store file first before - attempting to locate a shared credential file using either the default location beneath the user's - home profile folder or the location specified in the AWS_SHARED_CREDENTIALS_FILE environment - variable. - - - If credential materials cannot be read or are invalid due to missing data an InvalidDataException - is thrown. If no credentials can be located with the specified profile name, an ArgumentException - is thrown. - - - - - Name of the profile being used. - - - - - Location of the profiles, if used. - - - - - Tests if a profile has been registered in either the SDK store or the specified credential - file. - - The name of the profile to test - - Optional; instructs the SDK to check for the profile in the shared credentials file at the - specified location. If not set, the SDK will inspect its own credential store file first before - attempting to locate a shared credential file using either the default location beneath the user's - home profile folder or the location specified in the AWS_SHARED_CREDENTIALS_FILE environment - variable. - - True if a profile with the specified name has been registered. - - - - Tests if an instance can be created from the persisted profile data. - If profilesLocation is null/empty, the SDK store is searched for the - profile data before probing for the profile in the shared the ini-format - credential file. - - The name of the profile to test - - If null/empty, the SDK store is searched for the named profile otherwise - the ini-format credential file at the specified location is inspected. - - True if the persisted data would yield a valid credentials instance. - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - Helper routiners for AWS and Federated credential profiles. Probes the - profile type for the supplied profile name and returns the appropriate profile - instance. - - - - - Determines the type of the requested profile and returns the - appropriate profile instance. - - The name of the profile (AWS or federated) to be loaded. - Instantiated profile type. - - - - Determines the type of the requested profile and returns the - appropriate profile instance. - - The name of the profile (AWS or federated) to be loaded. - - The location of the shared credentials (.ini) file, for profiles that are not stored in the - SDK credential store. - - Instantiated profile type. - - - - Probes for and returns the fully qualified name of the shared ini-format credentials - file. - - - Contains the file or folder name of the credential file. If not specified, the - routine will first check the application configuration file for a setting indicating - the file location or filename. If the configuration file does not yield a credential - file location then an environment variable is examined. Finally the routine will - inspect the fallback default location beneath the user's home folder location. - - - The fully qualified name to the credential file that was located, or null - if no credential file could be found. - - - - - Obtains credentials from access key/secret key or AWSProfileName settings - in the application's app.config or web.config file. - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - Exception thrown on validation of a StoredProfileFederatedCredentials instance if the role profile - is configured to use a non-default user identity and the QueryUserCredentialCallback on the - instance has not been set. - - - - - Initializes a new exception instance. - - - - - - Initializes a new exception instance. - - - - - - - Initializes a new exception instance. - - - - - - Constructs a new instance of the CredentialRequestCallbackRequiredException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Credentials that are retrieved from ConfigurationManager.AppSettings - - - - - Constructs an instance of EnvironmentAWSCredentials and attempts - to load AccessKey and SecretKey from ConfigurationManager.AppSettings - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - Temporary credentials that are created following successful authentication with - a federated endpoint supporting SAML. - - - 1. Currently only the SDK store supports profiles that contain the necessary data to support - authentication and role-based credential generation. The ini-format files used by the AWS CLI - and some other SDKs are not supported at this time. -
- 2. In order to use the StoredProfileFederatedCredentials class the AWSSDK.SecurityToken assembly - must be available to your application at runtime. - - - - - Custom state to return to the registered callback to handle credential requests. - The data will be contained in the CredentialRequestCallbackArgs instance supplied - to the callback. - - - - - The minimum allowed timespan for generated credentials, per STS documentation. - - - - - The maximum allowed timespan for generated credentials, per STS documentation. - - - - - Name of the profile being used. - - - - - Location of the profiles, if used. - - - - - The data about the SAML endpoint and any required user credentials parsed from the - profile. - - - - - Callback signature for obtaining user credentials that may be needed for authentication. - - - Data about the credential demand including any custom state data that was supplied - when the callback was registered. - - - The network credential to use in user authentication. Return null to signal the user - declined to provide credentials and authentication should not proceed. - - - - - Constructs an instance of StoredProfileFederatedCredentials using the profile name specified - in the App.config. If no profile name is specified then the default credentials are used. - - - - - Constructs an instance of StoredProfileFederatedCredentials. Credentials will be searched - for using the profileName parameter. - - The profile name to search for credentials for - - - - - Constructs an instance of StoredProfileFederatedCredentials. After construction call one of the Authenticate - methods to authenticate the user/process and obtain temporary AWS credentials. - - - For users who are domain joined (the role profile does not contain user identity information) the temporary - credentials will be refreshed automatically as needed. Non domain-joined users (those with user identity - data in the profile) are required to re-authenticate when credential refresh is required. An exception is - thrown when attempt is made to refresh credentials in this scenario. The consuming code of this class - should catch the exception and prompt the user for credentials, then call Authenticate to re-initialize - with a new set of temporary AWS credentials. - - - - The name of the profile holding the necessary role data to enable authentication and credential generation. - - Reserved for future use. - - The ini-format credentials file is not currently supported for SAML role profiles. - - - - - - Constructs an instance of StoredProfileFederatedCredentials. After construction call one of the Authenticate - methods to authenticate the user/process and obtain temporary AWS credentials. - - - For users who are domain joined (the role profile does not contain user identity information) the temporary - credentials will be refreshed automatically as needed. Non domain-joined users (those with user identity - data in the profile) are required to re-authenticate when credential refresh is required. An exception is - thrown when attempt is made to refresh credentials in this scenario. The consuming code of this class - should catch the exception and prompt the user for credentials, then call Authenticate to re-initialize - with a new set of temporary AWS credentials. - - - - The name of the profile holding the necessary role data to enable authentication and credential generation. - - Reserved for future use. - - Null or proxy settings to be used during the HHTPS authentication calls when generating credentials. - /// - The ini-format credentials file is not currently supported for SAML role profiles. - - - - - Registers a callback handler for scenarios where credentials need to be supplied - during user authentication (primarily the non-domain-joined use case). Custom data, - which will be supplied in the CredentialRequestCallbackArgs instance passed to the - callback, can also be supplied. - - - The callback will only be invoked if the underlying SAML role profile indicates it - was set up for use with a specific identity. For profiles that do not contain any user - identity the SDK will default to using the identity of the current process during - authentication. Additionally, if the profile contain user identity information but no - callback has been registered, the SDK will also attempt to use the current process - identity during authentication. - - - The handler to be called - - Custom state data to be supplied in the arguments to the callback. - - - Only one callback handler can be registered. The call to the handler will be made on - whatever thread is executing at the time a demand to provide AWS credentials is made. - If the handler code requires that UI need to be displayed, the handler should - transition to the UI thread as appropriate. - - - - - Tests if an instance can be created from the persisted profile data. - - The name of the profile to test. - The location of the shared ini-format credential file. - True if the persisted data would yield a valid credentials instance. - - This profile type is currently only supported in the SDK credential store file. - The shared ini-format file is not currently supported; any value supplied - for the profilesLocation value is ignored. - - - - - Performs any additional validation we may require on the profile content. - - - - - Refresh credentials after expiry. If the role profile is configured with user identity - information and a callback has been registered to obtain the user credential the callback - will be invoked ahead of authentication. For role profiles configured with user identity - but no callback registration, the SDK will fall back to attempting to use the default - user identity of the current process. - - - - - - Class that posts the CSM event to a UDP portconfig - This is a singleton class and is created once - per AmazonServiceClient. - - - - - The CSMevents are always posted to the localhost - - - - - Method to post UDP datagram for sync calls - - - - - Method to post UDP datagram for async calls - - - - - Determines the endpoint discovery enabled value based on an environment variable. If no value is found in the - environment then an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of EnvironmentVariable AWS_ENABLED_ENDPOINT_DISCOVERY. If no value is found in the - environment then an InvalidOperationException is thrown. - - - - - Determines endpoint discovery enabled based on a stored in an . - If the profile doesn't exist or there is no endpoint discovery enabled information an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of . - If the AWS_PROFILE environment variable is set the instance will be constructed using that profile, - otherwise it will use the default profile. - - If the profile doesn't exist or there is no endpoint discovery enabled information an InvalidOperationException is thrown. - - The ICredentialProfileSource to read the profile from. - - - - Attempts to construct an instance of . - If the profile doesn't exist or there is no endpoint discovery enabled information an InvalidOperationException is thrown. - - The ICredentialProfileSource to read the profile from. - The name of the profile. - - - - Probing mechanism to determine the endpoint discovery enabled value from various sources. - - - - - The valid hashing algorithm supported by the sdk for request signing. - - - - - Which end of a request was responsible for a service error response. - - - - - The sender was responsible for the error, i.e. the client - request failed validation or was improperly formatted. - - - - - The error occured within the service. - - - - - An unrecognized error type was returned. - - - - - Sts Regional Endpoints Value determines whether or not - to send the sts request to the regional endpoint or to - the global sts endpoint - - - - - Send the request to the global sts endpoint - if the region is a legacy global region - - - - - Send the request to the regional endpoint - - - - - S3 US East 1 endpoint value determines wheter or not - to send the us-east-1 s3 requests to the regional endpoint or to - the legacy global endpoint - - - - - Sends the requests to the legacy global s3 endpoint for us-east-1 - - - - - Sends the request to the regional s3 endpoint for us-east-1 - - - - - Superclass for Exceptions that come over the event stream, or to wrap other kinds of generic exceptions. - - - - - The numeric code identifier for the type of error. - - - - - Constructs an EventStreamError. - - - - - Constructs an EventStreamError. - - The error code. - The error message. - - - - Constructs a new instance of the EventStreamErrorCodeException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Event args that contain an . - - The - - - - The EventStream Event. - - - - - Constructs an EventStreamEventReceivedArgs. - - The EventStream Event. - - - - Event args that contain an . - - The . - - - - The EventStream Exception. - - - - - Constructs an EventStreamExceptionReceivedArgs. - - The EventStream Exception. - - - - Supported Header types for vnd.amazon.event-stream - - - - - Name for the Header. Maximum of 255 bytes. - - - - - Header type id - - - - - Computes the amount of memory neccesary to serialize this Header. - - - - - Writes this Header to buffer starting at offset - Keep in mind, this API assumes buffer is large enough - for the operation. - - buffer to serialize this Header to - offset to begin writing at. - - the new offset. - - - - - Returns the current value as a bool - - - - - Sets the current value - - - - - Returns the current value as a byte - - - - - Sets the current value - - - - - Gets the current value as a 16 bit integer. (Host Order). - - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a 32 bit integer. (Host Order) - - - - - Sets the current value - - - - - returns the current value as a 64-bit integer. (Host Order) - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a byte buffer. - - - - - - Sets the current value. Max length is 2^15 - 1 - - - - - Returns the current value as a utf-8 string. - - - - - Sets the current value. Utf-8 encoded. Max byte size is 2^16 - 1 - - - - - Gets the current value as a DateTime. - Note: You do not need to compensate for unix epoch on this API. - - - - - - Sets the current value. - Note: You do not need to compensate for unix epoch on this API. - - - - - Returns the current value as a Guid (UUID) - - - - - Sets the current value - - - - - Header Data for an EventStreamMessage - - Each header is of format: - [name len] (1) | [utf-8 name] (v) - [type (1)] - [value (v)] - - - - - Name for the Header. Maximum of 255 bytes. - - - - - Header type id - - - - - Initializes this Header with name. - - utf-8 string, max length is 255 - - - - Deserializes the header in buffer. - - buffer constaining the header - index to start from in the buffer. - updated offset with new value for offset - - - - Writes this Header to buffer starting at offset - Keep in mind, this API assumes buffer is large enough - for the operation. - - buffer to serialize this Header to - offset to begin writing at. - - the new offset. - - - - - Computes the amount of memory neccesary to serialize this Header. - - - - - Returns the current value as a bool - - - - - Sets the current value - - - - - Returns the current value as a byte - - - - - Sets the current value - - - - - Gets the current value as a 16 bit integer. (Host Order). - - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a 32 bit integer. (Host Order) - - - - - Sets the current value - - - - - returns the current value as a 64-bit integer. (Host Order) - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a byte buffer. - - - - - - Sets the current value. Max length is 2^15 - 1 - - - - - Returns the current value as a utf-8 string. - - - - - Sets the current value. Utf-8 encoded. Max byte size is 2^16 - 1 - - - - - Gets the current value as a DateTime. - Note: You do not need to compensate for unix epoch on this API. - - - - - - Sets the current value. - Note: You do not need to compensate for unix epoch on this API. - - - - - Returns the current value as a Guid (UUID) - - - - - Sets the current value - - - - - Constructs a new instance of the EventStreamParseException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Constructs a new instance of the EventStreamChecksumFailureException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Headers for the message. Can be null. - - - - - Payload for the message. Can be null. - - - - - Converts a message into a byte buffer (usually for network transmission). - - - - - Message is a single datagram. The format is as follows: - [ total length (4) ] | [ headers_length (4)] | [ prelude crc(4)] - [ headers (v)] - [ payload (v)} - [ trailing crc ] - - CRCs use the CRC32 algorithm. - - - - - Content type for EventStreams. - - - - - Headers for the message. Can be null. - - - - - Payload for the message. Can be null. - - - - - Initialize a message with headers and a payload. - - list of headers for the message, can be null. - payload for the message, can be null. - - - - Builds a message from buffer. - - buffer to read - offset to start reading - buffer length. - - parsed instance of EventStreamMessage. Doesn't return null, - does throw if CRCs don't match. - - - - - Converts a message into a byte buffer (usually for network transmission). - - - - - Defines exceptions that arise from an not conforming to specification. - - - - - Constructs an EventStreamValidationException. - - - - - Constructs an EventStreamValidationException. - - The exception message. - - - - Constructs an EventStreamValidationException. - - The exception message. - The inner exception. - - - - Constructs a new instance of the EventStreamValidationException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - The contract for the . - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - A subclass of that enables an enumerable interface for interacting with Events. - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - Flag if the stream was chosen to be enumerated. - - - - - A Stream of Events. Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treated as mutually exclusive. - - - - - A Stream of Events. Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treated as mutually exclusive. - - - - - Returns an enumerator that iterates through the collection. - - An enumerator that can be used to iterate through the collection. - - - - Returns an enumerator that iterates through a collection. - - An object that can be used to iterate through the collection. - - - - Starts the background thread to start reading events from the network stream. - - - - - The contract for the . - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - The size of the buffer for reading from the network stream. - - - - - Fires when an event is received. - - - - - Fired when an exception or error is raised. - - - - - Starts the background thread to start reading events from the network stream. - - - - - The superclass for all EventStreams. It contains the common processing logic needed to retreive events from a network Stream. It - also contains the mechanisms needed to have a background loop raise events. - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - "Unique" key for unknown event lookup. - - - - - Header key for message type. - - - - - Header key for event type. - - - - - Header key for exception type. - - - - - Header key for error code. - - - - - Header key for error message. - - - - - Value of when the message is an event. - - - - - Value of when the message is an exception. - - - - - Value of when the message is an error. - - - - - The size of the buffer for reading from the network stream. - Default is 8192. - - - - - The underlying stream to read events from. - - - - - Responsible for decoding events from sequences of bytes. - - - - - Fires when an event is recieved. - - - - - Fired when an exception or error is raised. - - - - - The mapping of event message to a generator function to construct the matching Event Stream event. - - - - - The mapping of event message to a generator function to construct the matching Event Stream exception. - - - - - Whether the Stream is currently being processed. - - - - - A Stream of Events. Events can be retrieved from this stream by attaching handlers to listen events, and then calling StartProcessing. - - - - - A Stream of Events. Events can be retrieved from this stream by attaching handlers to listen events, and then calling StartProcessing. - - - - - Converts an EventStreamMessage to an event. - - The event stream message to be converted. - The event - - - - Abstraction for cross-framework initiation of the background thread. - - - - - The background thread main loop. It will constantly read from the network stream until IsProcessing is false, or an error occurs. - - This stub exists due to FXCop. - - - - - The background thread main loop. It will constantly read from the network stream until IsProcessing is false, or an error occurs. - - Needed for 3.5 support. Not used. - - - - Reads from the stream into the buffer. It then passes the buffer to the decoder, which raises an event for - each message it decodes. - - The buffer to store the read bytes from the stream. - - - - Wraps exceptions in an outer exception so they can be passed to event handlers. If the Exception is already of a compatable type, - the method returns what it was given. - - The exception to wrap. - An exception of type TE - - - - Starts the background thread to start reading events from the network stream. - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Disposes the resources of this stream. - - Should dispose of unmanged resources. - - - - Event Arguments for EventStreamDecoder.MessageReceived. - - - - - Received message. - - - - - Additional object context - - - - - Initialize this with message - - - - - Initialize this with message and object conetext - - - - - Exception thrown when a request is made of the Decoder, but the internal state - machine is an invalid state. This is usually the result of an interanl exception - being thrown during parsing of the network stream. - - - - - Constructs a new instance of the EventStreamDecoderIllegalStateException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Contract for EventStreamDecoder - - - - - Invoked anytime an EventStreamMessage is found. - - - - - Processes data starting at offset up to length. - Invokes MessageRecieved for each message encountered. - If an exception is thrown, this object is not safe for reuse. - - buffer to read - offset in buffer to start reading. - length of data. - - - - Streaming decoder for listening for incoming EventStreamMessage datagrams. - - - - - Invoked anytime an EventStreamMessage is found. - - - - - Object data (optional) that can be passed to the event handler for MessageReceived. - - - - - Default constructor. Initializes internal _state machine. - - - - - Processes data starting at offset up to length. - Invokes MessageRecieved for each message encountered. - If an exception is thrown, this object is not safe for reuse. - - buffer to read - offset in buffer to start reading. - length of data. - - - - Superclass for Exceptions that come over the event stream, or to wrap other kinds of generic exceptions. - - - - - Constructs an EventStreamException. - - - - - Constructs an EventStreamException. - - The exception message. - - - - Constructs an EventStreamException. - - The exception message. - The inner exception. - - - - Constructs a new instance of the EventStreamException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - The contract for EventStream events. - - - - - The contract for EventStream terminal events. - - - - - This Event is returned if an event is retrieved from the event stream, but a generator function - for the event is not defined. This can occur if the SDK is not updated after a new event type is introduced. - - - - - The Message recieved from the event stream before conversion. - - - - - The event type. - - - - - Constructs an UnknownEventStreamEvent. - - - - - Constructs an UnknownEventStreamEvent. - - The Message recieved from the event stream before conversion. - The event type. - - - - Signals that an an has an unknown message type. These exceptions whould be - swallowed to allow future expansion of the EventStream specification without breaking existing clients. - - - - - Constructs an UnknownEventStreamMessageTypeException. - - - - - Constructs a new instance of the UnknownEventStreamMessageTypeException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - This exception is thrown if an exception is retrieved from the event stream and should be modeled, - but a generator function for the strongly-typed exception is not defined. - - - - - The exception type. - - - - - Constructs an EventStreamException. - - The exception type. - - - - Constructs a new instance of the UnknownEventStreamException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - All Amazon service interfaces like IAmazonS3 extend from this interface. This allows all the - Amazon service interfaces be identified by this base interface and helps with generic constraints. - - - - - A readonly view of the configuration for the service client. - - - - - This interface is the read only access to the ClientConfig object used when setting up service clients. Once service clients - are initiated the config object should not be changed to avoid issues with using a service client in a multi threaded environment. - - - - - Gets the RegionEndpoint property. The region constant to use that - determines the endpoint to use. If this is not set - then the client will fallback to the value of ServiceURL. - - - - - The constant used to lookup in the region hash the endpoint. - - - - - Gets and sets of the ServiceURL property. - This is an optional property if you need to set a specific service URL - instead setting the region with the RegionEndpoint property. - - - - - Gets the UseHttp property. - If this property is set to true, the client attempts - to use HTTP protocol. - By default, this property is set to false. - - - - - Gets Service Version - - - - - Gets the signatureMethod property. - - - - - Gets the SignatureVersion property. - - Note: This property exists for backward compatibility but is no longer - used by any service other than S3. - - - - - Gets the AuthenticationRegion property. - Used in AWS4 request signing, this is an optional property; - change it only if the region cannot be determined from the - service endpoint. - - - - - Gets the AuthenticationServiceName property. - Used in AWS4 request signing, this is the short-form - name of the service being called. - - - - - Gets the UserAgent property. - - - - - Gets the DisableLogging. If true logging for this client will be disabled. - - - - - Flag on whether to log metrics for service calls. - - This can be set in the application's configs, as below: - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSLogMetrics" value"true"/> - </appSettings> - </configuration> - - - - - - Gets the LogResponse property. - If this property is set to true, the service response - is read in its entirety and logged. - - - - - Gets the ReadEntireResponse. - If this property is set to true, the service response - is read in its entirety before being processed. - - - - - This flag controls if .NET HTTP infrastructure should follow redirection - responses (e.g. HTTP 307 - temporary redirect). - - - - - Gets the BufferSize property. - The BufferSize controls the buffer used to read in from input streams and write - out to the request. - - - - - Gets the MaxErrorRetry property. - - - - - Gets the interval at which progress update events are raised - for upload operations. By default, the progress update events are - raised at every 100KB of data transferred. - - - - - Flag on whether to resign requests on retry or not. - - - - - Credentials to use with a proxy. - - - - - Gets the default request timeout value. - - - - If the value is set, the value is assigned to the Timeout property of the HTTPWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - - - - Configures the endpoint calculation for a service to go to a dual stack (ipv6 enabled) endpoint - for the configured region. - - - Note: AWS services are enabling dualstack endpoints over time. It is your responsibility to check - that the service actually supports a dualstack endpoint in the configured region before enabling - this option for a service. - - - - - Configures a flag enabling to either opt in or opt out of the retry throttling service. - Note: set value to true to enable retry throttling feature. The Default value for this flag is false. - - - - - Using either the RegionEndpoint or the ServiceURL determine what the URL to the service is. - - The URL to the service. - - - - Performs validation on this config object. - Throws exception if any of the required values are missing/invalid. - - The timeout specified is null. - - - - Returns the clock skew adjusted utc now. This value is affected by AWSConfigs.ManualClockCorrection - - - - - Returns the calculated clock skew value for this config's service endpoint. If AWSConfigs.CorrectForClockSkew is false, - this value won't be used to construct service requests. - - - - - Gets the DisableHostPrefixInjection flag. If true, host prefix injection will be disabled for this client, the default value of this flag is false. - Host prefix injection prefixes the service endpoint with request members from APIs which use this feature. - Example: for a hostPrefix of "foo-name." and a endpoint of "service.region.amazonaws.com" the default behavior is to - prefix the endpoint with the hostPrefix resulting in a final endpoint of "foo-name.service.region.amazonaws.com". Setting - DisableHostPrefixInjection to true will disable hostPrefix injection resulting in a final endpoint of - "service.region.amazonaws.com" regardless of the value of hostPrefix. E.g. You may want to disable host prefix injection for testing against a local mock endpoint. - - - - - Returns the flag indicating if endpoint discovery should be enabled or disabled for operations that are not required to use endpoint discovery. - - - - - Returns the maximum number of discovered endpoints that can be stored within the cache for the client. The default limit is 1000 cache entries. - - - - - Gets the TCP keep-alive values to use for service requests. Enabling TCP keep-alive sends periodic TCP keep-alive probe packets, to prevent disconnection due to - network inactivity. This is useful when you make API calls that take a long time to respond. In this case, the connection could be dropped by an intermediate - node (e.g. proxy) as the connection is inactive for a long time. Timeout controls the duration of inactivity before a keep-alive probe packet is sent. - Interval controls the amount of time to wait before retrying a keep-alive probe packet in the event the server doesn't respond to a keep-alive probe. - - - - - Gets the ProxyHost property. - - - - - Gets the ProxyPort property. - - - - - Gets the max idle time set on the ServicePoint for the WebRequest. - Default value is 50 seconds (50,000 ms) unless ServicePointManager.MaxServicePointIdleTime is set, - in which case ServicePointManager.MaxServicePointIdleTime will be used as the default. - - - - - Gets the default read-write timeout value. - - - - - - - Gets the connection limit set on the ServicePoint for the WebRequest. - Default value is 50 connections unless ServicePointManager.DefaultConnectionLimit is set in - which case ServicePointManager.DefaultConnectionLimit will be used as the default. - - - - - Gets whether the Nagle algorithm is used on connections managed by the ServicePoint object used - for requests to AWS. This is defaulted to false for lower latency with responses that return small amount of data. This is the opposite - default than ServicePoint.UseNagleAlgorithm which is optimized for large responses like web pages or images. - - - - - Returns a WebProxy instance configured to match the proxy settings - in the client configuration. - - - - - Interface for a single logged message. - - - - - Log message format. - - - - - Log message arguments. - - - - - Culture-specific formatting provider. - - - - - Abstract parameter value. - - - - - String parameter value. - - - - - String value of the parameter. - - - - - Constructs ParameterValue for a single string. - - - - - - String list parameter value. - - - - - List of strings value of the parameter. - - - - - Constructs ParameterValue for a list of strings. - - - - - - The interface for an exception handler. - - - - - Handles an exception for the given execution context. - - The execution context, it contains the - request and response context. - The exception to handle. - - Returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception to replace the original exception. - - - - - The interface for an exception handler with a generic parameter for the exception type. - - The exception type. - - - - Handles an exception for the given execution context. - - The execution context, it contains the - request and response context. - The exception to handle. - - Returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception to replace the original exception. - - - - - The interface for a HTTP request factory. - - The type used by the underlying HTTP API to represent the request body. - - - - Creates an HTTP request for the given URI. - - The request URI. - An HTTP request. - - - - The interface for an HTTP request that is agnostic of the underlying HTTP API. - - The type used by the underlying HTTP API to represent the HTTP request content. - - - - The HTTP method or verb. - - - - - The request URI. - - - - - Configures a request as per the request context. - - The request context. - - - - Sets the headers on the request. - - A dictionary of header names and values. - - - - Gets a handle to the request content. - - The request content. - - - - Returns the HTTP response. - - The HTTP response. - - - - Writes a stream to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - The request context. - - - - Writes a byte array to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - - - - Sets up the progress listeners - - The content stream - The interval at which progress needs to be published - The objects which is trigerring the progress changes - The callback which will be invoked when the progress changed event is trigerred - an object, incase the progress is setup, else returns the original stream - - - - Aborts the HTTP request. - - - - - Initiates the operation to gets a handle to the request content. - - The async callback invoked when the operation completes. - The state object to be passed to the async callback. - IAsyncResult that represents an async operation. - - - - Ends the operation to gets a handle to the request content. - - IAsyncResult that represents an async operation. - The request content. - - - - Initiates the operation to Returns the HTTP response. - - The async callback invoked when the operation completes. - The state object to be passed to the async callback. - IAsyncResult that represents an async operation. - - - - Ends the operation to Returns the HTTP response. - - IAsyncResult that represents an async operation. - The HTTP response. - - - - Interface for a handler in a pipeline. - - - - - The logger used to log messages. - - - - - The inner handler which is called after the current - handler completes it's processing. - - - - - The outer handler which encapsulates the current handler. - - - - - Contains the processing logic for a synchronous request invocation. - This method should call InnerHandler.InvokeSync to continue processing of the - request by the pipeline, unless it's a terminating handler. - - The execution context which contains both the - requests and response context. - - - - Contains the processing logic for an asynchronous request invocation. - This method should call InnerHandler.InvokeSync to continue processing of the - request by the pipeline, unless it's a terminating handler. - - The execution context which contains both the - requests and response context. - IAsyncResult which represent a async operation. - - - - This callback method contains the processing logic that should be executed - after the underlying asynchronous operation completes. - This method is called as part of a callback chain which starts - from the InvokeAsyncCallback method of the bottommost handler and then invokes - each callback method of the handler above it. - This method should call OuterHandler.AsyncCallback to continue processing of the - request by the pipeline, unless it's the topmost handler. - - The execution context, it contains the - request and response context. - - - - A retry policy specifies all aspects of retry behavior. This includes conditions when the request should be retried, - checks of retry limit, preparing the request before retry and introducing delay (backoff) before retries. - - - - - Maximum number of retries to be performed. - This does not count the initial request. - - - - - The logger used to log messages. - - - - - Checks if a retry should be performed with the given execution context and exception. - - The execution context which contains both the - requests and response context. - The exception thrown after issuing the request. - Returns true if the request should be retried, else false. The exception is retried if it matches with clockskew error codes. - - - - Returns true if the request is in a state where it can be retried, else false. - - The execution context which contains both the - requests and response context. - Returns true if the request is in a state where it can be retried, else false. - - - - Return true if the request should be retried for the given exception. - - The execution context which contains both the - requests and response context. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Checks if the retry limit is reached. - - The execution context which contains both the - requests and response context. - Return false if the request can be retried, based on number of retries. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called on a successful request response. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called before a retry request is initiated. The value - returned is True by default(retry throttling feature is disabled). - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called before a retry request is initiated. The value - returned is True by default(retry throttling feature is disabled). - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - - - - Metrics collected by the SDK on a per-request basis. - - - Each request made to an AWS service by the SDK can have metrics - collected and logged. This interface represents the collected - metrics for a request. The metrics include properties (i.e. request id - and other metadata), timings for each stage of the request, and counters. - - - - - Collection of properties being tracked - - - - - Timings for metrics being tracked - - - - - Counters being tracked - - - - - Whether metrics are enabled for the request - - - - - JSON representation of the current metrics - - JSON string - - - - Represents how long a phase of an SDK request took. - - - - - Whether the timing has been stopped - - - - - Elapsed ticks from start to stop. - If timing hasn't been stopped yet, returns 0. - - - - - Elapsed time from start to stop. - If timing hasn't been stopped yet, returns TimeSpan.Zero - - - - - User supplied type to perform metrics formatting. - - - - - Produce custom formatting for SDK metrics. - - - If defined, this method will be called for every request made by the SDK. - - An instance of IRequestMetrics produced by the SDK - formatted string representation of the metrics - - - - Predefined request metrics that are collected by the SDK. - - - - - Information about the request. - - - - - Gets and sets the RequestId property. - ID that uniquely identifies a request. Amazon keeps track of request IDs. If you have a question about a request, include the request ID in your correspondence. - - - - - ICoreAmazonKMS is not meant to be used directly. It defines Key Management Service - with basic .NET types and allows other services to be able to use the service as - a runtime dependency. This interface is implemented by the AmazonKeyManagementServiceClient - defined in the AWSSDK.KeyManagementService assembly. - - - - - The result of the GenerateDataKey and GenerateDataKeyAsync operations. - - - - - The plaintext for the data key. - - - - - The ciphertext for the data key. - - - - - ICoreAmazonS3 is not meant to use directly. It defines S3 with basic .NET types - and allows other services to be able to use S3 as a runtime dependency. This interface - is implemented by the AmazonS3Client defined in the S3 assembly. - - - ICoreAmazonS3 is not meant to use directly. It defines S3 with basic .NET types - and allows other services to be able to use S3 as a runtime dependency. This interface - is implemented by the AmazonS3Client defined in the S3 assembly. - - - - - Generate a presigned URL. - - - - - - - - - - Start a delete object. - - - - - - - - - - - Get the results of a delete object. - - - - - - Start an upload object from stream. - - - - - - - - - - - - Get the results of an upload from stream. - - - - - - Start an upload object from file path. - - - - - - - - - - - - Get the results of an upload from file path. - - - - - - Start a download to a file path. - - - - - - - - - - - - Get results of downloading an object to a file path. - - - - - - Start opening a stream to an object in S3. - - - - - - - - - - - Get results of opening a stream to an object in S3. - - - - - - - Get all the object keys for the particular bucket and key prefix. - - - - - - - - - Delete the object. - - - - - - - - Deletes the ojects. - - - - - - - - Upload an object from a stream. - - - - - - - - - Upload an object from a file path. - - - - - - - - - Download object to a file path. - - - - - - - - - Get stream for an object. - - - - - - - - - Set the ACL on the object to public readable. - - - - - - - - Check to see if the bucket exists and if it doesn't create the bucket. - - - - - - Check to see if the bucket exists. - - - - - - - ICoreAmazonSQS is not meant to use directly. It defines SQS with basic .NET types - and allows other services to be able to use SQS as a runtime dependency. This interface - is implemented by the AmazonSQSClient defined in the SQS assembly. - - - - - - This method is used internally to access the Amazon SQS service within other service assemblies. - Please use AmazonSQSClient to access Amazon SQS instead. - - Get the attributes for the queue identified by the queue URL. - - The queue URL to get attributes for. - The attributes for the queue. - - - - - This method is used internally to access the Amazon SQS service within other service assemblies. - Please use AmazonSQSClient to access Amazon SQS instead. - - Set the attributes on the queue identified by the queue URL. - - The queue URL to set the attributues. - The attributes to set. - - - - ICoreAmazonSTS is not meant to be used directly. It defines Security Token - service with basic .NET types and allows other services to be able to use the service as - a runtime dependency. This interface is implemented by the AmazonSecurityTokenServiceClient - defined in the AWSSDK.SecurityToken assembly. - - - - - - This method is used internally to access the Amazon Security Token - service within other service assemblies. - Please use AmazonSecurityTokenServiceClient to access the Amazon Security Token - service instead. - - Use Amazon Security Token Service to assume a role. - - Proxy settings that are required for the HTTPS and STS calls made during the authentication/credential - generation process are supported and should have been configured on the STS ClientConfig instance - associated with the STS client instance exposing this interface. - - - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRole. - - - - - - This method is used internally to access the Amazon Security Token - service within other service assemblies. - Please use AmazonSecurityTokenServiceClient to access the Amazon Security Token - service instead. - - Authenticates against a federated identity endpoint supporting SAML and returns - temporary AWS credentials for the supplied role. - - The endpoint for the federated identity provider - The authentication type to use (NTLM, Kerberos etc) - The ARN of the role the user is to assume following authentication - TTL duration for the generated credentials. - - Optional; alternate user credential for authentication. If null the identity of the - current process is used. - - Generated credential data, including SAML-related information such as subject. - - Proxy settings that are required for the HTTPS and STS calls made during the authentication/credential - generation process are supported and should have been configured on the STS ClientConfig instance - associated with the STS client instance exposing this interface. - - - - - - This method is used internally to access the Amazon Security Token - service within other service assemblies. - Please use AmazonSecurityTokenServiceClient to access the Amazon Security Token - service instead. - - Use Amazon Security Token Service to assume a role. - - Proxy settings that are required for the HTTPS and STS calls made during the authentication/credential - generation process are supported and should have been configured on the STS ClientConfig instance - associated with the STS client instance exposing this interface. - - - The web identity token used to assume the role. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRoleWithWebIdentity - - - - - CoreAmazonKMS is not meant to use directly. It implements ICoreAmazonKMS - and allows other service clients to be able to use the KMS service as a runtime dependency. - - This class waits until a method is actually called on the ICoreAmazonKMS interface - before requiring the KMS assembly to be present and loaded. - - - - - This exception is thrown if there are problems signing the request. - - - - - Constructs a new instance of the SignatureException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - - - - Gets the percentage of transfer completed - - - - - Gets the number of bytes transferred since last event - - - - - Gets the number of bytes transferred - - - - - Gets the total number of bytes to be transferred - - - - - Returns a string representation of this object - - - - - - TcpKeepAlive class used to group all the different properties used for working with TCP keep-alives. - - - - - Specifies if TCP keep-alive is enabled or disabled. The default value is false for all services except Lambda. - - - - - The timeout before a TCP keep-alive packet will be sent. The timeout value must be greater - than 0 seconds and not null if Enabled is set to true. The default value is 5 minutes. - - - - - The interval before retrying a TCP keep-alive packet that did not receive an acknowledgement. The - interval must be greater than 0 seconds and not null if Enabled is set to true. The default value is 15 seconds. - - - - - Root AWS config section - - - - - Gets and sets the proxy settings for the SDK to use. - - - - - Settings for configuring a proxy for the SDK to use. - - - - - Gets and sets the host name or IP address of the proxy server. - - - - - Gets and sets the port number of the proxy. - - - - - Gets and sets the username to authenticate with the proxy server. - - - - - Gets and sets the password to authenticate with the proxy server. - - - - - Gets and set the proxy bypass list. A set of semi-colon - delimited regular expressions denoting the addresses that - should bypass the proxy. - - - - - Gets and sets the proxy option to bypass local addresses. - - - - - Logging section - - - - - Easy-to-use generic collection - - - - - - Configuration element that serializes properly when used with collections - - - - - ConfigurationElement class which returns false for IsReadOnly - - - - - Settings for configuring a proxy for the SDK to use. - - - Settings for configuring a proxy for the SDK to use. - - - - - The host name or IP address of the proxy server. - - - - - The port number of the proxy. - - - - - The username to authenticate with the proxy server. - - - - - The password to authenticate with the proxy server. - - - - - Collection of one or more regular expressions denoting addresses - for which the proxy will not be used. - - - For more information on bypass lists - see https://msdn.microsoft.com/en-us/library/system.net.webproxy.bypasslist%28v=vs.110%29.aspx. - - - - - If true requests to local addresses bypass the configured - proxy. - - - - - Settings for logging in the SDK. - - - Settings for logging in the SDK. - - - - - Logging destination. - - - - - When to log responses. - - - - - Gets or sets the size limit in bytes for logged responses. - If logging for response body is enabled, logged response - body is limited to this size. The default limit is 1KB. - - - - - Whether or not to log SDK metrics. - - - - - A custom formatter added through Configuration - - - - - Settings for configuring CSM in the SDK. - - - - - This class can be used to discover the public address ranges for AWS. The - information is retrieved from the publicly accessible - https://ip-ranges.amazonaws.com/ip-ranges.json file. - - - The information in this file is generated from our internal system-of-record and - is authoritative. You can expect it to change several times per week and should - poll accordingly. - - - - - Region identifier string for ROUTE53 and CLOUDFRONT ranges - - - - - Collection of service keys found in the data file. - - - - - The publication date and time of the file that was downloaded and parsed. - - - - - Collection of all public IP ranges. - - - - - Filtered collection of public IP ranges for the given service key - - - - - Filtered collection of public IP ranges for the given region (us-east-1 etc) or GLOBAL. - - - - - Downloads the most recent copy of the endpoint address file and - parses it to a collection of address range objects. - - - - - Downloads the most recent copy of the endpoint address file and - parses it to a collection of address range objects. - - - - - Represents the IP address range for a single region and service key. - - - - - The public IPv4 or Ipv6 address range, in CIDR notation. - - - - - Indicates ipv4 or v6 format of the address - - - - - The AWS region or GLOBAL for edge locations. Note that the CLOUDFRONT and ROUTE53 - ranges are GLOBAL. - - - - - The subset of IP address ranges. Specify AMAZON to get all IP address ranges - (for example, the ranges in the EC2 subset are also in the AMAZON subset). Note - that some IP address ranges are only in the AMAZON subset. - - - Valid values for the service key include "AMAZON", "EC2", "ROUTE53", - "ROUTE53_HEALTHCHECKS", and "CLOUDFRONT." If you need to know all of - the ranges and don't care about the service, use the "AMAZON" entries. - The other entries are subsets of this one. Also, some of the services, - such as S3, are represented in "AMAZON" and do not have an entry that - is specific to the service. We plan to add additional values over time; - code accordingly! - - - - - This class defines utilities and constants that can be used by - all the client libraries of the SDK. - - - - - The user agent string header - - - - - The Set of accepted and valid Url characters per RFC3986. - Characters outside of this set will be encoded. - - - - - The Set of accepted and valid Url characters per RFC1738. - Characters outside of this set will be encoded. - - - - - The set of accepted and valid Url path characters per RFC3986. - - - - - The string representing Url Encoded Content in HTTP requests - - - - - The GMT Date Format string. Used when parsing date objects - - - - - The ISO8601Date Format string. Used when parsing date objects - - - - - The ISO8601Date Format string. Used when parsing date objects - - - - - The ISO8601 Basic date/time format string. Used when parsing date objects - - - - - The ISO8601 basic date format. Used during AWS4 signature computation. - - - - - The RFC822Date Format string. Used when parsing date objects - - - - - Returns an extension of a path. - This has the same behavior as System.IO.Path.GetExtension, but does not - check the path for invalid characters. - - - - - - Convert request parameters to Url encoded query string - - - Convert Dictionary of parameters to Url encoded query string - - - - Returns the canonicalized resource path for the service endpoint with single URL encoded path segments. - - Endpoint URL for the request - Resource path for the request - - If resourcePath begins or ends with slash, the resulting canonicalized - path will follow suit. - - Canonicalized resource path for the endpoint - - - - Returns the canonicalized resource path for the service endpoint - - Endpoint URL for the request - Resource path for the request - If true pre URL encode path segments if necessary. - S3 is currently the only service that does not expect pre URL encoded segments. - - If resourcePath begins or ends with slash, the resulting canonicalized - path will follow suit. - - Canonicalized resource path for the endpoint - - - - Returns the canonicalized resource path for the service endpoint - - Endpoint URL for the request - Resource path for the request - If true pre URL encode path segments if necessary. - S3 is currently the only service that does not expect pre URL encoded segments. - Dictionary of key/value parameters containing the values for the ResourcePath key replacements - The version of the marshaller that constructed the request object. - - If resourcePath begins or ends with slash, the resulting canonicalized - path will follow suit. - - Canonicalized resource path for the endpoint - - - - Splits the resourcePath at / into segments then resolves any keys with the path resource values. Greedy - key values will be split into multiple segments at each /. - - The patterned resourcePath - The key/value lookup for the patterned resourcePath - A list of path segments where all keys in the resourcePath have been resolved to one or more path segment values - - - - Joins all path segments with the / character and encodes each segment before joining. - - The segments of a URL path split at each / character - If the path property is specified, - the accepted path characters {/+:} are not encoded. - A joined URL with encoded segments - - - - Takes a patterned resource path and resolves it using the key/value path resources into - a segmented encoded URL. - - The patterned resourcePath - The key/value lookup for the patterned resourcePath - A segmented encoded URL - - - - Returns a new string created by joining each of the strings in the - specified list together, with a comma between them. - - The list of strings to join into a single, comma delimited - string list. - A new string created by joining each of the strings in the - specified list together, with a comma between strings. - - - - Attempt to infer the region for a service request based on the endpoint - - Endpoint to the service to be called - - Region parsed from the endpoint; DefaultRegion (or DefaultGovRegion) - if it cannot be determined/is not explicit - - - - - Attempt to infer the service name for a request (in short form, eg 'iam') from the - service endpoint. - - Endpoint to the service to be called - - Short-form name of the service parsed from the endpoint; empty string if it cannot - be determined - - - - - Utility method for converting Unix epoch seconds to DateTime structure. - - The number of seconds since January 1, 1970. - Converted DateTime structure - - - - Helper function to format a byte array into string - - The data blob to process - If true, returns hex digits in lower case form - String version of the data - - - - Calls a specific EventHandler in a background thread - - - - - - - - Parses a query string of a URL and returns the parameters as a string-to-string dictionary. - - - - - - - Utility method for converting a string to a MemoryStream. - - - - - - - Utility method for copy the contents of the source stream to the destination stream. - - - - - - - Utility method for copy the contents of the source stream to the destination stream. - - - - - - - - Formats the current date as a GMT timestamp - - A GMT formatted string representation - of the current date and time - - - - - Formats the current date as ISO 8601 timestamp - - An ISO 8601 formatted string representation - of the current date and time - - - - - Gets the ISO8601 formatted timestamp that is minutesFromNow - in the future. - - The number of minutes from the current instant - for which the timestamp is needed. - The ISO8601 formatted future timestamp. - - - - Formats the current date as ISO 8601 timestamp - - An ISO 8601 formatted string representation - of the current date and time - - - - - Gets the RFC822 formatted timestamp that is minutesFromNow - in the future. - - The number of minutes from the current instant - for which the timestamp is needed. - The ISO8601 formatted future timestamp. - - - - Determines whether the given string is an absolute path to a root. - - The hypothetical absolute path. - True if is an absolute path. - - - - Returns true if the path specified is relative to the current drive or working directory. - Returns false if the path is fixed to a specific drive or UNC path. This method does no - validation of the path (URIs will be returned as relative as a result). - - - Handles paths that use the alternate directory separator. It is a frequent mistake to - assume that rooted paths (Path.IsPathRooted) are not relative. This isn't the case. - "C:a" is drive relative- meaning that it will be resolved against the current directory - for C: (rooted, but relative). "C:\a" is rooted and not relative (the current directory - will not be used to modify the path). - - - - - True if the given character is a directory separator. - - - - - Returns true if the given character is a valid drive letter - - - - - URL encodes a string per RFC3986. If the path property is specified, - the accepted path characters {/+:} are not encoded. - - The string to encode - Whether the string is a URL path or not - The encoded string - - - - URL encodes a string per the specified RFC. If the path property is specified, - the accepted path characters {/+:} are not encoded. - - RFC number determing safe characters - The string to encode - Whether the string is a URL path or not - The encoded string - - Currently recognised RFC versions are 1738 (Dec '94) and 3986 (Jan '05). - If the specified RFC is not recognised, 3986 is used by default. - - - - - URL encodes a string per the specified RFC with the exception of preserving the encoding of previously encoded slashes. - If the path property is specified, the accepted path characters {/+:} are not encoded. - - The string to encode - Whether the string is a URL path or not - The encoded string with any previously encoded %2F preserved - - - - Convert bytes to a hex string - - Bytes to convert. - Hexadecimal string representing the byte array. - - - - Convert a hex string to bytes - - Hexadecimal string - Byte array corresponding to the hex string. - - - - Returns DateTime.UtcNow + ManualClockCorrection when - is set. - This value should be used instead of DateTime.UtcNow to factor in manual clock correction - - - - - Returns true if the string has any bidirectional control characters. - - - - - - - Executes an HTTP request and returns the response as a string. This method - throws WebException and HttpRequestException. In the event HttpRequestException - is thrown the StatusCode is sent as user defined data on the exception under - the key "StatusCode". - - The URI to make the request to - The request type: GET, PUT, POST - null or the content to send with the request - Timeout for the request - Proxy for the request - null or any headers to send with the request - The response as a string. - - - - Utility method that accepts a string and replaces white spaces with a space. - - - - - - - Runs a process with the below input parameters. - - - - - - - This method allows to check whether a property of an object returned by a service call - is set. This method is needed to discriminate whether a field is not set (not present in - the service response) or if it is set to the default value for its type. Using this - method is not required for nullable properties (non-ValueType and Nullable) because - they will be simply set to null when not included in the service response. - This method can also be used on objects used as part of service requests. - This method doesn't support objects that are part of the S3 service model. - - An object that is used in an AWS service request or is - returned as part of an AWS service response. - The name of the property of awsServiceObject to check. - True if the property is set, otherwise false. - - - - This method is used preserve the stacktrace used from clients that support async calls. This - make sure that exceptions thrown during EndXXX methods has the orignal stacktrace that happen - in the background thread. - - - - - - Provides access to EC2 instance metadata when running on an EC2 instance. - If this class is used on a non-EC2 instance, the properties in this class - will return null. - - - - Amazon EC2 instances can access instance-specific metadata, as well as data supplied when launching the instances, using a specific URI. - - - You can use this data to build more generic AMIs that can be modified by configuration files supplied at launch time. - For example, if you run web servers for various small businesses, they can all use the same AMI and retrieve their content from the - Amazon S3 bucket you specify at launch. To add a new customer at any time, simply create a bucket for the customer, add their content, - and launch your AMI. - - - More information about EC2 Metadata - - - - - - - - - - Allows to configure the proxy used for HTTP requests. The default value is null. - - - - - The AMI ID used to launch the instance. - - - - - The index of this instance in the reservation. - - - - - The manifest path of the AMI with which the instance was launched. - - - - - The AMI IDs of any instances that were rebundled to create this AMI. - Will only exist if the AMI manifest file contained an ancestor-amis key. - - - - - The private hostname of the instance. - In cases where multiple network interfaces are present, - this refers to the eth0 device (the device for which the device number is 0). - - - - - Notifies the instance that it should reboot in preparation for bundling. - Valid values: none | shutdown | bundle-pending. - - - - - The ID of this instance. - - - - - The type of instance. - - - - - The ID of the kernel launched with this instance, if applicable. - - - - - The local hostname of the instance. In cases where multiple network interfaces are present, - this refers to the eth0 device (the device for which device-number is 0). - - - - - The instance's MAC address. In cases where multiple network interfaces are present, - this refers to the eth0 device (the device for which device-number is 0). - - - - - The private IP address of the instance. In cases where multiple network interfaces are present, - this refers to the eth0 device (the device for which device-number is 0). - - - - - The Availability Zone in which the instance launched. - - - - - Product codes associated with the instance, if any. - - - - - Public key. Only available if supplied at instance launch time. - - - - - The ID of the RAM disk specified at launch time, if applicable. - - - - - The region in which the instance is running, extracted from the identity - document data. - - - - - ID of the reservation. - - - - - The names of the security groups applied to the instance. - - - - - Returns information about the last time the instance profile was updated, - including the instance's LastUpdated date, InstanceProfileArn, and InstanceProfileId. - - - - - Returns the temporary security credentials (AccessKeyId, SecretAccessKey, SessionToken, and Expiration) - associated with the IAM roles on the instance. - - - - - The virtual devices associated with the ami, root, ebs, and swap. - - - - - The network interfaces on the instance. - - - - - The metadata sent to the instance. - - - - - Value showing whether the customer has enabled detailed - one-minute monitoring in CloudWatch. - - - - - JSON containing instance attributes, such as instance-id, private IP - address, etc - - - - - Data that can be used by other parties to verify its origin and authenticity. - - - - - Used to verify the document's authenticity and content against the signature. - - - - - Return the list of items in the metadata at path. - - Path at which to query the metadata; may be relative or absolute. - List of items returned by the metadata service - - - - Return the metadata at the path - - Path at which to query the metadata; may be relative or absolute. - Data returned by the metadata service - - - - Return the metadata at the path - - Path at which to query the metadata; may be relative or absolute. - Number of attempts to make - Data returned by the metadata service - - - - Return the list of items in the metadata at path. - - Path at which to query the metadata; may be relative or absolute. - Number of attempts to make - List of items returned by the metadata service - - - - Fetches the api token to use with metadata requests. - - The API token or null - - - - Fetches the api token to use with metadata requests. - - The number of tries to fetch the api token before giving up and throwing the web exception - The API token or null if an API token couldn't be obtained and doesn't need to be used - - - - Exponentially sleeps based on the current retry value. A lower - value will sleep shorter than a larger value - - Base 0 retry index - - - - Returns information about the last time the instance profile was updated, - including the instance's LastUpdated date, InstanceProfileArn, and InstanceProfileId. - - - - - The status of the instance profile - - - - - Further information about the status of the instance profile - - - - - The date and time the instance profile was updated - - - - - The Amazon Resource Name (ARN) of the instance profile - - - - - The Id of the instance profile - - - - - The temporary security credentials (AccessKeyId, SecretAccessKey, SessionToken, and Expiration) associated with the IAM role. - - - - - The status of the security credential - - - - - Further information about the status of the instance profile - - - - - The date and time the security credential was last updated - - - - - The type of the security credential - - - - - The uniqe id of the security credential - - - - - The secret key used to sign requests - - - - - The security token - - - - - The date and time when these credentials expire - - - - - All of the metadata associated with a network interface on the instance. - - - - - Construct an instance of NetworkInterface - - - - - - The interface's Media Access Control (mac) address. - - - - - The ID of the owner of the network interface. - - - In multiple-interface environments, an interface can be attached by a third party, such as Elastic Load Balancing. - Traffic on an interface is always billed to the interface owner. - - - - - The interface's profile - - - - - The interface's local hostname. - - - - - The private IP addresses associated with the interface. - - - - - The interface's public hostname. - - - - - The elastic IP addresses associated with the interface. - - - There may be multiple IP addresses on an instance. - - - - - Security groups to which the network interface belongs. - - - - - IDs of the security groups to which the network interface belongs. Returned only for Amazon EC2 instances launched into a VPC. - - - - - The ID of the Amazon EC2-VPC subnet in which the interface resides. - - - Returned only for Amazon EC2 instances launched into a VPC. - - - - - The CIDR block of the Amazon EC2-VPC subnet in which the interface resides. - - - Returned only for Amazon EC2 instances launched into a VPC. - - - - - The CIDR block of the Amazon EC2-VPC subnet in which the interface resides. - - - Returned only for Amazon EC2 instances launched into a VPC. - - - - - Get the private IPv4 address(es) that are associated with the public-ip address and assigned to that interface. - - The public IP address - Private IPv4 address(es) associated with the public IP address - - - - Wrapper class which invokes the static method - public static string GetEnvironmentVariable(string variable) - underneath. This class is added as a property on the singleton class - EnvironmentVariableSource. This change was done for testability. - - - - - Singleton class that holds the property of type IEnvironmentVariableRetreiver. - This property can hold an instance of type EnvironmentVariableRetreiver which has a wrapper - method for - public static string GetEnvironmentVariable(string variable) - or can be mocked for testing purposes. - - - - - Interface for EnvironmentVariableRetriever. - This serves as a property for the singleton EnvironmentVariableSource - - - - - Manager to access a settings store file. Objects are primarily accessed by DisplayName rather than unique key. - Settings store files are located under the current user's AppData\Local\AWSToolkit folder. - Select keys in these files are encrypted on a per user, per machine basis using the Windows Data Protection API; - the encrypted values cannot be used by any other user or on any other machine. - - This class is not threadsafe. - - - - - True if the encrypted store is availble, false otherwise. - - - - - Construct an NamedSettingsManager. - - The base filename to read/write. - - - - Register an object. Let the uniqueKey be assigned automatically. - - The display name for the object. - The property names and values for the object. - The unique key that was assigned to the object. - - - - Try to get an object form the store. - - The display name for the object. - The property names and values for the object. - True if the object was found, false otherwise. - - - - Try to get an object form the store. - - The display name for the object. - The uniqueKey of the object in the store - The property names and values for the object. - True if the object was found, false otherwise. - - - - Unregister an object from the store. - - The display name for the object. - - - - Rename an object in the store. - - - - if true and destination object already exists overwrite it - - - - Copy an object in the store. - The new object will be a copy of the original, except it will be assigned a new unique key. - - - - if true and destination object already exists overwrite it - - - - Get a list of the display names for the objects in the store. - - A list of display names. - - - - Root AWS config - - - - - Manager to access a settings store file. - Settings store files are located under the current user's AppData\Local\AWSToolkit folder. - Select keys in these files are encrypted on a per user, per machine basis using the Windows Data Protection API; - the encrypted values cannot be used by any other user or on any other machine. - - This class is not threadsafe. - - - - - True if the encrypted store is availble, false otherwise. - - - - - Construct a SettingsManager. - - The base filename to read/write. - - - - The base filename to read/write. - - - - - Register an object. Let the uniqueKey be assigned automatically. - - The property names and values for the object. - The unique key that was assigned to the object. - - - - Register an object. - - The uniqueKey for the object, or null if one should be assigned automatically. - The property names and values for the object. - The unique key that was assigned to the object. - - - - Try to get an object form the store. - - The uniqueKey of the object in the store - The property names and values for the object. - True if the object was found, false otherwise. - - - - Try to get an object form the store based on the value of a specific property. - If multiple objects with the same property value exist, return the first one. - - The name of the property to search on. - The value of the property to search on. - The unique key of the object. - The properties of the object. - - - - - Get a list of the unique keys of all the objects in the store. - - - - - - Get the value of a specific property for each object in the store. - - - - - - - Unregister an object from the store. - - The unique key for the object. - - - - Class that contains result of executing an external process through the SDKs - AWSSDKUtils.RunProcess/AWSSDKUtils.RunProcessAsync - - - - - The exit code with which the process exited - - - - - The output of the process read till the end - - - - - The error output of the process read till the end - - - - - This class allows profiles supporting AWS credentials and SAML-based authentication to be registered with - the SDK so that they can later be reference by a profile name. The credential profiles will be available - for use in the AWS Toolkit for Visual Studio and the AWS Tools for Windows PowerShell. - - The credentials are stored under the current users AppData folder encrypted using Windows Data Protection API. - - - To reference a profile from an application's App.config or Web.config use the AWSProfileName setting. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="development"/> - </appSettings> - </configuration> - - - - - - - Registers an AWS credentials profile that can later be referenced by the profileName. - This profile will only be visible for the current user. - - Name given to the AWS credentials. - The AWS access key id - The AWS secret key - - - - - Registers a role-based profile to be used with SAML authentication. The profile contains - details of the role to be assumed when AWS credentials are requested based on the role and - a reference to a SAML endpoint profile containing details of the endpoint to be called to - authenticate the user. - - - If user identity information is not supplied then the identity of the logged-in user will - be used when authenticaton is performed against the endpoint referenced in the SAML endpoint - profile. If identity is provided, no password information is stored in the role profile and - the user must supply the password for the identity prior to authentication with the endpoint. - - - Name to be assigned to the profile - - The name assigned to the endpoint settings, previously saved with RegisterSAMLEndpoint. - - - The arn of the role that the user wants to assume when using this profile. This - must be one of the set returned by the saml endpoint when the user authenticates. - - - Optional. By default the identity of the logged-in user will be used when authentication - is performed - the user will not be prompted to supply a password. By supplying a custom - identity for this parameter, the user will be prompted to supply the password for the - identity prior to authentication. - - - - - - Registers a role-based profile to be used with SAML authentication. The profile contains - details of the role to be assumed when AWS credentials are requested based on the role and - a reference to a SAML endpoint profile containing details of the endpoint to be called to - authenticate the user. - - - If user identity information is not supplied then the identity of the logged-in user will - be used when authenticaton is performed against the endpoint referenced in the SAML endpoint - profile. If identity is provided, no password information is stored in the role profile and - the user must supply the password for the identity prior to authentication with the endpoint. - - - Name to be assigned to the profile - - The name assigned to the endpoint settings, previously saved with RegisterSAMLEndpoint. - - - The arn of the role that the user wants to assume when using this profile. This - must be one of the set returned by the saml endpoint when the user authenticates. - - - Optional. By default the identity of the logged-in user will be used when authentication - is performed - the user will not be prompted to supply a password. By supplying a custom - identity for this parameter, the user will be prompted to supply the password for the - identity prior to authentication. - - - Set for profiles intended to be used in regions where a region-specific STS endpoint - must be used (eg cn-north-1). If left empty/null, the global sts.amazonaws.com endpoint - will be used when credentials are obtained for this profile. - - - - - Registers an endpoint to be used in conjunction with SAML role profiles. The role profiles - reference the endpoint settings to obtain the actual endpoint and any customization settings - needed to perform authentication. - - Name to be assigned to the endpoint settings. - The full uri of the authentication endpoint. - - The authentication type to use when performing calls against the endpoint. Valid values are 'NTLM', - 'Digest', 'Kerberos' and 'Negotiate'. The default if not configured (null/empty string) is 'Kerberos'. - - The unique id assigned to the new settings. - - - - Deletes the settings for an AWS credentials or SAML role profile from the SDK account store. - - The name of the profile to remove. - - - - Lists all profile names registered with the SDK account store. - - The profile names. - - - - Loads and returns all available credential profiles registered in the store. - - Collection of profiles. - - - - Checks if a given profile is known in the SDK credential store. - - The name of the profile to test for existence - True if the profile exists. - - - - Copies the contents of the source profile to the destination. If the destination - profile does not exist a new profile is created. Note that if the destination - profile exists, all keys it contains are removed and replaced with keys from the - source profile. - - The name of the profile to copy from. - The name of the profile to create or update. - The unique id assigned to the destination settings. - - - - Copies the contents of the source profile to the destination. If the destination - profile does not exist a new profile is created. Note that if the destination - profile exists, all keys it contains are removed and replaced with keys from the - source profile. - - The source profile to copy keys and values from. - The name of the profile to create or update. - The unique id assigned to the destination settings. - - - - Tries to get the AWS credentials from a profile in the SDK account store. - - The profile to get the credentials for. - Outputs the credentials for the profile. - Returns true if the profile exists otherwise false is returned. - - - - Gets the AWS credentials from a profile in the SDK account store. - - The profile to get the credentials for. - The AWS credentials for the profile. - Thrown if the profile does not exist - - - - Returns the profile with the specified name, if it has been registered in the SDK store. - - The name of the registered profile - The loaded profile data - - - - Returns the persisted data in the SDK store as a profile of the specified type T. - - The name of the profile holding the settings. - The loaded profile. An exception is thrown if the profile could not be loaded. - Thrown if the profile does not exist - - Currently supported profile types: AWSCredentialsProfile and SAMLRoleProfile. - - - - - Tries to load the specified profile data corresponding to profile type T from a named - profile in the SDK account store. - - The name of the profile holding the settings. - The loaded profile data. - Returns true if the profile exists otherwise false is returned. - - Currently supported profile types: AWSCredentialsProfile and SAMLRoleProfile. - - - - - Attempts to load the settings defining a SAML endpoint. - - The name assigned to the settings for the endpoint. - The instantiated endpoint. - True if the settings were successfully loaded. - - - - Loads the settings defining a SAML endpoint. - - The name assigned to the settings for the endpoint. - The loaded settings. An exception is thrown if they could not be loaded. - Thrown if the endpoint settings do not exist. - - - - Common base contract for all types of credential and role profiles. - - - - - The user-defined name for the settings. - - - - - The unique id of the profile in the backing store. - - - - - Saves the profile data to backing store, returning the unique id - assigned to the data. - - - - - The persisted data for a set of AWS credentials. At a minimum this - is access key and secret key data. - - - - - Tests if an AWSCredentialsProfile instance could be instantiated from - the persisted settings data. - - The name given to the persisted settings (previously verified as existing). - True if the settings are compatible with an AWSCredentialsProfile type. - - - - Tests if an AWSCredentialsProfile instance could be instantiated from - the persisted settings data. - - The persisted settings. - True if the settings are compatible with an AWSCredentialsProfile type. - - - - Instantiates an AWSCredentialsProfile instance from the specified profile name. - - The name of the profile holding the settings. - New credentials profile instance. An exception is thrown if the profile data is invalid. - - - - Instantiates an AWSCredentialsProfile instance from the supplied settings collection. - - The settings representing the stored profile. - New credentials profile instance. An exception is thrown if the profile data is invalid. - - - - Validates the contents of the specified profile. - - The name of the AWS credentials profile to validate. - Thrown if the profile settings fail to validate. - - - - Verifies that the persisted settings contains the minimal viable data to - instantiate an AWSCredentialsProfile instance. - - The persisted settings. - Thrown if the profile settings fail to validate. - - - - Persists the profile data to the store file. - - The unique ID assigned to the settings. - - - - Creates or updates the profile data in the store file. - - The unique ID assigned to the settings. - - - - The persisted data for a SAML endpoint. One or more role profiles - will reference this to obtain the common endpoint and other data needed - to perform authentication with a set of user credentials. - - - - - The default authentication type to use when attempting to perform an - authentication call against the configured endpoint. - - - - - The authentication endpoint which must be a HTTPS scheme. - - - - - The authentication type to use when calling the endpoint. - - - - - Tests if a SAMLEndpointSettings instance could be instantiated from - the persisted settings data. - - The name given to the persisted settings. - True if the settings are compatible. - - - - Tests if a SAMLEndpointSettings instance could be instantiated from - the persisted settings data. - - The persisted settings. - True if the settings are compatible. - - - - Instantiates an instance from settings stored with the specified name. - - The name of the endpoint settings in the store. - Profile instance or an exception if the profile data does not exist/contains invalid data. - - - - Instantiates an instance from the supplied settings. - - The persisted settings. - Profile instance or an exception if the profile data is invalid. - - - - Validates the contents of the specified endpoint settings. - - The name of the SAML endpoint settings to validate. - Thrown if the settings fail to validate. - - - - Verifies that the persisted settings contains the minimal viable data to - instantiate a SAMLEndpointSettings instance. - - The persisted settings. - Thrown if the settings fail to validate. - - - - Persists the settings to the storage file. - - The unique id assigned to the profile - - - - Creates or updates the settings data for a SAML endpoint in the backing store file. An error is - thrown if the scheme for the endpoint is not https. - - The name of the settings to create or update - The authentication endpoint - Optional authentication type to use when performing calls against the endpoint - The unique id assigned to the profile - - - - Constructs an endpoint settings instance. - - The user-defined name to assign to the settings. - - The absolute uri, including any query and relyingParty data, of the endpoint. - - - The authentication type to use when performing requests against the endpoint. - - - - - - The persisted data for a saml role profile for a user. This profile - references an endpoint profile containing the actual endpoint to be used, and - adds details of the role to be assumed when the profile is selected. - - - Optionally the profile can store a username and domain to be used during - authentication (default behavior, if this is not specified, is to use the user's - default network credentials). - - - - - - The ARN of the role that is to be assumed. - - - - - If non-default network credentials are to used contains - the user identity (in domain\user format, domain optional) that - should be used to supply credentials when the profile is used in - authentication. The user must be prompted to supply the - corresponding password prior to authentication. - - - - - If a specific user identity was specified in the profile, - returns true to indicate a password needs to be obtained from - the user before obtaining network credentials to be used on - authentication. The default is to use the credentials - associated with the currently logged-in user or process to - perform authentication, which does not require the user to be - prompted. - - - - - - For regions with a region-specific endpoint for STS (eg cn-north-1) this - field can be set to ensure calls to obtain temporary credentials - after successful authentication are forwarded to the correct regional - endpoint. - - - This field does not need to be set when running in a region for - which the sts.amazonaws.com endpoint is valid. - - - - - - Retrieves the active credential session, if any, associated with the - role profile. - - - The current credentials valid for the role specified in the profile. Returns - null if no active session is available, or the active session has expired. - - - When a user successfully authenticates and receives temporary AWS - credentials for a role, the profile is updated with details of the - session. When the profile is loaded by other processes or tools, if - session data is present and still valid it can be retrieved using this - method avoiding the need to re-authenticate and get additional temporary - credentials. - - - - - Persists the current credentials to a 'session' key in the RoleSessions.json file. - This enables external applications and tools using the same profile to obtain credentials - without needing to separately re-authenticate the user prior to expiry of the current - credentials. After persisting the session data it can be retrieved using GetCurrentSession(). - - - Although the credentials are temporary we still encrypt the stored data when at rest in - the sdk credential store. - - - The current credentials valid for the role specified in the profile. - - - - - Stores or clears the persisted session data. - - - - - - The endpoint settings from which the actual endpoint to use in authentication - is obtained. - - - - - Tests if a SAMLRoleProfile instance could be instantiated from - the persisted settings data. - - The name given to the persisted settings. - True if the settings are compatible with a SAMLRoleProfile type. - - - - Tests if a SAMLRoleProfile instance could be instantiated from - the persisted settings data. - - The persisted settings. - True if the settings are compatible with a SAMLRoleProfile type. - - - - Instantiates an instance from settings stored with the specified name. - - The name of the endpoint profile. - Profile instance or an exception if the profile data does not exist/contains invalid data. - - - - Instantiates an instance from the supplied settings. In addition to the profile settings - the SDK will inspect for a RoleSessions.json file containing active session data and if - an entry for the profile is present, will add the session data to the returned profile - object. - - The persisted settings. - Profile instance or an exception if the profile data is invalid. - - - - Validates the contents of the specified profile. - - The name of the SAML role profile to validate. - Thrown if the profile settings fail to validate. - - - - Validates that the presented settings would result in a valid role profile - instance. - - The persisted settings. - Thrown if the profile settings fail to validate. - - - - Stores the data in the role profile to the backing store file. - - - - - - Registers a role-based profile to be used with SAML authentication. The profile contains - details of the role to be assumed when AWS credentials are requested based on the role and - a reference to a SAML endpoint profile containing details of the endpoint to be called to - authenticate the user. - - - If user identity information is not supplied then the identity of the logged-in user will - be used when authenticaton is performed against the endpoint referenced in the SAML endpoint - profile. If identity is provided, no password information is stored in the role profile and - the user must supply the password for the identity prior to authentication with the endpoint. - - - Name to be assigned to the profile - - The name of the settings in the SAML endpoints file containing details of the - endpoint to authenticate with. - - - The arn of the role that the user wants to assume when using this profile. This - must be one of the set returned by the saml endpoint when the user authenticates. - - - Optional, can be used to prompt the user for a password for the account when authentication - is performed from a system that is not domain-joined. - - - Optional, details of the currently active credentials for the role that we want to - persist into the profile for other tools or processes to pick up, avoiding the need - to continually re-authenticate the user as they switch between tools. The active session, - if any, is stored separately from the profile using the file RoleSessions.json. - - - Set for profiles intended to be used in regions where a region-specific STS endpoint - must be used (eg cn-north-1). If left empty/null, the global sts.amazonaws.com endpoint - will be used when credentials are obtained for this profile. - - The unique id assigned to the profile. - - - - Tests for and loads any active session credentials for the specified profile. The session data - exists in a separate file from the profile, RoleSessions.json. - - - - - - - Stores the supplied session data into the RoleSessions.json backing file. - - - - - - - Constructs a profile data instance that will use the specified network identity - during authentication with configured endpoint. - - The user-defined name of the profile that sourced this data. - The settings for the authentication endpoint. - The role that should be assumed on successful authentication. - The credentials to supply in authentication, in domain\user format. - - Deserialized credential data from the profile, if still valid. Null if the profile does not - contain any active credentials, or the credentials it did hold are now invalid. - - - Set for profiles intended to be used in regions where a region-specific STS endpoint - must be used (eg cn-north-1). If left empty/null, the global sts.amazonaws.com endpoint - will be used when credentials are obtained for this profile. - - - - - Object to track circular references in nested types. - At each level of nesting, make a call to Track to retrieve Tracker, - a tracking object implementing the IDisposable interface. - Dispose of this tracker when leaving the context of the tracked object. - - - - - Tracker. Must be disposed. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Adds the current target to a reference list and returns a tracker. - The tracker removes the target from the reference list when the - tracker is disposed. - - - - - - - Utility class to parse Amazon resource names more commonly known as an ARN. - - - - - Gets and sets the partition associated with the ARN (e.g.: 'aws'). - - - - - Gets and sets the AWS service associated with the ARN (e.g.: 's3'). - - - - - Gets and sets the region associated with the ARN (e.g.: 'us-east-1'). - - - - - Gets and sets the account ID associated with the ARN. - - - - - Gets and sets the resource associated with the ARN (e.g.: 'mybucket/myobject'). - - - - - Returns true if the string appears to be an ARN by seeing if the string starts with "arn:". This method - doesn't guarantee the string is a valid ARN. To validate the string call TryParse. - - - - - - - Parses the string into an ARN object. - - String to parse into an ARN. - The out parameter for the ARN object created by TryParse. - True if the string can be parsed into an ARN object. - - - - Parses the string into an ARN object. - - String to parse into an Arn. - The Arn object created from the passed in string. - Thrown if arnString is null. - Thrown if the string passed in not valid ARN. - - - - Turns the Arn object into a string representation of an ARN. - - - - - - Configuration options that apply to the entire SDK. - - These settings can be configured through app.config or web.config. - Below is a full sample configuration that illustrates all the possible options. - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws region="us-west-2"> - <logging logTo="Log4Net, SystemDiagnostics" logResponses="Always" logMetrics="true" /> - <s3 useSignatureVersion4="true" /> - <proxy host="localhost" port="8888" username="1" password="1" /> - - <dynamoDB> - <dynamoDBContext tableNamePrefix="Prod-"> - - <tableAliases> - <alias fromTable="FakeTable" toTable="People" /> - <alias fromTable="Persons" toTable="People" /> - </tableAliases> - - <mappings> - <map type="Sample.Tests.Author, SampleDLL" targetTable="People" /> - <map type="Sample.Tests.Editor, SampleDLL" targetTable="People"> - <property name="FullName" attribute="Name" /> - <property name="EmployeeId" attribute="Id" /> - <property name="ComplexData" converter="Sample.Tests.ComplexDataConverter, SampleDLL" /> - <property name="Version" version="true" /> - <property name="Password" ignore="true" /> - </map> - </mappings> - - </dynamoDBContext> - </dynamoDB> - </aws> - - - - Configuration options that apply to the entire SDK. - - - - - Manual offset to apply to client clock. This is a global setting that overrides - ClockOffset value calculated for all service endpoints. - - - - - Determines if the SDK should correct for client clock skew - by determining the correct server time and reissuing the - request with the correct time. - Default value of this field is True. - will be updated with the calculated - offset even if this field is set to false, though requests - will not be corrected or retried. - Ignored if is set. - - - - - The calculated clock skew correction, if there is one. - This field will be set if a service call resulted in an exception - and the SDK has determined that there is a difference between local - and server times. - - If is set to true, this - value will be set to the correction, but it will not be used by the - SDK and clock skew errors will not be retried. - - - - - Key for the AWSRegion property. - - - - - - Configures the default AWS region for clients which have not explicitly specified a region. - Changes to this setting will only take effect for newly constructed instances of AWS clients. - - This setting can be configured through the App.config. For example: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws region="us-west-2" /> - - - - - - Key for the AWSProfileName property. - - - - - - Profile name for stored AWS credentials that will be used to make service calls. - Changes to this setting will only take effect in newly-constructed clients. - - To reference the account from an application's App.config or Web.config use the AWSProfileName setting. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="development"/> - </appSettings> - </configuration> - - - - - - - Key for the AWSProfilesLocation property. - - - - - - Location of the credentials file shared with other AWS SDKs. - By default, the credentials file is stored in the .aws directory in the current user's home directory. - - Changes to this setting will only take effect in newly-constructed clients. - - To reference the profile from an application's App.config or Web.config use the AWSProfileName setting. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfilesLocation" value="c:\config"/> - </appSettings> - </configuration> - - - - - - - Key for the Logging property. - - - - - - Configures how the SDK should log events, if at all. - Changes to this setting will only take effect in newly-constructed clients. - - The setting can be configured through App.config, for example: - - <appSettings> - <add key="AWSLogging" value="log4net"/> - </appSettings> - - - - - - Key for the ResponseLogging property. - - - - - - - Configures when the SDK should log service responses. - Changes to this setting will take effect immediately. - - The setting can be configured through App.config, for example: - - <appSettings> - <add key="AWSResponseLogging" value="OnError"/> - </appSettings> - - - - - - Key for the LogMetrics property. - - - - - - Configures if the SDK should log performance metrics. - This setting configures the default LogMetrics property for all clients/configs. - Changes to this setting will only take effect in newly-constructed clients. - - The setting can be configured through App.config, for example: - - <appSettings> - <add key="AWSLogMetrics" value="true"/> - </appSettings> - - - - - - Key for the EndpointDefinition property. - - - - - - Configures if the SDK should use a custom configuration file that defines the regions and endpoints. - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws endpointDefinition="c:\config\endpoints.json" /> - - - - - - Key for the UseSdkCache property. - - - - - - Configures if the SDK Cache should be used, the default value is true. - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws useSdkCache="true" /> - - - - - - Configuration for the Logging section of AWS configuration. - Changes to some settings may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws> - <logging logTo="Log4Net, SystemDiagnostics" logResponses="Always" logMetrics="true" /> - </aws> - - - - - - Configuration for the Proxy section of AWS configuration. - Changes to some settings may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws> - <proxy host="localhost" port="8888" username="1" password="1" bypassList="addressexpr1;addressexpr2;..." bypassOnLocal="true" /> - </aws> - - - - - - Configuration for the region endpoint section of AWS configuration. - Changes may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws region="us-west-2" /> - - - - - - Lock for SomeEvent delegate access. - - - - - This method should never be called directly. - Call AWSSDKUtils.CorrectedUtcNow instead. - - - - - - The unique application name for the current application. This values is currently used - by high level APIs (Mobile Analytics Manager and Cognito Sync Manager) to create a unique file - path to store local database files. - Changes to this setting will only take effect in newly-constructed objects using this property. - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws applicationName="" /> - - - - - - Add a listener for SDK logging. - - If the listener does not have a name, you will not be able to remove it later. - The source to log for, e.g. "Amazon", or "Amazon.DynamoDB". - The listener to add. - - - - Remove a trace listener from SDK logging. - - The source the listener was added to. - The name of the listener. - - - - Generates a sample XML representation of the SDK configuration section. - - - The XML returned has an example of every tag in the SDK configuration - section, and sample input for each attribute. This can be included in - an App.config or Web.config and edited to suit. Where a section contains - a collection, multiple of the same tag will be output. - - Sample XML configuration string. - - - - Logging options. - Can be combined to enable multiple loggers. - - - - - No logging - - - - - Log using log4net - - - - - Log using System.Diagnostics - - - - - Log to the console - - - - - Response logging option. - - - - - Never log service response - - - - - Only log service response when there's an error - - - - - Always log service response - - - - - Format for metrics data in the logs - - - - - Emit metrics in human-readable format - - - - - Emit metrics as JSON data - - - - - Allows to configure the proxy used for HTTP requests. The default value is null. - - - - - This class contains the endpoints available to the AWS clients. The static constants representing the - regions can be used while constructing the AWS client instead of looking up the exact endpoint URL. - - - - - Gets the endpoint for a service in a region. - - The services system name. - If true returns the endpoint for dualstack - Thrown when the request service does not have a valid endpoint in the region. - - - - - Enumerate through all the regions. - - - - - Gets the region based on its system name like "us-west-1" - - The system name of the service like "us-west-1" - - - - - This is a testing method and should not be called by production applications. - - - - - Gets the system name of a region. - - - - - Gets the display name of a region. - - - - - This region name is non-standard. Search the whole endpoints.json file to - determine the partition this region is in. - - - - - This class contains region information used to lazily compute the service endpoints. The static constants representing the - regions can be used while constructing the AWS client instead of looking up the exact endpoint URL. - - - - - The US East (Virginia) endpoint. - - - - - The US East (Virginia) regional endpoint. - - - - - The US East (Ohio) endpoint. - - - - - The US West (N. California) endpoint. - - - - - The US West (Oregon) endpoint. - - - - - The EU North (Stockholm) endpoint. - - - - - The EU West (Ireland) endpoint. - - - - - The EU West (London) endpoint. - - - - - The EU West (Paris) endpoint. - - - - - The EU Central (Frankfurt) endpoint. - - - - - The Asia Pacific (Hong Kong) endpoint. - - - - - The Asia Pacific (Tokyo) endpoint. - - - - - The Asia Pacific (Seoul) endpoint. - - - - - The Asia Pacific (Osaka-Local) endpoint. - - - - - The Asia Pacific (Mumbai) endpoint. - - - - - The Asia Pacific (Singapore) endpoint. - - - - - The Asia Pacific (Sydney) endpoint. - - - - - The South America (Sao Paulo) endpoint. - - - - - The US GovCloud East (Virginia) endpoint. - - - - - The US GovCloud West (Oregon) endpoint. - - - - - The China (Beijing) endpoint. - - - - - The China (Ningxia) endpoint. - - - - - The Canada (Central) endpoint. - - - - - The Middle East (Bahrain) endpoint. - - - - - Represents the endpoint overridding rules in the endpoints.json - Is used to map private region (ie us-east-1-regional) to public regions (us-east-1) - For signing purposes. - - - - - Enumerate through all the regions. - - - - - Gets the region based on its system name like "us-west-1" - - The system name of the service like "us-west-1" - - - - - Gets the region endpoint override if exists - - The region endpoint to find the possible override for - - - - - Gets the system name of a region. - - - - - Gets the display name of a region. - - - - - Gets the partition name the region is in. For example for us-east-1 the partition name is aws. For cn-northwest-1 the partition name is aws-cn. - - - - - Gets the dns suffix for the region endpoints in a partition. For example the aws partition's suffix is amazonaws.com. The aws-cn partition's suffix is amazonaws.com.cn. - - - - - Gets the endpoint for a service in a region. - - - The services system name. Service system names can be obtained from the - RegionEndpointServiceName member of the ClientConfig-derived class for the service. - - - For forwards compatibility, if the service being requested for isn't known in the region, this method - will generate an endpoint using the AWS endpoint heuristics. In this case, it is not guaranteed the - endpoint will point to a valid service endpoint. - - - - - - Gets the endpoint for a service in a region, optionally selecting a dualstack compatible endpoint. - - - The services system name. Service system names can be obtained from the - RegionEndpointServiceName member of the ClientConfig-derived class for the service. - - - If true a dualstack endpoint is returned. It is the user's responsibility to verify that the given service - supports a dualstack endpoint for the region. - - - For forwards compatibility, if the service being requested for isn't known in the region, this method - will generate an endpoint using the AWS endpoint heuristics. In this case, it is not guaranteed the - endpoint will point to a valid service endpoint. - - - - - - This class defines an endpoints hostname and which protocols it supports. - - - - - Gets the hostname for the service. - - - - - The authentication region to be used in request signing. - - - - - This property is only set for S3 endpoints. For all other services this property returns null. - For S3 endpoints, if the endpoint supports signature version 2 this property will be "2", otherwise it will be "4". - - - - a general purpose ASN.1 decoder - note: this class differs from the - others in that it returns null after it has read the last object in - the stream. If an ASN.1 Null is encountered a Der/BER Null object is - returned. - - - Create an ASN1InputStream where no DER object will be longer than limit. - - @param input stream containing ASN.1 encoded data. - @param limit maximum size of a DER encoded object. - - - Create an ASN1InputStream based on the input byte array. The length of DER objects in - the stream is automatically limited to the length of the input array. - - @param input array containing ASN.1 encoded data. - - - build an object given its tag and the number of bytes to construct it from. - - - Create a base ASN.1 object from a byte array. - The byte array to parse. - The base ASN.1 object represented by the byte array. - If there is a problem parsing the data. - - - Read a base ASN.1 object from a stream. - The stream to parse. - The base ASN.1 object represented by the byte array. - If there is a problem parsing the data. - - - return the object at the sequence position indicated by index. - - @param index the sequence number (starting at zero) of the object - @return the object at the sequence position indicated by index. - - - create an empty sequence - - - create a sequence containing one object - - - create a sequence containing a vector of objects. - - - - A - - - - - - A - - - A - - - - - - A - - - - - return a = a + b - b preserved. - - - unsigned comparison on two arrays - note the arrays may - start with leading zeros. - - - returns x = x - y - we assume x is >= y - - - - Calculates a 32bit Cyclic Redundancy Checksum (CRC) using the - same polynomial used by Zip. This type is used internally by DotNetZip; it is generally not used directly - by applications wishing to create, read, or manipulate zip archive files. - - - - - indicates the total number of bytes read on the CRC stream. - This is used when writing the ZipDirEntry when compressing files. - - - - - Indicates the current CRC for all blocks slurped in. - - - - - Returns the CRC32 for the specified stream. - - The stream over which to calculate the CRC32 - the CRC32 calculation - - - - Returns the CRC32 for the specified stream, and writes the input into the output stream. - - The stream over which to calculate the CRC32 - The stream into which to deflate the input - the CRC32 calculation - - - - Get the CRC32 for the given (word,byte) combo. - This is a computation defined by PKzip. - - The word to start with. - The byte to combine it with. - The CRC-ized result. - - - - Update the value for the running CRC32 using the given block of bytes. - This is useful when using the CRC32() class in a Stream. - - block of bytes to slurp - starting point in the block - how many bytes within the block to slurp - - - - A Stream that calculates a CRC32 (a checksum) on all bytes read, - or on all bytes written. - - - - - This class can be used to verify the CRC of a ZipEntry when reading from a stream, - or to calculate a CRC when writing to a stream. The stream should be used to either - read, or write, but not both. If you intermix reads and writes, the results are - not defined. - - This class is intended primarily for use internally by the DotNetZip library. - - - - - Gets the total number of bytes run through the CRC32 calculator. - - - - This is either the total number of bytes read, or the total number - of bytes written, depending on the direction of this stream. - - - - - The constructor. - - The underlying stream - - - - The constructor. - - The underlying stream - The length of the stream to slurp - - - - Provides the current CRC for all blocks slurped in. - - - - - Read from the stream - - the buffer to read - the offset at which to start - the number of bytes to read - the number of bytes actually read - - - - Write to the stream. - - the buffer from which to write - the offset at which to start writing - the number of bytes to write - - - - Indicates whether the stream supports reading. - - - - - Indicates whether the stream supports seeking. - - - - - Indicates whether the stream supports writing. - - - - - Flush the stream. - - - - - Not implemented. - - - - - Not implemented. - - - - - Not implemented. - - N/A - N/A - N/A - - - - Not implemented. - - N/A - - - diff --git a/packages/AWSSDK.Core.3.5.0-beta/lib/net45/AWSSDK.Core.dll b/packages/AWSSDK.Core.3.5.0-beta/lib/net45/AWSSDK.Core.dll deleted file mode 100644 index eac6edc..0000000 Binary files a/packages/AWSSDK.Core.3.5.0-beta/lib/net45/AWSSDK.Core.dll and /dev/null differ diff --git a/packages/AWSSDK.Core.3.5.0-beta/lib/net45/AWSSDK.Core.xml b/packages/AWSSDK.Core.3.5.0-beta/lib/net45/AWSSDK.Core.xml deleted file mode 100644 index 04560b6..0000000 --- a/packages/AWSSDK.Core.3.5.0-beta/lib/net45/AWSSDK.Core.xml +++ /dev/null @@ -1,14372 +0,0 @@ - - - - AWSSDK.Core - - - - - An access control policy action identifies a specific action in a service - that can be performed on a resource. For example, sending a message to a - queue. - - ActionIdentifiers allow you to limit what your access control policy statement affects. - For example, you could create a policy statement that enables a certain group - of users to send messages to your queue, but not allow them to perform any - other actions on your queue. - - - The action is B in the statement - "A has permission to do B to C where D applies." - - Free form access control policy actions may include a wildcard (*) to match - multiple actions. - - - Constants for known actions can be found in the Amazon.Auth.AccessControlPolicy.ActionIdentifiers namespace. - - - - - - Constructs an Actionidentifer with the given action name. - - The name of the action - - - - Gets and sets the name of this action. For example, 'sqs:SendMessage' is the - name corresponding to the SQS action that enables users to send a message - to an SQS queue. - - - - - The available AWS access control policy actions for Amazon AppStream. - - - - - - The available AWS access control policy actions for Auto Scaling. - - - - - - The available AWS access control policy actions for AWS Billing. - - - - - - The available AWS access control policy actions for AWS CloudFormation. - - - - - - The available AWS access control policy actions for Amazon CloudFront. - - - - - - The available AWS access control policy actions for Amazon CloudSearch. - - - - - - The available AWS access control policy actions for AWS CloudTrail. - - - - - - The available AWS access control policy actions for Amazon CloudWatch. - - - - - - The available AWS access control policy actions for Amazon CloudWatch Logs. - - - - - - The available AWS access control policy actions for Amazon Cognito Identity. - - - - - - The available AWS access control policy actions for Amazon Cognito Sync. - - - - - - The available AWS access control policy actions for AWS Direct Connect. - - - - - - The available AWS access control policy actions for Amazon DynamoDB. - - - - - - The available AWS access control policy actions for Amazon EC2. - - - - - - The available AWS access control policy actions for AWS ElastiCache. - - - - - - The available AWS access control policy actions for AWS Elastic Beanstalk. - - - - - - The available AWS access control policy actions for Elastic Load Balancing. - - - - - - The available AWS access control policy actions for Amazon Elastic MapReduce. - - - - - - The available AWS access control policy actions for Amazon Elastic Transcoder. - - - - - - The available AWS access control policy actions for Amazon Glacier. - - - - - - The available AWS access control policy actions for AWS Identity and Access Management. - - - - - - The available AWS access control policy actions for AWS Import Export. - - - - - - The available AWS access control policy actions for Amazon Kinesis. - - - - - - The available AWS access control policy actions for AWS Marketplace. - - - - - - The available AWS access control policy actions for AWS Marketplace Management Portal. - - - - - - The available AWS access control policy actions for Amazon Mobile Analytics. - - - - - - The available AWS access control policy actions for AWS OpsWorks. - - - - - - The available AWS access control policy actions for Amazon RDS. - - - - - - The available AWS access control policy actions for Amazon Redshift. - - - - - - The available AWS access control policy actions for Amazon Route 53. - - - - - - The available AWS access control policy actions for Amazon S3. - - - - - - The available AWS access control policy actions for AWS Security Token Service. - - - - - - The available AWS access control policy actions for Amazon SES. - - - - - - The available AWS access control policy actions for Amazon SimpleDB. - - - - - - The available AWS access control policy actions for Amazon Simple Workflow Service. - - - - - - The available AWS access control policy actions for Amazon SNS. - - - - - - The available AWS access control policy actions for Amazon SQS. - - - - - - The available AWS access control policy actions for Amazon Storage Gateway. - - - - - - The available AWS access control policy actions for AWS Whispersync. - - - - - - The available AWS access control policy actions for Amazon Zocalo. - - - - - - AWS access control policy conditions are contained in - objects, and affect when a statement is applied. For example, a statement - that allows access to an Amazon SQS queue could use a condition to only apply - the effect of that statement for requests that are made before a certain - date, or that originate from a range of IP addresses. - - Multiple conditions can be included in a single statement, and all conditions - must evaluate to true in order for the statement to take effect. - - - The set of conditions is D in the statement - "A has permission to do B to C where D applies." - - - A condition is composed of three parts: - - - Condition Key - The condition key declares which value of a - request to pull in and compare against when a policy is evaluated by AWS. For - example, using will cause - AWS to pull in the current request's source IP as the first value to compare - against every time your policy is evaluated. - - - - Comparison Type - This is a static value used as the second value - in the comparison when your policy is evaluated. Depending on the comparison - type, this value can optionally use wildcards. See the documentation for - individual comparison types for more information. - - - - Comparison Value - This is a static value used as the second value - in the comparison when your policy is evaluated. Depending on the comparison - type, this value can optionally use wildcards. See the documentation for - individual comparison types for more information. - - - - - - - - - Gets the type of this condition. - - - - - Gets and Sets the name of the condition key involved in this condition. - Condition keys are predefined values supported by AWS that provide input - to a condition's evaluation, such as the current time, or the IP address - of the incoming request. - - Your policy is evaluated for each incoming request, and condition keys - specify what information to pull out of those incoming requests and plug - into the conditions in your policy. - - - - - - Gets and Sets the values specified for this access control policy condition. - For example, in a condition that compares the incoming IP address of a - request to a specified range of IP addresses, the range of IP addresses - is the single value in the condition. - - Most conditions accept only one value, but multiple values are possible. - - - - - - A factory for creating conditions to be used in the policy. - - - - - Condition key for the current time. - - This condition key should only be used with enum. - - - - - - Condition key for whether or not an incoming request is using a secure - transport to make the request (i.e. HTTPS instead of HTTP). - - This condition key should only be used with the boolean overload of NewCondition. - - - - - - Condition key for the source IP from which a request originates. - - This condition key should only be used with enum. - - - - - - Condition key for the user agent included in a request. - - This condition key should only be used with - enum. - - - - - - Condition key for the current time, in epoch seconds. - - This condition key should only be used with enum. - objects. - - - - - - Condition key for the referrer specified by a request. - - This condition key should only be used with - objects. - - - - - - Condition key for the Amazon Resource Name (ARN) of the source specified - in a request. The source ARN indicates which resource is affecting the - resource listed in your policy. For example, an SNS topic is the source - ARN when publishing messages from the topic to an SQS queue. - - This condition key should only be used with enum. - - - - - - Enumeration of the supported ways an ARN comparison can be evaluated. - - - - Exact matching - - - - Loose case-insensitive matching of the ARN. Each of the six - colon-delimited components of the ARN is checked separately and each - can include a multi-character match wildcard (*) or a - single-character match wildcard (?). - - - - Negated form of ArnEquals - - - Negated form of ArnLike - - - - Enumeration of the supported ways a date comparison can be evaluated. - - - - - Enumeration of the supported ways an IP address comparison can be evaluated. - - - - - Matches an IP address against a CIDR IP range, evaluating to true if - the IP address being tested is in the condition's specified CIDR IP - range. - - - - - Negated form of IpAddress - - - - - Enumeration of the supported ways a numeric comparison can be evaluated - - - - - Enumeration of the supported ways a string comparison can be evaluated. - - - - - Case-sensitive exact string matching - - - - - Case-insensitive string matching - - - - - Loose case-insensitive matching. The values can include a - multi-character match wildcard (*) or a single-character match - wildcard (?) anywhere in the string. - - - - - Negated form of StringEquals. - - - - - Negated form of StringEqualsIgnorecase. - - - - - Negated form of StringLike. - - - - - Constructs a new access control policy condition that compares ARNs (Amazon Resource Names). - - The access policy condition key specifying where to get the first ARN for the comparison - The type of comparison to perform. - The second ARN to compare against. When using ArnLike or ArnNotLike this may contain the - multi-character wildcard (*) or the single-character wildcard - - - - Constructs a new access policy condition that performs a boolean - comparison. - - The access policy condition key specifying where to get the - first boolean value for the comparison (ex: aws:SecureTransport). - The boolean to compare against. - - - - This method is deprecated. Invoking this method results in non-UTC DateTimes - not being marshalled correctly. Use NewConditionUtc instead. - Constructs a new access policy condition that compares the current time - (on the AWS servers) to the specified date. - - The type of comparison to perform. For example, - DateComparisonType.DateLessThan will cause this policy - condition to evaluate to true if the current date is less than - the date specified in the second argument. - The date to compare against. - - - - Constructs a new access policy condition that compares the current time - (on the AWS servers) to the specified date. - - The type of comparison to perform. For example, - DateComparisonType.DateLessThan will cause this policy - condition to evaluate to true if the current date is less than - the date specified in the second argument. - The date to compare against. - - - - Constructs a new access policy condition that compares the source IP - address of the incoming request to an AWS service against the specified - CIDR range. The condition evaluates to true (meaning the policy statement - containing it will be applied) if the incoming source IP address is - within that range. - - To achieve the opposite effect (i.e. cause the condition to evaluate to - true when the incoming source IP is not in the specified CIDR - range) use the alternate constructor form and specify - IpAddressComparisonType.NotIpAddress. - - - The CIDR IP range involved in the policy condition. - - - - Constructs a new access policy condition that compares the source IP - address of the incoming request to an AWS service against the specified - CIDR range. When the condition evaluates to true (i.e. when the incoming - source IP address is within the CIDR range or not) depends on the - specified IpAddressComparisonType. - - The type of comparison to to perform. - The CIDR IP range involved in the policy condition. - - - - Constructs a new access policy condition that compares two numbers. - - The type of comparison to perform. - The access policy condition key specifying where to get the - first number for the comparison. - The second number to compare against. - - - - Constructs a new access control policy condition that compares two - strings. - - The type of comparison to perform - The access policy condition key specifying where to get the - first string for the comparison (ex: aws:UserAgent). - - The second string to compare against. When using - StringComparisonType.StringLike or - StringComparisonType.StringNotLike this may contain - the multi-character wildcard (*) or the single-character - wildcard (?). - - - - - Constructs a new access policy condition that compares the Amazon - Resource Name (ARN) of the source of an AWS resource that is modifying - another AWS resource with the specified pattern. - - For example, the source ARN could be an Amazon SNS topic ARN that is - sending messages to an Amazon SQS queue. In that case, the SNS topic ARN - would be compared the ARN pattern specified here. - - - The endpoint pattern may optionally contain the multi-character wildcard - * (*) or the single-character wildcard (?). Each of the six colon-delimited - components of the ARN is checked separately and each can include a - wildcard. - - - Policy policy = new Policy("MyQueuePolicy"); - policy.WithStatements(new Statement(Statement.StatementEffect.Allow) - .WithPrincipals(new Principal("*")).WithActionIdentifiers(SQSActionIdentifiers.SendMessage) - .WithResources(new Resource(myQueueArn)) - .WithConditions(ConditionFactory.NewSourceArnCondition(myTopicArn))); - - - The ARN pattern against which the source ARN will be compared. - Each of the six colon-delimited components of the ARN is - checked separately and each can include a wildcard. - A new access control policy condition that compares the ARN of - the source specified in an incoming request with the ARN pattern - specified here. - - - - Constructs a new access control policy condition that tests if the - incoming request was sent over a secure transport (HTTPS). - - A new access control policy condition that tests if the incoming - request was sent over a secure transport (HTTPS). - - - - Condition key for the canned ACL specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the location constraint specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the prefix specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the delimiter specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the max keys specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the source object specified by a request to copy an - object. - - This condition key may only be used with enum. - - - - - - Condition key for the metadata directive specified by a request to copy - an object. - - This condition key may only be used with enum. - - - - - - Condition key for the version ID of an object version specified by a - request. - - This condition key may only be used with enum. - - - - - - Constructs a new access policy condition that compares an Amazon S3 - canned ACL with the canned ACL specified by an incoming request. - - You can use this condition to ensure that any objects uploaded to an - Amazon S3 bucket have a specific canned ACL set. - - - The Amazon S3 canned ACL to compare against. - A new access control policy condition that compares the Amazon S3 - canned ACL specified in incoming requests against the value - specified. - - - - Condition key for The URL, e-mail address, or ARN from a Subscribe - request or a previously confirmed subscription. Use with string - conditions to restrict access to specific endpoints (e.g., - *@mycompany.com). - - This condition key may only be used with enum. - - - - - - Condition key for the protocol value from a Subscribe request or a - previously confirmed subscription. Use with string conditions to restrict - publication to specific delivery protocols (e.g., HTTPS). - - This condition key may only be used with enum. - - - - - - Constructs a new access policy condition that compares the requested - endpoint used to subscribe to an Amazon SNS topic with the specified - endpoint pattern. The endpoint pattern may optionally contain the - multi-character wildcard (*) or the single-character wildcard (?). - - For example, this condition can restrict subscriptions to a topic to - email addresses in a certain domain ("*@my-company.com"). - - - Policy policy = new Policy("MyTopicPolicy"); - policy.WithStatements(new Statement(Statement.StatementEffect.Allow) - .WithPrincipals(new Principal("*")).WithActionIdentifiers(SNSActionIdentifiers.Subscribe) - .WithResources(new Resource(myTopicArn)) - .WithConditions(ConditionFactory.NewEndpointCondition("*@my-company.com"))); - - - The endpoint pattern against which to compare the requested - endpoint for an Amazon SNS topic subscription. - A new access control policy condition that compares the endpoint - used in a request to subscribe to an Amazon SNS topic with the - endpoint pattern specified. - - - - Constructs a new AWS access control policy condition that allows an - access control statement to restrict subscriptions to an Amazon SNS topic - based on the protocol being used for the subscription. For example, this - condition can restrict subscriptions to a topic to endpoints using HTTPS - to ensure that messages are securely delivered. - - The protocol against which to compare the requested protocol - for an Amazon SNS topic subscription. - A new access control policy condition that compares the - notification protocol requested in a request to subscribe to an - Amazon SNS topic with the protocol value specified. - - - - Deserializes a JSON string into a AWS policy object. - - - - - Serializes an AWS policy object to a JSON string, suitable for sending to an - AWS service. - - - - Converts the specified AWS policy object to a JSON string, suitable for - passing to an AWS service. - - @param policy - The AWS policy object to convert to a JSON string. - - @return The JSON string representation of the specified policy object. - - @throws IllegalArgumentException - If the specified policy is null or invalid and cannot be - serialized to a JSON string. - - - - Uses the specified generator to write the JSON data for the principals in - the specified policy statement. - - - - - This sorts the conditions by condition type and key with the list of values for that combination. - - The list of conditions to be sorted. - - - - - An AWS access control policy is a object that acts as a container for one or - more statements, which specify fine grained rules for allowing or denying - various types of actions from being performed on your AWS resources. - - By default, all requests to use your resource coming from anyone but you are - denied. Access control polices can override that by allowing different types - of access to your resources, or by explicitly denying different types of - access. - - - Each statement in an AWS access control policy takes the form: - "A has permission to do B to C where D applies". - - - A is the prinicpal - The AWS account that is making a request to - access or modify one of your AWS resources. - - - - B is the action - the way in which your AWS resource is being accessed or modified, such - as sending a message to an Amazon SQS queue, or storing an object in an Amazon S3 bucket. - - - - C is the resource - your AWS entity that the principal wants to access, such - as an Amazon SQS queue, or an object stored in Amazon S3. - - - - D is the set of conditions - optional constraints that specify when to allow or deny - access for the principal to access your resource. Many expressive conditions are available, - some specific to each service. For example you can use date conditions to allow access to - your resources only after or before a specific time. - - - - - - Note that an AWS access control policy should not be confused with the - similarly named "POST form policy" concept used in Amazon S3. - - - - - - The default policy version - - - - - Constructs an empty AWS access control policy ready to be populated with - statements. - - - - - Constructs a new AWS access control policy with the specified policy ID. - The policy ID is a user specified string that serves to help developers - keep track of multiple polices. Policy IDs are often used as a human - readable name for a policy. - - The policy ID for the new policy object. Policy IDs serve to - help developers keep track of multiple policies, and are often - used to give the policy a meaningful, human readable name. - - - - Constructs a new AWS access control policy with the specified policy ID - and collection of statements. The policy ID is a user specified string - that serves to help developers keep track of multiple polices. Policy IDs - are often used as a human readable name for a policy. - - The policy ID for the new policy object. Policy IDs serve to - help developers keep track of multiple policies, and are often - used to give the policy a meaningful, human readable name. - The statements to include in the new policy. - - - - Gets and Sets the policy ID for this policy. Policy IDs serve to help - developers keep track of multiple policies, and are often used as human - readable name for a policy. - - - - - Sets the policy ID for this policy and returns the updated policy so that - multiple calls can be chained together. - - Policy IDs serve to help developers keep track of multiple policies, and - are often used as human readable name for a policy. - - - The polich ID for this policy - this instance - - - - Gets and sets the version of this AWS policy. - - - - - Gets and Sets the collection of statements contained by this policy. Individual - statements in a policy are what specify the rules that enable or disable - access to your AWS resources. - - - - - Checks to see if the permissions set in the statement are already set by another - statement in the policy. - - The statement to verify - True if the statement's permissions are already allowed by the statement - - - - Sets the collection of statements contained by this policy and returns - this policy object so that additional method calls can be chained - together. - - Individual statements in a policy are what specify the rules that enable - or disable access to your AWS resources. - - - The collection of statements included in this policy. - this instance - - - - Returns a JSON string representation of this AWS access control policy, - suitable to be sent to an AWS service as part of a request to set an - access control policy. - - A JSON string representation of this AWS access control policy. - - - - Returns a JSON string representation of this AWS access control policy, - suitable to be sent to an AWS service as part of a request to set an - access control policy. - - Toggle pretty print for the generated JSON document - A JSON string representation of this AWS access control policy. - - - - Parses a JSON document of a policy and creates a Policy object. - - JSON document of a policy. - - - - - A principal is an AWS account which is being allowed or denied access to a - resource through an access control policy. The principal is a property of the - Statement object, not directly the object. - - The principal is A in the statement - "A has permission to do B to C where D applies." - - - In an access control policy statement, you can set the principal to all - authenticated AWS users through the member. This - is useful when you don't want to restrict access based on the identity of the - requester, but instead on other identifying characteristics such as the - requester's IP address. - - - - - - Principal instance that includes all authenticated AWS users. - - This is useful when you don't want to restrict access based on the - identity of the requester, but instead on other identifying - characteristics such as the requester's IP address. - - - - - - The anonymous Principal. - - - - - The default Principal provider for AWS accounts. - - - - - Principal provider for Canonical User IDs. - - - - - Principal provider for federated users (using a SAML identity provider) - - - - - Principal provider for assume role policies that will be assumed by an AWS service - (e.g. "ec2.amazonaws.com"). - - - - - Dummy principal provider for anonynous. - - - - - Constructs a new principal with the specified AWS account ID. - - An AWS account ID. - - - - Constructs a new principal with the specified provider and id - - The provider of the principal - The unique ID of the Principal within the provider - - - - Constructs a new principal with the specified provider and id - and optionally strips hyphens from the id - - The provider of the principal - The unique ID of the Principal within the provider - Strip hyphen - - - - Gets and sets the provider for this principal, which indicates in what group of - users this principal resides. - - - - - Gets the unique ID for this principal. - - - - - Represents a resource involved in an AWS access control policy statement. - Resources are the service specific AWS entities owned by your account. Amazon - SQS queues, Amazon S3 buckets and objects, and Amazon SNS topics are all - examples of AWS resources. - - The standard way of specifying an AWS resource is with an Amazon Resource - Name (ARN). - - - The resource is C in the statement - "A has permission to do B to C where D applies." - - - - - - Constructs a new AWS access control policy resource. Resources are - typically specified as Amazon Resource Names (ARNs). - - You specify the resource using the following Amazon Resource Name (ARN) - format: arn:aws:<vendor>:<region>:<namespace>:<relative-id> - - - >vendor identifies the AWS product (e.g., sns) - - - region is the AWS Region the resource resides in (e.g., us-east-1), if any - - - namespace is the AWS account ID with no hyphens (e.g., 123456789012) - - - relative-id is the service specific portion that identifies the specific resource - - - - - For example, an Amazon SQS queue might be addressed with the following - ARN: arn:aws:sqs:us-east-1:987654321000:MyQueue - - - Some resources may not use every field in an ARN. For example, resources - in Amazon S3 are global, so they omit the region field: - arn:aws:s3:::bucket/* - - - The Amazon Resource Name (ARN) uniquely identifying the desired AWS resource. - - - - Gets the resource ID, typically an Amazon Resource Name (ARN), - identifying this resource. - - - - - A factory for creating resources to be used in the policy. - - - - - Constructs a new bucket resource that represents the the specified bucket - but not any of the contained objects. - - The name of the bucket represented by this AWS access control - policy resource. - - - - Constructs a new object resource that represents the specified objects. - The keyPattern argument may contain the '*' wildcard to match multiple - objects. For example, an object resource created for bucket 'mybucket' - and key pattern 'foo*' will match any object stored in 'mybucket' with a - key that starts with 'foo'. - - The name of the bucket containing the object or objects - represented by this resource. - The key or key pattern, which can optionally contain the '*' - wildcard to include multiple objects in the resource. - - - - Constructs a new SQS queue resource for an access control policy. A - policy statement using this resource will allow or deny actions on the - specified queue. - - The AWS account ID of the queue owner. - The name of the Amazon SQS queue. - - - - A statement is the formal description of a single permission, and is always - contained within a policy object. - - A statement describes a rule for allowing or denying access to a specific AWS - resource based on how the resource is being accessed, and who is attempting - to access the resource. Statements can also optionally contain a list of - conditions that specify when a statement is to be honored. - - - For example, consider a statement that: - - - A is the prinicpal - The AWS account that is making a request to - access or modify one of your AWS resources. - - - - B is the action - the way in which your AWS resource is being accessed or modified, such - as sending a message to an Amazon SQS queue, or storing an object in an Amazon S3 bucket. - - - - C is the resource - your AWS entity that the principal wants to access, such - as an Amazon SQS queue, or an object stored in Amazon S3. - - - - D is the set of conditions - optional constraints that specify when to allow or deny - access for the principal to access your resource. Many expressive conditions are available, - some specific to each service. For example you can use date conditions to allow access to - your resources only after or before a specific time. - - - - - - There are many resources and conditions available for use in statements, and - you can combine them to form fine grained custom access control polices. - - - - - - The effect is the result that you want a policy statement to return at - evaluation time. A policy statement can either allow access or explicitly - deny access. - - - - - Constructs a new access control policy statement with the specified - effect. - - Before a statement is valid and can be sent to AWS, callers must set the - principals, resources, and actions (as well as any optional conditions) - involved in the statement. - - - The effect this statement has (allowing access or denying - access) when all conditions, resources, principals, and - actions are matched. - - - - Gets and Sets the ID for this statement. Statement IDs serve to help keep track - of multiple statements, and are often used to give the statement a - meaningful, human readable name. - - Developers should be careful to not use the same statement ID for - multiple statements in the same policy. Reusing the same statement ID in - different policies is not a problem. - - - - - - Sets the ID for this statement and returns the updated statement so - multiple calls can be chained together. - - Statement IDs serve to help keep track of multiple statements, and are - often used to give the statement a meaningful, human readable name. - - - Developers should be careful to not use the same statement ID for - multiple statements in the same policy. Reusing the same statement ID in - different policies is not a problem. - - - The new statement ID for this statement. - this instance - - - - Gets and Sets the result effect of this policy statement when it is evaluated. - A policy statement can either allow access or explicitly - - - - - Gets and Sets the list of actions to which this policy statement applies. - Actions limit a policy statement to specific service operations that are - being allowed or denied by the policy statement. For example, you might - want to allow any AWS user to post messages to your SQS queue using the - SendMessage action, but you don't want to allow those users other actions - such as ReceiveMessage or DeleteQueue. - - - - - Sets the list of actions to which this policy statement applies and - returns this updated Statement object so that additional method calls can - be chained together. - - Actions limit a policy statement to specific service operations that are - being allowed or denied by the policy statement. For example, you might - want to allow any AWS user to post messages to your SQS queue using the - SendMessage action, but you don't want to allow those users other actions - such as ReceiveMessage or DeleteQueue. - - - The list of actions to which this statement applies. - this instance - - - - Gets and Sets the resources associated with this policy statement. Resources - are what a policy statement is allowing or denying access to, such as an - Amazon SQS queue or an Amazon SNS topic. - - Note that some services allow only one resource to be specified per - policy statement. - - - - - - Sets the resources associated with this policy statement and returns this - updated Statement object so that additional method calls can be chained - together. - - Resources are what a policy statement is allowing or denying access to, - such as an Amazon SQS queue or an Amazon SNS topic. - - - Note that some services allow only one resource to be specified per - policy statement. - - - The resources associated with this policy statement. - this instance - - - - Gets and Sets the conditions associated with this policy statement. Conditions - allow policy statements to be conditionally evaluated based on the many - available condition types. - - For example, a statement that allows access to an Amazon SQS queue could - use a condition to only apply the effect of that statement for requests - that are made before a certain date, or that originate from a range of IP - addresses. - - - When multiple conditions are included in a single statement, all - conditions must evaluate to true in order for the statement to take - effect. - - - - - - Sets the conditions associated with this policy statement, and returns - this updated Statement object so that additional method calls can be - chained together. - - Conditions allow policy statements to be conditionally evaluated based on - the many available condition types. - - - For example, a statement that allows access to an Amazon SQS queue could - use a condition to only apply the effect of that statement for requests - that are made before a certain date, or that originate from a range of IP - addresses. - - - Multiple conditions can be included in a single statement, and all - conditions must evaluate to true in order for the statement to take - effect. - - - The conditions associated with this policy statement. - this instance - - - - Gets and Sets the principals associated with this policy statement, indicating - which AWS accounts are affected by this policy statement. - - - - - Sets the principals associated with this policy statement, and returns - this updated Statement object. Principals control which AWS accounts are - affected by this policy statement. - - If you don't want to restrict your policy to specific users, you can use - to apply the policy to any user trying to - access your resource. - - - The list of principals associated with this policy statement. - this instance - - - - Exception thrown by the SDK for errors that occur within the SDK. - - - - - Constructs a new instance of the AmazonClientException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - This exception is thrown when there is a parse error on the response back from AWS. - - - - - The string value which could not be converted into a valid DateTime instance. - - - - - Constructs a new instance of the AmazonDateTimeUnmarshallingException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - Occurs before a request is marshalled. - - - - - Occurs before a request is issued against the service. - - - - - Occurs after a response is received from the service. - - - - - Occurs after an exception is encountered. - - - - - Patches the in-flight uri to stop it unescaping the path etc (what Uri did before - Microsoft deprecated the constructor flag). This is particularly important for - Amazon S3 customers who want to use backslash (\) in their key names. - - - Different behavior in the various runtimes has been observed and in addition some - 'documented' ways of doing this between 2.x and 4.x runtimes has also been observed - to not be reliable. - - This patch effectively emulates what adding a schemesettings element to the - app.config file with value 'name="http" genericUriParserOptions="DontUnescapePathDotsAndSlashes"' - does. As we're a dll, that avenue is not open to us. - - - - - - Used to create a copy of the config for a different service than the current instance. - - Target service ClientConfig - The new ClientConfig for the desired service - - - - A base exception for some Amazon Web Services. - - Most exceptions thrown to client code will be service-specific exceptions, though some services - may throw this exception if there is a problem which is caught in the core client code. - - - - - - Whether the error was attributable to Sender or Reciever. - - - - - The error code returned by the service - - - - - The id of the request which generated the exception. - - - - - The HTTP status code from the service response - - - - - Constructs a new instance of the AmazonServiceException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - This exception is thrown when there is a parse error on the response back from AWS. - - - - - Last known location in the response that was parsed, if available. - - - - - The entire response body that caused this exception, if available. - - - - - Constructs a new instance of the AmazonSimpleDBException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - Base class for request used by some of the services. - - - - - This flag specifies if SigV4 will be used for the current request. - - - - - Gets or Sets a value indicating if "Expect: 100-continue" HTTP header will be - sent by the client for this request. The default value is false. - - - - - Gets the signer to use for this request. - A null return value indicates to use the configured - signer for the service that this request is part of. - - A signer for this request, or null. - - - - Overrides the default request timeout value. - - - - If the value is set, the value is assigned to the Timeout property of the HTTPWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Overrides the default read-write timeout value. - - - - If the value is set, the value is assigned to the ReadWriteTimeout property of the HTTPWebRequest/WebRequestHandler object used - to send requests. - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - - Abstract class for Response objects, contains only metadata, - and no result information. - - - - - Contains additional information about the request, such as the - Request Id. - - - - - Returns the content length of the HTTP response. - - - - - Returns the status code of the HTTP response. - - - - - Base class for determining region based on inspection. - - - - - Sets the Region property by looking up the corresponding RegionEndpoint - from the supplied region system name (us-east-1, us-west-2 etc). - - The system name of the region. - - - - Determines region based on application configuration settings. If the configuration does not contain - the region setting key an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of ApplicationConfigAWSRegion. If no region is found in the - application configuration file then an InvalidOperationException is thrown. - - - - - Determines region based on an environment variable. If the environment does not contain - the region setting key an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of EnvironmentVariableAWSRegion. If no region is found in the - environment then an InvalidOperationException is thrown. - - - - - Determines region based on inspection of the instance metadata if running on an EC2 instance. - If instance metadata cannot be read or does not contain region information an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of InstanceProfileAWSRegion. If no region is found in the - metadata or we are not running on an EC2 instance an InvalidOperationException is thrown. - - - - - Determines region based on a stored in an . - If the profile doesn't exist or there is no region information an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of . - If the AWS_PROFILE environment variable is set the instance will be constructed using that profile, - otherwise it will use the default profile. - - If the profile doesn't exist or there is no region information an InvalidOperationException is thrown. - - The ICredentialProfileSource to read the profile from. - - - - Attempts to construct an instance of . - If the profile doesn't exist or there is no region information an InvalidOperationException is thrown. - - The ICredentialProfileSource to read the profile from. - The name of the profile. - - - - Probing mechanism to determine region from various sources. - - - - - This class is responsible for keeping track of Retry capacity across different ServiceURLs. - - - - - This method acquires a said retry capacity if the container has the capacity. - - Contains the RetryCapacity object for the said ServiceURL. - - - - This method calls a method to release capacity back - based on whether it was a successful response or a successful retry response. This is invoked by a retry request response. - - if this request is a retry, use a different capacity cost - Contains the RetryCapacity object for the said ServiceURL. - - - - Ths method fetches the RetryCapacity for the given ServiceURL from CapacityManager.CapacityContainer - - - - - This method releases capacity back. This is invoked by the TryReleaseCapacity method. - - Contains the RetryCapacity object for the said ServiceURL. - The capacity that needs to be released based on whether it was a successful response or a successful retry response. - - - - This class is the RetryCapacity class for a given ServiceURL. - - - - - This class composes Client Context header for Amazon Web Service client. - It contains information like app title, version code, version name, client id, OS platform etc. - - - This class composes Client Context header for Amazon Web Service client. - It contains information like app title, version code, version name, client id, OS platform etc. - - - - - Adds the custom attributes to the Client Context. - - Key. - Value. - - - - Gets a Json Representation of the Client Context. - - Json Representation of Client Context - - - - Class to which the Json stdout from credential process is - de-serialized into. - - - - - Version of the Json payload - - - - - AWS Access key - - - - - AWS Secret key - - - - - AWS Session token for session credentials - - - - - ISO8601 formatted timestamp till when the credential is valid. - - - - - This class gets the CSM configuration if set. - The priority goes - 1. App.config / instantiate on the AWSConfigs class - 2. Environment variable - 3. Shared Profile - - - - - Determine CSM configs from shared profile file. - - - - - Determine CSM configs from environment variables. - - - - - Determine CSM configs from AWSConfigs class. - - - - - Utility class for CSM. - Contains logic to serialize CSM events to Json. - - - - - Method to retrieve the API name from the request name. - - - - - Method to serialize MonitoringAPICallAttempt CSM event to json. - - - - - Method to serialize MonitoringAPICallEvent CSM event to json. - - - - - Method to serialize MonitoringAPICall CSM event to json. - - - - - Internal class that has the CSM configurations for the Monitoring Listener - after being derived from the CSMConfigChain class. - - - - - CSM event base class - - - - - Contains the operation name for the api call being made - - - - - Contains the service id ServiceId Sep of the service - against which the call is being made - - - - - Contains the "ClientId" configuration value - computed from the CSMConfigChain class - - - - - Contains the elapsed time, in milliseconds, - since January 1st, 1970, for the time point - at which the event occurred - - - - - Contains "ApiCall" or "ApiCallAttempt" - based on what the monitoring event is describing - - - - - Contains the enum of the above CSM type property - - - - - Contains the "Version" configuration value - computed from the CSMConfigChain class - Defaults to 1. - - - - - Contains the signing region used by the - service client that made the request attempt. - - - - - Contains the full value of the SDK's default - user agent header for http requests. - - - - - Class that captures the CSM Api Call Attempt Monitoring Events - for each http request and its subsequent response. - - - - - Contains the fully-qualified domain name of the endpoint that - the request attempt was submitted to. - - - - - Contains the session token passed - in the x-amz-security-token header. - - - - - Contains the aws_access_key value that - was used to sign the http request. - - - - - Contains the attempt's response status code, - as returned by the http client. - - - - - Contains the full text (exception object converted to String, - for example) for any attempt-level failure that is due to - something other than an Aws exception. The value of this entry - has a maximum length of 512. - - - - - Contains the short error name (exception class name, for example) - for any attempt-level failure that is due to something other - than an Aws exception.The value of this entry has a maximum length of 128. - - - - - Contains the Aws exception code returned in the response. - - - - - Contains the full text of the Aws exception message. - - - - - Contains the value of the response's x-amzn-RequestId header. - - - - - Contains the value of the response's x-amz-request-id header. - - - - - Contains the value of the response's x-amz-id-2 header. - - - - - Contains the elapsed time, in milliseconds, - between the construction of the http request and the - point in time where the http response has been parsed - or the attempt has definitively failed. - - - - - Class that captures the CSM Api Call Monitoring Events - for the entire SDK call. This is processed once. - - - - - Contains the total number of attempts that were made - by the service client to fulfill this request before succeeding or failing - - - - - Contains the elapsed time, in milliseconds, - between when the Api Call was begun and when a - final response or error is manifested to the caller - - - - - a boolean (0/1) value that is 0 unless the Api call failed - and the final attempt returned a retryable error.This entry should be - serialized as a numeric 0/1 value. This is mapped to MaxRetriesExceeded - when serialized to a UDP datagram. - - - - - Contains the full text (exception object - converted to String, for example) for an attempt-level failure that is due to - something other than an Aws exception that occurred on the last attempt to - fulfill the Api call.The value of this entry has a maximum length of 512. - - - - - Contains the short error name (exception - class name, for example) for a failure that is due to something other than an - Aws exception that occurred on the last attempt to fulfill an Api call.See - the SdkException entry for more details.The value of this entry has a - maximum length of 128. - - - - - Contains the Aws exception code - returned in the response to the final attempt at fulfilling this API call. - The value of this entry has a maximum length of 128. - - - - - - Contains the attempt's response status code, - as returned by the http client. - - - - - Computes RFC 2104-compliant HMAC signature. - - - - - Computes RFC 2104-compliant HMAC signature. - - - - - Inspects the supplied evidence to return the signer appropriate for the operation - - Global setting for the service - The request. - Configuration for the client - True if signature v4 request signing should be used - - - - Signs the specified request with the AWS3 signing protocol by using the - AWS account credentials given in the method parameters. - - The AWS public key - The AWS secret key used to sign the request in clear text - Request metrics - The configuration that specifies which hashing algorithm to use - The request to have the signature compute for - If any problems are encountered while signing the request - - - - AWS4 protocol signer for service calls that transmit authorization in the header field "Authorization". - - - - - Calculates and signs the specified request using the AWS4 signing protocol by using the - AWS account credentials given in the method parameters. The resulting signature is added - to the request headers as 'Authorization'. Parameters supplied in the request, either in - the resource path as a query string or in the Parameters collection must not have been - uri encoded. If they have, use the SignRequest method to obtain a signature. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. - - - Client configuration data encompassing the service call (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text. - - - If any problems are encountered while signing the request. - - - - - Calculates and signs the specified request using the AWS4 signing protocol by using the - AWS account credentials given in the method parameters. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. - - - Client configuration data encompassing the service call (notably authentication - region, endpoint and service name). - - - Metrics for the request. - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text. - - - If any problems are encountered while signing the request. - - - Parameters passed as part of the resource path should be uri-encoded prior to - entry to the signer. Parameters passed in the request.Parameters collection should - be not be encoded; encoding will be done for these parameters as part of the - construction of the canonical request. - - - - - Sets the AWS4 mandated 'host' and 'x-amz-date' headers, returning the date/time that will - be used throughout the signing process in various elements and formats. - - The current set of headers - - Date and time used for x-amz-date, in UTC - - - - Sets the AWS4 mandated 'host' and 'x-amz-date' headers, accepting and returning the date/time that will - be used throughout the signing process in various elements and formats. - - The current set of headers - - - Date and time used for x-amz-date, in UTC - - - - Computes and returns an AWS4 signature for the specified canonicalized request - - - - - - - - - - - - Computes and returns an AWS4 signature for the specified canonicalized request - - - - - - - - - - - - - Computes and returns an AWS4 signature for the specified canonicalized request - - - - - - - - - - - - - - Formats the supplied date and time for use in AWS4 signing, where various formats are used. - - - The required format - The UTC date/time in the requested format - - - - Compute and return the multi-stage signing key for the request. - - The clear-text AWS secret key, if not held in secureKey - The region in which the service request will be processed - Date of the request, in yyyyMMdd format - The name of the service being called by the request - Computed signing key - - - - If the caller has already set the x-amz-content-sha256 header with a pre-computed - content hash, or it is present as ContentStreamHash on the request instance, return - the value to be used in request canonicalization. - If not set as a header or in the request, attempt to compute a hash based on - inspection of the style of the request content. - - - - The computed hash, whether already set in headers or computed here. Null - if we were not able to compute a hash. - - - - - If signPayload is false set the x-amz-content-sha256 header to - the UNSIGNED-PAYLOAD magic string and return it. - Otherwise, if the caller has already set the x-amz-content-sha256 header with a pre-computed - content hash, or it is present as ContentStreamHash on the request instance, return - the value to be used in request canonicalization. - If not set as a header or in the request, attempt to compute a hash based on - inspection of the style of the request content. - - - - - The computed hash, whether already set in headers or computed here. Null - if we were not able to compute a hash. - - - - - Returns the HMAC256 for an arbitrary blob using the specified key - - - - - - - - Returns the HMAC256 for an arbitrary blob using the specified key - - - - - - - - Compute and return the hash of a data blob using the specified key - - Algorithm to use for hashing - Hash key - Data blob - Hash of the data - - - - Compute and return the hash of a data blob using the specified key - - Algorithm to use for hashing - Hash key - Data blob - Hash of the data - - - - Computes the non-keyed hash of the supplied data - - - - - - - Computes the non-keyed hash of the supplied data - - - - - - - Computes and returns the canonical request - - The endpoint URL - the path of the resource being operated on - The http method used for the request - The full request headers, sorted into canonical order - The query parameters for the request - - The hash of the binary request body if present. If not supplied, the routine - will look for the hash as a header on the request. - - Canonicalised request as a string - - - - Computes and returns the canonical request - - The endpoint URL - the path of the resource being operated on - The http method used for the request - The full request headers, sorted into canonical order - The query parameters for the request - - The path resource values lookup to use to replace the keys within resourcePath - The hash of the binary request body if present. If not supplied, the routine - will look for the hash as a header on the request. - - The version of the marshaller that constructed the request object. - Canonicalised request as a string - - - - Reorders the headers for the request for canonicalization. - - The set of proposed headers for the request - List of headers that must be included in the signature - For AWS4 signing, all headers are considered viable for inclusion - - - - Computes the canonical headers with values for the request. Only headers included in the signature - are included in the canonicalization process. - - All request headers, sorted into canonical order - Canonicalized string of headers, with the header names in lower case. - - - - Returns the set of headers included in the signature as a flattened, ;-delimited string - - The headers included in the signature - Formatted string of header names - - - - Collects the subresource and query string parameters into one collection - ready for canonicalization - - The in-flight request being signed - The fused set of parameters - - - - Computes and returns the canonicalized query string, if query parameters have been supplied. - Parameters with no value will be canonicalized as 'param='. The expectation is that parameters - have not already been url encoded prior to canonicalization. - - The set of parameters being passed on the uri - - Parameters must be uri encoded into the canonical request and by default the signer expects - that the supplied collection contains non-encoded data. Set this to false if the encoding was - done prior to signer entry. - - The uri encoded query string parameters in canonical ordering - - - - Computes and returns the canonicalized query string, if query parameters have been supplied. - Parameters with no value will be canonicalized as 'param='. The expectation is that parameters - have not already been url encoded prior to canonicalization. - - The set of parameters to be encoded in the query string - - Parameters must be uri encoded into the canonical request and by default the signer expects - that the supplied collection contains non-encoded data. Set this to false if the encoding was - done prior to signer entry. - - The uri encoded query string parameters in canonical ordering - - - - Returns the request parameters in the form of a query string. - - The request instance - Request parameters in query string format - - - - AWS4 protocol signer for Amazon S3 presigned urls. - - - - - Calculates and signs the specified request using the AWS4 signing protocol by using the - AWS account credentials given in the method parameters. The resulting signature is added - to the request headers as 'Authorization'. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. - - - Adding supporting data for the service call required by the signer (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text - - - If any problems are encountered while signing the request. - - - - - Calculates the AWS4 signature for a presigned url. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. If the Expires parameter - is present, it is renamed to 'X-Amz-Expires' before signing. - - - Adding supporting data for the service call required by the signer (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text - - - If any problems are encountered while signing the request. - - - Parameters passed as part of the resource path should be uri-encoded prior to - entry to the signer. Parameters passed in the request.Parameters collection should - be not be encoded; encoding will be done for these parameters as part of the - construction of the canonical request. - - - - - Calculates the AWS4 signature for a presigned url. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. If the Expires parameter - is present, it is renamed to 'X-Amz-Expires' before signing. - - - Adding supporting data for the service call required by the signer (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text - - - The service to sign for - - - The region to sign to, if null then the region the client is configured for will be used. - - - If any problems are encountered while signing the request. - - - Parameters passed as part of the resource path should be uri-encoded prior to - entry to the signer. Parameters passed in the request.Parameters collection should - be not be encoded; encoding will be done for these parameters as part of the - construction of the canonical request. - - The X-Amz-Content-SHA256 is cleared out of the request. - If the request is for S3 then the UNSIGNED_PAYLOAD value is used to generate the canonical request. - If the request isn't for S3 then the empty body SHA is used to generate the canonical request. - - - - - Encapsulates the various fields and eventual signing value that makes up - an AWS4 signature. This can be used to retrieve the required authorization string - or authorization query parameters for the final request as well as hold ongoing - signature computations for subsequent calls related to the initial signing. - - - - - Constructs a new signing result instance for a computed signature - - The access key that was included in the signature - Date/time (UTC) that the signature was computed - The collection of headers names that were included in the signature - Formatted 'scope' value for signing (YYYYMMDD/region/service/aws4_request) - Returns the key that was used to compute the signature - Computed signature - - - - The access key that was used in signature computation. - - - - - ISO8601 formatted date/time that the signature was computed - - - - - ISO8601 formatted date that the signature was computed - - - - - The ;-delimited collection of header names that were included in the signature computation - - - - - Formatted 'scope' value for signing (YYYYMMDD/region/service/aws4_request) - - - - - Returns a copy of the key that was used to compute the signature - - - - - Returns the hex string representing the signature - - - - - Returns a copy of the byte array containing the signature - - - - - Returns the signature in a form usable as an 'Authorization' header value. - - - - - Returns the signature in a form usable as a set of query string parameters. - - - - - Null Signer which does a no-op. - - - - - Signs the specified request with the AWS2 signing protocol by using the - AWS account credentials given in the method parameters. - - The AWS public key - The AWS secret key used to sign the request in clear text - Request metrics - The configuration that specifies which hashing algorithm to use - The request to have the signature compute for - If any problems are encountered while signing the request - - - - S3 signer constructor - - - - - S3 signer constructor - - - - - This exception is thrown if there are problems signing the request. - - - - - Constructs a new instance of the SignatureException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Collection used to indicate if the property was initialized was created by the SDK. - - - - - - Collection used to indicate if the property was initialized was created by the SDK. - - - - - - - Default implementation of the IRequest interface. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Constructs a new DefaultRequest with the specified service name and the - original, user facing request object. - - The orignal request that is being wrapped - The service name - - - - The name of the request - - - - - Gets and sets the type of http request to make, whether it should be POST,GET or DELETE - - - - - Gets and sets a flag that indicates whether the request is sent as a query string instead of the request body. - - - - - Returns the original, user facing request object which this internal - request object is representing. - - - - - Returns a dictionary of the headers included in this request. - - - - - Returns a dictionary of the parameters included in this request. - - - - - Collection of parameters included in this request. - - - - - Returns the subresources that should be appended to the resource path. - This is used primarily for Amazon S3, where object keys can contain '?' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new null entry to the SubResources collection for the request - - The name of the subresource - - - - Adds a new entry to the SubResources collection for the request - - The name of the subresource - Value of the entry - - - - Gets and Sets the endpoint for this request. - - - - - Gets and Sets the resource path added on to the endpoint. - - - - - Returns the path resources that should be used within the resource path. - This is used for services where path keys can contain '/' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new entry to the PathResources collection for the request - - The name of the pathresource with potential greedy syntax: {key+} - Value of the entry - - - - Gets and Sets the version number for the marshaller used to create this request. The version number - is used to support backward compatible changes that would otherwise be breaking changes when a - newer core is used with an older service assembly. - Versions: - 1 - Default version - 2 - Support for path segments - - - - - Gets and Sets the content for this request. - - - - - Flag that signals that Content was and should be set - from the Parameters collection. - - - - - Gets and sets the content stream. - - - - - Gets and sets the original stream position. - If ContentStream is null or does not support seek, this propery - should be equal to -1. - - - - - Computes the SHA 256 hash of the content stream. If the stream is not - seekable, it searches the parent stream hierarchy to find a seekable - stream prior to computation. Once computed, the hash is cached for future - use. If a suitable stream cannot be found to use, null is returned. - - - - - The name of the service to which this request is being sent. - - - - - Alternate endpoint to use for this request, if any. - - - - - Host prefix value to prepend to the endpoint for this request, if any. - - - - - Gets and sets the Suppress404Exceptions property. If true then 404s return back from AWS will not cause an exception and - an empty response object will be returned. - - - - - If using AWS4 signing protocol, contains the resultant parts of the - signature that we may need to make use of if we elect to do a chunked - encoding upload. - - - - - Determine whether to use a chunked encoding upload for the request - (applies to Amazon S3 PutObject and UploadPart requests only). - - - - - - Used for Amazon S3 requests where the bucket name is removed from - the marshalled resource path into the host header. To comply with - AWS2 signature calculation, we need to recover the bucket name - and include it in the resource canonicalization, which we do using - this field. - - - - - This flag specifies if SigV4 is required for the current request. - - - - - The authentication region to use for the request. - Set from Config.AuthenticationRegion. - - - - - The region in which the service request was signed. - - - - - Checks if the request stream can be rewinded. - - Returns true if the request stream can be rewinded , - else false. - - - - Returns true if the request can contain a request body, else false. - - Returns true if the currect request can contain a request body, else false. - - - - Returns true if the request has a body, else false. - - Returns true if the request has a body, else false. - - - - Class containing the data for one endpoint returned from a endpoint discovery request - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Constructs a new DiscoveryEndpoint - - The address of the endpoint - The cache period for the endpoint in minutes - - - - The address of the endpoint. - - - - - The cache period for the endpoint in minutes - - - - - Calculates if this endpoint has expired - - A boolean value indicating if the cache period has expired - - - - Extends the endpoint expiration by the specified number of minutes from now. - - - - - Class containing the data for one endpoint returned from a endpoint discovery request - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class containing the data to use with endpoint discovery - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Gets/sets and flag indicating if endpoint discovery is required for the request. - - - - - Sorted dictionary of the identifiers that must be sent with the endpoint discovery request. These - identifiers are used to construct the cache key for the cache that stores discovered endpoints. A - sorted dictionary is used instead of a dictionary to ensure the cache key comes out in the same order - each time it is constructed. - - - - - Represents the data to be used with endpoint discovery operations - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class used to resolve endpoints using Endpoint Discovery. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Method that performs endpoint discovery for the current operation - - Context information used in calculations for endpoint discovery - The operation to fetch endpoints from the server - - - - - Gets the number of cache keys in the cache - - - - - Class used to resolve endpoints using Endpoint Discovery. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class containing context information to use with endpoint discovery - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Gets the customer credential information. - - - - - Gets the operation name. - - - - - Gets the current marshalled endpoint discovery data. - - - - - Gets the flag indicating if the specified key should be evicted from the cache. - - - - - Gets the Uri that should be evicted if EvictCacheKey is set to true. - - - - - Class containing context information to use with endpoint discovery - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Error type, one of Sender, Receiver, Unknown - Only applies to XML-based services. - - - - - Name of the exception class to return - - - - - Error message - - - - - RequestId of the error. - Only applies to XML-based services. - - - - - Class containing the members used to invoke service calls - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class containing the members used to invoke service calls - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Represents a request being sent to an Amazon Web Service, including the - parameters being sent as part of the request, the endpoint to which the - request should be sent, etc. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - The name of the request - - - - - Returns a dictionary of the headers included in this request. - - - - - Gets and sets a flag that indicates whether the request is sent as a query string instead of the request body. - - - - - Returns a dictionary of the parameters included in this request. - - - - - Collection of parameters included in this request. - - - - - Returns the subresources that should be appended to the resource path. - This is used primarily for Amazon S3, where object keys can contain '?' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new null entry to the SubResources collection for the request - - The name of the subresource - - - - Adds a new entry to the SubResources collection for the request - - The name of the subresource - Value of the entry - - - - Gets and sets the type of http request to make, whether it should be POST,GET or DELETE - - - - - Gets and Sets the endpoint for this request. - - - - - Gets and Sets the resource path added on to the endpoint. - - - - - Returns the path resources that should be used within the resource path. - This is used for services where path keys can contain '/' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new entry to the PathResources collection for the request - - The name of the pathresource with potential greedy syntax: {key+} - Value of the entry - - - - Gets and Sets the version number for the marshaller used to create this request. The version number - is used to support backward compatible changes that would otherwise be breaking changes when a - newer core is used with an older service assembly. - - - - - Gets and Sets the content for this request. - - - - - Gets the header value from the request. - - - - - Flag that signals that Content was and should be set - from the Parameters collection. - - - - - Gets and sets the content stream. - - - - - Gets and sets the original stream position. - If ContentStream is null or does not support seek, this propery - should be equal to -1. - - - - - Computes the SHA 256 hash of the content stream. If the stream is not - seekable, it searches the parent stream hierarchy to find a seekable - stream prior to computation. Once computed, the hash is cached for future - use. - - - - - The name of the service to which this request is being sent. - - - - - Returns the original, user facing request object which this internal - request object is representing. - - - - - Alternate endpoint to use for this request, if any. - - - - - Host prefix value to prepend to the endpoint for this request, if any. - - - - - Gets and sets the Suppress404Exceptions property. If true then 404s return back from AWS will not cause an exception and - an empty response object will be returned. - - - - - If using AWS4 signing protocol, contains the resultant parts of the - signature that we may need to make use of if we elect to do a chunked - encoding upload. - - - - - Determine whether to use a chunked encoding upload for the request - (applies to Amazon S3 PutObject and UploadPart requests only). - - - - - - Used for Amazon S3 requests where the bucket name is removed from - the marshalled resource path into the host header. To comply with - AWS2 signature calculation, we need to recover the bucket name - and include it in the resource canonicalization, which we do using - this field. - - - - - This flag specifies if SigV4 is required for the current request. - - - - - The authentication region to use for the request. - Set from Config.AuthenticationRegion. - - - - - The region in which the service request was signed. - - - - - Checks if the request stream can be rewinded. - - Returns true if the request stream can be rewinded , - else false. - - - - Returns true if the request can contain a request body, else false. - - Returns true if the currect request can contain a request body, else false. - - - - Returns true if the request has a body, else false. - - Returns true if the request has a body, else false. - - - - Gets the value of the Service Id. - - - - - Gets the dictionary that gives mapping of renamed operations - - - - - IDictionary{String, String} access to ParameterCollection. - TODO: remove this class in version 3.4 of the SDK. - - - - - Constructs ParametersDictionaryFacade for a ParameterCollection - - - - - - A registry of object that will manipulate the runtime pipeline used by service clients. - - - - - Registers a customizer that will be applied for all service clients created. Each customizer has a unique name associated with it. If a customizer is registered more - than once with the same unique name then the calls after the first will be ignored. - - - - - - Deregistered the runtime pipeline customizer - - - - - - Deregistered the runtime pipeline customizer - - - - - - Applies all of the registered customizers on the runtime pipeline - - The service clients runtime pipeline. - Type object for the service client being created - - - - Interface for objects that will customize the runtime pipleine for newly created service clients. - - - - - The unique name for the customizer that identifies the customizer in the registry. The name is also used to identify the customizer on the SDK logs. - - - - - Called on service clients as they are being constructed to customize their runtime pipeline. - - - Type object for the service client being created - - - - Default ServiceMetadata implementation. - This implementation will be used if the service doesn't have a - IServiceMetadata implementation. - - - - - Gets the value of the Service Id. - - - - - Gets the dictionary that gives mapping of renamed operations - - - - - Response Unmarshaller for all Errors - - - - - Build an ErrorResponse from XML - - The XML parsing context. - Usually an Amazon.Runtime.Internal.UnmarshallerContext. - An ErrorResponse object. - - - - Return an instance of and ErrorResponseUnmarshaller. - - - - - - Interface for unmarshallers which unmarshall service responses. - The Unmarshallers are stateless, and only encode the rules for what data - in the XML stream goes into what members of an object. - - The type of object the unmarshaller returns - The type of the XML unmashaller context, which contains the - state of parsing the XML stream. Uaually an instance of - Amazon.Runtime.Internal.Transform.UnmarshallerContext. - - - - Extracts an exeption with data from an ErrorResponse. - - The XML parsing context. - An inner exception to be included with the returned exception - The HttpStatusCode from the ErrorResponse - Either an exception based on the ErrorCode from the ErrorResponse, or the - general service exception for the service in question. - - - - Interface for unmarshallers which unmarshall objects from response data. - The Unmarshallers are stateless, and only encode the rules for what data - in the XML stream goes into what members of an object. - - The type of object the unmarshaller returns - The type of the XML unmashaller context, which contains the - state during parsing of the XML stream. Usually an instance of - Amazon.Runtime.Internal.Transform.UnmarshallerContext. - - - - Given the current position in the XML stream, extract a T. - - The XML parsing context - An object of type T populated with data from the XML stream. - - - - Response Unmarshaller for all Errors - - - - - Build an ErrorResponse from json - - The json parsing context. - Usually an Amazon.Runtime.Internal.JsonUnmarshallerContext. - An ErrorResponse object. - - - - Return an instance of JsonErrorResponseUnmarshaller. - - - - - - Wraps a json string for unmarshalling. - - Each Read() operation gets the next token. - TestExpression() is used to match the current key-chain - to an xpath expression. The general pattern looks like this: - - JsonUnmarshallerContext context = new JsonUnmarshallerContext(jsonString); - while (context.Read()) - { - if (context.IsKey) - { - if (context.TestExpresion("path/to/element")) - { - myObject.stringMember = stringUnmarshaller.GetInstance().Unmarshall(context); - continue; - } - } - } - - - - - - Wrap the jsonstring for unmarshalling. - - Stream that contains the JSON for unmarshalling - If set to true, maintains a copy of the complete response body as the stream is being read. - Response data coming back from the request - - - - Are we at the start of the json document. - - - - - Is the current token the end of an object - - - - - Is the current token the start of an object - - - - - Returns the element depth of the parser's current position in the json - document being parsed. - - - - - The current Json path that is being unmarshalled. - - - - - Reads to the next token in the json document, and updates the context - accordingly. - - - True if a token was read, false if there are no more tokens to read. - - - - - Peeks at the next token. This peek implementation - reads the next token and makes the subsequent Read() return the same data. - If Peek is called successively, it will return the same data. - Only the first one calls Read(), subsequent calls - will return the same data until a Read() call is made. - - Token to peek. - Returns true if the peeked token matches given token. - - - - Returns the text contents of the current token being parsed. - - - The text contents of the current token being parsed. - - - - - The type of the current token - - - - - Get the base stream of the jsonStream. - - - - - Peeks at the next (non-whitespace) character in the jsonStream. - - The next (non-whitespace) character in the jsonStream, or -1 if at the end. - - - - Peeks at the next character in the stream. - If the data isn't buffered into the StreamReader (Peek() returns -1), - we flush the buffered data and try one more time. - - - - - - Abstract class for unmarshalling service responses. - - - - - Class for unmarshalling XML service responses. - - - - - Class for unmarshalling EC2 service responses. - - - - - Class for unmarshalling JSON service responses. - - - - - Unmarshaller for int fields - - - - - Unmarshaller for nullable int fields. Implemented only for JSON context - to handle cases where value can be null e.g. {'Priority': null}. - This unmarshaller is not implemented for XML context, as XML responses - will null elements (xsi:nil='true') will be skipped by the XML parser. - - - - - Unmarshaller for long fields - - - - - Unmarshaller for float fields - - - - - Unmarshaller for double fields - - - - - Unmarshaller for decimal fields - - - - - Unmarshaller for bool fields - - - - - Unmarshaller for string fields - - - - - Unmarshaller for byte fields - - - - - Unmarshaller for DateTime fields - - - - - Unmarshalls given string as a DateTime. Handles cases where we want to unmarshall - as just a DateTime or a nullable Datetime. - - Value to be parsed - If true, the method will return null if text is null. - If false, the method will return default(DateTime), if text is null. - - - - - Unmarshaller for nullable DateTime fields. Implemented only for JSON context - to handle cases where value can be null e.g. {'Priority': null}. - This unmarshaller is not implemented for XML context, as XML responses - will null elements (xsi:nil='true') will be skipped by the XML parser. - - - - - Unmarshaller for MemoryStream fields - - - - - Unmarshaller for ResponseMetadata - - - - - Base class for the UnmarshallerContext objects that are used - to unmarshall a web-service response. - - - - - Tests the specified expression against the current position in the XML - document - - The pseudo-XPath expression to test. - - True if the expression matches the current position in the document, - false otherwise. - - - - Tests the specified expression against the current position in the XML - document being parsed, and restricts the expression to matching at the - specified stack depth. - - The pseudo-XPath expression to test. - - The depth in the stack representing where the expression must - start matching in order for this method to return true. - - True if the specified expression matches the current position in - the XML document, starting from the specified depth. - - - - Reads the next token at depth greater than or equal to target depth. - - Tokens are read at depth greater than or equal to target depth. - True if a token was read and current depth is greater than or equal to target depth. - - - - The current path that is being unmarshalled. - - - - - Returns the element depth of the parser's current position in the - document being parsed. - - - - - Reads to the next node in the document, and updates the context accordingly. - - - True if a node was read, false if there are no more elements to read. - - - - - Returns the text contents of the current element being parsed. - - - The text contents of the current element being parsed. - - - - - True if NodeType is Element. - - - - - True if NodeType is EndElement. - - - - - True if the context is at the start of the document. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Wrap an XmltextReader for simulating an event stream. - - Each Read() operation goes either to the next element or next attribute within - the current element. TestExpression() is used to match the current event - to an xpath expression. The general pattern looks like this: - - UnmarshallerContext context = new UnmarshallerContext(...); - while (context.Read()) - { - if (context.TestExpresion("path/to/element")) - { - myObject.stringMember = stringUnmarshaller.GetInstance().Unmarshall(context); - continue; - } - if (context.TestExpression("path/to/@attribute")) - myObject.MyComplexTypeMember = MyComplexTypeUnmarshaller.GetInstance().Unmarshall(context); - } - - - - - - Wrap an XmlTextReader with state for event-based parsing of an XML stream. - - Stream with the XML from a service response. - If set to true, maintains a copy of the complete response body as the stream is being read. - Response data coming back from the request - - - - The current XML path that is being unmarshalled. - - - - - Returns the element depth of the parser's current position in the XML - document being parsed. - - - - - Reads to the next node in the XML document, and updates the context accordingly. - - - True if a node was read, false if there are no more elements to read./ - - - - - Returns the text contents of the current element being parsed. - - - The text contents of the current element being parsed. - - - - - True if NodeType is Element. - - - - - True if NodeType is EndElement. - - - - - True if the context is at the start of the document. - - - - - True if NodeType is Attribute. - - - - - Wrap an XmlTextReader with state for event-based parsing of an XML stream. - - Stream with the XML from a service response. - If set to true, maintains a copy of the complete response body as the stream is being read. - Response data coming back from the request - - - - RequestId value, if found in response - - - - - Reads to the next node in the XML document, and updates the context accordingly. - If node is RequestId, reads the contents and stores in RequestId property. - - - True if a node was read, false if there are no more elements to read./ - - - - - Constructs a new instance of the HttpWebRequestResponseData class with serialized data. - - The that holds the serialized object data. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - A stream which caches the contents of the underlying stream as it reads it. - - - - - All the bytes read by the stream. - - - - - Initializes the CachingWrapperStream with a base stream. - - The stream to be wrapped. - Maximum number of bytes to be cached. - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Gets a value indicating whether the current stream supports seeking. - CachingWrapperStream does not support seeking, this will always be false. - - - - - Gets or sets the position within the current stream. - CachingWrapperStream does not support seeking, attempting to set Position - will throw NotSupportedException. - - - - - Sets the position within the current stream. - CachingWrapperStream does not support seeking, attempting to call Seek - will throw NotSupportedException. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Stream wrapper that double-buffers from a wrapped stream and - returns the buffered content as a series of signed 'chunks' - for the AWS4 ('Signature V4') protocol. - - - - - Reads some or all of the processed chunk to the consumer, constructing - and streaming a new chunk if more input data is available. - - - - - - - - - Results of the header-signing portion of the request - - - - - Computed signature of the chunk prior to the one in-flight, in - hex - - - - - Computes the derived signature for a chunk of data of given length in the input buffer, - placing a formatted chunk with headers, signature and data into the output buffer - ready for streaming back to the consumer. - - - - - - Length override to return the true length of the payload plus the metainfo - supplied with each chunk - - - - - Computes the total size of the data payload, including the chunk metadata. - Called externally so as to be able to set the correct Content-Length header - value. - - - - - - - Computes the size of the header data for each chunk. - - - - - - - Attempt to read sufficient data for a whole chunk from the wrapped stream, - returning the number of bytes successfully read to be processed into a chunk - - - - - A list object that will always be sent to AWS services, - even if it is empty. - The AWS .NET SDK does not send empty collections to services, unless - the collection is of this type. - - - - - - A dictionary object that will always be sent to AWS services, - even if it is empty. - The AWS .NET SDK does not send empty collections to services, unless - the collection is of this type. - - - - - - - A wrapper stream that decrypts the base stream as it - is being read. - - - - - Initializes an DecryptStream with an decryption algorithm and a base stream. - - Stream to perform encryption on.. - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Gets a value indicating whether the current stream supports seeking. - DecryptStream does not support seeking, this will always be false. - - - - - Gets or sets the position within the current stream. - DecryptStream does not support seeking, attempting to set Position - will throw NotSupportedException. - - - - - Sets the position within the current stream. - DecryptStream does not support seeking, attempting to call Seek - will throw NotSupportedException. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Validates the underlying stream. - - - - - A wrapper stream that decrypts the base stream as it - is being read. - - - - - Initializes an DecryptStream with an decryption algorithm and a base stream. - - Stream to perform encryption on.. - Symmetric key to perform decryption - Initialization vector to perform decryption - - - - A wrapper stream that decrypts the base stream using AES algorithm as it - is being read. - - - - - Initializes an AESDecryptionStream with a base stream. - - Stream to perform decryption on.. - Symmetric key to perform decryption - Initialization vector to perform decryption - - - - Class to perform actions on a background thread. - Uses a single background thread and performs actions - on it in the order the data was sent through the instance. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Class to invoke actions on a background thread. - Uses a single background thread and invokes actions - on it in the order they were invoked through the instance. - - - - - A wrapper stream that encrypts the base stream as it - is being read. - - - - - Initializes an EncryptStream with an encryption algorithm and a base stream. - - Stream to perform encryption on.. - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Gets a value indicating whether the current stream supports seeking. - - - - - Returns encrypted content length. - - - - - Gets or sets the position within the current stream. - - - - - Sets the position within the current stream. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Validates the underlying stream. - - - - - A wrapper stream that encrypts the base stream as it - is being read. - - - - - Initializes an EncryptStream with an encryption algorithm and a base stream. - - Stream to perform encryption on.. - Symmetric key to perform encryption - Initialization vector to perform encryption - - - - A wrapper stream that encrypts the base stream using AES algorithm as it - is being read. - - - - - Initializes an AESEncryptionStream with a base stream. - - Stream to perform encryption on.. - Symmetric key to perform encryption - Initialization vector to perform encryption - - - - A wrapper stream that encrypts the base stream as it - is being read. - - - - - Initializes an EncryptStream for Multipart uploads with an encryption algorithm and a base stream. - - Stream to perform encryption on.. - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Gets a value indicating whether the current stream supports seeking. - - - - - Returns encrypted content length. - - - - - Gets or sets the position within the current stream. - - - - - Sets the position within the current stream. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Validates the underlying stream. - - - - - A wrapper stream that encrypts the base stream as it - is being read. - - - - - Initializes an EncryptStream with an encryption algorithm and a base stream. - - Stream to perform encryption on.. - Symmetric key to perform encryption - Initialization vector to perform encryption - - - - A wrapper stream that encrypts the base stream as it - is being read. - - - - - Initializes an AESEncryptionStream with a base stream. - - Stream to perform encryption on.. - Symmetric key to perform encryption - Initialization vector to perform encryption - - - - Returns true if the Content is set or there are - query parameters. - - This request - True if data is present; false otherwise. - - - - Utilities for dealing with Guids - - - - - Hashes a set of objects. - - - - - - - Combines a set of hashses. - - - - - - - Combines two hashes. - - - - - - - - Disposes of all managed and unmanaged resources. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - A wrapper stream that calculates a hash of the base stream as it - is being read. - The calculated hash is only available after the stream is closed or - CalculateHash is called. After calling CalculateHash, any further reads - on the streams will not change the CalculatedHash. - If an ExpectedHash is specified and is not equal to the calculated hash, - Close or CalculateHash methods will throw an AmazonClientException. - If CalculatedHash is calculated for only the portion of the stream that - is read. - - - Exception thrown during Close() or CalculateHash(), if ExpectedHash is set and - is different from CalculateHash that the stream calculates, provided that - CalculatedHash is not a zero-length byte array. - - - - - Algorithm to use to calculate hash. - - - - - True if hashing is finished and no more hashing should be done; - otherwise false. - - - - - Current position in the stream. - - - - - Calculated hash for the stream. - This value is set only after the stream is closed. - - - - - Expected hash value. Compared against CalculatedHash upon Close(). - If the hashes are different, an AmazonClientException is thrown. - - - - - Expected length of stream. - - - - - Initializes an HashStream with a hash algorithm and a base stream. - - Stream to calculate hash for. - - Expected hash. Will be compared against calculated hash on stream close. - Pass in null to disable check. - - - Expected length of the stream. If the reading stops before reaching this - position, CalculatedHash will be set to empty array. - - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Closes the underlying stream and finishes calculating the hash. - If an ExpectedHash is specified and is not equal to the calculated hash, - this method will throw an AmazonClientException. - - - If ExpectedHash is set and is different from CalculateHash that the stream calculates. - - - - - Gets a value indicating whether the current stream supports seeking. - HashStream does not support seeking, this will always be false. - - - - - Gets or sets the position within the current stream. - HashStream does not support seeking, attempting to set Position - will throw NotSupportedException. - - - - - Sets the position within the current stream. - HashStream does not support seeking, attempting to call Seek - will throw NotSupportedException. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Gets the overridden length used to construct the HashStream - - - - - Calculates the hash for the stream so far and disables any further - hashing. - - - - - Resets the hash stream to starting state. - Use this if the underlying stream has been modified and needs - to be rehashed without reconstructing the hierarchy. - - - - - Validates the underlying stream. - - - - - Compares two hashes (arrays of bytes). - - Expected hash. - Actual hash. - - True if the hashes are identical; otherwise false. - - - - - A wrapper stream that calculates a hash of the base stream as it - is being read or written. - The calculated hash is only available after the stream is closed or - CalculateHash is called. After calling CalculateHash, any further reads - on the streams will not change the CalculatedHash. - If an ExpectedHash is specified and is not equal to the calculated hash, - Close or CalculateHash methods will throw an AmazonClientException. - If base stream's position is not 0 or HashOnReads is true and the entire stream is - not read, the CalculatedHash will be set to an empty byte array and - comparison to ExpectedHash will not be made. - - - Exception thrown during Close() or CalculateHash(), if ExpectedHash is set and - is different from CalculateHash that the stream calculates, provided that - CalculatedHash is not a zero-length byte array. - - - - - Initializes an HashStream with a hash algorithm and a base stream. - - Stream to calculate hash for. - - Expected hash. Will be compared against calculated hash on stream close. - Pass in null to disable check. - - - Expected length of the stream. If the reading stops before reaching this - position, CalculatedHash will be set to empty array. - - - - - A wrapper stream that calculates an MD5 hash of the base stream as it - is being read or written. - The calculated hash is only available after the stream is closed or - CalculateHash is called. After calling CalculateHash, any further reads - on the streams will not change the CalculatedHash. - If an ExpectedHash is specified and is not equal to the calculated hash, - Close or CalculateHash methods will throw an AmazonClientException. - If base stream's position is not 0 or HashOnReads is true and the entire stream is - not read, the CalculatedHash will be set to an empty byte array and - comparison to ExpectedHash will not be made. - - - Exception thrown during Close() or CalculateHash(), if ExpectedHash is set and - is different from CalculateHash that the stream calculates, provided that - CalculatedHash is not a zero-length byte array. - - - - - Initializes an MD5Stream with a base stream. - - Stream to calculate hash for. - - Expected hash. Will be compared against calculated hash on stream close. - Pass in null to disable check. - - - Expected length of the stream. If the reading stops before reaching this - position, CalculatedHash will be set to empty array. - - - - - Utilities for validating label values for host prefix templates - - - - - Validates a label value - - - - - Provides read/write access to a file in the INI format. - - This class is not threadsafe. - - - - - Construct a new IniFile. - - path of the IniFile - - - - the path of the file - - - - - helper to access the lines of the file - - - - - Persist the changes to this INI file to disk. - - - - - Rename the section fromSectionName to toSectionName - - - - - - - Rename the section fromSectionName to toSectionName - - - - if true and destination section already exists overwrite it - - - - Copy the section fromSectionName to toSectionName - - - - Any properties in the original section that are also in this dictionary will - be replaced by the value from this dictionary. - - - - Copy the section fromSectionName to toSectionName - - - - Any properties in the original section that are also in this dictionary will - be replaced by the value from this dictionary. - if true and destination section already exists overwrite it - - - - Update the section with the properties given. - If the section doesn't exist, it will be appended to the file. - - Notes: - 1. Any properties that do exist in the section will be updated. - 2. A null value for a property denotes that it should be deleted from the section - 3. If any properties don't exist they will be appended to the end of the section - in the same order they appear in the SortedDictionary. - - name of the section to operate on - properties to add/update/delete - - - - Check if the section exists. If not, append it to the end of the file. - - section to ensure exists - - - - If the section exists, delete it from the INI file. - - section to delete - - - - Determine if a section exists in the INI file. - - name of section to look for - true if the section exists, false otherwise - - - - Return the properties for the section if it exists. - - name of section to get - properties contained in the section - True if the section was found, false otherwise - - - - Return the properties for the section if it exists. - - Regex to match name of section to get - properties contained in the section - True if the section was found, false otherwise - - - - Return the properties for the section if it exists. - - Regex to match name of section to get - name of section if regex matches - properties contained in the section - True if the section was found, false otherwise - - - - Simple wrapper around the log4net Error method. - - - - - - - - Write debug message to Console - - - - - - - - Write debug message to Console - - - - - - - Simple wrapper around the log4net InfoFormat method. - - - - - - - This is a dynamic wrapper around log4net so we can avoid log4net being required - to be distributed with the SDK. - - - - - Abstract logger class, base for any custom/specific loggers. - - - - - Flushes the logger contents. - - - - - Simple wrapper around the log4net IsErrorEnabled property. - - - - - Simple wrapper around the log4net IsDebugEnabled property. - - - - - Simple wrapper around the log4net IsInfoEnabled property. - - - - - Simple wrapper around the log4net Error method. - - - - - - - - Simple wrapper around the log4net Debug method. - - - - - - - - Simple wrapper around the log4net DebugFormat method. - - - - - - - Simple wrapper around the log4net InfoFormat method. - - - - - - - Logger wrapper for System.Diagnostics.TraceSource logger. - - - - - Creates TraceRoute for a given Type or the closest "parent" that has a listener configured. - Example: if type is Amazon.DynamoDB.AmazonDynamoDBClient, listeners can be configured for: - -Amazon.DynamoDB.AmazonDynamoDBClient - -Amazon.DynamoDB - -Amazon - The first matching TraceSource with listeners will be used. - If no listeners are configured for type or one of its "parents", will return null. - - - - - Gets a TraceSource for given Type with SourceLevels.All. - If there are no listeners configured for targetType or one of its "parents", returns null. - - - - - - - Gets a TraceSource for given Type and SourceLevels. - If there are no listeners configured for targetType or one of its "parents", returns null. - - - - - - - - Logger wrapper for reflected log4net logging methods. - - - - - This should be a one time call to use reflection to find all the types and methods - needed for the logging API. - - - - - Simple wrapper around the log4net IsErrorEnabled property. - - - - - Simple wrapper around the log4net Error method. - - - - - - - - Simple wrapper around the log4net IsDebugEnabled property. - - - - - Simple wrapper around the log4net Debug method. - - - - - - - - Simple wrapper around the log4net DebugFormat method. - - - - - - - Simple wrapper around the log4net IsInfoEnabled property. - - - - - Simple wrapper around the log4net InfoFormat method. - - - - - - - A single logged message - - - - - Log message arguments. - - - - - Culture-specific formatting provider. - - - - - Log message format. - - - - - a size-limited cache of key value pairs - - Once the maximum size has been reached, the least recently - used pairs will be evicted to make room for any new items. - - - - - - - the maximum number of entries this LruCache will hold - before items begin getting evicted - - - - - the number of items in the cache - - - - - Construct a new LruCache. - - maximum number of entries before items are evicted - - - - Add the key/value pair to the cache, or update - the value if the key already exists. - - If the cache is full, evicts the least recently used item. - - - - - - - Evicts a specific key out of the cache if it exists - - the key to evict from the cache - - - - Try to get the value associated with the key. - - the key to look up - the value, if the key exists - true if there is a value associated with the key, or false if no value is associated with the key - - - - Try to get the value associated with the key, if it doesn't exist, use the provided factory method to - create a new value and tries adding it to the cache. - - the key to look up - the factory method used in case the key is not present in the cache - the looked up value or the value created by the factory - - - - Clear the LruCache of all entries. - - - - - Helper class to support LruCache. - Does not implement the error checking and synchronization that - would be necessary for it to stand alone. - - - - - Item to be stored in the LruList - linked list structure. - - - - - Collection of properties being tracked - - - - - Timings for metrics being tracked - - - - - Counters being tracked - - - - - Whether metrics are enabled for the request - - - - - Constructs an empty, disabled metrics object - - - - - Starts timing an event. Logs an exception if an event - of the same type was started but not stopped. - - - - - - - Stops timing an event. Logs an exception if the event wasn't started. - - - - - - - Adds a property for a metric. If there are multiple, the - object is added as a new item in a list. - - - - - - - Sets a counter for a specific metric. - - - - - - - Increments a specific metric counter. - If counter doesn't exist yet, it is set to 1. - - - - - - Returns errors associated with the metric, including - if there are still any timing events in-flight. - - - - - - Returns a string representation of the current metrics. - - - - - - Return a JSON represenation of the current metrics - - - - - - Timing information for a metric - - - - - Empty, stopped timing object - - - - - Timing object in a started state - - - - - - Stops timing - - - - - - Whether the timing has been stopped - - - - - Elapsed ticks from start to stop. - If timing hasn't been stopped yet, returns 0. - - - - - Elapsed time from start to stop. - If timing hasn't been stopped yet, returns TimeSpan.Zero - - - - - Timing event, stops timing of a metric when disposed - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - The destructor for the client class. - - - - - A wrapper stream which supresses disposal of the underlying stream. - - - - - Constructor for NonDisposingWrapperStream. - - The base stream to wrap. - - - - The Close implementation for this wrapper stream - does not close the underlying stream. - - - - - The Dispose implementation for this wrapper stream - does not close the underlying stream. - - - - - Provides line-based read/write access to a file. - The file can be read into memory, changed, then written back to disk. - When the file is persisted back to disk, an optimistic concurrency - check is performed to make sure the file hasn't changed since it was - originally read. - - This class is not threadsafe. - - - - - a full copy of the original file - This is used for optimistic concurrency. - Note that this assumes a small file and does not scale large files. - - - - - path of the file - - - - - Read/write access to the lines that make up the file. - Any changes to this List are persisted back to disk when Persist() is called. - - NOTE: - The lines have the original line endings on them to preserve the - original text as much as possible. - - - - - Construct a new OptimisticLockedTextFile. - - path of the file - - - - Persist changes to disk after an optimistic concurrency check is completed. - - - - - This class is used to wrap a stream for a particular segment of a stream. It - makes that segment look like you are reading from beginning to end of the stream. - - - - - Subclass of IniFile that allows INI sections to be read with the profile keyword in front of the section name. - - - - - Wrapper stream that only supports reading - - - - - Partial wrapper stream that only supports reading - - - - - Uri wrapper that can parse out information (bucket, key, region, style) from an - S3 URI. - - - - - True if the URI contains the bucket in the path, false if it contains the bucket in the authority. - - - - - The bucket name parsed from the URI (or null if no bucket specified). - - - - - The key parsed from the URI (or null if no key specified). - - - - - The region parsed from the URI (or null if no region specified). - - - - - Constructs a parser for the S3 URI specified as a string. - - The S3 URI to be parsed. - - - - Constructs a parser for the S3 URI specified as a Uri instance. - - The S3 URI to be parsed. - - - - Percent-decodes the given string, with a fast path for strings that are not - percent-encoded. - - The string to decode - The decoded string - - - - Percent-decodes the given string. - - The string to decode - The index of the first '%' in the string - The decoded string - - - - Decodes the percent-encoded character at the given index in the string - and appends the decoded value to the string under construction. - - - The string under construction to which the decoded character will be - appended. - - The string being decoded. - The index of the '%' character in the string. - - - - Converts a hex character (0-9A-Fa-f) into its corresponding quad value. - - The hex character - The quad value - - - - Interface for a non-generic cache. - - - - - Clears the entire cache. - - - - - Maximum time to keep an item around after its last use. - - - - - How often should the cache be cleared of old items. - - - - - The number of items in the cache. - - - - - Interface for a generic cache. - - - - - - - Retrieves a value out of the cache or from the source. - - - - - - - - Retrieves a value out of the cache or from the source. - If the item was in the cache, isStaleItem is set to true; - otherwise, if the item comes from the source, isStaleItem is false. - - - - - - - - - Clears a specific value from the cache if it's there. - - - - - - Returns the keys for all items in the cache. - - - - - - Executes specified operation, catches exception, clears the cache for - the given key, retries the operation. - - - - - - - - - - - SDK-wide cache. - Provides access to caches specific to a particular set of credentials - and target region. - - - - - Clear all caches - - - - - Clear all caches of a particular type - - - - - - Retrieve a cache of a specific type for a client object. - The client object can be null in cases where a cache does - not correspond to a specific AWS account or target region. - - - - - - - - - - - Retrieve a cache of a specific type for a client object. - The client object can be null in cases where a cache does - not correspond to a specific AWS account or target region. - - - - - - - - - - - Utilities for converting objects to strings. Used by the marshaller classes. - - - - - Converts a DateTime to ISO8601 formatted string. - - - - - Converts a DateTime to RFC822 formatted string. - - - - - Converts a DateTime to Unix epoch time formatted string. - - - - - A wrapper stream. - - - - - Base stream. - - - - - Initializes WrapperStream with a base stream. - - - - - - Returns the first base non-WrapperStream. - - First base stream that is non-WrapperStream. - - - - Returns the first base non-WrapperStream. - - First base stream that is non-WrapperStream. - - - - Returns the first base non-WrapperStream. - - Potential WrapperStream - Base non-WrapperStream. - - - - Gets a value indicating whether the current stream supports reading. - True if the stream supports reading; otherwise, false. - - - - - Gets a value indicating whether the current stream supports seeking. - True if the stream supports seeking; otherwise, false. - - - - - Gets a value indicating whether the current stream supports writing. - True if the stream supports writing; otherwise, false. - - - - - Closes the current stream and releases any resources (such as sockets and - file handles) associated with the current stream. - - - - - Gets the length in bytes of the stream. - - - - - Gets or sets the position within the current stream. - - - - - Gets or sets a value, in miliseconds, that determines how long the stream - will attempt to read before timing out. - - - - - Gets or sets a value, in miliseconds, that determines how long the stream - will attempt to write before timing out. - - - - - Clears all buffers for this stream and causes any buffered data to be written - to the underlying device. - - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Sets the position within the current stream. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Sets the length of the current stream. - - The desired length of the current stream in bytes. - - - - Writes a sequence of bytes to the current stream and advances the current - position within this stream by the number of bytes written. - - - An array of bytes. This method copies count bytes from buffer to the current stream. - - - The zero-based byte offset in buffer at which to begin copying bytes to the - current stream. - - The number of bytes to be written to the current stream. - - - - This class is no longer used anymore and should be avoided as it is just meant - as a last resort when blending async and sync operations. The code is still - here to support versions before 3.3.9.0 of AWSSDK.DynamoDBv2. - - - - - Collection of parameters that an SDK client will send to a service. - - - - - Constructs empty ParameterCollection. - - - - - Adds a parameter with a string value. - - - - - - - Adds a parameter with a list-of-strings value. - - - - - - - Converts the current parameters into a list of key-value pairs. - - - - - - Property to denote that the last exception returned by an AWS Service - was retryable or not. - - - - - This handler processes exceptions thrown from the HTTP handler and - unmarshalls error responses. - - - - - Default set of exception handlers. - - - - - Default set of exception handlers. - - - - - Constructor for ErrorHandler. - - an ILogger instance. - - - - Handles and processes any exception thrown from underlying handlers. - - The execution context which contains both the - requests and response context. - - - - Handles and processes any exception thrown from underlying handlers. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Disposes the response body. - - The response context. - - - - Processes an exception by invoking a matching exception handler - for the given exception. - - The execution context, it contains the - request and response context. - The exception to be processed. - - This method returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception that may be thrown by exception - processing by a matching exception handler. - - - - - The abstract base class for exception handlers. - - The exception type. - - - - The exception handler for HttpErrorResponseException exception. - - - - - The constructor for HttpErrorResponseExceptionHandler. - - in instance of ILogger. - - - - Handles an exception for the given execution context. - - The execution context, it contains the - request and response context. - The exception to handle. - - Returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception to replace the original exception. - - - - - Checks if a HTTP 404 status code is returned which needs to be suppressed and - processes it. - If a suppressed 404 is present, it unmarshalls the response and returns true to - indicate that a suppressed 404 was processed, else returns false. - - The execution context, it contains the - request and response context. - - - If a suppressed 404 is present, returns true, else returns false. - - - - - The exception handler for HttpErrorResponseException exception. - - - - - A pipeline handler which provides hooks to run - external code in the pre-invoke and post-invoke phases. - - - - - Action to execute on the pre invoke phase. - - - - - Action to execute on the post invoke phase. - - - - - Calls the PreInvoke and PostInvoke methods before and after calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls the PreInvoke and PostInvoke methods before and after calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Executes the OnPreInvoke action as part of pre-invoke. - - The execution context, it contains the - request and response context. - - - - Executes the OnPreInvoke action as part of post-invoke. - - The execution context, it contains the - request and response context. - - - - This handler retrieved the AWS credentials to be used for the current call. - - - - - The constructor for CredentialsRetriever. - - An AWSCredentials instance. - - - - Retrieves the credentials to be used for the current call before - invoking the next handler. - - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - The CSM handler has the logic for capturing data for CSM attempts when enabled. - - - - - Invokes the CSM handler and captures data for the CSM attempts. - - - - - Calls the PreInvoke and PostInvoke methods before and after calling the next handler - in the pipeline. - - - - - Method that gets called in the final clause that captures data for each http request - from the request and response context. - - - - - Executes the OnPreInvoke action as part of pre-invoke. - - - - - Method to collect data in case of connection exception - - - - - Method to collect data in case of Amazon service exception - - - - - The CSM handler has the logic for capturing data for CSM events when enabled. - - - - - Invokes the CSM handler and captures data for the CSM events. - - - - - Calls the PreInvoke and PostInvoke methods before and after calling the next handler - in the pipeline. - - - - - Invoked from the finally block of CSMCallEventHandler's Invoke method. - This method is used to capture CSM Call event metrics. - - - - - - Method that gets invoked in case of an exception in the API request completion. - - - - - - - This handler resolves the endpoint to be used for the current request. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Resolves the endpoint to be used for the current request - before invoking the next handler. - - The execution context, it contains the - request and response context. - - - - This handler resolves the endpoint to be used for the current request. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Resolves the endpoint to be used for the current request - before invoking the next handler. - - The execution context, it contains the - request and response context. - - - - Determines the endpoint for the request. - - The request context. - - - - - This handler provides an OnError action that can be used as hook for - external code to handle exceptions in the runtime pipeline. - - - - - Action to execute if an exception occurs during the - execution of any underlying handlers. - - - - - Executes the OnError action if an exception occurs during the - execution of any underlying handlers. - - - - - - - This handler marshalls the request before calling invoking the next handler. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Marshalls the request before calling invoking the next handler. - - The execution context, it contains the - request and response context. - - - - This handler manages the metrics used to time the complete call and - logs the final metrics. - - - - - Captures the overall execution time and logs final metrics. - - The execution context which contains both the - requests and response context. - - - - Captures the overall execution time and logs final metrics. - - The response type for the current request. - - The execution context, it contains the request and response context. - - A task that represents the asynchronous operation. - - - - This handler processes HTTP redirects and reissues the call to the - redirected location. - - - - - Processes HTTP redirects and reissues the call to the - redirected location. - - The execution context which contains both the - requests and response context. - - - - Processes HTTP redirects and reissues the call to the - redirected location. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Checks if an HTTP 307 (temporary redirect) has occured and changes the - request endpoint to the redirected location. - - - The execution context, it contains the request and response context. - - - A boolean value that indicates if a redirect has occured. - - - - - This handler signs the request. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Signs the request before invoking the next handler. - - - The execution context, it contains the request and response context. - - - - - Determines if the request should be signed. - - The request context. - A boolean value that indicated if the request should be signed. - - - - Signs the request. - - The request context. - - - - This handler unmarshalls the HTTP response. - - - - - The constructor for Unmarshaller. - - - Boolean value which indicated if the unmarshaller - handler supports response logging. - - - - - Unmarshalls the response returned by the HttpHandler. - - The execution context which contains both the - requests and response context. - - - - Unmarshalls the response returned by the HttpHandler. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Unmarshalls the HTTP response. - - - The execution context, it contains the request and response context. - - - - - Constructs a new instance of the HttpErrorResponseException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - The HTTP handler contains common logic for issuing an HTTP request that is - independent of the underlying HTTP infrastructure. - - - - - - The sender parameter used in any events raised by this handler. - - - - - The constructor for HttpHandler. - - The request factory used to create HTTP Requests. - The sender parameter used in any events raised by this handler. - - - - Issues an HTTP request for the current request context. - - The execution context which contains both the - requests and response context. - - - - Issues an HTTP request for the current request context. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Determines the content for request body and uses the HTTP request - to write the content to the HTTP request body. - - Content to be written. - The HTTP request. - The request context. - - - - Creates the HttpWebRequest and configures the end point, content, user agent and proxy settings. - - The async request. - The web request that actually makes the call. - - - - Disposes the HTTP handler. - - - - - The request factory for System.Net.HttpWebRequest. - - - - - Some AWS services like Cloud 9 require at least TLS 1.1. Version of .NET Framework 4.5 and earlier - do not eanble TLS 1.1 and TLS 1.2 by default. This code adds those protocols if using an earlier - version of .NET that explicitly set the protocol and didn't have TLS 1.1 and TLS 1.2. - - - - - - Some AWS services like Cloud 9 require at least TLS 1.1. Version of .NET Framework 4.5 and earlier - do not eanble TLS 1.1 and TLS 1.2 by default. This code adds those protocols if using an earlier - version of .NET that explicitly set the protocol and didn't have TLS 1.1 and TLS 1.2. - - - - - - - Creates an HTTP request for the given URI. - - The request URI. - An HTTP request. - - - - This method is used for unit testing purposes. It allows setting of the flag - that indicates protocol setting was attempted. - - The new value - - - - Disposes the HttpWebRequestFactory. - - - - - HTTP request wrapper for System.Net.HttpWebRequest. - - - - - Constructor for HttpRequest. - - The request URI. - - - - The underlying HTTP web request. - - - - - The HTTP method or verb. - - - - - The request URI. - - - - - Returns the HTTP response. - - The HTTP response. - - - - Gets a handle to the request content. - - The request content. - - - - Writes a stream to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - The request context. - - - - Writes a byte array to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - - - - Aborts the HTTP request. - - - - - Gets a handle to the request content. - - - - - - Returns the HTTP response. - - A cancellation token that can be used to cancel the asynchronous operation. - - - - - Configures a request as per the request context. - - The request context. - - - - Sets the headers on the request. - - A dictionary of header names and values. - - - - Disposes the HttpRequest. - - - - - Sets up the progress listeners - - The content stream - The interval at which progress needs to be published - The objects which is trigerring the progress changes - The callback which will be invoked when the progress changed event is trigerred - an object, incase the progress is setup, else returns the original stream - - - - An abstract pipeline handler that has implements IPipelineHandler, - and has the default implmentation. This is the base class for most of - the handler implementations. - - - - - The logger used to log messages. - - - - - The inner handler which is called after the current - handler completes it's processing. - - - - - The outer handler which encapsulates the current handler. - - - - - Contains the processing logic for a synchronous request invocation. - This method calls InnerHandler.InvokeSync to continue processing of the - request by the pipeline. - - The execution context which contains both the - requests and response context. - - - - Contains the processing logic for an asynchronous request invocation. - This method calls InnerHandler.InvokeSync to continue processing of the - request by the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Logs the metrics for the current execution context. - - The execution context, it contains the - request and response context. - - - - The default implementation of the retry policy. - - - The default implementation of the retry policy. - - - - - The maximum value of exponential backoff in milliseconds, which will be used to wait - before retrying a request. - - - - - List of HTTP Status codes codes which are returned as part of the error response. - These status codes will be retried. - - - - - List of AWS specific error codes which are returned as part of the error response. - These error codes will be retried. - - - - - List of WebExceptionStatus for a WebException which will be retried. - - - - - Constructor for DefaultRetryPolicy. - - The maximum number of retries before throwing - back a exception. This does not count the initial request. - - - - Constructor for DefaultRetryPolicy. - - The Client config object. This is used to - retrieve the maximum number of retries before throwing - back a exception(This does not count the initial request) and - the service URL for the request. - - - - Returns true if the request is in a state where it can be retried, else false. - - Request context containing the state of the request. - Returns true if the request is in a state where it can be retried, else false. - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - - - - Virtual method that gets called on a success Response. If its a retry success response, the entire - retry acquired capacity is released(default is 5). If its just a success response a lesser value capacity - is released(default is 1). - - Request context containing the state of the request. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Request context containing the state of the request. - Return true if the request should be retried. - - - - Checks if the retry limit is reached. - - Request context containing the state of the request. - Return false if the request can be retried, based on number of retries. - - - - Waits before retrying a request. The default policy implements a exponential backoff. - - Request context containing the state of the request. - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - The retry handler has the generic logic for retrying requests. - It uses a retry policy which specifies when - a retry should be performed. - - - - - The logger used to log messages. - - - - - The retry policy which specifies when - a retry should be performed. - - - - - Constructor which takes in a retry policy. - - Retry Policy - - - - Invokes the inner handler and performs a retry, if required as per the - retry policy. - - The execution context which contains both the - requests and response context. - - - - Invokes the inner handler and performs a retry, if required as per the - retry policy. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Prepares the request for retry. - - Request context containing the state of the request. - - - - A runtime pipeline contains a collection of handlers which represent - different stages of request and response processing. - - - - - The top-most handler in the pipeline. - - - - - Constructor for RuntimePipeline. - - The handler with which the pipeline is initalized. - - - - Constructor for RuntimePipeline. - - List of handlers with which the pipeline is initalized. - - - - Constructor for RuntimePipeline. - - List of handlers with which the pipeline is initalized. - The logger used to log messages. - - - - Constructor for RuntimePipeline. - - The handler with which the pipeline is initalized. - The logger used to log messages. - - - - Invokes the pipeline synchronously. - - Request context - Response context - - - - Invokes the pipeline asynchronously. - - Request context - Response context - - - - Adds a new handler to the top of the pipeline. - - The handler to be added to the pipeline. - - - - Adds a handler after the first instance of handler of type T. - - Type of the handler after which the given handler instance is added. - The handler to be added to the pipeline. - - - - Adds a handler before the first instance of handler of type T. - - Type of the handler before which the given handler instance is added. - The handler to be added to the pipeline. - - - - Removes the first occurance of a handler of type T. - - Type of the handler which will be removed. - - - - Replaces the first occurance of a handler of type T with the given handler. - - Type of the handler which will be replaced. - The handler to be added to the pipeline. - - - - Inserts the given handler after current handler in the pipeline. - - Handler to be inserted in the pipeline. - Handler after which the given handler is inserted. - - - - Gets the innermost handler by traversing the inner handler till - it reaches the last one. - - - - - Retrieves a list of handlers, in the order of their execution. - - Handlers in the current pipeline. - - - - Retrieves current handlers, in the order of their execution. - - Handlers in the current pipeline. - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Provides information for Client Context header. - Client Context header needs information like App title, version code, version name, package name etc. - - - - - The title of your app. For example, "My App". - If this property is not null, the value would be used in Client Context header. - - - - - The version for your app. For example, V3.0. - If this property is not null, the value would be used in Client Context header. - - - - - The version code of your app. For example, 3.0. - If this property is not null, the value would be used in Client Context header. - - - - - The name of your app package. For example, com.your_company.your_app. - If this property is not null, the value would be used in Client Context header. - - - - - The operating system of the device. For example, iPhoneOS. - If this property is not null, the value would be used in Client Context header. - - - - - The version of the operating system of the device. For example, 8.1. - If this property is not null, the value would be used in Client Context header. - - - - - The locale of the device. For example, en_US. - If this property is not null, the value would be used in Client Context header. - - - - - The manufacturer of the device. For example, Samsung. - If this property is not null, the value would be used in Client Context header. - - - - - The model of the device. For example, Nexus. - If this property is not null, the value would be used in Client Context header. - - - - - This class is the base class of all the configurations settings to connect - to a service. - - - This class is the base class of all the configurations settings to connect - to a service. - - - - - Gets Service Version - - - - - Gets and sets of the signatureMethod property. - - - - - Gets and sets of the SignatureVersion property. - - Note: This property exists for backward compatibility but is no longer - used by any service other than S3. - - - - - Gets and sets of the UserAgent property. - - - - - Gets and sets the RegionEndpoint property. The region constant that - determines the endpoint to use. - - Setting this property to null will force the SDK to recalculate the - RegionEndpoint value based on App/WebConfig, environment variables, - profile, etc. - - - - - The constant used to lookup in the region hash the endpoint. - - - - - Gets and sets of the ServiceURL property. - This is an optional property; change it - only if you want to try a different service - endpoint. - - - - - Gets and sets the UseHttp. - If this property is set to true, the client attempts - to use HTTP protocol, if the target endpoint supports it. - By default, this property is set to false. - - - - - Given this client configuration, return a string form ofthe service endpoint url. - - - - - Gets and sets the AuthenticationRegion property. - Used in AWS4 request signing, this is an optional property; - change it only if the region cannot be determined from the - service endpoint. - - - - - Gets and sets the AuthenticationServiceName property. - Used in AWS4 request signing, this is the short-form - name of the service being called. - - - - - Gets and sets of the MaxErrorRetry property. - - - - - Gets and sets the LogResponse property. - If this property is set to true, the service response is logged. - The size of response being logged is controlled by the AWSConfigs.LoggingConfig.LogResponsesSizeLimit property. - - - - - Gets and sets the ReadEntireResponse property. - NOTE: This property does not effect response processing and is deprecated. - To enable response logging, the ClientConfig.LogResponse and AWSConfigs.LoggingConfig - properties can be used. - - - - - Gets and Sets the BufferSize property. - The BufferSize controls the buffer used to read in from input streams and write - out to the request. - - - - - - Gets or sets the interval at which progress update events are raised - for upload operations. By default, the progress update events are - raised at every 100KB of data transferred. - - - If the value of this property is set less than ClientConfig.BufferSize, - progress updates events will be raised at the interval specified by ClientConfig.BufferSize. - - - - - - Flag on whether to resign requests on retry or not. - For Amazon S3 and Amazon Glacier this value will always be set to true. - - - - - This flag controls if .NET HTTP infrastructure should follow redirection - responses (e.g. HTTP 307 - temporary redirect). - - - - - Flag on whether to log metrics for service calls. - - This can be set in the application's configs, as below: - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSLogMetrics" value"true"/> - </appSettings> - </configuration> - - - - - - Gets and sets the DisableLogging. If true logging for this client will be disabled. - - - - - Credentials to use with a proxy. - - - - - Specifies the TCP keep-alive values to use for service requests. - - - - - - If the value is set, the value is assigned to the Timeout property of the HttpWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Configures the endpoint calculation for a service to go to a dual stack (ipv6 enabled) endpoint - for the configured region. - - - Note: AWS services are enabling dualstack endpoints over time. It is your responsibility to check - that the service actually supports a dualstack endpoint in the configured region before enabling - this option for a service. - - - - - Enable or disable the Retry Throttling feature by setting the ThrottleRetries flag to True/False resepctively. - Retry Throttling is a feature that intelligently throttles retry attempts when a large precentage of requests - are failing and retries are unsuccessful as well. In such situations the allotted retry capacity for the service URL - will be drained until requests start to succeed again. Once the requisite capacity is available, retries would - be permitted again. When retries are throttled, the service enters a fail-fast behaviour as the traditional retry attempt - for the request would be circumvented. Hence, errors will resurface quickly. This will result in a greated number of exceptions - but prevents requests being tied up in unsuccessful retry attempts. - Note: Retry Throttling is enabled by default. Set the ThrottleRetries flag to false to switch off this feature. - - - - - Enable or disable the Nagle algorithm on the underlying http - client. - - This method is not intended to be called by consumers of the AWS SDK for .NET - - - - - - Performs validation on this config object. - Throws exception if any of the required values are missing/invalid. - - - - - Returns the current UTC now after clock correction for this endpoint. - - - - - The calculated clock skew correction for a specific endpoint, if there is one. - This field will be set if a service call resulted in an exception - and the SDK has determined that there is a difference between local - and server times. - - If is set to true, this - value will still be set to the correction, but it will not be used by the - SDK and clock skew errors will not be retried. - - - - - Gets and sets the DisableHostPrefixInjection flag. If true, host prefix injection will be disabled for this client, the default value of this flag is false. - Host prefix injection prefixes the service endpoint with request members from APIs which use this feature. - Example: for a hostPrefix of "foo-name." and a endpoint of "service.region.amazonaws.com" the default behavior is to - prefix the endpoint with the hostPrefix resulting in a final endpoint of "foo-name.service.region.amazonaws.com". Setting - DisableHostPrefixInjection to true will disable hostPrefix injection resulting in a final endpoint of - "service.region.amazonaws.com" regardless of the value of hostPrefix. E.g. You may want to disable host prefix injection for testing against a local mock endpoint. - - - - - Returns the flag indicating if endpoint discovery should be enabled or disabled for operations that are not required to use endpoint discovery. - - - - - Returns the maximum number of discovered endpoints that can be stored within the cache for the client. The default limit is 1000 cache entries. - - - - - Throw an exception if the boxed TimeSpan parameter doesn't have a value or is out of range. - - - - - Returns the request timeout value if its value is set, - else returns client timeout value. - - - - - Overrides the default read-write timeout value. - - - - If the value is set, the value is assigned to the ReadWriteTimeout property of the HttpWebRequest object used - to send requests. - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Gets and sets of the ProxyHost property. - - - - - Gets and sets the ProxyPort property. - - - - - Gets and sets the ProxyBypassList property; a collection - of regular expressions denoting the set of endpoints for - which the configured proxy host will be bypassed. - - - For more information on bypass lists - see https://msdn.microsoft.com/en-us/library/system.net.webproxy.bypasslist%28v=vs.110%29.aspx. - - - - - Gets and sets the ProxyBypassOnLocal property. - If set true requests to local addresses bypass the configured - proxy. - - - - - Returns a WebProxy instance configured to match the proxy settings - in the client configuration. - - - - - Unpacks the host, port and any credentials info into the instance's - proxy-related fields. - - The proxy details - - - - Gets and sets the max idle time set on the ServicePoint for the WebRequest. - Default value is 50 seconds (50,000 ms) unless ServicePointManager.MaxServicePointIdleTime is set, - in which case ServicePointManager.MaxServicePointIdleTime will be used as the default. - - - - - Gets and sets the connection limit set on the ServicePoint for the WebRequest. - Default value is 50 connections unless ServicePointManager.DefaultConnectionLimit is set in - which case ServicePointManager.DefaultConnectionLimit will be used as the default. - - - - - Gets or sets a Boolean value that determines whether the Nagle algorithm is used on connections managed by the ServicePoint object used - for requests to AWS. This is defaulted to false for lower latency with responses that return small amount of data. This is the opposite - default than ServicePoint.UseNagleAlgorithm which is optimized for large responses like web pages or images. - - - - - Base class for constant class that holds the value that will be sent to AWS for the static constants. - - - - - Gets the value that needs to be used when send the value to AWS - - - - - Attempt to find correct-cased constant value using whatever cased value the user - has provided. This is primarily useful for mapping any-cased values from a CLI - tool to the specific casing required by the service, avoiding the need for the - user to (a) remember the specific case and (b) actually type it correctly. - - The properly cased service constant matching the value - - - - Utility class that stores clock skew information. - - - - - GlobalClockCorrection should be only set by AWSConfigs.ManualClockCorrection property - and is only available to maintain backward compatibilty. This should override any - endpoint specific clockskew correction. - - - - - Return clock skew correction value for an endpoint if there is one. - - AWSConfigs.ManualClockCorrection overrides globally any calculated service endpoint specific - clock correction value. - - Endpoint should in a form such as "https://s3" - Clock correction value for an endpoint in TimeSpan. TimeSpan.Zero if no such clock correction is set. - - - - Get clock skew corrected UTC now value. If ManualClockCorrection is set, - use ManualClockCorrection instead of endpoint specific clock correction value. - - - - - - - Factory to construct different types of AWSCredentials based on a profile. - - - - - Gets the AWSCredentials for this profile if CanCreateAWSCredentials is true - and AWSCredentials can be created. Throws an exception otherwise. - - See for a list of AWSCredentials returned by this method. - - The profile to get AWSCredentials for. - The profile source, for profiles that reference other profiles. - AWSCredentials for this profile. - - - - Gets the AWSCredentials for this profile if CanCreateAWSCredentials is true - and AWSCredentials can be created. Throws an exception otherwise. - - See for a list of AWSCredentials returned by this method. - - The options to get AWSCredentials for. - The profile source, for options that reference other profiles. - AWSCredentials for the options given. - - - - Gets the AWSCredentials for this profile if CanCreateAWSCredentials is true - and AWSCredentials can be created. Throws an exception otherwise. - - See for a list of AWSCredentials returned by this method. - - The profile to get AWSCredentials for. - The profile source, for profiles that reference other profiles. - If true, throw a descriptive exception for any credentials that would not operate as-is. - In other words, any credentials that require programmatic callbacks at runtime. - AWSCredentials for this profile. - - - - Gets the AWSCredentials for this profile if CanCreateAWSCredentials is true - and AWSCredentials can be created. Throws an exception otherwise. - - See for a list of AWSCredentials returned by this method. - - The options to get AWSCredentials for. - The profile source, for options that reference other profiles. - If true, throw a descriptive exception for any credentials that would not operate as-is. - In other words, any credentials that require programmatic callbacks at runtime. - AWSCredentials for the options given. - - - - Return the credentials for the profile if valid credentials can created. - - The profile to create credentials with. - The profile source, for profiles that reference other profiles. - The credentials for the profile. - True if credentials can be created from the profile, false otherwise. - - - - Return the credentials for the profile if valid credentials can created. - - The options to get AWSCredentials for. - The profile source, for profiles that reference other profiles. - The credentials for the profile. - True if credentials can be created from the profile, false otherwise. - - - - Determine if the profileType will generate AWSCredentials that require a callback to be set on them. - - - - - - - A named group of options that are persisted and used to obtain AWSCredentials. - - - - - The name of the CredentialProfile - - - - - The options to be used to create AWSCredentials. - - - - - The region to be used with this CredentialProfile - - - - - The unique key for this CredentialProfile. - This key is used by the Visual Studio Tooklit to associate external artifacts with this profile. - - - - - The endpoint discovery enabled value for this CredentialProfile - - - - - If true the region identified in the S3 access point arn will be used when making requests. - - - - - The Sts Regional Endpoints Value as either legacy or regional - - - - - The S3 Regional Endpoint Value as either legacy or regional - - - - - An optional dictionary of name-value pairs stored with the CredentialProfile - - - - - True if the properties of the Options object can be converted into AWSCredentials, false otherwise. - See for more details about which options are available. - - - - - The that this is associated with. - Null if this is not associated with a . - - - - - If CanCreateAWSCredentials is true, returns a short description of the type of - credentials that would be created. - If CanCreateAWSCredentials is false, return null. - - - - - The CredentialProfileType of this CredentialProfile, if one applies. - - - - - Determine this CredentialProfile will generate AWSCredentials that require a callback to be set on them. - - - - - Construct a new CredentialProfile. - - - - - - - Gets the AWSCredentials for this profile if CanCreateAWSCredentials is true - and AWSCredentials can be created. Throws an exception otherwise. - - See for a list of AWSCredentials returned by this method. - - The profile source, for profiles that reference other profiles. - AWSCredentials for this profile. - - - - Gets the AWSCredentials for this profile if CanCreateAWSCredentials is true - and AWSCredentials can be created. Throws an exception otherwise. - - See for a list of AWSCredentials returned by this method. - - The profile source, for profiles that reference other profiles. - If true, throw a descriptive exception for any credentials that would not operate as-is. - In other words, any credentials that require programmatic callbacks at runtime. - AWSCredentials for this profile. - - - - The options that are available for creating AWSCredentials with the AWSCredentialsFactory. - The type of AWSCredentials that are created depends on which Options are set. - - Below are the different types of credentials returned, along with the options that are used to obtain them. - ([] denotes options that are not required) - - BasicAWSCredentials AccessKey SecretKey - SessionAWSCredentials AccessKey SecretKey Token - AssmeRoleAWSCredentials SourceProfile RoleArn [ExternalID] [MfaSerial] - FederatedAWSCredentials EndpointName RoleArn [UserIdentity] - - - - - The access key to be used in the AWSCredentials. - - - - - The source of credentials to be used to obtain AWSCredentials. - - - - - The endpoint name to be used for federated AWSCredentials. - - - - - The external id to use in assume role AWSCredentials. - - - - - The serial number of the MFA to use in assume role AWSCredentials. - - - - The role ARN to use when creating assume role or federated AWSCredentials. - - - - An identifier for the assumed role session. - - - - - The secret key to use when creating AWSCredentials. - - - - - When this CredentialProfileOptions object references another CredentialProfile, - the name of the referenced CredentialProfile. - - - - - The session token to be used to create AWSCredentials. - - - - - The user identity to use when creating federated AWSCredentials. - If not set, the user identity that the code is running under will be used. - - - - - Contains the executable information to be used by the process credential retriever - to either fetch Basic or Session credentials - - - - - Absolute path to the file on disk containing an OIDC token. - - - - - Return true the properties are all null or empty, false otherwise. - - - - - Class to abstract the combined use of NetSDKCredentialsFile and SharedCredentialsFile where possible. - - - - - - The location of the shared credentials file, or null to use the default location. - - - - - Construct a CredentialProfileChain. - - - - - Construct a CredentialProfileChain. - - The path to the aws credentials file to look at. - - - - - Try to get from a profile. - - - If ProfilesLocation is non-null and non-empty search the shared credentials - file at the disk path in the ProfilesLocation property. - - - If ProfilesLocation is null or empty and the platform supports the .NET SDK credentials file - search the SDK credentials file. If the profile is not found search the shared credentials file in the default location. - - - If ProfilesLocation is null or empty and the platform doesn't support the .NET SDK credentials file - search the shared credentials file in the default location. - - - The name of the profile to get credentials from. - The credentials, if the profile is found and credentials can be created. - True if the profile was found and credentials could be created, false otherwise. - - - - - Try to get a - - - If ProfilesLocation is non-null and non-empty search the shared credentials - file at the disk path in the ProfilesLocation property. - - - If ProfilesLocation is null or empty and the platform supports the .NET SDK credentials file - search the SDK credentials file. If the profile is not found search the shared credentials file in the default location. - - - If ProfilesLocation is null or empty and the platform doesn't support the .NET SDK credentials file - search the shared credentials file in the default location. - - - The name of the profile to get. - The profile, if found - True if the profile was found, false otherwise. - - - - - Get a list of available objects. - - - If ProfilesLocation is non-null and non-empty include profiles in the shared credentials - file at the disk path in the ProfilesLocation property. - - - If ProfilesLocation is null or empty and the platform supports the .NET SDK credentials file - include profiles from the SDK credentials file and from the shared credentials file in the default location. - - - If ProfilesLocation is null or empty and the platform doesn't support the .NET SDK credentials file - include profiles from the shared credentials file in the default location. - - - A list of objects. - - - - - Register a - - - If ProfilesLocation is non-null and non-empty register the profile in the shared credentials - file at the disk path in the ProfilesLocation property. - - - If ProfilesLocation is null or empty and the platform supports the .NET SDK credentials file - register the profile in the SDK credentials file. - - - If ProfilesLocation is null or empty and the platform doesn't support the .NET SDK credentials file - register the profile in the shared credentials file in the default location. - - - The profile to register. - - - - - Unregister a - - - If ProfilesLocation is non-null and non-empty unregister the profile from the shared credentials - file at the disk path in the ProfilesLocation property. - - - If ProfilesLocation is null or empty and the platform supports the .NET SDK credentials file - search the SDK credentials file. If the profile is found there unregister it. - If the profile was not found search the shared credentials file in the default location. - If the profile is found in the shared credentials file in the default location unregister it. - - - If ProfilesLocation is null or empty and the platform doesn't support the .NET SDK credentials file - search the shared credentials file in the default location. If the profile is found in the - shared credentials file in the default location unregister it. - - - The name of the profile to unregister. - - - - Interface to define the necessary operations for a CredentialProfile lookup mechanism. - - - - - Get the profile with the given name, if one exists. - - The name of the profile to get. - The profile, if it was found, null otherwise. - True if the profile was found, false otherwise. - - - - Interface to define the necessary operations for a CredentialProfile storage mechanism. - - - - - Rename the profile with oldProfileName to newProfileName. - - The profile to rename. - The new name for the profile. - - - - Rename the profile with oldProfileName to newProfileName. - - The profile to rename. - The new name for the profile. - If true and the destination profile exists it will be overwritten. - - - - Make a copy of the profile with fromProfileName called toProfileName. - - The name of the profile to copy from. - The name of the new profile. - - - - Make a copy of the profile with fromProfileName called toProfileName. - - The name of the profile to copy from. - The name of the new profile. - If true and the destination profile exists it will be overwritten. - - - - Add the given profile to the store, or update it if one with the same name already exists. - - - - - - Delete the profile with profileName if it exists. - - The name of the profile to delete. - - - - Get a list of valid profile names from this store. - Invalid profiles are ignored. - See for more information - about valid profiles. - - - - - - Get a list of valid profiles from this store. - Invalid profiles are ignored. - See for more information - about valid profiles. - - - - - - Class to easily convert from Dictionary<string, string> to ProfileOptions and back. - - - - - Separate the profileDictionary into its parts. - profileDictionary = profileOptions + reservedProperties + userProperties - - Dictionary with everything in it - Keys to ignore - The resulting CredentialProfileOptions - The properties that are left - - - - Separate the profileDictionary into its parts. - profileDictionary = profileOptions + reservedProperties + userProperties - - Dictionary with everything in it - Keys for the reservedKeys dictionary - The resulting CredentialProfileOptions - The resulting reserved properties - The properties that are left - - - - Validate the userProperties and then combine profileOptions, reservedProperties, and userProperties into one Dictionary. - - - - - - - - - - Make sure the userProperties dictionary doesn't contain any keys that are reserved. - Check is case-insensitive for added safety. - - - - - - - Make sure the userProperties dictionary doesn't contain any keys that - overlap with the names of mapped names for CredentialProfileOptions property names. - Check is case-insensitive for added safety. - - - - - - This class is used internally and should not be accessed by SDK users. - - Provide access to internal properties of CredentialProfile to - PowerShell tools and the Visual Studio Toolkit. - - - - - Attempt to read a role session with the given name. - If the session is invalid or expired it will not be returned. - - The name of the role session to get. - The credentials for the session, if found. - True if the session was found, false otherwise. - - - - This class allows profiles supporting AWSCredentials to be registered with - the SDK so that they can later be reference by a profile name. The credential profiles will be available - for use in the AWS Toolkit for Visual Studio and the AWS Tools for Windows PowerShell. - - The credentials are stored under the current users AppData folder encrypted using Windows Data Protection API. - - - This class is not threadsafe. - - - - - - Get the profile with the name given, if it exists in this store. - - The name of the profile to find. - The profile, if it was found, null otherwise - True if the profile was found, false otherwise. - - - - Add the profile to this store, if it's valid. - - The profile to add. - - - - If there is a profile in the store with the given name, delete it. - - The name of the profile to delete. - - - - Rename the profile with oldProfileName to newProfileName. - - The profile to rename. - The new name for the profile. - - - - Rename the profile with oldProfileName to newProfileName. - - The profile to rename. - The new name for the profile. - If true and the destination profile exists it will be overwritten. - - - - Make a copy of the profile with fromProfileName called toProfileName. - - The name of the profile to copy from. - The name of the new profile. - - - - Make a copy of the profile with fromProfileName called toProfileName. - - The name of the profile to copy from. - The name of the new profile. - If true and the destination profile exists it will be overwritten. - - - - Set the ProfileType field to maintain backward compatibility with ProfileManager. - The value is ignored when it's read back in. - - - - - - - Represents the different types of authentication available for SAML endpoints. - - - - - Representation of a SAML Endpoint. - - - - - The name given to this SAMLEndpoint. - - - - - The URI of the SAML endnpoint. - - - - - The authentication type associated with the SAML endpoint. - - - - - Internal constructor. Used by SAMLEndpointManager when reading endpoints from the encrypted store. - - - - - - - - Construct a SAMLEndpoint using the default SAMLAuthenticationType - Kerberos. - - The name of the endpoint. - The URI of the endpoint. - - - - Construct a SAMLEndpoint. - - The name of the endpoint. - The URI of the endpoint. - The authentication type of the endpoint. - - - - Manages endpoints to be used in conjunction with SAML role profiles. The role profiles - reference the endpoint to obtain the actual endpoint and any customization settings - needed to perform authentication. - - - - - Construct a SAMLEndpointManager. - - - - - True if the SAMLEndpointManager is available on the current platform, false otherwise. - - - - - Register an endpoint, or update an existing one. - - The endpoint to register. - - - - Get an endpoint, if it exists and is valid. - - The name of the endpoint to get. - The endpoint, or null if it's invalid or doesn't exist. - True if the endpoint exists and is valid, false otherwise. - - - - Get an endpoint from the store. - Throws an exception if there's an error reading the endpoint, or if it doesn't exist. - - The name of the endpoint to get. - The endpoint with the given name. - - - - Delete an endpoint from the store, if it exists. - - The name of the endpoint to delete. - - - - List the names of valid endpoints in the store. - - - - - - List valid endopints that can be read from the store. - - - - - - Provides access to read and write to the shared credentials INI file. - The file is read, parsed, and validated at construction time. - Changes can be made using the RegisterProfile() and - UnregisterProfile() methods. - - This class is not threadsafe. - - - - - To maintain compatibility with the CLI, - SharedCredentialsFile doesn't support the SAML profileTypes. - - - - - Construct a new SharedCredentialsFile in the default location. - - - - - Construct a new SharedCredentialsFile. - - The path of the shared credentials file. - - - - Add the profile given. If the profile already exists, update it. - - The profile to be written. - - - - Update the profile on disk regardless of the profile type. - - - - - - Deletes the section with the given ProfileName from the SharedCredentialsFile, if one exists. - - The ProfileName of the section to delete. - - - - Rename the profile with oldProfileName to newProfileName. - - The profile to rename. - The new name for the profile. - - - - Rename the profile with oldProfileName to newProfileName. - - The profile to rename. - The new name for the profile. - If true and the destination profile exists it will be overwritten. - - - - Make a copy of the profile with fromProfileName called toProfileName. - - The name of the profile to copy from. - The name of the new profile. - - - - Make a copy of the profile with fromProfileName called toProfileName. - - The name of the profile to copy from. - The name of the new profile. - If true and the destination profile exists it will be overwritten. - - - - Try to get a profile that may be partially in the credentials file and partially in the config file. - If there are identically named properties in both files, the properties in the credentials file take precedence. - - - - - - - - Anonymous credentials. - Using these credentials, the client does not sign the request. - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - AWS Credentials that automatically refresh by calling AssumeRole on - the Amazon Security Token Service. - - - - - The credentials of the user that will be used to call AssumeRole. - - - - - The Amazon Resource Name (ARN) of the role to assume. - - - - - An identifier for the assumed role session. - - - - - Options to be used in the call to AssumeRole. - - - - - Constructs an AssumeRoleAWSCredentials object. - - The credentials of the user that will be used to call AssumeRole. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - - - - Constructs an AssumeRoleAWSCredentials object. - - The credentials of the user that will be used to call AssumeRole. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRole. - - - - A unique identifier that is used by third parties when assuming roles in their customers' accounts. - - - - - An IAM policy in JSON format. - - - - - The length of time in seconds before the credentials will expire. - - - - - The proxy settings to use when calling AssumeRole. - - - - - The identification number of the MFA device that is associated with the user who is making the assume-role call. - - - - - The value provided by the MFA device, if the trust policy of the role being assumed requires MFA. - - - - - A callback that's used to obtain the MFA token code when the AssumeRoleAWSCredentials are refreshed. - - - - - Immutable representation of AWS credentials obtained as a result of - authenticating with the AssumeRole method of the Security Token Service. - - - - - The expiry time of the credentials, obtained from the AssumeRoleResponse. - - - - - Constructs an instance with supplied keys, token, and expiration. - - The AccessKey for the credentials. - The SecretKey for the credentials. - The security token for the credentials. - The expiration time for the credentials. - - - - Get a copy of this AssumeRoleImmutableCredentials object. - - A copy of this object. - - - - AWS Credentials that automatically refresh by calling AssumeRole on - the Amazon Security Token Service. - - - - - As established by STS, the regex used to validate the role session names is a string of 2-64 characters consisting of - upper- and lower-case alphanumeric characters with no spaces. You can also include - underscores or any of the following characters: =,.@- - - - - - Options to be used in the call to AssumeRole. - - - - - The absolute path to the file on disk containing an OIDC token - - - - - The Amazon Resource Name (ARN) of the role to assume. - - - - - An identifier for the assumed role session. - - - - - Constructs an AssumeRoleWithWebIdentityCredentials object. - - The absolute path to the file on disk containing an OIDC token. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - - - - Constructs an AssumeRoleWithWebIdentityCredentials object. - - The absolute path to the file on disk containing an OIDC token. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRole. - - - - Creates an instance of from environment variables. - - Throws an if the needed environment variables are not set. - The new credentials. - - - - Gets a client to be used for AssumeRoleWithWebIdentity requests. - - The STS client. - - - - Options for using a credentials object to make AssumeRoleWithWebIdentity calls. - - - - - Gets and sets the property DurationSeconds. - - The duration, in seconds, of the role session. The value can range from 900 seconds - (15 minutes) up to the maximum session duration setting for the role. This setting - can have a value from 1 hour to 12 hours. If you specify a value higher than this - setting, the operation fails. For example, if you specify a session duration of 12 - hours, but your administrator set the maximum session duration to 6 hours, your operation - fails. To learn how to view the maximum value for your role, see View - the Maximum Session Duration Setting for a Role in the IAM User Guide. - - - - By default, the value is set to 3600 seconds. - - - - The DurationSeconds parameter is separate from the duration of a console - session that you might request using the returned credentials. The request to the - federation endpoint for a console sign-in token takes a SessionDuration - parameter that specifies the maximum length of the console session. For more information, - see Creating - a URL that Enables Federated Users to Access the AWS Management Console in the - IAM User Guide. - - - - - - - Gets and sets the property ProviderId. - - The fully qualified host component of the domain name of the identity provider. - - - - Specify this value only for OAuth 2.0 access tokens. Currently www.amazon.com - and graph.facebook.com are the only supported identity providers for - OAuth 2.0 access tokens. Do not include URL schemes and port numbers. - - - - Do not specify this value for OpenID Connect ID tokens. - - - - - - Gets and sets the property Policy. - - An IAM policy in JSON format that you want to use as an inline session policy. - - - - This parameter is optional. Passing policies to this operation returns new temporary - credentials. The resulting session's permissions are the intersection of the role's - identity-based policy and the session policies. You can use the role's temporary credentials - in subsequent AWS API calls to access resources in the account that owns the role. - You cannot use session policies to grant more permissions than those allowed by the - identity-based policy of the role that is being assumed. For more information, see - Session - Policies in the IAM User Guide. - - - - The plain text that you use for both inline and managed session policies shouldn't - exceed 2048 characters. The JSON policy characters can be any ASCII character from - the space character to the end of the valid character list (\u0020 through \u00FF). - It can also include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D) - characters. - - - - The characters in this parameter count towards the 2048 character session policy guideline. - However, an AWS conversion compresses the session policies into a packed binary format - that has a separate limit. This is the enforced limit. The PackedPolicySize - response element indicates by percentage how close the policy is to the upper size - limit. - - - - - - - Gets and sets the property PolicyArns. - - The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use - as managed session policies. The policies must exist in the same account as the role. - - - - This parameter is optional. You can provide up to 10 managed policy ARNs. However, - the plain text that you use for both inline and managed session policies shouldn't - exceed 2048 characters. For more information about ARNs, see Amazon - Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference. - - - - The characters in this parameter count towards the 2048 character session policy guideline. - However, an AWS conversion compresses the session policies into a packed binary format - that has a separate limit. This is the enforced limit. The PackedPolicySize - response element indicates by percentage how close the policy is to the upper size - limit. - - - - Passing policies to this operation returns new temporary credentials. The resulting - session's permissions are the intersection of the role's identity-based policy and - the session policies. You can use the role's temporary credentials in subsequent AWS - API calls to access resources in the account that owns the role. You cannot use session - policies to grant more permissions than those allowed by the identity-based policy - of the role that is being assumed. For more information, see Session - Policies in the IAM User Guide. - - - - - - The proxy settings to use when calling AssumeRoleWithWebIdentity. - - This parameter is optional. - - - - - - Abstract class that represents a credentials object for AWS services. - - - - - Returns a copy of ImmutableCredentials - - - - - - Called by AmazonServiceClient to validate the credential state - on client construction. - - - - - Basic set of credentials consisting of an AccessKey and SecretKey - - - - - Constructs a BasicAWSCredentials object for the specified accessKey and secretKey. - - - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - State class passed on callback to demand user credentials when authentication - needs to be performed using a non-default identity. - - - - - If the current authentication callback is associated with - a credential profile, this can be used to give the user - some context on the request for his/her authentication. - - - - - Contains the user identity that the user should supply a password - for. The user can ignore if they choose and return credentials for - an alternate account. - - - - - Any custom state that was registered with the callback. - - - - - Set if the callback was due to a failed authentication attempt. - If false we are beginning to obtain or refresh credentials. - - - - - InstanceProfileAWSCredentials allows configuring Roles and every instance hits IMDS individually. - This class has a singleton timer task that caches instance profile credentials every 2 minutes. - - - - - Returns a copy of the most recent instance profile credentials. - - - - - Returns a copy of the most recent instance profile credentials. - - - - - Dispose this object and all related resources. - - - - - When running in an ECS container and AWS_CONTAINER_CREDENTIALS_RELATIVE_URI is set, - use the given end point to retrieve the credentials. - - - - - These constants should not be consumed by client code. They are only relevant - in the context of ECS container and, especially, AWS_CONTAINER_CREDENTIALS_RELATIVE_URI - environment variable should not be overriden by the client code. - - - - - Uses aws credentials stored in environment variables to construct the credentials object. - AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY are used for the access key id and secret key. - If the variable AWS_SESSION_TOKEN exists then it will be used to create temporary session - credentials. - - - For backwards compatibility the class will also attempt to discover the secret key from - the AWS_SECRET_KEY variable, if a value cannot be obtained using the standard - AWS_SECRET_ACCESS_KEY variable. - - - - - Constructs an instance of EnvironmentVariablesAWSCredentials. If no credentials are found in - the environment variables then an InvalidOperationException is thrown. - - - - - Creates immutable credentials from environment variables. - - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - If AWS_CONTAINER_CREDENTIALS_RELATIVE_URI environment variable is set, we want to attempt to retrieve credentials - using ECS endpoint instead of referring to instance profile credentials. - - - If AWS_CONTAINER_CREDENTIALS_RELATIVE_URI environment variable is set, we want to attempt to retrieve credentials - using ECS endpoint instead of referring to instance profile credentials. - - - - Custom exception type thrown when a role profile with user identity is used - in conjunction with a credential request callback. This exception is thrown - if the callback returns null, indicating the user declined to supply credentials. - - - - - Initializes a new exception instance. - - - - - - Initializes a new exception instance. - - - - - - - Constructs a new instance of the FederatedAuthenticationCancelledException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Custom exception type thrown when authentication for a user fails due to - invalid credentials. - - - - - Initializes a new exception instance. - - - - - - Initializes a new exception instance. - - - - - - - Constructs a new instance of the FederatedAuthenticationFailureException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Temporary credentials that are created following successful authentication with - a federated endpoint supporting SAML. - - - In order to use the FederatedAWSCredentials class the AWSSDK.SecurityToken assembly - must be available to your application at runtime. - - - - - Constructs an instance of FederatedAWSCredentials. After construction call GetCredentials - to authenticate the user/process and obtain temporary AWS credentials. - - The SAML endpoint used for authentication. - The role ARN used for authentication. - - - - Constructs an instance of FederatedAWSCredentials. After construction call GetCredentials - to authenticate the user/process and obtain temporary AWS credentials. - - The SAML endpoint used for authentication. - The role ARN used for authentication. - The options used for authentication. - See for details about available options. - - - - The SAML Endpoint used for authentication. - - - - - The role ARN used for authentication. - - - - - The options used for authentication. - See for details about available options. - - - - - Refresh credentials after expiry. If the role profile is configured with user identity - information and a callback has been registered to obtain the user credential, the callback - will be invoked ahead of authentication. For role profiles configured with user identity - but no callback registration, the SDK will fall back to attempting to use the default - user identity of the current process. - - - - - - Clears currently-stored credentials, forcing the next GetCredentials call to generate new credentials. - - - - - Options that control the behavior of . - - - - - The identity to use when authenticating. - This is in the form domain\username, or just username. - If this option is not set, the current user's identity will be used. - - - - - uses this callback to get credentials if the UserIdentity is set. - - - - - When makes a callback for credentials, - this state will be included for use by the callback handler. - - - - - The proxy settings to use when calling the - Secure Token Service and the ADFS endpoint. - - - - - Set this property when a region-specific STS endpoint must be used (eg cn-north-1). - If left empty/null, the global sts.amazonaws.com endpoint will be used when credentials are obtained. - - - - - The profile name, if this FederatedAWSCredentialsOptions - is associated with a CredentialProfile. - - - - - Immutable representation of AWS credentials. - - - - - Gets the AccessKey property for the current credentials. - - - - - Gets the SecretKey property for the current credentials. - - - - - Gets the Token property for the current credentials. - - - - - Gets the UseToken property for the current credentials. - Specifies if Token property is non-emtpy. - - - - - Constructs an ImmutableCredentials object with supplied accessKey, secretKey. - - - - Optional. Can be set to null or empty for non-session credentials. - - - - Returns a copy of the current credentials. - - - - - - Credentials that are retrieved from the Instance Profile service on an EC2 instance - - - - - Role for which the credentials are retrieved - - - - - Constructs a InstanceProfileAWSCredentials object for specific role - - Role to use - - - - Constructs a InstanceProfileAWSCredentials object for specific role - - Role to use - - - - Constructs a InstanceProfileAWSCredentials object for the first found role - - - - - Constructs a InstanceProfileAWSCredentials object for the first found role - - - - - Retrieves a list of all roles available through current InstanceProfile service - - - - - - Retrieves a list of all roles available through current InstanceProfile service - - - - - - Return true if string is null or whitespace, false otherwise. - We can't use String.IsNullOrWhitespace because it doesn't exist - in all frameworks we support. - - - - - - - Process Credentials can retrieve credentials by running a process and reading its stdout. - A new config option, "credential_process" is added to the shared config file that allows customers - to specify which process to run. The credentials retrieved by running this process could be either - Basic or Session credentials. - - - - - Generates new credentials by running the "credential_process" process. - - - - - Exception class to capture all exceptions encountered when starting or - executing the "credential_process" process. If the user has specified an executable - and the SDK is unable to execute it, the exception should be surfaces to the user - instead of moving on to the next credential provider. - - - - - Abstract class for automatically refreshing AWS credentials - - - - - Refresh state container consisting of credentials - and the date of the their expiration - - - - - Represents the current state of the Credentials. - - This can be cleared without synchronization. - - - - Semaphore to control thread access to GetCredentialsAsync method. - The semaphore will allow only one thread to generate new credentials and - update the current state. - - - - - The time before actual expiration to expire the credentials. - Property cannot be set to a negative TimeSpan. - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - Test credentials existence and expiration time - should update if: - credentials have not been loaded yet - it's past the expiration time. At this point currentState.Expiration may - have the PreemptExpiryTime baked into to the expiration from a call to - UpdateToGeneratedCredentials but it may not if this is new application load. - - - - - When overridden in a derived class, generates new credentials and new expiration date. - - Called on first credentials request and when expiration date is in the past. - - - - - - When overridden in a derived class, generates new credentials and new expiration date. - - Called on first credentials request and when expiration date is in the past. - - - - - - Clears currently-stored credentials, forcing the next GetCredentials call to generate new credentials. - - - - - Immutable representation of AWS credentials obtained as a result of - authenticating against a SAML-supporting federated identity provider. - - - - - The expiry time of the credentials, obtained from the AssumeRoleWithSAML response. - - - - - The value of the NameID element in the Subject element of the SAML assertion, as returned in the - AssumeRoleWithSAML response from the Security Token Service. - - - - - Constructs an instance with supplied keys and SAML assertion data. - - - - - - - - - - Constructs an instance with supplied keys and SAML assertion data. - - - - - - - - Returns a copy of the current credentials. - - - - - - Serializes the instance to a json-format string for external storage - - The serialized object in json - - - - Instantiates an instance from persisted json data - - The serialized data - Deserialized instance corresponding to the json data - - - - Session credentials consisting of AccessKey, SecretKey and Token - - - - - Constructs a SessionAWSCredentials object for the specified accessKey, secretKey. - - - - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - - Credentials that are retrieved using a stored profile. - - - Unless otherwise specified priority is given to loading credentials from the SDK credential store - file which is shared between the SDK, PowerShell CLI and Toolkit. Credentials in profiles in this - file are encrypted and can only be used by the user account on the current machine that stored the - profile. Credentials can also be loaded from the plain-text ini-format credential file which is - shared with other AWS SDKs. This file is expected to exist in a '.aws' folder in the user's home - directory but alternate locations can be specified using either the AWSProfilesLocation setting in - the application configuration file, or by using the AWS_SHARED_CREDENTIALS_FILE environment variable. - - - The profile name can be specified in the App.config using the AWSProfileName setting. - - - - - - Constructs an instance for credentials stored in a profile. This constructor searches for credentials - using the account name specified using the AWSProfileName setting, if set, in the application configuration - file. If the configuration file setting is not set the SDK will attempt to locate a profile with the name - 'default'. - - - - - Constructs an instance for credentials stored in a profile with the specified name. The SDK will - check the SDK credential store file first before looking for the shared ini-format credentials - file unless the application configuration file contains a setting for the 'AWSProfilesLocation' - indicating the search should be constrained to the shared credentials file at the specified - location. - - The name of the profile in which the credentials were stored. - - - - Constructs an instance for credentials stored in a profile with the specified name. - - The profile name to search for credentials for - - Optional; instructs the SDK to check for the profile in the shared credentials file at the - specified location. If not set, the SDK will inspect its own credential store file first before - attempting to locate a shared credential file using either the default location beneath the user's - home profile folder or the location specified in the AWS_SHARED_CREDENTIALS_FILE environment - variable. - - - If credential materials cannot be read or are invalid due to missing data an InvalidDataException - is thrown. If no credentials can be located with the specified profile name, an ArgumentException - is thrown. - - - - - Name of the profile being used. - - - - - Location of the profiles, if used. - - - - - Tests if a profile has been registered in either the SDK store or the specified credential - file. - - The name of the profile to test - - Optional; instructs the SDK to check for the profile in the shared credentials file at the - specified location. If not set, the SDK will inspect its own credential store file first before - attempting to locate a shared credential file using either the default location beneath the user's - home profile folder or the location specified in the AWS_SHARED_CREDENTIALS_FILE environment - variable. - - True if a profile with the specified name has been registered. - - - - Tests if an instance can be created from the persisted profile data. - If profilesLocation is null/empty, the SDK store is searched for the - profile data before probing for the profile in the shared the ini-format - credential file. - - The name of the profile to test - - If null/empty, the SDK store is searched for the named profile otherwise - the ini-format credential file at the specified location is inspected. - - True if the persisted data would yield a valid credentials instance. - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - Helper routiners for AWS and Federated credential profiles. Probes the - profile type for the supplied profile name and returns the appropriate profile - instance. - - - - - Determines the type of the requested profile and returns the - appropriate profile instance. - - The name of the profile (AWS or federated) to be loaded. - Instantiated profile type. - - - - Determines the type of the requested profile and returns the - appropriate profile instance. - - The name of the profile (AWS or federated) to be loaded. - - The location of the shared credentials (.ini) file, for profiles that are not stored in the - SDK credential store. - - Instantiated profile type. - - - - Probes for and returns the fully qualified name of the shared ini-format credentials - file. - - - Contains the file or folder name of the credential file. If not specified, the - routine will first check the application configuration file for a setting indicating - the file location or filename. If the configuration file does not yield a credential - file location then an environment variable is examined. Finally the routine will - inspect the fallback default location beneath the user's home folder location. - - - The fully qualified name to the credential file that was located, or null - if no credential file could be found. - - - - - Obtains credentials from access key/secret key or AWSProfileName settings - in the application's app.config or web.config file. - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - Exception thrown on validation of a StoredProfileFederatedCredentials instance if the role profile - is configured to use a non-default user identity and the QueryUserCredentialCallback on the - instance has not been set. - - - - - Initializes a new exception instance. - - - - - - Initializes a new exception instance. - - - - - - - Initializes a new exception instance. - - - - - - Constructs a new instance of the CredentialRequestCallbackRequiredException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Credentials that are retrieved from ConfigurationManager.AppSettings - - - - - Constructs an instance of EnvironmentAWSCredentials and attempts - to load AccessKey and SecretKey from ConfigurationManager.AppSettings - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - Temporary credentials that are created following successful authentication with - a federated endpoint supporting SAML. - - - 1. Currently only the SDK store supports profiles that contain the necessary data to support - authentication and role-based credential generation. The ini-format files used by the AWS CLI - and some other SDKs are not supported at this time. -
- 2. In order to use the StoredProfileFederatedCredentials class the AWSSDK.SecurityToken assembly - must be available to your application at runtime. - - - - - Custom state to return to the registered callback to handle credential requests. - The data will be contained in the CredentialRequestCallbackArgs instance supplied - to the callback. - - - - - The minimum allowed timespan for generated credentials, per STS documentation. - - - - - The maximum allowed timespan for generated credentials, per STS documentation. - - - - - Name of the profile being used. - - - - - Location of the profiles, if used. - - - - - The data about the SAML endpoint and any required user credentials parsed from the - profile. - - - - - Callback signature for obtaining user credentials that may be needed for authentication. - - - Data about the credential demand including any custom state data that was supplied - when the callback was registered. - - - The network credential to use in user authentication. Return null to signal the user - declined to provide credentials and authentication should not proceed. - - - - - Constructs an instance of StoredProfileFederatedCredentials using the profile name specified - in the App.config. If no profile name is specified then the default credentials are used. - - - - - Constructs an instance of StoredProfileFederatedCredentials. Credentials will be searched - for using the profileName parameter. - - The profile name to search for credentials for - - - - - Constructs an instance of StoredProfileFederatedCredentials. After construction call one of the Authenticate - methods to authenticate the user/process and obtain temporary AWS credentials. - - - For users who are domain joined (the role profile does not contain user identity information) the temporary - credentials will be refreshed automatically as needed. Non domain-joined users (those with user identity - data in the profile) are required to re-authenticate when credential refresh is required. An exception is - thrown when attempt is made to refresh credentials in this scenario. The consuming code of this class - should catch the exception and prompt the user for credentials, then call Authenticate to re-initialize - with a new set of temporary AWS credentials. - - - - The name of the profile holding the necessary role data to enable authentication and credential generation. - - Reserved for future use. - - The ini-format credentials file is not currently supported for SAML role profiles. - - - - - - Constructs an instance of StoredProfileFederatedCredentials. After construction call one of the Authenticate - methods to authenticate the user/process and obtain temporary AWS credentials. - - - For users who are domain joined (the role profile does not contain user identity information) the temporary - credentials will be refreshed automatically as needed. Non domain-joined users (those with user identity - data in the profile) are required to re-authenticate when credential refresh is required. An exception is - thrown when attempt is made to refresh credentials in this scenario. The consuming code of this class - should catch the exception and prompt the user for credentials, then call Authenticate to re-initialize - with a new set of temporary AWS credentials. - - - - The name of the profile holding the necessary role data to enable authentication and credential generation. - - Reserved for future use. - - Null or proxy settings to be used during the HHTPS authentication calls when generating credentials. - /// - The ini-format credentials file is not currently supported for SAML role profiles. - - - - - Registers a callback handler for scenarios where credentials need to be supplied - during user authentication (primarily the non-domain-joined use case). Custom data, - which will be supplied in the CredentialRequestCallbackArgs instance passed to the - callback, can also be supplied. - - - The callback will only be invoked if the underlying SAML role profile indicates it - was set up for use with a specific identity. For profiles that do not contain any user - identity the SDK will default to using the identity of the current process during - authentication. Additionally, if the profile contain user identity information but no - callback has been registered, the SDK will also attempt to use the current process - identity during authentication. - - - The handler to be called - - Custom state data to be supplied in the arguments to the callback. - - - Only one callback handler can be registered. The call to the handler will be made on - whatever thread is executing at the time a demand to provide AWS credentials is made. - If the handler code requires that UI need to be displayed, the handler should - transition to the UI thread as appropriate. - - - - - Tests if an instance can be created from the persisted profile data. - - The name of the profile to test. - The location of the shared ini-format credential file. - True if the persisted data would yield a valid credentials instance. - - This profile type is currently only supported in the SDK credential store file. - The shared ini-format file is not currently supported; any value supplied - for the profilesLocation value is ignored. - - - - - Performs any additional validation we may require on the profile content. - - - - - Refresh credentials after expiry. If the role profile is configured with user identity - information and a callback has been registered to obtain the user credential the callback - will be invoked ahead of authentication. For role profiles configured with user identity - but no callback registration, the SDK will fall back to attempting to use the default - user identity of the current process. - - - - - - Class that posts the CSM event to a UDP portconfig - This is a singleton class and is created once - per AmazonServiceClient. - - - - - The CSMevents are always posted to the localhost - - - - - Method to post UDP datagram for sync calls - - - - - Method to post UDP datagram for async calls - - - - - Method to post UDP datagram for bcl35 async calls - - - - - Determines the endpoint discovery enabled value based on an environment variable. If no value is found in the - environment then an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of EnvironmentVariable AWS_ENABLED_ENDPOINT_DISCOVERY. If no value is found in the - environment then an InvalidOperationException is thrown. - - - - - Determines endpoint discovery enabled based on a stored in an . - If the profile doesn't exist or there is no endpoint discovery enabled information an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of . - If the AWS_PROFILE environment variable is set the instance will be constructed using that profile, - otherwise it will use the default profile. - - If the profile doesn't exist or there is no endpoint discovery enabled information an InvalidOperationException is thrown. - - The ICredentialProfileSource to read the profile from. - - - - Attempts to construct an instance of . - If the profile doesn't exist or there is no endpoint discovery enabled information an InvalidOperationException is thrown. - - The ICredentialProfileSource to read the profile from. - The name of the profile. - - - - Probing mechanism to determine the endpoint discovery enabled value from various sources. - - - - - The valid hashing algorithm supported by the sdk for request signing. - - - - - Which end of a request was responsible for a service error response. - - - - - The sender was responsible for the error, i.e. the client - request failed validation or was improperly formatted. - - - - - The error occured within the service. - - - - - An unrecognized error type was returned. - - - - - Sts Regional Endpoints Value determines whether or not - to send the sts request to the regional endpoint or to - the global sts endpoint - - - - - Send the request to the global sts endpoint - if the region is a legacy global region - - - - - Send the request to the regional endpoint - - - - - S3 US East 1 endpoint value determines wheter or not - to send the us-east-1 s3 requests to the regional endpoint or to - the legacy global endpoint - - - - - Sends the requests to the legacy global s3 endpoint for us-east-1 - - - - - Sends the request to the regional s3 endpoint for us-east-1 - - - - - Superclass for Exceptions that come over the event stream, or to wrap other kinds of generic exceptions. - - - - - The numeric code identifier for the type of error. - - - - - Constructs an EventStreamError. - - - - - Constructs an EventStreamError. - - The error code. - The error message. - - - - Constructs a new instance of the EventStreamErrorCodeException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Event args that contain an . - - The - - - - The EventStream Event. - - - - - Constructs an EventStreamEventReceivedArgs. - - The EventStream Event. - - - - Event args that contain an . - - The . - - - - The EventStream Exception. - - - - - Constructs an EventStreamExceptionReceivedArgs. - - The EventStream Exception. - - - - Supported Header types for vnd.amazon.event-stream - - - - - Name for the Header. Maximum of 255 bytes. - - - - - Header type id - - - - - Computes the amount of memory neccesary to serialize this Header. - - - - - Writes this Header to buffer starting at offset - Keep in mind, this API assumes buffer is large enough - for the operation. - - buffer to serialize this Header to - offset to begin writing at. - - the new offset. - - - - - Returns the current value as a bool - - - - - Sets the current value - - - - - Returns the current value as a byte - - - - - Sets the current value - - - - - Gets the current value as a 16 bit integer. (Host Order). - - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a 32 bit integer. (Host Order) - - - - - Sets the current value - - - - - returns the current value as a 64-bit integer. (Host Order) - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a byte buffer. - - - - - - Sets the current value. Max length is 2^15 - 1 - - - - - Returns the current value as a utf-8 string. - - - - - Sets the current value. Utf-8 encoded. Max byte size is 2^16 - 1 - - - - - Gets the current value as a DateTime. - Note: You do not need to compensate for unix epoch on this API. - - - - - - Sets the current value. - Note: You do not need to compensate for unix epoch on this API. - - - - - Returns the current value as a Guid (UUID) - - - - - Sets the current value - - - - - Header Data for an EventStreamMessage - - Each header is of format: - [name len] (1) | [utf-8 name] (v) - [type (1)] - [value (v)] - - - - - Name for the Header. Maximum of 255 bytes. - - - - - Header type id - - - - - Initializes this Header with name. - - utf-8 string, max length is 255 - - - - Deserializes the header in buffer. - - buffer constaining the header - index to start from in the buffer. - updated offset with new value for offset - - - - Writes this Header to buffer starting at offset - Keep in mind, this API assumes buffer is large enough - for the operation. - - buffer to serialize this Header to - offset to begin writing at. - - the new offset. - - - - - Computes the amount of memory neccesary to serialize this Header. - - - - - Returns the current value as a bool - - - - - Sets the current value - - - - - Returns the current value as a byte - - - - - Sets the current value - - - - - Gets the current value as a 16 bit integer. (Host Order). - - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a 32 bit integer. (Host Order) - - - - - Sets the current value - - - - - returns the current value as a 64-bit integer. (Host Order) - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a byte buffer. - - - - - - Sets the current value. Max length is 2^15 - 1 - - - - - Returns the current value as a utf-8 string. - - - - - Sets the current value. Utf-8 encoded. Max byte size is 2^16 - 1 - - - - - Gets the current value as a DateTime. - Note: You do not need to compensate for unix epoch on this API. - - - - - - Sets the current value. - Note: You do not need to compensate for unix epoch on this API. - - - - - Returns the current value as a Guid (UUID) - - - - - Sets the current value - - - - - Constructs a new instance of the EventStreamParseException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Constructs a new instance of the EventStreamChecksumFailureException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Headers for the message. Can be null. - - - - - Payload for the message. Can be null. - - - - - Converts a message into a byte buffer (usually for network transmission). - - - - - Message is a single datagram. The format is as follows: - [ total length (4) ] | [ headers_length (4)] | [ prelude crc(4)] - [ headers (v)] - [ payload (v)} - [ trailing crc ] - - CRCs use the CRC32 algorithm. - - - - - Content type for EventStreams. - - - - - Headers for the message. Can be null. - - - - - Payload for the message. Can be null. - - - - - Initialize a message with headers and a payload. - - list of headers for the message, can be null. - payload for the message, can be null. - - - - Builds a message from buffer. - - buffer to read - offset to start reading - buffer length. - - parsed instance of EventStreamMessage. Doesn't return null, - does throw if CRCs don't match. - - - - - Converts a message into a byte buffer (usually for network transmission). - - - - - Defines exceptions that arise from an not conforming to specification. - - - - - Constructs an EventStreamValidationException. - - - - - Constructs an EventStreamValidationException. - - The exception message. - - - - Constructs an EventStreamValidationException. - - The exception message. - The inner exception. - - - - Constructs a new instance of the EventStreamValidationException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - The contract for the . - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - A subclass of that enables an enumerable interface for interacting with Events. - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - Flag if the stream was chosen to be enumerated. - - - - - A Stream of Events. Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treated as mutually exclusive. - - - - - A Stream of Events. Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treated as mutually exclusive. - - - - - Returns an enumerator that iterates through the collection. - - An enumerator that can be used to iterate through the collection. - - - - Returns an enumerator that iterates through a collection. - - An object that can be used to iterate through the collection. - - - - Starts the background thread to start reading events from the network stream. - - - - - The contract for the . - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - The size of the buffer for reading from the network stream. - - - - - Fires when an event is received. - - - - - Fired when an exception or error is raised. - - - - - Starts the background thread to start reading events from the network stream. - - - - - The superclass for all EventStreams. It contains the common processing logic needed to retreive events from a network Stream. It - also contains the mechanisms needed to have a background loop raise events. - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - "Unique" key for unknown event lookup. - - - - - Header key for message type. - - - - - Header key for event type. - - - - - Header key for exception type. - - - - - Header key for error code. - - - - - Header key for error message. - - - - - Value of when the message is an event. - - - - - Value of when the message is an exception. - - - - - Value of when the message is an error. - - - - - The size of the buffer for reading from the network stream. - Default is 8192. - - - - - The underlying stream to read events from. - - - - - Responsible for decoding events from sequences of bytes. - - - - - Fires when an event is recieved. - - - - - Fired when an exception or error is raised. - - - - - The mapping of event message to a generator function to construct the matching Event Stream event. - - - - - The mapping of event message to a generator function to construct the matching Event Stream exception. - - - - - Whether the Stream is currently being processed. - - - - - A Stream of Events. Events can be retrieved from this stream by attaching handlers to listen events, and then calling StartProcessing. - - - - - A Stream of Events. Events can be retrieved from this stream by attaching handlers to listen events, and then calling StartProcessing. - - - - - Converts an EventStreamMessage to an event. - - The event stream message to be converted. - The event - - - - Abstraction for cross-framework initiation of the background thread. - - - - - The background thread main loop. It will constantly read from the network stream until IsProcessing is false, or an error occurs. - - This stub exists due to FXCop. - - - - - The background thread main loop. It will constantly read from the network stream until IsProcessing is false, or an error occurs. - - Needed for 3.5 support. Not used. - - - - Reads from the stream into the buffer. It then passes the buffer to the decoder, which raises an event for - each message it decodes. - - The buffer to store the read bytes from the stream. - - - - Wraps exceptions in an outer exception so they can be passed to event handlers. If the Exception is already of a compatable type, - the method returns what it was given. - - The exception to wrap. - An exception of type TE - - - - Starts the background thread to start reading events from the network stream. - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Disposes the resources of this stream. - - Should dispose of unmanged resources. - - - - Event Arguments for EventStreamDecoder.MessageReceived. - - - - - Received message. - - - - - Additional object context - - - - - Initialize this with message - - - - - Initialize this with message and object conetext - - - - - Exception thrown when a request is made of the Decoder, but the internal state - machine is an invalid state. This is usually the result of an interanl exception - being thrown during parsing of the network stream. - - - - - Constructs a new instance of the EventStreamDecoderIllegalStateException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Contract for EventStreamDecoder - - - - - Invoked anytime an EventStreamMessage is found. - - - - - Processes data starting at offset up to length. - Invokes MessageRecieved for each message encountered. - If an exception is thrown, this object is not safe for reuse. - - buffer to read - offset in buffer to start reading. - length of data. - - - - Streaming decoder for listening for incoming EventStreamMessage datagrams. - - - - - Invoked anytime an EventStreamMessage is found. - - - - - Object data (optional) that can be passed to the event handler for MessageReceived. - - - - - Default constructor. Initializes internal _state machine. - - - - - Processes data starting at offset up to length. - Invokes MessageRecieved for each message encountered. - If an exception is thrown, this object is not safe for reuse. - - buffer to read - offset in buffer to start reading. - length of data. - - - - Superclass for Exceptions that come over the event stream, or to wrap other kinds of generic exceptions. - - - - - Constructs an EventStreamException. - - - - - Constructs an EventStreamException. - - The exception message. - - - - Constructs an EventStreamException. - - The exception message. - The inner exception. - - - - Constructs a new instance of the EventStreamException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - The contract for EventStream events. - - - - - The contract for EventStream terminal events. - - - - - This Event is returned if an event is retrieved from the event stream, but a generator function - for the event is not defined. This can occur if the SDK is not updated after a new event type is introduced. - - - - - The Message recieved from the event stream before conversion. - - - - - The event type. - - - - - Constructs an UnknownEventStreamEvent. - - - - - Constructs an UnknownEventStreamEvent. - - The Message recieved from the event stream before conversion. - The event type. - - - - Signals that an an has an unknown message type. These exceptions whould be - swallowed to allow future expansion of the EventStream specification without breaking existing clients. - - - - - Constructs an UnknownEventStreamMessageTypeException. - - - - - Constructs a new instance of the UnknownEventStreamMessageTypeException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - This exception is thrown if an exception is retrieved from the event stream and should be modeled, - but a generator function for the strongly-typed exception is not defined. - - - - - The exception type. - - - - - Constructs an EventStreamException. - - The exception type. - - - - Constructs a new instance of the UnknownEventStreamException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - All Amazon service interfaces like IAmazonS3 extend from this interface. This allows all the - Amazon service interfaces be identified by this base interface and helps with generic constraints. - - - - - A readonly view of the configuration for the service client. - - - - - This interface is the read only access to the ClientConfig object used when setting up service clients. Once service clients - are initiated the config object should not be changed to avoid issues with using a service client in a multi threaded environment. - - - - - Gets the RegionEndpoint property. The region constant to use that - determines the endpoint to use. If this is not set - then the client will fallback to the value of ServiceURL. - - - - - The constant used to lookup in the region hash the endpoint. - - - - - Gets and sets of the ServiceURL property. - This is an optional property if you need to set a specific service URL - instead setting the region with the RegionEndpoint property. - - - - - Gets the UseHttp property. - If this property is set to true, the client attempts - to use HTTP protocol. - By default, this property is set to false. - - - - - Gets Service Version - - - - - Gets the signatureMethod property. - - - - - Gets the SignatureVersion property. - - Note: This property exists for backward compatibility but is no longer - used by any service other than S3. - - - - - Gets the AuthenticationRegion property. - Used in AWS4 request signing, this is an optional property; - change it only if the region cannot be determined from the - service endpoint. - - - - - Gets the AuthenticationServiceName property. - Used in AWS4 request signing, this is the short-form - name of the service being called. - - - - - Gets the UserAgent property. - - - - - Gets the DisableLogging. If true logging for this client will be disabled. - - - - - Flag on whether to log metrics for service calls. - - This can be set in the application's configs, as below: - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSLogMetrics" value"true"/> - </appSettings> - </configuration> - - - - - - Gets the LogResponse property. - If this property is set to true, the service response - is read in its entirety and logged. - - - - - Gets the ReadEntireResponse. - If this property is set to true, the service response - is read in its entirety before being processed. - - - - - This flag controls if .NET HTTP infrastructure should follow redirection - responses (e.g. HTTP 307 - temporary redirect). - - - - - Gets the BufferSize property. - The BufferSize controls the buffer used to read in from input streams and write - out to the request. - - - - - Gets the MaxErrorRetry property. - - - - - Gets the interval at which progress update events are raised - for upload operations. By default, the progress update events are - raised at every 100KB of data transferred. - - - - - Flag on whether to resign requests on retry or not. - - - - - Credentials to use with a proxy. - - - - - Gets the default request timeout value. - - - - If the value is set, the value is assigned to the Timeout property of the HTTPWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - - - - Configures the endpoint calculation for a service to go to a dual stack (ipv6 enabled) endpoint - for the configured region. - - - Note: AWS services are enabling dualstack endpoints over time. It is your responsibility to check - that the service actually supports a dualstack endpoint in the configured region before enabling - this option for a service. - - - - - Configures a flag enabling to either opt in or opt out of the retry throttling service. - Note: set value to true to enable retry throttling feature. The Default value for this flag is false. - - - - - Using either the RegionEndpoint or the ServiceURL determine what the URL to the service is. - - The URL to the service. - - - - Performs validation on this config object. - Throws exception if any of the required values are missing/invalid. - - The timeout specified is null. - - - - Returns the clock skew adjusted utc now. This value is affected by AWSConfigs.ManualClockCorrection - - - - - Returns the calculated clock skew value for this config's service endpoint. If AWSConfigs.CorrectForClockSkew is false, - this value won't be used to construct service requests. - - - - - Gets the DisableHostPrefixInjection flag. If true, host prefix injection will be disabled for this client, the default value of this flag is false. - Host prefix injection prefixes the service endpoint with request members from APIs which use this feature. - Example: for a hostPrefix of "foo-name." and a endpoint of "service.region.amazonaws.com" the default behavior is to - prefix the endpoint with the hostPrefix resulting in a final endpoint of "foo-name.service.region.amazonaws.com". Setting - DisableHostPrefixInjection to true will disable hostPrefix injection resulting in a final endpoint of - "service.region.amazonaws.com" regardless of the value of hostPrefix. E.g. You may want to disable host prefix injection for testing against a local mock endpoint. - - - - - Returns the flag indicating if endpoint discovery should be enabled or disabled for operations that are not required to use endpoint discovery. - - - - - Returns the maximum number of discovered endpoints that can be stored within the cache for the client. The default limit is 1000 cache entries. - - - - - Gets the TCP keep-alive values to use for service requests. Enabling TCP keep-alive sends periodic TCP keep-alive probe packets, to prevent disconnection due to - network inactivity. This is useful when you make API calls that take a long time to respond. In this case, the connection could be dropped by an intermediate - node (e.g. proxy) as the connection is inactive for a long time. Timeout controls the duration of inactivity before a keep-alive probe packet is sent. - Interval controls the amount of time to wait before retrying a keep-alive probe packet in the event the server doesn't respond to a keep-alive probe. - - - - - Gets the ProxyHost property. - - - - - Gets the ProxyPort property. - - - - - Gets the max idle time set on the ServicePoint for the WebRequest. - Default value is 50 seconds (50,000 ms) unless ServicePointManager.MaxServicePointIdleTime is set, - in which case ServicePointManager.MaxServicePointIdleTime will be used as the default. - - - - - Gets the default read-write timeout value. - - - - - - - Gets the connection limit set on the ServicePoint for the WebRequest. - Default value is 50 connections unless ServicePointManager.DefaultConnectionLimit is set in - which case ServicePointManager.DefaultConnectionLimit will be used as the default. - - - - - Gets whether the Nagle algorithm is used on connections managed by the ServicePoint object used - for requests to AWS. This is defaulted to false for lower latency with responses that return small amount of data. This is the opposite - default than ServicePoint.UseNagleAlgorithm which is optimized for large responses like web pages or images. - - - - - Returns a WebProxy instance configured to match the proxy settings - in the client configuration. - - - - - Interface for a single logged message. - - - - - Log message format. - - - - - Log message arguments. - - - - - Culture-specific formatting provider. - - - - - Abstract parameter value. - - - - - String parameter value. - - - - - String value of the parameter. - - - - - Constructs ParameterValue for a single string. - - - - - - String list parameter value. - - - - - List of strings value of the parameter. - - - - - Constructs ParameterValue for a list of strings. - - - - - - The interface for an exception handler. - - - - - Handles an exception for the given execution context. - - The execution context, it contains the - request and response context. - The exception to handle. - - Returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception to replace the original exception. - - - - - The interface for an exception handler with a generic parameter for the exception type. - - The exception type. - - - - Handles an exception for the given execution context. - - The execution context, it contains the - request and response context. - The exception to handle. - - Returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception to replace the original exception. - - - - - The interface for a HTTP request factory. - - The type used by the underlying HTTP API to represent the request body. - - - - Creates an HTTP request for the given URI. - - The request URI. - An HTTP request. - - - - The interface for an HTTP request that is agnostic of the underlying HTTP API. - - The type used by the underlying HTTP API to represent the HTTP request content. - - - - The HTTP method or verb. - - - - - The request URI. - - - - - Configures a request as per the request context. - - The request context. - - - - Sets the headers on the request. - - A dictionary of header names and values. - - - - Gets a handle to the request content. - - The request content. - - - - Returns the HTTP response. - - The HTTP response. - - - - Writes a stream to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - The request context. - - - - Writes a byte array to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - - - - Sets up the progress listeners - - The content stream - The interval at which progress needs to be published - The objects which is trigerring the progress changes - The callback which will be invoked when the progress changed event is trigerred - an object, incase the progress is setup, else returns the original stream - - - - Aborts the HTTP request. - - - - - Gets a handle to the request content. - - - - - - Returns the HTTP response. - - A cancellation token that can be used to cancel the asynchronous operation. - - - - - Interface for a handler in a pipeline. - - - - - The logger used to log messages. - - - - - The inner handler which is called after the current - handler completes it's processing. - - - - - The outer handler which encapsulates the current handler. - - - - - Contains the processing logic for a synchronous request invocation. - This method should call InnerHandler.InvokeSync to continue processing of the - request by the pipeline, unless it's a terminating handler. - - The execution context which contains both the - requests and response context. - - - - Contains the processing logic for an asynchronous request invocation. - This method should call InnerHandler.InvokeSync to continue processing of the - request by the pipeline, unless it's a terminating handler. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - A retry policy specifies all aspects of retry behavior. This includes conditions when the request should be retried, - checks of retry limit, preparing the request before retry and introducing delay (backoff) before retries. - - - A retry policy specifies all aspects of retry behavior. This includes conditions when the request should be retried, - checks of retry limit, preparing the request before retry and introducing delay (backoff) before retries. - - - - - Maximum number of retries to be performed. - This does not count the initial request. - - - - - The logger used to log messages. - - - - - Checks if a retry should be performed with the given execution context and exception. - - The execution context which contains both the - requests and response context. - The exception thrown after issuing the request. - Returns true if the request should be retried, else false. The exception is retried if it matches with clockskew error codes. - - - - Returns true if the request is in a state where it can be retried, else false. - - The execution context which contains both the - requests and response context. - Returns true if the request is in a state where it can be retried, else false. - - - - Return true if the request should be retried for the given exception. - - The execution context which contains both the - requests and response context. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Checks if the retry limit is reached. - - The execution context which contains both the - requests and response context. - Return false if the request can be retried, based on number of retries. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called on a successful request response. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called before a retry request is initiated. The value - returned is True by default(retry throttling feature is disabled). - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called before a retry request is initiated. The value - returned is True by default(retry throttling feature is disabled). - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - - - - Checks if a retry should be performed with the given execution context and exception. - - The execution context which contains both the - requests and response context. - The exception throw after issuing the request. - Returns true if the request should be retried, else false. The exception is retried if it matches with clockskew error codes. - - - - Return true if the request should be retried for the given exception. - - The execution context which contains both the - requests and response context. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - Metrics collected by the SDK on a per-request basis. - - - Each request made to an AWS service by the SDK can have metrics - collected and logged. This interface represents the collected - metrics for a request. The metrics include properties (i.e. request id - and other metadata), timings for each stage of the request, and counters. - - - - - Collection of properties being tracked - - - - - Timings for metrics being tracked - - - - - Counters being tracked - - - - - Whether metrics are enabled for the request - - - - - JSON representation of the current metrics - - JSON string - - - - Represents how long a phase of an SDK request took. - - - - - Whether the timing has been stopped - - - - - Elapsed ticks from start to stop. - If timing hasn't been stopped yet, returns 0. - - - - - Elapsed time from start to stop. - If timing hasn't been stopped yet, returns TimeSpan.Zero - - - - - User supplied type to perform metrics formatting. - - - - - Produce custom formatting for SDK metrics. - - - If defined, this method will be called for every request made by the SDK. - - An instance of IRequestMetrics produced by the SDK - formatted string representation of the metrics - - - - Predefined request metrics that are collected by the SDK. - - - - - Information about the request. - - - - - Gets and sets the RequestId property. - ID that uniquely identifies a request. Amazon keeps track of request IDs. If you have a question about a request, include the request ID in your correspondence. - - - - - ICoreAmazonKMS is not meant to be used directly. It defines Key Management Service - with basic .NET types and allows other services to be able to use the service as - a runtime dependency. This interface is implemented by the AmazonKeyManagementServiceClient - defined in the AWSSDK.KeyManagementService assembly. - - - - - The result of the GenerateDataKey and GenerateDataKeyAsync operations. - - - - - The plaintext for the data key. - - - - - The ciphertext for the data key. - - - - - ICoreAmazonS3 is not meant to use directly. It defines S3 with basic .NET types - and allows other services to be able to use S3 as a runtime dependency. This interface - is implemented by the AmazonS3Client defined in the S3 assembly. - - - ICoreAmazonS3 is not meant to use directly. It defines S3 with basic .NET types - and allows other services to be able to use S3 as a runtime dependency. This interface - is implemented by the AmazonS3Client defined in the S3 assembly. - - - ICoreAmazonS3 is not meant to use directly. It defines S3 with basic .NET types - and allows other services to be able to use S3 as a runtime dependency. This interface - is implemented by the AmazonS3Client defined in the S3 assembly. - - - - - Generate a presigned URL. - - - - - - - - - - Get all the object keys for the particular bucket and key prefix. - - - - - - - - - Upload an object from a stream. - - - - - - - - - - - Delete an object. - - - - - - - - - - Delete an object. - - - - - - - - - - Open a stream to an object in S3. - - - - - - - - - - Upload an object from a file path. - - - - - - - - - - - Download an object in S3 to a file path. - - - - - - - - - - - Set the ACL on the object to public readable. - - - - - - - - Check to see if the bucket exists and if it doesn't create the bucket. - - - - - - Check to see if the bucket exists. - - - - - - - Get all the object keys for the particular bucket and key prefix. - - - - - - - - - Delete the object. - - - - - - - - Deletes the ojects. - - - - - - - - Upload an object from a stream. - - - - - - - - - Upload an object from a file path. - - - - - - - - - Download object to a file path. - - - - - - - - - Get stream for an object. - - - - - - - - - Set the ACL on the object to public readable. - - - - - - - - Check to see if the bucket exists and if it doesn't create the bucket. - - - - - - Check to see if the bucket exists. - - - - - - - ICoreAmazonSQS is not meant to use directly. It defines SQS with basic .NET types - and allows other services to be able to use SQS as a runtime dependency. This interface - is implemented by the AmazonSQSClient defined in the SQS assembly. - - - - - - This method is used internally to access the Amazon SQS service within other service assemblies. - Please use AmazonSQSClient to access Amazon SQS instead. - - Get the attributes for the queue identified by the queue URL. - - The queue URL to get attributes for. - The attributes for the queue. - - - - Get the attributes for the queue identified by the queue URL asynchronously. - - The queue URL to get attributes for. - A Task containing the result of a dictionary of attributes for the queue. - - - - - This method is used internally to access the Amazon SQS service within other service assemblies. - Please use AmazonSQSClient to access Amazon SQS instead. - - Set the attributes on the queue identified by the queue URL. - - The queue URL to set the attributues. - The attributes to set. - - - - Set the attributes on the queue identified by the queue URL asynchronously. - - The queue URL to set the attributues. - The attributes to set. - A Task - - - - ICoreAmazonSTS is not meant to be used directly. It defines Security Token - service with basic .NET types and allows other services to be able to use the service as - a runtime dependency. This interface is implemented by the AmazonSecurityTokenServiceClient - defined in the AWSSDK.SecurityToken assembly. - - - - - - This method is used internally to access the Amazon Security Token - service within other service assemblies. - Please use AmazonSecurityTokenServiceClient to access the Amazon Security Token - service instead. - - Use Amazon Security Token Service to assume a role. - - Proxy settings that are required for the HTTPS and STS calls made during the authentication/credential - generation process are supported and should have been configured on the STS ClientConfig instance - associated with the STS client instance exposing this interface. - - - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRole. - - - - - - This method is used internally to access the Amazon Security Token - service within other service assemblies. - Please use AmazonSecurityTokenServiceClient to access the Amazon Security Token - service instead. - - Authenticates against a federated identity endpoint supporting SAML and returns - temporary AWS credentials for the supplied role. - - The endpoint for the federated identity provider - The authentication type to use (NTLM, Kerberos etc) - The ARN of the role the user is to assume following authentication - TTL duration for the generated credentials. - - Optional; alternate user credential for authentication. If null the identity of the - current process is used. - - Generated credential data, including SAML-related information such as subject. - - Proxy settings that are required for the HTTPS and STS calls made during the authentication/credential - generation process are supported and should have been configured on the STS ClientConfig instance - associated with the STS client instance exposing this interface. - - - - - - This method is used internally to access the Amazon Security Token - service within other service assemblies. - Please use AmazonSecurityTokenServiceClient to access the Amazon Security Token - service instead. - - Use Amazon Security Token Service to assume a role. - - Proxy settings that are required for the HTTPS and STS calls made during the authentication/credential - generation process are supported and should have been configured on the STS ClientConfig instance - associated with the STS client instance exposing this interface. - - - The web identity token used to assume the role. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRoleWithWebIdentity - - - - - - This method is used internally to access the Amazon Security Token - service within other service assemblies. - Please use AmazonSecurityTokenServiceClient to access the Amazon Security Token - service instead. - - Use Amazon Security Token Service to assume a role. - - Proxy settings that are required for the HTTPS and STS calls made during the authentication/credential - generation process are supported and should have been configured on the STS ClientConfig instance - associated with the STS client instance exposing this interface. - - - The web identity token used to assume the role. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRoleWithWebIdentity - - - - - CoreAmazonKMS is not meant to use directly. It implements ICoreAmazonKMS - and allows other service clients to be able to use the KMS service as a runtime dependency. - - This class waits until a method is actually called on the ICoreAmazonKMS interface - before requiring the KMS assembly to be present and loaded. - - - - - This exception is thrown if there are problems signing the request. - - - - - Constructs a new instance of the SignatureException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - - - - Gets the percentage of transfer completed - - - - - Gets the number of bytes transferred since last event - - - - - Gets the number of bytes transferred - - - - - Gets the total number of bytes to be transferred - - - - - Returns a string representation of this object - - - - - - TcpKeepAlive class used to group all the different properties used for working with TCP keep-alives. - - - - - Specifies if TCP keep-alive is enabled or disabled. The default value is false for all services except Lambda. - - - - - The timeout before a TCP keep-alive packet will be sent. The timeout value must be greater - than 0 seconds and not null if Enabled is set to true. The default value is 5 minutes. - - - - - The interval before retrying a TCP keep-alive packet that did not receive an acknowledgement. The - interval must be greater than 0 seconds and not null if Enabled is set to true. The default value is 15 seconds. - - - - - Root AWS config section - - - - - Gets and sets the proxy settings for the SDK to use. - - - - - Settings for configuring a proxy for the SDK to use. - - - - - Gets and sets the host name or IP address of the proxy server. - - - - - Gets and sets the port number of the proxy. - - - - - Gets and sets the username to authenticate with the proxy server. - - - - - Gets and sets the password to authenticate with the proxy server. - - - - - Gets and set the proxy bypass list. A set of semi-colon - delimited regular expressions denoting the addresses that - should bypass the proxy. - - - - - Gets and sets the proxy option to bypass local addresses. - - - - - Logging section - - - - - Easy-to-use generic collection - - - - - - Configuration element that serializes properly when used with collections - - - - - ConfigurationElement class which returns false for IsReadOnly - - - - - Settings for configuring a proxy for the SDK to use. - - - Settings for configuring a proxy for the SDK to use. - - - - - The host name or IP address of the proxy server. - - - - - The port number of the proxy. - - - - - The username to authenticate with the proxy server. - - - - - The password to authenticate with the proxy server. - - - - - Collection of one or more regular expressions denoting addresses - for which the proxy will not be used. - - - For more information on bypass lists - see https://msdn.microsoft.com/en-us/library/system.net.webproxy.bypasslist%28v=vs.110%29.aspx. - - - - - If true requests to local addresses bypass the configured - proxy. - - - - - Settings for logging in the SDK. - - - Settings for logging in the SDK. - - - - - Logging destination. - - - - - When to log responses. - - - - - Gets or sets the size limit in bytes for logged responses. - If logging for response body is enabled, logged response - body is limited to this size. The default limit is 1KB. - - - - - Whether or not to log SDK metrics. - - - - - A custom formatter added through Configuration - - - - - Settings for configuring CSM in the SDK. - - - - - This class can be used to discover the public address ranges for AWS. The - information is retrieved from the publicly accessible - https://ip-ranges.amazonaws.com/ip-ranges.json file. - - - The information in this file is generated from our internal system-of-record and - is authoritative. You can expect it to change several times per week and should - poll accordingly. - - - - - Region identifier string for ROUTE53 and CLOUDFRONT ranges - - - - - Collection of service keys found in the data file. - - - - - The publication date and time of the file that was downloaded and parsed. - - - - - Collection of all public IP ranges. - - - - - Filtered collection of public IP ranges for the given service key - - - - - Filtered collection of public IP ranges for the given region (us-east-1 etc) or GLOBAL. - - - - - Downloads the most recent copy of the endpoint address file and - parses it to a collection of address range objects. - - - - - Downloads the most recent copy of the endpoint address file and - parses it to a collection of address range objects. - - - - - Represents the IP address range for a single region and service key. - - - - - The public IPv4 or Ipv6 address range, in CIDR notation. - - - - - Indicates ipv4 or v6 format of the address - - - - - The AWS region or GLOBAL for edge locations. Note that the CLOUDFRONT and ROUTE53 - ranges are GLOBAL. - - - - - The subset of IP address ranges. Specify AMAZON to get all IP address ranges - (for example, the ranges in the EC2 subset are also in the AMAZON subset). Note - that some IP address ranges are only in the AMAZON subset. - - - Valid values for the service key include "AMAZON", "EC2", "ROUTE53", - "ROUTE53_HEALTHCHECKS", and "CLOUDFRONT." If you need to know all of - the ranges and don't care about the service, use the "AMAZON" entries. - The other entries are subsets of this one. Also, some of the services, - such as S3, are represented in "AMAZON" and do not have an entry that - is specific to the service. We plan to add additional values over time; - code accordingly! - - - - - This class defines utilities and constants that can be used by - all the client libraries of the SDK. - - - - - The user agent string header - - - - - The Set of accepted and valid Url characters per RFC3986. - Characters outside of this set will be encoded. - - - - - The Set of accepted and valid Url characters per RFC1738. - Characters outside of this set will be encoded. - - - - - The set of accepted and valid Url path characters per RFC3986. - - - - - The string representing Url Encoded Content in HTTP requests - - - - - The GMT Date Format string. Used when parsing date objects - - - - - The ISO8601Date Format string. Used when parsing date objects - - - - - The ISO8601Date Format string. Used when parsing date objects - - - - - The ISO8601 Basic date/time format string. Used when parsing date objects - - - - - The ISO8601 basic date format. Used during AWS4 signature computation. - - - - - The RFC822Date Format string. Used when parsing date objects - - - - - Returns an extension of a path. - This has the same behavior as System.IO.Path.GetExtension, but does not - check the path for invalid characters. - - - - - - Convert request parameters to Url encoded query string - - - Convert Dictionary of parameters to Url encoded query string - - - - Returns the canonicalized resource path for the service endpoint with single URL encoded path segments. - - Endpoint URL for the request - Resource path for the request - - If resourcePath begins or ends with slash, the resulting canonicalized - path will follow suit. - - Canonicalized resource path for the endpoint - - - - Returns the canonicalized resource path for the service endpoint - - Endpoint URL for the request - Resource path for the request - If true pre URL encode path segments if necessary. - S3 is currently the only service that does not expect pre URL encoded segments. - - If resourcePath begins or ends with slash, the resulting canonicalized - path will follow suit. - - Canonicalized resource path for the endpoint - - - - Returns the canonicalized resource path for the service endpoint - - Endpoint URL for the request - Resource path for the request - If true pre URL encode path segments if necessary. - S3 is currently the only service that does not expect pre URL encoded segments. - Dictionary of key/value parameters containing the values for the ResourcePath key replacements - The version of the marshaller that constructed the request object. - - If resourcePath begins or ends with slash, the resulting canonicalized - path will follow suit. - - Canonicalized resource path for the endpoint - - - - Splits the resourcePath at / into segments then resolves any keys with the path resource values. Greedy - key values will be split into multiple segments at each /. - - The patterned resourcePath - The key/value lookup for the patterned resourcePath - A list of path segments where all keys in the resourcePath have been resolved to one or more path segment values - - - - Joins all path segments with the / character and encodes each segment before joining. - - The segments of a URL path split at each / character - If the path property is specified, - the accepted path characters {/+:} are not encoded. - A joined URL with encoded segments - - - - Takes a patterned resource path and resolves it using the key/value path resources into - a segmented encoded URL. - - The patterned resourcePath - The key/value lookup for the patterned resourcePath - A segmented encoded URL - - - - Returns a new string created by joining each of the strings in the - specified list together, with a comma between them. - - The list of strings to join into a single, comma delimited - string list. - A new string created by joining each of the strings in the - specified list together, with a comma between strings. - - - - Attempt to infer the region for a service request based on the endpoint - - Endpoint to the service to be called - - Region parsed from the endpoint; DefaultRegion (or DefaultGovRegion) - if it cannot be determined/is not explicit - - - - - Attempt to infer the service name for a request (in short form, eg 'iam') from the - service endpoint. - - Endpoint to the service to be called - - Short-form name of the service parsed from the endpoint; empty string if it cannot - be determined - - - - - Utility method for converting Unix epoch seconds to DateTime structure. - - The number of seconds since January 1, 1970. - Converted DateTime structure - - - - Helper function to format a byte array into string - - The data blob to process - If true, returns hex digits in lower case form - String version of the data - - - - Calls a specific EventHandler in a background thread - - - - - - - - Parses a query string of a URL and returns the parameters as a string-to-string dictionary. - - - - - - - Utility method for converting a string to a MemoryStream. - - - - - - - Utility method for copy the contents of the source stream to the destination stream. - - - - - - - Utility method for copy the contents of the source stream to the destination stream. - - - - - - - - Formats the current date as a GMT timestamp - - A GMT formatted string representation - of the current date and time - - - - - Formats the current date as ISO 8601 timestamp - - An ISO 8601 formatted string representation - of the current date and time - - - - - Gets the ISO8601 formatted timestamp that is minutesFromNow - in the future. - - The number of minutes from the current instant - for which the timestamp is needed. - The ISO8601 formatted future timestamp. - - - - Formats the current date as ISO 8601 timestamp - - An ISO 8601 formatted string representation - of the current date and time - - - - - Gets the RFC822 formatted timestamp that is minutesFromNow - in the future. - - The number of minutes from the current instant - for which the timestamp is needed. - The ISO8601 formatted future timestamp. - - - - Determines whether the given string is an absolute path to a root. - - The hypothetical absolute path. - True if is an absolute path. - - - - Returns true if the path specified is relative to the current drive or working directory. - Returns false if the path is fixed to a specific drive or UNC path. This method does no - validation of the path (URIs will be returned as relative as a result). - - - Handles paths that use the alternate directory separator. It is a frequent mistake to - assume that rooted paths (Path.IsPathRooted) are not relative. This isn't the case. - "C:a" is drive relative- meaning that it will be resolved against the current directory - for C: (rooted, but relative). "C:\a" is rooted and not relative (the current directory - will not be used to modify the path). - - - - - True if the given character is a directory separator. - - - - - Returns true if the given character is a valid drive letter - - - - - URL encodes a string per RFC3986. If the path property is specified, - the accepted path characters {/+:} are not encoded. - - The string to encode - Whether the string is a URL path or not - The encoded string - - - - URL encodes a string per the specified RFC. If the path property is specified, - the accepted path characters {/+:} are not encoded. - - RFC number determing safe characters - The string to encode - Whether the string is a URL path or not - The encoded string - - Currently recognised RFC versions are 1738 (Dec '94) and 3986 (Jan '05). - If the specified RFC is not recognised, 3986 is used by default. - - - - - URL encodes a string per the specified RFC with the exception of preserving the encoding of previously encoded slashes. - If the path property is specified, the accepted path characters {/+:} are not encoded. - - The string to encode - Whether the string is a URL path or not - The encoded string with any previously encoded %2F preserved - - - - Convert bytes to a hex string - - Bytes to convert. - Hexadecimal string representing the byte array. - - - - Convert a hex string to bytes - - Hexadecimal string - Byte array corresponding to the hex string. - - - - Returns DateTime.UtcNow + ManualClockCorrection when - is set. - This value should be used instead of DateTime.UtcNow to factor in manual clock correction - - - - - Returns true if the string has any bidirectional control characters. - - - - - - - Executes an HTTP request and returns the response as a string. This method - throws WebException and HttpRequestException. In the event HttpRequestException - is thrown the StatusCode is sent as user defined data on the exception under - the key "StatusCode". - - The URI to make the request to - The request type: GET, PUT, POST - null or the content to send with the request - Timeout for the request - Proxy for the request - null or any headers to send with the request - The response as a string. - - - - Utility method that accepts a string and replaces white spaces with a space. - - - - - - - Runs a process with the below input parameters. - - - - - - - This method allows to check whether a property of an object returned by a service call - is set. This method is needed to discriminate whether a field is not set (not present in - the service response) or if it is set to the default value for its type. Using this - method is not required for nullable properties (non-ValueType and Nullable) because - they will be simply set to null when not included in the service response. - This method can also be used on objects used as part of service requests. - This method doesn't support objects that are part of the S3 service model. - - An object that is used in an AWS service request or is - returned as part of an AWS service response. - The name of the property of awsServiceObject to check. - True if the property is set, otherwise false. - - - - This method is used preserve the stacktrace used from clients that support async calls. This - make sure that exceptions thrown during EndXXX methods has the orignal stacktrace that happen - in the background thread. - - - - - - Provides access to EC2 instance metadata when running on an EC2 instance. - If this class is used on a non-EC2 instance, the properties in this class - will return null. - - - - Amazon EC2 instances can access instance-specific metadata, as well as data supplied when launching the instances, using a specific URI. - - - You can use this data to build more generic AMIs that can be modified by configuration files supplied at launch time. - For example, if you run web servers for various small businesses, they can all use the same AMI and retrieve their content from the - Amazon S3 bucket you specify at launch. To add a new customer at any time, simply create a bucket for the customer, add their content, - and launch your AMI. - - - More information about EC2 Metadata - - - - - - - - - - Allows to configure the proxy used for HTTP requests. The default value is null. - - - - - The AMI ID used to launch the instance. - - - - - The index of this instance in the reservation. - - - - - The manifest path of the AMI with which the instance was launched. - - - - - The AMI IDs of any instances that were rebundled to create this AMI. - Will only exist if the AMI manifest file contained an ancestor-amis key. - - - - - The private hostname of the instance. - In cases where multiple network interfaces are present, - this refers to the eth0 device (the device for which the device number is 0). - - - - - Notifies the instance that it should reboot in preparation for bundling. - Valid values: none | shutdown | bundle-pending. - - - - - The ID of this instance. - - - - - The type of instance. - - - - - The ID of the kernel launched with this instance, if applicable. - - - - - The local hostname of the instance. In cases where multiple network interfaces are present, - this refers to the eth0 device (the device for which device-number is 0). - - - - - The instance's MAC address. In cases where multiple network interfaces are present, - this refers to the eth0 device (the device for which device-number is 0). - - - - - The private IP address of the instance. In cases where multiple network interfaces are present, - this refers to the eth0 device (the device for which device-number is 0). - - - - - The Availability Zone in which the instance launched. - - - - - Product codes associated with the instance, if any. - - - - - Public key. Only available if supplied at instance launch time. - - - - - The ID of the RAM disk specified at launch time, if applicable. - - - - - The region in which the instance is running, extracted from the identity - document data. - - - - - ID of the reservation. - - - - - The names of the security groups applied to the instance. - - - - - Returns information about the last time the instance profile was updated, - including the instance's LastUpdated date, InstanceProfileArn, and InstanceProfileId. - - - - - Returns the temporary security credentials (AccessKeyId, SecretAccessKey, SessionToken, and Expiration) - associated with the IAM roles on the instance. - - - - - The virtual devices associated with the ami, root, ebs, and swap. - - - - - The network interfaces on the instance. - - - - - The metadata sent to the instance. - - - - - Value showing whether the customer has enabled detailed - one-minute monitoring in CloudWatch. - - - - - JSON containing instance attributes, such as instance-id, private IP - address, etc - - - - - Data that can be used by other parties to verify its origin and authenticity. - - - - - Used to verify the document's authenticity and content against the signature. - - - - - Return the list of items in the metadata at path. - - Path at which to query the metadata; may be relative or absolute. - List of items returned by the metadata service - - - - Return the metadata at the path - - Path at which to query the metadata; may be relative or absolute. - Data returned by the metadata service - - - - Return the metadata at the path - - Path at which to query the metadata; may be relative or absolute. - Number of attempts to make - Data returned by the metadata service - - - - Return the list of items in the metadata at path. - - Path at which to query the metadata; may be relative or absolute. - Number of attempts to make - List of items returned by the metadata service - - - - Fetches the api token to use with metadata requests. - - The API token or null - - - - Fetches the api token to use with metadata requests. - - The number of tries to fetch the api token before giving up and throwing the web exception - The API token or null if an API token couldn't be obtained and doesn't need to be used - - - - Exponentially sleeps based on the current retry value. A lower - value will sleep shorter than a larger value - - Base 0 retry index - - - - Returns information about the last time the instance profile was updated, - including the instance's LastUpdated date, InstanceProfileArn, and InstanceProfileId. - - - - - The status of the instance profile - - - - - Further information about the status of the instance profile - - - - - The date and time the instance profile was updated - - - - - The Amazon Resource Name (ARN) of the instance profile - - - - - The Id of the instance profile - - - - - The temporary security credentials (AccessKeyId, SecretAccessKey, SessionToken, and Expiration) associated with the IAM role. - - - - - The status of the security credential - - - - - Further information about the status of the instance profile - - - - - The date and time the security credential was last updated - - - - - The type of the security credential - - - - - The uniqe id of the security credential - - - - - The secret key used to sign requests - - - - - The security token - - - - - The date and time when these credentials expire - - - - - All of the metadata associated with a network interface on the instance. - - - - - Construct an instance of NetworkInterface - - - - - - The interface's Media Access Control (mac) address. - - - - - The ID of the owner of the network interface. - - - In multiple-interface environments, an interface can be attached by a third party, such as Elastic Load Balancing. - Traffic on an interface is always billed to the interface owner. - - - - - The interface's profile - - - - - The interface's local hostname. - - - - - The private IP addresses associated with the interface. - - - - - The interface's public hostname. - - - - - The elastic IP addresses associated with the interface. - - - There may be multiple IP addresses on an instance. - - - - - Security groups to which the network interface belongs. - - - - - IDs of the security groups to which the network interface belongs. Returned only for Amazon EC2 instances launched into a VPC. - - - - - The ID of the Amazon EC2-VPC subnet in which the interface resides. - - - Returned only for Amazon EC2 instances launched into a VPC. - - - - - The CIDR block of the Amazon EC2-VPC subnet in which the interface resides. - - - Returned only for Amazon EC2 instances launched into a VPC. - - - - - The CIDR block of the Amazon EC2-VPC subnet in which the interface resides. - - - Returned only for Amazon EC2 instances launched into a VPC. - - - - - Get the private IPv4 address(es) that are associated with the public-ip address and assigned to that interface. - - The public IP address - Private IPv4 address(es) associated with the public IP address - - - - Wrapper class which invokes the static method - public static string GetEnvironmentVariable(string variable) - underneath. This class is added as a property on the singleton class - EnvironmentVariableSource. This change was done for testability. - - - - - Singleton class that holds the property of type IEnvironmentVariableRetreiver. - This property can hold an instance of type EnvironmentVariableRetreiver which has a wrapper - method for - public static string GetEnvironmentVariable(string variable) - or can be mocked for testing purposes. - - - - - Interface for EnvironmentVariableRetriever. - This serves as a property for the singleton EnvironmentVariableSource - - - - - Manager to access a settings store file. Objects are primarily accessed by DisplayName rather than unique key. - Settings store files are located under the current user's AppData\Local\AWSToolkit folder. - Select keys in these files are encrypted on a per user, per machine basis using the Windows Data Protection API; - the encrypted values cannot be used by any other user or on any other machine. - - This class is not threadsafe. - - - - - True if the encrypted store is availble, false otherwise. - - - - - Construct an NamedSettingsManager. - - The base filename to read/write. - - - - Register an object. Let the uniqueKey be assigned automatically. - - The display name for the object. - The property names and values for the object. - The unique key that was assigned to the object. - - - - Try to get an object form the store. - - The display name for the object. - The property names and values for the object. - True if the object was found, false otherwise. - - - - Try to get an object form the store. - - The display name for the object. - The uniqueKey of the object in the store - The property names and values for the object. - True if the object was found, false otherwise. - - - - Unregister an object from the store. - - The display name for the object. - - - - Rename an object in the store. - - - - if true and destination object already exists overwrite it - - - - Copy an object in the store. - The new object will be a copy of the original, except it will be assigned a new unique key. - - - - if true and destination object already exists overwrite it - - - - Get a list of the display names for the objects in the store. - - A list of display names. - - - - Root AWS config - - - - - Manager to access a settings store file. - Settings store files are located under the current user's AppData\Local\AWSToolkit folder. - Select keys in these files are encrypted on a per user, per machine basis using the Windows Data Protection API; - the encrypted values cannot be used by any other user or on any other machine. - - This class is not threadsafe. - - - - - True if the encrypted store is availble, false otherwise. - - - - - Construct a SettingsManager. - - The base filename to read/write. - - - - The base filename to read/write. - - - - - Register an object. Let the uniqueKey be assigned automatically. - - The property names and values for the object. - The unique key that was assigned to the object. - - - - Register an object. - - The uniqueKey for the object, or null if one should be assigned automatically. - The property names and values for the object. - The unique key that was assigned to the object. - - - - Try to get an object form the store. - - The uniqueKey of the object in the store - The property names and values for the object. - True if the object was found, false otherwise. - - - - Try to get an object form the store based on the value of a specific property. - If multiple objects with the same property value exist, return the first one. - - The name of the property to search on. - The value of the property to search on. - The unique key of the object. - The properties of the object. - - - - - Get a list of the unique keys of all the objects in the store. - - - - - - Get the value of a specific property for each object in the store. - - - - - - - Unregister an object from the store. - - The unique key for the object. - - - - Class that contains result of executing an external process through the SDKs - AWSSDKUtils.RunProcess/AWSSDKUtils.RunProcessAsync - - - - - The exit code with which the process exited - - - - - The output of the process read till the end - - - - - The error output of the process read till the end - - - - - This class allows profiles supporting AWS credentials and SAML-based authentication to be registered with - the SDK so that they can later be reference by a profile name. The credential profiles will be available - for use in the AWS Toolkit for Visual Studio and the AWS Tools for Windows PowerShell. - - The credentials are stored under the current users AppData folder encrypted using Windows Data Protection API. - - - To reference a profile from an application's App.config or Web.config use the AWSProfileName setting. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="development"/> - </appSettings> - </configuration> - - - - - - - Registers an AWS credentials profile that can later be referenced by the profileName. - This profile will only be visible for the current user. - - Name given to the AWS credentials. - The AWS access key id - The AWS secret key - - - - - Registers a role-based profile to be used with SAML authentication. The profile contains - details of the role to be assumed when AWS credentials are requested based on the role and - a reference to a SAML endpoint profile containing details of the endpoint to be called to - authenticate the user. - - - If user identity information is not supplied then the identity of the logged-in user will - be used when authenticaton is performed against the endpoint referenced in the SAML endpoint - profile. If identity is provided, no password information is stored in the role profile and - the user must supply the password for the identity prior to authentication with the endpoint. - - - Name to be assigned to the profile - - The name assigned to the endpoint settings, previously saved with RegisterSAMLEndpoint. - - - The arn of the role that the user wants to assume when using this profile. This - must be one of the set returned by the saml endpoint when the user authenticates. - - - Optional. By default the identity of the logged-in user will be used when authentication - is performed - the user will not be prompted to supply a password. By supplying a custom - identity for this parameter, the user will be prompted to supply the password for the - identity prior to authentication. - - - - - - Registers a role-based profile to be used with SAML authentication. The profile contains - details of the role to be assumed when AWS credentials are requested based on the role and - a reference to a SAML endpoint profile containing details of the endpoint to be called to - authenticate the user. - - - If user identity information is not supplied then the identity of the logged-in user will - be used when authenticaton is performed against the endpoint referenced in the SAML endpoint - profile. If identity is provided, no password information is stored in the role profile and - the user must supply the password for the identity prior to authentication with the endpoint. - - - Name to be assigned to the profile - - The name assigned to the endpoint settings, previously saved with RegisterSAMLEndpoint. - - - The arn of the role that the user wants to assume when using this profile. This - must be one of the set returned by the saml endpoint when the user authenticates. - - - Optional. By default the identity of the logged-in user will be used when authentication - is performed - the user will not be prompted to supply a password. By supplying a custom - identity for this parameter, the user will be prompted to supply the password for the - identity prior to authentication. - - - Set for profiles intended to be used in regions where a region-specific STS endpoint - must be used (eg cn-north-1). If left empty/null, the global sts.amazonaws.com endpoint - will be used when credentials are obtained for this profile. - - - - - Registers an endpoint to be used in conjunction with SAML role profiles. The role profiles - reference the endpoint settings to obtain the actual endpoint and any customization settings - needed to perform authentication. - - Name to be assigned to the endpoint settings. - The full uri of the authentication endpoint. - - The authentication type to use when performing calls against the endpoint. Valid values are 'NTLM', - 'Digest', 'Kerberos' and 'Negotiate'. The default if not configured (null/empty string) is 'Kerberos'. - - The unique id assigned to the new settings. - - - - Deletes the settings for an AWS credentials or SAML role profile from the SDK account store. - - The name of the profile to remove. - - - - Lists all profile names registered with the SDK account store. - - The profile names. - - - - Loads and returns all available credential profiles registered in the store. - - Collection of profiles. - - - - Checks if a given profile is known in the SDK credential store. - - The name of the profile to test for existence - True if the profile exists. - - - - Copies the contents of the source profile to the destination. If the destination - profile does not exist a new profile is created. Note that if the destination - profile exists, all keys it contains are removed and replaced with keys from the - source profile. - - The name of the profile to copy from. - The name of the profile to create or update. - The unique id assigned to the destination settings. - - - - Copies the contents of the source profile to the destination. If the destination - profile does not exist a new profile is created. Note that if the destination - profile exists, all keys it contains are removed and replaced with keys from the - source profile. - - The source profile to copy keys and values from. - The name of the profile to create or update. - The unique id assigned to the destination settings. - - - - Tries to get the AWS credentials from a profile in the SDK account store. - - The profile to get the credentials for. - Outputs the credentials for the profile. - Returns true if the profile exists otherwise false is returned. - - - - Gets the AWS credentials from a profile in the SDK account store. - - The profile to get the credentials for. - The AWS credentials for the profile. - Thrown if the profile does not exist - - - - Returns the profile with the specified name, if it has been registered in the SDK store. - - The name of the registered profile - The loaded profile data - - - - Returns the persisted data in the SDK store as a profile of the specified type T. - - The name of the profile holding the settings. - The loaded profile. An exception is thrown if the profile could not be loaded. - Thrown if the profile does not exist - - Currently supported profile types: AWSCredentialsProfile and SAMLRoleProfile. - - - - - Tries to load the specified profile data corresponding to profile type T from a named - profile in the SDK account store. - - The name of the profile holding the settings. - The loaded profile data. - Returns true if the profile exists otherwise false is returned. - - Currently supported profile types: AWSCredentialsProfile and SAMLRoleProfile. - - - - - Attempts to load the settings defining a SAML endpoint. - - The name assigned to the settings for the endpoint. - The instantiated endpoint. - True if the settings were successfully loaded. - - - - Loads the settings defining a SAML endpoint. - - The name assigned to the settings for the endpoint. - The loaded settings. An exception is thrown if they could not be loaded. - Thrown if the endpoint settings do not exist. - - - - Common base contract for all types of credential and role profiles. - - - - - The user-defined name for the settings. - - - - - The unique id of the profile in the backing store. - - - - - Saves the profile data to backing store, returning the unique id - assigned to the data. - - - - - The persisted data for a set of AWS credentials. At a minimum this - is access key and secret key data. - - - - - Tests if an AWSCredentialsProfile instance could be instantiated from - the persisted settings data. - - The name given to the persisted settings (previously verified as existing). - True if the settings are compatible with an AWSCredentialsProfile type. - - - - Tests if an AWSCredentialsProfile instance could be instantiated from - the persisted settings data. - - The persisted settings. - True if the settings are compatible with an AWSCredentialsProfile type. - - - - Instantiates an AWSCredentialsProfile instance from the specified profile name. - - The name of the profile holding the settings. - New credentials profile instance. An exception is thrown if the profile data is invalid. - - - - Instantiates an AWSCredentialsProfile instance from the supplied settings collection. - - The settings representing the stored profile. - New credentials profile instance. An exception is thrown if the profile data is invalid. - - - - Validates the contents of the specified profile. - - The name of the AWS credentials profile to validate. - Thrown if the profile settings fail to validate. - - - - Verifies that the persisted settings contains the minimal viable data to - instantiate an AWSCredentialsProfile instance. - - The persisted settings. - Thrown if the profile settings fail to validate. - - - - Persists the profile data to the store file. - - The unique ID assigned to the settings. - - - - Creates or updates the profile data in the store file. - - The unique ID assigned to the settings. - - - - The persisted data for a SAML endpoint. One or more role profiles - will reference this to obtain the common endpoint and other data needed - to perform authentication with a set of user credentials. - - - - - The default authentication type to use when attempting to perform an - authentication call against the configured endpoint. - - - - - The authentication endpoint which must be a HTTPS scheme. - - - - - The authentication type to use when calling the endpoint. - - - - - Tests if a SAMLEndpointSettings instance could be instantiated from - the persisted settings data. - - The name given to the persisted settings. - True if the settings are compatible. - - - - Tests if a SAMLEndpointSettings instance could be instantiated from - the persisted settings data. - - The persisted settings. - True if the settings are compatible. - - - - Instantiates an instance from settings stored with the specified name. - - The name of the endpoint settings in the store. - Profile instance or an exception if the profile data does not exist/contains invalid data. - - - - Instantiates an instance from the supplied settings. - - The persisted settings. - Profile instance or an exception if the profile data is invalid. - - - - Validates the contents of the specified endpoint settings. - - The name of the SAML endpoint settings to validate. - Thrown if the settings fail to validate. - - - - Verifies that the persisted settings contains the minimal viable data to - instantiate a SAMLEndpointSettings instance. - - The persisted settings. - Thrown if the settings fail to validate. - - - - Persists the settings to the storage file. - - The unique id assigned to the profile - - - - Creates or updates the settings data for a SAML endpoint in the backing store file. An error is - thrown if the scheme for the endpoint is not https. - - The name of the settings to create or update - The authentication endpoint - Optional authentication type to use when performing calls against the endpoint - The unique id assigned to the profile - - - - Constructs an endpoint settings instance. - - The user-defined name to assign to the settings. - - The absolute uri, including any query and relyingParty data, of the endpoint. - - - The authentication type to use when performing requests against the endpoint. - - - - - - The persisted data for a saml role profile for a user. This profile - references an endpoint profile containing the actual endpoint to be used, and - adds details of the role to be assumed when the profile is selected. - - - Optionally the profile can store a username and domain to be used during - authentication (default behavior, if this is not specified, is to use the user's - default network credentials). - - - - - - The ARN of the role that is to be assumed. - - - - - If non-default network credentials are to used contains - the user identity (in domain\user format, domain optional) that - should be used to supply credentials when the profile is used in - authentication. The user must be prompted to supply the - corresponding password prior to authentication. - - - - - If a specific user identity was specified in the profile, - returns true to indicate a password needs to be obtained from - the user before obtaining network credentials to be used on - authentication. The default is to use the credentials - associated with the currently logged-in user or process to - perform authentication, which does not require the user to be - prompted. - - - - - - For regions with a region-specific endpoint for STS (eg cn-north-1) this - field can be set to ensure calls to obtain temporary credentials - after successful authentication are forwarded to the correct regional - endpoint. - - - This field does not need to be set when running in a region for - which the sts.amazonaws.com endpoint is valid. - - - - - - Retrieves the active credential session, if any, associated with the - role profile. - - - The current credentials valid for the role specified in the profile. Returns - null if no active session is available, or the active session has expired. - - - When a user successfully authenticates and receives temporary AWS - credentials for a role, the profile is updated with details of the - session. When the profile is loaded by other processes or tools, if - session data is present and still valid it can be retrieved using this - method avoiding the need to re-authenticate and get additional temporary - credentials. - - - - - Persists the current credentials to a 'session' key in the RoleSessions.json file. - This enables external applications and tools using the same profile to obtain credentials - without needing to separately re-authenticate the user prior to expiry of the current - credentials. After persisting the session data it can be retrieved using GetCurrentSession(). - - - Although the credentials are temporary we still encrypt the stored data when at rest in - the sdk credential store. - - - The current credentials valid for the role specified in the profile. - - - - - Stores or clears the persisted session data. - - - - - - The endpoint settings from which the actual endpoint to use in authentication - is obtained. - - - - - Tests if a SAMLRoleProfile instance could be instantiated from - the persisted settings data. - - The name given to the persisted settings. - True if the settings are compatible with a SAMLRoleProfile type. - - - - Tests if a SAMLRoleProfile instance could be instantiated from - the persisted settings data. - - The persisted settings. - True if the settings are compatible with a SAMLRoleProfile type. - - - - Instantiates an instance from settings stored with the specified name. - - The name of the endpoint profile. - Profile instance or an exception if the profile data does not exist/contains invalid data. - - - - Instantiates an instance from the supplied settings. In addition to the profile settings - the SDK will inspect for a RoleSessions.json file containing active session data and if - an entry for the profile is present, will add the session data to the returned profile - object. - - The persisted settings. - Profile instance or an exception if the profile data is invalid. - - - - Validates the contents of the specified profile. - - The name of the SAML role profile to validate. - Thrown if the profile settings fail to validate. - - - - Validates that the presented settings would result in a valid role profile - instance. - - The persisted settings. - Thrown if the profile settings fail to validate. - - - - Stores the data in the role profile to the backing store file. - - - - - - Registers a role-based profile to be used with SAML authentication. The profile contains - details of the role to be assumed when AWS credentials are requested based on the role and - a reference to a SAML endpoint profile containing details of the endpoint to be called to - authenticate the user. - - - If user identity information is not supplied then the identity of the logged-in user will - be used when authenticaton is performed against the endpoint referenced in the SAML endpoint - profile. If identity is provided, no password information is stored in the role profile and - the user must supply the password for the identity prior to authentication with the endpoint. - - - Name to be assigned to the profile - - The name of the settings in the SAML endpoints file containing details of the - endpoint to authenticate with. - - - The arn of the role that the user wants to assume when using this profile. This - must be one of the set returned by the saml endpoint when the user authenticates. - - - Optional, can be used to prompt the user for a password for the account when authentication - is performed from a system that is not domain-joined. - - - Optional, details of the currently active credentials for the role that we want to - persist into the profile for other tools or processes to pick up, avoiding the need - to continually re-authenticate the user as they switch between tools. The active session, - if any, is stored separately from the profile using the file RoleSessions.json. - - - Set for profiles intended to be used in regions where a region-specific STS endpoint - must be used (eg cn-north-1). If left empty/null, the global sts.amazonaws.com endpoint - will be used when credentials are obtained for this profile. - - The unique id assigned to the profile. - - - - Tests for and loads any active session credentials for the specified profile. The session data - exists in a separate file from the profile, RoleSessions.json. - - - - - - - Stores the supplied session data into the RoleSessions.json backing file. - - - - - - - Constructs a profile data instance that will use the specified network identity - during authentication with configured endpoint. - - The user-defined name of the profile that sourced this data. - The settings for the authentication endpoint. - The role that should be assumed on successful authentication. - The credentials to supply in authentication, in domain\user format. - - Deserialized credential data from the profile, if still valid. Null if the profile does not - contain any active credentials, or the credentials it did hold are now invalid. - - - Set for profiles intended to be used in regions where a region-specific STS endpoint - must be used (eg cn-north-1). If left empty/null, the global sts.amazonaws.com endpoint - will be used when credentials are obtained for this profile. - - - - - Object to track circular references in nested types. - At each level of nesting, make a call to Track to retrieve Tracker, - a tracking object implementing the IDisposable interface. - Dispose of this tracker when leaving the context of the tracked object. - - - - - Tracker. Must be disposed. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Adds the current target to a reference list and returns a tracker. - The tracker removes the target from the reference list when the - tracker is disposed. - - - - - - - AwsHttpClient is a wrapper around HttpClient class of the System.Net.Http library. - The wrapper has been added so as to remove System.Net.Http dependencies from the Services - and migrate it to a Core level dependecy only. This avoids version clashes when a service - and the Core depends on different versions of the System.Net.Http library. This is a Service - level utility method - - - - - AWSHttpClient wrapper that is wrapped around - HttpClient default wrapper. - - - - - AWSHttpClient BaseAddress property that is wrapper for - HttpClient BaseAddress property. - - - - - AWSHttpClient Timeout property that is wrapper for - HttpClient Timeout property. - - - - - AWSHttpClient MaxResponseContentBufferSize property that is wrapper for - HttpClient MaxResponseContentBufferSize property. - - - - - AWSHttpClient GetStreamAsync that accepts the requester's URI - and make a HttpClient.GetStreamAsync call. - - Requester Uri - - - - Wrapper method that accepts a request uri, stream content and headers and makes a sendAsync call. - - - - - - - Wrapper for HttpClient's HttpRequestMessage and SendAsync methods. - - - - Returns response headers information- header name,value and status code - - - - Wrapper for HttpClient Dispose. - - - - - Method that checks if the passed exception is of type - HttpRequestException - - - - - - - AWSStreamContent is a wrapper for StreamContent class in - the System.Net.Http library.The wrapper has been added so as to - remove System.Net.Http dependencies from the Services - and migrate it to a Core level dependecy only. This avoids version clashes when a service - and the Core depends on different versions of the System.Net.Http library. This is a Service - level utility method - - - - - Wrapper for StreamContent constructor - for stream content - - - - - - Wrapper for StreamContent constructor - for stream content and bufferSize - - - - - - - Wrapper to allow Services to remove StreamContent Headers - - - - - - - Wrapper to allow Services to add StreamContent Headers - - - - - - - Wrapper for StreamContent Dispose. - - - - - Utility class to parse Amazon resource names more commonly known as an ARN. - - - - - Gets and sets the partition associated with the ARN (e.g.: 'aws'). - - - - - Gets and sets the AWS service associated with the ARN (e.g.: 's3'). - - - - - Gets and sets the region associated with the ARN (e.g.: 'us-east-1'). - - - - - Gets and sets the account ID associated with the ARN. - - - - - Gets and sets the resource associated with the ARN (e.g.: 'mybucket/myobject'). - - - - - Returns true if the string appears to be an ARN by seeing if the string starts with "arn:". This method - doesn't guarantee the string is a valid ARN. To validate the string call TryParse. - - - - - - - Parses the string into an ARN object. - - String to parse into an ARN. - The out parameter for the ARN object created by TryParse. - True if the string can be parsed into an ARN object. - - - - Parses the string into an ARN object. - - String to parse into an Arn. - The Arn object created from the passed in string. - Thrown if arnString is null. - Thrown if the string passed in not valid ARN. - - - - Turns the Arn object into a string representation of an ARN. - - - - - - Configuration options that apply to the entire SDK. - - These settings can be configured through app.config or web.config. - Below is a full sample configuration that illustrates all the possible options. - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws region="us-west-2"> - <logging logTo="Log4Net, SystemDiagnostics" logResponses="Always" logMetrics="true" /> - <s3 useSignatureVersion4="true" /> - <proxy host="localhost" port="8888" username="1" password="1" /> - - <dynamoDB> - <dynamoDBContext tableNamePrefix="Prod-"> - - <tableAliases> - <alias fromTable="FakeTable" toTable="People" /> - <alias fromTable="Persons" toTable="People" /> - </tableAliases> - - <mappings> - <map type="Sample.Tests.Author, SampleDLL" targetTable="People" /> - <map type="Sample.Tests.Editor, SampleDLL" targetTable="People"> - <property name="FullName" attribute="Name" /> - <property name="EmployeeId" attribute="Id" /> - <property name="ComplexData" converter="Sample.Tests.ComplexDataConverter, SampleDLL" /> - <property name="Version" version="true" /> - <property name="Password" ignore="true" /> - </map> - </mappings> - - </dynamoDBContext> - </dynamoDB> - </aws> - - - - Configuration options that apply to the entire SDK. - - - - - Manual offset to apply to client clock. This is a global setting that overrides - ClockOffset value calculated for all service endpoints. - - - - - Determines if the SDK should correct for client clock skew - by determining the correct server time and reissuing the - request with the correct time. - Default value of this field is True. - will be updated with the calculated - offset even if this field is set to false, though requests - will not be corrected or retried. - Ignored if is set. - - - - - The calculated clock skew correction, if there is one. - This field will be set if a service call resulted in an exception - and the SDK has determined that there is a difference between local - and server times. - - If is set to true, this - value will be set to the correction, but it will not be used by the - SDK and clock skew errors will not be retried. - - - - - Key for the AWSRegion property. - - - - - - Configures the default AWS region for clients which have not explicitly specified a region. - Changes to this setting will only take effect for newly constructed instances of AWS clients. - - This setting can be configured through the App.config. For example: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws region="us-west-2" /> - - - - - - Key for the AWSProfileName property. - - - - - - Profile name for stored AWS credentials that will be used to make service calls. - Changes to this setting will only take effect in newly-constructed clients. - - To reference the account from an application's App.config or Web.config use the AWSProfileName setting. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="development"/> - </appSettings> - </configuration> - - - - - - - Key for the AWSProfilesLocation property. - - - - - - Location of the credentials file shared with other AWS SDKs. - By default, the credentials file is stored in the .aws directory in the current user's home directory. - - Changes to this setting will only take effect in newly-constructed clients. - - To reference the profile from an application's App.config or Web.config use the AWSProfileName setting. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfilesLocation" value="c:\config"/> - </appSettings> - </configuration> - - - - - - - Key for the Logging property. - - - - - - Configures how the SDK should log events, if at all. - Changes to this setting will only take effect in newly-constructed clients. - - The setting can be configured through App.config, for example: - - <appSettings> - <add key="AWSLogging" value="log4net"/> - </appSettings> - - - - - - Key for the ResponseLogging property. - - - - - - - Configures when the SDK should log service responses. - Changes to this setting will take effect immediately. - - The setting can be configured through App.config, for example: - - <appSettings> - <add key="AWSResponseLogging" value="OnError"/> - </appSettings> - - - - - - Key for the LogMetrics property. - - - - - - Configures if the SDK should log performance metrics. - This setting configures the default LogMetrics property for all clients/configs. - Changes to this setting will only take effect in newly-constructed clients. - - The setting can be configured through App.config, for example: - - <appSettings> - <add key="AWSLogMetrics" value="true"/> - </appSettings> - - - - - - Key for the EndpointDefinition property. - - - - - - Configures if the SDK should use a custom configuration file that defines the regions and endpoints. - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws endpointDefinition="c:\config\endpoints.json" /> - - - - - - Key for the UseSdkCache property. - - - - - - Configures if the SDK Cache should be used, the default value is true. - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws useSdkCache="true" /> - - - - - - Configuration for the Logging section of AWS configuration. - Changes to some settings may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws> - <logging logTo="Log4Net, SystemDiagnostics" logResponses="Always" logMetrics="true" /> - </aws> - - - - - - Configuration for the Proxy section of AWS configuration. - Changes to some settings may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws> - <proxy host="localhost" port="8888" username="1" password="1" bypassList="addressexpr1;addressexpr2;..." bypassOnLocal="true" /> - </aws> - - - - - - Configuration for the region endpoint section of AWS configuration. - Changes may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws region="us-west-2" /> - - - - - - Lock for SomeEvent delegate access. - - - - - This method should never be called directly. - Call AWSSDKUtils.CorrectedUtcNow instead. - - - - - - The unique application name for the current application. This values is currently used - by high level APIs (Mobile Analytics Manager and Cognito Sync Manager) to create a unique file - path to store local database files. - Changes to this setting will only take effect in newly-constructed objects using this property. - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws applicationName="" /> - - - - - - Add a listener for SDK logging. - - If the listener does not have a name, you will not be able to remove it later. - The source to log for, e.g. "Amazon", or "Amazon.DynamoDB". - The listener to add. - - - - Remove a trace listener from SDK logging. - - The source the listener was added to. - The name of the listener. - - - - Generates a sample XML representation of the SDK configuration section. - - - The XML returned has an example of every tag in the SDK configuration - section, and sample input for each attribute. This can be included in - an App.config or Web.config and edited to suit. Where a section contains - a collection, multiple of the same tag will be output. - - Sample XML configuration string. - - - - Logging options. - Can be combined to enable multiple loggers. - - - - - No logging - - - - - Log using log4net - - - - - Log using System.Diagnostics - - - - - Log to the console - - - - - Response logging option. - - - - - Never log service response - - - - - Only log service response when there's an error - - - - - Always log service response - - - - - Format for metrics data in the logs - - - - - Emit metrics in human-readable format - - - - - Emit metrics as JSON data - - - - - Allows to configure the proxy used for HTTP requests. The default value is null. - - - - - This class contains the endpoints available to the AWS clients. The static constants representing the - regions can be used while constructing the AWS client instead of looking up the exact endpoint URL. - - - - - Gets the endpoint for a service in a region. - - The services system name. - If true returns the endpoint for dualstack - Thrown when the request service does not have a valid endpoint in the region. - - - - - Enumerate through all the regions. - - - - - Gets the region based on its system name like "us-west-1" - - The system name of the service like "us-west-1" - - - - - This is a testing method and should not be called by production applications. - - - - - Gets the system name of a region. - - - - - Gets the display name of a region. - - - - - This region name is non-standard. Search the whole endpoints.json file to - determine the partition this region is in. - - - - - This class contains region information used to lazily compute the service endpoints. The static constants representing the - regions can be used while constructing the AWS client instead of looking up the exact endpoint URL. - - - - - The US East (Virginia) endpoint. - - - - - The US East (Virginia) regional endpoint. - - - - - The US East (Ohio) endpoint. - - - - - The US West (N. California) endpoint. - - - - - The US West (Oregon) endpoint. - - - - - The EU North (Stockholm) endpoint. - - - - - The EU West (Ireland) endpoint. - - - - - The EU West (London) endpoint. - - - - - The EU West (Paris) endpoint. - - - - - The EU Central (Frankfurt) endpoint. - - - - - The Asia Pacific (Hong Kong) endpoint. - - - - - The Asia Pacific (Tokyo) endpoint. - - - - - The Asia Pacific (Seoul) endpoint. - - - - - The Asia Pacific (Osaka-Local) endpoint. - - - - - The Asia Pacific (Mumbai) endpoint. - - - - - The Asia Pacific (Singapore) endpoint. - - - - - The Asia Pacific (Sydney) endpoint. - - - - - The South America (Sao Paulo) endpoint. - - - - - The US GovCloud East (Virginia) endpoint. - - - - - The US GovCloud West (Oregon) endpoint. - - - - - The China (Beijing) endpoint. - - - - - The China (Ningxia) endpoint. - - - - - The Canada (Central) endpoint. - - - - - The Middle East (Bahrain) endpoint. - - - - - Represents the endpoint overridding rules in the endpoints.json - Is used to map private region (ie us-east-1-regional) to public regions (us-east-1) - For signing purposes. - - - - - Enumerate through all the regions. - - - - - Gets the region based on its system name like "us-west-1" - - The system name of the service like "us-west-1" - - - - - Gets the region endpoint override if exists - - The region endpoint to find the possible override for - - - - - Gets the system name of a region. - - - - - Gets the display name of a region. - - - - - Gets the partition name the region is in. For example for us-east-1 the partition name is aws. For cn-northwest-1 the partition name is aws-cn. - - - - - Gets the dns suffix for the region endpoints in a partition. For example the aws partition's suffix is amazonaws.com. The aws-cn partition's suffix is amazonaws.com.cn. - - - - - Gets the endpoint for a service in a region. - - - The services system name. Service system names can be obtained from the - RegionEndpointServiceName member of the ClientConfig-derived class for the service. - - - For forwards compatibility, if the service being requested for isn't known in the region, this method - will generate an endpoint using the AWS endpoint heuristics. In this case, it is not guaranteed the - endpoint will point to a valid service endpoint. - - - - - - Gets the endpoint for a service in a region, optionally selecting a dualstack compatible endpoint. - - - The services system name. Service system names can be obtained from the - RegionEndpointServiceName member of the ClientConfig-derived class for the service. - - - If true a dualstack endpoint is returned. It is the user's responsibility to verify that the given service - supports a dualstack endpoint for the region. - - - For forwards compatibility, if the service being requested for isn't known in the region, this method - will generate an endpoint using the AWS endpoint heuristics. In this case, it is not guaranteed the - endpoint will point to a valid service endpoint. - - - - - - This class defines an endpoints hostname and which protocols it supports. - - - - - Gets the hostname for the service. - - - - - The authentication region to be used in request signing. - - - - - This property is only set for S3 endpoints. For all other services this property returns null. - For S3 endpoints, if the endpoint supports signature version 2 this property will be "2", otherwise it will be "4". - - - - a general purpose ASN.1 decoder - note: this class differs from the - others in that it returns null after it has read the last object in - the stream. If an ASN.1 Null is encountered a Der/BER Null object is - returned. - - - Create an ASN1InputStream where no DER object will be longer than limit. - - @param input stream containing ASN.1 encoded data. - @param limit maximum size of a DER encoded object. - - - Create an ASN1InputStream based on the input byte array. The length of DER objects in - the stream is automatically limited to the length of the input array. - - @param input array containing ASN.1 encoded data. - - - build an object given its tag and the number of bytes to construct it from. - - - Create a base ASN.1 object from a byte array. - The byte array to parse. - The base ASN.1 object represented by the byte array. - If there is a problem parsing the data. - - - Read a base ASN.1 object from a stream. - The stream to parse. - The base ASN.1 object represented by the byte array. - If there is a problem parsing the data. - - - return the object at the sequence position indicated by index. - - @param index the sequence number (starting at zero) of the object - @return the object at the sequence position indicated by index. - - - create an empty sequence - - - create a sequence containing one object - - - create a sequence containing a vector of objects. - - - - A - - - - - - A - - - A - - - - - - A - - - - - return a = a + b - b preserved. - - - unsigned comparison on two arrays - note the arrays may - start with leading zeros. - - - returns x = x - y - we assume x is >= y - - - - Calculates a 32bit Cyclic Redundancy Checksum (CRC) using the - same polynomial used by Zip. This type is used internally by DotNetZip; it is generally not used directly - by applications wishing to create, read, or manipulate zip archive files. - - - - - indicates the total number of bytes read on the CRC stream. - This is used when writing the ZipDirEntry when compressing files. - - - - - Indicates the current CRC for all blocks slurped in. - - - - - Returns the CRC32 for the specified stream. - - The stream over which to calculate the CRC32 - the CRC32 calculation - - - - Returns the CRC32 for the specified stream, and writes the input into the output stream. - - The stream over which to calculate the CRC32 - The stream into which to deflate the input - the CRC32 calculation - - - - Get the CRC32 for the given (word,byte) combo. - This is a computation defined by PKzip. - - The word to start with. - The byte to combine it with. - The CRC-ized result. - - - - Update the value for the running CRC32 using the given block of bytes. - This is useful when using the CRC32() class in a Stream. - - block of bytes to slurp - starting point in the block - how many bytes within the block to slurp - - - - A Stream that calculates a CRC32 (a checksum) on all bytes read, - or on all bytes written. - - - - - This class can be used to verify the CRC of a ZipEntry when reading from a stream, - or to calculate a CRC when writing to a stream. The stream should be used to either - read, or write, but not both. If you intermix reads and writes, the results are - not defined. - - This class is intended primarily for use internally by the DotNetZip library. - - - - - Gets the total number of bytes run through the CRC32 calculator. - - - - This is either the total number of bytes read, or the total number - of bytes written, depending on the direction of this stream. - - - - - The constructor. - - The underlying stream - - - - The constructor. - - The underlying stream - The length of the stream to slurp - - - - Provides the current CRC for all blocks slurped in. - - - - - Read from the stream - - the buffer to read - the offset at which to start - the number of bytes to read - the number of bytes actually read - - - - Write to the stream. - - the buffer from which to write - the offset at which to start writing - the number of bytes to write - - - - Indicates whether the stream supports reading. - - - - - Indicates whether the stream supports seeking. - - - - - Indicates whether the stream supports writing. - - - - - Flush the stream. - - - - - Not implemented. - - - - - Not implemented. - - - - - Not implemented. - - N/A - N/A - N/A - - - - Not implemented. - - N/A - - - diff --git a/packages/AWSSDK.Core.3.5.0-beta/lib/netstandard1.3/AWSSDK.Core.dll b/packages/AWSSDK.Core.3.5.0-beta/lib/netstandard1.3/AWSSDK.Core.dll deleted file mode 100644 index ad10657..0000000 Binary files a/packages/AWSSDK.Core.3.5.0-beta/lib/netstandard1.3/AWSSDK.Core.dll and /dev/null differ diff --git a/packages/AWSSDK.Core.3.5.0-beta/lib/netstandard1.3/AWSSDK.Core.xml b/packages/AWSSDK.Core.3.5.0-beta/lib/netstandard1.3/AWSSDK.Core.xml deleted file mode 100644 index 78b1a0d..0000000 --- a/packages/AWSSDK.Core.3.5.0-beta/lib/netstandard1.3/AWSSDK.Core.xml +++ /dev/null @@ -1,13371 +0,0 @@ - - - - AWSSDK.Core - - - - - An access control policy action identifies a specific action in a service - that can be performed on a resource. For example, sending a message to a - queue. - - ActionIdentifiers allow you to limit what your access control policy statement affects. - For example, you could create a policy statement that enables a certain group - of users to send messages to your queue, but not allow them to perform any - other actions on your queue. - - - The action is B in the statement - "A has permission to do B to C where D applies." - - Free form access control policy actions may include a wildcard (*) to match - multiple actions. - - - Constants for known actions can be found in the Amazon.Auth.AccessControlPolicy.ActionIdentifiers namespace. - - - - - - Constructs an Actionidentifer with the given action name. - - The name of the action - - - - Gets and sets the name of this action. For example, 'sqs:SendMessage' is the - name corresponding to the SQS action that enables users to send a message - to an SQS queue. - - - - - The available AWS access control policy actions for Amazon AppStream. - - - - - - The available AWS access control policy actions for Auto Scaling. - - - - - - The available AWS access control policy actions for AWS Billing. - - - - - - The available AWS access control policy actions for AWS CloudFormation. - - - - - - The available AWS access control policy actions for Amazon CloudFront. - - - - - - The available AWS access control policy actions for Amazon CloudSearch. - - - - - - The available AWS access control policy actions for AWS CloudTrail. - - - - - - The available AWS access control policy actions for Amazon CloudWatch. - - - - - - The available AWS access control policy actions for Amazon CloudWatch Logs. - - - - - - The available AWS access control policy actions for Amazon Cognito Identity. - - - - - - The available AWS access control policy actions for Amazon Cognito Sync. - - - - - - The available AWS access control policy actions for AWS Direct Connect. - - - - - - The available AWS access control policy actions for Amazon DynamoDB. - - - - - - The available AWS access control policy actions for Amazon EC2. - - - - - - The available AWS access control policy actions for AWS ElastiCache. - - - - - - The available AWS access control policy actions for AWS Elastic Beanstalk. - - - - - - The available AWS access control policy actions for Elastic Load Balancing. - - - - - - The available AWS access control policy actions for Amazon Elastic MapReduce. - - - - - - The available AWS access control policy actions for Amazon Elastic Transcoder. - - - - - - The available AWS access control policy actions for Amazon Glacier. - - - - - - The available AWS access control policy actions for AWS Identity and Access Management. - - - - - - The available AWS access control policy actions for AWS Import Export. - - - - - - The available AWS access control policy actions for Amazon Kinesis. - - - - - - The available AWS access control policy actions for AWS Marketplace. - - - - - - The available AWS access control policy actions for AWS Marketplace Management Portal. - - - - - - The available AWS access control policy actions for Amazon Mobile Analytics. - - - - - - The available AWS access control policy actions for AWS OpsWorks. - - - - - - The available AWS access control policy actions for Amazon RDS. - - - - - - The available AWS access control policy actions for Amazon Redshift. - - - - - - The available AWS access control policy actions for Amazon Route 53. - - - - - - The available AWS access control policy actions for Amazon S3. - - - - - - The available AWS access control policy actions for AWS Security Token Service. - - - - - - The available AWS access control policy actions for Amazon SES. - - - - - - The available AWS access control policy actions for Amazon SimpleDB. - - - - - - The available AWS access control policy actions for Amazon Simple Workflow Service. - - - - - - The available AWS access control policy actions for Amazon SNS. - - - - - - The available AWS access control policy actions for Amazon SQS. - - - - - - The available AWS access control policy actions for Amazon Storage Gateway. - - - - - - The available AWS access control policy actions for AWS Whispersync. - - - - - - The available AWS access control policy actions for Amazon Zocalo. - - - - - - AWS access control policy conditions are contained in - objects, and affect when a statement is applied. For example, a statement - that allows access to an Amazon SQS queue could use a condition to only apply - the effect of that statement for requests that are made before a certain - date, or that originate from a range of IP addresses. - - Multiple conditions can be included in a single statement, and all conditions - must evaluate to true in order for the statement to take effect. - - - The set of conditions is D in the statement - "A has permission to do B to C where D applies." - - - A condition is composed of three parts: - - - Condition Key - The condition key declares which value of a - request to pull in and compare against when a policy is evaluated by AWS. For - example, using will cause - AWS to pull in the current request's source IP as the first value to compare - against every time your policy is evaluated. - - - - Comparison Type - This is a static value used as the second value - in the comparison when your policy is evaluated. Depending on the comparison - type, this value can optionally use wildcards. See the documentation for - individual comparison types for more information. - - - - Comparison Value - This is a static value used as the second value - in the comparison when your policy is evaluated. Depending on the comparison - type, this value can optionally use wildcards. See the documentation for - individual comparison types for more information. - - - - - - - - - Gets the type of this condition. - - - - - Gets and Sets the name of the condition key involved in this condition. - Condition keys are predefined values supported by AWS that provide input - to a condition's evaluation, such as the current time, or the IP address - of the incoming request. - - Your policy is evaluated for each incoming request, and condition keys - specify what information to pull out of those incoming requests and plug - into the conditions in your policy. - - - - - - Gets and Sets the values specified for this access control policy condition. - For example, in a condition that compares the incoming IP address of a - request to a specified range of IP addresses, the range of IP addresses - is the single value in the condition. - - Most conditions accept only one value, but multiple values are possible. - - - - - - A factory for creating conditions to be used in the policy. - - - - - Condition key for the current time. - - This condition key should only be used with enum. - - - - - - Condition key for whether or not an incoming request is using a secure - transport to make the request (i.e. HTTPS instead of HTTP). - - This condition key should only be used with the boolean overload of NewCondition. - - - - - - Condition key for the source IP from which a request originates. - - This condition key should only be used with enum. - - - - - - Condition key for the user agent included in a request. - - This condition key should only be used with - enum. - - - - - - Condition key for the current time, in epoch seconds. - - This condition key should only be used with enum. - objects. - - - - - - Condition key for the referrer specified by a request. - - This condition key should only be used with - objects. - - - - - - Condition key for the Amazon Resource Name (ARN) of the source specified - in a request. The source ARN indicates which resource is affecting the - resource listed in your policy. For example, an SNS topic is the source - ARN when publishing messages from the topic to an SQS queue. - - This condition key should only be used with enum. - - - - - - Enumeration of the supported ways an ARN comparison can be evaluated. - - - - Exact matching - - - - Loose case-insensitive matching of the ARN. Each of the six - colon-delimited components of the ARN is checked separately and each - can include a multi-character match wildcard (*) or a - single-character match wildcard (?). - - - - Negated form of ArnEquals - - - Negated form of ArnLike - - - - Enumeration of the supported ways a date comparison can be evaluated. - - - - - Enumeration of the supported ways an IP address comparison can be evaluated. - - - - - Matches an IP address against a CIDR IP range, evaluating to true if - the IP address being tested is in the condition's specified CIDR IP - range. - - - - - Negated form of IpAddress - - - - - Enumeration of the supported ways a numeric comparison can be evaluated - - - - - Enumeration of the supported ways a string comparison can be evaluated. - - - - - Case-sensitive exact string matching - - - - - Case-insensitive string matching - - - - - Loose case-insensitive matching. The values can include a - multi-character match wildcard (*) or a single-character match - wildcard (?) anywhere in the string. - - - - - Negated form of StringEquals. - - - - - Negated form of StringEqualsIgnorecase. - - - - - Negated form of StringLike. - - - - - Constructs a new access control policy condition that compares ARNs (Amazon Resource Names). - - The access policy condition key specifying where to get the first ARN for the comparison - The type of comparison to perform. - The second ARN to compare against. When using ArnLike or ArnNotLike this may contain the - multi-character wildcard (*) or the single-character wildcard - - - - Constructs a new access policy condition that performs a boolean - comparison. - - The access policy condition key specifying where to get the - first boolean value for the comparison (ex: aws:SecureTransport). - The boolean to compare against. - - - - This method is deprecated. Invoking this method results in non-UTC DateTimes - not being marshalled correctly. Use NewConditionUtc instead. - Constructs a new access policy condition that compares the current time - (on the AWS servers) to the specified date. - - The type of comparison to perform. For example, - DateComparisonType.DateLessThan will cause this policy - condition to evaluate to true if the current date is less than - the date specified in the second argument. - The date to compare against. - - - - Constructs a new access policy condition that compares the current time - (on the AWS servers) to the specified date. - - The type of comparison to perform. For example, - DateComparisonType.DateLessThan will cause this policy - condition to evaluate to true if the current date is less than - the date specified in the second argument. - The date to compare against. - - - - Constructs a new access policy condition that compares the source IP - address of the incoming request to an AWS service against the specified - CIDR range. The condition evaluates to true (meaning the policy statement - containing it will be applied) if the incoming source IP address is - within that range. - - To achieve the opposite effect (i.e. cause the condition to evaluate to - true when the incoming source IP is not in the specified CIDR - range) use the alternate constructor form and specify - IpAddressComparisonType.NotIpAddress. - - - The CIDR IP range involved in the policy condition. - - - - Constructs a new access policy condition that compares the source IP - address of the incoming request to an AWS service against the specified - CIDR range. When the condition evaluates to true (i.e. when the incoming - source IP address is within the CIDR range or not) depends on the - specified IpAddressComparisonType. - - The type of comparison to to perform. - The CIDR IP range involved in the policy condition. - - - - Constructs a new access policy condition that compares two numbers. - - The type of comparison to perform. - The access policy condition key specifying where to get the - first number for the comparison. - The second number to compare against. - - - - Constructs a new access control policy condition that compares two - strings. - - The type of comparison to perform - The access policy condition key specifying where to get the - first string for the comparison (ex: aws:UserAgent). - - The second string to compare against. When using - StringComparisonType.StringLike or - StringComparisonType.StringNotLike this may contain - the multi-character wildcard (*) or the single-character - wildcard (?). - - - - - Constructs a new access policy condition that compares the Amazon - Resource Name (ARN) of the source of an AWS resource that is modifying - another AWS resource with the specified pattern. - - For example, the source ARN could be an Amazon SNS topic ARN that is - sending messages to an Amazon SQS queue. In that case, the SNS topic ARN - would be compared the ARN pattern specified here. - - - The endpoint pattern may optionally contain the multi-character wildcard - * (*) or the single-character wildcard (?). Each of the six colon-delimited - components of the ARN is checked separately and each can include a - wildcard. - - - Policy policy = new Policy("MyQueuePolicy"); - policy.WithStatements(new Statement(Statement.StatementEffect.Allow) - .WithPrincipals(new Principal("*")).WithActionIdentifiers(SQSActionIdentifiers.SendMessage) - .WithResources(new Resource(myQueueArn)) - .WithConditions(ConditionFactory.NewSourceArnCondition(myTopicArn))); - - - The ARN pattern against which the source ARN will be compared. - Each of the six colon-delimited components of the ARN is - checked separately and each can include a wildcard. - A new access control policy condition that compares the ARN of - the source specified in an incoming request with the ARN pattern - specified here. - - - - Constructs a new access control policy condition that tests if the - incoming request was sent over a secure transport (HTTPS). - - A new access control policy condition that tests if the incoming - request was sent over a secure transport (HTTPS). - - - - Condition key for the canned ACL specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the location constraint specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the prefix specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the delimiter specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the max keys specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the source object specified by a request to copy an - object. - - This condition key may only be used with enum. - - - - - - Condition key for the metadata directive specified by a request to copy - an object. - - This condition key may only be used with enum. - - - - - - Condition key for the version ID of an object version specified by a - request. - - This condition key may only be used with enum. - - - - - - Constructs a new access policy condition that compares an Amazon S3 - canned ACL with the canned ACL specified by an incoming request. - - You can use this condition to ensure that any objects uploaded to an - Amazon S3 bucket have a specific canned ACL set. - - - The Amazon S3 canned ACL to compare against. - A new access control policy condition that compares the Amazon S3 - canned ACL specified in incoming requests against the value - specified. - - - - Condition key for The URL, e-mail address, or ARN from a Subscribe - request or a previously confirmed subscription. Use with string - conditions to restrict access to specific endpoints (e.g., - *@mycompany.com). - - This condition key may only be used with enum. - - - - - - Condition key for the protocol value from a Subscribe request or a - previously confirmed subscription. Use with string conditions to restrict - publication to specific delivery protocols (e.g., HTTPS). - - This condition key may only be used with enum. - - - - - - Constructs a new access policy condition that compares the requested - endpoint used to subscribe to an Amazon SNS topic with the specified - endpoint pattern. The endpoint pattern may optionally contain the - multi-character wildcard (*) or the single-character wildcard (?). - - For example, this condition can restrict subscriptions to a topic to - email addresses in a certain domain ("*@my-company.com"). - - - Policy policy = new Policy("MyTopicPolicy"); - policy.WithStatements(new Statement(Statement.StatementEffect.Allow) - .WithPrincipals(new Principal("*")).WithActionIdentifiers(SNSActionIdentifiers.Subscribe) - .WithResources(new Resource(myTopicArn)) - .WithConditions(ConditionFactory.NewEndpointCondition("*@my-company.com"))); - - - The endpoint pattern against which to compare the requested - endpoint for an Amazon SNS topic subscription. - A new access control policy condition that compares the endpoint - used in a request to subscribe to an Amazon SNS topic with the - endpoint pattern specified. - - - - Constructs a new AWS access control policy condition that allows an - access control statement to restrict subscriptions to an Amazon SNS topic - based on the protocol being used for the subscription. For example, this - condition can restrict subscriptions to a topic to endpoints using HTTPS - to ensure that messages are securely delivered. - - The protocol against which to compare the requested protocol - for an Amazon SNS topic subscription. - A new access control policy condition that compares the - notification protocol requested in a request to subscribe to an - Amazon SNS topic with the protocol value specified. - - - - Deserializes a JSON string into a AWS policy object. - - - - - Serializes an AWS policy object to a JSON string, suitable for sending to an - AWS service. - - - - Converts the specified AWS policy object to a JSON string, suitable for - passing to an AWS service. - - @param policy - The AWS policy object to convert to a JSON string. - - @return The JSON string representation of the specified policy object. - - @throws IllegalArgumentException - If the specified policy is null or invalid and cannot be - serialized to a JSON string. - - - - Uses the specified generator to write the JSON data for the principals in - the specified policy statement. - - - - - This sorts the conditions by condition type and key with the list of values for that combination. - - The list of conditions to be sorted. - - - - - An AWS access control policy is a object that acts as a container for one or - more statements, which specify fine grained rules for allowing or denying - various types of actions from being performed on your AWS resources. - - By default, all requests to use your resource coming from anyone but you are - denied. Access control polices can override that by allowing different types - of access to your resources, or by explicitly denying different types of - access. - - - Each statement in an AWS access control policy takes the form: - "A has permission to do B to C where D applies". - - - A is the prinicpal - The AWS account that is making a request to - access or modify one of your AWS resources. - - - - B is the action - the way in which your AWS resource is being accessed or modified, such - as sending a message to an Amazon SQS queue, or storing an object in an Amazon S3 bucket. - - - - C is the resource - your AWS entity that the principal wants to access, such - as an Amazon SQS queue, or an object stored in Amazon S3. - - - - D is the set of conditions - optional constraints that specify when to allow or deny - access for the principal to access your resource. Many expressive conditions are available, - some specific to each service. For example you can use date conditions to allow access to - your resources only after or before a specific time. - - - - - - Note that an AWS access control policy should not be confused with the - similarly named "POST form policy" concept used in Amazon S3. - - - - - - The default policy version - - - - - Constructs an empty AWS access control policy ready to be populated with - statements. - - - - - Constructs a new AWS access control policy with the specified policy ID. - The policy ID is a user specified string that serves to help developers - keep track of multiple polices. Policy IDs are often used as a human - readable name for a policy. - - The policy ID for the new policy object. Policy IDs serve to - help developers keep track of multiple policies, and are often - used to give the policy a meaningful, human readable name. - - - - Constructs a new AWS access control policy with the specified policy ID - and collection of statements. The policy ID is a user specified string - that serves to help developers keep track of multiple polices. Policy IDs - are often used as a human readable name for a policy. - - The policy ID for the new policy object. Policy IDs serve to - help developers keep track of multiple policies, and are often - used to give the policy a meaningful, human readable name. - The statements to include in the new policy. - - - - Gets and Sets the policy ID for this policy. Policy IDs serve to help - developers keep track of multiple policies, and are often used as human - readable name for a policy. - - - - - Sets the policy ID for this policy and returns the updated policy so that - multiple calls can be chained together. - - Policy IDs serve to help developers keep track of multiple policies, and - are often used as human readable name for a policy. - - - The polich ID for this policy - this instance - - - - Gets and sets the version of this AWS policy. - - - - - Gets and Sets the collection of statements contained by this policy. Individual - statements in a policy are what specify the rules that enable or disable - access to your AWS resources. - - - - - Checks to see if the permissions set in the statement are already set by another - statement in the policy. - - The statement to verify - True if the statement's permissions are already allowed by the statement - - - - Sets the collection of statements contained by this policy and returns - this policy object so that additional method calls can be chained - together. - - Individual statements in a policy are what specify the rules that enable - or disable access to your AWS resources. - - - The collection of statements included in this policy. - this instance - - - - Returns a JSON string representation of this AWS access control policy, - suitable to be sent to an AWS service as part of a request to set an - access control policy. - - A JSON string representation of this AWS access control policy. - - - - Returns a JSON string representation of this AWS access control policy, - suitable to be sent to an AWS service as part of a request to set an - access control policy. - - Toggle pretty print for the generated JSON document - A JSON string representation of this AWS access control policy. - - - - Parses a JSON document of a policy and creates a Policy object. - - JSON document of a policy. - - - - - A principal is an AWS account which is being allowed or denied access to a - resource through an access control policy. The principal is a property of the - Statement object, not directly the object. - - The principal is A in the statement - "A has permission to do B to C where D applies." - - - In an access control policy statement, you can set the principal to all - authenticated AWS users through the member. This - is useful when you don't want to restrict access based on the identity of the - requester, but instead on other identifying characteristics such as the - requester's IP address. - - - - - - Principal instance that includes all authenticated AWS users. - - This is useful when you don't want to restrict access based on the - identity of the requester, but instead on other identifying - characteristics such as the requester's IP address. - - - - - - The anonymous Principal. - - - - - The default Principal provider for AWS accounts. - - - - - Principal provider for Canonical User IDs. - - - - - Principal provider for federated users (using a SAML identity provider) - - - - - Principal provider for assume role policies that will be assumed by an AWS service - (e.g. "ec2.amazonaws.com"). - - - - - Dummy principal provider for anonynous. - - - - - Constructs a new principal with the specified AWS account ID. - - An AWS account ID. - - - - Constructs a new principal with the specified provider and id - - The provider of the principal - The unique ID of the Principal within the provider - - - - Constructs a new principal with the specified provider and id - and optionally strips hyphens from the id - - The provider of the principal - The unique ID of the Principal within the provider - Strip hyphen - - - - Gets and sets the provider for this principal, which indicates in what group of - users this principal resides. - - - - - Gets the unique ID for this principal. - - - - - Represents a resource involved in an AWS access control policy statement. - Resources are the service specific AWS entities owned by your account. Amazon - SQS queues, Amazon S3 buckets and objects, and Amazon SNS topics are all - examples of AWS resources. - - The standard way of specifying an AWS resource is with an Amazon Resource - Name (ARN). - - - The resource is C in the statement - "A has permission to do B to C where D applies." - - - - - - Constructs a new AWS access control policy resource. Resources are - typically specified as Amazon Resource Names (ARNs). - - You specify the resource using the following Amazon Resource Name (ARN) - format: arn:aws:<vendor>:<region>:<namespace>:<relative-id> - - - >vendor identifies the AWS product (e.g., sns) - - - region is the AWS Region the resource resides in (e.g., us-east-1), if any - - - namespace is the AWS account ID with no hyphens (e.g., 123456789012) - - - relative-id is the service specific portion that identifies the specific resource - - - - - For example, an Amazon SQS queue might be addressed with the following - ARN: arn:aws:sqs:us-east-1:987654321000:MyQueue - - - Some resources may not use every field in an ARN. For example, resources - in Amazon S3 are global, so they omit the region field: - arn:aws:s3:::bucket/* - - - The Amazon Resource Name (ARN) uniquely identifying the desired AWS resource. - - - - Gets the resource ID, typically an Amazon Resource Name (ARN), - identifying this resource. - - - - - A factory for creating resources to be used in the policy. - - - - - Constructs a new bucket resource that represents the the specified bucket - but not any of the contained objects. - - The name of the bucket represented by this AWS access control - policy resource. - - - - Constructs a new object resource that represents the specified objects. - The keyPattern argument may contain the '*' wildcard to match multiple - objects. For example, an object resource created for bucket 'mybucket' - and key pattern 'foo*' will match any object stored in 'mybucket' with a - key that starts with 'foo'. - - The name of the bucket containing the object or objects - represented by this resource. - The key or key pattern, which can optionally contain the '*' - wildcard to include multiple objects in the resource. - - - - Constructs a new SQS queue resource for an access control policy. A - policy statement using this resource will allow or deny actions on the - specified queue. - - The AWS account ID of the queue owner. - The name of the Amazon SQS queue. - - - - A statement is the formal description of a single permission, and is always - contained within a policy object. - - A statement describes a rule for allowing or denying access to a specific AWS - resource based on how the resource is being accessed, and who is attempting - to access the resource. Statements can also optionally contain a list of - conditions that specify when a statement is to be honored. - - - For example, consider a statement that: - - - A is the prinicpal - The AWS account that is making a request to - access or modify one of your AWS resources. - - - - B is the action - the way in which your AWS resource is being accessed or modified, such - as sending a message to an Amazon SQS queue, or storing an object in an Amazon S3 bucket. - - - - C is the resource - your AWS entity that the principal wants to access, such - as an Amazon SQS queue, or an object stored in Amazon S3. - - - - D is the set of conditions - optional constraints that specify when to allow or deny - access for the principal to access your resource. Many expressive conditions are available, - some specific to each service. For example you can use date conditions to allow access to - your resources only after or before a specific time. - - - - - - There are many resources and conditions available for use in statements, and - you can combine them to form fine grained custom access control polices. - - - - - - The effect is the result that you want a policy statement to return at - evaluation time. A policy statement can either allow access or explicitly - deny access. - - - - - Constructs a new access control policy statement with the specified - effect. - - Before a statement is valid and can be sent to AWS, callers must set the - principals, resources, and actions (as well as any optional conditions) - involved in the statement. - - - The effect this statement has (allowing access or denying - access) when all conditions, resources, principals, and - actions are matched. - - - - Gets and Sets the ID for this statement. Statement IDs serve to help keep track - of multiple statements, and are often used to give the statement a - meaningful, human readable name. - - Developers should be careful to not use the same statement ID for - multiple statements in the same policy. Reusing the same statement ID in - different policies is not a problem. - - - - - - Sets the ID for this statement and returns the updated statement so - multiple calls can be chained together. - - Statement IDs serve to help keep track of multiple statements, and are - often used to give the statement a meaningful, human readable name. - - - Developers should be careful to not use the same statement ID for - multiple statements in the same policy. Reusing the same statement ID in - different policies is not a problem. - - - The new statement ID for this statement. - this instance - - - - Gets and Sets the result effect of this policy statement when it is evaluated. - A policy statement can either allow access or explicitly - - - - - Gets and Sets the list of actions to which this policy statement applies. - Actions limit a policy statement to specific service operations that are - being allowed or denied by the policy statement. For example, you might - want to allow any AWS user to post messages to your SQS queue using the - SendMessage action, but you don't want to allow those users other actions - such as ReceiveMessage or DeleteQueue. - - - - - Sets the list of actions to which this policy statement applies and - returns this updated Statement object so that additional method calls can - be chained together. - - Actions limit a policy statement to specific service operations that are - being allowed or denied by the policy statement. For example, you might - want to allow any AWS user to post messages to your SQS queue using the - SendMessage action, but you don't want to allow those users other actions - such as ReceiveMessage or DeleteQueue. - - - The list of actions to which this statement applies. - this instance - - - - Gets and Sets the resources associated with this policy statement. Resources - are what a policy statement is allowing or denying access to, such as an - Amazon SQS queue or an Amazon SNS topic. - - Note that some services allow only one resource to be specified per - policy statement. - - - - - - Sets the resources associated with this policy statement and returns this - updated Statement object so that additional method calls can be chained - together. - - Resources are what a policy statement is allowing or denying access to, - such as an Amazon SQS queue or an Amazon SNS topic. - - - Note that some services allow only one resource to be specified per - policy statement. - - - The resources associated with this policy statement. - this instance - - - - Gets and Sets the conditions associated with this policy statement. Conditions - allow policy statements to be conditionally evaluated based on the many - available condition types. - - For example, a statement that allows access to an Amazon SQS queue could - use a condition to only apply the effect of that statement for requests - that are made before a certain date, or that originate from a range of IP - addresses. - - - When multiple conditions are included in a single statement, all - conditions must evaluate to true in order for the statement to take - effect. - - - - - - Sets the conditions associated with this policy statement, and returns - this updated Statement object so that additional method calls can be - chained together. - - Conditions allow policy statements to be conditionally evaluated based on - the many available condition types. - - - For example, a statement that allows access to an Amazon SQS queue could - use a condition to only apply the effect of that statement for requests - that are made before a certain date, or that originate from a range of IP - addresses. - - - Multiple conditions can be included in a single statement, and all - conditions must evaluate to true in order for the statement to take - effect. - - - The conditions associated with this policy statement. - this instance - - - - Gets and Sets the principals associated with this policy statement, indicating - which AWS accounts are affected by this policy statement. - - - - - Sets the principals associated with this policy statement, and returns - this updated Statement object. Principals control which AWS accounts are - affected by this policy statement. - - If you don't want to restrict your policy to specific users, you can use - to apply the policy to any user trying to - access your resource. - - - The list of principals associated with this policy statement. - this instance - - - - Exception thrown by the SDK for errors that occur within the SDK. - - - - - This exception is thrown when there is a parse error on the response back from AWS. - - - - - The string value which could not be converted into a valid DateTime instance. - - - - - Occurs before a request is marshalled. - - - - - Occurs before a request is issued against the service. - - - - - Occurs after a response is received from the service. - - - - - Occurs after an exception is encountered. - - - - - Patches the in-flight uri to stop it unescaping the path etc (what Uri did before - Microsoft deprecated the constructor flag). This is particularly important for - Amazon S3 customers who want to use backslash (\) in their key names. - - - Different behavior in the various runtimes has been observed and in addition some - 'documented' ways of doing this between 2.x and 4.x runtimes has also been observed - to not be reliable. - - This patch effectively emulates what adding a schemesettings element to the - app.config file with value 'name="http" genericUriParserOptions="DontUnescapePathDotsAndSlashes"' - does. As we're a dll, that avenue is not open to us. - - - - - - Used to create a copy of the config for a different service than the current instance. - - Target service ClientConfig - The new ClientConfig for the desired service - - - - A base exception for some Amazon Web Services. - - Most exceptions thrown to client code will be service-specific exceptions, though some services - may throw this exception if there is a problem which is caught in the core client code. - - - - - - Whether the error was attributable to Sender or Reciever. - - - - - The error code returned by the service - - - - - The id of the request which generated the exception. - - - - - The HTTP status code from the service response - - - - - This exception is thrown when there is a parse error on the response back from AWS. - - - - - Last known location in the response that was parsed, if available. - - - - - The entire response body that caused this exception, if available. - - - - - Base class for request used by some of the services. - - - - - This flag specifies if SigV4 will be used for the current request. - - - - - Gets or Sets a value indicating if "Expect: 100-continue" HTTP header will be - sent by the client for this request. The default value is false. - - - - - Gets the signer to use for this request. - A null return value indicates to use the configured - signer for the service that this request is part of. - - A signer for this request, or null. - - - - Abstract class for Response objects, contains only metadata, - and no result information. - - - - - Contains additional information about the request, such as the - Request Id. - - - - - Returns the content length of the HTTP response. - - - - - Returns the status code of the HTTP response. - - - - - Base class for determining region based on inspection. - - - - - Sets the Region property by looking up the corresponding RegionEndpoint - from the supplied region system name (us-east-1, us-west-2 etc). - - The system name of the region. - - - - Determines region based on application configuration settings. If the configuration does not contain - the region setting key an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of ApplicationConfigAWSRegion. If no region is found in the - application configuration file then an InvalidOperationException is thrown. - - - - - Determines region based on an environment variable. If the environment does not contain - the region setting key an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of EnvironmentVariableAWSRegion. If no region is found in the - environment then an InvalidOperationException is thrown. - - - - - Determines region based on inspection of the instance metadata if running on an EC2 instance. - If instance metadata cannot be read or does not contain region information an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of InstanceProfileAWSRegion. If no region is found in the - metadata or we are not running on an EC2 instance an InvalidOperationException is thrown. - - - - - Determines region based on a stored in an . - If the profile doesn't exist or there is no region information an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of . - If the AWS_PROFILE environment variable is set the instance will be constructed using that profile, - otherwise it will use the default profile. - - If the profile doesn't exist or there is no region information an InvalidOperationException is thrown. - - The ICredentialProfileSource to read the profile from. - - - - Attempts to construct an instance of . - If the profile doesn't exist or there is no region information an InvalidOperationException is thrown. - - The ICredentialProfileSource to read the profile from. - The name of the profile. - - - - Probing mechanism to determine region from various sources. - - - - - This class is responsible for keeping track of Retry capacity across different ServiceURLs. - - - - - This method acquires a said retry capacity if the container has the capacity. - - Contains the RetryCapacity object for the said ServiceURL. - - - - This method calls a method to release capacity back - based on whether it was a successful response or a successful retry response. This is invoked by a retry request response. - - if this request is a retry, use a different capacity cost - Contains the RetryCapacity object for the said ServiceURL. - - - - Ths method fetches the RetryCapacity for the given ServiceURL from CapacityManager.CapacityContainer - - - - - This method releases capacity back. This is invoked by the TryReleaseCapacity method. - - Contains the RetryCapacity object for the said ServiceURL. - The capacity that needs to be released based on whether it was a successful response or a successful retry response. - - - - This class is the RetryCapacity class for a given ServiceURL. - - - - - This class composes Client Context header for Amazon Web Service client. - It contains information like app title, version code, version name, client id, OS platform etc. - - - - - Adds the custom attributes to the Client Context. - - Key. - Value. - - - - Gets a Json Representation of the Client Context. - - Json Representation of Client Context - - - - Class to which the Json stdout from credential process is - de-serialized into. - - - - - Version of the Json payload - - - - - AWS Access key - - - - - AWS Secret key - - - - - AWS Session token for session credentials - - - - - ISO8601 formatted timestamp till when the credential is valid. - - - - - This class gets the CSM configuration if set. - The priority goes - 1. App.config / instantiate on the AWSConfigs class - 2. Environment variable - 3. Shared Profile - - - - - Determine CSM configs from shared profile file. - - - - - Determine CSM configs from environment variables. - - - - - Determine CSM configs from AWSConfigs class. - - - - - Utility class for CSM. - Contains logic to serialize CSM events to Json. - - - - - Method to retrieve the API name from the request name. - - - - - Method to serialize MonitoringAPICallAttempt CSM event to json. - - - - - Method to serialize MonitoringAPICallEvent CSM event to json. - - - - - Method to serialize MonitoringAPICall CSM event to json. - - - - - Internal class that has the CSM configurations for the Monitoring Listener - after being derived from the CSMConfigChain class. - - - - - CSM event base class - - - - - Contains the operation name for the api call being made - - - - - Contains the service id ServiceId Sep of the service - against which the call is being made - - - - - Contains the "ClientId" configuration value - computed from the CSMConfigChain class - - - - - Contains the elapsed time, in milliseconds, - since January 1st, 1970, for the time point - at which the event occurred - - - - - Contains "ApiCall" or "ApiCallAttempt" - based on what the monitoring event is describing - - - - - Contains the enum of the above CSM type property - - - - - Contains the "Version" configuration value - computed from the CSMConfigChain class - Defaults to 1. - - - - - Contains the signing region used by the - service client that made the request attempt. - - - - - Contains the full value of the SDK's default - user agent header for http requests. - - - - - Class that captures the CSM Api Call Attempt Monitoring Events - for each http request and its subsequent response. - - - - - Contains the fully-qualified domain name of the endpoint that - the request attempt was submitted to. - - - - - Contains the session token passed - in the x-amz-security-token header. - - - - - Contains the aws_access_key value that - was used to sign the http request. - - - - - Contains the attempt's response status code, - as returned by the http client. - - - - - Contains the full text (exception object converted to String, - for example) for any attempt-level failure that is due to - something other than an Aws exception. The value of this entry - has a maximum length of 512. - - - - - Contains the short error name (exception class name, for example) - for any attempt-level failure that is due to something other - than an Aws exception.The value of this entry has a maximum length of 128. - - - - - Contains the Aws exception code returned in the response. - - - - - Contains the full text of the Aws exception message. - - - - - Contains the value of the response's x-amzn-RequestId header. - - - - - Contains the value of the response's x-amz-request-id header. - - - - - Contains the value of the response's x-amz-id-2 header. - - - - - Contains the elapsed time, in milliseconds, - between the construction of the http request and the - point in time where the http response has been parsed - or the attempt has definitively failed. - - - - - Class that captures the CSM Api Call Monitoring Events - for the entire SDK call. This is processed once. - - - - - Contains the total number of attempts that were made - by the service client to fulfill this request before succeeding or failing - - - - - Contains the elapsed time, in milliseconds, - between when the Api Call was begun and when a - final response or error is manifested to the caller - - - - - a boolean (0/1) value that is 0 unless the Api call failed - and the final attempt returned a retryable error.This entry should be - serialized as a numeric 0/1 value. This is mapped to MaxRetriesExceeded - when serialized to a UDP datagram. - - - - - Contains the full text (exception object - converted to String, for example) for an attempt-level failure that is due to - something other than an Aws exception that occurred on the last attempt to - fulfill the Api call.The value of this entry has a maximum length of 512. - - - - - Contains the short error name (exception - class name, for example) for a failure that is due to something other than an - Aws exception that occurred on the last attempt to fulfill an Api call.See - the SdkException entry for more details.The value of this entry has a - maximum length of 128. - - - - - Contains the Aws exception code - returned in the response to the final attempt at fulfilling this API call. - The value of this entry has a maximum length of 128. - - - - - - Contains the attempt's response status code, - as returned by the http client. - - - - - Computes RFC 2104-compliant HMAC signature. - - - - - Computes RFC 2104-compliant HMAC signature. - - - - - Inspects the supplied evidence to return the signer appropriate for the operation - - Global setting for the service - The request. - Configuration for the client - True if signature v4 request signing should be used - - - - Signs the specified request with the AWS3 signing protocol by using the - AWS account credentials given in the method parameters. - - The AWS public key - The AWS secret key used to sign the request in clear text - Request metrics - The configuration that specifies which hashing algorithm to use - The request to have the signature compute for - If any problems are encountered while signing the request - - - - AWS4 protocol signer for service calls that transmit authorization in the header field "Authorization". - - - - - Calculates and signs the specified request using the AWS4 signing protocol by using the - AWS account credentials given in the method parameters. The resulting signature is added - to the request headers as 'Authorization'. Parameters supplied in the request, either in - the resource path as a query string or in the Parameters collection must not have been - uri encoded. If they have, use the SignRequest method to obtain a signature. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. - - - Client configuration data encompassing the service call (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text. - - - If any problems are encountered while signing the request. - - - - - Calculates and signs the specified request using the AWS4 signing protocol by using the - AWS account credentials given in the method parameters. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. - - - Client configuration data encompassing the service call (notably authentication - region, endpoint and service name). - - - Metrics for the request. - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text. - - - If any problems are encountered while signing the request. - - - Parameters passed as part of the resource path should be uri-encoded prior to - entry to the signer. Parameters passed in the request.Parameters collection should - be not be encoded; encoding will be done for these parameters as part of the - construction of the canonical request. - - - - - Sets the AWS4 mandated 'host' and 'x-amz-date' headers, returning the date/time that will - be used throughout the signing process in various elements and formats. - - The current set of headers - - Date and time used for x-amz-date, in UTC - - - - Sets the AWS4 mandated 'host' and 'x-amz-date' headers, accepting and returning the date/time that will - be used throughout the signing process in various elements and formats. - - The current set of headers - - - Date and time used for x-amz-date, in UTC - - - - Computes and returns an AWS4 signature for the specified canonicalized request - - - - - - - - - - - - Computes and returns an AWS4 signature for the specified canonicalized request - - - - - - - - - - - - - Computes and returns an AWS4 signature for the specified canonicalized request - - - - - - - - - - - - - - Formats the supplied date and time for use in AWS4 signing, where various formats are used. - - - The required format - The UTC date/time in the requested format - - - - Compute and return the multi-stage signing key for the request. - - The clear-text AWS secret key, if not held in secureKey - The region in which the service request will be processed - Date of the request, in yyyyMMdd format - The name of the service being called by the request - Computed signing key - - - - If the caller has already set the x-amz-content-sha256 header with a pre-computed - content hash, or it is present as ContentStreamHash on the request instance, return - the value to be used in request canonicalization. - If not set as a header or in the request, attempt to compute a hash based on - inspection of the style of the request content. - - - - The computed hash, whether already set in headers or computed here. Null - if we were not able to compute a hash. - - - - - If signPayload is false set the x-amz-content-sha256 header to - the UNSIGNED-PAYLOAD magic string and return it. - Otherwise, if the caller has already set the x-amz-content-sha256 header with a pre-computed - content hash, or it is present as ContentStreamHash on the request instance, return - the value to be used in request canonicalization. - If not set as a header or in the request, attempt to compute a hash based on - inspection of the style of the request content. - - - - - The computed hash, whether already set in headers or computed here. Null - if we were not able to compute a hash. - - - - - Returns the HMAC256 for an arbitrary blob using the specified key - - - - - - - - Returns the HMAC256 for an arbitrary blob using the specified key - - - - - - - - Compute and return the hash of a data blob using the specified key - - Algorithm to use for hashing - Hash key - Data blob - Hash of the data - - - - Compute and return the hash of a data blob using the specified key - - Algorithm to use for hashing - Hash key - Data blob - Hash of the data - - - - Computes the non-keyed hash of the supplied data - - - - - - - Computes the non-keyed hash of the supplied data - - - - - - - Computes and returns the canonical request - - The endpoint URL - the path of the resource being operated on - The http method used for the request - The full request headers, sorted into canonical order - The query parameters for the request - - The hash of the binary request body if present. If not supplied, the routine - will look for the hash as a header on the request. - - Canonicalised request as a string - - - - Computes and returns the canonical request - - The endpoint URL - the path of the resource being operated on - The http method used for the request - The full request headers, sorted into canonical order - The query parameters for the request - - The path resource values lookup to use to replace the keys within resourcePath - The hash of the binary request body if present. If not supplied, the routine - will look for the hash as a header on the request. - - The version of the marshaller that constructed the request object. - Canonicalised request as a string - - - - Reorders the headers for the request for canonicalization. - - The set of proposed headers for the request - List of headers that must be included in the signature - For AWS4 signing, all headers are considered viable for inclusion - - - - Computes the canonical headers with values for the request. Only headers included in the signature - are included in the canonicalization process. - - All request headers, sorted into canonical order - Canonicalized string of headers, with the header names in lower case. - - - - Returns the set of headers included in the signature as a flattened, ;-delimited string - - The headers included in the signature - Formatted string of header names - - - - Collects the subresource and query string parameters into one collection - ready for canonicalization - - The in-flight request being signed - The fused set of parameters - - - - Computes and returns the canonicalized query string, if query parameters have been supplied. - Parameters with no value will be canonicalized as 'param='. The expectation is that parameters - have not already been url encoded prior to canonicalization. - - The set of parameters being passed on the uri - - Parameters must be uri encoded into the canonical request and by default the signer expects - that the supplied collection contains non-encoded data. Set this to false if the encoding was - done prior to signer entry. - - The uri encoded query string parameters in canonical ordering - - - - Computes and returns the canonicalized query string, if query parameters have been supplied. - Parameters with no value will be canonicalized as 'param='. The expectation is that parameters - have not already been url encoded prior to canonicalization. - - The set of parameters to be encoded in the query string - - Parameters must be uri encoded into the canonical request and by default the signer expects - that the supplied collection contains non-encoded data. Set this to false if the encoding was - done prior to signer entry. - - The uri encoded query string parameters in canonical ordering - - - - Returns the request parameters in the form of a query string. - - The request instance - Request parameters in query string format - - - - AWS4 protocol signer for Amazon S3 presigned urls. - - - - - Calculates and signs the specified request using the AWS4 signing protocol by using the - AWS account credentials given in the method parameters. The resulting signature is added - to the request headers as 'Authorization'. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. - - - Adding supporting data for the service call required by the signer (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text - - - If any problems are encountered while signing the request. - - - - - Calculates the AWS4 signature for a presigned url. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. If the Expires parameter - is present, it is renamed to 'X-Amz-Expires' before signing. - - - Adding supporting data for the service call required by the signer (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text - - - If any problems are encountered while signing the request. - - - Parameters passed as part of the resource path should be uri-encoded prior to - entry to the signer. Parameters passed in the request.Parameters collection should - be not be encoded; encoding will be done for these parameters as part of the - construction of the canonical request. - - - - - Calculates the AWS4 signature for a presigned url. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. If the Expires parameter - is present, it is renamed to 'X-Amz-Expires' before signing. - - - Adding supporting data for the service call required by the signer (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text - - - The service to sign for - - - The region to sign to, if null then the region the client is configured for will be used. - - - If any problems are encountered while signing the request. - - - Parameters passed as part of the resource path should be uri-encoded prior to - entry to the signer. Parameters passed in the request.Parameters collection should - be not be encoded; encoding will be done for these parameters as part of the - construction of the canonical request. - - The X-Amz-Content-SHA256 is cleared out of the request. - If the request is for S3 then the UNSIGNED_PAYLOAD value is used to generate the canonical request. - If the request isn't for S3 then the empty body SHA is used to generate the canonical request. - - - - - Encapsulates the various fields and eventual signing value that makes up - an AWS4 signature. This can be used to retrieve the required authorization string - or authorization query parameters for the final request as well as hold ongoing - signature computations for subsequent calls related to the initial signing. - - - - - Constructs a new signing result instance for a computed signature - - The access key that was included in the signature - Date/time (UTC) that the signature was computed - The collection of headers names that were included in the signature - Formatted 'scope' value for signing (YYYYMMDD/region/service/aws4_request) - Returns the key that was used to compute the signature - Computed signature - - - - The access key that was used in signature computation. - - - - - ISO8601 formatted date/time that the signature was computed - - - - - ISO8601 formatted date that the signature was computed - - - - - The ;-delimited collection of header names that were included in the signature computation - - - - - Formatted 'scope' value for signing (YYYYMMDD/region/service/aws4_request) - - - - - Returns a copy of the key that was used to compute the signature - - - - - Returns the hex string representing the signature - - - - - Returns a copy of the byte array containing the signature - - - - - Returns the signature in a form usable as an 'Authorization' header value. - - - - - Returns the signature in a form usable as a set of query string parameters. - - - - - Null Signer which does a no-op. - - - - - Signs the specified request with the AWS2 signing protocol by using the - AWS account credentials given in the method parameters. - - The AWS public key - The AWS secret key used to sign the request in clear text - Request metrics - The configuration that specifies which hashing algorithm to use - The request to have the signature compute for - If any problems are encountered while signing the request - - - - S3 signer constructor - - - - - S3 signer constructor - - - - - This exception is thrown if there are problems signing the request. - - - - - Collection used to indicate if the property was initialized was created by the SDK. - - - - - - Collection used to indicate if the property was initialized was created by the SDK. - - - - - - - Default implementation of the IRequest interface. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Constructs a new DefaultRequest with the specified service name and the - original, user facing request object. - - The orignal request that is being wrapped - The service name - - - - The name of the request - - - - - Gets and sets the type of http request to make, whether it should be POST,GET or DELETE - - - - - Gets and sets a flag that indicates whether the request is sent as a query string instead of the request body. - - - - - Returns the original, user facing request object which this internal - request object is representing. - - - - - Returns a dictionary of the headers included in this request. - - - - - Returns a dictionary of the parameters included in this request. - - - - - Collection of parameters included in this request. - - - - - Returns the subresources that should be appended to the resource path. - This is used primarily for Amazon S3, where object keys can contain '?' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new null entry to the SubResources collection for the request - - The name of the subresource - - - - Adds a new entry to the SubResources collection for the request - - The name of the subresource - Value of the entry - - - - Gets and Sets the endpoint for this request. - - - - - Gets and Sets the resource path added on to the endpoint. - - - - - Returns the path resources that should be used within the resource path. - This is used for services where path keys can contain '/' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new entry to the PathResources collection for the request - - The name of the pathresource with potential greedy syntax: {key+} - Value of the entry - - - - Gets and Sets the version number for the marshaller used to create this request. The version number - is used to support backward compatible changes that would otherwise be breaking changes when a - newer core is used with an older service assembly. - Versions: - 1 - Default version - 2 - Support for path segments - - - - - Gets and Sets the content for this request. - - - - - Flag that signals that Content was and should be set - from the Parameters collection. - - - - - Gets and sets the content stream. - - - - - Gets and sets the original stream position. - If ContentStream is null or does not support seek, this propery - should be equal to -1. - - - - - Computes the SHA 256 hash of the content stream. If the stream is not - seekable, it searches the parent stream hierarchy to find a seekable - stream prior to computation. Once computed, the hash is cached for future - use. If a suitable stream cannot be found to use, null is returned. - - - - - The name of the service to which this request is being sent. - - - - - Alternate endpoint to use for this request, if any. - - - - - Host prefix value to prepend to the endpoint for this request, if any. - - - - - Gets and sets the Suppress404Exceptions property. If true then 404s return back from AWS will not cause an exception and - an empty response object will be returned. - - - - - If using AWS4 signing protocol, contains the resultant parts of the - signature that we may need to make use of if we elect to do a chunked - encoding upload. - - - - - Determine whether to use a chunked encoding upload for the request - (applies to Amazon S3 PutObject and UploadPart requests only). - - - - - - Used for Amazon S3 requests where the bucket name is removed from - the marshalled resource path into the host header. To comply with - AWS2 signature calculation, we need to recover the bucket name - and include it in the resource canonicalization, which we do using - this field. - - - - - This flag specifies if SigV4 is required for the current request. - - - - - The authentication region to use for the request. - Set from Config.AuthenticationRegion. - - - - - The region in which the service request was signed. - - - - - Checks if the request stream can be rewinded. - - Returns true if the request stream can be rewinded , - else false. - - - - Returns true if the request can contain a request body, else false. - - Returns true if the currect request can contain a request body, else false. - - - - Returns true if the request has a body, else false. - - Returns true if the request has a body, else false. - - - - Class containing the data for one endpoint returned from a endpoint discovery request - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Constructs a new DiscoveryEndpoint - - The address of the endpoint - The cache period for the endpoint in minutes - - - - The address of the endpoint. - - - - - The cache period for the endpoint in minutes - - - - - Calculates if this endpoint has expired - - A boolean value indicating if the cache period has expired - - - - Extends the endpoint expiration by the specified number of minutes from now. - - - - - Class containing the data for one endpoint returned from a endpoint discovery request - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class containing the data to use with endpoint discovery - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Gets/sets and flag indicating if endpoint discovery is required for the request. - - - - - Sorted dictionary of the identifiers that must be sent with the endpoint discovery request. These - identifiers are used to construct the cache key for the cache that stores discovered endpoints. A - sorted dictionary is used instead of a dictionary to ensure the cache key comes out in the same order - each time it is constructed. - - - - - Represents the data to be used with endpoint discovery operations - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class used to resolve endpoints using Endpoint Discovery. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Method that performs endpoint discovery for the current operation - - Context information used in calculations for endpoint discovery - The operation to fetch endpoints from the server - - - - - Gets the number of cache keys in the cache - - - - - Class used to resolve endpoints using Endpoint Discovery. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class containing context information to use with endpoint discovery - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Gets the customer credential information. - - - - - Gets the operation name. - - - - - Gets the current marshalled endpoint discovery data. - - - - - Gets the flag indicating if the specified key should be evicted from the cache. - - - - - Gets the Uri that should be evicted if EvictCacheKey is set to true. - - - - - Class containing context information to use with endpoint discovery - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Error type, one of Sender, Receiver, Unknown - Only applies to XML-based services. - - - - - Name of the exception class to return - - - - - Error message - - - - - RequestId of the error. - Only applies to XML-based services. - - - - - Class containing the members used to invoke service calls - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class containing the members used to invoke service calls - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Represents a request being sent to an Amazon Web Service, including the - parameters being sent as part of the request, the endpoint to which the - request should be sent, etc. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - The name of the request - - - - - Returns a dictionary of the headers included in this request. - - - - - Gets and sets a flag that indicates whether the request is sent as a query string instead of the request body. - - - - - Returns a dictionary of the parameters included in this request. - - - - - Collection of parameters included in this request. - - - - - Returns the subresources that should be appended to the resource path. - This is used primarily for Amazon S3, where object keys can contain '?' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new null entry to the SubResources collection for the request - - The name of the subresource - - - - Adds a new entry to the SubResources collection for the request - - The name of the subresource - Value of the entry - - - - Gets and sets the type of http request to make, whether it should be POST,GET or DELETE - - - - - Gets and Sets the endpoint for this request. - - - - - Gets and Sets the resource path added on to the endpoint. - - - - - Returns the path resources that should be used within the resource path. - This is used for services where path keys can contain '/' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new entry to the PathResources collection for the request - - The name of the pathresource with potential greedy syntax: {key+} - Value of the entry - - - - Gets and Sets the version number for the marshaller used to create this request. The version number - is used to support backward compatible changes that would otherwise be breaking changes when a - newer core is used with an older service assembly. - - - - - Gets and Sets the content for this request. - - - - - Gets the header value from the request. - - - - - Flag that signals that Content was and should be set - from the Parameters collection. - - - - - Gets and sets the content stream. - - - - - Gets and sets the original stream position. - If ContentStream is null or does not support seek, this propery - should be equal to -1. - - - - - Computes the SHA 256 hash of the content stream. If the stream is not - seekable, it searches the parent stream hierarchy to find a seekable - stream prior to computation. Once computed, the hash is cached for future - use. - - - - - The name of the service to which this request is being sent. - - - - - Returns the original, user facing request object which this internal - request object is representing. - - - - - Alternate endpoint to use for this request, if any. - - - - - Host prefix value to prepend to the endpoint for this request, if any. - - - - - Gets and sets the Suppress404Exceptions property. If true then 404s return back from AWS will not cause an exception and - an empty response object will be returned. - - - - - If using AWS4 signing protocol, contains the resultant parts of the - signature that we may need to make use of if we elect to do a chunked - encoding upload. - - - - - Determine whether to use a chunked encoding upload for the request - (applies to Amazon S3 PutObject and UploadPart requests only). - - - - - - Used for Amazon S3 requests where the bucket name is removed from - the marshalled resource path into the host header. To comply with - AWS2 signature calculation, we need to recover the bucket name - and include it in the resource canonicalization, which we do using - this field. - - - - - This flag specifies if SigV4 is required for the current request. - - - - - The authentication region to use for the request. - Set from Config.AuthenticationRegion. - - - - - The region in which the service request was signed. - - - - - Checks if the request stream can be rewinded. - - Returns true if the request stream can be rewinded , - else false. - - - - Returns true if the request can contain a request body, else false. - - Returns true if the currect request can contain a request body, else false. - - - - Returns true if the request has a body, else false. - - Returns true if the request has a body, else false. - - - - Gets the value of the Service Id. - - - - - Gets the dictionary that gives mapping of renamed operations - - - - - IDictionary{String, String} access to ParameterCollection. - TODO: remove this class in version 3.4 of the SDK. - - - - - Constructs ParametersDictionaryFacade for a ParameterCollection - - - - - - A registry of object that will manipulate the runtime pipeline used by service clients. - - - - - Registers a customizer that will be applied for all service clients created. Each customizer has a unique name associated with it. If a customizer is registered more - than once with the same unique name then the calls after the first will be ignored. - - - - - - Deregistered the runtime pipeline customizer - - - - - - Deregistered the runtime pipeline customizer - - - - - - Applies all of the registered customizers on the runtime pipeline - - The service clients runtime pipeline. - Type object for the service client being created - - - - Interface for objects that will customize the runtime pipleine for newly created service clients. - - - - - The unique name for the customizer that identifies the customizer in the registry. The name is also used to identify the customizer on the SDK logs. - - - - - Called on service clients as they are being constructed to customize their runtime pipeline. - - - Type object for the service client being created - - - - Default ServiceMetadata implementation. - This implementation will be used if the service doesn't have a - IServiceMetadata implementation. - - - - - Gets the value of the Service Id. - - - - - Gets the dictionary that gives mapping of renamed operations - - - - - Response Unmarshaller for all Errors - - - - - Build an ErrorResponse from XML - - The XML parsing context. - Usually an Amazon.Runtime.Internal.UnmarshallerContext. - An ErrorResponse object. - - - - Return an instance of and ErrorResponseUnmarshaller. - - - - - - Interface for unmarshallers which unmarshall service responses. - The Unmarshallers are stateless, and only encode the rules for what data - in the XML stream goes into what members of an object. - - The type of object the unmarshaller returns - The type of the XML unmashaller context, which contains the - state of parsing the XML stream. Uaually an instance of - Amazon.Runtime.Internal.Transform.UnmarshallerContext. - - - - Extracts an exeption with data from an ErrorResponse. - - The XML parsing context. - An inner exception to be included with the returned exception - The HttpStatusCode from the ErrorResponse - Either an exception based on the ErrorCode from the ErrorResponse, or the - general service exception for the service in question. - - - - Interface for unmarshallers which unmarshall objects from response data. - The Unmarshallers are stateless, and only encode the rules for what data - in the XML stream goes into what members of an object. - - The type of object the unmarshaller returns - The type of the XML unmashaller context, which contains the - state during parsing of the XML stream. Usually an instance of - Amazon.Runtime.Internal.Transform.UnmarshallerContext. - - - - Given the current position in the XML stream, extract a T. - - The XML parsing context - An object of type T populated with data from the XML stream. - - - - Response Unmarshaller for all Errors - - - - - Build an ErrorResponse from json - - The json parsing context. - Usually an Amazon.Runtime.Internal.JsonUnmarshallerContext. - An ErrorResponse object. - - - - Return an instance of JsonErrorResponseUnmarshaller. - - - - - - Wraps a json string for unmarshalling. - - Each Read() operation gets the next token. - TestExpression() is used to match the current key-chain - to an xpath expression. The general pattern looks like this: - - JsonUnmarshallerContext context = new JsonUnmarshallerContext(jsonString); - while (context.Read()) - { - if (context.IsKey) - { - if (context.TestExpresion("path/to/element")) - { - myObject.stringMember = stringUnmarshaller.GetInstance().Unmarshall(context); - continue; - } - } - } - - - - - - Wrap the jsonstring for unmarshalling. - - Stream that contains the JSON for unmarshalling - If set to true, maintains a copy of the complete response body as the stream is being read. - Response data coming back from the request - - - - Are we at the start of the json document. - - - - - Is the current token the end of an object - - - - - Is the current token the start of an object - - - - - Returns the element depth of the parser's current position in the json - document being parsed. - - - - - The current Json path that is being unmarshalled. - - - - - Reads to the next token in the json document, and updates the context - accordingly. - - - True if a token was read, false if there are no more tokens to read. - - - - - Peeks at the next token. This peek implementation - reads the next token and makes the subsequent Read() return the same data. - If Peek is called successively, it will return the same data. - Only the first one calls Read(), subsequent calls - will return the same data until a Read() call is made. - - Token to peek. - Returns true if the peeked token matches given token. - - - - Returns the text contents of the current token being parsed. - - - The text contents of the current token being parsed. - - - - - The type of the current token - - - - - Get the base stream of the jsonStream. - - - - - Peeks at the next (non-whitespace) character in the jsonStream. - - The next (non-whitespace) character in the jsonStream, or -1 if at the end. - - - - Peeks at the next character in the stream. - If the data isn't buffered into the StreamReader (Peek() returns -1), - we flush the buffered data and try one more time. - - - - - - Abstract class for unmarshalling service responses. - - - - - Class for unmarshalling XML service responses. - - - - - Class for unmarshalling EC2 service responses. - - - - - Class for unmarshalling JSON service responses. - - - - - Unmarshaller for int fields - - - - - Unmarshaller for nullable int fields. Implemented only for JSON context - to handle cases where value can be null e.g. {'Priority': null}. - This unmarshaller is not implemented for XML context, as XML responses - will null elements (xsi:nil='true') will be skipped by the XML parser. - - - - - Unmarshaller for long fields - - - - - Unmarshaller for float fields - - - - - Unmarshaller for double fields - - - - - Unmarshaller for decimal fields - - - - - Unmarshaller for bool fields - - - - - Unmarshaller for string fields - - - - - Unmarshaller for byte fields - - - - - Unmarshaller for DateTime fields - - - - - Unmarshalls given string as a DateTime. Handles cases where we want to unmarshall - as just a DateTime or a nullable Datetime. - - Value to be parsed - If true, the method will return null if text is null. - If false, the method will return default(DateTime), if text is null. - - - - - Unmarshaller for nullable DateTime fields. Implemented only for JSON context - to handle cases where value can be null e.g. {'Priority': null}. - This unmarshaller is not implemented for XML context, as XML responses - will null elements (xsi:nil='true') will be skipped by the XML parser. - - - - - Unmarshaller for MemoryStream fields - - - - - Unmarshaller for ResponseMetadata - - - - - Base class for the UnmarshallerContext objects that are used - to unmarshall a web-service response. - - - - - Tests the specified expression against the current position in the XML - document - - The pseudo-XPath expression to test. - - True if the expression matches the current position in the document, - false otherwise. - - - - Tests the specified expression against the current position in the XML - document being parsed, and restricts the expression to matching at the - specified stack depth. - - The pseudo-XPath expression to test. - - The depth in the stack representing where the expression must - start matching in order for this method to return true. - - True if the specified expression matches the current position in - the XML document, starting from the specified depth. - - - - Reads the next token at depth greater than or equal to target depth. - - Tokens are read at depth greater than or equal to target depth. - True if a token was read and current depth is greater than or equal to target depth. - - - - The current path that is being unmarshalled. - - - - - Returns the element depth of the parser's current position in the - document being parsed. - - - - - Reads to the next node in the document, and updates the context accordingly. - - - True if a node was read, false if there are no more elements to read. - - - - - Returns the text contents of the current element being parsed. - - - The text contents of the current element being parsed. - - - - - True if NodeType is Element. - - - - - True if NodeType is EndElement. - - - - - True if the context is at the start of the document. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Wrap an XmltextReader for simulating an event stream. - - Each Read() operation goes either to the next element or next attribute within - the current element. TestExpression() is used to match the current event - to an xpath expression. The general pattern looks like this: - - UnmarshallerContext context = new UnmarshallerContext(...); - while (context.Read()) - { - if (context.TestExpresion("path/to/element")) - { - myObject.stringMember = stringUnmarshaller.GetInstance().Unmarshall(context); - continue; - } - if (context.TestExpression("path/to/@attribute")) - myObject.MyComplexTypeMember = MyComplexTypeUnmarshaller.GetInstance().Unmarshall(context); - } - - - - - - Wrap an XmlTextReader with state for event-based parsing of an XML stream. - - Stream with the XML from a service response. - If set to true, maintains a copy of the complete response body as the stream is being read. - Response data coming back from the request - - - - The current XML path that is being unmarshalled. - - - - - Returns the element depth of the parser's current position in the XML - document being parsed. - - - - - Reads to the next node in the XML document, and updates the context accordingly. - - - True if a node was read, false if there are no more elements to read./ - - - - - Returns the text contents of the current element being parsed. - - - The text contents of the current element being parsed. - - - - - True if NodeType is Element. - - - - - True if NodeType is EndElement. - - - - - True if the context is at the start of the document. - - - - - True if NodeType is Attribute. - - - - - Wrap an XmlTextReader with state for event-based parsing of an XML stream. - - Stream with the XML from a service response. - If set to true, maintains a copy of the complete response body as the stream is being read. - Response data coming back from the request - - - - RequestId value, if found in response - - - - - Reads to the next node in the XML document, and updates the context accordingly. - If node is RequestId, reads the contents and stores in RequestId property. - - - True if a node was read, false if there are no more elements to read./ - - - - - A stream which caches the contents of the underlying stream as it reads it. - - - - - All the bytes read by the stream. - - - - - Initializes the CachingWrapperStream with a base stream. - - The stream to be wrapped. - Maximum number of bytes to be cached. - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Gets a value indicating whether the current stream supports seeking. - CachingWrapperStream does not support seeking, this will always be false. - - - - - Gets or sets the position within the current stream. - CachingWrapperStream does not support seeking, attempting to set Position - will throw NotSupportedException. - - - - - Sets the position within the current stream. - CachingWrapperStream does not support seeking, attempting to call Seek - will throw NotSupportedException. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Stream wrapper that double-buffers from a wrapped stream and - returns the buffered content as a series of signed 'chunks' - for the AWS4 ('Signature V4') protocol. - - - - - Reads some or all of the processed chunk to the consumer, constructing - and streaming a new chunk if more input data is available. - - - - - - - - - Results of the header-signing portion of the request - - - - - Computed signature of the chunk prior to the one in-flight, in - hex - - - - - Computes the derived signature for a chunk of data of given length in the input buffer, - placing a formatted chunk with headers, signature and data into the output buffer - ready for streaming back to the consumer. - - - - - - Length override to return the true length of the payload plus the metainfo - supplied with each chunk - - - - - Computes the total size of the data payload, including the chunk metadata. - Called externally so as to be able to set the correct Content-Length header - value. - - - - - - - Computes the size of the header data for each chunk. - - - - - - - Attempt to read sufficient data for a whole chunk from the wrapped stream, - returning the number of bytes successfully read to be processed into a chunk - - - - - A list object that will always be sent to AWS services, - even if it is empty. - The AWS .NET SDK does not send empty collections to services, unless - the collection is of this type. - - - - - - A dictionary object that will always be sent to AWS services, - even if it is empty. - The AWS .NET SDK does not send empty collections to services, unless - the collection is of this type. - - - - - - - A wrapper stream that decrypts the base stream as it - is being read. - - - - - Initializes an DecryptStream with an decryption algorithm and a base stream. - - Stream to perform encryption on.. - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Gets a value indicating whether the current stream supports seeking. - DecryptStream does not support seeking, this will always be false. - - - - - Gets or sets the position within the current stream. - DecryptStream does not support seeking, attempting to set Position - will throw NotSupportedException. - - - - - Sets the position within the current stream. - DecryptStream does not support seeking, attempting to call Seek - will throw NotSupportedException. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Validates the underlying stream. - - - - - A wrapper stream that decrypts the base stream as it - is being read. - - - - - Initializes an DecryptStream with an decryption algorithm and a base stream. - - Stream to perform encryption on.. - Symmetric key to perform decryption - Initialization vector to perform decryption - - - - A wrapper stream that decrypts the base stream using AES algorithm as it - is being read. - - - - - Initializes an AESDecryptionStream with a base stream. - - Stream to perform decryption on.. - Symmetric key to perform decryption - Initialization vector to perform decryption - - - - Class to perform actions on a background thread. - Uses a single background thread and performs actions - on it in the order the data was sent through the instance. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Class to invoke actions on a background thread. - Uses a single background thread and invokes actions - on it in the order they were invoked through the instance. - - - - - A wrapper stream that encrypts the base stream as it - is being read. - - - - - Initializes an EncryptStream with an encryption algorithm and a base stream. - - Stream to perform encryption on.. - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Gets a value indicating whether the current stream supports seeking. - - - - - Returns encrypted content length. - - - - - Gets or sets the position within the current stream. - - - - - Sets the position within the current stream. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Validates the underlying stream. - - - - - A wrapper stream that encrypts the base stream as it - is being read. - - - - - Initializes an EncryptStream with an encryption algorithm and a base stream. - - Stream to perform encryption on.. - Symmetric key to perform encryption - Initialization vector to perform encryption - - - - A wrapper stream that encrypts the base stream using AES algorithm as it - is being read. - - - - - Initializes an AESEncryptionStream with a base stream. - - Stream to perform encryption on.. - Symmetric key to perform encryption - Initialization vector to perform encryption - - - - A wrapper stream that encrypts the base stream as it - is being read. - - - - - Initializes an EncryptStream for Multipart uploads with an encryption algorithm and a base stream. - - Stream to perform encryption on.. - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Gets a value indicating whether the current stream supports seeking. - - - - - Returns encrypted content length. - - - - - Gets or sets the position within the current stream. - - - - - Sets the position within the current stream. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Validates the underlying stream. - - - - - A wrapper stream that encrypts the base stream as it - is being read. - - - - - Initializes an EncryptStream with an encryption algorithm and a base stream. - - Stream to perform encryption on.. - Symmetric key to perform encryption - Initialization vector to perform encryption - - - - A wrapper stream that encrypts the base stream as it - is being read. - - - - - Initializes an AESEncryptionStream with a base stream. - - Stream to perform encryption on.. - Symmetric key to perform encryption - Initialization vector to perform encryption - - - - Returns true if the Content is set or there are - query parameters. - - This request - True if data is present; false otherwise. - - - - Utilities for dealing with Guids - - - - - Hashes a set of objects. - - - - - - - Combines a set of hashses. - - - - - - - Combines two hashes. - - - - - - - - Disposes of all managed and unmanaged resources. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - A wrapper stream that calculates a hash of the base stream as it - is being read. - The calculated hash is only available after the stream is closed or - CalculateHash is called. After calling CalculateHash, any further reads - on the streams will not change the CalculatedHash. - If an ExpectedHash is specified and is not equal to the calculated hash, - Close or CalculateHash methods will throw an AmazonClientException. - If CalculatedHash is calculated for only the portion of the stream that - is read. - - - Exception thrown during Close() or CalculateHash(), if ExpectedHash is set and - is different from CalculateHash that the stream calculates, provided that - CalculatedHash is not a zero-length byte array. - - - - - Algorithm to use to calculate hash. - - - - - True if hashing is finished and no more hashing should be done; - otherwise false. - - - - - Current position in the stream. - - - - - Calculated hash for the stream. - This value is set only after the stream is closed. - - - - - Expected hash value. Compared against CalculatedHash upon Close(). - If the hashes are different, an AmazonClientException is thrown. - - - - - Expected length of stream. - - - - - Initializes an HashStream with a hash algorithm and a base stream. - - Stream to calculate hash for. - - Expected hash. Will be compared against calculated hash on stream close. - Pass in null to disable check. - - - Expected length of the stream. If the reading stops before reaching this - position, CalculatedHash will be set to empty array. - - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Gets a value indicating whether the current stream supports seeking. - HashStream does not support seeking, this will always be false. - - - - - Gets or sets the position within the current stream. - HashStream does not support seeking, attempting to set Position - will throw NotSupportedException. - - - - - Sets the position within the current stream. - HashStream does not support seeking, attempting to call Seek - will throw NotSupportedException. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Gets the overridden length used to construct the HashStream - - - - - Calculates the hash for the stream so far and disables any further - hashing. - - - - - Resets the hash stream to starting state. - Use this if the underlying stream has been modified and needs - to be rehashed without reconstructing the hierarchy. - - - - - Validates the underlying stream. - - - - - Compares two hashes (arrays of bytes). - - Expected hash. - Actual hash. - - True if the hashes are identical; otherwise false. - - - - - A wrapper stream that calculates a hash of the base stream as it - is being read or written. - The calculated hash is only available after the stream is closed or - CalculateHash is called. After calling CalculateHash, any further reads - on the streams will not change the CalculatedHash. - If an ExpectedHash is specified and is not equal to the calculated hash, - Close or CalculateHash methods will throw an AmazonClientException. - If base stream's position is not 0 or HashOnReads is true and the entire stream is - not read, the CalculatedHash will be set to an empty byte array and - comparison to ExpectedHash will not be made. - - - Exception thrown during Close() or CalculateHash(), if ExpectedHash is set and - is different from CalculateHash that the stream calculates, provided that - CalculatedHash is not a zero-length byte array. - - - - - Initializes an HashStream with a hash algorithm and a base stream. - - Stream to calculate hash for. - - Expected hash. Will be compared against calculated hash on stream close. - Pass in null to disable check. - - - Expected length of the stream. If the reading stops before reaching this - position, CalculatedHash will be set to empty array. - - - - - A wrapper stream that calculates an MD5 hash of the base stream as it - is being read or written. - The calculated hash is only available after the stream is closed or - CalculateHash is called. After calling CalculateHash, any further reads - on the streams will not change the CalculatedHash. - If an ExpectedHash is specified and is not equal to the calculated hash, - Close or CalculateHash methods will throw an AmazonClientException. - If base stream's position is not 0 or HashOnReads is true and the entire stream is - not read, the CalculatedHash will be set to an empty byte array and - comparison to ExpectedHash will not be made. - - - Exception thrown during Close() or CalculateHash(), if ExpectedHash is set and - is different from CalculateHash that the stream calculates, provided that - CalculatedHash is not a zero-length byte array. - - - - - Initializes an MD5Stream with a base stream. - - Stream to calculate hash for. - - Expected hash. Will be compared against calculated hash on stream close. - Pass in null to disable check. - - - Expected length of the stream. If the reading stops before reaching this - position, CalculatedHash will be set to empty array. - - - - - Utilities for validating label values for host prefix templates - - - - - Validates a label value - - - - - Provides read/write access to a file in the INI format. - - This class is not threadsafe. - - - - - Construct a new IniFile. - - path of the IniFile - - - - the path of the file - - - - - helper to access the lines of the file - - - - - Persist the changes to this INI file to disk. - - - - - Rename the section fromSectionName to toSectionName - - - - - - - Rename the section fromSectionName to toSectionName - - - - if true and destination section already exists overwrite it - - - - Copy the section fromSectionName to toSectionName - - - - Any properties in the original section that are also in this dictionary will - be replaced by the value from this dictionary. - - - - Copy the section fromSectionName to toSectionName - - - - Any properties in the original section that are also in this dictionary will - be replaced by the value from this dictionary. - if true and destination section already exists overwrite it - - - - Update the section with the properties given. - If the section doesn't exist, it will be appended to the file. - - Notes: - 1. Any properties that do exist in the section will be updated. - 2. A null value for a property denotes that it should be deleted from the section - 3. If any properties don't exist they will be appended to the end of the section - in the same order they appear in the SortedDictionary. - - name of the section to operate on - properties to add/update/delete - - - - Check if the section exists. If not, append it to the end of the file. - - section to ensure exists - - - - If the section exists, delete it from the INI file. - - section to delete - - - - Determine if a section exists in the INI file. - - name of section to look for - true if the section exists, false otherwise - - - - Return the properties for the section if it exists. - - name of section to get - properties contained in the section - True if the section was found, false otherwise - - - - Return the properties for the section if it exists. - - Regex to match name of section to get - properties contained in the section - True if the section was found, false otherwise - - - - Return the properties for the section if it exists. - - Regex to match name of section to get - name of section if regex matches - properties contained in the section - True if the section was found, false otherwise - - - - Simple wrapper around the log4net Error method. - - - - - - - - Write debug message to Console - - - - - - - - Write debug message to Console - - - - - - - Simple wrapper around the log4net InfoFormat method. - - - - - - - This is a dynamic wrapper around log4net so we can avoid log4net being required - to be distributed with the SDK. - - - - - Abstract logger class, base for any custom/specific loggers. - - - - - Flushes the logger contents. - - - - - Simple wrapper around the log4net IsErrorEnabled property. - - - - - Simple wrapper around the log4net IsDebugEnabled property. - - - - - Simple wrapper around the log4net IsInfoEnabled property. - - - - - Simple wrapper around the log4net Error method. - - - - - - - - Simple wrapper around the log4net Debug method. - - - - - - - - Simple wrapper around the log4net DebugFormat method. - - - - - - - Simple wrapper around the log4net InfoFormat method. - - - - - - - Logger wrapper for reflected log4net logging methods. - - - - - This should be a one time call to use reflection to find all the types and methods - needed for the logging API. - - - - - Simple wrapper around the log4net IsErrorEnabled property. - - - - - Simple wrapper around the log4net Error method. - - - - - - - - Simple wrapper around the log4net IsDebugEnabled property. - - - - - Simple wrapper around the log4net Debug method. - - - - - - - - Simple wrapper around the log4net DebugFormat method. - - - - - - - Simple wrapper around the log4net IsInfoEnabled property. - - - - - Simple wrapper around the log4net InfoFormat method. - - - - - - - A single logged message - - - - - Log message arguments. - - - - - Culture-specific formatting provider. - - - - - Log message format. - - - - - a size-limited cache of key value pairs - - Once the maximum size has been reached, the least recently - used pairs will be evicted to make room for any new items. - - - - - - - the maximum number of entries this LruCache will hold - before items begin getting evicted - - - - - the number of items in the cache - - - - - Construct a new LruCache. - - maximum number of entries before items are evicted - - - - Add the key/value pair to the cache, or update - the value if the key already exists. - - If the cache is full, evicts the least recently used item. - - - - - - - Evicts a specific key out of the cache if it exists - - the key to evict from the cache - - - - Try to get the value associated with the key. - - the key to look up - the value, if the key exists - true if there is a value associated with the key, or false if no value is associated with the key - - - - Try to get the value associated with the key, if it doesn't exist, use the provided factory method to - create a new value and tries adding it to the cache. - - the key to look up - the factory method used in case the key is not present in the cache - the looked up value or the value created by the factory - - - - Clear the LruCache of all entries. - - - - - Helper class to support LruCache. - Does not implement the error checking and synchronization that - would be necessary for it to stand alone. - - - - - Item to be stored in the LruList - linked list structure. - - - - - Collection of properties being tracked - - - - - Timings for metrics being tracked - - - - - Counters being tracked - - - - - Whether metrics are enabled for the request - - - - - Constructs an empty, disabled metrics object - - - - - Starts timing an event. Logs an exception if an event - of the same type was started but not stopped. - - - - - - - Stops timing an event. Logs an exception if the event wasn't started. - - - - - - - Adds a property for a metric. If there are multiple, the - object is added as a new item in a list. - - - - - - - Sets a counter for a specific metric. - - - - - - - Increments a specific metric counter. - If counter doesn't exist yet, it is set to 1. - - - - - - Returns errors associated with the metric, including - if there are still any timing events in-flight. - - - - - - Returns a string representation of the current metrics. - - - - - - Return a JSON represenation of the current metrics - - - - - - Timing information for a metric - - - - - Empty, stopped timing object - - - - - Timing object in a started state - - - - - - Stops timing - - - - - - Whether the timing has been stopped - - - - - Elapsed ticks from start to stop. - If timing hasn't been stopped yet, returns 0. - - - - - Elapsed time from start to stop. - If timing hasn't been stopped yet, returns TimeSpan.Zero - - - - - Timing event, stops timing of a metric when disposed - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - The destructor for the client class. - - - - - A wrapper stream which supresses disposal of the underlying stream. - - - - - Constructor for NonDisposingWrapperStream. - - The base stream to wrap. - - - - The Dispose implementation for this wrapper stream - does not close the underlying stream. - - - - - Provides line-based read/write access to a file. - The file can be read into memory, changed, then written back to disk. - When the file is persisted back to disk, an optimistic concurrency - check is performed to make sure the file hasn't changed since it was - originally read. - - This class is not threadsafe. - - - - - a full copy of the original file - This is used for optimistic concurrency. - Note that this assumes a small file and does not scale large files. - - - - - path of the file - - - - - Read/write access to the lines that make up the file. - Any changes to this List are persisted back to disk when Persist() is called. - - NOTE: - The lines have the original line endings on them to preserve the - original text as much as possible. - - - - - Construct a new OptimisticLockedTextFile. - - path of the file - - - - Persist changes to disk after an optimistic concurrency check is completed. - - - - - This class is used to wrap a stream for a particular segment of a stream. It - makes that segment look like you are reading from beginning to end of the stream. - - - - - Subclass of IniFile that allows INI sections to be read with the profile keyword in front of the section name. - - - - - Wrapper stream that only supports reading - - - - - Partial wrapper stream that only supports reading - - - - - Uri wrapper that can parse out information (bucket, key, region, style) from an - S3 URI. - - - - - True if the URI contains the bucket in the path, false if it contains the bucket in the authority. - - - - - The bucket name parsed from the URI (or null if no bucket specified). - - - - - The key parsed from the URI (or null if no key specified). - - - - - The region parsed from the URI (or null if no region specified). - - - - - Constructs a parser for the S3 URI specified as a string. - - The S3 URI to be parsed. - - - - Constructs a parser for the S3 URI specified as a Uri instance. - - The S3 URI to be parsed. - - - - Percent-decodes the given string, with a fast path for strings that are not - percent-encoded. - - The string to decode - The decoded string - - - - Percent-decodes the given string. - - The string to decode - The index of the first '%' in the string - The decoded string - - - - Decodes the percent-encoded character at the given index in the string - and appends the decoded value to the string under construction. - - - The string under construction to which the decoded character will be - appended. - - The string being decoded. - The index of the '%' character in the string. - - - - Converts a hex character (0-9A-Fa-f) into its corresponding quad value. - - The hex character - The quad value - - - - Interface for a non-generic cache. - - - - - Clears the entire cache. - - - - - Maximum time to keep an item around after its last use. - - - - - How often should the cache be cleared of old items. - - - - - The number of items in the cache. - - - - - Interface for a generic cache. - - - - - - - Retrieves a value out of the cache or from the source. - - - - - - - - Retrieves a value out of the cache or from the source. - If the item was in the cache, isStaleItem is set to true; - otherwise, if the item comes from the source, isStaleItem is false. - - - - - - - - - Clears a specific value from the cache if it's there. - - - - - - Returns the keys for all items in the cache. - - - - - - Executes specified operation, catches exception, clears the cache for - the given key, retries the operation. - - - - - - - - - - - SDK-wide cache. - Provides access to caches specific to a particular set of credentials - and target region. - - - - - Clear all caches - - - - - Clear all caches of a particular type - - - - - - Retrieve a cache of a specific type for a client object. - The client object can be null in cases where a cache does - not correspond to a specific AWS account or target region. - - - - - - - - - - - Retrieve a cache of a specific type for a client object. - The client object can be null in cases where a cache does - not correspond to a specific AWS account or target region. - - - - - - - - - - - Utilities for converting objects to strings. Used by the marshaller classes. - - - - - Converts a DateTime to ISO8601 formatted string. - - - - - Converts a DateTime to RFC822 formatted string. - - - - - Converts a DateTime to Unix epoch time formatted string. - - - - - A wrapper stream. - - - - - Base stream. - - - - - Initializes WrapperStream with a base stream. - - - - - - Returns the first base non-WrapperStream. - - First base stream that is non-WrapperStream. - - - - Returns the first base non-WrapperStream. - - First base stream that is non-WrapperStream. - - - - Returns the first base non-WrapperStream. - - Potential WrapperStream - Base non-WrapperStream. - - - - Gets a value indicating whether the current stream supports reading. - True if the stream supports reading; otherwise, false. - - - - - Gets a value indicating whether the current stream supports seeking. - True if the stream supports seeking; otherwise, false. - - - - - Gets a value indicating whether the current stream supports writing. - True if the stream supports writing; otherwise, false. - - - - - Closes the current stream and releases any resources (such as sockets and - file handles) associated with the current stream. - - - - - Gets the length in bytes of the stream. - - - - - Gets or sets the position within the current stream. - - - - - Gets or sets a value, in miliseconds, that determines how long the stream - will attempt to read before timing out. - - - - - Gets or sets a value, in miliseconds, that determines how long the stream - will attempt to write before timing out. - - - - - Clears all buffers for this stream and causes any buffered data to be written - to the underlying device. - - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Sets the position within the current stream. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Sets the length of the current stream. - - The desired length of the current stream in bytes. - - - - Writes a sequence of bytes to the current stream and advances the current - position within this stream by the number of bytes written. - - - An array of bytes. This method copies count bytes from buffer to the current stream. - - - The zero-based byte offset in buffer at which to begin copying bytes to the - current stream. - - The number of bytes to be written to the current stream. - - - - This is a utility class to be used in last resort for code paths that are synchronous but need to call an asynchronous method. - This should never be used for methods that are called at high volume as this utility class has a performance cost. For example this - class was added for the refreshing credentials like Cognito which would need to use this about once an hour. - - This code is taken from: http://stackoverflow.com/questions/5095183/how-would-i-run-an-async-taskt-method-synchronously - which is licensed under Creative Commons Attribution-ShareAlike 3.0 (http://creativecommons.org/licenses/by-sa/3.0/) - - - - - Execute's an async Task<T> which has a void return value synchronously - - Task<T> method to execute - - - - Execute's an async Task<T> method which has a T return type synchronously - - Return Type - Task<T> method to execute - - - - - Custom WebProxy implementation that creates a webproxy based on - user inputs(Host name and port number) - - - - - Set the ProxyUri - - - - - Create a Uri based on the user inputs(Host name and port number) - - - - - Proxy Uri property - - - - - Proxy Credentials property - - - - - Getter to fetch the set proxy - - - - - Method to determine if the proxy should be bypassed when accessing an internet source - - - - - This class is no longer used anymore and should be avoided as it is just meant - as a last resort when blending async and sync operations. The code is still - here to support versions before 3.3.9.0 of AWSSDK.DynamoDBv2. - - - - - Collection of parameters that an SDK client will send to a service. - - - - - Constructs empty ParameterCollection. - - - - - Adds a parameter with a string value. - - - - - - - Adds a parameter with a list-of-strings value. - - - - - - - Converts the current parameters into a list of key-value pairs. - - - - - - Property to denote that the last exception returned by an AWS Service - was retryable or not. - - - - - This handler processes exceptions thrown from the HTTP handler and - unmarshalls error responses. - - - - - Default set of exception handlers. - - - - - Default set of exception handlers. - - - - - Constructor for ErrorHandler. - - an ILogger instance. - - - - Handles and processes any exception thrown from underlying handlers. - - The execution context which contains both the - requests and response context. - - - - Handles and processes any exception thrown from underlying handlers. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Disposes the response body. - - The response context. - - - - Processes an exception by invoking a matching exception handler - for the given exception. - - The execution context, it contains the - request and response context. - The exception to be processed. - - This method returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception that may be thrown by exception - processing by a matching exception handler. - - - - - The abstract base class for exception handlers. - - The exception type. - - - - The exception handler for HttpErrorResponseException exception. - - - - - The constructor for HttpErrorResponseExceptionHandler. - - in instance of ILogger. - - - - Handles an exception for the given execution context. - - The execution context, it contains the - request and response context. - The exception to handle. - - Returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception to replace the original exception. - - - - - Checks if a HTTP 404 status code is returned which needs to be suppressed and - processes it. - If a suppressed 404 is present, it unmarshalls the response and returns true to - indicate that a suppressed 404 was processed, else returns false. - - The execution context, it contains the - request and response context. - - - If a suppressed 404 is present, returns true, else returns false. - - - - - A pipeline handler which provides hooks to run - external code in the pre-invoke and post-invoke phases. - - - - - Action to execute on the pre invoke phase. - - - - - Action to execute on the post invoke phase. - - - - - Calls the PreInvoke and PostInvoke methods before and after calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls the PreInvoke and PostInvoke methods before and after calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Executes the OnPreInvoke action as part of pre-invoke. - - The execution context, it contains the - request and response context. - - - - Executes the OnPreInvoke action as part of post-invoke. - - The execution context, it contains the - request and response context. - - - - This handler retrieved the AWS credentials to be used for the current call. - - - - - The constructor for CredentialsRetriever. - - An AWSCredentials instance. - - - - Retrieves the credentials to be used for the current call before - invoking the next handler. - - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - The CSM handler has the logic for capturing data for CSM attempts when enabled. - - - - - Invokes the CSM handler and captures data for the CSM attempts. - - - - - Calls the PreInvoke and PostInvoke methods before and after calling the next handler - in the pipeline. - - - - - Method that gets called in the final clause that captures data for each http request - from the request and response context. - - - - - Executes the OnPreInvoke action as part of pre-invoke. - - - - - Method to collect data in case of connection exception - - - - - Method to collect data in case of Amazon service exception - - - - - The CSM handler has the logic for capturing data for CSM events when enabled. - - - - - Invokes the CSM handler and captures data for the CSM events. - - - - - Calls the PreInvoke and PostInvoke methods before and after calling the next handler - in the pipeline. - - - - - Invoked from the finally block of CSMCallEventHandler's Invoke method. - This method is used to capture CSM Call event metrics. - - - - - - Method that gets invoked in case of an exception in the API request completion. - - - - - - - This handler resolves the endpoint to be used for the current request. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Resolves the endpoint to be used for the current request - before invoking the next handler. - - The execution context, it contains the - request and response context. - - - - This handler resolves the endpoint to be used for the current request. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Resolves the endpoint to be used for the current request - before invoking the next handler. - - The execution context, it contains the - request and response context. - - - - Determines the endpoint for the request. - - The request context. - - - - - This handler provides an OnError action that can be used as hook for - external code to handle exceptions in the runtime pipeline. - - - - - Action to execute if an exception occurs during the - execution of any underlying handlers. - - - - - Executes the OnError action if an exception occurs during the - execution of any underlying handlers. - - - - - - - This handler marshalls the request before calling invoking the next handler. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Marshalls the request before calling invoking the next handler. - - The execution context, it contains the - request and response context. - - - - This handler manages the metrics used to time the complete call and - logs the final metrics. - - - - - Captures the overall execution time and logs final metrics. - - The execution context which contains both the - requests and response context. - - - - Captures the overall execution time and logs final metrics. - - The response type for the current request. - - The execution context, it contains the request and response context. - - A task that represents the asynchronous operation. - - - - This handler processes HTTP redirects and reissues the call to the - redirected location. - - - - - Processes HTTP redirects and reissues the call to the - redirected location. - - The execution context which contains both the - requests and response context. - - - - Processes HTTP redirects and reissues the call to the - redirected location. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Checks if an HTTP 307 (temporary redirect) has occured and changes the - request endpoint to the redirected location. - - - The execution context, it contains the request and response context. - - - A boolean value that indicates if a redirect has occured. - - - - - This handler signs the request. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Signs the request before invoking the next handler. - - - The execution context, it contains the request and response context. - - - - - Determines if the request should be signed. - - The request context. - A boolean value that indicated if the request should be signed. - - - - Signs the request. - - The request context. - - - - This handler unmarshalls the HTTP response. - - - - - The constructor for Unmarshaller. - - - Boolean value which indicated if the unmarshaller - handler supports response logging. - - - - - Unmarshalls the response returned by the HttpHandler. - - The execution context which contains both the - requests and response context. - - - - Unmarshalls the response returned by the HttpHandler. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Unmarshalls the HTTP response. - - - The execution context, it contains the request and response context. - - - - - Unmarshalls the HTTP response. - - - The execution context, it contains the request and response context. - - - - - The HTTP handler contains common logic for issuing an HTTP request that is - independent of the underlying HTTP infrastructure. - - - - - - The sender parameter used in any events raised by this handler. - - - - - The constructor for HttpHandler. - - The request factory used to create HTTP Requests. - The sender parameter used in any events raised by this handler. - - - - Issues an HTTP request for the current request context. - - The execution context which contains both the - requests and response context. - - - - Issues an HTTP request for the current request context. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Determines the content for request body and uses the HTTP request - to write the content to the HTTP request body. - - Content to be written. - The HTTP request. - The request context. - - - - Creates the HttpWebRequest and configures the end point, content, user agent and proxy settings. - - The async request. - The web request that actually makes the call. - - - - Disposes the HTTP handler. - - - - - An abstract pipeline handler that has implements IPipelineHandler, - and has the default implmentation. This is the base class for most of - the handler implementations. - - - - - The logger used to log messages. - - - - - The inner handler which is called after the current - handler completes it's processing. - - - - - The outer handler which encapsulates the current handler. - - - - - Contains the processing logic for a synchronous request invocation. - This method calls InnerHandler.InvokeSync to continue processing of the - request by the pipeline. - - The execution context which contains both the - requests and response context. - - - - Contains the processing logic for an asynchronous request invocation. - This method calls InnerHandler.InvokeSync to continue processing of the - request by the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Logs the metrics for the current execution context. - - The execution context, it contains the - request and response context. - - - - The default implementation of the retry policy. - - - The default implementation of the retry policy. - - - - - The maximum value of exponential backoff in milliseconds, which will be used to wait - before retrying a request. - - - - - List of HTTP Status codes codes which are returned as part of the error response. - These status codes will be retried. - - - - - List of AWS specific error codes which are returned as part of the error response. - These error codes will be retried. - - - - - List of WebExceptionStatus for a WebException which will be retried. - - - - - Constructor for DefaultRetryPolicy. - - The maximum number of retries before throwing - back a exception. This does not count the initial request. - - - - Constructor for DefaultRetryPolicy. - - The Client config object. This is used to - retrieve the maximum number of retries before throwing - back a exception(This does not count the initial request) and - the service URL for the request. - - - - Returns true if the request is in a state where it can be retried, else false. - - Request context containing the state of the request. - Returns true if the request is in a state where it can be retried, else false. - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - - - - Virtual method that gets called on a success Response. If its a retry success response, the entire - retry acquired capacity is released(default is 5). If its just a success response a lesser value capacity - is released(default is 1). - - Request context containing the state of the request. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Request context containing the state of the request. - Return true if the request should be retried. - - - - Checks if the retry limit is reached. - - Request context containing the state of the request. - Return false if the request can be retried, based on number of retries. - - - - Waits before retrying a request. The default policy implements a exponential backoff. - - Request context containing the state of the request. - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - The retry handler has the generic logic for retrying requests. - It uses a retry policy which specifies when - a retry should be performed. - - - - - The logger used to log messages. - - - - - The retry policy which specifies when - a retry should be performed. - - - - - Constructor which takes in a retry policy. - - Retry Policy - - - - Invokes the inner handler and performs a retry, if required as per the - retry policy. - - The execution context which contains both the - requests and response context. - - - - Invokes the inner handler and performs a retry, if required as per the - retry policy. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Prepares the request for retry. - - Request context containing the state of the request. - - - - A runtime pipeline contains a collection of handlers which represent - different stages of request and response processing. - - - - - The top-most handler in the pipeline. - - - - - Constructor for RuntimePipeline. - - The handler with which the pipeline is initalized. - - - - Constructor for RuntimePipeline. - - List of handlers with which the pipeline is initalized. - - - - Constructor for RuntimePipeline. - - List of handlers with which the pipeline is initalized. - The logger used to log messages. - - - - Constructor for RuntimePipeline. - - The handler with which the pipeline is initalized. - The logger used to log messages. - - - - Invokes the pipeline synchronously. - - Request context - Response context - - - - Invokes the pipeline asynchronously. - - Request context - Response context - - - - Adds a new handler to the top of the pipeline. - - The handler to be added to the pipeline. - - - - Adds a handler after the first instance of handler of type T. - - Type of the handler after which the given handler instance is added. - The handler to be added to the pipeline. - - - - Adds a handler before the first instance of handler of type T. - - Type of the handler before which the given handler instance is added. - The handler to be added to the pipeline. - - - - Removes the first occurance of a handler of type T. - - Type of the handler which will be removed. - - - - Replaces the first occurance of a handler of type T with the given handler. - - Type of the handler which will be replaced. - The handler to be added to the pipeline. - - - - Inserts the given handler after current handler in the pipeline. - - Handler to be inserted in the pipeline. - Handler after which the given handler is inserted. - - - - Gets the innermost handler by traversing the inner handler till - it reaches the last one. - - - - - Retrieves a list of handlers, in the order of their execution. - - Handlers in the current pipeline. - - - - Retrieves current handlers, in the order of their execution. - - Handlers in the current pipeline. - - - - This class is the base class of all the configurations settings to connect - to a service. - - - This class is the base class of all the configurations settings to connect - to a service. - - - - - Gets Service Version - - - - - Gets and sets of the signatureMethod property. - - - - - Gets and sets of the SignatureVersion property. - - Note: This property exists for backward compatibility but is no longer - used by any service other than S3. - - - - - Gets and sets of the UserAgent property. - - - - - Gets and sets the RegionEndpoint property. The region constant that - determines the endpoint to use. - - Setting this property to null will force the SDK to recalculate the - RegionEndpoint value based on App/WebConfig, environment variables, - profile, etc. - - - - - The constant used to lookup in the region hash the endpoint. - - - - - Gets and sets of the ServiceURL property. - This is an optional property; change it - only if you want to try a different service - endpoint. - - - - - Gets and sets the UseHttp. - If this property is set to true, the client attempts - to use HTTP protocol, if the target endpoint supports it. - By default, this property is set to false. - - - - - Given this client configuration, return a string form ofthe service endpoint url. - - - - - Gets and sets the AuthenticationRegion property. - Used in AWS4 request signing, this is an optional property; - change it only if the region cannot be determined from the - service endpoint. - - - - - Gets and sets the AuthenticationServiceName property. - Used in AWS4 request signing, this is the short-form - name of the service being called. - - - - - Gets and sets of the MaxErrorRetry property. - - - - - Gets and sets the LogResponse property. - If this property is set to true, the service response is logged. - The size of response being logged is controlled by the AWSConfigs.LoggingConfig.LogResponsesSizeLimit property. - - - - - Gets and sets the ReadEntireResponse property. - NOTE: This property does not effect response processing and is deprecated. - To enable response logging, the ClientConfig.LogResponse and AWSConfigs.LoggingConfig - properties can be used. - - - - - Gets and Sets the BufferSize property. - The BufferSize controls the buffer used to read in from input streams and write - out to the request. - - - - - - Gets or sets the interval at which progress update events are raised - for upload operations. By default, the progress update events are - raised at every 100KB of data transferred. - - - If the value of this property is set less than ClientConfig.BufferSize, - progress updates events will be raised at the interval specified by ClientConfig.BufferSize. - - - - - - Flag on whether to resign requests on retry or not. - For Amazon S3 and Amazon Glacier this value will always be set to true. - - - - - This flag controls if .NET HTTP infrastructure should follow redirection - responses (e.g. HTTP 307 - temporary redirect). - - - - - Flag on whether to log metrics for service calls. - - This can be set in the application's configs, as below: - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSLogMetrics" value"true"/> - </appSettings> - </configuration> - - - - - - Gets and sets the DisableLogging. If true logging for this client will be disabled. - - - - - Credentials to use with a proxy. - - - - - - If the value is set, the value is assigned to the Timeout property of the HttpWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Configures the endpoint calculation for a service to go to a dual stack (ipv6 enabled) endpoint - for the configured region. - - - Note: AWS services are enabling dualstack endpoints over time. It is your responsibility to check - that the service actually supports a dualstack endpoint in the configured region before enabling - this option for a service. - - - - - Enable or disable the Retry Throttling feature by setting the ThrottleRetries flag to True/False resepctively. - Retry Throttling is a feature that intelligently throttles retry attempts when a large precentage of requests - are failing and retries are unsuccessful as well. In such situations the allotted retry capacity for the service URL - will be drained until requests start to succeed again. Once the requisite capacity is available, retries would - be permitted again. When retries are throttled, the service enters a fail-fast behaviour as the traditional retry attempt - for the request would be circumvented. Hence, errors will resurface quickly. This will result in a greated number of exceptions - but prevents requests being tied up in unsuccessful retry attempts. - Note: Retry Throttling is enabled by default. Set the ThrottleRetries flag to false to switch off this feature. - - - - - Enable or disable the Nagle algorithm on the underlying http - client. - - This method is not intended to be called by consumers of the AWS SDK for .NET - - - - - - Performs validation on this config object. - Throws exception if any of the required values are missing/invalid. - - - - - Returns the current UTC now after clock correction for this endpoint. - - - - - The calculated clock skew correction for a specific endpoint, if there is one. - This field will be set if a service call resulted in an exception - and the SDK has determined that there is a difference between local - and server times. - - If is set to true, this - value will still be set to the correction, but it will not be used by the - SDK and clock skew errors will not be retried. - - - - - Gets and sets the DisableHostPrefixInjection flag. If true, host prefix injection will be disabled for this client, the default value of this flag is false. - Host prefix injection prefixes the service endpoint with request members from APIs which use this feature. - Example: for a hostPrefix of "foo-name." and a endpoint of "service.region.amazonaws.com" the default behavior is to - prefix the endpoint with the hostPrefix resulting in a final endpoint of "foo-name.service.region.amazonaws.com". Setting - DisableHostPrefixInjection to true will disable hostPrefix injection resulting in a final endpoint of - "service.region.amazonaws.com" regardless of the value of hostPrefix. E.g. You may want to disable host prefix injection for testing against a local mock endpoint. - - - - - Returns the flag indicating if endpoint discovery should be enabled or disabled for operations that are not required to use endpoint discovery. - - - - - Returns the maximum number of discovered endpoints that can be stored within the cache for the client. The default limit is 1000 cache entries. - - - - - Throw an exception if the boxed TimeSpan parameter doesn't have a value or is out of range. - - - - - Returns the request timeout value if its value is set, - else returns client timeout value. - - - - - - This is a switch used for performance testing and is not intended for production applications - to change. This switch may be removed in a future version of the SDK as the .NET Core platform matures. - - - If true, the HttpClient is cached and reused for every request made by the service client - and shared with other service clients. - - - For the .NET Core platform this is default to true because the HttpClient manages the connection - pool. - - - - - - If CacheHttpClient is set to true then HttpClientCacheSize controls the number of HttpClients cached. - - On Windows the default value is 1 since the underlying native implementation does not have throttling constraints - like the non Windows Curl based implementation. For non Windows based platforms the default is the value return from - System.Environment.ProcessorCount. - - - - - - Overrides the default read-write timeout value. - - - - If the value is set, the value is assigned to the ReadWriteTimeout property of the HttpWebRequest object used - to send requests. - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Returns a WebProxy instance configured to match the proxy settings - in the client configuration. - - - - - Unpacks the host, port and any credentials info into the instance's - proxy-related fields. - Unlike the SetWebProxy implementation on .NET 3.5/4.5,the Host and the Port are not reconstructed from the - input proxyuri - - The proxy details - - - - Gets and sets of the ProxyHost property. - - - - - Gets and sets of the ProxyPort property. - - - - - Get or set the value to use for on requests. - If this property is null, - will be left at its default value of . - - - - - - Returns true if the clients should be cached by HttpRequestMessageFactory, false otherwise. - - - - - - - Returns true if the SDK should dispose HttpClients after one use, false otherwise. - - - - - - - Create a unique string used for caching the HttpClient based on the settings that are used from the ClientConfig that are set on the HttpClient. - - - - - - - Determines if HttpClients created with the given IClientConfig should be cached at the SDK - client level, or cached globally. - - If there is no HttpClientFactory assigned and proxy or proxy credentials are set - this returns false because those properties can't be serialized as part of the key in the global http client cache. - - - - - Base class for constant class that holds the value that will be sent to AWS for the static constants. - - - - - Gets the value that needs to be used when send the value to AWS - - - - - Attempt to find correct-cased constant value using whatever cased value the user - has provided. This is primarily useful for mapping any-cased values from a CLI - tool to the specific casing required by the service, avoiding the need for the - user to (a) remember the specific case and (b) actually type it correctly. - - The properly cased service constant matching the value - - - - Utility class that stores clock skew information. - - - - - GlobalClockCorrection should be only set by AWSConfigs.ManualClockCorrection property - and is only available to maintain backward compatibilty. This should override any - endpoint specific clockskew correction. - - - - - Return clock skew correction value for an endpoint if there is one. - - AWSConfigs.ManualClockCorrection overrides globally any calculated service endpoint specific - clock correction value. - - Endpoint should in a form such as "https://s3" - Clock correction value for an endpoint in TimeSpan. TimeSpan.Zero if no such clock correction is set. - - - - Get clock skew corrected UTC now value. If ManualClockCorrection is set, - use ManualClockCorrection instead of endpoint specific clock correction value. - - - - - - - Factory to construct different types of AWSCredentials based on a profile. - - - - - Gets the AWSCredentials for this profile if CanCreateAWSCredentials is true - and AWSCredentials can be created. Throws an exception otherwise. - - See for a list of AWSCredentials returned by this method. - - The profile to get AWSCredentials for. - The profile source, for profiles that reference other profiles. - AWSCredentials for this profile. - - - - Gets the AWSCredentials for this profile if CanCreateAWSCredentials is true - and AWSCredentials can be created. Throws an exception otherwise. - - See for a list of AWSCredentials returned by this method. - - The options to get AWSCredentials for. - The profile source, for options that reference other profiles. - AWSCredentials for the options given. - - - - Gets the AWSCredentials for this profile if CanCreateAWSCredentials is true - and AWSCredentials can be created. Throws an exception otherwise. - - See for a list of AWSCredentials returned by this method. - - The profile to get AWSCredentials for. - The profile source, for profiles that reference other profiles. - If true, throw a descriptive exception for any credentials that would not operate as-is. - In other words, any credentials that require programmatic callbacks at runtime. - AWSCredentials for this profile. - - - - Gets the AWSCredentials for this profile if CanCreateAWSCredentials is true - and AWSCredentials can be created. Throws an exception otherwise. - - See for a list of AWSCredentials returned by this method. - - The options to get AWSCredentials for. - The profile source, for options that reference other profiles. - If true, throw a descriptive exception for any credentials that would not operate as-is. - In other words, any credentials that require programmatic callbacks at runtime. - AWSCredentials for the options given. - - - - Return the credentials for the profile if valid credentials can created. - - The profile to create credentials with. - The profile source, for profiles that reference other profiles. - The credentials for the profile. - True if credentials can be created from the profile, false otherwise. - - - - Return the credentials for the profile if valid credentials can created. - - The options to get AWSCredentials for. - The profile source, for profiles that reference other profiles. - The credentials for the profile. - True if credentials can be created from the profile, false otherwise. - - - - Determine if the profileType will generate AWSCredentials that require a callback to be set on them. - - - - - - - A named group of options that are persisted and used to obtain AWSCredentials. - - - - - The name of the CredentialProfile - - - - - The options to be used to create AWSCredentials. - - - - - The region to be used with this CredentialProfile - - - - - The unique key for this CredentialProfile. - This key is used by the Visual Studio Tooklit to associate external artifacts with this profile. - - - - - The endpoint discovery enabled value for this CredentialProfile - - - - - If true the region identified in the S3 access point arn will be used when making requests. - - - - - The Sts Regional Endpoints Value as either legacy or regional - - - - - The S3 Regional Endpoint Value as either legacy or regional - - - - - An optional dictionary of name-value pairs stored with the CredentialProfile - - - - - True if the properties of the Options object can be converted into AWSCredentials, false otherwise. - See for more details about which options are available. - - - - - The that this is associated with. - Null if this is not associated with a . - - - - - If CanCreateAWSCredentials is true, returns a short description of the type of - credentials that would be created. - If CanCreateAWSCredentials is false, return null. - - - - - The CredentialProfileType of this CredentialProfile, if one applies. - - - - - Determine this CredentialProfile will generate AWSCredentials that require a callback to be set on them. - - - - - Construct a new CredentialProfile. - - - - - - - Gets the AWSCredentials for this profile if CanCreateAWSCredentials is true - and AWSCredentials can be created. Throws an exception otherwise. - - See for a list of AWSCredentials returned by this method. - - The profile source, for profiles that reference other profiles. - AWSCredentials for this profile. - - - - Gets the AWSCredentials for this profile if CanCreateAWSCredentials is true - and AWSCredentials can be created. Throws an exception otherwise. - - See for a list of AWSCredentials returned by this method. - - The profile source, for profiles that reference other profiles. - If true, throw a descriptive exception for any credentials that would not operate as-is. - In other words, any credentials that require programmatic callbacks at runtime. - AWSCredentials for this profile. - - - - The options that are available for creating AWSCredentials with the AWSCredentialsFactory. - The type of AWSCredentials that are created depends on which Options are set. - - Below are the different types of credentials returned, along with the options that are used to obtain them. - ([] denotes options that are not required) - - BasicAWSCredentials AccessKey SecretKey - SessionAWSCredentials AccessKey SecretKey Token - AssmeRoleAWSCredentials SourceProfile RoleArn [ExternalID] [MfaSerial] - - - - - The access key to be used in the AWSCredentials. - - - - - The source of credentials to be used to obtain AWSCredentials. - - - - - The external id to use in assume role AWSCredentials. - - - - - The serial number of the MFA to use in assume role AWSCredentials. - - - - The role ARN to use when creating assume role AWSCredentials. - - - - An identifier for the assumed role session. - - - - - The secret key to use when creating AWSCredentials. - - - - - When this CredentialProfileOptions object references another CredentialProfile, - the name of the referenced CredentialProfile. - - - - - The session token to be used to create AWSCredentials. - - - - - Contains the executable information to be used by the process credential retriever - to either fetch Basic or Session credentials - - - - - Absolute path to the file on disk containing an OIDC token. - - - - - Return true the properties are all null or empty, false otherwise. - - - - - Class to abstract the combined use of NetSDKCredentialsFile and SharedCredentialsFile where possible. - - - - - - The location of the shared credentials file, or null to use the default location. - - - - - Construct a CredentialProfileChain. - - - - - Construct a CredentialProfileChain. - - The path to the aws credentials file to look at. - - - - - Try to get from a profile. - - - If ProfilesLocation is non-null and non-empty search the shared credentials - file at the disk path in the ProfilesLocation property. - - - If ProfilesLocation is null or empty and the platform supports the .NET SDK credentials file - search the SDK credentials file. If the profile is not found search the shared credentials file in the default location. - - - If ProfilesLocation is null or empty and the platform doesn't support the .NET SDK credentials file - search the shared credentials file in the default location. - - - The name of the profile to get credentials from. - The credentials, if the profile is found and credentials can be created. - True if the profile was found and credentials could be created, false otherwise. - - - - - Try to get a - - - If ProfilesLocation is non-null and non-empty search the shared credentials - file at the disk path in the ProfilesLocation property. - - - If ProfilesLocation is null or empty and the platform supports the .NET SDK credentials file - search the SDK credentials file. If the profile is not found search the shared credentials file in the default location. - - - If ProfilesLocation is null or empty and the platform doesn't support the .NET SDK credentials file - search the shared credentials file in the default location. - - - The name of the profile to get. - The profile, if found - True if the profile was found, false otherwise. - - - - - Get a list of available objects. - - - If ProfilesLocation is non-null and non-empty include profiles in the shared credentials - file at the disk path in the ProfilesLocation property. - - - If ProfilesLocation is null or empty and the platform supports the .NET SDK credentials file - include profiles from the SDK credentials file and from the shared credentials file in the default location. - - - If ProfilesLocation is null or empty and the platform doesn't support the .NET SDK credentials file - include profiles from the shared credentials file in the default location. - - - A list of objects. - - - - - Register a - - - If ProfilesLocation is non-null and non-empty register the profile in the shared credentials - file at the disk path in the ProfilesLocation property. - - - If ProfilesLocation is null or empty and the platform supports the .NET SDK credentials file - register the profile in the SDK credentials file. - - - If ProfilesLocation is null or empty and the platform doesn't support the .NET SDK credentials file - register the profile in the shared credentials file in the default location. - - - The profile to register. - - - - - Unregister a - - - If ProfilesLocation is non-null and non-empty unregister the profile from the shared credentials - file at the disk path in the ProfilesLocation property. - - - If ProfilesLocation is null or empty and the platform supports the .NET SDK credentials file - search the SDK credentials file. If the profile is found there unregister it. - If the profile was not found search the shared credentials file in the default location. - If the profile is found in the shared credentials file in the default location unregister it. - - - If ProfilesLocation is null or empty and the platform doesn't support the .NET SDK credentials file - search the shared credentials file in the default location. If the profile is found in the - shared credentials file in the default location unregister it. - - - The name of the profile to unregister. - - - - Interface to define the necessary operations for a CredentialProfile lookup mechanism. - - - - - Get the profile with the given name, if one exists. - - The name of the profile to get. - The profile, if it was found, null otherwise. - True if the profile was found, false otherwise. - - - - Interface to define the necessary operations for a CredentialProfile storage mechanism. - - - - - Rename the profile with oldProfileName to newProfileName. - - The profile to rename. - The new name for the profile. - - - - Rename the profile with oldProfileName to newProfileName. - - The profile to rename. - The new name for the profile. - If true and the destination profile exists it will be overwritten. - - - - Make a copy of the profile with fromProfileName called toProfileName. - - The name of the profile to copy from. - The name of the new profile. - - - - Make a copy of the profile with fromProfileName called toProfileName. - - The name of the profile to copy from. - The name of the new profile. - If true and the destination profile exists it will be overwritten. - - - - Add the given profile to the store, or update it if one with the same name already exists. - - - - - - Delete the profile with profileName if it exists. - - The name of the profile to delete. - - - - Get a list of valid profile names from this store. - Invalid profiles are ignored. - See for more information - about valid profiles. - - - - - - Get a list of valid profiles from this store. - Invalid profiles are ignored. - See for more information - about valid profiles. - - - - - - Class to easily convert from Dictionary<string, string> to ProfileOptions and back. - - - - - Separate the profileDictionary into its parts. - profileDictionary = profileOptions + reservedProperties + userProperties - - Dictionary with everything in it - Keys to ignore - The resulting CredentialProfileOptions - The properties that are left - - - - Separate the profileDictionary into its parts. - profileDictionary = profileOptions + reservedProperties + userProperties - - Dictionary with everything in it - Keys for the reservedKeys dictionary - The resulting CredentialProfileOptions - The resulting reserved properties - The properties that are left - - - - Validate the userProperties and then combine profileOptions, reservedProperties, and userProperties into one Dictionary. - - - - - - - - - - Make sure the userProperties dictionary doesn't contain any keys that are reserved. - Check is case-insensitive for added safety. - - - - - - - Make sure the userProperties dictionary doesn't contain any keys that - overlap with the names of mapped names for CredentialProfileOptions property names. - Check is case-insensitive for added safety. - - - - - - This class is used internally and should not be accessed by SDK users. - - Provide access to internal properties of CredentialProfile to - PowerShell tools and the Visual Studio Toolkit. - - - - - This class allows profiles supporting AWSCredentials to be registered with - the SDK so that they can later be reference by a profile name. The credential profiles will be available - for use in the AWS Toolkit for Visual Studio and the AWS Tools for Windows PowerShell. - - The credentials are stored under the current users AppData folder encrypted using Windows Data Protection API. - - - This class is not threadsafe. - - - - - - Get the profile with the name given, if it exists in this store. - - The name of the profile to find. - The profile, if it was found, null otherwise - True if the profile was found, false otherwise. - - - - Add the profile to this store, if it's valid. - - The profile to add. - - - - If there is a profile in the store with the given name, delete it. - - The name of the profile to delete. - - - - Rename the profile with oldProfileName to newProfileName. - - The profile to rename. - The new name for the profile. - - - - Rename the profile with oldProfileName to newProfileName. - - The profile to rename. - The new name for the profile. - If true and the destination profile exists it will be overwritten. - - - - Make a copy of the profile with fromProfileName called toProfileName. - - The name of the profile to copy from. - The name of the new profile. - - - - Make a copy of the profile with fromProfileName called toProfileName. - - The name of the profile to copy from. - The name of the new profile. - If true and the destination profile exists it will be overwritten. - - - - Set the ProfileType field to maintain backward compatibility with ProfileManager. - The value is ignored when it's read back in. - - - - - - - Provides access to read and write to the shared credentials INI file. - The file is read, parsed, and validated at construction time. - Changes can be made using the RegisterProfile() and - UnregisterProfile() methods. - - This class is not threadsafe. - - - - - To maintain compatibility with the CLI, - SharedCredentialsFile doesn't support the SAML profileTypes. - - - - - Construct a new SharedCredentialsFile in the default location. - - - - - Construct a new SharedCredentialsFile. - - The path of the shared credentials file. - - - - Add the profile given. If the profile already exists, update it. - - The profile to be written. - - - - Update the profile on disk regardless of the profile type. - - - - - - Deletes the section with the given ProfileName from the SharedCredentialsFile, if one exists. - - The ProfileName of the section to delete. - - - - Rename the profile with oldProfileName to newProfileName. - - The profile to rename. - The new name for the profile. - - - - Rename the profile with oldProfileName to newProfileName. - - The profile to rename. - The new name for the profile. - If true and the destination profile exists it will be overwritten. - - - - Make a copy of the profile with fromProfileName called toProfileName. - - The name of the profile to copy from. - The name of the new profile. - - - - Make a copy of the profile with fromProfileName called toProfileName. - - The name of the profile to copy from. - The name of the new profile. - If true and the destination profile exists it will be overwritten. - - - - Try to get a profile that may be partially in the credentials file and partially in the config file. - If there are identically named properties in both files, the properties in the credentials file take precedence. - - - - - - - - Anonymous credentials. - Using these credentials, the client does not sign the request. - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - AWS Credentials that automatically refresh by calling AssumeRole on - the Amazon Security Token Service. - - - - - The credentials of the user that will be used to call AssumeRole. - - - - - The Amazon Resource Name (ARN) of the role to assume. - - - - - An identifier for the assumed role session. - - - - - Options to be used in the call to AssumeRole. - - - - - Constructs an AssumeRoleAWSCredentials object. - - The credentials of the user that will be used to call AssumeRole. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - - - - Constructs an AssumeRoleAWSCredentials object. - - The credentials of the user that will be used to call AssumeRole. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRole. - - - - A unique identifier that is used by third parties when assuming roles in their customers' accounts. - - - - - An IAM policy in JSON format. - - - - - The length of time in seconds before the credentials will expire. - - - - - The proxy settings to use when calling AssumeRole. - - - - - The identification number of the MFA device that is associated with the user who is making the assume-role call. - - - - - The value provided by the MFA device, if the trust policy of the role being assumed requires MFA. - - - - - A callback that's used to obtain the MFA token code when the AssumeRoleAWSCredentials are refreshed. - - - - - Immutable representation of AWS credentials obtained as a result of - authenticating with the AssumeRole method of the Security Token Service. - - - - - The expiry time of the credentials, obtained from the AssumeRoleResponse. - - - - - Constructs an instance with supplied keys, token, and expiration. - - The AccessKey for the credentials. - The SecretKey for the credentials. - The security token for the credentials. - The expiration time for the credentials. - - - - Get a copy of this AssumeRoleImmutableCredentials object. - - A copy of this object. - - - - AWS Credentials that automatically refresh by calling AssumeRole on - the Amazon Security Token Service. - - - - - As established by STS, the regex used to validate the role session names is a string of 2-64 characters consisting of - upper- and lower-case alphanumeric characters with no spaces. You can also include - underscores or any of the following characters: =,.@- - - - - - Options to be used in the call to AssumeRole. - - - - - The absolute path to the file on disk containing an OIDC token - - - - - The Amazon Resource Name (ARN) of the role to assume. - - - - - An identifier for the assumed role session. - - - - - Constructs an AssumeRoleWithWebIdentityCredentials object. - - The absolute path to the file on disk containing an OIDC token. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - - - - Constructs an AssumeRoleWithWebIdentityCredentials object. - - The absolute path to the file on disk containing an OIDC token. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRole. - - - - Creates an instance of from environment variables. - - Throws an if the needed environment variables are not set. - The new credentials. - - - - Gets a client to be used for AssumeRoleWithWebIdentity requests. - - The STS client. - - - - Options for using a credentials object to make AssumeRoleWithWebIdentity calls. - - - - - Gets and sets the property DurationSeconds. - - The duration, in seconds, of the role session. The value can range from 900 seconds - (15 minutes) up to the maximum session duration setting for the role. This setting - can have a value from 1 hour to 12 hours. If you specify a value higher than this - setting, the operation fails. For example, if you specify a session duration of 12 - hours, but your administrator set the maximum session duration to 6 hours, your operation - fails. To learn how to view the maximum value for your role, see View - the Maximum Session Duration Setting for a Role in the IAM User Guide. - - - - By default, the value is set to 3600 seconds. - - - - The DurationSeconds parameter is separate from the duration of a console - session that you might request using the returned credentials. The request to the - federation endpoint for a console sign-in token takes a SessionDuration - parameter that specifies the maximum length of the console session. For more information, - see Creating - a URL that Enables Federated Users to Access the AWS Management Console in the - IAM User Guide. - - - - - - - Gets and sets the property ProviderId. - - The fully qualified host component of the domain name of the identity provider. - - - - Specify this value only for OAuth 2.0 access tokens. Currently www.amazon.com - and graph.facebook.com are the only supported identity providers for - OAuth 2.0 access tokens. Do not include URL schemes and port numbers. - - - - Do not specify this value for OpenID Connect ID tokens. - - - - - - Gets and sets the property Policy. - - An IAM policy in JSON format that you want to use as an inline session policy. - - - - This parameter is optional. Passing policies to this operation returns new temporary - credentials. The resulting session's permissions are the intersection of the role's - identity-based policy and the session policies. You can use the role's temporary credentials - in subsequent AWS API calls to access resources in the account that owns the role. - You cannot use session policies to grant more permissions than those allowed by the - identity-based policy of the role that is being assumed. For more information, see - Session - Policies in the IAM User Guide. - - - - The plain text that you use for both inline and managed session policies shouldn't - exceed 2048 characters. The JSON policy characters can be any ASCII character from - the space character to the end of the valid character list (\u0020 through \u00FF). - It can also include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D) - characters. - - - - The characters in this parameter count towards the 2048 character session policy guideline. - However, an AWS conversion compresses the session policies into a packed binary format - that has a separate limit. This is the enforced limit. The PackedPolicySize - response element indicates by percentage how close the policy is to the upper size - limit. - - - - - - - Gets and sets the property PolicyArns. - - The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use - as managed session policies. The policies must exist in the same account as the role. - - - - This parameter is optional. You can provide up to 10 managed policy ARNs. However, - the plain text that you use for both inline and managed session policies shouldn't - exceed 2048 characters. For more information about ARNs, see Amazon - Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference. - - - - The characters in this parameter count towards the 2048 character session policy guideline. - However, an AWS conversion compresses the session policies into a packed binary format - that has a separate limit. This is the enforced limit. The PackedPolicySize - response element indicates by percentage how close the policy is to the upper size - limit. - - - - Passing policies to this operation returns new temporary credentials. The resulting - session's permissions are the intersection of the role's identity-based policy and - the session policies. You can use the role's temporary credentials in subsequent AWS - API calls to access resources in the account that owns the role. You cannot use session - policies to grant more permissions than those allowed by the identity-based policy - of the role that is being assumed. For more information, see Session - Policies in the IAM User Guide. - - - - - - The proxy settings to use when calling AssumeRoleWithWebIdentity. - - This parameter is optional. - - - - - - Abstract class that represents a credentials object for AWS services. - - - - - Returns a copy of ImmutableCredentials - - - - - - Called by AmazonServiceClient to validate the credential state - on client construction. - - - - - Basic set of credentials consisting of an AccessKey and SecretKey - - - - - Constructs a BasicAWSCredentials object for the specified accessKey and secretKey. - - - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - InstanceProfileAWSCredentials allows configuring Roles and every instance hits IMDS individually. - This class has a singleton timer task that caches instance profile credentials every 2 minutes. - - - - - Returns a copy of the most recent instance profile credentials. - - - - - Returns a copy of the most recent instance profile credentials. - - - - - Dispose this object and all related resources. - - - - - When running in an ECS container and AWS_CONTAINER_CREDENTIALS_RELATIVE_URI is set, - use the given end point to retrieve the credentials. - - - - - These constants should not be consumed by client code. They are only relevant - in the context of ECS container and, especially, AWS_CONTAINER_CREDENTIALS_RELATIVE_URI - environment variable should not be overriden by the client code. - - - - - Uses aws credentials stored in environment variables to construct the credentials object. - AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY are used for the access key id and secret key. - If the variable AWS_SESSION_TOKEN exists then it will be used to create temporary session - credentials. - - - For backwards compatibility the class will also attempt to discover the secret key from - the AWS_SECRET_KEY variable, if a value cannot be obtained using the standard - AWS_SECRET_ACCESS_KEY variable. - - - - - Constructs an instance of EnvironmentVariablesAWSCredentials. If no credentials are found in - the environment variables then an InvalidOperationException is thrown. - - - - - Creates immutable credentials from environment variables. - - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - If AWS_CONTAINER_CREDENTIALS_RELATIVE_URI environment variable is set, we want to attempt to retrieve credentials - using ECS endpoint instead of referring to instance profile credentials. - - - If AWS_CONTAINER_CREDENTIALS_RELATIVE_URI environment variable is set, we want to attempt to retrieve credentials - using ECS endpoint instead of referring to instance profile credentials. - - - - Immutable representation of AWS credentials. - - - - - Gets the AccessKey property for the current credentials. - - - - - Gets the SecretKey property for the current credentials. - - - - - Gets the Token property for the current credentials. - - - - - Gets the UseToken property for the current credentials. - Specifies if Token property is non-emtpy. - - - - - Constructs an ImmutableCredentials object with supplied accessKey, secretKey. - - - - Optional. Can be set to null or empty for non-session credentials. - - - - Returns a copy of the current credentials. - - - - - - Credentials that are retrieved from the Instance Profile service on an EC2 instance - - - - - Role for which the credentials are retrieved - - - - - Constructs a InstanceProfileAWSCredentials object for specific role - - Role to use - - - - Constructs a InstanceProfileAWSCredentials object for specific role - - Role to use - - - - Constructs a InstanceProfileAWSCredentials object for the first found role - - - - - Constructs a InstanceProfileAWSCredentials object for the first found role - - - - - Retrieves a list of all roles available through current InstanceProfile service - - - - - - Retrieves a list of all roles available through current InstanceProfile service - - - - - - Return true if string is null or whitespace, false otherwise. - We can't use String.IsNullOrWhitespace because it doesn't exist - in all frameworks we support. - - - - - - - Process Credentials can retrieve credentials by running a process and reading its stdout. - A new config option, "credential_process" is added to the shared config file that allows customers - to specify which process to run. The credentials retrieved by running this process could be either - Basic or Session credentials. - - - - - Generates new credentials by running the "credential_process" process. - - - - - Exception class to capture all exceptions encountered when starting or - executing the "credential_process" process. If the user has specified an executable - and the SDK is unable to execute it, the exception should be surfaces to the user - instead of moving on to the next credential provider. - - - - - Abstract class for automatically refreshing AWS credentials - - - - - Refresh state container consisting of credentials - and the date of the their expiration - - - - - Represents the current state of the Credentials. - - This can be cleared without synchronization. - - - - Semaphore to control thread access to GetCredentialsAsync method. - The semaphore will allow only one thread to generate new credentials and - update the current state. - - - - - The time before actual expiration to expire the credentials. - Property cannot be set to a negative TimeSpan. - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - Test credentials existence and expiration time - should update if: - credentials have not been loaded yet - it's past the expiration time. At this point currentState.Expiration may - have the PreemptExpiryTime baked into to the expiration from a call to - UpdateToGeneratedCredentials but it may not if this is new application load. - - - - - When overridden in a derived class, generates new credentials and new expiration date. - - Called on first credentials request and when expiration date is in the past. - - - - - - When overridden in a derived class, generates new credentials and new expiration date. - - Called on first credentials request and when expiration date is in the past. - - - - - - Clears currently-stored credentials, forcing the next GetCredentials call to generate new credentials. - - - - - Immutable representation of AWS credentials obtained as a result of - authenticating against a SAML-supporting federated identity provider. - - - - - The expiry time of the credentials, obtained from the AssumeRoleWithSAML response. - - - - - The value of the NameID element in the Subject element of the SAML assertion, as returned in the - AssumeRoleWithSAML response from the Security Token Service. - - - - - Constructs an instance with supplied keys and SAML assertion data. - - - - - - - - - - Constructs an instance with supplied keys and SAML assertion data. - - - - - - - - Returns a copy of the current credentials. - - - - - - Serializes the instance to a json-format string for external storage - - The serialized object in json - - - - Instantiates an instance from persisted json data - - The serialized data - Deserialized instance corresponding to the json data - - - - Session credentials consisting of AccessKey, SecretKey and Token - - - - - Constructs a SessionAWSCredentials object for the specified accessKey, secretKey. - - - - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - - Credentials that are retrieved using a stored profile. - - - Unless otherwise specified priority is given to loading credentials from the SDK credential store - file which is shared between the SDK, PowerShell CLI and Toolkit. Credentials in profiles in this - file are encrypted and can only be used by the user account on the current machine that stored the - profile. Credentials can also be loaded from the plain-text ini-format credential file which is - shared with other AWS SDKs. This file is expected to exist in a '.aws' folder in the user's home - directory but alternate locations can be specified using either the AWSProfilesLocation setting in - the application configuration file, or by using the AWS_SHARED_CREDENTIALS_FILE environment variable. - - - The profile name can be specified in the App.config using the AWSProfileName setting. - - - - - - Constructs an instance for credentials stored in a profile. This constructor searches for credentials - using the account name specified using the AWSProfileName setting, if set, in the application configuration - file. If the configuration file setting is not set the SDK will attempt to locate a profile with the name - 'default'. - - - - - Constructs an instance for credentials stored in a profile with the specified name. The SDK will - check the SDK credential store file first before looking for the shared ini-format credentials - file unless the application configuration file contains a setting for the 'AWSProfilesLocation' - indicating the search should be constrained to the shared credentials file at the specified - location. - - The name of the profile in which the credentials were stored. - - - - Constructs an instance for credentials stored in a profile with the specified name. - - The profile name to search for credentials for - - Optional; instructs the SDK to check for the profile in the shared credentials file at the - specified location. If not set, the SDK will inspect its own credential store file first before - attempting to locate a shared credential file using either the default location beneath the user's - home profile folder or the location specified in the AWS_SHARED_CREDENTIALS_FILE environment - variable. - - - If credential materials cannot be read or are invalid due to missing data an InvalidDataException - is thrown. If no credentials can be located with the specified profile name, an ArgumentException - is thrown. - - - - - Name of the profile being used. - - - - - Location of the profiles, if used. - - - - - Tests if a profile has been registered in either the SDK store or the specified credential - file. - - The name of the profile to test - - Optional; instructs the SDK to check for the profile in the shared credentials file at the - specified location. If not set, the SDK will inspect its own credential store file first before - attempting to locate a shared credential file using either the default location beneath the user's - home profile folder or the location specified in the AWS_SHARED_CREDENTIALS_FILE environment - variable. - - True if a profile with the specified name has been registered. - - - - Tests if an instance can be created from the persisted profile data. - If profilesLocation is null/empty, the SDK store is searched for the - profile data before probing for the profile in the shared the ini-format - credential file. - - The name of the profile to test - - If null/empty, the SDK store is searched for the named profile otherwise - the ini-format credential file at the specified location is inspected. - - True if the persisted data would yield a valid credentials instance. - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - Helper routiners for AWS and Federated credential profiles. Probes the - profile type for the supplied profile name and returns the appropriate profile - instance. - - - - - Determines the type of the requested profile and returns the - appropriate profile instance. - - The name of the profile (AWS or federated) to be loaded. - Instantiated profile type. - - - - Determines the type of the requested profile and returns the - appropriate profile instance. - - The name of the profile (AWS or federated) to be loaded. - - The location of the shared credentials (.ini) file, for profiles that are not stored in the - SDK credential store. - - Instantiated profile type. - - - - Probes for and returns the fully qualified name of the shared ini-format credentials - file. - - - Contains the file or folder name of the credential file. If not specified, the - routine will first check the application configuration file for a setting indicating - the file location or filename. If the configuration file does not yield a credential - file location then an environment variable is examined. Finally the routine will - inspect the fallback default location beneath the user's home folder location. - - - The fully qualified name to the credential file that was located, or null - if no credential file could be found. - - - - - Class that posts the CSM event to a UDP portconfig - This is a singleton class and is created once - per AmazonServiceClient. - - - - - The CSMevents are always posted to the localhost - - - - - Method to post UDP datagram for sync calls - - - - - Method to post UDP datagram for async calls - - - - - Method to post UDP datagram for bcl35 async calls - - - - - Determines the endpoint discovery enabled value based on an environment variable. If no value is found in the - environment then an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of EnvironmentVariable AWS_ENABLED_ENDPOINT_DISCOVERY. If no value is found in the - environment then an InvalidOperationException is thrown. - - - - - Determines endpoint discovery enabled based on a stored in an . - If the profile doesn't exist or there is no endpoint discovery enabled information an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of . - If the AWS_PROFILE environment variable is set the instance will be constructed using that profile, - otherwise it will use the default profile. - - If the profile doesn't exist or there is no endpoint discovery enabled information an InvalidOperationException is thrown. - - The ICredentialProfileSource to read the profile from. - - - - Attempts to construct an instance of . - If the profile doesn't exist or there is no endpoint discovery enabled information an InvalidOperationException is thrown. - - The ICredentialProfileSource to read the profile from. - The name of the profile. - - - - Probing mechanism to determine the endpoint discovery enabled value from various sources. - - - - - The valid hashing algorithm supported by the sdk for request signing. - - - - - Which end of a request was responsible for a service error response. - - - - - The sender was responsible for the error, i.e. the client - request failed validation or was improperly formatted. - - - - - The error occured within the service. - - - - - An unrecognized error type was returned. - - - - - Sts Regional Endpoints Value determines whether or not - to send the sts request to the regional endpoint or to - the global sts endpoint - - - - - Send the request to the global sts endpoint - if the region is a legacy global region - - - - - Send the request to the regional endpoint - - - - - S3 US East 1 endpoint value determines wheter or not - to send the us-east-1 s3 requests to the regional endpoint or to - the legacy global endpoint - - - - - Sends the requests to the legacy global s3 endpoint for us-east-1 - - - - - Sends the request to the regional s3 endpoint for us-east-1 - - - - - Superclass for Exceptions that come over the event stream, or to wrap other kinds of generic exceptions. - - - - - The numeric code identifier for the type of error. - - - - - Constructs an EventStreamError. - - - - - Constructs an EventStreamError. - - The error code. - The error message. - - - - Event args that contain an . - - The - - - - The EventStream Event. - - - - - Constructs an EventStreamEventReceivedArgs. - - The EventStream Event. - - - - Event args that contain an . - - The . - - - - The EventStream Exception. - - - - - Constructs an EventStreamExceptionReceivedArgs. - - The EventStream Exception. - - - - Supported Header types for vnd.amazon.event-stream - - - - - Name for the Header. Maximum of 255 bytes. - - - - - Header type id - - - - - Computes the amount of memory neccesary to serialize this Header. - - - - - Writes this Header to buffer starting at offset - Keep in mind, this API assumes buffer is large enough - for the operation. - - buffer to serialize this Header to - offset to begin writing at. - - the new offset. - - - - - Returns the current value as a bool - - - - - Sets the current value - - - - - Returns the current value as a byte - - - - - Sets the current value - - - - - Gets the current value as a 16 bit integer. (Host Order). - - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a 32 bit integer. (Host Order) - - - - - Sets the current value - - - - - returns the current value as a 64-bit integer. (Host Order) - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a byte buffer. - - - - - - Sets the current value. Max length is 2^15 - 1 - - - - - Returns the current value as a utf-8 string. - - - - - Sets the current value. Utf-8 encoded. Max byte size is 2^16 - 1 - - - - - Gets the current value as a DateTime. - Note: You do not need to compensate for unix epoch on this API. - - - - - - Sets the current value. - Note: You do not need to compensate for unix epoch on this API. - - - - - Returns the current value as a Guid (UUID) - - - - - Sets the current value - - - - - Header Data for an EventStreamMessage - - Each header is of format: - [name len] (1) | [utf-8 name] (v) - [type (1)] - [value (v)] - - - - - Name for the Header. Maximum of 255 bytes. - - - - - Header type id - - - - - Initializes this Header with name. - - utf-8 string, max length is 255 - - - - Deserializes the header in buffer. - - buffer constaining the header - index to start from in the buffer. - updated offset with new value for offset - - - - Writes this Header to buffer starting at offset - Keep in mind, this API assumes buffer is large enough - for the operation. - - buffer to serialize this Header to - offset to begin writing at. - - the new offset. - - - - - Computes the amount of memory neccesary to serialize this Header. - - - - - Returns the current value as a bool - - - - - Sets the current value - - - - - Returns the current value as a byte - - - - - Sets the current value - - - - - Gets the current value as a 16 bit integer. (Host Order). - - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a 32 bit integer. (Host Order) - - - - - Sets the current value - - - - - returns the current value as a 64-bit integer. (Host Order) - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a byte buffer. - - - - - - Sets the current value. Max length is 2^15 - 1 - - - - - Returns the current value as a utf-8 string. - - - - - Sets the current value. Utf-8 encoded. Max byte size is 2^16 - 1 - - - - - Gets the current value as a DateTime. - Note: You do not need to compensate for unix epoch on this API. - - - - - - Sets the current value. - Note: You do not need to compensate for unix epoch on this API. - - - - - Returns the current value as a Guid (UUID) - - - - - Sets the current value - - - - - Headers for the message. Can be null. - - - - - Payload for the message. Can be null. - - - - - Converts a message into a byte buffer (usually for network transmission). - - - - - Message is a single datagram. The format is as follows: - [ total length (4) ] | [ headers_length (4)] | [ prelude crc(4)] - [ headers (v)] - [ payload (v)} - [ trailing crc ] - - CRCs use the CRC32 algorithm. - - - - - Content type for EventStreams. - - - - - Headers for the message. Can be null. - - - - - Payload for the message. Can be null. - - - - - Initialize a message with headers and a payload. - - list of headers for the message, can be null. - payload for the message, can be null. - - - - Builds a message from buffer. - - buffer to read - offset to start reading - buffer length. - - parsed instance of EventStreamMessage. Doesn't return null, - does throw if CRCs don't match. - - - - - Converts a message into a byte buffer (usually for network transmission). - - - - - Defines exceptions that arise from an not conforming to specification. - - - - - Constructs an EventStreamValidationException. - - - - - Constructs an EventStreamValidationException. - - The exception message. - - - - Constructs an EventStreamValidationException. - - The exception message. - The inner exception. - - - - The contract for the . - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - A subclass of that enables an enumerable interface for interacting with Events. - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - Flag if the stream was chosen to be enumerated. - - - - - A Stream of Events. Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treated as mutually exclusive. - - - - - A Stream of Events. Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treated as mutually exclusive. - - - - - Returns an enumerator that iterates through the collection. - - An enumerator that can be used to iterate through the collection. - - - - Returns an enumerator that iterates through a collection. - - An object that can be used to iterate through the collection. - - - - Starts the background thread to start reading events from the network stream. - - - - - The contract for the . - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - The size of the buffer for reading from the network stream. - - - - - Fires when an event is received. - - - - - Fired when an exception or error is raised. - - - - - Starts the background thread to start reading events from the network stream. - - - - - The superclass for all EventStreams. It contains the common processing logic needed to retreive events from a network Stream. It - also contains the mechanisms needed to have a background loop raise events. - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - "Unique" key for unknown event lookup. - - - - - Header key for message type. - - - - - Header key for event type. - - - - - Header key for exception type. - - - - - Header key for error code. - - - - - Header key for error message. - - - - - Value of when the message is an event. - - - - - Value of when the message is an exception. - - - - - Value of when the message is an error. - - - - - The size of the buffer for reading from the network stream. - Default is 8192. - - - - - The underlying stream to read events from. - - - - - Responsible for decoding events from sequences of bytes. - - - - - Fires when an event is recieved. - - - - - Fired when an exception or error is raised. - - - - - The mapping of event message to a generator function to construct the matching Event Stream event. - - - - - The mapping of event message to a generator function to construct the matching Event Stream exception. - - - - - Whether the Stream is currently being processed. - - - - - A Stream of Events. Events can be retrieved from this stream by attaching handlers to listen events, and then calling StartProcessing. - - - - - A Stream of Events. Events can be retrieved from this stream by attaching handlers to listen events, and then calling StartProcessing. - - - - - Converts an EventStreamMessage to an event. - - The event stream message to be converted. - The event - - - - Abstraction for cross-framework initiation of the background thread. - - - - - The background thread main loop. It will constantly read from the network stream until IsProcessing is false, or an error occurs. - - This stub exists due to FXCop. - - - - - The background thread main loop. It will constantly read from the network stream until IsProcessing is false, or an error occurs. - - Needed for 3.5 support. Not used. - - - - Reads from the stream into the buffer. It then passes the buffer to the decoder, which raises an event for - each message it decodes. - - The buffer to store the read bytes from the stream. - - - - Wraps exceptions in an outer exception so they can be passed to event handlers. If the Exception is already of a compatable type, - the method returns what it was given. - - The exception to wrap. - An exception of type TE - - - - Starts the background thread to start reading events from the network stream. - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Disposes the resources of this stream. - - Should dispose of unmanged resources. - - - - Event Arguments for EventStreamDecoder.MessageReceived. - - - - - Received message. - - - - - Additional object context - - - - - Initialize this with message - - - - - Initialize this with message and object conetext - - - - - Exception thrown when a request is made of the Decoder, but the internal state - machine is an invalid state. This is usually the result of an interanl exception - being thrown during parsing of the network stream. - - - - - Contract for EventStreamDecoder - - - - - Invoked anytime an EventStreamMessage is found. - - - - - Processes data starting at offset up to length. - Invokes MessageRecieved for each message encountered. - If an exception is thrown, this object is not safe for reuse. - - buffer to read - offset in buffer to start reading. - length of data. - - - - Streaming decoder for listening for incoming EventStreamMessage datagrams. - - - - - Invoked anytime an EventStreamMessage is found. - - - - - Object data (optional) that can be passed to the event handler for MessageReceived. - - - - - Default constructor. Initializes internal _state machine. - - - - - Processes data starting at offset up to length. - Invokes MessageRecieved for each message encountered. - If an exception is thrown, this object is not safe for reuse. - - buffer to read - offset in buffer to start reading. - length of data. - - - - Superclass for Exceptions that come over the event stream, or to wrap other kinds of generic exceptions. - - - - - Constructs an EventStreamException. - - - - - Constructs an EventStreamException. - - The exception message. - - - - Constructs an EventStreamException. - - The exception message. - The inner exception. - - - - The contract for EventStream events. - - - - - The contract for EventStream terminal events. - - - - - This Event is returned if an event is retrieved from the event stream, but a generator function - for the event is not defined. This can occur if the SDK is not updated after a new event type is introduced. - - - - - The Message recieved from the event stream before conversion. - - - - - The event type. - - - - - Constructs an UnknownEventStreamEvent. - - - - - Constructs an UnknownEventStreamEvent. - - The Message recieved from the event stream before conversion. - The event type. - - - - Signals that an an has an unknown message type. These exceptions whould be - swallowed to allow future expansion of the EventStream specification without breaking existing clients. - - - - - Constructs an UnknownEventStreamMessageTypeException. - - - - - This exception is thrown if an exception is retrieved from the event stream and should be modeled, - but a generator function for the strongly-typed exception is not defined. - - - - - The exception type. - - - - - Constructs an EventStreamException. - - The exception type. - - - - All Amazon service interfaces like IAmazonS3 extend from this interface. This allows all the - Amazon service interfaces be identified by this base interface and helps with generic constraints. - - - - - A readonly view of the configuration for the service client. - - - - - This interface is the read only access to the ClientConfig object used when setting up service clients. Once service clients - are initiated the config object should not be changed to avoid issues with using a service client in a multi threaded environment. - - - - - Gets the RegionEndpoint property. The region constant to use that - determines the endpoint to use. If this is not set - then the client will fallback to the value of ServiceURL. - - - - - The constant used to lookup in the region hash the endpoint. - - - - - Gets and sets of the ServiceURL property. - This is an optional property if you need to set a specific service URL - instead setting the region with the RegionEndpoint property. - - - - - Gets the UseHttp property. - If this property is set to true, the client attempts - to use HTTP protocol. - By default, this property is set to false. - - - - - Gets Service Version - - - - - Gets the signatureMethod property. - - - - - Gets the SignatureVersion property. - - Note: This property exists for backward compatibility but is no longer - used by any service other than S3. - - - - - Gets the AuthenticationRegion property. - Used in AWS4 request signing, this is an optional property; - change it only if the region cannot be determined from the - service endpoint. - - - - - Gets the AuthenticationServiceName property. - Used in AWS4 request signing, this is the short-form - name of the service being called. - - - - - Gets the UserAgent property. - - - - - Gets the DisableLogging. If true logging for this client will be disabled. - - - - - Flag on whether to log metrics for service calls. - - This can be set in the application's configs, as below: - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSLogMetrics" value"true"/> - </appSettings> - </configuration> - - - - - - Gets the LogResponse property. - If this property is set to true, the service response - is read in its entirety and logged. - - - - - Gets the ReadEntireResponse. - If this property is set to true, the service response - is read in its entirety before being processed. - - - - - This flag controls if .NET HTTP infrastructure should follow redirection - responses (e.g. HTTP 307 - temporary redirect). - - - - - Gets the BufferSize property. - The BufferSize controls the buffer used to read in from input streams and write - out to the request. - - - - - Gets the MaxErrorRetry property. - - - - - Gets the interval at which progress update events are raised - for upload operations. By default, the progress update events are - raised at every 100KB of data transferred. - - - - - Flag on whether to resign requests on retry or not. - - - - - Credentials to use with a proxy. - - - - - Gets the default request timeout value. - - - - If the value is set, the value is assigned to the Timeout property of the HTTPWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - - - - Configures the endpoint calculation for a service to go to a dual stack (ipv6 enabled) endpoint - for the configured region. - - - Note: AWS services are enabling dualstack endpoints over time. It is your responsibility to check - that the service actually supports a dualstack endpoint in the configured region before enabling - this option for a service. - - - - - Configures a flag enabling to either opt in or opt out of the retry throttling service. - Note: set value to true to enable retry throttling feature. The Default value for this flag is false. - - - - - Using either the RegionEndpoint or the ServiceURL determine what the URL to the service is. - - The URL to the service. - - - - Performs validation on this config object. - Throws exception if any of the required values are missing/invalid. - - The timeout specified is null. - - - - Returns the clock skew adjusted utc now. This value is affected by AWSConfigs.ManualClockCorrection - - - - - Returns the calculated clock skew value for this config's service endpoint. If AWSConfigs.CorrectForClockSkew is false, - this value won't be used to construct service requests. - - - - - Gets the DisableHostPrefixInjection flag. If true, host prefix injection will be disabled for this client, the default value of this flag is false. - Host prefix injection prefixes the service endpoint with request members from APIs which use this feature. - Example: for a hostPrefix of "foo-name." and a endpoint of "service.region.amazonaws.com" the default behavior is to - prefix the endpoint with the hostPrefix resulting in a final endpoint of "foo-name.service.region.amazonaws.com". Setting - DisableHostPrefixInjection to true will disable hostPrefix injection resulting in a final endpoint of - "service.region.amazonaws.com" regardless of the value of hostPrefix. E.g. You may want to disable host prefix injection for testing against a local mock endpoint. - - - - - Returns the flag indicating if endpoint discovery should be enabled or disabled for operations that are not required to use endpoint discovery. - - - - - Returns the maximum number of discovered endpoints that can be stored within the cache for the client. The default limit is 1000 cache entries. - - - - - Get the value to use for on requests. - If this property is null, - will be left at its default value of . - - - - - - This is a switch used for performance testing and is not intended for production applications - to change. This switch may be removed in a future version of the SDK as the .NET Core platform matures. - - - If true, the HttpClient is cached and reused for every request made by the service client - and shared with other service clients. - - - For the .NET Core platform this is default to true because the HttpClient manages the connection - pool. - - - - - - If CacheHttpClient is set to true then HttpClientCacheSize controls the number of HttpClients cached. - - - - - Gets the ProxyHost property. - - - - - Gets the ProxyPort property. - - - - - Returns a WebProxy instance configured to match the proxy settings - in the client configuration. - - - - - - Interface for a single logged message. - - - - - Log message format. - - - - - Log message arguments. - - - - - Culture-specific formatting provider. - - - - - Abstract parameter value. - - - - - String parameter value. - - - - - String value of the parameter. - - - - - Constructs ParameterValue for a single string. - - - - - - String list parameter value. - - - - - List of strings value of the parameter. - - - - - Constructs ParameterValue for a list of strings. - - - - - - The interface for an exception handler. - - - - - Handles an exception for the given execution context. - - The execution context, it contains the - request and response context. - The exception to handle. - - Returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception to replace the original exception. - - - - - The interface for an exception handler with a generic parameter for the exception type. - - The exception type. - - - - Handles an exception for the given execution context. - - The execution context, it contains the - request and response context. - The exception to handle. - - Returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception to replace the original exception. - - - - - The interface for a HTTP request factory. - - The type used by the underlying HTTP API to represent the request body. - - - - Creates an HTTP request for the given URI. - - The request URI. - An HTTP request. - - - - The interface for an HTTP request that is agnostic of the underlying HTTP API. - - The type used by the underlying HTTP API to represent the HTTP request content. - - - - The HTTP method or verb. - - - - - The request URI. - - - - - Configures a request as per the request context. - - The request context. - - - - Sets the headers on the request. - - A dictionary of header names and values. - - - - Gets a handle to the request content. - - The request content. - - - - Returns the HTTP response. - - The HTTP response. - - - - Writes a stream to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - The request context. - - - - Writes a byte array to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - - - - Sets up the progress listeners - - The content stream - The interval at which progress needs to be published - The objects which is trigerring the progress changes - The callback which will be invoked when the progress changed event is trigerred - an object, incase the progress is setup, else returns the original stream - - - - Aborts the HTTP request. - - - - - Gets a handle to the request content. - - - - - - Returns the HTTP response. - - A cancellation token that can be used to cancel the asynchronous operation. - - - - - A factory which creates HTTP clients. - - - - - Create and configure an HttpClient. - - - - - - If true the SDK will internally cache the clients created by CreateHttpClient. - If false the sdk will not cache the clients. - Override this method to return false if your HttpClientFactory will handle its own caching - or if you don't want clients to be cached. - - - - - - - Determines if the SDK will dispose clients after they're used. - If HttpClients are cached, either by the SDK or by your HttpClientFactory, this should be false. - If there is no caching then this should be true. - - - - - - - Returns a string that's used to group equivalent HttpClients into caches. - This method isn't used unless UseSDKHttpClientCaching returns true; - - A null return value signals the SDK caching mechanism to cache HttpClients per SDK client. - So when the SDK client is disposed, the HttpClients are as well. - - A non-null return value signals the SDK that HttpClients created with the given clientConfig - should be cached and reused globally. ClientConfigs that produce the same result for - GetConfigUniqueString will be grouped together and considered equivalent for caching purposes. - - - - - - - A factory which creates HTTP requests which uses System.Net.Http.HttpClient. - - - - - The constructor for HttpRequestMessageFactory. - - Configuration setting for a client. - - - - Creates an HTTP request for the given URI. - - The request URI. - An HTTP request. - - - - Disposes the HttpRequestMessageFactory. - - - - - Dispose the factory - - - - - - Create and configure a managed HttpClient instance. - The use of HttpClientHandler in the constructor for HttpClient implicitly creates a managed HttpClient. - - - - - - - A cache of HttpClient objects. The GetNextClient method does a round robin cycle through the clients - to distribute the load even across. - - - - - Constructs a container for a cache of HttpClient objects - - The HttpClient to cache - - - - Returns the next HttpClient using a round robin rotation. It is expected that individual clients will be used - by more then one Thread. - - - - - - Disposes the HttpClientCache. - - - - - Dispose the HttpClientCache - - - - - - HTTP request wrapper for System.Net.Http.HttpRequestMessage. - - - - - Set of content header names. - - - - - The constructor for HttpWebRequestMessage. - - The HttpClient used to make the request. - The request URI. - The service client config. - - - - The underlying HttpClient - - - - - The underlying HTTP web request. - - - - - The HTTP method or verb. - - - - - The request URI. - - - - - Configures a request as per the request context. - - The request context. - - - - Sets the headers on the request. - - A dictionary of header names and values. - - - - Gets a handle to the request content. - - The request content. - - - - Returns the HTTP response. - - The HTTP response. - - - - Aborts the HTTP request. - - - - - Returns the HTTP response. - - A cancellation token that can be used to cancel the asynchronous operation. - - - - - Writes a stream to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - The request context. - - - - Writes a byte array to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - - - - Gets a handle to the request content. - - - - - - Disposes the HttpWebRequestMessage. - - - - - - - - - - - Sets up the progress listeners - - The content stream - The interval at which progress needs to be published - The objects which is trigerring the progress changes - The callback which will be invoked when the progress changed event is trigerred - an object, incase the progress is setup, else returns the original stream - - - - Interface for a handler in a pipeline. - - - - - The logger used to log messages. - - - - - The inner handler which is called after the current - handler completes it's processing. - - - - - The outer handler which encapsulates the current handler. - - - - - Contains the processing logic for a synchronous request invocation. - This method should call InnerHandler.InvokeSync to continue processing of the - request by the pipeline, unless it's a terminating handler. - - The execution context which contains both the - requests and response context. - - - - Contains the processing logic for an asynchronous request invocation. - This method should call InnerHandler.InvokeSync to continue processing of the - request by the pipeline, unless it's a terminating handler. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - A retry policy specifies all aspects of retry behavior. This includes conditions when the request should be retried, - checks of retry limit, preparing the request before retry and introducing delay (backoff) before retries. - - - A retry policy specifies all aspects of retry behavior. This includes conditions when the request should be retried, - checks of retry limit, preparing the request before retry and introducing delay (backoff) before retries. - - - - - Maximum number of retries to be performed. - This does not count the initial request. - - - - - The logger used to log messages. - - - - - Checks if a retry should be performed with the given execution context and exception. - - The execution context which contains both the - requests and response context. - The exception thrown after issuing the request. - Returns true if the request should be retried, else false. The exception is retried if it matches with clockskew error codes. - - - - Returns true if the request is in a state where it can be retried, else false. - - The execution context which contains both the - requests and response context. - Returns true if the request is in a state where it can be retried, else false. - - - - Return true if the request should be retried for the given exception. - - The execution context which contains both the - requests and response context. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Checks if the retry limit is reached. - - The execution context which contains both the - requests and response context. - Return false if the request can be retried, based on number of retries. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called on a successful request response. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called before a retry request is initiated. The value - returned is True by default(retry throttling feature is disabled). - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called before a retry request is initiated. The value - returned is True by default(retry throttling feature is disabled). - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - - - - Checks if a retry should be performed with the given execution context and exception. - - The execution context which contains both the - requests and response context. - The exception throw after issuing the request. - Returns true if the request should be retried, else false. The exception is retried if it matches with clockskew error codes. - - - - Return true if the request should be retried for the given exception. - - The execution context which contains both the - requests and response context. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - Metrics collected by the SDK on a per-request basis. - - - Each request made to an AWS service by the SDK can have metrics - collected and logged. This interface represents the collected - metrics for a request. The metrics include properties (i.e. request id - and other metadata), timings for each stage of the request, and counters. - - - - - Collection of properties being tracked - - - - - Timings for metrics being tracked - - - - - Counters being tracked - - - - - Whether metrics are enabled for the request - - - - - JSON representation of the current metrics - - JSON string - - - - Represents how long a phase of an SDK request took. - - - - - Whether the timing has been stopped - - - - - Elapsed ticks from start to stop. - If timing hasn't been stopped yet, returns 0. - - - - - Elapsed time from start to stop. - If timing hasn't been stopped yet, returns TimeSpan.Zero - - - - - User supplied type to perform metrics formatting. - - - - - Produce custom formatting for SDK metrics. - - - If defined, this method will be called for every request made by the SDK. - - An instance of IRequestMetrics produced by the SDK - formatted string representation of the metrics - - - - Predefined request metrics that are collected by the SDK. - - - - - Information about the request. - - - - - Gets and sets the RequestId property. - ID that uniquely identifies a request. Amazon keeps track of request IDs. If you have a question about a request, include the request ID in your correspondence. - - - - - ICoreAmazonKMS is not meant to be used directly. It defines Key Management Service - with basic .NET types and allows other services to be able to use the service as - a runtime dependency. This interface is implemented by the AmazonKeyManagementServiceClient - defined in the AWSSDK.KeyManagementService assembly. - - - - - The result of the GenerateDataKey and GenerateDataKeyAsync operations. - - - - - The plaintext for the data key. - - - - - The ciphertext for the data key. - - - - - ICoreAmazonS3 is not meant to use directly. It defines S3 with basic .NET types - and allows other services to be able to use S3 as a runtime dependency. This interface - is implemented by the AmazonS3Client defined in the S3 assembly. - - - ICoreAmazonS3 is not meant to use directly. It defines S3 with basic .NET types - and allows other services to be able to use S3 as a runtime dependency. This interface - is implemented by the AmazonS3Client defined in the S3 assembly. - - - - - Generate a presigned URL. - - - - - - - - - - Get all the object keys for the particular bucket and key prefix. - - - - - - - - - Upload an object from a stream. - - - - - - - - - - - Delete an object. - - - - - - - - - - Delete an object. - - - - - - - - - - Open a stream to an object in S3. - - - - - - - - - - Upload an object from a file path. - - - - - - - - - - - Download an object in S3 to a file path. - - - - - - - - - - - Set the ACL on the object to public readable. - - - - - - - - Check to see if the bucket exists and if it doesn't create the bucket. - - - - - - Check to see if the bucket exists. - - - - - - - ICoreAmazonSQS is not meant to use directly. It defines SQS with basic .NET types - and allows other services to be able to use SQS as a runtime dependency. This interface - is implemented by the AmazonSQSClient defined in the SQS assembly. - - - - - Get the attributes for the queue identified by the queue URL asynchronously. - - The queue URL to get attributes for. - A Task containing the result of a dictionary of attributes for the queue. - - - - Set the attributes on the queue identified by the queue URL asynchronously. - - The queue URL to set the attributues. - The attributes to set. - A Task - - - - ICoreAmazonSTS is not meant to be used directly. It defines Security Token - service with basic .NET types and allows other services to be able to use the service as - a runtime dependency. This interface is implemented by the AmazonSecurityTokenServiceClient - defined in the AWSSDK.SecurityToken assembly. - - - - - - This method is used internally to access the Amazon Security Token - service within other service assemblies. - Please use AmazonSecurityTokenServiceClient to access the Amazon Security Token - service instead. - - Use Amazon Security Token Service to assume a role. - - Proxy settings that are required for the HTTPS and STS calls made during the authentication/credential - generation process are supported and should have been configured on the STS ClientConfig instance - associated with the STS client instance exposing this interface. - - - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRole. - - - - - - This method is used internally to access the Amazon Security Token - service within other service assemblies. - Please use AmazonSecurityTokenServiceClient to access the Amazon Security Token - service instead. - - Use Amazon Security Token Service to assume a role. - - Proxy settings that are required for the HTTPS and STS calls made during the authentication/credential - generation process are supported and should have been configured on the STS ClientConfig instance - associated with the STS client instance exposing this interface. - - - The web identity token used to assume the role. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRoleWithWebIdentity - - - - - - This method is used internally to access the Amazon Security Token - service within other service assemblies. - Please use AmazonSecurityTokenServiceClient to access the Amazon Security Token - service instead. - - Use Amazon Security Token Service to assume a role. - - Proxy settings that are required for the HTTPS and STS calls made during the authentication/credential - generation process are supported and should have been configured on the STS ClientConfig instance - associated with the STS client instance exposing this interface. - - - The web identity token used to assume the role. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRoleWithWebIdentity - - - - - CoreAmazonKMS is not meant to use directly. It implements ICoreAmazonKMS - and allows other service clients to be able to use the KMS service as a runtime dependency. - - This class waits until a method is actually called on the ICoreAmazonKMS interface - before requiring the KMS assembly to be present and loaded. - - - - - This exception is thrown if there are problems signing the request. - - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - - - - Gets the percentage of transfer completed - - - - - Gets the number of bytes transferred since last event - - - - - Gets the number of bytes transferred - - - - - Gets the total number of bytes to be transferred - - - - - Returns a string representation of this object - - - - - - Settings for configuring a proxy for the SDK to use. - - - - - The host name or IP address of the proxy server. - - - - - The port number of the proxy. - - - - - The username to authenticate with the proxy server. - - - - - The password to authenticate with the proxy server. - - - - - Collection of one or more regular expressions denoting addresses - for which the proxy will not be used. - - - For more information on bypass lists - see https://msdn.microsoft.com/en-us/library/system.net.webproxy.bypasslist%28v=vs.110%29.aspx. - - - - - If true requests to local addresses bypass the configured - proxy. - - - - - Settings for logging in the SDK. - - - - - Logging destination. - - - - - When to log responses. - - - - - Gets or sets the size limit in bytes for logged responses. - If logging for response body is enabled, logged response - body is limited to this size. The default limit is 1KB. - - - - - Whether or not to log SDK metrics. - - - - - A custom formatter added through Configuration - - - - - This class can be used to discover the public address ranges for AWS. The - information is retrieved from the publicly accessible - https://ip-ranges.amazonaws.com/ip-ranges.json file. - - - The information in this file is generated from our internal system-of-record and - is authoritative. You can expect it to change several times per week and should - poll accordingly. - - - - - Region identifier string for ROUTE53 and CLOUDFRONT ranges - - - - - Collection of service keys found in the data file. - - - - - The publication date and time of the file that was downloaded and parsed. - - - - - Collection of all public IP ranges. - - - - - Filtered collection of public IP ranges for the given service key - - - - - Filtered collection of public IP ranges for the given region (us-east-1 etc) or GLOBAL. - - - - - Downloads the most recent copy of the endpoint address file and - parses it to a collection of address range objects. - - - - - Downloads the most recent copy of the endpoint address file and - parses it to a collection of address range objects. - - - - - Represents the IP address range for a single region and service key. - - - - - The public IPv4 or Ipv6 address range, in CIDR notation. - - - - - Indicates ipv4 or v6 format of the address - - - - - The AWS region or GLOBAL for edge locations. Note that the CLOUDFRONT and ROUTE53 - ranges are GLOBAL. - - - - - The subset of IP address ranges. Specify AMAZON to get all IP address ranges - (for example, the ranges in the EC2 subset are also in the AMAZON subset). Note - that some IP address ranges are only in the AMAZON subset. - - - Valid values for the service key include "AMAZON", "EC2", "ROUTE53", - "ROUTE53_HEALTHCHECKS", and "CLOUDFRONT." If you need to know all of - the ranges and don't care about the service, use the "AMAZON" entries. - The other entries are subsets of this one. Also, some of the services, - such as S3, are represented in "AMAZON" and do not have an entry that - is specific to the service. We plan to add additional values over time; - code accordingly! - - - - - This class defines utilities and constants that can be used by - all the client libraries of the SDK. - - - - - The user agent string header - - - - - The Set of accepted and valid Url characters per RFC3986. - Characters outside of this set will be encoded. - - - - - The Set of accepted and valid Url characters per RFC1738. - Characters outside of this set will be encoded. - - - - - The set of accepted and valid Url path characters per RFC3986. - - - - - The string representing Url Encoded Content in HTTP requests - - - - - The GMT Date Format string. Used when parsing date objects - - - - - The ISO8601Date Format string. Used when parsing date objects - - - - - The ISO8601Date Format string. Used when parsing date objects - - - - - The ISO8601 Basic date/time format string. Used when parsing date objects - - - - - The ISO8601 basic date format. Used during AWS4 signature computation. - - - - - The RFC822Date Format string. Used when parsing date objects - - - - - Returns an extension of a path. - This has the same behavior as System.IO.Path.GetExtension, but does not - check the path for invalid characters. - - - - - - Convert request parameters to Url encoded query string - - - Convert Dictionary of parameters to Url encoded query string - - - - Returns the canonicalized resource path for the service endpoint with single URL encoded path segments. - - Endpoint URL for the request - Resource path for the request - - If resourcePath begins or ends with slash, the resulting canonicalized - path will follow suit. - - Canonicalized resource path for the endpoint - - - - Returns the canonicalized resource path for the service endpoint - - Endpoint URL for the request - Resource path for the request - If true pre URL encode path segments if necessary. - S3 is currently the only service that does not expect pre URL encoded segments. - - If resourcePath begins or ends with slash, the resulting canonicalized - path will follow suit. - - Canonicalized resource path for the endpoint - - - - Returns the canonicalized resource path for the service endpoint - - Endpoint URL for the request - Resource path for the request - If true pre URL encode path segments if necessary. - S3 is currently the only service that does not expect pre URL encoded segments. - Dictionary of key/value parameters containing the values for the ResourcePath key replacements - The version of the marshaller that constructed the request object. - - If resourcePath begins or ends with slash, the resulting canonicalized - path will follow suit. - - Canonicalized resource path for the endpoint - - - - Splits the resourcePath at / into segments then resolves any keys with the path resource values. Greedy - key values will be split into multiple segments at each /. - - The patterned resourcePath - The key/value lookup for the patterned resourcePath - A list of path segments where all keys in the resourcePath have been resolved to one or more path segment values - - - - Joins all path segments with the / character and encodes each segment before joining. - - The segments of a URL path split at each / character - If the path property is specified, - the accepted path characters {/+:} are not encoded. - A joined URL with encoded segments - - - - Takes a patterned resource path and resolves it using the key/value path resources into - a segmented encoded URL. - - The patterned resourcePath - The key/value lookup for the patterned resourcePath - A segmented encoded URL - - - - Returns a new string created by joining each of the strings in the - specified list together, with a comma between them. - - The list of strings to join into a single, comma delimited - string list. - A new string created by joining each of the strings in the - specified list together, with a comma between strings. - - - - Attempt to infer the region for a service request based on the endpoint - - Endpoint to the service to be called - - Region parsed from the endpoint; DefaultRegion (or DefaultGovRegion) - if it cannot be determined/is not explicit - - - - - Attempt to infer the service name for a request (in short form, eg 'iam') from the - service endpoint. - - Endpoint to the service to be called - - Short-form name of the service parsed from the endpoint; empty string if it cannot - be determined - - - - - Utility method for converting Unix epoch seconds to DateTime structure. - - The number of seconds since January 1, 1970. - Converted DateTime structure - - - - Helper function to format a byte array into string - - The data blob to process - If true, returns hex digits in lower case form - String version of the data - - - - Calls a specific EventHandler in a background thread - - - - - - - - Parses a query string of a URL and returns the parameters as a string-to-string dictionary. - - - - - - - Utility method for converting a string to a MemoryStream. - - - - - - - Utility method for copy the contents of the source stream to the destination stream. - - - - - - - Utility method for copy the contents of the source stream to the destination stream. - - - - - - - - Formats the current date as a GMT timestamp - - A GMT formatted string representation - of the current date and time - - - - - Formats the current date as ISO 8601 timestamp - - An ISO 8601 formatted string representation - of the current date and time - - - - - Gets the ISO8601 formatted timestamp that is minutesFromNow - in the future. - - The number of minutes from the current instant - for which the timestamp is needed. - The ISO8601 formatted future timestamp. - - - - Formats the current date as ISO 8601 timestamp - - An ISO 8601 formatted string representation - of the current date and time - - - - - Gets the RFC822 formatted timestamp that is minutesFromNow - in the future. - - The number of minutes from the current instant - for which the timestamp is needed. - The ISO8601 formatted future timestamp. - - - - Determines whether the given string is an absolute path to a root. - - The hypothetical absolute path. - True if is an absolute path. - - - - Returns true if the path specified is relative to the current drive or working directory. - Returns false if the path is fixed to a specific drive or UNC path. This method does no - validation of the path (URIs will be returned as relative as a result). - - - Handles paths that use the alternate directory separator. It is a frequent mistake to - assume that rooted paths (Path.IsPathRooted) are not relative. This isn't the case. - "C:a" is drive relative- meaning that it will be resolved against the current directory - for C: (rooted, but relative). "C:\a" is rooted and not relative (the current directory - will not be used to modify the path). - - - - - True if the given character is a directory separator. - - - - - Returns true if the given character is a valid drive letter - - - - - URL encodes a string per RFC3986. If the path property is specified, - the accepted path characters {/+:} are not encoded. - - The string to encode - Whether the string is a URL path or not - The encoded string - - - - URL encodes a string per the specified RFC. If the path property is specified, - the accepted path characters {/+:} are not encoded. - - RFC number determing safe characters - The string to encode - Whether the string is a URL path or not - The encoded string - - Currently recognised RFC versions are 1738 (Dec '94) and 3986 (Jan '05). - If the specified RFC is not recognised, 3986 is used by default. - - - - - URL encodes a string per the specified RFC with the exception of preserving the encoding of previously encoded slashes. - If the path property is specified, the accepted path characters {/+:} are not encoded. - - The string to encode - Whether the string is a URL path or not - The encoded string with any previously encoded %2F preserved - - - - Convert bytes to a hex string - - Bytes to convert. - Hexadecimal string representing the byte array. - - - - Convert a hex string to bytes - - Hexadecimal string - Byte array corresponding to the hex string. - - - - Returns DateTime.UtcNow + ManualClockCorrection when - is set. - This value should be used instead of DateTime.UtcNow to factor in manual clock correction - - - - - Returns true if the string has any bidirectional control characters. - - - - - - - Executes an HTTP request and returns the response as a string. This method - throws WebException and HttpRequestException. In the event HttpRequestException - is thrown the StatusCode is sent as user defined data on the exception under - the key "StatusCode". - - The URI to make the request to - The request type: GET, PUT, POST - null or the content to send with the request - Timeout for the request - Proxy for the request - null or any headers to send with the request - The response as a string. - - - - Utility method that accepts a string and replaces white spaces with a space. - - - - - - - Runs a process with the below input parameters. - - - - - - - This method is used preserve the stacktrace used from clients that support async calls. This - make sure that exceptions thrown during EndXXX methods has the orignal stacktrace that happen - in the background thread. - - - - - - Provides access to EC2 instance metadata when running on an EC2 instance. - If this class is used on a non-EC2 instance, the properties in this class - will return null. - - - - Amazon EC2 instances can access instance-specific metadata, as well as data supplied when launching the instances, using a specific URI. - - - You can use this data to build more generic AMIs that can be modified by configuration files supplied at launch time. - For example, if you run web servers for various small businesses, they can all use the same AMI and retrieve their content from the - Amazon S3 bucket you specify at launch. To add a new customer at any time, simply create a bucket for the customer, add their content, - and launch your AMI. - - - More information about EC2 Metadata - - - - - - - - - - Allows to configure the proxy used for HTTP requests. The default value is null. - - - - - The AMI ID used to launch the instance. - - - - - The index of this instance in the reservation. - - - - - The manifest path of the AMI with which the instance was launched. - - - - - The AMI IDs of any instances that were rebundled to create this AMI. - Will only exist if the AMI manifest file contained an ancestor-amis key. - - - - - The private hostname of the instance. - In cases where multiple network interfaces are present, - this refers to the eth0 device (the device for which the device number is 0). - - - - - Notifies the instance that it should reboot in preparation for bundling. - Valid values: none | shutdown | bundle-pending. - - - - - The ID of this instance. - - - - - The type of instance. - - - - - The ID of the kernel launched with this instance, if applicable. - - - - - The local hostname of the instance. In cases where multiple network interfaces are present, - this refers to the eth0 device (the device for which device-number is 0). - - - - - The instance's MAC address. In cases where multiple network interfaces are present, - this refers to the eth0 device (the device for which device-number is 0). - - - - - The private IP address of the instance. In cases where multiple network interfaces are present, - this refers to the eth0 device (the device for which device-number is 0). - - - - - The Availability Zone in which the instance launched. - - - - - Product codes associated with the instance, if any. - - - - - Public key. Only available if supplied at instance launch time. - - - - - The ID of the RAM disk specified at launch time, if applicable. - - - - - The region in which the instance is running, extracted from the identity - document data. - - - - - ID of the reservation. - - - - - The names of the security groups applied to the instance. - - - - - Returns information about the last time the instance profile was updated, - including the instance's LastUpdated date, InstanceProfileArn, and InstanceProfileId. - - - - - Returns the temporary security credentials (AccessKeyId, SecretAccessKey, SessionToken, and Expiration) - associated with the IAM roles on the instance. - - - - - The virtual devices associated with the ami, root, ebs, and swap. - - - - - The network interfaces on the instance. - - - - - The metadata sent to the instance. - - - - - Value showing whether the customer has enabled detailed - one-minute monitoring in CloudWatch. - - - - - JSON containing instance attributes, such as instance-id, private IP - address, etc - - - - - Data that can be used by other parties to verify its origin and authenticity. - - - - - Used to verify the document's authenticity and content against the signature. - - - - - Return the list of items in the metadata at path. - - Path at which to query the metadata; may be relative or absolute. - List of items returned by the metadata service - - - - Return the metadata at the path - - Path at which to query the metadata; may be relative or absolute. - Data returned by the metadata service - - - - Return the metadata at the path - - Path at which to query the metadata; may be relative or absolute. - Number of attempts to make - Data returned by the metadata service - - - - Return the list of items in the metadata at path. - - Path at which to query the metadata; may be relative or absolute. - Number of attempts to make - List of items returned by the metadata service - - - - Fetches the api token to use with metadata requests. - - The API token or null - - - - Fetches the api token to use with metadata requests. - - The number of tries to fetch the api token before giving up and throwing the web exception - The API token or null if an API token couldn't be obtained and doesn't need to be used - - - - Exponentially sleeps based on the current retry value. A lower - value will sleep shorter than a larger value - - Base 0 retry index - - - - Returns information about the last time the instance profile was updated, - including the instance's LastUpdated date, InstanceProfileArn, and InstanceProfileId. - - - - - The status of the instance profile - - - - - Further information about the status of the instance profile - - - - - The date and time the instance profile was updated - - - - - The Amazon Resource Name (ARN) of the instance profile - - - - - The Id of the instance profile - - - - - The temporary security credentials (AccessKeyId, SecretAccessKey, SessionToken, and Expiration) associated with the IAM role. - - - - - The status of the security credential - - - - - Further information about the status of the instance profile - - - - - The date and time the security credential was last updated - - - - - The type of the security credential - - - - - The uniqe id of the security credential - - - - - The secret key used to sign requests - - - - - The security token - - - - - The date and time when these credentials expire - - - - - All of the metadata associated with a network interface on the instance. - - - - - Construct an instance of NetworkInterface - - - - - - The interface's Media Access Control (mac) address. - - - - - The ID of the owner of the network interface. - - - In multiple-interface environments, an interface can be attached by a third party, such as Elastic Load Balancing. - Traffic on an interface is always billed to the interface owner. - - - - - The interface's profile - - - - - The interface's local hostname. - - - - - The private IP addresses associated with the interface. - - - - - The interface's public hostname. - - - - - The elastic IP addresses associated with the interface. - - - There may be multiple IP addresses on an instance. - - - - - Security groups to which the network interface belongs. - - - - - IDs of the security groups to which the network interface belongs. Returned only for Amazon EC2 instances launched into a VPC. - - - - - The ID of the Amazon EC2-VPC subnet in which the interface resides. - - - Returned only for Amazon EC2 instances launched into a VPC. - - - - - The CIDR block of the Amazon EC2-VPC subnet in which the interface resides. - - - Returned only for Amazon EC2 instances launched into a VPC. - - - - - The CIDR block of the Amazon EC2-VPC subnet in which the interface resides. - - - Returned only for Amazon EC2 instances launched into a VPC. - - - - - Get the private IPv4 address(es) that are associated with the public-ip address and assigned to that interface. - - The public IP address - Private IPv4 address(es) associated with the public IP address - - - - Wrapper class which invokes the static method - public static string GetEnvironmentVariable(string variable) - underneath. This class is added as a property on the singleton class - EnvironmentVariableSource. This change was done for testability. - - - - - Singleton class that holds the property of type IEnvironmentVariableRetreiver. - This property can hold an instance of type EnvironmentVariableRetreiver which has a wrapper - method for - public static string GetEnvironmentVariable(string variable) - or can be mocked for testing purposes. - - - - - Interface for EnvironmentVariableRetriever. - This serves as a property for the singleton EnvironmentVariableSource - - - - - Returns the type of platform and version.!-- If on a special platform, a static "0" is used as the version since - we have nothing more specific that actually means anything. Otherwise, asks InteropServices RuntimeInformation for - the OSDescription and trims off the OS name. - - - - - Returns the special platform information (e.g. Unity_OSXEditor, Xamarin_AndroidTablet) if - on those platforms, otherwise asks InteropServices RuntimeInformation for the OSDescription - and trims off the version. - - - - - Returns the special platform information (e.g. Unity_OSXEditor, Xamarin_AndroidTablet) if - on those platforms, otherwise asks InteropServices RuntimeInformation for the OSDescription, - keeping the version tail. - - - - - Manager to access a settings store file. Objects are primarily accessed by DisplayName rather than unique key. - Settings store files are located under the current user's AppData\Local\AWSToolkit folder. - Select keys in these files are encrypted on a per user, per machine basis using the Windows Data Protection API; - the encrypted values cannot be used by any other user or on any other machine. - - This class is not threadsafe. - - - - - True if the encrypted store is availble, false otherwise. - - - - - Construct an NamedSettingsManager. - - The base filename to read/write. - - - - Register an object. Let the uniqueKey be assigned automatically. - - The display name for the object. - The property names and values for the object. - The unique key that was assigned to the object. - - - - Try to get an object form the store. - - The display name for the object. - The property names and values for the object. - True if the object was found, false otherwise. - - - - Try to get an object form the store. - - The display name for the object. - The uniqueKey of the object in the store - The property names and values for the object. - True if the object was found, false otherwise. - - - - Unregister an object from the store. - - The display name for the object. - - - - Rename an object in the store. - - - - if true and destination object already exists overwrite it - - - - Copy an object in the store. - The new object will be a copy of the original, except it will be assigned a new unique key. - - - - if true and destination object already exists overwrite it - - - - Get a list of the display names for the objects in the store. - - A list of display names. - - - - Root AWS config - - - - - Manager to access a settings store file. - Settings store files are located under the current user's AppData\Local\AWSToolkit folder. - Select keys in these files are encrypted on a per user, per machine basis using the Windows Data Protection API; - the encrypted values cannot be used by any other user or on any other machine. - - This class is not threadsafe. - - - - - True if the encrypted store is availble, false otherwise. - - - - - Construct a SettingsManager. - - The base filename to read/write. - - - - The base filename to read/write. - - - - - Register an object. Let the uniqueKey be assigned automatically. - - The property names and values for the object. - The unique key that was assigned to the object. - - - - Register an object. - - The uniqueKey for the object, or null if one should be assigned automatically. - The property names and values for the object. - The unique key that was assigned to the object. - - - - Try to get an object form the store. - - The uniqueKey of the object in the store - The property names and values for the object. - True if the object was found, false otherwise. - - - - Try to get an object form the store based on the value of a specific property. - If multiple objects with the same property value exist, return the first one. - - The name of the property to search on. - The value of the property to search on. - The unique key of the object. - The properties of the object. - - - - - Get a list of the unique keys of all the objects in the store. - - - - - - Get the value of a specific property for each object in the store. - - - - - - - Unregister an object from the store. - - The unique key for the object. - - - - Class that contains result of executing an external process through the SDKs - AWSSDKUtils.RunProcess/AWSSDKUtils.RunProcessAsync - - - - - The exit code with which the process exited - - - - - The output of the process read till the end - - - - - The error output of the process read till the end - - - - - This class allows profiles supporting AWS credentials and SAML-based authentication to be registered with - the SDK so that they can later be reference by a profile name. The credential profiles will be available - for use in the AWS Toolkit for Visual Studio and the AWS Tools for Windows PowerShell. - - The credentials are stored under the current users AppData folder encrypted using Windows Data Protection API. - - - To reference a profile from an application's App.config or Web.config use the AWSProfileName setting. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="development"/> - </appSettings> - </configuration> - - - - - - - Registers an AWS credentials profile that can later be referenced by the profileName. - This profile will only be visible for the current user. - - Name given to the AWS credentials. - The AWS access key id - The AWS secret key - - - - - Registers a role-based profile to be used with SAML authentication. The profile contains - details of the role to be assumed when AWS credentials are requested based on the role and - a reference to a SAML endpoint profile containing details of the endpoint to be called to - authenticate the user. - - - If user identity information is not supplied then the identity of the logged-in user will - be used when authenticaton is performed against the endpoint referenced in the SAML endpoint - profile. If identity is provided, no password information is stored in the role profile and - the user must supply the password for the identity prior to authentication with the endpoint. - - - Name to be assigned to the profile - - The name assigned to the endpoint settings, previously saved with RegisterSAMLEndpoint. - - - The arn of the role that the user wants to assume when using this profile. This - must be one of the set returned by the saml endpoint when the user authenticates. - - - Optional. By default the identity of the logged-in user will be used when authentication - is performed - the user will not be prompted to supply a password. By supplying a custom - identity for this parameter, the user will be prompted to supply the password for the - identity prior to authentication. - - - - - - Registers a role-based profile to be used with SAML authentication. The profile contains - details of the role to be assumed when AWS credentials are requested based on the role and - a reference to a SAML endpoint profile containing details of the endpoint to be called to - authenticate the user. - - - If user identity information is not supplied then the identity of the logged-in user will - be used when authenticaton is performed against the endpoint referenced in the SAML endpoint - profile. If identity is provided, no password information is stored in the role profile and - the user must supply the password for the identity prior to authentication with the endpoint. - - - Name to be assigned to the profile - - The name assigned to the endpoint settings, previously saved with RegisterSAMLEndpoint. - - - The arn of the role that the user wants to assume when using this profile. This - must be one of the set returned by the saml endpoint when the user authenticates. - - - Optional. By default the identity of the logged-in user will be used when authentication - is performed - the user will not be prompted to supply a password. By supplying a custom - identity for this parameter, the user will be prompted to supply the password for the - identity prior to authentication. - - - Set for profiles intended to be used in regions where a region-specific STS endpoint - must be used (eg cn-north-1). If left empty/null, the global sts.amazonaws.com endpoint - will be used when credentials are obtained for this profile. - - - - - Registers an endpoint to be used in conjunction with SAML role profiles. The role profiles - reference the endpoint settings to obtain the actual endpoint and any customization settings - needed to perform authentication. - - Name to be assigned to the endpoint settings. - The full uri of the authentication endpoint. - - The authentication type to use when performing calls against the endpoint. Valid values are 'NTLM', - 'Digest', 'Kerberos' and 'Negotiate'. The default if not configured (null/empty string) is 'Kerberos'. - - The unique id assigned to the new settings. - - - - Deletes the settings for an AWS credentials or SAML role profile from the SDK account store. - - The name of the profile to remove. - - - - Lists all profile names registered with the SDK account store. - - The profile names. - - - - Loads and returns all available credential profiles registered in the store. - - Collection of profiles. - - - - Checks if a given profile is known in the SDK credential store. - - The name of the profile to test for existence - True if the profile exists. - - - - Copies the contents of the source profile to the destination. If the destination - profile does not exist a new profile is created. Note that if the destination - profile exists, all keys it contains are removed and replaced with keys from the - source profile. - - The name of the profile to copy from. - The name of the profile to create or update. - The unique id assigned to the destination settings. - - - - Copies the contents of the source profile to the destination. If the destination - profile does not exist a new profile is created. Note that if the destination - profile exists, all keys it contains are removed and replaced with keys from the - source profile. - - The source profile to copy keys and values from. - The name of the profile to create or update. - The unique id assigned to the destination settings. - - - - Tries to get the AWS credentials from a profile in the SDK account store. - - The profile to get the credentials for. - Outputs the credentials for the profile. - Returns true if the profile exists otherwise false is returned. - - - - Gets the AWS credentials from a profile in the SDK account store. - - The profile to get the credentials for. - The AWS credentials for the profile. - Thrown if the profile does not exist - - - - Returns the profile with the specified name, if it has been registered in the SDK store. - - The name of the registered profile - The loaded profile data - - - - Returns the persisted data in the SDK store as a profile of the specified type T. - - The name of the profile holding the settings. - The loaded profile. An exception is thrown if the profile could not be loaded. - Thrown if the profile does not exist - - Currently supported profile types: AWSCredentialsProfile and SAMLRoleProfile. - - - - - Tries to load the specified profile data corresponding to profile type T from a named - profile in the SDK account store. - - The name of the profile holding the settings. - The loaded profile data. - Returns true if the profile exists otherwise false is returned. - - Currently supported profile types: AWSCredentialsProfile and SAMLRoleProfile. - - - - - Attempts to load the settings defining a SAML endpoint. - - The name assigned to the settings for the endpoint. - The instantiated endpoint. - True if the settings were successfully loaded. - - - - Loads the settings defining a SAML endpoint. - - The name assigned to the settings for the endpoint. - The loaded settings. An exception is thrown if they could not be loaded. - Thrown if the endpoint settings do not exist. - - - - Common base contract for all types of credential and role profiles. - - - - - The user-defined name for the settings. - - - - - The unique id of the profile in the backing store. - - - - - Saves the profile data to backing store, returning the unique id - assigned to the data. - - - - - The persisted data for a set of AWS credentials. At a minimum this - is access key and secret key data. - - - - - Tests if an AWSCredentialsProfile instance could be instantiated from - the persisted settings data. - - The name given to the persisted settings (previously verified as existing). - True if the settings are compatible with an AWSCredentialsProfile type. - - - - Tests if an AWSCredentialsProfile instance could be instantiated from - the persisted settings data. - - The persisted settings. - True if the settings are compatible with an AWSCredentialsProfile type. - - - - Instantiates an AWSCredentialsProfile instance from the specified profile name. - - The name of the profile holding the settings. - New credentials profile instance. An exception is thrown if the profile data is invalid. - - - - Instantiates an AWSCredentialsProfile instance from the supplied settings collection. - - The settings representing the stored profile. - New credentials profile instance. An exception is thrown if the profile data is invalid. - - - - Validates the contents of the specified profile. - - The name of the AWS credentials profile to validate. - Thrown if the profile settings fail to validate. - - - - Verifies that the persisted settings contains the minimal viable data to - instantiate an AWSCredentialsProfile instance. - - The persisted settings. - Thrown if the profile settings fail to validate. - - - - Persists the profile data to the store file. - - The unique ID assigned to the settings. - - - - Creates or updates the profile data in the store file. - - The unique ID assigned to the settings. - - - - The persisted data for a SAML endpoint. One or more role profiles - will reference this to obtain the common endpoint and other data needed - to perform authentication with a set of user credentials. - - - - - The default authentication type to use when attempting to perform an - authentication call against the configured endpoint. - - - - - The authentication endpoint which must be a HTTPS scheme. - - - - - The authentication type to use when calling the endpoint. - - - - - Tests if a SAMLEndpointSettings instance could be instantiated from - the persisted settings data. - - The name given to the persisted settings. - True if the settings are compatible. - - - - Tests if a SAMLEndpointSettings instance could be instantiated from - the persisted settings data. - - The persisted settings. - True if the settings are compatible. - - - - Instantiates an instance from settings stored with the specified name. - - The name of the endpoint settings in the store. - Profile instance or an exception if the profile data does not exist/contains invalid data. - - - - Instantiates an instance from the supplied settings. - - The persisted settings. - Profile instance or an exception if the profile data is invalid. - - - - Validates the contents of the specified endpoint settings. - - The name of the SAML endpoint settings to validate. - Thrown if the settings fail to validate. - - - - Verifies that the persisted settings contains the minimal viable data to - instantiate a SAMLEndpointSettings instance. - - The persisted settings. - Thrown if the settings fail to validate. - - - - Persists the settings to the storage file. - - The unique id assigned to the profile - - - - Creates or updates the settings data for a SAML endpoint in the backing store file. An error is - thrown if the scheme for the endpoint is not https. - - The name of the settings to create or update - The authentication endpoint - Optional authentication type to use when performing calls against the endpoint - The unique id assigned to the profile - - - - Constructs an endpoint settings instance. - - The user-defined name to assign to the settings. - - The absolute uri, including any query and relyingParty data, of the endpoint. - - - The authentication type to use when performing requests against the endpoint. - - - - - - The persisted data for a saml role profile for a user. This profile - references an endpoint profile containing the actual endpoint to be used, and - adds details of the role to be assumed when the profile is selected. - - - Optionally the profile can store a username and domain to be used during - authentication (default behavior, if this is not specified, is to use the user's - default network credentials). - - - - - - The ARN of the role that is to be assumed. - - - - - If non-default network credentials are to used contains - the user identity (in domain\user format, domain optional) that - should be used to supply credentials when the profile is used in - authentication. The user must be prompted to supply the - corresponding password prior to authentication. - - - - - If a specific user identity was specified in the profile, - returns true to indicate a password needs to be obtained from - the user before obtaining network credentials to be used on - authentication. The default is to use the credentials - associated with the currently logged-in user or process to - perform authentication, which does not require the user to be - prompted. - - - - - - For regions with a region-specific endpoint for STS (eg cn-north-1) this - field can be set to ensure calls to obtain temporary credentials - after successful authentication are forwarded to the correct regional - endpoint. - - - This field does not need to be set when running in a region for - which the sts.amazonaws.com endpoint is valid. - - - - - - Retrieves the active credential session, if any, associated with the - role profile. - - - The current credentials valid for the role specified in the profile. Returns - null if no active session is available, or the active session has expired. - - - When a user successfully authenticates and receives temporary AWS - credentials for a role, the profile is updated with details of the - session. When the profile is loaded by other processes or tools, if - session data is present and still valid it can be retrieved using this - method avoiding the need to re-authenticate and get additional temporary - credentials. - - - - - Persists the current credentials to a 'session' key in the RoleSessions.json file. - This enables external applications and tools using the same profile to obtain credentials - without needing to separately re-authenticate the user prior to expiry of the current - credentials. After persisting the session data it can be retrieved using GetCurrentSession(). - - - Although the credentials are temporary we still encrypt the stored data when at rest in - the sdk credential store. - - - The current credentials valid for the role specified in the profile. - - - - - Stores or clears the persisted session data. - - - - - - The endpoint settings from which the actual endpoint to use in authentication - is obtained. - - - - - Tests if a SAMLRoleProfile instance could be instantiated from - the persisted settings data. - - The name given to the persisted settings. - True if the settings are compatible with a SAMLRoleProfile type. - - - - Tests if a SAMLRoleProfile instance could be instantiated from - the persisted settings data. - - The persisted settings. - True if the settings are compatible with a SAMLRoleProfile type. - - - - Instantiates an instance from settings stored with the specified name. - - The name of the endpoint profile. - Profile instance or an exception if the profile data does not exist/contains invalid data. - - - - Instantiates an instance from the supplied settings. In addition to the profile settings - the SDK will inspect for a RoleSessions.json file containing active session data and if - an entry for the profile is present, will add the session data to the returned profile - object. - - The persisted settings. - Profile instance or an exception if the profile data is invalid. - - - - Validates the contents of the specified profile. - - The name of the SAML role profile to validate. - Thrown if the profile settings fail to validate. - - - - Validates that the presented settings would result in a valid role profile - instance. - - The persisted settings. - Thrown if the profile settings fail to validate. - - - - Stores the data in the role profile to the backing store file. - - - - - - Registers a role-based profile to be used with SAML authentication. The profile contains - details of the role to be assumed when AWS credentials are requested based on the role and - a reference to a SAML endpoint profile containing details of the endpoint to be called to - authenticate the user. - - - If user identity information is not supplied then the identity of the logged-in user will - be used when authenticaton is performed against the endpoint referenced in the SAML endpoint - profile. If identity is provided, no password information is stored in the role profile and - the user must supply the password for the identity prior to authentication with the endpoint. - - - Name to be assigned to the profile - - The name of the settings in the SAML endpoints file containing details of the - endpoint to authenticate with. - - - The arn of the role that the user wants to assume when using this profile. This - must be one of the set returned by the saml endpoint when the user authenticates. - - - Optional, can be used to prompt the user for a password for the account when authentication - is performed from a system that is not domain-joined. - - - Optional, details of the currently active credentials for the role that we want to - persist into the profile for other tools or processes to pick up, avoiding the need - to continually re-authenticate the user as they switch between tools. The active session, - if any, is stored separately from the profile using the file RoleSessions.json. - - - Set for profiles intended to be used in regions where a region-specific STS endpoint - must be used (eg cn-north-1). If left empty/null, the global sts.amazonaws.com endpoint - will be used when credentials are obtained for this profile. - - The unique id assigned to the profile. - - - - Tests for and loads any active session credentials for the specified profile. The session data - exists in a separate file from the profile, RoleSessions.json. - - - - - - - Stores the supplied session data into the RoleSessions.json backing file. - - - - - - - Constructs a profile data instance that will use the specified network identity - during authentication with configured endpoint. - - The user-defined name of the profile that sourced this data. - The settings for the authentication endpoint. - The role that should be assumed on successful authentication. - The credentials to supply in authentication, in domain\user format. - - Deserialized credential data from the profile, if still valid. Null if the profile does not - contain any active credentials, or the credentials it did hold are now invalid. - - - Set for profiles intended to be used in regions where a region-specific STS endpoint - must be used (eg cn-north-1). If left empty/null, the global sts.amazonaws.com endpoint - will be used when credentials are obtained for this profile. - - - - - Object to track circular references in nested types. - At each level of nesting, make a call to Track to retrieve Tracker, - a tracking object implementing the IDisposable interface. - Dispose of this tracker when leaving the context of the tracked object. - - - - - Tracker. Must be disposed. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Adds the current target to a reference list and returns a tracker. - The tracker removes the target from the reference list when the - tracker is disposed. - - - - - - - AwsHttpClient is a wrapper around HttpClient class of the System.Net.Http library. - The wrapper has been added so as to remove System.Net.Http dependencies from the Services - and migrate it to a Core level dependecy only. This avoids version clashes when a service - and the Core depends on different versions of the System.Net.Http library. This is a Service - level utility method - - - - - AWSHttpClient wrapper that is wrapped around - HttpClient default wrapper. - - - - - AWSHttpClient BaseAddress property that is wrapper for - HttpClient BaseAddress property. - - - - - AWSHttpClient Timeout property that is wrapper for - HttpClient Timeout property. - - - - - AWSHttpClient MaxResponseContentBufferSize property that is wrapper for - HttpClient MaxResponseContentBufferSize property. - - - - - AWSHttpClient GetStreamAsync that accepts the requester's URI - and make a HttpClient.GetStreamAsync call. - - Requester Uri - - - - Wrapper method that accepts a request uri, stream content and headers and makes a sendAsync call. - - - - - - - Wrapper for HttpClient's HttpRequestMessage and SendAsync methods. - - - - Returns response headers information- header name,value and status code - - - - Wrapper for HttpClient Dispose. - - - - - Method that checks if the passed exception is of type - HttpRequestException - - - - - - - AWSStreamContent is a wrapper for StreamContent class in - the System.Net.Http library.The wrapper has been added so as to - remove System.Net.Http dependencies from the Services - and migrate it to a Core level dependecy only. This avoids version clashes when a service - and the Core depends on different versions of the System.Net.Http library. This is a Service - level utility method - - - - - Wrapper for StreamContent constructor - for stream content - - - - - - Wrapper for StreamContent constructor - for stream content and bufferSize - - - - - - - Wrapper to allow Services to remove StreamContent Headers - - - - - - - Wrapper to allow Services to add StreamContent Headers - - - - - - - Wrapper for StreamContent Dispose. - - - - - Utility class to parse Amazon resource names more commonly known as an ARN. - - - - - Gets and sets the partition associated with the ARN (e.g.: 'aws'). - - - - - Gets and sets the AWS service associated with the ARN (e.g.: 's3'). - - - - - Gets and sets the region associated with the ARN (e.g.: 'us-east-1'). - - - - - Gets and sets the account ID associated with the ARN. - - - - - Gets and sets the resource associated with the ARN (e.g.: 'mybucket/myobject'). - - - - - Returns true if the string appears to be an ARN by seeing if the string starts with "arn:". This method - doesn't guarantee the string is a valid ARN. To validate the string call TryParse. - - - - - - - Parses the string into an ARN object. - - String to parse into an ARN. - The out parameter for the ARN object created by TryParse. - True if the string can be parsed into an ARN object. - - - - Parses the string into an ARN object. - - String to parse into an Arn. - The Arn object created from the passed in string. - Thrown if arnString is null. - Thrown if the string passed in not valid ARN. - - - - Turns the Arn object into a string representation of an ARN. - - - - - - Configuration options that apply to the entire SDK. - - These settings can be configured through app.config or web.config. - Below is a full sample configuration that illustrates all the possible options. - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws region="us-west-2"> - <logging logTo="Log4Net, SystemDiagnostics" logResponses="Always" logMetrics="true" /> - <s3 useSignatureVersion4="true" /> - <proxy host="localhost" port="8888" username="1" password="1" /> - - <dynamoDB> - <dynamoDBContext tableNamePrefix="Prod-"> - - <tableAliases> - <alias fromTable="FakeTable" toTable="People" /> - <alias fromTable="Persons" toTable="People" /> - </tableAliases> - - <mappings> - <map type="Sample.Tests.Author, SampleDLL" targetTable="People" /> - <map type="Sample.Tests.Editor, SampleDLL" targetTable="People"> - <property name="FullName" attribute="Name" /> - <property name="EmployeeId" attribute="Id" /> - <property name="ComplexData" converter="Sample.Tests.ComplexDataConverter, SampleDLL" /> - <property name="Version" version="true" /> - <property name="Password" ignore="true" /> - </map> - </mappings> - - </dynamoDBContext> - </dynamoDB> - </aws> - - - - Configuration options that apply to the entire SDK. - - - - - Manual offset to apply to client clock. This is a global setting that overrides - ClockOffset value calculated for all service endpoints. - - - - - Determines if the SDK should correct for client clock skew - by determining the correct server time and reissuing the - request with the correct time. - Default value of this field is True. - will be updated with the calculated - offset even if this field is set to false, though requests - will not be corrected or retried. - Ignored if is set. - - - - - The calculated clock skew correction, if there is one. - This field will be set if a service call resulted in an exception - and the SDK has determined that there is a difference between local - and server times. - - If is set to true, this - value will be set to the correction, but it will not be used by the - SDK and clock skew errors will not be retried. - - - - - Key for the AWSRegion property. - - - - - - Configures the default AWS region for clients which have not explicitly specified a region. - Changes to this setting will only take effect for newly constructed instances of AWS clients. - - This setting can be configured through the App.config. For example: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws region="us-west-2" /> - - - - - - Key for the AWSProfileName property. - - - - - - Profile name for stored AWS credentials that will be used to make service calls. - Changes to this setting will only take effect in newly-constructed clients. - - To reference the account from an application's App.config or Web.config use the AWSProfileName setting. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="development"/> - </appSettings> - </configuration> - - - - - - - Key for the AWSProfilesLocation property. - - - - - - Location of the credentials file shared with other AWS SDKs. - By default, the credentials file is stored in the .aws directory in the current user's home directory. - - Changes to this setting will only take effect in newly-constructed clients. - - To reference the profile from an application's App.config or Web.config use the AWSProfileName setting. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfilesLocation" value="c:\config"/> - </appSettings> - </configuration> - - - - - - - Key for the Logging property. - - - - - - Configures how the SDK should log events, if at all. - Changes to this setting will only take effect in newly-constructed clients. - - The setting can be configured through App.config, for example: - - <appSettings> - <add key="AWSLogging" value="log4net"/> - </appSettings> - - - - - - Key for the ResponseLogging property. - - - - - - - Configures when the SDK should log service responses. - Changes to this setting will take effect immediately. - - The setting can be configured through App.config, for example: - - <appSettings> - <add key="AWSResponseLogging" value="OnError"/> - </appSettings> - - - - - - Key for the LogMetrics property. - - - - - - Configures if the SDK should log performance metrics. - This setting configures the default LogMetrics property for all clients/configs. - Changes to this setting will only take effect in newly-constructed clients. - - The setting can be configured through App.config, for example: - - <appSettings> - <add key="AWSLogMetrics" value="true"/> - </appSettings> - - - - - - Key for the EndpointDefinition property. - - - - - - Configures if the SDK should use a custom configuration file that defines the regions and endpoints. - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws endpointDefinition="c:\config\endpoints.json" /> - - - - - - Key for the UseSdkCache property. - - - - - - Configures if the SDK Cache should be used, the default value is true. - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws useSdkCache="true" /> - - - - - - Configuration for the Logging section of AWS configuration. - Changes to some settings may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws> - <logging logTo="Log4Net, SystemDiagnostics" logResponses="Always" logMetrics="true" /> - </aws> - - - - - - Configuration for the Proxy section of AWS configuration. - Changes to some settings may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws> - <proxy host="localhost" port="8888" username="1" password="1" bypassList="addressexpr1;addressexpr2;..." bypassOnLocal="true" /> - </aws> - - - - - - Configuration for the region endpoint section of AWS configuration. - Changes may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws region="us-west-2" /> - - - - - - Lock for SomeEvent delegate access. - - - - - This method should never be called directly. - Call AWSSDKUtils.CorrectedUtcNow instead. - - - - - - Logging options. - Can be combined to enable multiple loggers. - - - - - No logging - - - - - Log using log4net - - - - - Log using System.Diagnostics - - - - - Log to the console - - - - - Response logging option. - - - - - Never log service response - - - - - Only log service response when there's an error - - - - - Always log service response - - - - - Format for metrics data in the logs - - - - - Emit metrics in human-readable format - - - - - Emit metrics as JSON data - - - - - Allows to configure the proxy used for HTTP requests. The default value is null. - - - - - This class contains the endpoints available to the AWS clients. The static constants representing the - regions can be used while constructing the AWS client instead of looking up the exact endpoint URL. - - - - - Gets the endpoint for a service in a region. - - The services system name. - If true returns the endpoint for dualstack - Thrown when the request service does not have a valid endpoint in the region. - - - - - Enumerate through all the regions. - - - - - Gets the region based on its system name like "us-west-1" - - The system name of the service like "us-west-1" - - - - - This is a testing method and should not be called by production applications. - - - - - Gets the system name of a region. - - - - - Gets the display name of a region. - - - - - This region name is non-standard. Search the whole endpoints.json file to - determine the partition this region is in. - - - - - This class contains region information used to lazily compute the service endpoints. The static constants representing the - regions can be used while constructing the AWS client instead of looking up the exact endpoint URL. - - - - - The US East (Virginia) endpoint. - - - - - The US East (Virginia) regional endpoint. - - - - - The US East (Ohio) endpoint. - - - - - The US West (N. California) endpoint. - - - - - The US West (Oregon) endpoint. - - - - - The EU North (Stockholm) endpoint. - - - - - The EU West (Ireland) endpoint. - - - - - The EU West (London) endpoint. - - - - - The EU West (Paris) endpoint. - - - - - The EU Central (Frankfurt) endpoint. - - - - - The Asia Pacific (Hong Kong) endpoint. - - - - - The Asia Pacific (Tokyo) endpoint. - - - - - The Asia Pacific (Seoul) endpoint. - - - - - The Asia Pacific (Osaka-Local) endpoint. - - - - - The Asia Pacific (Mumbai) endpoint. - - - - - The Asia Pacific (Singapore) endpoint. - - - - - The Asia Pacific (Sydney) endpoint. - - - - - The South America (Sao Paulo) endpoint. - - - - - The US GovCloud East (Virginia) endpoint. - - - - - The US GovCloud West (Oregon) endpoint. - - - - - The China (Beijing) endpoint. - - - - - The China (Ningxia) endpoint. - - - - - The Canada (Central) endpoint. - - - - - The Middle East (Bahrain) endpoint. - - - - - Represents the endpoint overridding rules in the endpoints.json - Is used to map private region (ie us-east-1-regional) to public regions (us-east-1) - For signing purposes. - - - - - Enumerate through all the regions. - - - - - Gets the region based on its system name like "us-west-1" - - The system name of the service like "us-west-1" - - - - - Gets the region endpoint override if exists - - The region endpoint to find the possible override for - - - - - Gets the system name of a region. - - - - - Gets the display name of a region. - - - - - Gets the partition name the region is in. For example for us-east-1 the partition name is aws. For cn-northwest-1 the partition name is aws-cn. - - - - - Gets the dns suffix for the region endpoints in a partition. For example the aws partition's suffix is amazonaws.com. The aws-cn partition's suffix is amazonaws.com.cn. - - - - - Gets the endpoint for a service in a region. - - - The services system name. Service system names can be obtained from the - RegionEndpointServiceName member of the ClientConfig-derived class for the service. - - - For forwards compatibility, if the service being requested for isn't known in the region, this method - will generate an endpoint using the AWS endpoint heuristics. In this case, it is not guaranteed the - endpoint will point to a valid service endpoint. - - - - - - Gets the endpoint for a service in a region, optionally selecting a dualstack compatible endpoint. - - - The services system name. Service system names can be obtained from the - RegionEndpointServiceName member of the ClientConfig-derived class for the service. - - - If true a dualstack endpoint is returned. It is the user's responsibility to verify that the given service - supports a dualstack endpoint for the region. - - - For forwards compatibility, if the service being requested for isn't known in the region, this method - will generate an endpoint using the AWS endpoint heuristics. In this case, it is not guaranteed the - endpoint will point to a valid service endpoint. - - - - - - This class defines an endpoints hostname and which protocols it supports. - - - - - Gets the hostname for the service. - - - - - The authentication region to be used in request signing. - - - - - This property is only set for S3 endpoints. For all other services this property returns null. - For S3 endpoints, if the endpoint supports signature version 2 this property will be "2", otherwise it will be "4". - - - - a general purpose ASN.1 decoder - note: this class differs from the - others in that it returns null after it has read the last object in - the stream. If an ASN.1 Null is encountered a Der/BER Null object is - returned. - - - Create an ASN1InputStream where no DER object will be longer than limit. - - @param input stream containing ASN.1 encoded data. - @param limit maximum size of a DER encoded object. - - - Create an ASN1InputStream based on the input byte array. The length of DER objects in - the stream is automatically limited to the length of the input array. - - @param input array containing ASN.1 encoded data. - - - build an object given its tag and the number of bytes to construct it from. - - - Create a base ASN.1 object from a byte array. - The byte array to parse. - The base ASN.1 object represented by the byte array. - If there is a problem parsing the data. - - - Read a base ASN.1 object from a stream. - The stream to parse. - The base ASN.1 object represented by the byte array. - If there is a problem parsing the data. - - - return the object at the sequence position indicated by index. - - @param index the sequence number (starting at zero) of the object - @return the object at the sequence position indicated by index. - - - create an empty sequence - - - create a sequence containing one object - - - create a sequence containing a vector of objects. - - - - A - - - - - - A - - - A - - - - - - A - - - - - return a = a + b - b preserved. - - - unsigned comparison on two arrays - note the arrays may - start with leading zeros. - - - returns x = x - y - we assume x is >= y - - - - Calculates a 32bit Cyclic Redundancy Checksum (CRC) using the - same polynomial used by Zip. This type is used internally by DotNetZip; it is generally not used directly - by applications wishing to create, read, or manipulate zip archive files. - - - - - indicates the total number of bytes read on the CRC stream. - This is used when writing the ZipDirEntry when compressing files. - - - - - Indicates the current CRC for all blocks slurped in. - - - - - Returns the CRC32 for the specified stream. - - The stream over which to calculate the CRC32 - the CRC32 calculation - - - - Returns the CRC32 for the specified stream, and writes the input into the output stream. - - The stream over which to calculate the CRC32 - The stream into which to deflate the input - the CRC32 calculation - - - - Get the CRC32 for the given (word,byte) combo. - This is a computation defined by PKzip. - - The word to start with. - The byte to combine it with. - The CRC-ized result. - - - - Update the value for the running CRC32 using the given block of bytes. - This is useful when using the CRC32() class in a Stream. - - block of bytes to slurp - starting point in the block - how many bytes within the block to slurp - - - - A Stream that calculates a CRC32 (a checksum) on all bytes read, - or on all bytes written. - - - - - This class can be used to verify the CRC of a ZipEntry when reading from a stream, - or to calculate a CRC when writing to a stream. The stream should be used to either - read, or write, but not both. If you intermix reads and writes, the results are - not defined. - - This class is intended primarily for use internally by the DotNetZip library. - - - - - Gets the total number of bytes run through the CRC32 calculator. - - - - This is either the total number of bytes read, or the total number - of bytes written, depending on the direction of this stream. - - - - - The constructor. - - The underlying stream - - - - The constructor. - - The underlying stream - The length of the stream to slurp - - - - Provides the current CRC for all blocks slurped in. - - - - - Read from the stream - - the buffer to read - the offset at which to start - the number of bytes to read - the number of bytes actually read - - - - Write to the stream. - - the buffer from which to write - the offset at which to start writing - the number of bytes to write - - - - Indicates whether the stream supports reading. - - - - - Indicates whether the stream supports seeking. - - - - - Indicates whether the stream supports writing. - - - - - Flush the stream. - - - - - Not implemented. - - - - - Not implemented. - - - - - Not implemented. - - N/A - N/A - N/A - - - - Not implemented. - - N/A - - - diff --git a/packages/AWSSDK.Core.3.5.0-beta/lib/netstandard2.0/AWSSDK.Core.dll b/packages/AWSSDK.Core.3.5.0-beta/lib/netstandard2.0/AWSSDK.Core.dll deleted file mode 100644 index 3d810cd..0000000 Binary files a/packages/AWSSDK.Core.3.5.0-beta/lib/netstandard2.0/AWSSDK.Core.dll and /dev/null differ diff --git a/packages/AWSSDK.Core.3.5.0-beta/lib/netstandard2.0/AWSSDK.Core.xml b/packages/AWSSDK.Core.3.5.0-beta/lib/netstandard2.0/AWSSDK.Core.xml deleted file mode 100644 index d5fa10c..0000000 --- a/packages/AWSSDK.Core.3.5.0-beta/lib/netstandard2.0/AWSSDK.Core.xml +++ /dev/null @@ -1,13764 +0,0 @@ - - - - AWSSDK.Core - - - - - An access control policy action identifies a specific action in a service - that can be performed on a resource. For example, sending a message to a - queue. - - ActionIdentifiers allow you to limit what your access control policy statement affects. - For example, you could create a policy statement that enables a certain group - of users to send messages to your queue, but not allow them to perform any - other actions on your queue. - - - The action is B in the statement - "A has permission to do B to C where D applies." - - Free form access control policy actions may include a wildcard (*) to match - multiple actions. - - - Constants for known actions can be found in the Amazon.Auth.AccessControlPolicy.ActionIdentifiers namespace. - - - - - - Constructs an Actionidentifer with the given action name. - - The name of the action - - - - Gets and sets the name of this action. For example, 'sqs:SendMessage' is the - name corresponding to the SQS action that enables users to send a message - to an SQS queue. - - - - - The available AWS access control policy actions for Amazon AppStream. - - - - - - The available AWS access control policy actions for Auto Scaling. - - - - - - The available AWS access control policy actions for AWS Billing. - - - - - - The available AWS access control policy actions for AWS CloudFormation. - - - - - - The available AWS access control policy actions for Amazon CloudFront. - - - - - - The available AWS access control policy actions for Amazon CloudSearch. - - - - - - The available AWS access control policy actions for AWS CloudTrail. - - - - - - The available AWS access control policy actions for Amazon CloudWatch. - - - - - - The available AWS access control policy actions for Amazon CloudWatch Logs. - - - - - - The available AWS access control policy actions for Amazon Cognito Identity. - - - - - - The available AWS access control policy actions for Amazon Cognito Sync. - - - - - - The available AWS access control policy actions for AWS Direct Connect. - - - - - - The available AWS access control policy actions for Amazon DynamoDB. - - - - - - The available AWS access control policy actions for Amazon EC2. - - - - - - The available AWS access control policy actions for AWS ElastiCache. - - - - - - The available AWS access control policy actions for AWS Elastic Beanstalk. - - - - - - The available AWS access control policy actions for Elastic Load Balancing. - - - - - - The available AWS access control policy actions for Amazon Elastic MapReduce. - - - - - - The available AWS access control policy actions for Amazon Elastic Transcoder. - - - - - - The available AWS access control policy actions for Amazon Glacier. - - - - - - The available AWS access control policy actions for AWS Identity and Access Management. - - - - - - The available AWS access control policy actions for AWS Import Export. - - - - - - The available AWS access control policy actions for Amazon Kinesis. - - - - - - The available AWS access control policy actions for AWS Marketplace. - - - - - - The available AWS access control policy actions for AWS Marketplace Management Portal. - - - - - - The available AWS access control policy actions for Amazon Mobile Analytics. - - - - - - The available AWS access control policy actions for AWS OpsWorks. - - - - - - The available AWS access control policy actions for Amazon RDS. - - - - - - The available AWS access control policy actions for Amazon Redshift. - - - - - - The available AWS access control policy actions for Amazon Route 53. - - - - - - The available AWS access control policy actions for Amazon S3. - - - - - - The available AWS access control policy actions for AWS Security Token Service. - - - - - - The available AWS access control policy actions for Amazon SES. - - - - - - The available AWS access control policy actions for Amazon SimpleDB. - - - - - - The available AWS access control policy actions for Amazon Simple Workflow Service. - - - - - - The available AWS access control policy actions for Amazon SNS. - - - - - - The available AWS access control policy actions for Amazon SQS. - - - - - - The available AWS access control policy actions for Amazon Storage Gateway. - - - - - - The available AWS access control policy actions for AWS Whispersync. - - - - - - The available AWS access control policy actions for Amazon Zocalo. - - - - - - AWS access control policy conditions are contained in - objects, and affect when a statement is applied. For example, a statement - that allows access to an Amazon SQS queue could use a condition to only apply - the effect of that statement for requests that are made before a certain - date, or that originate from a range of IP addresses. - - Multiple conditions can be included in a single statement, and all conditions - must evaluate to true in order for the statement to take effect. - - - The set of conditions is D in the statement - "A has permission to do B to C where D applies." - - - A condition is composed of three parts: - - - Condition Key - The condition key declares which value of a - request to pull in and compare against when a policy is evaluated by AWS. For - example, using will cause - AWS to pull in the current request's source IP as the first value to compare - against every time your policy is evaluated. - - - - Comparison Type - This is a static value used as the second value - in the comparison when your policy is evaluated. Depending on the comparison - type, this value can optionally use wildcards. See the documentation for - individual comparison types for more information. - - - - Comparison Value - This is a static value used as the second value - in the comparison when your policy is evaluated. Depending on the comparison - type, this value can optionally use wildcards. See the documentation for - individual comparison types for more information. - - - - - - - - - Gets the type of this condition. - - - - - Gets and Sets the name of the condition key involved in this condition. - Condition keys are predefined values supported by AWS that provide input - to a condition's evaluation, such as the current time, or the IP address - of the incoming request. - - Your policy is evaluated for each incoming request, and condition keys - specify what information to pull out of those incoming requests and plug - into the conditions in your policy. - - - - - - Gets and Sets the values specified for this access control policy condition. - For example, in a condition that compares the incoming IP address of a - request to a specified range of IP addresses, the range of IP addresses - is the single value in the condition. - - Most conditions accept only one value, but multiple values are possible. - - - - - - A factory for creating conditions to be used in the policy. - - - - - Condition key for the current time. - - This condition key should only be used with enum. - - - - - - Condition key for whether or not an incoming request is using a secure - transport to make the request (i.e. HTTPS instead of HTTP). - - This condition key should only be used with the boolean overload of NewCondition. - - - - - - Condition key for the source IP from which a request originates. - - This condition key should only be used with enum. - - - - - - Condition key for the user agent included in a request. - - This condition key should only be used with - enum. - - - - - - Condition key for the current time, in epoch seconds. - - This condition key should only be used with enum. - objects. - - - - - - Condition key for the referrer specified by a request. - - This condition key should only be used with - objects. - - - - - - Condition key for the Amazon Resource Name (ARN) of the source specified - in a request. The source ARN indicates which resource is affecting the - resource listed in your policy. For example, an SNS topic is the source - ARN when publishing messages from the topic to an SQS queue. - - This condition key should only be used with enum. - - - - - - Enumeration of the supported ways an ARN comparison can be evaluated. - - - - Exact matching - - - - Loose case-insensitive matching of the ARN. Each of the six - colon-delimited components of the ARN is checked separately and each - can include a multi-character match wildcard (*) or a - single-character match wildcard (?). - - - - Negated form of ArnEquals - - - Negated form of ArnLike - - - - Enumeration of the supported ways a date comparison can be evaluated. - - - - - Enumeration of the supported ways an IP address comparison can be evaluated. - - - - - Matches an IP address against a CIDR IP range, evaluating to true if - the IP address being tested is in the condition's specified CIDR IP - range. - - - - - Negated form of IpAddress - - - - - Enumeration of the supported ways a numeric comparison can be evaluated - - - - - Enumeration of the supported ways a string comparison can be evaluated. - - - - - Case-sensitive exact string matching - - - - - Case-insensitive string matching - - - - - Loose case-insensitive matching. The values can include a - multi-character match wildcard (*) or a single-character match - wildcard (?) anywhere in the string. - - - - - Negated form of StringEquals. - - - - - Negated form of StringEqualsIgnorecase. - - - - - Negated form of StringLike. - - - - - Constructs a new access control policy condition that compares ARNs (Amazon Resource Names). - - The access policy condition key specifying where to get the first ARN for the comparison - The type of comparison to perform. - The second ARN to compare against. When using ArnLike or ArnNotLike this may contain the - multi-character wildcard (*) or the single-character wildcard - - - - Constructs a new access policy condition that performs a boolean - comparison. - - The access policy condition key specifying where to get the - first boolean value for the comparison (ex: aws:SecureTransport). - The boolean to compare against. - - - - This method is deprecated. Invoking this method results in non-UTC DateTimes - not being marshalled correctly. Use NewConditionUtc instead. - Constructs a new access policy condition that compares the current time - (on the AWS servers) to the specified date. - - The type of comparison to perform. For example, - DateComparisonType.DateLessThan will cause this policy - condition to evaluate to true if the current date is less than - the date specified in the second argument. - The date to compare against. - - - - Constructs a new access policy condition that compares the current time - (on the AWS servers) to the specified date. - - The type of comparison to perform. For example, - DateComparisonType.DateLessThan will cause this policy - condition to evaluate to true if the current date is less than - the date specified in the second argument. - The date to compare against. - - - - Constructs a new access policy condition that compares the source IP - address of the incoming request to an AWS service against the specified - CIDR range. The condition evaluates to true (meaning the policy statement - containing it will be applied) if the incoming source IP address is - within that range. - - To achieve the opposite effect (i.e. cause the condition to evaluate to - true when the incoming source IP is not in the specified CIDR - range) use the alternate constructor form and specify - IpAddressComparisonType.NotIpAddress. - - - The CIDR IP range involved in the policy condition. - - - - Constructs a new access policy condition that compares the source IP - address of the incoming request to an AWS service against the specified - CIDR range. When the condition evaluates to true (i.e. when the incoming - source IP address is within the CIDR range or not) depends on the - specified IpAddressComparisonType. - - The type of comparison to to perform. - The CIDR IP range involved in the policy condition. - - - - Constructs a new access policy condition that compares two numbers. - - The type of comparison to perform. - The access policy condition key specifying where to get the - first number for the comparison. - The second number to compare against. - - - - Constructs a new access control policy condition that compares two - strings. - - The type of comparison to perform - The access policy condition key specifying where to get the - first string for the comparison (ex: aws:UserAgent). - - The second string to compare against. When using - StringComparisonType.StringLike or - StringComparisonType.StringNotLike this may contain - the multi-character wildcard (*) or the single-character - wildcard (?). - - - - - Constructs a new access policy condition that compares the Amazon - Resource Name (ARN) of the source of an AWS resource that is modifying - another AWS resource with the specified pattern. - - For example, the source ARN could be an Amazon SNS topic ARN that is - sending messages to an Amazon SQS queue. In that case, the SNS topic ARN - would be compared the ARN pattern specified here. - - - The endpoint pattern may optionally contain the multi-character wildcard - * (*) or the single-character wildcard (?). Each of the six colon-delimited - components of the ARN is checked separately and each can include a - wildcard. - - - Policy policy = new Policy("MyQueuePolicy"); - policy.WithStatements(new Statement(Statement.StatementEffect.Allow) - .WithPrincipals(new Principal("*")).WithActionIdentifiers(SQSActionIdentifiers.SendMessage) - .WithResources(new Resource(myQueueArn)) - .WithConditions(ConditionFactory.NewSourceArnCondition(myTopicArn))); - - - The ARN pattern against which the source ARN will be compared. - Each of the six colon-delimited components of the ARN is - checked separately and each can include a wildcard. - A new access control policy condition that compares the ARN of - the source specified in an incoming request with the ARN pattern - specified here. - - - - Constructs a new access control policy condition that tests if the - incoming request was sent over a secure transport (HTTPS). - - A new access control policy condition that tests if the incoming - request was sent over a secure transport (HTTPS). - - - - Condition key for the canned ACL specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the location constraint specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the prefix specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the delimiter specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the max keys specified by a request. - - This condition key may only be used with enum. - - - - - - Condition key for the source object specified by a request to copy an - object. - - This condition key may only be used with enum. - - - - - - Condition key for the metadata directive specified by a request to copy - an object. - - This condition key may only be used with enum. - - - - - - Condition key for the version ID of an object version specified by a - request. - - This condition key may only be used with enum. - - - - - - Constructs a new access policy condition that compares an Amazon S3 - canned ACL with the canned ACL specified by an incoming request. - - You can use this condition to ensure that any objects uploaded to an - Amazon S3 bucket have a specific canned ACL set. - - - The Amazon S3 canned ACL to compare against. - A new access control policy condition that compares the Amazon S3 - canned ACL specified in incoming requests against the value - specified. - - - - Condition key for The URL, e-mail address, or ARN from a Subscribe - request or a previously confirmed subscription. Use with string - conditions to restrict access to specific endpoints (e.g., - *@mycompany.com). - - This condition key may only be used with enum. - - - - - - Condition key for the protocol value from a Subscribe request or a - previously confirmed subscription. Use with string conditions to restrict - publication to specific delivery protocols (e.g., HTTPS). - - This condition key may only be used with enum. - - - - - - Constructs a new access policy condition that compares the requested - endpoint used to subscribe to an Amazon SNS topic with the specified - endpoint pattern. The endpoint pattern may optionally contain the - multi-character wildcard (*) or the single-character wildcard (?). - - For example, this condition can restrict subscriptions to a topic to - email addresses in a certain domain ("*@my-company.com"). - - - Policy policy = new Policy("MyTopicPolicy"); - policy.WithStatements(new Statement(Statement.StatementEffect.Allow) - .WithPrincipals(new Principal("*")).WithActionIdentifiers(SNSActionIdentifiers.Subscribe) - .WithResources(new Resource(myTopicArn)) - .WithConditions(ConditionFactory.NewEndpointCondition("*@my-company.com"))); - - - The endpoint pattern against which to compare the requested - endpoint for an Amazon SNS topic subscription. - A new access control policy condition that compares the endpoint - used in a request to subscribe to an Amazon SNS topic with the - endpoint pattern specified. - - - - Constructs a new AWS access control policy condition that allows an - access control statement to restrict subscriptions to an Amazon SNS topic - based on the protocol being used for the subscription. For example, this - condition can restrict subscriptions to a topic to endpoints using HTTPS - to ensure that messages are securely delivered. - - The protocol against which to compare the requested protocol - for an Amazon SNS topic subscription. - A new access control policy condition that compares the - notification protocol requested in a request to subscribe to an - Amazon SNS topic with the protocol value specified. - - - - Deserializes a JSON string into a AWS policy object. - - - - - Serializes an AWS policy object to a JSON string, suitable for sending to an - AWS service. - - - - Converts the specified AWS policy object to a JSON string, suitable for - passing to an AWS service. - - @param policy - The AWS policy object to convert to a JSON string. - - @return The JSON string representation of the specified policy object. - - @throws IllegalArgumentException - If the specified policy is null or invalid and cannot be - serialized to a JSON string. - - - - Uses the specified generator to write the JSON data for the principals in - the specified policy statement. - - - - - This sorts the conditions by condition type and key with the list of values for that combination. - - The list of conditions to be sorted. - - - - - An AWS access control policy is a object that acts as a container for one or - more statements, which specify fine grained rules for allowing or denying - various types of actions from being performed on your AWS resources. - - By default, all requests to use your resource coming from anyone but you are - denied. Access control polices can override that by allowing different types - of access to your resources, or by explicitly denying different types of - access. - - - Each statement in an AWS access control policy takes the form: - "A has permission to do B to C where D applies". - - - A is the prinicpal - The AWS account that is making a request to - access or modify one of your AWS resources. - - - - B is the action - the way in which your AWS resource is being accessed or modified, such - as sending a message to an Amazon SQS queue, or storing an object in an Amazon S3 bucket. - - - - C is the resource - your AWS entity that the principal wants to access, such - as an Amazon SQS queue, or an object stored in Amazon S3. - - - - D is the set of conditions - optional constraints that specify when to allow or deny - access for the principal to access your resource. Many expressive conditions are available, - some specific to each service. For example you can use date conditions to allow access to - your resources only after or before a specific time. - - - - - - Note that an AWS access control policy should not be confused with the - similarly named "POST form policy" concept used in Amazon S3. - - - - - - The default policy version - - - - - Constructs an empty AWS access control policy ready to be populated with - statements. - - - - - Constructs a new AWS access control policy with the specified policy ID. - The policy ID is a user specified string that serves to help developers - keep track of multiple polices. Policy IDs are often used as a human - readable name for a policy. - - The policy ID for the new policy object. Policy IDs serve to - help developers keep track of multiple policies, and are often - used to give the policy a meaningful, human readable name. - - - - Constructs a new AWS access control policy with the specified policy ID - and collection of statements. The policy ID is a user specified string - that serves to help developers keep track of multiple polices. Policy IDs - are often used as a human readable name for a policy. - - The policy ID for the new policy object. Policy IDs serve to - help developers keep track of multiple policies, and are often - used to give the policy a meaningful, human readable name. - The statements to include in the new policy. - - - - Gets and Sets the policy ID for this policy. Policy IDs serve to help - developers keep track of multiple policies, and are often used as human - readable name for a policy. - - - - - Sets the policy ID for this policy and returns the updated policy so that - multiple calls can be chained together. - - Policy IDs serve to help developers keep track of multiple policies, and - are often used as human readable name for a policy. - - - The polich ID for this policy - this instance - - - - Gets and sets the version of this AWS policy. - - - - - Gets and Sets the collection of statements contained by this policy. Individual - statements in a policy are what specify the rules that enable or disable - access to your AWS resources. - - - - - Checks to see if the permissions set in the statement are already set by another - statement in the policy. - - The statement to verify - True if the statement's permissions are already allowed by the statement - - - - Sets the collection of statements contained by this policy and returns - this policy object so that additional method calls can be chained - together. - - Individual statements in a policy are what specify the rules that enable - or disable access to your AWS resources. - - - The collection of statements included in this policy. - this instance - - - - Returns a JSON string representation of this AWS access control policy, - suitable to be sent to an AWS service as part of a request to set an - access control policy. - - A JSON string representation of this AWS access control policy. - - - - Returns a JSON string representation of this AWS access control policy, - suitable to be sent to an AWS service as part of a request to set an - access control policy. - - Toggle pretty print for the generated JSON document - A JSON string representation of this AWS access control policy. - - - - Parses a JSON document of a policy and creates a Policy object. - - JSON document of a policy. - - - - - A principal is an AWS account which is being allowed or denied access to a - resource through an access control policy. The principal is a property of the - Statement object, not directly the object. - - The principal is A in the statement - "A has permission to do B to C where D applies." - - - In an access control policy statement, you can set the principal to all - authenticated AWS users through the member. This - is useful when you don't want to restrict access based on the identity of the - requester, but instead on other identifying characteristics such as the - requester's IP address. - - - - - - Principal instance that includes all authenticated AWS users. - - This is useful when you don't want to restrict access based on the - identity of the requester, but instead on other identifying - characteristics such as the requester's IP address. - - - - - - The anonymous Principal. - - - - - The default Principal provider for AWS accounts. - - - - - Principal provider for Canonical User IDs. - - - - - Principal provider for federated users (using a SAML identity provider) - - - - - Principal provider for assume role policies that will be assumed by an AWS service - (e.g. "ec2.amazonaws.com"). - - - - - Dummy principal provider for anonynous. - - - - - Constructs a new principal with the specified AWS account ID. - - An AWS account ID. - - - - Constructs a new principal with the specified provider and id - - The provider of the principal - The unique ID of the Principal within the provider - - - - Constructs a new principal with the specified provider and id - and optionally strips hyphens from the id - - The provider of the principal - The unique ID of the Principal within the provider - Strip hyphen - - - - Gets and sets the provider for this principal, which indicates in what group of - users this principal resides. - - - - - Gets the unique ID for this principal. - - - - - Represents a resource involved in an AWS access control policy statement. - Resources are the service specific AWS entities owned by your account. Amazon - SQS queues, Amazon S3 buckets and objects, and Amazon SNS topics are all - examples of AWS resources. - - The standard way of specifying an AWS resource is with an Amazon Resource - Name (ARN). - - - The resource is C in the statement - "A has permission to do B to C where D applies." - - - - - - Constructs a new AWS access control policy resource. Resources are - typically specified as Amazon Resource Names (ARNs). - - You specify the resource using the following Amazon Resource Name (ARN) - format: arn:aws:<vendor>:<region>:<namespace>:<relative-id> - - - >vendor identifies the AWS product (e.g., sns) - - - region is the AWS Region the resource resides in (e.g., us-east-1), if any - - - namespace is the AWS account ID with no hyphens (e.g., 123456789012) - - - relative-id is the service specific portion that identifies the specific resource - - - - - For example, an Amazon SQS queue might be addressed with the following - ARN: arn:aws:sqs:us-east-1:987654321000:MyQueue - - - Some resources may not use every field in an ARN. For example, resources - in Amazon S3 are global, so they omit the region field: - arn:aws:s3:::bucket/* - - - The Amazon Resource Name (ARN) uniquely identifying the desired AWS resource. - - - - Gets the resource ID, typically an Amazon Resource Name (ARN), - identifying this resource. - - - - - A factory for creating resources to be used in the policy. - - - - - Constructs a new bucket resource that represents the the specified bucket - but not any of the contained objects. - - The name of the bucket represented by this AWS access control - policy resource. - - - - Constructs a new object resource that represents the specified objects. - The keyPattern argument may contain the '*' wildcard to match multiple - objects. For example, an object resource created for bucket 'mybucket' - and key pattern 'foo*' will match any object stored in 'mybucket' with a - key that starts with 'foo'. - - The name of the bucket containing the object or objects - represented by this resource. - The key or key pattern, which can optionally contain the '*' - wildcard to include multiple objects in the resource. - - - - Constructs a new SQS queue resource for an access control policy. A - policy statement using this resource will allow or deny actions on the - specified queue. - - The AWS account ID of the queue owner. - The name of the Amazon SQS queue. - - - - A statement is the formal description of a single permission, and is always - contained within a policy object. - - A statement describes a rule for allowing or denying access to a specific AWS - resource based on how the resource is being accessed, and who is attempting - to access the resource. Statements can also optionally contain a list of - conditions that specify when a statement is to be honored. - - - For example, consider a statement that: - - - A is the prinicpal - The AWS account that is making a request to - access or modify one of your AWS resources. - - - - B is the action - the way in which your AWS resource is being accessed or modified, such - as sending a message to an Amazon SQS queue, or storing an object in an Amazon S3 bucket. - - - - C is the resource - your AWS entity that the principal wants to access, such - as an Amazon SQS queue, or an object stored in Amazon S3. - - - - D is the set of conditions - optional constraints that specify when to allow or deny - access for the principal to access your resource. Many expressive conditions are available, - some specific to each service. For example you can use date conditions to allow access to - your resources only after or before a specific time. - - - - - - There are many resources and conditions available for use in statements, and - you can combine them to form fine grained custom access control polices. - - - - - - The effect is the result that you want a policy statement to return at - evaluation time. A policy statement can either allow access or explicitly - deny access. - - - - - Constructs a new access control policy statement with the specified - effect. - - Before a statement is valid and can be sent to AWS, callers must set the - principals, resources, and actions (as well as any optional conditions) - involved in the statement. - - - The effect this statement has (allowing access or denying - access) when all conditions, resources, principals, and - actions are matched. - - - - Gets and Sets the ID for this statement. Statement IDs serve to help keep track - of multiple statements, and are often used to give the statement a - meaningful, human readable name. - - Developers should be careful to not use the same statement ID for - multiple statements in the same policy. Reusing the same statement ID in - different policies is not a problem. - - - - - - Sets the ID for this statement and returns the updated statement so - multiple calls can be chained together. - - Statement IDs serve to help keep track of multiple statements, and are - often used to give the statement a meaningful, human readable name. - - - Developers should be careful to not use the same statement ID for - multiple statements in the same policy. Reusing the same statement ID in - different policies is not a problem. - - - The new statement ID for this statement. - this instance - - - - Gets and Sets the result effect of this policy statement when it is evaluated. - A policy statement can either allow access or explicitly - - - - - Gets and Sets the list of actions to which this policy statement applies. - Actions limit a policy statement to specific service operations that are - being allowed or denied by the policy statement. For example, you might - want to allow any AWS user to post messages to your SQS queue using the - SendMessage action, but you don't want to allow those users other actions - such as ReceiveMessage or DeleteQueue. - - - - - Sets the list of actions to which this policy statement applies and - returns this updated Statement object so that additional method calls can - be chained together. - - Actions limit a policy statement to specific service operations that are - being allowed or denied by the policy statement. For example, you might - want to allow any AWS user to post messages to your SQS queue using the - SendMessage action, but you don't want to allow those users other actions - such as ReceiveMessage or DeleteQueue. - - - The list of actions to which this statement applies. - this instance - - - - Gets and Sets the resources associated with this policy statement. Resources - are what a policy statement is allowing or denying access to, such as an - Amazon SQS queue or an Amazon SNS topic. - - Note that some services allow only one resource to be specified per - policy statement. - - - - - - Sets the resources associated with this policy statement and returns this - updated Statement object so that additional method calls can be chained - together. - - Resources are what a policy statement is allowing or denying access to, - such as an Amazon SQS queue or an Amazon SNS topic. - - - Note that some services allow only one resource to be specified per - policy statement. - - - The resources associated with this policy statement. - this instance - - - - Gets and Sets the conditions associated with this policy statement. Conditions - allow policy statements to be conditionally evaluated based on the many - available condition types. - - For example, a statement that allows access to an Amazon SQS queue could - use a condition to only apply the effect of that statement for requests - that are made before a certain date, or that originate from a range of IP - addresses. - - - When multiple conditions are included in a single statement, all - conditions must evaluate to true in order for the statement to take - effect. - - - - - - Sets the conditions associated with this policy statement, and returns - this updated Statement object so that additional method calls can be - chained together. - - Conditions allow policy statements to be conditionally evaluated based on - the many available condition types. - - - For example, a statement that allows access to an Amazon SQS queue could - use a condition to only apply the effect of that statement for requests - that are made before a certain date, or that originate from a range of IP - addresses. - - - Multiple conditions can be included in a single statement, and all - conditions must evaluate to true in order for the statement to take - effect. - - - The conditions associated with this policy statement. - this instance - - - - Gets and Sets the principals associated with this policy statement, indicating - which AWS accounts are affected by this policy statement. - - - - - Sets the principals associated with this policy statement, and returns - this updated Statement object. Principals control which AWS accounts are - affected by this policy statement. - - If you don't want to restrict your policy to specific users, you can use - to apply the policy to any user trying to - access your resource. - - - The list of principals associated with this policy statement. - this instance - - - - Exception thrown by the SDK for errors that occur within the SDK. - - - - - This exception is thrown when there is a parse error on the response back from AWS. - - - - - The string value which could not be converted into a valid DateTime instance. - - - - - Occurs before a request is marshalled. - - - - - Occurs before a request is issued against the service. - - - - - Occurs after a response is received from the service. - - - - - Occurs after an exception is encountered. - - - - - Patches the in-flight uri to stop it unescaping the path etc (what Uri did before - Microsoft deprecated the constructor flag). This is particularly important for - Amazon S3 customers who want to use backslash (\) in their key names. - - - Different behavior in the various runtimes has been observed and in addition some - 'documented' ways of doing this between 2.x and 4.x runtimes has also been observed - to not be reliable. - - This patch effectively emulates what adding a schemesettings element to the - app.config file with value 'name="http" genericUriParserOptions="DontUnescapePathDotsAndSlashes"' - does. As we're a dll, that avenue is not open to us. - - - - - - Used to create a copy of the config for a different service than the current instance. - - Target service ClientConfig - The new ClientConfig for the desired service - - - - A base exception for some Amazon Web Services. - - Most exceptions thrown to client code will be service-specific exceptions, though some services - may throw this exception if there is a problem which is caught in the core client code. - - - - - - Whether the error was attributable to Sender or Reciever. - - - - - The error code returned by the service - - - - - The id of the request which generated the exception. - - - - - The HTTP status code from the service response - - - - - This exception is thrown when there is a parse error on the response back from AWS. - - - - - Last known location in the response that was parsed, if available. - - - - - The entire response body that caused this exception, if available. - - - - - Base class for request used by some of the services. - - - - - This flag specifies if SigV4 will be used for the current request. - - - - - Gets or Sets a value indicating if "Expect: 100-continue" HTTP header will be - sent by the client for this request. The default value is false. - - - - - Gets the signer to use for this request. - A null return value indicates to use the configured - signer for the service that this request is part of. - - A signer for this request, or null. - - - - Abstract class for Response objects, contains only metadata, - and no result information. - - - - - Contains additional information about the request, such as the - Request Id. - - - - - Returns the content length of the HTTP response. - - - - - Returns the status code of the HTTP response. - - - - - Base class for determining region based on inspection. - - - - - Sets the Region property by looking up the corresponding RegionEndpoint - from the supplied region system name (us-east-1, us-west-2 etc). - - The system name of the region. - - - - Determines region based on application configuration settings. If the configuration does not contain - the region setting key an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of ApplicationConfigAWSRegion. If no region is found in the - application configuration file then an InvalidOperationException is thrown. - - - - - Determines region based on an environment variable. If the environment does not contain - the region setting key an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of EnvironmentVariableAWSRegion. If no region is found in the - environment then an InvalidOperationException is thrown. - - - - - Determines region based on inspection of the instance metadata if running on an EC2 instance. - If instance metadata cannot be read or does not contain region information an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of InstanceProfileAWSRegion. If no region is found in the - metadata or we are not running on an EC2 instance an InvalidOperationException is thrown. - - - - - Determines region based on a stored in an . - If the profile doesn't exist or there is no region information an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of . - If the AWS_PROFILE environment variable is set the instance will be constructed using that profile, - otherwise it will use the default profile. - - If the profile doesn't exist or there is no region information an InvalidOperationException is thrown. - - The ICredentialProfileSource to read the profile from. - - - - Attempts to construct an instance of . - If the profile doesn't exist or there is no region information an InvalidOperationException is thrown. - - The ICredentialProfileSource to read the profile from. - The name of the profile. - - - - Probing mechanism to determine region from various sources. - - - - - This class is responsible for keeping track of Retry capacity across different ServiceURLs. - - - - - This method acquires a said retry capacity if the container has the capacity. - - Contains the RetryCapacity object for the said ServiceURL. - - - - This method calls a method to release capacity back - based on whether it was a successful response or a successful retry response. This is invoked by a retry request response. - - if this request is a retry, use a different capacity cost - Contains the RetryCapacity object for the said ServiceURL. - - - - Ths method fetches the RetryCapacity for the given ServiceURL from CapacityManager.CapacityContainer - - - - - This method releases capacity back. This is invoked by the TryReleaseCapacity method. - - Contains the RetryCapacity object for the said ServiceURL. - The capacity that needs to be released based on whether it was a successful response or a successful retry response. - - - - This class is the RetryCapacity class for a given ServiceURL. - - - - - This class composes Client Context header for Amazon Web Service client. - It contains information like app title, version code, version name, client id, OS platform etc. - - - - - Adds the custom attributes to the Client Context. - - Key. - Value. - - - - Gets a Json Representation of the Client Context. - - Json Representation of Client Context - - - - Class to which the Json stdout from credential process is - de-serialized into. - - - - - Version of the Json payload - - - - - AWS Access key - - - - - AWS Secret key - - - - - AWS Session token for session credentials - - - - - ISO8601 formatted timestamp till when the credential is valid. - - - - - This class gets the CSM configuration if set. - The priority goes - 1. App.config / instantiate on the AWSConfigs class - 2. Environment variable - 3. Shared Profile - - - - - Determine CSM configs from shared profile file. - - - - - Determine CSM configs from environment variables. - - - - - Determine CSM configs from AWSConfigs class. - - - - - Utility class for CSM. - Contains logic to serialize CSM events to Json. - - - - - Method to retrieve the API name from the request name. - - - - - Method to serialize MonitoringAPICallAttempt CSM event to json. - - - - - Method to serialize MonitoringAPICallEvent CSM event to json. - - - - - Method to serialize MonitoringAPICall CSM event to json. - - - - - Internal class that has the CSM configurations for the Monitoring Listener - after being derived from the CSMConfigChain class. - - - - - CSM event base class - - - - - Contains the operation name for the api call being made - - - - - Contains the service id ServiceId Sep of the service - against which the call is being made - - - - - Contains the "ClientId" configuration value - computed from the CSMConfigChain class - - - - - Contains the elapsed time, in milliseconds, - since January 1st, 1970, for the time point - at which the event occurred - - - - - Contains "ApiCall" or "ApiCallAttempt" - based on what the monitoring event is describing - - - - - Contains the enum of the above CSM type property - - - - - Contains the "Version" configuration value - computed from the CSMConfigChain class - Defaults to 1. - - - - - Contains the signing region used by the - service client that made the request attempt. - - - - - Contains the full value of the SDK's default - user agent header for http requests. - - - - - Class that captures the CSM Api Call Attempt Monitoring Events - for each http request and its subsequent response. - - - - - Contains the fully-qualified domain name of the endpoint that - the request attempt was submitted to. - - - - - Contains the session token passed - in the x-amz-security-token header. - - - - - Contains the aws_access_key value that - was used to sign the http request. - - - - - Contains the attempt's response status code, - as returned by the http client. - - - - - Contains the full text (exception object converted to String, - for example) for any attempt-level failure that is due to - something other than an Aws exception. The value of this entry - has a maximum length of 512. - - - - - Contains the short error name (exception class name, for example) - for any attempt-level failure that is due to something other - than an Aws exception.The value of this entry has a maximum length of 128. - - - - - Contains the Aws exception code returned in the response. - - - - - Contains the full text of the Aws exception message. - - - - - Contains the value of the response's x-amzn-RequestId header. - - - - - Contains the value of the response's x-amz-request-id header. - - - - - Contains the value of the response's x-amz-id-2 header. - - - - - Contains the elapsed time, in milliseconds, - between the construction of the http request and the - point in time where the http response has been parsed - or the attempt has definitively failed. - - - - - Class that captures the CSM Api Call Monitoring Events - for the entire SDK call. This is processed once. - - - - - Contains the total number of attempts that were made - by the service client to fulfill this request before succeeding or failing - - - - - Contains the elapsed time, in milliseconds, - between when the Api Call was begun and when a - final response or error is manifested to the caller - - - - - a boolean (0/1) value that is 0 unless the Api call failed - and the final attempt returned a retryable error.This entry should be - serialized as a numeric 0/1 value. This is mapped to MaxRetriesExceeded - when serialized to a UDP datagram. - - - - - Contains the full text (exception object - converted to String, for example) for an attempt-level failure that is due to - something other than an Aws exception that occurred on the last attempt to - fulfill the Api call.The value of this entry has a maximum length of 512. - - - - - Contains the short error name (exception - class name, for example) for a failure that is due to something other than an - Aws exception that occurred on the last attempt to fulfill an Api call.See - the SdkException entry for more details.The value of this entry has a - maximum length of 128. - - - - - Contains the Aws exception code - returned in the response to the final attempt at fulfilling this API call. - The value of this entry has a maximum length of 128. - - - - - - Contains the attempt's response status code, - as returned by the http client. - - - - - Computes RFC 2104-compliant HMAC signature. - - - - - Computes RFC 2104-compliant HMAC signature. - - - - - Inspects the supplied evidence to return the signer appropriate for the operation - - Global setting for the service - The request. - Configuration for the client - True if signature v4 request signing should be used - - - - Signs the specified request with the AWS3 signing protocol by using the - AWS account credentials given in the method parameters. - - The AWS public key - The AWS secret key used to sign the request in clear text - Request metrics - The configuration that specifies which hashing algorithm to use - The request to have the signature compute for - If any problems are encountered while signing the request - - - - AWS4 protocol signer for service calls that transmit authorization in the header field "Authorization". - - - - - Calculates and signs the specified request using the AWS4 signing protocol by using the - AWS account credentials given in the method parameters. The resulting signature is added - to the request headers as 'Authorization'. Parameters supplied in the request, either in - the resource path as a query string or in the Parameters collection must not have been - uri encoded. If they have, use the SignRequest method to obtain a signature. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. - - - Client configuration data encompassing the service call (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text. - - - If any problems are encountered while signing the request. - - - - - Calculates and signs the specified request using the AWS4 signing protocol by using the - AWS account credentials given in the method parameters. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. - - - Client configuration data encompassing the service call (notably authentication - region, endpoint and service name). - - - Metrics for the request. - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text. - - - If any problems are encountered while signing the request. - - - Parameters passed as part of the resource path should be uri-encoded prior to - entry to the signer. Parameters passed in the request.Parameters collection should - be not be encoded; encoding will be done for these parameters as part of the - construction of the canonical request. - - - - - Sets the AWS4 mandated 'host' and 'x-amz-date' headers, returning the date/time that will - be used throughout the signing process in various elements and formats. - - The current set of headers - - Date and time used for x-amz-date, in UTC - - - - Sets the AWS4 mandated 'host' and 'x-amz-date' headers, accepting and returning the date/time that will - be used throughout the signing process in various elements and formats. - - The current set of headers - - - Date and time used for x-amz-date, in UTC - - - - Computes and returns an AWS4 signature for the specified canonicalized request - - - - - - - - - - - - Computes and returns an AWS4 signature for the specified canonicalized request - - - - - - - - - - - - - Computes and returns an AWS4 signature for the specified canonicalized request - - - - - - - - - - - - - - Formats the supplied date and time for use in AWS4 signing, where various formats are used. - - - The required format - The UTC date/time in the requested format - - - - Compute and return the multi-stage signing key for the request. - - The clear-text AWS secret key, if not held in secureKey - The region in which the service request will be processed - Date of the request, in yyyyMMdd format - The name of the service being called by the request - Computed signing key - - - - If the caller has already set the x-amz-content-sha256 header with a pre-computed - content hash, or it is present as ContentStreamHash on the request instance, return - the value to be used in request canonicalization. - If not set as a header or in the request, attempt to compute a hash based on - inspection of the style of the request content. - - - - The computed hash, whether already set in headers or computed here. Null - if we were not able to compute a hash. - - - - - If signPayload is false set the x-amz-content-sha256 header to - the UNSIGNED-PAYLOAD magic string and return it. - Otherwise, if the caller has already set the x-amz-content-sha256 header with a pre-computed - content hash, or it is present as ContentStreamHash on the request instance, return - the value to be used in request canonicalization. - If not set as a header or in the request, attempt to compute a hash based on - inspection of the style of the request content. - - - - - The computed hash, whether already set in headers or computed here. Null - if we were not able to compute a hash. - - - - - Returns the HMAC256 for an arbitrary blob using the specified key - - - - - - - - Returns the HMAC256 for an arbitrary blob using the specified key - - - - - - - - Compute and return the hash of a data blob using the specified key - - Algorithm to use for hashing - Hash key - Data blob - Hash of the data - - - - Compute and return the hash of a data blob using the specified key - - Algorithm to use for hashing - Hash key - Data blob - Hash of the data - - - - Computes the non-keyed hash of the supplied data - - - - - - - Computes the non-keyed hash of the supplied data - - - - - - - Computes and returns the canonical request - - The endpoint URL - the path of the resource being operated on - The http method used for the request - The full request headers, sorted into canonical order - The query parameters for the request - - The hash of the binary request body if present. If not supplied, the routine - will look for the hash as a header on the request. - - Canonicalised request as a string - - - - Computes and returns the canonical request - - The endpoint URL - the path of the resource being operated on - The http method used for the request - The full request headers, sorted into canonical order - The query parameters for the request - - The path resource values lookup to use to replace the keys within resourcePath - The hash of the binary request body if present. If not supplied, the routine - will look for the hash as a header on the request. - - The version of the marshaller that constructed the request object. - Canonicalised request as a string - - - - Reorders the headers for the request for canonicalization. - - The set of proposed headers for the request - List of headers that must be included in the signature - For AWS4 signing, all headers are considered viable for inclusion - - - - Computes the canonical headers with values for the request. Only headers included in the signature - are included in the canonicalization process. - - All request headers, sorted into canonical order - Canonicalized string of headers, with the header names in lower case. - - - - Returns the set of headers included in the signature as a flattened, ;-delimited string - - The headers included in the signature - Formatted string of header names - - - - Collects the subresource and query string parameters into one collection - ready for canonicalization - - The in-flight request being signed - The fused set of parameters - - - - Computes and returns the canonicalized query string, if query parameters have been supplied. - Parameters with no value will be canonicalized as 'param='. The expectation is that parameters - have not already been url encoded prior to canonicalization. - - The set of parameters being passed on the uri - - Parameters must be uri encoded into the canonical request and by default the signer expects - that the supplied collection contains non-encoded data. Set this to false if the encoding was - done prior to signer entry. - - The uri encoded query string parameters in canonical ordering - - - - Computes and returns the canonicalized query string, if query parameters have been supplied. - Parameters with no value will be canonicalized as 'param='. The expectation is that parameters - have not already been url encoded prior to canonicalization. - - The set of parameters to be encoded in the query string - - Parameters must be uri encoded into the canonical request and by default the signer expects - that the supplied collection contains non-encoded data. Set this to false if the encoding was - done prior to signer entry. - - The uri encoded query string parameters in canonical ordering - - - - Returns the request parameters in the form of a query string. - - The request instance - Request parameters in query string format - - - - AWS4 protocol signer for Amazon S3 presigned urls. - - - - - Calculates and signs the specified request using the AWS4 signing protocol by using the - AWS account credentials given in the method parameters. The resulting signature is added - to the request headers as 'Authorization'. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. - - - Adding supporting data for the service call required by the signer (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text - - - If any problems are encountered while signing the request. - - - - - Calculates the AWS4 signature for a presigned url. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. If the Expires parameter - is present, it is renamed to 'X-Amz-Expires' before signing. - - - Adding supporting data for the service call required by the signer (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text - - - If any problems are encountered while signing the request. - - - Parameters passed as part of the resource path should be uri-encoded prior to - entry to the signer. Parameters passed in the request.Parameters collection should - be not be encoded; encoding will be done for these parameters as part of the - construction of the canonical request. - - - - - Calculates the AWS4 signature for a presigned url. - - - The request to compute the signature for. Additional headers mandated by the AWS4 protocol - ('host' and 'x-amz-date') will be added to the request before signing. If the Expires parameter - is present, it is renamed to 'X-Amz-Expires' before signing. - - - Adding supporting data for the service call required by the signer (notably authentication - region, endpoint and service name). - - - Metrics for the request - - - The AWS public key for the account making the service call. - - - The AWS secret key for the account making the call, in clear text - - - The service to sign for - - - The region to sign to, if null then the region the client is configured for will be used. - - - If any problems are encountered while signing the request. - - - Parameters passed as part of the resource path should be uri-encoded prior to - entry to the signer. Parameters passed in the request.Parameters collection should - be not be encoded; encoding will be done for these parameters as part of the - construction of the canonical request. - - The X-Amz-Content-SHA256 is cleared out of the request. - If the request is for S3 then the UNSIGNED_PAYLOAD value is used to generate the canonical request. - If the request isn't for S3 then the empty body SHA is used to generate the canonical request. - - - - - Encapsulates the various fields and eventual signing value that makes up - an AWS4 signature. This can be used to retrieve the required authorization string - or authorization query parameters for the final request as well as hold ongoing - signature computations for subsequent calls related to the initial signing. - - - - - Constructs a new signing result instance for a computed signature - - The access key that was included in the signature - Date/time (UTC) that the signature was computed - The collection of headers names that were included in the signature - Formatted 'scope' value for signing (YYYYMMDD/region/service/aws4_request) - Returns the key that was used to compute the signature - Computed signature - - - - The access key that was used in signature computation. - - - - - ISO8601 formatted date/time that the signature was computed - - - - - ISO8601 formatted date that the signature was computed - - - - - The ;-delimited collection of header names that were included in the signature computation - - - - - Formatted 'scope' value for signing (YYYYMMDD/region/service/aws4_request) - - - - - Returns a copy of the key that was used to compute the signature - - - - - Returns the hex string representing the signature - - - - - Returns a copy of the byte array containing the signature - - - - - Returns the signature in a form usable as an 'Authorization' header value. - - - - - Returns the signature in a form usable as a set of query string parameters. - - - - - Null Signer which does a no-op. - - - - - Signs the specified request with the AWS2 signing protocol by using the - AWS account credentials given in the method parameters. - - The AWS public key - The AWS secret key used to sign the request in clear text - Request metrics - The configuration that specifies which hashing algorithm to use - The request to have the signature compute for - If any problems are encountered while signing the request - - - - S3 signer constructor - - - - - S3 signer constructor - - - - - This exception is thrown if there are problems signing the request. - - - - - Collection used to indicate if the property was initialized was created by the SDK. - - - - - - Collection used to indicate if the property was initialized was created by the SDK. - - - - - - - Default implementation of the IRequest interface. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Constructs a new DefaultRequest with the specified service name and the - original, user facing request object. - - The orignal request that is being wrapped - The service name - - - - The name of the request - - - - - Gets and sets the type of http request to make, whether it should be POST,GET or DELETE - - - - - Gets and sets a flag that indicates whether the request is sent as a query string instead of the request body. - - - - - Returns the original, user facing request object which this internal - request object is representing. - - - - - Returns a dictionary of the headers included in this request. - - - - - Returns a dictionary of the parameters included in this request. - - - - - Collection of parameters included in this request. - - - - - Returns the subresources that should be appended to the resource path. - This is used primarily for Amazon S3, where object keys can contain '?' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new null entry to the SubResources collection for the request - - The name of the subresource - - - - Adds a new entry to the SubResources collection for the request - - The name of the subresource - Value of the entry - - - - Gets and Sets the endpoint for this request. - - - - - Gets and Sets the resource path added on to the endpoint. - - - - - Returns the path resources that should be used within the resource path. - This is used for services where path keys can contain '/' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new entry to the PathResources collection for the request - - The name of the pathresource with potential greedy syntax: {key+} - Value of the entry - - - - Gets and Sets the version number for the marshaller used to create this request. The version number - is used to support backward compatible changes that would otherwise be breaking changes when a - newer core is used with an older service assembly. - Versions: - 1 - Default version - 2 - Support for path segments - - - - - Gets and Sets the content for this request. - - - - - Flag that signals that Content was and should be set - from the Parameters collection. - - - - - Gets and sets the content stream. - - - - - Gets and sets the original stream position. - If ContentStream is null or does not support seek, this propery - should be equal to -1. - - - - - Computes the SHA 256 hash of the content stream. If the stream is not - seekable, it searches the parent stream hierarchy to find a seekable - stream prior to computation. Once computed, the hash is cached for future - use. If a suitable stream cannot be found to use, null is returned. - - - - - The name of the service to which this request is being sent. - - - - - Alternate endpoint to use for this request, if any. - - - - - Host prefix value to prepend to the endpoint for this request, if any. - - - - - Gets and sets the Suppress404Exceptions property. If true then 404s return back from AWS will not cause an exception and - an empty response object will be returned. - - - - - If using AWS4 signing protocol, contains the resultant parts of the - signature that we may need to make use of if we elect to do a chunked - encoding upload. - - - - - Determine whether to use a chunked encoding upload for the request - (applies to Amazon S3 PutObject and UploadPart requests only). - - - - - - Used for Amazon S3 requests where the bucket name is removed from - the marshalled resource path into the host header. To comply with - AWS2 signature calculation, we need to recover the bucket name - and include it in the resource canonicalization, which we do using - this field. - - - - - This flag specifies if SigV4 is required for the current request. - - - - - The authentication region to use for the request. - Set from Config.AuthenticationRegion. - - - - - The region in which the service request was signed. - - - - - Checks if the request stream can be rewinded. - - Returns true if the request stream can be rewinded , - else false. - - - - Returns true if the request can contain a request body, else false. - - Returns true if the currect request can contain a request body, else false. - - - - Returns true if the request has a body, else false. - - Returns true if the request has a body, else false. - - - - Class containing the data for one endpoint returned from a endpoint discovery request - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Constructs a new DiscoveryEndpoint - - The address of the endpoint - The cache period for the endpoint in minutes - - - - The address of the endpoint. - - - - - The cache period for the endpoint in minutes - - - - - Calculates if this endpoint has expired - - A boolean value indicating if the cache period has expired - - - - Extends the endpoint expiration by the specified number of minutes from now. - - - - - Class containing the data for one endpoint returned from a endpoint discovery request - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class containing the data to use with endpoint discovery - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Gets/sets and flag indicating if endpoint discovery is required for the request. - - - - - Sorted dictionary of the identifiers that must be sent with the endpoint discovery request. These - identifiers are used to construct the cache key for the cache that stores discovered endpoints. A - sorted dictionary is used instead of a dictionary to ensure the cache key comes out in the same order - each time it is constructed. - - - - - Represents the data to be used with endpoint discovery operations - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class used to resolve endpoints using Endpoint Discovery. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Method that performs endpoint discovery for the current operation - - Context information used in calculations for endpoint discovery - The operation to fetch endpoints from the server - - - - - Gets the number of cache keys in the cache - - - - - Class used to resolve endpoints using Endpoint Discovery. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class containing context information to use with endpoint discovery - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Gets the customer credential information. - - - - - Gets the operation name. - - - - - Gets the current marshalled endpoint discovery data. - - - - - Gets the flag indicating if the specified key should be evicted from the cache. - - - - - Gets the Uri that should be evicted if EvictCacheKey is set to true. - - - - - Class containing context information to use with endpoint discovery - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Error type, one of Sender, Receiver, Unknown - Only applies to XML-based services. - - - - - Name of the exception class to return - - - - - Error message - - - - - RequestId of the error. - Only applies to XML-based services. - - - - - Class containing the members used to invoke service calls - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Class containing the members used to invoke service calls - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - Represents a request being sent to an Amazon Web Service, including the - parameters being sent as part of the request, the endpoint to which the - request should be sent, etc. - - This class is only intended for internal use inside the AWS client libraries. - Callers shouldn't ever interact directly with objects of this class. - - - - - - The name of the request - - - - - Returns a dictionary of the headers included in this request. - - - - - Gets and sets a flag that indicates whether the request is sent as a query string instead of the request body. - - - - - Returns a dictionary of the parameters included in this request. - - - - - Collection of parameters included in this request. - - - - - Returns the subresources that should be appended to the resource path. - This is used primarily for Amazon S3, where object keys can contain '?' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new null entry to the SubResources collection for the request - - The name of the subresource - - - - Adds a new entry to the SubResources collection for the request - - The name of the subresource - Value of the entry - - - - Gets and sets the type of http request to make, whether it should be POST,GET or DELETE - - - - - Gets and Sets the endpoint for this request. - - - - - Gets and Sets the resource path added on to the endpoint. - - - - - Returns the path resources that should be used within the resource path. - This is used for services where path keys can contain '/' - characters, making string-splitting of a resource path potentially - hazardous. - - - - - Adds a new entry to the PathResources collection for the request - - The name of the pathresource with potential greedy syntax: {key+} - Value of the entry - - - - Gets and Sets the version number for the marshaller used to create this request. The version number - is used to support backward compatible changes that would otherwise be breaking changes when a - newer core is used with an older service assembly. - - - - - Gets and Sets the content for this request. - - - - - Gets the header value from the request. - - - - - Flag that signals that Content was and should be set - from the Parameters collection. - - - - - Gets and sets the content stream. - - - - - Gets and sets the original stream position. - If ContentStream is null or does not support seek, this propery - should be equal to -1. - - - - - Computes the SHA 256 hash of the content stream. If the stream is not - seekable, it searches the parent stream hierarchy to find a seekable - stream prior to computation. Once computed, the hash is cached for future - use. - - - - - The name of the service to which this request is being sent. - - - - - Returns the original, user facing request object which this internal - request object is representing. - - - - - Alternate endpoint to use for this request, if any. - - - - - Host prefix value to prepend to the endpoint for this request, if any. - - - - - Gets and sets the Suppress404Exceptions property. If true then 404s return back from AWS will not cause an exception and - an empty response object will be returned. - - - - - If using AWS4 signing protocol, contains the resultant parts of the - signature that we may need to make use of if we elect to do a chunked - encoding upload. - - - - - Determine whether to use a chunked encoding upload for the request - (applies to Amazon S3 PutObject and UploadPart requests only). - - - - - - Used for Amazon S3 requests where the bucket name is removed from - the marshalled resource path into the host header. To comply with - AWS2 signature calculation, we need to recover the bucket name - and include it in the resource canonicalization, which we do using - this field. - - - - - This flag specifies if SigV4 is required for the current request. - - - - - The authentication region to use for the request. - Set from Config.AuthenticationRegion. - - - - - The region in which the service request was signed. - - - - - Checks if the request stream can be rewinded. - - Returns true if the request stream can be rewinded , - else false. - - - - Returns true if the request can contain a request body, else false. - - Returns true if the currect request can contain a request body, else false. - - - - Returns true if the request has a body, else false. - - Returns true if the request has a body, else false. - - - - Gets the value of the Service Id. - - - - - Gets the dictionary that gives mapping of renamed operations - - - - - IDictionary{String, String} access to ParameterCollection. - TODO: remove this class in version 3.4 of the SDK. - - - - - Constructs ParametersDictionaryFacade for a ParameterCollection - - - - - - A registry of object that will manipulate the runtime pipeline used by service clients. - - - - - Registers a customizer that will be applied for all service clients created. Each customizer has a unique name associated with it. If a customizer is registered more - than once with the same unique name then the calls after the first will be ignored. - - - - - - Deregistered the runtime pipeline customizer - - - - - - Deregistered the runtime pipeline customizer - - - - - - Applies all of the registered customizers on the runtime pipeline - - The service clients runtime pipeline. - Type object for the service client being created - - - - Interface for objects that will customize the runtime pipleine for newly created service clients. - - - - - The unique name for the customizer that identifies the customizer in the registry. The name is also used to identify the customizer on the SDK logs. - - - - - Called on service clients as they are being constructed to customize their runtime pipeline. - - - Type object for the service client being created - - - - Default ServiceMetadata implementation. - This implementation will be used if the service doesn't have a - IServiceMetadata implementation. - - - - - Gets the value of the Service Id. - - - - - Gets the dictionary that gives mapping of renamed operations - - - - - Response Unmarshaller for all Errors - - - - - Build an ErrorResponse from XML - - The XML parsing context. - Usually an Amazon.Runtime.Internal.UnmarshallerContext. - An ErrorResponse object. - - - - Return an instance of and ErrorResponseUnmarshaller. - - - - - - Interface for unmarshallers which unmarshall service responses. - The Unmarshallers are stateless, and only encode the rules for what data - in the XML stream goes into what members of an object. - - The type of object the unmarshaller returns - The type of the XML unmashaller context, which contains the - state of parsing the XML stream. Uaually an instance of - Amazon.Runtime.Internal.Transform.UnmarshallerContext. - - - - Extracts an exeption with data from an ErrorResponse. - - The XML parsing context. - An inner exception to be included with the returned exception - The HttpStatusCode from the ErrorResponse - Either an exception based on the ErrorCode from the ErrorResponse, or the - general service exception for the service in question. - - - - Interface for unmarshallers which unmarshall objects from response data. - The Unmarshallers are stateless, and only encode the rules for what data - in the XML stream goes into what members of an object. - - The type of object the unmarshaller returns - The type of the XML unmashaller context, which contains the - state during parsing of the XML stream. Usually an instance of - Amazon.Runtime.Internal.Transform.UnmarshallerContext. - - - - Given the current position in the XML stream, extract a T. - - The XML parsing context - An object of type T populated with data from the XML stream. - - - - Response Unmarshaller for all Errors - - - - - Build an ErrorResponse from json - - The json parsing context. - Usually an Amazon.Runtime.Internal.JsonUnmarshallerContext. - An ErrorResponse object. - - - - Return an instance of JsonErrorResponseUnmarshaller. - - - - - - Wraps a json string for unmarshalling. - - Each Read() operation gets the next token. - TestExpression() is used to match the current key-chain - to an xpath expression. The general pattern looks like this: - - JsonUnmarshallerContext context = new JsonUnmarshallerContext(jsonString); - while (context.Read()) - { - if (context.IsKey) - { - if (context.TestExpresion("path/to/element")) - { - myObject.stringMember = stringUnmarshaller.GetInstance().Unmarshall(context); - continue; - } - } - } - - - - - - Wrap the jsonstring for unmarshalling. - - Stream that contains the JSON for unmarshalling - If set to true, maintains a copy of the complete response body as the stream is being read. - Response data coming back from the request - - - - Are we at the start of the json document. - - - - - Is the current token the end of an object - - - - - Is the current token the start of an object - - - - - Returns the element depth of the parser's current position in the json - document being parsed. - - - - - The current Json path that is being unmarshalled. - - - - - Reads to the next token in the json document, and updates the context - accordingly. - - - True if a token was read, false if there are no more tokens to read. - - - - - Peeks at the next token. This peek implementation - reads the next token and makes the subsequent Read() return the same data. - If Peek is called successively, it will return the same data. - Only the first one calls Read(), subsequent calls - will return the same data until a Read() call is made. - - Token to peek. - Returns true if the peeked token matches given token. - - - - Returns the text contents of the current token being parsed. - - - The text contents of the current token being parsed. - - - - - The type of the current token - - - - - Get the base stream of the jsonStream. - - - - - Peeks at the next (non-whitespace) character in the jsonStream. - - The next (non-whitespace) character in the jsonStream, or -1 if at the end. - - - - Peeks at the next character in the stream. - If the data isn't buffered into the StreamReader (Peek() returns -1), - we flush the buffered data and try one more time. - - - - - - Abstract class for unmarshalling service responses. - - - - - Class for unmarshalling XML service responses. - - - - - Class for unmarshalling EC2 service responses. - - - - - Class for unmarshalling JSON service responses. - - - - - Unmarshaller for int fields - - - - - Unmarshaller for nullable int fields. Implemented only for JSON context - to handle cases where value can be null e.g. {'Priority': null}. - This unmarshaller is not implemented for XML context, as XML responses - will null elements (xsi:nil='true') will be skipped by the XML parser. - - - - - Unmarshaller for long fields - - - - - Unmarshaller for float fields - - - - - Unmarshaller for double fields - - - - - Unmarshaller for decimal fields - - - - - Unmarshaller for bool fields - - - - - Unmarshaller for string fields - - - - - Unmarshaller for byte fields - - - - - Unmarshaller for DateTime fields - - - - - Unmarshalls given string as a DateTime. Handles cases where we want to unmarshall - as just a DateTime or a nullable Datetime. - - Value to be parsed - If true, the method will return null if text is null. - If false, the method will return default(DateTime), if text is null. - - - - - Unmarshaller for nullable DateTime fields. Implemented only for JSON context - to handle cases where value can be null e.g. {'Priority': null}. - This unmarshaller is not implemented for XML context, as XML responses - will null elements (xsi:nil='true') will be skipped by the XML parser. - - - - - Unmarshaller for MemoryStream fields - - - - - Unmarshaller for ResponseMetadata - - - - - Base class for the UnmarshallerContext objects that are used - to unmarshall a web-service response. - - - - - Tests the specified expression against the current position in the XML - document - - The pseudo-XPath expression to test. - - True if the expression matches the current position in the document, - false otherwise. - - - - Tests the specified expression against the current position in the XML - document being parsed, and restricts the expression to matching at the - specified stack depth. - - The pseudo-XPath expression to test. - - The depth in the stack representing where the expression must - start matching in order for this method to return true. - - True if the specified expression matches the current position in - the XML document, starting from the specified depth. - - - - Reads the next token at depth greater than or equal to target depth. - - Tokens are read at depth greater than or equal to target depth. - True if a token was read and current depth is greater than or equal to target depth. - - - - The current path that is being unmarshalled. - - - - - Returns the element depth of the parser's current position in the - document being parsed. - - - - - Reads to the next node in the document, and updates the context accordingly. - - - True if a node was read, false if there are no more elements to read. - - - - - Returns the text contents of the current element being parsed. - - - The text contents of the current element being parsed. - - - - - True if NodeType is Element. - - - - - True if NodeType is EndElement. - - - - - True if the context is at the start of the document. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Wrap an XmltextReader for simulating an event stream. - - Each Read() operation goes either to the next element or next attribute within - the current element. TestExpression() is used to match the current event - to an xpath expression. The general pattern looks like this: - - UnmarshallerContext context = new UnmarshallerContext(...); - while (context.Read()) - { - if (context.TestExpresion("path/to/element")) - { - myObject.stringMember = stringUnmarshaller.GetInstance().Unmarshall(context); - continue; - } - if (context.TestExpression("path/to/@attribute")) - myObject.MyComplexTypeMember = MyComplexTypeUnmarshaller.GetInstance().Unmarshall(context); - } - - - - - - Wrap an XmlTextReader with state for event-based parsing of an XML stream. - - Stream with the XML from a service response. - If set to true, maintains a copy of the complete response body as the stream is being read. - Response data coming back from the request - - - - The current XML path that is being unmarshalled. - - - - - Returns the element depth of the parser's current position in the XML - document being parsed. - - - - - Reads to the next node in the XML document, and updates the context accordingly. - - - True if a node was read, false if there are no more elements to read./ - - - - - Returns the text contents of the current element being parsed. - - - The text contents of the current element being parsed. - - - - - True if NodeType is Element. - - - - - True if NodeType is EndElement. - - - - - True if the context is at the start of the document. - - - - - True if NodeType is Attribute. - - - - - Wrap an XmlTextReader with state for event-based parsing of an XML stream. - - Stream with the XML from a service response. - If set to true, maintains a copy of the complete response body as the stream is being read. - Response data coming back from the request - - - - RequestId value, if found in response - - - - - Reads to the next node in the XML document, and updates the context accordingly. - If node is RequestId, reads the contents and stores in RequestId property. - - - True if a node was read, false if there are no more elements to read./ - - - - - A stream which caches the contents of the underlying stream as it reads it. - - - - - All the bytes read by the stream. - - - - - Initializes the CachingWrapperStream with a base stream. - - The stream to be wrapped. - Maximum number of bytes to be cached. - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Gets a value indicating whether the current stream supports seeking. - CachingWrapperStream does not support seeking, this will always be false. - - - - - Gets or sets the position within the current stream. - CachingWrapperStream does not support seeking, attempting to set Position - will throw NotSupportedException. - - - - - Sets the position within the current stream. - CachingWrapperStream does not support seeking, attempting to call Seek - will throw NotSupportedException. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Stream wrapper that double-buffers from a wrapped stream and - returns the buffered content as a series of signed 'chunks' - for the AWS4 ('Signature V4') protocol. - - - - - Reads some or all of the processed chunk to the consumer, constructing - and streaming a new chunk if more input data is available. - - - - - - - - - Results of the header-signing portion of the request - - - - - Computed signature of the chunk prior to the one in-flight, in - hex - - - - - Computes the derived signature for a chunk of data of given length in the input buffer, - placing a formatted chunk with headers, signature and data into the output buffer - ready for streaming back to the consumer. - - - - - - Length override to return the true length of the payload plus the metainfo - supplied with each chunk - - - - - Computes the total size of the data payload, including the chunk metadata. - Called externally so as to be able to set the correct Content-Length header - value. - - - - - - - Computes the size of the header data for each chunk. - - - - - - - Attempt to read sufficient data for a whole chunk from the wrapped stream, - returning the number of bytes successfully read to be processed into a chunk - - - - - A list object that will always be sent to AWS services, - even if it is empty. - The AWS .NET SDK does not send empty collections to services, unless - the collection is of this type. - - - - - - A dictionary object that will always be sent to AWS services, - even if it is empty. - The AWS .NET SDK does not send empty collections to services, unless - the collection is of this type. - - - - - - - A wrapper stream that decrypts the base stream as it - is being read. - - - - - Initializes an DecryptStream with an decryption algorithm and a base stream. - - Stream to perform encryption on.. - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Gets a value indicating whether the current stream supports seeking. - DecryptStream does not support seeking, this will always be false. - - - - - Gets or sets the position within the current stream. - DecryptStream does not support seeking, attempting to set Position - will throw NotSupportedException. - - - - - Sets the position within the current stream. - DecryptStream does not support seeking, attempting to call Seek - will throw NotSupportedException. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Validates the underlying stream. - - - - - A wrapper stream that decrypts the base stream as it - is being read. - - - - - Initializes an DecryptStream with an decryption algorithm and a base stream. - - Stream to perform encryption on.. - Symmetric key to perform decryption - Initialization vector to perform decryption - - - - A wrapper stream that decrypts the base stream using AES algorithm as it - is being read. - - - - - Initializes an AESDecryptionStream with a base stream. - - Stream to perform decryption on.. - Symmetric key to perform decryption - Initialization vector to perform decryption - - - - Class to perform actions on a background thread. - Uses a single background thread and performs actions - on it in the order the data was sent through the instance. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Class to invoke actions on a background thread. - Uses a single background thread and invokes actions - on it in the order they were invoked through the instance. - - - - - A wrapper stream that encrypts the base stream as it - is being read. - - - - - Initializes an EncryptStream with an encryption algorithm and a base stream. - - Stream to perform encryption on.. - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Gets a value indicating whether the current stream supports seeking. - - - - - Returns encrypted content length. - - - - - Gets or sets the position within the current stream. - - - - - Sets the position within the current stream. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Validates the underlying stream. - - - - - A wrapper stream that encrypts the base stream as it - is being read. - - - - - Initializes an EncryptStream with an encryption algorithm and a base stream. - - Stream to perform encryption on.. - Symmetric key to perform encryption - Initialization vector to perform encryption - - - - A wrapper stream that encrypts the base stream using AES algorithm as it - is being read. - - - - - Initializes an AESEncryptionStream with a base stream. - - Stream to perform encryption on.. - Symmetric key to perform encryption - Initialization vector to perform encryption - - - - A wrapper stream that encrypts the base stream as it - is being read. - - - - - Initializes an EncryptStream for Multipart uploads with an encryption algorithm and a base stream. - - Stream to perform encryption on.. - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Gets a value indicating whether the current stream supports seeking. - - - - - Returns encrypted content length. - - - - - Gets or sets the position within the current stream. - - - - - Sets the position within the current stream. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Validates the underlying stream. - - - - - A wrapper stream that encrypts the base stream as it - is being read. - - - - - Initializes an EncryptStream with an encryption algorithm and a base stream. - - Stream to perform encryption on.. - Symmetric key to perform encryption - Initialization vector to perform encryption - - - - A wrapper stream that encrypts the base stream as it - is being read. - - - - - Initializes an AESEncryptionStream with a base stream. - - Stream to perform encryption on.. - Symmetric key to perform encryption - Initialization vector to perform encryption - - - - Returns true if the Content is set or there are - query parameters. - - This request - True if data is present; false otherwise. - - - - Utilities for dealing with Guids - - - - - Hashes a set of objects. - - - - - - - Combines a set of hashses. - - - - - - - Combines two hashes. - - - - - - - - Disposes of all managed and unmanaged resources. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - A wrapper stream that calculates a hash of the base stream as it - is being read. - The calculated hash is only available after the stream is closed or - CalculateHash is called. After calling CalculateHash, any further reads - on the streams will not change the CalculatedHash. - If an ExpectedHash is specified and is not equal to the calculated hash, - Close or CalculateHash methods will throw an AmazonClientException. - If CalculatedHash is calculated for only the portion of the stream that - is read. - - - Exception thrown during Close() or CalculateHash(), if ExpectedHash is set and - is different from CalculateHash that the stream calculates, provided that - CalculatedHash is not a zero-length byte array. - - - - - Algorithm to use to calculate hash. - - - - - True if hashing is finished and no more hashing should be done; - otherwise false. - - - - - Current position in the stream. - - - - - Calculated hash for the stream. - This value is set only after the stream is closed. - - - - - Expected hash value. Compared against CalculatedHash upon Close(). - If the hashes are different, an AmazonClientException is thrown. - - - - - Expected length of stream. - - - - - Initializes an HashStream with a hash algorithm and a base stream. - - Stream to calculate hash for. - - Expected hash. Will be compared against calculated hash on stream close. - Pass in null to disable check. - - - Expected length of the stream. If the reading stops before reaching this - position, CalculatedHash will be set to empty array. - - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Gets a value indicating whether the current stream supports seeking. - HashStream does not support seeking, this will always be false. - - - - - Gets or sets the position within the current stream. - HashStream does not support seeking, attempting to set Position - will throw NotSupportedException. - - - - - Sets the position within the current stream. - HashStream does not support seeking, attempting to call Seek - will throw NotSupportedException. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Gets the overridden length used to construct the HashStream - - - - - Calculates the hash for the stream so far and disables any further - hashing. - - - - - Resets the hash stream to starting state. - Use this if the underlying stream has been modified and needs - to be rehashed without reconstructing the hierarchy. - - - - - Validates the underlying stream. - - - - - Compares two hashes (arrays of bytes). - - Expected hash. - Actual hash. - - True if the hashes are identical; otherwise false. - - - - - A wrapper stream that calculates a hash of the base stream as it - is being read or written. - The calculated hash is only available after the stream is closed or - CalculateHash is called. After calling CalculateHash, any further reads - on the streams will not change the CalculatedHash. - If an ExpectedHash is specified and is not equal to the calculated hash, - Close or CalculateHash methods will throw an AmazonClientException. - If base stream's position is not 0 or HashOnReads is true and the entire stream is - not read, the CalculatedHash will be set to an empty byte array and - comparison to ExpectedHash will not be made. - - - Exception thrown during Close() or CalculateHash(), if ExpectedHash is set and - is different from CalculateHash that the stream calculates, provided that - CalculatedHash is not a zero-length byte array. - - - - - Initializes an HashStream with a hash algorithm and a base stream. - - Stream to calculate hash for. - - Expected hash. Will be compared against calculated hash on stream close. - Pass in null to disable check. - - - Expected length of the stream. If the reading stops before reaching this - position, CalculatedHash will be set to empty array. - - - - - A wrapper stream that calculates an MD5 hash of the base stream as it - is being read or written. - The calculated hash is only available after the stream is closed or - CalculateHash is called. After calling CalculateHash, any further reads - on the streams will not change the CalculatedHash. - If an ExpectedHash is specified and is not equal to the calculated hash, - Close or CalculateHash methods will throw an AmazonClientException. - If base stream's position is not 0 or HashOnReads is true and the entire stream is - not read, the CalculatedHash will be set to an empty byte array and - comparison to ExpectedHash will not be made. - - - Exception thrown during Close() or CalculateHash(), if ExpectedHash is set and - is different from CalculateHash that the stream calculates, provided that - CalculatedHash is not a zero-length byte array. - - - - - Initializes an MD5Stream with a base stream. - - Stream to calculate hash for. - - Expected hash. Will be compared against calculated hash on stream close. - Pass in null to disable check. - - - Expected length of the stream. If the reading stops before reaching this - position, CalculatedHash will be set to empty array. - - - - - Utilities for validating label values for host prefix templates - - - - - Validates a label value - - - - - Provides read/write access to a file in the INI format. - - This class is not threadsafe. - - - - - Construct a new IniFile. - - path of the IniFile - - - - the path of the file - - - - - helper to access the lines of the file - - - - - Persist the changes to this INI file to disk. - - - - - Rename the section fromSectionName to toSectionName - - - - - - - Rename the section fromSectionName to toSectionName - - - - if true and destination section already exists overwrite it - - - - Copy the section fromSectionName to toSectionName - - - - Any properties in the original section that are also in this dictionary will - be replaced by the value from this dictionary. - - - - Copy the section fromSectionName to toSectionName - - - - Any properties in the original section that are also in this dictionary will - be replaced by the value from this dictionary. - if true and destination section already exists overwrite it - - - - Update the section with the properties given. - If the section doesn't exist, it will be appended to the file. - - Notes: - 1. Any properties that do exist in the section will be updated. - 2. A null value for a property denotes that it should be deleted from the section - 3. If any properties don't exist they will be appended to the end of the section - in the same order they appear in the SortedDictionary. - - name of the section to operate on - properties to add/update/delete - - - - Check if the section exists. If not, append it to the end of the file. - - section to ensure exists - - - - If the section exists, delete it from the INI file. - - section to delete - - - - Determine if a section exists in the INI file. - - name of section to look for - true if the section exists, false otherwise - - - - Return the properties for the section if it exists. - - name of section to get - properties contained in the section - True if the section was found, false otherwise - - - - Return the properties for the section if it exists. - - Regex to match name of section to get - properties contained in the section - True if the section was found, false otherwise - - - - Return the properties for the section if it exists. - - Regex to match name of section to get - name of section if regex matches - properties contained in the section - True if the section was found, false otherwise - - - - Simple wrapper around the log4net Error method. - - - - - - - - Write debug message to Console - - - - - - - - Write debug message to Console - - - - - - - Simple wrapper around the log4net InfoFormat method. - - - - - - - This is a dynamic wrapper around log4net so we can avoid log4net being required - to be distributed with the SDK. - - - - - Abstract logger class, base for any custom/specific loggers. - - - - - Flushes the logger contents. - - - - - Simple wrapper around the log4net IsErrorEnabled property. - - - - - Simple wrapper around the log4net IsDebugEnabled property. - - - - - Simple wrapper around the log4net IsInfoEnabled property. - - - - - Simple wrapper around the log4net Error method. - - - - - - - - Simple wrapper around the log4net Debug method. - - - - - - - - Simple wrapper around the log4net DebugFormat method. - - - - - - - Simple wrapper around the log4net InfoFormat method. - - - - - - - Logger wrapper for System.Diagnostics.TraceSource logger. - - - - - Creates TraceRoute for a given Type or the closest "parent" that has a listener configured. - Example: if type is Amazon.DynamoDB.AmazonDynamoDBClient, listeners can be configured for: - -Amazon.DynamoDB.AmazonDynamoDBClient - -Amazon.DynamoDB - -Amazon - The first matching TraceSource with listeners will be used. - If no listeners are configured for type or one of its "parents", will return null. - - - - - Gets a TraceSource for given Type with SourceLevels.All. - If there are no listeners configured for targetType or one of its "parents", returns null. - - - - - - - Gets a TraceSource for given Type and SourceLevels. - If there are no listeners configured for targetType or one of its "parents", returns null. - - - - - - - - Logger wrapper for reflected log4net logging methods. - - - - - This should be a one time call to use reflection to find all the types and methods - needed for the logging API. - - - - - Simple wrapper around the log4net IsErrorEnabled property. - - - - - Simple wrapper around the log4net Error method. - - - - - - - - Simple wrapper around the log4net IsDebugEnabled property. - - - - - Simple wrapper around the log4net Debug method. - - - - - - - - Simple wrapper around the log4net DebugFormat method. - - - - - - - Simple wrapper around the log4net IsInfoEnabled property. - - - - - Simple wrapper around the log4net InfoFormat method. - - - - - - - A single logged message - - - - - Log message arguments. - - - - - Culture-specific formatting provider. - - - - - Log message format. - - - - - a size-limited cache of key value pairs - - Once the maximum size has been reached, the least recently - used pairs will be evicted to make room for any new items. - - - - - - - the maximum number of entries this LruCache will hold - before items begin getting evicted - - - - - the number of items in the cache - - - - - Construct a new LruCache. - - maximum number of entries before items are evicted - - - - Add the key/value pair to the cache, or update - the value if the key already exists. - - If the cache is full, evicts the least recently used item. - - - - - - - Evicts a specific key out of the cache if it exists - - the key to evict from the cache - - - - Try to get the value associated with the key. - - the key to look up - the value, if the key exists - true if there is a value associated with the key, or false if no value is associated with the key - - - - Try to get the value associated with the key, if it doesn't exist, use the provided factory method to - create a new value and tries adding it to the cache. - - the key to look up - the factory method used in case the key is not present in the cache - the looked up value or the value created by the factory - - - - Clear the LruCache of all entries. - - - - - Helper class to support LruCache. - Does not implement the error checking and synchronization that - would be necessary for it to stand alone. - - - - - Item to be stored in the LruList - linked list structure. - - - - - Collection of properties being tracked - - - - - Timings for metrics being tracked - - - - - Counters being tracked - - - - - Whether metrics are enabled for the request - - - - - Constructs an empty, disabled metrics object - - - - - Starts timing an event. Logs an exception if an event - of the same type was started but not stopped. - - - - - - - Stops timing an event. Logs an exception if the event wasn't started. - - - - - - - Adds a property for a metric. If there are multiple, the - object is added as a new item in a list. - - - - - - - Sets a counter for a specific metric. - - - - - - - Increments a specific metric counter. - If counter doesn't exist yet, it is set to 1. - - - - - - Returns errors associated with the metric, including - if there are still any timing events in-flight. - - - - - - Returns a string representation of the current metrics. - - - - - - Return a JSON represenation of the current metrics - - - - - - Timing information for a metric - - - - - Empty, stopped timing object - - - - - Timing object in a started state - - - - - - Stops timing - - - - - - Whether the timing has been stopped - - - - - Elapsed ticks from start to stop. - If timing hasn't been stopped yet, returns 0. - - - - - Elapsed time from start to stop. - If timing hasn't been stopped yet, returns TimeSpan.Zero - - - - - Timing event, stops timing of a metric when disposed - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - The destructor for the client class. - - - - - A wrapper stream which supresses disposal of the underlying stream. - - - - - Constructor for NonDisposingWrapperStream. - - The base stream to wrap. - - - - The Dispose implementation for this wrapper stream - does not close the underlying stream. - - - - - Provides line-based read/write access to a file. - The file can be read into memory, changed, then written back to disk. - When the file is persisted back to disk, an optimistic concurrency - check is performed to make sure the file hasn't changed since it was - originally read. - - This class is not threadsafe. - - - - - a full copy of the original file - This is used for optimistic concurrency. - Note that this assumes a small file and does not scale large files. - - - - - path of the file - - - - - Read/write access to the lines that make up the file. - Any changes to this List are persisted back to disk when Persist() is called. - - NOTE: - The lines have the original line endings on them to preserve the - original text as much as possible. - - - - - Construct a new OptimisticLockedTextFile. - - path of the file - - - - Persist changes to disk after an optimistic concurrency check is completed. - - - - - This class is used to wrap a stream for a particular segment of a stream. It - makes that segment look like you are reading from beginning to end of the stream. - - - - - Subclass of IniFile that allows INI sections to be read with the profile keyword in front of the section name. - - - - - Wrapper stream that only supports reading - - - - - Partial wrapper stream that only supports reading - - - - - Uri wrapper that can parse out information (bucket, key, region, style) from an - S3 URI. - - - - - True if the URI contains the bucket in the path, false if it contains the bucket in the authority. - - - - - The bucket name parsed from the URI (or null if no bucket specified). - - - - - The key parsed from the URI (or null if no key specified). - - - - - The region parsed from the URI (or null if no region specified). - - - - - Constructs a parser for the S3 URI specified as a string. - - The S3 URI to be parsed. - - - - Constructs a parser for the S3 URI specified as a Uri instance. - - The S3 URI to be parsed. - - - - Percent-decodes the given string, with a fast path for strings that are not - percent-encoded. - - The string to decode - The decoded string - - - - Percent-decodes the given string. - - The string to decode - The index of the first '%' in the string - The decoded string - - - - Decodes the percent-encoded character at the given index in the string - and appends the decoded value to the string under construction. - - - The string under construction to which the decoded character will be - appended. - - The string being decoded. - The index of the '%' character in the string. - - - - Converts a hex character (0-9A-Fa-f) into its corresponding quad value. - - The hex character - The quad value - - - - Interface for a non-generic cache. - - - - - Clears the entire cache. - - - - - Maximum time to keep an item around after its last use. - - - - - How often should the cache be cleared of old items. - - - - - The number of items in the cache. - - - - - Interface for a generic cache. - - - - - - - Retrieves a value out of the cache or from the source. - - - - - - - - Retrieves a value out of the cache or from the source. - If the item was in the cache, isStaleItem is set to true; - otherwise, if the item comes from the source, isStaleItem is false. - - - - - - - - - Clears a specific value from the cache if it's there. - - - - - - Returns the keys for all items in the cache. - - - - - - Executes specified operation, catches exception, clears the cache for - the given key, retries the operation. - - - - - - - - - - - SDK-wide cache. - Provides access to caches specific to a particular set of credentials - and target region. - - - - - Clear all caches - - - - - Clear all caches of a particular type - - - - - - Retrieve a cache of a specific type for a client object. - The client object can be null in cases where a cache does - not correspond to a specific AWS account or target region. - - - - - - - - - - - Retrieve a cache of a specific type for a client object. - The client object can be null in cases where a cache does - not correspond to a specific AWS account or target region. - - - - - - - - - - - Utilities for converting objects to strings. Used by the marshaller classes. - - - - - Converts a DateTime to ISO8601 formatted string. - - - - - Converts a DateTime to RFC822 formatted string. - - - - - Converts a DateTime to Unix epoch time formatted string. - - - - - A wrapper stream. - - - - - Base stream. - - - - - Initializes WrapperStream with a base stream. - - - - - - Returns the first base non-WrapperStream. - - First base stream that is non-WrapperStream. - - - - Returns the first base non-WrapperStream. - - First base stream that is non-WrapperStream. - - - - Returns the first base non-WrapperStream. - - Potential WrapperStream - Base non-WrapperStream. - - - - Gets a value indicating whether the current stream supports reading. - True if the stream supports reading; otherwise, false. - - - - - Gets a value indicating whether the current stream supports seeking. - True if the stream supports seeking; otherwise, false. - - - - - Gets a value indicating whether the current stream supports writing. - True if the stream supports writing; otherwise, false. - - - - - Closes the current stream and releases any resources (such as sockets and - file handles) associated with the current stream. - - - - - Gets the length in bytes of the stream. - - - - - Gets or sets the position within the current stream. - - - - - Gets or sets a value, in miliseconds, that determines how long the stream - will attempt to read before timing out. - - - - - Gets or sets a value, in miliseconds, that determines how long the stream - will attempt to write before timing out. - - - - - Clears all buffers for this stream and causes any buffered data to be written - to the underlying device. - - - - - Reads a sequence of bytes from the current stream and advances the position - within the stream by the number of bytes read. - - - An array of bytes. When this method returns, the buffer contains the specified - byte array with the values between offset and (offset + count - 1) replaced - by the bytes read from the current source. - - - The zero-based byte offset in buffer at which to begin storing the data read - from the current stream. - - - The maximum number of bytes to be read from the current stream. - - - The total number of bytes read into the buffer. This can be less than the - number of bytes requested if that many bytes are not currently available, - or zero (0) if the end of the stream has been reached. - - - - - Sets the position within the current stream. - - A byte offset relative to the origin parameter. - - A value of type System.IO.SeekOrigin indicating the reference point used - to obtain the new position. - The new position within the current stream. - - - - Sets the length of the current stream. - - The desired length of the current stream in bytes. - - - - Writes a sequence of bytes to the current stream and advances the current - position within this stream by the number of bytes written. - - - An array of bytes. This method copies count bytes from buffer to the current stream. - - - The zero-based byte offset in buffer at which to begin copying bytes to the - current stream. - - The number of bytes to be written to the current stream. - - - - This is a utility class to be used in last resort for code paths that are synchronous but need to call an asynchronous method. - This should never be used for methods that are called at high volume as this utility class has a performance cost. For example this - class was added for the refreshing credentials like Cognito which would need to use this about once an hour. - - This code is taken from: http://stackoverflow.com/questions/5095183/how-would-i-run-an-async-taskt-method-synchronously - which is licensed under Creative Commons Attribution-ShareAlike 3.0 (http://creativecommons.org/licenses/by-sa/3.0/) - - - - - Execute's an async Task<T> which has a void return value synchronously - - Task<T> method to execute - - - - Execute's an async Task<T> method which has a T return type synchronously - - Return Type - Task<T> method to execute - - - - - Custom WebProxy implementation that creates a webproxy based on - user inputs(Host name and port number) - - - - - Set the ProxyUri - - - - - Create a Uri based on the user inputs(Host name and port number) - - - - - Proxy Uri property - - - - - Proxy Credentials property - - - - - Getter to fetch the set proxy - - - - - Method to determine if the proxy should be bypassed when accessing an internet source - - - - - This class is no longer used anymore and should be avoided as it is just meant - as a last resort when blending async and sync operations. The code is still - here to support versions before 3.3.9.0 of AWSSDK.DynamoDBv2. - - - - - Collection of parameters that an SDK client will send to a service. - - - - - Constructs empty ParameterCollection. - - - - - Adds a parameter with a string value. - - - - - - - Adds a parameter with a list-of-strings value. - - - - - - - Converts the current parameters into a list of key-value pairs. - - - - - - Property to denote that the last exception returned by an AWS Service - was retryable or not. - - - - - This handler processes exceptions thrown from the HTTP handler and - unmarshalls error responses. - - - - - Default set of exception handlers. - - - - - Default set of exception handlers. - - - - - Constructor for ErrorHandler. - - an ILogger instance. - - - - Handles and processes any exception thrown from underlying handlers. - - The execution context which contains both the - requests and response context. - - - - Handles and processes any exception thrown from underlying handlers. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Disposes the response body. - - The response context. - - - - Processes an exception by invoking a matching exception handler - for the given exception. - - The execution context, it contains the - request and response context. - The exception to be processed. - - This method returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception that may be thrown by exception - processing by a matching exception handler. - - - - - The abstract base class for exception handlers. - - The exception type. - - - - The exception handler for HttpErrorResponseException exception. - - - - - The constructor for HttpErrorResponseExceptionHandler. - - in instance of ILogger. - - - - Handles an exception for the given execution context. - - The execution context, it contains the - request and response context. - The exception to handle. - - Returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception to replace the original exception. - - - - - Checks if a HTTP 404 status code is returned which needs to be suppressed and - processes it. - If a suppressed 404 is present, it unmarshalls the response and returns true to - indicate that a suppressed 404 was processed, else returns false. - - The execution context, it contains the - request and response context. - - - If a suppressed 404 is present, returns true, else returns false. - - - - - A pipeline handler which provides hooks to run - external code in the pre-invoke and post-invoke phases. - - - - - Action to execute on the pre invoke phase. - - - - - Action to execute on the post invoke phase. - - - - - Calls the PreInvoke and PostInvoke methods before and after calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls the PreInvoke and PostInvoke methods before and after calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Executes the OnPreInvoke action as part of pre-invoke. - - The execution context, it contains the - request and response context. - - - - Executes the OnPreInvoke action as part of post-invoke. - - The execution context, it contains the - request and response context. - - - - This handler retrieved the AWS credentials to be used for the current call. - - - - - The constructor for CredentialsRetriever. - - An AWSCredentials instance. - - - - Retrieves the credentials to be used for the current call before - invoking the next handler. - - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - The CSM handler has the logic for capturing data for CSM attempts when enabled. - - - - - Invokes the CSM handler and captures data for the CSM attempts. - - - - - Calls the PreInvoke and PostInvoke methods before and after calling the next handler - in the pipeline. - - - - - Method that gets called in the final clause that captures data for each http request - from the request and response context. - - - - - Executes the OnPreInvoke action as part of pre-invoke. - - - - - Method to collect data in case of connection exception - - - - - Method to collect data in case of Amazon service exception - - - - - The CSM handler has the logic for capturing data for CSM events when enabled. - - - - - Invokes the CSM handler and captures data for the CSM events. - - - - - Calls the PreInvoke and PostInvoke methods before and after calling the next handler - in the pipeline. - - - - - Invoked from the finally block of CSMCallEventHandler's Invoke method. - This method is used to capture CSM Call event metrics. - - - - - - Method that gets invoked in case of an exception in the API request completion. - - - - - - - This handler resolves the endpoint to be used for the current request. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Resolves the endpoint to be used for the current request - before invoking the next handler. - - The execution context, it contains the - request and response context. - - - - This handler resolves the endpoint to be used for the current request. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Resolves the endpoint to be used for the current request - before invoking the next handler. - - The execution context, it contains the - request and response context. - - - - Determines the endpoint for the request. - - The request context. - - - - - This handler provides an OnError action that can be used as hook for - external code to handle exceptions in the runtime pipeline. - - - - - Action to execute if an exception occurs during the - execution of any underlying handlers. - - - - - Executes the OnError action if an exception occurs during the - execution of any underlying handlers. - - - - - - - This handler marshalls the request before calling invoking the next handler. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Marshalls the request before calling invoking the next handler. - - The execution context, it contains the - request and response context. - - - - This handler manages the metrics used to time the complete call and - logs the final metrics. - - - - - Captures the overall execution time and logs final metrics. - - The execution context which contains both the - requests and response context. - - - - Captures the overall execution time and logs final metrics. - - The response type for the current request. - - The execution context, it contains the request and response context. - - A task that represents the asynchronous operation. - - - - This handler processes HTTP redirects and reissues the call to the - redirected location. - - - - - Processes HTTP redirects and reissues the call to the - redirected location. - - The execution context which contains both the - requests and response context. - - - - Processes HTTP redirects and reissues the call to the - redirected location. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Checks if an HTTP 307 (temporary redirect) has occured and changes the - request endpoint to the redirected location. - - - The execution context, it contains the request and response context. - - - A boolean value that indicates if a redirect has occured. - - - - - This handler signs the request. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Signs the request before invoking the next handler. - - - The execution context, it contains the request and response context. - - - - - Determines if the request should be signed. - - The request context. - A boolean value that indicated if the request should be signed. - - - - Signs the request. - - The request context. - - - - This handler unmarshalls the HTTP response. - - - - - The constructor for Unmarshaller. - - - Boolean value which indicated if the unmarshaller - handler supports response logging. - - - - - Unmarshalls the response returned by the HttpHandler. - - The execution context which contains both the - requests and response context. - - - - Unmarshalls the response returned by the HttpHandler. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Unmarshalls the HTTP response. - - - The execution context, it contains the request and response context. - - - - - Unmarshalls the HTTP response. - - - The execution context, it contains the request and response context. - - - - - The HTTP handler contains common logic for issuing an HTTP request that is - independent of the underlying HTTP infrastructure. - - - - - - The sender parameter used in any events raised by this handler. - - - - - The constructor for HttpHandler. - - The request factory used to create HTTP Requests. - The sender parameter used in any events raised by this handler. - - - - Issues an HTTP request for the current request context. - - The execution context which contains both the - requests and response context. - - - - Issues an HTTP request for the current request context. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Determines the content for request body and uses the HTTP request - to write the content to the HTTP request body. - - Content to be written. - The HTTP request. - The request context. - - - - Creates the HttpWebRequest and configures the end point, content, user agent and proxy settings. - - The async request. - The web request that actually makes the call. - - - - Disposes the HTTP handler. - - - - - An abstract pipeline handler that has implements IPipelineHandler, - and has the default implmentation. This is the base class for most of - the handler implementations. - - - - - The logger used to log messages. - - - - - The inner handler which is called after the current - handler completes it's processing. - - - - - The outer handler which encapsulates the current handler. - - - - - Contains the processing logic for a synchronous request invocation. - This method calls InnerHandler.InvokeSync to continue processing of the - request by the pipeline. - - The execution context which contains both the - requests and response context. - - - - Contains the processing logic for an asynchronous request invocation. - This method calls InnerHandler.InvokeSync to continue processing of the - request by the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Logs the metrics for the current execution context. - - The execution context, it contains the - request and response context. - - - - The default implementation of the retry policy. - - - The default implementation of the retry policy. - - - - - The maximum value of exponential backoff in milliseconds, which will be used to wait - before retrying a request. - - - - - List of HTTP Status codes codes which are returned as part of the error response. - These status codes will be retried. - - - - - List of AWS specific error codes which are returned as part of the error response. - These error codes will be retried. - - - - - List of WebExceptionStatus for a WebException which will be retried. - - - - - Constructor for DefaultRetryPolicy. - - The maximum number of retries before throwing - back a exception. This does not count the initial request. - - - - Constructor for DefaultRetryPolicy. - - The Client config object. This is used to - retrieve the maximum number of retries before throwing - back a exception(This does not count the initial request) and - the service URL for the request. - - - - Returns true if the request is in a state where it can be retried, else false. - - Request context containing the state of the request. - Returns true if the request is in a state where it can be retried, else false. - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called when a retry request is initiated. If retry throttling is - enabled, the value returned is true if the required capacity is retured, false otherwise. - If retry throttling is disabled, true is returned. - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - - - - Virtual method that gets called on a success Response. If its a retry success response, the entire - retry acquired capacity is released(default is 5). If its just a success response a lesser value capacity - is released(default is 1). - - Request context containing the state of the request. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - The exception thrown by the previous request. - Request context containing the state of the request. - Return true if the request should be retried. - - - - Checks if the retry limit is reached. - - Request context containing the state of the request. - Return false if the request can be retried, based on number of retries. - - - - Waits before retrying a request. The default policy implements a exponential backoff. - - Request context containing the state of the request. - - - - Return true if the request should be retried. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - The retry handler has the generic logic for retrying requests. - It uses a retry policy which specifies when - a retry should be performed. - - - - - The logger used to log messages. - - - - - The retry policy which specifies when - a retry should be performed. - - - - - Constructor which takes in a retry policy. - - Retry Policy - - - - Invokes the inner handler and performs a retry, if required as per the - retry policy. - - The execution context which contains both the - requests and response context. - - - - Invokes the inner handler and performs a retry, if required as per the - retry policy. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Prepares the request for retry. - - Request context containing the state of the request. - - - - A runtime pipeline contains a collection of handlers which represent - different stages of request and response processing. - - - - - The top-most handler in the pipeline. - - - - - Constructor for RuntimePipeline. - - The handler with which the pipeline is initalized. - - - - Constructor for RuntimePipeline. - - List of handlers with which the pipeline is initalized. - - - - Constructor for RuntimePipeline. - - List of handlers with which the pipeline is initalized. - The logger used to log messages. - - - - Constructor for RuntimePipeline. - - The handler with which the pipeline is initalized. - The logger used to log messages. - - - - Invokes the pipeline synchronously. - - Request context - Response context - - - - Invokes the pipeline asynchronously. - - Request context - Response context - - - - Adds a new handler to the top of the pipeline. - - The handler to be added to the pipeline. - - - - Adds a handler after the first instance of handler of type T. - - Type of the handler after which the given handler instance is added. - The handler to be added to the pipeline. - - - - Adds a handler before the first instance of handler of type T. - - Type of the handler before which the given handler instance is added. - The handler to be added to the pipeline. - - - - Removes the first occurance of a handler of type T. - - Type of the handler which will be removed. - - - - Replaces the first occurance of a handler of type T with the given handler. - - Type of the handler which will be replaced. - The handler to be added to the pipeline. - - - - Inserts the given handler after current handler in the pipeline. - - Handler to be inserted in the pipeline. - Handler after which the given handler is inserted. - - - - Gets the innermost handler by traversing the inner handler till - it reaches the last one. - - - - - Retrieves a list of handlers, in the order of their execution. - - Handlers in the current pipeline. - - - - Retrieves current handlers, in the order of their execution. - - Handlers in the current pipeline. - - - - This class is the base class of all the configurations settings to connect - to a service. - - - This class is the base class of all the configurations settings to connect - to a service. - - - - - Gets Service Version - - - - - Gets and sets of the signatureMethod property. - - - - - Gets and sets of the SignatureVersion property. - - Note: This property exists for backward compatibility but is no longer - used by any service other than S3. - - - - - Gets and sets of the UserAgent property. - - - - - Gets and sets the RegionEndpoint property. The region constant that - determines the endpoint to use. - - Setting this property to null will force the SDK to recalculate the - RegionEndpoint value based on App/WebConfig, environment variables, - profile, etc. - - - - - The constant used to lookup in the region hash the endpoint. - - - - - Gets and sets of the ServiceURL property. - This is an optional property; change it - only if you want to try a different service - endpoint. - - - - - Gets and sets the UseHttp. - If this property is set to true, the client attempts - to use HTTP protocol, if the target endpoint supports it. - By default, this property is set to false. - - - - - Given this client configuration, return a string form ofthe service endpoint url. - - - - - Gets and sets the AuthenticationRegion property. - Used in AWS4 request signing, this is an optional property; - change it only if the region cannot be determined from the - service endpoint. - - - - - Gets and sets the AuthenticationServiceName property. - Used in AWS4 request signing, this is the short-form - name of the service being called. - - - - - Gets and sets of the MaxErrorRetry property. - - - - - Gets and sets the LogResponse property. - If this property is set to true, the service response is logged. - The size of response being logged is controlled by the AWSConfigs.LoggingConfig.LogResponsesSizeLimit property. - - - - - Gets and sets the ReadEntireResponse property. - NOTE: This property does not effect response processing and is deprecated. - To enable response logging, the ClientConfig.LogResponse and AWSConfigs.LoggingConfig - properties can be used. - - - - - Gets and Sets the BufferSize property. - The BufferSize controls the buffer used to read in from input streams and write - out to the request. - - - - - - Gets or sets the interval at which progress update events are raised - for upload operations. By default, the progress update events are - raised at every 100KB of data transferred. - - - If the value of this property is set less than ClientConfig.BufferSize, - progress updates events will be raised at the interval specified by ClientConfig.BufferSize. - - - - - - Flag on whether to resign requests on retry or not. - For Amazon S3 and Amazon Glacier this value will always be set to true. - - - - - This flag controls if .NET HTTP infrastructure should follow redirection - responses (e.g. HTTP 307 - temporary redirect). - - - - - Flag on whether to log metrics for service calls. - - This can be set in the application's configs, as below: - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSLogMetrics" value"true"/> - </appSettings> - </configuration> - - - - - - Gets and sets the DisableLogging. If true logging for this client will be disabled. - - - - - Credentials to use with a proxy. - - - - - - If the value is set, the value is assigned to the Timeout property of the HttpWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Configures the endpoint calculation for a service to go to a dual stack (ipv6 enabled) endpoint - for the configured region. - - - Note: AWS services are enabling dualstack endpoints over time. It is your responsibility to check - that the service actually supports a dualstack endpoint in the configured region before enabling - this option for a service. - - - - - Enable or disable the Retry Throttling feature by setting the ThrottleRetries flag to True/False resepctively. - Retry Throttling is a feature that intelligently throttles retry attempts when a large precentage of requests - are failing and retries are unsuccessful as well. In such situations the allotted retry capacity for the service URL - will be drained until requests start to succeed again. Once the requisite capacity is available, retries would - be permitted again. When retries are throttled, the service enters a fail-fast behaviour as the traditional retry attempt - for the request would be circumvented. Hence, errors will resurface quickly. This will result in a greated number of exceptions - but prevents requests being tied up in unsuccessful retry attempts. - Note: Retry Throttling is enabled by default. Set the ThrottleRetries flag to false to switch off this feature. - - - - - Enable or disable the Nagle algorithm on the underlying http - client. - - This method is not intended to be called by consumers of the AWS SDK for .NET - - - - - - Performs validation on this config object. - Throws exception if any of the required values are missing/invalid. - - - - - Returns the current UTC now after clock correction for this endpoint. - - - - - The calculated clock skew correction for a specific endpoint, if there is one. - This field will be set if a service call resulted in an exception - and the SDK has determined that there is a difference between local - and server times. - - If is set to true, this - value will still be set to the correction, but it will not be used by the - SDK and clock skew errors will not be retried. - - - - - Gets and sets the DisableHostPrefixInjection flag. If true, host prefix injection will be disabled for this client, the default value of this flag is false. - Host prefix injection prefixes the service endpoint with request members from APIs which use this feature. - Example: for a hostPrefix of "foo-name." and a endpoint of "service.region.amazonaws.com" the default behavior is to - prefix the endpoint with the hostPrefix resulting in a final endpoint of "foo-name.service.region.amazonaws.com". Setting - DisableHostPrefixInjection to true will disable hostPrefix injection resulting in a final endpoint of - "service.region.amazonaws.com" regardless of the value of hostPrefix. E.g. You may want to disable host prefix injection for testing against a local mock endpoint. - - - - - Returns the flag indicating if endpoint discovery should be enabled or disabled for operations that are not required to use endpoint discovery. - - - - - Returns the maximum number of discovered endpoints that can be stored within the cache for the client. The default limit is 1000 cache entries. - - - - - Throw an exception if the boxed TimeSpan parameter doesn't have a value or is out of range. - - - - - Returns the request timeout value if its value is set, - else returns client timeout value. - - - - - - This is a switch used for performance testing and is not intended for production applications - to change. This switch may be removed in a future version of the SDK as the .NET Core platform matures. - - - If true, the HttpClient is cached and reused for every request made by the service client - and shared with other service clients. - - - For the .NET Core platform this is default to true because the HttpClient manages the connection - pool. - - - - - - If CacheHttpClient is set to true then HttpClientCacheSize controls the number of HttpClients cached. - - On Windows the default value is 1 since the underlying native implementation does not have throttling constraints - like the non Windows Curl based implementation. For non Windows based platforms the default is the value return from - System.Environment.ProcessorCount. - - - - - - Overrides the default read-write timeout value. - - - - If the value is set, the value is assigned to the ReadWriteTimeout property of the HttpWebRequest object used - to send requests. - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Returns a WebProxy instance configured to match the proxy settings - in the client configuration. - - - - - Unpacks the host, port and any credentials info into the instance's - proxy-related fields. - Unlike the SetWebProxy implementation on .NET 3.5/4.5,the Host and the Port are not reconstructed from the - input proxyuri - - The proxy details - - - - Gets and sets of the ProxyHost property. - - - - - Gets and sets of the ProxyPort property. - - - - - Get or set the value to use for on requests. - If this property is null, - will be left at its default value of . - - - - - - Returns true if the clients should be cached by HttpRequestMessageFactory, false otherwise. - - - - - - - Returns true if the SDK should dispose HttpClients after one use, false otherwise. - - - - - - - Create a unique string used for caching the HttpClient based on the settings that are used from the ClientConfig that are set on the HttpClient. - - - - - - - Determines if HttpClients created with the given IClientConfig should be cached at the SDK - client level, or cached globally. - - If there is no HttpClientFactory assigned and proxy or proxy credentials are set - this returns false because those properties can't be serialized as part of the key in the global http client cache. - - - - - Base class for constant class that holds the value that will be sent to AWS for the static constants. - - - - - Gets the value that needs to be used when send the value to AWS - - - - - Attempt to find correct-cased constant value using whatever cased value the user - has provided. This is primarily useful for mapping any-cased values from a CLI - tool to the specific casing required by the service, avoiding the need for the - user to (a) remember the specific case and (b) actually type it correctly. - - The properly cased service constant matching the value - - - - Utility class that stores clock skew information. - - - - - GlobalClockCorrection should be only set by AWSConfigs.ManualClockCorrection property - and is only available to maintain backward compatibilty. This should override any - endpoint specific clockskew correction. - - - - - Return clock skew correction value for an endpoint if there is one. - - AWSConfigs.ManualClockCorrection overrides globally any calculated service endpoint specific - clock correction value. - - Endpoint should in a form such as "https://s3" - Clock correction value for an endpoint in TimeSpan. TimeSpan.Zero if no such clock correction is set. - - - - Get clock skew corrected UTC now value. If ManualClockCorrection is set, - use ManualClockCorrection instead of endpoint specific clock correction value. - - - - - - - Factory to construct different types of AWSCredentials based on a profile. - - - - - Gets the AWSCredentials for this profile if CanCreateAWSCredentials is true - and AWSCredentials can be created. Throws an exception otherwise. - - See for a list of AWSCredentials returned by this method. - - The profile to get AWSCredentials for. - The profile source, for profiles that reference other profiles. - AWSCredentials for this profile. - - - - Gets the AWSCredentials for this profile if CanCreateAWSCredentials is true - and AWSCredentials can be created. Throws an exception otherwise. - - See for a list of AWSCredentials returned by this method. - - The options to get AWSCredentials for. - The profile source, for options that reference other profiles. - AWSCredentials for the options given. - - - - Gets the AWSCredentials for this profile if CanCreateAWSCredentials is true - and AWSCredentials can be created. Throws an exception otherwise. - - See for a list of AWSCredentials returned by this method. - - The profile to get AWSCredentials for. - The profile source, for profiles that reference other profiles. - If true, throw a descriptive exception for any credentials that would not operate as-is. - In other words, any credentials that require programmatic callbacks at runtime. - AWSCredentials for this profile. - - - - Gets the AWSCredentials for this profile if CanCreateAWSCredentials is true - and AWSCredentials can be created. Throws an exception otherwise. - - See for a list of AWSCredentials returned by this method. - - The options to get AWSCredentials for. - The profile source, for options that reference other profiles. - If true, throw a descriptive exception for any credentials that would not operate as-is. - In other words, any credentials that require programmatic callbacks at runtime. - AWSCredentials for the options given. - - - - Return the credentials for the profile if valid credentials can created. - - The profile to create credentials with. - The profile source, for profiles that reference other profiles. - The credentials for the profile. - True if credentials can be created from the profile, false otherwise. - - - - Return the credentials for the profile if valid credentials can created. - - The options to get AWSCredentials for. - The profile source, for profiles that reference other profiles. - The credentials for the profile. - True if credentials can be created from the profile, false otherwise. - - - - Determine if the profileType will generate AWSCredentials that require a callback to be set on them. - - - - - - - A named group of options that are persisted and used to obtain AWSCredentials. - - - - - The name of the CredentialProfile - - - - - The options to be used to create AWSCredentials. - - - - - The region to be used with this CredentialProfile - - - - - The unique key for this CredentialProfile. - This key is used by the Visual Studio Tooklit to associate external artifacts with this profile. - - - - - The endpoint discovery enabled value for this CredentialProfile - - - - - If true the region identified in the S3 access point arn will be used when making requests. - - - - - The Sts Regional Endpoints Value as either legacy or regional - - - - - The S3 Regional Endpoint Value as either legacy or regional - - - - - An optional dictionary of name-value pairs stored with the CredentialProfile - - - - - True if the properties of the Options object can be converted into AWSCredentials, false otherwise. - See for more details about which options are available. - - - - - The that this is associated with. - Null if this is not associated with a . - - - - - If CanCreateAWSCredentials is true, returns a short description of the type of - credentials that would be created. - If CanCreateAWSCredentials is false, return null. - - - - - The CredentialProfileType of this CredentialProfile, if one applies. - - - - - Determine this CredentialProfile will generate AWSCredentials that require a callback to be set on them. - - - - - Construct a new CredentialProfile. - - - - - - - Gets the AWSCredentials for this profile if CanCreateAWSCredentials is true - and AWSCredentials can be created. Throws an exception otherwise. - - See for a list of AWSCredentials returned by this method. - - The profile source, for profiles that reference other profiles. - AWSCredentials for this profile. - - - - Gets the AWSCredentials for this profile if CanCreateAWSCredentials is true - and AWSCredentials can be created. Throws an exception otherwise. - - See for a list of AWSCredentials returned by this method. - - The profile source, for profiles that reference other profiles. - If true, throw a descriptive exception for any credentials that would not operate as-is. - In other words, any credentials that require programmatic callbacks at runtime. - AWSCredentials for this profile. - - - - The options that are available for creating AWSCredentials with the AWSCredentialsFactory. - The type of AWSCredentials that are created depends on which Options are set. - - Below are the different types of credentials returned, along with the options that are used to obtain them. - ([] denotes options that are not required) - - BasicAWSCredentials AccessKey SecretKey - SessionAWSCredentials AccessKey SecretKey Token - AssmeRoleAWSCredentials SourceProfile RoleArn [ExternalID] [MfaSerial] - FederatedAWSCredentials EndpointName RoleArn [UserIdentity] - - - - - The access key to be used in the AWSCredentials. - - - - - The source of credentials to be used to obtain AWSCredentials. - - - - - The endpoint name to be used for federated AWSCredentials. - - - - - The external id to use in assume role AWSCredentials. - - - - - The serial number of the MFA to use in assume role AWSCredentials. - - - - The role ARN to use when creating assume role or federated AWSCredentials. - - - - An identifier for the assumed role session. - - - - - The secret key to use when creating AWSCredentials. - - - - - When this CredentialProfileOptions object references another CredentialProfile, - the name of the referenced CredentialProfile. - - - - - The session token to be used to create AWSCredentials. - - - - - The user identity to use when creating federated AWSCredentials. - If not set, the user identity that the code is running under will be used. - - - - - Contains the executable information to be used by the process credential retriever - to either fetch Basic or Session credentials - - - - - Absolute path to the file on disk containing an OIDC token. - - - - - Return true the properties are all null or empty, false otherwise. - - - - - Class to abstract the combined use of NetSDKCredentialsFile and SharedCredentialsFile where possible. - - - - - - The location of the shared credentials file, or null to use the default location. - - - - - Construct a CredentialProfileChain. - - - - - Construct a CredentialProfileChain. - - The path to the aws credentials file to look at. - - - - - Try to get from a profile. - - - If ProfilesLocation is non-null and non-empty search the shared credentials - file at the disk path in the ProfilesLocation property. - - - If ProfilesLocation is null or empty and the platform supports the .NET SDK credentials file - search the SDK credentials file. If the profile is not found search the shared credentials file in the default location. - - - If ProfilesLocation is null or empty and the platform doesn't support the .NET SDK credentials file - search the shared credentials file in the default location. - - - The name of the profile to get credentials from. - The credentials, if the profile is found and credentials can be created. - True if the profile was found and credentials could be created, false otherwise. - - - - - Try to get a - - - If ProfilesLocation is non-null and non-empty search the shared credentials - file at the disk path in the ProfilesLocation property. - - - If ProfilesLocation is null or empty and the platform supports the .NET SDK credentials file - search the SDK credentials file. If the profile is not found search the shared credentials file in the default location. - - - If ProfilesLocation is null or empty and the platform doesn't support the .NET SDK credentials file - search the shared credentials file in the default location. - - - The name of the profile to get. - The profile, if found - True if the profile was found, false otherwise. - - - - - Get a list of available objects. - - - If ProfilesLocation is non-null and non-empty include profiles in the shared credentials - file at the disk path in the ProfilesLocation property. - - - If ProfilesLocation is null or empty and the platform supports the .NET SDK credentials file - include profiles from the SDK credentials file and from the shared credentials file in the default location. - - - If ProfilesLocation is null or empty and the platform doesn't support the .NET SDK credentials file - include profiles from the shared credentials file in the default location. - - - A list of objects. - - - - - Register a - - - If ProfilesLocation is non-null and non-empty register the profile in the shared credentials - file at the disk path in the ProfilesLocation property. - - - If ProfilesLocation is null or empty and the platform supports the .NET SDK credentials file - register the profile in the SDK credentials file. - - - If ProfilesLocation is null or empty and the platform doesn't support the .NET SDK credentials file - register the profile in the shared credentials file in the default location. - - - The profile to register. - - - - - Unregister a - - - If ProfilesLocation is non-null and non-empty unregister the profile from the shared credentials - file at the disk path in the ProfilesLocation property. - - - If ProfilesLocation is null or empty and the platform supports the .NET SDK credentials file - search the SDK credentials file. If the profile is found there unregister it. - If the profile was not found search the shared credentials file in the default location. - If the profile is found in the shared credentials file in the default location unregister it. - - - If ProfilesLocation is null or empty and the platform doesn't support the .NET SDK credentials file - search the shared credentials file in the default location. If the profile is found in the - shared credentials file in the default location unregister it. - - - The name of the profile to unregister. - - - - Interface to define the necessary operations for a CredentialProfile lookup mechanism. - - - - - Get the profile with the given name, if one exists. - - The name of the profile to get. - The profile, if it was found, null otherwise. - True if the profile was found, false otherwise. - - - - Interface to define the necessary operations for a CredentialProfile storage mechanism. - - - - - Rename the profile with oldProfileName to newProfileName. - - The profile to rename. - The new name for the profile. - - - - Rename the profile with oldProfileName to newProfileName. - - The profile to rename. - The new name for the profile. - If true and the destination profile exists it will be overwritten. - - - - Make a copy of the profile with fromProfileName called toProfileName. - - The name of the profile to copy from. - The name of the new profile. - - - - Make a copy of the profile with fromProfileName called toProfileName. - - The name of the profile to copy from. - The name of the new profile. - If true and the destination profile exists it will be overwritten. - - - - Add the given profile to the store, or update it if one with the same name already exists. - - - - - - Delete the profile with profileName if it exists. - - The name of the profile to delete. - - - - Get a list of valid profile names from this store. - Invalid profiles are ignored. - See for more information - about valid profiles. - - - - - - Get a list of valid profiles from this store. - Invalid profiles are ignored. - See for more information - about valid profiles. - - - - - - Class to easily convert from Dictionary<string, string> to ProfileOptions and back. - - - - - Separate the profileDictionary into its parts. - profileDictionary = profileOptions + reservedProperties + userProperties - - Dictionary with everything in it - Keys to ignore - The resulting CredentialProfileOptions - The properties that are left - - - - Separate the profileDictionary into its parts. - profileDictionary = profileOptions + reservedProperties + userProperties - - Dictionary with everything in it - Keys for the reservedKeys dictionary - The resulting CredentialProfileOptions - The resulting reserved properties - The properties that are left - - - - Validate the userProperties and then combine profileOptions, reservedProperties, and userProperties into one Dictionary. - - - - - - - - - - Make sure the userProperties dictionary doesn't contain any keys that are reserved. - Check is case-insensitive for added safety. - - - - - - - Make sure the userProperties dictionary doesn't contain any keys that - overlap with the names of mapped names for CredentialProfileOptions property names. - Check is case-insensitive for added safety. - - - - - - This class is used internally and should not be accessed by SDK users. - - Provide access to internal properties of CredentialProfile to - PowerShell tools and the Visual Studio Toolkit. - - - - - Attempt to read a role session with the given name. - If the session is invalid or expired it will not be returned. - - The name of the role session to get. - The credentials for the session, if found. - True if the session was found, false otherwise. - - - - This class allows profiles supporting AWSCredentials to be registered with - the SDK so that they can later be reference by a profile name. The credential profiles will be available - for use in the AWS Toolkit for Visual Studio and the AWS Tools for Windows PowerShell. - - The credentials are stored under the current users AppData folder encrypted using Windows Data Protection API. - - - This class is not threadsafe. - - - - - - Get the profile with the name given, if it exists in this store. - - The name of the profile to find. - The profile, if it was found, null otherwise - True if the profile was found, false otherwise. - - - - Add the profile to this store, if it's valid. - - The profile to add. - - - - If there is a profile in the store with the given name, delete it. - - The name of the profile to delete. - - - - Rename the profile with oldProfileName to newProfileName. - - The profile to rename. - The new name for the profile. - - - - Rename the profile with oldProfileName to newProfileName. - - The profile to rename. - The new name for the profile. - If true and the destination profile exists it will be overwritten. - - - - Make a copy of the profile with fromProfileName called toProfileName. - - The name of the profile to copy from. - The name of the new profile. - - - - Make a copy of the profile with fromProfileName called toProfileName. - - The name of the profile to copy from. - The name of the new profile. - If true and the destination profile exists it will be overwritten. - - - - Set the ProfileType field to maintain backward compatibility with ProfileManager. - The value is ignored when it's read back in. - - - - - - - Represents the different types of authentication available for SAML endpoints. - - - - - Representation of a SAML Endpoint. - - - - - The name given to this SAMLEndpoint. - - - - - The URI of the SAML endnpoint. - - - - - The authentication type associated with the SAML endpoint. - - - - - Internal constructor. Used by SAMLEndpointManager when reading endpoints from the encrypted store. - - - - - - - - Construct a SAMLEndpoint using the default SAMLAuthenticationType - Kerberos. - - The name of the endpoint. - The URI of the endpoint. - - - - Construct a SAMLEndpoint. - - The name of the endpoint. - The URI of the endpoint. - The authentication type of the endpoint. - - - - Manages endpoints to be used in conjunction with SAML role profiles. The role profiles - reference the endpoint to obtain the actual endpoint and any customization settings - needed to perform authentication. - - - - - Construct a SAMLEndpointManager. - - - - - True if the SAMLEndpointManager is available on the current platform, false otherwise. - - - - - Register an endpoint, or update an existing one. - - The endpoint to register. - - - - Get an endpoint, if it exists and is valid. - - The name of the endpoint to get. - The endpoint, or null if it's invalid or doesn't exist. - True if the endpoint exists and is valid, false otherwise. - - - - Get an endpoint from the store. - Throws an exception if there's an error reading the endpoint, or if it doesn't exist. - - The name of the endpoint to get. - The endpoint with the given name. - - - - Delete an endpoint from the store, if it exists. - - The name of the endpoint to delete. - - - - List the names of valid endpoints in the store. - - - - - - List valid endopints that can be read from the store. - - - - - - Provides access to read and write to the shared credentials INI file. - The file is read, parsed, and validated at construction time. - Changes can be made using the RegisterProfile() and - UnregisterProfile() methods. - - This class is not threadsafe. - - - - - To maintain compatibility with the CLI, - SharedCredentialsFile doesn't support the SAML profileTypes. - - - - - Construct a new SharedCredentialsFile in the default location. - - - - - Construct a new SharedCredentialsFile. - - The path of the shared credentials file. - - - - Add the profile given. If the profile already exists, update it. - - The profile to be written. - - - - Update the profile on disk regardless of the profile type. - - - - - - Deletes the section with the given ProfileName from the SharedCredentialsFile, if one exists. - - The ProfileName of the section to delete. - - - - Rename the profile with oldProfileName to newProfileName. - - The profile to rename. - The new name for the profile. - - - - Rename the profile with oldProfileName to newProfileName. - - The profile to rename. - The new name for the profile. - If true and the destination profile exists it will be overwritten. - - - - Make a copy of the profile with fromProfileName called toProfileName. - - The name of the profile to copy from. - The name of the new profile. - - - - Make a copy of the profile with fromProfileName called toProfileName. - - The name of the profile to copy from. - The name of the new profile. - If true and the destination profile exists it will be overwritten. - - - - Try to get a profile that may be partially in the credentials file and partially in the config file. - If there are identically named properties in both files, the properties in the credentials file take precedence. - - - - - - - - Anonymous credentials. - Using these credentials, the client does not sign the request. - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - AWS Credentials that automatically refresh by calling AssumeRole on - the Amazon Security Token Service. - - - - - The credentials of the user that will be used to call AssumeRole. - - - - - The Amazon Resource Name (ARN) of the role to assume. - - - - - An identifier for the assumed role session. - - - - - Options to be used in the call to AssumeRole. - - - - - Constructs an AssumeRoleAWSCredentials object. - - The credentials of the user that will be used to call AssumeRole. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - - - - Constructs an AssumeRoleAWSCredentials object. - - The credentials of the user that will be used to call AssumeRole. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRole. - - - - A unique identifier that is used by third parties when assuming roles in their customers' accounts. - - - - - An IAM policy in JSON format. - - - - - The length of time in seconds before the credentials will expire. - - - - - The proxy settings to use when calling AssumeRole. - - - - - The identification number of the MFA device that is associated with the user who is making the assume-role call. - - - - - The value provided by the MFA device, if the trust policy of the role being assumed requires MFA. - - - - - A callback that's used to obtain the MFA token code when the AssumeRoleAWSCredentials are refreshed. - - - - - Immutable representation of AWS credentials obtained as a result of - authenticating with the AssumeRole method of the Security Token Service. - - - - - The expiry time of the credentials, obtained from the AssumeRoleResponse. - - - - - Constructs an instance with supplied keys, token, and expiration. - - The AccessKey for the credentials. - The SecretKey for the credentials. - The security token for the credentials. - The expiration time for the credentials. - - - - Get a copy of this AssumeRoleImmutableCredentials object. - - A copy of this object. - - - - AWS Credentials that automatically refresh by calling AssumeRole on - the Amazon Security Token Service. - - - - - As established by STS, the regex used to validate the role session names is a string of 2-64 characters consisting of - upper- and lower-case alphanumeric characters with no spaces. You can also include - underscores or any of the following characters: =,.@- - - - - - Options to be used in the call to AssumeRole. - - - - - The absolute path to the file on disk containing an OIDC token - - - - - The Amazon Resource Name (ARN) of the role to assume. - - - - - An identifier for the assumed role session. - - - - - Constructs an AssumeRoleWithWebIdentityCredentials object. - - The absolute path to the file on disk containing an OIDC token. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - - - - Constructs an AssumeRoleWithWebIdentityCredentials object. - - The absolute path to the file on disk containing an OIDC token. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRole. - - - - Creates an instance of from environment variables. - - Throws an if the needed environment variables are not set. - The new credentials. - - - - Gets a client to be used for AssumeRoleWithWebIdentity requests. - - The STS client. - - - - Options for using a credentials object to make AssumeRoleWithWebIdentity calls. - - - - - Gets and sets the property DurationSeconds. - - The duration, in seconds, of the role session. The value can range from 900 seconds - (15 minutes) up to the maximum session duration setting for the role. This setting - can have a value from 1 hour to 12 hours. If you specify a value higher than this - setting, the operation fails. For example, if you specify a session duration of 12 - hours, but your administrator set the maximum session duration to 6 hours, your operation - fails. To learn how to view the maximum value for your role, see View - the Maximum Session Duration Setting for a Role in the IAM User Guide. - - - - By default, the value is set to 3600 seconds. - - - - The DurationSeconds parameter is separate from the duration of a console - session that you might request using the returned credentials. The request to the - federation endpoint for a console sign-in token takes a SessionDuration - parameter that specifies the maximum length of the console session. For more information, - see Creating - a URL that Enables Federated Users to Access the AWS Management Console in the - IAM User Guide. - - - - - - - Gets and sets the property ProviderId. - - The fully qualified host component of the domain name of the identity provider. - - - - Specify this value only for OAuth 2.0 access tokens. Currently www.amazon.com - and graph.facebook.com are the only supported identity providers for - OAuth 2.0 access tokens. Do not include URL schemes and port numbers. - - - - Do not specify this value for OpenID Connect ID tokens. - - - - - - Gets and sets the property Policy. - - An IAM policy in JSON format that you want to use as an inline session policy. - - - - This parameter is optional. Passing policies to this operation returns new temporary - credentials. The resulting session's permissions are the intersection of the role's - identity-based policy and the session policies. You can use the role's temporary credentials - in subsequent AWS API calls to access resources in the account that owns the role. - You cannot use session policies to grant more permissions than those allowed by the - identity-based policy of the role that is being assumed. For more information, see - Session - Policies in the IAM User Guide. - - - - The plain text that you use for both inline and managed session policies shouldn't - exceed 2048 characters. The JSON policy characters can be any ASCII character from - the space character to the end of the valid character list (\u0020 through \u00FF). - It can also include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D) - characters. - - - - The characters in this parameter count towards the 2048 character session policy guideline. - However, an AWS conversion compresses the session policies into a packed binary format - that has a separate limit. This is the enforced limit. The PackedPolicySize - response element indicates by percentage how close the policy is to the upper size - limit. - - - - - - - Gets and sets the property PolicyArns. - - The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use - as managed session policies. The policies must exist in the same account as the role. - - - - This parameter is optional. You can provide up to 10 managed policy ARNs. However, - the plain text that you use for both inline and managed session policies shouldn't - exceed 2048 characters. For more information about ARNs, see Amazon - Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference. - - - - The characters in this parameter count towards the 2048 character session policy guideline. - However, an AWS conversion compresses the session policies into a packed binary format - that has a separate limit. This is the enforced limit. The PackedPolicySize - response element indicates by percentage how close the policy is to the upper size - limit. - - - - Passing policies to this operation returns new temporary credentials. The resulting - session's permissions are the intersection of the role's identity-based policy and - the session policies. You can use the role's temporary credentials in subsequent AWS - API calls to access resources in the account that owns the role. You cannot use session - policies to grant more permissions than those allowed by the identity-based policy - of the role that is being assumed. For more information, see Session - Policies in the IAM User Guide. - - - - - - The proxy settings to use when calling AssumeRoleWithWebIdentity. - - This parameter is optional. - - - - - - Abstract class that represents a credentials object for AWS services. - - - - - Returns a copy of ImmutableCredentials - - - - - - Called by AmazonServiceClient to validate the credential state - on client construction. - - - - - Basic set of credentials consisting of an AccessKey and SecretKey - - - - - Constructs a BasicAWSCredentials object for the specified accessKey and secretKey. - - - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - State class passed on callback to demand user credentials when authentication - needs to be performed using a non-default identity. - - - - - If the current authentication callback is associated with - a credential profile, this can be used to give the user - some context on the request for his/her authentication. - - - - - Contains the user identity that the user should supply a password - for. The user can ignore if they choose and return credentials for - an alternate account. - - - - - Any custom state that was registered with the callback. - - - - - Set if the callback was due to a failed authentication attempt. - If false we are beginning to obtain or refresh credentials. - - - - - InstanceProfileAWSCredentials allows configuring Roles and every instance hits IMDS individually. - This class has a singleton timer task that caches instance profile credentials every 2 minutes. - - - - - Returns a copy of the most recent instance profile credentials. - - - - - Returns a copy of the most recent instance profile credentials. - - - - - Dispose this object and all related resources. - - - - - When running in an ECS container and AWS_CONTAINER_CREDENTIALS_RELATIVE_URI is set, - use the given end point to retrieve the credentials. - - - - - These constants should not be consumed by client code. They are only relevant - in the context of ECS container and, especially, AWS_CONTAINER_CREDENTIALS_RELATIVE_URI - environment variable should not be overriden by the client code. - - - - - Uses aws credentials stored in environment variables to construct the credentials object. - AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY are used for the access key id and secret key. - If the variable AWS_SESSION_TOKEN exists then it will be used to create temporary session - credentials. - - - For backwards compatibility the class will also attempt to discover the secret key from - the AWS_SECRET_KEY variable, if a value cannot be obtained using the standard - AWS_SECRET_ACCESS_KEY variable. - - - - - Constructs an instance of EnvironmentVariablesAWSCredentials. If no credentials are found in - the environment variables then an InvalidOperationException is thrown. - - - - - Creates immutable credentials from environment variables. - - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - If AWS_CONTAINER_CREDENTIALS_RELATIVE_URI environment variable is set, we want to attempt to retrieve credentials - using ECS endpoint instead of referring to instance profile credentials. - - - If AWS_CONTAINER_CREDENTIALS_RELATIVE_URI environment variable is set, we want to attempt to retrieve credentials - using ECS endpoint instead of referring to instance profile credentials. - - - - Custom exception type thrown when a role profile with user identity is used - in conjunction with a credential request callback. This exception is thrown - if the callback returns null, indicating the user declined to supply credentials. - - - - - Initializes a new exception instance. - - - - - - Initializes a new exception instance. - - - - - - - Custom exception type thrown when authentication for a user fails due to - invalid credentials. - - - - - Initializes a new exception instance. - - - - - - Initializes a new exception instance. - - - - - - - Temporary credentials that are created following successful authentication with - a federated endpoint supporting SAML. - - - In order to use the FederatedAWSCredentials class the AWSSDK.SecurityToken assembly - must be available to your application at runtime. - - - - - Constructs an instance of FederatedAWSCredentials. After construction call GetCredentials - to authenticate the user/process and obtain temporary AWS credentials. - - The SAML endpoint used for authentication. - The role ARN used for authentication. - - - - Constructs an instance of FederatedAWSCredentials. After construction call GetCredentials - to authenticate the user/process and obtain temporary AWS credentials. - - The SAML endpoint used for authentication. - The role ARN used for authentication. - The options used for authentication. - See for details about available options. - - - - The SAML Endpoint used for authentication. - - - - - The role ARN used for authentication. - - - - - The options used for authentication. - See for details about available options. - - - - - Refresh credentials after expiry. If the role profile is configured with user identity - information and a callback has been registered to obtain the user credential, the callback - will be invoked ahead of authentication. For role profiles configured with user identity - but no callback registration, the SDK will fall back to attempting to use the default - user identity of the current process. - - - - - - Clears currently-stored credentials, forcing the next GetCredentials call to generate new credentials. - - - - - Options that control the behavior of . - - - - - The identity to use when authenticating. - This is in the form domain\username, or just username. - If this option is not set, the current user's identity will be used. - - - - - uses this callback to get credentials if the UserIdentity is set. - - - - - When makes a callback for credentials, - this state will be included for use by the callback handler. - - - - - The proxy settings to use when calling the - Secure Token Service and the ADFS endpoint. - - - - - Set this property when a region-specific STS endpoint must be used (eg cn-north-1). - If left empty/null, the global sts.amazonaws.com endpoint will be used when credentials are obtained. - - - - - The profile name, if this FederatedAWSCredentialsOptions - is associated with a CredentialProfile. - - - - - Immutable representation of AWS credentials. - - - - - Gets the AccessKey property for the current credentials. - - - - - Gets the SecretKey property for the current credentials. - - - - - Gets the Token property for the current credentials. - - - - - Gets the UseToken property for the current credentials. - Specifies if Token property is non-emtpy. - - - - - Constructs an ImmutableCredentials object with supplied accessKey, secretKey. - - - - Optional. Can be set to null or empty for non-session credentials. - - - - Returns a copy of the current credentials. - - - - - - Credentials that are retrieved from the Instance Profile service on an EC2 instance - - - - - Role for which the credentials are retrieved - - - - - Constructs a InstanceProfileAWSCredentials object for specific role - - Role to use - - - - Constructs a InstanceProfileAWSCredentials object for specific role - - Role to use - - - - Constructs a InstanceProfileAWSCredentials object for the first found role - - - - - Constructs a InstanceProfileAWSCredentials object for the first found role - - - - - Retrieves a list of all roles available through current InstanceProfile service - - - - - - Retrieves a list of all roles available through current InstanceProfile service - - - - - - Return true if string is null or whitespace, false otherwise. - We can't use String.IsNullOrWhitespace because it doesn't exist - in all frameworks we support. - - - - - - - Process Credentials can retrieve credentials by running a process and reading its stdout. - A new config option, "credential_process" is added to the shared config file that allows customers - to specify which process to run. The credentials retrieved by running this process could be either - Basic or Session credentials. - - - - - Generates new credentials by running the "credential_process" process. - - - - - Exception class to capture all exceptions encountered when starting or - executing the "credential_process" process. If the user has specified an executable - and the SDK is unable to execute it, the exception should be surfaces to the user - instead of moving on to the next credential provider. - - - - - Abstract class for automatically refreshing AWS credentials - - - - - Refresh state container consisting of credentials - and the date of the their expiration - - - - - Represents the current state of the Credentials. - - This can be cleared without synchronization. - - - - Semaphore to control thread access to GetCredentialsAsync method. - The semaphore will allow only one thread to generate new credentials and - update the current state. - - - - - The time before actual expiration to expire the credentials. - Property cannot be set to a negative TimeSpan. - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - Test credentials existence and expiration time - should update if: - credentials have not been loaded yet - it's past the expiration time. At this point currentState.Expiration may - have the PreemptExpiryTime baked into to the expiration from a call to - UpdateToGeneratedCredentials but it may not if this is new application load. - - - - - When overridden in a derived class, generates new credentials and new expiration date. - - Called on first credentials request and when expiration date is in the past. - - - - - - When overridden in a derived class, generates new credentials and new expiration date. - - Called on first credentials request and when expiration date is in the past. - - - - - - Clears currently-stored credentials, forcing the next GetCredentials call to generate new credentials. - - - - - Immutable representation of AWS credentials obtained as a result of - authenticating against a SAML-supporting federated identity provider. - - - - - The expiry time of the credentials, obtained from the AssumeRoleWithSAML response. - - - - - The value of the NameID element in the Subject element of the SAML assertion, as returned in the - AssumeRoleWithSAML response from the Security Token Service. - - - - - Constructs an instance with supplied keys and SAML assertion data. - - - - - - - - - - Constructs an instance with supplied keys and SAML assertion data. - - - - - - - - Returns a copy of the current credentials. - - - - - - Serializes the instance to a json-format string for external storage - - The serialized object in json - - - - Instantiates an instance from persisted json data - - The serialized data - Deserialized instance corresponding to the json data - - - - Session credentials consisting of AccessKey, SecretKey and Token - - - - - Constructs a SessionAWSCredentials object for the specified accessKey, secretKey. - - - - - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - - Credentials that are retrieved using a stored profile. - - - Unless otherwise specified priority is given to loading credentials from the SDK credential store - file which is shared between the SDK, PowerShell CLI and Toolkit. Credentials in profiles in this - file are encrypted and can only be used by the user account on the current machine that stored the - profile. Credentials can also be loaded from the plain-text ini-format credential file which is - shared with other AWS SDKs. This file is expected to exist in a '.aws' folder in the user's home - directory but alternate locations can be specified using either the AWSProfilesLocation setting in - the application configuration file, or by using the AWS_SHARED_CREDENTIALS_FILE environment variable. - - - The profile name can be specified in the App.config using the AWSProfileName setting. - - - - - - Constructs an instance for credentials stored in a profile. This constructor searches for credentials - using the account name specified using the AWSProfileName setting, if set, in the application configuration - file. If the configuration file setting is not set the SDK will attempt to locate a profile with the name - 'default'. - - - - - Constructs an instance for credentials stored in a profile with the specified name. The SDK will - check the SDK credential store file first before looking for the shared ini-format credentials - file unless the application configuration file contains a setting for the 'AWSProfilesLocation' - indicating the search should be constrained to the shared credentials file at the specified - location. - - The name of the profile in which the credentials were stored. - - - - Constructs an instance for credentials stored in a profile with the specified name. - - The profile name to search for credentials for - - Optional; instructs the SDK to check for the profile in the shared credentials file at the - specified location. If not set, the SDK will inspect its own credential store file first before - attempting to locate a shared credential file using either the default location beneath the user's - home profile folder or the location specified in the AWS_SHARED_CREDENTIALS_FILE environment - variable. - - - If credential materials cannot be read or are invalid due to missing data an InvalidDataException - is thrown. If no credentials can be located with the specified profile name, an ArgumentException - is thrown. - - - - - Name of the profile being used. - - - - - Location of the profiles, if used. - - - - - Tests if a profile has been registered in either the SDK store or the specified credential - file. - - The name of the profile to test - - Optional; instructs the SDK to check for the profile in the shared credentials file at the - specified location. If not set, the SDK will inspect its own credential store file first before - attempting to locate a shared credential file using either the default location beneath the user's - home profile folder or the location specified in the AWS_SHARED_CREDENTIALS_FILE environment - variable. - - True if a profile with the specified name has been registered. - - - - Tests if an instance can be created from the persisted profile data. - If profilesLocation is null/empty, the SDK store is searched for the - profile data before probing for the profile in the shared the ini-format - credential file. - - The name of the profile to test - - If null/empty, the SDK store is searched for the named profile otherwise - the ini-format credential file at the specified location is inspected. - - True if the persisted data would yield a valid credentials instance. - - - - Returns an instance of ImmutableCredentials for this instance - - - - - - Helper routiners for AWS and Federated credential profiles. Probes the - profile type for the supplied profile name and returns the appropriate profile - instance. - - - - - Determines the type of the requested profile and returns the - appropriate profile instance. - - The name of the profile (AWS or federated) to be loaded. - Instantiated profile type. - - - - Determines the type of the requested profile and returns the - appropriate profile instance. - - The name of the profile (AWS or federated) to be loaded. - - The location of the shared credentials (.ini) file, for profiles that are not stored in the - SDK credential store. - - Instantiated profile type. - - - - Probes for and returns the fully qualified name of the shared ini-format credentials - file. - - - Contains the file or folder name of the credential file. If not specified, the - routine will first check the application configuration file for a setting indicating - the file location or filename. If the configuration file does not yield a credential - file location then an environment variable is examined. Finally the routine will - inspect the fallback default location beneath the user's home folder location. - - - The fully qualified name to the credential file that was located, or null - if no credential file could be found. - - - - - Class that posts the CSM event to a UDP portconfig - This is a singleton class and is created once - per AmazonServiceClient. - - - - - The CSMevents are always posted to the localhost - - - - - Method to post UDP datagram for sync calls - - - - - Method to post UDP datagram for async calls - - - - - Method to post UDP datagram for bcl35 async calls - - - - - Determines the endpoint discovery enabled value based on an environment variable. If no value is found in the - environment then an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of EnvironmentVariable AWS_ENABLED_ENDPOINT_DISCOVERY. If no value is found in the - environment then an InvalidOperationException is thrown. - - - - - Determines endpoint discovery enabled based on a stored in an . - If the profile doesn't exist or there is no endpoint discovery enabled information an InvalidOperationException is thrown. - - - - - Attempts to construct an instance of . - If the AWS_PROFILE environment variable is set the instance will be constructed using that profile, - otherwise it will use the default profile. - - If the profile doesn't exist or there is no endpoint discovery enabled information an InvalidOperationException is thrown. - - The ICredentialProfileSource to read the profile from. - - - - Attempts to construct an instance of . - If the profile doesn't exist or there is no endpoint discovery enabled information an InvalidOperationException is thrown. - - The ICredentialProfileSource to read the profile from. - The name of the profile. - - - - Probing mechanism to determine the endpoint discovery enabled value from various sources. - - - - - The valid hashing algorithm supported by the sdk for request signing. - - - - - Which end of a request was responsible for a service error response. - - - - - The sender was responsible for the error, i.e. the client - request failed validation or was improperly formatted. - - - - - The error occured within the service. - - - - - An unrecognized error type was returned. - - - - - Sts Regional Endpoints Value determines whether or not - to send the sts request to the regional endpoint or to - the global sts endpoint - - - - - Send the request to the global sts endpoint - if the region is a legacy global region - - - - - Send the request to the regional endpoint - - - - - S3 US East 1 endpoint value determines wheter or not - to send the us-east-1 s3 requests to the regional endpoint or to - the legacy global endpoint - - - - - Sends the requests to the legacy global s3 endpoint for us-east-1 - - - - - Sends the request to the regional s3 endpoint for us-east-1 - - - - - Superclass for Exceptions that come over the event stream, or to wrap other kinds of generic exceptions. - - - - - The numeric code identifier for the type of error. - - - - - Constructs an EventStreamError. - - - - - Constructs an EventStreamError. - - The error code. - The error message. - - - - Event args that contain an . - - The - - - - The EventStream Event. - - - - - Constructs an EventStreamEventReceivedArgs. - - The EventStream Event. - - - - Event args that contain an . - - The . - - - - The EventStream Exception. - - - - - Constructs an EventStreamExceptionReceivedArgs. - - The EventStream Exception. - - - - Supported Header types for vnd.amazon.event-stream - - - - - Name for the Header. Maximum of 255 bytes. - - - - - Header type id - - - - - Computes the amount of memory neccesary to serialize this Header. - - - - - Writes this Header to buffer starting at offset - Keep in mind, this API assumes buffer is large enough - for the operation. - - buffer to serialize this Header to - offset to begin writing at. - - the new offset. - - - - - Returns the current value as a bool - - - - - Sets the current value - - - - - Returns the current value as a byte - - - - - Sets the current value - - - - - Gets the current value as a 16 bit integer. (Host Order). - - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a 32 bit integer. (Host Order) - - - - - Sets the current value - - - - - returns the current value as a 64-bit integer. (Host Order) - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a byte buffer. - - - - - - Sets the current value. Max length is 2^15 - 1 - - - - - Returns the current value as a utf-8 string. - - - - - Sets the current value. Utf-8 encoded. Max byte size is 2^16 - 1 - - - - - Gets the current value as a DateTime. - Note: You do not need to compensate for unix epoch on this API. - - - - - - Sets the current value. - Note: You do not need to compensate for unix epoch on this API. - - - - - Returns the current value as a Guid (UUID) - - - - - Sets the current value - - - - - Header Data for an EventStreamMessage - - Each header is of format: - [name len] (1) | [utf-8 name] (v) - [type (1)] - [value (v)] - - - - - Name for the Header. Maximum of 255 bytes. - - - - - Header type id - - - - - Initializes this Header with name. - - utf-8 string, max length is 255 - - - - Deserializes the header in buffer. - - buffer constaining the header - index to start from in the buffer. - updated offset with new value for offset - - - - Writes this Header to buffer starting at offset - Keep in mind, this API assumes buffer is large enough - for the operation. - - buffer to serialize this Header to - offset to begin writing at. - - the new offset. - - - - - Computes the amount of memory neccesary to serialize this Header. - - - - - Returns the current value as a bool - - - - - Sets the current value - - - - - Returns the current value as a byte - - - - - Sets the current value - - - - - Gets the current value as a 16 bit integer. (Host Order). - - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a 32 bit integer. (Host Order) - - - - - Sets the current value - - - - - returns the current value as a 64-bit integer. (Host Order) - - - - - Sets the current value. (Host Order) - - - - - Returns the current value as a byte buffer. - - - - - - Sets the current value. Max length is 2^15 - 1 - - - - - Returns the current value as a utf-8 string. - - - - - Sets the current value. Utf-8 encoded. Max byte size is 2^16 - 1 - - - - - Gets the current value as a DateTime. - Note: You do not need to compensate for unix epoch on this API. - - - - - - Sets the current value. - Note: You do not need to compensate for unix epoch on this API. - - - - - Returns the current value as a Guid (UUID) - - - - - Sets the current value - - - - - Headers for the message. Can be null. - - - - - Payload for the message. Can be null. - - - - - Converts a message into a byte buffer (usually for network transmission). - - - - - Message is a single datagram. The format is as follows: - [ total length (4) ] | [ headers_length (4)] | [ prelude crc(4)] - [ headers (v)] - [ payload (v)} - [ trailing crc ] - - CRCs use the CRC32 algorithm. - - - - - Content type for EventStreams. - - - - - Headers for the message. Can be null. - - - - - Payload for the message. Can be null. - - - - - Initialize a message with headers and a payload. - - list of headers for the message, can be null. - payload for the message, can be null. - - - - Builds a message from buffer. - - buffer to read - offset to start reading - buffer length. - - parsed instance of EventStreamMessage. Doesn't return null, - does throw if CRCs don't match. - - - - - Converts a message into a byte buffer (usually for network transmission). - - - - - Defines exceptions that arise from an not conforming to specification. - - - - - Constructs an EventStreamValidationException. - - - - - Constructs an EventStreamValidationException. - - The exception message. - - - - Constructs an EventStreamValidationException. - - The exception message. - The inner exception. - - - - The contract for the . - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - A subclass of that enables an enumerable interface for interacting with Events. - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - Flag if the stream was chosen to be enumerated. - - - - - A Stream of Events. Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treated as mutually exclusive. - - - - - A Stream of Events. Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treated as mutually exclusive. - - - - - Returns an enumerator that iterates through the collection. - - An enumerator that can be used to iterate through the collection. - - - - Returns an enumerator that iterates through a collection. - - An object that can be used to iterate through the collection. - - - - Starts the background thread to start reading events from the network stream. - - - - - The contract for the . - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - The size of the buffer for reading from the network stream. - - - - - Fires when an event is received. - - - - - Fired when an exception or error is raised. - - - - - Starts the background thread to start reading events from the network stream. - - - - - The superclass for all EventStreams. It contains the common processing logic needed to retreive events from a network Stream. It - also contains the mechanisms needed to have a background loop raise events. - - An implementation of IEventStreamEvent (e.g. IS3Event). - An implementation of EventStreamException (e.g. S3EventStreamException). - - - - "Unique" key for unknown event lookup. - - - - - Header key for message type. - - - - - Header key for event type. - - - - - Header key for exception type. - - - - - Header key for error code. - - - - - Header key for error message. - - - - - Value of when the message is an event. - - - - - Value of when the message is an exception. - - - - - Value of when the message is an error. - - - - - The size of the buffer for reading from the network stream. - Default is 8192. - - - - - The underlying stream to read events from. - - - - - Responsible for decoding events from sequences of bytes. - - - - - Fires when an event is recieved. - - - - - Fired when an exception or error is raised. - - - - - The mapping of event message to a generator function to construct the matching Event Stream event. - - - - - The mapping of event message to a generator function to construct the matching Event Stream exception. - - - - - Whether the Stream is currently being processed. - - - - - A Stream of Events. Events can be retrieved from this stream by attaching handlers to listen events, and then calling StartProcessing. - - - - - A Stream of Events. Events can be retrieved from this stream by attaching handlers to listen events, and then calling StartProcessing. - - - - - Converts an EventStreamMessage to an event. - - The event stream message to be converted. - The event - - - - Abstraction for cross-framework initiation of the background thread. - - - - - The background thread main loop. It will constantly read from the network stream until IsProcessing is false, or an error occurs. - - This stub exists due to FXCop. - - - - - The background thread main loop. It will constantly read from the network stream until IsProcessing is false, or an error occurs. - - Needed for 3.5 support. Not used. - - - - Reads from the stream into the buffer. It then passes the buffer to the decoder, which raises an event for - each message it decodes. - - The buffer to store the read bytes from the stream. - - - - Wraps exceptions in an outer exception so they can be passed to event handlers. If the Exception is already of a compatable type, - the method returns what it was given. - - The exception to wrap. - An exception of type TE - - - - Starts the background thread to start reading events from the network stream. - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Disposes the resources of this stream. - - Should dispose of unmanged resources. - - - - Event Arguments for EventStreamDecoder.MessageReceived. - - - - - Received message. - - - - - Additional object context - - - - - Initialize this with message - - - - - Initialize this with message and object conetext - - - - - Exception thrown when a request is made of the Decoder, but the internal state - machine is an invalid state. This is usually the result of an interanl exception - being thrown during parsing of the network stream. - - - - - Contract for EventStreamDecoder - - - - - Invoked anytime an EventStreamMessage is found. - - - - - Processes data starting at offset up to length. - Invokes MessageRecieved for each message encountered. - If an exception is thrown, this object is not safe for reuse. - - buffer to read - offset in buffer to start reading. - length of data. - - - - Streaming decoder for listening for incoming EventStreamMessage datagrams. - - - - - Invoked anytime an EventStreamMessage is found. - - - - - Object data (optional) that can be passed to the event handler for MessageReceived. - - - - - Default constructor. Initializes internal _state machine. - - - - - Processes data starting at offset up to length. - Invokes MessageRecieved for each message encountered. - If an exception is thrown, this object is not safe for reuse. - - buffer to read - offset in buffer to start reading. - length of data. - - - - Superclass for Exceptions that come over the event stream, or to wrap other kinds of generic exceptions. - - - - - Constructs an EventStreamException. - - - - - Constructs an EventStreamException. - - The exception message. - - - - Constructs an EventStreamException. - - The exception message. - The inner exception. - - - - The contract for EventStream events. - - - - - The contract for EventStream terminal events. - - - - - This Event is returned if an event is retrieved from the event stream, but a generator function - for the event is not defined. This can occur if the SDK is not updated after a new event type is introduced. - - - - - The Message recieved from the event stream before conversion. - - - - - The event type. - - - - - Constructs an UnknownEventStreamEvent. - - - - - Constructs an UnknownEventStreamEvent. - - The Message recieved from the event stream before conversion. - The event type. - - - - Signals that an an has an unknown message type. These exceptions whould be - swallowed to allow future expansion of the EventStream specification without breaking existing clients. - - - - - Constructs an UnknownEventStreamMessageTypeException. - - - - - This exception is thrown if an exception is retrieved from the event stream and should be modeled, - but a generator function for the strongly-typed exception is not defined. - - - - - The exception type. - - - - - Constructs an EventStreamException. - - The exception type. - - - - All Amazon service interfaces like IAmazonS3 extend from this interface. This allows all the - Amazon service interfaces be identified by this base interface and helps with generic constraints. - - - - - A readonly view of the configuration for the service client. - - - - - This interface is the read only access to the ClientConfig object used when setting up service clients. Once service clients - are initiated the config object should not be changed to avoid issues with using a service client in a multi threaded environment. - - - - - Gets the RegionEndpoint property. The region constant to use that - determines the endpoint to use. If this is not set - then the client will fallback to the value of ServiceURL. - - - - - The constant used to lookup in the region hash the endpoint. - - - - - Gets and sets of the ServiceURL property. - This is an optional property if you need to set a specific service URL - instead setting the region with the RegionEndpoint property. - - - - - Gets the UseHttp property. - If this property is set to true, the client attempts - to use HTTP protocol. - By default, this property is set to false. - - - - - Gets Service Version - - - - - Gets the signatureMethod property. - - - - - Gets the SignatureVersion property. - - Note: This property exists for backward compatibility but is no longer - used by any service other than S3. - - - - - Gets the AuthenticationRegion property. - Used in AWS4 request signing, this is an optional property; - change it only if the region cannot be determined from the - service endpoint. - - - - - Gets the AuthenticationServiceName property. - Used in AWS4 request signing, this is the short-form - name of the service being called. - - - - - Gets the UserAgent property. - - - - - Gets the DisableLogging. If true logging for this client will be disabled. - - - - - Flag on whether to log metrics for service calls. - - This can be set in the application's configs, as below: - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSLogMetrics" value"true"/> - </appSettings> - </configuration> - - - - - - Gets the LogResponse property. - If this property is set to true, the service response - is read in its entirety and logged. - - - - - Gets the ReadEntireResponse. - If this property is set to true, the service response - is read in its entirety before being processed. - - - - - This flag controls if .NET HTTP infrastructure should follow redirection - responses (e.g. HTTP 307 - temporary redirect). - - - - - Gets the BufferSize property. - The BufferSize controls the buffer used to read in from input streams and write - out to the request. - - - - - Gets the MaxErrorRetry property. - - - - - Gets the interval at which progress update events are raised - for upload operations. By default, the progress update events are - raised at every 100KB of data transferred. - - - - - Flag on whether to resign requests on retry or not. - - - - - Credentials to use with a proxy. - - - - - Gets the default request timeout value. - - - - If the value is set, the value is assigned to the Timeout property of the HTTPWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - - - - Configures the endpoint calculation for a service to go to a dual stack (ipv6 enabled) endpoint - for the configured region. - - - Note: AWS services are enabling dualstack endpoints over time. It is your responsibility to check - that the service actually supports a dualstack endpoint in the configured region before enabling - this option for a service. - - - - - Configures a flag enabling to either opt in or opt out of the retry throttling service. - Note: set value to true to enable retry throttling feature. The Default value for this flag is false. - - - - - Using either the RegionEndpoint or the ServiceURL determine what the URL to the service is. - - The URL to the service. - - - - Performs validation on this config object. - Throws exception if any of the required values are missing/invalid. - - The timeout specified is null. - - - - Returns the clock skew adjusted utc now. This value is affected by AWSConfigs.ManualClockCorrection - - - - - Returns the calculated clock skew value for this config's service endpoint. If AWSConfigs.CorrectForClockSkew is false, - this value won't be used to construct service requests. - - - - - Gets the DisableHostPrefixInjection flag. If true, host prefix injection will be disabled for this client, the default value of this flag is false. - Host prefix injection prefixes the service endpoint with request members from APIs which use this feature. - Example: for a hostPrefix of "foo-name." and a endpoint of "service.region.amazonaws.com" the default behavior is to - prefix the endpoint with the hostPrefix resulting in a final endpoint of "foo-name.service.region.amazonaws.com". Setting - DisableHostPrefixInjection to true will disable hostPrefix injection resulting in a final endpoint of - "service.region.amazonaws.com" regardless of the value of hostPrefix. E.g. You may want to disable host prefix injection for testing against a local mock endpoint. - - - - - Returns the flag indicating if endpoint discovery should be enabled or disabled for operations that are not required to use endpoint discovery. - - - - - Returns the maximum number of discovered endpoints that can be stored within the cache for the client. The default limit is 1000 cache entries. - - - - - Get the value to use for on requests. - If this property is null, - will be left at its default value of . - - - - - - This is a switch used for performance testing and is not intended for production applications - to change. This switch may be removed in a future version of the SDK as the .NET Core platform matures. - - - If true, the HttpClient is cached and reused for every request made by the service client - and shared with other service clients. - - - For the .NET Core platform this is default to true because the HttpClient manages the connection - pool. - - - - - - If CacheHttpClient is set to true then HttpClientCacheSize controls the number of HttpClients cached. - - - - - Gets the ProxyHost property. - - - - - Gets the ProxyPort property. - - - - - Returns a WebProxy instance configured to match the proxy settings - in the client configuration. - - - - - - Interface for a single logged message. - - - - - Log message format. - - - - - Log message arguments. - - - - - Culture-specific formatting provider. - - - - - Abstract parameter value. - - - - - String parameter value. - - - - - String value of the parameter. - - - - - Constructs ParameterValue for a single string. - - - - - - String list parameter value. - - - - - List of strings value of the parameter. - - - - - Constructs ParameterValue for a list of strings. - - - - - - The interface for an exception handler. - - - - - Handles an exception for the given execution context. - - The execution context, it contains the - request and response context. - The exception to handle. - - Returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception to replace the original exception. - - - - - The interface for an exception handler with a generic parameter for the exception type. - - The exception type. - - - - Handles an exception for the given execution context. - - The execution context, it contains the - request and response context. - The exception to handle. - - Returns a boolean value which indicates if the original exception - should be rethrown. - This method can also throw a new exception to replace the original exception. - - - - - The interface for a HTTP request factory. - - The type used by the underlying HTTP API to represent the request body. - - - - Creates an HTTP request for the given URI. - - The request URI. - An HTTP request. - - - - The interface for an HTTP request that is agnostic of the underlying HTTP API. - - The type used by the underlying HTTP API to represent the HTTP request content. - - - - The HTTP method or verb. - - - - - The request URI. - - - - - Configures a request as per the request context. - - The request context. - - - - Sets the headers on the request. - - A dictionary of header names and values. - - - - Gets a handle to the request content. - - The request content. - - - - Returns the HTTP response. - - The HTTP response. - - - - Writes a stream to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - The request context. - - - - Writes a byte array to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - - - - Sets up the progress listeners - - The content stream - The interval at which progress needs to be published - The objects which is trigerring the progress changes - The callback which will be invoked when the progress changed event is trigerred - an object, incase the progress is setup, else returns the original stream - - - - Aborts the HTTP request. - - - - - Gets a handle to the request content. - - - - - - Returns the HTTP response. - - A cancellation token that can be used to cancel the asynchronous operation. - - - - - A factory which creates HTTP clients. - - - - - Create and configure an HttpClient. - - - - - - If true the SDK will internally cache the clients created by CreateHttpClient. - If false the sdk will not cache the clients. - Override this method to return false if your HttpClientFactory will handle its own caching - or if you don't want clients to be cached. - - - - - - - Determines if the SDK will dispose clients after they're used. - If HttpClients are cached, either by the SDK or by your HttpClientFactory, this should be false. - If there is no caching then this should be true. - - - - - - - Returns a string that's used to group equivalent HttpClients into caches. - This method isn't used unless UseSDKHttpClientCaching returns true; - - A null return value signals the SDK caching mechanism to cache HttpClients per SDK client. - So when the SDK client is disposed, the HttpClients are as well. - - A non-null return value signals the SDK that HttpClients created with the given clientConfig - should be cached and reused globally. ClientConfigs that produce the same result for - GetConfigUniqueString will be grouped together and considered equivalent for caching purposes. - - - - - - - A factory which creates HTTP requests which uses System.Net.Http.HttpClient. - - - - - The constructor for HttpRequestMessageFactory. - - Configuration setting for a client. - - - - Creates an HTTP request for the given URI. - - The request URI. - An HTTP request. - - - - Disposes the HttpRequestMessageFactory. - - - - - Dispose the factory - - - - - - Create and configure a managed HttpClient instance. - The use of HttpClientHandler in the constructor for HttpClient implicitly creates a managed HttpClient. - - - - - - - A cache of HttpClient objects. The GetNextClient method does a round robin cycle through the clients - to distribute the load even across. - - - - - Constructs a container for a cache of HttpClient objects - - The HttpClient to cache - - - - Returns the next HttpClient using a round robin rotation. It is expected that individual clients will be used - by more then one Thread. - - - - - - Disposes the HttpClientCache. - - - - - Dispose the HttpClientCache - - - - - - HTTP request wrapper for System.Net.Http.HttpRequestMessage. - - - - - Set of content header names. - - - - - The constructor for HttpWebRequestMessage. - - The HttpClient used to make the request. - The request URI. - The service client config. - - - - The underlying HttpClient - - - - - The underlying HTTP web request. - - - - - The HTTP method or verb. - - - - - The request URI. - - - - - Configures a request as per the request context. - - The request context. - - - - Sets the headers on the request. - - A dictionary of header names and values. - - - - Gets a handle to the request content. - - The request content. - - - - Returns the HTTP response. - - The HTTP response. - - - - Aborts the HTTP request. - - - - - Returns the HTTP response. - - A cancellation token that can be used to cancel the asynchronous operation. - - - - - Writes a stream to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - The request context. - - - - Writes a byte array to the request body. - - The destination where the content stream is written. - The content stream to be written. - HTTP content headers. - - - - Gets a handle to the request content. - - - - - - Disposes the HttpWebRequestMessage. - - - - - - - - - - - Sets up the progress listeners - - The content stream - The interval at which progress needs to be published - The objects which is trigerring the progress changes - The callback which will be invoked when the progress changed event is trigerred - an object, incase the progress is setup, else returns the original stream - - - - Interface for a handler in a pipeline. - - - - - The logger used to log messages. - - - - - The inner handler which is called after the current - handler completes it's processing. - - - - - The outer handler which encapsulates the current handler. - - - - - Contains the processing logic for a synchronous request invocation. - This method should call InnerHandler.InvokeSync to continue processing of the - request by the pipeline, unless it's a terminating handler. - - The execution context which contains both the - requests and response context. - - - - Contains the processing logic for an asynchronous request invocation. - This method should call InnerHandler.InvokeSync to continue processing of the - request by the pipeline, unless it's a terminating handler. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - A retry policy specifies all aspects of retry behavior. This includes conditions when the request should be retried, - checks of retry limit, preparing the request before retry and introducing delay (backoff) before retries. - - - A retry policy specifies all aspects of retry behavior. This includes conditions when the request should be retried, - checks of retry limit, preparing the request before retry and introducing delay (backoff) before retries. - - - - - Maximum number of retries to be performed. - This does not count the initial request. - - - - - The logger used to log messages. - - - - - Checks if a retry should be performed with the given execution context and exception. - - The execution context which contains both the - requests and response context. - The exception thrown after issuing the request. - Returns true if the request should be retried, else false. The exception is retried if it matches with clockskew error codes. - - - - Returns true if the request is in a state where it can be retried, else false. - - The execution context which contains both the - requests and response context. - Returns true if the request is in a state where it can be retried, else false. - - - - Return true if the request should be retried for the given exception. - - The execution context which contains both the - requests and response context. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Checks if the retry limit is reached. - - The execution context which contains both the - requests and response context. - Return false if the request can be retried, based on number of retries. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called on a successful request response. - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called before a retry request is initiated. The value - returned is True by default(retry throttling feature is disabled). - - The execution context which contains both the - requests and response context. - - - - Virtual method that gets called before a retry request is initiated. The value - returned is True by default(retry throttling feature is disabled). - - The execution context which contains both the - requests and response context. - true to bypass any attempt to acquire capacity on a retry - - - - Checks if a retry should be performed with the given execution context and exception. - - The execution context which contains both the - requests and response context. - The exception throw after issuing the request. - Returns true if the request should be retried, else false. The exception is retried if it matches with clockskew error codes. - - - - Return true if the request should be retried for the given exception. - - The execution context which contains both the - requests and response context. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Waits before retrying a request. - - The execution context which contains both the - requests and response context. - - - - Metrics collected by the SDK on a per-request basis. - - - Each request made to an AWS service by the SDK can have metrics - collected and logged. This interface represents the collected - metrics for a request. The metrics include properties (i.e. request id - and other metadata), timings for each stage of the request, and counters. - - - - - Collection of properties being tracked - - - - - Timings for metrics being tracked - - - - - Counters being tracked - - - - - Whether metrics are enabled for the request - - - - - JSON representation of the current metrics - - JSON string - - - - Represents how long a phase of an SDK request took. - - - - - Whether the timing has been stopped - - - - - Elapsed ticks from start to stop. - If timing hasn't been stopped yet, returns 0. - - - - - Elapsed time from start to stop. - If timing hasn't been stopped yet, returns TimeSpan.Zero - - - - - User supplied type to perform metrics formatting. - - - - - Produce custom formatting for SDK metrics. - - - If defined, this method will be called for every request made by the SDK. - - An instance of IRequestMetrics produced by the SDK - formatted string representation of the metrics - - - - Predefined request metrics that are collected by the SDK. - - - - - Information about the request. - - - - - Gets and sets the RequestId property. - ID that uniquely identifies a request. Amazon keeps track of request IDs. If you have a question about a request, include the request ID in your correspondence. - - - - - ICoreAmazonKMS is not meant to be used directly. It defines Key Management Service - with basic .NET types and allows other services to be able to use the service as - a runtime dependency. This interface is implemented by the AmazonKeyManagementServiceClient - defined in the AWSSDK.KeyManagementService assembly. - - - - - The result of the GenerateDataKey and GenerateDataKeyAsync operations. - - - - - The plaintext for the data key. - - - - - The ciphertext for the data key. - - - - - ICoreAmazonS3 is not meant to use directly. It defines S3 with basic .NET types - and allows other services to be able to use S3 as a runtime dependency. This interface - is implemented by the AmazonS3Client defined in the S3 assembly. - - - ICoreAmazonS3 is not meant to use directly. It defines S3 with basic .NET types - and allows other services to be able to use S3 as a runtime dependency. This interface - is implemented by the AmazonS3Client defined in the S3 assembly. - - - - - Generate a presigned URL. - - - - - - - - - - Get all the object keys for the particular bucket and key prefix. - - - - - - - - - Upload an object from a stream. - - - - - - - - - - - Delete an object. - - - - - - - - - - Delete an object. - - - - - - - - - - Open a stream to an object in S3. - - - - - - - - - - Upload an object from a file path. - - - - - - - - - - - Download an object in S3 to a file path. - - - - - - - - - - - Set the ACL on the object to public readable. - - - - - - - - Check to see if the bucket exists and if it doesn't create the bucket. - - - - - - Check to see if the bucket exists. - - - - - - - ICoreAmazonSQS is not meant to use directly. It defines SQS with basic .NET types - and allows other services to be able to use SQS as a runtime dependency. This interface - is implemented by the AmazonSQSClient defined in the SQS assembly. - - - - - Get the attributes for the queue identified by the queue URL asynchronously. - - The queue URL to get attributes for. - A Task containing the result of a dictionary of attributes for the queue. - - - - Set the attributes on the queue identified by the queue URL asynchronously. - - The queue URL to set the attributues. - The attributes to set. - A Task - - - - ICoreAmazonSTS is not meant to be used directly. It defines Security Token - service with basic .NET types and allows other services to be able to use the service as - a runtime dependency. This interface is implemented by the AmazonSecurityTokenServiceClient - defined in the AWSSDK.SecurityToken assembly. - - - - - - This method is used internally to access the Amazon Security Token - service within other service assemblies. - Please use AmazonSecurityTokenServiceClient to access the Amazon Security Token - service instead. - - Use Amazon Security Token Service to assume a role. - - Proxy settings that are required for the HTTPS and STS calls made during the authentication/credential - generation process are supported and should have been configured on the STS ClientConfig instance - associated with the STS client instance exposing this interface. - - - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRole. - - - - - ICoreAmazonSTS_SAML is not meant to be used directly. It defines Security Token - service with basic .NET types and allows other services to be able to use the service as - a runtime dependency. This interface is implemented by the AmazonSecurityTokenServiceClient - defined in the AWSSDK.SecurityToken assembly. - - - - - - This method is used internally to access the Amazon Security Token - service within other service assemblies. - Please use AmazonSecurityTokenServiceClient to access the Amazon Security Token - service instead. - - Authenticates against a federated identity endpoint supporting SAML and returns - temporary AWS credentials for the supplied role. - - The endpoint for the federated identity provider - The authentication type to use (NTLM, Kerberos etc) - The ARN of the role the user is to assume following authentication - TTL duration for the generated credentials. - - Optional; alternate user credential for authentication. If null the identity of the - current process is used. - - Generated credential data, including SAML-related information such as subject. - - Proxy settings that are required for the HTTPS and STS calls made during the authentication/credential - generation process are supported and should have been configured on the STS ClientConfig instance - associated with the STS client instance exposing this interface. - - - - - - This method is used internally to access the Amazon Security Token - service within other service assemblies. - Please use AmazonSecurityTokenServiceClient to access the Amazon Security Token - service instead. - - Use Amazon Security Token Service to assume a role. - - Proxy settings that are required for the HTTPS and STS calls made during the authentication/credential - generation process are supported and should have been configured on the STS ClientConfig instance - associated with the STS client instance exposing this interface. - - - The web identity token used to assume the role. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRoleWithWebIdentity - - - - - - This method is used internally to access the Amazon Security Token - service within other service assemblies. - Please use AmazonSecurityTokenServiceClient to access the Amazon Security Token - service instead. - - Use Amazon Security Token Service to assume a role. - - Proxy settings that are required for the HTTPS and STS calls made during the authentication/credential - generation process are supported and should have been configured on the STS ClientConfig instance - associated with the STS client instance exposing this interface. - - - The web identity token used to assume the role. - The Amazon Resource Name (ARN) of the role to assume. - An identifier for the assumed role session. - Options to be used in the call to AssumeRoleWithWebIdentity - - - - - CoreAmazonKMS is not meant to use directly. It implements ICoreAmazonKMS - and allows other service clients to be able to use the KMS service as a runtime dependency. - - This class waits until a method is actually called on the ICoreAmazonKMS interface - before requiring the KMS assembly to be present and loaded. - - - - - This exception is thrown if there are problems signing the request. - - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - - - - Gets the percentage of transfer completed - - - - - Gets the number of bytes transferred since last event - - - - - Gets the number of bytes transferred - - - - - Gets the total number of bytes to be transferred - - - - - Returns a string representation of this object - - - - - - Settings for configuring a proxy for the SDK to use. - - - - - The host name or IP address of the proxy server. - - - - - The port number of the proxy. - - - - - The username to authenticate with the proxy server. - - - - - The password to authenticate with the proxy server. - - - - - Collection of one or more regular expressions denoting addresses - for which the proxy will not be used. - - - For more information on bypass lists - see https://msdn.microsoft.com/en-us/library/system.net.webproxy.bypasslist%28v=vs.110%29.aspx. - - - - - If true requests to local addresses bypass the configured - proxy. - - - - - Settings for logging in the SDK. - - - - - Logging destination. - - - - - When to log responses. - - - - - Gets or sets the size limit in bytes for logged responses. - If logging for response body is enabled, logged response - body is limited to this size. The default limit is 1KB. - - - - - Whether or not to log SDK metrics. - - - - - A custom formatter added through Configuration - - - - - This class can be used to discover the public address ranges for AWS. The - information is retrieved from the publicly accessible - https://ip-ranges.amazonaws.com/ip-ranges.json file. - - - The information in this file is generated from our internal system-of-record and - is authoritative. You can expect it to change several times per week and should - poll accordingly. - - - - - Region identifier string for ROUTE53 and CLOUDFRONT ranges - - - - - Collection of service keys found in the data file. - - - - - The publication date and time of the file that was downloaded and parsed. - - - - - Collection of all public IP ranges. - - - - - Filtered collection of public IP ranges for the given service key - - - - - Filtered collection of public IP ranges for the given region (us-east-1 etc) or GLOBAL. - - - - - Downloads the most recent copy of the endpoint address file and - parses it to a collection of address range objects. - - - - - Downloads the most recent copy of the endpoint address file and - parses it to a collection of address range objects. - - - - - Represents the IP address range for a single region and service key. - - - - - The public IPv4 or Ipv6 address range, in CIDR notation. - - - - - Indicates ipv4 or v6 format of the address - - - - - The AWS region or GLOBAL for edge locations. Note that the CLOUDFRONT and ROUTE53 - ranges are GLOBAL. - - - - - The subset of IP address ranges. Specify AMAZON to get all IP address ranges - (for example, the ranges in the EC2 subset are also in the AMAZON subset). Note - that some IP address ranges are only in the AMAZON subset. - - - Valid values for the service key include "AMAZON", "EC2", "ROUTE53", - "ROUTE53_HEALTHCHECKS", and "CLOUDFRONT." If you need to know all of - the ranges and don't care about the service, use the "AMAZON" entries. - The other entries are subsets of this one. Also, some of the services, - such as S3, are represented in "AMAZON" and do not have an entry that - is specific to the service. We plan to add additional values over time; - code accordingly! - - - - - This class defines utilities and constants that can be used by - all the client libraries of the SDK. - - - - - The user agent string header - - - - - The Set of accepted and valid Url characters per RFC3986. - Characters outside of this set will be encoded. - - - - - The Set of accepted and valid Url characters per RFC1738. - Characters outside of this set will be encoded. - - - - - The set of accepted and valid Url path characters per RFC3986. - - - - - The string representing Url Encoded Content in HTTP requests - - - - - The GMT Date Format string. Used when parsing date objects - - - - - The ISO8601Date Format string. Used when parsing date objects - - - - - The ISO8601Date Format string. Used when parsing date objects - - - - - The ISO8601 Basic date/time format string. Used when parsing date objects - - - - - The ISO8601 basic date format. Used during AWS4 signature computation. - - - - - The RFC822Date Format string. Used when parsing date objects - - - - - Returns an extension of a path. - This has the same behavior as System.IO.Path.GetExtension, but does not - check the path for invalid characters. - - - - - - Convert request parameters to Url encoded query string - - - Convert Dictionary of parameters to Url encoded query string - - - - Returns the canonicalized resource path for the service endpoint with single URL encoded path segments. - - Endpoint URL for the request - Resource path for the request - - If resourcePath begins or ends with slash, the resulting canonicalized - path will follow suit. - - Canonicalized resource path for the endpoint - - - - Returns the canonicalized resource path for the service endpoint - - Endpoint URL for the request - Resource path for the request - If true pre URL encode path segments if necessary. - S3 is currently the only service that does not expect pre URL encoded segments. - - If resourcePath begins or ends with slash, the resulting canonicalized - path will follow suit. - - Canonicalized resource path for the endpoint - - - - Returns the canonicalized resource path for the service endpoint - - Endpoint URL for the request - Resource path for the request - If true pre URL encode path segments if necessary. - S3 is currently the only service that does not expect pre URL encoded segments. - Dictionary of key/value parameters containing the values for the ResourcePath key replacements - The version of the marshaller that constructed the request object. - - If resourcePath begins or ends with slash, the resulting canonicalized - path will follow suit. - - Canonicalized resource path for the endpoint - - - - Splits the resourcePath at / into segments then resolves any keys with the path resource values. Greedy - key values will be split into multiple segments at each /. - - The patterned resourcePath - The key/value lookup for the patterned resourcePath - A list of path segments where all keys in the resourcePath have been resolved to one or more path segment values - - - - Joins all path segments with the / character and encodes each segment before joining. - - The segments of a URL path split at each / character - If the path property is specified, - the accepted path characters {/+:} are not encoded. - A joined URL with encoded segments - - - - Takes a patterned resource path and resolves it using the key/value path resources into - a segmented encoded URL. - - The patterned resourcePath - The key/value lookup for the patterned resourcePath - A segmented encoded URL - - - - Returns a new string created by joining each of the strings in the - specified list together, with a comma between them. - - The list of strings to join into a single, comma delimited - string list. - A new string created by joining each of the strings in the - specified list together, with a comma between strings. - - - - Attempt to infer the region for a service request based on the endpoint - - Endpoint to the service to be called - - Region parsed from the endpoint; DefaultRegion (or DefaultGovRegion) - if it cannot be determined/is not explicit - - - - - Attempt to infer the service name for a request (in short form, eg 'iam') from the - service endpoint. - - Endpoint to the service to be called - - Short-form name of the service parsed from the endpoint; empty string if it cannot - be determined - - - - - Utility method for converting Unix epoch seconds to DateTime structure. - - The number of seconds since January 1, 1970. - Converted DateTime structure - - - - Helper function to format a byte array into string - - The data blob to process - If true, returns hex digits in lower case form - String version of the data - - - - Calls a specific EventHandler in a background thread - - - - - - - - Parses a query string of a URL and returns the parameters as a string-to-string dictionary. - - - - - - - Utility method for converting a string to a MemoryStream. - - - - - - - Utility method for copy the contents of the source stream to the destination stream. - - - - - - - Utility method for copy the contents of the source stream to the destination stream. - - - - - - - - Formats the current date as a GMT timestamp - - A GMT formatted string representation - of the current date and time - - - - - Formats the current date as ISO 8601 timestamp - - An ISO 8601 formatted string representation - of the current date and time - - - - - Gets the ISO8601 formatted timestamp that is minutesFromNow - in the future. - - The number of minutes from the current instant - for which the timestamp is needed. - The ISO8601 formatted future timestamp. - - - - Formats the current date as ISO 8601 timestamp - - An ISO 8601 formatted string representation - of the current date and time - - - - - Gets the RFC822 formatted timestamp that is minutesFromNow - in the future. - - The number of minutes from the current instant - for which the timestamp is needed. - The ISO8601 formatted future timestamp. - - - - Determines whether the given string is an absolute path to a root. - - The hypothetical absolute path. - True if is an absolute path. - - - - Returns true if the path specified is relative to the current drive or working directory. - Returns false if the path is fixed to a specific drive or UNC path. This method does no - validation of the path (URIs will be returned as relative as a result). - - - Handles paths that use the alternate directory separator. It is a frequent mistake to - assume that rooted paths (Path.IsPathRooted) are not relative. This isn't the case. - "C:a" is drive relative- meaning that it will be resolved against the current directory - for C: (rooted, but relative). "C:\a" is rooted and not relative (the current directory - will not be used to modify the path). - - - - - True if the given character is a directory separator. - - - - - Returns true if the given character is a valid drive letter - - - - - URL encodes a string per RFC3986. If the path property is specified, - the accepted path characters {/+:} are not encoded. - - The string to encode - Whether the string is a URL path or not - The encoded string - - - - URL encodes a string per the specified RFC. If the path property is specified, - the accepted path characters {/+:} are not encoded. - - RFC number determing safe characters - The string to encode - Whether the string is a URL path or not - The encoded string - - Currently recognised RFC versions are 1738 (Dec '94) and 3986 (Jan '05). - If the specified RFC is not recognised, 3986 is used by default. - - - - - URL encodes a string per the specified RFC with the exception of preserving the encoding of previously encoded slashes. - If the path property is specified, the accepted path characters {/+:} are not encoded. - - The string to encode - Whether the string is a URL path or not - The encoded string with any previously encoded %2F preserved - - - - Convert bytes to a hex string - - Bytes to convert. - Hexadecimal string representing the byte array. - - - - Convert a hex string to bytes - - Hexadecimal string - Byte array corresponding to the hex string. - - - - Returns DateTime.UtcNow + ManualClockCorrection when - is set. - This value should be used instead of DateTime.UtcNow to factor in manual clock correction - - - - - Returns true if the string has any bidirectional control characters. - - - - - - - Executes an HTTP request and returns the response as a string. This method - throws WebException and HttpRequestException. In the event HttpRequestException - is thrown the StatusCode is sent as user defined data on the exception under - the key "StatusCode". - - The URI to make the request to - The request type: GET, PUT, POST - null or the content to send with the request - Timeout for the request - Proxy for the request - null or any headers to send with the request - The response as a string. - - - - Utility method that accepts a string and replaces white spaces with a space. - - - - - - - Runs a process with the below input parameters. - - - - - - - This method allows to check whether a property of an object returned by a service call - is set. This method is needed to discriminate whether a field is not set (not present in - the service response) or if it is set to the default value for its type. Using this - method is not required for nullable properties (non-ValueType and Nullable) because - they will be simply set to null when not included in the service response. - This method can also be used on objects used as part of service requests. - This method doesn't support objects that are part of the S3 service model. - - An object that is used in an AWS service request or is - returned as part of an AWS service response. - The name of the property of awsServiceObject to check. - True if the property is set, otherwise false. - - - - This method is used preserve the stacktrace used from clients that support async calls. This - make sure that exceptions thrown during EndXXX methods has the orignal stacktrace that happen - in the background thread. - - - - - - Provides access to EC2 instance metadata when running on an EC2 instance. - If this class is used on a non-EC2 instance, the properties in this class - will return null. - - - - Amazon EC2 instances can access instance-specific metadata, as well as data supplied when launching the instances, using a specific URI. - - - You can use this data to build more generic AMIs that can be modified by configuration files supplied at launch time. - For example, if you run web servers for various small businesses, they can all use the same AMI and retrieve their content from the - Amazon S3 bucket you specify at launch. To add a new customer at any time, simply create a bucket for the customer, add their content, - and launch your AMI. - - - More information about EC2 Metadata - - - - - - - - - - Allows to configure the proxy used for HTTP requests. The default value is null. - - - - - The AMI ID used to launch the instance. - - - - - The index of this instance in the reservation. - - - - - The manifest path of the AMI with which the instance was launched. - - - - - The AMI IDs of any instances that were rebundled to create this AMI. - Will only exist if the AMI manifest file contained an ancestor-amis key. - - - - - The private hostname of the instance. - In cases where multiple network interfaces are present, - this refers to the eth0 device (the device for which the device number is 0). - - - - - Notifies the instance that it should reboot in preparation for bundling. - Valid values: none | shutdown | bundle-pending. - - - - - The ID of this instance. - - - - - The type of instance. - - - - - The ID of the kernel launched with this instance, if applicable. - - - - - The local hostname of the instance. In cases where multiple network interfaces are present, - this refers to the eth0 device (the device for which device-number is 0). - - - - - The instance's MAC address. In cases where multiple network interfaces are present, - this refers to the eth0 device (the device for which device-number is 0). - - - - - The private IP address of the instance. In cases where multiple network interfaces are present, - this refers to the eth0 device (the device for which device-number is 0). - - - - - The Availability Zone in which the instance launched. - - - - - Product codes associated with the instance, if any. - - - - - Public key. Only available if supplied at instance launch time. - - - - - The ID of the RAM disk specified at launch time, if applicable. - - - - - The region in which the instance is running, extracted from the identity - document data. - - - - - ID of the reservation. - - - - - The names of the security groups applied to the instance. - - - - - Returns information about the last time the instance profile was updated, - including the instance's LastUpdated date, InstanceProfileArn, and InstanceProfileId. - - - - - Returns the temporary security credentials (AccessKeyId, SecretAccessKey, SessionToken, and Expiration) - associated with the IAM roles on the instance. - - - - - The virtual devices associated with the ami, root, ebs, and swap. - - - - - The network interfaces on the instance. - - - - - The metadata sent to the instance. - - - - - Value showing whether the customer has enabled detailed - one-minute monitoring in CloudWatch. - - - - - JSON containing instance attributes, such as instance-id, private IP - address, etc - - - - - Data that can be used by other parties to verify its origin and authenticity. - - - - - Used to verify the document's authenticity and content against the signature. - - - - - Return the list of items in the metadata at path. - - Path at which to query the metadata; may be relative or absolute. - List of items returned by the metadata service - - - - Return the metadata at the path - - Path at which to query the metadata; may be relative or absolute. - Data returned by the metadata service - - - - Return the metadata at the path - - Path at which to query the metadata; may be relative or absolute. - Number of attempts to make - Data returned by the metadata service - - - - Return the list of items in the metadata at path. - - Path at which to query the metadata; may be relative or absolute. - Number of attempts to make - List of items returned by the metadata service - - - - Fetches the api token to use with metadata requests. - - The API token or null - - - - Fetches the api token to use with metadata requests. - - The number of tries to fetch the api token before giving up and throwing the web exception - The API token or null if an API token couldn't be obtained and doesn't need to be used - - - - Exponentially sleeps based on the current retry value. A lower - value will sleep shorter than a larger value - - Base 0 retry index - - - - Returns information about the last time the instance profile was updated, - including the instance's LastUpdated date, InstanceProfileArn, and InstanceProfileId. - - - - - The status of the instance profile - - - - - Further information about the status of the instance profile - - - - - The date and time the instance profile was updated - - - - - The Amazon Resource Name (ARN) of the instance profile - - - - - The Id of the instance profile - - - - - The temporary security credentials (AccessKeyId, SecretAccessKey, SessionToken, and Expiration) associated with the IAM role. - - - - - The status of the security credential - - - - - Further information about the status of the instance profile - - - - - The date and time the security credential was last updated - - - - - The type of the security credential - - - - - The uniqe id of the security credential - - - - - The secret key used to sign requests - - - - - The security token - - - - - The date and time when these credentials expire - - - - - All of the metadata associated with a network interface on the instance. - - - - - Construct an instance of NetworkInterface - - - - - - The interface's Media Access Control (mac) address. - - - - - The ID of the owner of the network interface. - - - In multiple-interface environments, an interface can be attached by a third party, such as Elastic Load Balancing. - Traffic on an interface is always billed to the interface owner. - - - - - The interface's profile - - - - - The interface's local hostname. - - - - - The private IP addresses associated with the interface. - - - - - The interface's public hostname. - - - - - The elastic IP addresses associated with the interface. - - - There may be multiple IP addresses on an instance. - - - - - Security groups to which the network interface belongs. - - - - - IDs of the security groups to which the network interface belongs. Returned only for Amazon EC2 instances launched into a VPC. - - - - - The ID of the Amazon EC2-VPC subnet in which the interface resides. - - - Returned only for Amazon EC2 instances launched into a VPC. - - - - - The CIDR block of the Amazon EC2-VPC subnet in which the interface resides. - - - Returned only for Amazon EC2 instances launched into a VPC. - - - - - The CIDR block of the Amazon EC2-VPC subnet in which the interface resides. - - - Returned only for Amazon EC2 instances launched into a VPC. - - - - - Get the private IPv4 address(es) that are associated with the public-ip address and assigned to that interface. - - The public IP address - Private IPv4 address(es) associated with the public IP address - - - - Wrapper class which invokes the static method - public static string GetEnvironmentVariable(string variable) - underneath. This class is added as a property on the singleton class - EnvironmentVariableSource. This change was done for testability. - - - - - Singleton class that holds the property of type IEnvironmentVariableRetreiver. - This property can hold an instance of type EnvironmentVariableRetreiver which has a wrapper - method for - public static string GetEnvironmentVariable(string variable) - or can be mocked for testing purposes. - - - - - Interface for EnvironmentVariableRetriever. - This serves as a property for the singleton EnvironmentVariableSource - - - - - Returns the type of platform and version.!-- If on a special platform, a static "0" is used as the version since - we have nothing more specific that actually means anything. Otherwise, asks InteropServices RuntimeInformation for - the OSDescription and trims off the OS name. - - - - - Returns the special platform information (e.g. Unity_OSXEditor, Xamarin_AndroidTablet) if - on those platforms, otherwise asks InteropServices RuntimeInformation for the OSDescription - and trims off the version. - - - - - Returns the special platform information (e.g. Unity_OSXEditor, Xamarin_AndroidTablet) if - on those platforms, otherwise asks InteropServices RuntimeInformation for the OSDescription, - keeping the version tail. - - - - - Manager to access a settings store file. Objects are primarily accessed by DisplayName rather than unique key. - Settings store files are located under the current user's AppData\Local\AWSToolkit folder. - Select keys in these files are encrypted on a per user, per machine basis using the Windows Data Protection API; - the encrypted values cannot be used by any other user or on any other machine. - - This class is not threadsafe. - - - - - True if the encrypted store is availble, false otherwise. - - - - - Construct an NamedSettingsManager. - - The base filename to read/write. - - - - Register an object. Let the uniqueKey be assigned automatically. - - The display name for the object. - The property names and values for the object. - The unique key that was assigned to the object. - - - - Try to get an object form the store. - - The display name for the object. - The property names and values for the object. - True if the object was found, false otherwise. - - - - Try to get an object form the store. - - The display name for the object. - The uniqueKey of the object in the store - The property names and values for the object. - True if the object was found, false otherwise. - - - - Unregister an object from the store. - - The display name for the object. - - - - Rename an object in the store. - - - - if true and destination object already exists overwrite it - - - - Copy an object in the store. - The new object will be a copy of the original, except it will be assigned a new unique key. - - - - if true and destination object already exists overwrite it - - - - Get a list of the display names for the objects in the store. - - A list of display names. - - - - Root AWS config - - - - - Manager to access a settings store file. - Settings store files are located under the current user's AppData\Local\AWSToolkit folder. - Select keys in these files are encrypted on a per user, per machine basis using the Windows Data Protection API; - the encrypted values cannot be used by any other user or on any other machine. - - This class is not threadsafe. - - - - - True if the encrypted store is availble, false otherwise. - - - - - Construct a SettingsManager. - - The base filename to read/write. - - - - The base filename to read/write. - - - - - Register an object. Let the uniqueKey be assigned automatically. - - The property names and values for the object. - The unique key that was assigned to the object. - - - - Register an object. - - The uniqueKey for the object, or null if one should be assigned automatically. - The property names and values for the object. - The unique key that was assigned to the object. - - - - Try to get an object form the store. - - The uniqueKey of the object in the store - The property names and values for the object. - True if the object was found, false otherwise. - - - - Try to get an object form the store based on the value of a specific property. - If multiple objects with the same property value exist, return the first one. - - The name of the property to search on. - The value of the property to search on. - The unique key of the object. - The properties of the object. - - - - - Get a list of the unique keys of all the objects in the store. - - - - - - Get the value of a specific property for each object in the store. - - - - - - - Unregister an object from the store. - - The unique key for the object. - - - - Class that contains result of executing an external process through the SDKs - AWSSDKUtils.RunProcess/AWSSDKUtils.RunProcessAsync - - - - - The exit code with which the process exited - - - - - The output of the process read till the end - - - - - The error output of the process read till the end - - - - - This class allows profiles supporting AWS credentials and SAML-based authentication to be registered with - the SDK so that they can later be reference by a profile name. The credential profiles will be available - for use in the AWS Toolkit for Visual Studio and the AWS Tools for Windows PowerShell. - - The credentials are stored under the current users AppData folder encrypted using Windows Data Protection API. - - - To reference a profile from an application's App.config or Web.config use the AWSProfileName setting. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="development"/> - </appSettings> - </configuration> - - - - - - - Registers an AWS credentials profile that can later be referenced by the profileName. - This profile will only be visible for the current user. - - Name given to the AWS credentials. - The AWS access key id - The AWS secret key - - - - - Registers a role-based profile to be used with SAML authentication. The profile contains - details of the role to be assumed when AWS credentials are requested based on the role and - a reference to a SAML endpoint profile containing details of the endpoint to be called to - authenticate the user. - - - If user identity information is not supplied then the identity of the logged-in user will - be used when authenticaton is performed against the endpoint referenced in the SAML endpoint - profile. If identity is provided, no password information is stored in the role profile and - the user must supply the password for the identity prior to authentication with the endpoint. - - - Name to be assigned to the profile - - The name assigned to the endpoint settings, previously saved with RegisterSAMLEndpoint. - - - The arn of the role that the user wants to assume when using this profile. This - must be one of the set returned by the saml endpoint when the user authenticates. - - - Optional. By default the identity of the logged-in user will be used when authentication - is performed - the user will not be prompted to supply a password. By supplying a custom - identity for this parameter, the user will be prompted to supply the password for the - identity prior to authentication. - - - - - - Registers a role-based profile to be used with SAML authentication. The profile contains - details of the role to be assumed when AWS credentials are requested based on the role and - a reference to a SAML endpoint profile containing details of the endpoint to be called to - authenticate the user. - - - If user identity information is not supplied then the identity of the logged-in user will - be used when authenticaton is performed against the endpoint referenced in the SAML endpoint - profile. If identity is provided, no password information is stored in the role profile and - the user must supply the password for the identity prior to authentication with the endpoint. - - - Name to be assigned to the profile - - The name assigned to the endpoint settings, previously saved with RegisterSAMLEndpoint. - - - The arn of the role that the user wants to assume when using this profile. This - must be one of the set returned by the saml endpoint when the user authenticates. - - - Optional. By default the identity of the logged-in user will be used when authentication - is performed - the user will not be prompted to supply a password. By supplying a custom - identity for this parameter, the user will be prompted to supply the password for the - identity prior to authentication. - - - Set for profiles intended to be used in regions where a region-specific STS endpoint - must be used (eg cn-north-1). If left empty/null, the global sts.amazonaws.com endpoint - will be used when credentials are obtained for this profile. - - - - - Registers an endpoint to be used in conjunction with SAML role profiles. The role profiles - reference the endpoint settings to obtain the actual endpoint and any customization settings - needed to perform authentication. - - Name to be assigned to the endpoint settings. - The full uri of the authentication endpoint. - - The authentication type to use when performing calls against the endpoint. Valid values are 'NTLM', - 'Digest', 'Kerberos' and 'Negotiate'. The default if not configured (null/empty string) is 'Kerberos'. - - The unique id assigned to the new settings. - - - - Deletes the settings for an AWS credentials or SAML role profile from the SDK account store. - - The name of the profile to remove. - - - - Lists all profile names registered with the SDK account store. - - The profile names. - - - - Loads and returns all available credential profiles registered in the store. - - Collection of profiles. - - - - Checks if a given profile is known in the SDK credential store. - - The name of the profile to test for existence - True if the profile exists. - - - - Copies the contents of the source profile to the destination. If the destination - profile does not exist a new profile is created. Note that if the destination - profile exists, all keys it contains are removed and replaced with keys from the - source profile. - - The name of the profile to copy from. - The name of the profile to create or update. - The unique id assigned to the destination settings. - - - - Copies the contents of the source profile to the destination. If the destination - profile does not exist a new profile is created. Note that if the destination - profile exists, all keys it contains are removed and replaced with keys from the - source profile. - - The source profile to copy keys and values from. - The name of the profile to create or update. - The unique id assigned to the destination settings. - - - - Tries to get the AWS credentials from a profile in the SDK account store. - - The profile to get the credentials for. - Outputs the credentials for the profile. - Returns true if the profile exists otherwise false is returned. - - - - Gets the AWS credentials from a profile in the SDK account store. - - The profile to get the credentials for. - The AWS credentials for the profile. - Thrown if the profile does not exist - - - - Returns the profile with the specified name, if it has been registered in the SDK store. - - The name of the registered profile - The loaded profile data - - - - Returns the persisted data in the SDK store as a profile of the specified type T. - - The name of the profile holding the settings. - The loaded profile. An exception is thrown if the profile could not be loaded. - Thrown if the profile does not exist - - Currently supported profile types: AWSCredentialsProfile and SAMLRoleProfile. - - - - - Tries to load the specified profile data corresponding to profile type T from a named - profile in the SDK account store. - - The name of the profile holding the settings. - The loaded profile data. - Returns true if the profile exists otherwise false is returned. - - Currently supported profile types: AWSCredentialsProfile and SAMLRoleProfile. - - - - - Attempts to load the settings defining a SAML endpoint. - - The name assigned to the settings for the endpoint. - The instantiated endpoint. - True if the settings were successfully loaded. - - - - Loads the settings defining a SAML endpoint. - - The name assigned to the settings for the endpoint. - The loaded settings. An exception is thrown if they could not be loaded. - Thrown if the endpoint settings do not exist. - - - - Common base contract for all types of credential and role profiles. - - - - - The user-defined name for the settings. - - - - - The unique id of the profile in the backing store. - - - - - Saves the profile data to backing store, returning the unique id - assigned to the data. - - - - - The persisted data for a set of AWS credentials. At a minimum this - is access key and secret key data. - - - - - Tests if an AWSCredentialsProfile instance could be instantiated from - the persisted settings data. - - The name given to the persisted settings (previously verified as existing). - True if the settings are compatible with an AWSCredentialsProfile type. - - - - Tests if an AWSCredentialsProfile instance could be instantiated from - the persisted settings data. - - The persisted settings. - True if the settings are compatible with an AWSCredentialsProfile type. - - - - Instantiates an AWSCredentialsProfile instance from the specified profile name. - - The name of the profile holding the settings. - New credentials profile instance. An exception is thrown if the profile data is invalid. - - - - Instantiates an AWSCredentialsProfile instance from the supplied settings collection. - - The settings representing the stored profile. - New credentials profile instance. An exception is thrown if the profile data is invalid. - - - - Validates the contents of the specified profile. - - The name of the AWS credentials profile to validate. - Thrown if the profile settings fail to validate. - - - - Verifies that the persisted settings contains the minimal viable data to - instantiate an AWSCredentialsProfile instance. - - The persisted settings. - Thrown if the profile settings fail to validate. - - - - Persists the profile data to the store file. - - The unique ID assigned to the settings. - - - - Creates or updates the profile data in the store file. - - The unique ID assigned to the settings. - - - - The persisted data for a SAML endpoint. One or more role profiles - will reference this to obtain the common endpoint and other data needed - to perform authentication with a set of user credentials. - - - - - The default authentication type to use when attempting to perform an - authentication call against the configured endpoint. - - - - - The authentication endpoint which must be a HTTPS scheme. - - - - - The authentication type to use when calling the endpoint. - - - - - Tests if a SAMLEndpointSettings instance could be instantiated from - the persisted settings data. - - The name given to the persisted settings. - True if the settings are compatible. - - - - Tests if a SAMLEndpointSettings instance could be instantiated from - the persisted settings data. - - The persisted settings. - True if the settings are compatible. - - - - Instantiates an instance from settings stored with the specified name. - - The name of the endpoint settings in the store. - Profile instance or an exception if the profile data does not exist/contains invalid data. - - - - Instantiates an instance from the supplied settings. - - The persisted settings. - Profile instance or an exception if the profile data is invalid. - - - - Validates the contents of the specified endpoint settings. - - The name of the SAML endpoint settings to validate. - Thrown if the settings fail to validate. - - - - Verifies that the persisted settings contains the minimal viable data to - instantiate a SAMLEndpointSettings instance. - - The persisted settings. - Thrown if the settings fail to validate. - - - - Persists the settings to the storage file. - - The unique id assigned to the profile - - - - Creates or updates the settings data for a SAML endpoint in the backing store file. An error is - thrown if the scheme for the endpoint is not https. - - The name of the settings to create or update - The authentication endpoint - Optional authentication type to use when performing calls against the endpoint - The unique id assigned to the profile - - - - Constructs an endpoint settings instance. - - The user-defined name to assign to the settings. - - The absolute uri, including any query and relyingParty data, of the endpoint. - - - The authentication type to use when performing requests against the endpoint. - - - - - - The persisted data for a saml role profile for a user. This profile - references an endpoint profile containing the actual endpoint to be used, and - adds details of the role to be assumed when the profile is selected. - - - Optionally the profile can store a username and domain to be used during - authentication (default behavior, if this is not specified, is to use the user's - default network credentials). - - - - - - The ARN of the role that is to be assumed. - - - - - If non-default network credentials are to used contains - the user identity (in domain\user format, domain optional) that - should be used to supply credentials when the profile is used in - authentication. The user must be prompted to supply the - corresponding password prior to authentication. - - - - - If a specific user identity was specified in the profile, - returns true to indicate a password needs to be obtained from - the user before obtaining network credentials to be used on - authentication. The default is to use the credentials - associated with the currently logged-in user or process to - perform authentication, which does not require the user to be - prompted. - - - - - - For regions with a region-specific endpoint for STS (eg cn-north-1) this - field can be set to ensure calls to obtain temporary credentials - after successful authentication are forwarded to the correct regional - endpoint. - - - This field does not need to be set when running in a region for - which the sts.amazonaws.com endpoint is valid. - - - - - - Retrieves the active credential session, if any, associated with the - role profile. - - - The current credentials valid for the role specified in the profile. Returns - null if no active session is available, or the active session has expired. - - - When a user successfully authenticates and receives temporary AWS - credentials for a role, the profile is updated with details of the - session. When the profile is loaded by other processes or tools, if - session data is present and still valid it can be retrieved using this - method avoiding the need to re-authenticate and get additional temporary - credentials. - - - - - Persists the current credentials to a 'session' key in the RoleSessions.json file. - This enables external applications and tools using the same profile to obtain credentials - without needing to separately re-authenticate the user prior to expiry of the current - credentials. After persisting the session data it can be retrieved using GetCurrentSession(). - - - Although the credentials are temporary we still encrypt the stored data when at rest in - the sdk credential store. - - - The current credentials valid for the role specified in the profile. - - - - - Stores or clears the persisted session data. - - - - - - The endpoint settings from which the actual endpoint to use in authentication - is obtained. - - - - - Tests if a SAMLRoleProfile instance could be instantiated from - the persisted settings data. - - The name given to the persisted settings. - True if the settings are compatible with a SAMLRoleProfile type. - - - - Tests if a SAMLRoleProfile instance could be instantiated from - the persisted settings data. - - The persisted settings. - True if the settings are compatible with a SAMLRoleProfile type. - - - - Instantiates an instance from settings stored with the specified name. - - The name of the endpoint profile. - Profile instance or an exception if the profile data does not exist/contains invalid data. - - - - Instantiates an instance from the supplied settings. In addition to the profile settings - the SDK will inspect for a RoleSessions.json file containing active session data and if - an entry for the profile is present, will add the session data to the returned profile - object. - - The persisted settings. - Profile instance or an exception if the profile data is invalid. - - - - Validates the contents of the specified profile. - - The name of the SAML role profile to validate. - Thrown if the profile settings fail to validate. - - - - Validates that the presented settings would result in a valid role profile - instance. - - The persisted settings. - Thrown if the profile settings fail to validate. - - - - Stores the data in the role profile to the backing store file. - - - - - - Registers a role-based profile to be used with SAML authentication. The profile contains - details of the role to be assumed when AWS credentials are requested based on the role and - a reference to a SAML endpoint profile containing details of the endpoint to be called to - authenticate the user. - - - If user identity information is not supplied then the identity of the logged-in user will - be used when authenticaton is performed against the endpoint referenced in the SAML endpoint - profile. If identity is provided, no password information is stored in the role profile and - the user must supply the password for the identity prior to authentication with the endpoint. - - - Name to be assigned to the profile - - The name of the settings in the SAML endpoints file containing details of the - endpoint to authenticate with. - - - The arn of the role that the user wants to assume when using this profile. This - must be one of the set returned by the saml endpoint when the user authenticates. - - - Optional, can be used to prompt the user for a password for the account when authentication - is performed from a system that is not domain-joined. - - - Optional, details of the currently active credentials for the role that we want to - persist into the profile for other tools or processes to pick up, avoiding the need - to continually re-authenticate the user as they switch between tools. The active session, - if any, is stored separately from the profile using the file RoleSessions.json. - - - Set for profiles intended to be used in regions where a region-specific STS endpoint - must be used (eg cn-north-1). If left empty/null, the global sts.amazonaws.com endpoint - will be used when credentials are obtained for this profile. - - The unique id assigned to the profile. - - - - Tests for and loads any active session credentials for the specified profile. The session data - exists in a separate file from the profile, RoleSessions.json. - - - - - - - Stores the supplied session data into the RoleSessions.json backing file. - - - - - - - Constructs a profile data instance that will use the specified network identity - during authentication with configured endpoint. - - The user-defined name of the profile that sourced this data. - The settings for the authentication endpoint. - The role that should be assumed on successful authentication. - The credentials to supply in authentication, in domain\user format. - - Deserialized credential data from the profile, if still valid. Null if the profile does not - contain any active credentials, or the credentials it did hold are now invalid. - - - Set for profiles intended to be used in regions where a region-specific STS endpoint - must be used (eg cn-north-1). If left empty/null, the global sts.amazonaws.com endpoint - will be used when credentials are obtained for this profile. - - - - - Object to track circular references in nested types. - At each level of nesting, make a call to Track to retrieve Tracker, - a tracking object implementing the IDisposable interface. - Dispose of this tracker when leaving the context of the tracked object. - - - - - Tracker. Must be disposed. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Adds the current target to a reference list and returns a tracker. - The tracker removes the target from the reference list when the - tracker is disposed. - - - - - - - AwsHttpClient is a wrapper around HttpClient class of the System.Net.Http library. - The wrapper has been added so as to remove System.Net.Http dependencies from the Services - and migrate it to a Core level dependecy only. This avoids version clashes when a service - and the Core depends on different versions of the System.Net.Http library. This is a Service - level utility method - - - - - AWSHttpClient wrapper that is wrapped around - HttpClient default wrapper. - - - - - AWSHttpClient BaseAddress property that is wrapper for - HttpClient BaseAddress property. - - - - - AWSHttpClient Timeout property that is wrapper for - HttpClient Timeout property. - - - - - AWSHttpClient MaxResponseContentBufferSize property that is wrapper for - HttpClient MaxResponseContentBufferSize property. - - - - - AWSHttpClient GetStreamAsync that accepts the requester's URI - and make a HttpClient.GetStreamAsync call. - - Requester Uri - - - - Wrapper method that accepts a request uri, stream content and headers and makes a sendAsync call. - - - - - - - Wrapper for HttpClient's HttpRequestMessage and SendAsync methods. - - - - Returns response headers information- header name,value and status code - - - - Wrapper for HttpClient Dispose. - - - - - Method that checks if the passed exception is of type - HttpRequestException - - - - - - - AWSStreamContent is a wrapper for StreamContent class in - the System.Net.Http library.The wrapper has been added so as to - remove System.Net.Http dependencies from the Services - and migrate it to a Core level dependecy only. This avoids version clashes when a service - and the Core depends on different versions of the System.Net.Http library. This is a Service - level utility method - - - - - Wrapper for StreamContent constructor - for stream content - - - - - - Wrapper for StreamContent constructor - for stream content and bufferSize - - - - - - - Wrapper to allow Services to remove StreamContent Headers - - - - - - - Wrapper to allow Services to add StreamContent Headers - - - - - - - Wrapper for StreamContent Dispose. - - - - - Utility class to parse Amazon resource names more commonly known as an ARN. - - - - - Gets and sets the partition associated with the ARN (e.g.: 'aws'). - - - - - Gets and sets the AWS service associated with the ARN (e.g.: 's3'). - - - - - Gets and sets the region associated with the ARN (e.g.: 'us-east-1'). - - - - - Gets and sets the account ID associated with the ARN. - - - - - Gets and sets the resource associated with the ARN (e.g.: 'mybucket/myobject'). - - - - - Returns true if the string appears to be an ARN by seeing if the string starts with "arn:". This method - doesn't guarantee the string is a valid ARN. To validate the string call TryParse. - - - - - - - Parses the string into an ARN object. - - String to parse into an ARN. - The out parameter for the ARN object created by TryParse. - True if the string can be parsed into an ARN object. - - - - Parses the string into an ARN object. - - String to parse into an Arn. - The Arn object created from the passed in string. - Thrown if arnString is null. - Thrown if the string passed in not valid ARN. - - - - Turns the Arn object into a string representation of an ARN. - - - - - - Configuration options that apply to the entire SDK. - - These settings can be configured through app.config or web.config. - Below is a full sample configuration that illustrates all the possible options. - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws region="us-west-2"> - <logging logTo="Log4Net, SystemDiagnostics" logResponses="Always" logMetrics="true" /> - <s3 useSignatureVersion4="true" /> - <proxy host="localhost" port="8888" username="1" password="1" /> - - <dynamoDB> - <dynamoDBContext tableNamePrefix="Prod-"> - - <tableAliases> - <alias fromTable="FakeTable" toTable="People" /> - <alias fromTable="Persons" toTable="People" /> - </tableAliases> - - <mappings> - <map type="Sample.Tests.Author, SampleDLL" targetTable="People" /> - <map type="Sample.Tests.Editor, SampleDLL" targetTable="People"> - <property name="FullName" attribute="Name" /> - <property name="EmployeeId" attribute="Id" /> - <property name="ComplexData" converter="Sample.Tests.ComplexDataConverter, SampleDLL" /> - <property name="Version" version="true" /> - <property name="Password" ignore="true" /> - </map> - </mappings> - - </dynamoDBContext> - </dynamoDB> - </aws> - - - - Configuration options that apply to the entire SDK. - - - - - Manual offset to apply to client clock. This is a global setting that overrides - ClockOffset value calculated for all service endpoints. - - - - - Determines if the SDK should correct for client clock skew - by determining the correct server time and reissuing the - request with the correct time. - Default value of this field is True. - will be updated with the calculated - offset even if this field is set to false, though requests - will not be corrected or retried. - Ignored if is set. - - - - - The calculated clock skew correction, if there is one. - This field will be set if a service call resulted in an exception - and the SDK has determined that there is a difference between local - and server times. - - If is set to true, this - value will be set to the correction, but it will not be used by the - SDK and clock skew errors will not be retried. - - - - - Key for the AWSRegion property. - - - - - - Configures the default AWS region for clients which have not explicitly specified a region. - Changes to this setting will only take effect for newly constructed instances of AWS clients. - - This setting can be configured through the App.config. For example: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws region="us-west-2" /> - - - - - - Key for the AWSProfileName property. - - - - - - Profile name for stored AWS credentials that will be used to make service calls. - Changes to this setting will only take effect in newly-constructed clients. - - To reference the account from an application's App.config or Web.config use the AWSProfileName setting. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="development"/> - </appSettings> - </configuration> - - - - - - - Key for the AWSProfilesLocation property. - - - - - - Location of the credentials file shared with other AWS SDKs. - By default, the credentials file is stored in the .aws directory in the current user's home directory. - - Changes to this setting will only take effect in newly-constructed clients. - - To reference the profile from an application's App.config or Web.config use the AWSProfileName setting. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfilesLocation" value="c:\config"/> - </appSettings> - </configuration> - - - - - - - Key for the Logging property. - - - - - - Configures how the SDK should log events, if at all. - Changes to this setting will only take effect in newly-constructed clients. - - The setting can be configured through App.config, for example: - - <appSettings> - <add key="AWSLogging" value="log4net"/> - </appSettings> - - - - - - Key for the ResponseLogging property. - - - - - - - Configures when the SDK should log service responses. - Changes to this setting will take effect immediately. - - The setting can be configured through App.config, for example: - - <appSettings> - <add key="AWSResponseLogging" value="OnError"/> - </appSettings> - - - - - - Key for the LogMetrics property. - - - - - - Configures if the SDK should log performance metrics. - This setting configures the default LogMetrics property for all clients/configs. - Changes to this setting will only take effect in newly-constructed clients. - - The setting can be configured through App.config, for example: - - <appSettings> - <add key="AWSLogMetrics" value="true"/> - </appSettings> - - - - - - Key for the EndpointDefinition property. - - - - - - Configures if the SDK should use a custom configuration file that defines the regions and endpoints. - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws endpointDefinition="c:\config\endpoints.json" /> - - - - - - Key for the UseSdkCache property. - - - - - - Configures if the SDK Cache should be used, the default value is true. - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws useSdkCache="true" /> - - - - - - Configuration for the Logging section of AWS configuration. - Changes to some settings may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws> - <logging logTo="Log4Net, SystemDiagnostics" logResponses="Always" logMetrics="true" /> - </aws> - - - - - - Configuration for the Proxy section of AWS configuration. - Changes to some settings may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws> - <proxy host="localhost" port="8888" username="1" password="1" bypassList="addressexpr1;addressexpr2;..." bypassOnLocal="true" /> - </aws> - - - - - - Configuration for the region endpoint section of AWS configuration. - Changes may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws region="us-west-2" /> - - - - - - Lock for SomeEvent delegate access. - - - - - This method should never be called directly. - Call AWSSDKUtils.CorrectedUtcNow instead. - - - - - - Add a listener for SDK logging. - - If the listener does not have a name, you will not be able to remove it later. - The source to log for, e.g. "Amazon", or "Amazon.DynamoDB". - The listener to add. - - - - Remove a trace listener from SDK logging. - - The source the listener was added to. - The name of the listener. - - - - Logging options. - Can be combined to enable multiple loggers. - - - - - No logging - - - - - Log using log4net - - - - - Log using System.Diagnostics - - - - - Log to the console - - - - - Response logging option. - - - - - Never log service response - - - - - Only log service response when there's an error - - - - - Always log service response - - - - - Format for metrics data in the logs - - - - - Emit metrics in human-readable format - - - - - Emit metrics as JSON data - - - - - Allows to configure the proxy used for HTTP requests. The default value is null. - - - - - This class contains the endpoints available to the AWS clients. The static constants representing the - regions can be used while constructing the AWS client instead of looking up the exact endpoint URL. - - - - - Gets the endpoint for a service in a region. - - The services system name. - If true returns the endpoint for dualstack - Thrown when the request service does not have a valid endpoint in the region. - - - - - Enumerate through all the regions. - - - - - Gets the region based on its system name like "us-west-1" - - The system name of the service like "us-west-1" - - - - - This is a testing method and should not be called by production applications. - - - - - Gets the system name of a region. - - - - - Gets the display name of a region. - - - - - This region name is non-standard. Search the whole endpoints.json file to - determine the partition this region is in. - - - - - This class contains region information used to lazily compute the service endpoints. The static constants representing the - regions can be used while constructing the AWS client instead of looking up the exact endpoint URL. - - - - - The US East (Virginia) endpoint. - - - - - The US East (Virginia) regional endpoint. - - - - - The US East (Ohio) endpoint. - - - - - The US West (N. California) endpoint. - - - - - The US West (Oregon) endpoint. - - - - - The EU North (Stockholm) endpoint. - - - - - The EU West (Ireland) endpoint. - - - - - The EU West (London) endpoint. - - - - - The EU West (Paris) endpoint. - - - - - The EU Central (Frankfurt) endpoint. - - - - - The Asia Pacific (Hong Kong) endpoint. - - - - - The Asia Pacific (Tokyo) endpoint. - - - - - The Asia Pacific (Seoul) endpoint. - - - - - The Asia Pacific (Osaka-Local) endpoint. - - - - - The Asia Pacific (Mumbai) endpoint. - - - - - The Asia Pacific (Singapore) endpoint. - - - - - The Asia Pacific (Sydney) endpoint. - - - - - The South America (Sao Paulo) endpoint. - - - - - The US GovCloud East (Virginia) endpoint. - - - - - The US GovCloud West (Oregon) endpoint. - - - - - The China (Beijing) endpoint. - - - - - The China (Ningxia) endpoint. - - - - - The Canada (Central) endpoint. - - - - - The Middle East (Bahrain) endpoint. - - - - - Represents the endpoint overridding rules in the endpoints.json - Is used to map private region (ie us-east-1-regional) to public regions (us-east-1) - For signing purposes. - - - - - Enumerate through all the regions. - - - - - Gets the region based on its system name like "us-west-1" - - The system name of the service like "us-west-1" - - - - - Gets the region endpoint override if exists - - The region endpoint to find the possible override for - - - - - Gets the system name of a region. - - - - - Gets the display name of a region. - - - - - Gets the partition name the region is in. For example for us-east-1 the partition name is aws. For cn-northwest-1 the partition name is aws-cn. - - - - - Gets the dns suffix for the region endpoints in a partition. For example the aws partition's suffix is amazonaws.com. The aws-cn partition's suffix is amazonaws.com.cn. - - - - - Gets the endpoint for a service in a region. - - - The services system name. Service system names can be obtained from the - RegionEndpointServiceName member of the ClientConfig-derived class for the service. - - - For forwards compatibility, if the service being requested for isn't known in the region, this method - will generate an endpoint using the AWS endpoint heuristics. In this case, it is not guaranteed the - endpoint will point to a valid service endpoint. - - - - - - Gets the endpoint for a service in a region, optionally selecting a dualstack compatible endpoint. - - - The services system name. Service system names can be obtained from the - RegionEndpointServiceName member of the ClientConfig-derived class for the service. - - - If true a dualstack endpoint is returned. It is the user's responsibility to verify that the given service - supports a dualstack endpoint for the region. - - - For forwards compatibility, if the service being requested for isn't known in the region, this method - will generate an endpoint using the AWS endpoint heuristics. In this case, it is not guaranteed the - endpoint will point to a valid service endpoint. - - - - - - This class defines an endpoints hostname and which protocols it supports. - - - - - Gets the hostname for the service. - - - - - The authentication region to be used in request signing. - - - - - This property is only set for S3 endpoints. For all other services this property returns null. - For S3 endpoints, if the endpoint supports signature version 2 this property will be "2", otherwise it will be "4". - - - - a general purpose ASN.1 decoder - note: this class differs from the - others in that it returns null after it has read the last object in - the stream. If an ASN.1 Null is encountered a Der/BER Null object is - returned. - - - Create an ASN1InputStream where no DER object will be longer than limit. - - @param input stream containing ASN.1 encoded data. - @param limit maximum size of a DER encoded object. - - - Create an ASN1InputStream based on the input byte array. The length of DER objects in - the stream is automatically limited to the length of the input array. - - @param input array containing ASN.1 encoded data. - - - build an object given its tag and the number of bytes to construct it from. - - - Create a base ASN.1 object from a byte array. - The byte array to parse. - The base ASN.1 object represented by the byte array. - If there is a problem parsing the data. - - - Read a base ASN.1 object from a stream. - The stream to parse. - The base ASN.1 object represented by the byte array. - If there is a problem parsing the data. - - - return the object at the sequence position indicated by index. - - @param index the sequence number (starting at zero) of the object - @return the object at the sequence position indicated by index. - - - create an empty sequence - - - create a sequence containing one object - - - create a sequence containing a vector of objects. - - - - A - - - - - - A - - - A - - - - - - A - - - - - return a = a + b - b preserved. - - - unsigned comparison on two arrays - note the arrays may - start with leading zeros. - - - returns x = x - y - we assume x is >= y - - - - Calculates a 32bit Cyclic Redundancy Checksum (CRC) using the - same polynomial used by Zip. This type is used internally by DotNetZip; it is generally not used directly - by applications wishing to create, read, or manipulate zip archive files. - - - - - indicates the total number of bytes read on the CRC stream. - This is used when writing the ZipDirEntry when compressing files. - - - - - Indicates the current CRC for all blocks slurped in. - - - - - Returns the CRC32 for the specified stream. - - The stream over which to calculate the CRC32 - the CRC32 calculation - - - - Returns the CRC32 for the specified stream, and writes the input into the output stream. - - The stream over which to calculate the CRC32 - The stream into which to deflate the input - the CRC32 calculation - - - - Get the CRC32 for the given (word,byte) combo. - This is a computation defined by PKzip. - - The word to start with. - The byte to combine it with. - The CRC-ized result. - - - - Update the value for the running CRC32 using the given block of bytes. - This is useful when using the CRC32() class in a Stream. - - block of bytes to slurp - starting point in the block - how many bytes within the block to slurp - - - - A Stream that calculates a CRC32 (a checksum) on all bytes read, - or on all bytes written. - - - - - This class can be used to verify the CRC of a ZipEntry when reading from a stream, - or to calculate a CRC when writing to a stream. The stream should be used to either - read, or write, but not both. If you intermix reads and writes, the results are - not defined. - - This class is intended primarily for use internally by the DotNetZip library. - - - - - Gets the total number of bytes run through the CRC32 calculator. - - - - This is either the total number of bytes read, or the total number - of bytes written, depending on the direction of this stream. - - - - - The constructor. - - The underlying stream - - - - The constructor. - - The underlying stream - The length of the stream to slurp - - - - Provides the current CRC for all blocks slurped in. - - - - - Read from the stream - - the buffer to read - the offset at which to start - the number of bytes to read - the number of bytes actually read - - - - Write to the stream. - - the buffer from which to write - the offset at which to start writing - the number of bytes to write - - - - Indicates whether the stream supports reading. - - - - - Indicates whether the stream supports seeking. - - - - - Indicates whether the stream supports writing. - - - - - Flush the stream. - - - - - Not implemented. - - - - - Not implemented. - - - - - Not implemented. - - N/A - N/A - N/A - - - - Not implemented. - - N/A - - - diff --git a/packages/AWSSDK.Core.3.5.0-beta/tools/account-management.ps1 b/packages/AWSSDK.Core.3.5.0-beta/tools/account-management.ps1 deleted file mode 100644 index d74de22..0000000 --- a/packages/AWSSDK.Core.3.5.0-beta/tools/account-management.ps1 +++ /dev/null @@ -1,64 +0,0 @@ - -function RegisterProfile() -{ - $dllpath = "..\lib\net35\AWSSDK.Core.dll" - $sdkassembly = [System.Reflection.Assembly]::LoadFrom($dllpath) - - $completed = $FALSE - do - { - Write-Host "1) Add/Update new profile credentials" - Write-Host "2) List registered profiles" - Write-Host "3) Remove profile credentials" - Write-Host "4) Exit" - - Write-Host "" - $choose = Read-Host "Choose an option" - - If ($choose -eq "1") - { - $profileName = Read-Host "Profile name: " - $accessKey = Read-Host "Access key: " - $secretKey = Read-Host "Secret key: " - [Amazon.Util.ProfileManager]::RegisterProfile($profileName, $accessKey, $secretKey) - } - ElseIf($choose -eq "2") - { - Write-Host "" - - $profiles = [Amazon.Util.ProfileManager]::ListProfileNames() | sort - foreach($profile in $profiles) - { - Write-Host "*" $profile - } - Write-Host "" - } - ElseIf($choose -eq "3") - { - Write-Host "" - - $i = 1 - $profiles = [Amazon.Util.ProfileManager]::ListProfileNames() | sort - foreach($profile in $profiles) - { - Write-Host $i")" $profile - $i++ - } - Write-Host "" - $pick = Read-Host "Select a profile to unregister" - [Amazon.Util.ProfileManager]::UnregisterProfile($profiles[$pick - 1]) - } - ElseIf($choose -eq "4") - { - $completed = $TRUE - } - Else - { - Write-Host "" - Write-Host "Unknown choose" - Write-Host "" - } - }while($completed -ne $TRUE) -} - -RegisterProfile \ No newline at end of file diff --git a/packages/AWSSDK.S3.3.3.111.14/.signature.p7s b/packages/AWSSDK.S3.3.3.111.14/.signature.p7s deleted file mode 100644 index 90bd9fd..0000000 Binary files a/packages/AWSSDK.S3.3.3.111.14/.signature.p7s and /dev/null differ diff --git a/packages/AWSSDK.S3.3.3.111.14/AWSSDK.S3.3.3.111.14.nupkg b/packages/AWSSDK.S3.3.3.111.14/AWSSDK.S3.3.3.111.14.nupkg deleted file mode 100644 index 5037e09..0000000 Binary files a/packages/AWSSDK.S3.3.3.111.14/AWSSDK.S3.3.3.111.14.nupkg and /dev/null differ diff --git a/packages/AWSSDK.S3.3.3.111.14/analyzers/dotnet/cs/AWSSDK.S3.CodeAnalysis.dll b/packages/AWSSDK.S3.3.3.111.14/analyzers/dotnet/cs/AWSSDK.S3.CodeAnalysis.dll deleted file mode 100644 index 0c967aa..0000000 Binary files a/packages/AWSSDK.S3.3.3.111.14/analyzers/dotnet/cs/AWSSDK.S3.CodeAnalysis.dll and /dev/null differ diff --git a/packages/AWSSDK.S3.3.3.111.14/lib/MonoAndroid10/AWSSDK.S3.XML b/packages/AWSSDK.S3.3.3.111.14/lib/MonoAndroid10/AWSSDK.S3.XML deleted file mode 100644 index 389da7c..0000000 --- a/packages/AWSSDK.S3.3.3.111.14/lib/MonoAndroid10/AWSSDK.S3.XML +++ /dev/null @@ -1,28560 +0,0 @@ - - - - AWSSDK.S3 - - - - - Implementation for accessing S3 - - - - - - - Specialize the initialize of the client. - - - - - Create a signed URL allowing access to a resource that would - usually require authentication. - - - - When using query string authentication you create a query, - specify an expiration time for the query, sign it with your - signature, place the data in an HTTP request, and distribute - the request to a user or embed the request in a web page. - - - A PreSigned URL can be generated for GET, PUT, DELETE and HEAD - operations on your bucketName, keys, and versions. - - - The GetPreSignedUrlRequest that defines the - parameters of the operation. - determines if signing will fall back to SigV2 if the - signing region is us-east-1 - A string that is the signed http request. - - - - - - Marshalls the parameters for a presigned url for a preferred signing protocol. - - - - - - True if AWS4 signing will be used; if the expiry period in the request exceeds the - maximum allowed for AWS4 (one week), an ArgumentException is thrown. - - - - - - Create a signed URL allowing access to a resource that would - usually require authentication. - - - - When using query string authentication you create a query, - specify an expiration time for the query, sign it with your - signature, place the data in an HTTP request, and distribute - the request to a user or embed the request in a web page. - - - A PreSigned URL can be generated for GET, PUT, DELETE and HEAD - operations on your bucketName, keys, and versions. - - - The GetPreSignedUrlRequest that defines the - parameters of the operation. - A string that is the signed http request. - - - - - - Constructs AmazonS3Client with AWS Credentials - - AWS Credentials - - - - Constructs AmazonS3Client with AWS Credentials - - AWS Credentials - The region to connect. - - - - Constructs AmazonS3Client with AWS Credentials and an - AmazonS3Client Configuration object. - - AWS Credentials - The AmazonS3Client Configuration Object - - - - Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - - - - Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - The region to connect. - - - - Constructs AmazonS3Client with AWS Access Key ID, AWS Secret Key and an - AmazonS3Client Configuration object. - - AWS Access Key ID - AWS Secret Access Key - The AmazonS3Client Configuration Object - - - - Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - - - - Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - The region to connect. - - - - Constructs AmazonS3Client with AWS Access Key ID, AWS Secret Key and an - AmazonS3Client Configuration object. - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - The AmazonS3Client Configuration Object - - - - Creates the signer for the service. - - - - - Customizes the runtime pipeline. - - Runtime pipeline for the current client. - - - - Capture metadata for the service. - - - - - Disposes the service client. - - - - - This operation aborts a multipart upload. After a multipart upload is aborted, no - additional parts can be uploaded using that upload ID. The storage consumed by any - previously uploaded parts will be freed. However, if any part uploads are currently - in progress, those part uploads might or might not succeed. As a result, it might - be necessary to abort a given multipart upload multiple times in order to completely - free all storage consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts operation and ensure that the parts - list is empty. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - The bucket name to which the upload was taking place. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object for which the multipart upload was initiated. - Upload ID that identifies the multipart upload. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AbortMultipartUpload service method, as returned by S3. - REST API Reference for AbortMultipartUpload Operation - - - - This operation aborts a multipart upload. After a multipart upload is aborted, no - additional parts can be uploaded using that upload ID. The storage consumed by any - previously uploaded parts will be freed. However, if any part uploads are currently - in progress, those part uploads might or might not succeed. As a result, it might - be necessary to abort a given multipart upload multiple times in order to completely - free all storage consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts operation and ensure that the parts - list is empty. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - Container for the necessary parameters to execute the AbortMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AbortMultipartUpload service method, as returned by S3. - REST API Reference for AbortMultipartUpload Operation - - - - Completes a multipart upload by assembling previously uploaded parts. - - - - You first initiate the multipart upload and then upload all parts using the UploadPart - operation. After successfully uploading all relevant parts of an upload, you call - this operation to complete the upload. Upon receiving this request, Amazon S3 concatenates - all the parts in ascending order by part number to create a new object. In the Complete - Multipart Upload request, you must provide the parts list. You must ensure that the - parts list is complete. This operation concatenates the parts that you provide in - the list. For each part in the list, you must provide the part number and the ETag - value, returned after that part was uploaded. - - - - Processing of a Complete Multipart Upload request could take several minutes to complete. - After Amazon S3 begins processing the request, it sends an HTTP response header that - specifies a 200 OK response. While processing is in progress, Amazon S3 periodically - sends white space characters to keep the connection from timing out. Because a request - could fail after the initial 200 OK response has been sent, it is important that you - check the response body to determine whether the request succeeded. - - - - Note that if CompleteMultipartUpload fails, applications should be prepared - to retry the failed requests. For more information, see Amazon - S3 Error Best Practices. - - - - For more information about multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - GetBucketLifecycle has the following special errors: - -
  • - - Error code: EntityTooSmall - -
    • - - Description: Your proposed upload is smaller than the minimum allowed object size. - Each part must be at least 5 MB in size, except the last part. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPart - -
    • - - Description: One or more of the specified parts could not be found. The part might - not have been uploaded, or the specified entity tag might not have matched the part's - entity tag. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPartOrder - -
    • - - Description: The list of parts was not in ascending order. The parts list must be - specified in order by part number. - -
    • - - 400 Bad Request - -
  • - - Error code: NoSuchUpload - -
    • - - Description: The specified multipart upload does not exist. The upload ID might be - invalid, or the multipart upload might have been aborted or completed. - -
    • - - 404 Not Found - -
- - The following operations are related to CompleteMultipartUpload: - - - - Container for the necessary parameters to execute the CompleteMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CompleteMultipartUpload service method, as returned by S3. - REST API Reference for CompleteMultipartUpload Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 Developer Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Encryption - - - - The source object that you are copying can be encrypted or unencrypted. The source - object can be encrypted with server-side encryption using AWS managed encryption keys - (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side - encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers - and decrypts the data when you access it. - - - - You can optionally use the appropriate encryption-related headers to request server-side - encryption for the target object. You have the option to provide your own encryption - key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that - was used to encrypt the source object. You can even request encryption if the source - object was not encrypted. For more information about server-side encryption, see Using - Server-Side Encryption. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject operation to change the storage class of an - object that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 Service Developer Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 Developer Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Encryption - - - - The source object that you are copying can be encrypted or unencrypted. The source - object can be encrypted with server-side encryption using AWS managed encryption keys - (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side - encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers - and decrypts the data when you access it. - - - - You can optionally use the appropriate encryption-related headers to request server-side - encryption for the target object. You have the option to provide your own encryption - key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that - was used to encrypt the source object. You can even request encryption if the source - object was not encrypted. For more information about server-side encryption, see Using - Server-Side Encryption. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject operation to change the storage class of an - object that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 Service Developer Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 Developer Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Encryption - - - - The source object that you are copying can be encrypted or unencrypted. The source - object can be encrypted with server-side encryption using AWS managed encryption keys - (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side - encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers - and decrypts the data when you access it. - - - - You can optionally use the appropriate encryption-related headers to request server-side - encryption for the target object. You have the option to provide your own encryption - key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that - was used to encrypt the source object. You can even request encryption if the source - object was not encrypted. For more information about server-side encryption, see Using - Server-Side Encryption. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject operation to change the storage class of an - object that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 Service Developer Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - Container for the necessary parameters to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - - - - - - Deletes an analytics configuration for the bucket (specified by the analytics configuration - ID). - - - - To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to DeleteBucketAnalyticsConfiguration: - -
  • - - - -
  • - - - -
  • - - - -
- - Container for the necessary parameters to execute the DeleteBucketAnalyticsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketAnalyticsConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketAnalyticsConfiguration Operation - - - - - Deletes an inventory configuration (identified by the inventory ID) from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - Operations related to DeleteBucketInventoryConfiguration include: - - - - Container for the necessary parameters to execute the DeleteBucketInventoryConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketInventoryConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketInventoryConfiguration Operation - - - - Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified - by the metrics configuration ID) from the bucket. Note that this doesn't include the - daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketMetricsConfiguration Operation - - - - This implementation of the DELETE operation uses the policy subresource to delete - the policy of a specified bucket. If you are using an identity other than the root - user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - The bucket name. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketPolicy service method, as returned by S3. - REST API Reference for DeleteBucketPolicy Operation - - - - This implementation of the DELETE operation uses the policy subresource to delete - the policy of a specified bucket. If you are using an identity other than the root - user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - Container for the necessary parameters to execute the DeleteBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketPolicy service method, as returned by S3. - REST API Reference for DeleteBucketPolicy Operation - - - - Deletes the replication configuration from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutReplicationConfiguration - action. The bucket owner has these permissions by default and can grant it to others. - For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - It can take a while for the deletion of a replication configuration to fully propagate. - - - - For information about replication configuration, see Replication - in the Amazon S3 Developer Guide. - - - - The following operations are related to DeleteBucketReplication: - - - - Container for the necessary parameters to execute the DeleteBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketReplication service method, as returned by S3. - REST API Reference for DeleteBucketReplication Operation - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - The bucket that has the tag set to be removed. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketTagging service method, as returned by S3. - REST API Reference for DeleteBucketTagging Operation - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - Container for the necessary parameters to execute the DeleteBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketTagging service method, as returned by S3. - REST API Reference for DeleteBucketTagging Operation - - - - This operation removes the website configuration for a bucket. Amazon S3 returns a - 200 OK response upon successfully deleting a website configuration on - the specified bucket. You will get a 200 OK response if the website configuration - you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE operation requires the S3:DeleteBucketWebsite permission. - By default, only the bucket owner can delete the website configuration attached to - a bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which you want to remove the website configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketWebsite service method, as returned by S3. - REST API Reference for DeleteBucketWebsite Operation - - - - This operation removes the website configuration for a bucket. Amazon S3 returns a - 200 OK response upon successfully deleting a website configuration on - the specified bucket. You will get a 200 OK response if the website configuration - you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE operation requires the S3:DeleteBucketWebsite permission. - By default, only the bucket owner can delete the website configuration attached to - a bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the DeleteBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketWebsite service method, as returned by S3. - REST API Reference for DeleteBucketWebsite Operation - - - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - The bucket name of the lifecycle to delete. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - REST API Reference for DeleteLifecycleConfiguration Operation - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - Container for the necessary parameters to execute the DeleteLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - REST API Reference for DeleteLifecycleConfiguration Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key name of the object to delete. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key name of the object to delete. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - Container for the necessary parameters to execute the DeleteObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - This operation enables you to delete multiple objects from a bucket using a single - HTTP request. If you know the object keys that you want to delete, then this operation - provides a suitable alternative to sending individual delete requests, reducing per-request - overhead. - - - - The request contains a list of up to 1000 keys that you want to delete. In the XML, - you provide the object key names, and optionally, version IDs if you want to delete - a specific version of the object from a versioning-enabled bucket. For each key, Amazon - S3 performs a delete operation and returns the result of that delete, success, or - failure, in the response. Note that if the object specified in the request is not - found, Amazon S3 returns the result as deleted. - - - - The operation supports two modes for the response: verbose and quiet. By default, - the operation uses verbose mode in which the response includes the result of deletion - of each key in your request. In quiet mode the response includes only keys where the - delete operation encountered an error. For a successful deletion, the operation does - not return any information about the delete in the response body. - - - - When performing this operation on an MFA Delete enabled bucket, that attempts to delete - any versioned objects, you must include an MFA token. If you do not provide one, the - entire request will fail, even if there are non-versioned objects you are trying to - delete. If you provide an invalid token, whether there are versioned keys in the request - or not, the entire Multi-Object Delete request will fail. For information about MFA - Delete, see - MFA Delete. - - - - Finally, the Content-MD5 header is required for all Multi-Object Delete requests. - Amazon S3 uses the header value to ensure that your request body has not been altered - in transit. - - - - The following operations are related to DeleteObjects: - - - - Container for the necessary parameters to execute the DeleteObjects service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObjects service method, as returned by S3. - REST API Reference for DeleteObjects Operation - - - - Removes the entire tag set from the specified object. For more information about managing - object tags, see - Object Tagging. - - - - To use this operation, you must have permission to perform the s3:DeleteObjectTagging - action. - - - - To delete tags of a specific object version, add the versionId query - parameter in the request. You will need permission for the s3:DeleteObjectVersionTagging - action. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteObjectTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObjectTagging service method, as returned by S3. - REST API Reference for DeleteObjectTagging Operation - - - - Removes the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:PutBucketPublicAccessBlock - permission. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to DeletePublicAccessBlock: - - - - Container for the necessary parameters to execute the DeletePublicAccessBlock service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeletePublicAccessBlock service method, as returned by S3. - REST API Reference for DeletePublicAccessBlock Operation - - - - - - - - - Returns the default encryption configuration for an Amazon S3 bucket. For information - about the Amazon S3 default encryption feature, see Amazon - S3 Default Bucket Encryption. - - - - To use this operation, you must have permission to perform the s3:GetEncryptionConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to GetBucketEncryption: - - - - Container for the necessary parameters to execute the GetBucketEncryption service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketEncryption service method, as returned by S3. - REST API Reference for GetBucketEncryption Operation - - - - Returns an inventory configuration (identified by the inventory configuration ID) - from the bucket. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - The following operations are related to GetBucketInventoryConfiguration: - - - - Container for the necessary parameters to execute the GetBucketInventoryConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketInventoryConfiguration service method, as returned by S3. - REST API Reference for GetBucketInventoryConfiguration Operation - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - The name of the bucket for which to get the location. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLocation service method, as returned by S3. - REST API Reference for GetBucketLocation Operation - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - Container for the necessary parameters to execute the GetBucketLocation service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLocation service method, as returned by S3. - REST API Reference for GetBucketLocation Operation - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - The bucket name for which to get the logging information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLogging service method, as returned by S3. - REST API Reference for GetBucketLogging Operation - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - Container for the necessary parameters to execute the GetBucketLogging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLogging service method, as returned by S3. - REST API Reference for GetBucketLogging Operation - - - - Gets a metrics configuration (specified by the metrics configuration ID) from the - bucket. Note that this doesn't include the daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to GetBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the GetBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for GetBucketMetricsConfiguration Operation - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following operation is related to GetBucketNotification: - - - - Name of the bucket for which to get the notification configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketNotification service method, as returned by S3. - REST API Reference for GetBucketNotification Operation - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following operation is related to GetBucketNotification: - - - - Container for the necessary parameters to execute the GetBucketNotification service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketNotification service method, as returned by S3. - REST API Reference for GetBucketNotification Operation - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operation is related to GetBucketPolicy: - - - - The bucket name for which to get the bucket policy. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicy service method, as returned by S3. - REST API Reference for GetBucketPolicy Operation - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operation is related to GetBucketPolicy: - - - - Container for the necessary parameters to execute the GetBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicy service method, as returned by S3. - REST API Reference for GetBucketPolicy Operation - - - - Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket - is public. In order to use this operation, you must have the s3:GetBucketPolicyStatus - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - For more information about when Amazon S3 considers a bucket public, see The - Meaning of "Public". - - - - The following operations are related to GetBucketPolicyStatus: - - - - Container for the necessary parameters to execute the GetBucketPolicyStatus service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicyStatus service method, as returned by S3. - REST API Reference for GetBucketPolicyStatus Operation - - - - Retrieves the replication configuration for the given Amazon S3 bucket. - - Container for the necessary parameters to execute the GetBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketReplication service method, as returned by S3. - REST API Reference for GetBucketReplication Operation - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - The name of the bucket for which to get the payment request configuration - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketRequestPayment service method, as returned by S3. - REST API Reference for GetBucketRequestPayment Operation - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - Container for the necessary parameters to execute the GetBucketRequestPayment service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketRequestPayment service method, as returned by S3. - REST API Reference for GetBucketRequestPayment Operation - - - - Returns the tag set associated with the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - GetBucketTagging has the following special error: - -
  • - - Error code: NoSuchTagSetError - -
    • - - Description: There is no tag set associated with the bucket. - -
- - The following operations are related to GetBucketTagging: - - - - Container for the necessary parameters to execute the GetBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketTagging service method, as returned by S3. - REST API Reference for GetBucketTagging Operation - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - The name of the bucket for which to get the versioning information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketVersioning service method, as returned by S3. - REST API Reference for GetBucketVersioning Operation - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - Container for the necessary parameters to execute the GetBucketVersioning service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketVersioning service method, as returned by S3. - REST API Reference for GetBucketVersioning Operation - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET operation requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which to get the website configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketWebsite service method, as returned by S3. - REST API Reference for GetBucketWebsite Operation - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET operation requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the GetBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketWebsite service method, as returned by S3. - REST API Reference for GetBucketWebsite Operation - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - The bucket name for which to get the cors configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetCORSConfiguration service method, as returned by S3. - REST API Reference for GetCORSConfiguration Operation - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - Container for the necessary parameters to execute the GetCORSConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetCORSConfiguration service method, as returned by S3. - REST API Reference for GetCORSConfiguration Operation - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are still using previous version of the lifecycle configuration, it works. - For the earlier API description, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to GetBucketLifecycleConfiguration: - - - - The name of the bucket for which to get the lifecycle information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetLifecycleConfiguration service method, as returned by S3. - REST API Reference for GetLifecycleConfiguration Operation - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are still using previous version of the lifecycle configuration, it works. - For the earlier API description, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to GetBucketLifecycleConfiguration: - - - - Container for the necessary parameters to execute the GetLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetLifecycleConfiguration service method, as returned by S3. - REST API Reference for GetLifecycleConfiguration Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object to get. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object to get. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - Container for the necessary parameters to execute the GetObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Gets an object's current Legal Hold status. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLegalHold service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectLegalHold service method, as returned by S3. - REST API Reference for GetObjectLegalHold Operation - - - - Gets the Object Lock configuration for a bucket. The rule specified in the Object - Lock configuration will be applied by default to every new object placed in the specified - bucket. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLockConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectLockConfiguration service method, as returned by S3. - REST API Reference for GetObjectLockConfiguration Operation - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - The name of the bucket containing the object. - The object key. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - The name of the bucket containing the object. - The object key. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - Container for the necessary parameters to execute the GetObjectMetadata service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - Retrieves an object's retention settings. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectRetention service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectRetention service method, as returned by S3. - REST API Reference for GetObjectRetention Operation - - - - Returns the tag-set of an object. You send the GET request against the tagging subresource - associated with the object. - - - - To use this operation, you must have permission to perform the s3:GetObjectTagging - action. By default, the GET operation returns information about current version of - an object. For a versioned bucket, you can have multiple versions of an object in - your bucket. To retrieve tags of any other version, use the versionId query parameter. - You also need permission for the s3:GetObjectVersionTagging action. - - - - By default, the bucket owner has this permission and can grant this permission to - others. - - - - For information about the Amazon S3 object tagging feature, see Object - Tagging. - - - - The following operation is related to GetObjectTagging: - - - - Container for the necessary parameters to execute the GetObjectTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTagging service method, as returned by S3. - REST API Reference for GetObjectTagging Operation - - - - Return torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Amazon - S3 Torrent. - - - - You can get torrent only for objects that are less than 5 GB in size and that are - not encrypted using server-side encryption with customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - The following operation is related to GetObjectTorrent: - - - - The name of the bucket containing the object for which to get the torrent files. - The object key for which to get the information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTorrent service method, as returned by S3. - REST API Reference for GetObjectTorrent Operation - - - - Return torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Amazon - S3 Torrent. - - - - You can get torrent only for objects that are less than 5 GB in size and that are - not encrypted using server-side encryption with customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - The following operation is related to GetObjectTorrent: - - - - Container for the necessary parameters to execute the GetObjectTorrent service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTorrent service method, as returned by S3. - REST API Reference for GetObjectTorrent Operation - - - - Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:GetBucketPublicAccessBlock - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket - or an object, it checks the PublicAccessBlock configuration for both - the bucket (or the bucket that contains the object) and the bucket owner's account. - If the PublicAccessBlock settings are different between the bucket and - the account, Amazon S3 uses the most restrictive combination of the bucket-level and - account-level settings. - - - - For more information about when Amazon S3 considers a bucket or an object public, - see The - Meaning of "Public". - - - - The following operations are related to GetPublicAccessBlock: - - - - Container for the necessary parameters to execute the GetPublicAccessBlock service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetPublicAccessBlock service method, as returned by S3. - REST API Reference for GetPublicAccessBlock Operation - - - - This operation is useful to determine if a bucket exists and you have permission to - access it. The operation returns a 200 OK if the bucket exists and you - have permission to access it. Otherwise, the operation might return responses such - as 404 Not Found and 403 Forbidden. - - - - To use this operation, you must have permissions to perform the s3:ListBucket - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - Container for the necessary parameters to execute the HeadBucket service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the HeadBucket service method, as returned by S3. - REST API Reference for HeadBucket Operation - - - - This operation initiates a multipart upload and returns an upload ID. This upload - ID is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort operation - and Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload API and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart) and UploadPartCopy) requests must match the headers you - used in the request to initiate the upload by using CreateMultipartUpload. - - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, - kms:GenerateDataKey*, and kms:DescribeKey actions on the - key. These permissions are required because Amazon S3 must decrypt and read data from - the encrypted file parts before it completes the multipart upload. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - The following operations are related to CreateMultipartUpload: - - - - The name of the bucket to which to initiate the upload - Object key for which the multipart upload is to be initiated. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the InitiateMultipartUpload service method, as returned by S3. - REST API Reference for InitiateMultipartUpload Operation - - - - This operation initiates a multipart upload and returns an upload ID. This upload - ID is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort operation - and Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload API and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart) and UploadPartCopy) requests must match the headers you - used in the request to initiate the upload by using CreateMultipartUpload. - - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, - kms:GenerateDataKey*, and kms:DescribeKey actions on the - key. These permissions are required because Amazon S3 must decrypt and read data from - the encrypted file parts before it completes the multipart upload. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - The following operations are related to CreateMultipartUpload: - - - - Container for the necessary parameters to execute the InitiateMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the InitiateMultipartUpload service method, as returned by S3. - REST API Reference for InitiateMultipartUpload Operation - - - - Lists the analytics configurations for the bucket. You can have up to 1,000 analytics - configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. You should always check the IsTruncated element in the response. - If there are no more configurations to list, IsTruncated is set to false. - If there are more configurations to list, IsTruncated is set to true, - and there will be a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to ListBucketAnalyticsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketAnalyticsConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketAnalyticsConfigurations service method, as returned by S3. - REST API Reference for ListBucketAnalyticsConfigurations Operation - - - - Returns a list of inventory configurations for the bucket. You can have up to 1,000 - analytics configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory - - - - The following operations are related to ListBucketInventoryConfigurations: - - - - Container for the necessary parameters to execute the ListBucketInventoryConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketInventoryConfigurations service method, as returned by S3. - REST API Reference for ListBucketInventoryConfigurations Operation - - - - Lists the metrics configurations for the bucket. The metrics configurations are only - for the request metrics of the bucket and do not provide information on daily storage - metrics. You can have up to 1,000 configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For more information about metrics configurations and CloudWatch request metrics, - see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to ListBucketMetricsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketMetricsConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketMetricsConfigurations service method, as returned by S3. - REST API Reference for ListBucketMetricsConfigurations Operation - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBuckets service method, as returned by S3. - REST API Reference for ListBuckets Operation - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - Container for the necessary parameters to execute the ListBuckets service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBuckets service method, as returned by S3. - REST API Reference for ListBuckets Operation - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Container for the necessary parameters to execute the ListMultipartUploads service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. - Limits the response to keys that begin with the specified prefix. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - Container for the necessary parameters to execute the ListObjects service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Make sure to design - your application to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - To use this operation in an AWS Identity and Access Management (IAM) policy, you must - have permissions to perform the s3:ListBucket action. The bucket owner - has this permission by default and can grant this permission to others. For more information - about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - This section describes the latest revision of the API. We recommend that you use this - revised API for application development. For backward compatibility, Amazon S3 continues - to support the prior version of this API, ListObjects. - - - - To get a list of your buckets, see ListBuckets. - - - - The following operations are related to ListObjectsV2: - - - - Container for the necessary parameters to execute the ListObjectsV2 service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjectsV2 service method, as returned by S3. - REST API Reference for ListObjectsV2 Operation - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). This request returns a maximum of 1,000 - uploaded parts. The default number of parts returned is 1,000 parts. You can restrict - the number of parts returned by specifying the max-parts request parameter. - If your multipart upload consists of more than 1,000 parts, the response returns an - IsTruncated field with the value of true, and a NextPartNumberMarker - element. In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListParts: - - - - Name of the bucket to which the parts are being uploaded. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Object key for which the multipart upload was initiated. - Upload ID identifying the multipart upload whose parts are being listed. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListParts service method, as returned by S3. - REST API Reference for ListParts Operation - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). This request returns a maximum of 1,000 - uploaded parts. The default number of parts returned is 1,000 parts. You can restrict - the number of parts returned by specifying the max-parts request parameter. - If your multipart upload consists of more than 1,000 parts, the response returns an - IsTruncated field with the value of true, and a NextPartNumberMarker - element. In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListParts: - - - - Container for the necessary parameters to execute the ListParts service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListParts service method, as returned by S3. - REST API Reference for ListParts Operation - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - Container for the necessary parameters to execute the ListVersions service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - - Creates a new bucket. To create a bucket, you must register with Amazon S3 and have - a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed - to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information on bucket naming restrictions, - see Working - with Amazon S3 Buckets. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) - Region. For more information, see How - to Select a Region for Your Buckets. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - Hosting of Buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - The name of the bucket to create. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucket service method, as returned by S3. - REST API Reference for PutBucket Operation - - - - Creates a new bucket. To create a bucket, you must register with Amazon S3 and have - a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed - to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information on bucket naming restrictions, - see Working - with Amazon S3 Buckets. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) - Region. For more information, see How - to Select a Region for Your Buckets. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - Hosting of Buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - Container for the necessary parameters to execute the PutBucket service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucket service method, as returned by S3. - REST API Reference for PutBucket Operation - - - - Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration - is a bucket-level feature that enables you to perform faster data transfers to Amazon - S3. - - - - To use this operation, you must have permission to perform the s3:PutAccelerateConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The Transfer Acceleration state of a bucket can be set to one of the following two - values: - -
  • - - Enabled – Enables accelerated data transfers to the bucket. - -
  • - - Suspended – Disables accelerated data transfers to the bucket. - -
- - The GetBucketAccelerateConfiguration operation returns the transfer acceleration - state of a bucket. - - - - After setting the Transfer Acceleration state of a bucket to Enabled, it might take - up to thirty minutes before the data transfer rates to the bucket increase. - - - - The name of the bucket used for Transfer Acceleration must be DNS-compliant and must - not contain periods ("."). - - - - For more information about transfer acceleration, see Transfer - Acceleration. - - - - The following operations are related to PutBucketAccelerateConfiguration: - - - - Container for the necessary parameters to execute the PutBucketAccelerateConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketAccelerateConfiguration service method, as returned by S3. - REST API Reference for PutBucketAccelerateConfiguration Operation - - - - - - - Set the logging parameters for a bucket and to specify permissions for who can view - and modify the logging parameters. All logs are saved to buckets in the same AWS Region - as the source bucket. To set the logging status of a bucket, you must be the bucket - owner. - - - - The bucket owner is automatically granted FULL_CONTROL to all logs. You use the Grantee - request element to grant access to other people. The Permissions request - element specifies the kind of access the grantee has to the logs. - - - - Grantee Values - - - - You can specify the person (grantee) to whom you're assigning access rights (using - request elements) in the following ways: - -
  • - - By the person's ID: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> - </Grantee> - - - - DisplayName is optional and ignored in the request. - -
  • - - By Email address: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee> - - - - - The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl - request, appears as the CanonicalUser. - -
  • - - By URI: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee> - - -
- - To enable logging, you use LoggingEnabled and its children request elements. To disable - logging, you use an empty BucketLoggingStatus request element: - - - - <BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01" /> - - - - - For more information about server access logging, see Server - Access Logging. - - - - For more information about creating a bucket, see CreateBucket. For more information - about returning the logging status of a bucket, see GetBucketLogging. - - - - The following operations are related to PutBucketLogging: - - - - Container for the necessary parameters to execute the PutBucketLogging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketLogging service method, as returned by S3. - REST API Reference for PutBucketLogging Operation - - - - Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. - You can have up to 1,000 metrics configurations per bucket. If you're updating an - existing metrics configuration, note that this is a full replacement of the existing - metrics configuration. If you don't include the elements you want to keep, they are - erased. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to PutBucketMetricsConfiguration: - - - - GetBucketLifecycle has the following special error: - -
  • - - Error code: TooManyConfigurations - -
    • - - Description: You are attempting to create a new configuration but have already reached - the 1,000-configuration limit. - -
    • - - HTTP Status Code: HTTP 400 Bad Request - -
- - Container for the necessary parameters to execute the PutBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for PutBucketMetricsConfiguration Operation - - - - Enables notifications of specified events for a bucket. For more information about - event notifications, see Configuring - Event Notifications. - - - - Using this API, you can replace an existing notification configuration. The configuration - is an XML file that defines the event types that you want Amazon S3 to publish and - the destination where you want Amazon S3 to publish an event notification when it - detects an event of the specified type. - - - - By default, your bucket has no event notifications configured. That is, the notification - configuration will be an empty NotificationConfiguration. - - - - <NotificationConfiguration> - - - - </NotificationConfiguration> - - - - This operation replaces the existing notification configuration with the configuration - you include in the request body. - - - - After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification - Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, - and that the bucket owner has permission to publish to it by sending a test notification. - In the case of AWS Lambda destinations, Amazon S3 verifies that the Lambda function - permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. - For more information, see Configuring - Notifications for Amazon S3 Events. - - - - You can disable notifications by adding the empty NotificationConfiguration element. - - - - By default, only the bucket owner can configure notifications on a bucket. However, - bucket owners can use a bucket policy to grant permission to other users to set this - configuration with s3:PutBucketNotification permission. - - - - The PUT notification is an atomic operation. For example, suppose your notification - configuration includes SNS topic, SQS queue, and Lambda function configurations. When - you send a PUT request with this configuration, Amazon S3 sends test messages to your - SNS topic. If the message fails, the entire PUT operation will fail, and Amazon S3 - will not add the configuration to your bucket. - - - - Responses - - - - If the configuration in the request body includes only one TopicConfiguration - specifying only the s3:ReducedRedundancyLostObject event type, the response - will also include the x-amz-sns-test-message-id header containing the - message ID of the test notification sent to the topic. - - - - The following operation is related to PutBucketNotificationConfiguration: - - - - Container for the necessary parameters to execute the PutBucketNotification service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketNotification service method, as returned by S3. - REST API Reference for PutBucketNotification Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - The MD5 hash of the request body. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - Container for the necessary parameters to execute the PutBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Creates a replication configuration or replaces an existing one. For more information, - see Replication - in the Amazon S3 Developer Guide. - - - - To perform this operation, the user or role performing the operation must have the - iam:PassRole - permission. - - - - Specify the replication configuration in the request body. In the replication configuration, - you provide the name of the destination bucket where you want Amazon S3 to replicate - objects, the IAM role that Amazon S3 can assume to replicate objects on your behalf, - and other relevant information. - - - - A replication configuration must include at least one rule, and can contain a maximum - of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects - in the source bucket. To choose additional subsets of objects to replicate, add a - rule for each subset. All rules must specify the same destination bucket. - - - - To specify a subset of the objects in the source bucket to apply a replication rule - to, add the Filter element as a child of the Rule element. You can filter objects - based on an object key prefix, one or more object tags, or both. When you add the - Filter element in the configuration, you must also add the following elements: DeleteMarkerReplication, - Status, and Priority. - - - - For information about enabling versioning on a bucket, see Using - Versioning. - - - - By default, a resource owner, in this case the AWS account that created the bucket, - can perform this operation. The resource owner can also grant others permissions to - perform the operation. For more information about permissions, see Specifying - Permissions in a Policy and Managing - Access Permissions to Your Amazon S3 Resources. - - - - Handling Replication of Encrypted Objects - - - - By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side - encryption with CMKs stored in AWS KMS. To replicate AWS KMS-encrypted objects, add - the following: SourceSelectionCriteria, SseKmsEncryptedObjects, - Status, EncryptionConfiguration, and ReplicaKmsKeyID. - For information about replication configuration, see Replicating - Objects Created with SSE Using CMKs stored in AWS KMS. - - - - For information on PutBucketReplication errors, see ReplicationErrorCodeList - - - - - The following operations are related to PutBucketReplication: - - - - Container for the necessary parameters to execute the PutBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketReplication service method, as returned by S3. - REST API Reference for PutBucketReplication Operation - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - The bucket name. - Container for Payer. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketRequestPayment service method, as returned by S3. - REST API Reference for PutBucketRequestPayment Operation - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - Container for the necessary parameters to execute the PutBucketRequestPayment service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketRequestPayment service method, as returned by S3. - REST API Reference for PutBucketRequestPayment Operation - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging. - - - - Within a bucket, if you add a tag that has the same key as an existing tag, the new - value overwrites the old value. For more information, see Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional operation is currently in progress against - this resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - The bucket name. - A property of PutBucketTaggingRequest used to execute the PutBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketTagging service method, as returned by S3. - REST API Reference for PutBucketTagging Operation - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging. - - - - Within a bucket, if you add a tag that has the same key as an existing tag, the new - value overwrites the old value. For more information, see Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional operation is currently in progress against - this resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - Container for the necessary parameters to execute the PutBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketTagging service method, as returned by S3. - REST API Reference for PutBucketTagging Operation - - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT operation requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - Amazon S3 has a limitation of 50 routing rules per website configuration. If you require - more than 50 routing rules, you can use object redirect. For more information, see - Configuring - an Object Redirect in the Amazon Simple Storage Service Developer Guide. - - - The bucket name. - Container for the request. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketWebsite service method, as returned by S3. - REST API Reference for PutBucketWebsite Operation - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT operation requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - Amazon S3 has a limitation of 50 routing rules per website configuration. If you require - more than 50 routing rules, you can use object redirect. For more information, see - Configuring - an Object Redirect in the Amazon Simple Storage Service Developer Guide. - - - Container for the necessary parameters to execute the PutBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketWebsite service method, as returned by S3. - REST API Reference for PutBucketWebsite Operation - - - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - The name of the bucket for which to set the configuration. - A property of PutLifecycleConfigurationRequest used to execute the PutLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutLifecycleConfiguration service method, as returned by S3. - REST API Reference for PutLifecycleConfiguration Operation - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - Container for the necessary parameters to execute the PutLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutLifecycleConfiguration service method, as returned by S3. - REST API Reference for PutLifecycleConfiguration Operation - - - - - - - - - - - - - - - - - Configuration for accessing AmazonS3 service - - - Configuration for accessing Amazon S3 service - - - - - When true, requests will always use path style addressing. - - - - - Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. - To use this feature, the bucket name should be DNS compliant names and should not contain periods (.). - The following APIs are not supported and are sent to the regular region endpoint, even if this option is enabled: -
    -
  1. PutBucket
    2. -
  2. ListBuckets
    3. -
  3. DeleteBucket
    4. -
- - - This option cannot be used at the same time as UseDualstackEndpoint. - - - - - If set to true and the service package supports it the region identified in the arn for a resource - will be used when making the service request. - - - - - USEast1RegionalEndpointValue determines wheter or not - to send the us-east-1 s3 requests to the regional endpoint or to - the legacy global endpoint. - This flags takes precedence over the AWS_S3_US_EAST_1_REGIONAL_ENDPOINT - environment variable and the credential file. - - - - - This method contains custom initializations for the config object. - - - - - Given this client configuration, returns the service url - - The service url in the form of a string - - - - If the client is configured to hit us-east-1 with the S3UsEast1RegionalEndpointValue flag not set, - this method checks whether the environment variable is present or the credential file contains a valid value - - A Nullable of S3UsEast1RegionalEndpointValue representing the client configuration for the regional us-east-1 endpoint - - - - Validate that the config object is properly configured. - - - - - Checks the AWS_S3_US_EAST_1_REGIONAL_ENDPOINT environment variable for the presence of the s3 regional flag - - A nullable of S3UsEast1RegionalEndpointValue - - - - Checks the credential file for the presence of the s3 regional flag - - A nullable of S3UsEast1RegionalEndpointValue - - - - Default constructor - - - - - The constant used to lookup in the region hash the endpoint. - - - - - Gets the ServiceVersion property. - - - - - Gets the value of UserAgent property. - - - - - Base exception for S3 errors. - - - - - Construct an instance of AmazonS3Exception - - - - - - Construct an instance of AmazonS3Exception - - - - - - - Construct an instance of AmazonS3Exception - - - - - - Construct an instance of AmazonS3Exception - - - - - - - - - - Construct an instance of AmazonS3Exception - - - - - - - - - - - Construct an instance of AmazonS3Exception - - - - - - - - - - - - Construct an instance of AmazonS3Exception - - - - - - - - - - - - - A special token that helps AWS troubleshoot problems. - - - - - A special token that helps AWS troubleshoot S3 accelerate problems. - - - - - The entire response body for this exception, if available. - - - - - The region that the AmazonS3Exception relates to. - - - - - Gets the exception message. - - - - - Extensions methods added to Amazon.Arn type to help parse S3 specific resources from the ARN. - - - - - Attempt to parse the resource component of the ARN into access point resource name. - - An AWS ARN to parse - The access point resouce identifier found in the ARN. - True if the ARN contains an access point resource identifier. - - - - Attempt to parse the resource component of the ARN into bucket name. - - An AWS ARN to parse - The bucket name found in the ARN. - True if the ARN contains a bucket name. - - - - The file format used when exporting data to Amazon S3. - - - - - CSV file format. - - - - - Construct instance of AnalyticsS3ExportFileFormat. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to an AnalyticsS3ExportFileFormat. - - - - - - - Represents the accelerate status for a bucket. - - - - - Bucket acceleration is enabled. - - - - - Bucket acceleration is suspended. - - - - - Construct instance of BucketAccelerateStatus. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to an BucketAccelerateStatus - - - - - - - The status of the delete marker replication. - - - - - Delete marker replication is enabled. - - - - - Delete marker replication is disabled. - - - - - Construct instance of DeleteMarkerReplicationStatus. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to a DeleteMarkerReplicationStatus - - - - - - - A list of all possible CannedACLs that can be used - for S3 Buckets or S3 Objects. For more information about CannedACLs, refer to - . - - - - - Owner gets FULL_CONTROL. - No one else has access rights (default). - - - - - Owner gets FULL_CONTROL. - No one else has access rights (default). - - - - - Owner gets FULL_CONTROL and the anonymous principal is granted READ access. - If this policy is used on an object, it can be read from a browser with no authentication. - - - - - Owner gets FULL_CONTROL, the anonymous principal is granted READ and WRITE access. - This can be a useful policy to apply to a bucket, but is generally not recommended. - - - - - Owner gets FULL_CONTROL, and any principal authenticated as a registered Amazon - S3 user is granted READ access. - - - - - Owner gets FULL_CONTROL. Amazon EC2 gets READ access to GET an - Amazon Machine Image (AMI) bundle from Amazon S3. - - - - - Object Owner gets FULL_CONTROL, Bucket Owner gets READ - This ACL applies only to objects and is equivalent to private when used with PUT Bucket. - You use this ACL to let someone other than the bucket owner write content (get full control) - in the bucket but still grant the bucket owner read access to the objects. - - - - - Object Owner gets FULL_CONTROL, Bucket Owner gets FULL_CONTROL. - This ACL applies only to objects and is equivalent to private when used with PUT Bucket. - You use this ACL to let someone other than the bucket owner write content (get full control) - in the bucket but still grant the bucket owner full rights over the objects. - - - - - The LogDelivery group gets WRITE and READ_ACP permissions on the bucket. - - - - - Construct instance of S3CannedACL. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to an S3CannedACL - - - - - - - A list of all possible S3 Bucket region possibilities. For - more information, refer to - . - - - - - Specifies that the S3 Bucket should use US locality. - This is the default value. - - - - - Specifies that the S3 Bucket should use US-EAST-2 locality. - - - - - Specifies that the S3 Bucket should use EU locality which defaults to EU-WEST-1 - - - - - Specifies that the S3 Bucket should use the EU-NORTH-1 locality. - - - - - Specifies that the S3 Bucket should use the EU-WEST-1 locality. - - - - - Specifies that the S3 Bucket should use the EU-WEST-2 locality. - - - - - Specifies that the S3 Bucket should use the EU-WEST-3 locality. - - - - - Specifies that the S3 Bucket should use the EU-CENTRAL-1 locality. - - - - - Specifies that the S3 Bucket should use US-WEST-1 locality. - - - - - Specifies that the S3 Bucket should use US-WEST-2 locality. - - - - - Specifies that the S3 Bucket should use US-GOV-EAST-1 locality. - - - - - Specifies that the S3 Bucket should use US-GOV-WEST-1 locality. - - - - - Specifies that the S3 Bucket should use the AP-EAST-1 locality. - - - - - Specifies that the S3 Bucket should use the AP-SOUTHEAST-1 locality. - - - - - Specifies that the S3 Bucket should use the AP-SOUTHEAST-2 locality. - - - - - Specifies that the S3 Bucket should use the AP-NORTHEAST-1 locality. - - - - - Specifies that the S3 Bucket should use the AP-NORTHEAST-2 locality. - - - - - Specifies that the S3 Bucket should use the AP-NORTHEAST-3 locality. - - - - - Specifies that the S3 Bucket should use the AP-SOUTH-1 locality. - - - - - Specifies that the S3 Bucket should use the SA-EAST-1 locality. - - - - - Specifies that the S3 Bucket should use CN-NORTH-1 locality. - - - - - Specifies that the S3 Bucket should use CN-NORTHWEST-1 locality. - - - - - Specifies that the S3 Bucket should use CA-CENTRAL-1 locality. - - - - - Specifies that the S3 Bucket should use US-WEST-1 locality. - - - - - Specifies that the S3 Bucket should use CN-NORTH-1 locality. - - - - - Specifies that the S3 Bucket should use US-GOV-WEST-1 locality. - - - - - Construct instance of S3Region. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to the S3Region class - - - - - - - A list of all ACL permissions. For more information, refer to - . - - - - - When applied to a bucket, grants permission to list the bucket. - When applied to an object, this grants permission to read the - object data and/or metadata. - - - - - When applied to a bucket, grants permission to create, overwrite, - and delete any object in the bucket. This permission is not - supported for objects. - - - - - Grants permission to read the ACL for the applicable bucket or object. - The owner of a bucket or object always has this permission implicitly. - - - - - Gives permission to overwrite the ACP for the applicable bucket or object. - The owner of a bucket or object always has this permission implicitly. - Granting this permission is equivalent to granting FULL_CONTROL because - the grant recipient can make any changes to the ACP. - - - - - Provides READ, WRITE, READ_ACP, and WRITE_ACP permissions. - It does not convey additional rights and is provided only for convenience. - - - - - Gives permission to restore an object that is currently stored in Amazon Glacier - for archival storage. - - - - - Construct S3Permission. - - - - - - Construct instance of S3Permission. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - - Gets and sets the HeaderName property. - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to an S3Permission - - - - - - - An enumeration of all Metadata directives that - can be used for the CopyObject operation. - - - - - Specifies that the metadata is copied from the source object. - - - - - Specifies that the metadata is replaced with metadata provided in the request. - All original metadata is replaced by the metadata you specify. - - - - - An enumeration of all protocols that the pre-signed - URL can be created against. - - - - - https protocol will be used in the pre-signed URL. - - - - - http protocol will be used in the pre-signed URL. - - - - - An enumeration of supported HTTP verbs - - - - - The GET HTTP verb. - - - - - The HEAD HTTP verb. - - - - - The PUT HTTP verb. - - - - - The DELETE HTTP verb. - - - - - S3 Storage Class Definitions - - - - - The STANDARD storage class, which is the default - storage class for S3. - - Durability 99.999999999%; Availability 99.99% over a given year. - - - - - REDUCED_REDUNDANCY provides the same availability as standard, but at a lower durability. - - Durability 99.99%; Availability 99.99% over a given year. - - - - - The GLACIER storage is for object that are stored in Amazon Glacier. - This storage class is for objects that are for archival purpose and - get operations are rare. - - Durability 99.999999999% - - - - - The STANDARD_IA storage is for infrequently accessed objects. - This storage class is for objects that are long-lived and less frequently accessed, - like backups and older data. - - Durability 99.999999999%; Availability 99.9% over a given year. - - - - - The ONEZONE_IA storage is for infrequently accessed objects. It is similiar to STANDARD_IA, but - only stores object data within one Availablity Zone in a given region. - - Durability 99.999999999%; Availability 99% over a given year. - - - - - IntelligentTiering makes it easy to lower your overall cost of storage by automatically placing data in the storage - class that best matches the access patterns for the storage. With IntelligentTiering, you don’t need to define - and manage individual policies for lifecycle data management or write code to transition objects - between storage classes. Instead, you can use IntelligentTiering to manage transitions between Standard and - S-IA without writing any application code. IntelligentTiering also manages transitions automatically to - Glacier for long term archive in addition to S3 storage classes. - - - - - S3 Glacier Deep Archive provides secure, durable object storage class for long term data archival. - It is the ideal storage class to make an archival, durable copy of data that rarely, if ever, needs to be accessed. - It can be used as an offline backup for their most important data assets and to meet long-term retention needs. - - - - - Construct an instance of S3StorageClass. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to S3StorageClass. - - - - - - - The constants for the known event names used by S3 notification. S3 might add new - events before the SDK is updated. In which case the names listed in the S3 documentation - will work as well as these constants. - - - - - An event that says an object has been lost in the reduced redundancy storage. - - - - - A list of all server-side encryption methods for customer provided encryption keys. - - - - - No server side encryption to be used. - - - - - Use AES 256 server side encryption. - - - - - Constructs an instance of ServerSideEncryptionCustomerMethod. - - - - - - Finds the constant for the unique value. - - - - - - - Converts string to ServerSideEncryptionCustomerMethod. - - - - - - - A list of all server-side encryption methods. - - - - - No server side encryption to be used. - - - - - Use AES 256 server side encryption. - - - - - Use AWS Key Management Service for server side encryption. - - - - - Construct instance of ServerSideEncryptionMethod. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to ServerSideEncryptionCustomerMethod. - - - - - - - A list of all grantee types. - - - - - The predefined group. - - - - - The email address of an AWS account - - - - - The canonical user ID of an AWS account - - - - - Construct an instance of GranteeType. - - - - - - Finds the constant for the unique value. - - - - - - - Convert a string to GranteeType. - - - - - - - A list of all lifecycle statuses. - - - - - The rule is enabled. - - - - - The rule is disabled. - - - - - Constructs an instance LifecycleRuleStatus. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to LifecycleRuleStatus. - - - - - - - A list of all version statuses. - - - - - The rule is off. - - - - - The rule is suspended. - - - - - The rule is enabled. - - - - - Construct an instance of VersionStatus. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to VersionStatus. - - - - - - - A list of all encoding types. - - - - - Url encoding. - - - - - Constructs intance of EncodingType - - - - - - Finds the constant for the unique value. - - - - - - - Converts string to EncodingType - - - - - - - The bucket event for which to send notifications. - - - - - The event encapsulates all the object create events - - - - - Event for put operations - - - - - Event for post operations - - - - - Event for copy operations - - - - - Event for completing a multi part upload - - - - - This event encapsulates all the object removed events - - - - - Event for object removed, delete operation. - - - - - Event for object removed, delete marker created operation. - - - - - Event for objects stored in reduced redundancy and S3 detects the object is lost - - - - - Event for all object restore - - - - - Event for restore post operations. - - - - - Event for when object restore is completed. - - - - - Event for replication of all - - - - - Event for operation failed replication - - - - - Evemt for replication operation not tracked - - - - - Event for replication operation missed threshold - - - - - Event for operation replicated after threshold - - - - - Constructs instance of EventType. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to EventType. - - - - - - - Compares if the ConstantClass instances are equals. - - - - - - - Compares if the ConstantClass instances are equals. This is ovewritten to handle the - discrepancy with S3 events coming from Lambda that don't have the prefix "s3:". - - - - - - - A list of all Inventory Formats. - - - - - CSV inventory format - - - - - ORC inventory format - - - - - Parquet inventory format - - - - - Construct instance of InventoryFormat. - - - - - - Finds the constant for the unique value. - - The string representation of the InventoryFormat. - The InventoryFormat object for that string. - - - - Convert string to InventoryFormat. - - - - - - - A list of inventory included object versions. - - - - - All Inventory Included Object Versions - - - - - Current Inventory Included Object Versions - - - - - Construct instance of InventoryIncludedObjectVersions. - - - - - - Finds the constant for the unique value. - - The string representation of the InventoryIncludedObjectVersions. - The InventoryIncludedObjectVersions object for that string. - - - - Convert string to InventoryIncludedObjectVersions. - - - - - - - A list of inventory frequencies. - - - - - Daily Inventory Frequency - - - - - Weekly Inventory Frequency - - - - - Construct instance of InventoryFrequency. - - - - - - Finds the constant for the unique value. - - The string representation of the InventoryFrequency. - The InventoryFrequency object for that string. - - - - Convert string to InventoryFrequency. - - - - - - - A list of inventory optional fields. - - - - - InventoryOptionalField for Size - - - - - InventoryOptionalField for LastModifiedDate - - - - - InventoryOptionalField for StorageClass - - - - - InventoryOptionalField for ETag - - - - - InventoryOptionalField for IsMultipartUploaded - - - - - InventoryOptionalField for ReplicationStatus - - - - - InventoryOptionalField for EncryptionStatus - - - - - InventoryOptionalField for ObjectLockRetainUntilDate - - - - - InventoryOptionalField for ObjectLockMode - - - - - InventoryOptionalField for ObjectLockLegalHoldStatus - - - - - InventoryOptionalField for IntelligentTieringAccessTier - - - - - Construct instance of InventoryOptionalField. - - - - - - Finds the constant for the unique value. - - The string representation of the InventoryOptionalField. - The InventoryIncludedObjectVersions object for that string. - - - - Convert string to InventoryOptionalField. - - - - - - - The status of the replication job associated with this source object. - - - - - The object is pending replication. - - - - - The object has been replicated. - - - - - The object was created as a result of replication. - - - - - The object replication has failed due to a customer-attributable reason, and the replication will not be attempted again. - - - - - Construct instance of ReplicationStatus. - - - - - - Finds the constant for the unique value. - - The string representation of the ReplicationStatus. - The ReplicationStatus object for that string. - - - - Convert string to ReplicationStatus. - - - - - - - Whether a replication rule is applied or ignored. - - - - - The rule will be applied. - - - - - The rule will be ignored. - - - - - Construct instance of ReplicationRuleStatus - - - - - - Finds the constant for the unique value. - - The string representation of the ReplicationRuleStatus. - The ReplicationRuleStatus object for that string. - - - - Convert string to ReplicationRuleStatus. - - - - - - - Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request. - - - - - The object tag-set is copied from the source object. - - - - - The object tag-set is replaced with tag-set provided in the request. - - - - - Construct instance of TaggingDirective - - - - - Finds the constant for the unique value. - - The string representation of the TaggingDirective. - The TaggingDirective object for that string. - - - - Convert string to TaggingDirective. - - - - - All enumerations type for retrieval tier for Glacier restore. - - - - - Standard Tier for Glacier restore. - - - - - Bulk Tier for Glacier restore. - - - - - Expedited Tier for Glacier restore. - - - - - Construct instance of RestoreObjectRequestGlacierJobTier - - - - - - Finds the constant for the unique value. - - The string representation of the RestoreObjectRequestGlacierJobTier. - The RestoreObjectRequestGlacierJobTier object for that string. - - - - Convert string to RestoreObjectRequestGlacierJobTier. - - - - - - - The version of the output schema to use when exporting data. - - - - - The schema output version V_1. - - - - - Construct instance of StorageClassAnalysisSchemaVersion - - - - - - Finds the constant for the unique value. - - The string representation of the StorageClassAnalysisSchemaVersion. - The StorageClassAnalysisSchemaVersion object for that string. - - - - Convert string to StorageClassAnalysisSchemaVersion. - - - - - - - Acknowledges that requester pays for the operation. - - - - - Requester pays for the operation. - - - - - Finds the RequestPayer instance for the string value. - - - - - Converts string to RequestPayer instance - - - - - The response from S3 that it confirms that requester pays. - - - - - S3 acknowledges that the requester pays. - - - - - Finds the RequestCharged instance for the string value - - - - - converts the string to RequestCharged instance - - - - - The override value for the owner of the replica object. - - - - - Overrides destination bucket's owner. - - - - - Finds the OwnerOverride instance for the string value - - - - - converts the string to OwnerOverride instance - - - - - The replication for KMS encrypted S3 objects is disabled if status is not Enabled. - - - - - The replication for KMS encrypted S3 objects is enabled. - - - - - The replication for KMS encrypted S3 objects is disabled. - - - - - - - - - - Finds the SseKmsEncryptedObjectsStatus instance for the string value - - - - - Converts the string to SseKmsEncryptedObjectsStatus instance - - - - - Specify how headers will be handled. - - - - - Headers will be usable in SELECT clause. - - - - - Headers will be skipped - - - - - No header is present. - - - - - Finds the FileHeaderInfo instance for the string value - - - - - - - Converts the string to FileHeaderInfo instance - - - - - Specifies whether existing object replication is enabled. - - - - - Enable the replication of existing objects - - - - - Disable the replication of existing objects - - - - - Finds the ExistingObjectReplicationStatus instance for the string value - - - - - - - Converts the string to ExistingObjectReplicationStatus instance - - - - - Describes when fields in output should be surrounded with quotes. - - - - - Specifies that fields in output should always be surrounded in quotes. - - - - - Specifies that fields in output should be surrounded in quotes as necessary. - - - - - Finds the QuoteFields instance for the string value - - string value that maps to QuoteFields enum - QuoteFields enum - - - - Converts the string to QuoteFields instance - - - - - Type of the expression provided in the Expression member. - - - - - SQL expression - - - - - Finds the ExpressionType instance for the string value - - string value that maps to ExpressionType enum - ExpressionType enum - - - - Converts the string to ExpressionType instance - - - - - Indicates what type of job is being initiated. - - - - - Finds the RestoreRequestType instance for the string value - - - - - Converts the string to RestoreRequestType instance - - - - - The type of JSON. - - - - - Finds the JsonType instance for the string value - - - - - Converts the string to JsonType instance - - - - - Specifies object's compression format. - - - - - Finds the CompressionType instance for the string value - - - - - Converts the string to CompressionType instance - - - - - The type of ObjectLockEnabled - - - - - Finds the ObjectLockEnabled instance for the string value - - - - - Converts the string to ObjectLockEnabled instance - - - - - The type of ObjectLockLegalHoldStatus - - - - - Finds the ObjectLockLegalHoldStatus instance for the string value - - - - - Converts the string to ObjectLockLegalHoldStatus instance - - - - - The type of ObjectLockRetentionMode - - - - - Finds the ObjectLockRetentionMode instance for the string value - - - - - Converts the string to ObjectLockRetentionMode instance - - - - - The type of ObjectLockMode - - - - - Finds the ObjectLockMode instance for the string value - - - - - Converts the string to ObjectLockMode instance - - - - - Specifies whether the replication time is enabled. - - - - - Replication time is enabled. - - - - - Replication time is disabled. - - - - - Finds the ReplicationTimeStatus instance for the string value - - - - - - - Converts the string to ReplicationTimeStatus instance - - - - - - Specifies whether the replication metrics are enabled. - - - - - Replication metrics are enabled. - - - - - Replication metrics are disabled. - - - - - Finds the MetricsStatus instance for the string value - - - - - - - Converts the string to MetricsStatus instance - - - - - - Custom pipeline handler to clean up streams in case of an exception. - - - - - Catch exceptions and clean up any open streams. - - - - - - Catch exceptions and clean up any open streams. - - - - - - - Custom pipeline handler to enable sig V4 for Get requests. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Custom pipeline handler to enable sig V4 for Get requests. - - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Calls the post invoke logic after calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls the and post invoke logic after calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Constructor for AmazonS3RetryPolicy. - - The IClientConfig object - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - - - a value if it can be determined, or null if the IO-bound calculations need to be done - - - - Return true if the request should be retried. Implements additional checks - specific to S3 on top of the checks in DefaultRetryPolicy. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Constructor for AmazonS3StandardRetryPolicy. - - The IClientConfig object - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - - - a value if it can be determined, or null if the IO-bound calculations need to be done - - - - Return true if the request should be retried. Implements additional checks - specific to S3 on top of the checks in StandardRetryPolicy. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Constructor for AmazonS3AdaptiveRetryPolicy. - - The IClientConfig object - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - - - a value if it can be determined, or null if the IO-bound calculations need to be done - - - - Return true if the request should be retried. Implements additional checks - specific to S3 on top of the checks in AdaptiveRetryPolicy. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Marker interface to identify AmazonS3EncryptionClient. - - - - - Service metadata for Amazon S3 service - - - - - Gets the value of the Service Id. - - - - - Gets the dictionary that gives mapping of renamed operations - - - - - The parameters to request an abort of a multipart upload. - - - After a multipart upload is aborted, no additional parts can be uploaded using that upload ID. - The storage consumed by any previously uploaded parts will be freed. However, if any part uploads - are currently in progress, those part uploads might or might not succeed. As a result, it might be - necessary to abort a given multipart upload multiple times in order to completely free all storage - consumed by all parts. - - - - - The bucket name to which the upload was taking place. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The key of the S3 object that was being uploaded. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - The upload id for the in-progress multipart upload that should be aborted. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the AbortMultipartUpload response metadata. - The AbortMultipartUpload operation has a void result type. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Bucket accelerate configuration. - - - - - The accelerate status of the bucket. - - - - - AccessControlTranslation class - - - - - The override value for the owner of the replica object. - - - - - Class for AnalyticsAndOperator - A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. - The operator must have at least two predicates, and an object must match all of the predicates - in order for the filter to apply. - - Note: The current implementation restricts the usage to atmost one AnalyticsPrefixPredicate - and any number of AnalyticsTagPredicates. - - - - Class for AnalyticsConfiguration - - - - - The identifier used to represent an analytics configuration. - - - - - The filter used to describe a set of objects for analyses. - A filter must have exactly one prefix, one tag, or one conjunction (AnalyticsAndOperator). - If no filter is provided, all objects will be considered in any analysis. - - - - - If present, it indicates that data related to access patterns will be collected - and made available to analyze the tradeoffs between different storage classes. - - - - - Class for AnalyticsExportDestination - - - - - A destination signifying output to an S3 bucket. - - - - - Filter class for Metrics. - - - - - Filter Predicate setup for specific filter types. - - - - - Filter Predicate abstract class for specific filter types to be derived from. - - - - - Abstract class that can be used over logical filter predicates,i.e. AND/OR. - - - - - Internal implementation of Metrics Predicate visitor interface. - - - - - Interface for implementing visitor pattern in Analytics Predicate Filter. - - - - - Interface for implementing visitor pattern in Inventory Predicate Filter. - - - - - Interface for implementing visitor pattern in Metrics Predicate Filter. - - - - - Internal implementation of Inventory Predicate visitor interface. - - - - - Internal implementation of Metrics Predicate visitor interface. - - - - - Defines the interface that is used to visit all the different - implementations of - - - - - Visit a - - - - - - Visit a - - - - - - Visit a - - - - - - Implementation of to marshall . - - - - - AbortIncompleteMultipartUpload Unmarshaller - - - - - Abort Multipart Upload Request Marshaller - - - - - Response Unmarshaller for AbortMultipartUpload operation - - - - - AnalyticsConfiguration Unmarshaller - - - - - AnalyticsExportDestinationUnmarshaller - - - - - AnalyticsFilter Unmarshaller - - - - - AnalyticsS3BucketDestination Unmarshaller - - - - - Bucket Unmarshaller - - - - - CommonPrefixesItem Unmarshaller - - - - - Complete Multipart Upload Request Marshaller - - - - - Response Unmarshaller for CompleteMultipartUpload operation - - - - - ContentsItem Unmarshaller - - - - - Copy Object Request Marshaller - - - - - Response Unmarshaller for CopyObject operation - - - - - Upload Part Copy Request Marshaller - - - - - Response Unmarshaller for CopyPart operation - - - - - CORSRule Unmarshaller - - - - - Response Unmarshaller for DefaultRetention Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Delete InventoryConfiguration Request Marshaller - - - - - Response Unmarshaller for DeleteAnalyticsConfiguration operation - - - - - Response Unmarshaller for DeleteCORSConfiguration operation - - - - - Delete InventoryConfiguration Request Marshaller - - - - - Response Unmarshaller for DeleteInventoryConfiguration operation - - - - - Delete Bucket MetricsConfiguration Request Marshaller - - - - - Response Unmarshaller for DeleteBucketMetricsConfiguration operation - - - - - Delete Bucket Policy Request Marshaller - - - - - Response Unmarshaller for DeleteBucketPolicy operation - - - - - Delete Bucket Request Marshaller - - - - - Response Unmarshaller for DeleteBucket operation - - - - - Delete Bucket Tagging Request Marshaller - - - - - Response Unmarshaller for DeleteBucketTagging operation - - - - - Delete Bucket Website Request Marshaller - - - - - Response Unmarshaller for DeleteBucketWebsite operation - - - - - Delete Bucket Cors Request Marshaller - - - - - DeletedObject Unmarshaller - - - - - Delete Bucket Lifecycle Request Marshaller - - - - - Response Unmarshaller for DeleteBucketLifecycle operation - - - - - Delete Object Request Marshaller - - - - - Response Unmarshaller for DeleteObject operation - - - - - Delete Objects Request Marshaller - - - - - Response Unmarshaller for DeleteObjects operation - - - - - DeleteObjectTaggingRequest Marshaller - - - - - Marshall DeleteObjectTaggingRequest object into an http request. - - - - - Marshall DeleteObjectTaggingRequest object into an http request. - - - - - Response Unmarshaller for DeleteObjectTagging operation - - - - - DeletePublicAccessBlock Request Marshaller - - - - - Response Unmarshaller for DeletePublicAccessBlock operation - - - - - ErrorsItem Unmarshaller - - - - - Expiration Unmarshaller - - - - - FilterRule Unmarshaller - - - - - Filter Unmarshaller - - - - - Get Object Acl Request Marshaller - - - - - Response Unmarshaller for GetACL operation - - - - - Get Object Accelerate Configuration Request Marshaller - - - - - Response Unmarshaller for GetACL operation - - - - - Get BucketAnalyticsConfiguration Request Marshaller - - - - - Response Unmarshaller for GetAnalyticsConfiguration operation - - - - - Get InventoryConfiguration Request Marshaller - - - - - Response Unmarshaller for GetInventoryConfiguration operation - - - - - Get Bucket Location Request Marshaller - - - - - Response Unmarshaller for GetBucketLocation operation - - - - - Get Bucket Logging Request Marshaller - - - - - Response Unmarshaller for GetBucketLogging operation - - - - - Get Bucket MetricsConfigurationRequest Marshaller - - - - - Response Unmarshaller for GetBucketMetricsConfiguration operation - - - - - Get Bucket Notification Request Marshaller - - - - - Response Unmarshaller for GetBucketNotification operation - - - - - Get BucketName Policy Request Marshaller - - - - - Response Unmarshaller for GetBucketPolicy operation - - - - - GetBucketPolicyStatusRequestMarshaller - - - - - Response Unmarshaller for GetBucketPolicyStatus operation - - - - - Get Bucket Request Payment Request Marshaller - - - - - Response Unmarshaller for GetBucketRequestPayment operation - - - - - Get Bucket Tagging Request Marshaller - - - - - Response Unmarshaller for GetBucketTagging operation - - - - - Get Bucket Versioning Request Marshaller - - - - - Response Unmarshaller for GetBucketVersioning operation - - - - - Get Bucket Website Request Marshaller - - - - - Response Unmarshaller for GetBucketWebsite operation - - - - - Get Bucket Cors Request Marshaller - - - - - Response Unmarshaller for GetCORSConfiguration operation - - - - - Get Bucket Lifecycle Request Marshaller - - - - - Response Unmarshaller for GetLifecycleConfiguration operation - - - - - GetObjectLegalHold Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for GetObjectLegalHold operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - GetObjectLockConfiguration Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for GetObjectLockConfiguration operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - GetObjectMetadata Marshaller - - - - - Response Unmarshaller for GetObjectMetadata operation - - - - - Get Object Request Marshaller - - - - - Response Unmarshaller for GetObject operation - - - - - GetObjectRetention Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for GetObjectRetention operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - GetObjectTaggingRequest Marshaller - - - - - Marshall GetObjectTaggingRequest into an http request. - - - - - Marshall GetObjectTaggingRequest into an http request. - - - - - Response Unmarshaller for GetObjectTagging operation - - - - - Get Object Torrent Request Marshaller - - - - - Response Unmarshaller for GetObjectTorrent operation - - - - - GetPublicAccessBlockRequestMarshaller - - - - - Response Unmarshaller for GetPublicAccessBlock operation - - - - - Grantee Unmarshaller - - - - - Grant Unmarshaller - - - - - Head Bucket Request Marshaller - - - - - Response Unmarshaller for HeadBucket operation - - - - - Create Multipart Upload Request Marshaller - - - - - Response Unmarshaller for InitiateMultipartUpload operation - - - - - Initiator Unmarshaller - - - - - InventoryConfiguration Unmarshaller - - - - - InventoryDestination Unmarshaller - - - - - InventoryEncryption Unmarshaller - - - - - InventoryFilter Unmarshaller - - - - - InventoryS3BucketDestination Unmarshaller - - - - - InventorySchedule Unmarshaller - - - - - LifecycleFilterPredicate Unmarshaller - - - - - LifecycleRuleNoncurrentVersionExpiration Unmarshaller - - - - - LifecycleRuleNoncurrentVersionTransition Unmarshaller - - - - - List AnalyticsConfiguration Request Marshaller - - - - - Response Unmarshaller for ListAnalyticsConfiguration operation - - - - - List InventoryConfiguration Request Marshaller - - - - - Response Unmarshaller for ListInventoryConfiguration operation - - - - - List Bucket MetricsConfigurationRequest Marshaller - - - - - Response Unmarshaller for ListBucketMetricsConfiguration operation - - - - - List Buckets Request Marshaller - - - - - Response Unmarshaller for ListBuckets operation - - - - - List Multipart Uploads Request Marshaller - - - - - Response Unmarshaller for ListMultipartUploads operation - - - - - List Objects Request Marshaller - - - - - Response Unmarshaller for ListObjects operation - - - - - List Objects Request Marshaller - - - - - Response Unmarshaller for ListObjects operation - - - - - List Parts Request Marshaller - - - - - Response Unmarshaller for ListParts operation - - - - - List Object Versions Request Marshaller - - - - - Response Unmarshaller for ListVersions operation - - - - - LoggingEnabled Unmarshaller - - - - - MetricsConfiguration Unmarshaller - - - - - MetricsFilte Unmarshaller - - - - - UploadsItem Unmarshaller - - - - - Response Unmarshaller for ObjectLockConfiguration Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Response Unmarshaller for ObjectLockLegalHold Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Response Unmarshaller for ObjectLockRetention Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Response Unmarshaller for ObjectLockRule Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Owner Unmarshaller - - - - - PartsItem Unmarshaller - - - - - PolicyStatus Unmarshaller - - - - - PublicAccessBlockConfiguration Unmarshaller - - - - - Put Object Acl Request Marshaller - - - - - Response Unmarshaller for PutObjectAcl operation - - - - - Put Object Acl Request Marshaller - - - - - Response Unmarshaller for PutBucketAccelerate operation - - - - - Request Marshaller for PutAnalyticsConfiguration operation - - - - - Response Unmarshaller for PutBucketAnalytics operation - - - - - Request Marshaller for PutInventoryConfiguration operation - - - - - Response Unmarshaller for PutBucketWebsite operation - - - - - Enable Bucket Logging Request Marshaller - - - - - Response Unmarshaller for PutBucketLogging operation - - - - - Put Bucket MetricsConfigurationRequest Marshaller - - - - - Response Unmarshaller for PutBucketMetricsConfiguration operation - - - - - Put Bucket Notification Request Marshaller - - - - - Response Unmarshaller for PutBucketNotification operation - - - - - Put Bucket Policy Request Marshaller - - - - - Response Unmarshaller for PutBucketPolicy operation - - - - - Put Buckeyt Replication Request Marshaller - - - - - Response Unmarshaller for PutBucketReplication operation. - - - - - Put Bucket Request Marshaller - - - - - Put Bucket Request Payment Request Marshaller - - - - - Response Unmarshaller for PutBucketRequestPayment operation - - - - - Response Unmarshaller for PutBucket operation - - - - - Put Bucket Tagging Request Marshaller - - - - - Response Unmarshaller for PutBucketTagging operation - - - - - Put Bucket Versioning Request Marshaller - - - - - Response Unmarshaller for PutBucketVersioning operation - - - - - Put Bucket Website Request Marshaller - - - - - Response Unmarshaller for PutBucketWebsite operation - - - - - Put Bucket Cors Request Marshaller - - - - - Response Unmarshaller for PutCORSConfiguration operation - - - - - Put Bucket Lifecycle Request Marshaller - - - - - Response Unmarshaller for PutLifecycleConfiguration operation - - - - - PutObjectLegalHold Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for PutObjectLegalHold operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - PutObjectLockConfiguration Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for PutObjectLockConfiguration operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Put Object Request Marshaller - - - - - Response Unmarshaller for PutObject operation - - - - - PutObjectRetention Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for PutObjectRetention operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Delete Object Tagging Request Marshaller - - - - - Marshall PutObjectTaggingRequest into an http request. - - - - - Marshall PutObjectTaggingRequest into an http request. - - - - - Response Unmarshaller for DeleteObjectTagging operation - - - - - PutPublicAccessBlock Request Marshaller - - - - - Response Unmarshaller for PutPublicAccessBlock operation - - - - - Restore Object Request Marshaller - - - - - Response Unmarshaller for RestoreObject operation - - - - - Condition Unmarshaller - - - - - Redirect Unmarshaller - - - - - RoutingRule Unmarshaller - - - - - RulesItem Unmarshaller - - - - - Response Unmarshaller for all Errors - - - - - Build an S3ErrorResponse from XML - - The XML parsing context. - Usually an Amazon.Runtime.Internal.UnmarshallerContext. - An S3ErrorResponse object. - - - - Grant Unmarshaller - - - - - Class for unmarshalling S3 service responses - - - - - Specialized S3 unmarshaller context. - - - - - Wrap an XmlTextReader with state for event-based parsing of an XML stream. - - Stream with the XML from a service response. - If set to true, maintains a copy of the complete response body as the stream is being read. - Response data coming back from the request - If set to is true, configure unmarshaller with exception specifics. - - - - Reads to the next node in the XML document, and updates the context accordingly. - If node is RequestId, reads the contents and stores in RequestId property. - - - True if a node was read, false if there are no more elements to read./ - - - - - SSEKMS Unmarshaller - - - - - StorageClassAnalysisDataExportDataExportUnmarshaller - - - - - StorageClassAnalysisUnmarshaller - - - - - Tag Unmarshaller - - - - - TopicConfiguration Unmarshaller - - - - - Transition Unmarshaller - - - - - Upload Part Request Marshaller - - - - - Response Unmarshaller for UploadPart operation - - - - - VersionsItem Unmarshaller - - - - - Class for AnalyticsPrefixPredicate - The prefix used when evaluating a metrics filter. - - - - - Class for AnalyticsS3BucketDestination - - - - - The file format used when exporting data to Amazon S3. - - - - - The account ID that owns the destination bucket. If no account ID is provided, the owner will not be validated prior to exporting data. - - - - - The Amazon resource name (ARN) of the bucket to which data is exported. - - - - - The prefix to use when exporting data. The exported data begins with this prefix. - - - - - Class for MetricsTagPredicate - The tag used when evaluating a metrics filter. - - - - - This class represents the byte range for a range GET from S3. - - - - - Constructs a ByteRange and sets the start and end. - - - - - - - Constructs a ByteRange and sets the header to the value specified. - - - - - - A private string, represending the byte range. - - - - - The starting byte number of the range - - - - - The ending byte number of the range - - - - - The formatted string representing the byte range to be set for the range header. - - - - - Container for the parameters to the CompleteMultipartUpload operation. - Completes a multipart upload by assembling previously uploaded parts. - - - - - The name of the bucketName containing the S3 object that was being uploaded in parts. - - - - - The key of the S3 object that was being uploaded. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - A collection of part numbers and corresponding etags. - - - - - Adds a collection of part numbers and corresponding etags. - - PartETags that will added to this request. - - - - Adds a collection of part numbers and corresponding etags. - - PartETags that will added to this request. - - - - Adds a collection of part numbers and corresponding etags by transforming the UploadPartResponses into PartETags. - - The list of response objects return from UploadParts. - - - - Adds a collection of part numbers and corresponding etags by transforming the UploadPartResponses into PartETags. - - The list of response objects return from UploadParts. - - - - Adds a collection of part numbers and corresponding etags by transforming the CopyPartResponse into PartETags. - - The list of response objects return from CopyParts. - - - - Adds a collection of part numbers and corresponding etags by transforming the CopyPartResponse into PartETags. - - The list of response objects return from CopyParts. - - - - The upload id for the in-progress multipart upload that should be completed. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the CompleteMultipartUpload response and response metadata. - - - - - Gets and sets the URI that identifies the newly created object. - - - - - Gets and sets the name of the bucketName that contains the newly created object. - - - - - Gets and sets the object key of the newly created object. - - - - - Gets and sets Entity tag that identifies the newly created object's data. Objects with different - object data will have different entity tags. The entity tag is an opaque string. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - Gets and sets the ServerSideEncryptionMethod property. - Specifies the encryption used on the server to - store the content. - Default is None. - - - - - Gets and sets the VersionId property. - This is the version-id of the S3 object - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the CopyObject operation. - Creates a copy of an object that is already stored in Amazon S3. - - - - - The name of the bucket containing the object to copy. - - - - - Checks if SourceBucket property is set. - - true if SourceBucket property is set. - - - - The key of the object to copy. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Checks if SourceKey property is set. - - true if SourceKey property is set. - - - - Specifies a particular version of the source object to copy. By default the latest version is copied. - - - - - Checks if SourceVersionId property is set. - - true if SourceVersionId property is set. - - - - The name of the bucket to contain the copy of the source object. - - - - - Checks if DestinationBucket property is set. - - true if DestinationBucket property is set. - - - - The key to be given to the copy of the source object. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Checks if DestinationKey property is set. - - true if DestinationKey property is set. - - - - A canned access control list (CACL) to apply to the object. - Please refer to for - information on S3 Canned ACLs. - - - - - ETag to be matched as a pre-condition for copying the source object - otherwise returns a PreconditionFailed. - - - Copies the object if its entity tag (ETag) matches - the specified tag; otherwise return a 412 (precondition failed). - Constraints: This property can be used with IfUnmodifiedSince, - but cannot be used with other conditional copy properties. - - - - - Checks if ETagToMatch property is set. - - - Copies the object if its entity tag (ETag) is different - than the specified Etag; otherwise returns a 412 (failed condition). - Constraints: This header can be used with IfModifiedSince, but cannot - be used with other conditional copy properties. - - true if ETagToMatch property is set. - - - - ETag that must not be matched as a pre-condition for copying the source object, - otherwise returns a PreconditionFailed. - - - - - Checks if ETagToNotMatch property is set. - - true if ETagToNotMatch property is set. - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or - ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Copies the object if it has been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it has been modified since the - specified time; otherwise returns a 412 (failed condition). - Constraints: This property can be used with ETagToNotMatch, - but cannot be used with other conditional copy properties. - - - - - Copies the object if it has been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it has been modified since the - specified time; otherwise returns a 412 (failed condition). - Constraints: This property can be used with ETagToNotMatch, - but cannot be used with other conditional copy properties. - - - - - Checks if ModifiedSinceDateUtc property is set. - - true if ModifiedSinceDateUtc property is set. - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or - UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Copies the object if it has not been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it hasn't been modified since the - specified time; otherwise returns a 412 (precondition failed). - Constraints: This property can be used with ETagToMatch, - but cannot be used with other conditional copy properties. - - - - - Copies the object if it has not been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it hasn't been modified since the - specified time; otherwise returns a 412 (precondition failed). - Constraints: This property can be used with ETagToMatch, - but cannot be used with other conditional copy properties. - - - - - Checks if UnmodifiedSinceDateUtc property is set. - - true if UnmodifiedSinceDateUtc property is set. - - - - Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request. - - - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - Specifies whether you want to apply a Legal Hold to the copied object. - - - - - - Gets and sets the property ObjectLockMode. - - The Object Lock mode that you want to apply to the copied object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - The date and time when you want the copied object's Object Lock to expire. - - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - Checks if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - true if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - - - The type of storage to use for the object. Defaults to 'STANDARD'. - - - - - - If the bucketName is configured as a website, redirects requests for this object to another object in the same bucketName or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - This is a convenience property for Headers.ContentType. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - /// - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The customer provided encryption key for the source object of the copy. - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - true if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the CopySourceServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if CopySourceServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - The tag-set for the object destination object this value must be used in conjunction with the TaggingDirective. The tag-set must be encoded as URL Query parameters. - - - - - Checks if Tagging property is set - - true if Tagging is set. - - - - Returns information about the CopyObject response and response metadata. - - - - - Gets and sets the ETag property. - - - - - Gets and sets the LastModified property. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - Gets and sets the SourceVersionId property. - This is the Version Id of the Source Object - - - - - Version ID of the newly created copy. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the CopyPart operation. - Uploads a part by copying data from an existing object as data source. - - - - - The name of the bucket containing the object to copy. - - - - - Checks if SourceBucket property is set. - - true if SourceBucket property is set. - - - - The key of the object to copy. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Checks if SourceKey property is set. - - true if SourceKey property is set. - - - - Specifies a particular version of the source object to copy. By default the latest version is copied. - - - - - Checks if SourceVersionId property is set. - - true if SourceVersionId property is set. - - - - The name of the bucket to contain the copy of the source object. - - - - - Checks if DestinationBucket property is set. - - true if DestinationBucket property is set. - - - - The key to be given to the copy of the source object. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Checks if DestinationKey property is set. - - true if DestinationKey property is set. - - - - The ID identifying multipart upload for which we are copying a part. - - - - - Checks if UploadId property is set. - - true if UploadId property is set. - - - - Collection of ETags to be matched as a pre-condition for copying the source object - otherwise returns a PreconditionFailed. - - - Copies the object if its entity tag (ETag) matches one of - the specified tags; otherwise return a 412 (precondition failed). - Constraints: This property can be used with IfUnmodifiedSince, - but cannot be used with other conditional copy properties. - - - - - Checks if ETagsToMatch property is set. - - true if ETagToMatch property is set. - - - - Collection of ETags that must not be matched as a pre-condition for copying the source object - otherwise returns a PreconditionFailed. - - - Copies the object if its entity tag (ETag) does not match any of the specified - tags; otherwise returns a 412 (failed condition). - Constraints: This header can be used with IfModifiedSince, but cannot - be used with other conditional copy properties. - - - - - Checks if ETagToNotMatch property is set. - - true if ETagToNotMatch property is set. - - - - Copies the object if it has been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it has been modified since the - specified time; otherwise returns a 412 (failed condition). - Constraints: This property can be used with ETagToNotMatch, - but cannot be used with other conditional copy properties. - - - - - Checks if ModifiedSinceDate property is set. - - true if ModifiedSinceDate property is set. - - - - Copies the object if it has not been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it hasn't been modified since the - specified time; otherwise returns a 412 (precondition failed). - Constraints: This property can be used with ETagToMatch, - but cannot be used with other conditional copy properties. - - - - - Checks if UnmodifiedSinceDate property is set. - - true if UnmodifiedSinceDate property is set. - - - - The number of the part to be copied. - - - Valid part numbers are from 1 to 10,000 inclusive and will uniquely identify the part - and determine the relative ordering within the destination object. If a part already - exists with the PartNumber it will be overwritten. - - - - - Checks if PartNumber property is set. - - true if PartNumber property is set. - - - - The location of the first byte in the range if only a portion of the - source object is to be copied as the part. - - - The LastByte property must also be set or this value will be ignored. - - - - - Checks if FirstByte property is set. - - true if FirstByte property is set. - - - - The location of the last byte in the range if only a portion of the - source object is to be copied as the part. - - - The FirstByte property must also be set or this value will be ignored. - - - - - Checks if LastByte property is set. - - true if LastByte property is set. - - - - - This property is obsolete. Use ServerSideEncryptionMethod in InitiateMultipartUploadRequest instead. - - - Default: None - - - - - - Checks if ServerSideEncryptionMethod property is set. - - true if ServerSideEncryptionMethod property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - This property is obsolete. Use ServerSideEncryptionKeyManagementServiceKeyId in InitiateMultipartUploadRequest instead. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The customer provided encryption key for the source object of the copy. - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - true if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the CopySourceServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if CopySourceServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - - - Returns information about the CopyPart response and response metadata. - - - - - The version of the source object that was copied, if you have enabled versioning on the source bucketName. - - - - - - Entity tag of the object. - - - - - - Date and time at which the object was uploaded. - - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - Gets and sets the PartNumber property. - This is the part number in it's multi-part upload that will uniquely identify the part - and determine the relative ordering within the destination object. - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - A collection of up to 100 cross-origin resource sharing (CORS) rules. - - - - - The collection of rules in this configuration. - - - - C O R S Rule - - - - - Identifies HTTP methods that the domain/origin specified in the rule is allowed to execute. - - - - - - One or more origins you want customers to be able to access the bucket from. - - - - - - An optional unique identifier for the rule. - - - The ID value can be up to 255 characters long. The IDs help you find a rule in the configuration. - - - - - Checks if Id property is set. - - true if Id property is set. - - - - One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript - XMLHttpRequest object). - - - - - - The time in seconds that your browser is to cache the preflight response for the specified resource. - - - - - - Specifies which headers are allowed in a pre-flight OPTIONS request through the - Access-Control-Request-Headers header. - - - Each header name specified in the Access-Control-Request-Headers must have a corresponding - entry in the rule. Only the headers that were requested will be sent back. - This element can contain at most one * wildcard character. - - - - - Checks if AllowedHeaders property is set. - - true if AllowedHeaders property is set. - - - - Describes how a CSV-formatted input object is formatted. - - - - - Describes the first line of input. Valid values: None, Ignore, Use. - - - - - Single character used to indicate a row should be ignored when present at the start of a row. - - - - - Single character used for escaping the quote character inside an already escaped value. - - - - - Value used to separate individual records. - - - - - Value used to separate individual fields in a record. - - - - - Value used for escaping where the field delimiter is part of the value. - - - - - Specifies that CSV field values may contain quoted record delimiters and such records should be allowed. Default value is FALSE. Setting this value to TRUE may lower performance. - - - - - Describes how CSV-formatted results are formatted. - - - - - Indicates whether or not all output fields should be quoted. - - - - - Single character used for escaping the quote character inside an already escaped value. - - - - - Value used to separate individual records. - - - - - Value used to separate individual fields in a record. - - - - - Value used for escaping where the field delimiter is part of the value. - - - - - The container element for specifying the default Object Lock retention settings for - new objects placed in the specified bucket. - - - - - Gets and sets the property Days. - - The number of days that you want to specify for the default retention period. - - - - - - Gets and sets the property Mode. - - The default Object Lock retention mode you want to apply to new objects placed in - the specified bucket. - - - - - - Gets and sets the property Years. - - The number of years that you want to specify for the default retention period. - - - - - - Container for the parameters to the DeleteBucketAnalyticsConfiguration operation. - Deletes an analytics configuration for the bucket (specified by the analytics configuration ID). - - - - - The name of the bucket from which an analytics configuration is deleted. - - - - - The identifier used to represent an analytics configuration. - - - - - Returns information about the DeleteBucketAnalyticsConfiguration response metadata. - The DeleteBucketAnalyticsConfiguration operation has a void result type. - - - - - Request object for the DeleteBucketEncryption operation. - Request Deletes the server-side encryption configuration from the bucket. - - - - - The name of the bucket containing the server-side encryption configuration to delete. - - - - - Returns information about the DeleteBucketEncryption response metadata. - The DeleteBucketEncryption operation has a void result type. - - - - - Container for the parameters to the DeleteInventoryConfiguration operation. - Deletes an inventory configuration (identified by the inventory ID) from the bucket. - - - - - The name of the bucket containing the inventory configuration to delete. - - - - - The ID used to identify the inventory configuration. - - - - - Returns information about the DeleteInventoryConfiguration response metadata. - The DeleteInventoryConfiguration operation has a void result type. - - - - - Container for the parameters to the DeleteBucketMetricsConfiguration operation. - Deletes a metrics configuration (specified by the metrics configuration ID) from the bucket. - - - - - The name of the bucket on which Inventory configuration is to be removed. - - - - - The ID used to identify the metrics configuration. - - - - - Returns information about the DeleteBucketMetricsConfiguration response metadata. - The DeleteBucketMetricsConfiguration operation has a void result type. - - - - - Container for the parameters to the DeleteBucketPolicy operation. - Deletes the policy from the bucket. - - - - - The bucket on which the policy is to be deleted. - - - - - Returns information about the DeleteBucketPolicy response metadata. - The DeleteBucketPolicy operation has a void result type. - - - - - Request object for the DeleteBucketReplication operation. - - - - - Gets and sets the property BucketName. -

Deletes the replication subresource associated with the specified - bucket.

There is usually some time lag before - replication configuration deletion is fully propagated to all the - Amazon S3 systems.

For more information, see - - Cross-Region Replication (CRR) in the Amazon S3 Developer - Guide.

- - - - - Returns information about the DeleteBucketReplication response metadata. - The DeleteBucketReplication operation has a void result type. - - - - - Container for the parameters to the DeleteBucket operation. - Deletes the bucket. All objects (including all object versions and Delete Markers) in the bucket must be deleted before the bucket - itself can be deleted. - - - - - The name of the bucket to be created. - - - - - The region locality for the bucket. - - - When set, this will determine the region the bucket exists in. - Refer - for a list of possible values. - - - - - If set to true the bucket will be deleted in the same region as the configuration of the AmazonS3 client. - DeleteBucketRequest.BucketRegion takes precedence over this property if both are set. - Default: true. - - - - - Returns information about the DeleteBucket response metadata. - The DeleteBucket operation has a void result type. - - - - - The parameters to request deletion of a tag set from a bucket. - - - To use this operation, you must have permission to perform the s3:PutBucketTagging action. - By default, the bucket owner has this permission and can grant this permission to others. - - - - - The name of the bucket on which the tag set is to be removed. - - - - - Returns information about the DeleteBucketTagging response metadata. - The DeleteBucketTagging operation has a void result type. - - - - - Container for the parameters to the DeleteBucketWebsite operation. - This operation removes the website configuration from the bucket. - - - - - The name of the bucket on which website configuration is to be removed. - - - - - Returns information about the DeleteBucketWebsite response metadata. - The DeleteBucketWebsite operation has a void result type. - - - - - Container for the parameters to the DeleteCORSConfiguration operation. - Deletes the cors configuration information set for the bucket. - - - - - Gets and sets the BucketName property. - - - - - Returns information about the DeleteCORSConfiguration response metadata. - The DeleteCORSConfiguration operation has a void result type. - - - - - Contains information about a successful delete operation against a specific S3 object. - - - - - Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a - delete marker. In a simple DELETE, this header indicates whether (true) or not (false) a delete - marker was created. - - - - - The version ID of the delete marker created as a result of the DELETE operation. If you delete a - specific object version, the value returned by this header is the version ID of the object version - deleted. - - - - - The key of the deleted S3 object. - - - - - The version of the deleted S3 object. - - - - - Contains information about a failed delete operation against a specific S3 object. - - - - - The key of the S3 object. - - - - - The version of the S3 object. - - - - - The failure code for the delete error. - - - - - The failure message for the delete error. - - - - - The parameters to request deletion of the lifecycle configuration on a bucket. - - - - Amazon S3 removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. - Your objects never expire, and Amazon S3 no longer automatically deletes any objects on the basis of rules contained - in the deleted lifecycle configuration. - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration action. By default, the - bucket owner has this permission and the bucket owner can grant this permission to others. - - - There is usually some time lag before lifecycle configuration deletion is fully propagated to all the Amazon S3 systems. - - - - - - The name of the bucket on which the lifecycle configuration is to be deleted. - - - - - Returns information about the DeleteLifecycleConfiguration response metadata. - The DeleteLifecycleConfiguration operation has a void result type. - - - - -

Specifies whether Amazon S3 should replicate delete makers.

- - - - - Gets and sets the property Status. -

The status of the delete marker replication.

-

In the current implementation, Amazon S3 does not replicate - the delete markers. Therefore, the status must be - Disabled.

- - - - - The parameters to request deletion of an object in a bucket. - The operation removes the null version (if there is one) of an object and inserts a delete marker, which - becomes the latest version of the object. - - - - To remove a specific version, you must be the bucket owner and you must use the versionId subresource. - Using this subresource permanently deletes the version. - - - If the object you want to delete is in a bucket where the bucket versioning configuration is MFA Delete enabled, - you must include specify the MFA serial number and value in the request. - - - If there isn't a null version, Amazon S3 does not remove any objects. - - - - - - The bucket name of the bucket containing the object. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property BypassGovernanceRetention. - - - - - The key identifying the object to delete. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - The identifier for the specific version of the object to be deleted, if required. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - The MfaCodes Tuple associates the Serial Number and the current Token/Code displayed on the - Multi-Factor Authentication device associated with your AWS Account. - - - This is a required property for this request if:
- 1. EnableMfaDelete was configured on the bucket - containing this object's version.
- 2. You are deleting an object's version - - - - - Checks if the MfaCodes property is set. - - true if the MfaCodes property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the DeleteObject response and response metadata. - - - - - Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a delete marker. - - - - - - Returns the version ID of the delete marker created as a result of the DELETE operation. - - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the DeleteObjects operation. - This operation enables you to delete multiple objects from a bucket using a single HTTP request. You may specify up to 1000 - keys. - - - Container for the parameters to the DeleteObjects operation. - This operation enables you to delete multiple objects from a bucket using a single HTTP request. You may specify up to 1000 - keys. - - - - - The bucket name containing the objects to delete. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property BypassGovernanceRetention. - - Specifies whether you want to delete this object even if it has a Governance-type - Object Lock in place. You must have sufficient permissions to perform this operation. - - - - - - List of object keys to delete. - - - - - Toggles between Quiet and Verbose mode for the operation. - If set to true (Quiet mode), the response includes only those keys for objects on which - the delete operation failed. - - - By default this property is false and keys for both successful deletes - and failures are returned in the response. - - - - - The MfaCodes Tuple associates the Serial Number and the current Token/Code displayed on the - Multi-Factor Authentication device associated with your AWS Account. - - - This is a required property for this request if:
- 1. EnableMfaDelete was configured on the bucket - containing this object's version.
- 2. You are deleting an object's version - - - - - Checks if the MfaCodes property is set. - - true if the MfaCodes property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Add a key to the set of keys of objects to be deleted. - - Object key - - - - Add a key and a version to be deleted. - - Key of the object to be deleted. - Version of the object to be deleted. - - - - Add a KeyVersion object representing the S3 object to be deleted. - - KeyVersion representation of object to be deleted. - - - - Returns information about the DeleteObjects response and response metadata. - - - - - A default constructor for DeleteObjectsResponse - - - - - Gets and sets the DeletedObjects property. - A list of successful deletes. - Set only when Quiet=false on DeleteObjectsRequest. - - - - - Gets and sets the DeleteErrors property. - A list of errors encountered while deleting objects. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the DeleteObjectTaggingRequest operation. - - - - - The bucket name containing the objects from which to remove the tags. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Check to see if Bucket property is set - - - - - The key identifying the object tagging to delete. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Check to see if Key property is set - - - - - The identifier for the specific version of the object to be deleted, if required. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - Returns information about the DeleteObjectTagging response and response metadata. - - - - - Returns the version ID of the delete marker created as a result of the DELETE operation. - - - - - Check to see if VersionId property is set - - - - - Container for the parameters to the DeletePublicAccessBlock operation. - Removes the Public Access Block configuration for an Amazon S3 bucket. - - - - - Gets and sets the property BucketName. - - The Amazon S3 bucket whose Public Access Block configuration you want to delete. - - - - - - This is the response object from the DeletePublicAccessBlock operation. - - - - - EncryptionConfiguration class - - - - - The ID of the AWS KMS key for the region where the destination bucket - resides. Amazon S3 uses this key to encrypt the replica object. - - - - - A container that specifies information about existing object replication. You can choose whether to enable or disable the replication of existing objects. - - - - - Specifies whether existing object replication is enabled. - - - - - Defines the expiration policy for a given object. - - - - - This property is deprecated. This property exposes a DateTime of kind Unspecified. Use ExpiryDateUtc instead. - The date and time for expiry. - - - - - The date and time for expiry. - - - - - Id of the configuration rule for this expiry. - - - - - Constructs an empty instance of an Expiration object - - - - Bucket - Represents a set of filter criteria that limits the objects that can trigger event notifications - - - - - Filter criteria that limits the objects that can trigger event notifications based on their S3 Key name. - - - - - Bucket - Represents a Filter Rule for a NotificationConfiguration. - - - - - Constructs an empty FilterRule. - - - - - Constructs a FilterRule with a specific name and value. - - - - - - - The name of the filter rule. - - - - - The value of the filter rule. - - - - - Container for the parameters to the GetACL operation. - Returns the access control list (ACL) of an object. - - - - - The bucket name that contains the object for which to get the ACL information. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The key of the S3 object to be queried. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - VersionId used to reference a specific version of the object. - - - - - Returns information about the GetACL response and response metadata. - - - - - Gets and sets the AccessControlList property. - - - - - Container for the parameters to the GetBucketAccelerateConfiguration operation. - - - - - The name of the bucket. - - - - - The response class for GetBucketAccelerateConfiguration operation. - - - - - The accelerate status of the bucket. - - - - - Container for the parameters to the GetBucketAnalyticsConfiguration operation. - Gets an analytics configuration for the bucket (specified by the analytics configuration ID). - - - - - The name of the bucket from which an analytics configuration is retrieved. - - - - - The identifier used to represent an analytics configuration. - - - - - GetBucketAnalyticsConfigurationResponse Response - - - - - The configuration and any analyses for the analytics filter. - - - - - Container for the parameters to the GetBucketEncryptionRequest operation. - Returns the server-side encryption configuration of a bucket. - - - - - The name of the bucket. - - - - - GetBucketEncryptionResponse Response - - - - - Container for server-side encryption configuration rules. Currently S3 supports one rule only. - - - - - Container for the parameters to the GetInventoryConfigurationRequest operation. - Returns an inventory configuration (identified by the inventory ID) from the bucket. - - - - - The name of the bucket containing the inventory configuration to retrieve. - - - - - The ID used to identify the inventory configuration. - - - - - GetInventoryConfigurationResponse Response - - - - - Specifies the inventory configuration. - - - - - Container for the parameters to the GetBucketLocation operation. - Returns the region the bucket resides in. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetBucketLocation response and response metadata. - - - - - Gets and sets the Location property. - If the the bucket is located in us-east-1 S3Region.US will be return which has a - value of empty string. - - - - - Container for the parameters to the GetBucketLogging operation. - Returns the logging status of a bucket and the permissions users have to view and modify that status. To use GET, you must be the - bucket owner. - - - - - The name of the bucket to query. - - - - - Returns information about the GetBucketLogging response and response metadata. - - - - - Gets and sets the LoggingConfig property. - - - - - Container for the parameters to the GetBucketMetricsConfiguration operation. - Gets a metrics configuration (specified by the metrics configuration ID) from the bucket. - - - - - The name of the bucket containing the metrics configuration to retrieve. - - - - - The ID used to identify the metrics configuration. - - - - - GetBucketMetricsConfiguration Response - - - - - Specifies the metrics configuration. - - - - - Container for the parameters to the GetBucketNotification operation. - Return the notification configuration of a bucket. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetBucketNotification response and response metadata. - - - - - Gets and sets the TopicConfigurations property. TopicConfigurations are configuration - for Amazon S3 events to be sent to Amazon SNS topics. - - - - - Gets and sets the QueueConfigurations property. QueueConfigurations are configuration - for Amazon S3 events to be sent to Amazon SQS queues. - - - - - Gets and sets the LambdaFunctionConfigurations property. LambdaFunctionConfigurations are configuration - for Amazon S3 events to be sent to an Amazon Lambda cloud function. - - - - - Container for the parameters to the GetBucketPolicy operation. - Returns the policy of a specified bucket. - - - - - The name of the bucket. - - - - - Get BucketName Policy Response - - - - - The bucket policy as a JSON document. - - - - - Container for the parameters to the GetBucketPolicyStatus operation. - Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket - is public. - - - - - Gets and sets the property BucketName. - - The name of the Amazon S3 bucket whose public-policy status you want to retrieve. - - - - - - This is the response object from the GetBucketPolicyStatus operation. - - - - - The public-policy status for this bucket. - - - - - Container for the parameters to the GetBucketReplicationConfiguration operation. - Returns the replication configuration information set on the bucket. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetReplicationConfiguration response and response metadata. - - - - - The replication configuration for the buccket specified in the request. - - - - - Container for the parameters to the GetBucketRequestPayment operation. - Returns the request payment configuration of a bucket. - - - - - The name of the bucket. - - - - - Returns information about the GetBucketRequestPayment response and response metadata. - - - - - Specifies who pays for the download and request fees. - - - - - - Container for the parameters to the GetBucketTagging operation. - Returns the tag set associated with the bucket. - - - - - The name of the bucket to be queried. - - - - - Returns information about the GetBucketTagging response and response metadata. - - - - - The collection of tags. - - - - - Container for the parameters to the GetBucketVersioning operation. - Returns the versioning state of a bucket. - - - - - The name of the bucket to be queried. - - - - - Returns information about the GetBucketVersioning response and response metadata. - - - - - Gets and sets the Versioning property. - Unless Versioning has been explicitly "Enabled" on a bucket, - Versioning Status is "Off". Once Versioning has been - "Enabled", it can be "Suspended" but cannot be switched "Off". - - - - - Container for the parameters to the GetBucketWebsite operation. - Returns the website configuration for a bucket. - - - - - The name of the bucket to be queried. - - - - - Returns information about the GetBucketWebsite response and response metadata. - - - - - Gets and sets the WebsiteConfiguration property. - - This is where the index document suffix and custom error page are defined. - - - - - Container for the parameters to the GetBucketCors operation. - Returns the cors configuration for the bucket. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetBucketCors response and response metadata. - - - - - The current CORSConfiguration for the bucket. - - - - - Container for the parameters to the GetLifecycleConfiguration operation. - Returns the lifecycle configuration information set on the bucket. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetLifecycleConfiguration response and response metadata. - - - - - Gets and Sets the property that governs whether - the response includes successful deletes as well as errors - following the DeleteObjects call against S3. - - By default this property is false and successful deletes - are returned in the response. - - - - - Container for the parameters to the GetObjectLegalHold operation. - Gets an object's current Legal Hold status. - - - - - The bucket name containing the object whose Legal Hold status you want to retrieve. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property Key. - - The key name for the object whose Legal Hold status you want to retrieve. - - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property VersionId. - - The version ID of the object whose Legal Hold status you want to retrieve. - - - - - - This is the response object from the GetObjectLegalHold operation. - - - - - Gets and sets the property LegalHold. - - The current Legal Hold status for the specified object. - - - - - - Container for the parameters to the GetObjectLockConfiguration operation. - Gets the Object Lock configuration for a bucket. The rule specified in the Object - Lock configuration will be applied by default to every new object placed in the specified - bucket. - - - - - Gets and sets the property BucketName. - - The bucket whose Object Lock configuration you want to retrieve. - - - - - - This is the response object from the GetObjectLockConfiguration operation. - - - - - Gets and sets the property ObjectLockConfiguration. - - The specified bucket's Object Lock configuration. - - - - - - Container for the parameters to the HeadObject operation. - The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you''re only - interested in an object''s metadata. To use HEAD, you must have READ access to the object. - - - - - The name of the bucket that contains the object. - - - - - ETag to be matched as a pre-condition for returning the object, - otherwise a PreconditionFailed signal is returned. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or - ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Returns the object only if it has been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Returns the object only if it has been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - ETag that should not be matched as a pre-condition for returning the object, - otherwise a PreconditionFailed signal is returned. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or - UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Returns the object only if it has not been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Returns the object only if it has not been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - The key of the object. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - VersionId used to reference a specific version of the object. - - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to decrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - Part number of the object being read. This is a positive integer between 1 and 10,000. - Effectively performs a 'ranged' HEAD request for the part specified. - Useful querying about the size of the part and the number of parts in this object. - - - - - Check if PartNumber property is set. - - true if PartNumber property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the HeadObject response and response metadata. - - - - - Flag which returns true if the Expires property has been unmarshalled - from the raw value or set by user code. - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the - response. - - - - - - Gets and sets the AcceptRanges. - - - - - Gets and sets the ContentRange. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - Gets and sets the RestoreExpiration property. - RestoreExpiration will be set for objects that have been restored from Amazon Glacier. - It indiciates for those objects how long the restored object will exist. - - - - - Gets and sets the RestoreInProgress - Will be true when the object is in the process of being restored from Amazon Glacier. - - - - - Last modified date of the object - - - - - - An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL - - - - - - This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like - SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal - HTTP headers. - - - - - - Version of the object. - - - - - - The date and time at which the object is no longer cacheable. - - - - - - If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The status of the replication job associated with this source object. - - - - - Checks if ReplicationStatus property is set. - - true if ReplicationStatus property is set. - - - - The count of parts this object has. - - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - The Legal Hold status for the specified object. - - - - - - Gets and sets the property ObjectLockMode. - - The Object Lock mode currently in place for this object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - The date and time when this object's Object Lock will expire. - - - - - - The class of storage used to store the object. - - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the GetObject operation. - Retrieves objects from Amazon S3. - - - - - The bucket name containing the object. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - ETag to be matched as a pre-condition for returning the object, - otherwise a PreconditionFailed signal is returned. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or - ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Returns the object only if it has been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Returns the object only if it has been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - ETag that should not be matched as a pre-condition for returning the object, - otherwise a PreconditionFailed signal is returned. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or - UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Returns the object only if it has not been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Returns the object only if it has not been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Gets and sets the Key property. This is the user defined key that identifies the object in the bucket. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Downloads the specified range bytes of an object. - - - - - A set of response headers that should be returned with the object. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ResponseExpiresUtc instead. Setting either ResponseExpires or - ResponseExpiresUtc results in both ResponseExpires and ResponseExpiresUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ResponseExpires is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Sets the Expires header of the response. - - - - - Sets the Expires header of the response. - - - - - VersionId used to reference a specific version of the object. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to decrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - Part number of the object being read. This is a positive integer between 1 and 10,000. - Effectively performs a 'ranged' GET request for the part specified. Useful for downloading just a part of an object. - - - - - Checks if PartNumber property is set. - - true if PartNumber property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the GetObject response and response metadata. - - - - - Flag which returns true if the Expires property has been unmarshalled - from the raw value or set by user code. - - - - - Gets and sets the BucketName property. - - - - - Gets and sets the Key property. - - - - - Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the - response. - - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - Gets and sets the AcceptRanges. - - - - - Gets and sets the ContentRange. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - Gets and sets the RestoreExpiration property. - RestoreExpiration will be set for objects that have been restored from Amazon Glacier. - It indiciates for those objects how long the restored object will exist. - - - - - Gets and sets the RestoreInProgress - Will be true when the object is in the process of being restored from Amazon Glacier. - - - - - Last modified date of the object - - - - - - An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL - - - - - - This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like - SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal - HTTP headers. - - - - - - Version of the object. - - - - - - The date and time at which the object is no longer cacheable. - - - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - - - - Gets and sets the property ObjectLockMode. - - The Object Lock mode currently in place for this object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - The date and time when this object's Object Lock will expire. - - - - - - If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The class of storage used to store the object. - - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The status of the replication job associated with this source object. - - - - - Checks if ReplicationStatus property is set. - - true if ReplicationStatus property is set. - - - - The number of parts this oject has. - - - - - Checks if PartsCount is set. - - true if PartsCount property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - The number of tags, if any, on the object. - - - - - The event for Write Object progress notifications. All - subscribers will be notified when a new progress - event is raised. - - - Subscribe to this event if you want to receive - put object progress notifications. Here is how:
- 1. Define a method with a signature similar to this one: - - private void displayProgress(object sender, WriteObjectProgressArgs args) - { - Console.WriteLine(args); - } - - 2. Add this method to the Put Object Progress Event delegate's invocation list - - GetObjectResponse response = s3Client.GetObject(request); - response.WriteObjectProgressEvent += displayProgress; - - - - - - This method is called by a producer of write object progress - notifications. When called, all the subscribers in the - invocation list will be called sequentially. - - The file being written. - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - True if transfer is complete - - - - Writes the content of the ResponseStream a file indicated by the filePath argument. - - The location where to write the ResponseStream - Whether or not to append to the file if it exists - - - - Encapsulates the information needed to provide - download progress for the Write Object Event. - - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The bucket name for the S3 object being written. - The object key for the S3 object being written. - The version-id of the S3 object. - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - True if finished writing - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The bucket name for the S3 object being written. - The object key for the S3 object being written. - The file for the S3 object being written. - The version-id of the S3 object. - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - True if finished writing - - - - Gets the bucket name for the S3 object being written. - - - - - Gets the object key for the S3 object being written. - - - - - Gets the version-id of the S3 object. - - - - - The file for the S3 object being written. - - - - - True if writing is complete - - - - - Container for the parameters to the GetObjectRetention operation. - Retrieves an object's retention settings. - - - - - The bucket name containing the object whose retention settings you want to retrieve. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property Key. - - The key name for the object whose retention settings you want to retrieve. - - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property VersionId. - - The version ID for the object whose retention settings you want to retrieve. - - - - - - This is the response object from the GetObjectRetention operation. - - - - - Gets and sets the property Retention. - - The container element for an object's retention settings. - - - - - - Container for the parameters to the GetObjectTaggingRequest operation. - - - - - The bucket name containing the object for which to get the tagging information. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Check to see if Bucket property is set - - - - - Gets and sets the Key property. This is the user defined key that identifies the object in the bucket. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Check to see if Key property is set - - - - - VersionId used to reference a specific version of the object. - - - - - - Returns information about the GetObjectTagging response and response metadata. - - - - - Gets or sets tag-set for a given object - - - - - Container for the parameters to the GetObjectTorrent operation. - Return torrent files from a bucket. - - - - - The name of the bucket containing the object. - - - - - The key identifying the object. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the GetObjectTorrent response and response metadata. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - The parameters to create a pre-signed URL to a bucket or object. - - - For more information, refer to: . -
Required Parameters: BucketName, Expires -
Optional Parameters: Key, VersionId, Verb: default is GET - - - - - The name of the bucket to create a pre-signed url to, or containing the object. - - - - - Checks if BucketName property is set. - - true if BucketName property is set. - - - - The key to the object for which a pre-signed url should be created. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Checks if Key property is set. - - true if Key property is set. - - - - A standard MIME type describing the format of the object data. - - - - The content type for the content being uploaded. This property defaults to "binary/octet-stream". - For more information, refer to: . - - - Note that if content type is specified, it should also be included in the HttpRequest headers - of the eventual upload request, otherwise a signature error may result. - - - - - - The expiry date and time for the pre-signed url. - - - - - Checks if Expires property is set. - - true if Expires property is set. - - - - The requested protocol (http/https) for the pre-signed url. - - - Defaults to https. - - - - - The verb for the pre-signed url. - - - Accepted verbs are GET, PUT, DELETE and HEAD. - Default is GET. - - - - - Version id for the object that the pre-signed url will reference. If not set, - the url will reference the latest version of the object. - - - This is the VersionId for the S3 Object you want to get - a PreSigned URL for. The VersionId property will be ignored - for PreSigned "PUT" requests and for requests that don't specify - the Key property. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - The upload id for the multipart upload for which a pre-signed url should be created. - - - - - Checks if UploadId property is set. - - true if UploadId property is set. - - - - The part number for the multipart upload for which a pre-signed url should be created. - - - - - Checks if PartNumber property is set. - - true if PartNumber property is set. - - - - Specifies the encryption used on the server to store the content. - - - - Default is None. - - - If specifying encryption (not None), the corresponding request must include header - "x-amz-server-side-encryption" with the value of the encryption. - - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - Confirms that the requester knows that she or he will be charged for the request. - Bucket owners need not specify this parameter in their requests. - - - - - A set of response headers that should be returned with the pre-signed url creation response. - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - Custom parameters to include in the signed request, so that they are tamper-proof. - - - - - The parameters for a pre-signed URL to a bucket or object as a string. - - - For more information, refer to: . - - - - - The PreSignedURL as a string - - - - - Constructor - - A url returned from GetPreSignedUrlRequest - - - - Container for the parameters to the GetPublicAccessBlock operation. - Retrieves the Public Access Block configuration for an Amazon S3 bucket. - - - - - Gets and sets the property BucketName. - - The name of the Amazon S3 bucket whose Public Access Block configuration you want - to retrieve. - - - - - - This is the response object from the GetPublicAccessBlock operation. - - - - - The Public Access Block configuration currently in effect for this Amazon S3 bucket. - - - - - Container for the parameters to the HeadBucket operation. - This operation is useful to determine if a bucket exists and you have permission to access it. - - - - - Returns information about the HeadBucket response metadata. - The HeadBucket operation has a void result type. - - - - - This class contains the headers for an S3 object. - - - - - Gets and sets headers to set for the object. - - The name of the header - The value for the header - - - - Gets the count of headers. - - - - - Gets the names of the headers set. - - - - - Specifies caching behavior along the request/reply chain. - - - - - - Specifies presentational information for the object. - - - - - - Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type - referenced by the Content-Type header field. - - - - - - The size of the object, in bytes. - - - - - The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. This - header can be used as a message integrity check to verify that the data is the same data that was originally sent. - - - - - A standard MIME type describing the format of the object data. - - - - - - The date and time at which the object is no longer cacheable. - - - - - - - Container for the parameters to the InitiateMultipartUpload operation. - Initiates a multipart upload and returns an upload ID. - - - - - Envelope Key to Encrypt data - - - - - Encrypted Envelope Key to Encrypt data - - - - - Initialization Vector for encryption - - - - - A canned access control list (ACL) to apply to the object. - Please refer to for information on S3 Canned ACLs. - - - - - The name of the bucketName where the new object will be created, or existing object updated. - - - - - The key of the object to create or update. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - StorageClass property for the object. - - - Default: S3StorageClass.Standard. Set this property - only if you want reduced redundancy for this object. - Please refer to - for - information on S3 Storage Classes. - - - - - If the bucketName is configured as a website, redirects requests for this object to another object in the same bucketName or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - This is a convenience property for Headers.ContentType. - - - - - - Specifies the encryption to be used on the server for the new object. - - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - Checks if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - true if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - Specifies whether you want to apply a Legal Hold to the uploaded object. - - - - - - Gets and sets the property ObjectLockMode. - - Specifies the Object Lock mode that you want to apply to the uploaded object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - Specifies the date and time when you want the Object Lock to expire. - - - - - - The tag-set for the object. The tag-set must be encoded as URL Query parameters. - - - - - Checks if Tagging property is set - - true if Tagging is set. - - - - Returns information about the InitiateMultipartUpload response and response metadata. - - - - - Name of the bucketName to which the multipart upload was initiated. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Object key for which the multipart upload was initiated. - - - - - - Gets and sets the initiated multipart upload id. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - Date when multipart upload will become eligible for abort operation by lifecycle. - - - - - Id of the lifecycle rule that makes a multipart upload eligible for abort operation. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Identifies who initiated the multipart upload. - - - - - Name of the Principal. - - - - - - If the principal is an AWS account, it provides the Canonical User ID. If the principal is an IAM User, it provides a user ARN value. - - - - - - Describes the serialization format of the object. - - - - - Describes the serialization of a CSV-encoded object. - - - - - Specifies object's compression format. Valid values: NONE, GZIP. Default Value: NONE. - - - - - Specifies JSON as object's input serialization format. - - - - - Specifies Parquet as object's input serialization format. - - - - - Class for MetricsConfiguration - - - - - Contains information about where to publish the inventory results. - - - - - Specifies whether the inventory is enabled or disabled. - - - - - Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria. - - - - - The ID used to identify the inventory configuration. - - - - - Specifies which object version(s) to included in the inventory results. - - - - - Contains the optional fields that are included in the inventory results. - - - - - Specifies the schedule for generating inventory results. - - - - - Class for InventoryDestination - - - - - Contains the bucket name, file format, bucket owner (optional), and prefix (optional) where inventory results are published. - - - - - InventoryEncryption class - - - - - Specifies the use of SSE-S3 to encrypt delievered Inventory reports. - - - - - Specifies the use of SSE-KMS to encrypt delievered Inventory reports. - - - - - Class for InventoryFilter - - - - - Filter Predicate setup for specific filter types. - - - - - Filter Predicate abstract class for specific filter types to be derived from. - - - - - Class for InventoryPrefixPredicate - The prefix that an object must have to be included in the inventory results. - - - - - The ID of the account that owns the destination bucket. - - - - - The Amazon resource name (ARN) of the bucket where inventory results will be published. - - - - - The prefix that is prepended to all inventory results. - - - - - Specifies the output format of the inventory results. - - - - - Contains the type of server-side encryption used to encrypt the inventory results. - - - - - Class for InventorySchedule - - - - - Specifies how frequently inventory results are produced. - - - - - Specifies JSON as object's input serialization format. - - - - - The type of JSON. Valid values: Document, Lines. - - - - - Specifies JSON as request's output serialization format - - - - - The value used to separate individual records in the output. - - - - - Specifies an object key and optional object version. - - - - - Key name of the object to delete. - - - - - - VersionId for the specific version of the object to delete. - - - - - - This class contains the configuration Amazon S3 uses to figure out what events you want to listen - and send the event to an Amazon Lambda cloud function. - - - - - Gets and set the Id property. The Id will be provided in the event content and can be used - to identify which configuration caused an event to fire. If the Id is not provided for the configuration, one will be generated. - - - - - Gets and sets the FunctionArn property. This is the Amazon Lambda cloud function to which Amazon S3 will invoke with the events. - - - - Lifecycle Configuration - - - - - Gets and sets the Rules property. These rules defined the lifecycle configuration. - - - - - Base class for all the different predicates that can be used - in a filter. - - - - - This method is called by the visitor when it wants to visit the predicate. - - - - - - Filter identifying one or more objects to which a applies. - - - - - The predicate used by the filter. - - - - - Base class for lifecycle operators. - - - - - The list of objects - that this operator operates on. - - - - - The logical and operator for filtering objects for a - - - - - Accept a visit from an - - - This method is used internally by the SDK. - - - - - - A predicate that filters objects for a - by matching a particular prefix. - - - - - The prefix to be matched by filtered objects. - - - - - Accept a visit from an - - - This method is used internally by the SDK. - - - - - - A predicate that filters objects for a - by matching a particular key and value. - - - - - The Tag to be matched by filtered objects. - - - - - Accept a visit from an - - - This method is used internally by the SDK. - - - - - - Rules Item - - - - - Defines the length of time, in days, before objects expire. - - - - - Unique identifier for the rule. The value cannot be longer than 255 characters. - - - - - Prefix identifying one or more objects to which the rule applies. - - - - - - Filter identifying one or more objects to which the rule applies. - - - - - If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied. - - - - - - The transition rule that describes when objects transition to a different storage class. - - Lifecycle rules can now contain multiple transitions. This property is obsolete in favor of the Transitions property. - This property will always get or set the the zeroth element in the Transitions collection. - - - - - - Defines the length of time, in days, before noncurrent versions expire. - - - - - The transition rule that describes when noncurrent versions transition to - a different storage class. - - Lifecycle rules can now contain multiple noncurrent version transitions. This property - is obsolete in favor of the NoncurrentVersionTransitions property. - This property will always get or set the the zeroth element in the NoncurrentVersionTransitions collection. - - - - - - The transition rules that describe when objects transition to a different storage class. - - - - - The transition rules that describe when noncurrent versions transition to - a different storage class. - - - - - Specifies the days since the initiation of an Incomplete Multipart Upload - that Lifecycle will wait before permanently removing all parts of the upload. - - - - - Specifies the days since the initiation of an Incomplete Multipart Upload - that Lifecycle will wait before permanently removing all parts of the upload. - - - - - Indicates the number of days that must pass since initiation for Lifecycle - to abort an Incomplete Multipart Upload. - - - - Expiration - - - - - Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format. - - - - - - Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer. - - - - - - Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set to true, the delete marker will be expired; if set to false the policy takes no action. This cannot be specified with Days or Date in a Lifecycle Expiration Policy. - - - - - - Noncurrent Version Expiration - - - - - Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated - action. For information about the noncurrent days calculations, see - How Amazon S3 Calculates When an Object Became Noncurrent - in the Amazon Simple Storage Service Developer Guide. - - - - - LifecycleTransition defines when and how objects transition. - - - - - Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated - action. For information about the noncurrent days calculations, see - How Amazon S3 Calculates When an Object Became Noncurrent - in the Amazon Simple Storage Service Developer Guide. - - - - - The class of storage used to store the object. - - - - - - LifecycleTransition defines when and how objects transition. - - - - - Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format. - - - - - - Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer. - - - - - - The class of storage used to store the object. - - - - - - Container for the parameters to the ListInventoryConfigurationsRequest operation. - Lists the analytics configurations for the bucket. - - - - - The name of the bucket containing the analytics configurations to retrieve. - - - - - The ContinuationToken that represents a placeholder from where this request should begin. - - - - - Returns information about the ListBucketAnalyticsConfigurationsResponse response and response metadata. - - - - - The ContinuationToken that represents where this request began. - - - - - The list of analytics configurations for a bucket. - - - - - Indicates whether the returned list of analytics configurations is complete. - A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request. - - - - - NextContinuationToken is sent when isTruncated is true, which indicates that there are more analytics configurations to list. - The next request must include this NextContinuationToken. The token is obfuscated and is not a usable value. - - - - - Container for the parameters to the ListInventoryConfigurationsRequest operation. - Returns a list of inventory configurations for the bucket. - - - - - The name of the bucket containing the inventory configurations to retrieve. - - - - - The marker used to continue an inventory configuration listing that has been truncated. - Use the NextContinuationToken from a previously truncated list response to continue the listing. - The continuation token is an opaque value that Amazon S3 understands. - - - - - Returns information about the ListInventoryConfigurationsResponse response and response metadata. - - - - - If sent in the request, the marker that is used as a starting point for this inventory configuration list response. - - - - - The list of inventory configurations for a bucket. - - - - - Indicates whether the returned list of inventory configurations is truncated in this response. A value of true indicates that the list is truncated. - - - - - The marker used to continue this inventory configuration listing. Use the NextContinuationToken from this response to continue the listing in a subsequent request. - The continuation token is an opaque value that Amazon S3 understands. - - - - - Container for the parameters to the ListBucketMetricsConfigurationRequest operation. - Lists the metrics configurations for the bucket. - - - - - The name of the bucket containing the metrics configurations to retrieve. - - - - - - The marker that is used to continue a metrics configuration listing that has been truncated. - Use the NextContinuationToken from a previously truncated list response to continue the listing. - The continuation token is an opaque value that Amazon S3 understands. - - - - - - Returns information about the ListBucketMetricsConfiguration response and response metadata. - - - - - - The marker that is used to continue a metrics configuration listing that has been truncated. - Use the NextContinuationToken from a previously truncated list response to continue the listing. - The continuation token is an opaque value that Amazon S3 understands. - - - - - - The list of metrics configurations for a bucket. - - - - - - Indicates whether the returned list of metrics configurations is complete. - A value of true indicates that the list is not complete and the NextContinuationToken will be provided for - a subsequent request. - - - - - - - The marker used to continue a metrics configuration listing that has been truncated. - Use the NextContinuationToken from a previously truncated list response to continue the listing. - The continuation token is an opaque value that Amazon S3 understands. - - - - - - Container for the parameters to the ListBuckets operation. - Returns a list of all buckets owned by the authenticated sender of the request. - - - - - Returns information about the ListBuckets response and response metadata. - - - - - List of buckets. - - - - - Owner of the buckets. - - - - - Container for the parameters to the ListMultipartUploads operation. - This operation lists in-progress multipart uploads. - - - - - Name of the bucket to which the multipart upload was initiated. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Character you use to group keys. - - - - - - Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin. - - - - - - Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response body. 1,000 is the maximum number of uploads that - can be returned in a response. - - - - - - Lists in-progress uploads only for those keys that begin with the specified prefix. - - - - - - Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the - upload-id-marker parameter is ignored. - - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - Returns information about the ListMultipartUploads response and response metadata. - - - - - Name of the bucketName to which the multipart upload was initiated. - - - - - - The key at or after which the listing began. - - - - - - Upload ID after which listing began. - - - - - - When a list is truncated, this element specifies the value that should be used for the key-marker request parameter in a subsequent request. - - - - - - When a list is truncated, this element specifies the value that should be used for the upload-id-marker request parameter in a subsequent - request. - - - - - - Maximum number of multipart uploads that could have been included in the response. - - - - - - Indicates whether the returned list of multipart uploads is truncated. A value of true indicates that the list was truncated. The list can - be truncated if the number of multipart uploads exceeds the limit allowed or specified by max uploads. - - - - - - Gets and sets the MultipartUploads property. - - Container for elements related to a particular multipart upload. A response - can contain zero or more Upload elements. - - - - - - Gets and sets the Prefix property. - - - - - Gets and sets the Delimiter property. - - - - - Gets the CommonPrefixes property. - A response can contain CommonPrefixes only if you specify a delimiter. - When you do, CommonPrefixes contains all (if there are any) keys between - Prefix and the next occurrence of the string specified by delimiter. In effect, - CommonPrefixes lists keys that act like subdirectories in the directory specified - by Prefix. For example, if prefix is notes/ and delimiter is a slash (/), in - notes/summer/july, the common prefix is notes/summer/. - - - - - Container for the parameters to the ListObjects operation. - Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a - subset of the objects in a bucket. - - - - - The name of the bucket containing the objects whose keys are to be listed. - - - - - A delimiter is a character you use to group keys. - - - - - Specifies the key to start with when listing objects in a bucket. - - - - - Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more. - - - - - Limits the response to keys that begin with the specified prefix. - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the ListObjects response and response metadata. - - - - - A flag that indicates whether or not Amazon S3 returned all of the results that satisfied - the search criteria. - - - - - Gets and sets the NextMarker property. - NextMarker is set by S3 only if a Delimiter was specified - in the original ListObjects request. If a delimiter was - not specified, the AWS SDK for .NET returns the last Key - of the List of Objects retrieved from S3 as the NextMarker. - - - - - Gets the S3Objects property. This is a list of - objects in the bucket that match your search criteria. - - - - - Gets and sets the Name property which is the name of the bucket. - - - - - Gets and sets the Prefix property. - - - - - Gets and sets the MaxKeys property. This is max number of object keys returned by the list operation. - - - - - Gets the CommonPrefixes property. - A response can contain CommonPrefixes only if you specify a delimiter. - When you do, CommonPrefixes contains all (if there are any) keys between - Prefix and the next occurrence of the string specified by delimiter. In effect, - CommonPrefixes lists keys that act like subdirectories in the directory specified - by Prefix. For example, if prefix is notes/ and delimiter is a slash (/), in - notes/summer/july, the common prefix is notes/summer/. - - - - - Gets and sets the Delimiter property. - Causes keys that contain the same string between the prefix and the - first occurrence of the delimiter to be rolled up into a single result - element in the CommonPrefixes collection. - - - These rolled-up keys are not returned elsewhere in the response. - - - - - Container for the parameters to the ListObjects operation. - Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a - subset of the objects in a bucket. - - - - - Bucket name to list. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - A delimiter is a character you use to group keys. - - - - - Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more. - - - - - Limits the response to keys that begin with the specified prefix. - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts - listing after this specified key. StartAfter can be any key in the bucket. - Cannot be set at the same time as ContinuationToken. - - - - - ContinuationToken indicates Amazon S3 that the list is being continued on this - bucket with a token. ContinuationToken is obfuscated and is not a real key. - - - - - The owner field is not present in ListObjectsV2 responses by default. - If you want to return owner field with each key in the result then set this field to true. - If not specified, the Owner field on S3Object will be null. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the ListObjects response and response metadata. - - - - - A flag that indicates whether or not Amazon S3 returned all of the results that satisfied - the search criteria. - - - - - Gets and sets the S3Objects property. Metadata about each object returned. - - - - - Bucket name. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the Prefix property. - - - - - Gets and sets the MaxKeys property. This is max number of object keys returned by the list operation. - - - - - Gets and sets the CommonPrefixes property. - CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence - of the string specified by delimiter - - - - - Gets and sets the Delimiter property. - Causes keys that contain the same string between the prefix and the - first occurrence of the delimiter to be rolled up into a single result - element in the CommonPrefixes collection. - - - These rolled-up keys are not returned elsewhere in the response. - - - - - Encoding type used by Amazon S3 to encode object keys in the response. - - - - - KeyCount is the number of keys returned with this request. - KeyCount will always be less than or equal to MaxKeys field. - - - - - ContinuationToken indicates Amazon S3 that the list is being continued - on this bucket with a token. - ContinuationToken is obfuscated and is not a real key - - - - - NextContinuationToken is sent when isTruncated is true which means there - are more keys in the bucket that can be listed. The next ListObjectV2 call - to Amazon S3 can be continued with this NextContinuationToken. - NextContinuationToken is obfuscated and is not a real key. - - - - - StartAfter is where you want Amazon S3 to start listing from. - Amazon S3 starts listing after this specified key. - StartAfter can be any key in the bucket. - - - - - Container for the parameters to the ListParts operation. - Lists the parts that have been uploaded for a specific multipart upload. - - - - - Name of the bucket to which the parts are being uploaded. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The object key for which the multipart upload was initiated. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Sets the maximum number of parts to return. - - - - - - Specifies the part after which listing should begin. Only parts with higher part numbers will be listed. - - - - - - Upload ID identifying the multipart upload whose parts are being listed. - - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the ListParts response and response metadata. - - - - - Name of the bucketName to which the multipart upload was initiated. - - - - - - Object key for which the multipart upload was initiated. - - - - - - Upload ID identifying the multipart upload whose parts are being listed. - - - - - - Part number after which listing begins. - - - - - - When a list is truncated, this element specifies the last part in the list, as well as the value to use for the part-number-marker request - parameter in a subsequent request. - - - - - - Maximum number of parts that were allowed in the response. - - - - - - Indicates whether the returned list of parts is truncated. - - - - - - Gets and sets the Parts property. - - PartDetails is a container for elements related to a particular part. A response can contain - zero or more Part elements. - - - - - - Identifies who initiated the multipart upload. - - - - - - Gets and sets the Owner property. - - - - - The class of storage used to store the object. - - - - - - Date when multipart upload will become eligible for abort operation by lifecycle. - - - - - Id of the lifecycle rule that makes a multipart upload eligible for abort operation. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the ListVersions operation. - Returns metadata about all of the versions of objects in a bucket. - - - - - The bucket name that contains the objects. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - A delimiter is a character you use to group keys. - - - - - Specifies the key to start with when listing objects in a bucket. - - - - - Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more. - - - - - Limits the response to keys that begin with the specified prefix. - - - - - Specifies the object version you want to start listing from. - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - Returns information about the ListVersions response and response metadata. - - - - - A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria. If your results were - truncated, you can make a follow-up paginated request using the NextKeyMarker and NextVersionIdMarker response parameters as a starting - place in another request to return the rest of the results. - - - - - - Marks the last Key returned in a truncated response. - - - - - - Gets and sets the VersionIdMarker property. - Marks the last Version-Id returned in a truncated response. - - - - - Use this value for the key marker request parameter in a subsequent request. - - - - - - Use this value for the next version id marker parameter in a subsequent request. - - - - - - Gets and sets the Versions property. This is a list of - object versions in the bucket that match your search criteria. - - - - - Gets and sets the Name property. - The bucket's name. - - - - - Gets and sets the Prefix property. - Keys that begin with the indicated prefix are listed. - - - - - Gets and sets the MaxKeys property. - This is the maximum number of keys in the S3ObjectVersions collection. - The value is derived from the MaxKeys parameter to ListVersionsRequest. - - - - - Gets the CommonPrefixes property. - A response can contain CommonPrefixes only if you specify a delimiter. - When you do, CommonPrefixes contains all (if there are any) keys between - Prefix and the next occurrence of the string specified by delimiter. - - - - - Gets and sets the Delimiter property. - Causes keys that contain the same string between the prefix and the - first occurrence of the delimiter to be rolled up into a single result - element in the CommonPrefixes collection. - - - These rolled-up keys are not returned elsewhere in the response. - - - - - This class contains the meta data for an S3 object. - - - - - Gets and sets meta data for the object. Meta data names must start with "x-amz-meta-". If the name passeed in as the indexer - doesn't start with "x-amz-meta-" then it will be prepended. - - The name of the meta data. - The value for the meta data - - - - Adds the metadata to the collection, if the name already exists it will be overwritten. - - The name of the metadata element - The value for the metadata - - - - Gets the count of headers. - - - - - Gets the names of the meta data elements. - - - - - A metadata key-value pair to store with an object. - - - - - Key of metadata key-value pair - - - - - Value of metadata key-value pair - - - - - A container specifying replication metrics-related information, including whether - emitting metrics and Amazon S3 events for replication are enabled. In addition, contains - configurations related to specific metrics or events. Must be specified together with a - ReplicationTime block. - - - - - Specifies whether the replication metrics are enabled. - - - - - A container specifying the time threshold for emitting the - s3:Replication:OperationMissedThreshold event. - - - - - Class for MetricsAndOperatorPredicate - A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. - The operator must have at least two predicates, and an object must match all of the predicates - in order for the filter to apply. - - Note: The current implementation restricts the usage to atmost one MetricsPrefixPredicate - and any number of MetricsTagPredicates. - - - - Class for MetricsConfiguration - - - - - The ID used to identify the metrics configuration. - - - - - Specifies a metrics configuration filter. - The metrics configuration will only include objects that meet the filter's criteria. - A filter must be a prefix, a tag, or a conjunction (MetricsAndOperator). - - - - - Filter class for Metrics. - - - - - Filter Predicate setup for specific filter types. - - - - - Filter Predicate abstract class for specific filter types to be derived from. - - - - - Abstract class that can be used over logical filter predicates,i.e. AND/OR. - - - - - Class for MetricsPrefixPredicate - The prefix used when evaluating a metrics filter. - - - - - Class for MetricsTagPredicate - The tag used when evaluating a metrics filter. - - - - - This class contains the mfa codes used authentication - - - - - Gets and sets the serial number of the authentication device - - - - - Gets and sets the displated value on the authentication device - - - - - The formatted string of the mfa codes to be passed to S3. - - - - - Container for elements related to a particular multipart upload. - - - - - Date and time at which the multipart upload was initiated. - - - - - - Identifies who initiated the multipart upload. - - - - - - Key of the object for which the multipart upload was initiated. - - - - - - Gets and sets the Owner property. - - - - - The class of storage used to store the object. - - - - - - Upload ID that identifies the multipart upload. - - - - - - An abstract class for all the notification configurations associated with an Amazon S3 bucket. - - - - - Gets and sets the Events property. These are the events the configuration will listen to. - - - - - Filter criteria for determining which S3 objects trigger event notifications. - - - - - - The container element for Object Lock configuration parameters. - - - - - Gets and sets the property ObjectLockEnabled. - - Indicates whether this object has an Object Lock configuration enabled. - - - - - - Gets and sets the property Rule. - - The Object Lock rule in place for the specified object. - - - - - - A Legal Hold configuration for an object. - - - - - Gets and sets the property Status. - - Indicates whether the specified object has a Legal Hold in place. - - - - - - A Retention configuration for an object. - - - - - Gets and sets the property Mode. - - Indicates the Retention mode for the specified object. - - - - - - Gets and sets the property RetainUntilDate. - - - - - The container element for an Object Lock rule. - - - - - Gets and sets the property DefaultRetention. - - The default retention period that you want to apply to new objects placed in the specified - bucket. - - - - - - Describes the location where the restore job's output is stored. - - - - - Describes an S3 location that will receive the results of the restore request. - - - - - Describes how results of the Select job are serialized. - - - - - Describes the serialization of CSV-encoded Select results. - - - - - Specifies JSON as request's output serialization format. - - - - - The owner of an S3 bucket. - - - - - The display name of the owner. - - - - - The unique identifier of the owner. - - - - - This class contains custom querystring parameters for an S3 object, which can then be signed as part of a Pre-signed URL request - - - - - Gets and sets parameters for the object. Parameter names must start with "x-". If the name passeed in as the indexer - doesn't start with "x-" then it will be prepended. - - The name of the parameter. - The value for the meta data - - - - Adds the parameter to the collection, if the name already exists it will be overwritten. - - The name of the parameter - The value for the parameter - - - - Gets the count of parameters. - - - - - Gets the names of the parameter elements. - - - - - Specifies Parquet as object's input serialization format. - - - - - A container for elements related to a particular part in a multipart operation. - A response can contain zero or more Part elements. - - - - - The date and time at which the part was uploaded. - - - - - The size of the uploaded part data. - - - - - A container holding the part number and etag used when completing a multipart upload. - - - - - Default constructor. - - - - - Constructs an instance of PartETag and sets the part number and etag. - - The part number. - the associated ETag for the part number. - - - - Compares the current object with another object of the same type. - - An object to compare with this object. - - A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has the following meanings: - Value - Meaning - Less than zero - This object is less than the parameter. - Zero - This object is equal to . - Greater than zero - This object is greater than . - - - - - The part number identifying the part. - - - - - The entity tag associated with the part. - - - - - The container element for this bucket's public-policy status. - - - - - Gets and sets the property IsPublic. - - The public-policy status for this bucket. TRUE indicates that this bucket - is public. FALSE indicates that the bucket is not public. - - - - - - The container element for all Public Access Block configuration options. You can enable - the configuration options in any combination. - - - - Amazon S3 considers a bucket policy public unless at least one of the following conditions - is true: - -
  1. - - The policy limits access to a set of CIDRs using aws:SourceIp. For more - information on CIDR, see http://www.rfc-editor.org/rfc/rfc4632.txt - - -
  2. - - The policy grants permissions, not including any "bad actions," to one of the following: - -
    • - - A fixed AWS principal, user, role, or service principal - -
    • - - A fixed aws:SourceArn - -
    • - - A fixed aws:SourceVpc - -
    • - - A fixed aws:SourceVpce - -
    • - - A fixed aws:SourceOwner - -
    • - - A fixed aws:SourceAccount - -
    • - - A fixed value of s3:x-amz-server-side-encryption-aws-kms-key-id - -
    • - - A fixed value of aws:userid outside the pattern "AROLEID:*" - -
- - "Bad actions" are those that could expose the data inside a bucket to reads or writes - by the public. These actions are s3:Get*, s3:List*, s3:AbortMultipartUpload, - s3:Delete*, s3:Put*, and s3:RestoreObject. - - - - The star notation for bad actions indicates that all matching operations are considered - bad actions. For example, because s3:Get* is a bad action, s3:GetObject, - s3:GetObjectVersion, and s3:GetObjectAcl are all bad actions. - - - - - - Gets and sets the property BlockPublicAcls. - - Specifies whether Amazon S3 should block public ACLs for this bucket. Setting this - element to TRUE causes the following behavior: - -
  • - - PUT Bucket acl and PUT Object acl calls will fail if the specified ACL allows public - access. - -
  • - - PUT Object calls will fail if the request includes an object ACL. - -
- - Note that enabling this setting doesn't affect existing policies or ACLs. - - - - - - Gets and sets the property IgnorePublicAcls. - - Specifies whether Amazon S3 should ignore public ACLs for this bucket. Setting this - element to TRUE causes Amazon S3 to ignore all public ACLs on this bucket - and any objects that it contains. - - - - Note that enabling this setting doesn't affect the persistence of any existing ACLs - and doesn't prevent new public ACLs from being set. - - - - - - Gets and sets the property BlockPublicPolicy. - - Specifies whether Amazon S3 should block public bucket policies for this bucket. Setting - this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy - if the specified bucket policy allows public access. - - - - Note that enabling this setting doesn't affect existing bucket policies. - - - - - - Gets and sets the property RestrictPublicBuckets. - - Specifies whether Amazon S3 should restrict public bucket policies for this bucket. - If this element is set to TRUE, then only the bucket owner and AWS Services - can access this bucket if it has a public policy. - - - - Note that enabling this setting doesn't affect previously stored bucket policies, - except that public and cross-account access within any public bucket policy, including - non-public delegation to specific accounts, is blocked. - - - - - - Container for the parameters to the PutAcl operation. - uses the acl subresource to set the access control list (ACL) permissions for an object that already exists in a bucket - - - - - The canned ACL to apply to the bucket. - - - - - - Custom ACLs to be applied to the bucket or object. - - - - - The bucket name that contains the object to which you want to attach the ACL. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The key of an S3 object. - If not specified, the ACLs are applied to the bucket. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - If set and an object key has been specified, the ACLs are applied - to the specific version of the object. - This property is ignored if the ACL is to be set on a Bucket. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - Returns information about the PutObjectAcl response metadata. - The PutAcl operation has a void result type. - - - - - The response for the PutBucketAccelerateConfiguration operation. - Adds an object to a bucket. - - - - - Container for the parameters to the PutBucketAccelerateConfiguration request. - - - - - The name of the bucket to contain the object. - - - - - Accelerate configuration for the bucket. - - - - - Container for the parameters to the PutBucketAnalyticsConfiguration operation. - Sets an analytics configuration for the bucket (specified by the analytics configuration ID). - - - - - The name of the bucket to which an analytics configuration is stored. - - - - - The identifier used to represent an analytics configuration. - - - - - The configuration and any analyses for the analytics filter. - - - - - Returns information about the PutBucketAnalyticsConfigurationResponse response metadata. - The PutBucketAnalyticsConfigurationResponse operation has a void result type. - - - - - Container for the parameters to the PutBucketRequestPayment operation. - Creates a new server-side encryption configuration (or replaces an existing one, if present). - - - - - The name of the bucket for which the server-side encryption configuration is set. - - - - - The base64-encoded 128-bit MD5 digest of the server-side encryption configuration. - - - This header can be used as a message integrity check to verify that the data is the same data that was originally sent. - Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. - - - - - Container for server-side encryption configuration rules. Currently S3 supports one rule only. - - - - - Container for the parameters to the PutBucketRequestPayment operation. - Adds an inventory configuration (identified by the inventory ID) from the bucket. - - - - - The name of the bucket where the inventory configuration will be stored. - - - - - Specifies the inventory Id. - - - - - Specifies the inventory configuration. - - - - - Returns information about the PutInventoryConfigurationResponse response metadata. - The PutInventoryConfigurationResponse operation has a void result type. - - - - - Container for the parameters to the PutBucketLoggingRequest operation. - Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. To set the - logging status of a bucket, you must be the bucket owner. - - - - - Gets and sets the BucketName property. - - - - - Gets and sets the LoggingConfig property. - - - - - Returns information about the PutBucketLogging response metadata. - The EnableBucketLogging operation has a void result type. - - - - - Container for the parameters to the PutBucketMetricsConfigurationRequest operation. - Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. - - - - - The name of the bucket for which the metrics configuration is set. - - - - - The ID used to identify the metrics configuration. - - - - - Specifies the metrics configuration. - - - - - Returns information about the PutBucketMetricsConfiguration response metadata. - The PutBucketMetricsConfiguration operation has a void result type. - - - - - Container for the parameters to the PutBucketNotification operation. - Enables notifications of specified events for a bucket. - - - - - Gets and sets the BucketName property. - - - - - Gets and sets the TopicConfigurations property. TopicConfigurations are configuration for Amazon S3 - events to be sent to Amazon SNS topics. - - - - - Gets and sets the QueueConfigurations property. QueueConfigurations are configuration for Amazon S3 - events to be sent to Amazon SQS queues. - - - - - Gets and sets the LambdaFunctionConfigurations property. LambdaFunctionConfigurations are configuration for - Amazon S3 events to be sent to an Amazon Lambda cloud function. - - - - - Returns information about the PutBucketNotification response metadata. - The PutBucketNotification operation has a void result type. - - - - - Container for the parameters to the PutBucketPolicy operation. - Replaces a policy on a bucket. If the bucket already has a policy, the one in this request completely replaces it. - - - - - The name of the bucket. - - - - - The base64 encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. - - - This header can be used as a message integrity check to verify that the data is the same data that was originally sent. - Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. - - - - - The bucket policy as a JSON document. - - - - - Set this parameter to true to confirm that you want to remove your - permissions to change this bucket policy in the future. - - - - - Overriden to turn off sending SHA256 header. - - - - - Returns information about the PutBucketPolicy response metadata. - The PutBucketPolicy operation has a void result type. - - - - - Container for the parameters to the PutBucketReplication operation. - Sets replication configuration for your bucket. If a replication configuration exists, this replaces it. - - - - - The name of the bucket to have the replication configuration applied. - - - - - The replication configuration to be applied. - - - - - Gets and sets the property Token. - - - - - Returns information about the PutBucketReplicationConfiguration response metadata. - The PutBucketReplicationConfiguration operation has a void result type. - - - - - Container for the parameters to the PutBucket operation. - Creates a new bucket. - - - - - The canned ACL to apply to the bucket. - - - - - - If set to true the bucket will be created in the same region - as the configuration of the AmazonS3 client. - If PutBucketRequest.BucketRegion or PutBucketRequest.BucketRegionName are set they take precedence over - this property. - Default: true. - - - - - The name of the bucket to be created. - - - - - The region locality for the bucket. - - - When set, this will determine where your data will - reside in S3. Refer - for a list of possible values. - - - - - The bucket region locality expressed using the name of the region. - When set, this will determine where your data will reside in S3. - Valid values: us-east-1, us-west-1, us-west-2, eu-west-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, sa-east-1 - - - - - Gets and sets the property ObjectLockEnabledForBucket. - - Specifies whether you want S3 Object Lock to be enabled for the new bucket. - - - - - - Container for the parameters to the PutBucketRequestPayment operation. - Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This - configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the - download. - - - - - The name of the bucket to set payment config. - - - - - Gets and sets request payment configuration - - - - - Returns information about the PutBucketRequestPayment response metadata. - The PutBucketRequestPayment operation has a void result type. - - - - - Returns information about the PutBucket response and response metadata. - - - - - Container for the parameters to the PutBucketTagging operation. - Sets the tags for a bucket. - - - - - The name of the bucket to apply the tags to. - - - - - The collection of tags. - - - - - Returns information about the PutBucketTagging response metadata. - The PutBucketTagging operation has a void result type. - - - - - Container for the parameters to the PutBucketVersioning operation. - Sets the versioning state of an existing bucket. To set the versioning state, you must be the bucket owner. - - - - - The name of the bucket to be updated. - - - - - The MfaCodes Tuple associates the Serial Number and the current Token/Code displayed on the - Multi-Factor Authentication device associated with your AWS Account. - - - This is a required property for this request if:
- 1. EnableMfaDelete was configured on the bucket - containing this object's version.
- 2. You are deleting an object's version - - - - - Checks if the MfaCodes property is set. - - true if the MfaCodes property is set. - - - - The versioning configuration to apply to the bucket. - - - Once Versioning has been "Enabled" on a bucket, it can be "Suspended" - but cannot be switched "Off". If EnableMfaDelete is set, - the MfaCodes property needs to contain the Serial of and current Token - displayed on the MFA device. - - - - - Returns information about the PutBucketVersioning response metadata. - The PutBucketVersioning operation has a void result type. - - - - - Container for the parameters to the PutBucketWebsite operation. - Set the website configuration for a bucket. - - - - - The name of the bucket to apply the configuration to. - - - - - The website configuration to apply. The configuration defines the index - document suffix and custom error page. - - - - - Returns information about the PutBucketWebsite response metadata. - The PutBucketWebsite operation has a void result type. - - - - - Container for the parameters to the PutCORSConfiguration operation. - Sets the cors configuration for a bucket. - - - - - The name of the bucket to have the CORS configuration applied. - - - - - The CORS configuration to apply. - - - - - Returns information about the PutCORSConfiguration response metadata. - The PutCORSConfiguration operation has a void result type. - - - - - Container for the parameters to the PutLifecycleConfiguration operation. - Sets lifecycle configuration for your bucket. If a lifecycle configuration exists, it replaces it. - - - - - The name of the bucket to have the lifecycle configuration applied. - - - - - The lifecycle configuration to be applied. - - - - - Returns information about the PutLifecycleConfiguration response metadata. - The PutLifecycleConfiguration operation has a void result type. - - - - - Container for the parameters to the PutObjectLegalHold operation. - Applies a Legal Hold configuration to the specified object. - - - - - The bucket name containing the object that you want to place a Legal Hold on. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property ContentMD5. - - The MD5 signature for the configuration included in your request. - - - - - - Gets and sets the property Key. - - The key name for the object that you want to place a Legal Hold on. - - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Gets and sets the property LegalHold. - - Container element for the Legal Hold configuration you want to apply to the specified - object. - - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property VersionId. - - The version ID of the object that you want to place a Legal Hold on. - - - - - - This is the response object from the PutObjectLegalHold operation. - - - - - Gets and sets the property RequestCharged. - - - - - Container for the parameters to the PutObjectLockConfiguration operation. - Places an Object Lock configuration on the specified bucket. The rule specified in - the Object Lock configuration will be applied by default to every new object placed - in the specified bucket. - - - - - Gets and sets the property BucketName. - - The bucket whose Object Lock configuration you want to create or replace. - - - - - - Gets and sets the property ContentMD5. - - The MD5 signature for the configuration included in your request. - - - - - - Gets and sets the property ObjectLockConfiguration. - - The Object Lock configuration that you want to apply to the specified bucket. - - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property Token. - - - - - This is the response object from the PutObjectLockConfiguration operation. - - - - - Gets and sets the property RequestCharged. - - - - - Container for the parameters to the PutObject operation. - Adds an object to a bucket. - - - Container for the parameters to the PutObject operation. - Adds an object to a bucket. - - - - - A canned access control list (CACL) to apply to the object. - Please refer to for - information on S3 Canned ACLs. - - - - - Input stream for the request; content for the request will be read from the stream. - - - - - - The full path and name to a file to be uploaded. - If this is set the request will upload the specified file to S3. - - - For WinRT and Windows Phone this property must be in the form of "ms-appdata:///local/file.txt". - - - - - - Text content to be uploaded. Use this property if you want to upload plaintext to S3. - The content type will be set to 'text/plain'. - - - - - If this value is set to true then the stream used with this request will be closed when all the content - is read from the stream. - Default: true. - - - - - If this value is set to true then the stream will be seeked back to the start before being read for upload. - Default: true. - - - - - If this value is set to true then a chunked encoding upload will be used for the request. - Default: true. - - - - - Bucket name to which the PUT operation was initiated. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - Gets and sets Key property. This key is used to identify the object in S3. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - Checks if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - true if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - - - The type of storage to use for the object. Defaults to 'STANDARD'. - - - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - The Legal Hold status that you want to apply to the specified object. - - - - - - Gets and sets the property ObjectLockMode. - - The Object Lock mode that you want to apply to this object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - The date and time when you want this object's Object Lock to expire. - - - - - - If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - Attach a callback that will be called as data is being sent to the AWS Service. - - - - - This is a convenience property for Headers.ContentType. - - - - - An MD5 digest for the content. - - - - The base64 encoded 128-bit MD5 digest of the message - (without the headers) according to RFC 1864. This header - can be used as a message integrity check to verify that - the data is the same data that was originally sent. - - - If supplied, after the file has been uploaded to S3, - S3 checks to ensure that the MD5 hash of the uploaded file - matches the hash supplied. - - - Although it is optional, we recommend using the - Content-MD5 mechanism as an end-to-end integrity check. - - - - - - Checks if MD5Digest property is set. - - true if MD5Digest property is set. - - - - Overriden to turn off sending SHA256 header. - - - - - Overriden to turn on expect 100 continue. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - The tag-set for the object. The tag-set must be encoded as URL Query parameters. - - - - - Checks if Tagging property is set - - true if Tagging is set. - - - - Returns information about the PutObject response and response metadata. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - Entity tag for the uploaded object. - - - - - - Version of the object. - - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the PutObjectRetention operation. - Places an Object Retention configuration on an object. - - - - - The bucket name that contains the object you want to apply this Object Retention configuration to. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property BypassGovernanceRetention. - - - - - Gets and sets the property ContentMD5. - - The MD5 signature for the configuration included in your request. - - - - - - Gets and sets the property Key. - - The key name for the object that you want to apply this Object Retention configuration - to. - - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property Retention. - - The container element for the Object Retention configuration. - - - - - - Gets and sets the property VersionId. - - The version ID for the object that you want to apply this Object Retention configuration - to. - - - - - - This is the response object from the PutObjectRetention operation. - - - - - Gets and sets the property RequestCharged. - - - - - Container for the parameters to the PutObjectTagging operation. - - - - - The bucket name containing the object. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Check to see if Bucket property is set - - - - - Gets and sets Key property. This key is used to identify the object in S3. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Check to see if Key property is set - - - - - The tag-set for the object. The tag-set must be encoded as URL Query parameters - - - - - Checks if Tagging property is set. - - - - - VersionId used to reference a specific version of the object. - - - - - - Returns information about the PutObjectTagging response and response metadata. - - - - - Version of the object. - - - - - Container for the parameters to the PutPublicAccessBlock operation. - Creates or modifies the Public Access Block configuration for an Amazon S3 bucket. - - - - - Gets and sets the property BucketName. - - The name of the Amazon S3 bucket whose Public Access Block configuration you want - to set. - - - - - - Gets and sets the property ContentMD5. - - The MD5 hash of the PutPublicBlock request body. - - - - - - Gets and sets the property PublicAccessBlockConfiguration. - - The Public Access Block configuration that you want to apply to this Amazon S3 bucket. - - - - - - This is the response object from the PutPublicAccessBlock operation. - - - - - Base class for put operations that can also put an ACL. - - - - - Gets the access control lists (ACLs) for this request. - Please refer to for information on - S3 Grants. - - - - - This class contains the configuration Amazon S3 uses to figure out what events you want to listen - and send the event to an Amazon SQS queue. - - The queue's policy must allow S3 to send messages to it. The utility method - Amazon.SQS.AmazonSQSClient.AuthorizeS3ToSendMessage(string,string) - can be used to help setup the queue policy. - - - - - - Gets and set the Id property. The Id will be provided in the event content and can be used - to identify which configuration caused an event to fire. If the Id is not provided for the configuration, one will be generated. - - - - - Gets and sets the Queue property. Amazon SQS queue to which Amazon S3 will publish a message - to report the specified events for the bucket. - - The queue's policy must allow S3 to send messages to it. The utility method - Amazon.SQS.AmazonSQSClient.AuthorizeS3ToSendMessage(string,string) - can be used to help setup the queue policy. - - - - - - This class defines the configuration for replication. - - - - - Indicates the ARN of the role to assume. - - - - - Check to see if the Role property is set. - - true if the Role property is set. - - - - Container for information about a particular replication rule. - Replication configuration must have at least one rule and can contain up to 1,000 rules. - - - - - Checks to see if the Rules property is set. - - true if the Rules property is set. - - - - Destination configuration for a replication rule. - - - - -

Amazon resource name (ARN) of the bucket where you want Amazon - S3 to store replicas of the object identified by the rule.

- If you have multiple rules in your replication configuration, all - rules must specify the same bucket as the destination. A replication - configuration can replicate objects only to one destination bucket.

- - - - - Checks to see if BucketArn property is set. - - true if BucketArn property is set. - - - - The class of storage used to store the object. - - - - - -

Account ID of the destination bucket. Currently Amazon S3 verifies this - value only if Access Control Translation is enabled.

In a cross-account - scenario, if you tell Amazon S3 to change replica ownership to the AWS account - that owns the destination bucket by adding the AccessControlTranslation - element, this is the account ID of the destination bucket owner.

- - - - -

Container for information regarding the access control for replicas.

-

Use only in a cross-account scenario, where source and destination bucket - owners are not the same, when you want to change replica ownership to the AWS - account that owns the destination bucket. If you don't add this element to the - replication configuration, the replicas are owned by same AWS account that - owns the source object.

- - - - -

Container that provides encryption-related information. You must - specify this element if the SourceSelectionCriteria is - specified.

- - - - - A container specifying the time when all objects and operations on objects are - replicated. Must be specified together with a Metrics block. - - - - - A container specifying replication metrics-related information, including whether - emitting metrics and Amazon S3 events for replication are enabled. In addition, - contains configurations related to specific metrics or events. Must be specified - together with a ReplicationTime block. - - - - - Rule that specifies the replication configuration. - - - - - Unique identifier for the rule. The value cannot be longer than 255 characters. - - - - - Checks to see if Id property is set. - - true if Id property is set. - - - -

The priority associated with the rule. If you specify multiple rules in a - replication configuration, then Amazon S3 applies rule priority in the event - there are conflicts (two or more rules identify the same object based on - filter specified). The rule with higher priority takes precedence. For - example,

  • Same object quality prefix based filter criteria - If prefixes you specified in multiple rules overlap.

  • Same - object qualify tag based filter criteria specified in multiple rules

    • -

For more information, see - - Cross-Region Replication (CRR) in the Amazon S3 Developer Guide.

- - - - - Checks to see if Priority property is set. - - true if Priority property is set. - - - - Object keyname prefix identifying one or more objects to which the - rule applies. Maximum prefix length can be up to 1,024 characters. - - - - - Checks to see if Prefix property is set. - - true if Prefix property is set. - - - - Gets and sets the property Filter. - - - - - Checks to see if Filter property is set. - - true if Filter property is set. - - - - Whether the rule is applied or ignored. - - - - - Checks to see if Status property is set. - - true if Status property is set. - - - - Container for replication destination information. - - - - - Checks to see if Destination property is set. - - true if Destination property is set. - - - -

Container that describes additional filters in identifying source objects that - you want to replicate. Currently, Amazon S3 supports only the filter that you can - specify for objects created with server-side encryption using an AWS KMS-managed - key. You can choose to enable or disable replication of these objects.

if - you want Amazon S3 to replicate objects created with server-side encryption using - AWS KMS-managed keys.

- - - - - A container that specifies information about existing object replication. - You can choose whether to enable or disable the replication of existing objects. - - - - - Checks to see if ExistingObjectReplication property is set. - - true if ExistingObjectReplication property is set. - - - - Specifies whether Amazon S3 should replicate delete makers. - - - - - Checks to see if DeleteMarkerReplication property is set. - - true if DeleteMarkerReplication property is set. - - - - - - - - Object keyname prefix that identifies subset of objects to which the rule applies. - - - - - Checks to see if Prefix property is set. - - true if Prefix property is set. - - - - All of these tags must exist in the object's tag set in order for the rule to apply. - - - - - Checks to see if Tags property is set. - - true if Tags property is set. - - - - Filter that identifies subset of objects to which the replication rule applies. - A Filter must specify exactly one Prefix, - Tag, or an And child element. - - - - - Object keyname prefix that identifies subset of objects to which the rule applies. - - - - - Checks to see if Prefix property is set. - - true if Prefix property is set. - - - -

Container for specifying a tag key and value.

-

The rule applies only to objects having the tag in its tagset.

- - - - - Checks to see if Tag property is set. - - true if Tag property is set. - - - -

Container for specifying rule filters. These filters determine the - subset of objects to which the rule applies. The element is required - only if you specify more than one filter. For example:

  • -

    You specify both a Prefix and a Tag - filters. Then you wrap these in an And tag.

    • -

  • You specify filter based on multiple tags. Then you wrap the - Tag elements in an And tag.

- - - - - Checks to see if And property is set. - - true if And property is set. - - - - A container specifying the time when all objects and operations on objects are replicated. Must be specified together with a Metrics block. - - - - - Specifies whether the replication time is enabled. - - - - - A container specifying the time by which replication should complete for all objects and operations on objects. - - - - - A container specifying the time value. - - - - - Contains an integer specifying time in minutes. - - - - - Request Payment Configuration - - - - - Specifies who pays for the download and request fees. - - - - - Container for values of the response headers that will be set on a response from a GetObject request. - These values override any headers that were set when the object was uploaded to S3. - - - - - A standard MIME type describing the format of the object data. - - - The content type for the content being uploaded. This property defaults to "binary/octet-stream". - For more information, refer to: - - - - - ContentLanguage header value. - - - - - Expiry header value. - - - - - CacheControl header value. - - - - - The ContentDisposition header value. - - - - - The ContentEncoding header value. - - - - - Container for the parameters to the RestoreObject operation. - Restores an archived copy of an object back into Amazon S3 - - - - - The bucket name or containing the object to restore. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the Key property. This key indicates the S3 object to restore. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Lifetime of the active copy in days - ** Do not use with restores that specify OutputLocation ** - - - - - VersionId used to reference a specific version of the object. - - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Glacier retrieval tier at which the restore will be processed. - ** Do not use with restores that specify OutputLocation ** - - - - - Glacier retrieval tier at which the restore will be processed. - ** Only use with restores that require OutputLocation ** - - - - - Type of restore request. - - - - - The optional description for the job. - - - - - Describes the parameters for Select job types. - - - - - Describes the location where the restore job's output is stored. - - - - - Returns information about the RestoreObject response metadata. - The RestoreObject operation has a void result type. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Indicates the path in the provided S3 output location where Select results will be restored to. - - - - Routing Rule - - - - - A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the - /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might - process the error. - - - - - - Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event of an - error, you can can specify a different error code to return. - - - - - - A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages - in the /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you - might process the error. - - - - - The HTTP error code when the redirect is applied. In the event of an error, if the error code equals this value, then the specified redirect - is applied. Required when parent element Condition is specified and sibling KeyPrefixEquals is not specified. If both are specified, then - both must be true for the redirect to be applied. - - - - - - The object key name prefix when the redirect is applied. For example, to redirect requests for ExamplePage.html, the key prefix will be - ExamplePage.html. To redirect request for all pages with the prefix docs/, the key prefix will be /docs, which identifies all objects in the - docs/ folder. Required when the parent element Condition is specified and sibling HttpErrorCodeReturnedEquals is not specified. If both - conditions are specified, both must be true for the redirect to be applied. - - - - - - Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event - of an error, you can can specify a different error code to return. - - - - - Name of the host where requests will be redirected. - - - - - - The HTTP redirect code to use on the response. Not required if one of the siblings is present. - - - - - - Protocol to use (http, https) when redirecting requests. The default is the protocol that is used in the original request. - - - - - - The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix docs/ (objects in the - docs/ folder) to documents/, you can set a condition block with KeyPrefixEquals set to docs/ and in the Redirect set ReplaceKeyPrefixWith to - /documents. Not required if one of the siblings is present. Can be present only if ReplaceKeyWith is not provided. - - - - - - The specific object key to use in the redirect request. For example, redirect request to error.html. Not required if one of the sibling is - present. Can be present only if ReplaceKeyPrefixWith is not provided. - - - - - - Represents an access control list (ACL) for S3. An AccessControlList is represented by an Owner, - and a List of Grants, where each Grant is a Grantee and a Permission. - - - - Each bucket and object in Amazon S3 has an ACL that defines its access control policy. - When a request is made, Amazon S3 authenticates the request using its standard - authentication procedure and then checks the ACL to verify the sender was granted access - to the bucket or object. If the sender is approved, the request proceeds. - Otherwise, Amazon S3 returns an error. - - - An ACL is a list of grants. A grant consists of one grantee and one permission. - ACLs only grant permissions; they do not deny them. - - - For convenience, some commonly used Access Control Lists are defined in - S3CannedACL. - - - Note: BucketName and object ACLs are completely independent; an object does not inherit the ACL - from its bucket. For example, if you create a bucket and grant write access to another user, - you will not be able to access the user's objects unless the user explicitly grants access. - This also applies if you grant anonymous write access to a bucket. Only the user "anonymous" - will be able to access objects the user created unless permission is explicitly granted to - the bucket owner. - - - Important: We highly recommend that you do not grant the anonymous group write access to your - buckets as you will have no control over the objects others can store and their associated charges. - For more information, see Grantees and Permissions - - - - - Creates a S3Grant and adds it to the list of grants. - - The grantee for the grant. - The permission for the grantee. - - - - Removes a specific permission for the given grantee. - - The grantee - The permission for the grantee to remove - - - - Removes all permissions for the given grantee. - - - - - - The owner of the bucket or object. - - - - Every bucket and object in Amazon S3 has an owner, the user that - created the bucket or object. The owner of a bucket or object cannot - be changed. However, if the object is overwritten by another user - (deleted and rewritten), the new object will have a new owner. - - - Note: Even the owner is subject to the ACL. For example, if an owner - does not have Permission.READ access to an object, the owner cannot read - that object. However, the owner of an object always has write access to the - access control policy (Permission.WriteAcp) and can change the ACL to - read the object. - - - - - - Checks if Owner property is set. - - true if Owner property is set. - - - - A collection of grants. - - - - - Checks if Grants property is set. - - true if Grants property is set. - - - Bucket - Represents an S3 bucket, contains the name of the S3 bucket and the date that the bucket was created. - - - - - Date the bucket was created. - - - - - - The name of the bucket. - - - - - Logging Enabled - - - - - Specifies the bucket where you want Amazon S3 to store server access logs. You can have your logs delivered to any bucket that you own, - including the same bucket that is being logged. You can also configure multiple buckets to deliver their logs to the same target bucket. In - this case you should choose a different TargetPrefix for each source bucket so that the delivered log files can be distinguished by key. - - - - - A collection of grants. - - - - - This element lets you specify a prefix for the keys that the log files will be stored under. - - - - - Creates a S3Grant and adds it to the list of grants. - - The grantee for the grant. - The permission for the grantee. - - - - Removes a specific permission for the given grantee. - - The grantee - The permission for the grantee to remove - - - - Removes all permissions for the given grantee. - - - - - - An S3 bucket versioning configuration. - - - Contains the bucket's versioning status (Off, Enabled, Suspended) and whether an MFADelete - has been enabled for the bucket. - - - - - Versioning status for the bucket. - Accepted values: Off, Enabled, Suspended. - - - - - Checks if Status property is set - - true if Status property is set - - - - Specifies whether MFA Delete is enabled on this S3 Bucket. - - - If this property is set, please ensure that the - PutBucketVersioningRequest's MfaCodes property is set with - the Serial of and Token on the MFA device. - - - - - Checks if EnableMfaDelete property is set. - - true if Status property is set - - - - Describes the server-side encryption that will be applied to the restore results. - - - - - The server-side encryption algorithm used when storing job results in Amazon S3 (e.g., AES256, aws:kms). - - - - - Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by - AWS KMS will fail if not made via SSL or using SigV4. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at - http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version - - - - - If the encryption type is aws:kms, this optional value can be used to specify the encryption context for the restore results. - - - - Grant - - - - - The grantee details. - - - - - Specifies the permission given to the grantee. - - - - - Grantee - - - - - Type of grantee - - - - - - Screen name of the grantee. - - - - - - Email address of the grantee. - - - - - - The canonical user ID of the grantee. - - - - - - URI of the grantee group. - - - - - - Filter criteria that allows for event notification filtering based on an S3 Object's key name. - - - - - Gets and sets the filterRules property. - These are the filter rules for this filter. - - - - - Describes an S3 location that will receive the results of the restore request. - - - - - The name of the bucket where the restore results will be placed. - - - - - The prefix that is prepended to the restore results for this request. - - - - - The canned ACL to apply to the restore results. - - - - - A list of grants that control access to the staged results. - - - - - The tag-set that is applied to the restore results. - - - - - A map of metadata to store with the restore results in S3. - - - - - The class of storage used to store the restore results. - - - - - Represents an S3 Object. Contains all attributes that an S3 Object has. - For more information about S3 Objects refer: - - - - - - Any ETag set on the object. - - - - - The name of the bucket containing this object. - - - - - The key of the object. - - - - - The date and time the object was last modified. - - The date retrieved from S3 is in ISO8601 format. A GMT formatted date is passed back to the user. - - - - - - The owner of the object. - - - - - The size of the object. - - - - - The class of storage used to store the object. - - - - - - Represents a version of an object in an S3 Bucket. An S3 object version is an S3 object - that also has a version identifier, an indication of whether this is the latest version of the object - and whether it's a DeleteMarker or not. - - - - - Specifies whether the object is (true) or is not (false) the latest version of an object. - - - - - Version ID of an object. - - - - - If true, the object is a delete marker for a deleted object. - - - - - Specifies the byte range of the object to get the records from. A record is processed when its first byte is contained by the range. - - - - - Specifies the start of the byte range. This parameter is optional. Valid values: non-negative integers. The default value is 0. - - - - - Specifies the end of the byte range. This parameter is optional. Valid values: non-negative integers. The default value is one less than the size of the object being queried. - - - - - Request to filter the contents of an Amazon S3 object based on a simple Structured Query Language (SQL) statement. - - In the request, along with the SQL expression, you must also specify a data serialization format (JSON or CSV) of the object. - Amazon S3 uses this to parse object data into records, and returns only records - that match the specified SQL expression. You must also specify the data serialization format for the response. - - - - S3Select API Documentation - - - - - The S3 Bucket. - - - - - The Object Key. - - - - - The SSE Algorithm used to encrypt the object. - - - Server-Side Encryption (Using Customer-Provided Encryption Keys. - - - - - The SSE Customer Key. - - - Server-Side Encryption (Using Customer-Provided Encryption Keys. - - - - - The SSE Customer Key MD5. - - - Server-Side Encryption (Using Customer-Provided Encryption Keys. - - - - - The expression that is used to query the object. - - - - - The type of the provided expression (e.g., SQL). - - - - - Specifies if periodic request progress information should be enabled. - - - - - Describes the format of the data in the object that is being queried. - - - - - Describes the format of the data that you want Amazon S3 to return in response. - - - - - The byte range of the object to get the records from. - - - - - Contains the response Payload for the SelectObjectContent request - - - - - The Event Stream result of SelectObjectContent - - - - - Describes the parameters for Select job types. - - - - - Describes the serialization format of the object. - - - - - The type of the provided expression (e.g., SQL). - - - - - The expression that is used to query the object. - - - - - Describes how the results of the Select job are serialized. - - - - - ServerSideEncryptionByDefault class - - - - - Server-side encryption algorithm to use for the default encryption. - - - - - KMS master key ID to use for the default encryption. - This parameter is allowed if SSEAlgorithm is aws:kms. - - - - - ServerSideEncryptionConfiguration class - - - - - Container for information about a particular server-side encryption configuration rule. - - - - - ServerSideEncryptionRule class - - - - - Describes the default server-side encryption to apply to - new objects in the bucket. If Put Object request - does not specify any server-side encryption, - this default encryption will be applied. - - - - - SourceSelectionCriteria class - - - - - Container for filter information of selection of KMS Encrypted - S3 objects. The element is required if you include - SourceSelectionCriteria in the replication - configuration. - - - - - SSEKMS class - - - - - Specifies the ID of the AWS Key Management Service (KMS) - master encryption key to use for encrypting Inventory reports. - - - - - SseKmsEncryptedObjects class - - - - - The replication for KMS encrypted S3 objects is disabled if status is not Enabled. - - - - - SSES3 class - - - - - Class for StorageClassAnalysis - - - - - A container used to describe how data related to the storage class analysis should be exported. - - - - - Class for StorageClassAnalysisDataExport - - - - - The version of the output schema to use when exporting data. Must be V_1. - - - - - The place to store the data for an analysis. - - - - - Base class for responses that return a stream. - - - - - Disposes of all managed and unmanaged resources. - - - - - An open stream read from to get the data from S3. In order to - use this stream without leaking the underlying resource, please - wrap access to the stream within a using block. - - - - - The exception that is thrown when the size of a stream does not match it's expected size. - - - - - Gets and sets ExpectedSize property. - - - - - Gets and sets ActualSize property. - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - - - Tag is a key-value pair of metadata associated with an S3Object - - - - - Name of the tag. - - - - - Value of the tag. - - - - - Structure that contains list of Tags - - - - - TagSet - - - - - This class contains the configuration Amazon S3 uses to figure out what events you want to listen - and send the event to an Amazon SNS topic. - - The topic's policy must allow S3 to publish messages to it. The utility method - Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.AuthorizeS3ToPublish(string,string) - can be used to help setup the topic policy. - - - - - - Gets and set the Id property. The Id will be provided in the event content and can be used - to identify which configuration caused an event to fire. If the Id is not provided for the configuration, one will be generated. - - - - - Bucket event for which to send notifications. - - Topic configurations can now contain multiple events. This property is obsolete in favor of the Events property. - This property will always get or set the the zeroth element in the Events collection. - - - - - - Gets and sets the Topic property. Amazon SNS topic to which Amazon S3 will publish a message to report the - specified events for the bucket. - - The topic's policy must allow S3 to publish messages to it. The utility method - Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.AuthorizeS3ToPublish(string,string) - can be used to help setup the topic policy. - - - - - - The parameters to request upload of a part in a multipart upload operation. - - - - If PartSize is not specified then the rest of the content from the file - or stream will be sent to Amazon S3. - - - You must set either the FilePath or InputStream. If FilePath is set then the FilePosition - property must be set. - - - - The parameters to request upload of a part in a multipart upload operation. - - - - If PartSize is not specified then the rest of the content from the file - or stream will be sent to Amazon S3. - - - You must set either the FilePath or InputStream. If FilePath is set then the FilePosition - property must be set. - - - - - - Caller needs to set this to true when uploading the last part. This property only needs to be set - when using the AmazonS3EncryptionClient. - - - - - Input stream for the request; content for the request will be read from the stream. - - - - - The name of the bucket containing the object to receive the part. - - - - - The key of the object. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Part number of part being uploaded. - - - - - - The size of the part to be uploaded. - - - - - Checks if PartSize property is set. - - true if PartSize property is set. - - - - Upload ID identifying the multipart upload whose part is being uploaded. - - - - - - An MD5 digest for the part. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - - Full path and name of a file from which the content for the part is retrieved. - - - For WinRT and Windows Phone this property must be in the form of "ms-appdata:///local/file.txt". - - - - - - Checks if the FilePath property is set. - - true if FilePath property is set. - - - - Position in the file specified by FilePath from which to retrieve the content of the part. - This field is required when a file path is specified. It is ignored when using the InputStream property. - - - - - If this value is set to true then a chunked encoding upload will be used for the request. - Default: true. - - - - - Checks if the FilePosition property is set. - - true if FilePosition property is set. - - - - Checks if the MD5Digest property is set. - - true if Md5Digest property is set. - - - - Attach a callback that will be called as data is being sent to the AWS Service. - - - - - Overriden to turn off sending SHA256 header. - - - - - Overriden to turn on Expect 100 continue. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the UploadPart response and response metadata. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - Entity tag for the uploaded object. - - - - - - Gets and sets the part number specified for the part upload. This is needed when - completing the multipart upload. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - Website Configuration - - - - - The ErrorDocument value, an object key name to use when a 4XX class error occurs. - - - - - - This value is a suffix that is appended to a request that is for a "directory" - on the website endpoint (e.g. if the suffix is index.html and - you make a request to samplebucket/images/ the data that - is returned will be for the object with the key name - images/index.html) - - - The suffix must not be empty and must not include a slash - character. - - - - - - Container for redirect information where all requests will be redirect - to. You can redirect requests to another host, to another page, or with - another protocol. In the event of an error, you can can specify a - different error code to return. . - - - - - The list of routing rules that can be used for configuring redirects if certain conditions are meet. - - - - - The Continuation Event. - - - - - Constructs a Continuation Event. - - - - - Constructs a Continuation Event. - - - - - - The End Event. - - - - - Constructs an End Event. - - - - - Constructs an End Event. - - - - - - Common Contract for S3 Events. - - - - - The Progress event details. - - - - - Current number of object bytes scanned. - - - - - Current number of uncompressed object bytes processed. - - - - - Total number of bytes of records payload data returned. - - - - - Constructs a instance of Progress. - - - - - The Progress Event. - - - - - The Progress event details. - - - - - Constructs a ProgressEvent. - - - - - Constructs a ProgressEvent. - - - - - - The Records Event - - - - - The byte array of partial, one or more result records. - - Payload is a , which is not thread-safe. - - - - - Constructs a RecordsEvent - - - - - Creates a new End Event. - - - - - - Modeled Exception that either comes over the stream from the service model, or wraps other exceptions for the purpose of raising events. If it is - modelled, it will be a subclass. - - - - - Creates a new S3EventStreamException - - - - - Creates a new S3EventStreamException - - - - - - Creates a new S3EventStreamException - - - - - - - The contract for the SelectObjectContentEventStream. - - - - - Event that encompasses all IS3Events. - - - - - Event that encompasses S3EventStreamExceptions. - - - - - Reaised when a Records event is received. - - - - - Reaised when a Stats event is received. - - - - - Reaised when a Progress event is received. - - - - - Reaised when a Continuation event is received. - - - - - Reaised when an End event is received. - - - - - A Stream of Events returned by the SelectObjectContent operation. Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treaded as mutually exclusive. - - - - - The mapping of event message to a generator function to construct the matching Event Stream event. - - - - - The mapping of event message to a generator function to construct the matching Event Stream exception. - - - - - Whether the backround processing loop is running. - - - - - Event that encompasses all IS3Events. - - - - - Event that encompasses S3EventStreamExceptions. - - - - - Reaised when a Records event is received. - - - - - Reaised when a Stats event is received. - - - - - Reaised when a Progress event is received. - - - - - Reaised when a Continuation event is received. - - - - - Reaised when an End event is received. - - - - - Event Stream returned by SelectObjectContentStream. - - Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treated as mutually exclusive. - - The network stream which events will be parsed from. - - - - Event Stream returned by SelectObjectContentStream. - - Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treaded as mutually exclusive. - - The network stream which events will be parsed from. - The decoder responsible for parsing events. - - - - The Stats event details. - - - - - Total number of object bytes scanned. - - - - - Total number of uncompressed object bytes processed. - - - - - Total number of bytes of records payload data returned. - - - - - Constructs an instance of Stats. - - - - - The Stats Event. - - - - - The Stats event details. - - - - - Constructs a StatsEvent - - - - - Constructs a ProgressEvent. - - - - - - This Event is returned if an event is retrieved from the event stream, but a generator function - for the event is not defined. - - - - - Constructs an UnknownEventStreamEvent. - - - - - Constructs an UnknownEventStreamEvent. - - The Message recieved from the event stream before conversion. - - - - Constructs an UnknownEventStreamEvent. - - The Message recieved from the event stream before conversion. - The event type. - - - - Arguments containing event details for an in-flight transfer. - - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - - - - Gets the percentage of transfer completed - - - - - Gets the number of bytes transferred since last event - - - - - Gets the number of bytes transferred - - - - - Gets the total number of bytes to be transferred - - - - - Returns a string representation of this object - - - - - - AmazonS3 exception. - Thrown when DeleteObjects returns successfully, but some of the objects - were not deleted. - - - - - Gets and sets the ErrorResponse property. - The DeleteObjectsErrorResponse associated with this exception. - - - - - Constructs an instance of DeleteObjectsException - - - - - - Uri wrapper that can parse out information (bucket, key, region, style) from an - S3 URI. - - - - - True if the URI contains the bucket in the path, false if it contains the bucket in the authority. - - - - - The bucket name parsed from the URI (or null if no bucket specified). - - - - - The key parsed from the URI (or null if no key specified). - - - - - The region parsed from the URI (or null if no region specified). - - - - - Constructs a parser for the S3 URI specified as a string. - - The S3 URI to be parsed. - - - - Constructs a parser for the S3 URI specified as a Uri instance. - - The S3 URI to be parsed. - - - - If the given string is an AmazonS3Endpoint return true and set the AmazonS3Uri out parameter. - - - - true if the string is an AmazonS3Endpoint, and the out paramter has been filled in, false otherwise - - - - If the given Uri is an AmazonS3Endpoint return true and set the AmazonS3Uri out parameter. - - - - true if the Uri is an AmazonS3Endpoint, and the out paramter has been filled in, false otherwise - - - - Checks whether the given URI is a Amazon S3 URI. - - The S3 URI to be checked. - true if the URI is a Amazon S3 URI, false; otherwise. - - - - Checks whether the given URI is a Amazon S3 URI. - - The S3 URI to be checked. - true if the URI is a Amazon S3 URI, false; otherwise. - - - - Percent-decodes the given string, with a fast path for strings that are not - percent-encoded. - - The string to decode - The decoded string - - - - Percent-decodes the given string. - - The string to decode - The index of the first '%' in the string - The decoded string - - - - Decodes the percent-encoded character at the given index in the string - and appends the decoded value to the string under construction. - - - The string under construction to which the decoded character will be - appended. - - The string being decoded. - The index of the '%' character in the string. - - - - Converts a hex character (0-9A-Fa-f) into its corresponding quad value. - - The hex character - The quad value - - - - Provides utilities used by the Amazon S3 client implementation. - These utilities might be useful to consumers of the Amazon S3 - library. - - - - - Determines MIME type from a file extension - - The extension of the file - The MIME type for the extension, or text/plain - - - - URL encodes a string. If the path property is specified, - the accepted path characters {/+:} are not encoded. - - The string to encode - Whether the string is a URL path or not - - - - - Converts a non-seekable stream into a System.IO.MemoryStream. - A MemoryStream's position can be moved arbitrarily - - The stream to be converted - A seekable MemoryStream - MemoryStreams use byte arrays as their backing store. - Please use this judicially as it is likely that a very large - stream will cause system resources to be used up. - - - - - Formats the current date as a GMT timestamp - - A GMT formatted string representation - of the current date and time - - - - - Generates an MD5 Digest for the string-based content - - The content for which the MD5 Digest needs - to be computed. - - Whether the returned checksum should be - base64 encoded. - - A string representation of the hash with or w/o base64 encoding - - - - - Only escape non-ascii characters in a string - - - - - - - Version2 S3 buckets adhere to RFC 1035: - - Less than 255 characters, with each label less than 63 characters. - Label must start with a letter - Label must end with a letter or digit - Label can have a string of letter, digits and hyphens in the middle. - Although names can be case-sensitive, no significance is attached to the case. - RFC 1123: Allow label to start with letter or digit (e.g. 3ware.com works) - RFC 2181: No restrictions apart from the length restrictions. - - S3 V2 will start with RFCs 1035 and 1123 and impose the following additional restrictions: - - Length between 3 and 63 characters (to allow headroom for upper-level domains, - as well as to avoid separate length restrictions for bucket-name and its labels - Only lower-case to avoid user confusion. - No dotted-decimal IPv4-like strings - - - The BucketName to validate if V2 addressing should be used - True if the BucketName should use V2 bucket addressing, false otherwise - - S3 v2 Bucket restrictions - - - - Determines whether an S3 bucket exists or not. - - The name of the bucket to check. - The Amazon S3 Client to use for S3 specific operations. - False is returned in case S3 responds with a NoSuchBucket error. - True is returned in case of success, AccessDenied error or PermanentRedirect error. - An exception is thrown in case of any other error. - This method calls GetACL for the bucket. - - - - Determines whether an S3 bucket exists or not. - This is done by: - 1. Creating a PreSigned Url for the bucket. To work with Signature V4 only regions, as - well as Signature V4-optional regions, we keep the expiry to within the maximum for V4 - (which is one week). - 2. Making a HEAD request to the Url - - The name of the bucket to check. - The Amazon S3 Client to use for S3 specific operations. - - - - - Class to manage and cache the correct region for buckets accessed without an explicit region. - - - Class to manage and cache the correct region for buckets accessed without an explicit region. - - - - - A cache of BucketName -> RegionEndpoint pairs. - The cache is used to make sure that bucket requests are signed for the correct region, - even when requesting them without an explicit region. - - - - - Detect a bucket region mismatch based on the x-amz-bucket-region header, and the status code provided. - - - - - - - - - Detects if the signature is malformed, and the requested bucket is in a Region - different from the Region of the request. - - - - the correct region if a mismatch was detected, null otherwise - - - - Detects if the signature is malformed, and the requested bucket is in a Region - different from the Region of the request. - - - - - the correct region if a mismatch was detected, null otherwise - - - - Use a HEAD bucket request to get the region for the given bucket. - - This method creates an AmazonS3Client from the credentials passed in. - It's critical that the AmazonS3Client is not used to make any requests that will - be routed through the pipeline. - - - - the value of the x-amz-bucket-region header from the response - - - - A helper class that represents a strongly typed S3 EventNotification item sent to SQS - - - - - Parse the JSON string into a S3EventNotification object. - - The function will try its best to parse input JSON string as best as it can. - It will not fail even if the JSON string contains unknown properties. - - For any parsing errors - - - - - Gets and sets the records for the S3 event notification - - - - - The class holds the user identity properties. - - - - - Gets and sets the PrincipalId property. - - - - - This class contains the identity information for an S3 bucket. - - - - - Gets and sets the name of the bucket. - - - - - Gets and sets the bucket owner id. - - - - - Gets and sets the S3 bucket arn. - - - - - This class contains the information for an object in S3. - - - - - Gets and sets the key for the object stored in S3. - - - - - Gets and sets the size of the object in S3. - - - - - Gets and sets the etag of the object. This can be used to determine if the object has changed. - - - - - Gets and sets the version id of the object in S3. - - - - - Gets and sets the sequencer a string representation of a hexadecimal value used to determine event sequence, only used with PUTs and DELETEs. - - - - - Gets and sets the meta information describing S3. - - - - - Gets and sets the ConfigurationId. This ID can be found in the bucket notification configuration. - - - - - Gets and sets the Bucket property. - - - - - Gets and sets the Object property. - - - - - Gets and sets the S3SchemaVersion property. - - - - - The class holds the request parameters - - - - - Gets and sets the SourceIPAddress. This is the ip address where the request came from. - - - - - This class holds the response elements. - - - - - Gets and sets the XAmzId2 Property. This is the Amazon S3 host that processed the request. - - - - - Gets and sets the XAmzRequestId. This is the Amazon S3 generated request ID. - - - - - The class holds the glacier event data elements. - - - - - Gets and sets the RestoreEventData property. - - - - - The class holds the restore event data elements. - - - - - Gets and sets the LifecycleRestorationExpiryTime the time when the object restoration will be expired. - - - - - Gets and sets the LifecycleRestoreStorageClass the source storage class for restore. - - - - - The class holds the event notification. - - - - - Gets and sets the AwsRegion property. - - - - - Gets and sets the EventName property. This identities what type of event occurred. - For example for an object just put in S3 this will be set to EventType.ObjectCreatedPut. - - - - - Gets and sets the EventSource property. - - - - - Gets and sets the EventType property. The time when S3 finished processing the request. - - - - - Gets and sets the EventVersion property. - - - - - Gets and sets the RequestParameters property. - - - - - Gets and sets the ResponseElements property. - - - - - Gets and sets the S3 property. - - - - - Gets and sets the UserIdentity property. - - - - - Get and sets the GlacierEventData property. - - - - - Interface for accessing S3 - - - - - - - Create a signed URL allowing access to a resource that would - usually require authentication. - - - - When using query string authentication you create a query, - specify an expiration time for the query, sign it with your - signature, place the data in an HTTP request, and distribute - the request to a user or embed the request in a web page. - - - A PreSigned URL can be generated for GET, PUT, DELETE and HEAD - operations on your bucketName, keys, and versions. - - - The GetPreSignedUrlRequest that defines the - parameters of the operation. - A string that is the signed http request. - - - - - - This operation aborts a multipart upload. After a multipart upload is aborted, no - additional parts can be uploaded using that upload ID. The storage consumed by any - previously uploaded parts will be freed. However, if any part uploads are currently - in progress, those part uploads might or might not succeed. As a result, it might - be necessary to abort a given multipart upload multiple times in order to completely - free all storage consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts operation and ensure that the parts - list is empty. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - The bucket name to which the upload was taking place. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object for which the multipart upload was initiated. - Upload ID that identifies the multipart upload. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AbortMultipartUpload service method, as returned by S3. - REST API Reference for AbortMultipartUpload Operation - - - - This operation aborts a multipart upload. After a multipart upload is aborted, no - additional parts can be uploaded using that upload ID. The storage consumed by any - previously uploaded parts will be freed. However, if any part uploads are currently - in progress, those part uploads might or might not succeed. As a result, it might - be necessary to abort a given multipart upload multiple times in order to completely - free all storage consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts operation and ensure that the parts - list is empty. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - Container for the necessary parameters to execute the AbortMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AbortMultipartUpload service method, as returned by S3. - REST API Reference for AbortMultipartUpload Operation - - - - Completes a multipart upload by assembling previously uploaded parts. - - - - You first initiate the multipart upload and then upload all parts using the UploadPart - operation. After successfully uploading all relevant parts of an upload, you call - this operation to complete the upload. Upon receiving this request, Amazon S3 concatenates - all the parts in ascending order by part number to create a new object. In the Complete - Multipart Upload request, you must provide the parts list. You must ensure that the - parts list is complete. This operation concatenates the parts that you provide in - the list. For each part in the list, you must provide the part number and the ETag - value, returned after that part was uploaded. - - - - Processing of a Complete Multipart Upload request could take several minutes to complete. - After Amazon S3 begins processing the request, it sends an HTTP response header that - specifies a 200 OK response. While processing is in progress, Amazon S3 periodically - sends white space characters to keep the connection from timing out. Because a request - could fail after the initial 200 OK response has been sent, it is important that you - check the response body to determine whether the request succeeded. - - - - Note that if CompleteMultipartUpload fails, applications should be prepared - to retry the failed requests. For more information, see Amazon - S3 Error Best Practices. - - - - For more information about multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - GetBucketLifecycle has the following special errors: - -
  • - - Error code: EntityTooSmall - -
    • - - Description: Your proposed upload is smaller than the minimum allowed object size. - Each part must be at least 5 MB in size, except the last part. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPart - -
    • - - Description: One or more of the specified parts could not be found. The part might - not have been uploaded, or the specified entity tag might not have matched the part's - entity tag. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPartOrder - -
    • - - Description: The list of parts was not in ascending order. The parts list must be - specified in order by part number. - -
    • - - 400 Bad Request - -
  • - - Error code: NoSuchUpload - -
    • - - Description: The specified multipart upload does not exist. The upload ID might be - invalid, or the multipart upload might have been aborted or completed. - -
    • - - 404 Not Found - -
- - The following operations are related to CompleteMultipartUpload: - - - - Container for the necessary parameters to execute the CompleteMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CompleteMultipartUpload service method, as returned by S3. - REST API Reference for CompleteMultipartUpload Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 Developer Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Encryption - - - - The source object that you are copying can be encrypted or unencrypted. The source - object can be encrypted with server-side encryption using AWS managed encryption keys - (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side - encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers - and decrypts the data when you access it. - - - - You can optionally use the appropriate encryption-related headers to request server-side - encryption for the target object. You have the option to provide your own encryption - key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that - was used to encrypt the source object. You can even request encryption if the source - object was not encrypted. For more information about server-side encryption, see Using - Server-Side Encryption. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject operation to change the storage class of an - object that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 Service Developer Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 Developer Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Encryption - - - - The source object that you are copying can be encrypted or unencrypted. The source - object can be encrypted with server-side encryption using AWS managed encryption keys - (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side - encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers - and decrypts the data when you access it. - - - - You can optionally use the appropriate encryption-related headers to request server-side - encryption for the target object. You have the option to provide your own encryption - key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that - was used to encrypt the source object. You can even request encryption if the source - object was not encrypted. For more information about server-side encryption, see Using - Server-Side Encryption. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject operation to change the storage class of an - object that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 Service Developer Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 Developer Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Encryption - - - - The source object that you are copying can be encrypted or unencrypted. The source - object can be encrypted with server-side encryption using AWS managed encryption keys - (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side - encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers - and decrypts the data when you access it. - - - - You can optionally use the appropriate encryption-related headers to request server-side - encryption for the target object. You have the option to provide your own encryption - key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that - was used to encrypt the source object. You can even request encryption if the source - object was not encrypted. For more information about server-side encryption, see Using - Server-Side Encryption. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject operation to change the storage class of an - object that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 Service Developer Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - Container for the necessary parameters to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - - - - - - Deletes an analytics configuration for the bucket (specified by the analytics configuration - ID). - - - - To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to DeleteBucketAnalyticsConfiguration: - -
  • - - - -
  • - - - -
  • - - - -
- - Container for the necessary parameters to execute the DeleteBucketAnalyticsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketAnalyticsConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketAnalyticsConfiguration Operation - - - - - Deletes an inventory configuration (identified by the inventory ID) from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - Operations related to DeleteBucketInventoryConfiguration include: - - - - Container for the necessary parameters to execute the DeleteBucketInventoryConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketInventoryConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketInventoryConfiguration Operation - - - - Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified - by the metrics configuration ID) from the bucket. Note that this doesn't include the - daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketMetricsConfiguration Operation - - - - This implementation of the DELETE operation uses the policy subresource to delete - the policy of a specified bucket. If you are using an identity other than the root - user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - The bucket name. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketPolicy service method, as returned by S3. - REST API Reference for DeleteBucketPolicy Operation - - - - This implementation of the DELETE operation uses the policy subresource to delete - the policy of a specified bucket. If you are using an identity other than the root - user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - Container for the necessary parameters to execute the DeleteBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketPolicy service method, as returned by S3. - REST API Reference for DeleteBucketPolicy Operation - - - - Deletes the replication configuration from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutReplicationConfiguration - action. The bucket owner has these permissions by default and can grant it to others. - For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - It can take a while for the deletion of a replication configuration to fully propagate. - - - - For information about replication configuration, see Replication - in the Amazon S3 Developer Guide. - - - - The following operations are related to DeleteBucketReplication: - - - - Container for the necessary parameters to execute the DeleteBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketReplication service method, as returned by S3. - REST API Reference for DeleteBucketReplication Operation - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - The bucket that has the tag set to be removed. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketTagging service method, as returned by S3. - REST API Reference for DeleteBucketTagging Operation - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - Container for the necessary parameters to execute the DeleteBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketTagging service method, as returned by S3. - REST API Reference for DeleteBucketTagging Operation - - - - This operation removes the website configuration for a bucket. Amazon S3 returns a - 200 OK response upon successfully deleting a website configuration on - the specified bucket. You will get a 200 OK response if the website configuration - you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE operation requires the S3:DeleteBucketWebsite permission. - By default, only the bucket owner can delete the website configuration attached to - a bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which you want to remove the website configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketWebsite service method, as returned by S3. - REST API Reference for DeleteBucketWebsite Operation - - - - This operation removes the website configuration for a bucket. Amazon S3 returns a - 200 OK response upon successfully deleting a website configuration on - the specified bucket. You will get a 200 OK response if the website configuration - you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE operation requires the S3:DeleteBucketWebsite permission. - By default, only the bucket owner can delete the website configuration attached to - a bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the DeleteBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketWebsite service method, as returned by S3. - REST API Reference for DeleteBucketWebsite Operation - - - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - The bucket name of the lifecycle to delete. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - REST API Reference for DeleteLifecycleConfiguration Operation - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - Container for the necessary parameters to execute the DeleteLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - REST API Reference for DeleteLifecycleConfiguration Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key name of the object to delete. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key name of the object to delete. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - Container for the necessary parameters to execute the DeleteObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - This operation enables you to delete multiple objects from a bucket using a single - HTTP request. If you know the object keys that you want to delete, then this operation - provides a suitable alternative to sending individual delete requests, reducing per-request - overhead. - - - - The request contains a list of up to 1000 keys that you want to delete. In the XML, - you provide the object key names, and optionally, version IDs if you want to delete - a specific version of the object from a versioning-enabled bucket. For each key, Amazon - S3 performs a delete operation and returns the result of that delete, success, or - failure, in the response. Note that if the object specified in the request is not - found, Amazon S3 returns the result as deleted. - - - - The operation supports two modes for the response: verbose and quiet. By default, - the operation uses verbose mode in which the response includes the result of deletion - of each key in your request. In quiet mode the response includes only keys where the - delete operation encountered an error. For a successful deletion, the operation does - not return any information about the delete in the response body. - - - - When performing this operation on an MFA Delete enabled bucket, that attempts to delete - any versioned objects, you must include an MFA token. If you do not provide one, the - entire request will fail, even if there are non-versioned objects you are trying to - delete. If you provide an invalid token, whether there are versioned keys in the request - or not, the entire Multi-Object Delete request will fail. For information about MFA - Delete, see - MFA Delete. - - - - Finally, the Content-MD5 header is required for all Multi-Object Delete requests. - Amazon S3 uses the header value to ensure that your request body has not been altered - in transit. - - - - The following operations are related to DeleteObjects: - - - - Container for the necessary parameters to execute the DeleteObjects service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObjects service method, as returned by S3. - REST API Reference for DeleteObjects Operation - - - - Removes the entire tag set from the specified object. For more information about managing - object tags, see - Object Tagging. - - - - To use this operation, you must have permission to perform the s3:DeleteObjectTagging - action. - - - - To delete tags of a specific object version, add the versionId query - parameter in the request. You will need permission for the s3:DeleteObjectVersionTagging - action. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteObjectTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObjectTagging service method, as returned by S3. - REST API Reference for DeleteObjectTagging Operation - - - - Removes the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:PutBucketPublicAccessBlock - permission. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to DeletePublicAccessBlock: - - - - Container for the necessary parameters to execute the DeletePublicAccessBlock service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeletePublicAccessBlock service method, as returned by S3. - REST API Reference for DeletePublicAccessBlock Operation - - - - - - - - - Returns the default encryption configuration for an Amazon S3 bucket. For information - about the Amazon S3 default encryption feature, see Amazon - S3 Default Bucket Encryption. - - - - To use this operation, you must have permission to perform the s3:GetEncryptionConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to GetBucketEncryption: - - - - Container for the necessary parameters to execute the GetBucketEncryption service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketEncryption service method, as returned by S3. - REST API Reference for GetBucketEncryption Operation - - - - Returns an inventory configuration (identified by the inventory configuration ID) - from the bucket. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - The following operations are related to GetBucketInventoryConfiguration: - - - - Container for the necessary parameters to execute the GetBucketInventoryConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketInventoryConfiguration service method, as returned by S3. - REST API Reference for GetBucketInventoryConfiguration Operation - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - The name of the bucket for which to get the location. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLocation service method, as returned by S3. - REST API Reference for GetBucketLocation Operation - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - Container for the necessary parameters to execute the GetBucketLocation service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLocation service method, as returned by S3. - REST API Reference for GetBucketLocation Operation - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - The bucket name for which to get the logging information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLogging service method, as returned by S3. - REST API Reference for GetBucketLogging Operation - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - Container for the necessary parameters to execute the GetBucketLogging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLogging service method, as returned by S3. - REST API Reference for GetBucketLogging Operation - - - - Gets a metrics configuration (specified by the metrics configuration ID) from the - bucket. Note that this doesn't include the daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to GetBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the GetBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for GetBucketMetricsConfiguration Operation - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following operation is related to GetBucketNotification: - - - - Name of the bucket for which to get the notification configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketNotification service method, as returned by S3. - REST API Reference for GetBucketNotification Operation - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following operation is related to GetBucketNotification: - - - - Container for the necessary parameters to execute the GetBucketNotification service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketNotification service method, as returned by S3. - REST API Reference for GetBucketNotification Operation - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operation is related to GetBucketPolicy: - - - - The bucket name for which to get the bucket policy. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicy service method, as returned by S3. - REST API Reference for GetBucketPolicy Operation - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operation is related to GetBucketPolicy: - - - - Container for the necessary parameters to execute the GetBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicy service method, as returned by S3. - REST API Reference for GetBucketPolicy Operation - - - - Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket - is public. In order to use this operation, you must have the s3:GetBucketPolicyStatus - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - For more information about when Amazon S3 considers a bucket public, see The - Meaning of "Public". - - - - The following operations are related to GetBucketPolicyStatus: - - - - Container for the necessary parameters to execute the GetBucketPolicyStatus service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicyStatus service method, as returned by S3. - REST API Reference for GetBucketPolicyStatus Operation - - - - Retrieves the replication configuration for the given Amazon S3 bucket. - - Container for the necessary parameters to execute the GetBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketReplication service method, as returned by S3. - REST API Reference for GetBucketReplication Operation - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - The name of the bucket for which to get the payment request configuration - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketRequestPayment service method, as returned by S3. - REST API Reference for GetBucketRequestPayment Operation - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - Container for the necessary parameters to execute the GetBucketRequestPayment service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketRequestPayment service method, as returned by S3. - REST API Reference for GetBucketRequestPayment Operation - - - - Returns the tag set associated with the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - GetBucketTagging has the following special error: - -
  • - - Error code: NoSuchTagSetError - -
    • - - Description: There is no tag set associated with the bucket. - -
- - The following operations are related to GetBucketTagging: - - - - Container for the necessary parameters to execute the GetBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketTagging service method, as returned by S3. - REST API Reference for GetBucketTagging Operation - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - The name of the bucket for which to get the versioning information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketVersioning service method, as returned by S3. - REST API Reference for GetBucketVersioning Operation - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - Container for the necessary parameters to execute the GetBucketVersioning service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketVersioning service method, as returned by S3. - REST API Reference for GetBucketVersioning Operation - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET operation requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which to get the website configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketWebsite service method, as returned by S3. - REST API Reference for GetBucketWebsite Operation - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET operation requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the GetBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketWebsite service method, as returned by S3. - REST API Reference for GetBucketWebsite Operation - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - The bucket name for which to get the cors configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetCORSConfiguration service method, as returned by S3. - REST API Reference for GetCORSConfiguration Operation - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - Container for the necessary parameters to execute the GetCORSConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetCORSConfiguration service method, as returned by S3. - REST API Reference for GetCORSConfiguration Operation - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are still using previous version of the lifecycle configuration, it works. - For the earlier API description, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to GetBucketLifecycleConfiguration: - - - - The name of the bucket for which to get the lifecycle information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetLifecycleConfiguration service method, as returned by S3. - REST API Reference for GetLifecycleConfiguration Operation - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are still using previous version of the lifecycle configuration, it works. - For the earlier API description, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to GetBucketLifecycleConfiguration: - - - - Container for the necessary parameters to execute the GetLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetLifecycleConfiguration service method, as returned by S3. - REST API Reference for GetLifecycleConfiguration Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object to get. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object to get. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - Container for the necessary parameters to execute the GetObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Gets an object's current Legal Hold status. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLegalHold service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectLegalHold service method, as returned by S3. - REST API Reference for GetObjectLegalHold Operation - - - - Gets the Object Lock configuration for a bucket. The rule specified in the Object - Lock configuration will be applied by default to every new object placed in the specified - bucket. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLockConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectLockConfiguration service method, as returned by S3. - REST API Reference for GetObjectLockConfiguration Operation - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - The name of the bucket containing the object. - The object key. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - The name of the bucket containing the object. - The object key. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - Container for the necessary parameters to execute the GetObjectMetadata service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - Retrieves an object's retention settings. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectRetention service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectRetention service method, as returned by S3. - REST API Reference for GetObjectRetention Operation - - - - Returns the tag-set of an object. You send the GET request against the tagging subresource - associated with the object. - - - - To use this operation, you must have permission to perform the s3:GetObjectTagging - action. By default, the GET operation returns information about current version of - an object. For a versioned bucket, you can have multiple versions of an object in - your bucket. To retrieve tags of any other version, use the versionId query parameter. - You also need permission for the s3:GetObjectVersionTagging action. - - - - By default, the bucket owner has this permission and can grant this permission to - others. - - - - For information about the Amazon S3 object tagging feature, see Object - Tagging. - - - - The following operation is related to GetObjectTagging: - - - - Container for the necessary parameters to execute the GetObjectTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTagging service method, as returned by S3. - REST API Reference for GetObjectTagging Operation - - - - Return torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Amazon - S3 Torrent. - - - - You can get torrent only for objects that are less than 5 GB in size and that are - not encrypted using server-side encryption with customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - The following operation is related to GetObjectTorrent: - - - - The name of the bucket containing the object for which to get the torrent files. - The object key for which to get the information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTorrent service method, as returned by S3. - REST API Reference for GetObjectTorrent Operation - - - - Return torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Amazon - S3 Torrent. - - - - You can get torrent only for objects that are less than 5 GB in size and that are - not encrypted using server-side encryption with customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - The following operation is related to GetObjectTorrent: - - - - Container for the necessary parameters to execute the GetObjectTorrent service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTorrent service method, as returned by S3. - REST API Reference for GetObjectTorrent Operation - - - - Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:GetBucketPublicAccessBlock - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket - or an object, it checks the PublicAccessBlock configuration for both - the bucket (or the bucket that contains the object) and the bucket owner's account. - If the PublicAccessBlock settings are different between the bucket and - the account, Amazon S3 uses the most restrictive combination of the bucket-level and - account-level settings. - - - - For more information about when Amazon S3 considers a bucket or an object public, - see The - Meaning of "Public". - - - - The following operations are related to GetPublicAccessBlock: - - - - Container for the necessary parameters to execute the GetPublicAccessBlock service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetPublicAccessBlock service method, as returned by S3. - REST API Reference for GetPublicAccessBlock Operation - - - - This operation initiates a multipart upload and returns an upload ID. This upload - ID is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort operation - and Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload API and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart) and UploadPartCopy) requests must match the headers you - used in the request to initiate the upload by using CreateMultipartUpload. - - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, - kms:GenerateDataKey*, and kms:DescribeKey actions on the - key. These permissions are required because Amazon S3 must decrypt and read data from - the encrypted file parts before it completes the multipart upload. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - The following operations are related to CreateMultipartUpload: - - - - The name of the bucket to which to initiate the upload - Object key for which the multipart upload is to be initiated. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the InitiateMultipartUpload service method, as returned by S3. - REST API Reference for InitiateMultipartUpload Operation - - - - This operation initiates a multipart upload and returns an upload ID. This upload - ID is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort operation - and Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload API and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart) and UploadPartCopy) requests must match the headers you - used in the request to initiate the upload by using CreateMultipartUpload. - - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, - kms:GenerateDataKey*, and kms:DescribeKey actions on the - key. These permissions are required because Amazon S3 must decrypt and read data from - the encrypted file parts before it completes the multipart upload. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - The following operations are related to CreateMultipartUpload: - - - - Container for the necessary parameters to execute the InitiateMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the InitiateMultipartUpload service method, as returned by S3. - REST API Reference for InitiateMultipartUpload Operation - - - - Lists the analytics configurations for the bucket. You can have up to 1,000 analytics - configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. You should always check the IsTruncated element in the response. - If there are no more configurations to list, IsTruncated is set to false. - If there are more configurations to list, IsTruncated is set to true, - and there will be a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to ListBucketAnalyticsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketAnalyticsConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketAnalyticsConfigurations service method, as returned by S3. - REST API Reference for ListBucketAnalyticsConfigurations Operation - - - - Returns a list of inventory configurations for the bucket. You can have up to 1,000 - analytics configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory - - - - The following operations are related to ListBucketInventoryConfigurations: - - - - Container for the necessary parameters to execute the ListBucketInventoryConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketInventoryConfigurations service method, as returned by S3. - REST API Reference for ListBucketInventoryConfigurations Operation - - - - Lists the metrics configurations for the bucket. The metrics configurations are only - for the request metrics of the bucket and do not provide information on daily storage - metrics. You can have up to 1,000 configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For more information about metrics configurations and CloudWatch request metrics, - see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to ListBucketMetricsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketMetricsConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketMetricsConfigurations service method, as returned by S3. - REST API Reference for ListBucketMetricsConfigurations Operation - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBuckets service method, as returned by S3. - REST API Reference for ListBuckets Operation - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - Container for the necessary parameters to execute the ListBuckets service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBuckets service method, as returned by S3. - REST API Reference for ListBuckets Operation - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Container for the necessary parameters to execute the ListMultipartUploads service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. - Limits the response to keys that begin with the specified prefix. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - Container for the necessary parameters to execute the ListObjects service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Make sure to design - your application to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - To use this operation in an AWS Identity and Access Management (IAM) policy, you must - have permissions to perform the s3:ListBucket action. The bucket owner - has this permission by default and can grant this permission to others. For more information - about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - This section describes the latest revision of the API. We recommend that you use this - revised API for application development. For backward compatibility, Amazon S3 continues - to support the prior version of this API, ListObjects. - - - - To get a list of your buckets, see ListBuckets. - - - - The following operations are related to ListObjectsV2: - - - - Container for the necessary parameters to execute the ListObjectsV2 service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjectsV2 service method, as returned by S3. - REST API Reference for ListObjectsV2 Operation - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). This request returns a maximum of 1,000 - uploaded parts. The default number of parts returned is 1,000 parts. You can restrict - the number of parts returned by specifying the max-parts request parameter. - If your multipart upload consists of more than 1,000 parts, the response returns an - IsTruncated field with the value of true, and a NextPartNumberMarker - element. In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListParts: - - - - Name of the bucket to which the parts are being uploaded. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Object key for which the multipart upload was initiated. - Upload ID identifying the multipart upload whose parts are being listed. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListParts service method, as returned by S3. - REST API Reference for ListParts Operation - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). This request returns a maximum of 1,000 - uploaded parts. The default number of parts returned is 1,000 parts. You can restrict - the number of parts returned by specifying the max-parts request parameter. - If your multipart upload consists of more than 1,000 parts, the response returns an - IsTruncated field with the value of true, and a NextPartNumberMarker - element. In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListParts: - - - - Container for the necessary parameters to execute the ListParts service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListParts service method, as returned by S3. - REST API Reference for ListParts Operation - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - Container for the necessary parameters to execute the ListVersions service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - - Creates a new bucket. To create a bucket, you must register with Amazon S3 and have - a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed - to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information on bucket naming restrictions, - see Working - with Amazon S3 Buckets. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) - Region. For more information, see How - to Select a Region for Your Buckets. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - Hosting of Buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - The name of the bucket to create. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucket service method, as returned by S3. - REST API Reference for PutBucket Operation - - - - Creates a new bucket. To create a bucket, you must register with Amazon S3 and have - a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed - to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information on bucket naming restrictions, - see Working - with Amazon S3 Buckets. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) - Region. For more information, see How - to Select a Region for Your Buckets. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - Hosting of Buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - Container for the necessary parameters to execute the PutBucket service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucket service method, as returned by S3. - REST API Reference for PutBucket Operation - - - - Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration - is a bucket-level feature that enables you to perform faster data transfers to Amazon - S3. - - - - To use this operation, you must have permission to perform the s3:PutAccelerateConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The Transfer Acceleration state of a bucket can be set to one of the following two - values: - -
  • - - Enabled – Enables accelerated data transfers to the bucket. - -
  • - - Suspended – Disables accelerated data transfers to the bucket. - -
- - The GetBucketAccelerateConfiguration operation returns the transfer acceleration - state of a bucket. - - - - After setting the Transfer Acceleration state of a bucket to Enabled, it might take - up to thirty minutes before the data transfer rates to the bucket increase. - - - - The name of the bucket used for Transfer Acceleration must be DNS-compliant and must - not contain periods ("."). - - - - For more information about transfer acceleration, see Transfer - Acceleration. - - - - The following operations are related to PutBucketAccelerateConfiguration: - - - - Container for the necessary parameters to execute the PutBucketAccelerateConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketAccelerateConfiguration service method, as returned by S3. - REST API Reference for PutBucketAccelerateConfiguration Operation - - - - - - - Set the logging parameters for a bucket and to specify permissions for who can view - and modify the logging parameters. All logs are saved to buckets in the same AWS Region - as the source bucket. To set the logging status of a bucket, you must be the bucket - owner. - - - - The bucket owner is automatically granted FULL_CONTROL to all logs. You use the Grantee - request element to grant access to other people. The Permissions request - element specifies the kind of access the grantee has to the logs. - - - - Grantee Values - - - - You can specify the person (grantee) to whom you're assigning access rights (using - request elements) in the following ways: - -
  • - - By the person's ID: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> - </Grantee> - - - - DisplayName is optional and ignored in the request. - -
  • - - By Email address: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee> - - - - - The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl - request, appears as the CanonicalUser. - -
  • - - By URI: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee> - - -
- - To enable logging, you use LoggingEnabled and its children request elements. To disable - logging, you use an empty BucketLoggingStatus request element: - - - - <BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01" /> - - - - - For more information about server access logging, see Server - Access Logging. - - - - For more information about creating a bucket, see CreateBucket. For more information - about returning the logging status of a bucket, see GetBucketLogging. - - - - The following operations are related to PutBucketLogging: - - - - Container for the necessary parameters to execute the PutBucketLogging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketLogging service method, as returned by S3. - REST API Reference for PutBucketLogging Operation - - - - Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. - You can have up to 1,000 metrics configurations per bucket. If you're updating an - existing metrics configuration, note that this is a full replacement of the existing - metrics configuration. If you don't include the elements you want to keep, they are - erased. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to PutBucketMetricsConfiguration: - - - - GetBucketLifecycle has the following special error: - -
  • - - Error code: TooManyConfigurations - -
    • - - Description: You are attempting to create a new configuration but have already reached - the 1,000-configuration limit. - -
    • - - HTTP Status Code: HTTP 400 Bad Request - -
- - Container for the necessary parameters to execute the PutBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for PutBucketMetricsConfiguration Operation - - - - Enables notifications of specified events for a bucket. For more information about - event notifications, see Configuring - Event Notifications. - - - - Using this API, you can replace an existing notification configuration. The configuration - is an XML file that defines the event types that you want Amazon S3 to publish and - the destination where you want Amazon S3 to publish an event notification when it - detects an event of the specified type. - - - - By default, your bucket has no event notifications configured. That is, the notification - configuration will be an empty NotificationConfiguration. - - - - <NotificationConfiguration> - - - - </NotificationConfiguration> - - - - This operation replaces the existing notification configuration with the configuration - you include in the request body. - - - - After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification - Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, - and that the bucket owner has permission to publish to it by sending a test notification. - In the case of AWS Lambda destinations, Amazon S3 verifies that the Lambda function - permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. - For more information, see Configuring - Notifications for Amazon S3 Events. - - - - You can disable notifications by adding the empty NotificationConfiguration element. - - - - By default, only the bucket owner can configure notifications on a bucket. However, - bucket owners can use a bucket policy to grant permission to other users to set this - configuration with s3:PutBucketNotification permission. - - - - The PUT notification is an atomic operation. For example, suppose your notification - configuration includes SNS topic, SQS queue, and Lambda function configurations. When - you send a PUT request with this configuration, Amazon S3 sends test messages to your - SNS topic. If the message fails, the entire PUT operation will fail, and Amazon S3 - will not add the configuration to your bucket. - - - - Responses - - - - If the configuration in the request body includes only one TopicConfiguration - specifying only the s3:ReducedRedundancyLostObject event type, the response - will also include the x-amz-sns-test-message-id header containing the - message ID of the test notification sent to the topic. - - - - The following operation is related to PutBucketNotificationConfiguration: - - - - Container for the necessary parameters to execute the PutBucketNotification service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketNotification service method, as returned by S3. - REST API Reference for PutBucketNotification Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - The MD5 hash of the request body. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - Container for the necessary parameters to execute the PutBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Creates a replication configuration or replaces an existing one. For more information, - see Replication - in the Amazon S3 Developer Guide. - - - - To perform this operation, the user or role performing the operation must have the - iam:PassRole - permission. - - - - Specify the replication configuration in the request body. In the replication configuration, - you provide the name of the destination bucket where you want Amazon S3 to replicate - objects, the IAM role that Amazon S3 can assume to replicate objects on your behalf, - and other relevant information. - - - - A replication configuration must include at least one rule, and can contain a maximum - of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects - in the source bucket. To choose additional subsets of objects to replicate, add a - rule for each subset. All rules must specify the same destination bucket. - - - - To specify a subset of the objects in the source bucket to apply a replication rule - to, add the Filter element as a child of the Rule element. You can filter objects - based on an object key prefix, one or more object tags, or both. When you add the - Filter element in the configuration, you must also add the following elements: DeleteMarkerReplication, - Status, and Priority. - - - - For information about enabling versioning on a bucket, see Using - Versioning. - - - - By default, a resource owner, in this case the AWS account that created the bucket, - can perform this operation. The resource owner can also grant others permissions to - perform the operation. For more information about permissions, see Specifying - Permissions in a Policy and Managing - Access Permissions to Your Amazon S3 Resources. - - - - Handling Replication of Encrypted Objects - - - - By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side - encryption with CMKs stored in AWS KMS. To replicate AWS KMS-encrypted objects, add - the following: SourceSelectionCriteria, SseKmsEncryptedObjects, - Status, EncryptionConfiguration, and ReplicaKmsKeyID. - For information about replication configuration, see Replicating - Objects Created with SSE Using CMKs stored in AWS KMS. - - - - For information on PutBucketReplication errors, see ReplicationErrorCodeList - - - - - The following operations are related to PutBucketReplication: - - - - Container for the necessary parameters to execute the PutBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketReplication service method, as returned by S3. - REST API Reference for PutBucketReplication Operation - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - The bucket name. - Container for Payer. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketRequestPayment service method, as returned by S3. - REST API Reference for PutBucketRequestPayment Operation - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - Container for the necessary parameters to execute the PutBucketRequestPayment service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketRequestPayment service method, as returned by S3. - REST API Reference for PutBucketRequestPayment Operation - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging. - - - - Within a bucket, if you add a tag that has the same key as an existing tag, the new - value overwrites the old value. For more information, see Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional operation is currently in progress against - this resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - The bucket name. - A property of PutBucketTaggingRequest used to execute the PutBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketTagging service method, as returned by S3. - REST API Reference for PutBucketTagging Operation - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging. - - - - Within a bucket, if you add a tag that has the same key as an existing tag, the new - value overwrites the old value. For more information, see Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional operation is currently in progress against - this resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - Container for the necessary parameters to execute the PutBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketTagging service method, as returned by S3. - REST API Reference for PutBucketTagging Operation - - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT operation requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - Amazon S3 has a limitation of 50 routing rules per website configuration. If you require - more than 50 routing rules, you can use object redirect. For more information, see - Configuring - an Object Redirect in the Amazon Simple Storage Service Developer Guide. - - - The bucket name. - Container for the request. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketWebsite service method, as returned by S3. - REST API Reference for PutBucketWebsite Operation - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT operation requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - Amazon S3 has a limitation of 50 routing rules per website configuration. If you require - more than 50 routing rules, you can use object redirect. For more information, see - Configuring - an Object Redirect in the Amazon Simple Storage Service Developer Guide. - - - Container for the necessary parameters to execute the PutBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketWebsite service method, as returned by S3. - REST API Reference for PutBucketWebsite Operation - - - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - The name of the bucket for which to set the configuration. - A property of PutLifecycleConfigurationRequest used to execute the PutLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutLifecycleConfiguration service method, as returned by S3. - REST API Reference for PutLifecycleConfiguration Operation - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - Container for the necessary parameters to execute the PutLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutLifecycleConfiguration service method, as returned by S3. - REST API Reference for PutLifecycleConfiguration Operation - - - - - - - - - - - - - - - - - The base class for requests that return Amazon S3 objects. - - - - - Gets or sets the name of the bucket. - - - The name of the bucket. - - - - - Gets whether or not the bucket name is set. - - - A value of true if the bucket name is set. - Returns false if otherwise. - - - - - Gets or sets the key under which the Amazon S3 object is stored. - - - The key under which the Amazon S3 object is stored. - - - - - Gets whether or not the key property is set. - - - A value of true if key property is set. - Returns false if otherwise. - - - - - Gets or sets the version ID of the Amazon S3 object. - - - The version ID of the Amazon S3 object. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or - ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Gets or sets the ModifiedSinceDate property. - - - The ModifiedSinceDate property. - - - - - Gets or sets the ModifiedSinceDate property. - - - The ModifiedSinceDate property. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or - UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Gets or sets the UnmodifiedSinceDate property. - - - The UnmodifiedSinceDate property. - - - - - Gets or sets the UnmodifiedSinceDate property. - - - The UnmodifiedSinceDate property. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to decrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - The base class TransferUtility request classes. - - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - - Gets the Amazon S3 client used for making calls into Amazon S3. - - - The Amazon S3 client used for making calls into Amazon S3. - - - - - Uploads the specified file. - The object key is derived from the file's name. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the specified file. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the contents of the specified stream. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The stream to read to obtain the content to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the stream to. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the file or stream specified by the request. - To track the progress of the upload, - add an event listener to the request's UploadProgressEvent. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - Contains all the parameters required to upload to Amazon S3. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Aborts the multipart uploads that were initiated before the specified date. - - - The name of the bucket containing multipart uploads. - - - The date before which the multipart uploads were initiated. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the content from Amazon S3 and writes it to the specified file. - If the key is not specified in the request parameter, - the file name will used as the key name. - - - Contains all the parameters required to download an Amazon S3 object. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Returns a stream from which the caller can read the content from the specified - Amazon S3 bucket and key. - The caller of this method is responsible for closing the stream. - - - The name of the bucket. - - - The object key. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Returns a stream to read the contents from Amazon S3 as - specified by the TransferUtilityOpenStreamRequest. - The caller of this method is responsible for closing the stream. - - - Contains all the parameters required for the OpenStream operation. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - - Constructs a new class. - - - The AWS Access Key ID. - - - The AWS Secret Access Key. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new class. - - - The AWS Access Key ID. - - - The AWS Secret Access Key. - - - The region to configure the transfer utility for. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new instance of the class. - - - The AWS Access Key ID. - - - The AWS Secret Access Key. - - - Specifies advanced settings. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new instance of the class. - - - The AWS Access Key ID. - - - The AWS Secret Access Key. - - - The region to configure the transfer utility for. - - - Specifies advanced settings. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new instance of the class. - - - The Amazon S3 client. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Initializes a new instance of the class. - - - The Amazon S3 client. - - - Specifies advanced configuration settings for . - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Gets the Amazon S3 client used for making calls into Amazon S3. - - - The Amazon S3 client used for making calls into Amazon S3. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Uploads the specified file. - The object key is derived from the file's name. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the specified file. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the contents of the specified stream. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The stream to read to obtain the content to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the stream to. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the file or stream specified by the request. - To track the progress of the upload, - add an event listener to the request's UploadProgressEvent. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - Contains all the parameters required to upload to Amazon S3. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Aborts the multipart uploads that were initiated before the specified date. - - - The name of the bucket containing multipart uploads. - - - The date before which the multipart uploads were initiated. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the content from Amazon S3 and writes it to the specified file. - If the key is not specified in the request parameter, - the file name will used as the key name. - - - Contains all the parameters required to download an Amazon S3 object. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Returns a stream from which the caller can read the content from the specified - Amazon S3 bucket and key. - The caller of this method is responsible for closing the stream. - - - The name of the bucket. - - - The object key. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Returns a stream to read the contents from Amazon S3 as - specified by the TransferUtilityOpenStreamRequest. - The caller of this method is responsible for closing the stream. - - - Contains all the parameters required for the OpenStream operation. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - - Provides configuration options for how processes requests. - - - The best configuration settings depend on network - configuration, latency and bandwidth. - The default configuration settings are suitable - for most applications, but this class enables developers to experiment with - different configurations and tune transfer manager performance. - - - - - - Default constructor. - - - - - Gets or sets the minimum part size for upload parts in bytes. The default is 16 MB. - Decreasing the minimum part size causes - multipart uploads to be split into a larger number - of smaller parts. Setting this value too low has a negative effect - on transfer speeds, causing extra latency and network - communication for each part. - - - - - This property determines how many active threads - or the number of concurrent asynchronous web requests - will be used to upload/download the file . - The default value is 10. - - - A value less than or equal to 0 will be silently ignored. - - - - - Gets or sets the number of executing threads. - This property determines how many active threads will be used to upload - the file. The default value is 10 threads. - - - A value less than or equal to 0 will be silently ignored. - - - - - Contains all the parameters - that can be set when making a this request with the - TransferUtility method. - - - - - Get or sets the file path location of where the - downloaded Amazon S3 object will be written to. - - - The file path location of where the downloaded Amazon S3 object will be written to. - - - - - Checks if FilePath property is set. - - True if FilePath property is set. - - - - The event for WriteObjectProgressEvent notifications. All - subscribers will be notified when a new progress - event is raised. - - The WriteObjectProgressEvent is fired as data - is downloaded from S3. The delegates attached to the event - will be passed information detailing how much data - has been downloaded as well as how much will be downloaded. - - - - Subscribe to this event if you want to receive - WriteObjectProgressEvent notifications. Here is how:
- 1. Define a method with a signature similar to this one: - - private void displayProgress(object sender, WriteObjectProgressArgs args) - { - Console.WriteLine(args); - } - - 2. Add this method to the WriteObjectProgressEvent delegate's invocation list - - TransferUtilityDownloadRequest request = new TransferUtilityDownloadRequest(); - request.WriteObjectProgressEvent += displayProgress; - - - - - - Causes the WriteObjectProgressEvent event to be fired. - - Progress data for the stream being written to file. - - - - Contains all the parameters - that can be set when making a this request with the - TransferUtility method. - - - - - Contains all the parameters - that can be set when making a this request with the - TransferUtility method. - - - - - Gets or sets the name of the bucket. - - - The name of the bucket. - - - - - Checks if BucketName property is set. - - true if BucketName property is set. - - - - Gets or sets the key under which the Amazon S3 object is to be stored. - - - The key under which the Amazon S3 object is to be stored. - - - - - Checks if Key property is set. - - true if Key property is set. - - - - Gets or sets the canned access control list (ACL) - for the uploaded object. - Please refer to - for - information on Amazon S3 canned ACLs. - - - The canned access control list (ACL) - for the uploaded object. - - - - - Checks if the CannedACL property is set. - - true if there is the CannedACL property is set. - - - - Removes the cannned access control list (ACL) - for the uploaded object. - - - - - Gets or sets the content type of the uploaded Amazon S3 object. - - - The content type of the uploaded Amazon S3 object. - - - - - Checks if ContentType property is set. - - true if ContentType property is set. - - - - Gets or sets the storage class for the uploaded Amazon S3 object. - Please refer to - for - information on S3 Storage Classes. - - - The storage class for the uploaded Amazon S3 object. - - - - - Gets and sets the ServerSideEncryptionMethod property. - Specifies the encryption used on the server to - store the content. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Input stream for the request; content for the request will be read from the stream. - - - - - - Gets or sets the file path - where the Amazon S3 object will be uploaded from. - - - For WinRT and Windows Phone this property must be in the form of "ms-appdata:///local/file.txt". - - - - The file path where the Amazon S3 object will be uploaded from. - - - - - Checks if FilePath property is set. - - true if FilePath property is set. - - - - Gets or sets the part size of the upload in bytes. - The uploaded file will be divided into - parts the size specified and - uploaded to Amazon S3 individually. - - - The part size of the upload. - - - - - Checks if PartSize property is set. - - true if PartSize property is set. - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - The tag-set for the object. - - - - - The event for UploadProgressEvent notifications. All - subscribers will be notified when a new progress - event is raised. - - The UploadProgressEvent is fired as data - is uploaded to S3. The delegates attached to the event - will be passed information detailing how much data - has been uploaded as well as how much will be uploaded. - - - - Subscribe to this event if you want to receive - UploadProgressEvent notifications. Here is how:
- 1. Define a method with a signature similar to this one: - - private void displayProgress(object sender, UploadProgressArgs args) - { - Console.WriteLine(args); - } - - 2. Add this method to the UploadProgressEvent delegate's invocation list - - TransferUtilityUploadRequest request = new TransferUtilityUploadRequest(); - request.UploadProgressEvent += displayProgress; - - - - - - Causes the UploadProgressEvent event to be fired. - - Progress data for the file being uploaded. - - - - Gets the length of the content by either checking the FileInfo.Length property or the Stream.Length property. - - The length of the content. - - - - Gets or sets whether or not the stream used with this request is - automatically closed when all of the content is read from the stream. - - - A value of true if the if the stream is - automatically closed when all of the content is read from the stream. - A value of false if otherwise. - - - - - If this value is set to true then the stream's position will be reset to the start before being read for upload. - Default: true. - - - - - Sets whether or not the stream used with this request is - automatically closed when all of the content is read from the stream - and returns this object instance, - enabling additional method calls to be chained together. - - - A value of true if the if the stream is - automatically closed when all of the content is read from the stream. - A value of false if otherwise. - - - This object instance, enabling additional method calls to be chained together. - - - - - Encapsulates the information needed to provide - transfer progress to subscribers of the Put Object - Event. - - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The how many bytes were transferred since last event. - The number of bytes transferred - The total number of bytes to be transferred - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The how many bytes were transferred since last event. - The number of bytes transferred - The total number of bytes to be transferred - The file being uploaded - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The how many bytes were transferred since last event. - The number of bytes transferred - The total number of bytes to be transferred - A compensation for any upstream aggregators if this event to correct theit totalTransferred count, - in case the underlying request is retried. - The file being uploaded - - - - Gets the FilePath. - - - - - Waits for all of the tasks to complete or till any task fails or is canceled. - - - - - Waits for all of the tasks to complete or till any task fails or is canceled. - - - - - Returns the amount of bytes remaining that need to be pulled down from S3. - - The fully qualified path of the file. - - - - - The command to manage an upload using the S3 multipart API. - - - - - Initializes a new instance of the class. - - The s3 client. - The config object that has the number of threads to use. - The file transporter request. - - - - This command is for doing regular PutObject requests. - - - - - Configuration for the S3 section of AWS configuration. - Changes to some settings may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws> - <s3 useSignatureVersion4="true" /> - </aws> - - - - - - Key for the S3UseSignatureVersion4Key property. - - - - - - Configures if the S3 client should use Signature Version 4 signing with requests. - By default, this setting is set to true which will use Signature Version 4 for all - requests except presigned URL requests when the region is set to us-east-1. When - UseSignatureVersion4 is explicitly set to true by directly setting this property or - directly setting this property through configuration, Signature Version 4 will be - used for all requests when able to do so. - When this setting is false, Signature Version 2 will be used. Note that when the - setting is false, Signature Version 4 may still be used by default in some cases - or with some regions. - - - - - Escape and unescape S3 metadata for S3 Put/Get object requests. - Escape only escapes non-ascii values in metadata - Any "%" values in metadata could interfere with this option. - Default value is false. - - - - - Was the value of the UseSignatureVersion4 property set explicitly? - This can be done via configuration or by directly setting the property. - - This is used to determine if the user set UseSignatureVersion4 to true, - or if it's true because the default was changed to true in the SDK. - - - - diff --git a/packages/AWSSDK.S3.3.3.111.14/lib/MonoAndroid10/AWSSDK.S3.dll b/packages/AWSSDK.S3.3.3.111.14/lib/MonoAndroid10/AWSSDK.S3.dll deleted file mode 100644 index 0610561..0000000 Binary files a/packages/AWSSDK.S3.3.3.111.14/lib/MonoAndroid10/AWSSDK.S3.dll and /dev/null differ diff --git a/packages/AWSSDK.S3.3.3.111.14/lib/MonoTouch10/AWSSDK.S3.XML b/packages/AWSSDK.S3.3.3.111.14/lib/MonoTouch10/AWSSDK.S3.XML deleted file mode 100644 index 389da7c..0000000 --- a/packages/AWSSDK.S3.3.3.111.14/lib/MonoTouch10/AWSSDK.S3.XML +++ /dev/null @@ -1,28560 +0,0 @@ - - - - AWSSDK.S3 - - - - - Implementation for accessing S3 - - - - - - - Specialize the initialize of the client. - - - - - Create a signed URL allowing access to a resource that would - usually require authentication. - - - - When using query string authentication you create a query, - specify an expiration time for the query, sign it with your - signature, place the data in an HTTP request, and distribute - the request to a user or embed the request in a web page. - - - A PreSigned URL can be generated for GET, PUT, DELETE and HEAD - operations on your bucketName, keys, and versions. - - - The GetPreSignedUrlRequest that defines the - parameters of the operation. - determines if signing will fall back to SigV2 if the - signing region is us-east-1 - A string that is the signed http request. - - - - - - Marshalls the parameters for a presigned url for a preferred signing protocol. - - - - - - True if AWS4 signing will be used; if the expiry period in the request exceeds the - maximum allowed for AWS4 (one week), an ArgumentException is thrown. - - - - - - Create a signed URL allowing access to a resource that would - usually require authentication. - - - - When using query string authentication you create a query, - specify an expiration time for the query, sign it with your - signature, place the data in an HTTP request, and distribute - the request to a user or embed the request in a web page. - - - A PreSigned URL can be generated for GET, PUT, DELETE and HEAD - operations on your bucketName, keys, and versions. - - - The GetPreSignedUrlRequest that defines the - parameters of the operation. - A string that is the signed http request. - - - - - - Constructs AmazonS3Client with AWS Credentials - - AWS Credentials - - - - Constructs AmazonS3Client with AWS Credentials - - AWS Credentials - The region to connect. - - - - Constructs AmazonS3Client with AWS Credentials and an - AmazonS3Client Configuration object. - - AWS Credentials - The AmazonS3Client Configuration Object - - - - Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - - - - Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - The region to connect. - - - - Constructs AmazonS3Client with AWS Access Key ID, AWS Secret Key and an - AmazonS3Client Configuration object. - - AWS Access Key ID - AWS Secret Access Key - The AmazonS3Client Configuration Object - - - - Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - - - - Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - The region to connect. - - - - Constructs AmazonS3Client with AWS Access Key ID, AWS Secret Key and an - AmazonS3Client Configuration object. - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - The AmazonS3Client Configuration Object - - - - Creates the signer for the service. - - - - - Customizes the runtime pipeline. - - Runtime pipeline for the current client. - - - - Capture metadata for the service. - - - - - Disposes the service client. - - - - - This operation aborts a multipart upload. After a multipart upload is aborted, no - additional parts can be uploaded using that upload ID. The storage consumed by any - previously uploaded parts will be freed. However, if any part uploads are currently - in progress, those part uploads might or might not succeed. As a result, it might - be necessary to abort a given multipart upload multiple times in order to completely - free all storage consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts operation and ensure that the parts - list is empty. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - The bucket name to which the upload was taking place. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object for which the multipart upload was initiated. - Upload ID that identifies the multipart upload. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AbortMultipartUpload service method, as returned by S3. - REST API Reference for AbortMultipartUpload Operation - - - - This operation aborts a multipart upload. After a multipart upload is aborted, no - additional parts can be uploaded using that upload ID. The storage consumed by any - previously uploaded parts will be freed. However, if any part uploads are currently - in progress, those part uploads might or might not succeed. As a result, it might - be necessary to abort a given multipart upload multiple times in order to completely - free all storage consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts operation and ensure that the parts - list is empty. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - Container for the necessary parameters to execute the AbortMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AbortMultipartUpload service method, as returned by S3. - REST API Reference for AbortMultipartUpload Operation - - - - Completes a multipart upload by assembling previously uploaded parts. - - - - You first initiate the multipart upload and then upload all parts using the UploadPart - operation. After successfully uploading all relevant parts of an upload, you call - this operation to complete the upload. Upon receiving this request, Amazon S3 concatenates - all the parts in ascending order by part number to create a new object. In the Complete - Multipart Upload request, you must provide the parts list. You must ensure that the - parts list is complete. This operation concatenates the parts that you provide in - the list. For each part in the list, you must provide the part number and the ETag - value, returned after that part was uploaded. - - - - Processing of a Complete Multipart Upload request could take several minutes to complete. - After Amazon S3 begins processing the request, it sends an HTTP response header that - specifies a 200 OK response. While processing is in progress, Amazon S3 periodically - sends white space characters to keep the connection from timing out. Because a request - could fail after the initial 200 OK response has been sent, it is important that you - check the response body to determine whether the request succeeded. - - - - Note that if CompleteMultipartUpload fails, applications should be prepared - to retry the failed requests. For more information, see Amazon - S3 Error Best Practices. - - - - For more information about multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - GetBucketLifecycle has the following special errors: - -
  • - - Error code: EntityTooSmall - -
    • - - Description: Your proposed upload is smaller than the minimum allowed object size. - Each part must be at least 5 MB in size, except the last part. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPart - -
    • - - Description: One or more of the specified parts could not be found. The part might - not have been uploaded, or the specified entity tag might not have matched the part's - entity tag. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPartOrder - -
    • - - Description: The list of parts was not in ascending order. The parts list must be - specified in order by part number. - -
    • - - 400 Bad Request - -
  • - - Error code: NoSuchUpload - -
    • - - Description: The specified multipart upload does not exist. The upload ID might be - invalid, or the multipart upload might have been aborted or completed. - -
    • - - 404 Not Found - -
- - The following operations are related to CompleteMultipartUpload: - - - - Container for the necessary parameters to execute the CompleteMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CompleteMultipartUpload service method, as returned by S3. - REST API Reference for CompleteMultipartUpload Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 Developer Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Encryption - - - - The source object that you are copying can be encrypted or unencrypted. The source - object can be encrypted with server-side encryption using AWS managed encryption keys - (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side - encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers - and decrypts the data when you access it. - - - - You can optionally use the appropriate encryption-related headers to request server-side - encryption for the target object. You have the option to provide your own encryption - key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that - was used to encrypt the source object. You can even request encryption if the source - object was not encrypted. For more information about server-side encryption, see Using - Server-Side Encryption. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject operation to change the storage class of an - object that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 Service Developer Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 Developer Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Encryption - - - - The source object that you are copying can be encrypted or unencrypted. The source - object can be encrypted with server-side encryption using AWS managed encryption keys - (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side - encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers - and decrypts the data when you access it. - - - - You can optionally use the appropriate encryption-related headers to request server-side - encryption for the target object. You have the option to provide your own encryption - key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that - was used to encrypt the source object. You can even request encryption if the source - object was not encrypted. For more information about server-side encryption, see Using - Server-Side Encryption. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject operation to change the storage class of an - object that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 Service Developer Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 Developer Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Encryption - - - - The source object that you are copying can be encrypted or unencrypted. The source - object can be encrypted with server-side encryption using AWS managed encryption keys - (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side - encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers - and decrypts the data when you access it. - - - - You can optionally use the appropriate encryption-related headers to request server-side - encryption for the target object. You have the option to provide your own encryption - key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that - was used to encrypt the source object. You can even request encryption if the source - object was not encrypted. For more information about server-side encryption, see Using - Server-Side Encryption. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject operation to change the storage class of an - object that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 Service Developer Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - Container for the necessary parameters to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - - - - - - Deletes an analytics configuration for the bucket (specified by the analytics configuration - ID). - - - - To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to DeleteBucketAnalyticsConfiguration: - -
  • - - - -
  • - - - -
  • - - - -
- - Container for the necessary parameters to execute the DeleteBucketAnalyticsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketAnalyticsConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketAnalyticsConfiguration Operation - - - - - Deletes an inventory configuration (identified by the inventory ID) from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - Operations related to DeleteBucketInventoryConfiguration include: - - - - Container for the necessary parameters to execute the DeleteBucketInventoryConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketInventoryConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketInventoryConfiguration Operation - - - - Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified - by the metrics configuration ID) from the bucket. Note that this doesn't include the - daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketMetricsConfiguration Operation - - - - This implementation of the DELETE operation uses the policy subresource to delete - the policy of a specified bucket. If you are using an identity other than the root - user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - The bucket name. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketPolicy service method, as returned by S3. - REST API Reference for DeleteBucketPolicy Operation - - - - This implementation of the DELETE operation uses the policy subresource to delete - the policy of a specified bucket. If you are using an identity other than the root - user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - Container for the necessary parameters to execute the DeleteBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketPolicy service method, as returned by S3. - REST API Reference for DeleteBucketPolicy Operation - - - - Deletes the replication configuration from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutReplicationConfiguration - action. The bucket owner has these permissions by default and can grant it to others. - For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - It can take a while for the deletion of a replication configuration to fully propagate. - - - - For information about replication configuration, see Replication - in the Amazon S3 Developer Guide. - - - - The following operations are related to DeleteBucketReplication: - - - - Container for the necessary parameters to execute the DeleteBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketReplication service method, as returned by S3. - REST API Reference for DeleteBucketReplication Operation - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - The bucket that has the tag set to be removed. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketTagging service method, as returned by S3. - REST API Reference for DeleteBucketTagging Operation - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - Container for the necessary parameters to execute the DeleteBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketTagging service method, as returned by S3. - REST API Reference for DeleteBucketTagging Operation - - - - This operation removes the website configuration for a bucket. Amazon S3 returns a - 200 OK response upon successfully deleting a website configuration on - the specified bucket. You will get a 200 OK response if the website configuration - you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE operation requires the S3:DeleteBucketWebsite permission. - By default, only the bucket owner can delete the website configuration attached to - a bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which you want to remove the website configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketWebsite service method, as returned by S3. - REST API Reference for DeleteBucketWebsite Operation - - - - This operation removes the website configuration for a bucket. Amazon S3 returns a - 200 OK response upon successfully deleting a website configuration on - the specified bucket. You will get a 200 OK response if the website configuration - you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE operation requires the S3:DeleteBucketWebsite permission. - By default, only the bucket owner can delete the website configuration attached to - a bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the DeleteBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketWebsite service method, as returned by S3. - REST API Reference for DeleteBucketWebsite Operation - - - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - The bucket name of the lifecycle to delete. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - REST API Reference for DeleteLifecycleConfiguration Operation - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - Container for the necessary parameters to execute the DeleteLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - REST API Reference for DeleteLifecycleConfiguration Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key name of the object to delete. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key name of the object to delete. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - Container for the necessary parameters to execute the DeleteObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - This operation enables you to delete multiple objects from a bucket using a single - HTTP request. If you know the object keys that you want to delete, then this operation - provides a suitable alternative to sending individual delete requests, reducing per-request - overhead. - - - - The request contains a list of up to 1000 keys that you want to delete. In the XML, - you provide the object key names, and optionally, version IDs if you want to delete - a specific version of the object from a versioning-enabled bucket. For each key, Amazon - S3 performs a delete operation and returns the result of that delete, success, or - failure, in the response. Note that if the object specified in the request is not - found, Amazon S3 returns the result as deleted. - - - - The operation supports two modes for the response: verbose and quiet. By default, - the operation uses verbose mode in which the response includes the result of deletion - of each key in your request. In quiet mode the response includes only keys where the - delete operation encountered an error. For a successful deletion, the operation does - not return any information about the delete in the response body. - - - - When performing this operation on an MFA Delete enabled bucket, that attempts to delete - any versioned objects, you must include an MFA token. If you do not provide one, the - entire request will fail, even if there are non-versioned objects you are trying to - delete. If you provide an invalid token, whether there are versioned keys in the request - or not, the entire Multi-Object Delete request will fail. For information about MFA - Delete, see - MFA Delete. - - - - Finally, the Content-MD5 header is required for all Multi-Object Delete requests. - Amazon S3 uses the header value to ensure that your request body has not been altered - in transit. - - - - The following operations are related to DeleteObjects: - - - - Container for the necessary parameters to execute the DeleteObjects service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObjects service method, as returned by S3. - REST API Reference for DeleteObjects Operation - - - - Removes the entire tag set from the specified object. For more information about managing - object tags, see - Object Tagging. - - - - To use this operation, you must have permission to perform the s3:DeleteObjectTagging - action. - - - - To delete tags of a specific object version, add the versionId query - parameter in the request. You will need permission for the s3:DeleteObjectVersionTagging - action. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteObjectTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObjectTagging service method, as returned by S3. - REST API Reference for DeleteObjectTagging Operation - - - - Removes the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:PutBucketPublicAccessBlock - permission. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to DeletePublicAccessBlock: - - - - Container for the necessary parameters to execute the DeletePublicAccessBlock service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeletePublicAccessBlock service method, as returned by S3. - REST API Reference for DeletePublicAccessBlock Operation - - - - - - - - - Returns the default encryption configuration for an Amazon S3 bucket. For information - about the Amazon S3 default encryption feature, see Amazon - S3 Default Bucket Encryption. - - - - To use this operation, you must have permission to perform the s3:GetEncryptionConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to GetBucketEncryption: - - - - Container for the necessary parameters to execute the GetBucketEncryption service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketEncryption service method, as returned by S3. - REST API Reference for GetBucketEncryption Operation - - - - Returns an inventory configuration (identified by the inventory configuration ID) - from the bucket. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - The following operations are related to GetBucketInventoryConfiguration: - - - - Container for the necessary parameters to execute the GetBucketInventoryConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketInventoryConfiguration service method, as returned by S3. - REST API Reference for GetBucketInventoryConfiguration Operation - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - The name of the bucket for which to get the location. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLocation service method, as returned by S3. - REST API Reference for GetBucketLocation Operation - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - Container for the necessary parameters to execute the GetBucketLocation service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLocation service method, as returned by S3. - REST API Reference for GetBucketLocation Operation - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - The bucket name for which to get the logging information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLogging service method, as returned by S3. - REST API Reference for GetBucketLogging Operation - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - Container for the necessary parameters to execute the GetBucketLogging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLogging service method, as returned by S3. - REST API Reference for GetBucketLogging Operation - - - - Gets a metrics configuration (specified by the metrics configuration ID) from the - bucket. Note that this doesn't include the daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to GetBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the GetBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for GetBucketMetricsConfiguration Operation - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following operation is related to GetBucketNotification: - - - - Name of the bucket for which to get the notification configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketNotification service method, as returned by S3. - REST API Reference for GetBucketNotification Operation - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following operation is related to GetBucketNotification: - - - - Container for the necessary parameters to execute the GetBucketNotification service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketNotification service method, as returned by S3. - REST API Reference for GetBucketNotification Operation - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operation is related to GetBucketPolicy: - - - - The bucket name for which to get the bucket policy. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicy service method, as returned by S3. - REST API Reference for GetBucketPolicy Operation - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operation is related to GetBucketPolicy: - - - - Container for the necessary parameters to execute the GetBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicy service method, as returned by S3. - REST API Reference for GetBucketPolicy Operation - - - - Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket - is public. In order to use this operation, you must have the s3:GetBucketPolicyStatus - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - For more information about when Amazon S3 considers a bucket public, see The - Meaning of "Public". - - - - The following operations are related to GetBucketPolicyStatus: - - - - Container for the necessary parameters to execute the GetBucketPolicyStatus service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicyStatus service method, as returned by S3. - REST API Reference for GetBucketPolicyStatus Operation - - - - Retrieves the replication configuration for the given Amazon S3 bucket. - - Container for the necessary parameters to execute the GetBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketReplication service method, as returned by S3. - REST API Reference for GetBucketReplication Operation - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - The name of the bucket for which to get the payment request configuration - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketRequestPayment service method, as returned by S3. - REST API Reference for GetBucketRequestPayment Operation - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - Container for the necessary parameters to execute the GetBucketRequestPayment service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketRequestPayment service method, as returned by S3. - REST API Reference for GetBucketRequestPayment Operation - - - - Returns the tag set associated with the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - GetBucketTagging has the following special error: - -
  • - - Error code: NoSuchTagSetError - -
    • - - Description: There is no tag set associated with the bucket. - -
- - The following operations are related to GetBucketTagging: - - - - Container for the necessary parameters to execute the GetBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketTagging service method, as returned by S3. - REST API Reference for GetBucketTagging Operation - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - The name of the bucket for which to get the versioning information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketVersioning service method, as returned by S3. - REST API Reference for GetBucketVersioning Operation - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - Container for the necessary parameters to execute the GetBucketVersioning service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketVersioning service method, as returned by S3. - REST API Reference for GetBucketVersioning Operation - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET operation requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which to get the website configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketWebsite service method, as returned by S3. - REST API Reference for GetBucketWebsite Operation - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET operation requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the GetBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketWebsite service method, as returned by S3. - REST API Reference for GetBucketWebsite Operation - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - The bucket name for which to get the cors configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetCORSConfiguration service method, as returned by S3. - REST API Reference for GetCORSConfiguration Operation - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - Container for the necessary parameters to execute the GetCORSConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetCORSConfiguration service method, as returned by S3. - REST API Reference for GetCORSConfiguration Operation - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are still using previous version of the lifecycle configuration, it works. - For the earlier API description, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to GetBucketLifecycleConfiguration: - - - - The name of the bucket for which to get the lifecycle information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetLifecycleConfiguration service method, as returned by S3. - REST API Reference for GetLifecycleConfiguration Operation - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are still using previous version of the lifecycle configuration, it works. - For the earlier API description, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to GetBucketLifecycleConfiguration: - - - - Container for the necessary parameters to execute the GetLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetLifecycleConfiguration service method, as returned by S3. - REST API Reference for GetLifecycleConfiguration Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object to get. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object to get. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - Container for the necessary parameters to execute the GetObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Gets an object's current Legal Hold status. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLegalHold service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectLegalHold service method, as returned by S3. - REST API Reference for GetObjectLegalHold Operation - - - - Gets the Object Lock configuration for a bucket. The rule specified in the Object - Lock configuration will be applied by default to every new object placed in the specified - bucket. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLockConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectLockConfiguration service method, as returned by S3. - REST API Reference for GetObjectLockConfiguration Operation - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - The name of the bucket containing the object. - The object key. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - The name of the bucket containing the object. - The object key. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - Container for the necessary parameters to execute the GetObjectMetadata service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - Retrieves an object's retention settings. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectRetention service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectRetention service method, as returned by S3. - REST API Reference for GetObjectRetention Operation - - - - Returns the tag-set of an object. You send the GET request against the tagging subresource - associated with the object. - - - - To use this operation, you must have permission to perform the s3:GetObjectTagging - action. By default, the GET operation returns information about current version of - an object. For a versioned bucket, you can have multiple versions of an object in - your bucket. To retrieve tags of any other version, use the versionId query parameter. - You also need permission for the s3:GetObjectVersionTagging action. - - - - By default, the bucket owner has this permission and can grant this permission to - others. - - - - For information about the Amazon S3 object tagging feature, see Object - Tagging. - - - - The following operation is related to GetObjectTagging: - - - - Container for the necessary parameters to execute the GetObjectTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTagging service method, as returned by S3. - REST API Reference for GetObjectTagging Operation - - - - Return torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Amazon - S3 Torrent. - - - - You can get torrent only for objects that are less than 5 GB in size and that are - not encrypted using server-side encryption with customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - The following operation is related to GetObjectTorrent: - - - - The name of the bucket containing the object for which to get the torrent files. - The object key for which to get the information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTorrent service method, as returned by S3. - REST API Reference for GetObjectTorrent Operation - - - - Return torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Amazon - S3 Torrent. - - - - You can get torrent only for objects that are less than 5 GB in size and that are - not encrypted using server-side encryption with customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - The following operation is related to GetObjectTorrent: - - - - Container for the necessary parameters to execute the GetObjectTorrent service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTorrent service method, as returned by S3. - REST API Reference for GetObjectTorrent Operation - - - - Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:GetBucketPublicAccessBlock - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket - or an object, it checks the PublicAccessBlock configuration for both - the bucket (or the bucket that contains the object) and the bucket owner's account. - If the PublicAccessBlock settings are different between the bucket and - the account, Amazon S3 uses the most restrictive combination of the bucket-level and - account-level settings. - - - - For more information about when Amazon S3 considers a bucket or an object public, - see The - Meaning of "Public". - - - - The following operations are related to GetPublicAccessBlock: - - - - Container for the necessary parameters to execute the GetPublicAccessBlock service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetPublicAccessBlock service method, as returned by S3. - REST API Reference for GetPublicAccessBlock Operation - - - - This operation is useful to determine if a bucket exists and you have permission to - access it. The operation returns a 200 OK if the bucket exists and you - have permission to access it. Otherwise, the operation might return responses such - as 404 Not Found and 403 Forbidden. - - - - To use this operation, you must have permissions to perform the s3:ListBucket - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - Container for the necessary parameters to execute the HeadBucket service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the HeadBucket service method, as returned by S3. - REST API Reference for HeadBucket Operation - - - - This operation initiates a multipart upload and returns an upload ID. This upload - ID is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort operation - and Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload API and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart) and UploadPartCopy) requests must match the headers you - used in the request to initiate the upload by using CreateMultipartUpload. - - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, - kms:GenerateDataKey*, and kms:DescribeKey actions on the - key. These permissions are required because Amazon S3 must decrypt and read data from - the encrypted file parts before it completes the multipart upload. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - The following operations are related to CreateMultipartUpload: - - - - The name of the bucket to which to initiate the upload - Object key for which the multipart upload is to be initiated. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the InitiateMultipartUpload service method, as returned by S3. - REST API Reference for InitiateMultipartUpload Operation - - - - This operation initiates a multipart upload and returns an upload ID. This upload - ID is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort operation - and Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload API and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart) and UploadPartCopy) requests must match the headers you - used in the request to initiate the upload by using CreateMultipartUpload. - - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, - kms:GenerateDataKey*, and kms:DescribeKey actions on the - key. These permissions are required because Amazon S3 must decrypt and read data from - the encrypted file parts before it completes the multipart upload. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - The following operations are related to CreateMultipartUpload: - - - - Container for the necessary parameters to execute the InitiateMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the InitiateMultipartUpload service method, as returned by S3. - REST API Reference for InitiateMultipartUpload Operation - - - - Lists the analytics configurations for the bucket. You can have up to 1,000 analytics - configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. You should always check the IsTruncated element in the response. - If there are no more configurations to list, IsTruncated is set to false. - If there are more configurations to list, IsTruncated is set to true, - and there will be a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to ListBucketAnalyticsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketAnalyticsConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketAnalyticsConfigurations service method, as returned by S3. - REST API Reference for ListBucketAnalyticsConfigurations Operation - - - - Returns a list of inventory configurations for the bucket. You can have up to 1,000 - analytics configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory - - - - The following operations are related to ListBucketInventoryConfigurations: - - - - Container for the necessary parameters to execute the ListBucketInventoryConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketInventoryConfigurations service method, as returned by S3. - REST API Reference for ListBucketInventoryConfigurations Operation - - - - Lists the metrics configurations for the bucket. The metrics configurations are only - for the request metrics of the bucket and do not provide information on daily storage - metrics. You can have up to 1,000 configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For more information about metrics configurations and CloudWatch request metrics, - see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to ListBucketMetricsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketMetricsConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketMetricsConfigurations service method, as returned by S3. - REST API Reference for ListBucketMetricsConfigurations Operation - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBuckets service method, as returned by S3. - REST API Reference for ListBuckets Operation - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - Container for the necessary parameters to execute the ListBuckets service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBuckets service method, as returned by S3. - REST API Reference for ListBuckets Operation - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Container for the necessary parameters to execute the ListMultipartUploads service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. - Limits the response to keys that begin with the specified prefix. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - Container for the necessary parameters to execute the ListObjects service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Make sure to design - your application to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - To use this operation in an AWS Identity and Access Management (IAM) policy, you must - have permissions to perform the s3:ListBucket action. The bucket owner - has this permission by default and can grant this permission to others. For more information - about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - This section describes the latest revision of the API. We recommend that you use this - revised API for application development. For backward compatibility, Amazon S3 continues - to support the prior version of this API, ListObjects. - - - - To get a list of your buckets, see ListBuckets. - - - - The following operations are related to ListObjectsV2: - - - - Container for the necessary parameters to execute the ListObjectsV2 service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjectsV2 service method, as returned by S3. - REST API Reference for ListObjectsV2 Operation - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). This request returns a maximum of 1,000 - uploaded parts. The default number of parts returned is 1,000 parts. You can restrict - the number of parts returned by specifying the max-parts request parameter. - If your multipart upload consists of more than 1,000 parts, the response returns an - IsTruncated field with the value of true, and a NextPartNumberMarker - element. In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListParts: - - - - Name of the bucket to which the parts are being uploaded. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Object key for which the multipart upload was initiated. - Upload ID identifying the multipart upload whose parts are being listed. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListParts service method, as returned by S3. - REST API Reference for ListParts Operation - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). This request returns a maximum of 1,000 - uploaded parts. The default number of parts returned is 1,000 parts. You can restrict - the number of parts returned by specifying the max-parts request parameter. - If your multipart upload consists of more than 1,000 parts, the response returns an - IsTruncated field with the value of true, and a NextPartNumberMarker - element. In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListParts: - - - - Container for the necessary parameters to execute the ListParts service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListParts service method, as returned by S3. - REST API Reference for ListParts Operation - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - Container for the necessary parameters to execute the ListVersions service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - - Creates a new bucket. To create a bucket, you must register with Amazon S3 and have - a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed - to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information on bucket naming restrictions, - see Working - with Amazon S3 Buckets. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) - Region. For more information, see How - to Select a Region for Your Buckets. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - Hosting of Buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - The name of the bucket to create. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucket service method, as returned by S3. - REST API Reference for PutBucket Operation - - - - Creates a new bucket. To create a bucket, you must register with Amazon S3 and have - a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed - to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information on bucket naming restrictions, - see Working - with Amazon S3 Buckets. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) - Region. For more information, see How - to Select a Region for Your Buckets. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - Hosting of Buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - Container for the necessary parameters to execute the PutBucket service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucket service method, as returned by S3. - REST API Reference for PutBucket Operation - - - - Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration - is a bucket-level feature that enables you to perform faster data transfers to Amazon - S3. - - - - To use this operation, you must have permission to perform the s3:PutAccelerateConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The Transfer Acceleration state of a bucket can be set to one of the following two - values: - -
  • - - Enabled – Enables accelerated data transfers to the bucket. - -
  • - - Suspended – Disables accelerated data transfers to the bucket. - -
- - The GetBucketAccelerateConfiguration operation returns the transfer acceleration - state of a bucket. - - - - After setting the Transfer Acceleration state of a bucket to Enabled, it might take - up to thirty minutes before the data transfer rates to the bucket increase. - - - - The name of the bucket used for Transfer Acceleration must be DNS-compliant and must - not contain periods ("."). - - - - For more information about transfer acceleration, see Transfer - Acceleration. - - - - The following operations are related to PutBucketAccelerateConfiguration: - - - - Container for the necessary parameters to execute the PutBucketAccelerateConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketAccelerateConfiguration service method, as returned by S3. - REST API Reference for PutBucketAccelerateConfiguration Operation - - - - - - - Set the logging parameters for a bucket and to specify permissions for who can view - and modify the logging parameters. All logs are saved to buckets in the same AWS Region - as the source bucket. To set the logging status of a bucket, you must be the bucket - owner. - - - - The bucket owner is automatically granted FULL_CONTROL to all logs. You use the Grantee - request element to grant access to other people. The Permissions request - element specifies the kind of access the grantee has to the logs. - - - - Grantee Values - - - - You can specify the person (grantee) to whom you're assigning access rights (using - request elements) in the following ways: - -
  • - - By the person's ID: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> - </Grantee> - - - - DisplayName is optional and ignored in the request. - -
  • - - By Email address: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee> - - - - - The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl - request, appears as the CanonicalUser. - -
  • - - By URI: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee> - - -
- - To enable logging, you use LoggingEnabled and its children request elements. To disable - logging, you use an empty BucketLoggingStatus request element: - - - - <BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01" /> - - - - - For more information about server access logging, see Server - Access Logging. - - - - For more information about creating a bucket, see CreateBucket. For more information - about returning the logging status of a bucket, see GetBucketLogging. - - - - The following operations are related to PutBucketLogging: - - - - Container for the necessary parameters to execute the PutBucketLogging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketLogging service method, as returned by S3. - REST API Reference for PutBucketLogging Operation - - - - Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. - You can have up to 1,000 metrics configurations per bucket. If you're updating an - existing metrics configuration, note that this is a full replacement of the existing - metrics configuration. If you don't include the elements you want to keep, they are - erased. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to PutBucketMetricsConfiguration: - - - - GetBucketLifecycle has the following special error: - -
  • - - Error code: TooManyConfigurations - -
    • - - Description: You are attempting to create a new configuration but have already reached - the 1,000-configuration limit. - -
    • - - HTTP Status Code: HTTP 400 Bad Request - -
- - Container for the necessary parameters to execute the PutBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for PutBucketMetricsConfiguration Operation - - - - Enables notifications of specified events for a bucket. For more information about - event notifications, see Configuring - Event Notifications. - - - - Using this API, you can replace an existing notification configuration. The configuration - is an XML file that defines the event types that you want Amazon S3 to publish and - the destination where you want Amazon S3 to publish an event notification when it - detects an event of the specified type. - - - - By default, your bucket has no event notifications configured. That is, the notification - configuration will be an empty NotificationConfiguration. - - - - <NotificationConfiguration> - - - - </NotificationConfiguration> - - - - This operation replaces the existing notification configuration with the configuration - you include in the request body. - - - - After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification - Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, - and that the bucket owner has permission to publish to it by sending a test notification. - In the case of AWS Lambda destinations, Amazon S3 verifies that the Lambda function - permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. - For more information, see Configuring - Notifications for Amazon S3 Events. - - - - You can disable notifications by adding the empty NotificationConfiguration element. - - - - By default, only the bucket owner can configure notifications on a bucket. However, - bucket owners can use a bucket policy to grant permission to other users to set this - configuration with s3:PutBucketNotification permission. - - - - The PUT notification is an atomic operation. For example, suppose your notification - configuration includes SNS topic, SQS queue, and Lambda function configurations. When - you send a PUT request with this configuration, Amazon S3 sends test messages to your - SNS topic. If the message fails, the entire PUT operation will fail, and Amazon S3 - will not add the configuration to your bucket. - - - - Responses - - - - If the configuration in the request body includes only one TopicConfiguration - specifying only the s3:ReducedRedundancyLostObject event type, the response - will also include the x-amz-sns-test-message-id header containing the - message ID of the test notification sent to the topic. - - - - The following operation is related to PutBucketNotificationConfiguration: - - - - Container for the necessary parameters to execute the PutBucketNotification service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketNotification service method, as returned by S3. - REST API Reference for PutBucketNotification Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - The MD5 hash of the request body. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - Container for the necessary parameters to execute the PutBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Creates a replication configuration or replaces an existing one. For more information, - see Replication - in the Amazon S3 Developer Guide. - - - - To perform this operation, the user or role performing the operation must have the - iam:PassRole - permission. - - - - Specify the replication configuration in the request body. In the replication configuration, - you provide the name of the destination bucket where you want Amazon S3 to replicate - objects, the IAM role that Amazon S3 can assume to replicate objects on your behalf, - and other relevant information. - - - - A replication configuration must include at least one rule, and can contain a maximum - of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects - in the source bucket. To choose additional subsets of objects to replicate, add a - rule for each subset. All rules must specify the same destination bucket. - - - - To specify a subset of the objects in the source bucket to apply a replication rule - to, add the Filter element as a child of the Rule element. You can filter objects - based on an object key prefix, one or more object tags, or both. When you add the - Filter element in the configuration, you must also add the following elements: DeleteMarkerReplication, - Status, and Priority. - - - - For information about enabling versioning on a bucket, see Using - Versioning. - - - - By default, a resource owner, in this case the AWS account that created the bucket, - can perform this operation. The resource owner can also grant others permissions to - perform the operation. For more information about permissions, see Specifying - Permissions in a Policy and Managing - Access Permissions to Your Amazon S3 Resources. - - - - Handling Replication of Encrypted Objects - - - - By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side - encryption with CMKs stored in AWS KMS. To replicate AWS KMS-encrypted objects, add - the following: SourceSelectionCriteria, SseKmsEncryptedObjects, - Status, EncryptionConfiguration, and ReplicaKmsKeyID. - For information about replication configuration, see Replicating - Objects Created with SSE Using CMKs stored in AWS KMS. - - - - For information on PutBucketReplication errors, see ReplicationErrorCodeList - - - - - The following operations are related to PutBucketReplication: - - - - Container for the necessary parameters to execute the PutBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketReplication service method, as returned by S3. - REST API Reference for PutBucketReplication Operation - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - The bucket name. - Container for Payer. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketRequestPayment service method, as returned by S3. - REST API Reference for PutBucketRequestPayment Operation - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - Container for the necessary parameters to execute the PutBucketRequestPayment service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketRequestPayment service method, as returned by S3. - REST API Reference for PutBucketRequestPayment Operation - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging. - - - - Within a bucket, if you add a tag that has the same key as an existing tag, the new - value overwrites the old value. For more information, see Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional operation is currently in progress against - this resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - The bucket name. - A property of PutBucketTaggingRequest used to execute the PutBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketTagging service method, as returned by S3. - REST API Reference for PutBucketTagging Operation - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging. - - - - Within a bucket, if you add a tag that has the same key as an existing tag, the new - value overwrites the old value. For more information, see Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional operation is currently in progress against - this resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - Container for the necessary parameters to execute the PutBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketTagging service method, as returned by S3. - REST API Reference for PutBucketTagging Operation - - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT operation requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - Amazon S3 has a limitation of 50 routing rules per website configuration. If you require - more than 50 routing rules, you can use object redirect. For more information, see - Configuring - an Object Redirect in the Amazon Simple Storage Service Developer Guide. - - - The bucket name. - Container for the request. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketWebsite service method, as returned by S3. - REST API Reference for PutBucketWebsite Operation - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT operation requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - Amazon S3 has a limitation of 50 routing rules per website configuration. If you require - more than 50 routing rules, you can use object redirect. For more information, see - Configuring - an Object Redirect in the Amazon Simple Storage Service Developer Guide. - - - Container for the necessary parameters to execute the PutBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketWebsite service method, as returned by S3. - REST API Reference for PutBucketWebsite Operation - - - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - The name of the bucket for which to set the configuration. - A property of PutLifecycleConfigurationRequest used to execute the PutLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutLifecycleConfiguration service method, as returned by S3. - REST API Reference for PutLifecycleConfiguration Operation - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - Container for the necessary parameters to execute the PutLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutLifecycleConfiguration service method, as returned by S3. - REST API Reference for PutLifecycleConfiguration Operation - - - - - - - - - - - - - - - - - Configuration for accessing AmazonS3 service - - - Configuration for accessing Amazon S3 service - - - - - When true, requests will always use path style addressing. - - - - - Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. - To use this feature, the bucket name should be DNS compliant names and should not contain periods (.). - The following APIs are not supported and are sent to the regular region endpoint, even if this option is enabled: -
    -
  1. PutBucket
    2. -
  2. ListBuckets
    3. -
  3. DeleteBucket
    4. -
- - - This option cannot be used at the same time as UseDualstackEndpoint. - - - - - If set to true and the service package supports it the region identified in the arn for a resource - will be used when making the service request. - - - - - USEast1RegionalEndpointValue determines wheter or not - to send the us-east-1 s3 requests to the regional endpoint or to - the legacy global endpoint. - This flags takes precedence over the AWS_S3_US_EAST_1_REGIONAL_ENDPOINT - environment variable and the credential file. - - - - - This method contains custom initializations for the config object. - - - - - Given this client configuration, returns the service url - - The service url in the form of a string - - - - If the client is configured to hit us-east-1 with the S3UsEast1RegionalEndpointValue flag not set, - this method checks whether the environment variable is present or the credential file contains a valid value - - A Nullable of S3UsEast1RegionalEndpointValue representing the client configuration for the regional us-east-1 endpoint - - - - Validate that the config object is properly configured. - - - - - Checks the AWS_S3_US_EAST_1_REGIONAL_ENDPOINT environment variable for the presence of the s3 regional flag - - A nullable of S3UsEast1RegionalEndpointValue - - - - Checks the credential file for the presence of the s3 regional flag - - A nullable of S3UsEast1RegionalEndpointValue - - - - Default constructor - - - - - The constant used to lookup in the region hash the endpoint. - - - - - Gets the ServiceVersion property. - - - - - Gets the value of UserAgent property. - - - - - Base exception for S3 errors. - - - - - Construct an instance of AmazonS3Exception - - - - - - Construct an instance of AmazonS3Exception - - - - - - - Construct an instance of AmazonS3Exception - - - - - - Construct an instance of AmazonS3Exception - - - - - - - - - - Construct an instance of AmazonS3Exception - - - - - - - - - - - Construct an instance of AmazonS3Exception - - - - - - - - - - - - Construct an instance of AmazonS3Exception - - - - - - - - - - - - - A special token that helps AWS troubleshoot problems. - - - - - A special token that helps AWS troubleshoot S3 accelerate problems. - - - - - The entire response body for this exception, if available. - - - - - The region that the AmazonS3Exception relates to. - - - - - Gets the exception message. - - - - - Extensions methods added to Amazon.Arn type to help parse S3 specific resources from the ARN. - - - - - Attempt to parse the resource component of the ARN into access point resource name. - - An AWS ARN to parse - The access point resouce identifier found in the ARN. - True if the ARN contains an access point resource identifier. - - - - Attempt to parse the resource component of the ARN into bucket name. - - An AWS ARN to parse - The bucket name found in the ARN. - True if the ARN contains a bucket name. - - - - The file format used when exporting data to Amazon S3. - - - - - CSV file format. - - - - - Construct instance of AnalyticsS3ExportFileFormat. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to an AnalyticsS3ExportFileFormat. - - - - - - - Represents the accelerate status for a bucket. - - - - - Bucket acceleration is enabled. - - - - - Bucket acceleration is suspended. - - - - - Construct instance of BucketAccelerateStatus. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to an BucketAccelerateStatus - - - - - - - The status of the delete marker replication. - - - - - Delete marker replication is enabled. - - - - - Delete marker replication is disabled. - - - - - Construct instance of DeleteMarkerReplicationStatus. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to a DeleteMarkerReplicationStatus - - - - - - - A list of all possible CannedACLs that can be used - for S3 Buckets or S3 Objects. For more information about CannedACLs, refer to - . - - - - - Owner gets FULL_CONTROL. - No one else has access rights (default). - - - - - Owner gets FULL_CONTROL. - No one else has access rights (default). - - - - - Owner gets FULL_CONTROL and the anonymous principal is granted READ access. - If this policy is used on an object, it can be read from a browser with no authentication. - - - - - Owner gets FULL_CONTROL, the anonymous principal is granted READ and WRITE access. - This can be a useful policy to apply to a bucket, but is generally not recommended. - - - - - Owner gets FULL_CONTROL, and any principal authenticated as a registered Amazon - S3 user is granted READ access. - - - - - Owner gets FULL_CONTROL. Amazon EC2 gets READ access to GET an - Amazon Machine Image (AMI) bundle from Amazon S3. - - - - - Object Owner gets FULL_CONTROL, Bucket Owner gets READ - This ACL applies only to objects and is equivalent to private when used with PUT Bucket. - You use this ACL to let someone other than the bucket owner write content (get full control) - in the bucket but still grant the bucket owner read access to the objects. - - - - - Object Owner gets FULL_CONTROL, Bucket Owner gets FULL_CONTROL. - This ACL applies only to objects and is equivalent to private when used with PUT Bucket. - You use this ACL to let someone other than the bucket owner write content (get full control) - in the bucket but still grant the bucket owner full rights over the objects. - - - - - The LogDelivery group gets WRITE and READ_ACP permissions on the bucket. - - - - - Construct instance of S3CannedACL. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to an S3CannedACL - - - - - - - A list of all possible S3 Bucket region possibilities. For - more information, refer to - . - - - - - Specifies that the S3 Bucket should use US locality. - This is the default value. - - - - - Specifies that the S3 Bucket should use US-EAST-2 locality. - - - - - Specifies that the S3 Bucket should use EU locality which defaults to EU-WEST-1 - - - - - Specifies that the S3 Bucket should use the EU-NORTH-1 locality. - - - - - Specifies that the S3 Bucket should use the EU-WEST-1 locality. - - - - - Specifies that the S3 Bucket should use the EU-WEST-2 locality. - - - - - Specifies that the S3 Bucket should use the EU-WEST-3 locality. - - - - - Specifies that the S3 Bucket should use the EU-CENTRAL-1 locality. - - - - - Specifies that the S3 Bucket should use US-WEST-1 locality. - - - - - Specifies that the S3 Bucket should use US-WEST-2 locality. - - - - - Specifies that the S3 Bucket should use US-GOV-EAST-1 locality. - - - - - Specifies that the S3 Bucket should use US-GOV-WEST-1 locality. - - - - - Specifies that the S3 Bucket should use the AP-EAST-1 locality. - - - - - Specifies that the S3 Bucket should use the AP-SOUTHEAST-1 locality. - - - - - Specifies that the S3 Bucket should use the AP-SOUTHEAST-2 locality. - - - - - Specifies that the S3 Bucket should use the AP-NORTHEAST-1 locality. - - - - - Specifies that the S3 Bucket should use the AP-NORTHEAST-2 locality. - - - - - Specifies that the S3 Bucket should use the AP-NORTHEAST-3 locality. - - - - - Specifies that the S3 Bucket should use the AP-SOUTH-1 locality. - - - - - Specifies that the S3 Bucket should use the SA-EAST-1 locality. - - - - - Specifies that the S3 Bucket should use CN-NORTH-1 locality. - - - - - Specifies that the S3 Bucket should use CN-NORTHWEST-1 locality. - - - - - Specifies that the S3 Bucket should use CA-CENTRAL-1 locality. - - - - - Specifies that the S3 Bucket should use US-WEST-1 locality. - - - - - Specifies that the S3 Bucket should use CN-NORTH-1 locality. - - - - - Specifies that the S3 Bucket should use US-GOV-WEST-1 locality. - - - - - Construct instance of S3Region. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to the S3Region class - - - - - - - A list of all ACL permissions. For more information, refer to - . - - - - - When applied to a bucket, grants permission to list the bucket. - When applied to an object, this grants permission to read the - object data and/or metadata. - - - - - When applied to a bucket, grants permission to create, overwrite, - and delete any object in the bucket. This permission is not - supported for objects. - - - - - Grants permission to read the ACL for the applicable bucket or object. - The owner of a bucket or object always has this permission implicitly. - - - - - Gives permission to overwrite the ACP for the applicable bucket or object. - The owner of a bucket or object always has this permission implicitly. - Granting this permission is equivalent to granting FULL_CONTROL because - the grant recipient can make any changes to the ACP. - - - - - Provides READ, WRITE, READ_ACP, and WRITE_ACP permissions. - It does not convey additional rights and is provided only for convenience. - - - - - Gives permission to restore an object that is currently stored in Amazon Glacier - for archival storage. - - - - - Construct S3Permission. - - - - - - Construct instance of S3Permission. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - - Gets and sets the HeaderName property. - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to an S3Permission - - - - - - - An enumeration of all Metadata directives that - can be used for the CopyObject operation. - - - - - Specifies that the metadata is copied from the source object. - - - - - Specifies that the metadata is replaced with metadata provided in the request. - All original metadata is replaced by the metadata you specify. - - - - - An enumeration of all protocols that the pre-signed - URL can be created against. - - - - - https protocol will be used in the pre-signed URL. - - - - - http protocol will be used in the pre-signed URL. - - - - - An enumeration of supported HTTP verbs - - - - - The GET HTTP verb. - - - - - The HEAD HTTP verb. - - - - - The PUT HTTP verb. - - - - - The DELETE HTTP verb. - - - - - S3 Storage Class Definitions - - - - - The STANDARD storage class, which is the default - storage class for S3. - - Durability 99.999999999%; Availability 99.99% over a given year. - - - - - REDUCED_REDUNDANCY provides the same availability as standard, but at a lower durability. - - Durability 99.99%; Availability 99.99% over a given year. - - - - - The GLACIER storage is for object that are stored in Amazon Glacier. - This storage class is for objects that are for archival purpose and - get operations are rare. - - Durability 99.999999999% - - - - - The STANDARD_IA storage is for infrequently accessed objects. - This storage class is for objects that are long-lived and less frequently accessed, - like backups and older data. - - Durability 99.999999999%; Availability 99.9% over a given year. - - - - - The ONEZONE_IA storage is for infrequently accessed objects. It is similiar to STANDARD_IA, but - only stores object data within one Availablity Zone in a given region. - - Durability 99.999999999%; Availability 99% over a given year. - - - - - IntelligentTiering makes it easy to lower your overall cost of storage by automatically placing data in the storage - class that best matches the access patterns for the storage. With IntelligentTiering, you don’t need to define - and manage individual policies for lifecycle data management or write code to transition objects - between storage classes. Instead, you can use IntelligentTiering to manage transitions between Standard and - S-IA without writing any application code. IntelligentTiering also manages transitions automatically to - Glacier for long term archive in addition to S3 storage classes. - - - - - S3 Glacier Deep Archive provides secure, durable object storage class for long term data archival. - It is the ideal storage class to make an archival, durable copy of data that rarely, if ever, needs to be accessed. - It can be used as an offline backup for their most important data assets and to meet long-term retention needs. - - - - - Construct an instance of S3StorageClass. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to S3StorageClass. - - - - - - - The constants for the known event names used by S3 notification. S3 might add new - events before the SDK is updated. In which case the names listed in the S3 documentation - will work as well as these constants. - - - - - An event that says an object has been lost in the reduced redundancy storage. - - - - - A list of all server-side encryption methods for customer provided encryption keys. - - - - - No server side encryption to be used. - - - - - Use AES 256 server side encryption. - - - - - Constructs an instance of ServerSideEncryptionCustomerMethod. - - - - - - Finds the constant for the unique value. - - - - - - - Converts string to ServerSideEncryptionCustomerMethod. - - - - - - - A list of all server-side encryption methods. - - - - - No server side encryption to be used. - - - - - Use AES 256 server side encryption. - - - - - Use AWS Key Management Service for server side encryption. - - - - - Construct instance of ServerSideEncryptionMethod. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to ServerSideEncryptionCustomerMethod. - - - - - - - A list of all grantee types. - - - - - The predefined group. - - - - - The email address of an AWS account - - - - - The canonical user ID of an AWS account - - - - - Construct an instance of GranteeType. - - - - - - Finds the constant for the unique value. - - - - - - - Convert a string to GranteeType. - - - - - - - A list of all lifecycle statuses. - - - - - The rule is enabled. - - - - - The rule is disabled. - - - - - Constructs an instance LifecycleRuleStatus. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to LifecycleRuleStatus. - - - - - - - A list of all version statuses. - - - - - The rule is off. - - - - - The rule is suspended. - - - - - The rule is enabled. - - - - - Construct an instance of VersionStatus. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to VersionStatus. - - - - - - - A list of all encoding types. - - - - - Url encoding. - - - - - Constructs intance of EncodingType - - - - - - Finds the constant for the unique value. - - - - - - - Converts string to EncodingType - - - - - - - The bucket event for which to send notifications. - - - - - The event encapsulates all the object create events - - - - - Event for put operations - - - - - Event for post operations - - - - - Event for copy operations - - - - - Event for completing a multi part upload - - - - - This event encapsulates all the object removed events - - - - - Event for object removed, delete operation. - - - - - Event for object removed, delete marker created operation. - - - - - Event for objects stored in reduced redundancy and S3 detects the object is lost - - - - - Event for all object restore - - - - - Event for restore post operations. - - - - - Event for when object restore is completed. - - - - - Event for replication of all - - - - - Event for operation failed replication - - - - - Evemt for replication operation not tracked - - - - - Event for replication operation missed threshold - - - - - Event for operation replicated after threshold - - - - - Constructs instance of EventType. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to EventType. - - - - - - - Compares if the ConstantClass instances are equals. - - - - - - - Compares if the ConstantClass instances are equals. This is ovewritten to handle the - discrepancy with S3 events coming from Lambda that don't have the prefix "s3:". - - - - - - - A list of all Inventory Formats. - - - - - CSV inventory format - - - - - ORC inventory format - - - - - Parquet inventory format - - - - - Construct instance of InventoryFormat. - - - - - - Finds the constant for the unique value. - - The string representation of the InventoryFormat. - The InventoryFormat object for that string. - - - - Convert string to InventoryFormat. - - - - - - - A list of inventory included object versions. - - - - - All Inventory Included Object Versions - - - - - Current Inventory Included Object Versions - - - - - Construct instance of InventoryIncludedObjectVersions. - - - - - - Finds the constant for the unique value. - - The string representation of the InventoryIncludedObjectVersions. - The InventoryIncludedObjectVersions object for that string. - - - - Convert string to InventoryIncludedObjectVersions. - - - - - - - A list of inventory frequencies. - - - - - Daily Inventory Frequency - - - - - Weekly Inventory Frequency - - - - - Construct instance of InventoryFrequency. - - - - - - Finds the constant for the unique value. - - The string representation of the InventoryFrequency. - The InventoryFrequency object for that string. - - - - Convert string to InventoryFrequency. - - - - - - - A list of inventory optional fields. - - - - - InventoryOptionalField for Size - - - - - InventoryOptionalField for LastModifiedDate - - - - - InventoryOptionalField for StorageClass - - - - - InventoryOptionalField for ETag - - - - - InventoryOptionalField for IsMultipartUploaded - - - - - InventoryOptionalField for ReplicationStatus - - - - - InventoryOptionalField for EncryptionStatus - - - - - InventoryOptionalField for ObjectLockRetainUntilDate - - - - - InventoryOptionalField for ObjectLockMode - - - - - InventoryOptionalField for ObjectLockLegalHoldStatus - - - - - InventoryOptionalField for IntelligentTieringAccessTier - - - - - Construct instance of InventoryOptionalField. - - - - - - Finds the constant for the unique value. - - The string representation of the InventoryOptionalField. - The InventoryIncludedObjectVersions object for that string. - - - - Convert string to InventoryOptionalField. - - - - - - - The status of the replication job associated with this source object. - - - - - The object is pending replication. - - - - - The object has been replicated. - - - - - The object was created as a result of replication. - - - - - The object replication has failed due to a customer-attributable reason, and the replication will not be attempted again. - - - - - Construct instance of ReplicationStatus. - - - - - - Finds the constant for the unique value. - - The string representation of the ReplicationStatus. - The ReplicationStatus object for that string. - - - - Convert string to ReplicationStatus. - - - - - - - Whether a replication rule is applied or ignored. - - - - - The rule will be applied. - - - - - The rule will be ignored. - - - - - Construct instance of ReplicationRuleStatus - - - - - - Finds the constant for the unique value. - - The string representation of the ReplicationRuleStatus. - The ReplicationRuleStatus object for that string. - - - - Convert string to ReplicationRuleStatus. - - - - - - - Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request. - - - - - The object tag-set is copied from the source object. - - - - - The object tag-set is replaced with tag-set provided in the request. - - - - - Construct instance of TaggingDirective - - - - - Finds the constant for the unique value. - - The string representation of the TaggingDirective. - The TaggingDirective object for that string. - - - - Convert string to TaggingDirective. - - - - - All enumerations type for retrieval tier for Glacier restore. - - - - - Standard Tier for Glacier restore. - - - - - Bulk Tier for Glacier restore. - - - - - Expedited Tier for Glacier restore. - - - - - Construct instance of RestoreObjectRequestGlacierJobTier - - - - - - Finds the constant for the unique value. - - The string representation of the RestoreObjectRequestGlacierJobTier. - The RestoreObjectRequestGlacierJobTier object for that string. - - - - Convert string to RestoreObjectRequestGlacierJobTier. - - - - - - - The version of the output schema to use when exporting data. - - - - - The schema output version V_1. - - - - - Construct instance of StorageClassAnalysisSchemaVersion - - - - - - Finds the constant for the unique value. - - The string representation of the StorageClassAnalysisSchemaVersion. - The StorageClassAnalysisSchemaVersion object for that string. - - - - Convert string to StorageClassAnalysisSchemaVersion. - - - - - - - Acknowledges that requester pays for the operation. - - - - - Requester pays for the operation. - - - - - Finds the RequestPayer instance for the string value. - - - - - Converts string to RequestPayer instance - - - - - The response from S3 that it confirms that requester pays. - - - - - S3 acknowledges that the requester pays. - - - - - Finds the RequestCharged instance for the string value - - - - - converts the string to RequestCharged instance - - - - - The override value for the owner of the replica object. - - - - - Overrides destination bucket's owner. - - - - - Finds the OwnerOverride instance for the string value - - - - - converts the string to OwnerOverride instance - - - - - The replication for KMS encrypted S3 objects is disabled if status is not Enabled. - - - - - The replication for KMS encrypted S3 objects is enabled. - - - - - The replication for KMS encrypted S3 objects is disabled. - - - - - - - - - - Finds the SseKmsEncryptedObjectsStatus instance for the string value - - - - - Converts the string to SseKmsEncryptedObjectsStatus instance - - - - - Specify how headers will be handled. - - - - - Headers will be usable in SELECT clause. - - - - - Headers will be skipped - - - - - No header is present. - - - - - Finds the FileHeaderInfo instance for the string value - - - - - - - Converts the string to FileHeaderInfo instance - - - - - Specifies whether existing object replication is enabled. - - - - - Enable the replication of existing objects - - - - - Disable the replication of existing objects - - - - - Finds the ExistingObjectReplicationStatus instance for the string value - - - - - - - Converts the string to ExistingObjectReplicationStatus instance - - - - - Describes when fields in output should be surrounded with quotes. - - - - - Specifies that fields in output should always be surrounded in quotes. - - - - - Specifies that fields in output should be surrounded in quotes as necessary. - - - - - Finds the QuoteFields instance for the string value - - string value that maps to QuoteFields enum - QuoteFields enum - - - - Converts the string to QuoteFields instance - - - - - Type of the expression provided in the Expression member. - - - - - SQL expression - - - - - Finds the ExpressionType instance for the string value - - string value that maps to ExpressionType enum - ExpressionType enum - - - - Converts the string to ExpressionType instance - - - - - Indicates what type of job is being initiated. - - - - - Finds the RestoreRequestType instance for the string value - - - - - Converts the string to RestoreRequestType instance - - - - - The type of JSON. - - - - - Finds the JsonType instance for the string value - - - - - Converts the string to JsonType instance - - - - - Specifies object's compression format. - - - - - Finds the CompressionType instance for the string value - - - - - Converts the string to CompressionType instance - - - - - The type of ObjectLockEnabled - - - - - Finds the ObjectLockEnabled instance for the string value - - - - - Converts the string to ObjectLockEnabled instance - - - - - The type of ObjectLockLegalHoldStatus - - - - - Finds the ObjectLockLegalHoldStatus instance for the string value - - - - - Converts the string to ObjectLockLegalHoldStatus instance - - - - - The type of ObjectLockRetentionMode - - - - - Finds the ObjectLockRetentionMode instance for the string value - - - - - Converts the string to ObjectLockRetentionMode instance - - - - - The type of ObjectLockMode - - - - - Finds the ObjectLockMode instance for the string value - - - - - Converts the string to ObjectLockMode instance - - - - - Specifies whether the replication time is enabled. - - - - - Replication time is enabled. - - - - - Replication time is disabled. - - - - - Finds the ReplicationTimeStatus instance for the string value - - - - - - - Converts the string to ReplicationTimeStatus instance - - - - - - Specifies whether the replication metrics are enabled. - - - - - Replication metrics are enabled. - - - - - Replication metrics are disabled. - - - - - Finds the MetricsStatus instance for the string value - - - - - - - Converts the string to MetricsStatus instance - - - - - - Custom pipeline handler to clean up streams in case of an exception. - - - - - Catch exceptions and clean up any open streams. - - - - - - Catch exceptions and clean up any open streams. - - - - - - - Custom pipeline handler to enable sig V4 for Get requests. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Custom pipeline handler to enable sig V4 for Get requests. - - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Calls the post invoke logic after calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls the and post invoke logic after calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Constructor for AmazonS3RetryPolicy. - - The IClientConfig object - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - - - a value if it can be determined, or null if the IO-bound calculations need to be done - - - - Return true if the request should be retried. Implements additional checks - specific to S3 on top of the checks in DefaultRetryPolicy. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Constructor for AmazonS3StandardRetryPolicy. - - The IClientConfig object - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - - - a value if it can be determined, or null if the IO-bound calculations need to be done - - - - Return true if the request should be retried. Implements additional checks - specific to S3 on top of the checks in StandardRetryPolicy. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Constructor for AmazonS3AdaptiveRetryPolicy. - - The IClientConfig object - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - - - a value if it can be determined, or null if the IO-bound calculations need to be done - - - - Return true if the request should be retried. Implements additional checks - specific to S3 on top of the checks in AdaptiveRetryPolicy. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Marker interface to identify AmazonS3EncryptionClient. - - - - - Service metadata for Amazon S3 service - - - - - Gets the value of the Service Id. - - - - - Gets the dictionary that gives mapping of renamed operations - - - - - The parameters to request an abort of a multipart upload. - - - After a multipart upload is aborted, no additional parts can be uploaded using that upload ID. - The storage consumed by any previously uploaded parts will be freed. However, if any part uploads - are currently in progress, those part uploads might or might not succeed. As a result, it might be - necessary to abort a given multipart upload multiple times in order to completely free all storage - consumed by all parts. - - - - - The bucket name to which the upload was taking place. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The key of the S3 object that was being uploaded. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - The upload id for the in-progress multipart upload that should be aborted. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the AbortMultipartUpload response metadata. - The AbortMultipartUpload operation has a void result type. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Bucket accelerate configuration. - - - - - The accelerate status of the bucket. - - - - - AccessControlTranslation class - - - - - The override value for the owner of the replica object. - - - - - Class for AnalyticsAndOperator - A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. - The operator must have at least two predicates, and an object must match all of the predicates - in order for the filter to apply. - - Note: The current implementation restricts the usage to atmost one AnalyticsPrefixPredicate - and any number of AnalyticsTagPredicates. - - - - Class for AnalyticsConfiguration - - - - - The identifier used to represent an analytics configuration. - - - - - The filter used to describe a set of objects for analyses. - A filter must have exactly one prefix, one tag, or one conjunction (AnalyticsAndOperator). - If no filter is provided, all objects will be considered in any analysis. - - - - - If present, it indicates that data related to access patterns will be collected - and made available to analyze the tradeoffs between different storage classes. - - - - - Class for AnalyticsExportDestination - - - - - A destination signifying output to an S3 bucket. - - - - - Filter class for Metrics. - - - - - Filter Predicate setup for specific filter types. - - - - - Filter Predicate abstract class for specific filter types to be derived from. - - - - - Abstract class that can be used over logical filter predicates,i.e. AND/OR. - - - - - Internal implementation of Metrics Predicate visitor interface. - - - - - Interface for implementing visitor pattern in Analytics Predicate Filter. - - - - - Interface for implementing visitor pattern in Inventory Predicate Filter. - - - - - Interface for implementing visitor pattern in Metrics Predicate Filter. - - - - - Internal implementation of Inventory Predicate visitor interface. - - - - - Internal implementation of Metrics Predicate visitor interface. - - - - - Defines the interface that is used to visit all the different - implementations of - - - - - Visit a - - - - - - Visit a - - - - - - Visit a - - - - - - Implementation of to marshall . - - - - - AbortIncompleteMultipartUpload Unmarshaller - - - - - Abort Multipart Upload Request Marshaller - - - - - Response Unmarshaller for AbortMultipartUpload operation - - - - - AnalyticsConfiguration Unmarshaller - - - - - AnalyticsExportDestinationUnmarshaller - - - - - AnalyticsFilter Unmarshaller - - - - - AnalyticsS3BucketDestination Unmarshaller - - - - - Bucket Unmarshaller - - - - - CommonPrefixesItem Unmarshaller - - - - - Complete Multipart Upload Request Marshaller - - - - - Response Unmarshaller for CompleteMultipartUpload operation - - - - - ContentsItem Unmarshaller - - - - - Copy Object Request Marshaller - - - - - Response Unmarshaller for CopyObject operation - - - - - Upload Part Copy Request Marshaller - - - - - Response Unmarshaller for CopyPart operation - - - - - CORSRule Unmarshaller - - - - - Response Unmarshaller for DefaultRetention Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Delete InventoryConfiguration Request Marshaller - - - - - Response Unmarshaller for DeleteAnalyticsConfiguration operation - - - - - Response Unmarshaller for DeleteCORSConfiguration operation - - - - - Delete InventoryConfiguration Request Marshaller - - - - - Response Unmarshaller for DeleteInventoryConfiguration operation - - - - - Delete Bucket MetricsConfiguration Request Marshaller - - - - - Response Unmarshaller for DeleteBucketMetricsConfiguration operation - - - - - Delete Bucket Policy Request Marshaller - - - - - Response Unmarshaller for DeleteBucketPolicy operation - - - - - Delete Bucket Request Marshaller - - - - - Response Unmarshaller for DeleteBucket operation - - - - - Delete Bucket Tagging Request Marshaller - - - - - Response Unmarshaller for DeleteBucketTagging operation - - - - - Delete Bucket Website Request Marshaller - - - - - Response Unmarshaller for DeleteBucketWebsite operation - - - - - Delete Bucket Cors Request Marshaller - - - - - DeletedObject Unmarshaller - - - - - Delete Bucket Lifecycle Request Marshaller - - - - - Response Unmarshaller for DeleteBucketLifecycle operation - - - - - Delete Object Request Marshaller - - - - - Response Unmarshaller for DeleteObject operation - - - - - Delete Objects Request Marshaller - - - - - Response Unmarshaller for DeleteObjects operation - - - - - DeleteObjectTaggingRequest Marshaller - - - - - Marshall DeleteObjectTaggingRequest object into an http request. - - - - - Marshall DeleteObjectTaggingRequest object into an http request. - - - - - Response Unmarshaller for DeleteObjectTagging operation - - - - - DeletePublicAccessBlock Request Marshaller - - - - - Response Unmarshaller for DeletePublicAccessBlock operation - - - - - ErrorsItem Unmarshaller - - - - - Expiration Unmarshaller - - - - - FilterRule Unmarshaller - - - - - Filter Unmarshaller - - - - - Get Object Acl Request Marshaller - - - - - Response Unmarshaller for GetACL operation - - - - - Get Object Accelerate Configuration Request Marshaller - - - - - Response Unmarshaller for GetACL operation - - - - - Get BucketAnalyticsConfiguration Request Marshaller - - - - - Response Unmarshaller for GetAnalyticsConfiguration operation - - - - - Get InventoryConfiguration Request Marshaller - - - - - Response Unmarshaller for GetInventoryConfiguration operation - - - - - Get Bucket Location Request Marshaller - - - - - Response Unmarshaller for GetBucketLocation operation - - - - - Get Bucket Logging Request Marshaller - - - - - Response Unmarshaller for GetBucketLogging operation - - - - - Get Bucket MetricsConfigurationRequest Marshaller - - - - - Response Unmarshaller for GetBucketMetricsConfiguration operation - - - - - Get Bucket Notification Request Marshaller - - - - - Response Unmarshaller for GetBucketNotification operation - - - - - Get BucketName Policy Request Marshaller - - - - - Response Unmarshaller for GetBucketPolicy operation - - - - - GetBucketPolicyStatusRequestMarshaller - - - - - Response Unmarshaller for GetBucketPolicyStatus operation - - - - - Get Bucket Request Payment Request Marshaller - - - - - Response Unmarshaller for GetBucketRequestPayment operation - - - - - Get Bucket Tagging Request Marshaller - - - - - Response Unmarshaller for GetBucketTagging operation - - - - - Get Bucket Versioning Request Marshaller - - - - - Response Unmarshaller for GetBucketVersioning operation - - - - - Get Bucket Website Request Marshaller - - - - - Response Unmarshaller for GetBucketWebsite operation - - - - - Get Bucket Cors Request Marshaller - - - - - Response Unmarshaller for GetCORSConfiguration operation - - - - - Get Bucket Lifecycle Request Marshaller - - - - - Response Unmarshaller for GetLifecycleConfiguration operation - - - - - GetObjectLegalHold Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for GetObjectLegalHold operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - GetObjectLockConfiguration Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for GetObjectLockConfiguration operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - GetObjectMetadata Marshaller - - - - - Response Unmarshaller for GetObjectMetadata operation - - - - - Get Object Request Marshaller - - - - - Response Unmarshaller for GetObject operation - - - - - GetObjectRetention Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for GetObjectRetention operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - GetObjectTaggingRequest Marshaller - - - - - Marshall GetObjectTaggingRequest into an http request. - - - - - Marshall GetObjectTaggingRequest into an http request. - - - - - Response Unmarshaller for GetObjectTagging operation - - - - - Get Object Torrent Request Marshaller - - - - - Response Unmarshaller for GetObjectTorrent operation - - - - - GetPublicAccessBlockRequestMarshaller - - - - - Response Unmarshaller for GetPublicAccessBlock operation - - - - - Grantee Unmarshaller - - - - - Grant Unmarshaller - - - - - Head Bucket Request Marshaller - - - - - Response Unmarshaller for HeadBucket operation - - - - - Create Multipart Upload Request Marshaller - - - - - Response Unmarshaller for InitiateMultipartUpload operation - - - - - Initiator Unmarshaller - - - - - InventoryConfiguration Unmarshaller - - - - - InventoryDestination Unmarshaller - - - - - InventoryEncryption Unmarshaller - - - - - InventoryFilter Unmarshaller - - - - - InventoryS3BucketDestination Unmarshaller - - - - - InventorySchedule Unmarshaller - - - - - LifecycleFilterPredicate Unmarshaller - - - - - LifecycleRuleNoncurrentVersionExpiration Unmarshaller - - - - - LifecycleRuleNoncurrentVersionTransition Unmarshaller - - - - - List AnalyticsConfiguration Request Marshaller - - - - - Response Unmarshaller for ListAnalyticsConfiguration operation - - - - - List InventoryConfiguration Request Marshaller - - - - - Response Unmarshaller for ListInventoryConfiguration operation - - - - - List Bucket MetricsConfigurationRequest Marshaller - - - - - Response Unmarshaller for ListBucketMetricsConfiguration operation - - - - - List Buckets Request Marshaller - - - - - Response Unmarshaller for ListBuckets operation - - - - - List Multipart Uploads Request Marshaller - - - - - Response Unmarshaller for ListMultipartUploads operation - - - - - List Objects Request Marshaller - - - - - Response Unmarshaller for ListObjects operation - - - - - List Objects Request Marshaller - - - - - Response Unmarshaller for ListObjects operation - - - - - List Parts Request Marshaller - - - - - Response Unmarshaller for ListParts operation - - - - - List Object Versions Request Marshaller - - - - - Response Unmarshaller for ListVersions operation - - - - - LoggingEnabled Unmarshaller - - - - - MetricsConfiguration Unmarshaller - - - - - MetricsFilte Unmarshaller - - - - - UploadsItem Unmarshaller - - - - - Response Unmarshaller for ObjectLockConfiguration Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Response Unmarshaller for ObjectLockLegalHold Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Response Unmarshaller for ObjectLockRetention Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Response Unmarshaller for ObjectLockRule Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Owner Unmarshaller - - - - - PartsItem Unmarshaller - - - - - PolicyStatus Unmarshaller - - - - - PublicAccessBlockConfiguration Unmarshaller - - - - - Put Object Acl Request Marshaller - - - - - Response Unmarshaller for PutObjectAcl operation - - - - - Put Object Acl Request Marshaller - - - - - Response Unmarshaller for PutBucketAccelerate operation - - - - - Request Marshaller for PutAnalyticsConfiguration operation - - - - - Response Unmarshaller for PutBucketAnalytics operation - - - - - Request Marshaller for PutInventoryConfiguration operation - - - - - Response Unmarshaller for PutBucketWebsite operation - - - - - Enable Bucket Logging Request Marshaller - - - - - Response Unmarshaller for PutBucketLogging operation - - - - - Put Bucket MetricsConfigurationRequest Marshaller - - - - - Response Unmarshaller for PutBucketMetricsConfiguration operation - - - - - Put Bucket Notification Request Marshaller - - - - - Response Unmarshaller for PutBucketNotification operation - - - - - Put Bucket Policy Request Marshaller - - - - - Response Unmarshaller for PutBucketPolicy operation - - - - - Put Buckeyt Replication Request Marshaller - - - - - Response Unmarshaller for PutBucketReplication operation. - - - - - Put Bucket Request Marshaller - - - - - Put Bucket Request Payment Request Marshaller - - - - - Response Unmarshaller for PutBucketRequestPayment operation - - - - - Response Unmarshaller for PutBucket operation - - - - - Put Bucket Tagging Request Marshaller - - - - - Response Unmarshaller for PutBucketTagging operation - - - - - Put Bucket Versioning Request Marshaller - - - - - Response Unmarshaller for PutBucketVersioning operation - - - - - Put Bucket Website Request Marshaller - - - - - Response Unmarshaller for PutBucketWebsite operation - - - - - Put Bucket Cors Request Marshaller - - - - - Response Unmarshaller for PutCORSConfiguration operation - - - - - Put Bucket Lifecycle Request Marshaller - - - - - Response Unmarshaller for PutLifecycleConfiguration operation - - - - - PutObjectLegalHold Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for PutObjectLegalHold operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - PutObjectLockConfiguration Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for PutObjectLockConfiguration operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Put Object Request Marshaller - - - - - Response Unmarshaller for PutObject operation - - - - - PutObjectRetention Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for PutObjectRetention operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Delete Object Tagging Request Marshaller - - - - - Marshall PutObjectTaggingRequest into an http request. - - - - - Marshall PutObjectTaggingRequest into an http request. - - - - - Response Unmarshaller for DeleteObjectTagging operation - - - - - PutPublicAccessBlock Request Marshaller - - - - - Response Unmarshaller for PutPublicAccessBlock operation - - - - - Restore Object Request Marshaller - - - - - Response Unmarshaller for RestoreObject operation - - - - - Condition Unmarshaller - - - - - Redirect Unmarshaller - - - - - RoutingRule Unmarshaller - - - - - RulesItem Unmarshaller - - - - - Response Unmarshaller for all Errors - - - - - Build an S3ErrorResponse from XML - - The XML parsing context. - Usually an Amazon.Runtime.Internal.UnmarshallerContext. - An S3ErrorResponse object. - - - - Grant Unmarshaller - - - - - Class for unmarshalling S3 service responses - - - - - Specialized S3 unmarshaller context. - - - - - Wrap an XmlTextReader with state for event-based parsing of an XML stream. - - Stream with the XML from a service response. - If set to true, maintains a copy of the complete response body as the stream is being read. - Response data coming back from the request - If set to is true, configure unmarshaller with exception specifics. - - - - Reads to the next node in the XML document, and updates the context accordingly. - If node is RequestId, reads the contents and stores in RequestId property. - - - True if a node was read, false if there are no more elements to read./ - - - - - SSEKMS Unmarshaller - - - - - StorageClassAnalysisDataExportDataExportUnmarshaller - - - - - StorageClassAnalysisUnmarshaller - - - - - Tag Unmarshaller - - - - - TopicConfiguration Unmarshaller - - - - - Transition Unmarshaller - - - - - Upload Part Request Marshaller - - - - - Response Unmarshaller for UploadPart operation - - - - - VersionsItem Unmarshaller - - - - - Class for AnalyticsPrefixPredicate - The prefix used when evaluating a metrics filter. - - - - - Class for AnalyticsS3BucketDestination - - - - - The file format used when exporting data to Amazon S3. - - - - - The account ID that owns the destination bucket. If no account ID is provided, the owner will not be validated prior to exporting data. - - - - - The Amazon resource name (ARN) of the bucket to which data is exported. - - - - - The prefix to use when exporting data. The exported data begins with this prefix. - - - - - Class for MetricsTagPredicate - The tag used when evaluating a metrics filter. - - - - - This class represents the byte range for a range GET from S3. - - - - - Constructs a ByteRange and sets the start and end. - - - - - - - Constructs a ByteRange and sets the header to the value specified. - - - - - - A private string, represending the byte range. - - - - - The starting byte number of the range - - - - - The ending byte number of the range - - - - - The formatted string representing the byte range to be set for the range header. - - - - - Container for the parameters to the CompleteMultipartUpload operation. - Completes a multipart upload by assembling previously uploaded parts. - - - - - The name of the bucketName containing the S3 object that was being uploaded in parts. - - - - - The key of the S3 object that was being uploaded. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - A collection of part numbers and corresponding etags. - - - - - Adds a collection of part numbers and corresponding etags. - - PartETags that will added to this request. - - - - Adds a collection of part numbers and corresponding etags. - - PartETags that will added to this request. - - - - Adds a collection of part numbers and corresponding etags by transforming the UploadPartResponses into PartETags. - - The list of response objects return from UploadParts. - - - - Adds a collection of part numbers and corresponding etags by transforming the UploadPartResponses into PartETags. - - The list of response objects return from UploadParts. - - - - Adds a collection of part numbers and corresponding etags by transforming the CopyPartResponse into PartETags. - - The list of response objects return from CopyParts. - - - - Adds a collection of part numbers and corresponding etags by transforming the CopyPartResponse into PartETags. - - The list of response objects return from CopyParts. - - - - The upload id for the in-progress multipart upload that should be completed. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the CompleteMultipartUpload response and response metadata. - - - - - Gets and sets the URI that identifies the newly created object. - - - - - Gets and sets the name of the bucketName that contains the newly created object. - - - - - Gets and sets the object key of the newly created object. - - - - - Gets and sets Entity tag that identifies the newly created object's data. Objects with different - object data will have different entity tags. The entity tag is an opaque string. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - Gets and sets the ServerSideEncryptionMethod property. - Specifies the encryption used on the server to - store the content. - Default is None. - - - - - Gets and sets the VersionId property. - This is the version-id of the S3 object - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the CopyObject operation. - Creates a copy of an object that is already stored in Amazon S3. - - - - - The name of the bucket containing the object to copy. - - - - - Checks if SourceBucket property is set. - - true if SourceBucket property is set. - - - - The key of the object to copy. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Checks if SourceKey property is set. - - true if SourceKey property is set. - - - - Specifies a particular version of the source object to copy. By default the latest version is copied. - - - - - Checks if SourceVersionId property is set. - - true if SourceVersionId property is set. - - - - The name of the bucket to contain the copy of the source object. - - - - - Checks if DestinationBucket property is set. - - true if DestinationBucket property is set. - - - - The key to be given to the copy of the source object. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Checks if DestinationKey property is set. - - true if DestinationKey property is set. - - - - A canned access control list (CACL) to apply to the object. - Please refer to for - information on S3 Canned ACLs. - - - - - ETag to be matched as a pre-condition for copying the source object - otherwise returns a PreconditionFailed. - - - Copies the object if its entity tag (ETag) matches - the specified tag; otherwise return a 412 (precondition failed). - Constraints: This property can be used with IfUnmodifiedSince, - but cannot be used with other conditional copy properties. - - - - - Checks if ETagToMatch property is set. - - - Copies the object if its entity tag (ETag) is different - than the specified Etag; otherwise returns a 412 (failed condition). - Constraints: This header can be used with IfModifiedSince, but cannot - be used with other conditional copy properties. - - true if ETagToMatch property is set. - - - - ETag that must not be matched as a pre-condition for copying the source object, - otherwise returns a PreconditionFailed. - - - - - Checks if ETagToNotMatch property is set. - - true if ETagToNotMatch property is set. - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or - ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Copies the object if it has been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it has been modified since the - specified time; otherwise returns a 412 (failed condition). - Constraints: This property can be used with ETagToNotMatch, - but cannot be used with other conditional copy properties. - - - - - Copies the object if it has been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it has been modified since the - specified time; otherwise returns a 412 (failed condition). - Constraints: This property can be used with ETagToNotMatch, - but cannot be used with other conditional copy properties. - - - - - Checks if ModifiedSinceDateUtc property is set. - - true if ModifiedSinceDateUtc property is set. - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or - UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Copies the object if it has not been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it hasn't been modified since the - specified time; otherwise returns a 412 (precondition failed). - Constraints: This property can be used with ETagToMatch, - but cannot be used with other conditional copy properties. - - - - - Copies the object if it has not been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it hasn't been modified since the - specified time; otherwise returns a 412 (precondition failed). - Constraints: This property can be used with ETagToMatch, - but cannot be used with other conditional copy properties. - - - - - Checks if UnmodifiedSinceDateUtc property is set. - - true if UnmodifiedSinceDateUtc property is set. - - - - Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request. - - - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - Specifies whether you want to apply a Legal Hold to the copied object. - - - - - - Gets and sets the property ObjectLockMode. - - The Object Lock mode that you want to apply to the copied object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - The date and time when you want the copied object's Object Lock to expire. - - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - Checks if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - true if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - - - The type of storage to use for the object. Defaults to 'STANDARD'. - - - - - - If the bucketName is configured as a website, redirects requests for this object to another object in the same bucketName or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - This is a convenience property for Headers.ContentType. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - /// - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The customer provided encryption key for the source object of the copy. - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - true if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the CopySourceServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if CopySourceServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - The tag-set for the object destination object this value must be used in conjunction with the TaggingDirective. The tag-set must be encoded as URL Query parameters. - - - - - Checks if Tagging property is set - - true if Tagging is set. - - - - Returns information about the CopyObject response and response metadata. - - - - - Gets and sets the ETag property. - - - - - Gets and sets the LastModified property. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - Gets and sets the SourceVersionId property. - This is the Version Id of the Source Object - - - - - Version ID of the newly created copy. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the CopyPart operation. - Uploads a part by copying data from an existing object as data source. - - - - - The name of the bucket containing the object to copy. - - - - - Checks if SourceBucket property is set. - - true if SourceBucket property is set. - - - - The key of the object to copy. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Checks if SourceKey property is set. - - true if SourceKey property is set. - - - - Specifies a particular version of the source object to copy. By default the latest version is copied. - - - - - Checks if SourceVersionId property is set. - - true if SourceVersionId property is set. - - - - The name of the bucket to contain the copy of the source object. - - - - - Checks if DestinationBucket property is set. - - true if DestinationBucket property is set. - - - - The key to be given to the copy of the source object. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Checks if DestinationKey property is set. - - true if DestinationKey property is set. - - - - The ID identifying multipart upload for which we are copying a part. - - - - - Checks if UploadId property is set. - - true if UploadId property is set. - - - - Collection of ETags to be matched as a pre-condition for copying the source object - otherwise returns a PreconditionFailed. - - - Copies the object if its entity tag (ETag) matches one of - the specified tags; otherwise return a 412 (precondition failed). - Constraints: This property can be used with IfUnmodifiedSince, - but cannot be used with other conditional copy properties. - - - - - Checks if ETagsToMatch property is set. - - true if ETagToMatch property is set. - - - - Collection of ETags that must not be matched as a pre-condition for copying the source object - otherwise returns a PreconditionFailed. - - - Copies the object if its entity tag (ETag) does not match any of the specified - tags; otherwise returns a 412 (failed condition). - Constraints: This header can be used with IfModifiedSince, but cannot - be used with other conditional copy properties. - - - - - Checks if ETagToNotMatch property is set. - - true if ETagToNotMatch property is set. - - - - Copies the object if it has been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it has been modified since the - specified time; otherwise returns a 412 (failed condition). - Constraints: This property can be used with ETagToNotMatch, - but cannot be used with other conditional copy properties. - - - - - Checks if ModifiedSinceDate property is set. - - true if ModifiedSinceDate property is set. - - - - Copies the object if it has not been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it hasn't been modified since the - specified time; otherwise returns a 412 (precondition failed). - Constraints: This property can be used with ETagToMatch, - but cannot be used with other conditional copy properties. - - - - - Checks if UnmodifiedSinceDate property is set. - - true if UnmodifiedSinceDate property is set. - - - - The number of the part to be copied. - - - Valid part numbers are from 1 to 10,000 inclusive and will uniquely identify the part - and determine the relative ordering within the destination object. If a part already - exists with the PartNumber it will be overwritten. - - - - - Checks if PartNumber property is set. - - true if PartNumber property is set. - - - - The location of the first byte in the range if only a portion of the - source object is to be copied as the part. - - - The LastByte property must also be set or this value will be ignored. - - - - - Checks if FirstByte property is set. - - true if FirstByte property is set. - - - - The location of the last byte in the range if only a portion of the - source object is to be copied as the part. - - - The FirstByte property must also be set or this value will be ignored. - - - - - Checks if LastByte property is set. - - true if LastByte property is set. - - - - - This property is obsolete. Use ServerSideEncryptionMethod in InitiateMultipartUploadRequest instead. - - - Default: None - - - - - - Checks if ServerSideEncryptionMethod property is set. - - true if ServerSideEncryptionMethod property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - This property is obsolete. Use ServerSideEncryptionKeyManagementServiceKeyId in InitiateMultipartUploadRequest instead. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The customer provided encryption key for the source object of the copy. - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - true if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the CopySourceServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if CopySourceServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - - - Returns information about the CopyPart response and response metadata. - - - - - The version of the source object that was copied, if you have enabled versioning on the source bucketName. - - - - - - Entity tag of the object. - - - - - - Date and time at which the object was uploaded. - - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - Gets and sets the PartNumber property. - This is the part number in it's multi-part upload that will uniquely identify the part - and determine the relative ordering within the destination object. - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - A collection of up to 100 cross-origin resource sharing (CORS) rules. - - - - - The collection of rules in this configuration. - - - - C O R S Rule - - - - - Identifies HTTP methods that the domain/origin specified in the rule is allowed to execute. - - - - - - One or more origins you want customers to be able to access the bucket from. - - - - - - An optional unique identifier for the rule. - - - The ID value can be up to 255 characters long. The IDs help you find a rule in the configuration. - - - - - Checks if Id property is set. - - true if Id property is set. - - - - One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript - XMLHttpRequest object). - - - - - - The time in seconds that your browser is to cache the preflight response for the specified resource. - - - - - - Specifies which headers are allowed in a pre-flight OPTIONS request through the - Access-Control-Request-Headers header. - - - Each header name specified in the Access-Control-Request-Headers must have a corresponding - entry in the rule. Only the headers that were requested will be sent back. - This element can contain at most one * wildcard character. - - - - - Checks if AllowedHeaders property is set. - - true if AllowedHeaders property is set. - - - - Describes how a CSV-formatted input object is formatted. - - - - - Describes the first line of input. Valid values: None, Ignore, Use. - - - - - Single character used to indicate a row should be ignored when present at the start of a row. - - - - - Single character used for escaping the quote character inside an already escaped value. - - - - - Value used to separate individual records. - - - - - Value used to separate individual fields in a record. - - - - - Value used for escaping where the field delimiter is part of the value. - - - - - Specifies that CSV field values may contain quoted record delimiters and such records should be allowed. Default value is FALSE. Setting this value to TRUE may lower performance. - - - - - Describes how CSV-formatted results are formatted. - - - - - Indicates whether or not all output fields should be quoted. - - - - - Single character used for escaping the quote character inside an already escaped value. - - - - - Value used to separate individual records. - - - - - Value used to separate individual fields in a record. - - - - - Value used for escaping where the field delimiter is part of the value. - - - - - The container element for specifying the default Object Lock retention settings for - new objects placed in the specified bucket. - - - - - Gets and sets the property Days. - - The number of days that you want to specify for the default retention period. - - - - - - Gets and sets the property Mode. - - The default Object Lock retention mode you want to apply to new objects placed in - the specified bucket. - - - - - - Gets and sets the property Years. - - The number of years that you want to specify for the default retention period. - - - - - - Container for the parameters to the DeleteBucketAnalyticsConfiguration operation. - Deletes an analytics configuration for the bucket (specified by the analytics configuration ID). - - - - - The name of the bucket from which an analytics configuration is deleted. - - - - - The identifier used to represent an analytics configuration. - - - - - Returns information about the DeleteBucketAnalyticsConfiguration response metadata. - The DeleteBucketAnalyticsConfiguration operation has a void result type. - - - - - Request object for the DeleteBucketEncryption operation. - Request Deletes the server-side encryption configuration from the bucket. - - - - - The name of the bucket containing the server-side encryption configuration to delete. - - - - - Returns information about the DeleteBucketEncryption response metadata. - The DeleteBucketEncryption operation has a void result type. - - - - - Container for the parameters to the DeleteInventoryConfiguration operation. - Deletes an inventory configuration (identified by the inventory ID) from the bucket. - - - - - The name of the bucket containing the inventory configuration to delete. - - - - - The ID used to identify the inventory configuration. - - - - - Returns information about the DeleteInventoryConfiguration response metadata. - The DeleteInventoryConfiguration operation has a void result type. - - - - - Container for the parameters to the DeleteBucketMetricsConfiguration operation. - Deletes a metrics configuration (specified by the metrics configuration ID) from the bucket. - - - - - The name of the bucket on which Inventory configuration is to be removed. - - - - - The ID used to identify the metrics configuration. - - - - - Returns information about the DeleteBucketMetricsConfiguration response metadata. - The DeleteBucketMetricsConfiguration operation has a void result type. - - - - - Container for the parameters to the DeleteBucketPolicy operation. - Deletes the policy from the bucket. - - - - - The bucket on which the policy is to be deleted. - - - - - Returns information about the DeleteBucketPolicy response metadata. - The DeleteBucketPolicy operation has a void result type. - - - - - Request object for the DeleteBucketReplication operation. - - - - - Gets and sets the property BucketName. -

Deletes the replication subresource associated with the specified - bucket.

There is usually some time lag before - replication configuration deletion is fully propagated to all the - Amazon S3 systems.

For more information, see - - Cross-Region Replication (CRR) in the Amazon S3 Developer - Guide.

- - - - - Returns information about the DeleteBucketReplication response metadata. - The DeleteBucketReplication operation has a void result type. - - - - - Container for the parameters to the DeleteBucket operation. - Deletes the bucket. All objects (including all object versions and Delete Markers) in the bucket must be deleted before the bucket - itself can be deleted. - - - - - The name of the bucket to be created. - - - - - The region locality for the bucket. - - - When set, this will determine the region the bucket exists in. - Refer - for a list of possible values. - - - - - If set to true the bucket will be deleted in the same region as the configuration of the AmazonS3 client. - DeleteBucketRequest.BucketRegion takes precedence over this property if both are set. - Default: true. - - - - - Returns information about the DeleteBucket response metadata. - The DeleteBucket operation has a void result type. - - - - - The parameters to request deletion of a tag set from a bucket. - - - To use this operation, you must have permission to perform the s3:PutBucketTagging action. - By default, the bucket owner has this permission and can grant this permission to others. - - - - - The name of the bucket on which the tag set is to be removed. - - - - - Returns information about the DeleteBucketTagging response metadata. - The DeleteBucketTagging operation has a void result type. - - - - - Container for the parameters to the DeleteBucketWebsite operation. - This operation removes the website configuration from the bucket. - - - - - The name of the bucket on which website configuration is to be removed. - - - - - Returns information about the DeleteBucketWebsite response metadata. - The DeleteBucketWebsite operation has a void result type. - - - - - Container for the parameters to the DeleteCORSConfiguration operation. - Deletes the cors configuration information set for the bucket. - - - - - Gets and sets the BucketName property. - - - - - Returns information about the DeleteCORSConfiguration response metadata. - The DeleteCORSConfiguration operation has a void result type. - - - - - Contains information about a successful delete operation against a specific S3 object. - - - - - Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a - delete marker. In a simple DELETE, this header indicates whether (true) or not (false) a delete - marker was created. - - - - - The version ID of the delete marker created as a result of the DELETE operation. If you delete a - specific object version, the value returned by this header is the version ID of the object version - deleted. - - - - - The key of the deleted S3 object. - - - - - The version of the deleted S3 object. - - - - - Contains information about a failed delete operation against a specific S3 object. - - - - - The key of the S3 object. - - - - - The version of the S3 object. - - - - - The failure code for the delete error. - - - - - The failure message for the delete error. - - - - - The parameters to request deletion of the lifecycle configuration on a bucket. - - - - Amazon S3 removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. - Your objects never expire, and Amazon S3 no longer automatically deletes any objects on the basis of rules contained - in the deleted lifecycle configuration. - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration action. By default, the - bucket owner has this permission and the bucket owner can grant this permission to others. - - - There is usually some time lag before lifecycle configuration deletion is fully propagated to all the Amazon S3 systems. - - - - - - The name of the bucket on which the lifecycle configuration is to be deleted. - - - - - Returns information about the DeleteLifecycleConfiguration response metadata. - The DeleteLifecycleConfiguration operation has a void result type. - - - - -

Specifies whether Amazon S3 should replicate delete makers.

- - - - - Gets and sets the property Status. -

The status of the delete marker replication.

-

In the current implementation, Amazon S3 does not replicate - the delete markers. Therefore, the status must be - Disabled.

- - - - - The parameters to request deletion of an object in a bucket. - The operation removes the null version (if there is one) of an object and inserts a delete marker, which - becomes the latest version of the object. - - - - To remove a specific version, you must be the bucket owner and you must use the versionId subresource. - Using this subresource permanently deletes the version. - - - If the object you want to delete is in a bucket where the bucket versioning configuration is MFA Delete enabled, - you must include specify the MFA serial number and value in the request. - - - If there isn't a null version, Amazon S3 does not remove any objects. - - - - - - The bucket name of the bucket containing the object. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property BypassGovernanceRetention. - - - - - The key identifying the object to delete. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - The identifier for the specific version of the object to be deleted, if required. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - The MfaCodes Tuple associates the Serial Number and the current Token/Code displayed on the - Multi-Factor Authentication device associated with your AWS Account. - - - This is a required property for this request if:
- 1. EnableMfaDelete was configured on the bucket - containing this object's version.
- 2. You are deleting an object's version - - - - - Checks if the MfaCodes property is set. - - true if the MfaCodes property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the DeleteObject response and response metadata. - - - - - Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a delete marker. - - - - - - Returns the version ID of the delete marker created as a result of the DELETE operation. - - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the DeleteObjects operation. - This operation enables you to delete multiple objects from a bucket using a single HTTP request. You may specify up to 1000 - keys. - - - Container for the parameters to the DeleteObjects operation. - This operation enables you to delete multiple objects from a bucket using a single HTTP request. You may specify up to 1000 - keys. - - - - - The bucket name containing the objects to delete. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property BypassGovernanceRetention. - - Specifies whether you want to delete this object even if it has a Governance-type - Object Lock in place. You must have sufficient permissions to perform this operation. - - - - - - List of object keys to delete. - - - - - Toggles between Quiet and Verbose mode for the operation. - If set to true (Quiet mode), the response includes only those keys for objects on which - the delete operation failed. - - - By default this property is false and keys for both successful deletes - and failures are returned in the response. - - - - - The MfaCodes Tuple associates the Serial Number and the current Token/Code displayed on the - Multi-Factor Authentication device associated with your AWS Account. - - - This is a required property for this request if:
- 1. EnableMfaDelete was configured on the bucket - containing this object's version.
- 2. You are deleting an object's version - - - - - Checks if the MfaCodes property is set. - - true if the MfaCodes property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Add a key to the set of keys of objects to be deleted. - - Object key - - - - Add a key and a version to be deleted. - - Key of the object to be deleted. - Version of the object to be deleted. - - - - Add a KeyVersion object representing the S3 object to be deleted. - - KeyVersion representation of object to be deleted. - - - - Returns information about the DeleteObjects response and response metadata. - - - - - A default constructor for DeleteObjectsResponse - - - - - Gets and sets the DeletedObjects property. - A list of successful deletes. - Set only when Quiet=false on DeleteObjectsRequest. - - - - - Gets and sets the DeleteErrors property. - A list of errors encountered while deleting objects. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the DeleteObjectTaggingRequest operation. - - - - - The bucket name containing the objects from which to remove the tags. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Check to see if Bucket property is set - - - - - The key identifying the object tagging to delete. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Check to see if Key property is set - - - - - The identifier for the specific version of the object to be deleted, if required. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - Returns information about the DeleteObjectTagging response and response metadata. - - - - - Returns the version ID of the delete marker created as a result of the DELETE operation. - - - - - Check to see if VersionId property is set - - - - - Container for the parameters to the DeletePublicAccessBlock operation. - Removes the Public Access Block configuration for an Amazon S3 bucket. - - - - - Gets and sets the property BucketName. - - The Amazon S3 bucket whose Public Access Block configuration you want to delete. - - - - - - This is the response object from the DeletePublicAccessBlock operation. - - - - - EncryptionConfiguration class - - - - - The ID of the AWS KMS key for the region where the destination bucket - resides. Amazon S3 uses this key to encrypt the replica object. - - - - - A container that specifies information about existing object replication. You can choose whether to enable or disable the replication of existing objects. - - - - - Specifies whether existing object replication is enabled. - - - - - Defines the expiration policy for a given object. - - - - - This property is deprecated. This property exposes a DateTime of kind Unspecified. Use ExpiryDateUtc instead. - The date and time for expiry. - - - - - The date and time for expiry. - - - - - Id of the configuration rule for this expiry. - - - - - Constructs an empty instance of an Expiration object - - - - Bucket - Represents a set of filter criteria that limits the objects that can trigger event notifications - - - - - Filter criteria that limits the objects that can trigger event notifications based on their S3 Key name. - - - - - Bucket - Represents a Filter Rule for a NotificationConfiguration. - - - - - Constructs an empty FilterRule. - - - - - Constructs a FilterRule with a specific name and value. - - - - - - - The name of the filter rule. - - - - - The value of the filter rule. - - - - - Container for the parameters to the GetACL operation. - Returns the access control list (ACL) of an object. - - - - - The bucket name that contains the object for which to get the ACL information. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The key of the S3 object to be queried. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - VersionId used to reference a specific version of the object. - - - - - Returns information about the GetACL response and response metadata. - - - - - Gets and sets the AccessControlList property. - - - - - Container for the parameters to the GetBucketAccelerateConfiguration operation. - - - - - The name of the bucket. - - - - - The response class for GetBucketAccelerateConfiguration operation. - - - - - The accelerate status of the bucket. - - - - - Container for the parameters to the GetBucketAnalyticsConfiguration operation. - Gets an analytics configuration for the bucket (specified by the analytics configuration ID). - - - - - The name of the bucket from which an analytics configuration is retrieved. - - - - - The identifier used to represent an analytics configuration. - - - - - GetBucketAnalyticsConfigurationResponse Response - - - - - The configuration and any analyses for the analytics filter. - - - - - Container for the parameters to the GetBucketEncryptionRequest operation. - Returns the server-side encryption configuration of a bucket. - - - - - The name of the bucket. - - - - - GetBucketEncryptionResponse Response - - - - - Container for server-side encryption configuration rules. Currently S3 supports one rule only. - - - - - Container for the parameters to the GetInventoryConfigurationRequest operation. - Returns an inventory configuration (identified by the inventory ID) from the bucket. - - - - - The name of the bucket containing the inventory configuration to retrieve. - - - - - The ID used to identify the inventory configuration. - - - - - GetInventoryConfigurationResponse Response - - - - - Specifies the inventory configuration. - - - - - Container for the parameters to the GetBucketLocation operation. - Returns the region the bucket resides in. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetBucketLocation response and response metadata. - - - - - Gets and sets the Location property. - If the the bucket is located in us-east-1 S3Region.US will be return which has a - value of empty string. - - - - - Container for the parameters to the GetBucketLogging operation. - Returns the logging status of a bucket and the permissions users have to view and modify that status. To use GET, you must be the - bucket owner. - - - - - The name of the bucket to query. - - - - - Returns information about the GetBucketLogging response and response metadata. - - - - - Gets and sets the LoggingConfig property. - - - - - Container for the parameters to the GetBucketMetricsConfiguration operation. - Gets a metrics configuration (specified by the metrics configuration ID) from the bucket. - - - - - The name of the bucket containing the metrics configuration to retrieve. - - - - - The ID used to identify the metrics configuration. - - - - - GetBucketMetricsConfiguration Response - - - - - Specifies the metrics configuration. - - - - - Container for the parameters to the GetBucketNotification operation. - Return the notification configuration of a bucket. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetBucketNotification response and response metadata. - - - - - Gets and sets the TopicConfigurations property. TopicConfigurations are configuration - for Amazon S3 events to be sent to Amazon SNS topics. - - - - - Gets and sets the QueueConfigurations property. QueueConfigurations are configuration - for Amazon S3 events to be sent to Amazon SQS queues. - - - - - Gets and sets the LambdaFunctionConfigurations property. LambdaFunctionConfigurations are configuration - for Amazon S3 events to be sent to an Amazon Lambda cloud function. - - - - - Container for the parameters to the GetBucketPolicy operation. - Returns the policy of a specified bucket. - - - - - The name of the bucket. - - - - - Get BucketName Policy Response - - - - - The bucket policy as a JSON document. - - - - - Container for the parameters to the GetBucketPolicyStatus operation. - Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket - is public. - - - - - Gets and sets the property BucketName. - - The name of the Amazon S3 bucket whose public-policy status you want to retrieve. - - - - - - This is the response object from the GetBucketPolicyStatus operation. - - - - - The public-policy status for this bucket. - - - - - Container for the parameters to the GetBucketReplicationConfiguration operation. - Returns the replication configuration information set on the bucket. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetReplicationConfiguration response and response metadata. - - - - - The replication configuration for the buccket specified in the request. - - - - - Container for the parameters to the GetBucketRequestPayment operation. - Returns the request payment configuration of a bucket. - - - - - The name of the bucket. - - - - - Returns information about the GetBucketRequestPayment response and response metadata. - - - - - Specifies who pays for the download and request fees. - - - - - - Container for the parameters to the GetBucketTagging operation. - Returns the tag set associated with the bucket. - - - - - The name of the bucket to be queried. - - - - - Returns information about the GetBucketTagging response and response metadata. - - - - - The collection of tags. - - - - - Container for the parameters to the GetBucketVersioning operation. - Returns the versioning state of a bucket. - - - - - The name of the bucket to be queried. - - - - - Returns information about the GetBucketVersioning response and response metadata. - - - - - Gets and sets the Versioning property. - Unless Versioning has been explicitly "Enabled" on a bucket, - Versioning Status is "Off". Once Versioning has been - "Enabled", it can be "Suspended" but cannot be switched "Off". - - - - - Container for the parameters to the GetBucketWebsite operation. - Returns the website configuration for a bucket. - - - - - The name of the bucket to be queried. - - - - - Returns information about the GetBucketWebsite response and response metadata. - - - - - Gets and sets the WebsiteConfiguration property. - - This is where the index document suffix and custom error page are defined. - - - - - Container for the parameters to the GetBucketCors operation. - Returns the cors configuration for the bucket. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetBucketCors response and response metadata. - - - - - The current CORSConfiguration for the bucket. - - - - - Container for the parameters to the GetLifecycleConfiguration operation. - Returns the lifecycle configuration information set on the bucket. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetLifecycleConfiguration response and response metadata. - - - - - Gets and Sets the property that governs whether - the response includes successful deletes as well as errors - following the DeleteObjects call against S3. - - By default this property is false and successful deletes - are returned in the response. - - - - - Container for the parameters to the GetObjectLegalHold operation. - Gets an object's current Legal Hold status. - - - - - The bucket name containing the object whose Legal Hold status you want to retrieve. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property Key. - - The key name for the object whose Legal Hold status you want to retrieve. - - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property VersionId. - - The version ID of the object whose Legal Hold status you want to retrieve. - - - - - - This is the response object from the GetObjectLegalHold operation. - - - - - Gets and sets the property LegalHold. - - The current Legal Hold status for the specified object. - - - - - - Container for the parameters to the GetObjectLockConfiguration operation. - Gets the Object Lock configuration for a bucket. The rule specified in the Object - Lock configuration will be applied by default to every new object placed in the specified - bucket. - - - - - Gets and sets the property BucketName. - - The bucket whose Object Lock configuration you want to retrieve. - - - - - - This is the response object from the GetObjectLockConfiguration operation. - - - - - Gets and sets the property ObjectLockConfiguration. - - The specified bucket's Object Lock configuration. - - - - - - Container for the parameters to the HeadObject operation. - The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you''re only - interested in an object''s metadata. To use HEAD, you must have READ access to the object. - - - - - The name of the bucket that contains the object. - - - - - ETag to be matched as a pre-condition for returning the object, - otherwise a PreconditionFailed signal is returned. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or - ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Returns the object only if it has been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Returns the object only if it has been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - ETag that should not be matched as a pre-condition for returning the object, - otherwise a PreconditionFailed signal is returned. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or - UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Returns the object only if it has not been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Returns the object only if it has not been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - The key of the object. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - VersionId used to reference a specific version of the object. - - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to decrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - Part number of the object being read. This is a positive integer between 1 and 10,000. - Effectively performs a 'ranged' HEAD request for the part specified. - Useful querying about the size of the part and the number of parts in this object. - - - - - Check if PartNumber property is set. - - true if PartNumber property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the HeadObject response and response metadata. - - - - - Flag which returns true if the Expires property has been unmarshalled - from the raw value or set by user code. - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the - response. - - - - - - Gets and sets the AcceptRanges. - - - - - Gets and sets the ContentRange. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - Gets and sets the RestoreExpiration property. - RestoreExpiration will be set for objects that have been restored from Amazon Glacier. - It indiciates for those objects how long the restored object will exist. - - - - - Gets and sets the RestoreInProgress - Will be true when the object is in the process of being restored from Amazon Glacier. - - - - - Last modified date of the object - - - - - - An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL - - - - - - This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like - SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal - HTTP headers. - - - - - - Version of the object. - - - - - - The date and time at which the object is no longer cacheable. - - - - - - If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The status of the replication job associated with this source object. - - - - - Checks if ReplicationStatus property is set. - - true if ReplicationStatus property is set. - - - - The count of parts this object has. - - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - The Legal Hold status for the specified object. - - - - - - Gets and sets the property ObjectLockMode. - - The Object Lock mode currently in place for this object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - The date and time when this object's Object Lock will expire. - - - - - - The class of storage used to store the object. - - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the GetObject operation. - Retrieves objects from Amazon S3. - - - - - The bucket name containing the object. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - ETag to be matched as a pre-condition for returning the object, - otherwise a PreconditionFailed signal is returned. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or - ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Returns the object only if it has been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Returns the object only if it has been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - ETag that should not be matched as a pre-condition for returning the object, - otherwise a PreconditionFailed signal is returned. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or - UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Returns the object only if it has not been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Returns the object only if it has not been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Gets and sets the Key property. This is the user defined key that identifies the object in the bucket. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Downloads the specified range bytes of an object. - - - - - A set of response headers that should be returned with the object. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ResponseExpiresUtc instead. Setting either ResponseExpires or - ResponseExpiresUtc results in both ResponseExpires and ResponseExpiresUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ResponseExpires is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Sets the Expires header of the response. - - - - - Sets the Expires header of the response. - - - - - VersionId used to reference a specific version of the object. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to decrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - Part number of the object being read. This is a positive integer between 1 and 10,000. - Effectively performs a 'ranged' GET request for the part specified. Useful for downloading just a part of an object. - - - - - Checks if PartNumber property is set. - - true if PartNumber property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the GetObject response and response metadata. - - - - - Flag which returns true if the Expires property has been unmarshalled - from the raw value or set by user code. - - - - - Gets and sets the BucketName property. - - - - - Gets and sets the Key property. - - - - - Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the - response. - - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - Gets and sets the AcceptRanges. - - - - - Gets and sets the ContentRange. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - Gets and sets the RestoreExpiration property. - RestoreExpiration will be set for objects that have been restored from Amazon Glacier. - It indiciates for those objects how long the restored object will exist. - - - - - Gets and sets the RestoreInProgress - Will be true when the object is in the process of being restored from Amazon Glacier. - - - - - Last modified date of the object - - - - - - An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL - - - - - - This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like - SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal - HTTP headers. - - - - - - Version of the object. - - - - - - The date and time at which the object is no longer cacheable. - - - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - - - - Gets and sets the property ObjectLockMode. - - The Object Lock mode currently in place for this object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - The date and time when this object's Object Lock will expire. - - - - - - If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The class of storage used to store the object. - - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The status of the replication job associated with this source object. - - - - - Checks if ReplicationStatus property is set. - - true if ReplicationStatus property is set. - - - - The number of parts this oject has. - - - - - Checks if PartsCount is set. - - true if PartsCount property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - The number of tags, if any, on the object. - - - - - The event for Write Object progress notifications. All - subscribers will be notified when a new progress - event is raised. - - - Subscribe to this event if you want to receive - put object progress notifications. Here is how:
- 1. Define a method with a signature similar to this one: - - private void displayProgress(object sender, WriteObjectProgressArgs args) - { - Console.WriteLine(args); - } - - 2. Add this method to the Put Object Progress Event delegate's invocation list - - GetObjectResponse response = s3Client.GetObject(request); - response.WriteObjectProgressEvent += displayProgress; - - - - - - This method is called by a producer of write object progress - notifications. When called, all the subscribers in the - invocation list will be called sequentially. - - The file being written. - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - True if transfer is complete - - - - Writes the content of the ResponseStream a file indicated by the filePath argument. - - The location where to write the ResponseStream - Whether or not to append to the file if it exists - - - - Encapsulates the information needed to provide - download progress for the Write Object Event. - - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The bucket name for the S3 object being written. - The object key for the S3 object being written. - The version-id of the S3 object. - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - True if finished writing - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The bucket name for the S3 object being written. - The object key for the S3 object being written. - The file for the S3 object being written. - The version-id of the S3 object. - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - True if finished writing - - - - Gets the bucket name for the S3 object being written. - - - - - Gets the object key for the S3 object being written. - - - - - Gets the version-id of the S3 object. - - - - - The file for the S3 object being written. - - - - - True if writing is complete - - - - - Container for the parameters to the GetObjectRetention operation. - Retrieves an object's retention settings. - - - - - The bucket name containing the object whose retention settings you want to retrieve. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property Key. - - The key name for the object whose retention settings you want to retrieve. - - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property VersionId. - - The version ID for the object whose retention settings you want to retrieve. - - - - - - This is the response object from the GetObjectRetention operation. - - - - - Gets and sets the property Retention. - - The container element for an object's retention settings. - - - - - - Container for the parameters to the GetObjectTaggingRequest operation. - - - - - The bucket name containing the object for which to get the tagging information. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Check to see if Bucket property is set - - - - - Gets and sets the Key property. This is the user defined key that identifies the object in the bucket. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Check to see if Key property is set - - - - - VersionId used to reference a specific version of the object. - - - - - - Returns information about the GetObjectTagging response and response metadata. - - - - - Gets or sets tag-set for a given object - - - - - Container for the parameters to the GetObjectTorrent operation. - Return torrent files from a bucket. - - - - - The name of the bucket containing the object. - - - - - The key identifying the object. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the GetObjectTorrent response and response metadata. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - The parameters to create a pre-signed URL to a bucket or object. - - - For more information, refer to: . -
Required Parameters: BucketName, Expires -
Optional Parameters: Key, VersionId, Verb: default is GET - - - - - The name of the bucket to create a pre-signed url to, or containing the object. - - - - - Checks if BucketName property is set. - - true if BucketName property is set. - - - - The key to the object for which a pre-signed url should be created. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Checks if Key property is set. - - true if Key property is set. - - - - A standard MIME type describing the format of the object data. - - - - The content type for the content being uploaded. This property defaults to "binary/octet-stream". - For more information, refer to: . - - - Note that if content type is specified, it should also be included in the HttpRequest headers - of the eventual upload request, otherwise a signature error may result. - - - - - - The expiry date and time for the pre-signed url. - - - - - Checks if Expires property is set. - - true if Expires property is set. - - - - The requested protocol (http/https) for the pre-signed url. - - - Defaults to https. - - - - - The verb for the pre-signed url. - - - Accepted verbs are GET, PUT, DELETE and HEAD. - Default is GET. - - - - - Version id for the object that the pre-signed url will reference. If not set, - the url will reference the latest version of the object. - - - This is the VersionId for the S3 Object you want to get - a PreSigned URL for. The VersionId property will be ignored - for PreSigned "PUT" requests and for requests that don't specify - the Key property. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - The upload id for the multipart upload for which a pre-signed url should be created. - - - - - Checks if UploadId property is set. - - true if UploadId property is set. - - - - The part number for the multipart upload for which a pre-signed url should be created. - - - - - Checks if PartNumber property is set. - - true if PartNumber property is set. - - - - Specifies the encryption used on the server to store the content. - - - - Default is None. - - - If specifying encryption (not None), the corresponding request must include header - "x-amz-server-side-encryption" with the value of the encryption. - - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - Confirms that the requester knows that she or he will be charged for the request. - Bucket owners need not specify this parameter in their requests. - - - - - A set of response headers that should be returned with the pre-signed url creation response. - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - Custom parameters to include in the signed request, so that they are tamper-proof. - - - - - The parameters for a pre-signed URL to a bucket or object as a string. - - - For more information, refer to: . - - - - - The PreSignedURL as a string - - - - - Constructor - - A url returned from GetPreSignedUrlRequest - - - - Container for the parameters to the GetPublicAccessBlock operation. - Retrieves the Public Access Block configuration for an Amazon S3 bucket. - - - - - Gets and sets the property BucketName. - - The name of the Amazon S3 bucket whose Public Access Block configuration you want - to retrieve. - - - - - - This is the response object from the GetPublicAccessBlock operation. - - - - - The Public Access Block configuration currently in effect for this Amazon S3 bucket. - - - - - Container for the parameters to the HeadBucket operation. - This operation is useful to determine if a bucket exists and you have permission to access it. - - - - - Returns information about the HeadBucket response metadata. - The HeadBucket operation has a void result type. - - - - - This class contains the headers for an S3 object. - - - - - Gets and sets headers to set for the object. - - The name of the header - The value for the header - - - - Gets the count of headers. - - - - - Gets the names of the headers set. - - - - - Specifies caching behavior along the request/reply chain. - - - - - - Specifies presentational information for the object. - - - - - - Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type - referenced by the Content-Type header field. - - - - - - The size of the object, in bytes. - - - - - The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. This - header can be used as a message integrity check to verify that the data is the same data that was originally sent. - - - - - A standard MIME type describing the format of the object data. - - - - - - The date and time at which the object is no longer cacheable. - - - - - - - Container for the parameters to the InitiateMultipartUpload operation. - Initiates a multipart upload and returns an upload ID. - - - - - Envelope Key to Encrypt data - - - - - Encrypted Envelope Key to Encrypt data - - - - - Initialization Vector for encryption - - - - - A canned access control list (ACL) to apply to the object. - Please refer to for information on S3 Canned ACLs. - - - - - The name of the bucketName where the new object will be created, or existing object updated. - - - - - The key of the object to create or update. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - StorageClass property for the object. - - - Default: S3StorageClass.Standard. Set this property - only if you want reduced redundancy for this object. - Please refer to - for - information on S3 Storage Classes. - - - - - If the bucketName is configured as a website, redirects requests for this object to another object in the same bucketName or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - This is a convenience property for Headers.ContentType. - - - - - - Specifies the encryption to be used on the server for the new object. - - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - Checks if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - true if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - Specifies whether you want to apply a Legal Hold to the uploaded object. - - - - - - Gets and sets the property ObjectLockMode. - - Specifies the Object Lock mode that you want to apply to the uploaded object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - Specifies the date and time when you want the Object Lock to expire. - - - - - - The tag-set for the object. The tag-set must be encoded as URL Query parameters. - - - - - Checks if Tagging property is set - - true if Tagging is set. - - - - Returns information about the InitiateMultipartUpload response and response metadata. - - - - - Name of the bucketName to which the multipart upload was initiated. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Object key for which the multipart upload was initiated. - - - - - - Gets and sets the initiated multipart upload id. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - Date when multipart upload will become eligible for abort operation by lifecycle. - - - - - Id of the lifecycle rule that makes a multipart upload eligible for abort operation. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Identifies who initiated the multipart upload. - - - - - Name of the Principal. - - - - - - If the principal is an AWS account, it provides the Canonical User ID. If the principal is an IAM User, it provides a user ARN value. - - - - - - Describes the serialization format of the object. - - - - - Describes the serialization of a CSV-encoded object. - - - - - Specifies object's compression format. Valid values: NONE, GZIP. Default Value: NONE. - - - - - Specifies JSON as object's input serialization format. - - - - - Specifies Parquet as object's input serialization format. - - - - - Class for MetricsConfiguration - - - - - Contains information about where to publish the inventory results. - - - - - Specifies whether the inventory is enabled or disabled. - - - - - Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria. - - - - - The ID used to identify the inventory configuration. - - - - - Specifies which object version(s) to included in the inventory results. - - - - - Contains the optional fields that are included in the inventory results. - - - - - Specifies the schedule for generating inventory results. - - - - - Class for InventoryDestination - - - - - Contains the bucket name, file format, bucket owner (optional), and prefix (optional) where inventory results are published. - - - - - InventoryEncryption class - - - - - Specifies the use of SSE-S3 to encrypt delievered Inventory reports. - - - - - Specifies the use of SSE-KMS to encrypt delievered Inventory reports. - - - - - Class for InventoryFilter - - - - - Filter Predicate setup for specific filter types. - - - - - Filter Predicate abstract class for specific filter types to be derived from. - - - - - Class for InventoryPrefixPredicate - The prefix that an object must have to be included in the inventory results. - - - - - The ID of the account that owns the destination bucket. - - - - - The Amazon resource name (ARN) of the bucket where inventory results will be published. - - - - - The prefix that is prepended to all inventory results. - - - - - Specifies the output format of the inventory results. - - - - - Contains the type of server-side encryption used to encrypt the inventory results. - - - - - Class for InventorySchedule - - - - - Specifies how frequently inventory results are produced. - - - - - Specifies JSON as object's input serialization format. - - - - - The type of JSON. Valid values: Document, Lines. - - - - - Specifies JSON as request's output serialization format - - - - - The value used to separate individual records in the output. - - - - - Specifies an object key and optional object version. - - - - - Key name of the object to delete. - - - - - - VersionId for the specific version of the object to delete. - - - - - - This class contains the configuration Amazon S3 uses to figure out what events you want to listen - and send the event to an Amazon Lambda cloud function. - - - - - Gets and set the Id property. The Id will be provided in the event content and can be used - to identify which configuration caused an event to fire. If the Id is not provided for the configuration, one will be generated. - - - - - Gets and sets the FunctionArn property. This is the Amazon Lambda cloud function to which Amazon S3 will invoke with the events. - - - - Lifecycle Configuration - - - - - Gets and sets the Rules property. These rules defined the lifecycle configuration. - - - - - Base class for all the different predicates that can be used - in a filter. - - - - - This method is called by the visitor when it wants to visit the predicate. - - - - - - Filter identifying one or more objects to which a applies. - - - - - The predicate used by the filter. - - - - - Base class for lifecycle operators. - - - - - The list of objects - that this operator operates on. - - - - - The logical and operator for filtering objects for a - - - - - Accept a visit from an - - - This method is used internally by the SDK. - - - - - - A predicate that filters objects for a - by matching a particular prefix. - - - - - The prefix to be matched by filtered objects. - - - - - Accept a visit from an - - - This method is used internally by the SDK. - - - - - - A predicate that filters objects for a - by matching a particular key and value. - - - - - The Tag to be matched by filtered objects. - - - - - Accept a visit from an - - - This method is used internally by the SDK. - - - - - - Rules Item - - - - - Defines the length of time, in days, before objects expire. - - - - - Unique identifier for the rule. The value cannot be longer than 255 characters. - - - - - Prefix identifying one or more objects to which the rule applies. - - - - - - Filter identifying one or more objects to which the rule applies. - - - - - If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied. - - - - - - The transition rule that describes when objects transition to a different storage class. - - Lifecycle rules can now contain multiple transitions. This property is obsolete in favor of the Transitions property. - This property will always get or set the the zeroth element in the Transitions collection. - - - - - - Defines the length of time, in days, before noncurrent versions expire. - - - - - The transition rule that describes when noncurrent versions transition to - a different storage class. - - Lifecycle rules can now contain multiple noncurrent version transitions. This property - is obsolete in favor of the NoncurrentVersionTransitions property. - This property will always get or set the the zeroth element in the NoncurrentVersionTransitions collection. - - - - - - The transition rules that describe when objects transition to a different storage class. - - - - - The transition rules that describe when noncurrent versions transition to - a different storage class. - - - - - Specifies the days since the initiation of an Incomplete Multipart Upload - that Lifecycle will wait before permanently removing all parts of the upload. - - - - - Specifies the days since the initiation of an Incomplete Multipart Upload - that Lifecycle will wait before permanently removing all parts of the upload. - - - - - Indicates the number of days that must pass since initiation for Lifecycle - to abort an Incomplete Multipart Upload. - - - - Expiration - - - - - Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format. - - - - - - Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer. - - - - - - Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set to true, the delete marker will be expired; if set to false the policy takes no action. This cannot be specified with Days or Date in a Lifecycle Expiration Policy. - - - - - - Noncurrent Version Expiration - - - - - Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated - action. For information about the noncurrent days calculations, see - How Amazon S3 Calculates When an Object Became Noncurrent - in the Amazon Simple Storage Service Developer Guide. - - - - - LifecycleTransition defines when and how objects transition. - - - - - Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated - action. For information about the noncurrent days calculations, see - How Amazon S3 Calculates When an Object Became Noncurrent - in the Amazon Simple Storage Service Developer Guide. - - - - - The class of storage used to store the object. - - - - - - LifecycleTransition defines when and how objects transition. - - - - - Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format. - - - - - - Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer. - - - - - - The class of storage used to store the object. - - - - - - Container for the parameters to the ListInventoryConfigurationsRequest operation. - Lists the analytics configurations for the bucket. - - - - - The name of the bucket containing the analytics configurations to retrieve. - - - - - The ContinuationToken that represents a placeholder from where this request should begin. - - - - - Returns information about the ListBucketAnalyticsConfigurationsResponse response and response metadata. - - - - - The ContinuationToken that represents where this request began. - - - - - The list of analytics configurations for a bucket. - - - - - Indicates whether the returned list of analytics configurations is complete. - A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request. - - - - - NextContinuationToken is sent when isTruncated is true, which indicates that there are more analytics configurations to list. - The next request must include this NextContinuationToken. The token is obfuscated and is not a usable value. - - - - - Container for the parameters to the ListInventoryConfigurationsRequest operation. - Returns a list of inventory configurations for the bucket. - - - - - The name of the bucket containing the inventory configurations to retrieve. - - - - - The marker used to continue an inventory configuration listing that has been truncated. - Use the NextContinuationToken from a previously truncated list response to continue the listing. - The continuation token is an opaque value that Amazon S3 understands. - - - - - Returns information about the ListInventoryConfigurationsResponse response and response metadata. - - - - - If sent in the request, the marker that is used as a starting point for this inventory configuration list response. - - - - - The list of inventory configurations for a bucket. - - - - - Indicates whether the returned list of inventory configurations is truncated in this response. A value of true indicates that the list is truncated. - - - - - The marker used to continue this inventory configuration listing. Use the NextContinuationToken from this response to continue the listing in a subsequent request. - The continuation token is an opaque value that Amazon S3 understands. - - - - - Container for the parameters to the ListBucketMetricsConfigurationRequest operation. - Lists the metrics configurations for the bucket. - - - - - The name of the bucket containing the metrics configurations to retrieve. - - - - - - The marker that is used to continue a metrics configuration listing that has been truncated. - Use the NextContinuationToken from a previously truncated list response to continue the listing. - The continuation token is an opaque value that Amazon S3 understands. - - - - - - Returns information about the ListBucketMetricsConfiguration response and response metadata. - - - - - - The marker that is used to continue a metrics configuration listing that has been truncated. - Use the NextContinuationToken from a previously truncated list response to continue the listing. - The continuation token is an opaque value that Amazon S3 understands. - - - - - - The list of metrics configurations for a bucket. - - - - - - Indicates whether the returned list of metrics configurations is complete. - A value of true indicates that the list is not complete and the NextContinuationToken will be provided for - a subsequent request. - - - - - - - The marker used to continue a metrics configuration listing that has been truncated. - Use the NextContinuationToken from a previously truncated list response to continue the listing. - The continuation token is an opaque value that Amazon S3 understands. - - - - - - Container for the parameters to the ListBuckets operation. - Returns a list of all buckets owned by the authenticated sender of the request. - - - - - Returns information about the ListBuckets response and response metadata. - - - - - List of buckets. - - - - - Owner of the buckets. - - - - - Container for the parameters to the ListMultipartUploads operation. - This operation lists in-progress multipart uploads. - - - - - Name of the bucket to which the multipart upload was initiated. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Character you use to group keys. - - - - - - Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin. - - - - - - Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response body. 1,000 is the maximum number of uploads that - can be returned in a response. - - - - - - Lists in-progress uploads only for those keys that begin with the specified prefix. - - - - - - Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the - upload-id-marker parameter is ignored. - - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - Returns information about the ListMultipartUploads response and response metadata. - - - - - Name of the bucketName to which the multipart upload was initiated. - - - - - - The key at or after which the listing began. - - - - - - Upload ID after which listing began. - - - - - - When a list is truncated, this element specifies the value that should be used for the key-marker request parameter in a subsequent request. - - - - - - When a list is truncated, this element specifies the value that should be used for the upload-id-marker request parameter in a subsequent - request. - - - - - - Maximum number of multipart uploads that could have been included in the response. - - - - - - Indicates whether the returned list of multipart uploads is truncated. A value of true indicates that the list was truncated. The list can - be truncated if the number of multipart uploads exceeds the limit allowed or specified by max uploads. - - - - - - Gets and sets the MultipartUploads property. - - Container for elements related to a particular multipart upload. A response - can contain zero or more Upload elements. - - - - - - Gets and sets the Prefix property. - - - - - Gets and sets the Delimiter property. - - - - - Gets the CommonPrefixes property. - A response can contain CommonPrefixes only if you specify a delimiter. - When you do, CommonPrefixes contains all (if there are any) keys between - Prefix and the next occurrence of the string specified by delimiter. In effect, - CommonPrefixes lists keys that act like subdirectories in the directory specified - by Prefix. For example, if prefix is notes/ and delimiter is a slash (/), in - notes/summer/july, the common prefix is notes/summer/. - - - - - Container for the parameters to the ListObjects operation. - Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a - subset of the objects in a bucket. - - - - - The name of the bucket containing the objects whose keys are to be listed. - - - - - A delimiter is a character you use to group keys. - - - - - Specifies the key to start with when listing objects in a bucket. - - - - - Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more. - - - - - Limits the response to keys that begin with the specified prefix. - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the ListObjects response and response metadata. - - - - - A flag that indicates whether or not Amazon S3 returned all of the results that satisfied - the search criteria. - - - - - Gets and sets the NextMarker property. - NextMarker is set by S3 only if a Delimiter was specified - in the original ListObjects request. If a delimiter was - not specified, the AWS SDK for .NET returns the last Key - of the List of Objects retrieved from S3 as the NextMarker. - - - - - Gets the S3Objects property. This is a list of - objects in the bucket that match your search criteria. - - - - - Gets and sets the Name property which is the name of the bucket. - - - - - Gets and sets the Prefix property. - - - - - Gets and sets the MaxKeys property. This is max number of object keys returned by the list operation. - - - - - Gets the CommonPrefixes property. - A response can contain CommonPrefixes only if you specify a delimiter. - When you do, CommonPrefixes contains all (if there are any) keys between - Prefix and the next occurrence of the string specified by delimiter. In effect, - CommonPrefixes lists keys that act like subdirectories in the directory specified - by Prefix. For example, if prefix is notes/ and delimiter is a slash (/), in - notes/summer/july, the common prefix is notes/summer/. - - - - - Gets and sets the Delimiter property. - Causes keys that contain the same string between the prefix and the - first occurrence of the delimiter to be rolled up into a single result - element in the CommonPrefixes collection. - - - These rolled-up keys are not returned elsewhere in the response. - - - - - Container for the parameters to the ListObjects operation. - Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a - subset of the objects in a bucket. - - - - - Bucket name to list. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - A delimiter is a character you use to group keys. - - - - - Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more. - - - - - Limits the response to keys that begin with the specified prefix. - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts - listing after this specified key. StartAfter can be any key in the bucket. - Cannot be set at the same time as ContinuationToken. - - - - - ContinuationToken indicates Amazon S3 that the list is being continued on this - bucket with a token. ContinuationToken is obfuscated and is not a real key. - - - - - The owner field is not present in ListObjectsV2 responses by default. - If you want to return owner field with each key in the result then set this field to true. - If not specified, the Owner field on S3Object will be null. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the ListObjects response and response metadata. - - - - - A flag that indicates whether or not Amazon S3 returned all of the results that satisfied - the search criteria. - - - - - Gets and sets the S3Objects property. Metadata about each object returned. - - - - - Bucket name. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the Prefix property. - - - - - Gets and sets the MaxKeys property. This is max number of object keys returned by the list operation. - - - - - Gets and sets the CommonPrefixes property. - CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence - of the string specified by delimiter - - - - - Gets and sets the Delimiter property. - Causes keys that contain the same string between the prefix and the - first occurrence of the delimiter to be rolled up into a single result - element in the CommonPrefixes collection. - - - These rolled-up keys are not returned elsewhere in the response. - - - - - Encoding type used by Amazon S3 to encode object keys in the response. - - - - - KeyCount is the number of keys returned with this request. - KeyCount will always be less than or equal to MaxKeys field. - - - - - ContinuationToken indicates Amazon S3 that the list is being continued - on this bucket with a token. - ContinuationToken is obfuscated and is not a real key - - - - - NextContinuationToken is sent when isTruncated is true which means there - are more keys in the bucket that can be listed. The next ListObjectV2 call - to Amazon S3 can be continued with this NextContinuationToken. - NextContinuationToken is obfuscated and is not a real key. - - - - - StartAfter is where you want Amazon S3 to start listing from. - Amazon S3 starts listing after this specified key. - StartAfter can be any key in the bucket. - - - - - Container for the parameters to the ListParts operation. - Lists the parts that have been uploaded for a specific multipart upload. - - - - - Name of the bucket to which the parts are being uploaded. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The object key for which the multipart upload was initiated. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Sets the maximum number of parts to return. - - - - - - Specifies the part after which listing should begin. Only parts with higher part numbers will be listed. - - - - - - Upload ID identifying the multipart upload whose parts are being listed. - - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the ListParts response and response metadata. - - - - - Name of the bucketName to which the multipart upload was initiated. - - - - - - Object key for which the multipart upload was initiated. - - - - - - Upload ID identifying the multipart upload whose parts are being listed. - - - - - - Part number after which listing begins. - - - - - - When a list is truncated, this element specifies the last part in the list, as well as the value to use for the part-number-marker request - parameter in a subsequent request. - - - - - - Maximum number of parts that were allowed in the response. - - - - - - Indicates whether the returned list of parts is truncated. - - - - - - Gets and sets the Parts property. - - PartDetails is a container for elements related to a particular part. A response can contain - zero or more Part elements. - - - - - - Identifies who initiated the multipart upload. - - - - - - Gets and sets the Owner property. - - - - - The class of storage used to store the object. - - - - - - Date when multipart upload will become eligible for abort operation by lifecycle. - - - - - Id of the lifecycle rule that makes a multipart upload eligible for abort operation. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the ListVersions operation. - Returns metadata about all of the versions of objects in a bucket. - - - - - The bucket name that contains the objects. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - A delimiter is a character you use to group keys. - - - - - Specifies the key to start with when listing objects in a bucket. - - - - - Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more. - - - - - Limits the response to keys that begin with the specified prefix. - - - - - Specifies the object version you want to start listing from. - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - Returns information about the ListVersions response and response metadata. - - - - - A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria. If your results were - truncated, you can make a follow-up paginated request using the NextKeyMarker and NextVersionIdMarker response parameters as a starting - place in another request to return the rest of the results. - - - - - - Marks the last Key returned in a truncated response. - - - - - - Gets and sets the VersionIdMarker property. - Marks the last Version-Id returned in a truncated response. - - - - - Use this value for the key marker request parameter in a subsequent request. - - - - - - Use this value for the next version id marker parameter in a subsequent request. - - - - - - Gets and sets the Versions property. This is a list of - object versions in the bucket that match your search criteria. - - - - - Gets and sets the Name property. - The bucket's name. - - - - - Gets and sets the Prefix property. - Keys that begin with the indicated prefix are listed. - - - - - Gets and sets the MaxKeys property. - This is the maximum number of keys in the S3ObjectVersions collection. - The value is derived from the MaxKeys parameter to ListVersionsRequest. - - - - - Gets the CommonPrefixes property. - A response can contain CommonPrefixes only if you specify a delimiter. - When you do, CommonPrefixes contains all (if there are any) keys between - Prefix and the next occurrence of the string specified by delimiter. - - - - - Gets and sets the Delimiter property. - Causes keys that contain the same string between the prefix and the - first occurrence of the delimiter to be rolled up into a single result - element in the CommonPrefixes collection. - - - These rolled-up keys are not returned elsewhere in the response. - - - - - This class contains the meta data for an S3 object. - - - - - Gets and sets meta data for the object. Meta data names must start with "x-amz-meta-". If the name passeed in as the indexer - doesn't start with "x-amz-meta-" then it will be prepended. - - The name of the meta data. - The value for the meta data - - - - Adds the metadata to the collection, if the name already exists it will be overwritten. - - The name of the metadata element - The value for the metadata - - - - Gets the count of headers. - - - - - Gets the names of the meta data elements. - - - - - A metadata key-value pair to store with an object. - - - - - Key of metadata key-value pair - - - - - Value of metadata key-value pair - - - - - A container specifying replication metrics-related information, including whether - emitting metrics and Amazon S3 events for replication are enabled. In addition, contains - configurations related to specific metrics or events. Must be specified together with a - ReplicationTime block. - - - - - Specifies whether the replication metrics are enabled. - - - - - A container specifying the time threshold for emitting the - s3:Replication:OperationMissedThreshold event. - - - - - Class for MetricsAndOperatorPredicate - A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. - The operator must have at least two predicates, and an object must match all of the predicates - in order for the filter to apply. - - Note: The current implementation restricts the usage to atmost one MetricsPrefixPredicate - and any number of MetricsTagPredicates. - - - - Class for MetricsConfiguration - - - - - The ID used to identify the metrics configuration. - - - - - Specifies a metrics configuration filter. - The metrics configuration will only include objects that meet the filter's criteria. - A filter must be a prefix, a tag, or a conjunction (MetricsAndOperator). - - - - - Filter class for Metrics. - - - - - Filter Predicate setup for specific filter types. - - - - - Filter Predicate abstract class for specific filter types to be derived from. - - - - - Abstract class that can be used over logical filter predicates,i.e. AND/OR. - - - - - Class for MetricsPrefixPredicate - The prefix used when evaluating a metrics filter. - - - - - Class for MetricsTagPredicate - The tag used when evaluating a metrics filter. - - - - - This class contains the mfa codes used authentication - - - - - Gets and sets the serial number of the authentication device - - - - - Gets and sets the displated value on the authentication device - - - - - The formatted string of the mfa codes to be passed to S3. - - - - - Container for elements related to a particular multipart upload. - - - - - Date and time at which the multipart upload was initiated. - - - - - - Identifies who initiated the multipart upload. - - - - - - Key of the object for which the multipart upload was initiated. - - - - - - Gets and sets the Owner property. - - - - - The class of storage used to store the object. - - - - - - Upload ID that identifies the multipart upload. - - - - - - An abstract class for all the notification configurations associated with an Amazon S3 bucket. - - - - - Gets and sets the Events property. These are the events the configuration will listen to. - - - - - Filter criteria for determining which S3 objects trigger event notifications. - - - - - - The container element for Object Lock configuration parameters. - - - - - Gets and sets the property ObjectLockEnabled. - - Indicates whether this object has an Object Lock configuration enabled. - - - - - - Gets and sets the property Rule. - - The Object Lock rule in place for the specified object. - - - - - - A Legal Hold configuration for an object. - - - - - Gets and sets the property Status. - - Indicates whether the specified object has a Legal Hold in place. - - - - - - A Retention configuration for an object. - - - - - Gets and sets the property Mode. - - Indicates the Retention mode for the specified object. - - - - - - Gets and sets the property RetainUntilDate. - - - - - The container element for an Object Lock rule. - - - - - Gets and sets the property DefaultRetention. - - The default retention period that you want to apply to new objects placed in the specified - bucket. - - - - - - Describes the location where the restore job's output is stored. - - - - - Describes an S3 location that will receive the results of the restore request. - - - - - Describes how results of the Select job are serialized. - - - - - Describes the serialization of CSV-encoded Select results. - - - - - Specifies JSON as request's output serialization format. - - - - - The owner of an S3 bucket. - - - - - The display name of the owner. - - - - - The unique identifier of the owner. - - - - - This class contains custom querystring parameters for an S3 object, which can then be signed as part of a Pre-signed URL request - - - - - Gets and sets parameters for the object. Parameter names must start with "x-". If the name passeed in as the indexer - doesn't start with "x-" then it will be prepended. - - The name of the parameter. - The value for the meta data - - - - Adds the parameter to the collection, if the name already exists it will be overwritten. - - The name of the parameter - The value for the parameter - - - - Gets the count of parameters. - - - - - Gets the names of the parameter elements. - - - - - Specifies Parquet as object's input serialization format. - - - - - A container for elements related to a particular part in a multipart operation. - A response can contain zero or more Part elements. - - - - - The date and time at which the part was uploaded. - - - - - The size of the uploaded part data. - - - - - A container holding the part number and etag used when completing a multipart upload. - - - - - Default constructor. - - - - - Constructs an instance of PartETag and sets the part number and etag. - - The part number. - the associated ETag for the part number. - - - - Compares the current object with another object of the same type. - - An object to compare with this object. - - A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has the following meanings: - Value - Meaning - Less than zero - This object is less than the parameter. - Zero - This object is equal to . - Greater than zero - This object is greater than . - - - - - The part number identifying the part. - - - - - The entity tag associated with the part. - - - - - The container element for this bucket's public-policy status. - - - - - Gets and sets the property IsPublic. - - The public-policy status for this bucket. TRUE indicates that this bucket - is public. FALSE indicates that the bucket is not public. - - - - - - The container element for all Public Access Block configuration options. You can enable - the configuration options in any combination. - - - - Amazon S3 considers a bucket policy public unless at least one of the following conditions - is true: - -
  1. - - The policy limits access to a set of CIDRs using aws:SourceIp. For more - information on CIDR, see http://www.rfc-editor.org/rfc/rfc4632.txt - - -
  2. - - The policy grants permissions, not including any "bad actions," to one of the following: - -
    • - - A fixed AWS principal, user, role, or service principal - -
    • - - A fixed aws:SourceArn - -
    • - - A fixed aws:SourceVpc - -
    • - - A fixed aws:SourceVpce - -
    • - - A fixed aws:SourceOwner - -
    • - - A fixed aws:SourceAccount - -
    • - - A fixed value of s3:x-amz-server-side-encryption-aws-kms-key-id - -
    • - - A fixed value of aws:userid outside the pattern "AROLEID:*" - -
- - "Bad actions" are those that could expose the data inside a bucket to reads or writes - by the public. These actions are s3:Get*, s3:List*, s3:AbortMultipartUpload, - s3:Delete*, s3:Put*, and s3:RestoreObject. - - - - The star notation for bad actions indicates that all matching operations are considered - bad actions. For example, because s3:Get* is a bad action, s3:GetObject, - s3:GetObjectVersion, and s3:GetObjectAcl are all bad actions. - - - - - - Gets and sets the property BlockPublicAcls. - - Specifies whether Amazon S3 should block public ACLs for this bucket. Setting this - element to TRUE causes the following behavior: - -
  • - - PUT Bucket acl and PUT Object acl calls will fail if the specified ACL allows public - access. - -
  • - - PUT Object calls will fail if the request includes an object ACL. - -
- - Note that enabling this setting doesn't affect existing policies or ACLs. - - - - - - Gets and sets the property IgnorePublicAcls. - - Specifies whether Amazon S3 should ignore public ACLs for this bucket. Setting this - element to TRUE causes Amazon S3 to ignore all public ACLs on this bucket - and any objects that it contains. - - - - Note that enabling this setting doesn't affect the persistence of any existing ACLs - and doesn't prevent new public ACLs from being set. - - - - - - Gets and sets the property BlockPublicPolicy. - - Specifies whether Amazon S3 should block public bucket policies for this bucket. Setting - this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy - if the specified bucket policy allows public access. - - - - Note that enabling this setting doesn't affect existing bucket policies. - - - - - - Gets and sets the property RestrictPublicBuckets. - - Specifies whether Amazon S3 should restrict public bucket policies for this bucket. - If this element is set to TRUE, then only the bucket owner and AWS Services - can access this bucket if it has a public policy. - - - - Note that enabling this setting doesn't affect previously stored bucket policies, - except that public and cross-account access within any public bucket policy, including - non-public delegation to specific accounts, is blocked. - - - - - - Container for the parameters to the PutAcl operation. - uses the acl subresource to set the access control list (ACL) permissions for an object that already exists in a bucket - - - - - The canned ACL to apply to the bucket. - - - - - - Custom ACLs to be applied to the bucket or object. - - - - - The bucket name that contains the object to which you want to attach the ACL. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The key of an S3 object. - If not specified, the ACLs are applied to the bucket. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - If set and an object key has been specified, the ACLs are applied - to the specific version of the object. - This property is ignored if the ACL is to be set on a Bucket. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - Returns information about the PutObjectAcl response metadata. - The PutAcl operation has a void result type. - - - - - The response for the PutBucketAccelerateConfiguration operation. - Adds an object to a bucket. - - - - - Container for the parameters to the PutBucketAccelerateConfiguration request. - - - - - The name of the bucket to contain the object. - - - - - Accelerate configuration for the bucket. - - - - - Container for the parameters to the PutBucketAnalyticsConfiguration operation. - Sets an analytics configuration for the bucket (specified by the analytics configuration ID). - - - - - The name of the bucket to which an analytics configuration is stored. - - - - - The identifier used to represent an analytics configuration. - - - - - The configuration and any analyses for the analytics filter. - - - - - Returns information about the PutBucketAnalyticsConfigurationResponse response metadata. - The PutBucketAnalyticsConfigurationResponse operation has a void result type. - - - - - Container for the parameters to the PutBucketRequestPayment operation. - Creates a new server-side encryption configuration (or replaces an existing one, if present). - - - - - The name of the bucket for which the server-side encryption configuration is set. - - - - - The base64-encoded 128-bit MD5 digest of the server-side encryption configuration. - - - This header can be used as a message integrity check to verify that the data is the same data that was originally sent. - Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. - - - - - Container for server-side encryption configuration rules. Currently S3 supports one rule only. - - - - - Container for the parameters to the PutBucketRequestPayment operation. - Adds an inventory configuration (identified by the inventory ID) from the bucket. - - - - - The name of the bucket where the inventory configuration will be stored. - - - - - Specifies the inventory Id. - - - - - Specifies the inventory configuration. - - - - - Returns information about the PutInventoryConfigurationResponse response metadata. - The PutInventoryConfigurationResponse operation has a void result type. - - - - - Container for the parameters to the PutBucketLoggingRequest operation. - Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. To set the - logging status of a bucket, you must be the bucket owner. - - - - - Gets and sets the BucketName property. - - - - - Gets and sets the LoggingConfig property. - - - - - Returns information about the PutBucketLogging response metadata. - The EnableBucketLogging operation has a void result type. - - - - - Container for the parameters to the PutBucketMetricsConfigurationRequest operation. - Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. - - - - - The name of the bucket for which the metrics configuration is set. - - - - - The ID used to identify the metrics configuration. - - - - - Specifies the metrics configuration. - - - - - Returns information about the PutBucketMetricsConfiguration response metadata. - The PutBucketMetricsConfiguration operation has a void result type. - - - - - Container for the parameters to the PutBucketNotification operation. - Enables notifications of specified events for a bucket. - - - - - Gets and sets the BucketName property. - - - - - Gets and sets the TopicConfigurations property. TopicConfigurations are configuration for Amazon S3 - events to be sent to Amazon SNS topics. - - - - - Gets and sets the QueueConfigurations property. QueueConfigurations are configuration for Amazon S3 - events to be sent to Amazon SQS queues. - - - - - Gets and sets the LambdaFunctionConfigurations property. LambdaFunctionConfigurations are configuration for - Amazon S3 events to be sent to an Amazon Lambda cloud function. - - - - - Returns information about the PutBucketNotification response metadata. - The PutBucketNotification operation has a void result type. - - - - - Container for the parameters to the PutBucketPolicy operation. - Replaces a policy on a bucket. If the bucket already has a policy, the one in this request completely replaces it. - - - - - The name of the bucket. - - - - - The base64 encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. - - - This header can be used as a message integrity check to verify that the data is the same data that was originally sent. - Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. - - - - - The bucket policy as a JSON document. - - - - - Set this parameter to true to confirm that you want to remove your - permissions to change this bucket policy in the future. - - - - - Overriden to turn off sending SHA256 header. - - - - - Returns information about the PutBucketPolicy response metadata. - The PutBucketPolicy operation has a void result type. - - - - - Container for the parameters to the PutBucketReplication operation. - Sets replication configuration for your bucket. If a replication configuration exists, this replaces it. - - - - - The name of the bucket to have the replication configuration applied. - - - - - The replication configuration to be applied. - - - - - Gets and sets the property Token. - - - - - Returns information about the PutBucketReplicationConfiguration response metadata. - The PutBucketReplicationConfiguration operation has a void result type. - - - - - Container for the parameters to the PutBucket operation. - Creates a new bucket. - - - - - The canned ACL to apply to the bucket. - - - - - - If set to true the bucket will be created in the same region - as the configuration of the AmazonS3 client. - If PutBucketRequest.BucketRegion or PutBucketRequest.BucketRegionName are set they take precedence over - this property. - Default: true. - - - - - The name of the bucket to be created. - - - - - The region locality for the bucket. - - - When set, this will determine where your data will - reside in S3. Refer - for a list of possible values. - - - - - The bucket region locality expressed using the name of the region. - When set, this will determine where your data will reside in S3. - Valid values: us-east-1, us-west-1, us-west-2, eu-west-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, sa-east-1 - - - - - Gets and sets the property ObjectLockEnabledForBucket. - - Specifies whether you want S3 Object Lock to be enabled for the new bucket. - - - - - - Container for the parameters to the PutBucketRequestPayment operation. - Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This - configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the - download. - - - - - The name of the bucket to set payment config. - - - - - Gets and sets request payment configuration - - - - - Returns information about the PutBucketRequestPayment response metadata. - The PutBucketRequestPayment operation has a void result type. - - - - - Returns information about the PutBucket response and response metadata. - - - - - Container for the parameters to the PutBucketTagging operation. - Sets the tags for a bucket. - - - - - The name of the bucket to apply the tags to. - - - - - The collection of tags. - - - - - Returns information about the PutBucketTagging response metadata. - The PutBucketTagging operation has a void result type. - - - - - Container for the parameters to the PutBucketVersioning operation. - Sets the versioning state of an existing bucket. To set the versioning state, you must be the bucket owner. - - - - - The name of the bucket to be updated. - - - - - The MfaCodes Tuple associates the Serial Number and the current Token/Code displayed on the - Multi-Factor Authentication device associated with your AWS Account. - - - This is a required property for this request if:
- 1. EnableMfaDelete was configured on the bucket - containing this object's version.
- 2. You are deleting an object's version - - - - - Checks if the MfaCodes property is set. - - true if the MfaCodes property is set. - - - - The versioning configuration to apply to the bucket. - - - Once Versioning has been "Enabled" on a bucket, it can be "Suspended" - but cannot be switched "Off". If EnableMfaDelete is set, - the MfaCodes property needs to contain the Serial of and current Token - displayed on the MFA device. - - - - - Returns information about the PutBucketVersioning response metadata. - The PutBucketVersioning operation has a void result type. - - - - - Container for the parameters to the PutBucketWebsite operation. - Set the website configuration for a bucket. - - - - - The name of the bucket to apply the configuration to. - - - - - The website configuration to apply. The configuration defines the index - document suffix and custom error page. - - - - - Returns information about the PutBucketWebsite response metadata. - The PutBucketWebsite operation has a void result type. - - - - - Container for the parameters to the PutCORSConfiguration operation. - Sets the cors configuration for a bucket. - - - - - The name of the bucket to have the CORS configuration applied. - - - - - The CORS configuration to apply. - - - - - Returns information about the PutCORSConfiguration response metadata. - The PutCORSConfiguration operation has a void result type. - - - - - Container for the parameters to the PutLifecycleConfiguration operation. - Sets lifecycle configuration for your bucket. If a lifecycle configuration exists, it replaces it. - - - - - The name of the bucket to have the lifecycle configuration applied. - - - - - The lifecycle configuration to be applied. - - - - - Returns information about the PutLifecycleConfiguration response metadata. - The PutLifecycleConfiguration operation has a void result type. - - - - - Container for the parameters to the PutObjectLegalHold operation. - Applies a Legal Hold configuration to the specified object. - - - - - The bucket name containing the object that you want to place a Legal Hold on. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property ContentMD5. - - The MD5 signature for the configuration included in your request. - - - - - - Gets and sets the property Key. - - The key name for the object that you want to place a Legal Hold on. - - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Gets and sets the property LegalHold. - - Container element for the Legal Hold configuration you want to apply to the specified - object. - - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property VersionId. - - The version ID of the object that you want to place a Legal Hold on. - - - - - - This is the response object from the PutObjectLegalHold operation. - - - - - Gets and sets the property RequestCharged. - - - - - Container for the parameters to the PutObjectLockConfiguration operation. - Places an Object Lock configuration on the specified bucket. The rule specified in - the Object Lock configuration will be applied by default to every new object placed - in the specified bucket. - - - - - Gets and sets the property BucketName. - - The bucket whose Object Lock configuration you want to create or replace. - - - - - - Gets and sets the property ContentMD5. - - The MD5 signature for the configuration included in your request. - - - - - - Gets and sets the property ObjectLockConfiguration. - - The Object Lock configuration that you want to apply to the specified bucket. - - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property Token. - - - - - This is the response object from the PutObjectLockConfiguration operation. - - - - - Gets and sets the property RequestCharged. - - - - - Container for the parameters to the PutObject operation. - Adds an object to a bucket. - - - Container for the parameters to the PutObject operation. - Adds an object to a bucket. - - - - - A canned access control list (CACL) to apply to the object. - Please refer to for - information on S3 Canned ACLs. - - - - - Input stream for the request; content for the request will be read from the stream. - - - - - - The full path and name to a file to be uploaded. - If this is set the request will upload the specified file to S3. - - - For WinRT and Windows Phone this property must be in the form of "ms-appdata:///local/file.txt". - - - - - - Text content to be uploaded. Use this property if you want to upload plaintext to S3. - The content type will be set to 'text/plain'. - - - - - If this value is set to true then the stream used with this request will be closed when all the content - is read from the stream. - Default: true. - - - - - If this value is set to true then the stream will be seeked back to the start before being read for upload. - Default: true. - - - - - If this value is set to true then a chunked encoding upload will be used for the request. - Default: true. - - - - - Bucket name to which the PUT operation was initiated. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - Gets and sets Key property. This key is used to identify the object in S3. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - Checks if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - true if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - - - The type of storage to use for the object. Defaults to 'STANDARD'. - - - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - The Legal Hold status that you want to apply to the specified object. - - - - - - Gets and sets the property ObjectLockMode. - - The Object Lock mode that you want to apply to this object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - The date and time when you want this object's Object Lock to expire. - - - - - - If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - Attach a callback that will be called as data is being sent to the AWS Service. - - - - - This is a convenience property for Headers.ContentType. - - - - - An MD5 digest for the content. - - - - The base64 encoded 128-bit MD5 digest of the message - (without the headers) according to RFC 1864. This header - can be used as a message integrity check to verify that - the data is the same data that was originally sent. - - - If supplied, after the file has been uploaded to S3, - S3 checks to ensure that the MD5 hash of the uploaded file - matches the hash supplied. - - - Although it is optional, we recommend using the - Content-MD5 mechanism as an end-to-end integrity check. - - - - - - Checks if MD5Digest property is set. - - true if MD5Digest property is set. - - - - Overriden to turn off sending SHA256 header. - - - - - Overriden to turn on expect 100 continue. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - The tag-set for the object. The tag-set must be encoded as URL Query parameters. - - - - - Checks if Tagging property is set - - true if Tagging is set. - - - - Returns information about the PutObject response and response metadata. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - Entity tag for the uploaded object. - - - - - - Version of the object. - - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the PutObjectRetention operation. - Places an Object Retention configuration on an object. - - - - - The bucket name that contains the object you want to apply this Object Retention configuration to. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property BypassGovernanceRetention. - - - - - Gets and sets the property ContentMD5. - - The MD5 signature for the configuration included in your request. - - - - - - Gets and sets the property Key. - - The key name for the object that you want to apply this Object Retention configuration - to. - - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property Retention. - - The container element for the Object Retention configuration. - - - - - - Gets and sets the property VersionId. - - The version ID for the object that you want to apply this Object Retention configuration - to. - - - - - - This is the response object from the PutObjectRetention operation. - - - - - Gets and sets the property RequestCharged. - - - - - Container for the parameters to the PutObjectTagging operation. - - - - - The bucket name containing the object. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Check to see if Bucket property is set - - - - - Gets and sets Key property. This key is used to identify the object in S3. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Check to see if Key property is set - - - - - The tag-set for the object. The tag-set must be encoded as URL Query parameters - - - - - Checks if Tagging property is set. - - - - - VersionId used to reference a specific version of the object. - - - - - - Returns information about the PutObjectTagging response and response metadata. - - - - - Version of the object. - - - - - Container for the parameters to the PutPublicAccessBlock operation. - Creates or modifies the Public Access Block configuration for an Amazon S3 bucket. - - - - - Gets and sets the property BucketName. - - The name of the Amazon S3 bucket whose Public Access Block configuration you want - to set. - - - - - - Gets and sets the property ContentMD5. - - The MD5 hash of the PutPublicBlock request body. - - - - - - Gets and sets the property PublicAccessBlockConfiguration. - - The Public Access Block configuration that you want to apply to this Amazon S3 bucket. - - - - - - This is the response object from the PutPublicAccessBlock operation. - - - - - Base class for put operations that can also put an ACL. - - - - - Gets the access control lists (ACLs) for this request. - Please refer to for information on - S3 Grants. - - - - - This class contains the configuration Amazon S3 uses to figure out what events you want to listen - and send the event to an Amazon SQS queue. - - The queue's policy must allow S3 to send messages to it. The utility method - Amazon.SQS.AmazonSQSClient.AuthorizeS3ToSendMessage(string,string) - can be used to help setup the queue policy. - - - - - - Gets and set the Id property. The Id will be provided in the event content and can be used - to identify which configuration caused an event to fire. If the Id is not provided for the configuration, one will be generated. - - - - - Gets and sets the Queue property. Amazon SQS queue to which Amazon S3 will publish a message - to report the specified events for the bucket. - - The queue's policy must allow S3 to send messages to it. The utility method - Amazon.SQS.AmazonSQSClient.AuthorizeS3ToSendMessage(string,string) - can be used to help setup the queue policy. - - - - - - This class defines the configuration for replication. - - - - - Indicates the ARN of the role to assume. - - - - - Check to see if the Role property is set. - - true if the Role property is set. - - - - Container for information about a particular replication rule. - Replication configuration must have at least one rule and can contain up to 1,000 rules. - - - - - Checks to see if the Rules property is set. - - true if the Rules property is set. - - - - Destination configuration for a replication rule. - - - - -

Amazon resource name (ARN) of the bucket where you want Amazon - S3 to store replicas of the object identified by the rule.

- If you have multiple rules in your replication configuration, all - rules must specify the same bucket as the destination. A replication - configuration can replicate objects only to one destination bucket.

- - - - - Checks to see if BucketArn property is set. - - true if BucketArn property is set. - - - - The class of storage used to store the object. - - - - - -

Account ID of the destination bucket. Currently Amazon S3 verifies this - value only if Access Control Translation is enabled.

In a cross-account - scenario, if you tell Amazon S3 to change replica ownership to the AWS account - that owns the destination bucket by adding the AccessControlTranslation - element, this is the account ID of the destination bucket owner.

- - - - -

Container for information regarding the access control for replicas.

-

Use only in a cross-account scenario, where source and destination bucket - owners are not the same, when you want to change replica ownership to the AWS - account that owns the destination bucket. If you don't add this element to the - replication configuration, the replicas are owned by same AWS account that - owns the source object.

- - - - -

Container that provides encryption-related information. You must - specify this element if the SourceSelectionCriteria is - specified.

- - - - - A container specifying the time when all objects and operations on objects are - replicated. Must be specified together with a Metrics block. - - - - - A container specifying replication metrics-related information, including whether - emitting metrics and Amazon S3 events for replication are enabled. In addition, - contains configurations related to specific metrics or events. Must be specified - together with a ReplicationTime block. - - - - - Rule that specifies the replication configuration. - - - - - Unique identifier for the rule. The value cannot be longer than 255 characters. - - - - - Checks to see if Id property is set. - - true if Id property is set. - - - -

The priority associated with the rule. If you specify multiple rules in a - replication configuration, then Amazon S3 applies rule priority in the event - there are conflicts (two or more rules identify the same object based on - filter specified). The rule with higher priority takes precedence. For - example,

  • Same object quality prefix based filter criteria - If prefixes you specified in multiple rules overlap.

  • Same - object qualify tag based filter criteria specified in multiple rules

    • -

For more information, see - - Cross-Region Replication (CRR) in the Amazon S3 Developer Guide.

- - - - - Checks to see if Priority property is set. - - true if Priority property is set. - - - - Object keyname prefix identifying one or more objects to which the - rule applies. Maximum prefix length can be up to 1,024 characters. - - - - - Checks to see if Prefix property is set. - - true if Prefix property is set. - - - - Gets and sets the property Filter. - - - - - Checks to see if Filter property is set. - - true if Filter property is set. - - - - Whether the rule is applied or ignored. - - - - - Checks to see if Status property is set. - - true if Status property is set. - - - - Container for replication destination information. - - - - - Checks to see if Destination property is set. - - true if Destination property is set. - - - -

Container that describes additional filters in identifying source objects that - you want to replicate. Currently, Amazon S3 supports only the filter that you can - specify for objects created with server-side encryption using an AWS KMS-managed - key. You can choose to enable or disable replication of these objects.

if - you want Amazon S3 to replicate objects created with server-side encryption using - AWS KMS-managed keys.

- - - - - A container that specifies information about existing object replication. - You can choose whether to enable or disable the replication of existing objects. - - - - - Checks to see if ExistingObjectReplication property is set. - - true if ExistingObjectReplication property is set. - - - - Specifies whether Amazon S3 should replicate delete makers. - - - - - Checks to see if DeleteMarkerReplication property is set. - - true if DeleteMarkerReplication property is set. - - - - - - - - Object keyname prefix that identifies subset of objects to which the rule applies. - - - - - Checks to see if Prefix property is set. - - true if Prefix property is set. - - - - All of these tags must exist in the object's tag set in order for the rule to apply. - - - - - Checks to see if Tags property is set. - - true if Tags property is set. - - - - Filter that identifies subset of objects to which the replication rule applies. - A Filter must specify exactly one Prefix, - Tag, or an And child element. - - - - - Object keyname prefix that identifies subset of objects to which the rule applies. - - - - - Checks to see if Prefix property is set. - - true if Prefix property is set. - - - -

Container for specifying a tag key and value.

-

The rule applies only to objects having the tag in its tagset.

- - - - - Checks to see if Tag property is set. - - true if Tag property is set. - - - -

Container for specifying rule filters. These filters determine the - subset of objects to which the rule applies. The element is required - only if you specify more than one filter. For example:

  • -

    You specify both a Prefix and a Tag - filters. Then you wrap these in an And tag.

    • -

  • You specify filter based on multiple tags. Then you wrap the - Tag elements in an And tag.

- - - - - Checks to see if And property is set. - - true if And property is set. - - - - A container specifying the time when all objects and operations on objects are replicated. Must be specified together with a Metrics block. - - - - - Specifies whether the replication time is enabled. - - - - - A container specifying the time by which replication should complete for all objects and operations on objects. - - - - - A container specifying the time value. - - - - - Contains an integer specifying time in minutes. - - - - - Request Payment Configuration - - - - - Specifies who pays for the download and request fees. - - - - - Container for values of the response headers that will be set on a response from a GetObject request. - These values override any headers that were set when the object was uploaded to S3. - - - - - A standard MIME type describing the format of the object data. - - - The content type for the content being uploaded. This property defaults to "binary/octet-stream". - For more information, refer to: - - - - - ContentLanguage header value. - - - - - Expiry header value. - - - - - CacheControl header value. - - - - - The ContentDisposition header value. - - - - - The ContentEncoding header value. - - - - - Container for the parameters to the RestoreObject operation. - Restores an archived copy of an object back into Amazon S3 - - - - - The bucket name or containing the object to restore. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the Key property. This key indicates the S3 object to restore. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Lifetime of the active copy in days - ** Do not use with restores that specify OutputLocation ** - - - - - VersionId used to reference a specific version of the object. - - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Glacier retrieval tier at which the restore will be processed. - ** Do not use with restores that specify OutputLocation ** - - - - - Glacier retrieval tier at which the restore will be processed. - ** Only use with restores that require OutputLocation ** - - - - - Type of restore request. - - - - - The optional description for the job. - - - - - Describes the parameters for Select job types. - - - - - Describes the location where the restore job's output is stored. - - - - - Returns information about the RestoreObject response metadata. - The RestoreObject operation has a void result type. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Indicates the path in the provided S3 output location where Select results will be restored to. - - - - Routing Rule - - - - - A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the - /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might - process the error. - - - - - - Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event of an - error, you can can specify a different error code to return. - - - - - - A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages - in the /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you - might process the error. - - - - - The HTTP error code when the redirect is applied. In the event of an error, if the error code equals this value, then the specified redirect - is applied. Required when parent element Condition is specified and sibling KeyPrefixEquals is not specified. If both are specified, then - both must be true for the redirect to be applied. - - - - - - The object key name prefix when the redirect is applied. For example, to redirect requests for ExamplePage.html, the key prefix will be - ExamplePage.html. To redirect request for all pages with the prefix docs/, the key prefix will be /docs, which identifies all objects in the - docs/ folder. Required when the parent element Condition is specified and sibling HttpErrorCodeReturnedEquals is not specified. If both - conditions are specified, both must be true for the redirect to be applied. - - - - - - Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event - of an error, you can can specify a different error code to return. - - - - - Name of the host where requests will be redirected. - - - - - - The HTTP redirect code to use on the response. Not required if one of the siblings is present. - - - - - - Protocol to use (http, https) when redirecting requests. The default is the protocol that is used in the original request. - - - - - - The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix docs/ (objects in the - docs/ folder) to documents/, you can set a condition block with KeyPrefixEquals set to docs/ and in the Redirect set ReplaceKeyPrefixWith to - /documents. Not required if one of the siblings is present. Can be present only if ReplaceKeyWith is not provided. - - - - - - The specific object key to use in the redirect request. For example, redirect request to error.html. Not required if one of the sibling is - present. Can be present only if ReplaceKeyPrefixWith is not provided. - - - - - - Represents an access control list (ACL) for S3. An AccessControlList is represented by an Owner, - and a List of Grants, where each Grant is a Grantee and a Permission. - - - - Each bucket and object in Amazon S3 has an ACL that defines its access control policy. - When a request is made, Amazon S3 authenticates the request using its standard - authentication procedure and then checks the ACL to verify the sender was granted access - to the bucket or object. If the sender is approved, the request proceeds. - Otherwise, Amazon S3 returns an error. - - - An ACL is a list of grants. A grant consists of one grantee and one permission. - ACLs only grant permissions; they do not deny them. - - - For convenience, some commonly used Access Control Lists are defined in - S3CannedACL. - - - Note: BucketName and object ACLs are completely independent; an object does not inherit the ACL - from its bucket. For example, if you create a bucket and grant write access to another user, - you will not be able to access the user's objects unless the user explicitly grants access. - This also applies if you grant anonymous write access to a bucket. Only the user "anonymous" - will be able to access objects the user created unless permission is explicitly granted to - the bucket owner. - - - Important: We highly recommend that you do not grant the anonymous group write access to your - buckets as you will have no control over the objects others can store and their associated charges. - For more information, see Grantees and Permissions - - - - - Creates a S3Grant and adds it to the list of grants. - - The grantee for the grant. - The permission for the grantee. - - - - Removes a specific permission for the given grantee. - - The grantee - The permission for the grantee to remove - - - - Removes all permissions for the given grantee. - - - - - - The owner of the bucket or object. - - - - Every bucket and object in Amazon S3 has an owner, the user that - created the bucket or object. The owner of a bucket or object cannot - be changed. However, if the object is overwritten by another user - (deleted and rewritten), the new object will have a new owner. - - - Note: Even the owner is subject to the ACL. For example, if an owner - does not have Permission.READ access to an object, the owner cannot read - that object. However, the owner of an object always has write access to the - access control policy (Permission.WriteAcp) and can change the ACL to - read the object. - - - - - - Checks if Owner property is set. - - true if Owner property is set. - - - - A collection of grants. - - - - - Checks if Grants property is set. - - true if Grants property is set. - - - Bucket - Represents an S3 bucket, contains the name of the S3 bucket and the date that the bucket was created. - - - - - Date the bucket was created. - - - - - - The name of the bucket. - - - - - Logging Enabled - - - - - Specifies the bucket where you want Amazon S3 to store server access logs. You can have your logs delivered to any bucket that you own, - including the same bucket that is being logged. You can also configure multiple buckets to deliver their logs to the same target bucket. In - this case you should choose a different TargetPrefix for each source bucket so that the delivered log files can be distinguished by key. - - - - - A collection of grants. - - - - - This element lets you specify a prefix for the keys that the log files will be stored under. - - - - - Creates a S3Grant and adds it to the list of grants. - - The grantee for the grant. - The permission for the grantee. - - - - Removes a specific permission for the given grantee. - - The grantee - The permission for the grantee to remove - - - - Removes all permissions for the given grantee. - - - - - - An S3 bucket versioning configuration. - - - Contains the bucket's versioning status (Off, Enabled, Suspended) and whether an MFADelete - has been enabled for the bucket. - - - - - Versioning status for the bucket. - Accepted values: Off, Enabled, Suspended. - - - - - Checks if Status property is set - - true if Status property is set - - - - Specifies whether MFA Delete is enabled on this S3 Bucket. - - - If this property is set, please ensure that the - PutBucketVersioningRequest's MfaCodes property is set with - the Serial of and Token on the MFA device. - - - - - Checks if EnableMfaDelete property is set. - - true if Status property is set - - - - Describes the server-side encryption that will be applied to the restore results. - - - - - The server-side encryption algorithm used when storing job results in Amazon S3 (e.g., AES256, aws:kms). - - - - - Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by - AWS KMS will fail if not made via SSL or using SigV4. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at - http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version - - - - - If the encryption type is aws:kms, this optional value can be used to specify the encryption context for the restore results. - - - - Grant - - - - - The grantee details. - - - - - Specifies the permission given to the grantee. - - - - - Grantee - - - - - Type of grantee - - - - - - Screen name of the grantee. - - - - - - Email address of the grantee. - - - - - - The canonical user ID of the grantee. - - - - - - URI of the grantee group. - - - - - - Filter criteria that allows for event notification filtering based on an S3 Object's key name. - - - - - Gets and sets the filterRules property. - These are the filter rules for this filter. - - - - - Describes an S3 location that will receive the results of the restore request. - - - - - The name of the bucket where the restore results will be placed. - - - - - The prefix that is prepended to the restore results for this request. - - - - - The canned ACL to apply to the restore results. - - - - - A list of grants that control access to the staged results. - - - - - The tag-set that is applied to the restore results. - - - - - A map of metadata to store with the restore results in S3. - - - - - The class of storage used to store the restore results. - - - - - Represents an S3 Object. Contains all attributes that an S3 Object has. - For more information about S3 Objects refer: - - - - - - Any ETag set on the object. - - - - - The name of the bucket containing this object. - - - - - The key of the object. - - - - - The date and time the object was last modified. - - The date retrieved from S3 is in ISO8601 format. A GMT formatted date is passed back to the user. - - - - - - The owner of the object. - - - - - The size of the object. - - - - - The class of storage used to store the object. - - - - - - Represents a version of an object in an S3 Bucket. An S3 object version is an S3 object - that also has a version identifier, an indication of whether this is the latest version of the object - and whether it's a DeleteMarker or not. - - - - - Specifies whether the object is (true) or is not (false) the latest version of an object. - - - - - Version ID of an object. - - - - - If true, the object is a delete marker for a deleted object. - - - - - Specifies the byte range of the object to get the records from. A record is processed when its first byte is contained by the range. - - - - - Specifies the start of the byte range. This parameter is optional. Valid values: non-negative integers. The default value is 0. - - - - - Specifies the end of the byte range. This parameter is optional. Valid values: non-negative integers. The default value is one less than the size of the object being queried. - - - - - Request to filter the contents of an Amazon S3 object based on a simple Structured Query Language (SQL) statement. - - In the request, along with the SQL expression, you must also specify a data serialization format (JSON or CSV) of the object. - Amazon S3 uses this to parse object data into records, and returns only records - that match the specified SQL expression. You must also specify the data serialization format for the response. - - - - S3Select API Documentation - - - - - The S3 Bucket. - - - - - The Object Key. - - - - - The SSE Algorithm used to encrypt the object. - - - Server-Side Encryption (Using Customer-Provided Encryption Keys. - - - - - The SSE Customer Key. - - - Server-Side Encryption (Using Customer-Provided Encryption Keys. - - - - - The SSE Customer Key MD5. - - - Server-Side Encryption (Using Customer-Provided Encryption Keys. - - - - - The expression that is used to query the object. - - - - - The type of the provided expression (e.g., SQL). - - - - - Specifies if periodic request progress information should be enabled. - - - - - Describes the format of the data in the object that is being queried. - - - - - Describes the format of the data that you want Amazon S3 to return in response. - - - - - The byte range of the object to get the records from. - - - - - Contains the response Payload for the SelectObjectContent request - - - - - The Event Stream result of SelectObjectContent - - - - - Describes the parameters for Select job types. - - - - - Describes the serialization format of the object. - - - - - The type of the provided expression (e.g., SQL). - - - - - The expression that is used to query the object. - - - - - Describes how the results of the Select job are serialized. - - - - - ServerSideEncryptionByDefault class - - - - - Server-side encryption algorithm to use for the default encryption. - - - - - KMS master key ID to use for the default encryption. - This parameter is allowed if SSEAlgorithm is aws:kms. - - - - - ServerSideEncryptionConfiguration class - - - - - Container for information about a particular server-side encryption configuration rule. - - - - - ServerSideEncryptionRule class - - - - - Describes the default server-side encryption to apply to - new objects in the bucket. If Put Object request - does not specify any server-side encryption, - this default encryption will be applied. - - - - - SourceSelectionCriteria class - - - - - Container for filter information of selection of KMS Encrypted - S3 objects. The element is required if you include - SourceSelectionCriteria in the replication - configuration. - - - - - SSEKMS class - - - - - Specifies the ID of the AWS Key Management Service (KMS) - master encryption key to use for encrypting Inventory reports. - - - - - SseKmsEncryptedObjects class - - - - - The replication for KMS encrypted S3 objects is disabled if status is not Enabled. - - - - - SSES3 class - - - - - Class for StorageClassAnalysis - - - - - A container used to describe how data related to the storage class analysis should be exported. - - - - - Class for StorageClassAnalysisDataExport - - - - - The version of the output schema to use when exporting data. Must be V_1. - - - - - The place to store the data for an analysis. - - - - - Base class for responses that return a stream. - - - - - Disposes of all managed and unmanaged resources. - - - - - An open stream read from to get the data from S3. In order to - use this stream without leaking the underlying resource, please - wrap access to the stream within a using block. - - - - - The exception that is thrown when the size of a stream does not match it's expected size. - - - - - Gets and sets ExpectedSize property. - - - - - Gets and sets ActualSize property. - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - - - Tag is a key-value pair of metadata associated with an S3Object - - - - - Name of the tag. - - - - - Value of the tag. - - - - - Structure that contains list of Tags - - - - - TagSet - - - - - This class contains the configuration Amazon S3 uses to figure out what events you want to listen - and send the event to an Amazon SNS topic. - - The topic's policy must allow S3 to publish messages to it. The utility method - Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.AuthorizeS3ToPublish(string,string) - can be used to help setup the topic policy. - - - - - - Gets and set the Id property. The Id will be provided in the event content and can be used - to identify which configuration caused an event to fire. If the Id is not provided for the configuration, one will be generated. - - - - - Bucket event for which to send notifications. - - Topic configurations can now contain multiple events. This property is obsolete in favor of the Events property. - This property will always get or set the the zeroth element in the Events collection. - - - - - - Gets and sets the Topic property. Amazon SNS topic to which Amazon S3 will publish a message to report the - specified events for the bucket. - - The topic's policy must allow S3 to publish messages to it. The utility method - Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.AuthorizeS3ToPublish(string,string) - can be used to help setup the topic policy. - - - - - - The parameters to request upload of a part in a multipart upload operation. - - - - If PartSize is not specified then the rest of the content from the file - or stream will be sent to Amazon S3. - - - You must set either the FilePath or InputStream. If FilePath is set then the FilePosition - property must be set. - - - - The parameters to request upload of a part in a multipart upload operation. - - - - If PartSize is not specified then the rest of the content from the file - or stream will be sent to Amazon S3. - - - You must set either the FilePath or InputStream. If FilePath is set then the FilePosition - property must be set. - - - - - - Caller needs to set this to true when uploading the last part. This property only needs to be set - when using the AmazonS3EncryptionClient. - - - - - Input stream for the request; content for the request will be read from the stream. - - - - - The name of the bucket containing the object to receive the part. - - - - - The key of the object. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Part number of part being uploaded. - - - - - - The size of the part to be uploaded. - - - - - Checks if PartSize property is set. - - true if PartSize property is set. - - - - Upload ID identifying the multipart upload whose part is being uploaded. - - - - - - An MD5 digest for the part. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - - Full path and name of a file from which the content for the part is retrieved. - - - For WinRT and Windows Phone this property must be in the form of "ms-appdata:///local/file.txt". - - - - - - Checks if the FilePath property is set. - - true if FilePath property is set. - - - - Position in the file specified by FilePath from which to retrieve the content of the part. - This field is required when a file path is specified. It is ignored when using the InputStream property. - - - - - If this value is set to true then a chunked encoding upload will be used for the request. - Default: true. - - - - - Checks if the FilePosition property is set. - - true if FilePosition property is set. - - - - Checks if the MD5Digest property is set. - - true if Md5Digest property is set. - - - - Attach a callback that will be called as data is being sent to the AWS Service. - - - - - Overriden to turn off sending SHA256 header. - - - - - Overriden to turn on Expect 100 continue. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the UploadPart response and response metadata. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - Entity tag for the uploaded object. - - - - - - Gets and sets the part number specified for the part upload. This is needed when - completing the multipart upload. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - Website Configuration - - - - - The ErrorDocument value, an object key name to use when a 4XX class error occurs. - - - - - - This value is a suffix that is appended to a request that is for a "directory" - on the website endpoint (e.g. if the suffix is index.html and - you make a request to samplebucket/images/ the data that - is returned will be for the object with the key name - images/index.html) - - - The suffix must not be empty and must not include a slash - character. - - - - - - Container for redirect information where all requests will be redirect - to. You can redirect requests to another host, to another page, or with - another protocol. In the event of an error, you can can specify a - different error code to return. . - - - - - The list of routing rules that can be used for configuring redirects if certain conditions are meet. - - - - - The Continuation Event. - - - - - Constructs a Continuation Event. - - - - - Constructs a Continuation Event. - - - - - - The End Event. - - - - - Constructs an End Event. - - - - - Constructs an End Event. - - - - - - Common Contract for S3 Events. - - - - - The Progress event details. - - - - - Current number of object bytes scanned. - - - - - Current number of uncompressed object bytes processed. - - - - - Total number of bytes of records payload data returned. - - - - - Constructs a instance of Progress. - - - - - The Progress Event. - - - - - The Progress event details. - - - - - Constructs a ProgressEvent. - - - - - Constructs a ProgressEvent. - - - - - - The Records Event - - - - - The byte array of partial, one or more result records. - - Payload is a , which is not thread-safe. - - - - - Constructs a RecordsEvent - - - - - Creates a new End Event. - - - - - - Modeled Exception that either comes over the stream from the service model, or wraps other exceptions for the purpose of raising events. If it is - modelled, it will be a subclass. - - - - - Creates a new S3EventStreamException - - - - - Creates a new S3EventStreamException - - - - - - Creates a new S3EventStreamException - - - - - - - The contract for the SelectObjectContentEventStream. - - - - - Event that encompasses all IS3Events. - - - - - Event that encompasses S3EventStreamExceptions. - - - - - Reaised when a Records event is received. - - - - - Reaised when a Stats event is received. - - - - - Reaised when a Progress event is received. - - - - - Reaised when a Continuation event is received. - - - - - Reaised when an End event is received. - - - - - A Stream of Events returned by the SelectObjectContent operation. Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treaded as mutually exclusive. - - - - - The mapping of event message to a generator function to construct the matching Event Stream event. - - - - - The mapping of event message to a generator function to construct the matching Event Stream exception. - - - - - Whether the backround processing loop is running. - - - - - Event that encompasses all IS3Events. - - - - - Event that encompasses S3EventStreamExceptions. - - - - - Reaised when a Records event is received. - - - - - Reaised when a Stats event is received. - - - - - Reaised when a Progress event is received. - - - - - Reaised when a Continuation event is received. - - - - - Reaised when an End event is received. - - - - - Event Stream returned by SelectObjectContentStream. - - Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treated as mutually exclusive. - - The network stream which events will be parsed from. - - - - Event Stream returned by SelectObjectContentStream. - - Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treaded as mutually exclusive. - - The network stream which events will be parsed from. - The decoder responsible for parsing events. - - - - The Stats event details. - - - - - Total number of object bytes scanned. - - - - - Total number of uncompressed object bytes processed. - - - - - Total number of bytes of records payload data returned. - - - - - Constructs an instance of Stats. - - - - - The Stats Event. - - - - - The Stats event details. - - - - - Constructs a StatsEvent - - - - - Constructs a ProgressEvent. - - - - - - This Event is returned if an event is retrieved from the event stream, but a generator function - for the event is not defined. - - - - - Constructs an UnknownEventStreamEvent. - - - - - Constructs an UnknownEventStreamEvent. - - The Message recieved from the event stream before conversion. - - - - Constructs an UnknownEventStreamEvent. - - The Message recieved from the event stream before conversion. - The event type. - - - - Arguments containing event details for an in-flight transfer. - - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - - - - Gets the percentage of transfer completed - - - - - Gets the number of bytes transferred since last event - - - - - Gets the number of bytes transferred - - - - - Gets the total number of bytes to be transferred - - - - - Returns a string representation of this object - - - - - - AmazonS3 exception. - Thrown when DeleteObjects returns successfully, but some of the objects - were not deleted. - - - - - Gets and sets the ErrorResponse property. - The DeleteObjectsErrorResponse associated with this exception. - - - - - Constructs an instance of DeleteObjectsException - - - - - - Uri wrapper that can parse out information (bucket, key, region, style) from an - S3 URI. - - - - - True if the URI contains the bucket in the path, false if it contains the bucket in the authority. - - - - - The bucket name parsed from the URI (or null if no bucket specified). - - - - - The key parsed from the URI (or null if no key specified). - - - - - The region parsed from the URI (or null if no region specified). - - - - - Constructs a parser for the S3 URI specified as a string. - - The S3 URI to be parsed. - - - - Constructs a parser for the S3 URI specified as a Uri instance. - - The S3 URI to be parsed. - - - - If the given string is an AmazonS3Endpoint return true and set the AmazonS3Uri out parameter. - - - - true if the string is an AmazonS3Endpoint, and the out paramter has been filled in, false otherwise - - - - If the given Uri is an AmazonS3Endpoint return true and set the AmazonS3Uri out parameter. - - - - true if the Uri is an AmazonS3Endpoint, and the out paramter has been filled in, false otherwise - - - - Checks whether the given URI is a Amazon S3 URI. - - The S3 URI to be checked. - true if the URI is a Amazon S3 URI, false; otherwise. - - - - Checks whether the given URI is a Amazon S3 URI. - - The S3 URI to be checked. - true if the URI is a Amazon S3 URI, false; otherwise. - - - - Percent-decodes the given string, with a fast path for strings that are not - percent-encoded. - - The string to decode - The decoded string - - - - Percent-decodes the given string. - - The string to decode - The index of the first '%' in the string - The decoded string - - - - Decodes the percent-encoded character at the given index in the string - and appends the decoded value to the string under construction. - - - The string under construction to which the decoded character will be - appended. - - The string being decoded. - The index of the '%' character in the string. - - - - Converts a hex character (0-9A-Fa-f) into its corresponding quad value. - - The hex character - The quad value - - - - Provides utilities used by the Amazon S3 client implementation. - These utilities might be useful to consumers of the Amazon S3 - library. - - - - - Determines MIME type from a file extension - - The extension of the file - The MIME type for the extension, or text/plain - - - - URL encodes a string. If the path property is specified, - the accepted path characters {/+:} are not encoded. - - The string to encode - Whether the string is a URL path or not - - - - - Converts a non-seekable stream into a System.IO.MemoryStream. - A MemoryStream's position can be moved arbitrarily - - The stream to be converted - A seekable MemoryStream - MemoryStreams use byte arrays as their backing store. - Please use this judicially as it is likely that a very large - stream will cause system resources to be used up. - - - - - Formats the current date as a GMT timestamp - - A GMT formatted string representation - of the current date and time - - - - - Generates an MD5 Digest for the string-based content - - The content for which the MD5 Digest needs - to be computed. - - Whether the returned checksum should be - base64 encoded. - - A string representation of the hash with or w/o base64 encoding - - - - - Only escape non-ascii characters in a string - - - - - - - Version2 S3 buckets adhere to RFC 1035: - - Less than 255 characters, with each label less than 63 characters. - Label must start with a letter - Label must end with a letter or digit - Label can have a string of letter, digits and hyphens in the middle. - Although names can be case-sensitive, no significance is attached to the case. - RFC 1123: Allow label to start with letter or digit (e.g. 3ware.com works) - RFC 2181: No restrictions apart from the length restrictions. - - S3 V2 will start with RFCs 1035 and 1123 and impose the following additional restrictions: - - Length between 3 and 63 characters (to allow headroom for upper-level domains, - as well as to avoid separate length restrictions for bucket-name and its labels - Only lower-case to avoid user confusion. - No dotted-decimal IPv4-like strings - - - The BucketName to validate if V2 addressing should be used - True if the BucketName should use V2 bucket addressing, false otherwise - - S3 v2 Bucket restrictions - - - - Determines whether an S3 bucket exists or not. - - The name of the bucket to check. - The Amazon S3 Client to use for S3 specific operations. - False is returned in case S3 responds with a NoSuchBucket error. - True is returned in case of success, AccessDenied error or PermanentRedirect error. - An exception is thrown in case of any other error. - This method calls GetACL for the bucket. - - - - Determines whether an S3 bucket exists or not. - This is done by: - 1. Creating a PreSigned Url for the bucket. To work with Signature V4 only regions, as - well as Signature V4-optional regions, we keep the expiry to within the maximum for V4 - (which is one week). - 2. Making a HEAD request to the Url - - The name of the bucket to check. - The Amazon S3 Client to use for S3 specific operations. - - - - - Class to manage and cache the correct region for buckets accessed without an explicit region. - - - Class to manage and cache the correct region for buckets accessed without an explicit region. - - - - - A cache of BucketName -> RegionEndpoint pairs. - The cache is used to make sure that bucket requests are signed for the correct region, - even when requesting them without an explicit region. - - - - - Detect a bucket region mismatch based on the x-amz-bucket-region header, and the status code provided. - - - - - - - - - Detects if the signature is malformed, and the requested bucket is in a Region - different from the Region of the request. - - - - the correct region if a mismatch was detected, null otherwise - - - - Detects if the signature is malformed, and the requested bucket is in a Region - different from the Region of the request. - - - - - the correct region if a mismatch was detected, null otherwise - - - - Use a HEAD bucket request to get the region for the given bucket. - - This method creates an AmazonS3Client from the credentials passed in. - It's critical that the AmazonS3Client is not used to make any requests that will - be routed through the pipeline. - - - - the value of the x-amz-bucket-region header from the response - - - - A helper class that represents a strongly typed S3 EventNotification item sent to SQS - - - - - Parse the JSON string into a S3EventNotification object. - - The function will try its best to parse input JSON string as best as it can. - It will not fail even if the JSON string contains unknown properties. - - For any parsing errors - - - - - Gets and sets the records for the S3 event notification - - - - - The class holds the user identity properties. - - - - - Gets and sets the PrincipalId property. - - - - - This class contains the identity information for an S3 bucket. - - - - - Gets and sets the name of the bucket. - - - - - Gets and sets the bucket owner id. - - - - - Gets and sets the S3 bucket arn. - - - - - This class contains the information for an object in S3. - - - - - Gets and sets the key for the object stored in S3. - - - - - Gets and sets the size of the object in S3. - - - - - Gets and sets the etag of the object. This can be used to determine if the object has changed. - - - - - Gets and sets the version id of the object in S3. - - - - - Gets and sets the sequencer a string representation of a hexadecimal value used to determine event sequence, only used with PUTs and DELETEs. - - - - - Gets and sets the meta information describing S3. - - - - - Gets and sets the ConfigurationId. This ID can be found in the bucket notification configuration. - - - - - Gets and sets the Bucket property. - - - - - Gets and sets the Object property. - - - - - Gets and sets the S3SchemaVersion property. - - - - - The class holds the request parameters - - - - - Gets and sets the SourceIPAddress. This is the ip address where the request came from. - - - - - This class holds the response elements. - - - - - Gets and sets the XAmzId2 Property. This is the Amazon S3 host that processed the request. - - - - - Gets and sets the XAmzRequestId. This is the Amazon S3 generated request ID. - - - - - The class holds the glacier event data elements. - - - - - Gets and sets the RestoreEventData property. - - - - - The class holds the restore event data elements. - - - - - Gets and sets the LifecycleRestorationExpiryTime the time when the object restoration will be expired. - - - - - Gets and sets the LifecycleRestoreStorageClass the source storage class for restore. - - - - - The class holds the event notification. - - - - - Gets and sets the AwsRegion property. - - - - - Gets and sets the EventName property. This identities what type of event occurred. - For example for an object just put in S3 this will be set to EventType.ObjectCreatedPut. - - - - - Gets and sets the EventSource property. - - - - - Gets and sets the EventType property. The time when S3 finished processing the request. - - - - - Gets and sets the EventVersion property. - - - - - Gets and sets the RequestParameters property. - - - - - Gets and sets the ResponseElements property. - - - - - Gets and sets the S3 property. - - - - - Gets and sets the UserIdentity property. - - - - - Get and sets the GlacierEventData property. - - - - - Interface for accessing S3 - - - - - - - Create a signed URL allowing access to a resource that would - usually require authentication. - - - - When using query string authentication you create a query, - specify an expiration time for the query, sign it with your - signature, place the data in an HTTP request, and distribute - the request to a user or embed the request in a web page. - - - A PreSigned URL can be generated for GET, PUT, DELETE and HEAD - operations on your bucketName, keys, and versions. - - - The GetPreSignedUrlRequest that defines the - parameters of the operation. - A string that is the signed http request. - - - - - - This operation aborts a multipart upload. After a multipart upload is aborted, no - additional parts can be uploaded using that upload ID. The storage consumed by any - previously uploaded parts will be freed. However, if any part uploads are currently - in progress, those part uploads might or might not succeed. As a result, it might - be necessary to abort a given multipart upload multiple times in order to completely - free all storage consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts operation and ensure that the parts - list is empty. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - The bucket name to which the upload was taking place. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object for which the multipart upload was initiated. - Upload ID that identifies the multipart upload. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AbortMultipartUpload service method, as returned by S3. - REST API Reference for AbortMultipartUpload Operation - - - - This operation aborts a multipart upload. After a multipart upload is aborted, no - additional parts can be uploaded using that upload ID. The storage consumed by any - previously uploaded parts will be freed. However, if any part uploads are currently - in progress, those part uploads might or might not succeed. As a result, it might - be necessary to abort a given multipart upload multiple times in order to completely - free all storage consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts operation and ensure that the parts - list is empty. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - Container for the necessary parameters to execute the AbortMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AbortMultipartUpload service method, as returned by S3. - REST API Reference for AbortMultipartUpload Operation - - - - Completes a multipart upload by assembling previously uploaded parts. - - - - You first initiate the multipart upload and then upload all parts using the UploadPart - operation. After successfully uploading all relevant parts of an upload, you call - this operation to complete the upload. Upon receiving this request, Amazon S3 concatenates - all the parts in ascending order by part number to create a new object. In the Complete - Multipart Upload request, you must provide the parts list. You must ensure that the - parts list is complete. This operation concatenates the parts that you provide in - the list. For each part in the list, you must provide the part number and the ETag - value, returned after that part was uploaded. - - - - Processing of a Complete Multipart Upload request could take several minutes to complete. - After Amazon S3 begins processing the request, it sends an HTTP response header that - specifies a 200 OK response. While processing is in progress, Amazon S3 periodically - sends white space characters to keep the connection from timing out. Because a request - could fail after the initial 200 OK response has been sent, it is important that you - check the response body to determine whether the request succeeded. - - - - Note that if CompleteMultipartUpload fails, applications should be prepared - to retry the failed requests. For more information, see Amazon - S3 Error Best Practices. - - - - For more information about multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - GetBucketLifecycle has the following special errors: - -
  • - - Error code: EntityTooSmall - -
    • - - Description: Your proposed upload is smaller than the minimum allowed object size. - Each part must be at least 5 MB in size, except the last part. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPart - -
    • - - Description: One or more of the specified parts could not be found. The part might - not have been uploaded, or the specified entity tag might not have matched the part's - entity tag. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPartOrder - -
    • - - Description: The list of parts was not in ascending order. The parts list must be - specified in order by part number. - -
    • - - 400 Bad Request - -
  • - - Error code: NoSuchUpload - -
    • - - Description: The specified multipart upload does not exist. The upload ID might be - invalid, or the multipart upload might have been aborted or completed. - -
    • - - 404 Not Found - -
- - The following operations are related to CompleteMultipartUpload: - - - - Container for the necessary parameters to execute the CompleteMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CompleteMultipartUpload service method, as returned by S3. - REST API Reference for CompleteMultipartUpload Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 Developer Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Encryption - - - - The source object that you are copying can be encrypted or unencrypted. The source - object can be encrypted with server-side encryption using AWS managed encryption keys - (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side - encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers - and decrypts the data when you access it. - - - - You can optionally use the appropriate encryption-related headers to request server-side - encryption for the target object. You have the option to provide your own encryption - key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that - was used to encrypt the source object. You can even request encryption if the source - object was not encrypted. For more information about server-side encryption, see Using - Server-Side Encryption. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject operation to change the storage class of an - object that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 Service Developer Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 Developer Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Encryption - - - - The source object that you are copying can be encrypted or unencrypted. The source - object can be encrypted with server-side encryption using AWS managed encryption keys - (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side - encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers - and decrypts the data when you access it. - - - - You can optionally use the appropriate encryption-related headers to request server-side - encryption for the target object. You have the option to provide your own encryption - key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that - was used to encrypt the source object. You can even request encryption if the source - object was not encrypted. For more information about server-side encryption, see Using - Server-Side Encryption. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject operation to change the storage class of an - object that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 Service Developer Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 Developer Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Encryption - - - - The source object that you are copying can be encrypted or unencrypted. The source - object can be encrypted with server-side encryption using AWS managed encryption keys - (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side - encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers - and decrypts the data when you access it. - - - - You can optionally use the appropriate encryption-related headers to request server-side - encryption for the target object. You have the option to provide your own encryption - key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that - was used to encrypt the source object. You can even request encryption if the source - object was not encrypted. For more information about server-side encryption, see Using - Server-Side Encryption. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject operation to change the storage class of an - object that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 Service Developer Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - Container for the necessary parameters to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - - - - - - Deletes an analytics configuration for the bucket (specified by the analytics configuration - ID). - - - - To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to DeleteBucketAnalyticsConfiguration: - -
  • - - - -
  • - - - -
  • - - - -
- - Container for the necessary parameters to execute the DeleteBucketAnalyticsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketAnalyticsConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketAnalyticsConfiguration Operation - - - - - Deletes an inventory configuration (identified by the inventory ID) from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - Operations related to DeleteBucketInventoryConfiguration include: - - - - Container for the necessary parameters to execute the DeleteBucketInventoryConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketInventoryConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketInventoryConfiguration Operation - - - - Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified - by the metrics configuration ID) from the bucket. Note that this doesn't include the - daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketMetricsConfiguration Operation - - - - This implementation of the DELETE operation uses the policy subresource to delete - the policy of a specified bucket. If you are using an identity other than the root - user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - The bucket name. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketPolicy service method, as returned by S3. - REST API Reference for DeleteBucketPolicy Operation - - - - This implementation of the DELETE operation uses the policy subresource to delete - the policy of a specified bucket. If you are using an identity other than the root - user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - Container for the necessary parameters to execute the DeleteBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketPolicy service method, as returned by S3. - REST API Reference for DeleteBucketPolicy Operation - - - - Deletes the replication configuration from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutReplicationConfiguration - action. The bucket owner has these permissions by default and can grant it to others. - For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - It can take a while for the deletion of a replication configuration to fully propagate. - - - - For information about replication configuration, see Replication - in the Amazon S3 Developer Guide. - - - - The following operations are related to DeleteBucketReplication: - - - - Container for the necessary parameters to execute the DeleteBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketReplication service method, as returned by S3. - REST API Reference for DeleteBucketReplication Operation - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - The bucket that has the tag set to be removed. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketTagging service method, as returned by S3. - REST API Reference for DeleteBucketTagging Operation - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - Container for the necessary parameters to execute the DeleteBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketTagging service method, as returned by S3. - REST API Reference for DeleteBucketTagging Operation - - - - This operation removes the website configuration for a bucket. Amazon S3 returns a - 200 OK response upon successfully deleting a website configuration on - the specified bucket. You will get a 200 OK response if the website configuration - you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE operation requires the S3:DeleteBucketWebsite permission. - By default, only the bucket owner can delete the website configuration attached to - a bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which you want to remove the website configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketWebsite service method, as returned by S3. - REST API Reference for DeleteBucketWebsite Operation - - - - This operation removes the website configuration for a bucket. Amazon S3 returns a - 200 OK response upon successfully deleting a website configuration on - the specified bucket. You will get a 200 OK response if the website configuration - you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE operation requires the S3:DeleteBucketWebsite permission. - By default, only the bucket owner can delete the website configuration attached to - a bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the DeleteBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketWebsite service method, as returned by S3. - REST API Reference for DeleteBucketWebsite Operation - - - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - The bucket name of the lifecycle to delete. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - REST API Reference for DeleteLifecycleConfiguration Operation - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - Container for the necessary parameters to execute the DeleteLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - REST API Reference for DeleteLifecycleConfiguration Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key name of the object to delete. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key name of the object to delete. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - Container for the necessary parameters to execute the DeleteObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - This operation enables you to delete multiple objects from a bucket using a single - HTTP request. If you know the object keys that you want to delete, then this operation - provides a suitable alternative to sending individual delete requests, reducing per-request - overhead. - - - - The request contains a list of up to 1000 keys that you want to delete. In the XML, - you provide the object key names, and optionally, version IDs if you want to delete - a specific version of the object from a versioning-enabled bucket. For each key, Amazon - S3 performs a delete operation and returns the result of that delete, success, or - failure, in the response. Note that if the object specified in the request is not - found, Amazon S3 returns the result as deleted. - - - - The operation supports two modes for the response: verbose and quiet. By default, - the operation uses verbose mode in which the response includes the result of deletion - of each key in your request. In quiet mode the response includes only keys where the - delete operation encountered an error. For a successful deletion, the operation does - not return any information about the delete in the response body. - - - - When performing this operation on an MFA Delete enabled bucket, that attempts to delete - any versioned objects, you must include an MFA token. If you do not provide one, the - entire request will fail, even if there are non-versioned objects you are trying to - delete. If you provide an invalid token, whether there are versioned keys in the request - or not, the entire Multi-Object Delete request will fail. For information about MFA - Delete, see - MFA Delete. - - - - Finally, the Content-MD5 header is required for all Multi-Object Delete requests. - Amazon S3 uses the header value to ensure that your request body has not been altered - in transit. - - - - The following operations are related to DeleteObjects: - - - - Container for the necessary parameters to execute the DeleteObjects service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObjects service method, as returned by S3. - REST API Reference for DeleteObjects Operation - - - - Removes the entire tag set from the specified object. For more information about managing - object tags, see - Object Tagging. - - - - To use this operation, you must have permission to perform the s3:DeleteObjectTagging - action. - - - - To delete tags of a specific object version, add the versionId query - parameter in the request. You will need permission for the s3:DeleteObjectVersionTagging - action. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteObjectTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObjectTagging service method, as returned by S3. - REST API Reference for DeleteObjectTagging Operation - - - - Removes the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:PutBucketPublicAccessBlock - permission. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to DeletePublicAccessBlock: - - - - Container for the necessary parameters to execute the DeletePublicAccessBlock service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeletePublicAccessBlock service method, as returned by S3. - REST API Reference for DeletePublicAccessBlock Operation - - - - - - - - - Returns the default encryption configuration for an Amazon S3 bucket. For information - about the Amazon S3 default encryption feature, see Amazon - S3 Default Bucket Encryption. - - - - To use this operation, you must have permission to perform the s3:GetEncryptionConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to GetBucketEncryption: - - - - Container for the necessary parameters to execute the GetBucketEncryption service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketEncryption service method, as returned by S3. - REST API Reference for GetBucketEncryption Operation - - - - Returns an inventory configuration (identified by the inventory configuration ID) - from the bucket. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - The following operations are related to GetBucketInventoryConfiguration: - - - - Container for the necessary parameters to execute the GetBucketInventoryConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketInventoryConfiguration service method, as returned by S3. - REST API Reference for GetBucketInventoryConfiguration Operation - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - The name of the bucket for which to get the location. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLocation service method, as returned by S3. - REST API Reference for GetBucketLocation Operation - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - Container for the necessary parameters to execute the GetBucketLocation service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLocation service method, as returned by S3. - REST API Reference for GetBucketLocation Operation - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - The bucket name for which to get the logging information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLogging service method, as returned by S3. - REST API Reference for GetBucketLogging Operation - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - Container for the necessary parameters to execute the GetBucketLogging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLogging service method, as returned by S3. - REST API Reference for GetBucketLogging Operation - - - - Gets a metrics configuration (specified by the metrics configuration ID) from the - bucket. Note that this doesn't include the daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to GetBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the GetBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for GetBucketMetricsConfiguration Operation - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following operation is related to GetBucketNotification: - - - - Name of the bucket for which to get the notification configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketNotification service method, as returned by S3. - REST API Reference for GetBucketNotification Operation - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following operation is related to GetBucketNotification: - - - - Container for the necessary parameters to execute the GetBucketNotification service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketNotification service method, as returned by S3. - REST API Reference for GetBucketNotification Operation - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operation is related to GetBucketPolicy: - - - - The bucket name for which to get the bucket policy. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicy service method, as returned by S3. - REST API Reference for GetBucketPolicy Operation - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operation is related to GetBucketPolicy: - - - - Container for the necessary parameters to execute the GetBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicy service method, as returned by S3. - REST API Reference for GetBucketPolicy Operation - - - - Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket - is public. In order to use this operation, you must have the s3:GetBucketPolicyStatus - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - For more information about when Amazon S3 considers a bucket public, see The - Meaning of "Public". - - - - The following operations are related to GetBucketPolicyStatus: - - - - Container for the necessary parameters to execute the GetBucketPolicyStatus service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicyStatus service method, as returned by S3. - REST API Reference for GetBucketPolicyStatus Operation - - - - Retrieves the replication configuration for the given Amazon S3 bucket. - - Container for the necessary parameters to execute the GetBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketReplication service method, as returned by S3. - REST API Reference for GetBucketReplication Operation - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - The name of the bucket for which to get the payment request configuration - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketRequestPayment service method, as returned by S3. - REST API Reference for GetBucketRequestPayment Operation - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - Container for the necessary parameters to execute the GetBucketRequestPayment service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketRequestPayment service method, as returned by S3. - REST API Reference for GetBucketRequestPayment Operation - - - - Returns the tag set associated with the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - GetBucketTagging has the following special error: - -
  • - - Error code: NoSuchTagSetError - -
    • - - Description: There is no tag set associated with the bucket. - -
- - The following operations are related to GetBucketTagging: - - - - Container for the necessary parameters to execute the GetBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketTagging service method, as returned by S3. - REST API Reference for GetBucketTagging Operation - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - The name of the bucket for which to get the versioning information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketVersioning service method, as returned by S3. - REST API Reference for GetBucketVersioning Operation - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - Container for the necessary parameters to execute the GetBucketVersioning service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketVersioning service method, as returned by S3. - REST API Reference for GetBucketVersioning Operation - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET operation requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which to get the website configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketWebsite service method, as returned by S3. - REST API Reference for GetBucketWebsite Operation - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET operation requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the GetBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketWebsite service method, as returned by S3. - REST API Reference for GetBucketWebsite Operation - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - The bucket name for which to get the cors configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetCORSConfiguration service method, as returned by S3. - REST API Reference for GetCORSConfiguration Operation - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - Container for the necessary parameters to execute the GetCORSConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetCORSConfiguration service method, as returned by S3. - REST API Reference for GetCORSConfiguration Operation - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are still using previous version of the lifecycle configuration, it works. - For the earlier API description, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to GetBucketLifecycleConfiguration: - - - - The name of the bucket for which to get the lifecycle information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetLifecycleConfiguration service method, as returned by S3. - REST API Reference for GetLifecycleConfiguration Operation - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are still using previous version of the lifecycle configuration, it works. - For the earlier API description, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to GetBucketLifecycleConfiguration: - - - - Container for the necessary parameters to execute the GetLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetLifecycleConfiguration service method, as returned by S3. - REST API Reference for GetLifecycleConfiguration Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object to get. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object to get. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - Container for the necessary parameters to execute the GetObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Gets an object's current Legal Hold status. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLegalHold service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectLegalHold service method, as returned by S3. - REST API Reference for GetObjectLegalHold Operation - - - - Gets the Object Lock configuration for a bucket. The rule specified in the Object - Lock configuration will be applied by default to every new object placed in the specified - bucket. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLockConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectLockConfiguration service method, as returned by S3. - REST API Reference for GetObjectLockConfiguration Operation - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - The name of the bucket containing the object. - The object key. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - The name of the bucket containing the object. - The object key. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - Container for the necessary parameters to execute the GetObjectMetadata service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - Retrieves an object's retention settings. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectRetention service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectRetention service method, as returned by S3. - REST API Reference for GetObjectRetention Operation - - - - Returns the tag-set of an object. You send the GET request against the tagging subresource - associated with the object. - - - - To use this operation, you must have permission to perform the s3:GetObjectTagging - action. By default, the GET operation returns information about current version of - an object. For a versioned bucket, you can have multiple versions of an object in - your bucket. To retrieve tags of any other version, use the versionId query parameter. - You also need permission for the s3:GetObjectVersionTagging action. - - - - By default, the bucket owner has this permission and can grant this permission to - others. - - - - For information about the Amazon S3 object tagging feature, see Object - Tagging. - - - - The following operation is related to GetObjectTagging: - - - - Container for the necessary parameters to execute the GetObjectTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTagging service method, as returned by S3. - REST API Reference for GetObjectTagging Operation - - - - Return torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Amazon - S3 Torrent. - - - - You can get torrent only for objects that are less than 5 GB in size and that are - not encrypted using server-side encryption with customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - The following operation is related to GetObjectTorrent: - - - - The name of the bucket containing the object for which to get the torrent files. - The object key for which to get the information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTorrent service method, as returned by S3. - REST API Reference for GetObjectTorrent Operation - - - - Return torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Amazon - S3 Torrent. - - - - You can get torrent only for objects that are less than 5 GB in size and that are - not encrypted using server-side encryption with customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - The following operation is related to GetObjectTorrent: - - - - Container for the necessary parameters to execute the GetObjectTorrent service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTorrent service method, as returned by S3. - REST API Reference for GetObjectTorrent Operation - - - - Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:GetBucketPublicAccessBlock - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket - or an object, it checks the PublicAccessBlock configuration for both - the bucket (or the bucket that contains the object) and the bucket owner's account. - If the PublicAccessBlock settings are different between the bucket and - the account, Amazon S3 uses the most restrictive combination of the bucket-level and - account-level settings. - - - - For more information about when Amazon S3 considers a bucket or an object public, - see The - Meaning of "Public". - - - - The following operations are related to GetPublicAccessBlock: - - - - Container for the necessary parameters to execute the GetPublicAccessBlock service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetPublicAccessBlock service method, as returned by S3. - REST API Reference for GetPublicAccessBlock Operation - - - - This operation initiates a multipart upload and returns an upload ID. This upload - ID is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort operation - and Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload API and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart) and UploadPartCopy) requests must match the headers you - used in the request to initiate the upload by using CreateMultipartUpload. - - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, - kms:GenerateDataKey*, and kms:DescribeKey actions on the - key. These permissions are required because Amazon S3 must decrypt and read data from - the encrypted file parts before it completes the multipart upload. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - The following operations are related to CreateMultipartUpload: - - - - The name of the bucket to which to initiate the upload - Object key for which the multipart upload is to be initiated. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the InitiateMultipartUpload service method, as returned by S3. - REST API Reference for InitiateMultipartUpload Operation - - - - This operation initiates a multipart upload and returns an upload ID. This upload - ID is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort operation - and Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload API and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart) and UploadPartCopy) requests must match the headers you - used in the request to initiate the upload by using CreateMultipartUpload. - - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, - kms:GenerateDataKey*, and kms:DescribeKey actions on the - key. These permissions are required because Amazon S3 must decrypt and read data from - the encrypted file parts before it completes the multipart upload. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - The following operations are related to CreateMultipartUpload: - - - - Container for the necessary parameters to execute the InitiateMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the InitiateMultipartUpload service method, as returned by S3. - REST API Reference for InitiateMultipartUpload Operation - - - - Lists the analytics configurations for the bucket. You can have up to 1,000 analytics - configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. You should always check the IsTruncated element in the response. - If there are no more configurations to list, IsTruncated is set to false. - If there are more configurations to list, IsTruncated is set to true, - and there will be a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to ListBucketAnalyticsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketAnalyticsConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketAnalyticsConfigurations service method, as returned by S3. - REST API Reference for ListBucketAnalyticsConfigurations Operation - - - - Returns a list of inventory configurations for the bucket. You can have up to 1,000 - analytics configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory - - - - The following operations are related to ListBucketInventoryConfigurations: - - - - Container for the necessary parameters to execute the ListBucketInventoryConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketInventoryConfigurations service method, as returned by S3. - REST API Reference for ListBucketInventoryConfigurations Operation - - - - Lists the metrics configurations for the bucket. The metrics configurations are only - for the request metrics of the bucket and do not provide information on daily storage - metrics. You can have up to 1,000 configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For more information about metrics configurations and CloudWatch request metrics, - see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to ListBucketMetricsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketMetricsConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketMetricsConfigurations service method, as returned by S3. - REST API Reference for ListBucketMetricsConfigurations Operation - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBuckets service method, as returned by S3. - REST API Reference for ListBuckets Operation - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - Container for the necessary parameters to execute the ListBuckets service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBuckets service method, as returned by S3. - REST API Reference for ListBuckets Operation - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Container for the necessary parameters to execute the ListMultipartUploads service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. - Limits the response to keys that begin with the specified prefix. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - Container for the necessary parameters to execute the ListObjects service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Make sure to design - your application to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - To use this operation in an AWS Identity and Access Management (IAM) policy, you must - have permissions to perform the s3:ListBucket action. The bucket owner - has this permission by default and can grant this permission to others. For more information - about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - This section describes the latest revision of the API. We recommend that you use this - revised API for application development. For backward compatibility, Amazon S3 continues - to support the prior version of this API, ListObjects. - - - - To get a list of your buckets, see ListBuckets. - - - - The following operations are related to ListObjectsV2: - - - - Container for the necessary parameters to execute the ListObjectsV2 service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjectsV2 service method, as returned by S3. - REST API Reference for ListObjectsV2 Operation - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). This request returns a maximum of 1,000 - uploaded parts. The default number of parts returned is 1,000 parts. You can restrict - the number of parts returned by specifying the max-parts request parameter. - If your multipart upload consists of more than 1,000 parts, the response returns an - IsTruncated field with the value of true, and a NextPartNumberMarker - element. In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListParts: - - - - Name of the bucket to which the parts are being uploaded. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Object key for which the multipart upload was initiated. - Upload ID identifying the multipart upload whose parts are being listed. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListParts service method, as returned by S3. - REST API Reference for ListParts Operation - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). This request returns a maximum of 1,000 - uploaded parts. The default number of parts returned is 1,000 parts. You can restrict - the number of parts returned by specifying the max-parts request parameter. - If your multipart upload consists of more than 1,000 parts, the response returns an - IsTruncated field with the value of true, and a NextPartNumberMarker - element. In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListParts: - - - - Container for the necessary parameters to execute the ListParts service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListParts service method, as returned by S3. - REST API Reference for ListParts Operation - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - Container for the necessary parameters to execute the ListVersions service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - - Creates a new bucket. To create a bucket, you must register with Amazon S3 and have - a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed - to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information on bucket naming restrictions, - see Working - with Amazon S3 Buckets. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) - Region. For more information, see How - to Select a Region for Your Buckets. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - Hosting of Buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - The name of the bucket to create. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucket service method, as returned by S3. - REST API Reference for PutBucket Operation - - - - Creates a new bucket. To create a bucket, you must register with Amazon S3 and have - a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed - to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information on bucket naming restrictions, - see Working - with Amazon S3 Buckets. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) - Region. For more information, see How - to Select a Region for Your Buckets. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - Hosting of Buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - Container for the necessary parameters to execute the PutBucket service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucket service method, as returned by S3. - REST API Reference for PutBucket Operation - - - - Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration - is a bucket-level feature that enables you to perform faster data transfers to Amazon - S3. - - - - To use this operation, you must have permission to perform the s3:PutAccelerateConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The Transfer Acceleration state of a bucket can be set to one of the following two - values: - -
  • - - Enabled – Enables accelerated data transfers to the bucket. - -
  • - - Suspended – Disables accelerated data transfers to the bucket. - -
- - The GetBucketAccelerateConfiguration operation returns the transfer acceleration - state of a bucket. - - - - After setting the Transfer Acceleration state of a bucket to Enabled, it might take - up to thirty minutes before the data transfer rates to the bucket increase. - - - - The name of the bucket used for Transfer Acceleration must be DNS-compliant and must - not contain periods ("."). - - - - For more information about transfer acceleration, see Transfer - Acceleration. - - - - The following operations are related to PutBucketAccelerateConfiguration: - - - - Container for the necessary parameters to execute the PutBucketAccelerateConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketAccelerateConfiguration service method, as returned by S3. - REST API Reference for PutBucketAccelerateConfiguration Operation - - - - - - - Set the logging parameters for a bucket and to specify permissions for who can view - and modify the logging parameters. All logs are saved to buckets in the same AWS Region - as the source bucket. To set the logging status of a bucket, you must be the bucket - owner. - - - - The bucket owner is automatically granted FULL_CONTROL to all logs. You use the Grantee - request element to grant access to other people. The Permissions request - element specifies the kind of access the grantee has to the logs. - - - - Grantee Values - - - - You can specify the person (grantee) to whom you're assigning access rights (using - request elements) in the following ways: - -
  • - - By the person's ID: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> - </Grantee> - - - - DisplayName is optional and ignored in the request. - -
  • - - By Email address: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee> - - - - - The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl - request, appears as the CanonicalUser. - -
  • - - By URI: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee> - - -
- - To enable logging, you use LoggingEnabled and its children request elements. To disable - logging, you use an empty BucketLoggingStatus request element: - - - - <BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01" /> - - - - - For more information about server access logging, see Server - Access Logging. - - - - For more information about creating a bucket, see CreateBucket. For more information - about returning the logging status of a bucket, see GetBucketLogging. - - - - The following operations are related to PutBucketLogging: - - - - Container for the necessary parameters to execute the PutBucketLogging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketLogging service method, as returned by S3. - REST API Reference for PutBucketLogging Operation - - - - Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. - You can have up to 1,000 metrics configurations per bucket. If you're updating an - existing metrics configuration, note that this is a full replacement of the existing - metrics configuration. If you don't include the elements you want to keep, they are - erased. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to PutBucketMetricsConfiguration: - - - - GetBucketLifecycle has the following special error: - -
  • - - Error code: TooManyConfigurations - -
    • - - Description: You are attempting to create a new configuration but have already reached - the 1,000-configuration limit. - -
    • - - HTTP Status Code: HTTP 400 Bad Request - -
- - Container for the necessary parameters to execute the PutBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for PutBucketMetricsConfiguration Operation - - - - Enables notifications of specified events for a bucket. For more information about - event notifications, see Configuring - Event Notifications. - - - - Using this API, you can replace an existing notification configuration. The configuration - is an XML file that defines the event types that you want Amazon S3 to publish and - the destination where you want Amazon S3 to publish an event notification when it - detects an event of the specified type. - - - - By default, your bucket has no event notifications configured. That is, the notification - configuration will be an empty NotificationConfiguration. - - - - <NotificationConfiguration> - - - - </NotificationConfiguration> - - - - This operation replaces the existing notification configuration with the configuration - you include in the request body. - - - - After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification - Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, - and that the bucket owner has permission to publish to it by sending a test notification. - In the case of AWS Lambda destinations, Amazon S3 verifies that the Lambda function - permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. - For more information, see Configuring - Notifications for Amazon S3 Events. - - - - You can disable notifications by adding the empty NotificationConfiguration element. - - - - By default, only the bucket owner can configure notifications on a bucket. However, - bucket owners can use a bucket policy to grant permission to other users to set this - configuration with s3:PutBucketNotification permission. - - - - The PUT notification is an atomic operation. For example, suppose your notification - configuration includes SNS topic, SQS queue, and Lambda function configurations. When - you send a PUT request with this configuration, Amazon S3 sends test messages to your - SNS topic. If the message fails, the entire PUT operation will fail, and Amazon S3 - will not add the configuration to your bucket. - - - - Responses - - - - If the configuration in the request body includes only one TopicConfiguration - specifying only the s3:ReducedRedundancyLostObject event type, the response - will also include the x-amz-sns-test-message-id header containing the - message ID of the test notification sent to the topic. - - - - The following operation is related to PutBucketNotificationConfiguration: - - - - Container for the necessary parameters to execute the PutBucketNotification service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketNotification service method, as returned by S3. - REST API Reference for PutBucketNotification Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - The MD5 hash of the request body. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - Container for the necessary parameters to execute the PutBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Creates a replication configuration or replaces an existing one. For more information, - see Replication - in the Amazon S3 Developer Guide. - - - - To perform this operation, the user or role performing the operation must have the - iam:PassRole - permission. - - - - Specify the replication configuration in the request body. In the replication configuration, - you provide the name of the destination bucket where you want Amazon S3 to replicate - objects, the IAM role that Amazon S3 can assume to replicate objects on your behalf, - and other relevant information. - - - - A replication configuration must include at least one rule, and can contain a maximum - of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects - in the source bucket. To choose additional subsets of objects to replicate, add a - rule for each subset. All rules must specify the same destination bucket. - - - - To specify a subset of the objects in the source bucket to apply a replication rule - to, add the Filter element as a child of the Rule element. You can filter objects - based on an object key prefix, one or more object tags, or both. When you add the - Filter element in the configuration, you must also add the following elements: DeleteMarkerReplication, - Status, and Priority. - - - - For information about enabling versioning on a bucket, see Using - Versioning. - - - - By default, a resource owner, in this case the AWS account that created the bucket, - can perform this operation. The resource owner can also grant others permissions to - perform the operation. For more information about permissions, see Specifying - Permissions in a Policy and Managing - Access Permissions to Your Amazon S3 Resources. - - - - Handling Replication of Encrypted Objects - - - - By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side - encryption with CMKs stored in AWS KMS. To replicate AWS KMS-encrypted objects, add - the following: SourceSelectionCriteria, SseKmsEncryptedObjects, - Status, EncryptionConfiguration, and ReplicaKmsKeyID. - For information about replication configuration, see Replicating - Objects Created with SSE Using CMKs stored in AWS KMS. - - - - For information on PutBucketReplication errors, see ReplicationErrorCodeList - - - - - The following operations are related to PutBucketReplication: - - - - Container for the necessary parameters to execute the PutBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketReplication service method, as returned by S3. - REST API Reference for PutBucketReplication Operation - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - The bucket name. - Container for Payer. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketRequestPayment service method, as returned by S3. - REST API Reference for PutBucketRequestPayment Operation - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - Container for the necessary parameters to execute the PutBucketRequestPayment service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketRequestPayment service method, as returned by S3. - REST API Reference for PutBucketRequestPayment Operation - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging. - - - - Within a bucket, if you add a tag that has the same key as an existing tag, the new - value overwrites the old value. For more information, see Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional operation is currently in progress against - this resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - The bucket name. - A property of PutBucketTaggingRequest used to execute the PutBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketTagging service method, as returned by S3. - REST API Reference for PutBucketTagging Operation - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging. - - - - Within a bucket, if you add a tag that has the same key as an existing tag, the new - value overwrites the old value. For more information, see Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional operation is currently in progress against - this resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - Container for the necessary parameters to execute the PutBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketTagging service method, as returned by S3. - REST API Reference for PutBucketTagging Operation - - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT operation requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - Amazon S3 has a limitation of 50 routing rules per website configuration. If you require - more than 50 routing rules, you can use object redirect. For more information, see - Configuring - an Object Redirect in the Amazon Simple Storage Service Developer Guide. - - - The bucket name. - Container for the request. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketWebsite service method, as returned by S3. - REST API Reference for PutBucketWebsite Operation - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT operation requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - Amazon S3 has a limitation of 50 routing rules per website configuration. If you require - more than 50 routing rules, you can use object redirect. For more information, see - Configuring - an Object Redirect in the Amazon Simple Storage Service Developer Guide. - - - Container for the necessary parameters to execute the PutBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketWebsite service method, as returned by S3. - REST API Reference for PutBucketWebsite Operation - - - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - The name of the bucket for which to set the configuration. - A property of PutLifecycleConfigurationRequest used to execute the PutLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutLifecycleConfiguration service method, as returned by S3. - REST API Reference for PutLifecycleConfiguration Operation - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - Container for the necessary parameters to execute the PutLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutLifecycleConfiguration service method, as returned by S3. - REST API Reference for PutLifecycleConfiguration Operation - - - - - - - - - - - - - - - - - The base class for requests that return Amazon S3 objects. - - - - - Gets or sets the name of the bucket. - - - The name of the bucket. - - - - - Gets whether or not the bucket name is set. - - - A value of true if the bucket name is set. - Returns false if otherwise. - - - - - Gets or sets the key under which the Amazon S3 object is stored. - - - The key under which the Amazon S3 object is stored. - - - - - Gets whether or not the key property is set. - - - A value of true if key property is set. - Returns false if otherwise. - - - - - Gets or sets the version ID of the Amazon S3 object. - - - The version ID of the Amazon S3 object. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or - ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Gets or sets the ModifiedSinceDate property. - - - The ModifiedSinceDate property. - - - - - Gets or sets the ModifiedSinceDate property. - - - The ModifiedSinceDate property. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or - UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Gets or sets the UnmodifiedSinceDate property. - - - The UnmodifiedSinceDate property. - - - - - Gets or sets the UnmodifiedSinceDate property. - - - The UnmodifiedSinceDate property. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to decrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - The base class TransferUtility request classes. - - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - - Gets the Amazon S3 client used for making calls into Amazon S3. - - - The Amazon S3 client used for making calls into Amazon S3. - - - - - Uploads the specified file. - The object key is derived from the file's name. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the specified file. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the contents of the specified stream. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The stream to read to obtain the content to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the stream to. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the file or stream specified by the request. - To track the progress of the upload, - add an event listener to the request's UploadProgressEvent. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - Contains all the parameters required to upload to Amazon S3. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Aborts the multipart uploads that were initiated before the specified date. - - - The name of the bucket containing multipart uploads. - - - The date before which the multipart uploads were initiated. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the content from Amazon S3 and writes it to the specified file. - If the key is not specified in the request parameter, - the file name will used as the key name. - - - Contains all the parameters required to download an Amazon S3 object. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Returns a stream from which the caller can read the content from the specified - Amazon S3 bucket and key. - The caller of this method is responsible for closing the stream. - - - The name of the bucket. - - - The object key. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Returns a stream to read the contents from Amazon S3 as - specified by the TransferUtilityOpenStreamRequest. - The caller of this method is responsible for closing the stream. - - - Contains all the parameters required for the OpenStream operation. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - - Constructs a new class. - - - The AWS Access Key ID. - - - The AWS Secret Access Key. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new class. - - - The AWS Access Key ID. - - - The AWS Secret Access Key. - - - The region to configure the transfer utility for. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new instance of the class. - - - The AWS Access Key ID. - - - The AWS Secret Access Key. - - - Specifies advanced settings. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new instance of the class. - - - The AWS Access Key ID. - - - The AWS Secret Access Key. - - - The region to configure the transfer utility for. - - - Specifies advanced settings. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new instance of the class. - - - The Amazon S3 client. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Initializes a new instance of the class. - - - The Amazon S3 client. - - - Specifies advanced configuration settings for . - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Gets the Amazon S3 client used for making calls into Amazon S3. - - - The Amazon S3 client used for making calls into Amazon S3. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Uploads the specified file. - The object key is derived from the file's name. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the specified file. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the contents of the specified stream. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The stream to read to obtain the content to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the stream to. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the file or stream specified by the request. - To track the progress of the upload, - add an event listener to the request's UploadProgressEvent. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - Contains all the parameters required to upload to Amazon S3. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Aborts the multipart uploads that were initiated before the specified date. - - - The name of the bucket containing multipart uploads. - - - The date before which the multipart uploads were initiated. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the content from Amazon S3 and writes it to the specified file. - If the key is not specified in the request parameter, - the file name will used as the key name. - - - Contains all the parameters required to download an Amazon S3 object. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Returns a stream from which the caller can read the content from the specified - Amazon S3 bucket and key. - The caller of this method is responsible for closing the stream. - - - The name of the bucket. - - - The object key. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Returns a stream to read the contents from Amazon S3 as - specified by the TransferUtilityOpenStreamRequest. - The caller of this method is responsible for closing the stream. - - - Contains all the parameters required for the OpenStream operation. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - - Provides configuration options for how processes requests. - - - The best configuration settings depend on network - configuration, latency and bandwidth. - The default configuration settings are suitable - for most applications, but this class enables developers to experiment with - different configurations and tune transfer manager performance. - - - - - - Default constructor. - - - - - Gets or sets the minimum part size for upload parts in bytes. The default is 16 MB. - Decreasing the minimum part size causes - multipart uploads to be split into a larger number - of smaller parts. Setting this value too low has a negative effect - on transfer speeds, causing extra latency and network - communication for each part. - - - - - This property determines how many active threads - or the number of concurrent asynchronous web requests - will be used to upload/download the file . - The default value is 10. - - - A value less than or equal to 0 will be silently ignored. - - - - - Gets or sets the number of executing threads. - This property determines how many active threads will be used to upload - the file. The default value is 10 threads. - - - A value less than or equal to 0 will be silently ignored. - - - - - Contains all the parameters - that can be set when making a this request with the - TransferUtility method. - - - - - Get or sets the file path location of where the - downloaded Amazon S3 object will be written to. - - - The file path location of where the downloaded Amazon S3 object will be written to. - - - - - Checks if FilePath property is set. - - True if FilePath property is set. - - - - The event for WriteObjectProgressEvent notifications. All - subscribers will be notified when a new progress - event is raised. - - The WriteObjectProgressEvent is fired as data - is downloaded from S3. The delegates attached to the event - will be passed information detailing how much data - has been downloaded as well as how much will be downloaded. - - - - Subscribe to this event if you want to receive - WriteObjectProgressEvent notifications. Here is how:
- 1. Define a method with a signature similar to this one: - - private void displayProgress(object sender, WriteObjectProgressArgs args) - { - Console.WriteLine(args); - } - - 2. Add this method to the WriteObjectProgressEvent delegate's invocation list - - TransferUtilityDownloadRequest request = new TransferUtilityDownloadRequest(); - request.WriteObjectProgressEvent += displayProgress; - - - - - - Causes the WriteObjectProgressEvent event to be fired. - - Progress data for the stream being written to file. - - - - Contains all the parameters - that can be set when making a this request with the - TransferUtility method. - - - - - Contains all the parameters - that can be set when making a this request with the - TransferUtility method. - - - - - Gets or sets the name of the bucket. - - - The name of the bucket. - - - - - Checks if BucketName property is set. - - true if BucketName property is set. - - - - Gets or sets the key under which the Amazon S3 object is to be stored. - - - The key under which the Amazon S3 object is to be stored. - - - - - Checks if Key property is set. - - true if Key property is set. - - - - Gets or sets the canned access control list (ACL) - for the uploaded object. - Please refer to - for - information on Amazon S3 canned ACLs. - - - The canned access control list (ACL) - for the uploaded object. - - - - - Checks if the CannedACL property is set. - - true if there is the CannedACL property is set. - - - - Removes the cannned access control list (ACL) - for the uploaded object. - - - - - Gets or sets the content type of the uploaded Amazon S3 object. - - - The content type of the uploaded Amazon S3 object. - - - - - Checks if ContentType property is set. - - true if ContentType property is set. - - - - Gets or sets the storage class for the uploaded Amazon S3 object. - Please refer to - for - information on S3 Storage Classes. - - - The storage class for the uploaded Amazon S3 object. - - - - - Gets and sets the ServerSideEncryptionMethod property. - Specifies the encryption used on the server to - store the content. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Input stream for the request; content for the request will be read from the stream. - - - - - - Gets or sets the file path - where the Amazon S3 object will be uploaded from. - - - For WinRT and Windows Phone this property must be in the form of "ms-appdata:///local/file.txt". - - - - The file path where the Amazon S3 object will be uploaded from. - - - - - Checks if FilePath property is set. - - true if FilePath property is set. - - - - Gets or sets the part size of the upload in bytes. - The uploaded file will be divided into - parts the size specified and - uploaded to Amazon S3 individually. - - - The part size of the upload. - - - - - Checks if PartSize property is set. - - true if PartSize property is set. - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - The tag-set for the object. - - - - - The event for UploadProgressEvent notifications. All - subscribers will be notified when a new progress - event is raised. - - The UploadProgressEvent is fired as data - is uploaded to S3. The delegates attached to the event - will be passed information detailing how much data - has been uploaded as well as how much will be uploaded. - - - - Subscribe to this event if you want to receive - UploadProgressEvent notifications. Here is how:
- 1. Define a method with a signature similar to this one: - - private void displayProgress(object sender, UploadProgressArgs args) - { - Console.WriteLine(args); - } - - 2. Add this method to the UploadProgressEvent delegate's invocation list - - TransferUtilityUploadRequest request = new TransferUtilityUploadRequest(); - request.UploadProgressEvent += displayProgress; - - - - - - Causes the UploadProgressEvent event to be fired. - - Progress data for the file being uploaded. - - - - Gets the length of the content by either checking the FileInfo.Length property or the Stream.Length property. - - The length of the content. - - - - Gets or sets whether or not the stream used with this request is - automatically closed when all of the content is read from the stream. - - - A value of true if the if the stream is - automatically closed when all of the content is read from the stream. - A value of false if otherwise. - - - - - If this value is set to true then the stream's position will be reset to the start before being read for upload. - Default: true. - - - - - Sets whether or not the stream used with this request is - automatically closed when all of the content is read from the stream - and returns this object instance, - enabling additional method calls to be chained together. - - - A value of true if the if the stream is - automatically closed when all of the content is read from the stream. - A value of false if otherwise. - - - This object instance, enabling additional method calls to be chained together. - - - - - Encapsulates the information needed to provide - transfer progress to subscribers of the Put Object - Event. - - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The how many bytes were transferred since last event. - The number of bytes transferred - The total number of bytes to be transferred - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The how many bytes were transferred since last event. - The number of bytes transferred - The total number of bytes to be transferred - The file being uploaded - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The how many bytes were transferred since last event. - The number of bytes transferred - The total number of bytes to be transferred - A compensation for any upstream aggregators if this event to correct theit totalTransferred count, - in case the underlying request is retried. - The file being uploaded - - - - Gets the FilePath. - - - - - Waits for all of the tasks to complete or till any task fails or is canceled. - - - - - Waits for all of the tasks to complete or till any task fails or is canceled. - - - - - Returns the amount of bytes remaining that need to be pulled down from S3. - - The fully qualified path of the file. - - - - - The command to manage an upload using the S3 multipart API. - - - - - Initializes a new instance of the class. - - The s3 client. - The config object that has the number of threads to use. - The file transporter request. - - - - This command is for doing regular PutObject requests. - - - - - Configuration for the S3 section of AWS configuration. - Changes to some settings may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws> - <s3 useSignatureVersion4="true" /> - </aws> - - - - - - Key for the S3UseSignatureVersion4Key property. - - - - - - Configures if the S3 client should use Signature Version 4 signing with requests. - By default, this setting is set to true which will use Signature Version 4 for all - requests except presigned URL requests when the region is set to us-east-1. When - UseSignatureVersion4 is explicitly set to true by directly setting this property or - directly setting this property through configuration, Signature Version 4 will be - used for all requests when able to do so. - When this setting is false, Signature Version 2 will be used. Note that when the - setting is false, Signature Version 4 may still be used by default in some cases - or with some regions. - - - - - Escape and unescape S3 metadata for S3 Put/Get object requests. - Escape only escapes non-ascii values in metadata - Any "%" values in metadata could interfere with this option. - Default value is false. - - - - - Was the value of the UseSignatureVersion4 property set explicitly? - This can be done via configuration or by directly setting the property. - - This is used to determine if the user set UseSignatureVersion4 to true, - or if it's true because the default was changed to true in the SDK. - - - - diff --git a/packages/AWSSDK.S3.3.3.111.14/lib/MonoTouch10/AWSSDK.S3.dll b/packages/AWSSDK.S3.3.3.111.14/lib/MonoTouch10/AWSSDK.S3.dll deleted file mode 100644 index 0610561..0000000 Binary files a/packages/AWSSDK.S3.3.3.111.14/lib/MonoTouch10/AWSSDK.S3.dll and /dev/null differ diff --git a/packages/AWSSDK.S3.3.3.111.14/lib/Xamarin.iOS10/AWSSDK.S3.XML b/packages/AWSSDK.S3.3.3.111.14/lib/Xamarin.iOS10/AWSSDK.S3.XML deleted file mode 100644 index 389da7c..0000000 --- a/packages/AWSSDK.S3.3.3.111.14/lib/Xamarin.iOS10/AWSSDK.S3.XML +++ /dev/null @@ -1,28560 +0,0 @@ - - - - AWSSDK.S3 - - - - - Implementation for accessing S3 - - - - - - - Specialize the initialize of the client. - - - - - Create a signed URL allowing access to a resource that would - usually require authentication. - - - - When using query string authentication you create a query, - specify an expiration time for the query, sign it with your - signature, place the data in an HTTP request, and distribute - the request to a user or embed the request in a web page. - - - A PreSigned URL can be generated for GET, PUT, DELETE and HEAD - operations on your bucketName, keys, and versions. - - - The GetPreSignedUrlRequest that defines the - parameters of the operation. - determines if signing will fall back to SigV2 if the - signing region is us-east-1 - A string that is the signed http request. - - - - - - Marshalls the parameters for a presigned url for a preferred signing protocol. - - - - - - True if AWS4 signing will be used; if the expiry period in the request exceeds the - maximum allowed for AWS4 (one week), an ArgumentException is thrown. - - - - - - Create a signed URL allowing access to a resource that would - usually require authentication. - - - - When using query string authentication you create a query, - specify an expiration time for the query, sign it with your - signature, place the data in an HTTP request, and distribute - the request to a user or embed the request in a web page. - - - A PreSigned URL can be generated for GET, PUT, DELETE and HEAD - operations on your bucketName, keys, and versions. - - - The GetPreSignedUrlRequest that defines the - parameters of the operation. - A string that is the signed http request. - - - - - - Constructs AmazonS3Client with AWS Credentials - - AWS Credentials - - - - Constructs AmazonS3Client with AWS Credentials - - AWS Credentials - The region to connect. - - - - Constructs AmazonS3Client with AWS Credentials and an - AmazonS3Client Configuration object. - - AWS Credentials - The AmazonS3Client Configuration Object - - - - Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - - - - Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - The region to connect. - - - - Constructs AmazonS3Client with AWS Access Key ID, AWS Secret Key and an - AmazonS3Client Configuration object. - - AWS Access Key ID - AWS Secret Access Key - The AmazonS3Client Configuration Object - - - - Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - - - - Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - The region to connect. - - - - Constructs AmazonS3Client with AWS Access Key ID, AWS Secret Key and an - AmazonS3Client Configuration object. - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - The AmazonS3Client Configuration Object - - - - Creates the signer for the service. - - - - - Customizes the runtime pipeline. - - Runtime pipeline for the current client. - - - - Capture metadata for the service. - - - - - Disposes the service client. - - - - - This operation aborts a multipart upload. After a multipart upload is aborted, no - additional parts can be uploaded using that upload ID. The storage consumed by any - previously uploaded parts will be freed. However, if any part uploads are currently - in progress, those part uploads might or might not succeed. As a result, it might - be necessary to abort a given multipart upload multiple times in order to completely - free all storage consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts operation and ensure that the parts - list is empty. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - The bucket name to which the upload was taking place. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object for which the multipart upload was initiated. - Upload ID that identifies the multipart upload. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AbortMultipartUpload service method, as returned by S3. - REST API Reference for AbortMultipartUpload Operation - - - - This operation aborts a multipart upload. After a multipart upload is aborted, no - additional parts can be uploaded using that upload ID. The storage consumed by any - previously uploaded parts will be freed. However, if any part uploads are currently - in progress, those part uploads might or might not succeed. As a result, it might - be necessary to abort a given multipart upload multiple times in order to completely - free all storage consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts operation and ensure that the parts - list is empty. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - Container for the necessary parameters to execute the AbortMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AbortMultipartUpload service method, as returned by S3. - REST API Reference for AbortMultipartUpload Operation - - - - Completes a multipart upload by assembling previously uploaded parts. - - - - You first initiate the multipart upload and then upload all parts using the UploadPart - operation. After successfully uploading all relevant parts of an upload, you call - this operation to complete the upload. Upon receiving this request, Amazon S3 concatenates - all the parts in ascending order by part number to create a new object. In the Complete - Multipart Upload request, you must provide the parts list. You must ensure that the - parts list is complete. This operation concatenates the parts that you provide in - the list. For each part in the list, you must provide the part number and the ETag - value, returned after that part was uploaded. - - - - Processing of a Complete Multipart Upload request could take several minutes to complete. - After Amazon S3 begins processing the request, it sends an HTTP response header that - specifies a 200 OK response. While processing is in progress, Amazon S3 periodically - sends white space characters to keep the connection from timing out. Because a request - could fail after the initial 200 OK response has been sent, it is important that you - check the response body to determine whether the request succeeded. - - - - Note that if CompleteMultipartUpload fails, applications should be prepared - to retry the failed requests. For more information, see Amazon - S3 Error Best Practices. - - - - For more information about multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - GetBucketLifecycle has the following special errors: - -
  • - - Error code: EntityTooSmall - -
    • - - Description: Your proposed upload is smaller than the minimum allowed object size. - Each part must be at least 5 MB in size, except the last part. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPart - -
    • - - Description: One or more of the specified parts could not be found. The part might - not have been uploaded, or the specified entity tag might not have matched the part's - entity tag. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPartOrder - -
    • - - Description: The list of parts was not in ascending order. The parts list must be - specified in order by part number. - -
    • - - 400 Bad Request - -
  • - - Error code: NoSuchUpload - -
    • - - Description: The specified multipart upload does not exist. The upload ID might be - invalid, or the multipart upload might have been aborted or completed. - -
    • - - 404 Not Found - -
- - The following operations are related to CompleteMultipartUpload: - - - - Container for the necessary parameters to execute the CompleteMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CompleteMultipartUpload service method, as returned by S3. - REST API Reference for CompleteMultipartUpload Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 Developer Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Encryption - - - - The source object that you are copying can be encrypted or unencrypted. The source - object can be encrypted with server-side encryption using AWS managed encryption keys - (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side - encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers - and decrypts the data when you access it. - - - - You can optionally use the appropriate encryption-related headers to request server-side - encryption for the target object. You have the option to provide your own encryption - key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that - was used to encrypt the source object. You can even request encryption if the source - object was not encrypted. For more information about server-side encryption, see Using - Server-Side Encryption. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject operation to change the storage class of an - object that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 Service Developer Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 Developer Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Encryption - - - - The source object that you are copying can be encrypted or unencrypted. The source - object can be encrypted with server-side encryption using AWS managed encryption keys - (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side - encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers - and decrypts the data when you access it. - - - - You can optionally use the appropriate encryption-related headers to request server-side - encryption for the target object. You have the option to provide your own encryption - key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that - was used to encrypt the source object. You can even request encryption if the source - object was not encrypted. For more information about server-side encryption, see Using - Server-Side Encryption. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject operation to change the storage class of an - object that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 Service Developer Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 Developer Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Encryption - - - - The source object that you are copying can be encrypted or unencrypted. The source - object can be encrypted with server-side encryption using AWS managed encryption keys - (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side - encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers - and decrypts the data when you access it. - - - - You can optionally use the appropriate encryption-related headers to request server-side - encryption for the target object. You have the option to provide your own encryption - key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that - was used to encrypt the source object. You can even request encryption if the source - object was not encrypted. For more information about server-side encryption, see Using - Server-Side Encryption. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject operation to change the storage class of an - object that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 Service Developer Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - Container for the necessary parameters to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - - - - - - Deletes an analytics configuration for the bucket (specified by the analytics configuration - ID). - - - - To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to DeleteBucketAnalyticsConfiguration: - -
  • - - - -
  • - - - -
  • - - - -
- - Container for the necessary parameters to execute the DeleteBucketAnalyticsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketAnalyticsConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketAnalyticsConfiguration Operation - - - - - Deletes an inventory configuration (identified by the inventory ID) from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - Operations related to DeleteBucketInventoryConfiguration include: - - - - Container for the necessary parameters to execute the DeleteBucketInventoryConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketInventoryConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketInventoryConfiguration Operation - - - - Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified - by the metrics configuration ID) from the bucket. Note that this doesn't include the - daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketMetricsConfiguration Operation - - - - This implementation of the DELETE operation uses the policy subresource to delete - the policy of a specified bucket. If you are using an identity other than the root - user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - The bucket name. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketPolicy service method, as returned by S3. - REST API Reference for DeleteBucketPolicy Operation - - - - This implementation of the DELETE operation uses the policy subresource to delete - the policy of a specified bucket. If you are using an identity other than the root - user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - Container for the necessary parameters to execute the DeleteBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketPolicy service method, as returned by S3. - REST API Reference for DeleteBucketPolicy Operation - - - - Deletes the replication configuration from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutReplicationConfiguration - action. The bucket owner has these permissions by default and can grant it to others. - For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - It can take a while for the deletion of a replication configuration to fully propagate. - - - - For information about replication configuration, see Replication - in the Amazon S3 Developer Guide. - - - - The following operations are related to DeleteBucketReplication: - - - - Container for the necessary parameters to execute the DeleteBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketReplication service method, as returned by S3. - REST API Reference for DeleteBucketReplication Operation - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - The bucket that has the tag set to be removed. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketTagging service method, as returned by S3. - REST API Reference for DeleteBucketTagging Operation - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - Container for the necessary parameters to execute the DeleteBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketTagging service method, as returned by S3. - REST API Reference for DeleteBucketTagging Operation - - - - This operation removes the website configuration for a bucket. Amazon S3 returns a - 200 OK response upon successfully deleting a website configuration on - the specified bucket. You will get a 200 OK response if the website configuration - you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE operation requires the S3:DeleteBucketWebsite permission. - By default, only the bucket owner can delete the website configuration attached to - a bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which you want to remove the website configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketWebsite service method, as returned by S3. - REST API Reference for DeleteBucketWebsite Operation - - - - This operation removes the website configuration for a bucket. Amazon S3 returns a - 200 OK response upon successfully deleting a website configuration on - the specified bucket. You will get a 200 OK response if the website configuration - you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE operation requires the S3:DeleteBucketWebsite permission. - By default, only the bucket owner can delete the website configuration attached to - a bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the DeleteBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketWebsite service method, as returned by S3. - REST API Reference for DeleteBucketWebsite Operation - - - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - The bucket name of the lifecycle to delete. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - REST API Reference for DeleteLifecycleConfiguration Operation - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - Container for the necessary parameters to execute the DeleteLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - REST API Reference for DeleteLifecycleConfiguration Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key name of the object to delete. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key name of the object to delete. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - Container for the necessary parameters to execute the DeleteObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - This operation enables you to delete multiple objects from a bucket using a single - HTTP request. If you know the object keys that you want to delete, then this operation - provides a suitable alternative to sending individual delete requests, reducing per-request - overhead. - - - - The request contains a list of up to 1000 keys that you want to delete. In the XML, - you provide the object key names, and optionally, version IDs if you want to delete - a specific version of the object from a versioning-enabled bucket. For each key, Amazon - S3 performs a delete operation and returns the result of that delete, success, or - failure, in the response. Note that if the object specified in the request is not - found, Amazon S3 returns the result as deleted. - - - - The operation supports two modes for the response: verbose and quiet. By default, - the operation uses verbose mode in which the response includes the result of deletion - of each key in your request. In quiet mode the response includes only keys where the - delete operation encountered an error. For a successful deletion, the operation does - not return any information about the delete in the response body. - - - - When performing this operation on an MFA Delete enabled bucket, that attempts to delete - any versioned objects, you must include an MFA token. If you do not provide one, the - entire request will fail, even if there are non-versioned objects you are trying to - delete. If you provide an invalid token, whether there are versioned keys in the request - or not, the entire Multi-Object Delete request will fail. For information about MFA - Delete, see - MFA Delete. - - - - Finally, the Content-MD5 header is required for all Multi-Object Delete requests. - Amazon S3 uses the header value to ensure that your request body has not been altered - in transit. - - - - The following operations are related to DeleteObjects: - - - - Container for the necessary parameters to execute the DeleteObjects service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObjects service method, as returned by S3. - REST API Reference for DeleteObjects Operation - - - - Removes the entire tag set from the specified object. For more information about managing - object tags, see - Object Tagging. - - - - To use this operation, you must have permission to perform the s3:DeleteObjectTagging - action. - - - - To delete tags of a specific object version, add the versionId query - parameter in the request. You will need permission for the s3:DeleteObjectVersionTagging - action. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteObjectTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObjectTagging service method, as returned by S3. - REST API Reference for DeleteObjectTagging Operation - - - - Removes the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:PutBucketPublicAccessBlock - permission. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to DeletePublicAccessBlock: - - - - Container for the necessary parameters to execute the DeletePublicAccessBlock service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeletePublicAccessBlock service method, as returned by S3. - REST API Reference for DeletePublicAccessBlock Operation - - - - - - - - - Returns the default encryption configuration for an Amazon S3 bucket. For information - about the Amazon S3 default encryption feature, see Amazon - S3 Default Bucket Encryption. - - - - To use this operation, you must have permission to perform the s3:GetEncryptionConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to GetBucketEncryption: - - - - Container for the necessary parameters to execute the GetBucketEncryption service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketEncryption service method, as returned by S3. - REST API Reference for GetBucketEncryption Operation - - - - Returns an inventory configuration (identified by the inventory configuration ID) - from the bucket. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - The following operations are related to GetBucketInventoryConfiguration: - - - - Container for the necessary parameters to execute the GetBucketInventoryConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketInventoryConfiguration service method, as returned by S3. - REST API Reference for GetBucketInventoryConfiguration Operation - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - The name of the bucket for which to get the location. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLocation service method, as returned by S3. - REST API Reference for GetBucketLocation Operation - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - Container for the necessary parameters to execute the GetBucketLocation service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLocation service method, as returned by S3. - REST API Reference for GetBucketLocation Operation - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - The bucket name for which to get the logging information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLogging service method, as returned by S3. - REST API Reference for GetBucketLogging Operation - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - Container for the necessary parameters to execute the GetBucketLogging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLogging service method, as returned by S3. - REST API Reference for GetBucketLogging Operation - - - - Gets a metrics configuration (specified by the metrics configuration ID) from the - bucket. Note that this doesn't include the daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to GetBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the GetBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for GetBucketMetricsConfiguration Operation - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following operation is related to GetBucketNotification: - - - - Name of the bucket for which to get the notification configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketNotification service method, as returned by S3. - REST API Reference for GetBucketNotification Operation - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following operation is related to GetBucketNotification: - - - - Container for the necessary parameters to execute the GetBucketNotification service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketNotification service method, as returned by S3. - REST API Reference for GetBucketNotification Operation - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operation is related to GetBucketPolicy: - - - - The bucket name for which to get the bucket policy. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicy service method, as returned by S3. - REST API Reference for GetBucketPolicy Operation - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operation is related to GetBucketPolicy: - - - - Container for the necessary parameters to execute the GetBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicy service method, as returned by S3. - REST API Reference for GetBucketPolicy Operation - - - - Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket - is public. In order to use this operation, you must have the s3:GetBucketPolicyStatus - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - For more information about when Amazon S3 considers a bucket public, see The - Meaning of "Public". - - - - The following operations are related to GetBucketPolicyStatus: - - - - Container for the necessary parameters to execute the GetBucketPolicyStatus service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicyStatus service method, as returned by S3. - REST API Reference for GetBucketPolicyStatus Operation - - - - Retrieves the replication configuration for the given Amazon S3 bucket. - - Container for the necessary parameters to execute the GetBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketReplication service method, as returned by S3. - REST API Reference for GetBucketReplication Operation - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - The name of the bucket for which to get the payment request configuration - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketRequestPayment service method, as returned by S3. - REST API Reference for GetBucketRequestPayment Operation - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - Container for the necessary parameters to execute the GetBucketRequestPayment service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketRequestPayment service method, as returned by S3. - REST API Reference for GetBucketRequestPayment Operation - - - - Returns the tag set associated with the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - GetBucketTagging has the following special error: - -
  • - - Error code: NoSuchTagSetError - -
    • - - Description: There is no tag set associated with the bucket. - -
- - The following operations are related to GetBucketTagging: - - - - Container for the necessary parameters to execute the GetBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketTagging service method, as returned by S3. - REST API Reference for GetBucketTagging Operation - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - The name of the bucket for which to get the versioning information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketVersioning service method, as returned by S3. - REST API Reference for GetBucketVersioning Operation - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - Container for the necessary parameters to execute the GetBucketVersioning service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketVersioning service method, as returned by S3. - REST API Reference for GetBucketVersioning Operation - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET operation requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which to get the website configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketWebsite service method, as returned by S3. - REST API Reference for GetBucketWebsite Operation - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET operation requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the GetBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketWebsite service method, as returned by S3. - REST API Reference for GetBucketWebsite Operation - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - The bucket name for which to get the cors configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetCORSConfiguration service method, as returned by S3. - REST API Reference for GetCORSConfiguration Operation - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - Container for the necessary parameters to execute the GetCORSConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetCORSConfiguration service method, as returned by S3. - REST API Reference for GetCORSConfiguration Operation - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are still using previous version of the lifecycle configuration, it works. - For the earlier API description, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to GetBucketLifecycleConfiguration: - - - - The name of the bucket for which to get the lifecycle information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetLifecycleConfiguration service method, as returned by S3. - REST API Reference for GetLifecycleConfiguration Operation - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are still using previous version of the lifecycle configuration, it works. - For the earlier API description, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to GetBucketLifecycleConfiguration: - - - - Container for the necessary parameters to execute the GetLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetLifecycleConfiguration service method, as returned by S3. - REST API Reference for GetLifecycleConfiguration Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object to get. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object to get. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - Container for the necessary parameters to execute the GetObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Gets an object's current Legal Hold status. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLegalHold service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectLegalHold service method, as returned by S3. - REST API Reference for GetObjectLegalHold Operation - - - - Gets the Object Lock configuration for a bucket. The rule specified in the Object - Lock configuration will be applied by default to every new object placed in the specified - bucket. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLockConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectLockConfiguration service method, as returned by S3. - REST API Reference for GetObjectLockConfiguration Operation - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - The name of the bucket containing the object. - The object key. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - The name of the bucket containing the object. - The object key. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - Container for the necessary parameters to execute the GetObjectMetadata service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - Retrieves an object's retention settings. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectRetention service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectRetention service method, as returned by S3. - REST API Reference for GetObjectRetention Operation - - - - Returns the tag-set of an object. You send the GET request against the tagging subresource - associated with the object. - - - - To use this operation, you must have permission to perform the s3:GetObjectTagging - action. By default, the GET operation returns information about current version of - an object. For a versioned bucket, you can have multiple versions of an object in - your bucket. To retrieve tags of any other version, use the versionId query parameter. - You also need permission for the s3:GetObjectVersionTagging action. - - - - By default, the bucket owner has this permission and can grant this permission to - others. - - - - For information about the Amazon S3 object tagging feature, see Object - Tagging. - - - - The following operation is related to GetObjectTagging: - - - - Container for the necessary parameters to execute the GetObjectTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTagging service method, as returned by S3. - REST API Reference for GetObjectTagging Operation - - - - Return torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Amazon - S3 Torrent. - - - - You can get torrent only for objects that are less than 5 GB in size and that are - not encrypted using server-side encryption with customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - The following operation is related to GetObjectTorrent: - - - - The name of the bucket containing the object for which to get the torrent files. - The object key for which to get the information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTorrent service method, as returned by S3. - REST API Reference for GetObjectTorrent Operation - - - - Return torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Amazon - S3 Torrent. - - - - You can get torrent only for objects that are less than 5 GB in size and that are - not encrypted using server-side encryption with customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - The following operation is related to GetObjectTorrent: - - - - Container for the necessary parameters to execute the GetObjectTorrent service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTorrent service method, as returned by S3. - REST API Reference for GetObjectTorrent Operation - - - - Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:GetBucketPublicAccessBlock - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket - or an object, it checks the PublicAccessBlock configuration for both - the bucket (or the bucket that contains the object) and the bucket owner's account. - If the PublicAccessBlock settings are different between the bucket and - the account, Amazon S3 uses the most restrictive combination of the bucket-level and - account-level settings. - - - - For more information about when Amazon S3 considers a bucket or an object public, - see The - Meaning of "Public". - - - - The following operations are related to GetPublicAccessBlock: - - - - Container for the necessary parameters to execute the GetPublicAccessBlock service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetPublicAccessBlock service method, as returned by S3. - REST API Reference for GetPublicAccessBlock Operation - - - - This operation is useful to determine if a bucket exists and you have permission to - access it. The operation returns a 200 OK if the bucket exists and you - have permission to access it. Otherwise, the operation might return responses such - as 404 Not Found and 403 Forbidden. - - - - To use this operation, you must have permissions to perform the s3:ListBucket - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - Container for the necessary parameters to execute the HeadBucket service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the HeadBucket service method, as returned by S3. - REST API Reference for HeadBucket Operation - - - - This operation initiates a multipart upload and returns an upload ID. This upload - ID is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort operation - and Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload API and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart) and UploadPartCopy) requests must match the headers you - used in the request to initiate the upload by using CreateMultipartUpload. - - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, - kms:GenerateDataKey*, and kms:DescribeKey actions on the - key. These permissions are required because Amazon S3 must decrypt and read data from - the encrypted file parts before it completes the multipart upload. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - The following operations are related to CreateMultipartUpload: - - - - The name of the bucket to which to initiate the upload - Object key for which the multipart upload is to be initiated. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the InitiateMultipartUpload service method, as returned by S3. - REST API Reference for InitiateMultipartUpload Operation - - - - This operation initiates a multipart upload and returns an upload ID. This upload - ID is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort operation - and Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload API and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart) and UploadPartCopy) requests must match the headers you - used in the request to initiate the upload by using CreateMultipartUpload. - - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, - kms:GenerateDataKey*, and kms:DescribeKey actions on the - key. These permissions are required because Amazon S3 must decrypt and read data from - the encrypted file parts before it completes the multipart upload. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - The following operations are related to CreateMultipartUpload: - - - - Container for the necessary parameters to execute the InitiateMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the InitiateMultipartUpload service method, as returned by S3. - REST API Reference for InitiateMultipartUpload Operation - - - - Lists the analytics configurations for the bucket. You can have up to 1,000 analytics - configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. You should always check the IsTruncated element in the response. - If there are no more configurations to list, IsTruncated is set to false. - If there are more configurations to list, IsTruncated is set to true, - and there will be a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to ListBucketAnalyticsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketAnalyticsConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketAnalyticsConfigurations service method, as returned by S3. - REST API Reference for ListBucketAnalyticsConfigurations Operation - - - - Returns a list of inventory configurations for the bucket. You can have up to 1,000 - analytics configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory - - - - The following operations are related to ListBucketInventoryConfigurations: - - - - Container for the necessary parameters to execute the ListBucketInventoryConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketInventoryConfigurations service method, as returned by S3. - REST API Reference for ListBucketInventoryConfigurations Operation - - - - Lists the metrics configurations for the bucket. The metrics configurations are only - for the request metrics of the bucket and do not provide information on daily storage - metrics. You can have up to 1,000 configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For more information about metrics configurations and CloudWatch request metrics, - see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to ListBucketMetricsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketMetricsConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketMetricsConfigurations service method, as returned by S3. - REST API Reference for ListBucketMetricsConfigurations Operation - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBuckets service method, as returned by S3. - REST API Reference for ListBuckets Operation - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - Container for the necessary parameters to execute the ListBuckets service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBuckets service method, as returned by S3. - REST API Reference for ListBuckets Operation - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Container for the necessary parameters to execute the ListMultipartUploads service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. - Limits the response to keys that begin with the specified prefix. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - Container for the necessary parameters to execute the ListObjects service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Make sure to design - your application to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - To use this operation in an AWS Identity and Access Management (IAM) policy, you must - have permissions to perform the s3:ListBucket action. The bucket owner - has this permission by default and can grant this permission to others. For more information - about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - This section describes the latest revision of the API. We recommend that you use this - revised API for application development. For backward compatibility, Amazon S3 continues - to support the prior version of this API, ListObjects. - - - - To get a list of your buckets, see ListBuckets. - - - - The following operations are related to ListObjectsV2: - - - - Container for the necessary parameters to execute the ListObjectsV2 service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjectsV2 service method, as returned by S3. - REST API Reference for ListObjectsV2 Operation - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). This request returns a maximum of 1,000 - uploaded parts. The default number of parts returned is 1,000 parts. You can restrict - the number of parts returned by specifying the max-parts request parameter. - If your multipart upload consists of more than 1,000 parts, the response returns an - IsTruncated field with the value of true, and a NextPartNumberMarker - element. In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListParts: - - - - Name of the bucket to which the parts are being uploaded. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Object key for which the multipart upload was initiated. - Upload ID identifying the multipart upload whose parts are being listed. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListParts service method, as returned by S3. - REST API Reference for ListParts Operation - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). This request returns a maximum of 1,000 - uploaded parts. The default number of parts returned is 1,000 parts. You can restrict - the number of parts returned by specifying the max-parts request parameter. - If your multipart upload consists of more than 1,000 parts, the response returns an - IsTruncated field with the value of true, and a NextPartNumberMarker - element. In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListParts: - - - - Container for the necessary parameters to execute the ListParts service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListParts service method, as returned by S3. - REST API Reference for ListParts Operation - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - Container for the necessary parameters to execute the ListVersions service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - - Creates a new bucket. To create a bucket, you must register with Amazon S3 and have - a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed - to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information on bucket naming restrictions, - see Working - with Amazon S3 Buckets. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) - Region. For more information, see How - to Select a Region for Your Buckets. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - Hosting of Buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - The name of the bucket to create. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucket service method, as returned by S3. - REST API Reference for PutBucket Operation - - - - Creates a new bucket. To create a bucket, you must register with Amazon S3 and have - a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed - to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information on bucket naming restrictions, - see Working - with Amazon S3 Buckets. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) - Region. For more information, see How - to Select a Region for Your Buckets. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - Hosting of Buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - Container for the necessary parameters to execute the PutBucket service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucket service method, as returned by S3. - REST API Reference for PutBucket Operation - - - - Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration - is a bucket-level feature that enables you to perform faster data transfers to Amazon - S3. - - - - To use this operation, you must have permission to perform the s3:PutAccelerateConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The Transfer Acceleration state of a bucket can be set to one of the following two - values: - -
  • - - Enabled – Enables accelerated data transfers to the bucket. - -
  • - - Suspended – Disables accelerated data transfers to the bucket. - -
- - The GetBucketAccelerateConfiguration operation returns the transfer acceleration - state of a bucket. - - - - After setting the Transfer Acceleration state of a bucket to Enabled, it might take - up to thirty minutes before the data transfer rates to the bucket increase. - - - - The name of the bucket used for Transfer Acceleration must be DNS-compliant and must - not contain periods ("."). - - - - For more information about transfer acceleration, see Transfer - Acceleration. - - - - The following operations are related to PutBucketAccelerateConfiguration: - - - - Container for the necessary parameters to execute the PutBucketAccelerateConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketAccelerateConfiguration service method, as returned by S3. - REST API Reference for PutBucketAccelerateConfiguration Operation - - - - - - - Set the logging parameters for a bucket and to specify permissions for who can view - and modify the logging parameters. All logs are saved to buckets in the same AWS Region - as the source bucket. To set the logging status of a bucket, you must be the bucket - owner. - - - - The bucket owner is automatically granted FULL_CONTROL to all logs. You use the Grantee - request element to grant access to other people. The Permissions request - element specifies the kind of access the grantee has to the logs. - - - - Grantee Values - - - - You can specify the person (grantee) to whom you're assigning access rights (using - request elements) in the following ways: - -
  • - - By the person's ID: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> - </Grantee> - - - - DisplayName is optional and ignored in the request. - -
  • - - By Email address: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee> - - - - - The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl - request, appears as the CanonicalUser. - -
  • - - By URI: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee> - - -
- - To enable logging, you use LoggingEnabled and its children request elements. To disable - logging, you use an empty BucketLoggingStatus request element: - - - - <BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01" /> - - - - - For more information about server access logging, see Server - Access Logging. - - - - For more information about creating a bucket, see CreateBucket. For more information - about returning the logging status of a bucket, see GetBucketLogging. - - - - The following operations are related to PutBucketLogging: - - - - Container for the necessary parameters to execute the PutBucketLogging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketLogging service method, as returned by S3. - REST API Reference for PutBucketLogging Operation - - - - Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. - You can have up to 1,000 metrics configurations per bucket. If you're updating an - existing metrics configuration, note that this is a full replacement of the existing - metrics configuration. If you don't include the elements you want to keep, they are - erased. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to PutBucketMetricsConfiguration: - - - - GetBucketLifecycle has the following special error: - -
  • - - Error code: TooManyConfigurations - -
    • - - Description: You are attempting to create a new configuration but have already reached - the 1,000-configuration limit. - -
    • - - HTTP Status Code: HTTP 400 Bad Request - -
- - Container for the necessary parameters to execute the PutBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for PutBucketMetricsConfiguration Operation - - - - Enables notifications of specified events for a bucket. For more information about - event notifications, see Configuring - Event Notifications. - - - - Using this API, you can replace an existing notification configuration. The configuration - is an XML file that defines the event types that you want Amazon S3 to publish and - the destination where you want Amazon S3 to publish an event notification when it - detects an event of the specified type. - - - - By default, your bucket has no event notifications configured. That is, the notification - configuration will be an empty NotificationConfiguration. - - - - <NotificationConfiguration> - - - - </NotificationConfiguration> - - - - This operation replaces the existing notification configuration with the configuration - you include in the request body. - - - - After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification - Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, - and that the bucket owner has permission to publish to it by sending a test notification. - In the case of AWS Lambda destinations, Amazon S3 verifies that the Lambda function - permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. - For more information, see Configuring - Notifications for Amazon S3 Events. - - - - You can disable notifications by adding the empty NotificationConfiguration element. - - - - By default, only the bucket owner can configure notifications on a bucket. However, - bucket owners can use a bucket policy to grant permission to other users to set this - configuration with s3:PutBucketNotification permission. - - - - The PUT notification is an atomic operation. For example, suppose your notification - configuration includes SNS topic, SQS queue, and Lambda function configurations. When - you send a PUT request with this configuration, Amazon S3 sends test messages to your - SNS topic. If the message fails, the entire PUT operation will fail, and Amazon S3 - will not add the configuration to your bucket. - - - - Responses - - - - If the configuration in the request body includes only one TopicConfiguration - specifying only the s3:ReducedRedundancyLostObject event type, the response - will also include the x-amz-sns-test-message-id header containing the - message ID of the test notification sent to the topic. - - - - The following operation is related to PutBucketNotificationConfiguration: - - - - Container for the necessary parameters to execute the PutBucketNotification service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketNotification service method, as returned by S3. - REST API Reference for PutBucketNotification Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - The MD5 hash of the request body. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - Container for the necessary parameters to execute the PutBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Creates a replication configuration or replaces an existing one. For more information, - see Replication - in the Amazon S3 Developer Guide. - - - - To perform this operation, the user or role performing the operation must have the - iam:PassRole - permission. - - - - Specify the replication configuration in the request body. In the replication configuration, - you provide the name of the destination bucket where you want Amazon S3 to replicate - objects, the IAM role that Amazon S3 can assume to replicate objects on your behalf, - and other relevant information. - - - - A replication configuration must include at least one rule, and can contain a maximum - of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects - in the source bucket. To choose additional subsets of objects to replicate, add a - rule for each subset. All rules must specify the same destination bucket. - - - - To specify a subset of the objects in the source bucket to apply a replication rule - to, add the Filter element as a child of the Rule element. You can filter objects - based on an object key prefix, one or more object tags, or both. When you add the - Filter element in the configuration, you must also add the following elements: DeleteMarkerReplication, - Status, and Priority. - - - - For information about enabling versioning on a bucket, see Using - Versioning. - - - - By default, a resource owner, in this case the AWS account that created the bucket, - can perform this operation. The resource owner can also grant others permissions to - perform the operation. For more information about permissions, see Specifying - Permissions in a Policy and Managing - Access Permissions to Your Amazon S3 Resources. - - - - Handling Replication of Encrypted Objects - - - - By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side - encryption with CMKs stored in AWS KMS. To replicate AWS KMS-encrypted objects, add - the following: SourceSelectionCriteria, SseKmsEncryptedObjects, - Status, EncryptionConfiguration, and ReplicaKmsKeyID. - For information about replication configuration, see Replicating - Objects Created with SSE Using CMKs stored in AWS KMS. - - - - For information on PutBucketReplication errors, see ReplicationErrorCodeList - - - - - The following operations are related to PutBucketReplication: - - - - Container for the necessary parameters to execute the PutBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketReplication service method, as returned by S3. - REST API Reference for PutBucketReplication Operation - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - The bucket name. - Container for Payer. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketRequestPayment service method, as returned by S3. - REST API Reference for PutBucketRequestPayment Operation - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - Container for the necessary parameters to execute the PutBucketRequestPayment service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketRequestPayment service method, as returned by S3. - REST API Reference for PutBucketRequestPayment Operation - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging. - - - - Within a bucket, if you add a tag that has the same key as an existing tag, the new - value overwrites the old value. For more information, see Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional operation is currently in progress against - this resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - The bucket name. - A property of PutBucketTaggingRequest used to execute the PutBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketTagging service method, as returned by S3. - REST API Reference for PutBucketTagging Operation - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging. - - - - Within a bucket, if you add a tag that has the same key as an existing tag, the new - value overwrites the old value. For more information, see Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional operation is currently in progress against - this resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - Container for the necessary parameters to execute the PutBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketTagging service method, as returned by S3. - REST API Reference for PutBucketTagging Operation - - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT operation requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - Amazon S3 has a limitation of 50 routing rules per website configuration. If you require - more than 50 routing rules, you can use object redirect. For more information, see - Configuring - an Object Redirect in the Amazon Simple Storage Service Developer Guide. - - - The bucket name. - Container for the request. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketWebsite service method, as returned by S3. - REST API Reference for PutBucketWebsite Operation - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT operation requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - Amazon S3 has a limitation of 50 routing rules per website configuration. If you require - more than 50 routing rules, you can use object redirect. For more information, see - Configuring - an Object Redirect in the Amazon Simple Storage Service Developer Guide. - - - Container for the necessary parameters to execute the PutBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketWebsite service method, as returned by S3. - REST API Reference for PutBucketWebsite Operation - - - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - The name of the bucket for which to set the configuration. - A property of PutLifecycleConfigurationRequest used to execute the PutLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutLifecycleConfiguration service method, as returned by S3. - REST API Reference for PutLifecycleConfiguration Operation - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - Container for the necessary parameters to execute the PutLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutLifecycleConfiguration service method, as returned by S3. - REST API Reference for PutLifecycleConfiguration Operation - - - - - - - - - - - - - - - - - Configuration for accessing AmazonS3 service - - - Configuration for accessing Amazon S3 service - - - - - When true, requests will always use path style addressing. - - - - - Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. - To use this feature, the bucket name should be DNS compliant names and should not contain periods (.). - The following APIs are not supported and are sent to the regular region endpoint, even if this option is enabled: -
    -
  1. PutBucket
    2. -
  2. ListBuckets
    3. -
  3. DeleteBucket
    4. -
- - - This option cannot be used at the same time as UseDualstackEndpoint. - - - - - If set to true and the service package supports it the region identified in the arn for a resource - will be used when making the service request. - - - - - USEast1RegionalEndpointValue determines wheter or not - to send the us-east-1 s3 requests to the regional endpoint or to - the legacy global endpoint. - This flags takes precedence over the AWS_S3_US_EAST_1_REGIONAL_ENDPOINT - environment variable and the credential file. - - - - - This method contains custom initializations for the config object. - - - - - Given this client configuration, returns the service url - - The service url in the form of a string - - - - If the client is configured to hit us-east-1 with the S3UsEast1RegionalEndpointValue flag not set, - this method checks whether the environment variable is present or the credential file contains a valid value - - A Nullable of S3UsEast1RegionalEndpointValue representing the client configuration for the regional us-east-1 endpoint - - - - Validate that the config object is properly configured. - - - - - Checks the AWS_S3_US_EAST_1_REGIONAL_ENDPOINT environment variable for the presence of the s3 regional flag - - A nullable of S3UsEast1RegionalEndpointValue - - - - Checks the credential file for the presence of the s3 regional flag - - A nullable of S3UsEast1RegionalEndpointValue - - - - Default constructor - - - - - The constant used to lookup in the region hash the endpoint. - - - - - Gets the ServiceVersion property. - - - - - Gets the value of UserAgent property. - - - - - Base exception for S3 errors. - - - - - Construct an instance of AmazonS3Exception - - - - - - Construct an instance of AmazonS3Exception - - - - - - - Construct an instance of AmazonS3Exception - - - - - - Construct an instance of AmazonS3Exception - - - - - - - - - - Construct an instance of AmazonS3Exception - - - - - - - - - - - Construct an instance of AmazonS3Exception - - - - - - - - - - - - Construct an instance of AmazonS3Exception - - - - - - - - - - - - - A special token that helps AWS troubleshoot problems. - - - - - A special token that helps AWS troubleshoot S3 accelerate problems. - - - - - The entire response body for this exception, if available. - - - - - The region that the AmazonS3Exception relates to. - - - - - Gets the exception message. - - - - - Extensions methods added to Amazon.Arn type to help parse S3 specific resources from the ARN. - - - - - Attempt to parse the resource component of the ARN into access point resource name. - - An AWS ARN to parse - The access point resouce identifier found in the ARN. - True if the ARN contains an access point resource identifier. - - - - Attempt to parse the resource component of the ARN into bucket name. - - An AWS ARN to parse - The bucket name found in the ARN. - True if the ARN contains a bucket name. - - - - The file format used when exporting data to Amazon S3. - - - - - CSV file format. - - - - - Construct instance of AnalyticsS3ExportFileFormat. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to an AnalyticsS3ExportFileFormat. - - - - - - - Represents the accelerate status for a bucket. - - - - - Bucket acceleration is enabled. - - - - - Bucket acceleration is suspended. - - - - - Construct instance of BucketAccelerateStatus. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to an BucketAccelerateStatus - - - - - - - The status of the delete marker replication. - - - - - Delete marker replication is enabled. - - - - - Delete marker replication is disabled. - - - - - Construct instance of DeleteMarkerReplicationStatus. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to a DeleteMarkerReplicationStatus - - - - - - - A list of all possible CannedACLs that can be used - for S3 Buckets or S3 Objects. For more information about CannedACLs, refer to - . - - - - - Owner gets FULL_CONTROL. - No one else has access rights (default). - - - - - Owner gets FULL_CONTROL. - No one else has access rights (default). - - - - - Owner gets FULL_CONTROL and the anonymous principal is granted READ access. - If this policy is used on an object, it can be read from a browser with no authentication. - - - - - Owner gets FULL_CONTROL, the anonymous principal is granted READ and WRITE access. - This can be a useful policy to apply to a bucket, but is generally not recommended. - - - - - Owner gets FULL_CONTROL, and any principal authenticated as a registered Amazon - S3 user is granted READ access. - - - - - Owner gets FULL_CONTROL. Amazon EC2 gets READ access to GET an - Amazon Machine Image (AMI) bundle from Amazon S3. - - - - - Object Owner gets FULL_CONTROL, Bucket Owner gets READ - This ACL applies only to objects and is equivalent to private when used with PUT Bucket. - You use this ACL to let someone other than the bucket owner write content (get full control) - in the bucket but still grant the bucket owner read access to the objects. - - - - - Object Owner gets FULL_CONTROL, Bucket Owner gets FULL_CONTROL. - This ACL applies only to objects and is equivalent to private when used with PUT Bucket. - You use this ACL to let someone other than the bucket owner write content (get full control) - in the bucket but still grant the bucket owner full rights over the objects. - - - - - The LogDelivery group gets WRITE and READ_ACP permissions on the bucket. - - - - - Construct instance of S3CannedACL. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to an S3CannedACL - - - - - - - A list of all possible S3 Bucket region possibilities. For - more information, refer to - . - - - - - Specifies that the S3 Bucket should use US locality. - This is the default value. - - - - - Specifies that the S3 Bucket should use US-EAST-2 locality. - - - - - Specifies that the S3 Bucket should use EU locality which defaults to EU-WEST-1 - - - - - Specifies that the S3 Bucket should use the EU-NORTH-1 locality. - - - - - Specifies that the S3 Bucket should use the EU-WEST-1 locality. - - - - - Specifies that the S3 Bucket should use the EU-WEST-2 locality. - - - - - Specifies that the S3 Bucket should use the EU-WEST-3 locality. - - - - - Specifies that the S3 Bucket should use the EU-CENTRAL-1 locality. - - - - - Specifies that the S3 Bucket should use US-WEST-1 locality. - - - - - Specifies that the S3 Bucket should use US-WEST-2 locality. - - - - - Specifies that the S3 Bucket should use US-GOV-EAST-1 locality. - - - - - Specifies that the S3 Bucket should use US-GOV-WEST-1 locality. - - - - - Specifies that the S3 Bucket should use the AP-EAST-1 locality. - - - - - Specifies that the S3 Bucket should use the AP-SOUTHEAST-1 locality. - - - - - Specifies that the S3 Bucket should use the AP-SOUTHEAST-2 locality. - - - - - Specifies that the S3 Bucket should use the AP-NORTHEAST-1 locality. - - - - - Specifies that the S3 Bucket should use the AP-NORTHEAST-2 locality. - - - - - Specifies that the S3 Bucket should use the AP-NORTHEAST-3 locality. - - - - - Specifies that the S3 Bucket should use the AP-SOUTH-1 locality. - - - - - Specifies that the S3 Bucket should use the SA-EAST-1 locality. - - - - - Specifies that the S3 Bucket should use CN-NORTH-1 locality. - - - - - Specifies that the S3 Bucket should use CN-NORTHWEST-1 locality. - - - - - Specifies that the S3 Bucket should use CA-CENTRAL-1 locality. - - - - - Specifies that the S3 Bucket should use US-WEST-1 locality. - - - - - Specifies that the S3 Bucket should use CN-NORTH-1 locality. - - - - - Specifies that the S3 Bucket should use US-GOV-WEST-1 locality. - - - - - Construct instance of S3Region. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to the S3Region class - - - - - - - A list of all ACL permissions. For more information, refer to - . - - - - - When applied to a bucket, grants permission to list the bucket. - When applied to an object, this grants permission to read the - object data and/or metadata. - - - - - When applied to a bucket, grants permission to create, overwrite, - and delete any object in the bucket. This permission is not - supported for objects. - - - - - Grants permission to read the ACL for the applicable bucket or object. - The owner of a bucket or object always has this permission implicitly. - - - - - Gives permission to overwrite the ACP for the applicable bucket or object. - The owner of a bucket or object always has this permission implicitly. - Granting this permission is equivalent to granting FULL_CONTROL because - the grant recipient can make any changes to the ACP. - - - - - Provides READ, WRITE, READ_ACP, and WRITE_ACP permissions. - It does not convey additional rights and is provided only for convenience. - - - - - Gives permission to restore an object that is currently stored in Amazon Glacier - for archival storage. - - - - - Construct S3Permission. - - - - - - Construct instance of S3Permission. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - - Gets and sets the HeaderName property. - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to an S3Permission - - - - - - - An enumeration of all Metadata directives that - can be used for the CopyObject operation. - - - - - Specifies that the metadata is copied from the source object. - - - - - Specifies that the metadata is replaced with metadata provided in the request. - All original metadata is replaced by the metadata you specify. - - - - - An enumeration of all protocols that the pre-signed - URL can be created against. - - - - - https protocol will be used in the pre-signed URL. - - - - - http protocol will be used in the pre-signed URL. - - - - - An enumeration of supported HTTP verbs - - - - - The GET HTTP verb. - - - - - The HEAD HTTP verb. - - - - - The PUT HTTP verb. - - - - - The DELETE HTTP verb. - - - - - S3 Storage Class Definitions - - - - - The STANDARD storage class, which is the default - storage class for S3. - - Durability 99.999999999%; Availability 99.99% over a given year. - - - - - REDUCED_REDUNDANCY provides the same availability as standard, but at a lower durability. - - Durability 99.99%; Availability 99.99% over a given year. - - - - - The GLACIER storage is for object that are stored in Amazon Glacier. - This storage class is for objects that are for archival purpose and - get operations are rare. - - Durability 99.999999999% - - - - - The STANDARD_IA storage is for infrequently accessed objects. - This storage class is for objects that are long-lived and less frequently accessed, - like backups and older data. - - Durability 99.999999999%; Availability 99.9% over a given year. - - - - - The ONEZONE_IA storage is for infrequently accessed objects. It is similiar to STANDARD_IA, but - only stores object data within one Availablity Zone in a given region. - - Durability 99.999999999%; Availability 99% over a given year. - - - - - IntelligentTiering makes it easy to lower your overall cost of storage by automatically placing data in the storage - class that best matches the access patterns for the storage. With IntelligentTiering, you don’t need to define - and manage individual policies for lifecycle data management or write code to transition objects - between storage classes. Instead, you can use IntelligentTiering to manage transitions between Standard and - S-IA without writing any application code. IntelligentTiering also manages transitions automatically to - Glacier for long term archive in addition to S3 storage classes. - - - - - S3 Glacier Deep Archive provides secure, durable object storage class for long term data archival. - It is the ideal storage class to make an archival, durable copy of data that rarely, if ever, needs to be accessed. - It can be used as an offline backup for their most important data assets and to meet long-term retention needs. - - - - - Construct an instance of S3StorageClass. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to S3StorageClass. - - - - - - - The constants for the known event names used by S3 notification. S3 might add new - events before the SDK is updated. In which case the names listed in the S3 documentation - will work as well as these constants. - - - - - An event that says an object has been lost in the reduced redundancy storage. - - - - - A list of all server-side encryption methods for customer provided encryption keys. - - - - - No server side encryption to be used. - - - - - Use AES 256 server side encryption. - - - - - Constructs an instance of ServerSideEncryptionCustomerMethod. - - - - - - Finds the constant for the unique value. - - - - - - - Converts string to ServerSideEncryptionCustomerMethod. - - - - - - - A list of all server-side encryption methods. - - - - - No server side encryption to be used. - - - - - Use AES 256 server side encryption. - - - - - Use AWS Key Management Service for server side encryption. - - - - - Construct instance of ServerSideEncryptionMethod. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to ServerSideEncryptionCustomerMethod. - - - - - - - A list of all grantee types. - - - - - The predefined group. - - - - - The email address of an AWS account - - - - - The canonical user ID of an AWS account - - - - - Construct an instance of GranteeType. - - - - - - Finds the constant for the unique value. - - - - - - - Convert a string to GranteeType. - - - - - - - A list of all lifecycle statuses. - - - - - The rule is enabled. - - - - - The rule is disabled. - - - - - Constructs an instance LifecycleRuleStatus. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to LifecycleRuleStatus. - - - - - - - A list of all version statuses. - - - - - The rule is off. - - - - - The rule is suspended. - - - - - The rule is enabled. - - - - - Construct an instance of VersionStatus. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to VersionStatus. - - - - - - - A list of all encoding types. - - - - - Url encoding. - - - - - Constructs intance of EncodingType - - - - - - Finds the constant for the unique value. - - - - - - - Converts string to EncodingType - - - - - - - The bucket event for which to send notifications. - - - - - The event encapsulates all the object create events - - - - - Event for put operations - - - - - Event for post operations - - - - - Event for copy operations - - - - - Event for completing a multi part upload - - - - - This event encapsulates all the object removed events - - - - - Event for object removed, delete operation. - - - - - Event for object removed, delete marker created operation. - - - - - Event for objects stored in reduced redundancy and S3 detects the object is lost - - - - - Event for all object restore - - - - - Event for restore post operations. - - - - - Event for when object restore is completed. - - - - - Event for replication of all - - - - - Event for operation failed replication - - - - - Evemt for replication operation not tracked - - - - - Event for replication operation missed threshold - - - - - Event for operation replicated after threshold - - - - - Constructs instance of EventType. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to EventType. - - - - - - - Compares if the ConstantClass instances are equals. - - - - - - - Compares if the ConstantClass instances are equals. This is ovewritten to handle the - discrepancy with S3 events coming from Lambda that don't have the prefix "s3:". - - - - - - - A list of all Inventory Formats. - - - - - CSV inventory format - - - - - ORC inventory format - - - - - Parquet inventory format - - - - - Construct instance of InventoryFormat. - - - - - - Finds the constant for the unique value. - - The string representation of the InventoryFormat. - The InventoryFormat object for that string. - - - - Convert string to InventoryFormat. - - - - - - - A list of inventory included object versions. - - - - - All Inventory Included Object Versions - - - - - Current Inventory Included Object Versions - - - - - Construct instance of InventoryIncludedObjectVersions. - - - - - - Finds the constant for the unique value. - - The string representation of the InventoryIncludedObjectVersions. - The InventoryIncludedObjectVersions object for that string. - - - - Convert string to InventoryIncludedObjectVersions. - - - - - - - A list of inventory frequencies. - - - - - Daily Inventory Frequency - - - - - Weekly Inventory Frequency - - - - - Construct instance of InventoryFrequency. - - - - - - Finds the constant for the unique value. - - The string representation of the InventoryFrequency. - The InventoryFrequency object for that string. - - - - Convert string to InventoryFrequency. - - - - - - - A list of inventory optional fields. - - - - - InventoryOptionalField for Size - - - - - InventoryOptionalField for LastModifiedDate - - - - - InventoryOptionalField for StorageClass - - - - - InventoryOptionalField for ETag - - - - - InventoryOptionalField for IsMultipartUploaded - - - - - InventoryOptionalField for ReplicationStatus - - - - - InventoryOptionalField for EncryptionStatus - - - - - InventoryOptionalField for ObjectLockRetainUntilDate - - - - - InventoryOptionalField for ObjectLockMode - - - - - InventoryOptionalField for ObjectLockLegalHoldStatus - - - - - InventoryOptionalField for IntelligentTieringAccessTier - - - - - Construct instance of InventoryOptionalField. - - - - - - Finds the constant for the unique value. - - The string representation of the InventoryOptionalField. - The InventoryIncludedObjectVersions object for that string. - - - - Convert string to InventoryOptionalField. - - - - - - - The status of the replication job associated with this source object. - - - - - The object is pending replication. - - - - - The object has been replicated. - - - - - The object was created as a result of replication. - - - - - The object replication has failed due to a customer-attributable reason, and the replication will not be attempted again. - - - - - Construct instance of ReplicationStatus. - - - - - - Finds the constant for the unique value. - - The string representation of the ReplicationStatus. - The ReplicationStatus object for that string. - - - - Convert string to ReplicationStatus. - - - - - - - Whether a replication rule is applied or ignored. - - - - - The rule will be applied. - - - - - The rule will be ignored. - - - - - Construct instance of ReplicationRuleStatus - - - - - - Finds the constant for the unique value. - - The string representation of the ReplicationRuleStatus. - The ReplicationRuleStatus object for that string. - - - - Convert string to ReplicationRuleStatus. - - - - - - - Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request. - - - - - The object tag-set is copied from the source object. - - - - - The object tag-set is replaced with tag-set provided in the request. - - - - - Construct instance of TaggingDirective - - - - - Finds the constant for the unique value. - - The string representation of the TaggingDirective. - The TaggingDirective object for that string. - - - - Convert string to TaggingDirective. - - - - - All enumerations type for retrieval tier for Glacier restore. - - - - - Standard Tier for Glacier restore. - - - - - Bulk Tier for Glacier restore. - - - - - Expedited Tier for Glacier restore. - - - - - Construct instance of RestoreObjectRequestGlacierJobTier - - - - - - Finds the constant for the unique value. - - The string representation of the RestoreObjectRequestGlacierJobTier. - The RestoreObjectRequestGlacierJobTier object for that string. - - - - Convert string to RestoreObjectRequestGlacierJobTier. - - - - - - - The version of the output schema to use when exporting data. - - - - - The schema output version V_1. - - - - - Construct instance of StorageClassAnalysisSchemaVersion - - - - - - Finds the constant for the unique value. - - The string representation of the StorageClassAnalysisSchemaVersion. - The StorageClassAnalysisSchemaVersion object for that string. - - - - Convert string to StorageClassAnalysisSchemaVersion. - - - - - - - Acknowledges that requester pays for the operation. - - - - - Requester pays for the operation. - - - - - Finds the RequestPayer instance for the string value. - - - - - Converts string to RequestPayer instance - - - - - The response from S3 that it confirms that requester pays. - - - - - S3 acknowledges that the requester pays. - - - - - Finds the RequestCharged instance for the string value - - - - - converts the string to RequestCharged instance - - - - - The override value for the owner of the replica object. - - - - - Overrides destination bucket's owner. - - - - - Finds the OwnerOverride instance for the string value - - - - - converts the string to OwnerOverride instance - - - - - The replication for KMS encrypted S3 objects is disabled if status is not Enabled. - - - - - The replication for KMS encrypted S3 objects is enabled. - - - - - The replication for KMS encrypted S3 objects is disabled. - - - - - - - - - - Finds the SseKmsEncryptedObjectsStatus instance for the string value - - - - - Converts the string to SseKmsEncryptedObjectsStatus instance - - - - - Specify how headers will be handled. - - - - - Headers will be usable in SELECT clause. - - - - - Headers will be skipped - - - - - No header is present. - - - - - Finds the FileHeaderInfo instance for the string value - - - - - - - Converts the string to FileHeaderInfo instance - - - - - Specifies whether existing object replication is enabled. - - - - - Enable the replication of existing objects - - - - - Disable the replication of existing objects - - - - - Finds the ExistingObjectReplicationStatus instance for the string value - - - - - - - Converts the string to ExistingObjectReplicationStatus instance - - - - - Describes when fields in output should be surrounded with quotes. - - - - - Specifies that fields in output should always be surrounded in quotes. - - - - - Specifies that fields in output should be surrounded in quotes as necessary. - - - - - Finds the QuoteFields instance for the string value - - string value that maps to QuoteFields enum - QuoteFields enum - - - - Converts the string to QuoteFields instance - - - - - Type of the expression provided in the Expression member. - - - - - SQL expression - - - - - Finds the ExpressionType instance for the string value - - string value that maps to ExpressionType enum - ExpressionType enum - - - - Converts the string to ExpressionType instance - - - - - Indicates what type of job is being initiated. - - - - - Finds the RestoreRequestType instance for the string value - - - - - Converts the string to RestoreRequestType instance - - - - - The type of JSON. - - - - - Finds the JsonType instance for the string value - - - - - Converts the string to JsonType instance - - - - - Specifies object's compression format. - - - - - Finds the CompressionType instance for the string value - - - - - Converts the string to CompressionType instance - - - - - The type of ObjectLockEnabled - - - - - Finds the ObjectLockEnabled instance for the string value - - - - - Converts the string to ObjectLockEnabled instance - - - - - The type of ObjectLockLegalHoldStatus - - - - - Finds the ObjectLockLegalHoldStatus instance for the string value - - - - - Converts the string to ObjectLockLegalHoldStatus instance - - - - - The type of ObjectLockRetentionMode - - - - - Finds the ObjectLockRetentionMode instance for the string value - - - - - Converts the string to ObjectLockRetentionMode instance - - - - - The type of ObjectLockMode - - - - - Finds the ObjectLockMode instance for the string value - - - - - Converts the string to ObjectLockMode instance - - - - - Specifies whether the replication time is enabled. - - - - - Replication time is enabled. - - - - - Replication time is disabled. - - - - - Finds the ReplicationTimeStatus instance for the string value - - - - - - - Converts the string to ReplicationTimeStatus instance - - - - - - Specifies whether the replication metrics are enabled. - - - - - Replication metrics are enabled. - - - - - Replication metrics are disabled. - - - - - Finds the MetricsStatus instance for the string value - - - - - - - Converts the string to MetricsStatus instance - - - - - - Custom pipeline handler to clean up streams in case of an exception. - - - - - Catch exceptions and clean up any open streams. - - - - - - Catch exceptions and clean up any open streams. - - - - - - - Custom pipeline handler to enable sig V4 for Get requests. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Custom pipeline handler to enable sig V4 for Get requests. - - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Calls the post invoke logic after calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls the and post invoke logic after calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Constructor for AmazonS3RetryPolicy. - - The IClientConfig object - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - - - a value if it can be determined, or null if the IO-bound calculations need to be done - - - - Return true if the request should be retried. Implements additional checks - specific to S3 on top of the checks in DefaultRetryPolicy. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Constructor for AmazonS3StandardRetryPolicy. - - The IClientConfig object - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - - - a value if it can be determined, or null if the IO-bound calculations need to be done - - - - Return true if the request should be retried. Implements additional checks - specific to S3 on top of the checks in StandardRetryPolicy. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Constructor for AmazonS3AdaptiveRetryPolicy. - - The IClientConfig object - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - - - a value if it can be determined, or null if the IO-bound calculations need to be done - - - - Return true if the request should be retried. Implements additional checks - specific to S3 on top of the checks in AdaptiveRetryPolicy. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Marker interface to identify AmazonS3EncryptionClient. - - - - - Service metadata for Amazon S3 service - - - - - Gets the value of the Service Id. - - - - - Gets the dictionary that gives mapping of renamed operations - - - - - The parameters to request an abort of a multipart upload. - - - After a multipart upload is aborted, no additional parts can be uploaded using that upload ID. - The storage consumed by any previously uploaded parts will be freed. However, if any part uploads - are currently in progress, those part uploads might or might not succeed. As a result, it might be - necessary to abort a given multipart upload multiple times in order to completely free all storage - consumed by all parts. - - - - - The bucket name to which the upload was taking place. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The key of the S3 object that was being uploaded. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - The upload id for the in-progress multipart upload that should be aborted. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the AbortMultipartUpload response metadata. - The AbortMultipartUpload operation has a void result type. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Bucket accelerate configuration. - - - - - The accelerate status of the bucket. - - - - - AccessControlTranslation class - - - - - The override value for the owner of the replica object. - - - - - Class for AnalyticsAndOperator - A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. - The operator must have at least two predicates, and an object must match all of the predicates - in order for the filter to apply. - - Note: The current implementation restricts the usage to atmost one AnalyticsPrefixPredicate - and any number of AnalyticsTagPredicates. - - - - Class for AnalyticsConfiguration - - - - - The identifier used to represent an analytics configuration. - - - - - The filter used to describe a set of objects for analyses. - A filter must have exactly one prefix, one tag, or one conjunction (AnalyticsAndOperator). - If no filter is provided, all objects will be considered in any analysis. - - - - - If present, it indicates that data related to access patterns will be collected - and made available to analyze the tradeoffs between different storage classes. - - - - - Class for AnalyticsExportDestination - - - - - A destination signifying output to an S3 bucket. - - - - - Filter class for Metrics. - - - - - Filter Predicate setup for specific filter types. - - - - - Filter Predicate abstract class for specific filter types to be derived from. - - - - - Abstract class that can be used over logical filter predicates,i.e. AND/OR. - - - - - Internal implementation of Metrics Predicate visitor interface. - - - - - Interface for implementing visitor pattern in Analytics Predicate Filter. - - - - - Interface for implementing visitor pattern in Inventory Predicate Filter. - - - - - Interface for implementing visitor pattern in Metrics Predicate Filter. - - - - - Internal implementation of Inventory Predicate visitor interface. - - - - - Internal implementation of Metrics Predicate visitor interface. - - - - - Defines the interface that is used to visit all the different - implementations of - - - - - Visit a - - - - - - Visit a - - - - - - Visit a - - - - - - Implementation of to marshall . - - - - - AbortIncompleteMultipartUpload Unmarshaller - - - - - Abort Multipart Upload Request Marshaller - - - - - Response Unmarshaller for AbortMultipartUpload operation - - - - - AnalyticsConfiguration Unmarshaller - - - - - AnalyticsExportDestinationUnmarshaller - - - - - AnalyticsFilter Unmarshaller - - - - - AnalyticsS3BucketDestination Unmarshaller - - - - - Bucket Unmarshaller - - - - - CommonPrefixesItem Unmarshaller - - - - - Complete Multipart Upload Request Marshaller - - - - - Response Unmarshaller for CompleteMultipartUpload operation - - - - - ContentsItem Unmarshaller - - - - - Copy Object Request Marshaller - - - - - Response Unmarshaller for CopyObject operation - - - - - Upload Part Copy Request Marshaller - - - - - Response Unmarshaller for CopyPart operation - - - - - CORSRule Unmarshaller - - - - - Response Unmarshaller for DefaultRetention Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Delete InventoryConfiguration Request Marshaller - - - - - Response Unmarshaller for DeleteAnalyticsConfiguration operation - - - - - Response Unmarshaller for DeleteCORSConfiguration operation - - - - - Delete InventoryConfiguration Request Marshaller - - - - - Response Unmarshaller for DeleteInventoryConfiguration operation - - - - - Delete Bucket MetricsConfiguration Request Marshaller - - - - - Response Unmarshaller for DeleteBucketMetricsConfiguration operation - - - - - Delete Bucket Policy Request Marshaller - - - - - Response Unmarshaller for DeleteBucketPolicy operation - - - - - Delete Bucket Request Marshaller - - - - - Response Unmarshaller for DeleteBucket operation - - - - - Delete Bucket Tagging Request Marshaller - - - - - Response Unmarshaller for DeleteBucketTagging operation - - - - - Delete Bucket Website Request Marshaller - - - - - Response Unmarshaller for DeleteBucketWebsite operation - - - - - Delete Bucket Cors Request Marshaller - - - - - DeletedObject Unmarshaller - - - - - Delete Bucket Lifecycle Request Marshaller - - - - - Response Unmarshaller for DeleteBucketLifecycle operation - - - - - Delete Object Request Marshaller - - - - - Response Unmarshaller for DeleteObject operation - - - - - Delete Objects Request Marshaller - - - - - Response Unmarshaller for DeleteObjects operation - - - - - DeleteObjectTaggingRequest Marshaller - - - - - Marshall DeleteObjectTaggingRequest object into an http request. - - - - - Marshall DeleteObjectTaggingRequest object into an http request. - - - - - Response Unmarshaller for DeleteObjectTagging operation - - - - - DeletePublicAccessBlock Request Marshaller - - - - - Response Unmarshaller for DeletePublicAccessBlock operation - - - - - ErrorsItem Unmarshaller - - - - - Expiration Unmarshaller - - - - - FilterRule Unmarshaller - - - - - Filter Unmarshaller - - - - - Get Object Acl Request Marshaller - - - - - Response Unmarshaller for GetACL operation - - - - - Get Object Accelerate Configuration Request Marshaller - - - - - Response Unmarshaller for GetACL operation - - - - - Get BucketAnalyticsConfiguration Request Marshaller - - - - - Response Unmarshaller for GetAnalyticsConfiguration operation - - - - - Get InventoryConfiguration Request Marshaller - - - - - Response Unmarshaller for GetInventoryConfiguration operation - - - - - Get Bucket Location Request Marshaller - - - - - Response Unmarshaller for GetBucketLocation operation - - - - - Get Bucket Logging Request Marshaller - - - - - Response Unmarshaller for GetBucketLogging operation - - - - - Get Bucket MetricsConfigurationRequest Marshaller - - - - - Response Unmarshaller for GetBucketMetricsConfiguration operation - - - - - Get Bucket Notification Request Marshaller - - - - - Response Unmarshaller for GetBucketNotification operation - - - - - Get BucketName Policy Request Marshaller - - - - - Response Unmarshaller for GetBucketPolicy operation - - - - - GetBucketPolicyStatusRequestMarshaller - - - - - Response Unmarshaller for GetBucketPolicyStatus operation - - - - - Get Bucket Request Payment Request Marshaller - - - - - Response Unmarshaller for GetBucketRequestPayment operation - - - - - Get Bucket Tagging Request Marshaller - - - - - Response Unmarshaller for GetBucketTagging operation - - - - - Get Bucket Versioning Request Marshaller - - - - - Response Unmarshaller for GetBucketVersioning operation - - - - - Get Bucket Website Request Marshaller - - - - - Response Unmarshaller for GetBucketWebsite operation - - - - - Get Bucket Cors Request Marshaller - - - - - Response Unmarshaller for GetCORSConfiguration operation - - - - - Get Bucket Lifecycle Request Marshaller - - - - - Response Unmarshaller for GetLifecycleConfiguration operation - - - - - GetObjectLegalHold Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for GetObjectLegalHold operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - GetObjectLockConfiguration Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for GetObjectLockConfiguration operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - GetObjectMetadata Marshaller - - - - - Response Unmarshaller for GetObjectMetadata operation - - - - - Get Object Request Marshaller - - - - - Response Unmarshaller for GetObject operation - - - - - GetObjectRetention Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for GetObjectRetention operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - GetObjectTaggingRequest Marshaller - - - - - Marshall GetObjectTaggingRequest into an http request. - - - - - Marshall GetObjectTaggingRequest into an http request. - - - - - Response Unmarshaller for GetObjectTagging operation - - - - - Get Object Torrent Request Marshaller - - - - - Response Unmarshaller for GetObjectTorrent operation - - - - - GetPublicAccessBlockRequestMarshaller - - - - - Response Unmarshaller for GetPublicAccessBlock operation - - - - - Grantee Unmarshaller - - - - - Grant Unmarshaller - - - - - Head Bucket Request Marshaller - - - - - Response Unmarshaller for HeadBucket operation - - - - - Create Multipart Upload Request Marshaller - - - - - Response Unmarshaller for InitiateMultipartUpload operation - - - - - Initiator Unmarshaller - - - - - InventoryConfiguration Unmarshaller - - - - - InventoryDestination Unmarshaller - - - - - InventoryEncryption Unmarshaller - - - - - InventoryFilter Unmarshaller - - - - - InventoryS3BucketDestination Unmarshaller - - - - - InventorySchedule Unmarshaller - - - - - LifecycleFilterPredicate Unmarshaller - - - - - LifecycleRuleNoncurrentVersionExpiration Unmarshaller - - - - - LifecycleRuleNoncurrentVersionTransition Unmarshaller - - - - - List AnalyticsConfiguration Request Marshaller - - - - - Response Unmarshaller for ListAnalyticsConfiguration operation - - - - - List InventoryConfiguration Request Marshaller - - - - - Response Unmarshaller for ListInventoryConfiguration operation - - - - - List Bucket MetricsConfigurationRequest Marshaller - - - - - Response Unmarshaller for ListBucketMetricsConfiguration operation - - - - - List Buckets Request Marshaller - - - - - Response Unmarshaller for ListBuckets operation - - - - - List Multipart Uploads Request Marshaller - - - - - Response Unmarshaller for ListMultipartUploads operation - - - - - List Objects Request Marshaller - - - - - Response Unmarshaller for ListObjects operation - - - - - List Objects Request Marshaller - - - - - Response Unmarshaller for ListObjects operation - - - - - List Parts Request Marshaller - - - - - Response Unmarshaller for ListParts operation - - - - - List Object Versions Request Marshaller - - - - - Response Unmarshaller for ListVersions operation - - - - - LoggingEnabled Unmarshaller - - - - - MetricsConfiguration Unmarshaller - - - - - MetricsFilte Unmarshaller - - - - - UploadsItem Unmarshaller - - - - - Response Unmarshaller for ObjectLockConfiguration Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Response Unmarshaller for ObjectLockLegalHold Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Response Unmarshaller for ObjectLockRetention Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Response Unmarshaller for ObjectLockRule Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Owner Unmarshaller - - - - - PartsItem Unmarshaller - - - - - PolicyStatus Unmarshaller - - - - - PublicAccessBlockConfiguration Unmarshaller - - - - - Put Object Acl Request Marshaller - - - - - Response Unmarshaller for PutObjectAcl operation - - - - - Put Object Acl Request Marshaller - - - - - Response Unmarshaller for PutBucketAccelerate operation - - - - - Request Marshaller for PutAnalyticsConfiguration operation - - - - - Response Unmarshaller for PutBucketAnalytics operation - - - - - Request Marshaller for PutInventoryConfiguration operation - - - - - Response Unmarshaller for PutBucketWebsite operation - - - - - Enable Bucket Logging Request Marshaller - - - - - Response Unmarshaller for PutBucketLogging operation - - - - - Put Bucket MetricsConfigurationRequest Marshaller - - - - - Response Unmarshaller for PutBucketMetricsConfiguration operation - - - - - Put Bucket Notification Request Marshaller - - - - - Response Unmarshaller for PutBucketNotification operation - - - - - Put Bucket Policy Request Marshaller - - - - - Response Unmarshaller for PutBucketPolicy operation - - - - - Put Buckeyt Replication Request Marshaller - - - - - Response Unmarshaller for PutBucketReplication operation. - - - - - Put Bucket Request Marshaller - - - - - Put Bucket Request Payment Request Marshaller - - - - - Response Unmarshaller for PutBucketRequestPayment operation - - - - - Response Unmarshaller for PutBucket operation - - - - - Put Bucket Tagging Request Marshaller - - - - - Response Unmarshaller for PutBucketTagging operation - - - - - Put Bucket Versioning Request Marshaller - - - - - Response Unmarshaller for PutBucketVersioning operation - - - - - Put Bucket Website Request Marshaller - - - - - Response Unmarshaller for PutBucketWebsite operation - - - - - Put Bucket Cors Request Marshaller - - - - - Response Unmarshaller for PutCORSConfiguration operation - - - - - Put Bucket Lifecycle Request Marshaller - - - - - Response Unmarshaller for PutLifecycleConfiguration operation - - - - - PutObjectLegalHold Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for PutObjectLegalHold operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - PutObjectLockConfiguration Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for PutObjectLockConfiguration operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Put Object Request Marshaller - - - - - Response Unmarshaller for PutObject operation - - - - - PutObjectRetention Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for PutObjectRetention operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Delete Object Tagging Request Marshaller - - - - - Marshall PutObjectTaggingRequest into an http request. - - - - - Marshall PutObjectTaggingRequest into an http request. - - - - - Response Unmarshaller for DeleteObjectTagging operation - - - - - PutPublicAccessBlock Request Marshaller - - - - - Response Unmarshaller for PutPublicAccessBlock operation - - - - - Restore Object Request Marshaller - - - - - Response Unmarshaller for RestoreObject operation - - - - - Condition Unmarshaller - - - - - Redirect Unmarshaller - - - - - RoutingRule Unmarshaller - - - - - RulesItem Unmarshaller - - - - - Response Unmarshaller for all Errors - - - - - Build an S3ErrorResponse from XML - - The XML parsing context. - Usually an Amazon.Runtime.Internal.UnmarshallerContext. - An S3ErrorResponse object. - - - - Grant Unmarshaller - - - - - Class for unmarshalling S3 service responses - - - - - Specialized S3 unmarshaller context. - - - - - Wrap an XmlTextReader with state for event-based parsing of an XML stream. - - Stream with the XML from a service response. - If set to true, maintains a copy of the complete response body as the stream is being read. - Response data coming back from the request - If set to is true, configure unmarshaller with exception specifics. - - - - Reads to the next node in the XML document, and updates the context accordingly. - If node is RequestId, reads the contents and stores in RequestId property. - - - True if a node was read, false if there are no more elements to read./ - - - - - SSEKMS Unmarshaller - - - - - StorageClassAnalysisDataExportDataExportUnmarshaller - - - - - StorageClassAnalysisUnmarshaller - - - - - Tag Unmarshaller - - - - - TopicConfiguration Unmarshaller - - - - - Transition Unmarshaller - - - - - Upload Part Request Marshaller - - - - - Response Unmarshaller for UploadPart operation - - - - - VersionsItem Unmarshaller - - - - - Class for AnalyticsPrefixPredicate - The prefix used when evaluating a metrics filter. - - - - - Class for AnalyticsS3BucketDestination - - - - - The file format used when exporting data to Amazon S3. - - - - - The account ID that owns the destination bucket. If no account ID is provided, the owner will not be validated prior to exporting data. - - - - - The Amazon resource name (ARN) of the bucket to which data is exported. - - - - - The prefix to use when exporting data. The exported data begins with this prefix. - - - - - Class for MetricsTagPredicate - The tag used when evaluating a metrics filter. - - - - - This class represents the byte range for a range GET from S3. - - - - - Constructs a ByteRange and sets the start and end. - - - - - - - Constructs a ByteRange and sets the header to the value specified. - - - - - - A private string, represending the byte range. - - - - - The starting byte number of the range - - - - - The ending byte number of the range - - - - - The formatted string representing the byte range to be set for the range header. - - - - - Container for the parameters to the CompleteMultipartUpload operation. - Completes a multipart upload by assembling previously uploaded parts. - - - - - The name of the bucketName containing the S3 object that was being uploaded in parts. - - - - - The key of the S3 object that was being uploaded. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - A collection of part numbers and corresponding etags. - - - - - Adds a collection of part numbers and corresponding etags. - - PartETags that will added to this request. - - - - Adds a collection of part numbers and corresponding etags. - - PartETags that will added to this request. - - - - Adds a collection of part numbers and corresponding etags by transforming the UploadPartResponses into PartETags. - - The list of response objects return from UploadParts. - - - - Adds a collection of part numbers and corresponding etags by transforming the UploadPartResponses into PartETags. - - The list of response objects return from UploadParts. - - - - Adds a collection of part numbers and corresponding etags by transforming the CopyPartResponse into PartETags. - - The list of response objects return from CopyParts. - - - - Adds a collection of part numbers and corresponding etags by transforming the CopyPartResponse into PartETags. - - The list of response objects return from CopyParts. - - - - The upload id for the in-progress multipart upload that should be completed. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the CompleteMultipartUpload response and response metadata. - - - - - Gets and sets the URI that identifies the newly created object. - - - - - Gets and sets the name of the bucketName that contains the newly created object. - - - - - Gets and sets the object key of the newly created object. - - - - - Gets and sets Entity tag that identifies the newly created object's data. Objects with different - object data will have different entity tags. The entity tag is an opaque string. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - Gets and sets the ServerSideEncryptionMethod property. - Specifies the encryption used on the server to - store the content. - Default is None. - - - - - Gets and sets the VersionId property. - This is the version-id of the S3 object - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the CopyObject operation. - Creates a copy of an object that is already stored in Amazon S3. - - - - - The name of the bucket containing the object to copy. - - - - - Checks if SourceBucket property is set. - - true if SourceBucket property is set. - - - - The key of the object to copy. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Checks if SourceKey property is set. - - true if SourceKey property is set. - - - - Specifies a particular version of the source object to copy. By default the latest version is copied. - - - - - Checks if SourceVersionId property is set. - - true if SourceVersionId property is set. - - - - The name of the bucket to contain the copy of the source object. - - - - - Checks if DestinationBucket property is set. - - true if DestinationBucket property is set. - - - - The key to be given to the copy of the source object. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Checks if DestinationKey property is set. - - true if DestinationKey property is set. - - - - A canned access control list (CACL) to apply to the object. - Please refer to for - information on S3 Canned ACLs. - - - - - ETag to be matched as a pre-condition for copying the source object - otherwise returns a PreconditionFailed. - - - Copies the object if its entity tag (ETag) matches - the specified tag; otherwise return a 412 (precondition failed). - Constraints: This property can be used with IfUnmodifiedSince, - but cannot be used with other conditional copy properties. - - - - - Checks if ETagToMatch property is set. - - - Copies the object if its entity tag (ETag) is different - than the specified Etag; otherwise returns a 412 (failed condition). - Constraints: This header can be used with IfModifiedSince, but cannot - be used with other conditional copy properties. - - true if ETagToMatch property is set. - - - - ETag that must not be matched as a pre-condition for copying the source object, - otherwise returns a PreconditionFailed. - - - - - Checks if ETagToNotMatch property is set. - - true if ETagToNotMatch property is set. - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or - ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Copies the object if it has been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it has been modified since the - specified time; otherwise returns a 412 (failed condition). - Constraints: This property can be used with ETagToNotMatch, - but cannot be used with other conditional copy properties. - - - - - Copies the object if it has been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it has been modified since the - specified time; otherwise returns a 412 (failed condition). - Constraints: This property can be used with ETagToNotMatch, - but cannot be used with other conditional copy properties. - - - - - Checks if ModifiedSinceDateUtc property is set. - - true if ModifiedSinceDateUtc property is set. - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or - UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Copies the object if it has not been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it hasn't been modified since the - specified time; otherwise returns a 412 (precondition failed). - Constraints: This property can be used with ETagToMatch, - but cannot be used with other conditional copy properties. - - - - - Copies the object if it has not been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it hasn't been modified since the - specified time; otherwise returns a 412 (precondition failed). - Constraints: This property can be used with ETagToMatch, - but cannot be used with other conditional copy properties. - - - - - Checks if UnmodifiedSinceDateUtc property is set. - - true if UnmodifiedSinceDateUtc property is set. - - - - Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request. - - - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - Specifies whether you want to apply a Legal Hold to the copied object. - - - - - - Gets and sets the property ObjectLockMode. - - The Object Lock mode that you want to apply to the copied object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - The date and time when you want the copied object's Object Lock to expire. - - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - Checks if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - true if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - - - The type of storage to use for the object. Defaults to 'STANDARD'. - - - - - - If the bucketName is configured as a website, redirects requests for this object to another object in the same bucketName or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - This is a convenience property for Headers.ContentType. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - /// - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The customer provided encryption key for the source object of the copy. - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - true if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the CopySourceServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if CopySourceServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - The tag-set for the object destination object this value must be used in conjunction with the TaggingDirective. The tag-set must be encoded as URL Query parameters. - - - - - Checks if Tagging property is set - - true if Tagging is set. - - - - Returns information about the CopyObject response and response metadata. - - - - - Gets and sets the ETag property. - - - - - Gets and sets the LastModified property. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - Gets and sets the SourceVersionId property. - This is the Version Id of the Source Object - - - - - Version ID of the newly created copy. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the CopyPart operation. - Uploads a part by copying data from an existing object as data source. - - - - - The name of the bucket containing the object to copy. - - - - - Checks if SourceBucket property is set. - - true if SourceBucket property is set. - - - - The key of the object to copy. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Checks if SourceKey property is set. - - true if SourceKey property is set. - - - - Specifies a particular version of the source object to copy. By default the latest version is copied. - - - - - Checks if SourceVersionId property is set. - - true if SourceVersionId property is set. - - - - The name of the bucket to contain the copy of the source object. - - - - - Checks if DestinationBucket property is set. - - true if DestinationBucket property is set. - - - - The key to be given to the copy of the source object. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Checks if DestinationKey property is set. - - true if DestinationKey property is set. - - - - The ID identifying multipart upload for which we are copying a part. - - - - - Checks if UploadId property is set. - - true if UploadId property is set. - - - - Collection of ETags to be matched as a pre-condition for copying the source object - otherwise returns a PreconditionFailed. - - - Copies the object if its entity tag (ETag) matches one of - the specified tags; otherwise return a 412 (precondition failed). - Constraints: This property can be used with IfUnmodifiedSince, - but cannot be used with other conditional copy properties. - - - - - Checks if ETagsToMatch property is set. - - true if ETagToMatch property is set. - - - - Collection of ETags that must not be matched as a pre-condition for copying the source object - otherwise returns a PreconditionFailed. - - - Copies the object if its entity tag (ETag) does not match any of the specified - tags; otherwise returns a 412 (failed condition). - Constraints: This header can be used with IfModifiedSince, but cannot - be used with other conditional copy properties. - - - - - Checks if ETagToNotMatch property is set. - - true if ETagToNotMatch property is set. - - - - Copies the object if it has been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it has been modified since the - specified time; otherwise returns a 412 (failed condition). - Constraints: This property can be used with ETagToNotMatch, - but cannot be used with other conditional copy properties. - - - - - Checks if ModifiedSinceDate property is set. - - true if ModifiedSinceDate property is set. - - - - Copies the object if it has not been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it hasn't been modified since the - specified time; otherwise returns a 412 (precondition failed). - Constraints: This property can be used with ETagToMatch, - but cannot be used with other conditional copy properties. - - - - - Checks if UnmodifiedSinceDate property is set. - - true if UnmodifiedSinceDate property is set. - - - - The number of the part to be copied. - - - Valid part numbers are from 1 to 10,000 inclusive and will uniquely identify the part - and determine the relative ordering within the destination object. If a part already - exists with the PartNumber it will be overwritten. - - - - - Checks if PartNumber property is set. - - true if PartNumber property is set. - - - - The location of the first byte in the range if only a portion of the - source object is to be copied as the part. - - - The LastByte property must also be set or this value will be ignored. - - - - - Checks if FirstByte property is set. - - true if FirstByte property is set. - - - - The location of the last byte in the range if only a portion of the - source object is to be copied as the part. - - - The FirstByte property must also be set or this value will be ignored. - - - - - Checks if LastByte property is set. - - true if LastByte property is set. - - - - - This property is obsolete. Use ServerSideEncryptionMethod in InitiateMultipartUploadRequest instead. - - - Default: None - - - - - - Checks if ServerSideEncryptionMethod property is set. - - true if ServerSideEncryptionMethod property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - This property is obsolete. Use ServerSideEncryptionKeyManagementServiceKeyId in InitiateMultipartUploadRequest instead. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The customer provided encryption key for the source object of the copy. - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - true if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the CopySourceServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if CopySourceServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - - - Returns information about the CopyPart response and response metadata. - - - - - The version of the source object that was copied, if you have enabled versioning on the source bucketName. - - - - - - Entity tag of the object. - - - - - - Date and time at which the object was uploaded. - - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - Gets and sets the PartNumber property. - This is the part number in it's multi-part upload that will uniquely identify the part - and determine the relative ordering within the destination object. - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - A collection of up to 100 cross-origin resource sharing (CORS) rules. - - - - - The collection of rules in this configuration. - - - - C O R S Rule - - - - - Identifies HTTP methods that the domain/origin specified in the rule is allowed to execute. - - - - - - One or more origins you want customers to be able to access the bucket from. - - - - - - An optional unique identifier for the rule. - - - The ID value can be up to 255 characters long. The IDs help you find a rule in the configuration. - - - - - Checks if Id property is set. - - true if Id property is set. - - - - One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript - XMLHttpRequest object). - - - - - - The time in seconds that your browser is to cache the preflight response for the specified resource. - - - - - - Specifies which headers are allowed in a pre-flight OPTIONS request through the - Access-Control-Request-Headers header. - - - Each header name specified in the Access-Control-Request-Headers must have a corresponding - entry in the rule. Only the headers that were requested will be sent back. - This element can contain at most one * wildcard character. - - - - - Checks if AllowedHeaders property is set. - - true if AllowedHeaders property is set. - - - - Describes how a CSV-formatted input object is formatted. - - - - - Describes the first line of input. Valid values: None, Ignore, Use. - - - - - Single character used to indicate a row should be ignored when present at the start of a row. - - - - - Single character used for escaping the quote character inside an already escaped value. - - - - - Value used to separate individual records. - - - - - Value used to separate individual fields in a record. - - - - - Value used for escaping where the field delimiter is part of the value. - - - - - Specifies that CSV field values may contain quoted record delimiters and such records should be allowed. Default value is FALSE. Setting this value to TRUE may lower performance. - - - - - Describes how CSV-formatted results are formatted. - - - - - Indicates whether or not all output fields should be quoted. - - - - - Single character used for escaping the quote character inside an already escaped value. - - - - - Value used to separate individual records. - - - - - Value used to separate individual fields in a record. - - - - - Value used for escaping where the field delimiter is part of the value. - - - - - The container element for specifying the default Object Lock retention settings for - new objects placed in the specified bucket. - - - - - Gets and sets the property Days. - - The number of days that you want to specify for the default retention period. - - - - - - Gets and sets the property Mode. - - The default Object Lock retention mode you want to apply to new objects placed in - the specified bucket. - - - - - - Gets and sets the property Years. - - The number of years that you want to specify for the default retention period. - - - - - - Container for the parameters to the DeleteBucketAnalyticsConfiguration operation. - Deletes an analytics configuration for the bucket (specified by the analytics configuration ID). - - - - - The name of the bucket from which an analytics configuration is deleted. - - - - - The identifier used to represent an analytics configuration. - - - - - Returns information about the DeleteBucketAnalyticsConfiguration response metadata. - The DeleteBucketAnalyticsConfiguration operation has a void result type. - - - - - Request object for the DeleteBucketEncryption operation. - Request Deletes the server-side encryption configuration from the bucket. - - - - - The name of the bucket containing the server-side encryption configuration to delete. - - - - - Returns information about the DeleteBucketEncryption response metadata. - The DeleteBucketEncryption operation has a void result type. - - - - - Container for the parameters to the DeleteInventoryConfiguration operation. - Deletes an inventory configuration (identified by the inventory ID) from the bucket. - - - - - The name of the bucket containing the inventory configuration to delete. - - - - - The ID used to identify the inventory configuration. - - - - - Returns information about the DeleteInventoryConfiguration response metadata. - The DeleteInventoryConfiguration operation has a void result type. - - - - - Container for the parameters to the DeleteBucketMetricsConfiguration operation. - Deletes a metrics configuration (specified by the metrics configuration ID) from the bucket. - - - - - The name of the bucket on which Inventory configuration is to be removed. - - - - - The ID used to identify the metrics configuration. - - - - - Returns information about the DeleteBucketMetricsConfiguration response metadata. - The DeleteBucketMetricsConfiguration operation has a void result type. - - - - - Container for the parameters to the DeleteBucketPolicy operation. - Deletes the policy from the bucket. - - - - - The bucket on which the policy is to be deleted. - - - - - Returns information about the DeleteBucketPolicy response metadata. - The DeleteBucketPolicy operation has a void result type. - - - - - Request object for the DeleteBucketReplication operation. - - - - - Gets and sets the property BucketName. -

Deletes the replication subresource associated with the specified - bucket.

There is usually some time lag before - replication configuration deletion is fully propagated to all the - Amazon S3 systems.

For more information, see - - Cross-Region Replication (CRR) in the Amazon S3 Developer - Guide.

- - - - - Returns information about the DeleteBucketReplication response metadata. - The DeleteBucketReplication operation has a void result type. - - - - - Container for the parameters to the DeleteBucket operation. - Deletes the bucket. All objects (including all object versions and Delete Markers) in the bucket must be deleted before the bucket - itself can be deleted. - - - - - The name of the bucket to be created. - - - - - The region locality for the bucket. - - - When set, this will determine the region the bucket exists in. - Refer - for a list of possible values. - - - - - If set to true the bucket will be deleted in the same region as the configuration of the AmazonS3 client. - DeleteBucketRequest.BucketRegion takes precedence over this property if both are set. - Default: true. - - - - - Returns information about the DeleteBucket response metadata. - The DeleteBucket operation has a void result type. - - - - - The parameters to request deletion of a tag set from a bucket. - - - To use this operation, you must have permission to perform the s3:PutBucketTagging action. - By default, the bucket owner has this permission and can grant this permission to others. - - - - - The name of the bucket on which the tag set is to be removed. - - - - - Returns information about the DeleteBucketTagging response metadata. - The DeleteBucketTagging operation has a void result type. - - - - - Container for the parameters to the DeleteBucketWebsite operation. - This operation removes the website configuration from the bucket. - - - - - The name of the bucket on which website configuration is to be removed. - - - - - Returns information about the DeleteBucketWebsite response metadata. - The DeleteBucketWebsite operation has a void result type. - - - - - Container for the parameters to the DeleteCORSConfiguration operation. - Deletes the cors configuration information set for the bucket. - - - - - Gets and sets the BucketName property. - - - - - Returns information about the DeleteCORSConfiguration response metadata. - The DeleteCORSConfiguration operation has a void result type. - - - - - Contains information about a successful delete operation against a specific S3 object. - - - - - Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a - delete marker. In a simple DELETE, this header indicates whether (true) or not (false) a delete - marker was created. - - - - - The version ID of the delete marker created as a result of the DELETE operation. If you delete a - specific object version, the value returned by this header is the version ID of the object version - deleted. - - - - - The key of the deleted S3 object. - - - - - The version of the deleted S3 object. - - - - - Contains information about a failed delete operation against a specific S3 object. - - - - - The key of the S3 object. - - - - - The version of the S3 object. - - - - - The failure code for the delete error. - - - - - The failure message for the delete error. - - - - - The parameters to request deletion of the lifecycle configuration on a bucket. - - - - Amazon S3 removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. - Your objects never expire, and Amazon S3 no longer automatically deletes any objects on the basis of rules contained - in the deleted lifecycle configuration. - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration action. By default, the - bucket owner has this permission and the bucket owner can grant this permission to others. - - - There is usually some time lag before lifecycle configuration deletion is fully propagated to all the Amazon S3 systems. - - - - - - The name of the bucket on which the lifecycle configuration is to be deleted. - - - - - Returns information about the DeleteLifecycleConfiguration response metadata. - The DeleteLifecycleConfiguration operation has a void result type. - - - - -

Specifies whether Amazon S3 should replicate delete makers.

- - - - - Gets and sets the property Status. -

The status of the delete marker replication.

-

In the current implementation, Amazon S3 does not replicate - the delete markers. Therefore, the status must be - Disabled.

- - - - - The parameters to request deletion of an object in a bucket. - The operation removes the null version (if there is one) of an object and inserts a delete marker, which - becomes the latest version of the object. - - - - To remove a specific version, you must be the bucket owner and you must use the versionId subresource. - Using this subresource permanently deletes the version. - - - If the object you want to delete is in a bucket where the bucket versioning configuration is MFA Delete enabled, - you must include specify the MFA serial number and value in the request. - - - If there isn't a null version, Amazon S3 does not remove any objects. - - - - - - The bucket name of the bucket containing the object. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property BypassGovernanceRetention. - - - - - The key identifying the object to delete. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - The identifier for the specific version of the object to be deleted, if required. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - The MfaCodes Tuple associates the Serial Number and the current Token/Code displayed on the - Multi-Factor Authentication device associated with your AWS Account. - - - This is a required property for this request if:
- 1. EnableMfaDelete was configured on the bucket - containing this object's version.
- 2. You are deleting an object's version - - - - - Checks if the MfaCodes property is set. - - true if the MfaCodes property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the DeleteObject response and response metadata. - - - - - Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a delete marker. - - - - - - Returns the version ID of the delete marker created as a result of the DELETE operation. - - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the DeleteObjects operation. - This operation enables you to delete multiple objects from a bucket using a single HTTP request. You may specify up to 1000 - keys. - - - Container for the parameters to the DeleteObjects operation. - This operation enables you to delete multiple objects from a bucket using a single HTTP request. You may specify up to 1000 - keys. - - - - - The bucket name containing the objects to delete. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property BypassGovernanceRetention. - - Specifies whether you want to delete this object even if it has a Governance-type - Object Lock in place. You must have sufficient permissions to perform this operation. - - - - - - List of object keys to delete. - - - - - Toggles between Quiet and Verbose mode for the operation. - If set to true (Quiet mode), the response includes only those keys for objects on which - the delete operation failed. - - - By default this property is false and keys for both successful deletes - and failures are returned in the response. - - - - - The MfaCodes Tuple associates the Serial Number and the current Token/Code displayed on the - Multi-Factor Authentication device associated with your AWS Account. - - - This is a required property for this request if:
- 1. EnableMfaDelete was configured on the bucket - containing this object's version.
- 2. You are deleting an object's version - - - - - Checks if the MfaCodes property is set. - - true if the MfaCodes property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Add a key to the set of keys of objects to be deleted. - - Object key - - - - Add a key and a version to be deleted. - - Key of the object to be deleted. - Version of the object to be deleted. - - - - Add a KeyVersion object representing the S3 object to be deleted. - - KeyVersion representation of object to be deleted. - - - - Returns information about the DeleteObjects response and response metadata. - - - - - A default constructor for DeleteObjectsResponse - - - - - Gets and sets the DeletedObjects property. - A list of successful deletes. - Set only when Quiet=false on DeleteObjectsRequest. - - - - - Gets and sets the DeleteErrors property. - A list of errors encountered while deleting objects. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the DeleteObjectTaggingRequest operation. - - - - - The bucket name containing the objects from which to remove the tags. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Check to see if Bucket property is set - - - - - The key identifying the object tagging to delete. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Check to see if Key property is set - - - - - The identifier for the specific version of the object to be deleted, if required. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - Returns information about the DeleteObjectTagging response and response metadata. - - - - - Returns the version ID of the delete marker created as a result of the DELETE operation. - - - - - Check to see if VersionId property is set - - - - - Container for the parameters to the DeletePublicAccessBlock operation. - Removes the Public Access Block configuration for an Amazon S3 bucket. - - - - - Gets and sets the property BucketName. - - The Amazon S3 bucket whose Public Access Block configuration you want to delete. - - - - - - This is the response object from the DeletePublicAccessBlock operation. - - - - - EncryptionConfiguration class - - - - - The ID of the AWS KMS key for the region where the destination bucket - resides. Amazon S3 uses this key to encrypt the replica object. - - - - - A container that specifies information about existing object replication. You can choose whether to enable or disable the replication of existing objects. - - - - - Specifies whether existing object replication is enabled. - - - - - Defines the expiration policy for a given object. - - - - - This property is deprecated. This property exposes a DateTime of kind Unspecified. Use ExpiryDateUtc instead. - The date and time for expiry. - - - - - The date and time for expiry. - - - - - Id of the configuration rule for this expiry. - - - - - Constructs an empty instance of an Expiration object - - - - Bucket - Represents a set of filter criteria that limits the objects that can trigger event notifications - - - - - Filter criteria that limits the objects that can trigger event notifications based on their S3 Key name. - - - - - Bucket - Represents a Filter Rule for a NotificationConfiguration. - - - - - Constructs an empty FilterRule. - - - - - Constructs a FilterRule with a specific name and value. - - - - - - - The name of the filter rule. - - - - - The value of the filter rule. - - - - - Container for the parameters to the GetACL operation. - Returns the access control list (ACL) of an object. - - - - - The bucket name that contains the object for which to get the ACL information. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The key of the S3 object to be queried. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - VersionId used to reference a specific version of the object. - - - - - Returns information about the GetACL response and response metadata. - - - - - Gets and sets the AccessControlList property. - - - - - Container for the parameters to the GetBucketAccelerateConfiguration operation. - - - - - The name of the bucket. - - - - - The response class for GetBucketAccelerateConfiguration operation. - - - - - The accelerate status of the bucket. - - - - - Container for the parameters to the GetBucketAnalyticsConfiguration operation. - Gets an analytics configuration for the bucket (specified by the analytics configuration ID). - - - - - The name of the bucket from which an analytics configuration is retrieved. - - - - - The identifier used to represent an analytics configuration. - - - - - GetBucketAnalyticsConfigurationResponse Response - - - - - The configuration and any analyses for the analytics filter. - - - - - Container for the parameters to the GetBucketEncryptionRequest operation. - Returns the server-side encryption configuration of a bucket. - - - - - The name of the bucket. - - - - - GetBucketEncryptionResponse Response - - - - - Container for server-side encryption configuration rules. Currently S3 supports one rule only. - - - - - Container for the parameters to the GetInventoryConfigurationRequest operation. - Returns an inventory configuration (identified by the inventory ID) from the bucket. - - - - - The name of the bucket containing the inventory configuration to retrieve. - - - - - The ID used to identify the inventory configuration. - - - - - GetInventoryConfigurationResponse Response - - - - - Specifies the inventory configuration. - - - - - Container for the parameters to the GetBucketLocation operation. - Returns the region the bucket resides in. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetBucketLocation response and response metadata. - - - - - Gets and sets the Location property. - If the the bucket is located in us-east-1 S3Region.US will be return which has a - value of empty string. - - - - - Container for the parameters to the GetBucketLogging operation. - Returns the logging status of a bucket and the permissions users have to view and modify that status. To use GET, you must be the - bucket owner. - - - - - The name of the bucket to query. - - - - - Returns information about the GetBucketLogging response and response metadata. - - - - - Gets and sets the LoggingConfig property. - - - - - Container for the parameters to the GetBucketMetricsConfiguration operation. - Gets a metrics configuration (specified by the metrics configuration ID) from the bucket. - - - - - The name of the bucket containing the metrics configuration to retrieve. - - - - - The ID used to identify the metrics configuration. - - - - - GetBucketMetricsConfiguration Response - - - - - Specifies the metrics configuration. - - - - - Container for the parameters to the GetBucketNotification operation. - Return the notification configuration of a bucket. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetBucketNotification response and response metadata. - - - - - Gets and sets the TopicConfigurations property. TopicConfigurations are configuration - for Amazon S3 events to be sent to Amazon SNS topics. - - - - - Gets and sets the QueueConfigurations property. QueueConfigurations are configuration - for Amazon S3 events to be sent to Amazon SQS queues. - - - - - Gets and sets the LambdaFunctionConfigurations property. LambdaFunctionConfigurations are configuration - for Amazon S3 events to be sent to an Amazon Lambda cloud function. - - - - - Container for the parameters to the GetBucketPolicy operation. - Returns the policy of a specified bucket. - - - - - The name of the bucket. - - - - - Get BucketName Policy Response - - - - - The bucket policy as a JSON document. - - - - - Container for the parameters to the GetBucketPolicyStatus operation. - Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket - is public. - - - - - Gets and sets the property BucketName. - - The name of the Amazon S3 bucket whose public-policy status you want to retrieve. - - - - - - This is the response object from the GetBucketPolicyStatus operation. - - - - - The public-policy status for this bucket. - - - - - Container for the parameters to the GetBucketReplicationConfiguration operation. - Returns the replication configuration information set on the bucket. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetReplicationConfiguration response and response metadata. - - - - - The replication configuration for the buccket specified in the request. - - - - - Container for the parameters to the GetBucketRequestPayment operation. - Returns the request payment configuration of a bucket. - - - - - The name of the bucket. - - - - - Returns information about the GetBucketRequestPayment response and response metadata. - - - - - Specifies who pays for the download and request fees. - - - - - - Container for the parameters to the GetBucketTagging operation. - Returns the tag set associated with the bucket. - - - - - The name of the bucket to be queried. - - - - - Returns information about the GetBucketTagging response and response metadata. - - - - - The collection of tags. - - - - - Container for the parameters to the GetBucketVersioning operation. - Returns the versioning state of a bucket. - - - - - The name of the bucket to be queried. - - - - - Returns information about the GetBucketVersioning response and response metadata. - - - - - Gets and sets the Versioning property. - Unless Versioning has been explicitly "Enabled" on a bucket, - Versioning Status is "Off". Once Versioning has been - "Enabled", it can be "Suspended" but cannot be switched "Off". - - - - - Container for the parameters to the GetBucketWebsite operation. - Returns the website configuration for a bucket. - - - - - The name of the bucket to be queried. - - - - - Returns information about the GetBucketWebsite response and response metadata. - - - - - Gets and sets the WebsiteConfiguration property. - - This is where the index document suffix and custom error page are defined. - - - - - Container for the parameters to the GetBucketCors operation. - Returns the cors configuration for the bucket. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetBucketCors response and response metadata. - - - - - The current CORSConfiguration for the bucket. - - - - - Container for the parameters to the GetLifecycleConfiguration operation. - Returns the lifecycle configuration information set on the bucket. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetLifecycleConfiguration response and response metadata. - - - - - Gets and Sets the property that governs whether - the response includes successful deletes as well as errors - following the DeleteObjects call against S3. - - By default this property is false and successful deletes - are returned in the response. - - - - - Container for the parameters to the GetObjectLegalHold operation. - Gets an object's current Legal Hold status. - - - - - The bucket name containing the object whose Legal Hold status you want to retrieve. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property Key. - - The key name for the object whose Legal Hold status you want to retrieve. - - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property VersionId. - - The version ID of the object whose Legal Hold status you want to retrieve. - - - - - - This is the response object from the GetObjectLegalHold operation. - - - - - Gets and sets the property LegalHold. - - The current Legal Hold status for the specified object. - - - - - - Container for the parameters to the GetObjectLockConfiguration operation. - Gets the Object Lock configuration for a bucket. The rule specified in the Object - Lock configuration will be applied by default to every new object placed in the specified - bucket. - - - - - Gets and sets the property BucketName. - - The bucket whose Object Lock configuration you want to retrieve. - - - - - - This is the response object from the GetObjectLockConfiguration operation. - - - - - Gets and sets the property ObjectLockConfiguration. - - The specified bucket's Object Lock configuration. - - - - - - Container for the parameters to the HeadObject operation. - The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you''re only - interested in an object''s metadata. To use HEAD, you must have READ access to the object. - - - - - The name of the bucket that contains the object. - - - - - ETag to be matched as a pre-condition for returning the object, - otherwise a PreconditionFailed signal is returned. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or - ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Returns the object only if it has been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Returns the object only if it has been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - ETag that should not be matched as a pre-condition for returning the object, - otherwise a PreconditionFailed signal is returned. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or - UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Returns the object only if it has not been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Returns the object only if it has not been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - The key of the object. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - VersionId used to reference a specific version of the object. - - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to decrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - Part number of the object being read. This is a positive integer between 1 and 10,000. - Effectively performs a 'ranged' HEAD request for the part specified. - Useful querying about the size of the part and the number of parts in this object. - - - - - Check if PartNumber property is set. - - true if PartNumber property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the HeadObject response and response metadata. - - - - - Flag which returns true if the Expires property has been unmarshalled - from the raw value or set by user code. - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the - response. - - - - - - Gets and sets the AcceptRanges. - - - - - Gets and sets the ContentRange. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - Gets and sets the RestoreExpiration property. - RestoreExpiration will be set for objects that have been restored from Amazon Glacier. - It indiciates for those objects how long the restored object will exist. - - - - - Gets and sets the RestoreInProgress - Will be true when the object is in the process of being restored from Amazon Glacier. - - - - - Last modified date of the object - - - - - - An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL - - - - - - This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like - SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal - HTTP headers. - - - - - - Version of the object. - - - - - - The date and time at which the object is no longer cacheable. - - - - - - If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The status of the replication job associated with this source object. - - - - - Checks if ReplicationStatus property is set. - - true if ReplicationStatus property is set. - - - - The count of parts this object has. - - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - The Legal Hold status for the specified object. - - - - - - Gets and sets the property ObjectLockMode. - - The Object Lock mode currently in place for this object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - The date and time when this object's Object Lock will expire. - - - - - - The class of storage used to store the object. - - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the GetObject operation. - Retrieves objects from Amazon S3. - - - - - The bucket name containing the object. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - ETag to be matched as a pre-condition for returning the object, - otherwise a PreconditionFailed signal is returned. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or - ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Returns the object only if it has been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Returns the object only if it has been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - ETag that should not be matched as a pre-condition for returning the object, - otherwise a PreconditionFailed signal is returned. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or - UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Returns the object only if it has not been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Returns the object only if it has not been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Gets and sets the Key property. This is the user defined key that identifies the object in the bucket. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Downloads the specified range bytes of an object. - - - - - A set of response headers that should be returned with the object. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ResponseExpiresUtc instead. Setting either ResponseExpires or - ResponseExpiresUtc results in both ResponseExpires and ResponseExpiresUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ResponseExpires is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Sets the Expires header of the response. - - - - - Sets the Expires header of the response. - - - - - VersionId used to reference a specific version of the object. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to decrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - Part number of the object being read. This is a positive integer between 1 and 10,000. - Effectively performs a 'ranged' GET request for the part specified. Useful for downloading just a part of an object. - - - - - Checks if PartNumber property is set. - - true if PartNumber property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the GetObject response and response metadata. - - - - - Flag which returns true if the Expires property has been unmarshalled - from the raw value or set by user code. - - - - - Gets and sets the BucketName property. - - - - - Gets and sets the Key property. - - - - - Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the - response. - - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - Gets and sets the AcceptRanges. - - - - - Gets and sets the ContentRange. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - Gets and sets the RestoreExpiration property. - RestoreExpiration will be set for objects that have been restored from Amazon Glacier. - It indiciates for those objects how long the restored object will exist. - - - - - Gets and sets the RestoreInProgress - Will be true when the object is in the process of being restored from Amazon Glacier. - - - - - Last modified date of the object - - - - - - An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL - - - - - - This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like - SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal - HTTP headers. - - - - - - Version of the object. - - - - - - The date and time at which the object is no longer cacheable. - - - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - - - - Gets and sets the property ObjectLockMode. - - The Object Lock mode currently in place for this object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - The date and time when this object's Object Lock will expire. - - - - - - If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The class of storage used to store the object. - - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The status of the replication job associated with this source object. - - - - - Checks if ReplicationStatus property is set. - - true if ReplicationStatus property is set. - - - - The number of parts this oject has. - - - - - Checks if PartsCount is set. - - true if PartsCount property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - The number of tags, if any, on the object. - - - - - The event for Write Object progress notifications. All - subscribers will be notified when a new progress - event is raised. - - - Subscribe to this event if you want to receive - put object progress notifications. Here is how:
- 1. Define a method with a signature similar to this one: - - private void displayProgress(object sender, WriteObjectProgressArgs args) - { - Console.WriteLine(args); - } - - 2. Add this method to the Put Object Progress Event delegate's invocation list - - GetObjectResponse response = s3Client.GetObject(request); - response.WriteObjectProgressEvent += displayProgress; - - - - - - This method is called by a producer of write object progress - notifications. When called, all the subscribers in the - invocation list will be called sequentially. - - The file being written. - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - True if transfer is complete - - - - Writes the content of the ResponseStream a file indicated by the filePath argument. - - The location where to write the ResponseStream - Whether or not to append to the file if it exists - - - - Encapsulates the information needed to provide - download progress for the Write Object Event. - - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The bucket name for the S3 object being written. - The object key for the S3 object being written. - The version-id of the S3 object. - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - True if finished writing - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The bucket name for the S3 object being written. - The object key for the S3 object being written. - The file for the S3 object being written. - The version-id of the S3 object. - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - True if finished writing - - - - Gets the bucket name for the S3 object being written. - - - - - Gets the object key for the S3 object being written. - - - - - Gets the version-id of the S3 object. - - - - - The file for the S3 object being written. - - - - - True if writing is complete - - - - - Container for the parameters to the GetObjectRetention operation. - Retrieves an object's retention settings. - - - - - The bucket name containing the object whose retention settings you want to retrieve. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property Key. - - The key name for the object whose retention settings you want to retrieve. - - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property VersionId. - - The version ID for the object whose retention settings you want to retrieve. - - - - - - This is the response object from the GetObjectRetention operation. - - - - - Gets and sets the property Retention. - - The container element for an object's retention settings. - - - - - - Container for the parameters to the GetObjectTaggingRequest operation. - - - - - The bucket name containing the object for which to get the tagging information. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Check to see if Bucket property is set - - - - - Gets and sets the Key property. This is the user defined key that identifies the object in the bucket. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Check to see if Key property is set - - - - - VersionId used to reference a specific version of the object. - - - - - - Returns information about the GetObjectTagging response and response metadata. - - - - - Gets or sets tag-set for a given object - - - - - Container for the parameters to the GetObjectTorrent operation. - Return torrent files from a bucket. - - - - - The name of the bucket containing the object. - - - - - The key identifying the object. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the GetObjectTorrent response and response metadata. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - The parameters to create a pre-signed URL to a bucket or object. - - - For more information, refer to: . -
Required Parameters: BucketName, Expires -
Optional Parameters: Key, VersionId, Verb: default is GET - - - - - The name of the bucket to create a pre-signed url to, or containing the object. - - - - - Checks if BucketName property is set. - - true if BucketName property is set. - - - - The key to the object for which a pre-signed url should be created. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Checks if Key property is set. - - true if Key property is set. - - - - A standard MIME type describing the format of the object data. - - - - The content type for the content being uploaded. This property defaults to "binary/octet-stream". - For more information, refer to: . - - - Note that if content type is specified, it should also be included in the HttpRequest headers - of the eventual upload request, otherwise a signature error may result. - - - - - - The expiry date and time for the pre-signed url. - - - - - Checks if Expires property is set. - - true if Expires property is set. - - - - The requested protocol (http/https) for the pre-signed url. - - - Defaults to https. - - - - - The verb for the pre-signed url. - - - Accepted verbs are GET, PUT, DELETE and HEAD. - Default is GET. - - - - - Version id for the object that the pre-signed url will reference. If not set, - the url will reference the latest version of the object. - - - This is the VersionId for the S3 Object you want to get - a PreSigned URL for. The VersionId property will be ignored - for PreSigned "PUT" requests and for requests that don't specify - the Key property. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - The upload id for the multipart upload for which a pre-signed url should be created. - - - - - Checks if UploadId property is set. - - true if UploadId property is set. - - - - The part number for the multipart upload for which a pre-signed url should be created. - - - - - Checks if PartNumber property is set. - - true if PartNumber property is set. - - - - Specifies the encryption used on the server to store the content. - - - - Default is None. - - - If specifying encryption (not None), the corresponding request must include header - "x-amz-server-side-encryption" with the value of the encryption. - - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - Confirms that the requester knows that she or he will be charged for the request. - Bucket owners need not specify this parameter in their requests. - - - - - A set of response headers that should be returned with the pre-signed url creation response. - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - Custom parameters to include in the signed request, so that they are tamper-proof. - - - - - The parameters for a pre-signed URL to a bucket or object as a string. - - - For more information, refer to: . - - - - - The PreSignedURL as a string - - - - - Constructor - - A url returned from GetPreSignedUrlRequest - - - - Container for the parameters to the GetPublicAccessBlock operation. - Retrieves the Public Access Block configuration for an Amazon S3 bucket. - - - - - Gets and sets the property BucketName. - - The name of the Amazon S3 bucket whose Public Access Block configuration you want - to retrieve. - - - - - - This is the response object from the GetPublicAccessBlock operation. - - - - - The Public Access Block configuration currently in effect for this Amazon S3 bucket. - - - - - Container for the parameters to the HeadBucket operation. - This operation is useful to determine if a bucket exists and you have permission to access it. - - - - - Returns information about the HeadBucket response metadata. - The HeadBucket operation has a void result type. - - - - - This class contains the headers for an S3 object. - - - - - Gets and sets headers to set for the object. - - The name of the header - The value for the header - - - - Gets the count of headers. - - - - - Gets the names of the headers set. - - - - - Specifies caching behavior along the request/reply chain. - - - - - - Specifies presentational information for the object. - - - - - - Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type - referenced by the Content-Type header field. - - - - - - The size of the object, in bytes. - - - - - The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. This - header can be used as a message integrity check to verify that the data is the same data that was originally sent. - - - - - A standard MIME type describing the format of the object data. - - - - - - The date and time at which the object is no longer cacheable. - - - - - - - Container for the parameters to the InitiateMultipartUpload operation. - Initiates a multipart upload and returns an upload ID. - - - - - Envelope Key to Encrypt data - - - - - Encrypted Envelope Key to Encrypt data - - - - - Initialization Vector for encryption - - - - - A canned access control list (ACL) to apply to the object. - Please refer to for information on S3 Canned ACLs. - - - - - The name of the bucketName where the new object will be created, or existing object updated. - - - - - The key of the object to create or update. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - StorageClass property for the object. - - - Default: S3StorageClass.Standard. Set this property - only if you want reduced redundancy for this object. - Please refer to - for - information on S3 Storage Classes. - - - - - If the bucketName is configured as a website, redirects requests for this object to another object in the same bucketName or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - This is a convenience property for Headers.ContentType. - - - - - - Specifies the encryption to be used on the server for the new object. - - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - Checks if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - true if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - Specifies whether you want to apply a Legal Hold to the uploaded object. - - - - - - Gets and sets the property ObjectLockMode. - - Specifies the Object Lock mode that you want to apply to the uploaded object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - Specifies the date and time when you want the Object Lock to expire. - - - - - - The tag-set for the object. The tag-set must be encoded as URL Query parameters. - - - - - Checks if Tagging property is set - - true if Tagging is set. - - - - Returns information about the InitiateMultipartUpload response and response metadata. - - - - - Name of the bucketName to which the multipart upload was initiated. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Object key for which the multipart upload was initiated. - - - - - - Gets and sets the initiated multipart upload id. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - Date when multipart upload will become eligible for abort operation by lifecycle. - - - - - Id of the lifecycle rule that makes a multipart upload eligible for abort operation. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Identifies who initiated the multipart upload. - - - - - Name of the Principal. - - - - - - If the principal is an AWS account, it provides the Canonical User ID. If the principal is an IAM User, it provides a user ARN value. - - - - - - Describes the serialization format of the object. - - - - - Describes the serialization of a CSV-encoded object. - - - - - Specifies object's compression format. Valid values: NONE, GZIP. Default Value: NONE. - - - - - Specifies JSON as object's input serialization format. - - - - - Specifies Parquet as object's input serialization format. - - - - - Class for MetricsConfiguration - - - - - Contains information about where to publish the inventory results. - - - - - Specifies whether the inventory is enabled or disabled. - - - - - Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria. - - - - - The ID used to identify the inventory configuration. - - - - - Specifies which object version(s) to included in the inventory results. - - - - - Contains the optional fields that are included in the inventory results. - - - - - Specifies the schedule for generating inventory results. - - - - - Class for InventoryDestination - - - - - Contains the bucket name, file format, bucket owner (optional), and prefix (optional) where inventory results are published. - - - - - InventoryEncryption class - - - - - Specifies the use of SSE-S3 to encrypt delievered Inventory reports. - - - - - Specifies the use of SSE-KMS to encrypt delievered Inventory reports. - - - - - Class for InventoryFilter - - - - - Filter Predicate setup for specific filter types. - - - - - Filter Predicate abstract class for specific filter types to be derived from. - - - - - Class for InventoryPrefixPredicate - The prefix that an object must have to be included in the inventory results. - - - - - The ID of the account that owns the destination bucket. - - - - - The Amazon resource name (ARN) of the bucket where inventory results will be published. - - - - - The prefix that is prepended to all inventory results. - - - - - Specifies the output format of the inventory results. - - - - - Contains the type of server-side encryption used to encrypt the inventory results. - - - - - Class for InventorySchedule - - - - - Specifies how frequently inventory results are produced. - - - - - Specifies JSON as object's input serialization format. - - - - - The type of JSON. Valid values: Document, Lines. - - - - - Specifies JSON as request's output serialization format - - - - - The value used to separate individual records in the output. - - - - - Specifies an object key and optional object version. - - - - - Key name of the object to delete. - - - - - - VersionId for the specific version of the object to delete. - - - - - - This class contains the configuration Amazon S3 uses to figure out what events you want to listen - and send the event to an Amazon Lambda cloud function. - - - - - Gets and set the Id property. The Id will be provided in the event content and can be used - to identify which configuration caused an event to fire. If the Id is not provided for the configuration, one will be generated. - - - - - Gets and sets the FunctionArn property. This is the Amazon Lambda cloud function to which Amazon S3 will invoke with the events. - - - - Lifecycle Configuration - - - - - Gets and sets the Rules property. These rules defined the lifecycle configuration. - - - - - Base class for all the different predicates that can be used - in a filter. - - - - - This method is called by the visitor when it wants to visit the predicate. - - - - - - Filter identifying one or more objects to which a applies. - - - - - The predicate used by the filter. - - - - - Base class for lifecycle operators. - - - - - The list of objects - that this operator operates on. - - - - - The logical and operator for filtering objects for a - - - - - Accept a visit from an - - - This method is used internally by the SDK. - - - - - - A predicate that filters objects for a - by matching a particular prefix. - - - - - The prefix to be matched by filtered objects. - - - - - Accept a visit from an - - - This method is used internally by the SDK. - - - - - - A predicate that filters objects for a - by matching a particular key and value. - - - - - The Tag to be matched by filtered objects. - - - - - Accept a visit from an - - - This method is used internally by the SDK. - - - - - - Rules Item - - - - - Defines the length of time, in days, before objects expire. - - - - - Unique identifier for the rule. The value cannot be longer than 255 characters. - - - - - Prefix identifying one or more objects to which the rule applies. - - - - - - Filter identifying one or more objects to which the rule applies. - - - - - If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied. - - - - - - The transition rule that describes when objects transition to a different storage class. - - Lifecycle rules can now contain multiple transitions. This property is obsolete in favor of the Transitions property. - This property will always get or set the the zeroth element in the Transitions collection. - - - - - - Defines the length of time, in days, before noncurrent versions expire. - - - - - The transition rule that describes when noncurrent versions transition to - a different storage class. - - Lifecycle rules can now contain multiple noncurrent version transitions. This property - is obsolete in favor of the NoncurrentVersionTransitions property. - This property will always get or set the the zeroth element in the NoncurrentVersionTransitions collection. - - - - - - The transition rules that describe when objects transition to a different storage class. - - - - - The transition rules that describe when noncurrent versions transition to - a different storage class. - - - - - Specifies the days since the initiation of an Incomplete Multipart Upload - that Lifecycle will wait before permanently removing all parts of the upload. - - - - - Specifies the days since the initiation of an Incomplete Multipart Upload - that Lifecycle will wait before permanently removing all parts of the upload. - - - - - Indicates the number of days that must pass since initiation for Lifecycle - to abort an Incomplete Multipart Upload. - - - - Expiration - - - - - Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format. - - - - - - Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer. - - - - - - Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set to true, the delete marker will be expired; if set to false the policy takes no action. This cannot be specified with Days or Date in a Lifecycle Expiration Policy. - - - - - - Noncurrent Version Expiration - - - - - Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated - action. For information about the noncurrent days calculations, see - How Amazon S3 Calculates When an Object Became Noncurrent - in the Amazon Simple Storage Service Developer Guide. - - - - - LifecycleTransition defines when and how objects transition. - - - - - Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated - action. For information about the noncurrent days calculations, see - How Amazon S3 Calculates When an Object Became Noncurrent - in the Amazon Simple Storage Service Developer Guide. - - - - - The class of storage used to store the object. - - - - - - LifecycleTransition defines when and how objects transition. - - - - - Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format. - - - - - - Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer. - - - - - - The class of storage used to store the object. - - - - - - Container for the parameters to the ListInventoryConfigurationsRequest operation. - Lists the analytics configurations for the bucket. - - - - - The name of the bucket containing the analytics configurations to retrieve. - - - - - The ContinuationToken that represents a placeholder from where this request should begin. - - - - - Returns information about the ListBucketAnalyticsConfigurationsResponse response and response metadata. - - - - - The ContinuationToken that represents where this request began. - - - - - The list of analytics configurations for a bucket. - - - - - Indicates whether the returned list of analytics configurations is complete. - A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request. - - - - - NextContinuationToken is sent when isTruncated is true, which indicates that there are more analytics configurations to list. - The next request must include this NextContinuationToken. The token is obfuscated and is not a usable value. - - - - - Container for the parameters to the ListInventoryConfigurationsRequest operation. - Returns a list of inventory configurations for the bucket. - - - - - The name of the bucket containing the inventory configurations to retrieve. - - - - - The marker used to continue an inventory configuration listing that has been truncated. - Use the NextContinuationToken from a previously truncated list response to continue the listing. - The continuation token is an opaque value that Amazon S3 understands. - - - - - Returns information about the ListInventoryConfigurationsResponse response and response metadata. - - - - - If sent in the request, the marker that is used as a starting point for this inventory configuration list response. - - - - - The list of inventory configurations for a bucket. - - - - - Indicates whether the returned list of inventory configurations is truncated in this response. A value of true indicates that the list is truncated. - - - - - The marker used to continue this inventory configuration listing. Use the NextContinuationToken from this response to continue the listing in a subsequent request. - The continuation token is an opaque value that Amazon S3 understands. - - - - - Container for the parameters to the ListBucketMetricsConfigurationRequest operation. - Lists the metrics configurations for the bucket. - - - - - The name of the bucket containing the metrics configurations to retrieve. - - - - - - The marker that is used to continue a metrics configuration listing that has been truncated. - Use the NextContinuationToken from a previously truncated list response to continue the listing. - The continuation token is an opaque value that Amazon S3 understands. - - - - - - Returns information about the ListBucketMetricsConfiguration response and response metadata. - - - - - - The marker that is used to continue a metrics configuration listing that has been truncated. - Use the NextContinuationToken from a previously truncated list response to continue the listing. - The continuation token is an opaque value that Amazon S3 understands. - - - - - - The list of metrics configurations for a bucket. - - - - - - Indicates whether the returned list of metrics configurations is complete. - A value of true indicates that the list is not complete and the NextContinuationToken will be provided for - a subsequent request. - - - - - - - The marker used to continue a metrics configuration listing that has been truncated. - Use the NextContinuationToken from a previously truncated list response to continue the listing. - The continuation token is an opaque value that Amazon S3 understands. - - - - - - Container for the parameters to the ListBuckets operation. - Returns a list of all buckets owned by the authenticated sender of the request. - - - - - Returns information about the ListBuckets response and response metadata. - - - - - List of buckets. - - - - - Owner of the buckets. - - - - - Container for the parameters to the ListMultipartUploads operation. - This operation lists in-progress multipart uploads. - - - - - Name of the bucket to which the multipart upload was initiated. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Character you use to group keys. - - - - - - Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin. - - - - - - Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response body. 1,000 is the maximum number of uploads that - can be returned in a response. - - - - - - Lists in-progress uploads only for those keys that begin with the specified prefix. - - - - - - Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the - upload-id-marker parameter is ignored. - - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - Returns information about the ListMultipartUploads response and response metadata. - - - - - Name of the bucketName to which the multipart upload was initiated. - - - - - - The key at or after which the listing began. - - - - - - Upload ID after which listing began. - - - - - - When a list is truncated, this element specifies the value that should be used for the key-marker request parameter in a subsequent request. - - - - - - When a list is truncated, this element specifies the value that should be used for the upload-id-marker request parameter in a subsequent - request. - - - - - - Maximum number of multipart uploads that could have been included in the response. - - - - - - Indicates whether the returned list of multipart uploads is truncated. A value of true indicates that the list was truncated. The list can - be truncated if the number of multipart uploads exceeds the limit allowed or specified by max uploads. - - - - - - Gets and sets the MultipartUploads property. - - Container for elements related to a particular multipart upload. A response - can contain zero or more Upload elements. - - - - - - Gets and sets the Prefix property. - - - - - Gets and sets the Delimiter property. - - - - - Gets the CommonPrefixes property. - A response can contain CommonPrefixes only if you specify a delimiter. - When you do, CommonPrefixes contains all (if there are any) keys between - Prefix and the next occurrence of the string specified by delimiter. In effect, - CommonPrefixes lists keys that act like subdirectories in the directory specified - by Prefix. For example, if prefix is notes/ and delimiter is a slash (/), in - notes/summer/july, the common prefix is notes/summer/. - - - - - Container for the parameters to the ListObjects operation. - Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a - subset of the objects in a bucket. - - - - - The name of the bucket containing the objects whose keys are to be listed. - - - - - A delimiter is a character you use to group keys. - - - - - Specifies the key to start with when listing objects in a bucket. - - - - - Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more. - - - - - Limits the response to keys that begin with the specified prefix. - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the ListObjects response and response metadata. - - - - - A flag that indicates whether or not Amazon S3 returned all of the results that satisfied - the search criteria. - - - - - Gets and sets the NextMarker property. - NextMarker is set by S3 only if a Delimiter was specified - in the original ListObjects request. If a delimiter was - not specified, the AWS SDK for .NET returns the last Key - of the List of Objects retrieved from S3 as the NextMarker. - - - - - Gets the S3Objects property. This is a list of - objects in the bucket that match your search criteria. - - - - - Gets and sets the Name property which is the name of the bucket. - - - - - Gets and sets the Prefix property. - - - - - Gets and sets the MaxKeys property. This is max number of object keys returned by the list operation. - - - - - Gets the CommonPrefixes property. - A response can contain CommonPrefixes only if you specify a delimiter. - When you do, CommonPrefixes contains all (if there are any) keys between - Prefix and the next occurrence of the string specified by delimiter. In effect, - CommonPrefixes lists keys that act like subdirectories in the directory specified - by Prefix. For example, if prefix is notes/ and delimiter is a slash (/), in - notes/summer/july, the common prefix is notes/summer/. - - - - - Gets and sets the Delimiter property. - Causes keys that contain the same string between the prefix and the - first occurrence of the delimiter to be rolled up into a single result - element in the CommonPrefixes collection. - - - These rolled-up keys are not returned elsewhere in the response. - - - - - Container for the parameters to the ListObjects operation. - Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a - subset of the objects in a bucket. - - - - - Bucket name to list. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - A delimiter is a character you use to group keys. - - - - - Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more. - - - - - Limits the response to keys that begin with the specified prefix. - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts - listing after this specified key. StartAfter can be any key in the bucket. - Cannot be set at the same time as ContinuationToken. - - - - - ContinuationToken indicates Amazon S3 that the list is being continued on this - bucket with a token. ContinuationToken is obfuscated and is not a real key. - - - - - The owner field is not present in ListObjectsV2 responses by default. - If you want to return owner field with each key in the result then set this field to true. - If not specified, the Owner field on S3Object will be null. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the ListObjects response and response metadata. - - - - - A flag that indicates whether or not Amazon S3 returned all of the results that satisfied - the search criteria. - - - - - Gets and sets the S3Objects property. Metadata about each object returned. - - - - - Bucket name. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the Prefix property. - - - - - Gets and sets the MaxKeys property. This is max number of object keys returned by the list operation. - - - - - Gets and sets the CommonPrefixes property. - CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence - of the string specified by delimiter - - - - - Gets and sets the Delimiter property. - Causes keys that contain the same string between the prefix and the - first occurrence of the delimiter to be rolled up into a single result - element in the CommonPrefixes collection. - - - These rolled-up keys are not returned elsewhere in the response. - - - - - Encoding type used by Amazon S3 to encode object keys in the response. - - - - - KeyCount is the number of keys returned with this request. - KeyCount will always be less than or equal to MaxKeys field. - - - - - ContinuationToken indicates Amazon S3 that the list is being continued - on this bucket with a token. - ContinuationToken is obfuscated and is not a real key - - - - - NextContinuationToken is sent when isTruncated is true which means there - are more keys in the bucket that can be listed. The next ListObjectV2 call - to Amazon S3 can be continued with this NextContinuationToken. - NextContinuationToken is obfuscated and is not a real key. - - - - - StartAfter is where you want Amazon S3 to start listing from. - Amazon S3 starts listing after this specified key. - StartAfter can be any key in the bucket. - - - - - Container for the parameters to the ListParts operation. - Lists the parts that have been uploaded for a specific multipart upload. - - - - - Name of the bucket to which the parts are being uploaded. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The object key for which the multipart upload was initiated. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Sets the maximum number of parts to return. - - - - - - Specifies the part after which listing should begin. Only parts with higher part numbers will be listed. - - - - - - Upload ID identifying the multipart upload whose parts are being listed. - - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the ListParts response and response metadata. - - - - - Name of the bucketName to which the multipart upload was initiated. - - - - - - Object key for which the multipart upload was initiated. - - - - - - Upload ID identifying the multipart upload whose parts are being listed. - - - - - - Part number after which listing begins. - - - - - - When a list is truncated, this element specifies the last part in the list, as well as the value to use for the part-number-marker request - parameter in a subsequent request. - - - - - - Maximum number of parts that were allowed in the response. - - - - - - Indicates whether the returned list of parts is truncated. - - - - - - Gets and sets the Parts property. - - PartDetails is a container for elements related to a particular part. A response can contain - zero or more Part elements. - - - - - - Identifies who initiated the multipart upload. - - - - - - Gets and sets the Owner property. - - - - - The class of storage used to store the object. - - - - - - Date when multipart upload will become eligible for abort operation by lifecycle. - - - - - Id of the lifecycle rule that makes a multipart upload eligible for abort operation. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the ListVersions operation. - Returns metadata about all of the versions of objects in a bucket. - - - - - The bucket name that contains the objects. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - A delimiter is a character you use to group keys. - - - - - Specifies the key to start with when listing objects in a bucket. - - - - - Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more. - - - - - Limits the response to keys that begin with the specified prefix. - - - - - Specifies the object version you want to start listing from. - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - Returns information about the ListVersions response and response metadata. - - - - - A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria. If your results were - truncated, you can make a follow-up paginated request using the NextKeyMarker and NextVersionIdMarker response parameters as a starting - place in another request to return the rest of the results. - - - - - - Marks the last Key returned in a truncated response. - - - - - - Gets and sets the VersionIdMarker property. - Marks the last Version-Id returned in a truncated response. - - - - - Use this value for the key marker request parameter in a subsequent request. - - - - - - Use this value for the next version id marker parameter in a subsequent request. - - - - - - Gets and sets the Versions property. This is a list of - object versions in the bucket that match your search criteria. - - - - - Gets and sets the Name property. - The bucket's name. - - - - - Gets and sets the Prefix property. - Keys that begin with the indicated prefix are listed. - - - - - Gets and sets the MaxKeys property. - This is the maximum number of keys in the S3ObjectVersions collection. - The value is derived from the MaxKeys parameter to ListVersionsRequest. - - - - - Gets the CommonPrefixes property. - A response can contain CommonPrefixes only if you specify a delimiter. - When you do, CommonPrefixes contains all (if there are any) keys between - Prefix and the next occurrence of the string specified by delimiter. - - - - - Gets and sets the Delimiter property. - Causes keys that contain the same string between the prefix and the - first occurrence of the delimiter to be rolled up into a single result - element in the CommonPrefixes collection. - - - These rolled-up keys are not returned elsewhere in the response. - - - - - This class contains the meta data for an S3 object. - - - - - Gets and sets meta data for the object. Meta data names must start with "x-amz-meta-". If the name passeed in as the indexer - doesn't start with "x-amz-meta-" then it will be prepended. - - The name of the meta data. - The value for the meta data - - - - Adds the metadata to the collection, if the name already exists it will be overwritten. - - The name of the metadata element - The value for the metadata - - - - Gets the count of headers. - - - - - Gets the names of the meta data elements. - - - - - A metadata key-value pair to store with an object. - - - - - Key of metadata key-value pair - - - - - Value of metadata key-value pair - - - - - A container specifying replication metrics-related information, including whether - emitting metrics and Amazon S3 events for replication are enabled. In addition, contains - configurations related to specific metrics or events. Must be specified together with a - ReplicationTime block. - - - - - Specifies whether the replication metrics are enabled. - - - - - A container specifying the time threshold for emitting the - s3:Replication:OperationMissedThreshold event. - - - - - Class for MetricsAndOperatorPredicate - A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. - The operator must have at least two predicates, and an object must match all of the predicates - in order for the filter to apply. - - Note: The current implementation restricts the usage to atmost one MetricsPrefixPredicate - and any number of MetricsTagPredicates. - - - - Class for MetricsConfiguration - - - - - The ID used to identify the metrics configuration. - - - - - Specifies a metrics configuration filter. - The metrics configuration will only include objects that meet the filter's criteria. - A filter must be a prefix, a tag, or a conjunction (MetricsAndOperator). - - - - - Filter class for Metrics. - - - - - Filter Predicate setup for specific filter types. - - - - - Filter Predicate abstract class for specific filter types to be derived from. - - - - - Abstract class that can be used over logical filter predicates,i.e. AND/OR. - - - - - Class for MetricsPrefixPredicate - The prefix used when evaluating a metrics filter. - - - - - Class for MetricsTagPredicate - The tag used when evaluating a metrics filter. - - - - - This class contains the mfa codes used authentication - - - - - Gets and sets the serial number of the authentication device - - - - - Gets and sets the displated value on the authentication device - - - - - The formatted string of the mfa codes to be passed to S3. - - - - - Container for elements related to a particular multipart upload. - - - - - Date and time at which the multipart upload was initiated. - - - - - - Identifies who initiated the multipart upload. - - - - - - Key of the object for which the multipart upload was initiated. - - - - - - Gets and sets the Owner property. - - - - - The class of storage used to store the object. - - - - - - Upload ID that identifies the multipart upload. - - - - - - An abstract class for all the notification configurations associated with an Amazon S3 bucket. - - - - - Gets and sets the Events property. These are the events the configuration will listen to. - - - - - Filter criteria for determining which S3 objects trigger event notifications. - - - - - - The container element for Object Lock configuration parameters. - - - - - Gets and sets the property ObjectLockEnabled. - - Indicates whether this object has an Object Lock configuration enabled. - - - - - - Gets and sets the property Rule. - - The Object Lock rule in place for the specified object. - - - - - - A Legal Hold configuration for an object. - - - - - Gets and sets the property Status. - - Indicates whether the specified object has a Legal Hold in place. - - - - - - A Retention configuration for an object. - - - - - Gets and sets the property Mode. - - Indicates the Retention mode for the specified object. - - - - - - Gets and sets the property RetainUntilDate. - - - - - The container element for an Object Lock rule. - - - - - Gets and sets the property DefaultRetention. - - The default retention period that you want to apply to new objects placed in the specified - bucket. - - - - - - Describes the location where the restore job's output is stored. - - - - - Describes an S3 location that will receive the results of the restore request. - - - - - Describes how results of the Select job are serialized. - - - - - Describes the serialization of CSV-encoded Select results. - - - - - Specifies JSON as request's output serialization format. - - - - - The owner of an S3 bucket. - - - - - The display name of the owner. - - - - - The unique identifier of the owner. - - - - - This class contains custom querystring parameters for an S3 object, which can then be signed as part of a Pre-signed URL request - - - - - Gets and sets parameters for the object. Parameter names must start with "x-". If the name passeed in as the indexer - doesn't start with "x-" then it will be prepended. - - The name of the parameter. - The value for the meta data - - - - Adds the parameter to the collection, if the name already exists it will be overwritten. - - The name of the parameter - The value for the parameter - - - - Gets the count of parameters. - - - - - Gets the names of the parameter elements. - - - - - Specifies Parquet as object's input serialization format. - - - - - A container for elements related to a particular part in a multipart operation. - A response can contain zero or more Part elements. - - - - - The date and time at which the part was uploaded. - - - - - The size of the uploaded part data. - - - - - A container holding the part number and etag used when completing a multipart upload. - - - - - Default constructor. - - - - - Constructs an instance of PartETag and sets the part number and etag. - - The part number. - the associated ETag for the part number. - - - - Compares the current object with another object of the same type. - - An object to compare with this object. - - A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has the following meanings: - Value - Meaning - Less than zero - This object is less than the parameter. - Zero - This object is equal to . - Greater than zero - This object is greater than . - - - - - The part number identifying the part. - - - - - The entity tag associated with the part. - - - - - The container element for this bucket's public-policy status. - - - - - Gets and sets the property IsPublic. - - The public-policy status for this bucket. TRUE indicates that this bucket - is public. FALSE indicates that the bucket is not public. - - - - - - The container element for all Public Access Block configuration options. You can enable - the configuration options in any combination. - - - - Amazon S3 considers a bucket policy public unless at least one of the following conditions - is true: - -
  1. - - The policy limits access to a set of CIDRs using aws:SourceIp. For more - information on CIDR, see http://www.rfc-editor.org/rfc/rfc4632.txt - - -
  2. - - The policy grants permissions, not including any "bad actions," to one of the following: - -
    • - - A fixed AWS principal, user, role, or service principal - -
    • - - A fixed aws:SourceArn - -
    • - - A fixed aws:SourceVpc - -
    • - - A fixed aws:SourceVpce - -
    • - - A fixed aws:SourceOwner - -
    • - - A fixed aws:SourceAccount - -
    • - - A fixed value of s3:x-amz-server-side-encryption-aws-kms-key-id - -
    • - - A fixed value of aws:userid outside the pattern "AROLEID:*" - -
- - "Bad actions" are those that could expose the data inside a bucket to reads or writes - by the public. These actions are s3:Get*, s3:List*, s3:AbortMultipartUpload, - s3:Delete*, s3:Put*, and s3:RestoreObject. - - - - The star notation for bad actions indicates that all matching operations are considered - bad actions. For example, because s3:Get* is a bad action, s3:GetObject, - s3:GetObjectVersion, and s3:GetObjectAcl are all bad actions. - - - - - - Gets and sets the property BlockPublicAcls. - - Specifies whether Amazon S3 should block public ACLs for this bucket. Setting this - element to TRUE causes the following behavior: - -
  • - - PUT Bucket acl and PUT Object acl calls will fail if the specified ACL allows public - access. - -
  • - - PUT Object calls will fail if the request includes an object ACL. - -
- - Note that enabling this setting doesn't affect existing policies or ACLs. - - - - - - Gets and sets the property IgnorePublicAcls. - - Specifies whether Amazon S3 should ignore public ACLs for this bucket. Setting this - element to TRUE causes Amazon S3 to ignore all public ACLs on this bucket - and any objects that it contains. - - - - Note that enabling this setting doesn't affect the persistence of any existing ACLs - and doesn't prevent new public ACLs from being set. - - - - - - Gets and sets the property BlockPublicPolicy. - - Specifies whether Amazon S3 should block public bucket policies for this bucket. Setting - this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy - if the specified bucket policy allows public access. - - - - Note that enabling this setting doesn't affect existing bucket policies. - - - - - - Gets and sets the property RestrictPublicBuckets. - - Specifies whether Amazon S3 should restrict public bucket policies for this bucket. - If this element is set to TRUE, then only the bucket owner and AWS Services - can access this bucket if it has a public policy. - - - - Note that enabling this setting doesn't affect previously stored bucket policies, - except that public and cross-account access within any public bucket policy, including - non-public delegation to specific accounts, is blocked. - - - - - - Container for the parameters to the PutAcl operation. - uses the acl subresource to set the access control list (ACL) permissions for an object that already exists in a bucket - - - - - The canned ACL to apply to the bucket. - - - - - - Custom ACLs to be applied to the bucket or object. - - - - - The bucket name that contains the object to which you want to attach the ACL. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The key of an S3 object. - If not specified, the ACLs are applied to the bucket. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - If set and an object key has been specified, the ACLs are applied - to the specific version of the object. - This property is ignored if the ACL is to be set on a Bucket. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - Returns information about the PutObjectAcl response metadata. - The PutAcl operation has a void result type. - - - - - The response for the PutBucketAccelerateConfiguration operation. - Adds an object to a bucket. - - - - - Container for the parameters to the PutBucketAccelerateConfiguration request. - - - - - The name of the bucket to contain the object. - - - - - Accelerate configuration for the bucket. - - - - - Container for the parameters to the PutBucketAnalyticsConfiguration operation. - Sets an analytics configuration for the bucket (specified by the analytics configuration ID). - - - - - The name of the bucket to which an analytics configuration is stored. - - - - - The identifier used to represent an analytics configuration. - - - - - The configuration and any analyses for the analytics filter. - - - - - Returns information about the PutBucketAnalyticsConfigurationResponse response metadata. - The PutBucketAnalyticsConfigurationResponse operation has a void result type. - - - - - Container for the parameters to the PutBucketRequestPayment operation. - Creates a new server-side encryption configuration (or replaces an existing one, if present). - - - - - The name of the bucket for which the server-side encryption configuration is set. - - - - - The base64-encoded 128-bit MD5 digest of the server-side encryption configuration. - - - This header can be used as a message integrity check to verify that the data is the same data that was originally sent. - Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. - - - - - Container for server-side encryption configuration rules. Currently S3 supports one rule only. - - - - - Container for the parameters to the PutBucketRequestPayment operation. - Adds an inventory configuration (identified by the inventory ID) from the bucket. - - - - - The name of the bucket where the inventory configuration will be stored. - - - - - Specifies the inventory Id. - - - - - Specifies the inventory configuration. - - - - - Returns information about the PutInventoryConfigurationResponse response metadata. - The PutInventoryConfigurationResponse operation has a void result type. - - - - - Container for the parameters to the PutBucketLoggingRequest operation. - Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. To set the - logging status of a bucket, you must be the bucket owner. - - - - - Gets and sets the BucketName property. - - - - - Gets and sets the LoggingConfig property. - - - - - Returns information about the PutBucketLogging response metadata. - The EnableBucketLogging operation has a void result type. - - - - - Container for the parameters to the PutBucketMetricsConfigurationRequest operation. - Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. - - - - - The name of the bucket for which the metrics configuration is set. - - - - - The ID used to identify the metrics configuration. - - - - - Specifies the metrics configuration. - - - - - Returns information about the PutBucketMetricsConfiguration response metadata. - The PutBucketMetricsConfiguration operation has a void result type. - - - - - Container for the parameters to the PutBucketNotification operation. - Enables notifications of specified events for a bucket. - - - - - Gets and sets the BucketName property. - - - - - Gets and sets the TopicConfigurations property. TopicConfigurations are configuration for Amazon S3 - events to be sent to Amazon SNS topics. - - - - - Gets and sets the QueueConfigurations property. QueueConfigurations are configuration for Amazon S3 - events to be sent to Amazon SQS queues. - - - - - Gets and sets the LambdaFunctionConfigurations property. LambdaFunctionConfigurations are configuration for - Amazon S3 events to be sent to an Amazon Lambda cloud function. - - - - - Returns information about the PutBucketNotification response metadata. - The PutBucketNotification operation has a void result type. - - - - - Container for the parameters to the PutBucketPolicy operation. - Replaces a policy on a bucket. If the bucket already has a policy, the one in this request completely replaces it. - - - - - The name of the bucket. - - - - - The base64 encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. - - - This header can be used as a message integrity check to verify that the data is the same data that was originally sent. - Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. - - - - - The bucket policy as a JSON document. - - - - - Set this parameter to true to confirm that you want to remove your - permissions to change this bucket policy in the future. - - - - - Overriden to turn off sending SHA256 header. - - - - - Returns information about the PutBucketPolicy response metadata. - The PutBucketPolicy operation has a void result type. - - - - - Container for the parameters to the PutBucketReplication operation. - Sets replication configuration for your bucket. If a replication configuration exists, this replaces it. - - - - - The name of the bucket to have the replication configuration applied. - - - - - The replication configuration to be applied. - - - - - Gets and sets the property Token. - - - - - Returns information about the PutBucketReplicationConfiguration response metadata. - The PutBucketReplicationConfiguration operation has a void result type. - - - - - Container for the parameters to the PutBucket operation. - Creates a new bucket. - - - - - The canned ACL to apply to the bucket. - - - - - - If set to true the bucket will be created in the same region - as the configuration of the AmazonS3 client. - If PutBucketRequest.BucketRegion or PutBucketRequest.BucketRegionName are set they take precedence over - this property. - Default: true. - - - - - The name of the bucket to be created. - - - - - The region locality for the bucket. - - - When set, this will determine where your data will - reside in S3. Refer - for a list of possible values. - - - - - The bucket region locality expressed using the name of the region. - When set, this will determine where your data will reside in S3. - Valid values: us-east-1, us-west-1, us-west-2, eu-west-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, sa-east-1 - - - - - Gets and sets the property ObjectLockEnabledForBucket. - - Specifies whether you want S3 Object Lock to be enabled for the new bucket. - - - - - - Container for the parameters to the PutBucketRequestPayment operation. - Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This - configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the - download. - - - - - The name of the bucket to set payment config. - - - - - Gets and sets request payment configuration - - - - - Returns information about the PutBucketRequestPayment response metadata. - The PutBucketRequestPayment operation has a void result type. - - - - - Returns information about the PutBucket response and response metadata. - - - - - Container for the parameters to the PutBucketTagging operation. - Sets the tags for a bucket. - - - - - The name of the bucket to apply the tags to. - - - - - The collection of tags. - - - - - Returns information about the PutBucketTagging response metadata. - The PutBucketTagging operation has a void result type. - - - - - Container for the parameters to the PutBucketVersioning operation. - Sets the versioning state of an existing bucket. To set the versioning state, you must be the bucket owner. - - - - - The name of the bucket to be updated. - - - - - The MfaCodes Tuple associates the Serial Number and the current Token/Code displayed on the - Multi-Factor Authentication device associated with your AWS Account. - - - This is a required property for this request if:
- 1. EnableMfaDelete was configured on the bucket - containing this object's version.
- 2. You are deleting an object's version - - - - - Checks if the MfaCodes property is set. - - true if the MfaCodes property is set. - - - - The versioning configuration to apply to the bucket. - - - Once Versioning has been "Enabled" on a bucket, it can be "Suspended" - but cannot be switched "Off". If EnableMfaDelete is set, - the MfaCodes property needs to contain the Serial of and current Token - displayed on the MFA device. - - - - - Returns information about the PutBucketVersioning response metadata. - The PutBucketVersioning operation has a void result type. - - - - - Container for the parameters to the PutBucketWebsite operation. - Set the website configuration for a bucket. - - - - - The name of the bucket to apply the configuration to. - - - - - The website configuration to apply. The configuration defines the index - document suffix and custom error page. - - - - - Returns information about the PutBucketWebsite response metadata. - The PutBucketWebsite operation has a void result type. - - - - - Container for the parameters to the PutCORSConfiguration operation. - Sets the cors configuration for a bucket. - - - - - The name of the bucket to have the CORS configuration applied. - - - - - The CORS configuration to apply. - - - - - Returns information about the PutCORSConfiguration response metadata. - The PutCORSConfiguration operation has a void result type. - - - - - Container for the parameters to the PutLifecycleConfiguration operation. - Sets lifecycle configuration for your bucket. If a lifecycle configuration exists, it replaces it. - - - - - The name of the bucket to have the lifecycle configuration applied. - - - - - The lifecycle configuration to be applied. - - - - - Returns information about the PutLifecycleConfiguration response metadata. - The PutLifecycleConfiguration operation has a void result type. - - - - - Container for the parameters to the PutObjectLegalHold operation. - Applies a Legal Hold configuration to the specified object. - - - - - The bucket name containing the object that you want to place a Legal Hold on. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property ContentMD5. - - The MD5 signature for the configuration included in your request. - - - - - - Gets and sets the property Key. - - The key name for the object that you want to place a Legal Hold on. - - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Gets and sets the property LegalHold. - - Container element for the Legal Hold configuration you want to apply to the specified - object. - - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property VersionId. - - The version ID of the object that you want to place a Legal Hold on. - - - - - - This is the response object from the PutObjectLegalHold operation. - - - - - Gets and sets the property RequestCharged. - - - - - Container for the parameters to the PutObjectLockConfiguration operation. - Places an Object Lock configuration on the specified bucket. The rule specified in - the Object Lock configuration will be applied by default to every new object placed - in the specified bucket. - - - - - Gets and sets the property BucketName. - - The bucket whose Object Lock configuration you want to create or replace. - - - - - - Gets and sets the property ContentMD5. - - The MD5 signature for the configuration included in your request. - - - - - - Gets and sets the property ObjectLockConfiguration. - - The Object Lock configuration that you want to apply to the specified bucket. - - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property Token. - - - - - This is the response object from the PutObjectLockConfiguration operation. - - - - - Gets and sets the property RequestCharged. - - - - - Container for the parameters to the PutObject operation. - Adds an object to a bucket. - - - Container for the parameters to the PutObject operation. - Adds an object to a bucket. - - - - - A canned access control list (CACL) to apply to the object. - Please refer to for - information on S3 Canned ACLs. - - - - - Input stream for the request; content for the request will be read from the stream. - - - - - - The full path and name to a file to be uploaded. - If this is set the request will upload the specified file to S3. - - - For WinRT and Windows Phone this property must be in the form of "ms-appdata:///local/file.txt". - - - - - - Text content to be uploaded. Use this property if you want to upload plaintext to S3. - The content type will be set to 'text/plain'. - - - - - If this value is set to true then the stream used with this request will be closed when all the content - is read from the stream. - Default: true. - - - - - If this value is set to true then the stream will be seeked back to the start before being read for upload. - Default: true. - - - - - If this value is set to true then a chunked encoding upload will be used for the request. - Default: true. - - - - - Bucket name to which the PUT operation was initiated. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - Gets and sets Key property. This key is used to identify the object in S3. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - Checks if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - true if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - - - The type of storage to use for the object. Defaults to 'STANDARD'. - - - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - The Legal Hold status that you want to apply to the specified object. - - - - - - Gets and sets the property ObjectLockMode. - - The Object Lock mode that you want to apply to this object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - The date and time when you want this object's Object Lock to expire. - - - - - - If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - Attach a callback that will be called as data is being sent to the AWS Service. - - - - - This is a convenience property for Headers.ContentType. - - - - - An MD5 digest for the content. - - - - The base64 encoded 128-bit MD5 digest of the message - (without the headers) according to RFC 1864. This header - can be used as a message integrity check to verify that - the data is the same data that was originally sent. - - - If supplied, after the file has been uploaded to S3, - S3 checks to ensure that the MD5 hash of the uploaded file - matches the hash supplied. - - - Although it is optional, we recommend using the - Content-MD5 mechanism as an end-to-end integrity check. - - - - - - Checks if MD5Digest property is set. - - true if MD5Digest property is set. - - - - Overriden to turn off sending SHA256 header. - - - - - Overriden to turn on expect 100 continue. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - The tag-set for the object. The tag-set must be encoded as URL Query parameters. - - - - - Checks if Tagging property is set - - true if Tagging is set. - - - - Returns information about the PutObject response and response metadata. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - Entity tag for the uploaded object. - - - - - - Version of the object. - - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the PutObjectRetention operation. - Places an Object Retention configuration on an object. - - - - - The bucket name that contains the object you want to apply this Object Retention configuration to. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property BypassGovernanceRetention. - - - - - Gets and sets the property ContentMD5. - - The MD5 signature for the configuration included in your request. - - - - - - Gets and sets the property Key. - - The key name for the object that you want to apply this Object Retention configuration - to. - - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property Retention. - - The container element for the Object Retention configuration. - - - - - - Gets and sets the property VersionId. - - The version ID for the object that you want to apply this Object Retention configuration - to. - - - - - - This is the response object from the PutObjectRetention operation. - - - - - Gets and sets the property RequestCharged. - - - - - Container for the parameters to the PutObjectTagging operation. - - - - - The bucket name containing the object. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Check to see if Bucket property is set - - - - - Gets and sets Key property. This key is used to identify the object in S3. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Check to see if Key property is set - - - - - The tag-set for the object. The tag-set must be encoded as URL Query parameters - - - - - Checks if Tagging property is set. - - - - - VersionId used to reference a specific version of the object. - - - - - - Returns information about the PutObjectTagging response and response metadata. - - - - - Version of the object. - - - - - Container for the parameters to the PutPublicAccessBlock operation. - Creates or modifies the Public Access Block configuration for an Amazon S3 bucket. - - - - - Gets and sets the property BucketName. - - The name of the Amazon S3 bucket whose Public Access Block configuration you want - to set. - - - - - - Gets and sets the property ContentMD5. - - The MD5 hash of the PutPublicBlock request body. - - - - - - Gets and sets the property PublicAccessBlockConfiguration. - - The Public Access Block configuration that you want to apply to this Amazon S3 bucket. - - - - - - This is the response object from the PutPublicAccessBlock operation. - - - - - Base class for put operations that can also put an ACL. - - - - - Gets the access control lists (ACLs) for this request. - Please refer to for information on - S3 Grants. - - - - - This class contains the configuration Amazon S3 uses to figure out what events you want to listen - and send the event to an Amazon SQS queue. - - The queue's policy must allow S3 to send messages to it. The utility method - Amazon.SQS.AmazonSQSClient.AuthorizeS3ToSendMessage(string,string) - can be used to help setup the queue policy. - - - - - - Gets and set the Id property. The Id will be provided in the event content and can be used - to identify which configuration caused an event to fire. If the Id is not provided for the configuration, one will be generated. - - - - - Gets and sets the Queue property. Amazon SQS queue to which Amazon S3 will publish a message - to report the specified events for the bucket. - - The queue's policy must allow S3 to send messages to it. The utility method - Amazon.SQS.AmazonSQSClient.AuthorizeS3ToSendMessage(string,string) - can be used to help setup the queue policy. - - - - - - This class defines the configuration for replication. - - - - - Indicates the ARN of the role to assume. - - - - - Check to see if the Role property is set. - - true if the Role property is set. - - - - Container for information about a particular replication rule. - Replication configuration must have at least one rule and can contain up to 1,000 rules. - - - - - Checks to see if the Rules property is set. - - true if the Rules property is set. - - - - Destination configuration for a replication rule. - - - - -

Amazon resource name (ARN) of the bucket where you want Amazon - S3 to store replicas of the object identified by the rule.

- If you have multiple rules in your replication configuration, all - rules must specify the same bucket as the destination. A replication - configuration can replicate objects only to one destination bucket.

- - - - - Checks to see if BucketArn property is set. - - true if BucketArn property is set. - - - - The class of storage used to store the object. - - - - - -

Account ID of the destination bucket. Currently Amazon S3 verifies this - value only if Access Control Translation is enabled.

In a cross-account - scenario, if you tell Amazon S3 to change replica ownership to the AWS account - that owns the destination bucket by adding the AccessControlTranslation - element, this is the account ID of the destination bucket owner.

- - - - -

Container for information regarding the access control for replicas.

-

Use only in a cross-account scenario, where source and destination bucket - owners are not the same, when you want to change replica ownership to the AWS - account that owns the destination bucket. If you don't add this element to the - replication configuration, the replicas are owned by same AWS account that - owns the source object.

- - - - -

Container that provides encryption-related information. You must - specify this element if the SourceSelectionCriteria is - specified.

- - - - - A container specifying the time when all objects and operations on objects are - replicated. Must be specified together with a Metrics block. - - - - - A container specifying replication metrics-related information, including whether - emitting metrics and Amazon S3 events for replication are enabled. In addition, - contains configurations related to specific metrics or events. Must be specified - together with a ReplicationTime block. - - - - - Rule that specifies the replication configuration. - - - - - Unique identifier for the rule. The value cannot be longer than 255 characters. - - - - - Checks to see if Id property is set. - - true if Id property is set. - - - -

The priority associated with the rule. If you specify multiple rules in a - replication configuration, then Amazon S3 applies rule priority in the event - there are conflicts (two or more rules identify the same object based on - filter specified). The rule with higher priority takes precedence. For - example,

  • Same object quality prefix based filter criteria - If prefixes you specified in multiple rules overlap.

  • Same - object qualify tag based filter criteria specified in multiple rules

    • -

For more information, see - - Cross-Region Replication (CRR) in the Amazon S3 Developer Guide.

- - - - - Checks to see if Priority property is set. - - true if Priority property is set. - - - - Object keyname prefix identifying one or more objects to which the - rule applies. Maximum prefix length can be up to 1,024 characters. - - - - - Checks to see if Prefix property is set. - - true if Prefix property is set. - - - - Gets and sets the property Filter. - - - - - Checks to see if Filter property is set. - - true if Filter property is set. - - - - Whether the rule is applied or ignored. - - - - - Checks to see if Status property is set. - - true if Status property is set. - - - - Container for replication destination information. - - - - - Checks to see if Destination property is set. - - true if Destination property is set. - - - -

Container that describes additional filters in identifying source objects that - you want to replicate. Currently, Amazon S3 supports only the filter that you can - specify for objects created with server-side encryption using an AWS KMS-managed - key. You can choose to enable or disable replication of these objects.

if - you want Amazon S3 to replicate objects created with server-side encryption using - AWS KMS-managed keys.

- - - - - A container that specifies information about existing object replication. - You can choose whether to enable or disable the replication of existing objects. - - - - - Checks to see if ExistingObjectReplication property is set. - - true if ExistingObjectReplication property is set. - - - - Specifies whether Amazon S3 should replicate delete makers. - - - - - Checks to see if DeleteMarkerReplication property is set. - - true if DeleteMarkerReplication property is set. - - - - - - - - Object keyname prefix that identifies subset of objects to which the rule applies. - - - - - Checks to see if Prefix property is set. - - true if Prefix property is set. - - - - All of these tags must exist in the object's tag set in order for the rule to apply. - - - - - Checks to see if Tags property is set. - - true if Tags property is set. - - - - Filter that identifies subset of objects to which the replication rule applies. - A Filter must specify exactly one Prefix, - Tag, or an And child element. - - - - - Object keyname prefix that identifies subset of objects to which the rule applies. - - - - - Checks to see if Prefix property is set. - - true if Prefix property is set. - - - -

Container for specifying a tag key and value.

-

The rule applies only to objects having the tag in its tagset.

- - - - - Checks to see if Tag property is set. - - true if Tag property is set. - - - -

Container for specifying rule filters. These filters determine the - subset of objects to which the rule applies. The element is required - only if you specify more than one filter. For example:

  • -

    You specify both a Prefix and a Tag - filters. Then you wrap these in an And tag.

    • -

  • You specify filter based on multiple tags. Then you wrap the - Tag elements in an And tag.

- - - - - Checks to see if And property is set. - - true if And property is set. - - - - A container specifying the time when all objects and operations on objects are replicated. Must be specified together with a Metrics block. - - - - - Specifies whether the replication time is enabled. - - - - - A container specifying the time by which replication should complete for all objects and operations on objects. - - - - - A container specifying the time value. - - - - - Contains an integer specifying time in minutes. - - - - - Request Payment Configuration - - - - - Specifies who pays for the download and request fees. - - - - - Container for values of the response headers that will be set on a response from a GetObject request. - These values override any headers that were set when the object was uploaded to S3. - - - - - A standard MIME type describing the format of the object data. - - - The content type for the content being uploaded. This property defaults to "binary/octet-stream". - For more information, refer to: - - - - - ContentLanguage header value. - - - - - Expiry header value. - - - - - CacheControl header value. - - - - - The ContentDisposition header value. - - - - - The ContentEncoding header value. - - - - - Container for the parameters to the RestoreObject operation. - Restores an archived copy of an object back into Amazon S3 - - - - - The bucket name or containing the object to restore. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the Key property. This key indicates the S3 object to restore. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Lifetime of the active copy in days - ** Do not use with restores that specify OutputLocation ** - - - - - VersionId used to reference a specific version of the object. - - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Glacier retrieval tier at which the restore will be processed. - ** Do not use with restores that specify OutputLocation ** - - - - - Glacier retrieval tier at which the restore will be processed. - ** Only use with restores that require OutputLocation ** - - - - - Type of restore request. - - - - - The optional description for the job. - - - - - Describes the parameters for Select job types. - - - - - Describes the location where the restore job's output is stored. - - - - - Returns information about the RestoreObject response metadata. - The RestoreObject operation has a void result type. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Indicates the path in the provided S3 output location where Select results will be restored to. - - - - Routing Rule - - - - - A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the - /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might - process the error. - - - - - - Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event of an - error, you can can specify a different error code to return. - - - - - - A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages - in the /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you - might process the error. - - - - - The HTTP error code when the redirect is applied. In the event of an error, if the error code equals this value, then the specified redirect - is applied. Required when parent element Condition is specified and sibling KeyPrefixEquals is not specified. If both are specified, then - both must be true for the redirect to be applied. - - - - - - The object key name prefix when the redirect is applied. For example, to redirect requests for ExamplePage.html, the key prefix will be - ExamplePage.html. To redirect request for all pages with the prefix docs/, the key prefix will be /docs, which identifies all objects in the - docs/ folder. Required when the parent element Condition is specified and sibling HttpErrorCodeReturnedEquals is not specified. If both - conditions are specified, both must be true for the redirect to be applied. - - - - - - Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event - of an error, you can can specify a different error code to return. - - - - - Name of the host where requests will be redirected. - - - - - - The HTTP redirect code to use on the response. Not required if one of the siblings is present. - - - - - - Protocol to use (http, https) when redirecting requests. The default is the protocol that is used in the original request. - - - - - - The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix docs/ (objects in the - docs/ folder) to documents/, you can set a condition block with KeyPrefixEquals set to docs/ and in the Redirect set ReplaceKeyPrefixWith to - /documents. Not required if one of the siblings is present. Can be present only if ReplaceKeyWith is not provided. - - - - - - The specific object key to use in the redirect request. For example, redirect request to error.html. Not required if one of the sibling is - present. Can be present only if ReplaceKeyPrefixWith is not provided. - - - - - - Represents an access control list (ACL) for S3. An AccessControlList is represented by an Owner, - and a List of Grants, where each Grant is a Grantee and a Permission. - - - - Each bucket and object in Amazon S3 has an ACL that defines its access control policy. - When a request is made, Amazon S3 authenticates the request using its standard - authentication procedure and then checks the ACL to verify the sender was granted access - to the bucket or object. If the sender is approved, the request proceeds. - Otherwise, Amazon S3 returns an error. - - - An ACL is a list of grants. A grant consists of one grantee and one permission. - ACLs only grant permissions; they do not deny them. - - - For convenience, some commonly used Access Control Lists are defined in - S3CannedACL. - - - Note: BucketName and object ACLs are completely independent; an object does not inherit the ACL - from its bucket. For example, if you create a bucket and grant write access to another user, - you will not be able to access the user's objects unless the user explicitly grants access. - This also applies if you grant anonymous write access to a bucket. Only the user "anonymous" - will be able to access objects the user created unless permission is explicitly granted to - the bucket owner. - - - Important: We highly recommend that you do not grant the anonymous group write access to your - buckets as you will have no control over the objects others can store and their associated charges. - For more information, see Grantees and Permissions - - - - - Creates a S3Grant and adds it to the list of grants. - - The grantee for the grant. - The permission for the grantee. - - - - Removes a specific permission for the given grantee. - - The grantee - The permission for the grantee to remove - - - - Removes all permissions for the given grantee. - - - - - - The owner of the bucket or object. - - - - Every bucket and object in Amazon S3 has an owner, the user that - created the bucket or object. The owner of a bucket or object cannot - be changed. However, if the object is overwritten by another user - (deleted and rewritten), the new object will have a new owner. - - - Note: Even the owner is subject to the ACL. For example, if an owner - does not have Permission.READ access to an object, the owner cannot read - that object. However, the owner of an object always has write access to the - access control policy (Permission.WriteAcp) and can change the ACL to - read the object. - - - - - - Checks if Owner property is set. - - true if Owner property is set. - - - - A collection of grants. - - - - - Checks if Grants property is set. - - true if Grants property is set. - - - Bucket - Represents an S3 bucket, contains the name of the S3 bucket and the date that the bucket was created. - - - - - Date the bucket was created. - - - - - - The name of the bucket. - - - - - Logging Enabled - - - - - Specifies the bucket where you want Amazon S3 to store server access logs. You can have your logs delivered to any bucket that you own, - including the same bucket that is being logged. You can also configure multiple buckets to deliver their logs to the same target bucket. In - this case you should choose a different TargetPrefix for each source bucket so that the delivered log files can be distinguished by key. - - - - - A collection of grants. - - - - - This element lets you specify a prefix for the keys that the log files will be stored under. - - - - - Creates a S3Grant and adds it to the list of grants. - - The grantee for the grant. - The permission for the grantee. - - - - Removes a specific permission for the given grantee. - - The grantee - The permission for the grantee to remove - - - - Removes all permissions for the given grantee. - - - - - - An S3 bucket versioning configuration. - - - Contains the bucket's versioning status (Off, Enabled, Suspended) and whether an MFADelete - has been enabled for the bucket. - - - - - Versioning status for the bucket. - Accepted values: Off, Enabled, Suspended. - - - - - Checks if Status property is set - - true if Status property is set - - - - Specifies whether MFA Delete is enabled on this S3 Bucket. - - - If this property is set, please ensure that the - PutBucketVersioningRequest's MfaCodes property is set with - the Serial of and Token on the MFA device. - - - - - Checks if EnableMfaDelete property is set. - - true if Status property is set - - - - Describes the server-side encryption that will be applied to the restore results. - - - - - The server-side encryption algorithm used when storing job results in Amazon S3 (e.g., AES256, aws:kms). - - - - - Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by - AWS KMS will fail if not made via SSL or using SigV4. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at - http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version - - - - - If the encryption type is aws:kms, this optional value can be used to specify the encryption context for the restore results. - - - - Grant - - - - - The grantee details. - - - - - Specifies the permission given to the grantee. - - - - - Grantee - - - - - Type of grantee - - - - - - Screen name of the grantee. - - - - - - Email address of the grantee. - - - - - - The canonical user ID of the grantee. - - - - - - URI of the grantee group. - - - - - - Filter criteria that allows for event notification filtering based on an S3 Object's key name. - - - - - Gets and sets the filterRules property. - These are the filter rules for this filter. - - - - - Describes an S3 location that will receive the results of the restore request. - - - - - The name of the bucket where the restore results will be placed. - - - - - The prefix that is prepended to the restore results for this request. - - - - - The canned ACL to apply to the restore results. - - - - - A list of grants that control access to the staged results. - - - - - The tag-set that is applied to the restore results. - - - - - A map of metadata to store with the restore results in S3. - - - - - The class of storage used to store the restore results. - - - - - Represents an S3 Object. Contains all attributes that an S3 Object has. - For more information about S3 Objects refer: - - - - - - Any ETag set on the object. - - - - - The name of the bucket containing this object. - - - - - The key of the object. - - - - - The date and time the object was last modified. - - The date retrieved from S3 is in ISO8601 format. A GMT formatted date is passed back to the user. - - - - - - The owner of the object. - - - - - The size of the object. - - - - - The class of storage used to store the object. - - - - - - Represents a version of an object in an S3 Bucket. An S3 object version is an S3 object - that also has a version identifier, an indication of whether this is the latest version of the object - and whether it's a DeleteMarker or not. - - - - - Specifies whether the object is (true) or is not (false) the latest version of an object. - - - - - Version ID of an object. - - - - - If true, the object is a delete marker for a deleted object. - - - - - Specifies the byte range of the object to get the records from. A record is processed when its first byte is contained by the range. - - - - - Specifies the start of the byte range. This parameter is optional. Valid values: non-negative integers. The default value is 0. - - - - - Specifies the end of the byte range. This parameter is optional. Valid values: non-negative integers. The default value is one less than the size of the object being queried. - - - - - Request to filter the contents of an Amazon S3 object based on a simple Structured Query Language (SQL) statement. - - In the request, along with the SQL expression, you must also specify a data serialization format (JSON or CSV) of the object. - Amazon S3 uses this to parse object data into records, and returns only records - that match the specified SQL expression. You must also specify the data serialization format for the response. - - - - S3Select API Documentation - - - - - The S3 Bucket. - - - - - The Object Key. - - - - - The SSE Algorithm used to encrypt the object. - - - Server-Side Encryption (Using Customer-Provided Encryption Keys. - - - - - The SSE Customer Key. - - - Server-Side Encryption (Using Customer-Provided Encryption Keys. - - - - - The SSE Customer Key MD5. - - - Server-Side Encryption (Using Customer-Provided Encryption Keys. - - - - - The expression that is used to query the object. - - - - - The type of the provided expression (e.g., SQL). - - - - - Specifies if periodic request progress information should be enabled. - - - - - Describes the format of the data in the object that is being queried. - - - - - Describes the format of the data that you want Amazon S3 to return in response. - - - - - The byte range of the object to get the records from. - - - - - Contains the response Payload for the SelectObjectContent request - - - - - The Event Stream result of SelectObjectContent - - - - - Describes the parameters for Select job types. - - - - - Describes the serialization format of the object. - - - - - The type of the provided expression (e.g., SQL). - - - - - The expression that is used to query the object. - - - - - Describes how the results of the Select job are serialized. - - - - - ServerSideEncryptionByDefault class - - - - - Server-side encryption algorithm to use for the default encryption. - - - - - KMS master key ID to use for the default encryption. - This parameter is allowed if SSEAlgorithm is aws:kms. - - - - - ServerSideEncryptionConfiguration class - - - - - Container for information about a particular server-side encryption configuration rule. - - - - - ServerSideEncryptionRule class - - - - - Describes the default server-side encryption to apply to - new objects in the bucket. If Put Object request - does not specify any server-side encryption, - this default encryption will be applied. - - - - - SourceSelectionCriteria class - - - - - Container for filter information of selection of KMS Encrypted - S3 objects. The element is required if you include - SourceSelectionCriteria in the replication - configuration. - - - - - SSEKMS class - - - - - Specifies the ID of the AWS Key Management Service (KMS) - master encryption key to use for encrypting Inventory reports. - - - - - SseKmsEncryptedObjects class - - - - - The replication for KMS encrypted S3 objects is disabled if status is not Enabled. - - - - - SSES3 class - - - - - Class for StorageClassAnalysis - - - - - A container used to describe how data related to the storage class analysis should be exported. - - - - - Class for StorageClassAnalysisDataExport - - - - - The version of the output schema to use when exporting data. Must be V_1. - - - - - The place to store the data for an analysis. - - - - - Base class for responses that return a stream. - - - - - Disposes of all managed and unmanaged resources. - - - - - An open stream read from to get the data from S3. In order to - use this stream without leaking the underlying resource, please - wrap access to the stream within a using block. - - - - - The exception that is thrown when the size of a stream does not match it's expected size. - - - - - Gets and sets ExpectedSize property. - - - - - Gets and sets ActualSize property. - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - - - Tag is a key-value pair of metadata associated with an S3Object - - - - - Name of the tag. - - - - - Value of the tag. - - - - - Structure that contains list of Tags - - - - - TagSet - - - - - This class contains the configuration Amazon S3 uses to figure out what events you want to listen - and send the event to an Amazon SNS topic. - - The topic's policy must allow S3 to publish messages to it. The utility method - Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.AuthorizeS3ToPublish(string,string) - can be used to help setup the topic policy. - - - - - - Gets and set the Id property. The Id will be provided in the event content and can be used - to identify which configuration caused an event to fire. If the Id is not provided for the configuration, one will be generated. - - - - - Bucket event for which to send notifications. - - Topic configurations can now contain multiple events. This property is obsolete in favor of the Events property. - This property will always get or set the the zeroth element in the Events collection. - - - - - - Gets and sets the Topic property. Amazon SNS topic to which Amazon S3 will publish a message to report the - specified events for the bucket. - - The topic's policy must allow S3 to publish messages to it. The utility method - Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.AuthorizeS3ToPublish(string,string) - can be used to help setup the topic policy. - - - - - - The parameters to request upload of a part in a multipart upload operation. - - - - If PartSize is not specified then the rest of the content from the file - or stream will be sent to Amazon S3. - - - You must set either the FilePath or InputStream. If FilePath is set then the FilePosition - property must be set. - - - - The parameters to request upload of a part in a multipart upload operation. - - - - If PartSize is not specified then the rest of the content from the file - or stream will be sent to Amazon S3. - - - You must set either the FilePath or InputStream. If FilePath is set then the FilePosition - property must be set. - - - - - - Caller needs to set this to true when uploading the last part. This property only needs to be set - when using the AmazonS3EncryptionClient. - - - - - Input stream for the request; content for the request will be read from the stream. - - - - - The name of the bucket containing the object to receive the part. - - - - - The key of the object. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Part number of part being uploaded. - - - - - - The size of the part to be uploaded. - - - - - Checks if PartSize property is set. - - true if PartSize property is set. - - - - Upload ID identifying the multipart upload whose part is being uploaded. - - - - - - An MD5 digest for the part. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - - Full path and name of a file from which the content for the part is retrieved. - - - For WinRT and Windows Phone this property must be in the form of "ms-appdata:///local/file.txt". - - - - - - Checks if the FilePath property is set. - - true if FilePath property is set. - - - - Position in the file specified by FilePath from which to retrieve the content of the part. - This field is required when a file path is specified. It is ignored when using the InputStream property. - - - - - If this value is set to true then a chunked encoding upload will be used for the request. - Default: true. - - - - - Checks if the FilePosition property is set. - - true if FilePosition property is set. - - - - Checks if the MD5Digest property is set. - - true if Md5Digest property is set. - - - - Attach a callback that will be called as data is being sent to the AWS Service. - - - - - Overriden to turn off sending SHA256 header. - - - - - Overriden to turn on Expect 100 continue. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the UploadPart response and response metadata. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - Entity tag for the uploaded object. - - - - - - Gets and sets the part number specified for the part upload. This is needed when - completing the multipart upload. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - Website Configuration - - - - - The ErrorDocument value, an object key name to use when a 4XX class error occurs. - - - - - - This value is a suffix that is appended to a request that is for a "directory" - on the website endpoint (e.g. if the suffix is index.html and - you make a request to samplebucket/images/ the data that - is returned will be for the object with the key name - images/index.html) - - - The suffix must not be empty and must not include a slash - character. - - - - - - Container for redirect information where all requests will be redirect - to. You can redirect requests to another host, to another page, or with - another protocol. In the event of an error, you can can specify a - different error code to return. . - - - - - The list of routing rules that can be used for configuring redirects if certain conditions are meet. - - - - - The Continuation Event. - - - - - Constructs a Continuation Event. - - - - - Constructs a Continuation Event. - - - - - - The End Event. - - - - - Constructs an End Event. - - - - - Constructs an End Event. - - - - - - Common Contract for S3 Events. - - - - - The Progress event details. - - - - - Current number of object bytes scanned. - - - - - Current number of uncompressed object bytes processed. - - - - - Total number of bytes of records payload data returned. - - - - - Constructs a instance of Progress. - - - - - The Progress Event. - - - - - The Progress event details. - - - - - Constructs a ProgressEvent. - - - - - Constructs a ProgressEvent. - - - - - - The Records Event - - - - - The byte array of partial, one or more result records. - - Payload is a , which is not thread-safe. - - - - - Constructs a RecordsEvent - - - - - Creates a new End Event. - - - - - - Modeled Exception that either comes over the stream from the service model, or wraps other exceptions for the purpose of raising events. If it is - modelled, it will be a subclass. - - - - - Creates a new S3EventStreamException - - - - - Creates a new S3EventStreamException - - - - - - Creates a new S3EventStreamException - - - - - - - The contract for the SelectObjectContentEventStream. - - - - - Event that encompasses all IS3Events. - - - - - Event that encompasses S3EventStreamExceptions. - - - - - Reaised when a Records event is received. - - - - - Reaised when a Stats event is received. - - - - - Reaised when a Progress event is received. - - - - - Reaised when a Continuation event is received. - - - - - Reaised when an End event is received. - - - - - A Stream of Events returned by the SelectObjectContent operation. Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treaded as mutually exclusive. - - - - - The mapping of event message to a generator function to construct the matching Event Stream event. - - - - - The mapping of event message to a generator function to construct the matching Event Stream exception. - - - - - Whether the backround processing loop is running. - - - - - Event that encompasses all IS3Events. - - - - - Event that encompasses S3EventStreamExceptions. - - - - - Reaised when a Records event is received. - - - - - Reaised when a Stats event is received. - - - - - Reaised when a Progress event is received. - - - - - Reaised when a Continuation event is received. - - - - - Reaised when an End event is received. - - - - - Event Stream returned by SelectObjectContentStream. - - Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treated as mutually exclusive. - - The network stream which events will be parsed from. - - - - Event Stream returned by SelectObjectContentStream. - - Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treaded as mutually exclusive. - - The network stream which events will be parsed from. - The decoder responsible for parsing events. - - - - The Stats event details. - - - - - Total number of object bytes scanned. - - - - - Total number of uncompressed object bytes processed. - - - - - Total number of bytes of records payload data returned. - - - - - Constructs an instance of Stats. - - - - - The Stats Event. - - - - - The Stats event details. - - - - - Constructs a StatsEvent - - - - - Constructs a ProgressEvent. - - - - - - This Event is returned if an event is retrieved from the event stream, but a generator function - for the event is not defined. - - - - - Constructs an UnknownEventStreamEvent. - - - - - Constructs an UnknownEventStreamEvent. - - The Message recieved from the event stream before conversion. - - - - Constructs an UnknownEventStreamEvent. - - The Message recieved from the event stream before conversion. - The event type. - - - - Arguments containing event details for an in-flight transfer. - - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - - - - Gets the percentage of transfer completed - - - - - Gets the number of bytes transferred since last event - - - - - Gets the number of bytes transferred - - - - - Gets the total number of bytes to be transferred - - - - - Returns a string representation of this object - - - - - - AmazonS3 exception. - Thrown when DeleteObjects returns successfully, but some of the objects - were not deleted. - - - - - Gets and sets the ErrorResponse property. - The DeleteObjectsErrorResponse associated with this exception. - - - - - Constructs an instance of DeleteObjectsException - - - - - - Uri wrapper that can parse out information (bucket, key, region, style) from an - S3 URI. - - - - - True if the URI contains the bucket in the path, false if it contains the bucket in the authority. - - - - - The bucket name parsed from the URI (or null if no bucket specified). - - - - - The key parsed from the URI (or null if no key specified). - - - - - The region parsed from the URI (or null if no region specified). - - - - - Constructs a parser for the S3 URI specified as a string. - - The S3 URI to be parsed. - - - - Constructs a parser for the S3 URI specified as a Uri instance. - - The S3 URI to be parsed. - - - - If the given string is an AmazonS3Endpoint return true and set the AmazonS3Uri out parameter. - - - - true if the string is an AmazonS3Endpoint, and the out paramter has been filled in, false otherwise - - - - If the given Uri is an AmazonS3Endpoint return true and set the AmazonS3Uri out parameter. - - - - true if the Uri is an AmazonS3Endpoint, and the out paramter has been filled in, false otherwise - - - - Checks whether the given URI is a Amazon S3 URI. - - The S3 URI to be checked. - true if the URI is a Amazon S3 URI, false; otherwise. - - - - Checks whether the given URI is a Amazon S3 URI. - - The S3 URI to be checked. - true if the URI is a Amazon S3 URI, false; otherwise. - - - - Percent-decodes the given string, with a fast path for strings that are not - percent-encoded. - - The string to decode - The decoded string - - - - Percent-decodes the given string. - - The string to decode - The index of the first '%' in the string - The decoded string - - - - Decodes the percent-encoded character at the given index in the string - and appends the decoded value to the string under construction. - - - The string under construction to which the decoded character will be - appended. - - The string being decoded. - The index of the '%' character in the string. - - - - Converts a hex character (0-9A-Fa-f) into its corresponding quad value. - - The hex character - The quad value - - - - Provides utilities used by the Amazon S3 client implementation. - These utilities might be useful to consumers of the Amazon S3 - library. - - - - - Determines MIME type from a file extension - - The extension of the file - The MIME type for the extension, or text/plain - - - - URL encodes a string. If the path property is specified, - the accepted path characters {/+:} are not encoded. - - The string to encode - Whether the string is a URL path or not - - - - - Converts a non-seekable stream into a System.IO.MemoryStream. - A MemoryStream's position can be moved arbitrarily - - The stream to be converted - A seekable MemoryStream - MemoryStreams use byte arrays as their backing store. - Please use this judicially as it is likely that a very large - stream will cause system resources to be used up. - - - - - Formats the current date as a GMT timestamp - - A GMT formatted string representation - of the current date and time - - - - - Generates an MD5 Digest for the string-based content - - The content for which the MD5 Digest needs - to be computed. - - Whether the returned checksum should be - base64 encoded. - - A string representation of the hash with or w/o base64 encoding - - - - - Only escape non-ascii characters in a string - - - - - - - Version2 S3 buckets adhere to RFC 1035: - - Less than 255 characters, with each label less than 63 characters. - Label must start with a letter - Label must end with a letter or digit - Label can have a string of letter, digits and hyphens in the middle. - Although names can be case-sensitive, no significance is attached to the case. - RFC 1123: Allow label to start with letter or digit (e.g. 3ware.com works) - RFC 2181: No restrictions apart from the length restrictions. - - S3 V2 will start with RFCs 1035 and 1123 and impose the following additional restrictions: - - Length between 3 and 63 characters (to allow headroom for upper-level domains, - as well as to avoid separate length restrictions for bucket-name and its labels - Only lower-case to avoid user confusion. - No dotted-decimal IPv4-like strings - - - The BucketName to validate if V2 addressing should be used - True if the BucketName should use V2 bucket addressing, false otherwise - - S3 v2 Bucket restrictions - - - - Determines whether an S3 bucket exists or not. - - The name of the bucket to check. - The Amazon S3 Client to use for S3 specific operations. - False is returned in case S3 responds with a NoSuchBucket error. - True is returned in case of success, AccessDenied error or PermanentRedirect error. - An exception is thrown in case of any other error. - This method calls GetACL for the bucket. - - - - Determines whether an S3 bucket exists or not. - This is done by: - 1. Creating a PreSigned Url for the bucket. To work with Signature V4 only regions, as - well as Signature V4-optional regions, we keep the expiry to within the maximum for V4 - (which is one week). - 2. Making a HEAD request to the Url - - The name of the bucket to check. - The Amazon S3 Client to use for S3 specific operations. - - - - - Class to manage and cache the correct region for buckets accessed without an explicit region. - - - Class to manage and cache the correct region for buckets accessed without an explicit region. - - - - - A cache of BucketName -> RegionEndpoint pairs. - The cache is used to make sure that bucket requests are signed for the correct region, - even when requesting them without an explicit region. - - - - - Detect a bucket region mismatch based on the x-amz-bucket-region header, and the status code provided. - - - - - - - - - Detects if the signature is malformed, and the requested bucket is in a Region - different from the Region of the request. - - - - the correct region if a mismatch was detected, null otherwise - - - - Detects if the signature is malformed, and the requested bucket is in a Region - different from the Region of the request. - - - - - the correct region if a mismatch was detected, null otherwise - - - - Use a HEAD bucket request to get the region for the given bucket. - - This method creates an AmazonS3Client from the credentials passed in. - It's critical that the AmazonS3Client is not used to make any requests that will - be routed through the pipeline. - - - - the value of the x-amz-bucket-region header from the response - - - - A helper class that represents a strongly typed S3 EventNotification item sent to SQS - - - - - Parse the JSON string into a S3EventNotification object. - - The function will try its best to parse input JSON string as best as it can. - It will not fail even if the JSON string contains unknown properties. - - For any parsing errors - - - - - Gets and sets the records for the S3 event notification - - - - - The class holds the user identity properties. - - - - - Gets and sets the PrincipalId property. - - - - - This class contains the identity information for an S3 bucket. - - - - - Gets and sets the name of the bucket. - - - - - Gets and sets the bucket owner id. - - - - - Gets and sets the S3 bucket arn. - - - - - This class contains the information for an object in S3. - - - - - Gets and sets the key for the object stored in S3. - - - - - Gets and sets the size of the object in S3. - - - - - Gets and sets the etag of the object. This can be used to determine if the object has changed. - - - - - Gets and sets the version id of the object in S3. - - - - - Gets and sets the sequencer a string representation of a hexadecimal value used to determine event sequence, only used with PUTs and DELETEs. - - - - - Gets and sets the meta information describing S3. - - - - - Gets and sets the ConfigurationId. This ID can be found in the bucket notification configuration. - - - - - Gets and sets the Bucket property. - - - - - Gets and sets the Object property. - - - - - Gets and sets the S3SchemaVersion property. - - - - - The class holds the request parameters - - - - - Gets and sets the SourceIPAddress. This is the ip address where the request came from. - - - - - This class holds the response elements. - - - - - Gets and sets the XAmzId2 Property. This is the Amazon S3 host that processed the request. - - - - - Gets and sets the XAmzRequestId. This is the Amazon S3 generated request ID. - - - - - The class holds the glacier event data elements. - - - - - Gets and sets the RestoreEventData property. - - - - - The class holds the restore event data elements. - - - - - Gets and sets the LifecycleRestorationExpiryTime the time when the object restoration will be expired. - - - - - Gets and sets the LifecycleRestoreStorageClass the source storage class for restore. - - - - - The class holds the event notification. - - - - - Gets and sets the AwsRegion property. - - - - - Gets and sets the EventName property. This identities what type of event occurred. - For example for an object just put in S3 this will be set to EventType.ObjectCreatedPut. - - - - - Gets and sets the EventSource property. - - - - - Gets and sets the EventType property. The time when S3 finished processing the request. - - - - - Gets and sets the EventVersion property. - - - - - Gets and sets the RequestParameters property. - - - - - Gets and sets the ResponseElements property. - - - - - Gets and sets the S3 property. - - - - - Gets and sets the UserIdentity property. - - - - - Get and sets the GlacierEventData property. - - - - - Interface for accessing S3 - - - - - - - Create a signed URL allowing access to a resource that would - usually require authentication. - - - - When using query string authentication you create a query, - specify an expiration time for the query, sign it with your - signature, place the data in an HTTP request, and distribute - the request to a user or embed the request in a web page. - - - A PreSigned URL can be generated for GET, PUT, DELETE and HEAD - operations on your bucketName, keys, and versions. - - - The GetPreSignedUrlRequest that defines the - parameters of the operation. - A string that is the signed http request. - - - - - - This operation aborts a multipart upload. After a multipart upload is aborted, no - additional parts can be uploaded using that upload ID. The storage consumed by any - previously uploaded parts will be freed. However, if any part uploads are currently - in progress, those part uploads might or might not succeed. As a result, it might - be necessary to abort a given multipart upload multiple times in order to completely - free all storage consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts operation and ensure that the parts - list is empty. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - The bucket name to which the upload was taking place. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object for which the multipart upload was initiated. - Upload ID that identifies the multipart upload. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AbortMultipartUpload service method, as returned by S3. - REST API Reference for AbortMultipartUpload Operation - - - - This operation aborts a multipart upload. After a multipart upload is aborted, no - additional parts can be uploaded using that upload ID. The storage consumed by any - previously uploaded parts will be freed. However, if any part uploads are currently - in progress, those part uploads might or might not succeed. As a result, it might - be necessary to abort a given multipart upload multiple times in order to completely - free all storage consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts operation and ensure that the parts - list is empty. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - Container for the necessary parameters to execute the AbortMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AbortMultipartUpload service method, as returned by S3. - REST API Reference for AbortMultipartUpload Operation - - - - Completes a multipart upload by assembling previously uploaded parts. - - - - You first initiate the multipart upload and then upload all parts using the UploadPart - operation. After successfully uploading all relevant parts of an upload, you call - this operation to complete the upload. Upon receiving this request, Amazon S3 concatenates - all the parts in ascending order by part number to create a new object. In the Complete - Multipart Upload request, you must provide the parts list. You must ensure that the - parts list is complete. This operation concatenates the parts that you provide in - the list. For each part in the list, you must provide the part number and the ETag - value, returned after that part was uploaded. - - - - Processing of a Complete Multipart Upload request could take several minutes to complete. - After Amazon S3 begins processing the request, it sends an HTTP response header that - specifies a 200 OK response. While processing is in progress, Amazon S3 periodically - sends white space characters to keep the connection from timing out. Because a request - could fail after the initial 200 OK response has been sent, it is important that you - check the response body to determine whether the request succeeded. - - - - Note that if CompleteMultipartUpload fails, applications should be prepared - to retry the failed requests. For more information, see Amazon - S3 Error Best Practices. - - - - For more information about multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - GetBucketLifecycle has the following special errors: - -
  • - - Error code: EntityTooSmall - -
    • - - Description: Your proposed upload is smaller than the minimum allowed object size. - Each part must be at least 5 MB in size, except the last part. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPart - -
    • - - Description: One or more of the specified parts could not be found. The part might - not have been uploaded, or the specified entity tag might not have matched the part's - entity tag. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPartOrder - -
    • - - Description: The list of parts was not in ascending order. The parts list must be - specified in order by part number. - -
    • - - 400 Bad Request - -
  • - - Error code: NoSuchUpload - -
    • - - Description: The specified multipart upload does not exist. The upload ID might be - invalid, or the multipart upload might have been aborted or completed. - -
    • - - 404 Not Found - -
- - The following operations are related to CompleteMultipartUpload: - - - - Container for the necessary parameters to execute the CompleteMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CompleteMultipartUpload service method, as returned by S3. - REST API Reference for CompleteMultipartUpload Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 Developer Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Encryption - - - - The source object that you are copying can be encrypted or unencrypted. The source - object can be encrypted with server-side encryption using AWS managed encryption keys - (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side - encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers - and decrypts the data when you access it. - - - - You can optionally use the appropriate encryption-related headers to request server-side - encryption for the target object. You have the option to provide your own encryption - key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that - was used to encrypt the source object. You can even request encryption if the source - object was not encrypted. For more information about server-side encryption, see Using - Server-Side Encryption. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject operation to change the storage class of an - object that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 Service Developer Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 Developer Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Encryption - - - - The source object that you are copying can be encrypted or unencrypted. The source - object can be encrypted with server-side encryption using AWS managed encryption keys - (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side - encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers - and decrypts the data when you access it. - - - - You can optionally use the appropriate encryption-related headers to request server-side - encryption for the target object. You have the option to provide your own encryption - key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that - was used to encrypt the source object. You can even request encryption if the source - object was not encrypted. For more information about server-side encryption, see Using - Server-Side Encryption. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject operation to change the storage class of an - object that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 Service Developer Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 Developer Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Encryption - - - - The source object that you are copying can be encrypted or unencrypted. The source - object can be encrypted with server-side encryption using AWS managed encryption keys - (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side - encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers - and decrypts the data when you access it. - - - - You can optionally use the appropriate encryption-related headers to request server-side - encryption for the target object. You have the option to provide your own encryption - key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that - was used to encrypt the source object. You can even request encryption if the source - object was not encrypted. For more information about server-side encryption, see Using - Server-Side Encryption. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject operation to change the storage class of an - object that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 Service Developer Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - Container for the necessary parameters to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - - - - - - Deletes an analytics configuration for the bucket (specified by the analytics configuration - ID). - - - - To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to DeleteBucketAnalyticsConfiguration: - -
  • - - - -
  • - - - -
  • - - - -
- - Container for the necessary parameters to execute the DeleteBucketAnalyticsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketAnalyticsConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketAnalyticsConfiguration Operation - - - - - Deletes an inventory configuration (identified by the inventory ID) from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - Operations related to DeleteBucketInventoryConfiguration include: - - - - Container for the necessary parameters to execute the DeleteBucketInventoryConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketInventoryConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketInventoryConfiguration Operation - - - - Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified - by the metrics configuration ID) from the bucket. Note that this doesn't include the - daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketMetricsConfiguration Operation - - - - This implementation of the DELETE operation uses the policy subresource to delete - the policy of a specified bucket. If you are using an identity other than the root - user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - The bucket name. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketPolicy service method, as returned by S3. - REST API Reference for DeleteBucketPolicy Operation - - - - This implementation of the DELETE operation uses the policy subresource to delete - the policy of a specified bucket. If you are using an identity other than the root - user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - Container for the necessary parameters to execute the DeleteBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketPolicy service method, as returned by S3. - REST API Reference for DeleteBucketPolicy Operation - - - - Deletes the replication configuration from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutReplicationConfiguration - action. The bucket owner has these permissions by default and can grant it to others. - For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - It can take a while for the deletion of a replication configuration to fully propagate. - - - - For information about replication configuration, see Replication - in the Amazon S3 Developer Guide. - - - - The following operations are related to DeleteBucketReplication: - - - - Container for the necessary parameters to execute the DeleteBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketReplication service method, as returned by S3. - REST API Reference for DeleteBucketReplication Operation - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - The bucket that has the tag set to be removed. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketTagging service method, as returned by S3. - REST API Reference for DeleteBucketTagging Operation - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - Container for the necessary parameters to execute the DeleteBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketTagging service method, as returned by S3. - REST API Reference for DeleteBucketTagging Operation - - - - This operation removes the website configuration for a bucket. Amazon S3 returns a - 200 OK response upon successfully deleting a website configuration on - the specified bucket. You will get a 200 OK response if the website configuration - you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE operation requires the S3:DeleteBucketWebsite permission. - By default, only the bucket owner can delete the website configuration attached to - a bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which you want to remove the website configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketWebsite service method, as returned by S3. - REST API Reference for DeleteBucketWebsite Operation - - - - This operation removes the website configuration for a bucket. Amazon S3 returns a - 200 OK response upon successfully deleting a website configuration on - the specified bucket. You will get a 200 OK response if the website configuration - you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE operation requires the S3:DeleteBucketWebsite permission. - By default, only the bucket owner can delete the website configuration attached to - a bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the DeleteBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketWebsite service method, as returned by S3. - REST API Reference for DeleteBucketWebsite Operation - - - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - The bucket name of the lifecycle to delete. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - REST API Reference for DeleteLifecycleConfiguration Operation - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - Container for the necessary parameters to execute the DeleteLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - REST API Reference for DeleteLifecycleConfiguration Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key name of the object to delete. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key name of the object to delete. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - Container for the necessary parameters to execute the DeleteObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - This operation enables you to delete multiple objects from a bucket using a single - HTTP request. If you know the object keys that you want to delete, then this operation - provides a suitable alternative to sending individual delete requests, reducing per-request - overhead. - - - - The request contains a list of up to 1000 keys that you want to delete. In the XML, - you provide the object key names, and optionally, version IDs if you want to delete - a specific version of the object from a versioning-enabled bucket. For each key, Amazon - S3 performs a delete operation and returns the result of that delete, success, or - failure, in the response. Note that if the object specified in the request is not - found, Amazon S3 returns the result as deleted. - - - - The operation supports two modes for the response: verbose and quiet. By default, - the operation uses verbose mode in which the response includes the result of deletion - of each key in your request. In quiet mode the response includes only keys where the - delete operation encountered an error. For a successful deletion, the operation does - not return any information about the delete in the response body. - - - - When performing this operation on an MFA Delete enabled bucket, that attempts to delete - any versioned objects, you must include an MFA token. If you do not provide one, the - entire request will fail, even if there are non-versioned objects you are trying to - delete. If you provide an invalid token, whether there are versioned keys in the request - or not, the entire Multi-Object Delete request will fail. For information about MFA - Delete, see - MFA Delete. - - - - Finally, the Content-MD5 header is required for all Multi-Object Delete requests. - Amazon S3 uses the header value to ensure that your request body has not been altered - in transit. - - - - The following operations are related to DeleteObjects: - - - - Container for the necessary parameters to execute the DeleteObjects service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObjects service method, as returned by S3. - REST API Reference for DeleteObjects Operation - - - - Removes the entire tag set from the specified object. For more information about managing - object tags, see - Object Tagging. - - - - To use this operation, you must have permission to perform the s3:DeleteObjectTagging - action. - - - - To delete tags of a specific object version, add the versionId query - parameter in the request. You will need permission for the s3:DeleteObjectVersionTagging - action. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteObjectTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObjectTagging service method, as returned by S3. - REST API Reference for DeleteObjectTagging Operation - - - - Removes the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:PutBucketPublicAccessBlock - permission. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to DeletePublicAccessBlock: - - - - Container for the necessary parameters to execute the DeletePublicAccessBlock service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeletePublicAccessBlock service method, as returned by S3. - REST API Reference for DeletePublicAccessBlock Operation - - - - - - - - - Returns the default encryption configuration for an Amazon S3 bucket. For information - about the Amazon S3 default encryption feature, see Amazon - S3 Default Bucket Encryption. - - - - To use this operation, you must have permission to perform the s3:GetEncryptionConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to GetBucketEncryption: - - - - Container for the necessary parameters to execute the GetBucketEncryption service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketEncryption service method, as returned by S3. - REST API Reference for GetBucketEncryption Operation - - - - Returns an inventory configuration (identified by the inventory configuration ID) - from the bucket. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - The following operations are related to GetBucketInventoryConfiguration: - - - - Container for the necessary parameters to execute the GetBucketInventoryConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketInventoryConfiguration service method, as returned by S3. - REST API Reference for GetBucketInventoryConfiguration Operation - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - The name of the bucket for which to get the location. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLocation service method, as returned by S3. - REST API Reference for GetBucketLocation Operation - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - Container for the necessary parameters to execute the GetBucketLocation service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLocation service method, as returned by S3. - REST API Reference for GetBucketLocation Operation - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - The bucket name for which to get the logging information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLogging service method, as returned by S3. - REST API Reference for GetBucketLogging Operation - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - Container for the necessary parameters to execute the GetBucketLogging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLogging service method, as returned by S3. - REST API Reference for GetBucketLogging Operation - - - - Gets a metrics configuration (specified by the metrics configuration ID) from the - bucket. Note that this doesn't include the daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to GetBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the GetBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for GetBucketMetricsConfiguration Operation - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following operation is related to GetBucketNotification: - - - - Name of the bucket for which to get the notification configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketNotification service method, as returned by S3. - REST API Reference for GetBucketNotification Operation - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following operation is related to GetBucketNotification: - - - - Container for the necessary parameters to execute the GetBucketNotification service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketNotification service method, as returned by S3. - REST API Reference for GetBucketNotification Operation - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operation is related to GetBucketPolicy: - - - - The bucket name for which to get the bucket policy. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicy service method, as returned by S3. - REST API Reference for GetBucketPolicy Operation - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operation is related to GetBucketPolicy: - - - - Container for the necessary parameters to execute the GetBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicy service method, as returned by S3. - REST API Reference for GetBucketPolicy Operation - - - - Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket - is public. In order to use this operation, you must have the s3:GetBucketPolicyStatus - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - For more information about when Amazon S3 considers a bucket public, see The - Meaning of "Public". - - - - The following operations are related to GetBucketPolicyStatus: - - - - Container for the necessary parameters to execute the GetBucketPolicyStatus service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicyStatus service method, as returned by S3. - REST API Reference for GetBucketPolicyStatus Operation - - - - Retrieves the replication configuration for the given Amazon S3 bucket. - - Container for the necessary parameters to execute the GetBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketReplication service method, as returned by S3. - REST API Reference for GetBucketReplication Operation - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - The name of the bucket for which to get the payment request configuration - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketRequestPayment service method, as returned by S3. - REST API Reference for GetBucketRequestPayment Operation - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - Container for the necessary parameters to execute the GetBucketRequestPayment service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketRequestPayment service method, as returned by S3. - REST API Reference for GetBucketRequestPayment Operation - - - - Returns the tag set associated with the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - GetBucketTagging has the following special error: - -
  • - - Error code: NoSuchTagSetError - -
    • - - Description: There is no tag set associated with the bucket. - -
- - The following operations are related to GetBucketTagging: - - - - Container for the necessary parameters to execute the GetBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketTagging service method, as returned by S3. - REST API Reference for GetBucketTagging Operation - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - The name of the bucket for which to get the versioning information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketVersioning service method, as returned by S3. - REST API Reference for GetBucketVersioning Operation - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - Container for the necessary parameters to execute the GetBucketVersioning service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketVersioning service method, as returned by S3. - REST API Reference for GetBucketVersioning Operation - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET operation requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which to get the website configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketWebsite service method, as returned by S3. - REST API Reference for GetBucketWebsite Operation - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET operation requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the GetBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketWebsite service method, as returned by S3. - REST API Reference for GetBucketWebsite Operation - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - The bucket name for which to get the cors configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetCORSConfiguration service method, as returned by S3. - REST API Reference for GetCORSConfiguration Operation - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - Container for the necessary parameters to execute the GetCORSConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetCORSConfiguration service method, as returned by S3. - REST API Reference for GetCORSConfiguration Operation - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are still using previous version of the lifecycle configuration, it works. - For the earlier API description, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to GetBucketLifecycleConfiguration: - - - - The name of the bucket for which to get the lifecycle information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetLifecycleConfiguration service method, as returned by S3. - REST API Reference for GetLifecycleConfiguration Operation - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are still using previous version of the lifecycle configuration, it works. - For the earlier API description, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to GetBucketLifecycleConfiguration: - - - - Container for the necessary parameters to execute the GetLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetLifecycleConfiguration service method, as returned by S3. - REST API Reference for GetLifecycleConfiguration Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object to get. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object to get. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - Container for the necessary parameters to execute the GetObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Gets an object's current Legal Hold status. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLegalHold service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectLegalHold service method, as returned by S3. - REST API Reference for GetObjectLegalHold Operation - - - - Gets the Object Lock configuration for a bucket. The rule specified in the Object - Lock configuration will be applied by default to every new object placed in the specified - bucket. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLockConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectLockConfiguration service method, as returned by S3. - REST API Reference for GetObjectLockConfiguration Operation - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - The name of the bucket containing the object. - The object key. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - The name of the bucket containing the object. - The object key. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - Container for the necessary parameters to execute the GetObjectMetadata service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - Retrieves an object's retention settings. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectRetention service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectRetention service method, as returned by S3. - REST API Reference for GetObjectRetention Operation - - - - Returns the tag-set of an object. You send the GET request against the tagging subresource - associated with the object. - - - - To use this operation, you must have permission to perform the s3:GetObjectTagging - action. By default, the GET operation returns information about current version of - an object. For a versioned bucket, you can have multiple versions of an object in - your bucket. To retrieve tags of any other version, use the versionId query parameter. - You also need permission for the s3:GetObjectVersionTagging action. - - - - By default, the bucket owner has this permission and can grant this permission to - others. - - - - For information about the Amazon S3 object tagging feature, see Object - Tagging. - - - - The following operation is related to GetObjectTagging: - - - - Container for the necessary parameters to execute the GetObjectTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTagging service method, as returned by S3. - REST API Reference for GetObjectTagging Operation - - - - Return torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Amazon - S3 Torrent. - - - - You can get torrent only for objects that are less than 5 GB in size and that are - not encrypted using server-side encryption with customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - The following operation is related to GetObjectTorrent: - - - - The name of the bucket containing the object for which to get the torrent files. - The object key for which to get the information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTorrent service method, as returned by S3. - REST API Reference for GetObjectTorrent Operation - - - - Return torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Amazon - S3 Torrent. - - - - You can get torrent only for objects that are less than 5 GB in size and that are - not encrypted using server-side encryption with customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - The following operation is related to GetObjectTorrent: - - - - Container for the necessary parameters to execute the GetObjectTorrent service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTorrent service method, as returned by S3. - REST API Reference for GetObjectTorrent Operation - - - - Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:GetBucketPublicAccessBlock - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket - or an object, it checks the PublicAccessBlock configuration for both - the bucket (or the bucket that contains the object) and the bucket owner's account. - If the PublicAccessBlock settings are different between the bucket and - the account, Amazon S3 uses the most restrictive combination of the bucket-level and - account-level settings. - - - - For more information about when Amazon S3 considers a bucket or an object public, - see The - Meaning of "Public". - - - - The following operations are related to GetPublicAccessBlock: - - - - Container for the necessary parameters to execute the GetPublicAccessBlock service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetPublicAccessBlock service method, as returned by S3. - REST API Reference for GetPublicAccessBlock Operation - - - - This operation initiates a multipart upload and returns an upload ID. This upload - ID is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort operation - and Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload API and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart) and UploadPartCopy) requests must match the headers you - used in the request to initiate the upload by using CreateMultipartUpload. - - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, - kms:GenerateDataKey*, and kms:DescribeKey actions on the - key. These permissions are required because Amazon S3 must decrypt and read data from - the encrypted file parts before it completes the multipart upload. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - The following operations are related to CreateMultipartUpload: - - - - The name of the bucket to which to initiate the upload - Object key for which the multipart upload is to be initiated. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the InitiateMultipartUpload service method, as returned by S3. - REST API Reference for InitiateMultipartUpload Operation - - - - This operation initiates a multipart upload and returns an upload ID. This upload - ID is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort operation - and Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload API and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart) and UploadPartCopy) requests must match the headers you - used in the request to initiate the upload by using CreateMultipartUpload. - - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, - kms:GenerateDataKey*, and kms:DescribeKey actions on the - key. These permissions are required because Amazon S3 must decrypt and read data from - the encrypted file parts before it completes the multipart upload. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - The following operations are related to CreateMultipartUpload: - - - - Container for the necessary parameters to execute the InitiateMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the InitiateMultipartUpload service method, as returned by S3. - REST API Reference for InitiateMultipartUpload Operation - - - - Lists the analytics configurations for the bucket. You can have up to 1,000 analytics - configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. You should always check the IsTruncated element in the response. - If there are no more configurations to list, IsTruncated is set to false. - If there are more configurations to list, IsTruncated is set to true, - and there will be a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to ListBucketAnalyticsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketAnalyticsConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketAnalyticsConfigurations service method, as returned by S3. - REST API Reference for ListBucketAnalyticsConfigurations Operation - - - - Returns a list of inventory configurations for the bucket. You can have up to 1,000 - analytics configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory - - - - The following operations are related to ListBucketInventoryConfigurations: - - - - Container for the necessary parameters to execute the ListBucketInventoryConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketInventoryConfigurations service method, as returned by S3. - REST API Reference for ListBucketInventoryConfigurations Operation - - - - Lists the metrics configurations for the bucket. The metrics configurations are only - for the request metrics of the bucket and do not provide information on daily storage - metrics. You can have up to 1,000 configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For more information about metrics configurations and CloudWatch request metrics, - see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to ListBucketMetricsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketMetricsConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketMetricsConfigurations service method, as returned by S3. - REST API Reference for ListBucketMetricsConfigurations Operation - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBuckets service method, as returned by S3. - REST API Reference for ListBuckets Operation - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - Container for the necessary parameters to execute the ListBuckets service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBuckets service method, as returned by S3. - REST API Reference for ListBuckets Operation - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Container for the necessary parameters to execute the ListMultipartUploads service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. - Limits the response to keys that begin with the specified prefix. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - Container for the necessary parameters to execute the ListObjects service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Make sure to design - your application to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - To use this operation in an AWS Identity and Access Management (IAM) policy, you must - have permissions to perform the s3:ListBucket action. The bucket owner - has this permission by default and can grant this permission to others. For more information - about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - This section describes the latest revision of the API. We recommend that you use this - revised API for application development. For backward compatibility, Amazon S3 continues - to support the prior version of this API, ListObjects. - - - - To get a list of your buckets, see ListBuckets. - - - - The following operations are related to ListObjectsV2: - - - - Container for the necessary parameters to execute the ListObjectsV2 service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjectsV2 service method, as returned by S3. - REST API Reference for ListObjectsV2 Operation - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). This request returns a maximum of 1,000 - uploaded parts. The default number of parts returned is 1,000 parts. You can restrict - the number of parts returned by specifying the max-parts request parameter. - If your multipart upload consists of more than 1,000 parts, the response returns an - IsTruncated field with the value of true, and a NextPartNumberMarker - element. In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListParts: - - - - Name of the bucket to which the parts are being uploaded. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Object key for which the multipart upload was initiated. - Upload ID identifying the multipart upload whose parts are being listed. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListParts service method, as returned by S3. - REST API Reference for ListParts Operation - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). This request returns a maximum of 1,000 - uploaded parts. The default number of parts returned is 1,000 parts. You can restrict - the number of parts returned by specifying the max-parts request parameter. - If your multipart upload consists of more than 1,000 parts, the response returns an - IsTruncated field with the value of true, and a NextPartNumberMarker - element. In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListParts: - - - - Container for the necessary parameters to execute the ListParts service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListParts service method, as returned by S3. - REST API Reference for ListParts Operation - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - Container for the necessary parameters to execute the ListVersions service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - - Creates a new bucket. To create a bucket, you must register with Amazon S3 and have - a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed - to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information on bucket naming restrictions, - see Working - with Amazon S3 Buckets. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) - Region. For more information, see How - to Select a Region for Your Buckets. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - Hosting of Buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - The name of the bucket to create. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucket service method, as returned by S3. - REST API Reference for PutBucket Operation - - - - Creates a new bucket. To create a bucket, you must register with Amazon S3 and have - a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed - to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information on bucket naming restrictions, - see Working - with Amazon S3 Buckets. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) - Region. For more information, see How - to Select a Region for Your Buckets. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - Hosting of Buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - Container for the necessary parameters to execute the PutBucket service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucket service method, as returned by S3. - REST API Reference for PutBucket Operation - - - - Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration - is a bucket-level feature that enables you to perform faster data transfers to Amazon - S3. - - - - To use this operation, you must have permission to perform the s3:PutAccelerateConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The Transfer Acceleration state of a bucket can be set to one of the following two - values: - -
  • - - Enabled – Enables accelerated data transfers to the bucket. - -
  • - - Suspended – Disables accelerated data transfers to the bucket. - -
- - The GetBucketAccelerateConfiguration operation returns the transfer acceleration - state of a bucket. - - - - After setting the Transfer Acceleration state of a bucket to Enabled, it might take - up to thirty minutes before the data transfer rates to the bucket increase. - - - - The name of the bucket used for Transfer Acceleration must be DNS-compliant and must - not contain periods ("."). - - - - For more information about transfer acceleration, see Transfer - Acceleration. - - - - The following operations are related to PutBucketAccelerateConfiguration: - - - - Container for the necessary parameters to execute the PutBucketAccelerateConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketAccelerateConfiguration service method, as returned by S3. - REST API Reference for PutBucketAccelerateConfiguration Operation - - - - - - - Set the logging parameters for a bucket and to specify permissions for who can view - and modify the logging parameters. All logs are saved to buckets in the same AWS Region - as the source bucket. To set the logging status of a bucket, you must be the bucket - owner. - - - - The bucket owner is automatically granted FULL_CONTROL to all logs. You use the Grantee - request element to grant access to other people. The Permissions request - element specifies the kind of access the grantee has to the logs. - - - - Grantee Values - - - - You can specify the person (grantee) to whom you're assigning access rights (using - request elements) in the following ways: - -
  • - - By the person's ID: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> - </Grantee> - - - - DisplayName is optional and ignored in the request. - -
  • - - By Email address: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee> - - - - - The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl - request, appears as the CanonicalUser. - -
  • - - By URI: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee> - - -
- - To enable logging, you use LoggingEnabled and its children request elements. To disable - logging, you use an empty BucketLoggingStatus request element: - - - - <BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01" /> - - - - - For more information about server access logging, see Server - Access Logging. - - - - For more information about creating a bucket, see CreateBucket. For more information - about returning the logging status of a bucket, see GetBucketLogging. - - - - The following operations are related to PutBucketLogging: - - - - Container for the necessary parameters to execute the PutBucketLogging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketLogging service method, as returned by S3. - REST API Reference for PutBucketLogging Operation - - - - Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. - You can have up to 1,000 metrics configurations per bucket. If you're updating an - existing metrics configuration, note that this is a full replacement of the existing - metrics configuration. If you don't include the elements you want to keep, they are - erased. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to PutBucketMetricsConfiguration: - - - - GetBucketLifecycle has the following special error: - -
  • - - Error code: TooManyConfigurations - -
    • - - Description: You are attempting to create a new configuration but have already reached - the 1,000-configuration limit. - -
    • - - HTTP Status Code: HTTP 400 Bad Request - -
- - Container for the necessary parameters to execute the PutBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for PutBucketMetricsConfiguration Operation - - - - Enables notifications of specified events for a bucket. For more information about - event notifications, see Configuring - Event Notifications. - - - - Using this API, you can replace an existing notification configuration. The configuration - is an XML file that defines the event types that you want Amazon S3 to publish and - the destination where you want Amazon S3 to publish an event notification when it - detects an event of the specified type. - - - - By default, your bucket has no event notifications configured. That is, the notification - configuration will be an empty NotificationConfiguration. - - - - <NotificationConfiguration> - - - - </NotificationConfiguration> - - - - This operation replaces the existing notification configuration with the configuration - you include in the request body. - - - - After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification - Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, - and that the bucket owner has permission to publish to it by sending a test notification. - In the case of AWS Lambda destinations, Amazon S3 verifies that the Lambda function - permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. - For more information, see Configuring - Notifications for Amazon S3 Events. - - - - You can disable notifications by adding the empty NotificationConfiguration element. - - - - By default, only the bucket owner can configure notifications on a bucket. However, - bucket owners can use a bucket policy to grant permission to other users to set this - configuration with s3:PutBucketNotification permission. - - - - The PUT notification is an atomic operation. For example, suppose your notification - configuration includes SNS topic, SQS queue, and Lambda function configurations. When - you send a PUT request with this configuration, Amazon S3 sends test messages to your - SNS topic. If the message fails, the entire PUT operation will fail, and Amazon S3 - will not add the configuration to your bucket. - - - - Responses - - - - If the configuration in the request body includes only one TopicConfiguration - specifying only the s3:ReducedRedundancyLostObject event type, the response - will also include the x-amz-sns-test-message-id header containing the - message ID of the test notification sent to the topic. - - - - The following operation is related to PutBucketNotificationConfiguration: - - - - Container for the necessary parameters to execute the PutBucketNotification service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketNotification service method, as returned by S3. - REST API Reference for PutBucketNotification Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - The MD5 hash of the request body. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - Container for the necessary parameters to execute the PutBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Creates a replication configuration or replaces an existing one. For more information, - see Replication - in the Amazon S3 Developer Guide. - - - - To perform this operation, the user or role performing the operation must have the - iam:PassRole - permission. - - - - Specify the replication configuration in the request body. In the replication configuration, - you provide the name of the destination bucket where you want Amazon S3 to replicate - objects, the IAM role that Amazon S3 can assume to replicate objects on your behalf, - and other relevant information. - - - - A replication configuration must include at least one rule, and can contain a maximum - of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects - in the source bucket. To choose additional subsets of objects to replicate, add a - rule for each subset. All rules must specify the same destination bucket. - - - - To specify a subset of the objects in the source bucket to apply a replication rule - to, add the Filter element as a child of the Rule element. You can filter objects - based on an object key prefix, one or more object tags, or both. When you add the - Filter element in the configuration, you must also add the following elements: DeleteMarkerReplication, - Status, and Priority. - - - - For information about enabling versioning on a bucket, see Using - Versioning. - - - - By default, a resource owner, in this case the AWS account that created the bucket, - can perform this operation. The resource owner can also grant others permissions to - perform the operation. For more information about permissions, see Specifying - Permissions in a Policy and Managing - Access Permissions to Your Amazon S3 Resources. - - - - Handling Replication of Encrypted Objects - - - - By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side - encryption with CMKs stored in AWS KMS. To replicate AWS KMS-encrypted objects, add - the following: SourceSelectionCriteria, SseKmsEncryptedObjects, - Status, EncryptionConfiguration, and ReplicaKmsKeyID. - For information about replication configuration, see Replicating - Objects Created with SSE Using CMKs stored in AWS KMS. - - - - For information on PutBucketReplication errors, see ReplicationErrorCodeList - - - - - The following operations are related to PutBucketReplication: - - - - Container for the necessary parameters to execute the PutBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketReplication service method, as returned by S3. - REST API Reference for PutBucketReplication Operation - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - The bucket name. - Container for Payer. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketRequestPayment service method, as returned by S3. - REST API Reference for PutBucketRequestPayment Operation - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - Container for the necessary parameters to execute the PutBucketRequestPayment service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketRequestPayment service method, as returned by S3. - REST API Reference for PutBucketRequestPayment Operation - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging. - - - - Within a bucket, if you add a tag that has the same key as an existing tag, the new - value overwrites the old value. For more information, see Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional operation is currently in progress against - this resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - The bucket name. - A property of PutBucketTaggingRequest used to execute the PutBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketTagging service method, as returned by S3. - REST API Reference for PutBucketTagging Operation - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging. - - - - Within a bucket, if you add a tag that has the same key as an existing tag, the new - value overwrites the old value. For more information, see Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional operation is currently in progress against - this resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - Container for the necessary parameters to execute the PutBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketTagging service method, as returned by S3. - REST API Reference for PutBucketTagging Operation - - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT operation requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - Amazon S3 has a limitation of 50 routing rules per website configuration. If you require - more than 50 routing rules, you can use object redirect. For more information, see - Configuring - an Object Redirect in the Amazon Simple Storage Service Developer Guide. - - - The bucket name. - Container for the request. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketWebsite service method, as returned by S3. - REST API Reference for PutBucketWebsite Operation - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT operation requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - Amazon S3 has a limitation of 50 routing rules per website configuration. If you require - more than 50 routing rules, you can use object redirect. For more information, see - Configuring - an Object Redirect in the Amazon Simple Storage Service Developer Guide. - - - Container for the necessary parameters to execute the PutBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketWebsite service method, as returned by S3. - REST API Reference for PutBucketWebsite Operation - - - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - The name of the bucket for which to set the configuration. - A property of PutLifecycleConfigurationRequest used to execute the PutLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutLifecycleConfiguration service method, as returned by S3. - REST API Reference for PutLifecycleConfiguration Operation - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - Container for the necessary parameters to execute the PutLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutLifecycleConfiguration service method, as returned by S3. - REST API Reference for PutLifecycleConfiguration Operation - - - - - - - - - - - - - - - - - The base class for requests that return Amazon S3 objects. - - - - - Gets or sets the name of the bucket. - - - The name of the bucket. - - - - - Gets whether or not the bucket name is set. - - - A value of true if the bucket name is set. - Returns false if otherwise. - - - - - Gets or sets the key under which the Amazon S3 object is stored. - - - The key under which the Amazon S3 object is stored. - - - - - Gets whether or not the key property is set. - - - A value of true if key property is set. - Returns false if otherwise. - - - - - Gets or sets the version ID of the Amazon S3 object. - - - The version ID of the Amazon S3 object. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or - ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Gets or sets the ModifiedSinceDate property. - - - The ModifiedSinceDate property. - - - - - Gets or sets the ModifiedSinceDate property. - - - The ModifiedSinceDate property. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or - UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Gets or sets the UnmodifiedSinceDate property. - - - The UnmodifiedSinceDate property. - - - - - Gets or sets the UnmodifiedSinceDate property. - - - The UnmodifiedSinceDate property. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to decrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - The base class TransferUtility request classes. - - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - - Gets the Amazon S3 client used for making calls into Amazon S3. - - - The Amazon S3 client used for making calls into Amazon S3. - - - - - Uploads the specified file. - The object key is derived from the file's name. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the specified file. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the contents of the specified stream. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The stream to read to obtain the content to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the stream to. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the file or stream specified by the request. - To track the progress of the upload, - add an event listener to the request's UploadProgressEvent. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - Contains all the parameters required to upload to Amazon S3. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Aborts the multipart uploads that were initiated before the specified date. - - - The name of the bucket containing multipart uploads. - - - The date before which the multipart uploads were initiated. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the content from Amazon S3 and writes it to the specified file. - If the key is not specified in the request parameter, - the file name will used as the key name. - - - Contains all the parameters required to download an Amazon S3 object. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Returns a stream from which the caller can read the content from the specified - Amazon S3 bucket and key. - The caller of this method is responsible for closing the stream. - - - The name of the bucket. - - - The object key. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Returns a stream to read the contents from Amazon S3 as - specified by the TransferUtilityOpenStreamRequest. - The caller of this method is responsible for closing the stream. - - - Contains all the parameters required for the OpenStream operation. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - - Constructs a new class. - - - The AWS Access Key ID. - - - The AWS Secret Access Key. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new class. - - - The AWS Access Key ID. - - - The AWS Secret Access Key. - - - The region to configure the transfer utility for. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new instance of the class. - - - The AWS Access Key ID. - - - The AWS Secret Access Key. - - - Specifies advanced settings. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new instance of the class. - - - The AWS Access Key ID. - - - The AWS Secret Access Key. - - - The region to configure the transfer utility for. - - - Specifies advanced settings. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new instance of the class. - - - The Amazon S3 client. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Initializes a new instance of the class. - - - The Amazon S3 client. - - - Specifies advanced configuration settings for . - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Gets the Amazon S3 client used for making calls into Amazon S3. - - - The Amazon S3 client used for making calls into Amazon S3. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Uploads the specified file. - The object key is derived from the file's name. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the specified file. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the contents of the specified stream. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The stream to read to obtain the content to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the stream to. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the file or stream specified by the request. - To track the progress of the upload, - add an event listener to the request's UploadProgressEvent. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - Contains all the parameters required to upload to Amazon S3. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Aborts the multipart uploads that were initiated before the specified date. - - - The name of the bucket containing multipart uploads. - - - The date before which the multipart uploads were initiated. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the content from Amazon S3 and writes it to the specified file. - If the key is not specified in the request parameter, - the file name will used as the key name. - - - Contains all the parameters required to download an Amazon S3 object. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Returns a stream from which the caller can read the content from the specified - Amazon S3 bucket and key. - The caller of this method is responsible for closing the stream. - - - The name of the bucket. - - - The object key. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Returns a stream to read the contents from Amazon S3 as - specified by the TransferUtilityOpenStreamRequest. - The caller of this method is responsible for closing the stream. - - - Contains all the parameters required for the OpenStream operation. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - - Provides configuration options for how processes requests. - - - The best configuration settings depend on network - configuration, latency and bandwidth. - The default configuration settings are suitable - for most applications, but this class enables developers to experiment with - different configurations and tune transfer manager performance. - - - - - - Default constructor. - - - - - Gets or sets the minimum part size for upload parts in bytes. The default is 16 MB. - Decreasing the minimum part size causes - multipart uploads to be split into a larger number - of smaller parts. Setting this value too low has a negative effect - on transfer speeds, causing extra latency and network - communication for each part. - - - - - This property determines how many active threads - or the number of concurrent asynchronous web requests - will be used to upload/download the file . - The default value is 10. - - - A value less than or equal to 0 will be silently ignored. - - - - - Gets or sets the number of executing threads. - This property determines how many active threads will be used to upload - the file. The default value is 10 threads. - - - A value less than or equal to 0 will be silently ignored. - - - - - Contains all the parameters - that can be set when making a this request with the - TransferUtility method. - - - - - Get or sets the file path location of where the - downloaded Amazon S3 object will be written to. - - - The file path location of where the downloaded Amazon S3 object will be written to. - - - - - Checks if FilePath property is set. - - True if FilePath property is set. - - - - The event for WriteObjectProgressEvent notifications. All - subscribers will be notified when a new progress - event is raised. - - The WriteObjectProgressEvent is fired as data - is downloaded from S3. The delegates attached to the event - will be passed information detailing how much data - has been downloaded as well as how much will be downloaded. - - - - Subscribe to this event if you want to receive - WriteObjectProgressEvent notifications. Here is how:
- 1. Define a method with a signature similar to this one: - - private void displayProgress(object sender, WriteObjectProgressArgs args) - { - Console.WriteLine(args); - } - - 2. Add this method to the WriteObjectProgressEvent delegate's invocation list - - TransferUtilityDownloadRequest request = new TransferUtilityDownloadRequest(); - request.WriteObjectProgressEvent += displayProgress; - - - - - - Causes the WriteObjectProgressEvent event to be fired. - - Progress data for the stream being written to file. - - - - Contains all the parameters - that can be set when making a this request with the - TransferUtility method. - - - - - Contains all the parameters - that can be set when making a this request with the - TransferUtility method. - - - - - Gets or sets the name of the bucket. - - - The name of the bucket. - - - - - Checks if BucketName property is set. - - true if BucketName property is set. - - - - Gets or sets the key under which the Amazon S3 object is to be stored. - - - The key under which the Amazon S3 object is to be stored. - - - - - Checks if Key property is set. - - true if Key property is set. - - - - Gets or sets the canned access control list (ACL) - for the uploaded object. - Please refer to - for - information on Amazon S3 canned ACLs. - - - The canned access control list (ACL) - for the uploaded object. - - - - - Checks if the CannedACL property is set. - - true if there is the CannedACL property is set. - - - - Removes the cannned access control list (ACL) - for the uploaded object. - - - - - Gets or sets the content type of the uploaded Amazon S3 object. - - - The content type of the uploaded Amazon S3 object. - - - - - Checks if ContentType property is set. - - true if ContentType property is set. - - - - Gets or sets the storage class for the uploaded Amazon S3 object. - Please refer to - for - information on S3 Storage Classes. - - - The storage class for the uploaded Amazon S3 object. - - - - - Gets and sets the ServerSideEncryptionMethod property. - Specifies the encryption used on the server to - store the content. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Input stream for the request; content for the request will be read from the stream. - - - - - - Gets or sets the file path - where the Amazon S3 object will be uploaded from. - - - For WinRT and Windows Phone this property must be in the form of "ms-appdata:///local/file.txt". - - - - The file path where the Amazon S3 object will be uploaded from. - - - - - Checks if FilePath property is set. - - true if FilePath property is set. - - - - Gets or sets the part size of the upload in bytes. - The uploaded file will be divided into - parts the size specified and - uploaded to Amazon S3 individually. - - - The part size of the upload. - - - - - Checks if PartSize property is set. - - true if PartSize property is set. - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - The tag-set for the object. - - - - - The event for UploadProgressEvent notifications. All - subscribers will be notified when a new progress - event is raised. - - The UploadProgressEvent is fired as data - is uploaded to S3. The delegates attached to the event - will be passed information detailing how much data - has been uploaded as well as how much will be uploaded. - - - - Subscribe to this event if you want to receive - UploadProgressEvent notifications. Here is how:
- 1. Define a method with a signature similar to this one: - - private void displayProgress(object sender, UploadProgressArgs args) - { - Console.WriteLine(args); - } - - 2. Add this method to the UploadProgressEvent delegate's invocation list - - TransferUtilityUploadRequest request = new TransferUtilityUploadRequest(); - request.UploadProgressEvent += displayProgress; - - - - - - Causes the UploadProgressEvent event to be fired. - - Progress data for the file being uploaded. - - - - Gets the length of the content by either checking the FileInfo.Length property or the Stream.Length property. - - The length of the content. - - - - Gets or sets whether or not the stream used with this request is - automatically closed when all of the content is read from the stream. - - - A value of true if the if the stream is - automatically closed when all of the content is read from the stream. - A value of false if otherwise. - - - - - If this value is set to true then the stream's position will be reset to the start before being read for upload. - Default: true. - - - - - Sets whether or not the stream used with this request is - automatically closed when all of the content is read from the stream - and returns this object instance, - enabling additional method calls to be chained together. - - - A value of true if the if the stream is - automatically closed when all of the content is read from the stream. - A value of false if otherwise. - - - This object instance, enabling additional method calls to be chained together. - - - - - Encapsulates the information needed to provide - transfer progress to subscribers of the Put Object - Event. - - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The how many bytes were transferred since last event. - The number of bytes transferred - The total number of bytes to be transferred - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The how many bytes were transferred since last event. - The number of bytes transferred - The total number of bytes to be transferred - The file being uploaded - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The how many bytes were transferred since last event. - The number of bytes transferred - The total number of bytes to be transferred - A compensation for any upstream aggregators if this event to correct theit totalTransferred count, - in case the underlying request is retried. - The file being uploaded - - - - Gets the FilePath. - - - - - Waits for all of the tasks to complete or till any task fails or is canceled. - - - - - Waits for all of the tasks to complete or till any task fails or is canceled. - - - - - Returns the amount of bytes remaining that need to be pulled down from S3. - - The fully qualified path of the file. - - - - - The command to manage an upload using the S3 multipart API. - - - - - Initializes a new instance of the class. - - The s3 client. - The config object that has the number of threads to use. - The file transporter request. - - - - This command is for doing regular PutObject requests. - - - - - Configuration for the S3 section of AWS configuration. - Changes to some settings may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws> - <s3 useSignatureVersion4="true" /> - </aws> - - - - - - Key for the S3UseSignatureVersion4Key property. - - - - - - Configures if the S3 client should use Signature Version 4 signing with requests. - By default, this setting is set to true which will use Signature Version 4 for all - requests except presigned URL requests when the region is set to us-east-1. When - UseSignatureVersion4 is explicitly set to true by directly setting this property or - directly setting this property through configuration, Signature Version 4 will be - used for all requests when able to do so. - When this setting is false, Signature Version 2 will be used. Note that when the - setting is false, Signature Version 4 may still be used by default in some cases - or with some regions. - - - - - Escape and unescape S3 metadata for S3 Put/Get object requests. - Escape only escapes non-ascii values in metadata - Any "%" values in metadata could interfere with this option. - Default value is false. - - - - - Was the value of the UseSignatureVersion4 property set explicitly? - This can be done via configuration or by directly setting the property. - - This is used to determine if the user set UseSignatureVersion4 to true, - or if it's true because the default was changed to true in the SDK. - - - - diff --git a/packages/AWSSDK.S3.3.3.111.14/lib/Xamarin.iOS10/AWSSDK.S3.dll b/packages/AWSSDK.S3.3.3.111.14/lib/Xamarin.iOS10/AWSSDK.S3.dll deleted file mode 100644 index 0610561..0000000 Binary files a/packages/AWSSDK.S3.3.3.111.14/lib/Xamarin.iOS10/AWSSDK.S3.dll and /dev/null differ diff --git a/packages/AWSSDK.S3.3.3.111.14/lib/net35/AWSSDK.S3.dll b/packages/AWSSDK.S3.3.3.111.14/lib/net35/AWSSDK.S3.dll deleted file mode 100644 index b8bb513..0000000 Binary files a/packages/AWSSDK.S3.3.3.111.14/lib/net35/AWSSDK.S3.dll and /dev/null differ diff --git a/packages/AWSSDK.S3.3.3.111.14/lib/net35/AWSSDK.S3.xml b/packages/AWSSDK.S3.3.3.111.14/lib/net35/AWSSDK.S3.xml deleted file mode 100644 index 5b4414f..0000000 --- a/packages/AWSSDK.S3.3.3.111.14/lib/net35/AWSSDK.S3.xml +++ /dev/null @@ -1,36048 +0,0 @@ - - - - AWSSDK.S3 - - - - - Implementation for accessing S3 - - - - - - - Specialize the initialize of the client. - - - - - Create a signed URL allowing access to a resource that would - usually require authentication. - - - - When using query string authentication you create a query, - specify an expiration time for the query, sign it with your - signature, place the data in an HTTP request, and distribute - the request to a user or embed the request in a web page. - - - A PreSigned URL can be generated for GET, PUT, DELETE and HEAD - operations on your bucketName, keys, and versions. - - - The GetPreSignedUrlRequest that defines the - parameters of the operation. - determines if signing will fall back to SigV2 if the - signing region is us-east-1 - A string that is the signed http request. - - - - - - Marshalls the parameters for a presigned url for a preferred signing protocol. - - - - - - True if AWS4 signing will be used; if the expiry period in the request exceeds the - maximum allowed for AWS4 (one week), an ArgumentException is thrown. - - - - - - Create a signed URL allowing access to a resource that would - usually require authentication. - - - - When using query string authentication you create a query, - specify an expiration time for the query, sign it with your - signature, place the data in an HTTP request, and distribute - the request to a user or embed the request in a web page. - - - A PreSigned URL can be generated for GET, PUT, DELETE and HEAD - operations on your bucketName, keys, and versions. - - - The GetPreSignedUrlRequest that defines the - parameters of the operation. - A string that is the signed http request. - - - - - - Constructs AmazonS3Client with the credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - - - - Constructs AmazonS3Client with the credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - The region to connect. - - - - Constructs AmazonS3Client with the credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - The AmazonS3Client Configuration Object - - - - Constructs AmazonS3Client with AWS Credentials - - AWS Credentials - - - - Constructs AmazonS3Client with AWS Credentials - - AWS Credentials - The region to connect. - - - - Constructs AmazonS3Client with AWS Credentials and an - AmazonS3Client Configuration object. - - AWS Credentials - The AmazonS3Client Configuration Object - - - - Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - - - - Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - The region to connect. - - - - Constructs AmazonS3Client with AWS Access Key ID, AWS Secret Key and an - AmazonS3Client Configuration object. - - AWS Access Key ID - AWS Secret Access Key - The AmazonS3Client Configuration Object - - - - Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - - - - Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - The region to connect. - - - - Constructs AmazonS3Client with AWS Access Key ID, AWS Secret Key and an - AmazonS3Client Configuration object. - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - The AmazonS3Client Configuration Object - - - - Creates the signer for the service. - - - - - Customize the pipeline - - - - - - Capture metadata for the service. - - - - - Disposes the service client. - - - - - This operation aborts a multipart upload. After a multipart upload is aborted, no - additional parts can be uploaded using that upload ID. The storage consumed by any - previously uploaded parts will be freed. However, if any part uploads are currently - in progress, those part uploads might or might not succeed. As a result, it might - be necessary to abort a given multipart upload multiple times in order to completely - free all storage consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts operation and ensure that the parts - list is empty. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - The bucket name to which the upload was taking place. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object for which the multipart upload was initiated. - Upload ID that identifies the multipart upload. - - The response from the AbortMultipartUpload service method, as returned by S3. - REST API Reference for AbortMultipartUpload Operation - - - - This operation aborts a multipart upload. After a multipart upload is aborted, no - additional parts can be uploaded using that upload ID. The storage consumed by any - previously uploaded parts will be freed. However, if any part uploads are currently - in progress, those part uploads might or might not succeed. As a result, it might - be necessary to abort a given multipart upload multiple times in order to completely - free all storage consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts operation and ensure that the parts - list is empty. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - Container for the necessary parameters to execute the AbortMultipartUpload service method. - - The response from the AbortMultipartUpload service method, as returned by S3. - REST API Reference for AbortMultipartUpload Operation - - - - Initiates the asynchronous execution of the AbortMultipartUpload operation. - - - Container for the necessary parameters to execute the AbortMultipartUpload operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAbortMultipartUpload - operation. - REST API Reference for AbortMultipartUpload Operation - - - - Finishes the asynchronous execution of the AbortMultipartUpload operation. - - - The IAsyncResult returned by the call to BeginAbortMultipartUpload. - - Returns a AbortMultipartUploadResult from S3. - REST API Reference for AbortMultipartUpload Operation - - - - Completes a multipart upload by assembling previously uploaded parts. - - - - You first initiate the multipart upload and then upload all parts using the UploadPart - operation. After successfully uploading all relevant parts of an upload, you call - this operation to complete the upload. Upon receiving this request, Amazon S3 concatenates - all the parts in ascending order by part number to create a new object. In the Complete - Multipart Upload request, you must provide the parts list. You must ensure that the - parts list is complete. This operation concatenates the parts that you provide in - the list. For each part in the list, you must provide the part number and the ETag - value, returned after that part was uploaded. - - - - Processing of a Complete Multipart Upload request could take several minutes to complete. - After Amazon S3 begins processing the request, it sends an HTTP response header that - specifies a 200 OK response. While processing is in progress, Amazon S3 periodically - sends white space characters to keep the connection from timing out. Because a request - could fail after the initial 200 OK response has been sent, it is important that you - check the response body to determine whether the request succeeded. - - - - Note that if CompleteMultipartUpload fails, applications should be prepared - to retry the failed requests. For more information, see Amazon - S3 Error Best Practices. - - - - For more information about multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - GetBucketLifecycle has the following special errors: - -
  • - - Error code: EntityTooSmall - -
    • - - Description: Your proposed upload is smaller than the minimum allowed object size. - Each part must be at least 5 MB in size, except the last part. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPart - -
    • - - Description: One or more of the specified parts could not be found. The part might - not have been uploaded, or the specified entity tag might not have matched the part's - entity tag. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPartOrder - -
    • - - Description: The list of parts was not in ascending order. The parts list must be - specified in order by part number. - -
    • - - 400 Bad Request - -
  • - - Error code: NoSuchUpload - -
    • - - Description: The specified multipart upload does not exist. The upload ID might be - invalid, or the multipart upload might have been aborted or completed. - -
    • - - 404 Not Found - -
- - The following operations are related to CompleteMultipartUpload: - - - - Container for the necessary parameters to execute the CompleteMultipartUpload service method. - - The response from the CompleteMultipartUpload service method, as returned by S3. - REST API Reference for CompleteMultipartUpload Operation - - - - Initiates the asynchronous execution of the CompleteMultipartUpload operation. - - - Container for the necessary parameters to execute the CompleteMultipartUpload operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCompleteMultipartUpload - operation. - REST API Reference for CompleteMultipartUpload Operation - - - - Finishes the asynchronous execution of the CompleteMultipartUpload operation. - - - The IAsyncResult returned by the call to BeginCompleteMultipartUpload. - - Returns a CompleteMultipartUploadResult from S3. - REST API Reference for CompleteMultipartUpload Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 Developer Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Encryption - - - - The source object that you are copying can be encrypted or unencrypted. The source - object can be encrypted with server-side encryption using AWS managed encryption keys - (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side - encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers - and decrypts the data when you access it. - - - - You can optionally use the appropriate encryption-related headers to request server-side - encryption for the target object. You have the option to provide your own encryption - key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that - was used to encrypt the source object. You can even request encryption if the source - object was not encrypted. For more information about server-side encryption, see Using - Server-Side Encryption. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject operation to change the storage class of an - object that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 Service Developer Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 Developer Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Encryption - - - - The source object that you are copying can be encrypted or unencrypted. The source - object can be encrypted with server-side encryption using AWS managed encryption keys - (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side - encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers - and decrypts the data when you access it. - - - - You can optionally use the appropriate encryption-related headers to request server-side - encryption for the target object. You have the option to provide your own encryption - key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that - was used to encrypt the source object. You can even request encryption if the source - object was not encrypted. For more information about server-side encryption, see Using - Server-Side Encryption. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject operation to change the storage class of an - object that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 Service Developer Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 Developer Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Encryption - - - - The source object that you are copying can be encrypted or unencrypted. The source - object can be encrypted with server-side encryption using AWS managed encryption keys - (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side - encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers - and decrypts the data when you access it. - - - - You can optionally use the appropriate encryption-related headers to request server-side - encryption for the target object. You have the option to provide your own encryption - key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that - was used to encrypt the source object. You can even request encryption if the source - object was not encrypted. For more information about server-side encryption, see Using - Server-Side Encryption. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject operation to change the storage class of an - object that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 Service Developer Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - Container for the necessary parameters to execute the CopyObject service method. - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - Initiates the asynchronous execution of the CopyObject operation. - - - Container for the necessary parameters to execute the CopyObject operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCopyObject - operation. - REST API Reference for CopyObject Operation - - - - Finishes the asynchronous execution of the CopyObject operation. - - - The IAsyncResult returned by the call to BeginCopyObject. - - Returns a CopyObjectResult from S3. - REST API Reference for CopyObject Operation - - - - - - - Initiates the asynchronous execution of the CopyPart operation. - - - Container for the necessary parameters to execute the CopyPart operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCopyPart - operation. - REST API Reference for CopyPart Operation - - - - Finishes the asynchronous execution of the CopyPart operation. - - - The IAsyncResult returned by the call to BeginCopyPart. - - Returns a CopyPartResult from S3. - REST API Reference for CopyPart Operation - - - - - - Initiates the asynchronous execution of the DeleteBucket operation. - - - Container for the necessary parameters to execute the DeleteBucket operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteBucket - operation. - REST API Reference for DeleteBucket Operation - - - - Finishes the asynchronous execution of the DeleteBucket operation. - - - The IAsyncResult returned by the call to BeginDeleteBucket. - - Returns a DeleteBucketResult from S3. - REST API Reference for DeleteBucket Operation - - - - Deletes an analytics configuration for the bucket (specified by the analytics configuration - ID). - - - - To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to DeleteBucketAnalyticsConfiguration: - -
  • - - - -
  • - - - -
  • - - - -
- - Container for the necessary parameters to execute the DeleteBucketAnalyticsConfiguration service method. - - The response from the DeleteBucketAnalyticsConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketAnalyticsConfiguration Operation - - - - Initiates the asynchronous execution of the DeleteBucketAnalyticsConfiguration operation. - - - Container for the necessary parameters to execute the DeleteBucketAnalyticsConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteBucketAnalyticsConfiguration - operation. - REST API Reference for DeleteBucketAnalyticsConfiguration Operation - - - - Finishes the asynchronous execution of the DeleteBucketAnalyticsConfiguration operation. - - - The IAsyncResult returned by the call to BeginDeleteBucketAnalyticsConfiguration. - - Returns a DeleteBucketAnalyticsConfigurationResult from S3. - REST API Reference for DeleteBucketAnalyticsConfiguration Operation - - - - - Initiates the asynchronous execution of the DeleteBucketEncryption operation. - - - Container for the necessary parameters to execute the DeleteBucketEncryption operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteBucketEncryption - operation. - REST API Reference for DeleteBucketEncryption Operation - - - - Finishes the asynchronous execution of the DeleteBucketEncryption operation. - - - The IAsyncResult returned by the call to BeginDeleteBucketEncryption. - - Returns a DeleteBucketEncryptionResult from S3. - REST API Reference for DeleteBucketEncryption Operation - - - - Deletes an inventory configuration (identified by the inventory ID) from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - Operations related to DeleteBucketInventoryConfiguration include: - - - - Container for the necessary parameters to execute the DeleteBucketInventoryConfiguration service method. - - The response from the DeleteBucketInventoryConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketInventoryConfiguration Operation - - - - Initiates the asynchronous execution of the DeleteBucketInventoryConfiguration operation. - - - Container for the necessary parameters to execute the DeleteBucketInventoryConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteBucketInventoryConfiguration - operation. - REST API Reference for DeleteBucketInventoryConfiguration Operation - - - - Finishes the asynchronous execution of the DeleteBucketInventoryConfiguration operation. - - - The IAsyncResult returned by the call to BeginDeleteBucketInventoryConfiguration. - - Returns a DeleteBucketInventoryConfigurationResult from S3. - REST API Reference for DeleteBucketInventoryConfiguration Operation - - - - Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified - by the metrics configuration ID) from the bucket. Note that this doesn't include the - daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteBucketMetricsConfiguration service method. - - The response from the DeleteBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketMetricsConfiguration Operation - - - - Initiates the asynchronous execution of the DeleteBucketMetricsConfiguration operation. - - - Container for the necessary parameters to execute the DeleteBucketMetricsConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteBucketMetricsConfiguration - operation. - REST API Reference for DeleteBucketMetricsConfiguration Operation - - - - Finishes the asynchronous execution of the DeleteBucketMetricsConfiguration operation. - - - The IAsyncResult returned by the call to BeginDeleteBucketMetricsConfiguration. - - Returns a DeleteBucketMetricsConfigurationResult from S3. - REST API Reference for DeleteBucketMetricsConfiguration Operation - - - - This implementation of the DELETE operation uses the policy subresource to delete - the policy of a specified bucket. If you are using an identity other than the root - user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - The bucket name. - - The response from the DeleteBucketPolicy service method, as returned by S3. - REST API Reference for DeleteBucketPolicy Operation - - - - This implementation of the DELETE operation uses the policy subresource to delete - the policy of a specified bucket. If you are using an identity other than the root - user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - Container for the necessary parameters to execute the DeleteBucketPolicy service method. - - The response from the DeleteBucketPolicy service method, as returned by S3. - REST API Reference for DeleteBucketPolicy Operation - - - - Initiates the asynchronous execution of the DeleteBucketPolicy operation. - - - Container for the necessary parameters to execute the DeleteBucketPolicy operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteBucketPolicy - operation. - REST API Reference for DeleteBucketPolicy Operation - - - - Finishes the asynchronous execution of the DeleteBucketPolicy operation. - - - The IAsyncResult returned by the call to BeginDeleteBucketPolicy. - - Returns a DeleteBucketPolicyResult from S3. - REST API Reference for DeleteBucketPolicy Operation - - - - Deletes the replication configuration from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutReplicationConfiguration - action. The bucket owner has these permissions by default and can grant it to others. - For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - It can take a while for the deletion of a replication configuration to fully propagate. - - - - For information about replication configuration, see Replication - in the Amazon S3 Developer Guide. - - - - The following operations are related to DeleteBucketReplication: - - - - Container for the necessary parameters to execute the DeleteBucketReplication service method. - - The response from the DeleteBucketReplication service method, as returned by S3. - REST API Reference for DeleteBucketReplication Operation - - - - Initiates the asynchronous execution of the DeleteBucketReplication operation. - - - Container for the necessary parameters to execute the DeleteBucketReplication operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteBucketReplication - operation. - REST API Reference for DeleteBucketReplication Operation - - - - Finishes the asynchronous execution of the DeleteBucketReplication operation. - - - The IAsyncResult returned by the call to BeginDeleteBucketReplication. - - Returns a DeleteBucketReplicationResult from S3. - REST API Reference for DeleteBucketReplication Operation - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - The bucket that has the tag set to be removed. - - The response from the DeleteBucketTagging service method, as returned by S3. - REST API Reference for DeleteBucketTagging Operation - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - Container for the necessary parameters to execute the DeleteBucketTagging service method. - - The response from the DeleteBucketTagging service method, as returned by S3. - REST API Reference for DeleteBucketTagging Operation - - - - Initiates the asynchronous execution of the DeleteBucketTagging operation. - - - Container for the necessary parameters to execute the DeleteBucketTagging operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteBucketTagging - operation. - REST API Reference for DeleteBucketTagging Operation - - - - Finishes the asynchronous execution of the DeleteBucketTagging operation. - - - The IAsyncResult returned by the call to BeginDeleteBucketTagging. - - Returns a DeleteBucketTaggingResult from S3. - REST API Reference for DeleteBucketTagging Operation - - - - This operation removes the website configuration for a bucket. Amazon S3 returns a - 200 OK response upon successfully deleting a website configuration on - the specified bucket. You will get a 200 OK response if the website configuration - you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE operation requires the S3:DeleteBucketWebsite permission. - By default, only the bucket owner can delete the website configuration attached to - a bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which you want to remove the website configuration. - - The response from the DeleteBucketWebsite service method, as returned by S3. - REST API Reference for DeleteBucketWebsite Operation - - - - This operation removes the website configuration for a bucket. Amazon S3 returns a - 200 OK response upon successfully deleting a website configuration on - the specified bucket. You will get a 200 OK response if the website configuration - you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE operation requires the S3:DeleteBucketWebsite permission. - By default, only the bucket owner can delete the website configuration attached to - a bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the DeleteBucketWebsite service method. - - The response from the DeleteBucketWebsite service method, as returned by S3. - REST API Reference for DeleteBucketWebsite Operation - - - - Initiates the asynchronous execution of the DeleteBucketWebsite operation. - - - Container for the necessary parameters to execute the DeleteBucketWebsite operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteBucketWebsite - operation. - REST API Reference for DeleteBucketWebsite Operation - - - - Finishes the asynchronous execution of the DeleteBucketWebsite operation. - - - The IAsyncResult returned by the call to BeginDeleteBucketWebsite. - - Returns a DeleteBucketWebsiteResult from S3. - REST API Reference for DeleteBucketWebsite Operation - - - - - - Initiates the asynchronous execution of the DeleteCORSConfiguration operation. - - - Container for the necessary parameters to execute the DeleteCORSConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteCORSConfiguration - operation. - REST API Reference for DeleteCORSConfiguration Operation - - - - Finishes the asynchronous execution of the DeleteCORSConfiguration operation. - - - The IAsyncResult returned by the call to BeginDeleteCORSConfiguration. - - Returns a DeleteCORSConfigurationResult from S3. - REST API Reference for DeleteCORSConfiguration Operation - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - The bucket name of the lifecycle to delete. - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - REST API Reference for DeleteLifecycleConfiguration Operation - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - Container for the necessary parameters to execute the DeleteLifecycleConfiguration service method. - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - REST API Reference for DeleteLifecycleConfiguration Operation - - - - Initiates the asynchronous execution of the DeleteLifecycleConfiguration operation. - - - Container for the necessary parameters to execute the DeleteLifecycleConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteLifecycleConfiguration - operation. - REST API Reference for DeleteLifecycleConfiguration Operation - - - - Finishes the asynchronous execution of the DeleteLifecycleConfiguration operation. - - - The IAsyncResult returned by the call to BeginDeleteLifecycleConfiguration. - - Returns a DeleteLifecycleConfigurationResult from S3. - REST API Reference for DeleteLifecycleConfiguration Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key name of the object to delete. - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key name of the object to delete. - VersionId used to reference a specific version of the object. - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - Container for the necessary parameters to execute the DeleteObject service method. - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - Initiates the asynchronous execution of the DeleteObject operation. - - - Container for the necessary parameters to execute the DeleteObject operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteObject - operation. - REST API Reference for DeleteObject Operation - - - - Finishes the asynchronous execution of the DeleteObject operation. - - - The IAsyncResult returned by the call to BeginDeleteObject. - - Returns a DeleteObjectResult from S3. - REST API Reference for DeleteObject Operation - - - - This operation enables you to delete multiple objects from a bucket using a single - HTTP request. If you know the object keys that you want to delete, then this operation - provides a suitable alternative to sending individual delete requests, reducing per-request - overhead. - - - - The request contains a list of up to 1000 keys that you want to delete. In the XML, - you provide the object key names, and optionally, version IDs if you want to delete - a specific version of the object from a versioning-enabled bucket. For each key, Amazon - S3 performs a delete operation and returns the result of that delete, success, or - failure, in the response. Note that if the object specified in the request is not - found, Amazon S3 returns the result as deleted. - - - - The operation supports two modes for the response: verbose and quiet. By default, - the operation uses verbose mode in which the response includes the result of deletion - of each key in your request. In quiet mode the response includes only keys where the - delete operation encountered an error. For a successful deletion, the operation does - not return any information about the delete in the response body. - - - - When performing this operation on an MFA Delete enabled bucket, that attempts to delete - any versioned objects, you must include an MFA token. If you do not provide one, the - entire request will fail, even if there are non-versioned objects you are trying to - delete. If you provide an invalid token, whether there are versioned keys in the request - or not, the entire Multi-Object Delete request will fail. For information about MFA - Delete, see - MFA Delete. - - - - Finally, the Content-MD5 header is required for all Multi-Object Delete requests. - Amazon S3 uses the header value to ensure that your request body has not been altered - in transit. - - - - The following operations are related to DeleteObjects: - - - - Container for the necessary parameters to execute the DeleteObjects service method. - - The response from the DeleteObjects service method, as returned by S3. - REST API Reference for DeleteObjects Operation - - - - Initiates the asynchronous execution of the DeleteObjects operation. - - - Container for the necessary parameters to execute the DeleteObjects operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteObjects - operation. - REST API Reference for DeleteObjects Operation - - - - Finishes the asynchronous execution of the DeleteObjects operation. - - - The IAsyncResult returned by the call to BeginDeleteObjects. - - Returns a DeleteObjectsResult from S3. - REST API Reference for DeleteObjects Operation - - - - Removes the entire tag set from the specified object. For more information about managing - object tags, see - Object Tagging. - - - - To use this operation, you must have permission to perform the s3:DeleteObjectTagging - action. - - - - To delete tags of a specific object version, add the versionId query - parameter in the request. You will need permission for the s3:DeleteObjectVersionTagging - action. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteObjectTagging service method. - - The response from the DeleteObjectTagging service method, as returned by S3. - REST API Reference for DeleteObjectTagging Operation - - - - Initiates the asynchronous execution of the DeleteObjectTagging operation. - - - Container for the necessary parameters to execute the DeleteObjectTagging operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteObjectTagging - operation. - REST API Reference for DeleteObjectTagging Operation - - - - Finishes the asynchronous execution of the DeleteObjectTagging operation. - - - The IAsyncResult returned by the call to BeginDeleteObjectTagging. - - Returns a DeleteObjectTaggingResult from S3. - REST API Reference for DeleteObjectTagging Operation - - - - Removes the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:PutBucketPublicAccessBlock - permission. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to DeletePublicAccessBlock: - - - - Container for the necessary parameters to execute the DeletePublicAccessBlock service method. - - The response from the DeletePublicAccessBlock service method, as returned by S3. - REST API Reference for DeletePublicAccessBlock Operation - - - - Initiates the asynchronous execution of the DeletePublicAccessBlock operation. - - - Container for the necessary parameters to execute the DeletePublicAccessBlock operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeletePublicAccessBlock - operation. - REST API Reference for DeletePublicAccessBlock Operation - - - - Finishes the asynchronous execution of the DeletePublicAccessBlock operation. - - - The IAsyncResult returned by the call to BeginDeletePublicAccessBlock. - - Returns a DeletePublicAccessBlockResult from S3. - REST API Reference for DeletePublicAccessBlock Operation - - - - - - Initiates the asynchronous execution of the GetACL operation. - - - Container for the necessary parameters to execute the GetACL operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetACL - operation. - REST API Reference for GetACL Operation - - - - Finishes the asynchronous execution of the GetACL operation. - - - The IAsyncResult returned by the call to BeginGetACL. - - Returns a GetACLResult from S3. - REST API Reference for GetACL Operation - - - - - - Initiates the asynchronous execution of the GetBucketAccelerateConfiguration operation. - - - Container for the necessary parameters to execute the GetBucketAccelerateConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketAccelerateConfiguration - operation. - REST API Reference for GetBucketAccelerateConfiguration Operation - - - - Finishes the asynchronous execution of the GetBucketAccelerateConfiguration operation. - - - The IAsyncResult returned by the call to BeginGetBucketAccelerateConfiguration. - - Returns a GetBucketAccelerateConfigurationResult from S3. - REST API Reference for GetBucketAccelerateConfiguration Operation - - - - - Initiates the asynchronous execution of the GetBucketAnalyticsConfiguration operation. - - - Container for the necessary parameters to execute the GetBucketAnalyticsConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketAnalyticsConfiguration - operation. - REST API Reference for GetBucketAnalyticsConfiguration Operation - - - - Finishes the asynchronous execution of the GetBucketAnalyticsConfiguration operation. - - - The IAsyncResult returned by the call to BeginGetBucketAnalyticsConfiguration. - - Returns a GetBucketAnalyticsConfigurationResult from S3. - REST API Reference for GetBucketAnalyticsConfiguration Operation - - - - Returns the default encryption configuration for an Amazon S3 bucket. For information - about the Amazon S3 default encryption feature, see Amazon - S3 Default Bucket Encryption. - - - - To use this operation, you must have permission to perform the s3:GetEncryptionConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to GetBucketEncryption: - - - - Container for the necessary parameters to execute the GetBucketEncryption service method. - - The response from the GetBucketEncryption service method, as returned by S3. - REST API Reference for GetBucketEncryption Operation - - - - Initiates the asynchronous execution of the GetBucketEncryption operation. - - - Container for the necessary parameters to execute the GetBucketEncryption operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketEncryption - operation. - REST API Reference for GetBucketEncryption Operation - - - - Finishes the asynchronous execution of the GetBucketEncryption operation. - - - The IAsyncResult returned by the call to BeginGetBucketEncryption. - - Returns a GetBucketEncryptionResult from S3. - REST API Reference for GetBucketEncryption Operation - - - - Returns an inventory configuration (identified by the inventory configuration ID) - from the bucket. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - The following operations are related to GetBucketInventoryConfiguration: - - - - Container for the necessary parameters to execute the GetBucketInventoryConfiguration service method. - - The response from the GetBucketInventoryConfiguration service method, as returned by S3. - REST API Reference for GetBucketInventoryConfiguration Operation - - - - Initiates the asynchronous execution of the GetBucketInventoryConfiguration operation. - - - Container for the necessary parameters to execute the GetBucketInventoryConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketInventoryConfiguration - operation. - REST API Reference for GetBucketInventoryConfiguration Operation - - - - Finishes the asynchronous execution of the GetBucketInventoryConfiguration operation. - - - The IAsyncResult returned by the call to BeginGetBucketInventoryConfiguration. - - Returns a GetBucketInventoryConfigurationResult from S3. - REST API Reference for GetBucketInventoryConfiguration Operation - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - The name of the bucket for which to get the location. - - The response from the GetBucketLocation service method, as returned by S3. - REST API Reference for GetBucketLocation Operation - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - Container for the necessary parameters to execute the GetBucketLocation service method. - - The response from the GetBucketLocation service method, as returned by S3. - REST API Reference for GetBucketLocation Operation - - - - Initiates the asynchronous execution of the GetBucketLocation operation. - - - Container for the necessary parameters to execute the GetBucketLocation operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketLocation - operation. - REST API Reference for GetBucketLocation Operation - - - - Finishes the asynchronous execution of the GetBucketLocation operation. - - - The IAsyncResult returned by the call to BeginGetBucketLocation. - - Returns a GetBucketLocationResult from S3. - REST API Reference for GetBucketLocation Operation - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - The bucket name for which to get the logging information. - - The response from the GetBucketLogging service method, as returned by S3. - REST API Reference for GetBucketLogging Operation - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - Container for the necessary parameters to execute the GetBucketLogging service method. - - The response from the GetBucketLogging service method, as returned by S3. - REST API Reference for GetBucketLogging Operation - - - - Initiates the asynchronous execution of the GetBucketLogging operation. - - - Container for the necessary parameters to execute the GetBucketLogging operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketLogging - operation. - REST API Reference for GetBucketLogging Operation - - - - Finishes the asynchronous execution of the GetBucketLogging operation. - - - The IAsyncResult returned by the call to BeginGetBucketLogging. - - Returns a GetBucketLoggingResult from S3. - REST API Reference for GetBucketLogging Operation - - - - Gets a metrics configuration (specified by the metrics configuration ID) from the - bucket. Note that this doesn't include the daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to GetBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the GetBucketMetricsConfiguration service method. - - The response from the GetBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for GetBucketMetricsConfiguration Operation - - - - Initiates the asynchronous execution of the GetBucketMetricsConfiguration operation. - - - Container for the necessary parameters to execute the GetBucketMetricsConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketMetricsConfiguration - operation. - REST API Reference for GetBucketMetricsConfiguration Operation - - - - Finishes the asynchronous execution of the GetBucketMetricsConfiguration operation. - - - The IAsyncResult returned by the call to BeginGetBucketMetricsConfiguration. - - Returns a GetBucketMetricsConfigurationResult from S3. - REST API Reference for GetBucketMetricsConfiguration Operation - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following operation is related to GetBucketNotification: - - - - Name of the bucket for which to get the notification configuration. - - The response from the GetBucketNotification service method, as returned by S3. - REST API Reference for GetBucketNotification Operation - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following operation is related to GetBucketNotification: - - - - Container for the necessary parameters to execute the GetBucketNotification service method. - - The response from the GetBucketNotification service method, as returned by S3. - REST API Reference for GetBucketNotification Operation - - - - Initiates the asynchronous execution of the GetBucketNotification operation. - - - Container for the necessary parameters to execute the GetBucketNotification operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketNotification - operation. - REST API Reference for GetBucketNotification Operation - - - - Finishes the asynchronous execution of the GetBucketNotification operation. - - - The IAsyncResult returned by the call to BeginGetBucketNotification. - - Returns a GetBucketNotificationResult from S3. - REST API Reference for GetBucketNotification Operation - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operation is related to GetBucketPolicy: - - - - The bucket name for which to get the bucket policy. - - The response from the GetBucketPolicy service method, as returned by S3. - REST API Reference for GetBucketPolicy Operation - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operation is related to GetBucketPolicy: - - - - Container for the necessary parameters to execute the GetBucketPolicy service method. - - The response from the GetBucketPolicy service method, as returned by S3. - REST API Reference for GetBucketPolicy Operation - - - - Initiates the asynchronous execution of the GetBucketPolicy operation. - - - Container for the necessary parameters to execute the GetBucketPolicy operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketPolicy - operation. - REST API Reference for GetBucketPolicy Operation - - - - Finishes the asynchronous execution of the GetBucketPolicy operation. - - - The IAsyncResult returned by the call to BeginGetBucketPolicy. - - Returns a GetBucketPolicyResult from S3. - REST API Reference for GetBucketPolicy Operation - - - - Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket - is public. In order to use this operation, you must have the s3:GetBucketPolicyStatus - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - For more information about when Amazon S3 considers a bucket public, see The - Meaning of "Public". - - - - The following operations are related to GetBucketPolicyStatus: - - - - Container for the necessary parameters to execute the GetBucketPolicyStatus service method. - - The response from the GetBucketPolicyStatus service method, as returned by S3. - REST API Reference for GetBucketPolicyStatus Operation - - - - Initiates the asynchronous execution of the GetBucketPolicyStatus operation. - - - Container for the necessary parameters to execute the GetBucketPolicyStatus operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketPolicyStatus - operation. - REST API Reference for GetBucketPolicyStatus Operation - - - - Finishes the asynchronous execution of the GetBucketPolicyStatus operation. - - - The IAsyncResult returned by the call to BeginGetBucketPolicyStatus. - - Returns a GetBucketPolicyStatusResult from S3. - REST API Reference for GetBucketPolicyStatus Operation - - - - Retrieves the replication configuration for the given Amazon S3 bucket. - - Container for the necessary parameters to execute the GetBucketReplication service method. - - The response from the GetBucketReplication service method, as returned by S3. - REST API Reference for GetBucketReplication Operation - - - - Initiates the asynchronous execution of the GetBucketReplication operation. - - - Container for the necessary parameters to execute the GetBucketReplication operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketReplication - operation. - REST API Reference for GetBucketReplication Operation - - - - Finishes the asynchronous execution of the GetBucketReplication operation. - - - The IAsyncResult returned by the call to BeginGetBucketReplication. - - Returns a GetBucketReplicationResult from S3. - REST API Reference for GetBucketReplication Operation - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - The name of the bucket for which to get the payment request configuration - - The response from the GetBucketRequestPayment service method, as returned by S3. - REST API Reference for GetBucketRequestPayment Operation - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - Container for the necessary parameters to execute the GetBucketRequestPayment service method. - - The response from the GetBucketRequestPayment service method, as returned by S3. - REST API Reference for GetBucketRequestPayment Operation - - - - Initiates the asynchronous execution of the GetBucketRequestPayment operation. - - - Container for the necessary parameters to execute the GetBucketRequestPayment operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketRequestPayment - operation. - REST API Reference for GetBucketRequestPayment Operation - - - - Finishes the asynchronous execution of the GetBucketRequestPayment operation. - - - The IAsyncResult returned by the call to BeginGetBucketRequestPayment. - - Returns a GetBucketRequestPaymentResult from S3. - REST API Reference for GetBucketRequestPayment Operation - - - - Returns the tag set associated with the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - GetBucketTagging has the following special error: - -
  • - - Error code: NoSuchTagSetError - -
    • - - Description: There is no tag set associated with the bucket. - -
- - The following operations are related to GetBucketTagging: - - - - Container for the necessary parameters to execute the GetBucketTagging service method. - - The response from the GetBucketTagging service method, as returned by S3. - REST API Reference for GetBucketTagging Operation - - - - Initiates the asynchronous execution of the GetBucketTagging operation. - - - Container for the necessary parameters to execute the GetBucketTagging operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketTagging - operation. - REST API Reference for GetBucketTagging Operation - - - - Finishes the asynchronous execution of the GetBucketTagging operation. - - - The IAsyncResult returned by the call to BeginGetBucketTagging. - - Returns a GetBucketTaggingResult from S3. - REST API Reference for GetBucketTagging Operation - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - The name of the bucket for which to get the versioning information. - - The response from the GetBucketVersioning service method, as returned by S3. - REST API Reference for GetBucketVersioning Operation - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - Container for the necessary parameters to execute the GetBucketVersioning service method. - - The response from the GetBucketVersioning service method, as returned by S3. - REST API Reference for GetBucketVersioning Operation - - - - Initiates the asynchronous execution of the GetBucketVersioning operation. - - - Container for the necessary parameters to execute the GetBucketVersioning operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketVersioning - operation. - REST API Reference for GetBucketVersioning Operation - - - - Finishes the asynchronous execution of the GetBucketVersioning operation. - - - The IAsyncResult returned by the call to BeginGetBucketVersioning. - - Returns a GetBucketVersioningResult from S3. - REST API Reference for GetBucketVersioning Operation - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET operation requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which to get the website configuration. - - The response from the GetBucketWebsite service method, as returned by S3. - REST API Reference for GetBucketWebsite Operation - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET operation requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the GetBucketWebsite service method. - - The response from the GetBucketWebsite service method, as returned by S3. - REST API Reference for GetBucketWebsite Operation - - - - Initiates the asynchronous execution of the GetBucketWebsite operation. - - - Container for the necessary parameters to execute the GetBucketWebsite operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketWebsite - operation. - REST API Reference for GetBucketWebsite Operation - - - - Finishes the asynchronous execution of the GetBucketWebsite operation. - - - The IAsyncResult returned by the call to BeginGetBucketWebsite. - - Returns a GetBucketWebsiteResult from S3. - REST API Reference for GetBucketWebsite Operation - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - The bucket name for which to get the cors configuration. - - The response from the GetCORSConfiguration service method, as returned by S3. - REST API Reference for GetCORSConfiguration Operation - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - Container for the necessary parameters to execute the GetCORSConfiguration service method. - - The response from the GetCORSConfiguration service method, as returned by S3. - REST API Reference for GetCORSConfiguration Operation - - - - Initiates the asynchronous execution of the GetCORSConfiguration operation. - - - Container for the necessary parameters to execute the GetCORSConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetCORSConfiguration - operation. - REST API Reference for GetCORSConfiguration Operation - - - - Finishes the asynchronous execution of the GetCORSConfiguration operation. - - - The IAsyncResult returned by the call to BeginGetCORSConfiguration. - - Returns a GetCORSConfigurationResult from S3. - REST API Reference for GetCORSConfiguration Operation - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are still using previous version of the lifecycle configuration, it works. - For the earlier API description, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to GetBucketLifecycleConfiguration: - - - - The name of the bucket for which to get the lifecycle information. - - The response from the GetLifecycleConfiguration service method, as returned by S3. - REST API Reference for GetLifecycleConfiguration Operation - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are still using previous version of the lifecycle configuration, it works. - For the earlier API description, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to GetBucketLifecycleConfiguration: - - - - Container for the necessary parameters to execute the GetLifecycleConfiguration service method. - - The response from the GetLifecycleConfiguration service method, as returned by S3. - REST API Reference for GetLifecycleConfiguration Operation - - - - Initiates the asynchronous execution of the GetLifecycleConfiguration operation. - - - Container for the necessary parameters to execute the GetLifecycleConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetLifecycleConfiguration - operation. - REST API Reference for GetLifecycleConfiguration Operation - - - - Finishes the asynchronous execution of the GetLifecycleConfiguration operation. - - - The IAsyncResult returned by the call to BeginGetLifecycleConfiguration. - - Returns a GetLifecycleConfigurationResult from S3. - REST API Reference for GetLifecycleConfiguration Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object to get. - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object to get. - VersionId used to reference a specific version of the object. - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - Container for the necessary parameters to execute the GetObject service method. - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Initiates the asynchronous execution of the GetObject operation. - - - Container for the necessary parameters to execute the GetObject operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetObject - operation. - REST API Reference for GetObject Operation - - - - Finishes the asynchronous execution of the GetObject operation. - - - The IAsyncResult returned by the call to BeginGetObject. - - Returns a GetObjectResult from S3. - REST API Reference for GetObject Operation - - - - Gets an object's current Legal Hold status. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLegalHold service method. - - The response from the GetObjectLegalHold service method, as returned by S3. - REST API Reference for GetObjectLegalHold Operation - - - - Initiates the asynchronous execution of the GetObjectLegalHold operation. - - - Container for the necessary parameters to execute the GetObjectLegalHold operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetObjectLegalHold - operation. - REST API Reference for GetObjectLegalHold Operation - - - - Finishes the asynchronous execution of the GetObjectLegalHold operation. - - - The IAsyncResult returned by the call to BeginGetObjectLegalHold. - - Returns a GetObjectLegalHoldResult from S3. - REST API Reference for GetObjectLegalHold Operation - - - - Gets the Object Lock configuration for a bucket. The rule specified in the Object - Lock configuration will be applied by default to every new object placed in the specified - bucket. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLockConfiguration service method. - - The response from the GetObjectLockConfiguration service method, as returned by S3. - REST API Reference for GetObjectLockConfiguration Operation - - - - Initiates the asynchronous execution of the GetObjectLockConfiguration operation. - - - Container for the necessary parameters to execute the GetObjectLockConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetObjectLockConfiguration - operation. - REST API Reference for GetObjectLockConfiguration Operation - - - - Finishes the asynchronous execution of the GetObjectLockConfiguration operation. - - - The IAsyncResult returned by the call to BeginGetObjectLockConfiguration. - - Returns a GetObjectLockConfigurationResult from S3. - REST API Reference for GetObjectLockConfiguration Operation - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - The name of the bucket containing the object. - The object key. - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - The name of the bucket containing the object. - The object key. - VersionId used to reference a specific version of the object. - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - Container for the necessary parameters to execute the GetObjectMetadata service method. - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - Initiates the asynchronous execution of the GetObjectMetadata operation. - - - Container for the necessary parameters to execute the GetObjectMetadata operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetObjectMetadata - operation. - REST API Reference for GetObjectMetadata Operation - - - - Finishes the asynchronous execution of the GetObjectMetadata operation. - - - The IAsyncResult returned by the call to BeginGetObjectMetadata. - - Returns a GetObjectMetadataResult from S3. - REST API Reference for GetObjectMetadata Operation - - - - Retrieves an object's retention settings. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectRetention service method. - - The response from the GetObjectRetention service method, as returned by S3. - REST API Reference for GetObjectRetention Operation - - - - Initiates the asynchronous execution of the GetObjectRetention operation. - - - Container for the necessary parameters to execute the GetObjectRetention operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetObjectRetention - operation. - REST API Reference for GetObjectRetention Operation - - - - Finishes the asynchronous execution of the GetObjectRetention operation. - - - The IAsyncResult returned by the call to BeginGetObjectRetention. - - Returns a GetObjectRetentionResult from S3. - REST API Reference for GetObjectRetention Operation - - - - Returns the tag-set of an object. You send the GET request against the tagging subresource - associated with the object. - - - - To use this operation, you must have permission to perform the s3:GetObjectTagging - action. By default, the GET operation returns information about current version of - an object. For a versioned bucket, you can have multiple versions of an object in - your bucket. To retrieve tags of any other version, use the versionId query parameter. - You also need permission for the s3:GetObjectVersionTagging action. - - - - By default, the bucket owner has this permission and can grant this permission to - others. - - - - For information about the Amazon S3 object tagging feature, see Object - Tagging. - - - - The following operation is related to GetObjectTagging: - - - - Container for the necessary parameters to execute the GetObjectTagging service method. - - The response from the GetObjectTagging service method, as returned by S3. - REST API Reference for GetObjectTagging Operation - - - - Initiates the asynchronous execution of the GetObjectTagging operation. - - - Container for the necessary parameters to execute the GetObjectTagging operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetObjectTagging - operation. - REST API Reference for GetObjectTagging Operation - - - - Finishes the asynchronous execution of the GetObjectTagging operation. - - - The IAsyncResult returned by the call to BeginGetObjectTagging. - - Returns a GetObjectTaggingResult from S3. - REST API Reference for GetObjectTagging Operation - - - - Return torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Amazon - S3 Torrent. - - - - You can get torrent only for objects that are less than 5 GB in size and that are - not encrypted using server-side encryption with customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - The following operation is related to GetObjectTorrent: - - - - The name of the bucket containing the object for which to get the torrent files. - The object key for which to get the information. - - The response from the GetObjectTorrent service method, as returned by S3. - REST API Reference for GetObjectTorrent Operation - - - - Return torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Amazon - S3 Torrent. - - - - You can get torrent only for objects that are less than 5 GB in size and that are - not encrypted using server-side encryption with customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - The following operation is related to GetObjectTorrent: - - - - Container for the necessary parameters to execute the GetObjectTorrent service method. - - The response from the GetObjectTorrent service method, as returned by S3. - REST API Reference for GetObjectTorrent Operation - - - - Initiates the asynchronous execution of the GetObjectTorrent operation. - - - Container for the necessary parameters to execute the GetObjectTorrent operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetObjectTorrent - operation. - REST API Reference for GetObjectTorrent Operation - - - - Finishes the asynchronous execution of the GetObjectTorrent operation. - - - The IAsyncResult returned by the call to BeginGetObjectTorrent. - - Returns a GetObjectTorrentResult from S3. - REST API Reference for GetObjectTorrent Operation - - - - Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:GetBucketPublicAccessBlock - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket - or an object, it checks the PublicAccessBlock configuration for both - the bucket (or the bucket that contains the object) and the bucket owner's account. - If the PublicAccessBlock settings are different between the bucket and - the account, Amazon S3 uses the most restrictive combination of the bucket-level and - account-level settings. - - - - For more information about when Amazon S3 considers a bucket or an object public, - see The - Meaning of "Public". - - - - The following operations are related to GetPublicAccessBlock: - - - - Container for the necessary parameters to execute the GetPublicAccessBlock service method. - - The response from the GetPublicAccessBlock service method, as returned by S3. - REST API Reference for GetPublicAccessBlock Operation - - - - Initiates the asynchronous execution of the GetPublicAccessBlock operation. - - - Container for the necessary parameters to execute the GetPublicAccessBlock operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetPublicAccessBlock - operation. - REST API Reference for GetPublicAccessBlock Operation - - - - Finishes the asynchronous execution of the GetPublicAccessBlock operation. - - - The IAsyncResult returned by the call to BeginGetPublicAccessBlock. - - Returns a GetPublicAccessBlockResult from S3. - REST API Reference for GetPublicAccessBlock Operation - - - - This operation is useful to determine if a bucket exists and you have permission to - access it. The operation returns a 200 OK if the bucket exists and you - have permission to access it. Otherwise, the operation might return responses such - as 404 Not Found and 403 Forbidden. - - - - To use this operation, you must have permissions to perform the s3:ListBucket - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - Container for the necessary parameters to execute the HeadBucket service method. - - The response from the HeadBucket service method, as returned by S3. - REST API Reference for HeadBucket Operation - - - - Initiates the asynchronous execution of the HeadBucket operation. - - - Container for the necessary parameters to execute the HeadBucket operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndHeadBucket - operation. - REST API Reference for HeadBucket Operation - - - - Finishes the asynchronous execution of the HeadBucket operation. - - - The IAsyncResult returned by the call to BeginHeadBucket. - - Returns a HeadBucketResult from S3. - REST API Reference for HeadBucket Operation - - - - This operation initiates a multipart upload and returns an upload ID. This upload - ID is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort operation - and Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload API and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart) and UploadPartCopy) requests must match the headers you - used in the request to initiate the upload by using CreateMultipartUpload. - - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, - kms:GenerateDataKey*, and kms:DescribeKey actions on the - key. These permissions are required because Amazon S3 must decrypt and read data from - the encrypted file parts before it completes the multipart upload. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - The following operations are related to CreateMultipartUpload: - - - - The name of the bucket to which to initiate the upload - Object key for which the multipart upload is to be initiated. - - The response from the InitiateMultipartUpload service method, as returned by S3. - REST API Reference for InitiateMultipartUpload Operation - - - - This operation initiates a multipart upload and returns an upload ID. This upload - ID is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort operation - and Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload API and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart) and UploadPartCopy) requests must match the headers you - used in the request to initiate the upload by using CreateMultipartUpload. - - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, - kms:GenerateDataKey*, and kms:DescribeKey actions on the - key. These permissions are required because Amazon S3 must decrypt and read data from - the encrypted file parts before it completes the multipart upload. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - The following operations are related to CreateMultipartUpload: - - - - Container for the necessary parameters to execute the InitiateMultipartUpload service method. - - The response from the InitiateMultipartUpload service method, as returned by S3. - REST API Reference for InitiateMultipartUpload Operation - - - - Initiates the asynchronous execution of the InitiateMultipartUpload operation. - - - Container for the necessary parameters to execute the InitiateMultipartUpload operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndInitiateMultipartUpload - operation. - REST API Reference for InitiateMultipartUpload Operation - - - - Finishes the asynchronous execution of the InitiateMultipartUpload operation. - - - The IAsyncResult returned by the call to BeginInitiateMultipartUpload. - - Returns a InitiateMultipartUploadResult from S3. - REST API Reference for InitiateMultipartUpload Operation - - - - Lists the analytics configurations for the bucket. You can have up to 1,000 analytics - configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. You should always check the IsTruncated element in the response. - If there are no more configurations to list, IsTruncated is set to false. - If there are more configurations to list, IsTruncated is set to true, - and there will be a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to ListBucketAnalyticsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketAnalyticsConfigurations service method. - - The response from the ListBucketAnalyticsConfigurations service method, as returned by S3. - REST API Reference for ListBucketAnalyticsConfigurations Operation - - - - Initiates the asynchronous execution of the ListBucketAnalyticsConfigurations operation. - - - Container for the necessary parameters to execute the ListBucketAnalyticsConfigurations operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListBucketAnalyticsConfigurations - operation. - REST API Reference for ListBucketAnalyticsConfigurations Operation - - - - Finishes the asynchronous execution of the ListBucketAnalyticsConfigurations operation. - - - The IAsyncResult returned by the call to BeginListBucketAnalyticsConfigurations. - - Returns a ListBucketAnalyticsConfigurationsResult from S3. - REST API Reference for ListBucketAnalyticsConfigurations Operation - - - - Returns a list of inventory configurations for the bucket. You can have up to 1,000 - analytics configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory - - - - The following operations are related to ListBucketInventoryConfigurations: - - - - Container for the necessary parameters to execute the ListBucketInventoryConfigurations service method. - - The response from the ListBucketInventoryConfigurations service method, as returned by S3. - REST API Reference for ListBucketInventoryConfigurations Operation - - - - Initiates the asynchronous execution of the ListBucketInventoryConfigurations operation. - - - Container for the necessary parameters to execute the ListBucketInventoryConfigurations operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListBucketInventoryConfigurations - operation. - REST API Reference for ListBucketInventoryConfigurations Operation - - - - Finishes the asynchronous execution of the ListBucketInventoryConfigurations operation. - - - The IAsyncResult returned by the call to BeginListBucketInventoryConfigurations. - - Returns a ListBucketInventoryConfigurationsResult from S3. - REST API Reference for ListBucketInventoryConfigurations Operation - - - - Lists the metrics configurations for the bucket. The metrics configurations are only - for the request metrics of the bucket and do not provide information on daily storage - metrics. You can have up to 1,000 configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For more information about metrics configurations and CloudWatch request metrics, - see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to ListBucketMetricsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketMetricsConfigurations service method. - - The response from the ListBucketMetricsConfigurations service method, as returned by S3. - REST API Reference for ListBucketMetricsConfigurations Operation - - - - Initiates the asynchronous execution of the ListBucketMetricsConfigurations operation. - - - Container for the necessary parameters to execute the ListBucketMetricsConfigurations operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListBucketMetricsConfigurations - operation. - REST API Reference for ListBucketMetricsConfigurations Operation - - - - Finishes the asynchronous execution of the ListBucketMetricsConfigurations operation. - - - The IAsyncResult returned by the call to BeginListBucketMetricsConfigurations. - - Returns a ListBucketMetricsConfigurationsResult from S3. - REST API Reference for ListBucketMetricsConfigurations Operation - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - - The response from the ListBuckets service method, as returned by S3. - REST API Reference for ListBuckets Operation - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - Container for the necessary parameters to execute the ListBuckets service method. - - The response from the ListBuckets service method, as returned by S3. - REST API Reference for ListBuckets Operation - - - - Initiates the asynchronous execution of the ListBuckets operation. - - - Container for the necessary parameters to execute the ListBuckets operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListBuckets - operation. - REST API Reference for ListBuckets Operation - - - - Finishes the asynchronous execution of the ListBuckets operation. - - - The IAsyncResult returned by the call to BeginListBuckets. - - Returns a ListBucketsResult from S3. - REST API Reference for ListBuckets Operation - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Container for the necessary parameters to execute the ListMultipartUploads service method. - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - Initiates the asynchronous execution of the ListMultipartUploads operation. - - - Container for the necessary parameters to execute the ListMultipartUploads operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListMultipartUploads - operation. - REST API Reference for ListMultipartUploads Operation - - - - Finishes the asynchronous execution of the ListMultipartUploads operation. - - - The IAsyncResult returned by the call to BeginListMultipartUploads. - - Returns a ListMultipartUploadsResult from S3. - REST API Reference for ListMultipartUploads Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. - Limits the response to keys that begin with the specified prefix. - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - Container for the necessary parameters to execute the ListObjects service method. - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Initiates the asynchronous execution of the ListObjects operation. - - - Container for the necessary parameters to execute the ListObjects operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListObjects - operation. - REST API Reference for ListObjects Operation - - - - Finishes the asynchronous execution of the ListObjects operation. - - - The IAsyncResult returned by the call to BeginListObjects. - - Returns a ListObjectsResult from S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Make sure to design - your application to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - To use this operation in an AWS Identity and Access Management (IAM) policy, you must - have permissions to perform the s3:ListBucket action. The bucket owner - has this permission by default and can grant this permission to others. For more information - about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - This section describes the latest revision of the API. We recommend that you use this - revised API for application development. For backward compatibility, Amazon S3 continues - to support the prior version of this API, ListObjects. - - - - To get a list of your buckets, see ListBuckets. - - - - The following operations are related to ListObjectsV2: - - - - Container for the necessary parameters to execute the ListObjectsV2 service method. - - The response from the ListObjectsV2 service method, as returned by S3. - REST API Reference for ListObjectsV2 Operation - - - - Initiates the asynchronous execution of the ListObjectsV2 operation. - - - Container for the necessary parameters to execute the ListObjectsV2 operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListObjectsV2 - operation. - REST API Reference for ListObjectsV2 Operation - - - - Finishes the asynchronous execution of the ListObjectsV2 operation. - - - The IAsyncResult returned by the call to BeginListObjectsV2. - - Returns a ListObjectsV2Result from S3. - REST API Reference for ListObjectsV2 Operation - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). This request returns a maximum of 1,000 - uploaded parts. The default number of parts returned is 1,000 parts. You can restrict - the number of parts returned by specifying the max-parts request parameter. - If your multipart upload consists of more than 1,000 parts, the response returns an - IsTruncated field with the value of true, and a NextPartNumberMarker - element. In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListParts: - - - - Name of the bucket to which the parts are being uploaded. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Object key for which the multipart upload was initiated. - Upload ID identifying the multipart upload whose parts are being listed. - - The response from the ListParts service method, as returned by S3. - REST API Reference for ListParts Operation - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). This request returns a maximum of 1,000 - uploaded parts. The default number of parts returned is 1,000 parts. You can restrict - the number of parts returned by specifying the max-parts request parameter. - If your multipart upload consists of more than 1,000 parts, the response returns an - IsTruncated field with the value of true, and a NextPartNumberMarker - element. In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListParts: - - - - Container for the necessary parameters to execute the ListParts service method. - - The response from the ListParts service method, as returned by S3. - REST API Reference for ListParts Operation - - - - Initiates the asynchronous execution of the ListParts operation. - - - Container for the necessary parameters to execute the ListParts operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListParts - operation. - REST API Reference for ListParts Operation - - - - Finishes the asynchronous execution of the ListParts operation. - - - The IAsyncResult returned by the call to BeginListParts. - - Returns a ListPartsResult from S3. - REST API Reference for ListParts Operation - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes. - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - Container for the necessary parameters to execute the ListVersions service method. - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - Initiates the asynchronous execution of the ListVersions operation. - - - Container for the necessary parameters to execute the ListVersions operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListVersions - operation. - REST API Reference for ListVersions Operation - - - - Finishes the asynchronous execution of the ListVersions operation. - - - The IAsyncResult returned by the call to BeginListVersions. - - Returns a ListVersionsResult from S3. - REST API Reference for ListVersions Operation - - - - - Initiates the asynchronous execution of the PutACL operation. - - - Container for the necessary parameters to execute the PutACL operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutACL - operation. - REST API Reference for PutACL Operation - - - - Finishes the asynchronous execution of the PutACL operation. - - - The IAsyncResult returned by the call to BeginPutACL. - - Returns a PutACLResult from S3. - REST API Reference for PutACL Operation - - - - Creates a new bucket. To create a bucket, you must register with Amazon S3 and have - a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed - to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information on bucket naming restrictions, - see Working - with Amazon S3 Buckets. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) - Region. For more information, see How - to Select a Region for Your Buckets. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - Hosting of Buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - The name of the bucket to create. - - The response from the PutBucket service method, as returned by S3. - REST API Reference for PutBucket Operation - - - - Creates a new bucket. To create a bucket, you must register with Amazon S3 and have - a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed - to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information on bucket naming restrictions, - see Working - with Amazon S3 Buckets. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) - Region. For more information, see How - to Select a Region for Your Buckets. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - Hosting of Buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - Container for the necessary parameters to execute the PutBucket service method. - - The response from the PutBucket service method, as returned by S3. - REST API Reference for PutBucket Operation - - - - Initiates the asynchronous execution of the PutBucket operation. - - - Container for the necessary parameters to execute the PutBucket operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucket - operation. - REST API Reference for PutBucket Operation - - - - Finishes the asynchronous execution of the PutBucket operation. - - - The IAsyncResult returned by the call to BeginPutBucket. - - Returns a PutBucketResult from S3. - REST API Reference for PutBucket Operation - - - - Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration - is a bucket-level feature that enables you to perform faster data transfers to Amazon - S3. - - - - To use this operation, you must have permission to perform the s3:PutAccelerateConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The Transfer Acceleration state of a bucket can be set to one of the following two - values: - -
  • - - Enabled – Enables accelerated data transfers to the bucket. - -
  • - - Suspended – Disables accelerated data transfers to the bucket. - -
- - The GetBucketAccelerateConfiguration operation returns the transfer acceleration - state of a bucket. - - - - After setting the Transfer Acceleration state of a bucket to Enabled, it might take - up to thirty minutes before the data transfer rates to the bucket increase. - - - - The name of the bucket used for Transfer Acceleration must be DNS-compliant and must - not contain periods ("."). - - - - For more information about transfer acceleration, see Transfer - Acceleration. - - - - The following operations are related to PutBucketAccelerateConfiguration: - - - - Container for the necessary parameters to execute the PutBucketAccelerateConfiguration service method. - - The response from the PutBucketAccelerateConfiguration service method, as returned by S3. - REST API Reference for PutBucketAccelerateConfiguration Operation - - - - Initiates the asynchronous execution of the PutBucketAccelerateConfiguration operation. - - - Container for the necessary parameters to execute the PutBucketAccelerateConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketAccelerateConfiguration - operation. - REST API Reference for PutBucketAccelerateConfiguration Operation - - - - Finishes the asynchronous execution of the PutBucketAccelerateConfiguration operation. - - - The IAsyncResult returned by the call to BeginPutBucketAccelerateConfiguration. - - Returns a PutBucketAccelerateConfigurationResult from S3. - REST API Reference for PutBucketAccelerateConfiguration Operation - - - - - Initiates the asynchronous execution of the PutBucketAnalyticsConfiguration operation. - - - Container for the necessary parameters to execute the PutBucketAnalyticsConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketAnalyticsConfiguration - operation. - REST API Reference for PutBucketAnalyticsConfiguration Operation - - - - Finishes the asynchronous execution of the PutBucketAnalyticsConfiguration operation. - - - The IAsyncResult returned by the call to BeginPutBucketAnalyticsConfiguration. - - Returns a PutBucketAnalyticsConfigurationResult from S3. - REST API Reference for PutBucketAnalyticsConfiguration Operation - - - - - Initiates the asynchronous execution of the PutBucketEncryption operation. - - - Container for the necessary parameters to execute the PutBucketEncryption operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketEncryption - operation. - REST API Reference for PutBucketEncryption Operation - - - - Finishes the asynchronous execution of the PutBucketEncryption operation. - - - The IAsyncResult returned by the call to BeginPutBucketEncryption. - - Returns a PutBucketEncryptionResult from S3. - REST API Reference for PutBucketEncryption Operation - - - - - Initiates the asynchronous execution of the PutBucketInventoryConfiguration operation. - - - Container for the necessary parameters to execute the PutBucketInventoryConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketInventoryConfiguration - operation. - REST API Reference for PutBucketInventoryConfiguration Operation - - - - Finishes the asynchronous execution of the PutBucketInventoryConfiguration operation. - - - The IAsyncResult returned by the call to BeginPutBucketInventoryConfiguration. - - Returns a PutBucketInventoryConfigurationResult from S3. - REST API Reference for PutBucketInventoryConfiguration Operation - - - - Set the logging parameters for a bucket and to specify permissions for who can view - and modify the logging parameters. All logs are saved to buckets in the same AWS Region - as the source bucket. To set the logging status of a bucket, you must be the bucket - owner. - - - - The bucket owner is automatically granted FULL_CONTROL to all logs. You use the Grantee - request element to grant access to other people. The Permissions request - element specifies the kind of access the grantee has to the logs. - - - - Grantee Values - - - - You can specify the person (grantee) to whom you're assigning access rights (using - request elements) in the following ways: - -
  • - - By the person's ID: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> - </Grantee> - - - - DisplayName is optional and ignored in the request. - -
  • - - By Email address: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee> - - - - - The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl - request, appears as the CanonicalUser. - -
  • - - By URI: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee> - - -
- - To enable logging, you use LoggingEnabled and its children request elements. To disable - logging, you use an empty BucketLoggingStatus request element: - - - - <BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01" /> - - - - - For more information about server access logging, see Server - Access Logging. - - - - For more information about creating a bucket, see CreateBucket. For more information - about returning the logging status of a bucket, see GetBucketLogging. - - - - The following operations are related to PutBucketLogging: - - - - Container for the necessary parameters to execute the PutBucketLogging service method. - - The response from the PutBucketLogging service method, as returned by S3. - REST API Reference for PutBucketLogging Operation - - - - Initiates the asynchronous execution of the PutBucketLogging operation. - - - Container for the necessary parameters to execute the PutBucketLogging operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketLogging - operation. - REST API Reference for PutBucketLogging Operation - - - - Finishes the asynchronous execution of the PutBucketLogging operation. - - - The IAsyncResult returned by the call to BeginPutBucketLogging. - - Returns a PutBucketLoggingResult from S3. - REST API Reference for PutBucketLogging Operation - - - - Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. - You can have up to 1,000 metrics configurations per bucket. If you're updating an - existing metrics configuration, note that this is a full replacement of the existing - metrics configuration. If you don't include the elements you want to keep, they are - erased. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to PutBucketMetricsConfiguration: - - - - GetBucketLifecycle has the following special error: - -
  • - - Error code: TooManyConfigurations - -
    • - - Description: You are attempting to create a new configuration but have already reached - the 1,000-configuration limit. - -
    • - - HTTP Status Code: HTTP 400 Bad Request - -
- - Container for the necessary parameters to execute the PutBucketMetricsConfiguration service method. - - The response from the PutBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for PutBucketMetricsConfiguration Operation - - - - Initiates the asynchronous execution of the PutBucketMetricsConfiguration operation. - - - Container for the necessary parameters to execute the PutBucketMetricsConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketMetricsConfiguration - operation. - REST API Reference for PutBucketMetricsConfiguration Operation - - - - Finishes the asynchronous execution of the PutBucketMetricsConfiguration operation. - - - The IAsyncResult returned by the call to BeginPutBucketMetricsConfiguration. - - Returns a PutBucketMetricsConfigurationResult from S3. - REST API Reference for PutBucketMetricsConfiguration Operation - - - - Enables notifications of specified events for a bucket. For more information about - event notifications, see Configuring - Event Notifications. - - - - Using this API, you can replace an existing notification configuration. The configuration - is an XML file that defines the event types that you want Amazon S3 to publish and - the destination where you want Amazon S3 to publish an event notification when it - detects an event of the specified type. - - - - By default, your bucket has no event notifications configured. That is, the notification - configuration will be an empty NotificationConfiguration. - - - - <NotificationConfiguration> - - - - </NotificationConfiguration> - - - - This operation replaces the existing notification configuration with the configuration - you include in the request body. - - - - After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification - Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, - and that the bucket owner has permission to publish to it by sending a test notification. - In the case of AWS Lambda destinations, Amazon S3 verifies that the Lambda function - permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. - For more information, see Configuring - Notifications for Amazon S3 Events. - - - - You can disable notifications by adding the empty NotificationConfiguration element. - - - - By default, only the bucket owner can configure notifications on a bucket. However, - bucket owners can use a bucket policy to grant permission to other users to set this - configuration with s3:PutBucketNotification permission. - - - - The PUT notification is an atomic operation. For example, suppose your notification - configuration includes SNS topic, SQS queue, and Lambda function configurations. When - you send a PUT request with this configuration, Amazon S3 sends test messages to your - SNS topic. If the message fails, the entire PUT operation will fail, and Amazon S3 - will not add the configuration to your bucket. - - - - Responses - - - - If the configuration in the request body includes only one TopicConfiguration - specifying only the s3:ReducedRedundancyLostObject event type, the response - will also include the x-amz-sns-test-message-id header containing the - message ID of the test notification sent to the topic. - - - - The following operation is related to PutBucketNotificationConfiguration: - - - - Container for the necessary parameters to execute the PutBucketNotification service method. - - The response from the PutBucketNotification service method, as returned by S3. - REST API Reference for PutBucketNotification Operation - - - - Initiates the asynchronous execution of the PutBucketNotification operation. - - - Container for the necessary parameters to execute the PutBucketNotification operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketNotification - operation. - REST API Reference for PutBucketNotification Operation - - - - Finishes the asynchronous execution of the PutBucketNotification operation. - - - The IAsyncResult returned by the call to BeginPutBucketNotification. - - Returns a PutBucketNotificationResult from S3. - REST API Reference for PutBucketNotification Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - The MD5 hash of the request body. - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - Container for the necessary parameters to execute the PutBucketPolicy service method. - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Initiates the asynchronous execution of the PutBucketPolicy operation. - - - Container for the necessary parameters to execute the PutBucketPolicy operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketPolicy - operation. - REST API Reference for PutBucketPolicy Operation - - - - Finishes the asynchronous execution of the PutBucketPolicy operation. - - - The IAsyncResult returned by the call to BeginPutBucketPolicy. - - Returns a PutBucketPolicyResult from S3. - REST API Reference for PutBucketPolicy Operation - - - - Creates a replication configuration or replaces an existing one. For more information, - see Replication - in the Amazon S3 Developer Guide. - - - - To perform this operation, the user or role performing the operation must have the - iam:PassRole - permission. - - - - Specify the replication configuration in the request body. In the replication configuration, - you provide the name of the destination bucket where you want Amazon S3 to replicate - objects, the IAM role that Amazon S3 can assume to replicate objects on your behalf, - and other relevant information. - - - - A replication configuration must include at least one rule, and can contain a maximum - of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects - in the source bucket. To choose additional subsets of objects to replicate, add a - rule for each subset. All rules must specify the same destination bucket. - - - - To specify a subset of the objects in the source bucket to apply a replication rule - to, add the Filter element as a child of the Rule element. You can filter objects - based on an object key prefix, one or more object tags, or both. When you add the - Filter element in the configuration, you must also add the following elements: DeleteMarkerReplication, - Status, and Priority. - - - - For information about enabling versioning on a bucket, see Using - Versioning. - - - - By default, a resource owner, in this case the AWS account that created the bucket, - can perform this operation. The resource owner can also grant others permissions to - perform the operation. For more information about permissions, see Specifying - Permissions in a Policy and Managing - Access Permissions to Your Amazon S3 Resources. - - - - Handling Replication of Encrypted Objects - - - - By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side - encryption with CMKs stored in AWS KMS. To replicate AWS KMS-encrypted objects, add - the following: SourceSelectionCriteria, SseKmsEncryptedObjects, - Status, EncryptionConfiguration, and ReplicaKmsKeyID. - For information about replication configuration, see Replicating - Objects Created with SSE Using CMKs stored in AWS KMS. - - - - For information on PutBucketReplication errors, see ReplicationErrorCodeList - - - - - The following operations are related to PutBucketReplication: - - - - Container for the necessary parameters to execute the PutBucketReplication service method. - - The response from the PutBucketReplication service method, as returned by S3. - REST API Reference for PutBucketReplication Operation - - - - Initiates the asynchronous execution of the PutBucketReplication operation. - - - Container for the necessary parameters to execute the PutBucketReplication operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketReplication - operation. - REST API Reference for PutBucketReplication Operation - - - - Finishes the asynchronous execution of the PutBucketReplication operation. - - - The IAsyncResult returned by the call to BeginPutBucketReplication. - - Returns a PutBucketReplicationResult from S3. - REST API Reference for PutBucketReplication Operation - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - The bucket name. - Container for Payer. - - The response from the PutBucketRequestPayment service method, as returned by S3. - REST API Reference for PutBucketRequestPayment Operation - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - Container for the necessary parameters to execute the PutBucketRequestPayment service method. - - The response from the PutBucketRequestPayment service method, as returned by S3. - REST API Reference for PutBucketRequestPayment Operation - - - - Initiates the asynchronous execution of the PutBucketRequestPayment operation. - - - Container for the necessary parameters to execute the PutBucketRequestPayment operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketRequestPayment - operation. - REST API Reference for PutBucketRequestPayment Operation - - - - Finishes the asynchronous execution of the PutBucketRequestPayment operation. - - - The IAsyncResult returned by the call to BeginPutBucketRequestPayment. - - Returns a PutBucketRequestPaymentResult from S3. - REST API Reference for PutBucketRequestPayment Operation - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging. - - - - Within a bucket, if you add a tag that has the same key as an existing tag, the new - value overwrites the old value. For more information, see Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional operation is currently in progress against - this resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - The bucket name. - A property of PutBucketTaggingRequest used to execute the PutBucketTagging service method. - - The response from the PutBucketTagging service method, as returned by S3. - REST API Reference for PutBucketTagging Operation - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging. - - - - Within a bucket, if you add a tag that has the same key as an existing tag, the new - value overwrites the old value. For more information, see Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional operation is currently in progress against - this resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - Container for the necessary parameters to execute the PutBucketTagging service method. - - The response from the PutBucketTagging service method, as returned by S3. - REST API Reference for PutBucketTagging Operation - - - - Initiates the asynchronous execution of the PutBucketTagging operation. - - - Container for the necessary parameters to execute the PutBucketTagging operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketTagging - operation. - REST API Reference for PutBucketTagging Operation - - - - Finishes the asynchronous execution of the PutBucketTagging operation. - - - The IAsyncResult returned by the call to BeginPutBucketTagging. - - Returns a PutBucketTaggingResult from S3. - REST API Reference for PutBucketTagging Operation - - - - - Initiates the asynchronous execution of the PutBucketVersioning operation. - - - Container for the necessary parameters to execute the PutBucketVersioning operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketVersioning - operation. - REST API Reference for PutBucketVersioning Operation - - - - Finishes the asynchronous execution of the PutBucketVersioning operation. - - - The IAsyncResult returned by the call to BeginPutBucketVersioning. - - Returns a PutBucketVersioningResult from S3. - REST API Reference for PutBucketVersioning Operation - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT operation requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - Amazon S3 has a limitation of 50 routing rules per website configuration. If you require - more than 50 routing rules, you can use object redirect. For more information, see - Configuring - an Object Redirect in the Amazon Simple Storage Service Developer Guide. - - - The bucket name. - Container for the request. - - The response from the PutBucketWebsite service method, as returned by S3. - REST API Reference for PutBucketWebsite Operation - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT operation requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - Amazon S3 has a limitation of 50 routing rules per website configuration. If you require - more than 50 routing rules, you can use object redirect. For more information, see - Configuring - an Object Redirect in the Amazon Simple Storage Service Developer Guide. - - - Container for the necessary parameters to execute the PutBucketWebsite service method. - - The response from the PutBucketWebsite service method, as returned by S3. - REST API Reference for PutBucketWebsite Operation - - - - Initiates the asynchronous execution of the PutBucketWebsite operation. - - - Container for the necessary parameters to execute the PutBucketWebsite operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketWebsite - operation. - REST API Reference for PutBucketWebsite Operation - - - - Finishes the asynchronous execution of the PutBucketWebsite operation. - - - The IAsyncResult returned by the call to BeginPutBucketWebsite. - - Returns a PutBucketWebsiteResult from S3. - REST API Reference for PutBucketWebsite Operation - - - - - - Initiates the asynchronous execution of the PutCORSConfiguration operation. - - - Container for the necessary parameters to execute the PutCORSConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutCORSConfiguration - operation. - REST API Reference for PutCORSConfiguration Operation - - - - Finishes the asynchronous execution of the PutCORSConfiguration operation. - - - The IAsyncResult returned by the call to BeginPutCORSConfiguration. - - Returns a PutCORSConfigurationResult from S3. - REST API Reference for PutCORSConfiguration Operation - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - The name of the bucket for which to set the configuration. - A property of PutLifecycleConfigurationRequest used to execute the PutLifecycleConfiguration service method. - - The response from the PutLifecycleConfiguration service method, as returned by S3. - REST API Reference for PutLifecycleConfiguration Operation - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - Container for the necessary parameters to execute the PutLifecycleConfiguration service method. - - The response from the PutLifecycleConfiguration service method, as returned by S3. - REST API Reference for PutLifecycleConfiguration Operation - - - - Initiates the asynchronous execution of the PutLifecycleConfiguration operation. - - - Container for the necessary parameters to execute the PutLifecycleConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutLifecycleConfiguration - operation. - REST API Reference for PutLifecycleConfiguration Operation - - - - Finishes the asynchronous execution of the PutLifecycleConfiguration operation. - - - The IAsyncResult returned by the call to BeginPutLifecycleConfiguration. - - Returns a PutLifecycleConfigurationResult from S3. - REST API Reference for PutLifecycleConfiguration Operation - - - - - Initiates the asynchronous execution of the PutObject operation. - - - Container for the necessary parameters to execute the PutObject operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutObject - operation. - REST API Reference for PutObject Operation - - - - Finishes the asynchronous execution of the PutObject operation. - - - The IAsyncResult returned by the call to BeginPutObject. - - Returns a PutObjectResult from S3. - REST API Reference for PutObject Operation - - - - - Initiates the asynchronous execution of the PutObjectLegalHold operation. - - - Container for the necessary parameters to execute the PutObjectLegalHold operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutObjectLegalHold - operation. - REST API Reference for PutObjectLegalHold Operation - - - - Finishes the asynchronous execution of the PutObjectLegalHold operation. - - - The IAsyncResult returned by the call to BeginPutObjectLegalHold. - - Returns a PutObjectLegalHoldResult from S3. - REST API Reference for PutObjectLegalHold Operation - - - - - Initiates the asynchronous execution of the PutObjectLockConfiguration operation. - - - Container for the necessary parameters to execute the PutObjectLockConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutObjectLockConfiguration - operation. - REST API Reference for PutObjectLockConfiguration Operation - - - - Finishes the asynchronous execution of the PutObjectLockConfiguration operation. - - - The IAsyncResult returned by the call to BeginPutObjectLockConfiguration. - - Returns a PutObjectLockConfigurationResult from S3. - REST API Reference for PutObjectLockConfiguration Operation - - - - - Initiates the asynchronous execution of the PutObjectRetention operation. - - - Container for the necessary parameters to execute the PutObjectRetention operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutObjectRetention - operation. - REST API Reference for PutObjectRetention Operation - - - - Finishes the asynchronous execution of the PutObjectRetention operation. - - - The IAsyncResult returned by the call to BeginPutObjectRetention. - - Returns a PutObjectRetentionResult from S3. - REST API Reference for PutObjectRetention Operation - - - - - Initiates the asynchronous execution of the PutObjectTagging operation. - - - Container for the necessary parameters to execute the PutObjectTagging operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutObjectTagging - operation. - REST API Reference for PutObjectTagging Operation - - - - Finishes the asynchronous execution of the PutObjectTagging operation. - - - The IAsyncResult returned by the call to BeginPutObjectTagging. - - Returns a PutObjectTaggingResult from S3. - REST API Reference for PutObjectTagging Operation - - - - - Initiates the asynchronous execution of the PutPublicAccessBlock operation. - - - Container for the necessary parameters to execute the PutPublicAccessBlock operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutPublicAccessBlock - operation. - REST API Reference for PutPublicAccessBlock Operation - - - - Finishes the asynchronous execution of the PutPublicAccessBlock operation. - - - The IAsyncResult returned by the call to BeginPutPublicAccessBlock. - - Returns a PutPublicAccessBlockResult from S3. - REST API Reference for PutPublicAccessBlock Operation - - - - - - - - - Initiates the asynchronous execution of the RestoreObject operation. - - - Container for the necessary parameters to execute the RestoreObject operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRestoreObject - operation. - REST API Reference for RestoreObject Operation - - - - Finishes the asynchronous execution of the RestoreObject operation. - - - The IAsyncResult returned by the call to BeginRestoreObject. - - Returns a RestoreObjectResult from S3. - REST API Reference for RestoreObject Operation - - - - - Initiates the asynchronous execution of the SelectObjectContent operation. - - - Container for the necessary parameters to execute the SelectObjectContent operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSelectObjectContent - operation. - REST API Reference for SelectObjectContent Operation - - - - Finishes the asynchronous execution of the SelectObjectContent operation. - - - The IAsyncResult returned by the call to BeginSelectObjectContent. - - Returns a SelectObjectContentResult from S3. - REST API Reference for SelectObjectContent Operation - - - - - Initiates the asynchronous execution of the UploadPart operation. - - - Container for the necessary parameters to execute the UploadPart operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUploadPart - operation. - REST API Reference for UploadPart Operation - - - - Finishes the asynchronous execution of the UploadPart operation. - - - The IAsyncResult returned by the call to BeginUploadPart. - - Returns a UploadPartResult from S3. - REST API Reference for UploadPart Operation - - - - Configuration for accessing AmazonS3 service - - - Configuration for accessing Amazon S3 service - - - - - When true, requests will always use path style addressing. - - - - - Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. - To use this feature, the bucket name should be DNS compliant names and should not contain periods (.). - The following APIs are not supported and are sent to the regular region endpoint, even if this option is enabled: -
    -
  1. PutBucket
    2. -
  2. ListBuckets
    3. -
  3. DeleteBucket
    4. -
- - - This option cannot be used at the same time as UseDualstackEndpoint. - - - - - If set to true and the service package supports it the region identified in the arn for a resource - will be used when making the service request. - - - - - USEast1RegionalEndpointValue determines wheter or not - to send the us-east-1 s3 requests to the regional endpoint or to - the legacy global endpoint. - This flags takes precedence over the AWS_S3_US_EAST_1_REGIONAL_ENDPOINT - environment variable and the credential file. - - - - - This method contains custom initializations for the config object. - - - - - Given this client configuration, returns the service url - - The service url in the form of a string - - - - If the client is configured to hit us-east-1 with the S3UsEast1RegionalEndpointValue flag not set, - this method checks whether the environment variable is present or the credential file contains a valid value - - A Nullable of S3UsEast1RegionalEndpointValue representing the client configuration for the regional us-east-1 endpoint - - - - Validate that the config object is properly configured. - - - - - Checks the AWS_S3_US_EAST_1_REGIONAL_ENDPOINT environment variable for the presence of the s3 regional flag - - A nullable of S3UsEast1RegionalEndpointValue - - - - Checks the credential file for the presence of the s3 regional flag - - A nullable of S3UsEast1RegionalEndpointValue - - - - Default constructor - - - - - The constant used to lookup in the region hash the endpoint. - - - - - Gets the ServiceVersion property. - - - - - Gets the value of UserAgent property. - - - - - Base exception for S3 errors. - - - - - Construct an instance of AmazonS3Exception - - - - - - Construct an instance of AmazonS3Exception - - - - - - - Construct an instance of AmazonS3Exception - - - - - - Construct an instance of AmazonS3Exception - - - - - - - - - - Construct an instance of AmazonS3Exception - - - - - - - - - - - Construct an instance of AmazonS3Exception - - - - - - - - - - - - Construct an instance of AmazonS3Exception - - - - - - - - - - - - - A special token that helps AWS troubleshoot problems. - - - - - A special token that helps AWS troubleshoot S3 accelerate problems. - - - - - The entire response body for this exception, if available. - - - - - The region that the AmazonS3Exception relates to. - - - - - Gets the exception message. - - - - - Constructs a new instance of the AmazonS3Exception class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - Extensions methods added to Amazon.Arn type to help parse S3 specific resources from the ARN. - - - - - Attempt to parse the resource component of the ARN into access point resource name. - - An AWS ARN to parse - The access point resouce identifier found in the ARN. - True if the ARN contains an access point resource identifier. - - - - Attempt to parse the resource component of the ARN into bucket name. - - An AWS ARN to parse - The bucket name found in the ARN. - True if the ARN contains a bucket name. - - - - Custom pipeline handler to clean up streams in case of an exception. - - - - - Catch exceptions and clean up any open streams. - - - - - - Catch exceptions and clean up any open streams. - - - - - - Catch exceptions and clean up any open streams. - - - - - - - Custom pipeline handler to enable sig V4 for Get requests. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - IAsyncResult which represent an async operation. - - - - Custom pipeline handler to enable sig V4 for Get requests. - - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - IAsyncResult which represent an async operation. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - IAsyncResult which represent an async operation. - - - - Calls the post invoke logic after calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls the PostInvoke methods after calling the next handler - in the pipeline. - - The execution context, it contains the - request and response context. - - - - Constructor for AmazonS3RetryPolicy. - - The IClientConfig object - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - - - a value if it can be determined, or null if the IO-bound calculations need to be done - - - - Return true if the request should be retried. Implements additional checks - specific to S3 on top of the checks in DefaultRetryPolicy. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Constructor for AmazonS3StandardRetryPolicy. - - The IClientConfig object - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - - - a value if it can be determined, or null if the IO-bound calculations need to be done - - - - Return true if the request should be retried. Implements additional checks - specific to S3 on top of the checks in StandardRetryPolicy. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Constructor for AmazonS3AdaptiveRetryPolicy. - - The IClientConfig object - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - - - a value if it can be determined, or null if the IO-bound calculations need to be done - - - - Return true if the request should be retried. Implements additional checks - specific to S3 on top of the checks in AdaptiveRetryPolicy. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Marker interface to identify AmazonS3EncryptionClient. - - - - - Service metadata for Amazon S3 service - - - - - Gets the value of the Service Id. - - - - - Gets the dictionary that gives mapping of renamed operations - - - - - The parameters to request an abort of a multipart upload. - - - After a multipart upload is aborted, no additional parts can be uploaded using that upload ID. - The storage consumed by any previously uploaded parts will be freed. However, if any part uploads - are currently in progress, those part uploads might or might not succeed. As a result, it might be - necessary to abort a given multipart upload multiple times in order to completely free all storage - consumed by all parts. - - - - - The bucket name to which the upload was taking place. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The key of the S3 object that was being uploaded. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - The upload id for the in-progress multipart upload that should be aborted. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the AbortMultipartUpload response metadata. - The AbortMultipartUpload operation has a void result type. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Bucket accelerate configuration. - - - - - The accelerate status of the bucket. - - - - - AccessControlTranslation class - - - - - The override value for the owner of the replica object. - - - - - Class for AnalyticsAndOperator - A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. - The operator must have at least two predicates, and an object must match all of the predicates - in order for the filter to apply. - - Note: The current implementation restricts the usage to atmost one AnalyticsPrefixPredicate - and any number of AnalyticsTagPredicates. - - - - Class for AnalyticsConfiguration - - - - - The identifier used to represent an analytics configuration. - - - - - The filter used to describe a set of objects for analyses. - A filter must have exactly one prefix, one tag, or one conjunction (AnalyticsAndOperator). - If no filter is provided, all objects will be considered in any analysis. - - - - - If present, it indicates that data related to access patterns will be collected - and made available to analyze the tradeoffs between different storage classes. - - - - - Class for AnalyticsExportDestination - - - - - A destination signifying output to an S3 bucket. - - - - - Filter class for Metrics. - - - - - Filter Predicate setup for specific filter types. - - - - - Filter Predicate abstract class for specific filter types to be derived from. - - - - - Abstract class that can be used over logical filter predicates,i.e. AND/OR. - - - - - Internal implementation of Metrics Predicate visitor interface. - - - - - Interface for implementing visitor pattern in Analytics Predicate Filter. - - - - - Interface for implementing visitor pattern in Inventory Predicate Filter. - - - - - Interface for implementing visitor pattern in Metrics Predicate Filter. - - - - - Defines the interface that is used to visit all the different - implementations of - - - - - Visit a - - - - - - Visit a - - - - - - Visit a - - - - - - Implementation of to marshall . - - - - - AbortIncompleteMultipartUpload Unmarshaller - - - - - Abort Multipart Upload Request Marshaller - - - - - Response Unmarshaller for AbortMultipartUpload operation - - - - - AnalyticsConfiguration Unmarshaller - - - - - AnalyticsExportDestinationUnmarshaller - - - - - AnalyticsFilter Unmarshaller - - - - - AnalyticsS3BucketDestination Unmarshaller - - - - - Bucket Unmarshaller - - - - - CommonPrefixesItem Unmarshaller - - - - - Complete Multipart Upload Request Marshaller - - - - - Response Unmarshaller for CompleteMultipartUpload operation - - - - - ContentsItem Unmarshaller - - - - - Copy Object Request Marshaller - - - - - Response Unmarshaller for CopyObject operation - - - - - Upload Part Copy Request Marshaller - - - - - Response Unmarshaller for CopyPart operation - - - - - CORSRule Unmarshaller - - - - - Response Unmarshaller for DefaultRetention Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Delete InventoryConfiguration Request Marshaller - - - - - Response Unmarshaller for DeleteAnalyticsConfiguration operation - - - - - Response Unmarshaller for DeleteCORSConfiguration operation - - - - - Delete InventoryConfiguration Request Marshaller - - - - - Response Unmarshaller for DeleteInventoryConfiguration operation - - - - - Delete Bucket MetricsConfiguration Request Marshaller - - - - - Response Unmarshaller for DeleteBucketMetricsConfiguration operation - - - - - Delete Bucket Policy Request Marshaller - - - - - Response Unmarshaller for DeleteBucketPolicy operation - - - - - Delete Bucket Request Marshaller - - - - - Response Unmarshaller for DeleteBucket operation - - - - - Delete Bucket Tagging Request Marshaller - - - - - Response Unmarshaller for DeleteBucketTagging operation - - - - - Delete Bucket Website Request Marshaller - - - - - Response Unmarshaller for DeleteBucketWebsite operation - - - - - Delete Bucket Cors Request Marshaller - - - - - DeletedObject Unmarshaller - - - - - Delete Bucket Lifecycle Request Marshaller - - - - - Response Unmarshaller for DeleteBucketLifecycle operation - - - - - Delete Object Request Marshaller - - - - - Response Unmarshaller for DeleteObject operation - - - - - Delete Objects Request Marshaller - - - - - Response Unmarshaller for DeleteObjects operation - - - - - DeleteObjectTaggingRequest Marshaller - - - - - Marshall DeleteObjectTaggingRequest object into an http request. - - - - - Marshall DeleteObjectTaggingRequest object into an http request. - - - - - Response Unmarshaller for DeleteObjectTagging operation - - - - - DeletePublicAccessBlock Request Marshaller - - - - - Response Unmarshaller for DeletePublicAccessBlock operation - - - - - ErrorsItem Unmarshaller - - - - - Expiration Unmarshaller - - - - - FilterRule Unmarshaller - - - - - Filter Unmarshaller - - - - - Get Object Acl Request Marshaller - - - - - Response Unmarshaller for GetACL operation - - - - - Get Object Accelerate Configuration Request Marshaller - - - - - Response Unmarshaller for GetACL operation - - - - - Get BucketAnalyticsConfiguration Request Marshaller - - - - - Response Unmarshaller for GetAnalyticsConfiguration operation - - - - - Get InventoryConfiguration Request Marshaller - - - - - Response Unmarshaller for GetInventoryConfiguration operation - - - - - Get Bucket Location Request Marshaller - - - - - Response Unmarshaller for GetBucketLocation operation - - - - - Get Bucket Logging Request Marshaller - - - - - Response Unmarshaller for GetBucketLogging operation - - - - - Get Bucket MetricsConfigurationRequest Marshaller - - - - - Response Unmarshaller for GetBucketMetricsConfiguration operation - - - - - Get Bucket Notification Request Marshaller - - - - - Response Unmarshaller for GetBucketNotification operation - - - - - Get BucketName Policy Request Marshaller - - - - - Response Unmarshaller for GetBucketPolicy operation - - - - - GetBucketPolicyStatusRequestMarshaller - - - - - Response Unmarshaller for GetBucketPolicyStatus operation - - - - - Get Bucket Request Payment Request Marshaller - - - - - Response Unmarshaller for GetBucketRequestPayment operation - - - - - Get Bucket Tagging Request Marshaller - - - - - Response Unmarshaller for GetBucketTagging operation - - - - - Get Bucket Versioning Request Marshaller - - - - - Response Unmarshaller for GetBucketVersioning operation - - - - - Get Bucket Website Request Marshaller - - - - - Response Unmarshaller for GetBucketWebsite operation - - - - - Get Bucket Cors Request Marshaller - - - - - Response Unmarshaller for GetCORSConfiguration operation - - - - - Get Bucket Lifecycle Request Marshaller - - - - - Response Unmarshaller for GetLifecycleConfiguration operation - - - - - GetObjectLegalHold Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for GetObjectLegalHold operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - GetObjectLockConfiguration Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for GetObjectLockConfiguration operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - GetObjectMetadata Marshaller - - - - - Response Unmarshaller for GetObjectMetadata operation - - - - - Get Object Request Marshaller - - - - - Response Unmarshaller for GetObject operation - - - - - GetObjectRetention Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for GetObjectRetention operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - GetObjectTaggingRequest Marshaller - - - - - Marshall GetObjectTaggingRequest into an http request. - - - - - Marshall GetObjectTaggingRequest into an http request. - - - - - Response Unmarshaller for GetObjectTagging operation - - - - - Get Object Torrent Request Marshaller - - - - - Response Unmarshaller for GetObjectTorrent operation - - - - - GetPublicAccessBlockRequestMarshaller - - - - - Response Unmarshaller for GetPublicAccessBlock operation - - - - - Grantee Unmarshaller - - - - - Grant Unmarshaller - - - - - Head Bucket Request Marshaller - - - - - Response Unmarshaller for HeadBucket operation - - - - - Create Multipart Upload Request Marshaller - - - - - Response Unmarshaller for InitiateMultipartUpload operation - - - - - Initiator Unmarshaller - - - - - InventoryConfiguration Unmarshaller - - - - - InventoryDestination Unmarshaller - - - - - InventoryEncryption Unmarshaller - - - - - InventoryFilter Unmarshaller - - - - - InventoryS3BucketDestination Unmarshaller - - - - - InventorySchedule Unmarshaller - - - - - LifecycleFilterPredicate Unmarshaller - - - - - LifecycleRuleNoncurrentVersionExpiration Unmarshaller - - - - - LifecycleRuleNoncurrentVersionTransition Unmarshaller - - - - - List AnalyticsConfiguration Request Marshaller - - - - - Response Unmarshaller for ListAnalyticsConfiguration operation - - - - - List InventoryConfiguration Request Marshaller - - - - - Response Unmarshaller for ListInventoryConfiguration operation - - - - - List Bucket MetricsConfigurationRequest Marshaller - - - - - Response Unmarshaller for ListBucketMetricsConfiguration operation - - - - - List Buckets Request Marshaller - - - - - Response Unmarshaller for ListBuckets operation - - - - - List Multipart Uploads Request Marshaller - - - - - Response Unmarshaller for ListMultipartUploads operation - - - - - List Objects Request Marshaller - - - - - Response Unmarshaller for ListObjects operation - - - - - List Objects Request Marshaller - - - - - Response Unmarshaller for ListObjects operation - - - - - List Parts Request Marshaller - - - - - Response Unmarshaller for ListParts operation - - - - - List Object Versions Request Marshaller - - - - - Response Unmarshaller for ListVersions operation - - - - - LoggingEnabled Unmarshaller - - - - - MetricsConfiguration Unmarshaller - - - - - MetricsFilte Unmarshaller - - - - - UploadsItem Unmarshaller - - - - - Response Unmarshaller for ObjectLockConfiguration Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Response Unmarshaller for ObjectLockLegalHold Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Response Unmarshaller for ObjectLockRetention Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Response Unmarshaller for ObjectLockRule Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Owner Unmarshaller - - - - - PartsItem Unmarshaller - - - - - PolicyStatus Unmarshaller - - - - - PublicAccessBlockConfiguration Unmarshaller - - - - - Put Object Acl Request Marshaller - - - - - Response Unmarshaller for PutObjectAcl operation - - - - - Put Object Acl Request Marshaller - - - - - Response Unmarshaller for PutBucketAccelerate operation - - - - - Request Marshaller for PutAnalyticsConfiguration operation - - - - - Response Unmarshaller for PutBucketAnalytics operation - - - - - Request Marshaller for PutInventoryConfiguration operation - - - - - Response Unmarshaller for PutBucketWebsite operation - - - - - Enable Bucket Logging Request Marshaller - - - - - Response Unmarshaller for PutBucketLogging operation - - - - - Put Bucket MetricsConfigurationRequest Marshaller - - - - - Response Unmarshaller for PutBucketMetricsConfiguration operation - - - - - Put Bucket Notification Request Marshaller - - - - - Response Unmarshaller for PutBucketNotification operation - - - - - Put Bucket Policy Request Marshaller - - - - - Response Unmarshaller for PutBucketPolicy operation - - - - - Put Buckeyt Replication Request Marshaller - - - - - Response Unmarshaller for PutBucketReplication operation. - - - - - Put Bucket Request Marshaller - - - - - Put Bucket Request Payment Request Marshaller - - - - - Response Unmarshaller for PutBucketRequestPayment operation - - - - - Response Unmarshaller for PutBucket operation - - - - - Put Bucket Tagging Request Marshaller - - - - - Response Unmarshaller for PutBucketTagging operation - - - - - Put Bucket Versioning Request Marshaller - - - - - Response Unmarshaller for PutBucketVersioning operation - - - - - Put Bucket Website Request Marshaller - - - - - Response Unmarshaller for PutBucketWebsite operation - - - - - Put Bucket Cors Request Marshaller - - - - - Response Unmarshaller for PutCORSConfiguration operation - - - - - Put Bucket Lifecycle Request Marshaller - - - - - Response Unmarshaller for PutLifecycleConfiguration operation - - - - - PutObjectLegalHold Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for PutObjectLegalHold operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - PutObjectLockConfiguration Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for PutObjectLockConfiguration operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Put Object Request Marshaller - - - - - Response Unmarshaller for PutObject operation - - - - - PutObjectRetention Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for PutObjectRetention operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Delete Object Tagging Request Marshaller - - - - - Marshall PutObjectTaggingRequest into an http request. - - - - - Marshall PutObjectTaggingRequest into an http request. - - - - - Response Unmarshaller for DeleteObjectTagging operation - - - - - PutPublicAccessBlock Request Marshaller - - - - - Response Unmarshaller for PutPublicAccessBlock operation - - - - - Restore Object Request Marshaller - - - - - Response Unmarshaller for RestoreObject operation - - - - - Condition Unmarshaller - - - - - Redirect Unmarshaller - - - - - RoutingRule Unmarshaller - - - - - RulesItem Unmarshaller - - - - - Response Unmarshaller for all Errors - - - - - Build an S3ErrorResponse from XML - - The XML parsing context. - Usually an Amazon.Runtime.Internal.UnmarshallerContext. - An S3ErrorResponse object. - - - - Grant Unmarshaller - - - - - Class for unmarshalling S3 service responses - - - - - Specialized S3 unmarshaller context. - - - - - Wrap an XmlTextReader with state for event-based parsing of an XML stream. - - Stream with the XML from a service response. - If set to true, maintains a copy of the complete response body as the stream is being read. - Response data coming back from the request - If set to is true, configure unmarshaller with exception specifics. - - - - Reads to the next node in the XML document, and updates the context accordingly. - If node is RequestId, reads the contents and stores in RequestId property. - - - True if a node was read, false if there are no more elements to read./ - - - - - SSEKMS Unmarshaller - - - - - StorageClassAnalysisDataExportDataExportUnmarshaller - - - - - StorageClassAnalysisUnmarshaller - - - - - Tag Unmarshaller - - - - - TopicConfiguration Unmarshaller - - - - - Transition Unmarshaller - - - - - Upload Part Request Marshaller - - - - - Response Unmarshaller for UploadPart operation - - - - - VersionsItem Unmarshaller - - - - - Internal implementation of Inventory Predicate visitor interface. - - - - - Internal implementation of Metrics Predicate visitor interface. - - - - - Class for AnalyticsPrefixPredicate - The prefix used when evaluating a metrics filter. - - - - - Class for AnalyticsS3BucketDestination - - - - - The file format used when exporting data to Amazon S3. - - - - - The account ID that owns the destination bucket. If no account ID is provided, the owner will not be validated prior to exporting data. - - - - - The Amazon resource name (ARN) of the bucket to which data is exported. - - - - - The prefix to use when exporting data. The exported data begins with this prefix. - - - - - Class for MetricsTagPredicate - The tag used when evaluating a metrics filter. - - - - - This class represents the byte range for a range GET from S3. - - - - - Constructs a ByteRange and sets the start and end. - - - - - - - Constructs a ByteRange and sets the header to the value specified. - - - - - - A private string, represending the byte range. - - - - - The starting byte number of the range - - - - - The ending byte number of the range - - - - - The formatted string representing the byte range to be set for the range header. - - - - - Container for the parameters to the CompleteMultipartUpload operation. - Completes a multipart upload by assembling previously uploaded parts. - - - - - The name of the bucketName containing the S3 object that was being uploaded in parts. - - - - - The key of the S3 object that was being uploaded. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - A collection of part numbers and corresponding etags. - - - - - Adds a collection of part numbers and corresponding etags. - - PartETags that will added to this request. - - - - Adds a collection of part numbers and corresponding etags. - - PartETags that will added to this request. - - - - Adds a collection of part numbers and corresponding etags by transforming the UploadPartResponses into PartETags. - - The list of response objects return from UploadParts. - - - - Adds a collection of part numbers and corresponding etags by transforming the UploadPartResponses into PartETags. - - The list of response objects return from UploadParts. - - - - Adds a collection of part numbers and corresponding etags by transforming the CopyPartResponse into PartETags. - - The list of response objects return from CopyParts. - - - - Adds a collection of part numbers and corresponding etags by transforming the CopyPartResponse into PartETags. - - The list of response objects return from CopyParts. - - - - The upload id for the in-progress multipart upload that should be completed. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the CompleteMultipartUpload response and response metadata. - - - - - Gets and sets the URI that identifies the newly created object. - - - - - Gets and sets the name of the bucketName that contains the newly created object. - - - - - Gets and sets the object key of the newly created object. - - - - - Gets and sets Entity tag that identifies the newly created object's data. Objects with different - object data will have different entity tags. The entity tag is an opaque string. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - Gets and sets the ServerSideEncryptionMethod property. - Specifies the encryption used on the server to - store the content. - Default is None. - - - - - Gets and sets the VersionId property. - This is the version-id of the S3 object - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the CopyObject operation. - Creates a copy of an object that is already stored in Amazon S3. - - - Container for the parameters to the CopyObject operation. - Creates a copy of an object that is already stored in Amazon S3. - - - - - The name of the bucket containing the object to copy. - - - - - Checks if SourceBucket property is set. - - true if SourceBucket property is set. - - - - The key of the object to copy. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Checks if SourceKey property is set. - - true if SourceKey property is set. - - - - Specifies a particular version of the source object to copy. By default the latest version is copied. - - - - - Checks if SourceVersionId property is set. - - true if SourceVersionId property is set. - - - - The name of the bucket to contain the copy of the source object. - - - - - Checks if DestinationBucket property is set. - - true if DestinationBucket property is set. - - - - The key to be given to the copy of the source object. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Checks if DestinationKey property is set. - - true if DestinationKey property is set. - - - - A canned access control list (CACL) to apply to the object. - Please refer to for - information on S3 Canned ACLs. - - - - - ETag to be matched as a pre-condition for copying the source object - otherwise returns a PreconditionFailed. - - - Copies the object if its entity tag (ETag) matches - the specified tag; otherwise return a 412 (precondition failed). - Constraints: This property can be used with IfUnmodifiedSince, - but cannot be used with other conditional copy properties. - - - - - Checks if ETagToMatch property is set. - - - Copies the object if its entity tag (ETag) is different - than the specified Etag; otherwise returns a 412 (failed condition). - Constraints: This header can be used with IfModifiedSince, but cannot - be used with other conditional copy properties. - - true if ETagToMatch property is set. - - - - ETag that must not be matched as a pre-condition for copying the source object, - otherwise returns a PreconditionFailed. - - - - - Checks if ETagToNotMatch property is set. - - true if ETagToNotMatch property is set. - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or - ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Copies the object if it has been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it has been modified since the - specified time; otherwise returns a 412 (failed condition). - Constraints: This property can be used with ETagToNotMatch, - but cannot be used with other conditional copy properties. - - - - - Copies the object if it has been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it has been modified since the - specified time; otherwise returns a 412 (failed condition). - Constraints: This property can be used with ETagToNotMatch, - but cannot be used with other conditional copy properties. - - - - - Checks if ModifiedSinceDateUtc property is set. - - true if ModifiedSinceDateUtc property is set. - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or - UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Copies the object if it has not been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it hasn't been modified since the - specified time; otherwise returns a 412 (precondition failed). - Constraints: This property can be used with ETagToMatch, - but cannot be used with other conditional copy properties. - - - - - Copies the object if it has not been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it hasn't been modified since the - specified time; otherwise returns a 412 (precondition failed). - Constraints: This property can be used with ETagToMatch, - but cannot be used with other conditional copy properties. - - - - - Checks if UnmodifiedSinceDateUtc property is set. - - true if UnmodifiedSinceDateUtc property is set. - - - - Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request. - - - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - Specifies whether you want to apply a Legal Hold to the copied object. - - - - - - Gets and sets the property ObjectLockMode. - - The Object Lock mode that you want to apply to the copied object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - The date and time when you want the copied object's Object Lock to expire. - - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - Checks if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - true if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - - - The type of storage to use for the object. Defaults to 'STANDARD'. - - - - - - If the bucketName is configured as a website, redirects requests for this object to another object in the same bucketName or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - This is a convenience property for Headers.ContentType. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - /// - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The customer provided encryption key for the source object of the copy. - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - true if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the CopySourceServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if CopySourceServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - The tag-set for the object destination object this value must be used in conjunction with the TaggingDirective. The tag-set must be encoded as URL Query parameters. - - - - - Checks if Tagging property is set - - true if Tagging is set. - - - - Overrides the default request timeout value. - - - - If the value is set, the value is assigned to the Timeout property of the HTTPWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Overrides the default ReadWriteTimeout value. - - - - If the value is set, the value is assigned to the ReadWriteTimeout property of the HTTPWebRequest/WebRequestHandler object used - to send requests. - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - - Returns information about the CopyObject response and response metadata. - - - - - Gets and sets the ETag property. - - - - - Gets and sets the LastModified property. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - Gets and sets the SourceVersionId property. - This is the Version Id of the Source Object - - - - - Version ID of the newly created copy. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the CopyPart operation. - Uploads a part by copying data from an existing object as data source. - - - Container for the parameters to the CopyPart operation. - Uploads a part by copying data from an existing object as data source. - - - - - The name of the bucket containing the object to copy. - - - - - Checks if SourceBucket property is set. - - true if SourceBucket property is set. - - - - The key of the object to copy. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Checks if SourceKey property is set. - - true if SourceKey property is set. - - - - Specifies a particular version of the source object to copy. By default the latest version is copied. - - - - - Checks if SourceVersionId property is set. - - true if SourceVersionId property is set. - - - - The name of the bucket to contain the copy of the source object. - - - - - Checks if DestinationBucket property is set. - - true if DestinationBucket property is set. - - - - The key to be given to the copy of the source object. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Checks if DestinationKey property is set. - - true if DestinationKey property is set. - - - - The ID identifying multipart upload for which we are copying a part. - - - - - Checks if UploadId property is set. - - true if UploadId property is set. - - - - Collection of ETags to be matched as a pre-condition for copying the source object - otherwise returns a PreconditionFailed. - - - Copies the object if its entity tag (ETag) matches one of - the specified tags; otherwise return a 412 (precondition failed). - Constraints: This property can be used with IfUnmodifiedSince, - but cannot be used with other conditional copy properties. - - - - - Checks if ETagsToMatch property is set. - - true if ETagToMatch property is set. - - - - Collection of ETags that must not be matched as a pre-condition for copying the source object - otherwise returns a PreconditionFailed. - - - Copies the object if its entity tag (ETag) does not match any of the specified - tags; otherwise returns a 412 (failed condition). - Constraints: This header can be used with IfModifiedSince, but cannot - be used with other conditional copy properties. - - - - - Checks if ETagToNotMatch property is set. - - true if ETagToNotMatch property is set. - - - - Copies the object if it has been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it has been modified since the - specified time; otherwise returns a 412 (failed condition). - Constraints: This property can be used with ETagToNotMatch, - but cannot be used with other conditional copy properties. - - - - - Checks if ModifiedSinceDate property is set. - - true if ModifiedSinceDate property is set. - - - - Copies the object if it has not been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it hasn't been modified since the - specified time; otherwise returns a 412 (precondition failed). - Constraints: This property can be used with ETagToMatch, - but cannot be used with other conditional copy properties. - - - - - Checks if UnmodifiedSinceDate property is set. - - true if UnmodifiedSinceDate property is set. - - - - The number of the part to be copied. - - - Valid part numbers are from 1 to 10,000 inclusive and will uniquely identify the part - and determine the relative ordering within the destination object. If a part already - exists with the PartNumber it will be overwritten. - - - - - Checks if PartNumber property is set. - - true if PartNumber property is set. - - - - The location of the first byte in the range if only a portion of the - source object is to be copied as the part. - - - The LastByte property must also be set or this value will be ignored. - - - - - Checks if FirstByte property is set. - - true if FirstByte property is set. - - - - The location of the last byte in the range if only a portion of the - source object is to be copied as the part. - - - The FirstByte property must also be set or this value will be ignored. - - - - - Checks if LastByte property is set. - - true if LastByte property is set. - - - - - This property is obsolete. Use ServerSideEncryptionMethod in InitiateMultipartUploadRequest instead. - - - Default: None - - - - - - Checks if ServerSideEncryptionMethod property is set. - - true if ServerSideEncryptionMethod property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - This property is obsolete. Use ServerSideEncryptionKeyManagementServiceKeyId in InitiateMultipartUploadRequest instead. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The customer provided encryption key for the source object of the copy. - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - true if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the CopySourceServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if CopySourceServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - - - Overrides the default request timeout value. - - - - If the value is set, the value is assigned to the Timeout property of the HTTPWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Overrides the default ReadWriteTimeout value. - - - - If the value is set, the value is assigned to the ReadWriteTimeout property of the HTTPWebRequest/WebRequestHandler object used - to send requests. - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - - Returns information about the CopyPart response and response metadata. - - - - - The version of the source object that was copied, if you have enabled versioning on the source bucketName. - - - - - - Entity tag of the object. - - - - - - Date and time at which the object was uploaded. - - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - Gets and sets the PartNumber property. - This is the part number in it's multi-part upload that will uniquely identify the part - and determine the relative ordering within the destination object. - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - A collection of up to 100 cross-origin resource sharing (CORS) rules. - - - - - The collection of rules in this configuration. - - - - C O R S Rule - - - - - Identifies HTTP methods that the domain/origin specified in the rule is allowed to execute. - - - - - - One or more origins you want customers to be able to access the bucket from. - - - - - - An optional unique identifier for the rule. - - - The ID value can be up to 255 characters long. The IDs help you find a rule in the configuration. - - - - - Checks if Id property is set. - - true if Id property is set. - - - - One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript - XMLHttpRequest object). - - - - - - The time in seconds that your browser is to cache the preflight response for the specified resource. - - - - - - Specifies which headers are allowed in a pre-flight OPTIONS request through the - Access-Control-Request-Headers header. - - - Each header name specified in the Access-Control-Request-Headers must have a corresponding - entry in the rule. Only the headers that were requested will be sent back. - This element can contain at most one * wildcard character. - - - - - Checks if AllowedHeaders property is set. - - true if AllowedHeaders property is set. - - - - Describes how a CSV-formatted input object is formatted. - - - - - Describes the first line of input. Valid values: None, Ignore, Use. - - - - - Single character used to indicate a row should be ignored when present at the start of a row. - - - - - Single character used for escaping the quote character inside an already escaped value. - - - - - Value used to separate individual records. - - - - - Value used to separate individual fields in a record. - - - - - Value used for escaping where the field delimiter is part of the value. - - - - - Specifies that CSV field values may contain quoted record delimiters and such records should be allowed. Default value is FALSE. Setting this value to TRUE may lower performance. - - - - - Describes how CSV-formatted results are formatted. - - - - - Indicates whether or not all output fields should be quoted. - - - - - Single character used for escaping the quote character inside an already escaped value. - - - - - Value used to separate individual records. - - - - - Value used to separate individual fields in a record. - - - - - Value used for escaping where the field delimiter is part of the value. - - - - - The container element for specifying the default Object Lock retention settings for - new objects placed in the specified bucket. - - - - - Gets and sets the property Days. - - The number of days that you want to specify for the default retention period. - - - - - - Gets and sets the property Mode. - - The default Object Lock retention mode you want to apply to new objects placed in - the specified bucket. - - - - - - Gets and sets the property Years. - - The number of years that you want to specify for the default retention period. - - - - - - Container for the parameters to the DeleteBucketAnalyticsConfiguration operation. - Deletes an analytics configuration for the bucket (specified by the analytics configuration ID). - - - - - The name of the bucket from which an analytics configuration is deleted. - - - - - The identifier used to represent an analytics configuration. - - - - - Returns information about the DeleteBucketAnalyticsConfiguration response metadata. - The DeleteBucketAnalyticsConfiguration operation has a void result type. - - - - - Request object for the DeleteBucketEncryption operation. - Request Deletes the server-side encryption configuration from the bucket. - - - - - The name of the bucket containing the server-side encryption configuration to delete. - - - - - Returns information about the DeleteBucketEncryption response metadata. - The DeleteBucketEncryption operation has a void result type. - - - - - Container for the parameters to the DeleteInventoryConfiguration operation. - Deletes an inventory configuration (identified by the inventory ID) from the bucket. - - - - - The name of the bucket containing the inventory configuration to delete. - - - - - The ID used to identify the inventory configuration. - - - - - Returns information about the DeleteInventoryConfiguration response metadata. - The DeleteInventoryConfiguration operation has a void result type. - - - - - Container for the parameters to the DeleteBucketMetricsConfiguration operation. - Deletes a metrics configuration (specified by the metrics configuration ID) from the bucket. - - - - - The name of the bucket on which Inventory configuration is to be removed. - - - - - The ID used to identify the metrics configuration. - - - - - Returns information about the DeleteBucketMetricsConfiguration response metadata. - The DeleteBucketMetricsConfiguration operation has a void result type. - - - - - Container for the parameters to the DeleteBucketPolicy operation. - Deletes the policy from the bucket. - - - - - The bucket on which the policy is to be deleted. - - - - - Returns information about the DeleteBucketPolicy response metadata. - The DeleteBucketPolicy operation has a void result type. - - - - - Request object for the DeleteBucketReplication operation. - - - - - Gets and sets the property BucketName. -

Deletes the replication subresource associated with the specified - bucket.

There is usually some time lag before - replication configuration deletion is fully propagated to all the - Amazon S3 systems.

For more information, see - - Cross-Region Replication (CRR) in the Amazon S3 Developer - Guide.

- - - - - Returns information about the DeleteBucketReplication response metadata. - The DeleteBucketReplication operation has a void result type. - - - - - Container for the parameters to the DeleteBucket operation. - Deletes the bucket. All objects (including all object versions and Delete Markers) in the bucket must be deleted before the bucket - itself can be deleted. - - - - - The name of the bucket to be created. - - - - - The region locality for the bucket. - - - When set, this will determine the region the bucket exists in. - Refer - for a list of possible values. - - - - - If set to true the bucket will be deleted in the same region as the configuration of the AmazonS3 client. - DeleteBucketRequest.BucketRegion takes precedence over this property if both are set. - Default: true. - - - - - Returns information about the DeleteBucket response metadata. - The DeleteBucket operation has a void result type. - - - - - The parameters to request deletion of a tag set from a bucket. - - - To use this operation, you must have permission to perform the s3:PutBucketTagging action. - By default, the bucket owner has this permission and can grant this permission to others. - - - - - The name of the bucket on which the tag set is to be removed. - - - - - Returns information about the DeleteBucketTagging response metadata. - The DeleteBucketTagging operation has a void result type. - - - - - Container for the parameters to the DeleteBucketWebsite operation. - This operation removes the website configuration from the bucket. - - - - - The name of the bucket on which website configuration is to be removed. - - - - - Returns information about the DeleteBucketWebsite response metadata. - The DeleteBucketWebsite operation has a void result type. - - - - - Container for the parameters to the DeleteCORSConfiguration operation. - Deletes the cors configuration information set for the bucket. - - - - - Gets and sets the BucketName property. - - - - - Returns information about the DeleteCORSConfiguration response metadata. - The DeleteCORSConfiguration operation has a void result type. - - - - - Contains information about a successful delete operation against a specific S3 object. - - - - - Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a - delete marker. In a simple DELETE, this header indicates whether (true) or not (false) a delete - marker was created. - - - - - The version ID of the delete marker created as a result of the DELETE operation. If you delete a - specific object version, the value returned by this header is the version ID of the object version - deleted. - - - - - The key of the deleted S3 object. - - - - - The version of the deleted S3 object. - - - - - Contains information about a failed delete operation against a specific S3 object. - - - - - The key of the S3 object. - - - - - The version of the S3 object. - - - - - The failure code for the delete error. - - - - - The failure message for the delete error. - - - - - The parameters to request deletion of the lifecycle configuration on a bucket. - - - - Amazon S3 removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. - Your objects never expire, and Amazon S3 no longer automatically deletes any objects on the basis of rules contained - in the deleted lifecycle configuration. - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration action. By default, the - bucket owner has this permission and the bucket owner can grant this permission to others. - - - There is usually some time lag before lifecycle configuration deletion is fully propagated to all the Amazon S3 systems. - - - - - - The name of the bucket on which the lifecycle configuration is to be deleted. - - - - - Returns information about the DeleteLifecycleConfiguration response metadata. - The DeleteLifecycleConfiguration operation has a void result type. - - - - -

Specifies whether Amazon S3 should replicate delete makers.

- - - - - Gets and sets the property Status. -

The status of the delete marker replication.

-

In the current implementation, Amazon S3 does not replicate - the delete markers. Therefore, the status must be - Disabled.

- - - - - The parameters to request deletion of an object in a bucket. - The operation removes the null version (if there is one) of an object and inserts a delete marker, which - becomes the latest version of the object. - - - - To remove a specific version, you must be the bucket owner and you must use the versionId subresource. - Using this subresource permanently deletes the version. - - - If the object you want to delete is in a bucket where the bucket versioning configuration is MFA Delete enabled, - you must include specify the MFA serial number and value in the request. - - - If there isn't a null version, Amazon S3 does not remove any objects. - - - - - - The bucket name of the bucket containing the object. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property BypassGovernanceRetention. - - - - - The key identifying the object to delete. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - The identifier for the specific version of the object to be deleted, if required. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - The MfaCodes Tuple associates the Serial Number and the current Token/Code displayed on the - Multi-Factor Authentication device associated with your AWS Account. - - - This is a required property for this request if:
- 1. EnableMfaDelete was configured on the bucket - containing this object's version.
- 2. You are deleting an object's version - - - - - Checks if the MfaCodes property is set. - - true if the MfaCodes property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the DeleteObject response and response metadata. - - - - - Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a delete marker. - - - - - - Returns the version ID of the delete marker created as a result of the DELETE operation. - - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the DeleteObjects operation. - This operation enables you to delete multiple objects from a bucket using a single HTTP request. You may specify up to 1000 - keys. - - - Container for the parameters to the DeleteObjects operation. - This operation enables you to delete multiple objects from a bucket using a single HTTP request. You may specify up to 1000 - keys. - - - - - The bucket name containing the objects to delete. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property BypassGovernanceRetention. - - Specifies whether you want to delete this object even if it has a Governance-type - Object Lock in place. You must have sufficient permissions to perform this operation. - - - - - - List of object keys to delete. - - - - - Toggles between Quiet and Verbose mode for the operation. - If set to true (Quiet mode), the response includes only those keys for objects on which - the delete operation failed. - - - By default this property is false and keys for both successful deletes - and failures are returned in the response. - - - - - The MfaCodes Tuple associates the Serial Number and the current Token/Code displayed on the - Multi-Factor Authentication device associated with your AWS Account. - - - This is a required property for this request if:
- 1. EnableMfaDelete was configured on the bucket - containing this object's version.
- 2. You are deleting an object's version - - - - - Checks if the MfaCodes property is set. - - true if the MfaCodes property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Add a key to the set of keys of objects to be deleted. - - Object key - - - - Add a key and a version to be deleted. - - Key of the object to be deleted. - Version of the object to be deleted. - - - - Add a KeyVersion object representing the S3 object to be deleted. - - KeyVersion representation of object to be deleted. - - - - Returns information about the DeleteObjects response and response metadata. - - - - - A default constructor for DeleteObjectsResponse - - - - - Gets and sets the DeletedObjects property. - A list of successful deletes. - Set only when Quiet=false on DeleteObjectsRequest. - - - - - Gets and sets the DeleteErrors property. - A list of errors encountered while deleting objects. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Sets the with information about DeleteObjectsResponse - - The that holds the serialized object data. - The that contains contextual information about the source or destination. - - - - Sets the with information about the DeleteObjectsResponse. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - - - - Container for the parameters to the DeleteObjectTaggingRequest operation. - - - - - The bucket name containing the objects from which to remove the tags. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Check to see if Bucket property is set - - - - - The key identifying the object tagging to delete. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Check to see if Key property is set - - - - - The identifier for the specific version of the object to be deleted, if required. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - Returns information about the DeleteObjectTagging response and response metadata. - - - - - Returns the version ID of the delete marker created as a result of the DELETE operation. - - - - - Check to see if VersionId property is set - - - - - Container for the parameters to the DeletePublicAccessBlock operation. - Removes the Public Access Block configuration for an Amazon S3 bucket. - - - - - Gets and sets the property BucketName. - - The Amazon S3 bucket whose Public Access Block configuration you want to delete. - - - - - - This is the response object from the DeletePublicAccessBlock operation. - - - - - EncryptionConfiguration class - - - - - The ID of the AWS KMS key for the region where the destination bucket - resides. Amazon S3 uses this key to encrypt the replica object. - - - - - The Continuation Event. - - - - - Constructs a Continuation Event. - - - - - Constructs a Continuation Event. - - - - - - The End Event. - - - - - Constructs an End Event. - - - - - Constructs an End Event. - - - - - - Common Contract for S3 Events. - - - - - The Progress event details. - - - - - Current number of object bytes scanned. - - - - - Current number of uncompressed object bytes processed. - - - - - Total number of bytes of records payload data returned. - - - - - Constructs a instance of Progress. - - - - - The Progress Event. - - - - - The Progress event details. - - - - - Constructs a ProgressEvent. - - - - - Constructs a ProgressEvent. - - - - - - The Records Event - - - - - The byte array of partial, one or more result records. - - Payload is a , which is not thread-safe. - - - - - Constructs a RecordsEvent - - - - - Creates a new End Event. - - - - - - Modeled Exception that either comes over the stream from the service model, or wraps other exceptions for the purpose of raising events. If it is - modelled, it will be a subclass. - - - - - Creates a new S3EventStreamException - - - - - Creates a new S3EventStreamException - - - - - - Creates a new S3EventStreamException - - - - - - - Constructs a new instance of the S3EventStreamException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - The contract for the SelectObjectContentEventStream. - - - - - Event that encompasses all IS3Events. - - - - - Event that encompasses S3EventStreamExceptions. - - - - - Reaised when a Records event is received. - - - - - Reaised when a Stats event is received. - - - - - Reaised when a Progress event is received. - - - - - Reaised when a Continuation event is received. - - - - - Reaised when an End event is received. - - - - - A Stream of Events returned by the SelectObjectContent operation. Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treaded as mutually exclusive. - - - - - The mapping of event message to a generator function to construct the matching Event Stream event. - - - - - The mapping of event message to a generator function to construct the matching Event Stream exception. - - - - - Whether the backround processing loop is running. - - - - - Event that encompasses all IS3Events. - - - - - Event that encompasses S3EventStreamExceptions. - - - - - Reaised when a Records event is received. - - - - - Reaised when a Stats event is received. - - - - - Reaised when a Progress event is received. - - - - - Reaised when a Continuation event is received. - - - - - Reaised when an End event is received. - - - - - Event Stream returned by SelectObjectContentStream. - - Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treated as mutually exclusive. - - The network stream which events will be parsed from. - - - - Event Stream returned by SelectObjectContentStream. - - Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treaded as mutually exclusive. - - The network stream which events will be parsed from. - The decoder responsible for parsing events. - - - - The Stats event details. - - - - - Total number of object bytes scanned. - - - - - Total number of uncompressed object bytes processed. - - - - - Total number of bytes of records payload data returned. - - - - - Constructs an instance of Stats. - - - - - The Stats Event. - - - - - The Stats event details. - - - - - Constructs a StatsEvent - - - - - Constructs a ProgressEvent. - - - - - - This Event is returned if an event is retrieved from the event stream, but a generator function - for the event is not defined. - - - - - Constructs an UnknownEventStreamEvent. - - - - - Constructs an UnknownEventStreamEvent. - - The Message recieved from the event stream before conversion. - - - - Constructs an UnknownEventStreamEvent. - - The Message recieved from the event stream before conversion. - The event type. - - - - A container that specifies information about existing object replication. You can choose whether to enable or disable the replication of existing objects. - - - - - Specifies whether existing object replication is enabled. - - - - - Defines the expiration policy for a given object. - - - - - This property is deprecated. This property exposes a DateTime of kind Unspecified. Use ExpiryDateUtc instead. - The date and time for expiry. - - - - - The date and time for expiry. - - - - - Id of the configuration rule for this expiry. - - - - - Constructs an empty instance of an Expiration object - - - - Bucket - Represents a set of filter criteria that limits the objects that can trigger event notifications - - - - - Filter criteria that limits the objects that can trigger event notifications based on their S3 Key name. - - - - - Bucket - Represents a Filter Rule for a NotificationConfiguration. - - - - - Constructs an empty FilterRule. - - - - - Constructs a FilterRule with a specific name and value. - - - - - - - The name of the filter rule. - - - - - The value of the filter rule. - - - - - Container for the parameters to the GetACL operation. - Returns the access control list (ACL) of an object. - - - - - The bucket name that contains the object for which to get the ACL information. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The key of the S3 object to be queried. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - VersionId used to reference a specific version of the object. - - - - - Returns information about the GetACL response and response metadata. - - - - - Gets and sets the AccessControlList property. - - - - - Container for the parameters to the GetBucketAccelerateConfiguration operation. - - - - - The name of the bucket. - - - - - The response class for GetBucketAccelerateConfiguration operation. - - - - - The accelerate status of the bucket. - - - - - Container for the parameters to the GetBucketAnalyticsConfiguration operation. - Gets an analytics configuration for the bucket (specified by the analytics configuration ID). - - - - - The name of the bucket from which an analytics configuration is retrieved. - - - - - The identifier used to represent an analytics configuration. - - - - - GetBucketAnalyticsConfigurationResponse Response - - - - - The configuration and any analyses for the analytics filter. - - - - - Container for the parameters to the GetBucketEncryptionRequest operation. - Returns the server-side encryption configuration of a bucket. - - - - - The name of the bucket. - - - - - GetBucketEncryptionResponse Response - - - - - Container for server-side encryption configuration rules. Currently S3 supports one rule only. - - - - - Container for the parameters to the GetInventoryConfigurationRequest operation. - Returns an inventory configuration (identified by the inventory ID) from the bucket. - - - - - The name of the bucket containing the inventory configuration to retrieve. - - - - - The ID used to identify the inventory configuration. - - - - - GetInventoryConfigurationResponse Response - - - - - Specifies the inventory configuration. - - - - - Container for the parameters to the GetBucketLocation operation. - Returns the region the bucket resides in. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetBucketLocation response and response metadata. - - - - - Gets and sets the Location property. - If the the bucket is located in us-east-1 S3Region.US will be return which has a - value of empty string. - - - - - Container for the parameters to the GetBucketLogging operation. - Returns the logging status of a bucket and the permissions users have to view and modify that status. To use GET, you must be the - bucket owner. - - - - - The name of the bucket to query. - - - - - Returns information about the GetBucketLogging response and response metadata. - - - - - Gets and sets the LoggingConfig property. - - - - - Container for the parameters to the GetBucketMetricsConfiguration operation. - Gets a metrics configuration (specified by the metrics configuration ID) from the bucket. - - - - - The name of the bucket containing the metrics configuration to retrieve. - - - - - The ID used to identify the metrics configuration. - - - - - GetBucketMetricsConfiguration Response - - - - - Specifies the metrics configuration. - - - - - Container for the parameters to the GetBucketNotification operation. - Return the notification configuration of a bucket. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetBucketNotification response and response metadata. - - - - - Gets and sets the TopicConfigurations property. TopicConfigurations are configuration - for Amazon S3 events to be sent to Amazon SNS topics. - - - - - Gets and sets the QueueConfigurations property. QueueConfigurations are configuration - for Amazon S3 events to be sent to Amazon SQS queues. - - - - - Gets and sets the LambdaFunctionConfigurations property. LambdaFunctionConfigurations are configuration - for Amazon S3 events to be sent to an Amazon Lambda cloud function. - - - - - Container for the parameters to the GetBucketPolicy operation. - Returns the policy of a specified bucket. - - - - - The name of the bucket. - - - - - Get BucketName Policy Response - - - - - The bucket policy as a JSON document. - - - - - Container for the parameters to the GetBucketPolicyStatus operation. - Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket - is public. - - - - - Gets and sets the property BucketName. - - The name of the Amazon S3 bucket whose public-policy status you want to retrieve. - - - - - - This is the response object from the GetBucketPolicyStatus operation. - - - - - The public-policy status for this bucket. - - - - - Container for the parameters to the GetBucketReplicationConfiguration operation. - Returns the replication configuration information set on the bucket. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetReplicationConfiguration response and response metadata. - - - - - The replication configuration for the buccket specified in the request. - - - - - Container for the parameters to the GetBucketRequestPayment operation. - Returns the request payment configuration of a bucket. - - - - - The name of the bucket. - - - - - Returns information about the GetBucketRequestPayment response and response metadata. - - - - - Specifies who pays for the download and request fees. - - - - - - Container for the parameters to the GetBucketTagging operation. - Returns the tag set associated with the bucket. - - - - - The name of the bucket to be queried. - - - - - Returns information about the GetBucketTagging response and response metadata. - - - - - The collection of tags. - - - - - Container for the parameters to the GetBucketVersioning operation. - Returns the versioning state of a bucket. - - - - - The name of the bucket to be queried. - - - - - Returns information about the GetBucketVersioning response and response metadata. - - - - - Gets and sets the Versioning property. - Unless Versioning has been explicitly "Enabled" on a bucket, - Versioning Status is "Off". Once Versioning has been - "Enabled", it can be "Suspended" but cannot be switched "Off". - - - - - Container for the parameters to the GetBucketWebsite operation. - Returns the website configuration for a bucket. - - - - - The name of the bucket to be queried. - - - - - Returns information about the GetBucketWebsite response and response metadata. - - - - - Gets and sets the WebsiteConfiguration property. - - This is where the index document suffix and custom error page are defined. - - - - - Container for the parameters to the GetBucketCors operation. - Returns the cors configuration for the bucket. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetBucketCors response and response metadata. - - - - - The current CORSConfiguration for the bucket. - - - - - Container for the parameters to the GetLifecycleConfiguration operation. - Returns the lifecycle configuration information set on the bucket. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetLifecycleConfiguration response and response metadata. - - - - - Gets and Sets the property that governs whether - the response includes successful deletes as well as errors - following the DeleteObjects call against S3. - - By default this property is false and successful deletes - are returned in the response. - - - - - Container for the parameters to the GetObjectLegalHold operation. - Gets an object's current Legal Hold status. - - - - - The bucket name containing the object whose Legal Hold status you want to retrieve. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property Key. - - The key name for the object whose Legal Hold status you want to retrieve. - - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property VersionId. - - The version ID of the object whose Legal Hold status you want to retrieve. - - - - - - This is the response object from the GetObjectLegalHold operation. - - - - - Gets and sets the property LegalHold. - - The current Legal Hold status for the specified object. - - - - - - Container for the parameters to the GetObjectLockConfiguration operation. - Gets the Object Lock configuration for a bucket. The rule specified in the Object - Lock configuration will be applied by default to every new object placed in the specified - bucket. - - - - - Gets and sets the property BucketName. - - The bucket whose Object Lock configuration you want to retrieve. - - - - - - This is the response object from the GetObjectLockConfiguration operation. - - - - - Gets and sets the property ObjectLockConfiguration. - - The specified bucket's Object Lock configuration. - - - - - - Container for the parameters to the HeadObject operation. - The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you''re only - interested in an object''s metadata. To use HEAD, you must have READ access to the object. - - - - - The name of the bucket that contains the object. - - - - - ETag to be matched as a pre-condition for returning the object, - otherwise a PreconditionFailed signal is returned. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or - ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Returns the object only if it has been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Returns the object only if it has been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - ETag that should not be matched as a pre-condition for returning the object, - otherwise a PreconditionFailed signal is returned. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or - UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Returns the object only if it has not been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Returns the object only if it has not been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - The key of the object. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - VersionId used to reference a specific version of the object. - - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to decrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - Part number of the object being read. This is a positive integer between 1 and 10,000. - Effectively performs a 'ranged' HEAD request for the part specified. - Useful querying about the size of the part and the number of parts in this object. - - - - - Check if PartNumber property is set. - - true if PartNumber property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the HeadObject response and response metadata. - - - - - Flag which returns true if the Expires property has been unmarshalled - from the raw value or set by user code. - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the - response. - - - - - - Gets and sets the AcceptRanges. - - - - - Gets and sets the ContentRange. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - Gets and sets the RestoreExpiration property. - RestoreExpiration will be set for objects that have been restored from Amazon Glacier. - It indiciates for those objects how long the restored object will exist. - - - - - Gets and sets the RestoreInProgress - Will be true when the object is in the process of being restored from Amazon Glacier. - - - - - Last modified date of the object - - - - - - An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL - - - - - - This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like - SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal - HTTP headers. - - - - - - Version of the object. - - - - - - The date and time at which the object is no longer cacheable. - - - - - - If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The status of the replication job associated with this source object. - - - - - Checks if ReplicationStatus property is set. - - true if ReplicationStatus property is set. - - - - The count of parts this object has. - - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - The Legal Hold status for the specified object. - - - - - - Gets and sets the property ObjectLockMode. - - The Object Lock mode currently in place for this object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - The date and time when this object's Object Lock will expire. - - - - - - The class of storage used to store the object. - - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the GetObject operation. - Retrieves objects from Amazon S3. - - - - - The bucket name containing the object. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - ETag to be matched as a pre-condition for returning the object, - otherwise a PreconditionFailed signal is returned. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or - ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Returns the object only if it has been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Returns the object only if it has been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - ETag that should not be matched as a pre-condition for returning the object, - otherwise a PreconditionFailed signal is returned. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or - UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Returns the object only if it has not been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Returns the object only if it has not been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Gets and sets the Key property. This is the user defined key that identifies the object in the bucket. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Downloads the specified range bytes of an object. - - - - - A set of response headers that should be returned with the object. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ResponseExpiresUtc instead. Setting either ResponseExpires or - ResponseExpiresUtc results in both ResponseExpires and ResponseExpiresUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ResponseExpires is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Sets the Expires header of the response. - - - - - Sets the Expires header of the response. - - - - - VersionId used to reference a specific version of the object. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to decrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - Part number of the object being read. This is a positive integer between 1 and 10,000. - Effectively performs a 'ranged' GET request for the part specified. Useful for downloading just a part of an object. - - - - - Checks if PartNumber property is set. - - true if PartNumber property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the GetObject response and response metadata. - - - - - Flag which returns true if the Expires property has been unmarshalled - from the raw value or set by user code. - - - - - Gets and sets the BucketName property. - - - - - Gets and sets the Key property. - - - - - Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the - response. - - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - Gets and sets the AcceptRanges. - - - - - Gets and sets the ContentRange. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - Gets and sets the RestoreExpiration property. - RestoreExpiration will be set for objects that have been restored from Amazon Glacier. - It indiciates for those objects how long the restored object will exist. - - - - - Gets and sets the RestoreInProgress - Will be true when the object is in the process of being restored from Amazon Glacier. - - - - - Last modified date of the object - - - - - - An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL - - - - - - This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like - SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal - HTTP headers. - - - - - - Version of the object. - - - - - - The date and time at which the object is no longer cacheable. - - - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - - - - Gets and sets the property ObjectLockMode. - - The Object Lock mode currently in place for this object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - The date and time when this object's Object Lock will expire. - - - - - - If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The class of storage used to store the object. - - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The status of the replication job associated with this source object. - - - - - Checks if ReplicationStatus property is set. - - true if ReplicationStatus property is set. - - - - The number of parts this oject has. - - - - - Checks if PartsCount is set. - - true if PartsCount property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - The number of tags, if any, on the object. - - - - - Writes the content of the ResponseStream a file indicated by the filePath argument. - - The location where to write the ResponseStream - - - - Writes the content of the ResponseStream a file indicated by the filePath argument. - - The location where to write the ResponseStream - Whether or not to append to the file if it exists - - - - The event for Write Object progress notifications. All - subscribers will be notified when a new progress - event is raised. - - - Subscribe to this event if you want to receive - put object progress notifications. Here is how:
- 1. Define a method with a signature similar to this one: - - private void displayProgress(object sender, WriteObjectProgressArgs args) - { - Console.WriteLine(args); - } - - 2. Add this method to the Put Object Progress Event delegate's invocation list - - GetObjectResponse response = s3Client.GetObject(request); - response.WriteObjectProgressEvent += displayProgress; - - - - - - This method is called by a producer of write object progress - notifications. When called, all the subscribers in the - invocation list will be called sequentially. - - The file being written. - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - True if transfer is complete - - - - Encapsulates the information needed to provide - download progress for the Write Object Event. - - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The bucket name for the S3 object being written. - The object key for the S3 object being written. - The version-id of the S3 object. - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - True if finished writing - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The bucket name for the S3 object being written. - The object key for the S3 object being written. - The file for the S3 object being written. - The version-id of the S3 object. - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - True if finished writing - - - - Gets the bucket name for the S3 object being written. - - - - - Gets the object key for the S3 object being written. - - - - - Gets the version-id of the S3 object. - - - - - The file for the S3 object being written. - - - - - True if writing is complete - - - - - Container for the parameters to the GetObjectRetention operation. - Retrieves an object's retention settings. - - - - - The bucket name containing the object whose retention settings you want to retrieve. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property Key. - - The key name for the object whose retention settings you want to retrieve. - - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property VersionId. - - The version ID for the object whose retention settings you want to retrieve. - - - - - - This is the response object from the GetObjectRetention operation. - - - - - Gets and sets the property Retention. - - The container element for an object's retention settings. - - - - - - Container for the parameters to the GetObjectTaggingRequest operation. - - - - - The bucket name containing the object for which to get the tagging information. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Check to see if Bucket property is set - - - - - Gets and sets the Key property. This is the user defined key that identifies the object in the bucket. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Check to see if Key property is set - - - - - VersionId used to reference a specific version of the object. - - - - - - Returns information about the GetObjectTagging response and response metadata. - - - - - Gets or sets tag-set for a given object - - - - - Container for the parameters to the GetObjectTorrent operation. - Return torrent files from a bucket. - - - - - The name of the bucket containing the object. - - - - - The key identifying the object. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the GetObjectTorrent response and response metadata. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - The parameters to create a pre-signed URL to a bucket or object. - - - For more information, refer to: . -
Required Parameters: BucketName, Expires -
Optional Parameters: Key, VersionId, Verb: default is GET - - - - - The name of the bucket to create a pre-signed url to, or containing the object. - - - - - Checks if BucketName property is set. - - true if BucketName property is set. - - - - The key to the object for which a pre-signed url should be created. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Checks if Key property is set. - - true if Key property is set. - - - - A standard MIME type describing the format of the object data. - - - - The content type for the content being uploaded. This property defaults to "binary/octet-stream". - For more information, refer to: . - - - Note that if content type is specified, it should also be included in the HttpRequest headers - of the eventual upload request, otherwise a signature error may result. - - - - - - The expiry date and time for the pre-signed url. - - - - - Checks if Expires property is set. - - true if Expires property is set. - - - - The requested protocol (http/https) for the pre-signed url. - - - Defaults to https. - - - - - The verb for the pre-signed url. - - - Accepted verbs are GET, PUT, DELETE and HEAD. - Default is GET. - - - - - Version id for the object that the pre-signed url will reference. If not set, - the url will reference the latest version of the object. - - - This is the VersionId for the S3 Object you want to get - a PreSigned URL for. The VersionId property will be ignored - for PreSigned "PUT" requests and for requests that don't specify - the Key property. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - The upload id for the multipart upload for which a pre-signed url should be created. - - - - - Checks if UploadId property is set. - - true if UploadId property is set. - - - - The part number for the multipart upload for which a pre-signed url should be created. - - - - - Checks if PartNumber property is set. - - true if PartNumber property is set. - - - - Specifies the encryption used on the server to store the content. - - - - Default is None. - - - If specifying encryption (not None), the corresponding request must include header - "x-amz-server-side-encryption" with the value of the encryption. - - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - Confirms that the requester knows that she or he will be charged for the request. - Bucket owners need not specify this parameter in their requests. - - - - - A set of response headers that should be returned with the pre-signed url creation response. - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - Custom parameters to include in the signed request, so that they are tamper-proof. - - - - - The parameters for a pre-signed URL to a bucket or object as a string. - - - For more information, refer to: . - - - - - The PreSignedURL as a string - - - - - Constructor - - A url returned from GetPreSignedUrlRequest - - - - Container for the parameters to the GetPublicAccessBlock operation. - Retrieves the Public Access Block configuration for an Amazon S3 bucket. - - - - - Gets and sets the property BucketName. - - The name of the Amazon S3 bucket whose Public Access Block configuration you want - to retrieve. - - - - - - This is the response object from the GetPublicAccessBlock operation. - - - - - The Public Access Block configuration currently in effect for this Amazon S3 bucket. - - - - - Container for the parameters to the HeadBucket operation. - This operation is useful to determine if a bucket exists and you have permission to access it. - - - - - Returns information about the HeadBucket response metadata. - The HeadBucket operation has a void result type. - - - - - This class contains the headers for an S3 object. - - - - - Gets and sets headers to set for the object. - - The name of the header - The value for the header - - - - Gets the count of headers. - - - - - Gets the names of the headers set. - - - - - Specifies caching behavior along the request/reply chain. - - - - - - Specifies presentational information for the object. - - - - - - Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type - referenced by the Content-Type header field. - - - - - - The size of the object, in bytes. - - - - - The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. This - header can be used as a message integrity check to verify that the data is the same data that was originally sent. - - - - - A standard MIME type describing the format of the object data. - - - - - - The date and time at which the object is no longer cacheable. - - - - - - - Container for the parameters to the InitiateMultipartUpload operation. - Initiates a multipart upload and returns an upload ID. - - - - - Envelope Key to Encrypt data - - - - - Encrypted Envelope Key to Encrypt data - - - - - Initialization Vector for encryption - - - - - Storage mode for encryption information. - - - - - A canned access control list (ACL) to apply to the object. - Please refer to for information on S3 Canned ACLs. - - - - - The name of the bucketName where the new object will be created, or existing object updated. - - - - - The key of the object to create or update. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - StorageClass property for the object. - - - Default: S3StorageClass.Standard. Set this property - only if you want reduced redundancy for this object. - Please refer to - for - information on S3 Storage Classes. - - - - - If the bucketName is configured as a website, redirects requests for this object to another object in the same bucketName or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - This is a convenience property for Headers.ContentType. - - - - - - Specifies the encryption to be used on the server for the new object. - - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - Checks if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - true if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - Specifies whether you want to apply a Legal Hold to the uploaded object. - - - - - - Gets and sets the property ObjectLockMode. - - Specifies the Object Lock mode that you want to apply to the uploaded object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - Specifies the date and time when you want the Object Lock to expire. - - - - - - The tag-set for the object. The tag-set must be encoded as URL Query parameters. - - - - - Checks if Tagging property is set - - true if Tagging is set. - - - - Returns information about the InitiateMultipartUpload response and response metadata. - - - - - Name of the bucketName to which the multipart upload was initiated. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Object key for which the multipart upload was initiated. - - - - - - Gets and sets the initiated multipart upload id. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - Date when multipart upload will become eligible for abort operation by lifecycle. - - - - - Id of the lifecycle rule that makes a multipart upload eligible for abort operation. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Identifies who initiated the multipart upload. - - - - - Name of the Principal. - - - - - - If the principal is an AWS account, it provides the Canonical User ID. If the principal is an IAM User, it provides a user ARN value. - - - - - - Describes the serialization format of the object. - - - - - Describes the serialization of a CSV-encoded object. - - - - - Specifies object's compression format. Valid values: NONE, GZIP. Default Value: NONE. - - - - - Specifies JSON as object's input serialization format. - - - - - Specifies Parquet as object's input serialization format. - - - - - Class for MetricsConfiguration - - - - - Contains information about where to publish the inventory results. - - - - - Specifies whether the inventory is enabled or disabled. - - - - - Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria. - - - - - The ID used to identify the inventory configuration. - - - - - Specifies which object version(s) to included in the inventory results. - - - - - Contains the optional fields that are included in the inventory results. - - - - - Specifies the schedule for generating inventory results. - - - - - Class for InventoryDestination - - - - - Contains the bucket name, file format, bucket owner (optional), and prefix (optional) where inventory results are published. - - - - - InventoryEncryption class - - - - - Specifies the use of SSE-S3 to encrypt delievered Inventory reports. - - - - - Specifies the use of SSE-KMS to encrypt delievered Inventory reports. - - - - - Class for InventoryFilter - - - - - Filter Predicate setup for specific filter types. - - - - - Filter Predicate abstract class for specific filter types to be derived from. - - - - - Class for InventoryPrefixPredicate - The prefix that an object must have to be included in the inventory results. - - - - - The ID of the account that owns the destination bucket. - - - - - The Amazon resource name (ARN) of the bucket where inventory results will be published. - - - - - The prefix that is prepended to all inventory results. - - - - - Specifies the output format of the inventory results. - - - - - Contains the type of server-side encryption used to encrypt the inventory results. - - - - - Class for InventorySchedule - - - - - Specifies how frequently inventory results are produced. - - - - - Specifies JSON as object's input serialization format. - - - - - The type of JSON. Valid values: Document, Lines. - - - - - Specifies JSON as request's output serialization format - - - - - The value used to separate individual records in the output. - - - - - Specifies an object key and optional object version. - - - - - Key name of the object to delete. - - - - - - VersionId for the specific version of the object to delete. - - - - - - This class contains the configuration Amazon S3 uses to figure out what events you want to listen - and send the event to an Amazon Lambda cloud function. - - - - - Gets and set the Id property. The Id will be provided in the event content and can be used - to identify which configuration caused an event to fire. If the Id is not provided for the configuration, one will be generated. - - - - - Gets and sets the FunctionArn property. This is the Amazon Lambda cloud function to which Amazon S3 will invoke with the events. - - - - Lifecycle Configuration - - - - - Gets and sets the Rules property. These rules defined the lifecycle configuration. - - - - - Base class for all the different predicates that can be used - in a filter. - - - - - This method is called by the visitor when it wants to visit the predicate. - - - - - - Filter identifying one or more objects to which a applies. - - - - - The predicate used by the filter. - - - - - Base class for lifecycle operators. - - - - - The list of objects - that this operator operates on. - - - - - The logical and operator for filtering objects for a - - - - - Accept a visit from an - - - This method is used internally by the SDK. - - - - - - A predicate that filters objects for a - by matching a particular prefix. - - - - - The prefix to be matched by filtered objects. - - - - - Accept a visit from an - - - This method is used internally by the SDK. - - - - - - A predicate that filters objects for a - by matching a particular key and value. - - - - - The Tag to be matched by filtered objects. - - - - - Accept a visit from an - - - This method is used internally by the SDK. - - - - - - Rules Item - - - - - Defines the length of time, in days, before objects expire. - - - - - Unique identifier for the rule. The value cannot be longer than 255 characters. - - - - - Prefix identifying one or more objects to which the rule applies. - - - - - - Filter identifying one or more objects to which the rule applies. - - - - - If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied. - - - - - - The transition rule that describes when objects transition to a different storage class. - - Lifecycle rules can now contain multiple transitions. This property is obsolete in favor of the Transitions property. - This property will always get or set the the zeroth element in the Transitions collection. - - - - - - Defines the length of time, in days, before noncurrent versions expire. - - - - - The transition rule that describes when noncurrent versions transition to - a different storage class. - - Lifecycle rules can now contain multiple noncurrent version transitions. This property - is obsolete in favor of the NoncurrentVersionTransitions property. - This property will always get or set the the zeroth element in the NoncurrentVersionTransitions collection. - - - - - - The transition rules that describe when objects transition to a different storage class. - - - - - The transition rules that describe when noncurrent versions transition to - a different storage class. - - - - - Specifies the days since the initiation of an Incomplete Multipart Upload - that Lifecycle will wait before permanently removing all parts of the upload. - - - - - Specifies the days since the initiation of an Incomplete Multipart Upload - that Lifecycle will wait before permanently removing all parts of the upload. - - - - - Indicates the number of days that must pass since initiation for Lifecycle - to abort an Incomplete Multipart Upload. - - - - Expiration - - - - - Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format. - - - - - - Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer. - - - - - - Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set to true, the delete marker will be expired; if set to false the policy takes no action. This cannot be specified with Days or Date in a Lifecycle Expiration Policy. - - - - - - Noncurrent Version Expiration - - - - - Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated - action. For information about the noncurrent days calculations, see - How Amazon S3 Calculates When an Object Became Noncurrent - in the Amazon Simple Storage Service Developer Guide. - - - - - LifecycleTransition defines when and how objects transition. - - - - - Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated - action. For information about the noncurrent days calculations, see - How Amazon S3 Calculates When an Object Became Noncurrent - in the Amazon Simple Storage Service Developer Guide. - - - - - The class of storage used to store the object. - - - - - - LifecycleTransition defines when and how objects transition. - - - - - Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format. - - - - - - Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer. - - - - - - The class of storage used to store the object. - - - - - - Container for the parameters to the ListInventoryConfigurationsRequest operation. - Lists the analytics configurations for the bucket. - - - - - The name of the bucket containing the analytics configurations to retrieve. - - - - - The ContinuationToken that represents a placeholder from where this request should begin. - - - - - Returns information about the ListBucketAnalyticsConfigurationsResponse response and response metadata. - - - - - The ContinuationToken that represents where this request began. - - - - - The list of analytics configurations for a bucket. - - - - - Indicates whether the returned list of analytics configurations is complete. - A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request. - - - - - NextContinuationToken is sent when isTruncated is true, which indicates that there are more analytics configurations to list. - The next request must include this NextContinuationToken. The token is obfuscated and is not a usable value. - - - - - Container for the parameters to the ListInventoryConfigurationsRequest operation. - Returns a list of inventory configurations for the bucket. - - - - - The name of the bucket containing the inventory configurations to retrieve. - - - - - The marker used to continue an inventory configuration listing that has been truncated. - Use the NextContinuationToken from a previously truncated list response to continue the listing. - The continuation token is an opaque value that Amazon S3 understands. - - - - - Returns information about the ListInventoryConfigurationsResponse response and response metadata. - - - - - If sent in the request, the marker that is used as a starting point for this inventory configuration list response. - - - - - The list of inventory configurations for a bucket. - - - - - Indicates whether the returned list of inventory configurations is truncated in this response. A value of true indicates that the list is truncated. - - - - - The marker used to continue this inventory configuration listing. Use the NextContinuationToken from this response to continue the listing in a subsequent request. - The continuation token is an opaque value that Amazon S3 understands. - - - - - Container for the parameters to the ListBucketMetricsConfigurationRequest operation. - Lists the metrics configurations for the bucket. - - - - - The name of the bucket containing the metrics configurations to retrieve. - - - - - - The marker that is used to continue a metrics configuration listing that has been truncated. - Use the NextContinuationToken from a previously truncated list response to continue the listing. - The continuation token is an opaque value that Amazon S3 understands. - - - - - - Returns information about the ListBucketMetricsConfiguration response and response metadata. - - - - - - The marker that is used to continue a metrics configuration listing that has been truncated. - Use the NextContinuationToken from a previously truncated list response to continue the listing. - The continuation token is an opaque value that Amazon S3 understands. - - - - - - The list of metrics configurations for a bucket. - - - - - - Indicates whether the returned list of metrics configurations is complete. - A value of true indicates that the list is not complete and the NextContinuationToken will be provided for - a subsequent request. - - - - - - - The marker used to continue a metrics configuration listing that has been truncated. - Use the NextContinuationToken from a previously truncated list response to continue the listing. - The continuation token is an opaque value that Amazon S3 understands. - - - - - - Container for the parameters to the ListBuckets operation. - Returns a list of all buckets owned by the authenticated sender of the request. - - - - - Returns information about the ListBuckets response and response metadata. - - - - - List of buckets. - - - - - Owner of the buckets. - - - - - Container for the parameters to the ListMultipartUploads operation. - This operation lists in-progress multipart uploads. - - - - - Name of the bucket to which the multipart upload was initiated. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Character you use to group keys. - - - - - - Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin. - - - - - - Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response body. 1,000 is the maximum number of uploads that - can be returned in a response. - - - - - - Lists in-progress uploads only for those keys that begin with the specified prefix. - - - - - - Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the - upload-id-marker parameter is ignored. - - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - Returns information about the ListMultipartUploads response and response metadata. - - - - - Name of the bucketName to which the multipart upload was initiated. - - - - - - The key at or after which the listing began. - - - - - - Upload ID after which listing began. - - - - - - When a list is truncated, this element specifies the value that should be used for the key-marker request parameter in a subsequent request. - - - - - - When a list is truncated, this element specifies the value that should be used for the upload-id-marker request parameter in a subsequent - request. - - - - - - Maximum number of multipart uploads that could have been included in the response. - - - - - - Indicates whether the returned list of multipart uploads is truncated. A value of true indicates that the list was truncated. The list can - be truncated if the number of multipart uploads exceeds the limit allowed or specified by max uploads. - - - - - - Gets and sets the MultipartUploads property. - - Container for elements related to a particular multipart upload. A response - can contain zero or more Upload elements. - - - - - - Gets and sets the Prefix property. - - - - - Gets and sets the Delimiter property. - - - - - Gets the CommonPrefixes property. - A response can contain CommonPrefixes only if you specify a delimiter. - When you do, CommonPrefixes contains all (if there are any) keys between - Prefix and the next occurrence of the string specified by delimiter. In effect, - CommonPrefixes lists keys that act like subdirectories in the directory specified - by Prefix. For example, if prefix is notes/ and delimiter is a slash (/), in - notes/summer/july, the common prefix is notes/summer/. - - - - - Container for the parameters to the ListObjects operation. - Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a - subset of the objects in a bucket. - - - - - The name of the bucket containing the objects whose keys are to be listed. - - - - - A delimiter is a character you use to group keys. - - - - - Specifies the key to start with when listing objects in a bucket. - - - - - Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more. - - - - - Limits the response to keys that begin with the specified prefix. - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the ListObjects response and response metadata. - - - - - A flag that indicates whether or not Amazon S3 returned all of the results that satisfied - the search criteria. - - - - - Gets and sets the NextMarker property. - NextMarker is set by S3 only if a Delimiter was specified - in the original ListObjects request. If a delimiter was - not specified, the AWS SDK for .NET returns the last Key - of the List of Objects retrieved from S3 as the NextMarker. - - - - - Gets the S3Objects property. This is a list of - objects in the bucket that match your search criteria. - - - - - Gets and sets the Name property which is the name of the bucket. - - - - - Gets and sets the Prefix property. - - - - - Gets and sets the MaxKeys property. This is max number of object keys returned by the list operation. - - - - - Gets the CommonPrefixes property. - A response can contain CommonPrefixes only if you specify a delimiter. - When you do, CommonPrefixes contains all (if there are any) keys between - Prefix and the next occurrence of the string specified by delimiter. In effect, - CommonPrefixes lists keys that act like subdirectories in the directory specified - by Prefix. For example, if prefix is notes/ and delimiter is a slash (/), in - notes/summer/july, the common prefix is notes/summer/. - - - - - Gets and sets the Delimiter property. - Causes keys that contain the same string between the prefix and the - first occurrence of the delimiter to be rolled up into a single result - element in the CommonPrefixes collection. - - - These rolled-up keys are not returned elsewhere in the response. - - - - - Container for the parameters to the ListObjects operation. - Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a - subset of the objects in a bucket. - - - - - Bucket name to list. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - A delimiter is a character you use to group keys. - - - - - Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more. - - - - - Limits the response to keys that begin with the specified prefix. - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts - listing after this specified key. StartAfter can be any key in the bucket. - Cannot be set at the same time as ContinuationToken. - - - - - ContinuationToken indicates Amazon S3 that the list is being continued on this - bucket with a token. ContinuationToken is obfuscated and is not a real key. - - - - - The owner field is not present in ListObjectsV2 responses by default. - If you want to return owner field with each key in the result then set this field to true. - If not specified, the Owner field on S3Object will be null. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the ListObjects response and response metadata. - - - - - A flag that indicates whether or not Amazon S3 returned all of the results that satisfied - the search criteria. - - - - - Gets and sets the S3Objects property. Metadata about each object returned. - - - - - Bucket name. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the Prefix property. - - - - - Gets and sets the MaxKeys property. This is max number of object keys returned by the list operation. - - - - - Gets and sets the CommonPrefixes property. - CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence - of the string specified by delimiter - - - - - Gets and sets the Delimiter property. - Causes keys that contain the same string between the prefix and the - first occurrence of the delimiter to be rolled up into a single result - element in the CommonPrefixes collection. - - - These rolled-up keys are not returned elsewhere in the response. - - - - - Encoding type used by Amazon S3 to encode object keys in the response. - - - - - KeyCount is the number of keys returned with this request. - KeyCount will always be less than or equal to MaxKeys field. - - - - - ContinuationToken indicates Amazon S3 that the list is being continued - on this bucket with a token. - ContinuationToken is obfuscated and is not a real key - - - - - NextContinuationToken is sent when isTruncated is true which means there - are more keys in the bucket that can be listed. The next ListObjectV2 call - to Amazon S3 can be continued with this NextContinuationToken. - NextContinuationToken is obfuscated and is not a real key. - - - - - StartAfter is where you want Amazon S3 to start listing from. - Amazon S3 starts listing after this specified key. - StartAfter can be any key in the bucket. - - - - - Container for the parameters to the ListParts operation. - Lists the parts that have been uploaded for a specific multipart upload. - - - - - Name of the bucket to which the parts are being uploaded. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The object key for which the multipart upload was initiated. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Sets the maximum number of parts to return. - - - - - - Specifies the part after which listing should begin. Only parts with higher part numbers will be listed. - - - - - - Upload ID identifying the multipart upload whose parts are being listed. - - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the ListParts response and response metadata. - - - - - Name of the bucketName to which the multipart upload was initiated. - - - - - - Object key for which the multipart upload was initiated. - - - - - - Upload ID identifying the multipart upload whose parts are being listed. - - - - - - Part number after which listing begins. - - - - - - When a list is truncated, this element specifies the last part in the list, as well as the value to use for the part-number-marker request - parameter in a subsequent request. - - - - - - Maximum number of parts that were allowed in the response. - - - - - - Indicates whether the returned list of parts is truncated. - - - - - - Gets and sets the Parts property. - - PartDetails is a container for elements related to a particular part. A response can contain - zero or more Part elements. - - - - - - Identifies who initiated the multipart upload. - - - - - - Gets and sets the Owner property. - - - - - The class of storage used to store the object. - - - - - - Date when multipart upload will become eligible for abort operation by lifecycle. - - - - - Id of the lifecycle rule that makes a multipart upload eligible for abort operation. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the ListVersions operation. - Returns metadata about all of the versions of objects in a bucket. - - - - - The bucket name that contains the objects. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - A delimiter is a character you use to group keys. - - - - - Specifies the key to start with when listing objects in a bucket. - - - - - Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more. - - - - - Limits the response to keys that begin with the specified prefix. - - - - - Specifies the object version you want to start listing from. - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - Returns information about the ListVersions response and response metadata. - - - - - A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria. If your results were - truncated, you can make a follow-up paginated request using the NextKeyMarker and NextVersionIdMarker response parameters as a starting - place in another request to return the rest of the results. - - - - - - Marks the last Key returned in a truncated response. - - - - - - Gets and sets the VersionIdMarker property. - Marks the last Version-Id returned in a truncated response. - - - - - Use this value for the key marker request parameter in a subsequent request. - - - - - - Use this value for the next version id marker parameter in a subsequent request. - - - - - - Gets and sets the Versions property. This is a list of - object versions in the bucket that match your search criteria. - - - - - Gets and sets the Name property. - The bucket's name. - - - - - Gets and sets the Prefix property. - Keys that begin with the indicated prefix are listed. - - - - - Gets and sets the MaxKeys property. - This is the maximum number of keys in the S3ObjectVersions collection. - The value is derived from the MaxKeys parameter to ListVersionsRequest. - - - - - Gets the CommonPrefixes property. - A response can contain CommonPrefixes only if you specify a delimiter. - When you do, CommonPrefixes contains all (if there are any) keys between - Prefix and the next occurrence of the string specified by delimiter. - - - - - Gets and sets the Delimiter property. - Causes keys that contain the same string between the prefix and the - first occurrence of the delimiter to be rolled up into a single result - element in the CommonPrefixes collection. - - - These rolled-up keys are not returned elsewhere in the response. - - - - - This class contains the meta data for an S3 object. - - - - - Gets and sets meta data for the object. Meta data names must start with "x-amz-meta-". If the name passeed in as the indexer - doesn't start with "x-amz-meta-" then it will be prepended. - - The name of the meta data. - The value for the meta data - - - - Adds the metadata to the collection, if the name already exists it will be overwritten. - - The name of the metadata element - The value for the metadata - - - - Gets the count of headers. - - - - - Gets the names of the meta data elements. - - - - - A metadata key-value pair to store with an object. - - - - - Key of metadata key-value pair - - - - - Value of metadata key-value pair - - - - - A container specifying replication metrics-related information, including whether - emitting metrics and Amazon S3 events for replication are enabled. In addition, contains - configurations related to specific metrics or events. Must be specified together with a - ReplicationTime block. - - - - - Specifies whether the replication metrics are enabled. - - - - - A container specifying the time threshold for emitting the - s3:Replication:OperationMissedThreshold event. - - - - - Class for MetricsAndOperatorPredicate - A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. - The operator must have at least two predicates, and an object must match all of the predicates - in order for the filter to apply. - - Note: The current implementation restricts the usage to atmost one MetricsPrefixPredicate - and any number of MetricsTagPredicates. - - - - Class for MetricsConfiguration - - - - - The ID used to identify the metrics configuration. - - - - - Specifies a metrics configuration filter. - The metrics configuration will only include objects that meet the filter's criteria. - A filter must be a prefix, a tag, or a conjunction (MetricsAndOperator). - - - - - Filter class for Metrics. - - - - - Filter Predicate setup for specific filter types. - - - - - Filter Predicate abstract class for specific filter types to be derived from. - - - - - Abstract class that can be used over logical filter predicates,i.e. AND/OR. - - - - - Class for MetricsPrefixPredicate - The prefix used when evaluating a metrics filter. - - - - - Class for MetricsTagPredicate - The tag used when evaluating a metrics filter. - - - - - This class contains the mfa codes used authentication - - - - - Gets and sets the serial number of the authentication device - - - - - Gets and sets the displated value on the authentication device - - - - - The formatted string of the mfa codes to be passed to S3. - - - - - Container for elements related to a particular multipart upload. - - - - - Date and time at which the multipart upload was initiated. - - - - - - Identifies who initiated the multipart upload. - - - - - - Key of the object for which the multipart upload was initiated. - - - - - - Gets and sets the Owner property. - - - - - The class of storage used to store the object. - - - - - - Upload ID that identifies the multipart upload. - - - - - - An abstract class for all the notification configurations associated with an Amazon S3 bucket. - - - - - Gets and sets the Events property. These are the events the configuration will listen to. - - - - - Filter criteria for determining which S3 objects trigger event notifications. - - - - - - The container element for Object Lock configuration parameters. - - - - - Gets and sets the property ObjectLockEnabled. - - Indicates whether this object has an Object Lock configuration enabled. - - - - - - Gets and sets the property Rule. - - The Object Lock rule in place for the specified object. - - - - - - A Legal Hold configuration for an object. - - - - - Gets and sets the property Status. - - Indicates whether the specified object has a Legal Hold in place. - - - - - - A Retention configuration for an object. - - - - - Gets and sets the property Mode. - - Indicates the Retention mode for the specified object. - - - - - - Gets and sets the property RetainUntilDate. - - - - - The container element for an Object Lock rule. - - - - - Gets and sets the property DefaultRetention. - - The default retention period that you want to apply to new objects placed in the specified - bucket. - - - - - - Describes the location where the restore job's output is stored. - - - - - Describes an S3 location that will receive the results of the restore request. - - - - - Describes how results of the Select job are serialized. - - - - - Describes the serialization of CSV-encoded Select results. - - - - - Specifies JSON as request's output serialization format. - - - - - The owner of an S3 bucket. - - - - - The display name of the owner. - - - - - The unique identifier of the owner. - - - - - This class contains custom querystring parameters for an S3 object, which can then be signed as part of a Pre-signed URL request - - - - - Gets and sets parameters for the object. Parameter names must start with "x-". If the name passeed in as the indexer - doesn't start with "x-" then it will be prepended. - - The name of the parameter. - The value for the meta data - - - - Adds the parameter to the collection, if the name already exists it will be overwritten. - - The name of the parameter - The value for the parameter - - - - Gets the count of parameters. - - - - - Gets the names of the parameter elements. - - - - - Specifies Parquet as object's input serialization format. - - - - - A container for elements related to a particular part in a multipart operation. - A response can contain zero or more Part elements. - - - - - The date and time at which the part was uploaded. - - - - - The size of the uploaded part data. - - - - - A container holding the part number and etag used when completing a multipart upload. - - - - - Default constructor. - - - - - Constructs an instance of PartETag and sets the part number and etag. - - The part number. - the associated ETag for the part number. - - - - Compares the current object with another object of the same type. - - An object to compare with this object. - - A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has the following meanings: - Value - Meaning - Less than zero - This object is less than the parameter. - Zero - This object is equal to . - Greater than zero - This object is greater than . - - - - - The part number identifying the part. - - - - - The entity tag associated with the part. - - - - - The container element for this bucket's public-policy status. - - - - - Gets and sets the property IsPublic. - - The public-policy status for this bucket. TRUE indicates that this bucket - is public. FALSE indicates that the bucket is not public. - - - - - - The container element for all Public Access Block configuration options. You can enable - the configuration options in any combination. - - - - Amazon S3 considers a bucket policy public unless at least one of the following conditions - is true: - -
  1. - - The policy limits access to a set of CIDRs using aws:SourceIp. For more - information on CIDR, see http://www.rfc-editor.org/rfc/rfc4632.txt - - -
  2. - - The policy grants permissions, not including any "bad actions," to one of the following: - -
    • - - A fixed AWS principal, user, role, or service principal - -
    • - - A fixed aws:SourceArn - -
    • - - A fixed aws:SourceVpc - -
    • - - A fixed aws:SourceVpce - -
    • - - A fixed aws:SourceOwner - -
    • - - A fixed aws:SourceAccount - -
    • - - A fixed value of s3:x-amz-server-side-encryption-aws-kms-key-id - -
    • - - A fixed value of aws:userid outside the pattern "AROLEID:*" - -
- - "Bad actions" are those that could expose the data inside a bucket to reads or writes - by the public. These actions are s3:Get*, s3:List*, s3:AbortMultipartUpload, - s3:Delete*, s3:Put*, and s3:RestoreObject. - - - - The star notation for bad actions indicates that all matching operations are considered - bad actions. For example, because s3:Get* is a bad action, s3:GetObject, - s3:GetObjectVersion, and s3:GetObjectAcl are all bad actions. - - - - - - Gets and sets the property BlockPublicAcls. - - Specifies whether Amazon S3 should block public ACLs for this bucket. Setting this - element to TRUE causes the following behavior: - -
  • - - PUT Bucket acl and PUT Object acl calls will fail if the specified ACL allows public - access. - -
  • - - PUT Object calls will fail if the request includes an object ACL. - -
- - Note that enabling this setting doesn't affect existing policies or ACLs. - - - - - - Gets and sets the property IgnorePublicAcls. - - Specifies whether Amazon S3 should ignore public ACLs for this bucket. Setting this - element to TRUE causes Amazon S3 to ignore all public ACLs on this bucket - and any objects that it contains. - - - - Note that enabling this setting doesn't affect the persistence of any existing ACLs - and doesn't prevent new public ACLs from being set. - - - - - - Gets and sets the property BlockPublicPolicy. - - Specifies whether Amazon S3 should block public bucket policies for this bucket. Setting - this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy - if the specified bucket policy allows public access. - - - - Note that enabling this setting doesn't affect existing bucket policies. - - - - - - Gets and sets the property RestrictPublicBuckets. - - Specifies whether Amazon S3 should restrict public bucket policies for this bucket. - If this element is set to TRUE, then only the bucket owner and AWS Services - can access this bucket if it has a public policy. - - - - Note that enabling this setting doesn't affect previously stored bucket policies, - except that public and cross-account access within any public bucket policy, including - non-public delegation to specific accounts, is blocked. - - - - - - Container for the parameters to the PutAcl operation. - uses the acl subresource to set the access control list (ACL) permissions for an object that already exists in a bucket - - - - - The canned ACL to apply to the bucket. - - - - - - Custom ACLs to be applied to the bucket or object. - - - - - The bucket name that contains the object to which you want to attach the ACL. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The key of an S3 object. - If not specified, the ACLs are applied to the bucket. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - If set and an object key has been specified, the ACLs are applied - to the specific version of the object. - This property is ignored if the ACL is to be set on a Bucket. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - Returns information about the PutObjectAcl response metadata. - The PutAcl operation has a void result type. - - - - - The response for the PutBucketAccelerateConfiguration operation. - Adds an object to a bucket. - - - - - Container for the parameters to the PutBucketAccelerateConfiguration request. - - - - - The name of the bucket to contain the object. - - - - - Accelerate configuration for the bucket. - - - - - Container for the parameters to the PutBucketAnalyticsConfiguration operation. - Sets an analytics configuration for the bucket (specified by the analytics configuration ID). - - - - - The name of the bucket to which an analytics configuration is stored. - - - - - The identifier used to represent an analytics configuration. - - - - - The configuration and any analyses for the analytics filter. - - - - - Returns information about the PutBucketAnalyticsConfigurationResponse response metadata. - The PutBucketAnalyticsConfigurationResponse operation has a void result type. - - - - - Container for the parameters to the PutBucketRequestPayment operation. - Creates a new server-side encryption configuration (or replaces an existing one, if present). - - - - - The name of the bucket for which the server-side encryption configuration is set. - - - - - The base64-encoded 128-bit MD5 digest of the server-side encryption configuration. - - - This header can be used as a message integrity check to verify that the data is the same data that was originally sent. - Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. - - - - - Container for server-side encryption configuration rules. Currently S3 supports one rule only. - - - - - Container for the parameters to the PutBucketRequestPayment operation. - Adds an inventory configuration (identified by the inventory ID) from the bucket. - - - - - The name of the bucket where the inventory configuration will be stored. - - - - - Specifies the inventory Id. - - - - - Specifies the inventory configuration. - - - - - Returns information about the PutInventoryConfigurationResponse response metadata. - The PutInventoryConfigurationResponse operation has a void result type. - - - - - Container for the parameters to the PutBucketLoggingRequest operation. - Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. To set the - logging status of a bucket, you must be the bucket owner. - - - - - Gets and sets the BucketName property. - - - - - Gets and sets the LoggingConfig property. - - - - - Returns information about the PutBucketLogging response metadata. - The EnableBucketLogging operation has a void result type. - - - - - Container for the parameters to the PutBucketMetricsConfigurationRequest operation. - Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. - - - - - The name of the bucket for which the metrics configuration is set. - - - - - The ID used to identify the metrics configuration. - - - - - Specifies the metrics configuration. - - - - - Returns information about the PutBucketMetricsConfiguration response metadata. - The PutBucketMetricsConfiguration operation has a void result type. - - - - - Container for the parameters to the PutBucketNotification operation. - Enables notifications of specified events for a bucket. - - - - - Gets and sets the BucketName property. - - - - - Gets and sets the TopicConfigurations property. TopicConfigurations are configuration for Amazon S3 - events to be sent to Amazon SNS topics. - - - - - Gets and sets the QueueConfigurations property. QueueConfigurations are configuration for Amazon S3 - events to be sent to Amazon SQS queues. - - - - - Gets and sets the LambdaFunctionConfigurations property. LambdaFunctionConfigurations are configuration for - Amazon S3 events to be sent to an Amazon Lambda cloud function. - - - - - Returns information about the PutBucketNotification response metadata. - The PutBucketNotification operation has a void result type. - - - - - Container for the parameters to the PutBucketPolicy operation. - Replaces a policy on a bucket. If the bucket already has a policy, the one in this request completely replaces it. - - - - - The name of the bucket. - - - - - The base64 encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. - - - This header can be used as a message integrity check to verify that the data is the same data that was originally sent. - Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. - - - - - The bucket policy as a JSON document. - - - - - Set this parameter to true to confirm that you want to remove your - permissions to change this bucket policy in the future. - - - - - Overriden to turn off sending SHA256 header. - - - - - Returns information about the PutBucketPolicy response metadata. - The PutBucketPolicy operation has a void result type. - - - - - Container for the parameters to the PutBucketReplication operation. - Sets replication configuration for your bucket. If a replication configuration exists, this replaces it. - - - - - The name of the bucket to have the replication configuration applied. - - - - - The replication configuration to be applied. - - - - - Gets and sets the property Token. - - - - - Returns information about the PutBucketReplicationConfiguration response metadata. - The PutBucketReplicationConfiguration operation has a void result type. - - - - - Container for the parameters to the PutBucket operation. - Creates a new bucket. - - - - - The canned ACL to apply to the bucket. - - - - - - If set to true the bucket will be created in the same region - as the configuration of the AmazonS3 client. - If PutBucketRequest.BucketRegion or PutBucketRequest.BucketRegionName are set they take precedence over - this property. - Default: true. - - - - - The name of the bucket to be created. - - - - - The region locality for the bucket. - - - When set, this will determine where your data will - reside in S3. Refer - for a list of possible values. - - - - - The bucket region locality expressed using the name of the region. - When set, this will determine where your data will reside in S3. - Valid values: us-east-1, us-west-1, us-west-2, eu-west-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, sa-east-1 - - - - - Gets and sets the property ObjectLockEnabledForBucket. - - Specifies whether you want S3 Object Lock to be enabled for the new bucket. - - - - - - Container for the parameters to the PutBucketRequestPayment operation. - Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This - configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the - download. - - - - - The name of the bucket to set payment config. - - - - - Gets and sets request payment configuration - - - - - Returns information about the PutBucketRequestPayment response metadata. - The PutBucketRequestPayment operation has a void result type. - - - - - Returns information about the PutBucket response and response metadata. - - - - - Container for the parameters to the PutBucketTagging operation. - Sets the tags for a bucket. - - - - - The name of the bucket to apply the tags to. - - - - - The collection of tags. - - - - - Returns information about the PutBucketTagging response metadata. - The PutBucketTagging operation has a void result type. - - - - - Container for the parameters to the PutBucketVersioning operation. - Sets the versioning state of an existing bucket. To set the versioning state, you must be the bucket owner. - - - - - The name of the bucket to be updated. - - - - - The MfaCodes Tuple associates the Serial Number and the current Token/Code displayed on the - Multi-Factor Authentication device associated with your AWS Account. - - - This is a required property for this request if:
- 1. EnableMfaDelete was configured on the bucket - containing this object's version.
- 2. You are deleting an object's version - - - - - Checks if the MfaCodes property is set. - - true if the MfaCodes property is set. - - - - The versioning configuration to apply to the bucket. - - - Once Versioning has been "Enabled" on a bucket, it can be "Suspended" - but cannot be switched "Off". If EnableMfaDelete is set, - the MfaCodes property needs to contain the Serial of and current Token - displayed on the MFA device. - - - - - Returns information about the PutBucketVersioning response metadata. - The PutBucketVersioning operation has a void result type. - - - - - Container for the parameters to the PutBucketWebsite operation. - Set the website configuration for a bucket. - - - - - The name of the bucket to apply the configuration to. - - - - - The website configuration to apply. The configuration defines the index - document suffix and custom error page. - - - - - Returns information about the PutBucketWebsite response metadata. - The PutBucketWebsite operation has a void result type. - - - - - Container for the parameters to the PutCORSConfiguration operation. - Sets the cors configuration for a bucket. - - - - - The name of the bucket to have the CORS configuration applied. - - - - - The CORS configuration to apply. - - - - - Returns information about the PutCORSConfiguration response metadata. - The PutCORSConfiguration operation has a void result type. - - - - - Container for the parameters to the PutLifecycleConfiguration operation. - Sets lifecycle configuration for your bucket. If a lifecycle configuration exists, it replaces it. - - - - - The name of the bucket to have the lifecycle configuration applied. - - - - - The lifecycle configuration to be applied. - - - - - Returns information about the PutLifecycleConfiguration response metadata. - The PutLifecycleConfiguration operation has a void result type. - - - - - Container for the parameters to the PutObjectLegalHold operation. - Applies a Legal Hold configuration to the specified object. - - - - - The bucket name containing the object that you want to place a Legal Hold on. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property ContentMD5. - - The MD5 signature for the configuration included in your request. - - - - - - Gets and sets the property Key. - - The key name for the object that you want to place a Legal Hold on. - - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Gets and sets the property LegalHold. - - Container element for the Legal Hold configuration you want to apply to the specified - object. - - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property VersionId. - - The version ID of the object that you want to place a Legal Hold on. - - - - - - This is the response object from the PutObjectLegalHold operation. - - - - - Gets and sets the property RequestCharged. - - - - - Container for the parameters to the PutObjectLockConfiguration operation. - Places an Object Lock configuration on the specified bucket. The rule specified in - the Object Lock configuration will be applied by default to every new object placed - in the specified bucket. - - - - - Gets and sets the property BucketName. - - The bucket whose Object Lock configuration you want to create or replace. - - - - - - Gets and sets the property ContentMD5. - - The MD5 signature for the configuration included in your request. - - - - - - Gets and sets the property ObjectLockConfiguration. - - The Object Lock configuration that you want to apply to the specified bucket. - - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property Token. - - - - - This is the response object from the PutObjectLockConfiguration operation. - - - - - Gets and sets the property RequestCharged. - - - - - Container for the parameters to the PutObject operation. - Adds an object to a bucket. - - - Container for the parameters to the PutObject operation. - Adds an object to a bucket. - - - - - A canned access control list (CACL) to apply to the object. - Please refer to for - information on S3 Canned ACLs. - - - - - Input stream for the request; content for the request will be read from the stream. - - - - - - The full path and name to a file to be uploaded. - If this is set the request will upload the specified file to S3. - - - For WinRT and Windows Phone this property must be in the form of "ms-appdata:///local/file.txt". - - - - - - Text content to be uploaded. Use this property if you want to upload plaintext to S3. - The content type will be set to 'text/plain'. - - - - - If this value is set to true then the stream used with this request will be closed when all the content - is read from the stream. - Default: true. - - - - - If this value is set to true then the stream will be seeked back to the start before being read for upload. - Default: true. - - - - - If this value is set to true then a chunked encoding upload will be used for the request. - Default: true. - - - - - Bucket name to which the PUT operation was initiated. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - Gets and sets Key property. This key is used to identify the object in S3. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - Checks if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - true if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - - - The type of storage to use for the object. Defaults to 'STANDARD'. - - - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - The Legal Hold status that you want to apply to the specified object. - - - - - - Gets and sets the property ObjectLockMode. - - The Object Lock mode that you want to apply to this object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - The date and time when you want this object's Object Lock to expire. - - - - - - If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - Attach a callback that will be called as data is being sent to the AWS Service. - - - - - This is a convenience property for Headers.ContentType. - - - - - An MD5 digest for the content. - - - - The base64 encoded 128-bit MD5 digest of the message - (without the headers) according to RFC 1864. This header - can be used as a message integrity check to verify that - the data is the same data that was originally sent. - - - If supplied, after the file has been uploaded to S3, - S3 checks to ensure that the MD5 hash of the uploaded file - matches the hash supplied. - - - Although it is optional, we recommend using the - Content-MD5 mechanism as an end-to-end integrity check. - - - - - - Checks if MD5Digest property is set. - - true if MD5Digest property is set. - - - - Overriden to turn off sending SHA256 header. - - - - - Overriden to turn on expect 100 continue. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - The tag-set for the object. The tag-set must be encoded as URL Query parameters. - - - - - Checks if Tagging property is set - - true if Tagging is set. - - - - Overrides the default request timeout value. - - - - If the value is set, the value is assigned to the Timeout property of the HTTPWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Overrides the default ReadWriteTimeout value. - - - - If the value is set, the value is assigned to the ReadWriteTimeout property of the HTTPWebRequest/WebRequestHandler object used - to send requests. - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - - Returns information about the PutObject response and response metadata. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - Entity tag for the uploaded object. - - - - - - Version of the object. - - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the PutObjectRetention operation. - Places an Object Retention configuration on an object. - - - - - The bucket name that contains the object you want to apply this Object Retention configuration to. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property BypassGovernanceRetention. - - - - - Gets and sets the property ContentMD5. - - The MD5 signature for the configuration included in your request. - - - - - - Gets and sets the property Key. - - The key name for the object that you want to apply this Object Retention configuration - to. - - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property Retention. - - The container element for the Object Retention configuration. - - - - - - Gets and sets the property VersionId. - - The version ID for the object that you want to apply this Object Retention configuration - to. - - - - - - This is the response object from the PutObjectRetention operation. - - - - - Gets and sets the property RequestCharged. - - - - - Container for the parameters to the PutObjectTagging operation. - - - - - The bucket name containing the object. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Check to see if Bucket property is set - - - - - Gets and sets Key property. This key is used to identify the object in S3. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Check to see if Key property is set - - - - - The tag-set for the object. The tag-set must be encoded as URL Query parameters - - - - - Checks if Tagging property is set. - - - - - VersionId used to reference a specific version of the object. - - - - - - Returns information about the PutObjectTagging response and response metadata. - - - - - Version of the object. - - - - - Container for the parameters to the PutPublicAccessBlock operation. - Creates or modifies the Public Access Block configuration for an Amazon S3 bucket. - - - - - Gets and sets the property BucketName. - - The name of the Amazon S3 bucket whose Public Access Block configuration you want - to set. - - - - - - Gets and sets the property ContentMD5. - - The MD5 hash of the PutPublicBlock request body. - - - - - - Gets and sets the property PublicAccessBlockConfiguration. - - The Public Access Block configuration that you want to apply to this Amazon S3 bucket. - - - - - - This is the response object from the PutPublicAccessBlock operation. - - - - - Base class for put operations that can also put an ACL. - - - - - Gets the access control lists (ACLs) for this request. - Please refer to for information on - S3 Grants. - - - - - This class contains the configuration Amazon S3 uses to figure out what events you want to listen - and send the event to an Amazon SQS queue. - - The queue's policy must allow S3 to send messages to it. The utility method - Amazon.SQS.AmazonSQSClient.AuthorizeS3ToSendMessage(string,string) - can be used to help setup the queue policy. - - - - - - Gets and set the Id property. The Id will be provided in the event content and can be used - to identify which configuration caused an event to fire. If the Id is not provided for the configuration, one will be generated. - - - - - Gets and sets the Queue property. Amazon SQS queue to which Amazon S3 will publish a message - to report the specified events for the bucket. - - The queue's policy must allow S3 to send messages to it. The utility method - Amazon.SQS.AmazonSQSClient.AuthorizeS3ToSendMessage(string,string) - can be used to help setup the queue policy. - - - - - - This class defines the configuration for replication. - - - - - Indicates the ARN of the role to assume. - - - - - Check to see if the Role property is set. - - true if the Role property is set. - - - - Container for information about a particular replication rule. - Replication configuration must have at least one rule and can contain up to 1,000 rules. - - - - - Checks to see if the Rules property is set. - - true if the Rules property is set. - - - - Destination configuration for a replication rule. - - - - -

Amazon resource name (ARN) of the bucket where you want Amazon - S3 to store replicas of the object identified by the rule.

- If you have multiple rules in your replication configuration, all - rules must specify the same bucket as the destination. A replication - configuration can replicate objects only to one destination bucket.

- - - - - Checks to see if BucketArn property is set. - - true if BucketArn property is set. - - - - The class of storage used to store the object. - - - - - -

Account ID of the destination bucket. Currently Amazon S3 verifies this - value only if Access Control Translation is enabled.

In a cross-account - scenario, if you tell Amazon S3 to change replica ownership to the AWS account - that owns the destination bucket by adding the AccessControlTranslation - element, this is the account ID of the destination bucket owner.

- - - - -

Container for information regarding the access control for replicas.

-

Use only in a cross-account scenario, where source and destination bucket - owners are not the same, when you want to change replica ownership to the AWS - account that owns the destination bucket. If you don't add this element to the - replication configuration, the replicas are owned by same AWS account that - owns the source object.

- - - - -

Container that provides encryption-related information. You must - specify this element if the SourceSelectionCriteria is - specified.

- - - - - A container specifying the time when all objects and operations on objects are - replicated. Must be specified together with a Metrics block. - - - - - A container specifying replication metrics-related information, including whether - emitting metrics and Amazon S3 events for replication are enabled. In addition, - contains configurations related to specific metrics or events. Must be specified - together with a ReplicationTime block. - - - - - Rule that specifies the replication configuration. - - - - - Unique identifier for the rule. The value cannot be longer than 255 characters. - - - - - Checks to see if Id property is set. - - true if Id property is set. - - - -

The priority associated with the rule. If you specify multiple rules in a - replication configuration, then Amazon S3 applies rule priority in the event - there are conflicts (two or more rules identify the same object based on - filter specified). The rule with higher priority takes precedence. For - example,

  • Same object quality prefix based filter criteria - If prefixes you specified in multiple rules overlap.

  • Same - object qualify tag based filter criteria specified in multiple rules

    • -

For more information, see - - Cross-Region Replication (CRR) in the Amazon S3 Developer Guide.

- - - - - Checks to see if Priority property is set. - - true if Priority property is set. - - - - Object keyname prefix identifying one or more objects to which the - rule applies. Maximum prefix length can be up to 1,024 characters. - - - - - Checks to see if Prefix property is set. - - true if Prefix property is set. - - - - Gets and sets the property Filter. - - - - - Checks to see if Filter property is set. - - true if Filter property is set. - - - - Whether the rule is applied or ignored. - - - - - Checks to see if Status property is set. - - true if Status property is set. - - - - Container for replication destination information. - - - - - Checks to see if Destination property is set. - - true if Destination property is set. - - - -

Container that describes additional filters in identifying source objects that - you want to replicate. Currently, Amazon S3 supports only the filter that you can - specify for objects created with server-side encryption using an AWS KMS-managed - key. You can choose to enable or disable replication of these objects.

if - you want Amazon S3 to replicate objects created with server-side encryption using - AWS KMS-managed keys.

- - - - - A container that specifies information about existing object replication. - You can choose whether to enable or disable the replication of existing objects. - - - - - Checks to see if ExistingObjectReplication property is set. - - true if ExistingObjectReplication property is set. - - - - Specifies whether Amazon S3 should replicate delete makers. - - - - - Checks to see if DeleteMarkerReplication property is set. - - true if DeleteMarkerReplication property is set. - - - - - - - - Object keyname prefix that identifies subset of objects to which the rule applies. - - - - - Checks to see if Prefix property is set. - - true if Prefix property is set. - - - - All of these tags must exist in the object's tag set in order for the rule to apply. - - - - - Checks to see if Tags property is set. - - true if Tags property is set. - - - - Filter that identifies subset of objects to which the replication rule applies. - A Filter must specify exactly one Prefix, - Tag, or an And child element. - - - - - Object keyname prefix that identifies subset of objects to which the rule applies. - - - - - Checks to see if Prefix property is set. - - true if Prefix property is set. - - - -

Container for specifying a tag key and value.

-

The rule applies only to objects having the tag in its tagset.

- - - - - Checks to see if Tag property is set. - - true if Tag property is set. - - - -

Container for specifying rule filters. These filters determine the - subset of objects to which the rule applies. The element is required - only if you specify more than one filter. For example:

  • -

    You specify both a Prefix and a Tag - filters. Then you wrap these in an And tag.

    • -

  • You specify filter based on multiple tags. Then you wrap the - Tag elements in an And tag.

- - - - - Checks to see if And property is set. - - true if And property is set. - - - - A container specifying the time when all objects and operations on objects are replicated. Must be specified together with a Metrics block. - - - - - Specifies whether the replication time is enabled. - - - - - A container specifying the time by which replication should complete for all objects and operations on objects. - - - - - A container specifying the time value. - - - - - Contains an integer specifying time in minutes. - - - - - Request Payment Configuration - - - - - Specifies who pays for the download and request fees. - - - - - Container for values of the response headers that will be set on a response from a GetObject request. - These values override any headers that were set when the object was uploaded to S3. - - - - - A standard MIME type describing the format of the object data. - - - The content type for the content being uploaded. This property defaults to "binary/octet-stream". - For more information, refer to: - - - - - ContentLanguage header value. - - - - - Expiry header value. - - - - - CacheControl header value. - - - - - The ContentDisposition header value. - - - - - The ContentEncoding header value. - - - - - Container for the parameters to the RestoreObject operation. - Restores an archived copy of an object back into Amazon S3 - - - - - The bucket name or containing the object to restore. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the Key property. This key indicates the S3 object to restore. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Lifetime of the active copy in days - ** Do not use with restores that specify OutputLocation ** - - - - - VersionId used to reference a specific version of the object. - - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Glacier retrieval tier at which the restore will be processed. - ** Do not use with restores that specify OutputLocation ** - - - - - Glacier retrieval tier at which the restore will be processed. - ** Only use with restores that require OutputLocation ** - - - - - Type of restore request. - - - - - The optional description for the job. - - - - - Describes the parameters for Select job types. - - - - - Describes the location where the restore job's output is stored. - - - - - Returns information about the RestoreObject response metadata. - The RestoreObject operation has a void result type. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Indicates the path in the provided S3 output location where Select results will be restored to. - - - - Routing Rule - - - - - A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the - /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might - process the error. - - - - - - Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event of an - error, you can can specify a different error code to return. - - - - - - A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages - in the /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you - might process the error. - - - - - The HTTP error code when the redirect is applied. In the event of an error, if the error code equals this value, then the specified redirect - is applied. Required when parent element Condition is specified and sibling KeyPrefixEquals is not specified. If both are specified, then - both must be true for the redirect to be applied. - - - - - - The object key name prefix when the redirect is applied. For example, to redirect requests for ExamplePage.html, the key prefix will be - ExamplePage.html. To redirect request for all pages with the prefix docs/, the key prefix will be /docs, which identifies all objects in the - docs/ folder. Required when the parent element Condition is specified and sibling HttpErrorCodeReturnedEquals is not specified. If both - conditions are specified, both must be true for the redirect to be applied. - - - - - - Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event - of an error, you can can specify a different error code to return. - - - - - Name of the host where requests will be redirected. - - - - - - The HTTP redirect code to use on the response. Not required if one of the siblings is present. - - - - - - Protocol to use (http, https) when redirecting requests. The default is the protocol that is used in the original request. - - - - - - The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix docs/ (objects in the - docs/ folder) to documents/, you can set a condition block with KeyPrefixEquals set to docs/ and in the Redirect set ReplaceKeyPrefixWith to - /documents. Not required if one of the siblings is present. Can be present only if ReplaceKeyWith is not provided. - - - - - - The specific object key to use in the redirect request. For example, redirect request to error.html. Not required if one of the sibling is - present. Can be present only if ReplaceKeyPrefixWith is not provided. - - - - - - Represents an access control list (ACL) for S3. An AccessControlList is represented by an Owner, - and a List of Grants, where each Grant is a Grantee and a Permission. - - - - Each bucket and object in Amazon S3 has an ACL that defines its access control policy. - When a request is made, Amazon S3 authenticates the request using its standard - authentication procedure and then checks the ACL to verify the sender was granted access - to the bucket or object. If the sender is approved, the request proceeds. - Otherwise, Amazon S3 returns an error. - - - An ACL is a list of grants. A grant consists of one grantee and one permission. - ACLs only grant permissions; they do not deny them. - - - For convenience, some commonly used Access Control Lists are defined in - S3CannedACL. - - - Note: BucketName and object ACLs are completely independent; an object does not inherit the ACL - from its bucket. For example, if you create a bucket and grant write access to another user, - you will not be able to access the user's objects unless the user explicitly grants access. - This also applies if you grant anonymous write access to a bucket. Only the user "anonymous" - will be able to access objects the user created unless permission is explicitly granted to - the bucket owner. - - - Important: We highly recommend that you do not grant the anonymous group write access to your - buckets as you will have no control over the objects others can store and their associated charges. - For more information, see Grantees and Permissions - - - - - Creates a S3Grant and adds it to the list of grants. - - The grantee for the grant. - The permission for the grantee. - - - - Removes a specific permission for the given grantee. - - The grantee - The permission for the grantee to remove - - - - Removes all permissions for the given grantee. - - - - - - The owner of the bucket or object. - - - - Every bucket and object in Amazon S3 has an owner, the user that - created the bucket or object. The owner of a bucket or object cannot - be changed. However, if the object is overwritten by another user - (deleted and rewritten), the new object will have a new owner. - - - Note: Even the owner is subject to the ACL. For example, if an owner - does not have Permission.READ access to an object, the owner cannot read - that object. However, the owner of an object always has write access to the - access control policy (Permission.WriteAcp) and can change the ACL to - read the object. - - - - - - Checks if Owner property is set. - - true if Owner property is set. - - - - A collection of grants. - - - - - Checks if Grants property is set. - - true if Grants property is set. - - - Bucket - Represents an S3 bucket, contains the name of the S3 bucket and the date that the bucket was created. - - - - - Date the bucket was created. - - - - - - The name of the bucket. - - - - - Logging Enabled - - - - - Specifies the bucket where you want Amazon S3 to store server access logs. You can have your logs delivered to any bucket that you own, - including the same bucket that is being logged. You can also configure multiple buckets to deliver their logs to the same target bucket. In - this case you should choose a different TargetPrefix for each source bucket so that the delivered log files can be distinguished by key. - - - - - A collection of grants. - - - - - This element lets you specify a prefix for the keys that the log files will be stored under. - - - - - Creates a S3Grant and adds it to the list of grants. - - The grantee for the grant. - The permission for the grantee. - - - - Removes a specific permission for the given grantee. - - The grantee - The permission for the grantee to remove - - - - Removes all permissions for the given grantee. - - - - - - An S3 bucket versioning configuration. - - - Contains the bucket's versioning status (Off, Enabled, Suspended) and whether an MFADelete - has been enabled for the bucket. - - - - - Versioning status for the bucket. - Accepted values: Off, Enabled, Suspended. - - - - - Checks if Status property is set - - true if Status property is set - - - - Specifies whether MFA Delete is enabled on this S3 Bucket. - - - If this property is set, please ensure that the - PutBucketVersioningRequest's MfaCodes property is set with - the Serial of and Token on the MFA device. - - - - - Checks if EnableMfaDelete property is set. - - true if Status property is set - - - - Describes the server-side encryption that will be applied to the restore results. - - - - - The server-side encryption algorithm used when storing job results in Amazon S3 (e.g., AES256, aws:kms). - - - - - Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by - AWS KMS will fail if not made via SSL or using SigV4. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at - http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version - - - - - If the encryption type is aws:kms, this optional value can be used to specify the encryption context for the restore results. - - - - Grant - - - - - The grantee details. - - - - - Specifies the permission given to the grantee. - - - - - Grantee - - - - - Type of grantee - - - - - - Screen name of the grantee. - - - - - - Email address of the grantee. - - - - - - The canonical user ID of the grantee. - - - - - - URI of the grantee group. - - - - - - Filter criteria that allows for event notification filtering based on an S3 Object's key name. - - - - - Gets and sets the filterRules property. - These are the filter rules for this filter. - - - - - Describes an S3 location that will receive the results of the restore request. - - - - - The name of the bucket where the restore results will be placed. - - - - - The prefix that is prepended to the restore results for this request. - - - - - The canned ACL to apply to the restore results. - - - - - A list of grants that control access to the staged results. - - - - - The tag-set that is applied to the restore results. - - - - - A map of metadata to store with the restore results in S3. - - - - - The class of storage used to store the restore results. - - - - - Represents an S3 Object. Contains all attributes that an S3 Object has. - For more information about S3 Objects refer: - - - - - - Any ETag set on the object. - - - - - The name of the bucket containing this object. - - - - - The key of the object. - - - - - The date and time the object was last modified. - - The date retrieved from S3 is in ISO8601 format. A GMT formatted date is passed back to the user. - - - - - - The owner of the object. - - - - - The size of the object. - - - - - The class of storage used to store the object. - - - - - - Represents a version of an object in an S3 Bucket. An S3 object version is an S3 object - that also has a version identifier, an indication of whether this is the latest version of the object - and whether it's a DeleteMarker or not. - - - - - Specifies whether the object is (true) or is not (false) the latest version of an object. - - - - - Version ID of an object. - - - - - If true, the object is a delete marker for a deleted object. - - - - - Specifies the byte range of the object to get the records from. A record is processed when its first byte is contained by the range. - - - - - Specifies the start of the byte range. This parameter is optional. Valid values: non-negative integers. The default value is 0. - - - - - Specifies the end of the byte range. This parameter is optional. Valid values: non-negative integers. The default value is one less than the size of the object being queried. - - - - - Request to filter the contents of an Amazon S3 object based on a simple Structured Query Language (SQL) statement. - - In the request, along with the SQL expression, you must also specify a data serialization format (JSON or CSV) of the object. - Amazon S3 uses this to parse object data into records, and returns only records - that match the specified SQL expression. You must also specify the data serialization format for the response. - - - - S3Select API Documentation - - - - - The S3 Bucket. - - - - - The Object Key. - - - - - The SSE Algorithm used to encrypt the object. - - - Server-Side Encryption (Using Customer-Provided Encryption Keys. - - - - - The SSE Customer Key. - - - Server-Side Encryption (Using Customer-Provided Encryption Keys. - - - - - The SSE Customer Key MD5. - - - Server-Side Encryption (Using Customer-Provided Encryption Keys. - - - - - The expression that is used to query the object. - - - - - The type of the provided expression (e.g., SQL). - - - - - Specifies if periodic request progress information should be enabled. - - - - - Describes the format of the data in the object that is being queried. - - - - - Describes the format of the data that you want Amazon S3 to return in response. - - - - - The byte range of the object to get the records from. - - - - - Contains the response Payload for the SelectObjectContent request - - - - - The Event Stream result of SelectObjectContent - - - - - Describes the parameters for Select job types. - - - - - Describes the serialization format of the object. - - - - - The type of the provided expression (e.g., SQL). - - - - - The expression that is used to query the object. - - - - - Describes how the results of the Select job are serialized. - - - - - ServerSideEncryptionByDefault class - - - - - Server-side encryption algorithm to use for the default encryption. - - - - - KMS master key ID to use for the default encryption. - This parameter is allowed if SSEAlgorithm is aws:kms. - - - - - ServerSideEncryptionConfiguration class - - - - - Container for information about a particular server-side encryption configuration rule. - - - - - ServerSideEncryptionRule class - - - - - Describes the default server-side encryption to apply to - new objects in the bucket. If Put Object request - does not specify any server-side encryption, - this default encryption will be applied. - - - - - SourceSelectionCriteria class - - - - - Container for filter information of selection of KMS Encrypted - S3 objects. The element is required if you include - SourceSelectionCriteria in the replication - configuration. - - - - - SSEKMS class - - - - - Specifies the ID of the AWS Key Management Service (KMS) - master encryption key to use for encrypting Inventory reports. - - - - - SseKmsEncryptedObjects class - - - - - The replication for KMS encrypted S3 objects is disabled if status is not Enabled. - - - - - SSES3 class - - - - - Class for StorageClassAnalysis - - - - - A container used to describe how data related to the storage class analysis should be exported. - - - - - Class for StorageClassAnalysisDataExport - - - - - The version of the output schema to use when exporting data. Must be V_1. - - - - - The place to store the data for an analysis. - - - - - Base class for responses that return a stream. - - - - - Disposes of all managed and unmanaged resources. - - - - - An open stream read from to get the data from S3. In order to - use this stream without leaking the underlying resource, please - wrap access to the stream within a using block. - - - - - The exception that is thrown when the size of a stream does not match it's expected size. - - - - - Gets and sets ExpectedSize property. - - - - - Gets and sets ActualSize property. - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - - - Constructs a new instance of the AmazonServiceException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - Tag is a key-value pair of metadata associated with an S3Object - - - - - Name of the tag. - - - - - Value of the tag. - - - - - Structure that contains list of Tags - - - - - TagSet - - - - - This class contains the configuration Amazon S3 uses to figure out what events you want to listen - and send the event to an Amazon SNS topic. - - The topic's policy must allow S3 to publish messages to it. The utility method - Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.AuthorizeS3ToPublish(string,string) - can be used to help setup the topic policy. - - - - - - Gets and set the Id property. The Id will be provided in the event content and can be used - to identify which configuration caused an event to fire. If the Id is not provided for the configuration, one will be generated. - - - - - Bucket event for which to send notifications. - - Topic configurations can now contain multiple events. This property is obsolete in favor of the Events property. - This property will always get or set the the zeroth element in the Events collection. - - - - - - Gets and sets the Topic property. Amazon SNS topic to which Amazon S3 will publish a message to report the - specified events for the bucket. - - The topic's policy must allow S3 to publish messages to it. The utility method - Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.AuthorizeS3ToPublish(string,string) - can be used to help setup the topic policy. - - - - - - The parameters to request upload of a part in a multipart upload operation. - - - - If PartSize is not specified then the rest of the content from the file - or stream will be sent to Amazon S3. - - - You must set either the FilePath or InputStream. If FilePath is set then the FilePosition - property must be set. - - - - The parameters to request upload of a part in a multipart upload operation. - - - - If PartSize is not specified then the rest of the content from the file - or stream will be sent to Amazon S3. - - - You must set either the FilePath or InputStream. If FilePath is set then the FilePosition - property must be set. - - - - - - Caller needs to set this to true when uploading the last part. This property only needs to be set - when using the AmazonS3EncryptionClient. - - - - - Input stream for the request; content for the request will be read from the stream. - - - - - The name of the bucket containing the object to receive the part. - - - - - The key of the object. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Part number of part being uploaded. - - - - - - The size of the part to be uploaded. - - - - - Checks if PartSize property is set. - - true if PartSize property is set. - - - - Upload ID identifying the multipart upload whose part is being uploaded. - - - - - - An MD5 digest for the part. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - - Full path and name of a file from which the content for the part is retrieved. - - - For WinRT and Windows Phone this property must be in the form of "ms-appdata:///local/file.txt". - - - - - - Checks if the FilePath property is set. - - true if FilePath property is set. - - - - Position in the file specified by FilePath from which to retrieve the content of the part. - This field is required when a file path is specified. It is ignored when using the InputStream property. - - - - - If this value is set to true then a chunked encoding upload will be used for the request. - Default: true. - - - - - Checks if the FilePosition property is set. - - true if FilePosition property is set. - - - - Checks if the MD5Digest property is set. - - true if Md5Digest property is set. - - - - Attach a callback that will be called as data is being sent to the AWS Service. - - - - - Overriden to turn off sending SHA256 header. - - - - - Overriden to turn on Expect 100 continue. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Overrides the default request timeout value. - - - - If the value is set, the value is assigned to the Timeout property of the HTTPWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Overrides the default ReadWriteTimeout value. - - - - If the value is set, the value is assigned to the ReadWriteTimeout property of the HTTPWebRequest/WebRequestHandler object used - to send requests. - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - - Returns information about the UploadPart response and response metadata. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - Entity tag for the uploaded object. - - - - - - Gets and sets the part number specified for the part upload. This is needed when - completing the multipart upload. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - Website Configuration - - - - - The ErrorDocument value, an object key name to use when a 4XX class error occurs. - - - - - - This value is a suffix that is appended to a request that is for a "directory" - on the website endpoint (e.g. if the suffix is index.html and - you make a request to samplebucket/images/ the data that - is returned will be for the object with the key name - images/index.html) - - - The suffix must not be empty and must not include a slash - character. - - - - - - Container for redirect information where all requests will be redirect - to. You can redirect requests to another host, to another page, or with - another protocol. In the event of an error, you can can specify a - different error code to return. . - - - - - The list of routing rules that can be used for configuring redirects if certain conditions are meet. - - - - - Arguments containing event details for an in-flight transfer. - - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - - - - Gets the percentage of transfer completed - - - - - Gets the number of bytes transferred since last event - - - - - Gets the number of bytes transferred - - - - - Gets the total number of bytes to be transferred - - - - - Returns a string representation of this object - - - - - - AmazonS3 exception. - Thrown when DeleteObjects returns successfully, but some of the objects - were not deleted. - - - - - Gets and sets the ErrorResponse property. - The DeleteObjectsErrorResponse associated with this exception. - - - - - Constructs an instance of DeleteObjectsException - - - - - - Constructs a new instance of the DeleteObjectsException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - The file format used when exporting data to Amazon S3. - - - - - CSV file format. - - - - - Construct instance of AnalyticsS3ExportFileFormat. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to an AnalyticsS3ExportFileFormat. - - - - - - - Represents the accelerate status for a bucket. - - - - - Bucket acceleration is enabled. - - - - - Bucket acceleration is suspended. - - - - - Construct instance of BucketAccelerateStatus. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to an BucketAccelerateStatus - - - - - - - The status of the delete marker replication. - - - - - Delete marker replication is enabled. - - - - - Delete marker replication is disabled. - - - - - Construct instance of DeleteMarkerReplicationStatus. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to a DeleteMarkerReplicationStatus - - - - - - - A list of all possible CannedACLs that can be used - for S3 Buckets or S3 Objects. For more information about CannedACLs, refer to - . - - - - - Owner gets FULL_CONTROL. - No one else has access rights (default). - - - - - Owner gets FULL_CONTROL. - No one else has access rights (default). - - - - - Owner gets FULL_CONTROL and the anonymous principal is granted READ access. - If this policy is used on an object, it can be read from a browser with no authentication. - - - - - Owner gets FULL_CONTROL, the anonymous principal is granted READ and WRITE access. - This can be a useful policy to apply to a bucket, but is generally not recommended. - - - - - Owner gets FULL_CONTROL, and any principal authenticated as a registered Amazon - S3 user is granted READ access. - - - - - Owner gets FULL_CONTROL. Amazon EC2 gets READ access to GET an - Amazon Machine Image (AMI) bundle from Amazon S3. - - - - - Object Owner gets FULL_CONTROL, Bucket Owner gets READ - This ACL applies only to objects and is equivalent to private when used with PUT Bucket. - You use this ACL to let someone other than the bucket owner write content (get full control) - in the bucket but still grant the bucket owner read access to the objects. - - - - - Object Owner gets FULL_CONTROL, Bucket Owner gets FULL_CONTROL. - This ACL applies only to objects and is equivalent to private when used with PUT Bucket. - You use this ACL to let someone other than the bucket owner write content (get full control) - in the bucket but still grant the bucket owner full rights over the objects. - - - - - The LogDelivery group gets WRITE and READ_ACP permissions on the bucket. - - - - - Construct instance of S3CannedACL. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to an S3CannedACL - - - - - - - A list of all possible S3 Bucket region possibilities. For - more information, refer to - . - - - - - Specifies that the S3 Bucket should use US locality. - This is the default value. - - - - - Specifies that the S3 Bucket should use US-EAST-2 locality. - - - - - Specifies that the S3 Bucket should use EU locality which defaults to EU-WEST-1 - - - - - Specifies that the S3 Bucket should use the EU-NORTH-1 locality. - - - - - Specifies that the S3 Bucket should use the EU-WEST-1 locality. - - - - - Specifies that the S3 Bucket should use the EU-WEST-2 locality. - - - - - Specifies that the S3 Bucket should use the EU-WEST-3 locality. - - - - - Specifies that the S3 Bucket should use the EU-CENTRAL-1 locality. - - - - - Specifies that the S3 Bucket should use US-WEST-1 locality. - - - - - Specifies that the S3 Bucket should use US-WEST-2 locality. - - - - - Specifies that the S3 Bucket should use US-GOV-EAST-1 locality. - - - - - Specifies that the S3 Bucket should use US-GOV-WEST-1 locality. - - - - - Specifies that the S3 Bucket should use the AP-EAST-1 locality. - - - - - Specifies that the S3 Bucket should use the AP-SOUTHEAST-1 locality. - - - - - Specifies that the S3 Bucket should use the AP-SOUTHEAST-2 locality. - - - - - Specifies that the S3 Bucket should use the AP-NORTHEAST-1 locality. - - - - - Specifies that the S3 Bucket should use the AP-NORTHEAST-2 locality. - - - - - Specifies that the S3 Bucket should use the AP-NORTHEAST-3 locality. - - - - - Specifies that the S3 Bucket should use the AP-SOUTH-1 locality. - - - - - Specifies that the S3 Bucket should use the SA-EAST-1 locality. - - - - - Specifies that the S3 Bucket should use CN-NORTH-1 locality. - - - - - Specifies that the S3 Bucket should use CN-NORTHWEST-1 locality. - - - - - Specifies that the S3 Bucket should use CA-CENTRAL-1 locality. - - - - - Specifies that the S3 Bucket should use US-WEST-1 locality. - - - - - Specifies that the S3 Bucket should use CN-NORTH-1 locality. - - - - - Specifies that the S3 Bucket should use US-GOV-WEST-1 locality. - - - - - Construct instance of S3Region. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to the S3Region class - - - - - - - A list of all ACL permissions. For more information, refer to - . - - - - - When applied to a bucket, grants permission to list the bucket. - When applied to an object, this grants permission to read the - object data and/or metadata. - - - - - When applied to a bucket, grants permission to create, overwrite, - and delete any object in the bucket. This permission is not - supported for objects. - - - - - Grants permission to read the ACL for the applicable bucket or object. - The owner of a bucket or object always has this permission implicitly. - - - - - Gives permission to overwrite the ACP for the applicable bucket or object. - The owner of a bucket or object always has this permission implicitly. - Granting this permission is equivalent to granting FULL_CONTROL because - the grant recipient can make any changes to the ACP. - - - - - Provides READ, WRITE, READ_ACP, and WRITE_ACP permissions. - It does not convey additional rights and is provided only for convenience. - - - - - Gives permission to restore an object that is currently stored in Amazon Glacier - for archival storage. - - - - - Construct S3Permission. - - - - - - Construct instance of S3Permission. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - - Gets and sets the HeaderName property. - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to an S3Permission - - - - - - - An enumeration of all Metadata directives that - can be used for the CopyObject operation. - - - - - Specifies that the metadata is copied from the source object. - - - - - Specifies that the metadata is replaced with metadata provided in the request. - All original metadata is replaced by the metadata you specify. - - - - - An enumeration of all protocols that the pre-signed - URL can be created against. - - - - - https protocol will be used in the pre-signed URL. - - - - - http protocol will be used in the pre-signed URL. - - - - - An enumeration of supported HTTP verbs - - - - - The GET HTTP verb. - - - - - The HEAD HTTP verb. - - - - - The PUT HTTP verb. - - - - - The DELETE HTTP verb. - - - - - S3 Storage Class Definitions - - - - - The STANDARD storage class, which is the default - storage class for S3. - - Durability 99.999999999%; Availability 99.99% over a given year. - - - - - REDUCED_REDUNDANCY provides the same availability as standard, but at a lower durability. - - Durability 99.99%; Availability 99.99% over a given year. - - - - - The GLACIER storage is for object that are stored in Amazon Glacier. - This storage class is for objects that are for archival purpose and - get operations are rare. - - Durability 99.999999999% - - - - - The STANDARD_IA storage is for infrequently accessed objects. - This storage class is for objects that are long-lived and less frequently accessed, - like backups and older data. - - Durability 99.999999999%; Availability 99.9% over a given year. - - - - - The ONEZONE_IA storage is for infrequently accessed objects. It is similiar to STANDARD_IA, but - only stores object data within one Availablity Zone in a given region. - - Durability 99.999999999%; Availability 99% over a given year. - - - - - IntelligentTiering makes it easy to lower your overall cost of storage by automatically placing data in the storage - class that best matches the access patterns for the storage. With IntelligentTiering, you don’t need to define - and manage individual policies for lifecycle data management or write code to transition objects - between storage classes. Instead, you can use IntelligentTiering to manage transitions between Standard and - S-IA without writing any application code. IntelligentTiering also manages transitions automatically to - Glacier for long term archive in addition to S3 storage classes. - - - - - S3 Glacier Deep Archive provides secure, durable object storage class for long term data archival. - It is the ideal storage class to make an archival, durable copy of data that rarely, if ever, needs to be accessed. - It can be used as an offline backup for their most important data assets and to meet long-term retention needs. - - - - - Construct an instance of S3StorageClass. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to S3StorageClass. - - - - - - - The constants for the known event names used by S3 notification. S3 might add new - events before the SDK is updated. In which case the names listed in the S3 documentation - will work as well as these constants. - - - - - An event that says an object has been lost in the reduced redundancy storage. - - - - - A list of all server-side encryption methods for customer provided encryption keys. - - - - - No server side encryption to be used. - - - - - Use AES 256 server side encryption. - - - - - Constructs an instance of ServerSideEncryptionCustomerMethod. - - - - - - Finds the constant for the unique value. - - - - - - - Converts string to ServerSideEncryptionCustomerMethod. - - - - - - - A list of all server-side encryption methods. - - - - - No server side encryption to be used. - - - - - Use AES 256 server side encryption. - - - - - Use AWS Key Management Service for server side encryption. - - - - - Construct instance of ServerSideEncryptionMethod. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to ServerSideEncryptionCustomerMethod. - - - - - - - A list of all grantee types. - - - - - The predefined group. - - - - - The email address of an AWS account - - - - - The canonical user ID of an AWS account - - - - - Construct an instance of GranteeType. - - - - - - Finds the constant for the unique value. - - - - - - - Convert a string to GranteeType. - - - - - - - A list of all lifecycle statuses. - - - - - The rule is enabled. - - - - - The rule is disabled. - - - - - Constructs an instance LifecycleRuleStatus. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to LifecycleRuleStatus. - - - - - - - A list of all version statuses. - - - - - The rule is off. - - - - - The rule is suspended. - - - - - The rule is enabled. - - - - - Construct an instance of VersionStatus. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to VersionStatus. - - - - - - - A list of all encoding types. - - - - - Url encoding. - - - - - Constructs intance of EncodingType - - - - - - Finds the constant for the unique value. - - - - - - - Converts string to EncodingType - - - - - - - The bucket event for which to send notifications. - - - - - The event encapsulates all the object create events - - - - - Event for put operations - - - - - Event for post operations - - - - - Event for copy operations - - - - - Event for completing a multi part upload - - - - - This event encapsulates all the object removed events - - - - - Event for object removed, delete operation. - - - - - Event for object removed, delete marker created operation. - - - - - Event for objects stored in reduced redundancy and S3 detects the object is lost - - - - - Event for all object restore - - - - - Event for restore post operations. - - - - - Event for when object restore is completed. - - - - - Event for replication of all - - - - - Event for operation failed replication - - - - - Evemt for replication operation not tracked - - - - - Event for replication operation missed threshold - - - - - Event for operation replicated after threshold - - - - - Constructs instance of EventType. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to EventType. - - - - - - - Compares if the ConstantClass instances are equals. - - - - - - - Compares if the ConstantClass instances are equals. This is ovewritten to handle the - discrepancy with S3 events coming from Lambda that don't have the prefix "s3:". - - - - - - - A list of all Inventory Formats. - - - - - CSV inventory format - - - - - ORC inventory format - - - - - Parquet inventory format - - - - - Construct instance of InventoryFormat. - - - - - - Finds the constant for the unique value. - - The string representation of the InventoryFormat. - The InventoryFormat object for that string. - - - - Convert string to InventoryFormat. - - - - - - - A list of inventory included object versions. - - - - - All Inventory Included Object Versions - - - - - Current Inventory Included Object Versions - - - - - Construct instance of InventoryIncludedObjectVersions. - - - - - - Finds the constant for the unique value. - - The string representation of the InventoryIncludedObjectVersions. - The InventoryIncludedObjectVersions object for that string. - - - - Convert string to InventoryIncludedObjectVersions. - - - - - - - A list of inventory frequencies. - - - - - Daily Inventory Frequency - - - - - Weekly Inventory Frequency - - - - - Construct instance of InventoryFrequency. - - - - - - Finds the constant for the unique value. - - The string representation of the InventoryFrequency. - The InventoryFrequency object for that string. - - - - Convert string to InventoryFrequency. - - - - - - - A list of inventory optional fields. - - - - - InventoryOptionalField for Size - - - - - InventoryOptionalField for LastModifiedDate - - - - - InventoryOptionalField for StorageClass - - - - - InventoryOptionalField for ETag - - - - - InventoryOptionalField for IsMultipartUploaded - - - - - InventoryOptionalField for ReplicationStatus - - - - - InventoryOptionalField for EncryptionStatus - - - - - InventoryOptionalField for ObjectLockRetainUntilDate - - - - - InventoryOptionalField for ObjectLockMode - - - - - InventoryOptionalField for ObjectLockLegalHoldStatus - - - - - InventoryOptionalField for IntelligentTieringAccessTier - - - - - Construct instance of InventoryOptionalField. - - - - - - Finds the constant for the unique value. - - The string representation of the InventoryOptionalField. - The InventoryIncludedObjectVersions object for that string. - - - - Convert string to InventoryOptionalField. - - - - - - - The status of the replication job associated with this source object. - - - - - The object is pending replication. - - - - - The object has been replicated. - - - - - The object was created as a result of replication. - - - - - The object replication has failed due to a customer-attributable reason, and the replication will not be attempted again. - - - - - Construct instance of ReplicationStatus. - - - - - - Finds the constant for the unique value. - - The string representation of the ReplicationStatus. - The ReplicationStatus object for that string. - - - - Convert string to ReplicationStatus. - - - - - - - Whether a replication rule is applied or ignored. - - - - - The rule will be applied. - - - - - The rule will be ignored. - - - - - Construct instance of ReplicationRuleStatus - - - - - - Finds the constant for the unique value. - - The string representation of the ReplicationRuleStatus. - The ReplicationRuleStatus object for that string. - - - - Convert string to ReplicationRuleStatus. - - - - - - - Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request. - - - - - The object tag-set is copied from the source object. - - - - - The object tag-set is replaced with tag-set provided in the request. - - - - - Construct instance of TaggingDirective - - - - - Finds the constant for the unique value. - - The string representation of the TaggingDirective. - The TaggingDirective object for that string. - - - - Convert string to TaggingDirective. - - - - - All enumerations type for retrieval tier for Glacier restore. - - - - - Standard Tier for Glacier restore. - - - - - Bulk Tier for Glacier restore. - - - - - Expedited Tier for Glacier restore. - - - - - Construct instance of RestoreObjectRequestGlacierJobTier - - - - - - Finds the constant for the unique value. - - The string representation of the RestoreObjectRequestGlacierJobTier. - The RestoreObjectRequestGlacierJobTier object for that string. - - - - Convert string to RestoreObjectRequestGlacierJobTier. - - - - - - - The version of the output schema to use when exporting data. - - - - - The schema output version V_1. - - - - - Construct instance of StorageClassAnalysisSchemaVersion - - - - - - Finds the constant for the unique value. - - The string representation of the StorageClassAnalysisSchemaVersion. - The StorageClassAnalysisSchemaVersion object for that string. - - - - Convert string to StorageClassAnalysisSchemaVersion. - - - - - - - Acknowledges that requester pays for the operation. - - - - - Requester pays for the operation. - - - - - Finds the RequestPayer instance for the string value. - - - - - Converts string to RequestPayer instance - - - - - The response from S3 that it confirms that requester pays. - - - - - S3 acknowledges that the requester pays. - - - - - Finds the RequestCharged instance for the string value - - - - - converts the string to RequestCharged instance - - - - - The override value for the owner of the replica object. - - - - - Overrides destination bucket's owner. - - - - - Finds the OwnerOverride instance for the string value - - - - - converts the string to OwnerOverride instance - - - - - The replication for KMS encrypted S3 objects is disabled if status is not Enabled. - - - - - The replication for KMS encrypted S3 objects is enabled. - - - - - The replication for KMS encrypted S3 objects is disabled. - - - - - - - - - - Finds the SseKmsEncryptedObjectsStatus instance for the string value - - - - - Converts the string to SseKmsEncryptedObjectsStatus instance - - - - - Specify how headers will be handled. - - - - - Headers will be usable in SELECT clause. - - - - - Headers will be skipped - - - - - No header is present. - - - - - Finds the FileHeaderInfo instance for the string value - - - - - - - Converts the string to FileHeaderInfo instance - - - - - Specifies whether existing object replication is enabled. - - - - - Enable the replication of existing objects - - - - - Disable the replication of existing objects - - - - - Finds the ExistingObjectReplicationStatus instance for the string value - - - - - - - Converts the string to ExistingObjectReplicationStatus instance - - - - - Describes when fields in output should be surrounded with quotes. - - - - - Specifies that fields in output should always be surrounded in quotes. - - - - - Specifies that fields in output should be surrounded in quotes as necessary. - - - - - Finds the QuoteFields instance for the string value - - string value that maps to QuoteFields enum - QuoteFields enum - - - - Converts the string to QuoteFields instance - - - - - Type of the expression provided in the Expression member. - - - - - SQL expression - - - - - Finds the ExpressionType instance for the string value - - string value that maps to ExpressionType enum - ExpressionType enum - - - - Converts the string to ExpressionType instance - - - - - Indicates what type of job is being initiated. - - - - - Finds the RestoreRequestType instance for the string value - - - - - Converts the string to RestoreRequestType instance - - - - - The type of JSON. - - - - - Finds the JsonType instance for the string value - - - - - Converts the string to JsonType instance - - - - - Specifies object's compression format. - - - - - Finds the CompressionType instance for the string value - - - - - Converts the string to CompressionType instance - - - - - The type of ObjectLockEnabled - - - - - Finds the ObjectLockEnabled instance for the string value - - - - - Converts the string to ObjectLockEnabled instance - - - - - The type of ObjectLockLegalHoldStatus - - - - - Finds the ObjectLockLegalHoldStatus instance for the string value - - - - - Converts the string to ObjectLockLegalHoldStatus instance - - - - - The type of ObjectLockRetentionMode - - - - - Finds the ObjectLockRetentionMode instance for the string value - - - - - Converts the string to ObjectLockRetentionMode instance - - - - - The type of ObjectLockMode - - - - - Finds the ObjectLockMode instance for the string value - - - - - Converts the string to ObjectLockMode instance - - - - - Specifies whether the replication time is enabled. - - - - - Replication time is enabled. - - - - - Replication time is disabled. - - - - - Finds the ReplicationTimeStatus instance for the string value - - - - - - - Converts the string to ReplicationTimeStatus instance - - - - - - Specifies whether the replication metrics are enabled. - - - - - Replication metrics are enabled. - - - - - Replication metrics are disabled. - - - - - Finds the MetricsStatus instance for the string value - - - - - - - Converts the string to MetricsStatus instance - - - - - - Uri wrapper that can parse out information (bucket, key, region, style) from an - S3 URI. - - - - - True if the URI contains the bucket in the path, false if it contains the bucket in the authority. - - - - - The bucket name parsed from the URI (or null if no bucket specified). - - - - - The key parsed from the URI (or null if no key specified). - - - - - The region parsed from the URI (or null if no region specified). - - - - - Constructs a parser for the S3 URI specified as a string. - - The S3 URI to be parsed. - - - - Constructs a parser for the S3 URI specified as a Uri instance. - - The S3 URI to be parsed. - - - - If the given string is an AmazonS3Endpoint return true and set the AmazonS3Uri out parameter. - - - - true if the string is an AmazonS3Endpoint, and the out paramter has been filled in, false otherwise - - - - If the given Uri is an AmazonS3Endpoint return true and set the AmazonS3Uri out parameter. - - - - true if the Uri is an AmazonS3Endpoint, and the out paramter has been filled in, false otherwise - - - - Checks whether the given URI is a Amazon S3 URI. - - The S3 URI to be checked. - true if the URI is a Amazon S3 URI, false; otherwise. - - - - Checks whether the given URI is a Amazon S3 URI. - - The S3 URI to be checked. - true if the URI is a Amazon S3 URI, false; otherwise. - - - - Percent-decodes the given string, with a fast path for strings that are not - percent-encoded. - - The string to decode - The decoded string - - - - Percent-decodes the given string. - - The string to decode - The index of the first '%' in the string - The decoded string - - - - Decodes the percent-encoded character at the given index in the string - and appends the decoded value to the string under construction. - - - The string under construction to which the decoded character will be - appended. - - The string being decoded. - The index of the '%' character in the string. - - - - Converts a hex character (0-9A-Fa-f) into its corresponding quad value. - - The hex character - The quad value - - - - Provides utilities used by the Amazon S3 client implementation. - These utilities might be useful to consumers of the Amazon S3 - library. - - - Provides utilities used by the Amazon S3 client implementation. - These utilities might be useful to consumers of the Amazon S3 - library. - - - - - Determines MIME type from a file extension - - The extension of the file - The MIME type for the extension, or text/plain - - - - URL encodes a string. If the path property is specified, - the accepted path characters {/+:} are not encoded. - - The string to encode - Whether the string is a URL path or not - - - - - Converts a non-seekable stream into a System.IO.MemoryStream. - A MemoryStream's position can be moved arbitrarily - - The stream to be converted - A seekable MemoryStream - MemoryStreams use byte arrays as their backing store. - Please use this judicially as it is likely that a very large - stream will cause system resources to be used up. - - - - - Formats the current date as a GMT timestamp - - A GMT formatted string representation - of the current date and time - - - - - Generates an MD5 Digest for the string-based content - - The content for which the MD5 Digest needs - to be computed. - - Whether the returned checksum should be - base64 encoded. - - A string representation of the hash with or w/o base64 encoding - - - - - Only escape non-ascii characters in a string - - - - - - - Version2 S3 buckets adhere to RFC 1035: - - Less than 255 characters, with each label less than 63 characters. - Label must start with a letter - Label must end with a letter or digit - Label can have a string of letter, digits and hyphens in the middle. - Although names can be case-sensitive, no significance is attached to the case. - RFC 1123: Allow label to start with letter or digit (e.g. 3ware.com works) - RFC 2181: No restrictions apart from the length restrictions. - - S3 V2 will start with RFCs 1035 and 1123 and impose the following additional restrictions: - - Length between 3 and 63 characters (to allow headroom for upper-level domains, - as well as to avoid separate length restrictions for bucket-name and its labels - Only lower-case to avoid user confusion. - No dotted-decimal IPv4-like strings - - - The BucketName to validate if V2 addressing should be used - True if the BucketName should use V2 bucket addressing, false otherwise - - S3 v2 Bucket restrictions - - - - Determines whether an S3 bucket exists or not. - - The name of the bucket to check. - The Amazon S3 Client to use for S3 specific operations. - False is returned in case S3 responds with a NoSuchBucket error. - True is returned in case of success, AccessDenied error or PermanentRedirect error. - An exception is thrown in case of any other error. - This method calls GetACL for the bucket. - - - - Determines whether an S3 bucket exists or not. - This is done by: - 1. Creating a PreSigned Url for the bucket. To work with Signature V4 only regions, as - well as Signature V4-optional regions, we keep the expiry to within the maximum for V4 - (which is one week). - 2. Making a HEAD request to the Url - - The name of the bucket to check. - The Amazon S3 Client to use for S3 specific operations. - - - - - Sets the storage class for the S3 Object to the value - specified. - - The name of the bucket in which the key is stored - The key of the S3 Object whose storage class needs changing - The new Storage Class for the object - The Amazon S3 Client to use for S3 specific operations. - - - - - Sets the storage class for the S3 Object's Version to the value - specified. - - The name of the bucket in which the key is stored - The key of the S3 Object whose storage class needs changing - The version of the S3 Object whose storage class needs changing - The new Storage Class for the object - The Amazon S3 Client to use for S3 specific operations. - - - - - Sets the server side encryption method for the S3 Object to the value - specified. - - The name of the bucket in which the key is stored - The key of the S3 Object - The server side encryption method - The Amazon S3 Client to use for S3 specific operations. - - - - Sets the server side encryption method for the S3 Object's Version to the value - specified. - - The name of the bucket in which the key is stored - The key of the S3 Object - The version of the S3 Object - The server side encryption method - The Amazon S3 Client to use for S3 specific operations. - - - - Sets the redirect location for the S3 Object's when being accessed through the S3 website endpoint. - - The name of the bucket in which the key is stored - The key of the S3 Object - The redirect location - The Amazon S3 Client to use for S3 specific operations. - - - - Sets up the request needed to make an exact copy of the object leaving the parent method - the ability to change just the attribute being requested to change. - - - - - - - - - - - Converts the string representing a storage class that would come back from a ListObjects request - to the S3StorageClass enumeration. - - Amazon S3 string values for storage class - The converted S3StorageClass enumeration - - - - Upload data to Amazon S3 using HTTP POST. - - - For more information, - - Request object which describes the data to POST - Thrown if the service returns an error - - - - Deletes an S3 bucket which contains objects. - An S3 bucket which contains objects cannot be deleted until all the objects - in it are deleted. This method deletes all the objects in the specified - bucket and then deletes the bucket itself. - - The bucket to be deleted. - The Amazon S3 Client to use for S3 specific operations. - - - - Deletes an S3 bucket which contains objects. - An S3 bucket which contains objects cannot be deleted until all the objects - in it are deleted. This method deletes all the objects in the specified - bucket and then deletes the bucket itself. - - The bucket to be deleted. - The Amazon S3 Client to use for S3 specific operations. - Options to control the behavior of the delete operation. - - - - Initiates the asynchronous execution of the DeleteS3BucketWithObjects operation. - DeleteS3BucketWithObjects deletes an S3 bucket which contains objects. - An S3 bucket which contains objects cannot be deleted until all the objects - in it are deleted. This method deletes all the objects in the specified - bucket and then deletes the bucket itself. - - The bucket to be deleted. - The Amazon S3 Client to use for S3 specific operations. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property. - An IAsyncCancelableResult that can be used to poll or wait for results, or both; - this value is also needed when invoking EndDeleteS3BucketWithObjects. IAsyncCancelableResult can also - be used to cancel the operation while it's in progress. - - - - Initiates the asynchronous execution of the DeleteS3BucketWithObjects operation. - DeleteS3BucketWithObjects deletes an S3 bucket which contains objects. - An S3 bucket which contains objects cannot be deleted until all the objects - in it are deleted. This method deletes all the objects in the specified - bucket and then deletes the bucket itself. - - The bucket to be deleted. - The Amazon S3 Client to use for S3 specific operations. - Options to control the behavior of the delete operation. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property. - An IAsyncCancelableResult that can be used to poll or wait for results, or both; - this value is also needed when invoking EndDeleteS3BucketWithObjects. IAsyncCancelableResult can also - be used to cancel the operation while it's in progress. - - - - Initiates the asynchronous execution of the DeleteS3BucketWithObjects operation. - DeleteS3BucketWithObjects deletes an S3 bucket which contains objects. - An S3 bucket which contains objects cannot be deleted until all the objects - in it are deleted. This method deletes all the objects in the specified - bucket and then deletes the bucket itself. - - The bucket to be deleted. - The Amazon S3 Client to use for S3 specific operations. - >Options to control the behavior of the delete operation. - An callback that is invoked to send updates while delete operation is in progress. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property. - An IAsyncCancelableResult that can be used to poll or wait for results, or both; - this value is also needed when invoking EndDeleteS3BucketWithObjects. IAsyncCancelableResult can also - be used to cancel the operation while it's in progress. - - - - Finishes the asynchronous execution of the DeleteS3BucketWithObjects operation. - - The IAsyncCancelableResult returned by the call to BeginDeleteS3BucketWithObjects. - - - - Invokes the DeleteS3BucketWithObjectsInternal method. - - The Request object that has all the data to complete the operation. - - - - Deletes an S3 bucket which contains objects. - An S3 bucket which contains objects cannot be deleted until all the objects - in it are deleted. The function deletes all the objects in the specified - bucket and then deletes the bucket itself. - - The bucket to be deleted. - The Amazon S3 Client to use for S3 specific operations. - Options to control the behavior of the delete operation. - The callback which is used to send updates about the delete operation. - An IAsyncCancelableResult that can be used to poll or wait for results, or both; - this value is also needed when invoking EndDeleteS3BucketWithObjects. IAsyncCancelableResult can also - be used to cancel the operation while it's in progress. - - - - Invokes the callback which provides updated about the delete operation. - - The callback to be invoked. - The data being passed to the callback. - - - - Class to manage and cache the correct region for buckets accessed without an explicit region. - - - Class to manage and cache the correct region for buckets accessed without an explicit region. - - - - - A cache of BucketName -> RegionEndpoint pairs. - The cache is used to make sure that bucket requests are signed for the correct region, - even when requesting them without an explicit region. - - - - - Detect a bucket region mismatch based on the x-amz-bucket-region header, and the status code provided. - - - - - - - - - Detects if the signature is malformed, and the requested bucket is in a Region - different from the Region of the request. - - - - the correct region if a mismatch was detected, null otherwise - - - - Detects if the signature is malformed, and the requested bucket is in a Region - different from the Region of the request. - - - - - the correct region if a mismatch was detected, null otherwise - - - - Use a HEAD bucket request to get the region for the given bucket. - - This method creates an AmazonS3Client from the credentials passed in. - It's critical that the AmazonS3Client is not used to make any requests that will - be routed through the pipeline. - - - - the value of the x-amz-bucket-region header from the response - - - - A helper class that represents a strongly typed S3 EventNotification item sent to SQS - - - - - Parse the JSON string into a S3EventNotification object. - - The function will try its best to parse input JSON string as best as it can. - It will not fail even if the JSON string contains unknown properties. - - For any parsing errors - - - - - Gets and sets the records for the S3 event notification - - - - - The class holds the user identity properties. - - - - - Gets and sets the PrincipalId property. - - - - - This class contains the identity information for an S3 bucket. - - - - - Gets and sets the name of the bucket. - - - - - Gets and sets the bucket owner id. - - - - - Gets and sets the S3 bucket arn. - - - - - This class contains the information for an object in S3. - - - - - Gets and sets the key for the object stored in S3. - - - - - Gets and sets the size of the object in S3. - - - - - Gets and sets the etag of the object. This can be used to determine if the object has changed. - - - - - Gets and sets the version id of the object in S3. - - - - - Gets and sets the sequencer a string representation of a hexadecimal value used to determine event sequence, only used with PUTs and DELETEs. - - - - - Gets and sets the meta information describing S3. - - - - - Gets and sets the ConfigurationId. This ID can be found in the bucket notification configuration. - - - - - Gets and sets the Bucket property. - - - - - Gets and sets the Object property. - - - - - Gets and sets the S3SchemaVersion property. - - - - - The class holds the request parameters - - - - - Gets and sets the SourceIPAddress. This is the ip address where the request came from. - - - - - This class holds the response elements. - - - - - Gets and sets the XAmzId2 Property. This is the Amazon S3 host that processed the request. - - - - - Gets and sets the XAmzRequestId. This is the Amazon S3 generated request ID. - - - - - The class holds the glacier event data elements. - - - - - Gets and sets the RestoreEventData property. - - - - - The class holds the restore event data elements. - - - - - Gets and sets the LifecycleRestorationExpiryTime the time when the object restoration will be expired. - - - - - Gets and sets the LifecycleRestoreStorageClass the source storage class for restore. - - - - - The class holds the event notification. - - - - - Gets and sets the AwsRegion property. - - - - - Gets and sets the EventName property. This identities what type of event occurred. - For example for an object just put in S3 this will be set to EventType.ObjectCreatedPut. - - - - - Gets and sets the EventSource property. - - - - - Gets and sets the EventType property. The time when S3 finished processing the request. - - - - - Gets and sets the EventVersion property. - - - - - Gets and sets the RequestParameters property. - - - - - Gets and sets the ResponseElements property. - - - - - Gets and sets the S3 property. - - - - - Gets and sets the UserIdentity property. - - - - - Get and sets the GlacierEventData property. - - - - - Options which control the behaviour of the DeleteS3BucketWithObjects operation. - - - - - Gets or sets a value which indicates whether the - operation should be aborted if an error is encountered during execution. - - - - - Gets or sets a value which indicated whether verbose results shoule be returned to the - callback. - If quiet mode is true the callback will receive only keys where the delete operation encountered an error. - If quiet mode is false the callback will receive keys for both successful and unsuccessful delete operations. - - - - - Internal class used to pass the parameters for DeleteS3BucketWithObjects operation. - - - Internal class used to pass the parameters for DeleteS3BucketWithObjects operation. - - - - - Name of the bucket to be deleted. - - - - - The Amazon S3 Client to use for S3 specific operations. - - - - - Options to control the behavior of the delete operation. - - - - - The callback which is used to send updates about the delete operation. - - - - - Contains updates from DeleteS3BucketWithObjects operation. - - - - - The list of objects which were successfully deleted. - - - - - The list of objects for which the delete operation failed. - - - - - Represents the status of an asynchronous operation. - It adds support for Cancelation of the asynchronous operation. - - - - - Gets a value that indicated whether the asynchronous operation has been canceled. - - - - - Gets a user-defined object that qualifies or contains information about an - asynchronous operation. - - - - - Gets a System.Threading.WaitHandle that is used to wait for an asynchronous - operation to complete. - - - - - Gets a value that indicates whether the asynchronous operation completed - synchronously. - - - - - Gets a value that indicates whether the asynchronous operation has completed. - - - - - Gets a value that indicates whether a cancel is requested. - - - - - The last exception that when the asynchronous operation was executed. - This is used to capture the exception and re-throw it when EndOperation is called. - - - - - The callback to be invoked when the asynchronous operation is completed. - - - - - Constructor for AsyncCancelableResult. - - The callback to be invoked when the asynchronous operation is completed. - Gets a user-defined object that qualifies or contains information about an - asynchronous operation. - - - - - Cancels the asynchronous operation if it's in progress. - - - - - Signals that the operaton is canceled and invokes the callback. - - - - - Signals that the operation is completed and invoked the callback. - - - - - Performs application-defined tasks associated with freeing, releasing, or - resetting unmanaged resources. - - - - - Disposes any managed and unmanaged resources. - - Should pass true if called by Dispose(), pass false if - called during finalization. - - - - Represents the status of an asynchronous operation. This interface extends - IAsyncResult and adds support for Cancelation of the asynchronous operation. - - - - - Cancels the asynchronous operation if it's in progress. - - - - - Gets a value that indicated whether the asynchronous operation has been canceled. - - - - - An exception detailing a failed HTTP POST upload atempt to Amazon S3. - - - - - Initializes a new instance of S3PostUploadException with a specified error message - - The error message - - - - Initializes a new instance of S3PostUploadException with a specified error code and error message - - The error code - The error message - - - - The error code returned by S3 - - - - - The S3 request id - - - - - The S3 host id - - - - - The HTTP error status code returned by S3 - - - - - Additional information about the error - - - Some errors are accompanied by more specific information, which vary from error to error - - - - - Parse an S3 Error response and create an S3PostUploadException - - The response from S3 - An S3PostUploadException with the information from the response - - - - Constructs a new instance of the S3PostUploadException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - Class for unmarshalling response XML - - - - - Gets and sets the ErrorCode property. - - - - - Gets and sets the ErrorMessage property. - - - - - Gets and sets the RequestId property. - - - - - Gets and sets the HostId property. - - - - - Gets and sets the elements property. - - - - - Parameters for uploading to Amazon S3 a file using HTTP POS - - - - If a S3PostUploadSignedPolicy is assigned, then values set (other than InputStream or Path) on this object must adhere to the policy. - This includes metadata. If metadata is specified in the policy, then it must be included in the request. Adding metadata not in the - policy will cause the POST to fail. - - For more information, - - - - - - Default constructor. - - - - - S3 Bucket to upload the object to - - - - - The name of the uploaded key. - - - - - Stream to read the upload data for - - - If you use InputStream, then you also need to set ContentLength - - - - - File path to read the upload data from - - - - - Content type for the uploaded data - - - If this is not set, an attempt will be made to infer it from the extension on Key or Path (in that order), - otherwise 'application/octet-stream' will be assumed. - - - - - Specifies an Amazon S3 access control list - - - - - Signed policy from bucket owner. - - - - - Where to redirect browsers on a successful upload - - - - - The status code returned to the client upon successful upload if success_action_redirect is not specified - - - - Accepts the values OK (200) , Created (201), or NoContent (204, default). - - If the value is set to OK or NoContent, Amazon S3 returns an empty document with a 200 or 204 status code. - - If the value is set to Created, Amazon S3 returns an XML document with a 201 status code. - - If the value is not set or if it is set to an invalid value, Amazon S3 returns an empty document with a 204 status code. - - - - - - Storage class to use for storing the object - - - Default: STANDARD - - - - - The AWS region where the bucket is located. - - - Depending upon the bucket name, POST uploads will be - successfully redirected, but for buckets with non-DNS-compliant - characters, redirects will fail. Setting this to the appropriate - region will avoid the redirect. - - - - - Metadata to set on the uploaded object - - - If keys do not begin with 'x-amz-meta-' it will be added at POST time. - - - - - Write the multipart/form-data for this request for all fields except the file data to a stream - - - - - Class holds Response data for a post upload. - - - - - Gets and sets the StatusCode property. - - - - - Gets and sets the RequestId property. - - - - - Gets and sets the HostId property. - - - - - Gets and sets the CloudFront request ID. - - - - - Utility class for managing and exchanging HTTP POST uploads of objects to Amazon S3. - - - - This object supports creating, marshalling, and unmarshalling of the information needed to build - an authenticated HTTP POST request to S3 for uploading objects according to a policy. - - For more information, - - - - - Given a policy and AWS credentials, produce a S3PostUploadSignedPolicy. - - JSON string representing the policy to sign - Credentials to sign the policy with - A signed policy object for use with an S3PostUploadRequest. - - - - Given a policy and AWS credentials, produce a S3PostUploadSignedPolicy. - - JSON string representing the policy to sign - Credentials to sign the policy with - Service region endpoint. - A signed policy object for use with an S3PostUploadRequest. - - - - The policy document which governs what uploads can be done. - - - - - The signature for the policy. - - - - - The AWS Access Key Id for the credential pair that produced the signature. - - - - - The security token from session or instance credentials. - - - - - The signature version usedd. Either "2" or "4". - - - - - The signing algorithm used. Required as a field in the post Amazon - S3 can re-calculate the signature. - - - - - The date value in ISO8601 format. It is the same date used in - creating the signing key. - - - - - In addition to the access key ID, this provides scope information - used in calculating the signing key for signature calculation. - - - - - Get the policy document as a human readable string. - - Human readable policy document. - - - - JSON representation of this object - - JSON string - - - - XML Representation of this object - - XML String - - - - Create an instance of this class from a JSON string. - - JSON string - Instance of S3PostUploadSignedPolicy - - - - Create an instance of this class from an XML string. - - XML string generated by ToXml() - Instance of S3PostUploadSignedPolicy - - - - Interface for accessing S3 - - - - - - - Create a signed URL allowing access to a resource that would - usually require authentication. - - - - When using query string authentication you create a query, - specify an expiration time for the query, sign it with your - signature, place the data in an HTTP request, and distribute - the request to a user or embed the request in a web page. - - - A PreSigned URL can be generated for GET, PUT, DELETE and HEAD - operations on your bucketName, keys, and versions. - - - The GetPreSignedUrlRequest that defines the - parameters of the operation. - A string that is the signed http request. - - - - - - This operation aborts a multipart upload. After a multipart upload is aborted, no - additional parts can be uploaded using that upload ID. The storage consumed by any - previously uploaded parts will be freed. However, if any part uploads are currently - in progress, those part uploads might or might not succeed. As a result, it might - be necessary to abort a given multipart upload multiple times in order to completely - free all storage consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts operation and ensure that the parts - list is empty. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - The bucket name to which the upload was taking place. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object for which the multipart upload was initiated. - Upload ID that identifies the multipart upload. - - The response from the AbortMultipartUpload service method, as returned by S3. - REST API Reference for AbortMultipartUpload Operation - - - - This operation aborts a multipart upload. After a multipart upload is aborted, no - additional parts can be uploaded using that upload ID. The storage consumed by any - previously uploaded parts will be freed. However, if any part uploads are currently - in progress, those part uploads might or might not succeed. As a result, it might - be necessary to abort a given multipart upload multiple times in order to completely - free all storage consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts operation and ensure that the parts - list is empty. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - Container for the necessary parameters to execute the AbortMultipartUpload service method. - - The response from the AbortMultipartUpload service method, as returned by S3. - REST API Reference for AbortMultipartUpload Operation - - - - Initiates the asynchronous execution of the AbortMultipartUpload operation. - - - Container for the necessary parameters to execute the AbortMultipartUpload operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAbortMultipartUpload - operation. - REST API Reference for AbortMultipartUpload Operation - - - - Finishes the asynchronous execution of the AbortMultipartUpload operation. - - - The IAsyncResult returned by the call to BeginAbortMultipartUpload. - - Returns a AbortMultipartUploadResult from S3. - REST API Reference for AbortMultipartUpload Operation - - - - Completes a multipart upload by assembling previously uploaded parts. - - - - You first initiate the multipart upload and then upload all parts using the UploadPart - operation. After successfully uploading all relevant parts of an upload, you call - this operation to complete the upload. Upon receiving this request, Amazon S3 concatenates - all the parts in ascending order by part number to create a new object. In the Complete - Multipart Upload request, you must provide the parts list. You must ensure that the - parts list is complete. This operation concatenates the parts that you provide in - the list. For each part in the list, you must provide the part number and the ETag - value, returned after that part was uploaded. - - - - Processing of a Complete Multipart Upload request could take several minutes to complete. - After Amazon S3 begins processing the request, it sends an HTTP response header that - specifies a 200 OK response. While processing is in progress, Amazon S3 periodically - sends white space characters to keep the connection from timing out. Because a request - could fail after the initial 200 OK response has been sent, it is important that you - check the response body to determine whether the request succeeded. - - - - Note that if CompleteMultipartUpload fails, applications should be prepared - to retry the failed requests. For more information, see Amazon - S3 Error Best Practices. - - - - For more information about multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - GetBucketLifecycle has the following special errors: - -
  • - - Error code: EntityTooSmall - -
    • - - Description: Your proposed upload is smaller than the minimum allowed object size. - Each part must be at least 5 MB in size, except the last part. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPart - -
    • - - Description: One or more of the specified parts could not be found. The part might - not have been uploaded, or the specified entity tag might not have matched the part's - entity tag. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPartOrder - -
    • - - Description: The list of parts was not in ascending order. The parts list must be - specified in order by part number. - -
    • - - 400 Bad Request - -
  • - - Error code: NoSuchUpload - -
    • - - Description: The specified multipart upload does not exist. The upload ID might be - invalid, or the multipart upload might have been aborted or completed. - -
    • - - 404 Not Found - -
- - The following operations are related to CompleteMultipartUpload: - - - - Container for the necessary parameters to execute the CompleteMultipartUpload service method. - - The response from the CompleteMultipartUpload service method, as returned by S3. - REST API Reference for CompleteMultipartUpload Operation - - - - Initiates the asynchronous execution of the CompleteMultipartUpload operation. - - - Container for the necessary parameters to execute the CompleteMultipartUpload operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCompleteMultipartUpload - operation. - REST API Reference for CompleteMultipartUpload Operation - - - - Finishes the asynchronous execution of the CompleteMultipartUpload operation. - - - The IAsyncResult returned by the call to BeginCompleteMultipartUpload. - - Returns a CompleteMultipartUploadResult from S3. - REST API Reference for CompleteMultipartUpload Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 Developer Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Encryption - - - - The source object that you are copying can be encrypted or unencrypted. The source - object can be encrypted with server-side encryption using AWS managed encryption keys - (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side - encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers - and decrypts the data when you access it. - - - - You can optionally use the appropriate encryption-related headers to request server-side - encryption for the target object. You have the option to provide your own encryption - key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that - was used to encrypt the source object. You can even request encryption if the source - object was not encrypted. For more information about server-side encryption, see Using - Server-Side Encryption. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject operation to change the storage class of an - object that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 Service Developer Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 Developer Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Encryption - - - - The source object that you are copying can be encrypted or unencrypted. The source - object can be encrypted with server-side encryption using AWS managed encryption keys - (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side - encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers - and decrypts the data when you access it. - - - - You can optionally use the appropriate encryption-related headers to request server-side - encryption for the target object. You have the option to provide your own encryption - key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that - was used to encrypt the source object. You can even request encryption if the source - object was not encrypted. For more information about server-side encryption, see Using - Server-Side Encryption. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject operation to change the storage class of an - object that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 Service Developer Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 Developer Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Encryption - - - - The source object that you are copying can be encrypted or unencrypted. The source - object can be encrypted with server-side encryption using AWS managed encryption keys - (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side - encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers - and decrypts the data when you access it. - - - - You can optionally use the appropriate encryption-related headers to request server-side - encryption for the target object. You have the option to provide your own encryption - key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that - was used to encrypt the source object. You can even request encryption if the source - object was not encrypted. For more information about server-side encryption, see Using - Server-Side Encryption. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject operation to change the storage class of an - object that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 Service Developer Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - Container for the necessary parameters to execute the CopyObject service method. - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - Initiates the asynchronous execution of the CopyObject operation. - - - Container for the necessary parameters to execute the CopyObject operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCopyObject - operation. - REST API Reference for CopyObject Operation - - - - Finishes the asynchronous execution of the CopyObject operation. - - - The IAsyncResult returned by the call to BeginCopyObject. - - Returns a CopyObjectResult from S3. - REST API Reference for CopyObject Operation - - - - - - - Initiates the asynchronous execution of the CopyPart operation. - - - Container for the necessary parameters to execute the CopyPart operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCopyPart - operation. - REST API Reference for CopyPart Operation - - - - Finishes the asynchronous execution of the CopyPart operation. - - - The IAsyncResult returned by the call to BeginCopyPart. - - Returns a CopyPartResult from S3. - REST API Reference for CopyPart Operation - - - - - - Initiates the asynchronous execution of the DeleteBucket operation. - - - Container for the necessary parameters to execute the DeleteBucket operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteBucket - operation. - REST API Reference for DeleteBucket Operation - - - - Finishes the asynchronous execution of the DeleteBucket operation. - - - The IAsyncResult returned by the call to BeginDeleteBucket. - - Returns a DeleteBucketResult from S3. - REST API Reference for DeleteBucket Operation - - - - Deletes an analytics configuration for the bucket (specified by the analytics configuration - ID). - - - - To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to DeleteBucketAnalyticsConfiguration: - -
  • - - - -
  • - - - -
  • - - - -
- - Container for the necessary parameters to execute the DeleteBucketAnalyticsConfiguration service method. - - The response from the DeleteBucketAnalyticsConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketAnalyticsConfiguration Operation - - - - Initiates the asynchronous execution of the DeleteBucketAnalyticsConfiguration operation. - - - Container for the necessary parameters to execute the DeleteBucketAnalyticsConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteBucketAnalyticsConfiguration - operation. - REST API Reference for DeleteBucketAnalyticsConfiguration Operation - - - - Finishes the asynchronous execution of the DeleteBucketAnalyticsConfiguration operation. - - - The IAsyncResult returned by the call to BeginDeleteBucketAnalyticsConfiguration. - - Returns a DeleteBucketAnalyticsConfigurationResult from S3. - REST API Reference for DeleteBucketAnalyticsConfiguration Operation - - - - - Initiates the asynchronous execution of the DeleteBucketEncryption operation. - - - Container for the necessary parameters to execute the DeleteBucketEncryption operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteBucketEncryption - operation. - REST API Reference for DeleteBucketEncryption Operation - - - - Finishes the asynchronous execution of the DeleteBucketEncryption operation. - - - The IAsyncResult returned by the call to BeginDeleteBucketEncryption. - - Returns a DeleteBucketEncryptionResult from S3. - REST API Reference for DeleteBucketEncryption Operation - - - - Deletes an inventory configuration (identified by the inventory ID) from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - Operations related to DeleteBucketInventoryConfiguration include: - - - - Container for the necessary parameters to execute the DeleteBucketInventoryConfiguration service method. - - The response from the DeleteBucketInventoryConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketInventoryConfiguration Operation - - - - Initiates the asynchronous execution of the DeleteBucketInventoryConfiguration operation. - - - Container for the necessary parameters to execute the DeleteBucketInventoryConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteBucketInventoryConfiguration - operation. - REST API Reference for DeleteBucketInventoryConfiguration Operation - - - - Finishes the asynchronous execution of the DeleteBucketInventoryConfiguration operation. - - - The IAsyncResult returned by the call to BeginDeleteBucketInventoryConfiguration. - - Returns a DeleteBucketInventoryConfigurationResult from S3. - REST API Reference for DeleteBucketInventoryConfiguration Operation - - - - Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified - by the metrics configuration ID) from the bucket. Note that this doesn't include the - daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteBucketMetricsConfiguration service method. - - The response from the DeleteBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketMetricsConfiguration Operation - - - - Initiates the asynchronous execution of the DeleteBucketMetricsConfiguration operation. - - - Container for the necessary parameters to execute the DeleteBucketMetricsConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteBucketMetricsConfiguration - operation. - REST API Reference for DeleteBucketMetricsConfiguration Operation - - - - Finishes the asynchronous execution of the DeleteBucketMetricsConfiguration operation. - - - The IAsyncResult returned by the call to BeginDeleteBucketMetricsConfiguration. - - Returns a DeleteBucketMetricsConfigurationResult from S3. - REST API Reference for DeleteBucketMetricsConfiguration Operation - - - - This implementation of the DELETE operation uses the policy subresource to delete - the policy of a specified bucket. If you are using an identity other than the root - user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - The bucket name. - - The response from the DeleteBucketPolicy service method, as returned by S3. - REST API Reference for DeleteBucketPolicy Operation - - - - This implementation of the DELETE operation uses the policy subresource to delete - the policy of a specified bucket. If you are using an identity other than the root - user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - Container for the necessary parameters to execute the DeleteBucketPolicy service method. - - The response from the DeleteBucketPolicy service method, as returned by S3. - REST API Reference for DeleteBucketPolicy Operation - - - - Initiates the asynchronous execution of the DeleteBucketPolicy operation. - - - Container for the necessary parameters to execute the DeleteBucketPolicy operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteBucketPolicy - operation. - REST API Reference for DeleteBucketPolicy Operation - - - - Finishes the asynchronous execution of the DeleteBucketPolicy operation. - - - The IAsyncResult returned by the call to BeginDeleteBucketPolicy. - - Returns a DeleteBucketPolicyResult from S3. - REST API Reference for DeleteBucketPolicy Operation - - - - Deletes the replication configuration from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutReplicationConfiguration - action. The bucket owner has these permissions by default and can grant it to others. - For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - It can take a while for the deletion of a replication configuration to fully propagate. - - - - For information about replication configuration, see Replication - in the Amazon S3 Developer Guide. - - - - The following operations are related to DeleteBucketReplication: - - - - Container for the necessary parameters to execute the DeleteBucketReplication service method. - - The response from the DeleteBucketReplication service method, as returned by S3. - REST API Reference for DeleteBucketReplication Operation - - - - Initiates the asynchronous execution of the DeleteBucketReplication operation. - - - Container for the necessary parameters to execute the DeleteBucketReplication operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteBucketReplication - operation. - REST API Reference for DeleteBucketReplication Operation - - - - Finishes the asynchronous execution of the DeleteBucketReplication operation. - - - The IAsyncResult returned by the call to BeginDeleteBucketReplication. - - Returns a DeleteBucketReplicationResult from S3. - REST API Reference for DeleteBucketReplication Operation - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - The bucket that has the tag set to be removed. - - The response from the DeleteBucketTagging service method, as returned by S3. - REST API Reference for DeleteBucketTagging Operation - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - Container for the necessary parameters to execute the DeleteBucketTagging service method. - - The response from the DeleteBucketTagging service method, as returned by S3. - REST API Reference for DeleteBucketTagging Operation - - - - Initiates the asynchronous execution of the DeleteBucketTagging operation. - - - Container for the necessary parameters to execute the DeleteBucketTagging operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteBucketTagging - operation. - REST API Reference for DeleteBucketTagging Operation - - - - Finishes the asynchronous execution of the DeleteBucketTagging operation. - - - The IAsyncResult returned by the call to BeginDeleteBucketTagging. - - Returns a DeleteBucketTaggingResult from S3. - REST API Reference for DeleteBucketTagging Operation - - - - This operation removes the website configuration for a bucket. Amazon S3 returns a - 200 OK response upon successfully deleting a website configuration on - the specified bucket. You will get a 200 OK response if the website configuration - you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE operation requires the S3:DeleteBucketWebsite permission. - By default, only the bucket owner can delete the website configuration attached to - a bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which you want to remove the website configuration. - - The response from the DeleteBucketWebsite service method, as returned by S3. - REST API Reference for DeleteBucketWebsite Operation - - - - This operation removes the website configuration for a bucket. Amazon S3 returns a - 200 OK response upon successfully deleting a website configuration on - the specified bucket. You will get a 200 OK response if the website configuration - you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE operation requires the S3:DeleteBucketWebsite permission. - By default, only the bucket owner can delete the website configuration attached to - a bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the DeleteBucketWebsite service method. - - The response from the DeleteBucketWebsite service method, as returned by S3. - REST API Reference for DeleteBucketWebsite Operation - - - - Initiates the asynchronous execution of the DeleteBucketWebsite operation. - - - Container for the necessary parameters to execute the DeleteBucketWebsite operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteBucketWebsite - operation. - REST API Reference for DeleteBucketWebsite Operation - - - - Finishes the asynchronous execution of the DeleteBucketWebsite operation. - - - The IAsyncResult returned by the call to BeginDeleteBucketWebsite. - - Returns a DeleteBucketWebsiteResult from S3. - REST API Reference for DeleteBucketWebsite Operation - - - - - - Initiates the asynchronous execution of the DeleteCORSConfiguration operation. - - - Container for the necessary parameters to execute the DeleteCORSConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteCORSConfiguration - operation. - REST API Reference for DeleteCORSConfiguration Operation - - - - Finishes the asynchronous execution of the DeleteCORSConfiguration operation. - - - The IAsyncResult returned by the call to BeginDeleteCORSConfiguration. - - Returns a DeleteCORSConfigurationResult from S3. - REST API Reference for DeleteCORSConfiguration Operation - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - The bucket name of the lifecycle to delete. - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - REST API Reference for DeleteLifecycleConfiguration Operation - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - Container for the necessary parameters to execute the DeleteLifecycleConfiguration service method. - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - REST API Reference for DeleteLifecycleConfiguration Operation - - - - Initiates the asynchronous execution of the DeleteLifecycleConfiguration operation. - - - Container for the necessary parameters to execute the DeleteLifecycleConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteLifecycleConfiguration - operation. - REST API Reference for DeleteLifecycleConfiguration Operation - - - - Finishes the asynchronous execution of the DeleteLifecycleConfiguration operation. - - - The IAsyncResult returned by the call to BeginDeleteLifecycleConfiguration. - - Returns a DeleteLifecycleConfigurationResult from S3. - REST API Reference for DeleteLifecycleConfiguration Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key name of the object to delete. - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key name of the object to delete. - VersionId used to reference a specific version of the object. - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - Container for the necessary parameters to execute the DeleteObject service method. - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - Initiates the asynchronous execution of the DeleteObject operation. - - - Container for the necessary parameters to execute the DeleteObject operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteObject - operation. - REST API Reference for DeleteObject Operation - - - - Finishes the asynchronous execution of the DeleteObject operation. - - - The IAsyncResult returned by the call to BeginDeleteObject. - - Returns a DeleteObjectResult from S3. - REST API Reference for DeleteObject Operation - - - - This operation enables you to delete multiple objects from a bucket using a single - HTTP request. If you know the object keys that you want to delete, then this operation - provides a suitable alternative to sending individual delete requests, reducing per-request - overhead. - - - - The request contains a list of up to 1000 keys that you want to delete. In the XML, - you provide the object key names, and optionally, version IDs if you want to delete - a specific version of the object from a versioning-enabled bucket. For each key, Amazon - S3 performs a delete operation and returns the result of that delete, success, or - failure, in the response. Note that if the object specified in the request is not - found, Amazon S3 returns the result as deleted. - - - - The operation supports two modes for the response: verbose and quiet. By default, - the operation uses verbose mode in which the response includes the result of deletion - of each key in your request. In quiet mode the response includes only keys where the - delete operation encountered an error. For a successful deletion, the operation does - not return any information about the delete in the response body. - - - - When performing this operation on an MFA Delete enabled bucket, that attempts to delete - any versioned objects, you must include an MFA token. If you do not provide one, the - entire request will fail, even if there are non-versioned objects you are trying to - delete. If you provide an invalid token, whether there are versioned keys in the request - or not, the entire Multi-Object Delete request will fail. For information about MFA - Delete, see - MFA Delete. - - - - Finally, the Content-MD5 header is required for all Multi-Object Delete requests. - Amazon S3 uses the header value to ensure that your request body has not been altered - in transit. - - - - The following operations are related to DeleteObjects: - - - - Container for the necessary parameters to execute the DeleteObjects service method. - - The response from the DeleteObjects service method, as returned by S3. - REST API Reference for DeleteObjects Operation - - - - Initiates the asynchronous execution of the DeleteObjects operation. - - - Container for the necessary parameters to execute the DeleteObjects operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteObjects - operation. - REST API Reference for DeleteObjects Operation - - - - Finishes the asynchronous execution of the DeleteObjects operation. - - - The IAsyncResult returned by the call to BeginDeleteObjects. - - Returns a DeleteObjectsResult from S3. - REST API Reference for DeleteObjects Operation - - - - Removes the entire tag set from the specified object. For more information about managing - object tags, see - Object Tagging. - - - - To use this operation, you must have permission to perform the s3:DeleteObjectTagging - action. - - - - To delete tags of a specific object version, add the versionId query - parameter in the request. You will need permission for the s3:DeleteObjectVersionTagging - action. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteObjectTagging service method. - - The response from the DeleteObjectTagging service method, as returned by S3. - REST API Reference for DeleteObjectTagging Operation - - - - Initiates the asynchronous execution of the DeleteObjectTagging operation. - - - Container for the necessary parameters to execute the DeleteObjectTagging operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteObjectTagging - operation. - REST API Reference for DeleteObjectTagging Operation - - - - Finishes the asynchronous execution of the DeleteObjectTagging operation. - - - The IAsyncResult returned by the call to BeginDeleteObjectTagging. - - Returns a DeleteObjectTaggingResult from S3. - REST API Reference for DeleteObjectTagging Operation - - - - Removes the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:PutBucketPublicAccessBlock - permission. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to DeletePublicAccessBlock: - - - - Container for the necessary parameters to execute the DeletePublicAccessBlock service method. - - The response from the DeletePublicAccessBlock service method, as returned by S3. - REST API Reference for DeletePublicAccessBlock Operation - - - - Initiates the asynchronous execution of the DeletePublicAccessBlock operation. - - - Container for the necessary parameters to execute the DeletePublicAccessBlock operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeletePublicAccessBlock - operation. - REST API Reference for DeletePublicAccessBlock Operation - - - - Finishes the asynchronous execution of the DeletePublicAccessBlock operation. - - - The IAsyncResult returned by the call to BeginDeletePublicAccessBlock. - - Returns a DeletePublicAccessBlockResult from S3. - REST API Reference for DeletePublicAccessBlock Operation - - - - - - Initiates the asynchronous execution of the GetACL operation. - - - Container for the necessary parameters to execute the GetACL operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetACL - operation. - REST API Reference for GetACL Operation - - - - Finishes the asynchronous execution of the GetACL operation. - - - The IAsyncResult returned by the call to BeginGetACL. - - Returns a GetACLResult from S3. - REST API Reference for GetACL Operation - - - - - - Initiates the asynchronous execution of the GetBucketAccelerateConfiguration operation. - - - Container for the necessary parameters to execute the GetBucketAccelerateConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketAccelerateConfiguration - operation. - REST API Reference for GetBucketAccelerateConfiguration Operation - - - - Finishes the asynchronous execution of the GetBucketAccelerateConfiguration operation. - - - The IAsyncResult returned by the call to BeginGetBucketAccelerateConfiguration. - - Returns a GetBucketAccelerateConfigurationResult from S3. - REST API Reference for GetBucketAccelerateConfiguration Operation - - - - - Initiates the asynchronous execution of the GetBucketAnalyticsConfiguration operation. - - - Container for the necessary parameters to execute the GetBucketAnalyticsConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketAnalyticsConfiguration - operation. - REST API Reference for GetBucketAnalyticsConfiguration Operation - - - - Finishes the asynchronous execution of the GetBucketAnalyticsConfiguration operation. - - - The IAsyncResult returned by the call to BeginGetBucketAnalyticsConfiguration. - - Returns a GetBucketAnalyticsConfigurationResult from S3. - REST API Reference for GetBucketAnalyticsConfiguration Operation - - - - Returns the default encryption configuration for an Amazon S3 bucket. For information - about the Amazon S3 default encryption feature, see Amazon - S3 Default Bucket Encryption. - - - - To use this operation, you must have permission to perform the s3:GetEncryptionConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to GetBucketEncryption: - - - - Container for the necessary parameters to execute the GetBucketEncryption service method. - - The response from the GetBucketEncryption service method, as returned by S3. - REST API Reference for GetBucketEncryption Operation - - - - Initiates the asynchronous execution of the GetBucketEncryption operation. - - - Container for the necessary parameters to execute the GetBucketEncryption operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketEncryption - operation. - REST API Reference for GetBucketEncryption Operation - - - - Finishes the asynchronous execution of the GetBucketEncryption operation. - - - The IAsyncResult returned by the call to BeginGetBucketEncryption. - - Returns a GetBucketEncryptionResult from S3. - REST API Reference for GetBucketEncryption Operation - - - - Returns an inventory configuration (identified by the inventory configuration ID) - from the bucket. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - The following operations are related to GetBucketInventoryConfiguration: - - - - Container for the necessary parameters to execute the GetBucketInventoryConfiguration service method. - - The response from the GetBucketInventoryConfiguration service method, as returned by S3. - REST API Reference for GetBucketInventoryConfiguration Operation - - - - Initiates the asynchronous execution of the GetBucketInventoryConfiguration operation. - - - Container for the necessary parameters to execute the GetBucketInventoryConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketInventoryConfiguration - operation. - REST API Reference for GetBucketInventoryConfiguration Operation - - - - Finishes the asynchronous execution of the GetBucketInventoryConfiguration operation. - - - The IAsyncResult returned by the call to BeginGetBucketInventoryConfiguration. - - Returns a GetBucketInventoryConfigurationResult from S3. - REST API Reference for GetBucketInventoryConfiguration Operation - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - The name of the bucket for which to get the location. - - The response from the GetBucketLocation service method, as returned by S3. - REST API Reference for GetBucketLocation Operation - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - Container for the necessary parameters to execute the GetBucketLocation service method. - - The response from the GetBucketLocation service method, as returned by S3. - REST API Reference for GetBucketLocation Operation - - - - Initiates the asynchronous execution of the GetBucketLocation operation. - - - Container for the necessary parameters to execute the GetBucketLocation operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketLocation - operation. - REST API Reference for GetBucketLocation Operation - - - - Finishes the asynchronous execution of the GetBucketLocation operation. - - - The IAsyncResult returned by the call to BeginGetBucketLocation. - - Returns a GetBucketLocationResult from S3. - REST API Reference for GetBucketLocation Operation - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - The bucket name for which to get the logging information. - - The response from the GetBucketLogging service method, as returned by S3. - REST API Reference for GetBucketLogging Operation - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - Container for the necessary parameters to execute the GetBucketLogging service method. - - The response from the GetBucketLogging service method, as returned by S3. - REST API Reference for GetBucketLogging Operation - - - - Initiates the asynchronous execution of the GetBucketLogging operation. - - - Container for the necessary parameters to execute the GetBucketLogging operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketLogging - operation. - REST API Reference for GetBucketLogging Operation - - - - Finishes the asynchronous execution of the GetBucketLogging operation. - - - The IAsyncResult returned by the call to BeginGetBucketLogging. - - Returns a GetBucketLoggingResult from S3. - REST API Reference for GetBucketLogging Operation - - - - Gets a metrics configuration (specified by the metrics configuration ID) from the - bucket. Note that this doesn't include the daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to GetBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the GetBucketMetricsConfiguration service method. - - The response from the GetBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for GetBucketMetricsConfiguration Operation - - - - Initiates the asynchronous execution of the GetBucketMetricsConfiguration operation. - - - Container for the necessary parameters to execute the GetBucketMetricsConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketMetricsConfiguration - operation. - REST API Reference for GetBucketMetricsConfiguration Operation - - - - Finishes the asynchronous execution of the GetBucketMetricsConfiguration operation. - - - The IAsyncResult returned by the call to BeginGetBucketMetricsConfiguration. - - Returns a GetBucketMetricsConfigurationResult from S3. - REST API Reference for GetBucketMetricsConfiguration Operation - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following operation is related to GetBucketNotification: - - - - Name of the bucket for which to get the notification configuration. - - The response from the GetBucketNotification service method, as returned by S3. - REST API Reference for GetBucketNotification Operation - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following operation is related to GetBucketNotification: - - - - Container for the necessary parameters to execute the GetBucketNotification service method. - - The response from the GetBucketNotification service method, as returned by S3. - REST API Reference for GetBucketNotification Operation - - - - Initiates the asynchronous execution of the GetBucketNotification operation. - - - Container for the necessary parameters to execute the GetBucketNotification operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketNotification - operation. - REST API Reference for GetBucketNotification Operation - - - - Finishes the asynchronous execution of the GetBucketNotification operation. - - - The IAsyncResult returned by the call to BeginGetBucketNotification. - - Returns a GetBucketNotificationResult from S3. - REST API Reference for GetBucketNotification Operation - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operation is related to GetBucketPolicy: - - - - The bucket name for which to get the bucket policy. - - The response from the GetBucketPolicy service method, as returned by S3. - REST API Reference for GetBucketPolicy Operation - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operation is related to GetBucketPolicy: - - - - Container for the necessary parameters to execute the GetBucketPolicy service method. - - The response from the GetBucketPolicy service method, as returned by S3. - REST API Reference for GetBucketPolicy Operation - - - - Initiates the asynchronous execution of the GetBucketPolicy operation. - - - Container for the necessary parameters to execute the GetBucketPolicy operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketPolicy - operation. - REST API Reference for GetBucketPolicy Operation - - - - Finishes the asynchronous execution of the GetBucketPolicy operation. - - - The IAsyncResult returned by the call to BeginGetBucketPolicy. - - Returns a GetBucketPolicyResult from S3. - REST API Reference for GetBucketPolicy Operation - - - - Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket - is public. In order to use this operation, you must have the s3:GetBucketPolicyStatus - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - For more information about when Amazon S3 considers a bucket public, see The - Meaning of "Public". - - - - The following operations are related to GetBucketPolicyStatus: - - - - Container for the necessary parameters to execute the GetBucketPolicyStatus service method. - - The response from the GetBucketPolicyStatus service method, as returned by S3. - REST API Reference for GetBucketPolicyStatus Operation - - - - Initiates the asynchronous execution of the GetBucketPolicyStatus operation. - - - Container for the necessary parameters to execute the GetBucketPolicyStatus operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketPolicyStatus - operation. - REST API Reference for GetBucketPolicyStatus Operation - - - - Finishes the asynchronous execution of the GetBucketPolicyStatus operation. - - - The IAsyncResult returned by the call to BeginGetBucketPolicyStatus. - - Returns a GetBucketPolicyStatusResult from S3. - REST API Reference for GetBucketPolicyStatus Operation - - - - Retrieves the replication configuration for the given Amazon S3 bucket. - - Container for the necessary parameters to execute the GetBucketReplication service method. - - The response from the GetBucketReplication service method, as returned by S3. - REST API Reference for GetBucketReplication Operation - - - - Initiates the asynchronous execution of the GetBucketReplication operation. - - - Container for the necessary parameters to execute the GetBucketReplication operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketReplication - operation. - REST API Reference for GetBucketReplication Operation - - - - Finishes the asynchronous execution of the GetBucketReplication operation. - - - The IAsyncResult returned by the call to BeginGetBucketReplication. - - Returns a GetBucketReplicationResult from S3. - REST API Reference for GetBucketReplication Operation - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - The name of the bucket for which to get the payment request configuration - - The response from the GetBucketRequestPayment service method, as returned by S3. - REST API Reference for GetBucketRequestPayment Operation - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - Container for the necessary parameters to execute the GetBucketRequestPayment service method. - - The response from the GetBucketRequestPayment service method, as returned by S3. - REST API Reference for GetBucketRequestPayment Operation - - - - Initiates the asynchronous execution of the GetBucketRequestPayment operation. - - - Container for the necessary parameters to execute the GetBucketRequestPayment operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketRequestPayment - operation. - REST API Reference for GetBucketRequestPayment Operation - - - - Finishes the asynchronous execution of the GetBucketRequestPayment operation. - - - The IAsyncResult returned by the call to BeginGetBucketRequestPayment. - - Returns a GetBucketRequestPaymentResult from S3. - REST API Reference for GetBucketRequestPayment Operation - - - - Returns the tag set associated with the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - GetBucketTagging has the following special error: - -
  • - - Error code: NoSuchTagSetError - -
    • - - Description: There is no tag set associated with the bucket. - -
- - The following operations are related to GetBucketTagging: - - - - Container for the necessary parameters to execute the GetBucketTagging service method. - - The response from the GetBucketTagging service method, as returned by S3. - REST API Reference for GetBucketTagging Operation - - - - Initiates the asynchronous execution of the GetBucketTagging operation. - - - Container for the necessary parameters to execute the GetBucketTagging operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketTagging - operation. - REST API Reference for GetBucketTagging Operation - - - - Finishes the asynchronous execution of the GetBucketTagging operation. - - - The IAsyncResult returned by the call to BeginGetBucketTagging. - - Returns a GetBucketTaggingResult from S3. - REST API Reference for GetBucketTagging Operation - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - The name of the bucket for which to get the versioning information. - - The response from the GetBucketVersioning service method, as returned by S3. - REST API Reference for GetBucketVersioning Operation - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - Container for the necessary parameters to execute the GetBucketVersioning service method. - - The response from the GetBucketVersioning service method, as returned by S3. - REST API Reference for GetBucketVersioning Operation - - - - Initiates the asynchronous execution of the GetBucketVersioning operation. - - - Container for the necessary parameters to execute the GetBucketVersioning operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketVersioning - operation. - REST API Reference for GetBucketVersioning Operation - - - - Finishes the asynchronous execution of the GetBucketVersioning operation. - - - The IAsyncResult returned by the call to BeginGetBucketVersioning. - - Returns a GetBucketVersioningResult from S3. - REST API Reference for GetBucketVersioning Operation - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET operation requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which to get the website configuration. - - The response from the GetBucketWebsite service method, as returned by S3. - REST API Reference for GetBucketWebsite Operation - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET operation requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the GetBucketWebsite service method. - - The response from the GetBucketWebsite service method, as returned by S3. - REST API Reference for GetBucketWebsite Operation - - - - Initiates the asynchronous execution of the GetBucketWebsite operation. - - - Container for the necessary parameters to execute the GetBucketWebsite operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketWebsite - operation. - REST API Reference for GetBucketWebsite Operation - - - - Finishes the asynchronous execution of the GetBucketWebsite operation. - - - The IAsyncResult returned by the call to BeginGetBucketWebsite. - - Returns a GetBucketWebsiteResult from S3. - REST API Reference for GetBucketWebsite Operation - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - The bucket name for which to get the cors configuration. - - The response from the GetCORSConfiguration service method, as returned by S3. - REST API Reference for GetCORSConfiguration Operation - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - Container for the necessary parameters to execute the GetCORSConfiguration service method. - - The response from the GetCORSConfiguration service method, as returned by S3. - REST API Reference for GetCORSConfiguration Operation - - - - Initiates the asynchronous execution of the GetCORSConfiguration operation. - - - Container for the necessary parameters to execute the GetCORSConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetCORSConfiguration - operation. - REST API Reference for GetCORSConfiguration Operation - - - - Finishes the asynchronous execution of the GetCORSConfiguration operation. - - - The IAsyncResult returned by the call to BeginGetCORSConfiguration. - - Returns a GetCORSConfigurationResult from S3. - REST API Reference for GetCORSConfiguration Operation - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are still using previous version of the lifecycle configuration, it works. - For the earlier API description, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to GetBucketLifecycleConfiguration: - - - - The name of the bucket for which to get the lifecycle information. - - The response from the GetLifecycleConfiguration service method, as returned by S3. - REST API Reference for GetLifecycleConfiguration Operation - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are still using previous version of the lifecycle configuration, it works. - For the earlier API description, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to GetBucketLifecycleConfiguration: - - - - Container for the necessary parameters to execute the GetLifecycleConfiguration service method. - - The response from the GetLifecycleConfiguration service method, as returned by S3. - REST API Reference for GetLifecycleConfiguration Operation - - - - Initiates the asynchronous execution of the GetLifecycleConfiguration operation. - - - Container for the necessary parameters to execute the GetLifecycleConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetLifecycleConfiguration - operation. - REST API Reference for GetLifecycleConfiguration Operation - - - - Finishes the asynchronous execution of the GetLifecycleConfiguration operation. - - - The IAsyncResult returned by the call to BeginGetLifecycleConfiguration. - - Returns a GetLifecycleConfigurationResult from S3. - REST API Reference for GetLifecycleConfiguration Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object to get. - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object to get. - VersionId used to reference a specific version of the object. - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - Container for the necessary parameters to execute the GetObject service method. - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Initiates the asynchronous execution of the GetObject operation. - - - Container for the necessary parameters to execute the GetObject operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetObject - operation. - REST API Reference for GetObject Operation - - - - Finishes the asynchronous execution of the GetObject operation. - - - The IAsyncResult returned by the call to BeginGetObject. - - Returns a GetObjectResult from S3. - REST API Reference for GetObject Operation - - - - Gets an object's current Legal Hold status. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLegalHold service method. - - The response from the GetObjectLegalHold service method, as returned by S3. - REST API Reference for GetObjectLegalHold Operation - - - - Initiates the asynchronous execution of the GetObjectLegalHold operation. - - - Container for the necessary parameters to execute the GetObjectLegalHold operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetObjectLegalHold - operation. - REST API Reference for GetObjectLegalHold Operation - - - - Finishes the asynchronous execution of the GetObjectLegalHold operation. - - - The IAsyncResult returned by the call to BeginGetObjectLegalHold. - - Returns a GetObjectLegalHoldResult from S3. - REST API Reference for GetObjectLegalHold Operation - - - - Gets the Object Lock configuration for a bucket. The rule specified in the Object - Lock configuration will be applied by default to every new object placed in the specified - bucket. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLockConfiguration service method. - - The response from the GetObjectLockConfiguration service method, as returned by S3. - REST API Reference for GetObjectLockConfiguration Operation - - - - Initiates the asynchronous execution of the GetObjectLockConfiguration operation. - - - Container for the necessary parameters to execute the GetObjectLockConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetObjectLockConfiguration - operation. - REST API Reference for GetObjectLockConfiguration Operation - - - - Finishes the asynchronous execution of the GetObjectLockConfiguration operation. - - - The IAsyncResult returned by the call to BeginGetObjectLockConfiguration. - - Returns a GetObjectLockConfigurationResult from S3. - REST API Reference for GetObjectLockConfiguration Operation - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - The name of the bucket containing the object. - The object key. - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - The name of the bucket containing the object. - The object key. - VersionId used to reference a specific version of the object. - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - Container for the necessary parameters to execute the GetObjectMetadata service method. - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - Initiates the asynchronous execution of the GetObjectMetadata operation. - - - Container for the necessary parameters to execute the GetObjectMetadata operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetObjectMetadata - operation. - REST API Reference for GetObjectMetadata Operation - - - - Finishes the asynchronous execution of the GetObjectMetadata operation. - - - The IAsyncResult returned by the call to BeginGetObjectMetadata. - - Returns a GetObjectMetadataResult from S3. - REST API Reference for GetObjectMetadata Operation - - - - Retrieves an object's retention settings. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectRetention service method. - - The response from the GetObjectRetention service method, as returned by S3. - REST API Reference for GetObjectRetention Operation - - - - Initiates the asynchronous execution of the GetObjectRetention operation. - - - Container for the necessary parameters to execute the GetObjectRetention operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetObjectRetention - operation. - REST API Reference for GetObjectRetention Operation - - - - Finishes the asynchronous execution of the GetObjectRetention operation. - - - The IAsyncResult returned by the call to BeginGetObjectRetention. - - Returns a GetObjectRetentionResult from S3. - REST API Reference for GetObjectRetention Operation - - - - Returns the tag-set of an object. You send the GET request against the tagging subresource - associated with the object. - - - - To use this operation, you must have permission to perform the s3:GetObjectTagging - action. By default, the GET operation returns information about current version of - an object. For a versioned bucket, you can have multiple versions of an object in - your bucket. To retrieve tags of any other version, use the versionId query parameter. - You also need permission for the s3:GetObjectVersionTagging action. - - - - By default, the bucket owner has this permission and can grant this permission to - others. - - - - For information about the Amazon S3 object tagging feature, see Object - Tagging. - - - - The following operation is related to GetObjectTagging: - - - - Container for the necessary parameters to execute the GetObjectTagging service method. - - The response from the GetObjectTagging service method, as returned by S3. - REST API Reference for GetObjectTagging Operation - - - - Initiates the asynchronous execution of the GetObjectTagging operation. - - - Container for the necessary parameters to execute the GetObjectTagging operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetObjectTagging - operation. - REST API Reference for GetObjectTagging Operation - - - - Finishes the asynchronous execution of the GetObjectTagging operation. - - - The IAsyncResult returned by the call to BeginGetObjectTagging. - - Returns a GetObjectTaggingResult from S3. - REST API Reference for GetObjectTagging Operation - - - - Return torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Amazon - S3 Torrent. - - - - You can get torrent only for objects that are less than 5 GB in size and that are - not encrypted using server-side encryption with customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - The following operation is related to GetObjectTorrent: - - - - The name of the bucket containing the object for which to get the torrent files. - The object key for which to get the information. - - The response from the GetObjectTorrent service method, as returned by S3. - REST API Reference for GetObjectTorrent Operation - - - - Return torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Amazon - S3 Torrent. - - - - You can get torrent only for objects that are less than 5 GB in size and that are - not encrypted using server-side encryption with customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - The following operation is related to GetObjectTorrent: - - - - Container for the necessary parameters to execute the GetObjectTorrent service method. - - The response from the GetObjectTorrent service method, as returned by S3. - REST API Reference for GetObjectTorrent Operation - - - - Initiates the asynchronous execution of the GetObjectTorrent operation. - - - Container for the necessary parameters to execute the GetObjectTorrent operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetObjectTorrent - operation. - REST API Reference for GetObjectTorrent Operation - - - - Finishes the asynchronous execution of the GetObjectTorrent operation. - - - The IAsyncResult returned by the call to BeginGetObjectTorrent. - - Returns a GetObjectTorrentResult from S3. - REST API Reference for GetObjectTorrent Operation - - - - Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:GetBucketPublicAccessBlock - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket - or an object, it checks the PublicAccessBlock configuration for both - the bucket (or the bucket that contains the object) and the bucket owner's account. - If the PublicAccessBlock settings are different between the bucket and - the account, Amazon S3 uses the most restrictive combination of the bucket-level and - account-level settings. - - - - For more information about when Amazon S3 considers a bucket or an object public, - see The - Meaning of "Public". - - - - The following operations are related to GetPublicAccessBlock: - - - - Container for the necessary parameters to execute the GetPublicAccessBlock service method. - - The response from the GetPublicAccessBlock service method, as returned by S3. - REST API Reference for GetPublicAccessBlock Operation - - - - Initiates the asynchronous execution of the GetPublicAccessBlock operation. - - - Container for the necessary parameters to execute the GetPublicAccessBlock operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetPublicAccessBlock - operation. - REST API Reference for GetPublicAccessBlock Operation - - - - Finishes the asynchronous execution of the GetPublicAccessBlock operation. - - - The IAsyncResult returned by the call to BeginGetPublicAccessBlock. - - Returns a GetPublicAccessBlockResult from S3. - REST API Reference for GetPublicAccessBlock Operation - - - - This operation initiates a multipart upload and returns an upload ID. This upload - ID is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort operation - and Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload API and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart) and UploadPartCopy) requests must match the headers you - used in the request to initiate the upload by using CreateMultipartUpload. - - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, - kms:GenerateDataKey*, and kms:DescribeKey actions on the - key. These permissions are required because Amazon S3 must decrypt and read data from - the encrypted file parts before it completes the multipart upload. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - The following operations are related to CreateMultipartUpload: - - - - The name of the bucket to which to initiate the upload - Object key for which the multipart upload is to be initiated. - - The response from the InitiateMultipartUpload service method, as returned by S3. - REST API Reference for InitiateMultipartUpload Operation - - - - This operation initiates a multipart upload and returns an upload ID. This upload - ID is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort operation - and Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload API and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart) and UploadPartCopy) requests must match the headers you - used in the request to initiate the upload by using CreateMultipartUpload. - - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, - kms:GenerateDataKey*, and kms:DescribeKey actions on the - key. These permissions are required because Amazon S3 must decrypt and read data from - the encrypted file parts before it completes the multipart upload. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - The following operations are related to CreateMultipartUpload: - - - - Container for the necessary parameters to execute the InitiateMultipartUpload service method. - - The response from the InitiateMultipartUpload service method, as returned by S3. - REST API Reference for InitiateMultipartUpload Operation - - - - Initiates the asynchronous execution of the InitiateMultipartUpload operation. - - - Container for the necessary parameters to execute the InitiateMultipartUpload operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndInitiateMultipartUpload - operation. - REST API Reference for InitiateMultipartUpload Operation - - - - Finishes the asynchronous execution of the InitiateMultipartUpload operation. - - - The IAsyncResult returned by the call to BeginInitiateMultipartUpload. - - Returns a InitiateMultipartUploadResult from S3. - REST API Reference for InitiateMultipartUpload Operation - - - - Lists the analytics configurations for the bucket. You can have up to 1,000 analytics - configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. You should always check the IsTruncated element in the response. - If there are no more configurations to list, IsTruncated is set to false. - If there are more configurations to list, IsTruncated is set to true, - and there will be a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to ListBucketAnalyticsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketAnalyticsConfigurations service method. - - The response from the ListBucketAnalyticsConfigurations service method, as returned by S3. - REST API Reference for ListBucketAnalyticsConfigurations Operation - - - - Initiates the asynchronous execution of the ListBucketAnalyticsConfigurations operation. - - - Container for the necessary parameters to execute the ListBucketAnalyticsConfigurations operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListBucketAnalyticsConfigurations - operation. - REST API Reference for ListBucketAnalyticsConfigurations Operation - - - - Finishes the asynchronous execution of the ListBucketAnalyticsConfigurations operation. - - - The IAsyncResult returned by the call to BeginListBucketAnalyticsConfigurations. - - Returns a ListBucketAnalyticsConfigurationsResult from S3. - REST API Reference for ListBucketAnalyticsConfigurations Operation - - - - Returns a list of inventory configurations for the bucket. You can have up to 1,000 - analytics configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory - - - - The following operations are related to ListBucketInventoryConfigurations: - - - - Container for the necessary parameters to execute the ListBucketInventoryConfigurations service method. - - The response from the ListBucketInventoryConfigurations service method, as returned by S3. - REST API Reference for ListBucketInventoryConfigurations Operation - - - - Initiates the asynchronous execution of the ListBucketInventoryConfigurations operation. - - - Container for the necessary parameters to execute the ListBucketInventoryConfigurations operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListBucketInventoryConfigurations - operation. - REST API Reference for ListBucketInventoryConfigurations Operation - - - - Finishes the asynchronous execution of the ListBucketInventoryConfigurations operation. - - - The IAsyncResult returned by the call to BeginListBucketInventoryConfigurations. - - Returns a ListBucketInventoryConfigurationsResult from S3. - REST API Reference for ListBucketInventoryConfigurations Operation - - - - Lists the metrics configurations for the bucket. The metrics configurations are only - for the request metrics of the bucket and do not provide information on daily storage - metrics. You can have up to 1,000 configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For more information about metrics configurations and CloudWatch request metrics, - see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to ListBucketMetricsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketMetricsConfigurations service method. - - The response from the ListBucketMetricsConfigurations service method, as returned by S3. - REST API Reference for ListBucketMetricsConfigurations Operation - - - - Initiates the asynchronous execution of the ListBucketMetricsConfigurations operation. - - - Container for the necessary parameters to execute the ListBucketMetricsConfigurations operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListBucketMetricsConfigurations - operation. - REST API Reference for ListBucketMetricsConfigurations Operation - - - - Finishes the asynchronous execution of the ListBucketMetricsConfigurations operation. - - - The IAsyncResult returned by the call to BeginListBucketMetricsConfigurations. - - Returns a ListBucketMetricsConfigurationsResult from S3. - REST API Reference for ListBucketMetricsConfigurations Operation - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - - The response from the ListBuckets service method, as returned by S3. - REST API Reference for ListBuckets Operation - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - Container for the necessary parameters to execute the ListBuckets service method. - - The response from the ListBuckets service method, as returned by S3. - REST API Reference for ListBuckets Operation - - - - Initiates the asynchronous execution of the ListBuckets operation. - - - Container for the necessary parameters to execute the ListBuckets operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListBuckets - operation. - REST API Reference for ListBuckets Operation - - - - Finishes the asynchronous execution of the ListBuckets operation. - - - The IAsyncResult returned by the call to BeginListBuckets. - - Returns a ListBucketsResult from S3. - REST API Reference for ListBuckets Operation - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Container for the necessary parameters to execute the ListMultipartUploads service method. - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - Initiates the asynchronous execution of the ListMultipartUploads operation. - - - Container for the necessary parameters to execute the ListMultipartUploads operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListMultipartUploads - operation. - REST API Reference for ListMultipartUploads Operation - - - - Finishes the asynchronous execution of the ListMultipartUploads operation. - - - The IAsyncResult returned by the call to BeginListMultipartUploads. - - Returns a ListMultipartUploadsResult from S3. - REST API Reference for ListMultipartUploads Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. - Limits the response to keys that begin with the specified prefix. - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - Container for the necessary parameters to execute the ListObjects service method. - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Initiates the asynchronous execution of the ListObjects operation. - - - Container for the necessary parameters to execute the ListObjects operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListObjects - operation. - REST API Reference for ListObjects Operation - - - - Finishes the asynchronous execution of the ListObjects operation. - - - The IAsyncResult returned by the call to BeginListObjects. - - Returns a ListObjectsResult from S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Make sure to design - your application to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - To use this operation in an AWS Identity and Access Management (IAM) policy, you must - have permissions to perform the s3:ListBucket action. The bucket owner - has this permission by default and can grant this permission to others. For more information - about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - This section describes the latest revision of the API. We recommend that you use this - revised API for application development. For backward compatibility, Amazon S3 continues - to support the prior version of this API, ListObjects. - - - - To get a list of your buckets, see ListBuckets. - - - - The following operations are related to ListObjectsV2: - - - - Container for the necessary parameters to execute the ListObjectsV2 service method. - - The response from the ListObjectsV2 service method, as returned by S3. - REST API Reference for ListObjectsV2 Operation - - - - Initiates the asynchronous execution of the ListObjectsV2 operation. - - - Container for the necessary parameters to execute the ListObjectsV2 operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListObjectsV2 - operation. - REST API Reference for ListObjectsV2 Operation - - - - Finishes the asynchronous execution of the ListObjectsV2 operation. - - - The IAsyncResult returned by the call to BeginListObjectsV2. - - Returns a ListObjectsV2Result from S3. - REST API Reference for ListObjectsV2 Operation - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). This request returns a maximum of 1,000 - uploaded parts. The default number of parts returned is 1,000 parts. You can restrict - the number of parts returned by specifying the max-parts request parameter. - If your multipart upload consists of more than 1,000 parts, the response returns an - IsTruncated field with the value of true, and a NextPartNumberMarker - element. In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListParts: - - - - Name of the bucket to which the parts are being uploaded. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Object key for which the multipart upload was initiated. - Upload ID identifying the multipart upload whose parts are being listed. - - The response from the ListParts service method, as returned by S3. - REST API Reference for ListParts Operation - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). This request returns a maximum of 1,000 - uploaded parts. The default number of parts returned is 1,000 parts. You can restrict - the number of parts returned by specifying the max-parts request parameter. - If your multipart upload consists of more than 1,000 parts, the response returns an - IsTruncated field with the value of true, and a NextPartNumberMarker - element. In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListParts: - - - - Container for the necessary parameters to execute the ListParts service method. - - The response from the ListParts service method, as returned by S3. - REST API Reference for ListParts Operation - - - - Initiates the asynchronous execution of the ListParts operation. - - - Container for the necessary parameters to execute the ListParts operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListParts - operation. - REST API Reference for ListParts Operation - - - - Finishes the asynchronous execution of the ListParts operation. - - - The IAsyncResult returned by the call to BeginListParts. - - Returns a ListPartsResult from S3. - REST API Reference for ListParts Operation - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes. - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - Container for the necessary parameters to execute the ListVersions service method. - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - Initiates the asynchronous execution of the ListVersions operation. - - - Container for the necessary parameters to execute the ListVersions operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListVersions - operation. - REST API Reference for ListVersions Operation - - - - Finishes the asynchronous execution of the ListVersions operation. - - - The IAsyncResult returned by the call to BeginListVersions. - - Returns a ListVersionsResult from S3. - REST API Reference for ListVersions Operation - - - - - Initiates the asynchronous execution of the PutACL operation. - - - Container for the necessary parameters to execute the PutACL operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutACL - operation. - REST API Reference for PutACL Operation - - - - Finishes the asynchronous execution of the PutACL operation. - - - The IAsyncResult returned by the call to BeginPutACL. - - Returns a PutACLResult from S3. - REST API Reference for PutACL Operation - - - - Creates a new bucket. To create a bucket, you must register with Amazon S3 and have - a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed - to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information on bucket naming restrictions, - see Working - with Amazon S3 Buckets. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) - Region. For more information, see How - to Select a Region for Your Buckets. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - Hosting of Buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - The name of the bucket to create. - - The response from the PutBucket service method, as returned by S3. - REST API Reference for PutBucket Operation - - - - Creates a new bucket. To create a bucket, you must register with Amazon S3 and have - a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed - to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information on bucket naming restrictions, - see Working - with Amazon S3 Buckets. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) - Region. For more information, see How - to Select a Region for Your Buckets. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - Hosting of Buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - Container for the necessary parameters to execute the PutBucket service method. - - The response from the PutBucket service method, as returned by S3. - REST API Reference for PutBucket Operation - - - - Initiates the asynchronous execution of the PutBucket operation. - - - Container for the necessary parameters to execute the PutBucket operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucket - operation. - REST API Reference for PutBucket Operation - - - - Finishes the asynchronous execution of the PutBucket operation. - - - The IAsyncResult returned by the call to BeginPutBucket. - - Returns a PutBucketResult from S3. - REST API Reference for PutBucket Operation - - - - Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration - is a bucket-level feature that enables you to perform faster data transfers to Amazon - S3. - - - - To use this operation, you must have permission to perform the s3:PutAccelerateConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The Transfer Acceleration state of a bucket can be set to one of the following two - values: - -
  • - - Enabled – Enables accelerated data transfers to the bucket. - -
  • - - Suspended – Disables accelerated data transfers to the bucket. - -
- - The GetBucketAccelerateConfiguration operation returns the transfer acceleration - state of a bucket. - - - - After setting the Transfer Acceleration state of a bucket to Enabled, it might take - up to thirty minutes before the data transfer rates to the bucket increase. - - - - The name of the bucket used for Transfer Acceleration must be DNS-compliant and must - not contain periods ("."). - - - - For more information about transfer acceleration, see Transfer - Acceleration. - - - - The following operations are related to PutBucketAccelerateConfiguration: - - - - Container for the necessary parameters to execute the PutBucketAccelerateConfiguration service method. - - The response from the PutBucketAccelerateConfiguration service method, as returned by S3. - REST API Reference for PutBucketAccelerateConfiguration Operation - - - - Initiates the asynchronous execution of the PutBucketAccelerateConfiguration operation. - - - Container for the necessary parameters to execute the PutBucketAccelerateConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketAccelerateConfiguration - operation. - REST API Reference for PutBucketAccelerateConfiguration Operation - - - - Finishes the asynchronous execution of the PutBucketAccelerateConfiguration operation. - - - The IAsyncResult returned by the call to BeginPutBucketAccelerateConfiguration. - - Returns a PutBucketAccelerateConfigurationResult from S3. - REST API Reference for PutBucketAccelerateConfiguration Operation - - - - - Initiates the asynchronous execution of the PutBucketAnalyticsConfiguration operation. - - - Container for the necessary parameters to execute the PutBucketAnalyticsConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketAnalyticsConfiguration - operation. - REST API Reference for PutBucketAnalyticsConfiguration Operation - - - - Finishes the asynchronous execution of the PutBucketAnalyticsConfiguration operation. - - - The IAsyncResult returned by the call to BeginPutBucketAnalyticsConfiguration. - - Returns a PutBucketAnalyticsConfigurationResult from S3. - REST API Reference for PutBucketAnalyticsConfiguration Operation - - - - - Initiates the asynchronous execution of the PutBucketEncryption operation. - - - Container for the necessary parameters to execute the PutBucketEncryption operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketEncryption - operation. - REST API Reference for PutBucketEncryption Operation - - - - Finishes the asynchronous execution of the PutBucketEncryption operation. - - - The IAsyncResult returned by the call to BeginPutBucketEncryption. - - Returns a PutBucketEncryptionResult from S3. - REST API Reference for PutBucketEncryption Operation - - - - - Initiates the asynchronous execution of the PutBucketInventoryConfiguration operation. - - - Container for the necessary parameters to execute the PutBucketInventoryConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketInventoryConfiguration - operation. - REST API Reference for PutBucketInventoryConfiguration Operation - - - - Finishes the asynchronous execution of the PutBucketInventoryConfiguration operation. - - - The IAsyncResult returned by the call to BeginPutBucketInventoryConfiguration. - - Returns a PutBucketInventoryConfigurationResult from S3. - REST API Reference for PutBucketInventoryConfiguration Operation - - - - Set the logging parameters for a bucket and to specify permissions for who can view - and modify the logging parameters. All logs are saved to buckets in the same AWS Region - as the source bucket. To set the logging status of a bucket, you must be the bucket - owner. - - - - The bucket owner is automatically granted FULL_CONTROL to all logs. You use the Grantee - request element to grant access to other people. The Permissions request - element specifies the kind of access the grantee has to the logs. - - - - Grantee Values - - - - You can specify the person (grantee) to whom you're assigning access rights (using - request elements) in the following ways: - -
  • - - By the person's ID: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> - </Grantee> - - - - DisplayName is optional and ignored in the request. - -
  • - - By Email address: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee> - - - - - The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl - request, appears as the CanonicalUser. - -
  • - - By URI: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee> - - -
- - To enable logging, you use LoggingEnabled and its children request elements. To disable - logging, you use an empty BucketLoggingStatus request element: - - - - <BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01" /> - - - - - For more information about server access logging, see Server - Access Logging. - - - - For more information about creating a bucket, see CreateBucket. For more information - about returning the logging status of a bucket, see GetBucketLogging. - - - - The following operations are related to PutBucketLogging: - - - - Container for the necessary parameters to execute the PutBucketLogging service method. - - The response from the PutBucketLogging service method, as returned by S3. - REST API Reference for PutBucketLogging Operation - - - - Initiates the asynchronous execution of the PutBucketLogging operation. - - - Container for the necessary parameters to execute the PutBucketLogging operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketLogging - operation. - REST API Reference for PutBucketLogging Operation - - - - Finishes the asynchronous execution of the PutBucketLogging operation. - - - The IAsyncResult returned by the call to BeginPutBucketLogging. - - Returns a PutBucketLoggingResult from S3. - REST API Reference for PutBucketLogging Operation - - - - Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. - You can have up to 1,000 metrics configurations per bucket. If you're updating an - existing metrics configuration, note that this is a full replacement of the existing - metrics configuration. If you don't include the elements you want to keep, they are - erased. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to PutBucketMetricsConfiguration: - - - - GetBucketLifecycle has the following special error: - -
  • - - Error code: TooManyConfigurations - -
    • - - Description: You are attempting to create a new configuration but have already reached - the 1,000-configuration limit. - -
    • - - HTTP Status Code: HTTP 400 Bad Request - -
- - Container for the necessary parameters to execute the PutBucketMetricsConfiguration service method. - - The response from the PutBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for PutBucketMetricsConfiguration Operation - - - - Initiates the asynchronous execution of the PutBucketMetricsConfiguration operation. - - - Container for the necessary parameters to execute the PutBucketMetricsConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketMetricsConfiguration - operation. - REST API Reference for PutBucketMetricsConfiguration Operation - - - - Finishes the asynchronous execution of the PutBucketMetricsConfiguration operation. - - - The IAsyncResult returned by the call to BeginPutBucketMetricsConfiguration. - - Returns a PutBucketMetricsConfigurationResult from S3. - REST API Reference for PutBucketMetricsConfiguration Operation - - - - Enables notifications of specified events for a bucket. For more information about - event notifications, see Configuring - Event Notifications. - - - - Using this API, you can replace an existing notification configuration. The configuration - is an XML file that defines the event types that you want Amazon S3 to publish and - the destination where you want Amazon S3 to publish an event notification when it - detects an event of the specified type. - - - - By default, your bucket has no event notifications configured. That is, the notification - configuration will be an empty NotificationConfiguration. - - - - <NotificationConfiguration> - - - - </NotificationConfiguration> - - - - This operation replaces the existing notification configuration with the configuration - you include in the request body. - - - - After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification - Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, - and that the bucket owner has permission to publish to it by sending a test notification. - In the case of AWS Lambda destinations, Amazon S3 verifies that the Lambda function - permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. - For more information, see Configuring - Notifications for Amazon S3 Events. - - - - You can disable notifications by adding the empty NotificationConfiguration element. - - - - By default, only the bucket owner can configure notifications on a bucket. However, - bucket owners can use a bucket policy to grant permission to other users to set this - configuration with s3:PutBucketNotification permission. - - - - The PUT notification is an atomic operation. For example, suppose your notification - configuration includes SNS topic, SQS queue, and Lambda function configurations. When - you send a PUT request with this configuration, Amazon S3 sends test messages to your - SNS topic. If the message fails, the entire PUT operation will fail, and Amazon S3 - will not add the configuration to your bucket. - - - - Responses - - - - If the configuration in the request body includes only one TopicConfiguration - specifying only the s3:ReducedRedundancyLostObject event type, the response - will also include the x-amz-sns-test-message-id header containing the - message ID of the test notification sent to the topic. - - - - The following operation is related to PutBucketNotificationConfiguration: - - - - Container for the necessary parameters to execute the PutBucketNotification service method. - - The response from the PutBucketNotification service method, as returned by S3. - REST API Reference for PutBucketNotification Operation - - - - Initiates the asynchronous execution of the PutBucketNotification operation. - - - Container for the necessary parameters to execute the PutBucketNotification operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketNotification - operation. - REST API Reference for PutBucketNotification Operation - - - - Finishes the asynchronous execution of the PutBucketNotification operation. - - - The IAsyncResult returned by the call to BeginPutBucketNotification. - - Returns a PutBucketNotificationResult from S3. - REST API Reference for PutBucketNotification Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - The MD5 hash of the request body. - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - Container for the necessary parameters to execute the PutBucketPolicy service method. - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Initiates the asynchronous execution of the PutBucketPolicy operation. - - - Container for the necessary parameters to execute the PutBucketPolicy operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketPolicy - operation. - REST API Reference for PutBucketPolicy Operation - - - - Finishes the asynchronous execution of the PutBucketPolicy operation. - - - The IAsyncResult returned by the call to BeginPutBucketPolicy. - - Returns a PutBucketPolicyResult from S3. - REST API Reference for PutBucketPolicy Operation - - - - Creates a replication configuration or replaces an existing one. For more information, - see Replication - in the Amazon S3 Developer Guide. - - - - To perform this operation, the user or role performing the operation must have the - iam:PassRole - permission. - - - - Specify the replication configuration in the request body. In the replication configuration, - you provide the name of the destination bucket where you want Amazon S3 to replicate - objects, the IAM role that Amazon S3 can assume to replicate objects on your behalf, - and other relevant information. - - - - A replication configuration must include at least one rule, and can contain a maximum - of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects - in the source bucket. To choose additional subsets of objects to replicate, add a - rule for each subset. All rules must specify the same destination bucket. - - - - To specify a subset of the objects in the source bucket to apply a replication rule - to, add the Filter element as a child of the Rule element. You can filter objects - based on an object key prefix, one or more object tags, or both. When you add the - Filter element in the configuration, you must also add the following elements: DeleteMarkerReplication, - Status, and Priority. - - - - For information about enabling versioning on a bucket, see Using - Versioning. - - - - By default, a resource owner, in this case the AWS account that created the bucket, - can perform this operation. The resource owner can also grant others permissions to - perform the operation. For more information about permissions, see Specifying - Permissions in a Policy and Managing - Access Permissions to Your Amazon S3 Resources. - - - - Handling Replication of Encrypted Objects - - - - By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side - encryption with CMKs stored in AWS KMS. To replicate AWS KMS-encrypted objects, add - the following: SourceSelectionCriteria, SseKmsEncryptedObjects, - Status, EncryptionConfiguration, and ReplicaKmsKeyID. - For information about replication configuration, see Replicating - Objects Created with SSE Using CMKs stored in AWS KMS. - - - - For information on PutBucketReplication errors, see ReplicationErrorCodeList - - - - - The following operations are related to PutBucketReplication: - - - - Container for the necessary parameters to execute the PutBucketReplication service method. - - The response from the PutBucketReplication service method, as returned by S3. - REST API Reference for PutBucketReplication Operation - - - - Initiates the asynchronous execution of the PutBucketReplication operation. - - - Container for the necessary parameters to execute the PutBucketReplication operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketReplication - operation. - REST API Reference for PutBucketReplication Operation - - - - Finishes the asynchronous execution of the PutBucketReplication operation. - - - The IAsyncResult returned by the call to BeginPutBucketReplication. - - Returns a PutBucketReplicationResult from S3. - REST API Reference for PutBucketReplication Operation - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - The bucket name. - Container for Payer. - - The response from the PutBucketRequestPayment service method, as returned by S3. - REST API Reference for PutBucketRequestPayment Operation - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - Container for the necessary parameters to execute the PutBucketRequestPayment service method. - - The response from the PutBucketRequestPayment service method, as returned by S3. - REST API Reference for PutBucketRequestPayment Operation - - - - Initiates the asynchronous execution of the PutBucketRequestPayment operation. - - - Container for the necessary parameters to execute the PutBucketRequestPayment operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketRequestPayment - operation. - REST API Reference for PutBucketRequestPayment Operation - - - - Finishes the asynchronous execution of the PutBucketRequestPayment operation. - - - The IAsyncResult returned by the call to BeginPutBucketRequestPayment. - - Returns a PutBucketRequestPaymentResult from S3. - REST API Reference for PutBucketRequestPayment Operation - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging. - - - - Within a bucket, if you add a tag that has the same key as an existing tag, the new - value overwrites the old value. For more information, see Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional operation is currently in progress against - this resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - The bucket name. - A property of PutBucketTaggingRequest used to execute the PutBucketTagging service method. - - The response from the PutBucketTagging service method, as returned by S3. - REST API Reference for PutBucketTagging Operation - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging. - - - - Within a bucket, if you add a tag that has the same key as an existing tag, the new - value overwrites the old value. For more information, see Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional operation is currently in progress against - this resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - Container for the necessary parameters to execute the PutBucketTagging service method. - - The response from the PutBucketTagging service method, as returned by S3. - REST API Reference for PutBucketTagging Operation - - - - Initiates the asynchronous execution of the PutBucketTagging operation. - - - Container for the necessary parameters to execute the PutBucketTagging operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketTagging - operation. - REST API Reference for PutBucketTagging Operation - - - - Finishes the asynchronous execution of the PutBucketTagging operation. - - - The IAsyncResult returned by the call to BeginPutBucketTagging. - - Returns a PutBucketTaggingResult from S3. - REST API Reference for PutBucketTagging Operation - - - - - Initiates the asynchronous execution of the PutBucketVersioning operation. - - - Container for the necessary parameters to execute the PutBucketVersioning operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketVersioning - operation. - REST API Reference for PutBucketVersioning Operation - - - - Finishes the asynchronous execution of the PutBucketVersioning operation. - - - The IAsyncResult returned by the call to BeginPutBucketVersioning. - - Returns a PutBucketVersioningResult from S3. - REST API Reference for PutBucketVersioning Operation - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT operation requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - Amazon S3 has a limitation of 50 routing rules per website configuration. If you require - more than 50 routing rules, you can use object redirect. For more information, see - Configuring - an Object Redirect in the Amazon Simple Storage Service Developer Guide. - - - The bucket name. - Container for the request. - - The response from the PutBucketWebsite service method, as returned by S3. - REST API Reference for PutBucketWebsite Operation - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT operation requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - Amazon S3 has a limitation of 50 routing rules per website configuration. If you require - more than 50 routing rules, you can use object redirect. For more information, see - Configuring - an Object Redirect in the Amazon Simple Storage Service Developer Guide. - - - Container for the necessary parameters to execute the PutBucketWebsite service method. - - The response from the PutBucketWebsite service method, as returned by S3. - REST API Reference for PutBucketWebsite Operation - - - - Initiates the asynchronous execution of the PutBucketWebsite operation. - - - Container for the necessary parameters to execute the PutBucketWebsite operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketWebsite - operation. - REST API Reference for PutBucketWebsite Operation - - - - Finishes the asynchronous execution of the PutBucketWebsite operation. - - - The IAsyncResult returned by the call to BeginPutBucketWebsite. - - Returns a PutBucketWebsiteResult from S3. - REST API Reference for PutBucketWebsite Operation - - - - - - Initiates the asynchronous execution of the PutCORSConfiguration operation. - - - Container for the necessary parameters to execute the PutCORSConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutCORSConfiguration - operation. - REST API Reference for PutCORSConfiguration Operation - - - - Finishes the asynchronous execution of the PutCORSConfiguration operation. - - - The IAsyncResult returned by the call to BeginPutCORSConfiguration. - - Returns a PutCORSConfigurationResult from S3. - REST API Reference for PutCORSConfiguration Operation - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - The name of the bucket for which to set the configuration. - A property of PutLifecycleConfigurationRequest used to execute the PutLifecycleConfiguration service method. - - The response from the PutLifecycleConfiguration service method, as returned by S3. - REST API Reference for PutLifecycleConfiguration Operation - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - Container for the necessary parameters to execute the PutLifecycleConfiguration service method. - - The response from the PutLifecycleConfiguration service method, as returned by S3. - REST API Reference for PutLifecycleConfiguration Operation - - - - Initiates the asynchronous execution of the PutLifecycleConfiguration operation. - - - Container for the necessary parameters to execute the PutLifecycleConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutLifecycleConfiguration - operation. - REST API Reference for PutLifecycleConfiguration Operation - - - - Finishes the asynchronous execution of the PutLifecycleConfiguration operation. - - - The IAsyncResult returned by the call to BeginPutLifecycleConfiguration. - - Returns a PutLifecycleConfigurationResult from S3. - REST API Reference for PutLifecycleConfiguration Operation - - - - - Initiates the asynchronous execution of the PutObject operation. - - - Container for the necessary parameters to execute the PutObject operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutObject - operation. - REST API Reference for PutObject Operation - - - - Finishes the asynchronous execution of the PutObject operation. - - - The IAsyncResult returned by the call to BeginPutObject. - - Returns a PutObjectResult from S3. - REST API Reference for PutObject Operation - - - - - Initiates the asynchronous execution of the PutObjectLegalHold operation. - - - Container for the necessary parameters to execute the PutObjectLegalHold operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutObjectLegalHold - operation. - REST API Reference for PutObjectLegalHold Operation - - - - Finishes the asynchronous execution of the PutObjectLegalHold operation. - - - The IAsyncResult returned by the call to BeginPutObjectLegalHold. - - Returns a PutObjectLegalHoldResult from S3. - REST API Reference for PutObjectLegalHold Operation - - - - - Initiates the asynchronous execution of the PutObjectLockConfiguration operation. - - - Container for the necessary parameters to execute the PutObjectLockConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutObjectLockConfiguration - operation. - REST API Reference for PutObjectLockConfiguration Operation - - - - Finishes the asynchronous execution of the PutObjectLockConfiguration operation. - - - The IAsyncResult returned by the call to BeginPutObjectLockConfiguration. - - Returns a PutObjectLockConfigurationResult from S3. - REST API Reference for PutObjectLockConfiguration Operation - - - - - Initiates the asynchronous execution of the PutObjectRetention operation. - - - Container for the necessary parameters to execute the PutObjectRetention operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutObjectRetention - operation. - REST API Reference for PutObjectRetention Operation - - - - Finishes the asynchronous execution of the PutObjectRetention operation. - - - The IAsyncResult returned by the call to BeginPutObjectRetention. - - Returns a PutObjectRetentionResult from S3. - REST API Reference for PutObjectRetention Operation - - - - - Initiates the asynchronous execution of the PutObjectTagging operation. - - - Container for the necessary parameters to execute the PutObjectTagging operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutObjectTagging - operation. - REST API Reference for PutObjectTagging Operation - - - - Finishes the asynchronous execution of the PutObjectTagging operation. - - - The IAsyncResult returned by the call to BeginPutObjectTagging. - - Returns a PutObjectTaggingResult from S3. - REST API Reference for PutObjectTagging Operation - - - - - Initiates the asynchronous execution of the PutPublicAccessBlock operation. - - - Container for the necessary parameters to execute the PutPublicAccessBlock operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutPublicAccessBlock - operation. - REST API Reference for PutPublicAccessBlock Operation - - - - Finishes the asynchronous execution of the PutPublicAccessBlock operation. - - - The IAsyncResult returned by the call to BeginPutPublicAccessBlock. - - Returns a PutPublicAccessBlockResult from S3. - REST API Reference for PutPublicAccessBlock Operation - - - - - - - - - Initiates the asynchronous execution of the RestoreObject operation. - - - Container for the necessary parameters to execute the RestoreObject operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRestoreObject - operation. - REST API Reference for RestoreObject Operation - - - - Finishes the asynchronous execution of the RestoreObject operation. - - - The IAsyncResult returned by the call to BeginRestoreObject. - - Returns a RestoreObjectResult from S3. - REST API Reference for RestoreObject Operation - - - - - Initiates the asynchronous execution of the SelectObjectContent operation. - - - Container for the necessary parameters to execute the SelectObjectContent operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSelectObjectContent - operation. - REST API Reference for SelectObjectContent Operation - - - - Finishes the asynchronous execution of the SelectObjectContent operation. - - - The IAsyncResult returned by the call to BeginSelectObjectContent. - - Returns a SelectObjectContentResult from S3. - REST API Reference for SelectObjectContent Operation - - - - - Initiates the asynchronous execution of the UploadPart operation. - - - Container for the necessary parameters to execute the UploadPart operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUploadPart - operation. - REST API Reference for UploadPart Operation - - - - Finishes the asynchronous execution of the UploadPart operation. - - - The IAsyncResult returned by the call to BeginUploadPart. - - Returns a UploadPartResult from S3. - REST API Reference for UploadPart Operation - - - - The base class for requests that return Amazon S3 objects. - - - - - Gets or sets the name of the bucket. - - - The name of the bucket. - - - - - Gets whether or not the bucket name is set. - - - A value of true if the bucket name is set. - Returns false if otherwise. - - - - - Gets or sets the key under which the Amazon S3 object is stored. - - - The key under which the Amazon S3 object is stored. - - - - - Gets whether or not the key property is set. - - - A value of true if key property is set. - Returns false if otherwise. - - - - - Gets or sets the version ID of the Amazon S3 object. - - - The version ID of the Amazon S3 object. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or - ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Gets or sets the ModifiedSinceDate property. - - - The ModifiedSinceDate property. - - - - - Gets or sets the ModifiedSinceDate property. - - - The ModifiedSinceDate property. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or - UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Gets or sets the UnmodifiedSinceDate property. - - - The UnmodifiedSinceDate property. - - - - - Gets or sets the UnmodifiedSinceDate property. - - - The UnmodifiedSinceDate property. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to decrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - The base class TransferUtility request classes. - - - - - Overrides the default request timeout value. - - - - The value of this property is assigned to the Timeout property of the HTTPWebRequest/HttpClient object used - to send requests. Each TransferUtility's Download method may perform multiple server requests to complete the operation. - This timeout does not apply to the overall operation. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Returns the amount of bytes remaining that need to be pulled down from S3. - - The fully qualified path of the file. - - - - - The command to manage an upload using the S3 multipart API. - - - The command to manage an upload using the S3 multipart API. - - - - - Initializes a new instance of the class. - - The s3 client. - The config object that has the number of threads to use. - The file transporter request. - - - - Runs the multipart upload. - - - - - Used as the ThreadStart for the threads doing the upload. - - - - - This command is for doing regular PutObject requests. - - - This command is for doing regular PutObject requests. - - - - - This command files all the files that meets the criteria specified in the TransferUtilityUploadDirectoryRequest request - and uploads them. - - - This command files all the files that meets the criteria specified in the TransferUtilityUploadDirectoryRequest request - and uploads them. - - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - - Gets the Amazon S3 client used for making calls into Amazon S3. - - - The Amazon S3 client used for making calls into Amazon S3. - - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - A pattern used to identify the files from the source directory to upload. - - - A search option that specifies whether to recursively search for files to upload - in subdirectories. - - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The request that contains all the parameters required to upload a directory. - - - - - Initiates the asynchronous execution of the UploadDirectory operation. - - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. - Retrieve this object from within the callback procedure using the AsyncState property. - - - - - An IAsyncResult that can be used to poll, or wait for results, or both. - This value is also needed when invoking EndUploadDirectory. - - - - Initiates the asynchronous execution of the UploadDirectory operation. - - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - A pattern used to identify the files from the source directory to upload. - - - A search option that specifies whether to recursively search for files to upload - in subdirectories. - - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property. - - - - An IAsyncResult that can be used to poll, or wait for results, or both. - This value is also needed when invoking EndUploadDirectory. - - - - Initiates the asynchronous execution of the UploadDirectory operation. - - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The request that contains all the parameters required to upload a directory. - - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property. - - - - An IAsyncResult that can be used to poll, or wait for results, or both. - This value is also needed when invoking EndUploadDirectory. - - - - Finishes the asynchronous execution of the UploadDirectory operation. - - - The IAsyncResult returned by the call to BeginUploadDirectory. - - - - - - - Uploads the specified file. - The object key is derived from the file's name. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - - - Uploads the specified file. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - The key under which the Amazon S3 object is stored. - - - - - Uploads the contents of the specified stream. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The stream to read to obtain the content to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the stream to. - - - The key under which the Amazon S3 object is stored. - - - - - Uploads the file or stream specified by the request. - To track the progress of the upload, - add an event listener to the request's UploadProgressEvent. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - Contains all the parameters required to upload to Amazon S3. - - - - - Initiates the asynchronous execution of the Upload operation. - - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property. - - - - An IAsyncResult that can be used to poll, or wait for results, or both. - This values is also needed when invoking EndUpload. - - - - Initiates the asynchronous execution of the Upload operation. - - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - The key under which the Amazon S3 object is stored. - - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property. - - - - An IAsyncResult that can be used to poll, or wait for results, or both. - This values is also needed when invoking EndUpload. - - - - Initiates the asynchronous execution of the Upload operation. - - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The stream to read to obtain the content to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the stream to. - - - The key under which the Amazon S3 object is stored. - - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property. - - - - An IAsyncResult that can be used to poll, or wait for results, or both. - This values is also needed when invoking EndUpload. - - - - Initiates the asynchronous execution of the Upload operation. - - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - Contains all the parameters required to upload to Amazon S3. - - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property. - - - - An IAsyncResult that can be used to poll, or wait for results, or both. - This values is also needed when invoking EndUpload. - - - - Finishes the asynchronous execution of the Upload operation. - - - The IAsyncResult returned by the call to BeginUpload. - - - - - - - Returns a stream from which the caller can read the content from the specified - Amazon S3 bucket and key. - The caller of this method is responsible for closing the stream. - - - The name of the bucket. - - - The object key. - - - A stream of the contents from the specified Amazon S3 and key. - - - - - Returns a stream to read the contents from Amazon S3 as - specified by the TransferUtilityOpenStreamRequest. - The caller of this method is responsible for closing the stream. - - - Contains all the parameters required to open a stream to an S3 object. - - - A stream of the contents from Amazon S3. - - - - - Initiates the asynchronous execution of the OpenStream operation. - - - - The name of the bucket. - - - The object key. - - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property. - - - - An IAsyncResult that can be used to poll, or wait for results, or both. - This values is also needed when invoking EndOpenStream. - - - - Initiates the asynchronous execution of the OpenStream operation. - - - - Contains all the parameters required to open a stream to an Amazon S3 object. - - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property. - - - - An IAsyncResult that can be used to poll, or wait for results, or both. - This values is also needed when invoking EndOpenStream. - - - - Finishes the asynchronous execution of the OpenStream operation. - - - The IAsyncResult returned by the call to BeginOpenStream. - - - - - - - Downloads the content from Amazon S3 and writes it to the specified file. - - - The file path where the content from Amazon S3 will be written to. - - - The name of the bucket containing the Amazon S3 object to download. - - - The key under which the Amazon S3 object is stored. - - - - - Downloads the content from Amazon S3 and writes it to the specified file. - If the key is not specified in the request parameter, - the file name will used as the key name. - - - Contains all the parameters required to download an Amazon S3 object. - - - - - Initiates the asynchronous execution of the Download operation. - - - - The file path where the content from Amazon S3 will be written to. - - - The name of the bucket containing the Amazon S3 object to download. - - - The key under which the Amazon S3 object is stored. - - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property. - - - - An IAsyncResult that can be used to poll, or wait for results, or both. - This values is also needed when invoking EndDownload. - - - - Initiates the asynchronous execution of the Download operation. - - - - Contains all the parameters required to download an Amazon S3 object. - - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property. - - - - An IAsyncResult that can be used to poll, or wait for results, or both. - This values is also needed when invoking EndDownload. - - - - Finishes the asynchronous execution of the Download operation. - - - The IAsyncResult returned by the call to BeginDownload. - - - - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by s3Directory. - - - The name of the bucket containing the Amazon S3 objects to download. - - - The directory in Amazon S3 to download. - - - The local directory to download the objects to. - - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by the S3Directory - property of the passed in TransferUtilityDownloadDirectoryRequest object. - - - Contains all the parameters required to download objects from Amazon S3 - into a local directory. - - - - - Initiates the asynchronous execution of the DownloadDirectory operation. - - - - The name of the bucket containing the Amazon S3 objects to download. - - - The directory in Amazon S3 to download. - - - The local directory to download the objects to. - - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property. - - - - An IAsyncResult that can be used to poll, or wait for results, or both. - This values is also needed when invoking EndDownloadDirectory. - - - - Initiates the asynchronous execution of the DownloadDirectory operation. - - - - Contains all the parameters required to download objects from a directory in Amazon S3 - to a local directory. - - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property. - - - - An IAsyncResult that can be used to poll, or wait for results, or both. - This values is also needed when invoking EndDownload. - - - - Finishes the asynchronous execution of the DownloadDirectory operation. - - - The IAsyncResult returned by the call to BeginDownloadDirectory. - - - - - - - Aborts the multipart uploads that were initiated before the specified date. - - - The name of the bucket containing multipart uploads. - - - The date before which the multipart uploads were initiated. - - - - - Initiates the asynchronous execution of the AbortMultipartUploads operation. - - - - The name of the bucket containing multipart uploads. - - - The date before which the multipart uploads were initiated. - - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property. - - - - An IAsyncResult that can be used to poll, or wait for results, or both. - This values is also needed when invoking EndAbortMultipartUploads. - - - - Finishes the asynchronous execution of the AbortMultipartUploads operation. - - - The IAsyncResult returned by the call to BeginAbortMultipartUploads. - - - - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - - Constructs a new class. - - - The AWS Access Key ID. - - - The AWS Secret Access Key. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new class. - - - The AWS Access Key ID. - - - The AWS Secret Access Key. - - - The region to configure the transfer utility for. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new instance of the class. - - - The AWS Access Key ID. - - - The AWS Secret Access Key. - - - Specifies advanced settings. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new instance of the class. - - - The AWS Access Key ID. - - - The AWS Secret Access Key. - - - The region to configure the transfer utility for. - - - Specifies advanced settings. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new instance of the class. - - - The Amazon S3 client. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Initializes a new instance of the class. - - - The Amazon S3 client. - - - Specifies advanced configuration settings for . - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Gets the Amazon S3 client used for making calls into Amazon S3. - - - The Amazon S3 client used for making calls into Amazon S3. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Constructs a new class. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new class. - - - The region to configure the transfer utility for. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new class. - - - Specifies advanced configuration settings for . - - - - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - A pattern used to identify the files from the source directory to upload. - - - A search option that specifies whether to recursively search for files to upload - in subdirectories. - - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The request that contains all the parameters required to upload a directory. - - - - - Initiates the asynchronous execution of the UploadDirectory operation. - - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. - Retrieve this object from within the callback procedure using the AsyncState property. - - - - - An IAsyncResult that can be used to poll, or wait for results, or both. - This value is also needed when invoking EndUploadDirectory. - - - - Initiates the asynchronous execution of the UploadDirectory operation. - - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - A pattern used to identify the files from the source directory to upload. - - - A search option that specifies whether to recursively search for files to upload - in subdirectories. - - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property. - - - - An IAsyncResult that can be used to poll, or wait for results, or both. - This value is also needed when invoking EndUploadDirectory. - - - - Initiates the asynchronous execution of the UploadDirectory operation. - - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The request that contains all the parameters required to upload a directory. - - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property. - - - - An IAsyncResult that can be used to poll, or wait for results, or both. - This value is also needed when invoking EndUploadDirectory. - - - - Finishes the asynchronous execution of the UploadDirectory operation. - - - The IAsyncResult returned by the call to BeginUploadDirectory. - - - - - - - Uploads the specified file. - The object key is derived from the file's name. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - - - Uploads the specified file. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - The key under which the Amazon S3 object is stored. - - - - - Uploads the contents of the specified stream. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The stream to read to obtain the content to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the stream to. - - - The key under which the Amazon S3 object is stored. - - - - - Uploads the file or stream specified by the request. - To track the progress of the upload, - add an event listener to the request's UploadProgressEvent. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - Contains all the parameters required to upload to Amazon S3. - - - - - Initiates the asynchronous execution of the Upload operation. - - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property. - - - - An IAsyncResult that can be used to poll, or wait for results, or both. - This values is also needed when invoking EndUpload. - - - - Initiates the asynchronous execution of the Upload operation. - - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - The key under which the Amazon S3 object is stored. - - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property. - - - - An IAsyncResult that can be used to poll, or wait for results, or both. - This values is also needed when invoking EndUpload. - - - - Initiates the asynchronous execution of the Upload operation. - - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The stream to read to obtain the content to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the stream to. - - - The key under which the Amazon S3 object is stored. - - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property. - - - - An IAsyncResult that can be used to poll, or wait for results, or both. - This values is also needed when invoking EndUpload. - - - - Initiates the asynchronous execution of the Upload operation. - - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - Contains all the parameters required to upload to Amazon S3. - - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property. - - - - An IAsyncResult that can be used to poll, or wait for results, or both. - This values is also needed when invoking EndUpload. - - - - Finishes the asynchronous execution of the Upload operation. - - - The IAsyncResult returned by the call to BeginUpload. - - - - - - - Returns a stream from which the caller can read the content from the specified - Amazon S3 bucket and key. - The caller of this method is responsible for closing the stream. - - - The name of the bucket. - - - The object key. - - - A stream of the contents from the specified Amazon S3 and key. - - - - - Returns a stream to read the contents from Amazon S3 as - specified by the TransferUtilityOpenStreamRequest. - The caller of this method is responsible for closing the stream. - - - Contains all the parameters required to open a stream to an S3 object. - - - A stream of the contents from Amazon S3. - - - - - Initiates the asynchronous execution of the OpenStream operation. - - - - The name of the bucket. - - - The object key. - - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property. - - - - An IAsyncResult that can be used to poll, or wait for results, or both. - This values is also needed when invoking EndOpenStream. - - - - Initiates the asynchronous execution of the OpenStream operation. - - - - Contains all the parameters required to open a stream to an Amazon S3 object. - - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property. - - - - An IAsyncResult that can be used to poll, or wait for results, or both. - This values is also needed when invoking EndOpenStream. - - - - Finishes the asynchronous execution of the OpenStream operation. - - - The IAsyncResult returned by the call to BeginOpenStream. - - - - - - - Downloads the content from Amazon S3 and writes it to the specified file. - - - The file path where the content from Amazon S3 will be written to. - - - The name of the bucket containing the Amazon S3 object to download. - - - The key under which the Amazon S3 object is stored. - - - - - Downloads the content from Amazon S3 and writes it to the specified file. - If the key is not specified in the request parameter, - the file name will used as the key name. - - - Contains all the parameters required to download an Amazon S3 object. - - - - - Initiates the asynchronous execution of the Download operation. - - - - The file path where the content from Amazon S3 will be written to. - - - The name of the bucket containing the Amazon S3 object to download. - - - The key under which the Amazon S3 object is stored. - - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property. - - - - An IAsyncResult that can be used to poll, or wait for results, or both. - This values is also needed when invoking EndDownload. - - - - Initiates the asynchronous execution of the Download operation. - - - - Contains all the parameters required to download an Amazon S3 object. - - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property. - - - - An IAsyncResult that can be used to poll, or wait for results, or both. - This values is also needed when invoking EndDownload. - - - - Finishes the asynchronous execution of the Download operation. - - - The IAsyncResult returned by the call to BeginDownload. - - - - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by s3Directory. - - - The name of the bucket containing the Amazon S3 objects to download. - - - The directory in Amazon S3 to download. - - - The local directory to download the objects to. - - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by the S3Directory - property of the passed in TransferUtilityDownloadDirectoryRequest object. - - - Contains all the parameters required to download objects from Amazon S3 - into a local directory. - - - - - Initiates the asynchronous execution of the DownloadDirectory operation. - - - - The name of the bucket containing the Amazon S3 objects to download. - - - The directory in Amazon S3 to download. - - - The local directory to download the objects to. - - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property. - - - - An IAsyncResult that can be used to poll, or wait for results, or both. - This values is also needed when invoking EndDownloadDirectory. - - - - Initiates the asynchronous execution of the DownloadDirectory operation. - - - - Contains all the parameters required to download objects from a directory in Amazon S3 - to a local directory. - - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property. - - - - An IAsyncResult that can be used to poll, or wait for results, or both. - This values is also needed when invoking EndDownload. - - - - Finishes the asynchronous execution of the DownloadDirectory operation. - - - The IAsyncResult returned by the call to BeginDownloadDirectory. - - - - - - - Aborts the multipart uploads that were initiated before the specified date. - - - The name of the bucket containing multipart uploads. - - - The date before which the multipart uploads were initiated. - - - - - Initiates the asynchronous execution of the AbortMultipartUploads operation. - - - - The name of the bucket containing multipart uploads. - - - The date before which the multipart uploads were initiated. - - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property. - - - - An IAsyncResult that can be used to poll, or wait for results, or both. - This values is also needed when invoking EndAbortMultipartUploads. - - - - Finishes the asynchronous execution of the AbortMultipartUploads operation. - - - The IAsyncResult returned by the call to BeginAbortMultipartUploads. - - - - - - - Uploads the specified file. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - The key under which the Amazon S3 object is stored. - - - - - Uploads the contents of the specified stream. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - The stream to read to obtain the content to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the stream to. - - - The key under which the Amazon S3 object is stored. - - - - - Uploads the file or stream specified by the request. - To track the progress of the upload, - add an event listener to the request's UploadProgressEvent. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - Contains all the parameters required to upload to Amazon S3. - - - - - - Provides configuration options for how processes requests. - - - The best configuration settings depend on network - configuration, latency and bandwidth. - The default configuration settings are suitable - for most applications, but this class enables developers to experiment with - different configurations and tune transfer manager performance. - - - - - Provides configuration options for how processes requests. - - - The best configuration settings depend on network - configuration, latency and bandwidth. - The default configuration settings are suitable - for most applications, but this class enables developers to experiment with - different configurations and tune transfer manager performance. - - - - - - Default constructor. - - - - - Gets or sets the minimum part size for upload parts in bytes. The default is 16 MB. - Decreasing the minimum part size causes - multipart uploads to be split into a larger number - of smaller parts. Setting this value too low has a negative effect - on transfer speeds, causing extra latency and network - communication for each part. - - - - - This property determines how many active threads - or the number of concurrent asynchronous web requests - will be used to upload/download the file . - The default value is 10. - - - A value less than or equal to 0 will be silently ignored. - - - - - Gets or sets the number of executing threads. - This property determines how many active threads will be used to upload - the file. The default value is 10 threads. - - - A value less than or equal to 0 will be silently ignored. - - - - - Gets or sets the default timeout in milliseconds used for writing objects to S3. - - - - - Contains all the parameters - that can be set when making a this request with the - TransferUtility method. - - - - - Get or sets the file path location of where the - downloaded Amazon S3 object will be written to. - - - The file path location of where the downloaded Amazon S3 object will be written to. - - - - - Checks if FilePath property is set. - - True if FilePath property is set. - - - - The event for WriteObjectProgressEvent notifications. All - subscribers will be notified when a new progress - event is raised. - - The WriteObjectProgressEvent is fired as data - is downloaded from S3. The delegates attached to the event - will be passed information detailing how much data - has been downloaded as well as how much will be downloaded. - - - - Subscribe to this event if you want to receive - WriteObjectProgressEvent notifications. Here is how:
- 1. Define a method with a signature similar to this one: - - private void displayProgress(object sender, WriteObjectProgressArgs args) - { - Console.WriteLine(args); - } - - 2. Add this method to the WriteObjectProgressEvent delegate's invocation list - - TransferUtilityDownloadRequest request = new TransferUtilityDownloadRequest(); - request.WriteObjectProgressEvent += displayProgress; - - - - - - Causes the WriteObjectProgressEvent event to be fired. - - Progress data for the stream being written to file. - - - - Contains all the parameters - that can be set when making a this request with the - TransferUtility method. - - - - - Contains all the parameters - that can be set when making a this request with the - TransferUtility method. - - - - - Gets or sets the name of the bucket. - - - The name of the bucket. - - - - - Checks if BucketName property is set. - - true if BucketName property is set. - - - - Gets or sets the key under which the Amazon S3 object is to be stored. - - - The key under which the Amazon S3 object is to be stored. - - - - - Checks if Key property is set. - - true if Key property is set. - - - - Gets or sets the canned access control list (ACL) - for the uploaded object. - Please refer to - for - information on Amazon S3 canned ACLs. - - - The canned access control list (ACL) - for the uploaded object. - - - - - Checks if the CannedACL property is set. - - true if there is the CannedACL property is set. - - - - Removes the cannned access control list (ACL) - for the uploaded object. - - - - - Gets or sets the content type of the uploaded Amazon S3 object. - - - The content type of the uploaded Amazon S3 object. - - - - - Checks if ContentType property is set. - - true if ContentType property is set. - - - - Gets or sets the storage class for the uploaded Amazon S3 object. - Please refer to - for - information on S3 Storage Classes. - - - The storage class for the uploaded Amazon S3 object. - - - - - Gets and sets the ServerSideEncryptionMethod property. - Specifies the encryption used on the server to - store the content. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Input stream for the request; content for the request will be read from the stream. - - - - - - Gets or sets the file path - where the Amazon S3 object will be uploaded from. - - - For WinRT and Windows Phone this property must be in the form of "ms-appdata:///local/file.txt". - - - - The file path where the Amazon S3 object will be uploaded from. - - - - - Checks if FilePath property is set. - - true if FilePath property is set. - - - - Gets or sets the part size of the upload in bytes. - The uploaded file will be divided into - parts the size specified and - uploaded to Amazon S3 individually. - - - The part size of the upload. - - - - - Checks if PartSize property is set. - - true if PartSize property is set. - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - The tag-set for the object. - - - - - The event for UploadProgressEvent notifications. All - subscribers will be notified when a new progress - event is raised. - - The UploadProgressEvent is fired as data - is uploaded to S3. The delegates attached to the event - will be passed information detailing how much data - has been uploaded as well as how much will be uploaded. - - - - Subscribe to this event if you want to receive - UploadProgressEvent notifications. Here is how:
- 1. Define a method with a signature similar to this one: - - private void displayProgress(object sender, UploadProgressArgs args) - { - Console.WriteLine(args); - } - - 2. Add this method to the UploadProgressEvent delegate's invocation list - - TransferUtilityUploadRequest request = new TransferUtilityUploadRequest(); - request.UploadProgressEvent += displayProgress; - - - - - - Causes the UploadProgressEvent event to be fired. - - Progress data for the file being uploaded. - - - - Gets the length of the content by either checking the FileInfo.Length property or the Stream.Length property. - - The length of the content. - - - - Gets or sets whether or not the stream used with this request is - automatically closed when all of the content is read from the stream. - - - A value of true if the if the stream is - automatically closed when all of the content is read from the stream. - A value of false if otherwise. - - - - - If this value is set to true then the stream's position will be reset to the start before being read for upload. - Default: true. - - - - - Sets whether or not the stream used with this request is - automatically closed when all of the content is read from the stream - and returns this object instance, - enabling additional method calls to be chained together. - - - A value of true if the if the stream is - automatically closed when all of the content is read from the stream. - A value of false if otherwise. - - - This object instance, enabling additional method calls to be chained together. - - - - - Encapsulates the information needed to provide - transfer progress to subscribers of the Put Object - Event. - - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The how many bytes were transferred since last event. - The number of bytes transferred - The total number of bytes to be transferred - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The how many bytes were transferred since last event. - The number of bytes transferred - The total number of bytes to be transferred - The file being uploaded - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The how many bytes were transferred since last event. - The number of bytes transferred - The total number of bytes to be transferred - A compensation for any upstream aggregators if this event to correct theit totalTransferred count, - in case the underlying request is retried. - The file being uploaded - - - - Gets the FilePath. - - - - - Request object for downloading a directory with the TransferUtility. - - - - - Gets or sets the name of the bucket. - - - The name of the bucket. - - - - - Gets whether or not the bucket name is set. - - - A value of true if the bucket name is set. - Otherwise, returns false. - - - - - Gets or sets the local directory where objects from Amazon S3 will be downloaded. - If the directory doesn't exist, it will be created. - - - The local directory where objects from Amazon S3 will be downloaded. - - - - - Gets whether or not the LocalDirectory property is set. - - - A value of true if LocalDirectory property is set. - Otherwise, returns false. - - - - - Gets or sets the Amazon S3 directory to download from. - This is translated to a key prefix; keys that have this prefix will be - downloaded. - - - - - Gets whether or not the S3Directory property is set. - - - A value of true if S3Directory property is set. - Otherwise, returns false. - - - - - - This property is deprecated. This property doesn't honor the DateTimeKind, please - use ModifiedSinceDateUtc instead. - - Gets or sets the ModifiedSinceDate property. - Only objects that have been modified since this date will be - downloaded. - - - The ModifiedSinceDate property. - - - - - Checks if ModifiedSinceDate property is set. - - A value of true if ModifiedSinceDate property is set. - Otherwise, returns false. - - - - Gets or sets the ModifiedSinceDateUtc property. - Only objects that have been modified since this date will be - downloaded. - - - The ModifiedSinceDateUtc property. - - - - - Checks if ModifiedSinceDateUtc property is set. - - A value of true if ModifiedSinceDateUtc property is set. - Otherwise, returns false. - - - - - This property is deprecated. This property doesn't honor the DateTimeKind, please - use UnmodifiedSinceDateUtc instead. - - Gets or sets the UnmodifiedSinceDate property. - Only objects that have not been modified since this date will be downloaded. - - - The UnmodifiedSinceDate property. - - - - - Checks if UnmodifiedSinceDate property is set. - - true if UnmodifiedSinceDate property is set. - - - - Gets or sets the UnmodifiedSinceDateUtc property. - Only objects that have not been modified since this date will be downloaded. - - - The UnmodifiedSinceDateUtc property. - - - - - Checks if UnmodifiedSinceDateUtc property is set. - - true if UnmodifiedSinceDateUtc property is set. - - - - Gets or sets the DownloadFilesConcurrently property. - Specifies if multiple files will be downloaded concurrently. - The number of concurrent web requests used is controlled - by the TransferUtilityConfig.ConcurrencyLevel property. - - - - - The event for DownloadedDirectoryProgressEvent notifications. All - subscribers will be notified when a new progress - event is raised. - - The DownloadedDirectoryProgressEvent is fired as data - is downloaded from Amazon S3. The delegates attached to the event - will be passed information detailing how much data - has been downloaded as well as how much will be downloaded. - - - - Subscribe to this event if you want to receive - DownloadedDirectoryProgressEvent notifications. Here is how:
- 1. Define a method with a signature similar to this one: - - private void displayProgress(object sender, DownloadDirectoryProgressArgs args) - { - Console.WriteLine(args); - } - - 2. Add this method to the DownloadedDirectoryProgressEvent delegate's invocation list - - TransferUtilityDownloadDirectoryRequest request = new TransferUtilityDownloadDirectoryRequest(); - request.DownloadedDirectoryProgressEvent += displayProgress; - - - - - - Encapsulates the information needed to provide - transfer progress to subscribers of the DownloadDirectory - event. - - - - - Constructs a new instance of DownloadDirectoryProgressArgs. - - - The number of files downloaded. - - - The total number of files to download. - - - The current file being downloaded - - - The number of transferred bytes for the current file. - - - The size of the current file in bytes. - - - - - Constructs a new instance of DownloadDirectoryProgressArgs. - - - The number of files downloaded. - - - The total number of files to download. - - - The bytes transferred across all files being downloaded. - - - The total number of bytes across all files being downloaded. - - - The current file being downloaded. - - - The number of transferred bytes for the current file. - - - The size of the current file in bytes. - - - - - Gets or sets the total number of files. - - The total number of files. - - - - Gets or sets the number of files downloaded so far. - - The number of files downloaded. - - - - Gets or sets the total number of bytes across all files being downloaded. - - The total number of bytes across all files being downloaded. - - - - Gets or sets the bytes transferred across all files being downloaded. - - The bytes transferred across all files being downloaded. - - - - Gets or sets the current file being downloaded. - - The current file being downloaded. - - - - Gets or sets the transferred bytes for the current file. - - The transferred bytes for the current file. - - - - Gets or sets the total number of bytes for the current file. - - The total number of bytes for the current file. - - - - The string representation of this instance of DownloadDirectoryProgressArgs. - - The string representation of this instance of DownloadDirectoryProgressArgs. - - - - Contains all the parameters - that can be set when making a this request with the - TransferUtility method. - - - - - Gets or sets the directory where files are uploaded from. - - - The directory where files are uploaded from. - - - - - Checks if Directory property is set. - - true if Directory property is set. - - - - Gets or sets the KeyPrefix property. As object keys are generated for the - files being uploaded this value will prefix the key. This is useful when a directory - needs to be uploaded into sub directory in the S3 Bucket. - - - The directory where files are uploaded from. - - - - - Checks if KeyPrefix property is set. - - true if KeyPrefix property is set. - - - - Gets and sets the search pattern used to determine which - files in the directory are uploaded. - - - The search pattern used to deterimine which - files in the directory are uploaded. - The default value is "*", specifying that all files - in the directory will be uploaded. - - - - - Checks if SearchPattern property is set. - - true if SearchPattern property is set. - - - - Gets or sets the recursive options for the directory upload. - - - The recursive options for the directory upload. - Set by default to TopDirectoryOnly, - specifying that files will be uploaded from the root directory only. - - - - - Gets or sets the name of the bucket. - - - The name of the bucket. - - - - - Checks if BucketName property is set. - - true if BucketName property is set. - - - - Gets or sets the canned access control list (ACL) - for the uploaded objects. - Please refer to - for - information on Amazon S3 canned ACLs. - - - The canned access control list (ACL) - for the uploaded objects. - - - - - Checks if the CannedACL property is set. - - true if there is the CannedACL property is set. - - - - Gets or sets the content type for the uploaded Amazon S3 objects. - The default behavior when this field is not set is to use the file - extension to set the content type. If this field is set to a value it - will be applied to all uploaded files in the directory, overriding - file extension inspection. - - - The content type for all the uploaded Amazon S3 objects. - - - - - Gets or sets the storage class for the uploaded Amazon S3 objects. - Please refer to - for - information on S3 Storage Classes. - - - The storage class for the uploaded Amazon S3 objects. - - - - - The collection of meta data for the request. - - - - - Gets or sets the ServerSideEncryptionMethod property. - Specifies the encryption used on the server to - store the content. - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Gets or sets the UploadFilesConcurrently property. - Specifies if multiple files will be uploaded concurrently. - The number of concurrent web requests used is controlled - by the TransferUtilityConfig.ConcurrencyLevel property. - - - - - The event for UploadDirectoryProgressEvent notifications. All - subscribers will be notified when a new progress - event is raised. - - The UploadDirectoryProgressEvent is fired as data - is uploaded to S3. The delegates attached to the event - will be passed information detailing how much data - has been uploaded as well as how much will be uploaded. - - - - Subscribe to this event if you want to receive - UploadDirectoryProgressEvent notifications. Here is how:
- 1. Define a method with a signature similar to this one: - - private void displayProgress(object sender, UploadDirectoryProgressArgs args) - { - Console.WriteLine(args); - } - - 2. Add this method to the UploadDirectoryProgressEvent delegate's invocation list - - TransferUtilityUploadDirectoryRequest request = new TransferUtilityUploadDirectoryRequest(); - request.UploadDirectoryProgressEvent += displayProgress; - - - - - - The event for modifying individual TransferUtilityUploadRequest for each file - being uploaded. - - - - - Causes the UploadDirectoryProgressEvent event to be fired. - - Progress data for files currently being uploaded. - - - - Tags that will be applied to all objects in the diretory. - - - - - Encapsulates the information needed to provide - transfer progress to subscribers of the UploadDirectory - event. - - - - - Constructs a new instance of UploadDirectoryProgressArgs. - - - The number of files uploaded. - - - The total number of files to upload. - - - The current file - - - The number of transferred bytes for current file. - - - The size of the current file in bytes. - - - - - Constructs a new instance of UploadDirectoryProgressArgs. - - - The number of files uploaded. - - - The total number of files to upload. - - - The bytes transferred across all files being uploaded. - - - The total number of bytes across all files being uploaded. - - - The current file being uploaded. - - - The number of transferred bytes for current file. - - - The size of the current file in bytes. - - - - - Gets or sets the total number of files. - - The total number of files. - - - - Gets or sets the number of files uploaded. - - The number of files uploaded. - - - - Gets or sets the total number of bytes across all files being uploaded. - - The total number of bytes across all files being uploaded. - - - - Gets or sets the bytes transferred across all files being uploaded. - - The bytes transferred across all files being uploaded. - - - - Gets or sets the current file. - - The current file. - - - - Gets or sets the transferred bytes for current file. - - The transferred bytes for current file. - - - - Gets or sets the total number of bytes for current file. - - The total number of bytes for current file. - - - - The string representation of this instance of UploadDirectoryProgressArgs. - - The string representation of this instance of UploadDirectoryProgressArgs. - - - - Contains a single TransferUtilityUploadRequest corresponding - to a single file about to be uploaded, allowing changes to - the request before it is executed. - - - - - Constructs a new UploadDirectoryFileRequestArgs instance. - - Request being processed. - - - - Gets and sets the UploadRequest property. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - This class extends the AmazonS3Client and provides client side encryption when reading or writing S3 objects. - - - - - Constructs AmazonS3EncryptionClient with the Encryption materials and credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Constructs AmazonS3EncryptionClient with the Encryption materials and credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - - The region to connect. - - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Constructs AmazonS3EncryptionClient with the Encryption materials, - AmazonS3 CryptoConfiguration object and credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - - The AmazonS3EncryptionClient CryptoConfiguration Object - - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Constructs AmazonS3EncryptionClient with AWS Credentials and Encryption materials. - - - The encryption materials to be used to encrypt and decrypt envelope key. - - AWS Credentials - - - - Constructs AmazonS3EncryptionClient with AWS Credentials, Region and Encryption materials - - AWS Credentials - The region to connect. - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Constructs AmazonS3EncryptionClient with AWS Credentials, AmazonS3CryptoConfiguration Configuration object - and Encryption materials - - AWS Credentials - The AmazonS3EncryptionClient CryptoConfiguration Object - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Constructs AmazonS3EncryptionClient with AWS Access Key ID, - AWS Secret Key and Encryption materials - - AWS Access Key ID - AWS Secret Access Key - The encryption materials to be used to encrypt and decrypt envelope key. - - - - Constructs AmazonS3EncryptionClient with AWS Access Key ID, - AWS Secret Key, Region and Encryption materials - - AWS Access Key ID - AWS Secret Access Key - The region to connect. - The encryption materials to be used to encrypt and decrypt envelope key. - - - - Constructs AmazonS3EncryptionClient with AWS Access Key ID, Secret Key, - AmazonS3 CryptoConfiguration object and Encryption materials. - - AWS Access Key ID - AWS Secret Access Key - The AmazonS3EncryptionClient CryptoConfiguration Object - The encryption materials to be used to encrypt and decrypt envelope key. - - - - Constructs AmazonS3EncryptionClient with AWS Access Key ID, Secret Key, - SessionToken and Encryption materials. - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Constructs AmazonS3EncryptionClient with AWS Access Key ID, Secret Key, - SessionToken, Region and Encryption materials. - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - The region to connect. - The encryption materials to be used to encrypt and decrypt envelope key. - - - - Constructs AmazonS3EncryptionClient with AWS Access Key ID, Secret Key, SessionToken - AmazonS3EncryptionClient CryptoConfiguration object and Encryption materials. - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - The AmazonS3EncryptionClient CryptoConfiguration Object - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Turn off response logging because it will interfere with decrypt of the data coming back from S3. - - - - - Customize the pipeline to allow encryption. - - - - - - Dispose this instance - - - - - - AmazonS3CryptoConfiguration allows customers - to set storage mode for encryption credentials - - - - - Default Constructor. - - - - - Gets and sets the StorageMode property. This determines if the crypto metadata is stored as metadata on the object or as a separate object in S3. - The default is ObjectMetadata. - - - - - Mode for string the encryption information for an object. - - - - - Store the information in a separate S3 Object. - - - - - Store the information as metadata on the encrypted object. - - - - - Encryption Instructions store the encryption credentials - - - - - Construct an instance EncryptionInstructions. - - - - - - - - - Construct an instance EncryptionInstructions. - - - - - - - - The "key encrypting key" materials used in encrypt/decryption. - These materials may be an asymmetric key, a symmetric key, or a KMS key ID. - - - - - Constructs a new EncryptionMaterials object, storing an asymmetric key. - - - - - - Constructs a new EncryptionMaterials object, storing a symmetric key. - - - - - - Constructs a new EncryptionMaterials object, storing a KMS Key ID - - - - - - The EncryptionUtils class encrypts and decrypts data stored in S3. - It can be used to prepare requests for encryption before they are stored in S3 - and to decrypt objects that are retrieved from S3. - - - - - Decrypts an encrypted Envelope key using the provided encryption materials - and returns it in raw byte array form. - - Encrypted envelope key - Encryption materials needed to decrypt the encrypted envlelope key - - - - - Returns an updated stream where the stream contains the encrypted object contents. - The specified instruction will be used to encrypt data. - - - The stream whose contents are to be encrypted. - - - The instruction that will be used to encrypt the object data. - - - Encrypted stream, i.e input stream wrapped into encrypted stream - - - - - Returns an updated input stream where the input stream contains the encrypted object contents. - The specified instruction will be used to encrypt data. - - - The stream whose contents are to be encrypted. - - - The instruction that will be used to encrypt the object data. - - - Encrypted stream, i.e input stream wrapped into encrypted stream - - - - - Updates object where the object - input stream contains the decrypted contents. - - - The getObject response whose contents are to be decrypted. - - - The instruction that will be used to encrypt the object data. - - - - - Generates an instruction that will be used to encrypt an object - using materials with the KMSKeyID set. - - - Used to call KMS to generate a data key. - - - The encryption materials to be used to encrypt and decrypt data. - - - The instruction that will be used to encrypt an object. - - - - - Generates an instruction that will be used to encrypt an object - using materials with the AsymmetricProvider or SymmetricProvider set. - - - The encryption materials to be used to encrypt and decrypt data. - - - The instruction that will be used to encrypt an object. - - - - - Builds an instruction object from the object metadata. - - - A non-null object response that contains encryption information in its metadata. - - - The non-null encryption materials to be used to encrypt and decrypt Envelope key. - - - The decrypted envelope key to be use if KMS key wrapping is being used. Or null if non-KMS key wrapping is being used. - - - - - - - Builds an instruction object from the instruction file. - - Instruction file GetObject response - - The non-null encryption materials to be used to encrypt and decrypt Envelope key. - - - A non-null instruction object containing encryption information. - - - - - Update the request's ObjectMetadata with the necessary information for decrypting the object. - - - AmazonWebServiceRequest encrypted using the given instruction - - - Non-null instruction used to encrypt the data in this AmazonWebServiceRequest . - - - If true use V2 metadata format, otherwise use V1. - - - - - Adds UnEncrypted content length to object metadata - - - - - - checks if encryption credentials are in object metadata - - Response of the object - - - - - checks if encryption credentials are in the instructionfile - - Instruction file response that contains encryption information - - - - - Custom the pipeline handler to decrypt objects. - - - - - Construct instance of SetupDecryptionHandler. - - - - - - Gets the EncryptionClient property which is the AmazonS3EncryptionClient that is decrypting the object. - - - - - Calls the post invoke logic after calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Decrypt the object being downloaded. - - - - - - Calls the PostInvoke methods after calling the next handler - in the pipeline. - - The execution context, it contains the - request and response context. - - - - Decrypt the object being downloaded. - - - - - - - Updates object where the object input stream contains the decrypted contents. - - - The getObject response of InstructionFile. - - - The getObject response whose contents are to be decrypted. - - - - - Updates object where the object input stream contains the decrypted contents. - - - The getObject response whose contents are to be decrypted. - - - The decrypted envelope key to be use if KMS key wrapping is being used. Or null if non-KMS key wrapping is being used. - - - - - Custom pipeline handler to encrypt the data as it is being uploaded to S3. - - - - - Construct an instance SetupEncryptionHandler. - - - - - - Gets the EncryptionClient property which is the AmazonS3EncryptionClient that is encrypting the object. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Encrypts the S3 object being uploaded. - - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - IAsyncResult which represent an async operation. - - - - Make sure that the storage mode and encryption materials are compatible. - The client only supports KMS key wrapping in metadata storage mode. - - - - - Updates the request where the metadata contains encryption information - and the input stream contains the encrypted object contents. - - - The request whose contents are to be encrypted. - - - - - Updates the request where the instruction file contains encryption information - and the input stream contains the encrypted object contents. - - - - - - Updates the request where the input stream contains the encrypted object contents. - - - - - - Adds the crypto token to the user agent - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - IAsyncResult which represent an async operation. - - - - Customize the user agent. - - - - - - Mimics the System.IO.DirectoryInfo for a virtual directory in S3. It exposes properties and methods for enumerating directories and files as well as - methods manipulate directories. - - - It is important to keep in mind that S3 is not a filesystem. It is possible for S3 object keys to contain - characters which are not not legal file path characters, and so some pre-existing objects in a bucket that were created with - other software may not be compatible with this class. - - - - - Initialize a new instance of the S3DirectoryInfo class for the specified S3 bucket. - - S3 client which is used to access the S3 resources. - Name of the S3 bucket. - - - - - Initialize a new instance of the S3DirectoryInfo class for the specified S3 bucket and S3 object key. - - S3 client which is used to access the S3 resources. - Name of the S3 bucket. - The S3 object key. - - - - - The S3DirectoryInfo for the root of the S3 bucket. - - - - - Checks with S3 to see if the directory exists and if so returns true. - - Due to Amazon S3's eventual consistency model this property can return false for newly created buckets. - - - - - - - Returns empty string for directories. - - - - - The full path of the directory including bucket name. - - - - - Returns the last write time of the the latest file written to the directory. - - - - - - - UTC converted version of LastWriteTime. - - - - - - - Returns the name of the folder. - - - - - Return the S3DirectoryInfo of the parent directory. - - - - - Returns the S3DirectroyInfo for the S3 account. - - - - - Returns the type of file system element. - - - - - Creates the directory in S3. If no object key was specified when creating the S3DirectoryInfo then the bucket will be created. - - - - - - - Creates a sub directory inside the instance of S3DirectoryInfo. - - - - - - - - - Deletes all the files in this directory as well as this directory. - - - - - - - - Deletes all the files in this directory as well as this directory. If recursive is set to true then all sub directories will be - deleted as well. - - - - - If true then sub directories will be deleted as well. - - - - Enumerate the sub directories of this directory. - - - - An enumerable collection of directories. - - - - Enumerate the sub directories of this directory. - - The search string. The default pattern is "*", which returns all directories. - - - An enumerable collection of directories that matches searchPattern. - - - - Enumerate the sub directories of this directory. - - The search string. The default pattern is "*", which returns all directories. - One of the enumeration values that specifies whether the search operation should include only the current directory or all subdirectories. The default value is TopDirectoryOnly. - - - An enumerable collection of directories that matches searchPattern and searchOption. - - - - Enumerate the files of this directory. - - - - An enumerable collection of files. - - - - Enumerate the sub directories of this directory. - - The search string. The default pattern is "*", which returns all files. - - - An enumerable collection of files that matches searchPattern. - - - - Enumerate the files of this directory. - - The search string. The default pattern is "*", which returns all files. - One of the enumeration values that specifies whether the search operation should include only the current directory or all subdirectories. The default value is TopDirectoryOnly. - - - An enumerable collection of files that matches searchPattern and searchOption. - - - - Enumerate the files of this directory. - - - - An enumerable collection of files. - - - - Enumerate the files of this directory. - - The search string. The default pattern is "*", which returns all files. - - - An enumerable collection of files that matches searchPattern. - - - - Enumerate the files of this directory. - - The search string. The default pattern is "*", which returns all files. - One of the enumeration values that specifies whether the search operation should include only the current directory or all subdirectories. The default value is TopDirectoryOnly. - - - An enumerable collection of files that matches searchPattern and searchOption. - - - - Returns the S3DirectoryInfo for the specified sub directory. - - Directory to get the S3DirectroyInfo for. - The S3DirectoryInfo for the specified sub directory. - - - - Returns an array of S3DirectoryInfos for the directories in this directory. - - - - An array of directories. - - - - Returns an array of S3DirectoryInfos for the directories in this directory. - - The search string. The default pattern is "*", which returns all files. - An array of files that matches searchPattern. - - - - Returns an array of S3DirectoryInfos for the directories in this directory. - - The search string. The default pattern is "*", which returns all directories. - One of the enumeration values that specifies whether the search operation should include only the current directory or all subdirectories. The default value is TopDirectoryOnly. - - - An array of directories that matches searchPattern and searchOption. - - - - Returns the S3FileInfo for the specified file. - - File to get the S3FileInfo for. - The S3FileInfo for the specified file. - - - - Returns an array of S3FileInfos for the files in this directory. - - - - An array of files. - - - - Returns an array of S3FileInfos for the files in this directory. - - The search string. The default pattern is "*", which returns all files. - - - An array of files that matches searchPattern. - - - - Returns an array of S3FileInfos for the files in this directory. - - The search string. The default pattern is "*", which returns all files. - One of the enumeration values that specifies whether the search operation should include only the current directory or all subdirectories. The default value is TopDirectoryOnly. - - - An array of files that matches searchPattern and searchOption. - - - - Returns an array of IS3FileSystemInfos for the files in this directory. - - - - An array of files. - - - - Returns an array of IS3FileSystemInfos for the files in this directory. - - The search string. The default pattern is "*", which returns all files. - - - An array of files that matches searchPattern. - - - - Returns an array of IS3FileSystemInfos for the files in this directory. - - The search string. The default pattern is "*", which returns all files. - One of the enumeration values that specifies whether the search operation should include only the current directory or all subdirectories. The default value is TopDirectoryOnly. - - - An array of files that matches searchPattern and searchOption. - - - - Copies the files from this directory to the target directory specified by the bucket and object key. - - The target bucket to copy to. - The target object key which represents a directory in S3. - - - - S3DirectoryInfo for the target location. - - - - Copies the files from this directory to the target directory specified by the bucket and object key. Only - files that have changed since the changeSince date will be copied. - - The target bucket to copy to. - The target object key which represents a directory in S3. - Date which files must have changed since in ordered to be copied. - - - - S3DirectoryInfo for the target location. - - - - Copies the files from this directory to the target directory. - - The target directory to copy to. - - - - S3DirectoryInfo for the target location. - - - - Copies the files from this directory to the target directory. Only - files that have changed since the changeSince date will be copied. - - The target directory to copy to. - Date which files must have changed since in ordered to be copied. - - - - S3DirectoryInfo for the target location. - - - - Copies the files from the S3 directory to the local file system in the location indicated by the path parameter. - - The location on the local file system to copy the files to. - - - DirectoryInfo for the local directory where files are copied to. - - - - Copies the files from the S3 directory to the local file system in the location indicated by the path parameter. - Only files that have been modified since the changesSince property will be copied. - - The location on the local file system to copy the files to. - Date which files must have changed since in ordered to be copied. - - - - DirectoryInfo for the local directory where files are copied to. - - - - Copies files from the local file system to S3 in this directory. Sub directories are copied as well. - - The local file system path where the files are to be copied. - - - - S3DirectoryInfo where the files are copied to. - - - - Copies files from the local file system to S3 in this directory. Sub directories are copied as well. - Only files that have been modified since the changesSince property will be copied. - - The local file system path where the files are to copy. - Date which files must have changed since in ordered to be copied. - - - - S3DirectoryInfo where the files are copied to. - - - - Moves the directory to the target directory specified by the bucket and object key. - - The target bucket to move to. - The target object key which represents a directory in S3. - - - - S3DirectoryInfo for the target location. - - - - Moves the directory to the target S3 directory. - - The target directory to copy to. - - - - S3DirectoryInfo for the target location. - - - - Moves the files from the S3 directory to the local file system in the location indicated by the path parameter. - - The location on the local file system to move the files to. - - - - DirectoryInfo for the local directory where files are moved to. - - - - Moves files from the local file system to S3 in this directory. Sub directories are moved as well. - - The local file system path where the files are to be moved. - - - - S3DirectoryInfo where the files are moved to. - - - - Implement the ToString method. - - - - - - Creating and deleting buckets can sometimes take a little bit of time. To make sure - users of this API do not experience the side effects of the eventual consistency - we block until the state change has happened. - - - - - - Mimics the System.IO.FileInfo for a file in S3. It exposes properties and methods manipulating files in S3. - - - - - Initialize a new instance of the S3FileInfo class for the specified S3 bucket and S3 object key. - - S3 client which is used to access the S3 resources. - Name of the S3 bucket. - The S3 object key. - - - - - Returns the parent S3DirectoryInfo. - - - - - The full name of parent directory. - - - - - Checks S3 if the file exists in S3 and return true if it does. - - - - - - - Gets the file's extension. - - - - - Returns the full path including the bucket. - - - - - Returns the last time the file was modified. - - - - - - - Returns the last time the file was modified in UTC. - - - - - - - Returns the content length of the file. - - - - - - - Returns the file name without its directory name. - - - - - Returns the type of file system element. - - - - - Copies this file's content to the file indicated by the S3 bucket and object key. - If the file already exists in S3 than an ArgumentException is thrown. - - S3 bucket to copy the file to. - S3 object key to copy the file to. - - - - S3FileInfo of the newly copied file. - - - - Copies this file's content to the file indicated by the S3 bucket and object key. - If the file already exists in S3 and overwrite is set to false than an ArgumentException is thrown. - - S3 bucket to copy the file to. - S3 object key to copy the file to. - Determines whether the file can be overwritten. - If the file already exists in S3 and overwrite is set to false. - - - - S3FileInfo of the newly copied file. - - - - Copies this file to the target directory. - If the file already exists in S3 than an ArgumentException is thrown. - - Target directory where to copy the file to. - If the directory does not exist. - If the file already exists in S3. - - - S3FileInfo of the newly copied file. - - - - Copies this file to the target directory. - If the file already exists in S3 and overwrite is set to false than an ArgumentException is thrown. - - Target directory where to copy the file to. - Determines whether the file can be overwritten. - If the directory does not exist. - If the file already exists in S3 and overwrite is set to false. - - - S3FileInfo of the newly copied file. - - - - Copies this file to the location indicated by the passed in S3FileInfo. - If the file already exists in S3 than an ArgumentException is thrown. - - The target location to copy this file to. - If the file already exists in S3. - - - S3FileInfo of the newly copied file. - - - - Copies this file to the location indicated by the passed in S3FileInfo. - If the file already exists in S3 and overwrite is set to false than an ArgumentException is thrown. - - The target location to copy this file to. - Determines whether the file can be overwritten. - If the file already exists in S3 and overwrite is set to false. - - - S3FileInfo of the newly copied file. - - - - Copies from S3 to the local file system. - If the file already exists on the local file system than an ArgumentException is thrown. - - The path where to copy the file to. - If the file already exists locally. - - - FileInfo for the local file where file is copied to. - - - - Copies from S3 to the local file system. - If the file already exists on the local file system and overwrite is set to false than an ArgumentException is thrown. - - The path where to copy the file to. - Determines whether the file can be overwritten. - If the file already exists locally and overwrite is set to false. - - - FileInfo for the local file where file is copied to. - - - - Copies the file from the local file system to S3. - If the file already exists in S3 than an ArgumentException is thrown. - - Location of the file on the local file system to copy. - If the file already exists in S3. - - - S3FileInfo where the file is copied to. - - - - Copies the file from the local file system to S3. - If the file already exists in S3 and overwrite is set to false than an ArgumentException is thrown. - - Location of the file on the local file system to copy. - Determines whether the file can be overwritten. - If the file already exists in S3 and overwrite is set to false. - - - S3FileInfo where the file is copied to. - - - - Returns a Stream that can be used to write data to S3. - - - The content will not be written to S3 until the Stream is closed. - - - - Stream to write content to. - - - - Returns a StreamWriter that can be used to write data to S3. - - - The content will not be written to S3 until the Stream is closed. - - - - Stream to write content to. - - - - Deletes the from S3. - - - - - - - Moves the file to a a new location in S3. - - Bucket to move the file to. - Object key to move the file to. - If the file already exists in S3. - - - - S3FileInfo for the target location. - - - - Moves the file to a a new location in S3. - - The target directory to copy to. - If the file already exists in S3. - - - - S3FileInfo for the target location. - - - - Moves the file to a a new location in S3. - - The target file to copy to. - If the file already exists in S3. - - - - S3FileInfo for the target location. - - - - Moves the file from S3 to the local file system in the location indicated by the path parameter. - - The location on the local file system to move the file to. - If the file already exists locally. - - - - FileInfo for the local file where file is moved to. - - - - Moves the file from the local file system to S3 in this directory. - If the file already exists in S3 than an ArgumentException is thrown. - - The local file system path where the files are to be moved. - If the file already exists locally. - - - - S3FileInfo where the file is moved to. - - - - Moves the file from the local file system to S3 in this directory. - If the file already exists in S3 and overwrite is set to false than an ArgumentException is thrown. - - The local file system path where the files are to be moved. - Determines whether the file can be overwritten. - If the file already exists in S3 and overwrite is set to false. - - - - S3FileInfo where the file is moved to. - - - - Returns a Stream for reading the contents of the file. - - The file is already open. - - - Stream to read from. - - - - Returns a StreamReader for reading the contents of the file. - - The file is already open. - - - StreamReader to read from. - - - - Returns a Stream for writing to S3. If the file already exists it will be overwritten. - - - The content will not be written to S3 until the Stream is closed. - - The file is already open. - - - Stream to write from. - - - - Replaces the destination file with the content of this file and then deletes the orignial file. If a backup location is specifed then the content of destination file is - backup to it. - - Destination bucket of this file will be copy to. - Destination object key of this file will be copy to. - Backup bucket to store the contents of the destination file. - Backup object key to store the contents of the destination file. - - - - - S3FileInfo of the destination file. - - - - Replaces the destination file with the content of this file and then deletes the orignial file. If a backupDir is specifed then the content of destination file is - backup to it. - - Where the contents of this file will be copy to. - If specified the destFile is backup to it. - - - - - S3FileInfo of the destination file. - - - - Replaces the destination file with the content of this file and then deletes the orignial file. If a backupFile is specifed then the content of destination file is - backup to it. - - Where the contents of this file will be copy to. - If specified the destFile is backup to it. - - - - - S3FileInfo of the destination file. - - - - Replaces the content of the destination file on the local file system with the content from this file from S3. - If a backup file is specified then the content of the destination file is backup to it. - - - - - - - - - - - - Implement the ToString method. - - - - - - Enumeration indicated whether a file system element is a file or directory. - - - - - Type is a directory. - - - - - Type is a file. - - - - - Common interface for both S3FileInfo and S3DirectoryInfo. - - - - - Returns true if the item exists in S3. - - - - - Returns the extension of the item. - - - - - Returns the fully qualified path to the item. - - - - - Returns the last modified time for this item from S3 in local timezone. - - - - - Returns the last modified time for this item from S3 in UTC timezone. - - - - - Returns the name of the item without parent information. - - - - - Indicates what type of item this object represents. - - - - - Deletes this item from S3. - - - - - Configuration for the S3 section of AWS configuration. - Changes to some settings may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws> - <s3 useSignatureVersion4="true" /> - </aws> - - - - - - Key for the S3UseSignatureVersion4Key property. - - - - - - Configures if the S3 client should use Signature Version 4 signing with requests. - By default, this setting is set to true which will use Signature Version 4 for all - requests except presigned URL requests when the region is set to us-east-1. When - UseSignatureVersion4 is explicitly set to true by directly setting this property or - directly setting this property through configuration, Signature Version 4 will be - used for all requests when able to do so. - When this setting is false, Signature Version 2 will be used. Note that when the - setting is false, Signature Version 4 may still be used by default in some cases - or with some regions. - - - - - Escape and unescape S3 metadata for S3 Put/Get object requests. - Escape only escapes non-ascii values in metadata - Any "%" values in metadata could interfere with this option. - Default value is false. - - - - - Was the value of the UseSignatureVersion4 property set explicitly? - This can be done via configuration or by directly setting the property. - - This is used to determine if the user set UseSignatureVersion4 to true, - or if it's true because the default was changed to true in the SDK. - - - - - V4-enabling section - - - - diff --git a/packages/AWSSDK.S3.3.3.111.14/lib/net45/AWSSDK.S3.dll b/packages/AWSSDK.S3.3.3.111.14/lib/net45/AWSSDK.S3.dll deleted file mode 100644 index 5435beb..0000000 Binary files a/packages/AWSSDK.S3.3.3.111.14/lib/net45/AWSSDK.S3.dll and /dev/null differ diff --git a/packages/AWSSDK.S3.3.3.111.14/lib/net45/AWSSDK.S3.xml b/packages/AWSSDK.S3.3.3.111.14/lib/net45/AWSSDK.S3.xml deleted file mode 100644 index 9227dc9..0000000 --- a/packages/AWSSDK.S3.3.3.111.14/lib/net45/AWSSDK.S3.xml +++ /dev/null @@ -1,46117 +0,0 @@ - - - - AWSSDK.S3 - - - - - Implementation for accessing S3 - - - - - - - Specialize the initialize of the client. - - - - - Create a signed URL allowing access to a resource that would - usually require authentication. - - - - When using query string authentication you create a query, - specify an expiration time for the query, sign it with your - signature, place the data in an HTTP request, and distribute - the request to a user or embed the request in a web page. - - - A PreSigned URL can be generated for GET, PUT, DELETE and HEAD - operations on your bucketName, keys, and versions. - - - The GetPreSignedUrlRequest that defines the - parameters of the operation. - determines if signing will fall back to SigV2 if the - signing region is us-east-1 - A string that is the signed http request. - - - - - - Marshalls the parameters for a presigned url for a preferred signing protocol. - - - - - - True if AWS4 signing will be used; if the expiry period in the request exceeds the - maximum allowed for AWS4 (one week), an ArgumentException is thrown. - - - - - - Create a signed URL allowing access to a resource that would - usually require authentication. - - - - When using query string authentication you create a query, - specify an expiration time for the query, sign it with your - signature, place the data in an HTTP request, and distribute - the request to a user or embed the request in a web page. - - - A PreSigned URL can be generated for GET, PUT, DELETE and HEAD - operations on your bucketName, keys, and versions. - - - The GetPreSignedUrlRequest that defines the - parameters of the operation. - A string that is the signed http request. - - - - - - Constructs AmazonS3Client with the credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - - - - Constructs AmazonS3Client with the credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - The region to connect. - - - - Constructs AmazonS3Client with the credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - The AmazonS3Client Configuration Object - - - - Constructs AmazonS3Client with AWS Credentials - - AWS Credentials - - - - Constructs AmazonS3Client with AWS Credentials - - AWS Credentials - The region to connect. - - - - Constructs AmazonS3Client with AWS Credentials and an - AmazonS3Client Configuration object. - - AWS Credentials - The AmazonS3Client Configuration Object - - - - Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - - - - Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - The region to connect. - - - - Constructs AmazonS3Client with AWS Access Key ID, AWS Secret Key and an - AmazonS3Client Configuration object. - - AWS Access Key ID - AWS Secret Access Key - The AmazonS3Client Configuration Object - - - - Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - - - - Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - The region to connect. - - - - Constructs AmazonS3Client with AWS Access Key ID, AWS Secret Key and an - AmazonS3Client Configuration object. - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - The AmazonS3Client Configuration Object - - - - Creates the signer for the service. - - - - - Customize the pipeline - - - - - - Capture metadata for the service. - - - - - Disposes the service client. - - - - - This operation aborts a multipart upload. After a multipart upload is aborted, no - additional parts can be uploaded using that upload ID. The storage consumed by any - previously uploaded parts will be freed. However, if any part uploads are currently - in progress, those part uploads might or might not succeed. As a result, it might - be necessary to abort a given multipart upload multiple times in order to completely - free all storage consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts operation and ensure that the parts - list is empty. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - The bucket name to which the upload was taking place. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object for which the multipart upload was initiated. - Upload ID that identifies the multipart upload. - - The response from the AbortMultipartUpload service method, as returned by S3. - REST API Reference for AbortMultipartUpload Operation - - - - This operation aborts a multipart upload. After a multipart upload is aborted, no - additional parts can be uploaded using that upload ID. The storage consumed by any - previously uploaded parts will be freed. However, if any part uploads are currently - in progress, those part uploads might or might not succeed. As a result, it might - be necessary to abort a given multipart upload multiple times in order to completely - free all storage consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts operation and ensure that the parts - list is empty. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - Container for the necessary parameters to execute the AbortMultipartUpload service method. - - The response from the AbortMultipartUpload service method, as returned by S3. - REST API Reference for AbortMultipartUpload Operation - - - - This operation aborts a multipart upload. After a multipart upload is aborted, no - additional parts can be uploaded using that upload ID. The storage consumed by any - previously uploaded parts will be freed. However, if any part uploads are currently - in progress, those part uploads might or might not succeed. As a result, it might - be necessary to abort a given multipart upload multiple times in order to completely - free all storage consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts operation and ensure that the parts - list is empty. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - The bucket name to which the upload was taking place. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object for which the multipart upload was initiated. - Upload ID that identifies the multipart upload. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AbortMultipartUpload service method, as returned by S3. - REST API Reference for AbortMultipartUpload Operation - - - - This operation aborts a multipart upload. After a multipart upload is aborted, no - additional parts can be uploaded using that upload ID. The storage consumed by any - previously uploaded parts will be freed. However, if any part uploads are currently - in progress, those part uploads might or might not succeed. As a result, it might - be necessary to abort a given multipart upload multiple times in order to completely - free all storage consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts operation and ensure that the parts - list is empty. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - Container for the necessary parameters to execute the AbortMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AbortMultipartUpload service method, as returned by S3. - REST API Reference for AbortMultipartUpload Operation - - - - Completes a multipart upload by assembling previously uploaded parts. - - - - You first initiate the multipart upload and then upload all parts using the UploadPart - operation. After successfully uploading all relevant parts of an upload, you call - this operation to complete the upload. Upon receiving this request, Amazon S3 concatenates - all the parts in ascending order by part number to create a new object. In the Complete - Multipart Upload request, you must provide the parts list. You must ensure that the - parts list is complete. This operation concatenates the parts that you provide in - the list. For each part in the list, you must provide the part number and the ETag - value, returned after that part was uploaded. - - - - Processing of a Complete Multipart Upload request could take several minutes to complete. - After Amazon S3 begins processing the request, it sends an HTTP response header that - specifies a 200 OK response. While processing is in progress, Amazon S3 periodically - sends white space characters to keep the connection from timing out. Because a request - could fail after the initial 200 OK response has been sent, it is important that you - check the response body to determine whether the request succeeded. - - - - Note that if CompleteMultipartUpload fails, applications should be prepared - to retry the failed requests. For more information, see Amazon - S3 Error Best Practices. - - - - For more information about multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - GetBucketLifecycle has the following special errors: - -
  • - - Error code: EntityTooSmall - -
    • - - Description: Your proposed upload is smaller than the minimum allowed object size. - Each part must be at least 5 MB in size, except the last part. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPart - -
    • - - Description: One or more of the specified parts could not be found. The part might - not have been uploaded, or the specified entity tag might not have matched the part's - entity tag. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPartOrder - -
    • - - Description: The list of parts was not in ascending order. The parts list must be - specified in order by part number. - -
    • - - 400 Bad Request - -
  • - - Error code: NoSuchUpload - -
    • - - Description: The specified multipart upload does not exist. The upload ID might be - invalid, or the multipart upload might have been aborted or completed. - -
    • - - 404 Not Found - -
- - The following operations are related to CompleteMultipartUpload: - - - - Container for the necessary parameters to execute the CompleteMultipartUpload service method. - - The response from the CompleteMultipartUpload service method, as returned by S3. - REST API Reference for CompleteMultipartUpload Operation - - - - Completes a multipart upload by assembling previously uploaded parts. - - - - You first initiate the multipart upload and then upload all parts using the UploadPart - operation. After successfully uploading all relevant parts of an upload, you call - this operation to complete the upload. Upon receiving this request, Amazon S3 concatenates - all the parts in ascending order by part number to create a new object. In the Complete - Multipart Upload request, you must provide the parts list. You must ensure that the - parts list is complete. This operation concatenates the parts that you provide in - the list. For each part in the list, you must provide the part number and the ETag - value, returned after that part was uploaded. - - - - Processing of a Complete Multipart Upload request could take several minutes to complete. - After Amazon S3 begins processing the request, it sends an HTTP response header that - specifies a 200 OK response. While processing is in progress, Amazon S3 periodically - sends white space characters to keep the connection from timing out. Because a request - could fail after the initial 200 OK response has been sent, it is important that you - check the response body to determine whether the request succeeded. - - - - Note that if CompleteMultipartUpload fails, applications should be prepared - to retry the failed requests. For more information, see Amazon - S3 Error Best Practices. - - - - For more information about multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - GetBucketLifecycle has the following special errors: - -
  • - - Error code: EntityTooSmall - -
    • - - Description: Your proposed upload is smaller than the minimum allowed object size. - Each part must be at least 5 MB in size, except the last part. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPart - -
    • - - Description: One or more of the specified parts could not be found. The part might - not have been uploaded, or the specified entity tag might not have matched the part's - entity tag. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPartOrder - -
    • - - Description: The list of parts was not in ascending order. The parts list must be - specified in order by part number. - -
    • - - 400 Bad Request - -
  • - - Error code: NoSuchUpload - -
    • - - Description: The specified multipart upload does not exist. The upload ID might be - invalid, or the multipart upload might have been aborted or completed. - -
    • - - 404 Not Found - -
- - The following operations are related to CompleteMultipartUpload: - - - - Container for the necessary parameters to execute the CompleteMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CompleteMultipartUpload service method, as returned by S3. - REST API Reference for CompleteMultipartUpload Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 Developer Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Encryption - - - - The source object that you are copying can be encrypted or unencrypted. The source - object can be encrypted with server-side encryption using AWS managed encryption keys - (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side - encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers - and decrypts the data when you access it. - - - - You can optionally use the appropriate encryption-related headers to request server-side - encryption for the target object. You have the option to provide your own encryption - key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that - was used to encrypt the source object. You can even request encryption if the source - object was not encrypted. For more information about server-side encryption, see Using - Server-Side Encryption. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject operation to change the storage class of an - object that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 Service Developer Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 Developer Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Encryption - - - - The source object that you are copying can be encrypted or unencrypted. The source - object can be encrypted with server-side encryption using AWS managed encryption keys - (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side - encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers - and decrypts the data when you access it. - - - - You can optionally use the appropriate encryption-related headers to request server-side - encryption for the target object. You have the option to provide your own encryption - key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that - was used to encrypt the source object. You can even request encryption if the source - object was not encrypted. For more information about server-side encryption, see Using - Server-Side Encryption. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject operation to change the storage class of an - object that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 Service Developer Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 Developer Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Encryption - - - - The source object that you are copying can be encrypted or unencrypted. The source - object can be encrypted with server-side encryption using AWS managed encryption keys - (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side - encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers - and decrypts the data when you access it. - - - - You can optionally use the appropriate encryption-related headers to request server-side - encryption for the target object. You have the option to provide your own encryption - key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that - was used to encrypt the source object. You can even request encryption if the source - object was not encrypted. For more information about server-side encryption, see Using - Server-Side Encryption. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject operation to change the storage class of an - object that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 Service Developer Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - Container for the necessary parameters to execute the CopyObject service method. - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 Developer Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Encryption - - - - The source object that you are copying can be encrypted or unencrypted. The source - object can be encrypted with server-side encryption using AWS managed encryption keys - (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side - encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers - and decrypts the data when you access it. - - - - You can optionally use the appropriate encryption-related headers to request server-side - encryption for the target object. You have the option to provide your own encryption - key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that - was used to encrypt the source object. You can even request encryption if the source - object was not encrypted. For more information about server-side encryption, see Using - Server-Side Encryption. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject operation to change the storage class of an - object that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 Service Developer Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 Developer Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Encryption - - - - The source object that you are copying can be encrypted or unencrypted. The source - object can be encrypted with server-side encryption using AWS managed encryption keys - (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side - encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers - and decrypts the data when you access it. - - - - You can optionally use the appropriate encryption-related headers to request server-side - encryption for the target object. You have the option to provide your own encryption - key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that - was used to encrypt the source object. You can even request encryption if the source - object was not encrypted. For more information about server-side encryption, see Using - Server-Side Encryption. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject operation to change the storage class of an - object that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 Service Developer Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 Developer Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Encryption - - - - The source object that you are copying can be encrypted or unencrypted. The source - object can be encrypted with server-side encryption using AWS managed encryption keys - (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side - encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers - and decrypts the data when you access it. - - - - You can optionally use the appropriate encryption-related headers to request server-side - encryption for the target object. You have the option to provide your own encryption - key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that - was used to encrypt the source object. You can even request encryption if the source - object was not encrypted. For more information about server-side encryption, see Using - Server-Side Encryption. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject operation to change the storage class of an - object that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 Service Developer Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - Container for the necessary parameters to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - - - - - - - - - - - Deletes an analytics configuration for the bucket (specified by the analytics configuration - ID). - - - - To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to DeleteBucketAnalyticsConfiguration: - -
  • - - - -
  • - - - -
  • - - - -
- - Container for the necessary parameters to execute the DeleteBucketAnalyticsConfiguration service method. - - The response from the DeleteBucketAnalyticsConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketAnalyticsConfiguration Operation - - - - Deletes an analytics configuration for the bucket (specified by the analytics configuration - ID). - - - - To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to DeleteBucketAnalyticsConfiguration: - -
  • - - - -
  • - - - -
  • - - - -
- - Container for the necessary parameters to execute the DeleteBucketAnalyticsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketAnalyticsConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketAnalyticsConfiguration Operation - - - - - - Deletes an inventory configuration (identified by the inventory ID) from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - Operations related to DeleteBucketInventoryConfiguration include: - - - - Container for the necessary parameters to execute the DeleteBucketInventoryConfiguration service method. - - The response from the DeleteBucketInventoryConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketInventoryConfiguration Operation - - - - Deletes an inventory configuration (identified by the inventory ID) from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - Operations related to DeleteBucketInventoryConfiguration include: - - - - Container for the necessary parameters to execute the DeleteBucketInventoryConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketInventoryConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketInventoryConfiguration Operation - - - - Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified - by the metrics configuration ID) from the bucket. Note that this doesn't include the - daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteBucketMetricsConfiguration service method. - - The response from the DeleteBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketMetricsConfiguration Operation - - - - Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified - by the metrics configuration ID) from the bucket. Note that this doesn't include the - daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketMetricsConfiguration Operation - - - - This implementation of the DELETE operation uses the policy subresource to delete - the policy of a specified bucket. If you are using an identity other than the root - user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - The bucket name. - - The response from the DeleteBucketPolicy service method, as returned by S3. - REST API Reference for DeleteBucketPolicy Operation - - - - This implementation of the DELETE operation uses the policy subresource to delete - the policy of a specified bucket. If you are using an identity other than the root - user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - Container for the necessary parameters to execute the DeleteBucketPolicy service method. - - The response from the DeleteBucketPolicy service method, as returned by S3. - REST API Reference for DeleteBucketPolicy Operation - - - - This implementation of the DELETE operation uses the policy subresource to delete - the policy of a specified bucket. If you are using an identity other than the root - user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - The bucket name. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketPolicy service method, as returned by S3. - REST API Reference for DeleteBucketPolicy Operation - - - - This implementation of the DELETE operation uses the policy subresource to delete - the policy of a specified bucket. If you are using an identity other than the root - user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - Container for the necessary parameters to execute the DeleteBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketPolicy service method, as returned by S3. - REST API Reference for DeleteBucketPolicy Operation - - - - Deletes the replication configuration from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutReplicationConfiguration - action. The bucket owner has these permissions by default and can grant it to others. - For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - It can take a while for the deletion of a replication configuration to fully propagate. - - - - For information about replication configuration, see Replication - in the Amazon S3 Developer Guide. - - - - The following operations are related to DeleteBucketReplication: - - - - Container for the necessary parameters to execute the DeleteBucketReplication service method. - - The response from the DeleteBucketReplication service method, as returned by S3. - REST API Reference for DeleteBucketReplication Operation - - - - Deletes the replication configuration from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutReplicationConfiguration - action. The bucket owner has these permissions by default and can grant it to others. - For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - It can take a while for the deletion of a replication configuration to fully propagate. - - - - For information about replication configuration, see Replication - in the Amazon S3 Developer Guide. - - - - The following operations are related to DeleteBucketReplication: - - - - Container for the necessary parameters to execute the DeleteBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketReplication service method, as returned by S3. - REST API Reference for DeleteBucketReplication Operation - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - The bucket that has the tag set to be removed. - - The response from the DeleteBucketTagging service method, as returned by S3. - REST API Reference for DeleteBucketTagging Operation - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - Container for the necessary parameters to execute the DeleteBucketTagging service method. - - The response from the DeleteBucketTagging service method, as returned by S3. - REST API Reference for DeleteBucketTagging Operation - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - The bucket that has the tag set to be removed. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketTagging service method, as returned by S3. - REST API Reference for DeleteBucketTagging Operation - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - Container for the necessary parameters to execute the DeleteBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketTagging service method, as returned by S3. - REST API Reference for DeleteBucketTagging Operation - - - - This operation removes the website configuration for a bucket. Amazon S3 returns a - 200 OK response upon successfully deleting a website configuration on - the specified bucket. You will get a 200 OK response if the website configuration - you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE operation requires the S3:DeleteBucketWebsite permission. - By default, only the bucket owner can delete the website configuration attached to - a bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which you want to remove the website configuration. - - The response from the DeleteBucketWebsite service method, as returned by S3. - REST API Reference for DeleteBucketWebsite Operation - - - - This operation removes the website configuration for a bucket. Amazon S3 returns a - 200 OK response upon successfully deleting a website configuration on - the specified bucket. You will get a 200 OK response if the website configuration - you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE operation requires the S3:DeleteBucketWebsite permission. - By default, only the bucket owner can delete the website configuration attached to - a bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the DeleteBucketWebsite service method. - - The response from the DeleteBucketWebsite service method, as returned by S3. - REST API Reference for DeleteBucketWebsite Operation - - - - This operation removes the website configuration for a bucket. Amazon S3 returns a - 200 OK response upon successfully deleting a website configuration on - the specified bucket. You will get a 200 OK response if the website configuration - you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE operation requires the S3:DeleteBucketWebsite permission. - By default, only the bucket owner can delete the website configuration attached to - a bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which you want to remove the website configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketWebsite service method, as returned by S3. - REST API Reference for DeleteBucketWebsite Operation - - - - This operation removes the website configuration for a bucket. Amazon S3 returns a - 200 OK response upon successfully deleting a website configuration on - the specified bucket. You will get a 200 OK response if the website configuration - you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE operation requires the S3:DeleteBucketWebsite permission. - By default, only the bucket owner can delete the website configuration attached to - a bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the DeleteBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketWebsite service method, as returned by S3. - REST API Reference for DeleteBucketWebsite Operation - - - - - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - The bucket name of the lifecycle to delete. - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - REST API Reference for DeleteLifecycleConfiguration Operation - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - Container for the necessary parameters to execute the DeleteLifecycleConfiguration service method. - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - REST API Reference for DeleteLifecycleConfiguration Operation - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - The bucket name of the lifecycle to delete. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - REST API Reference for DeleteLifecycleConfiguration Operation - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - Container for the necessary parameters to execute the DeleteLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - REST API Reference for DeleteLifecycleConfiguration Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key name of the object to delete. - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key name of the object to delete. - VersionId used to reference a specific version of the object. - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - Container for the necessary parameters to execute the DeleteObject service method. - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key name of the object to delete. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key name of the object to delete. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - Container for the necessary parameters to execute the DeleteObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - This operation enables you to delete multiple objects from a bucket using a single - HTTP request. If you know the object keys that you want to delete, then this operation - provides a suitable alternative to sending individual delete requests, reducing per-request - overhead. - - - - The request contains a list of up to 1000 keys that you want to delete. In the XML, - you provide the object key names, and optionally, version IDs if you want to delete - a specific version of the object from a versioning-enabled bucket. For each key, Amazon - S3 performs a delete operation and returns the result of that delete, success, or - failure, in the response. Note that if the object specified in the request is not - found, Amazon S3 returns the result as deleted. - - - - The operation supports two modes for the response: verbose and quiet. By default, - the operation uses verbose mode in which the response includes the result of deletion - of each key in your request. In quiet mode the response includes only keys where the - delete operation encountered an error. For a successful deletion, the operation does - not return any information about the delete in the response body. - - - - When performing this operation on an MFA Delete enabled bucket, that attempts to delete - any versioned objects, you must include an MFA token. If you do not provide one, the - entire request will fail, even if there are non-versioned objects you are trying to - delete. If you provide an invalid token, whether there are versioned keys in the request - or not, the entire Multi-Object Delete request will fail. For information about MFA - Delete, see - MFA Delete. - - - - Finally, the Content-MD5 header is required for all Multi-Object Delete requests. - Amazon S3 uses the header value to ensure that your request body has not been altered - in transit. - - - - The following operations are related to DeleteObjects: - - - - Container for the necessary parameters to execute the DeleteObjects service method. - - The response from the DeleteObjects service method, as returned by S3. - REST API Reference for DeleteObjects Operation - - - - This operation enables you to delete multiple objects from a bucket using a single - HTTP request. If you know the object keys that you want to delete, then this operation - provides a suitable alternative to sending individual delete requests, reducing per-request - overhead. - - - - The request contains a list of up to 1000 keys that you want to delete. In the XML, - you provide the object key names, and optionally, version IDs if you want to delete - a specific version of the object from a versioning-enabled bucket. For each key, Amazon - S3 performs a delete operation and returns the result of that delete, success, or - failure, in the response. Note that if the object specified in the request is not - found, Amazon S3 returns the result as deleted. - - - - The operation supports two modes for the response: verbose and quiet. By default, - the operation uses verbose mode in which the response includes the result of deletion - of each key in your request. In quiet mode the response includes only keys where the - delete operation encountered an error. For a successful deletion, the operation does - not return any information about the delete in the response body. - - - - When performing this operation on an MFA Delete enabled bucket, that attempts to delete - any versioned objects, you must include an MFA token. If you do not provide one, the - entire request will fail, even if there are non-versioned objects you are trying to - delete. If you provide an invalid token, whether there are versioned keys in the request - or not, the entire Multi-Object Delete request will fail. For information about MFA - Delete, see - MFA Delete. - - - - Finally, the Content-MD5 header is required for all Multi-Object Delete requests. - Amazon S3 uses the header value to ensure that your request body has not been altered - in transit. - - - - The following operations are related to DeleteObjects: - - - - Container for the necessary parameters to execute the DeleteObjects service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObjects service method, as returned by S3. - REST API Reference for DeleteObjects Operation - - - - Removes the entire tag set from the specified object. For more information about managing - object tags, see - Object Tagging. - - - - To use this operation, you must have permission to perform the s3:DeleteObjectTagging - action. - - - - To delete tags of a specific object version, add the versionId query - parameter in the request. You will need permission for the s3:DeleteObjectVersionTagging - action. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteObjectTagging service method. - - The response from the DeleteObjectTagging service method, as returned by S3. - REST API Reference for DeleteObjectTagging Operation - - - - Removes the entire tag set from the specified object. For more information about managing - object tags, see - Object Tagging. - - - - To use this operation, you must have permission to perform the s3:DeleteObjectTagging - action. - - - - To delete tags of a specific object version, add the versionId query - parameter in the request. You will need permission for the s3:DeleteObjectVersionTagging - action. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteObjectTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObjectTagging service method, as returned by S3. - REST API Reference for DeleteObjectTagging Operation - - - - Removes the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:PutBucketPublicAccessBlock - permission. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to DeletePublicAccessBlock: - - - - Container for the necessary parameters to execute the DeletePublicAccessBlock service method. - - The response from the DeletePublicAccessBlock service method, as returned by S3. - REST API Reference for DeletePublicAccessBlock Operation - - - - Removes the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:PutBucketPublicAccessBlock - permission. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to DeletePublicAccessBlock: - - - - Container for the necessary parameters to execute the DeletePublicAccessBlock service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeletePublicAccessBlock service method, as returned by S3. - REST API Reference for DeletePublicAccessBlock Operation - - - - - - - - - - - - - - Returns the default encryption configuration for an Amazon S3 bucket. For information - about the Amazon S3 default encryption feature, see Amazon - S3 Default Bucket Encryption. - - - - To use this operation, you must have permission to perform the s3:GetEncryptionConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to GetBucketEncryption: - - - - Container for the necessary parameters to execute the GetBucketEncryption service method. - - The response from the GetBucketEncryption service method, as returned by S3. - REST API Reference for GetBucketEncryption Operation - - - - Returns the default encryption configuration for an Amazon S3 bucket. For information - about the Amazon S3 default encryption feature, see Amazon - S3 Default Bucket Encryption. - - - - To use this operation, you must have permission to perform the s3:GetEncryptionConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to GetBucketEncryption: - - - - Container for the necessary parameters to execute the GetBucketEncryption service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketEncryption service method, as returned by S3. - REST API Reference for GetBucketEncryption Operation - - - - Returns an inventory configuration (identified by the inventory configuration ID) - from the bucket. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - The following operations are related to GetBucketInventoryConfiguration: - - - - Container for the necessary parameters to execute the GetBucketInventoryConfiguration service method. - - The response from the GetBucketInventoryConfiguration service method, as returned by S3. - REST API Reference for GetBucketInventoryConfiguration Operation - - - - Returns an inventory configuration (identified by the inventory configuration ID) - from the bucket. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - The following operations are related to GetBucketInventoryConfiguration: - - - - Container for the necessary parameters to execute the GetBucketInventoryConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketInventoryConfiguration service method, as returned by S3. - REST API Reference for GetBucketInventoryConfiguration Operation - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - The name of the bucket for which to get the location. - - The response from the GetBucketLocation service method, as returned by S3. - REST API Reference for GetBucketLocation Operation - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - Container for the necessary parameters to execute the GetBucketLocation service method. - - The response from the GetBucketLocation service method, as returned by S3. - REST API Reference for GetBucketLocation Operation - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - The name of the bucket for which to get the location. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLocation service method, as returned by S3. - REST API Reference for GetBucketLocation Operation - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - Container for the necessary parameters to execute the GetBucketLocation service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLocation service method, as returned by S3. - REST API Reference for GetBucketLocation Operation - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - The bucket name for which to get the logging information. - - The response from the GetBucketLogging service method, as returned by S3. - REST API Reference for GetBucketLogging Operation - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - Container for the necessary parameters to execute the GetBucketLogging service method. - - The response from the GetBucketLogging service method, as returned by S3. - REST API Reference for GetBucketLogging Operation - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - The bucket name for which to get the logging information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLogging service method, as returned by S3. - REST API Reference for GetBucketLogging Operation - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - Container for the necessary parameters to execute the GetBucketLogging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLogging service method, as returned by S3. - REST API Reference for GetBucketLogging Operation - - - - Gets a metrics configuration (specified by the metrics configuration ID) from the - bucket. Note that this doesn't include the daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to GetBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the GetBucketMetricsConfiguration service method. - - The response from the GetBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for GetBucketMetricsConfiguration Operation - - - - Gets a metrics configuration (specified by the metrics configuration ID) from the - bucket. Note that this doesn't include the daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to GetBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the GetBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for GetBucketMetricsConfiguration Operation - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following operation is related to GetBucketNotification: - - - - Name of the bucket for which to get the notification configuration. - - The response from the GetBucketNotification service method, as returned by S3. - REST API Reference for GetBucketNotification Operation - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following operation is related to GetBucketNotification: - - - - Container for the necessary parameters to execute the GetBucketNotification service method. - - The response from the GetBucketNotification service method, as returned by S3. - REST API Reference for GetBucketNotification Operation - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following operation is related to GetBucketNotification: - - - - Name of the bucket for which to get the notification configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketNotification service method, as returned by S3. - REST API Reference for GetBucketNotification Operation - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following operation is related to GetBucketNotification: - - - - Container for the necessary parameters to execute the GetBucketNotification service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketNotification service method, as returned by S3. - REST API Reference for GetBucketNotification Operation - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operation is related to GetBucketPolicy: - - - - The bucket name for which to get the bucket policy. - - The response from the GetBucketPolicy service method, as returned by S3. - REST API Reference for GetBucketPolicy Operation - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operation is related to GetBucketPolicy: - - - - Container for the necessary parameters to execute the GetBucketPolicy service method. - - The response from the GetBucketPolicy service method, as returned by S3. - REST API Reference for GetBucketPolicy Operation - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operation is related to GetBucketPolicy: - - - - The bucket name for which to get the bucket policy. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicy service method, as returned by S3. - REST API Reference for GetBucketPolicy Operation - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operation is related to GetBucketPolicy: - - - - Container for the necessary parameters to execute the GetBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicy service method, as returned by S3. - REST API Reference for GetBucketPolicy Operation - - - - Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket - is public. In order to use this operation, you must have the s3:GetBucketPolicyStatus - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - For more information about when Amazon S3 considers a bucket public, see The - Meaning of "Public". - - - - The following operations are related to GetBucketPolicyStatus: - - - - Container for the necessary parameters to execute the GetBucketPolicyStatus service method. - - The response from the GetBucketPolicyStatus service method, as returned by S3. - REST API Reference for GetBucketPolicyStatus Operation - - - - Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket - is public. In order to use this operation, you must have the s3:GetBucketPolicyStatus - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - For more information about when Amazon S3 considers a bucket public, see The - Meaning of "Public". - - - - The following operations are related to GetBucketPolicyStatus: - - - - Container for the necessary parameters to execute the GetBucketPolicyStatus service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicyStatus service method, as returned by S3. - REST API Reference for GetBucketPolicyStatus Operation - - - - Retrieves the replication configuration for the given Amazon S3 bucket. - - Container for the necessary parameters to execute the GetBucketReplication service method. - - The response from the GetBucketReplication service method, as returned by S3. - REST API Reference for GetBucketReplication Operation - - - - Retrieves the replication configuration for the given Amazon S3 bucket. - - Container for the necessary parameters to execute the GetBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketReplication service method, as returned by S3. - REST API Reference for GetBucketReplication Operation - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - The name of the bucket for which to get the payment request configuration - - The response from the GetBucketRequestPayment service method, as returned by S3. - REST API Reference for GetBucketRequestPayment Operation - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - Container for the necessary parameters to execute the GetBucketRequestPayment service method. - - The response from the GetBucketRequestPayment service method, as returned by S3. - REST API Reference for GetBucketRequestPayment Operation - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - The name of the bucket for which to get the payment request configuration - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketRequestPayment service method, as returned by S3. - REST API Reference for GetBucketRequestPayment Operation - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - Container for the necessary parameters to execute the GetBucketRequestPayment service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketRequestPayment service method, as returned by S3. - REST API Reference for GetBucketRequestPayment Operation - - - - Returns the tag set associated with the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - GetBucketTagging has the following special error: - -
  • - - Error code: NoSuchTagSetError - -
    • - - Description: There is no tag set associated with the bucket. - -
- - The following operations are related to GetBucketTagging: - - - - Container for the necessary parameters to execute the GetBucketTagging service method. - - The response from the GetBucketTagging service method, as returned by S3. - REST API Reference for GetBucketTagging Operation - - - - Returns the tag set associated with the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - GetBucketTagging has the following special error: - -
  • - - Error code: NoSuchTagSetError - -
    • - - Description: There is no tag set associated with the bucket. - -
- - The following operations are related to GetBucketTagging: - - - - Container for the necessary parameters to execute the GetBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketTagging service method, as returned by S3. - REST API Reference for GetBucketTagging Operation - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - The name of the bucket for which to get the versioning information. - - The response from the GetBucketVersioning service method, as returned by S3. - REST API Reference for GetBucketVersioning Operation - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - Container for the necessary parameters to execute the GetBucketVersioning service method. - - The response from the GetBucketVersioning service method, as returned by S3. - REST API Reference for GetBucketVersioning Operation - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - The name of the bucket for which to get the versioning information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketVersioning service method, as returned by S3. - REST API Reference for GetBucketVersioning Operation - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - Container for the necessary parameters to execute the GetBucketVersioning service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketVersioning service method, as returned by S3. - REST API Reference for GetBucketVersioning Operation - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET operation requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which to get the website configuration. - - The response from the GetBucketWebsite service method, as returned by S3. - REST API Reference for GetBucketWebsite Operation - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET operation requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the GetBucketWebsite service method. - - The response from the GetBucketWebsite service method, as returned by S3. - REST API Reference for GetBucketWebsite Operation - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET operation requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which to get the website configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketWebsite service method, as returned by S3. - REST API Reference for GetBucketWebsite Operation - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET operation requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the GetBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketWebsite service method, as returned by S3. - REST API Reference for GetBucketWebsite Operation - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - The bucket name for which to get the cors configuration. - - The response from the GetCORSConfiguration service method, as returned by S3. - REST API Reference for GetCORSConfiguration Operation - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - Container for the necessary parameters to execute the GetCORSConfiguration service method. - - The response from the GetCORSConfiguration service method, as returned by S3. - REST API Reference for GetCORSConfiguration Operation - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - The bucket name for which to get the cors configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetCORSConfiguration service method, as returned by S3. - REST API Reference for GetCORSConfiguration Operation - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - Container for the necessary parameters to execute the GetCORSConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetCORSConfiguration service method, as returned by S3. - REST API Reference for GetCORSConfiguration Operation - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are still using previous version of the lifecycle configuration, it works. - For the earlier API description, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to GetBucketLifecycleConfiguration: - - - - The name of the bucket for which to get the lifecycle information. - - The response from the GetLifecycleConfiguration service method, as returned by S3. - REST API Reference for GetLifecycleConfiguration Operation - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are still using previous version of the lifecycle configuration, it works. - For the earlier API description, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to GetBucketLifecycleConfiguration: - - - - Container for the necessary parameters to execute the GetLifecycleConfiguration service method. - - The response from the GetLifecycleConfiguration service method, as returned by S3. - REST API Reference for GetLifecycleConfiguration Operation - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are still using previous version of the lifecycle configuration, it works. - For the earlier API description, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to GetBucketLifecycleConfiguration: - - - - The name of the bucket for which to get the lifecycle information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetLifecycleConfiguration service method, as returned by S3. - REST API Reference for GetLifecycleConfiguration Operation - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are still using previous version of the lifecycle configuration, it works. - For the earlier API description, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to GetBucketLifecycleConfiguration: - - - - Container for the necessary parameters to execute the GetLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetLifecycleConfiguration service method, as returned by S3. - REST API Reference for GetLifecycleConfiguration Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object to get. - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object to get. - VersionId used to reference a specific version of the object. - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - Container for the necessary parameters to execute the GetObject service method. - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object to get. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object to get. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - Container for the necessary parameters to execute the GetObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Gets an object's current Legal Hold status. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLegalHold service method. - - The response from the GetObjectLegalHold service method, as returned by S3. - REST API Reference for GetObjectLegalHold Operation - - - - Gets an object's current Legal Hold status. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLegalHold service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectLegalHold service method, as returned by S3. - REST API Reference for GetObjectLegalHold Operation - - - - Gets the Object Lock configuration for a bucket. The rule specified in the Object - Lock configuration will be applied by default to every new object placed in the specified - bucket. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLockConfiguration service method. - - The response from the GetObjectLockConfiguration service method, as returned by S3. - REST API Reference for GetObjectLockConfiguration Operation - - - - Gets the Object Lock configuration for a bucket. The rule specified in the Object - Lock configuration will be applied by default to every new object placed in the specified - bucket. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLockConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectLockConfiguration service method, as returned by S3. - REST API Reference for GetObjectLockConfiguration Operation - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - The name of the bucket containing the object. - The object key. - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - The name of the bucket containing the object. - The object key. - VersionId used to reference a specific version of the object. - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - Container for the necessary parameters to execute the GetObjectMetadata service method. - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - The name of the bucket containing the object. - The object key. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - The name of the bucket containing the object. - The object key. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - Container for the necessary parameters to execute the GetObjectMetadata service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - Retrieves an object's retention settings. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectRetention service method. - - The response from the GetObjectRetention service method, as returned by S3. - REST API Reference for GetObjectRetention Operation - - - - Retrieves an object's retention settings. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectRetention service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectRetention service method, as returned by S3. - REST API Reference for GetObjectRetention Operation - - - - Returns the tag-set of an object. You send the GET request against the tagging subresource - associated with the object. - - - - To use this operation, you must have permission to perform the s3:GetObjectTagging - action. By default, the GET operation returns information about current version of - an object. For a versioned bucket, you can have multiple versions of an object in - your bucket. To retrieve tags of any other version, use the versionId query parameter. - You also need permission for the s3:GetObjectVersionTagging action. - - - - By default, the bucket owner has this permission and can grant this permission to - others. - - - - For information about the Amazon S3 object tagging feature, see Object - Tagging. - - - - The following operation is related to GetObjectTagging: - - - - Container for the necessary parameters to execute the GetObjectTagging service method. - - The response from the GetObjectTagging service method, as returned by S3. - REST API Reference for GetObjectTagging Operation - - - - Returns the tag-set of an object. You send the GET request against the tagging subresource - associated with the object. - - - - To use this operation, you must have permission to perform the s3:GetObjectTagging - action. By default, the GET operation returns information about current version of - an object. For a versioned bucket, you can have multiple versions of an object in - your bucket. To retrieve tags of any other version, use the versionId query parameter. - You also need permission for the s3:GetObjectVersionTagging action. - - - - By default, the bucket owner has this permission and can grant this permission to - others. - - - - For information about the Amazon S3 object tagging feature, see Object - Tagging. - - - - The following operation is related to GetObjectTagging: - - - - Container for the necessary parameters to execute the GetObjectTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTagging service method, as returned by S3. - REST API Reference for GetObjectTagging Operation - - - - Return torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Amazon - S3 Torrent. - - - - You can get torrent only for objects that are less than 5 GB in size and that are - not encrypted using server-side encryption with customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - The following operation is related to GetObjectTorrent: - - - - The name of the bucket containing the object for which to get the torrent files. - The object key for which to get the information. - - The response from the GetObjectTorrent service method, as returned by S3. - REST API Reference for GetObjectTorrent Operation - - - - Return torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Amazon - S3 Torrent. - - - - You can get torrent only for objects that are less than 5 GB in size and that are - not encrypted using server-side encryption with customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - The following operation is related to GetObjectTorrent: - - - - Container for the necessary parameters to execute the GetObjectTorrent service method. - - The response from the GetObjectTorrent service method, as returned by S3. - REST API Reference for GetObjectTorrent Operation - - - - Return torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Amazon - S3 Torrent. - - - - You can get torrent only for objects that are less than 5 GB in size and that are - not encrypted using server-side encryption with customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - The following operation is related to GetObjectTorrent: - - - - The name of the bucket containing the object for which to get the torrent files. - The object key for which to get the information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTorrent service method, as returned by S3. - REST API Reference for GetObjectTorrent Operation - - - - Return torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Amazon - S3 Torrent. - - - - You can get torrent only for objects that are less than 5 GB in size and that are - not encrypted using server-side encryption with customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - The following operation is related to GetObjectTorrent: - - - - Container for the necessary parameters to execute the GetObjectTorrent service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTorrent service method, as returned by S3. - REST API Reference for GetObjectTorrent Operation - - - - Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:GetBucketPublicAccessBlock - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket - or an object, it checks the PublicAccessBlock configuration for both - the bucket (or the bucket that contains the object) and the bucket owner's account. - If the PublicAccessBlock settings are different between the bucket and - the account, Amazon S3 uses the most restrictive combination of the bucket-level and - account-level settings. - - - - For more information about when Amazon S3 considers a bucket or an object public, - see The - Meaning of "Public". - - - - The following operations are related to GetPublicAccessBlock: - - - - Container for the necessary parameters to execute the GetPublicAccessBlock service method. - - The response from the GetPublicAccessBlock service method, as returned by S3. - REST API Reference for GetPublicAccessBlock Operation - - - - Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:GetBucketPublicAccessBlock - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket - or an object, it checks the PublicAccessBlock configuration for both - the bucket (or the bucket that contains the object) and the bucket owner's account. - If the PublicAccessBlock settings are different between the bucket and - the account, Amazon S3 uses the most restrictive combination of the bucket-level and - account-level settings. - - - - For more information about when Amazon S3 considers a bucket or an object public, - see The - Meaning of "Public". - - - - The following operations are related to GetPublicAccessBlock: - - - - Container for the necessary parameters to execute the GetPublicAccessBlock service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetPublicAccessBlock service method, as returned by S3. - REST API Reference for GetPublicAccessBlock Operation - - - - This operation is useful to determine if a bucket exists and you have permission to - access it. The operation returns a 200 OK if the bucket exists and you - have permission to access it. Otherwise, the operation might return responses such - as 404 Not Found and 403 Forbidden. - - - - To use this operation, you must have permissions to perform the s3:ListBucket - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - Container for the necessary parameters to execute the HeadBucket service method. - - The response from the HeadBucket service method, as returned by S3. - REST API Reference for HeadBucket Operation - - - - This operation is useful to determine if a bucket exists and you have permission to - access it. The operation returns a 200 OK if the bucket exists and you - have permission to access it. Otherwise, the operation might return responses such - as 404 Not Found and 403 Forbidden. - - - - To use this operation, you must have permissions to perform the s3:ListBucket - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - Container for the necessary parameters to execute the HeadBucket service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the HeadBucket service method, as returned by S3. - REST API Reference for HeadBucket Operation - - - - This operation initiates a multipart upload and returns an upload ID. This upload - ID is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort operation - and Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload API and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart) and UploadPartCopy) requests must match the headers you - used in the request to initiate the upload by using CreateMultipartUpload. - - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, - kms:GenerateDataKey*, and kms:DescribeKey actions on the - key. These permissions are required because Amazon S3 must decrypt and read data from - the encrypted file parts before it completes the multipart upload. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - The following operations are related to CreateMultipartUpload: - - - - The name of the bucket to which to initiate the upload - Object key for which the multipart upload is to be initiated. - - The response from the InitiateMultipartUpload service method, as returned by S3. - REST API Reference for InitiateMultipartUpload Operation - - - - This operation initiates a multipart upload and returns an upload ID. This upload - ID is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort operation - and Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload API and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart) and UploadPartCopy) requests must match the headers you - used in the request to initiate the upload by using CreateMultipartUpload. - - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, - kms:GenerateDataKey*, and kms:DescribeKey actions on the - key. These permissions are required because Amazon S3 must decrypt and read data from - the encrypted file parts before it completes the multipart upload. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - The following operations are related to CreateMultipartUpload: - - - - Container for the necessary parameters to execute the InitiateMultipartUpload service method. - - The response from the InitiateMultipartUpload service method, as returned by S3. - REST API Reference for InitiateMultipartUpload Operation - - - - This operation initiates a multipart upload and returns an upload ID. This upload - ID is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort operation - and Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload API and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart) and UploadPartCopy) requests must match the headers you - used in the request to initiate the upload by using CreateMultipartUpload. - - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, - kms:GenerateDataKey*, and kms:DescribeKey actions on the - key. These permissions are required because Amazon S3 must decrypt and read data from - the encrypted file parts before it completes the multipart upload. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - The following operations are related to CreateMultipartUpload: - - - - The name of the bucket to which to initiate the upload - Object key for which the multipart upload is to be initiated. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the InitiateMultipartUpload service method, as returned by S3. - REST API Reference for InitiateMultipartUpload Operation - - - - This operation initiates a multipart upload and returns an upload ID. This upload - ID is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort operation - and Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload API and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart) and UploadPartCopy) requests must match the headers you - used in the request to initiate the upload by using CreateMultipartUpload. - - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, - kms:GenerateDataKey*, and kms:DescribeKey actions on the - key. These permissions are required because Amazon S3 must decrypt and read data from - the encrypted file parts before it completes the multipart upload. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - The following operations are related to CreateMultipartUpload: - - - - Container for the necessary parameters to execute the InitiateMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the InitiateMultipartUpload service method, as returned by S3. - REST API Reference for InitiateMultipartUpload Operation - - - - Lists the analytics configurations for the bucket. You can have up to 1,000 analytics - configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. You should always check the IsTruncated element in the response. - If there are no more configurations to list, IsTruncated is set to false. - If there are more configurations to list, IsTruncated is set to true, - and there will be a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to ListBucketAnalyticsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketAnalyticsConfigurations service method. - - The response from the ListBucketAnalyticsConfigurations service method, as returned by S3. - REST API Reference for ListBucketAnalyticsConfigurations Operation - - - - Lists the analytics configurations for the bucket. You can have up to 1,000 analytics - configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. You should always check the IsTruncated element in the response. - If there are no more configurations to list, IsTruncated is set to false. - If there are more configurations to list, IsTruncated is set to true, - and there will be a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to ListBucketAnalyticsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketAnalyticsConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketAnalyticsConfigurations service method, as returned by S3. - REST API Reference for ListBucketAnalyticsConfigurations Operation - - - - Returns a list of inventory configurations for the bucket. You can have up to 1,000 - analytics configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory - - - - The following operations are related to ListBucketInventoryConfigurations: - - - - Container for the necessary parameters to execute the ListBucketInventoryConfigurations service method. - - The response from the ListBucketInventoryConfigurations service method, as returned by S3. - REST API Reference for ListBucketInventoryConfigurations Operation - - - - Returns a list of inventory configurations for the bucket. You can have up to 1,000 - analytics configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory - - - - The following operations are related to ListBucketInventoryConfigurations: - - - - Container for the necessary parameters to execute the ListBucketInventoryConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketInventoryConfigurations service method, as returned by S3. - REST API Reference for ListBucketInventoryConfigurations Operation - - - - Lists the metrics configurations for the bucket. The metrics configurations are only - for the request metrics of the bucket and do not provide information on daily storage - metrics. You can have up to 1,000 configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For more information about metrics configurations and CloudWatch request metrics, - see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to ListBucketMetricsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketMetricsConfigurations service method. - - The response from the ListBucketMetricsConfigurations service method, as returned by S3. - REST API Reference for ListBucketMetricsConfigurations Operation - - - - Lists the metrics configurations for the bucket. The metrics configurations are only - for the request metrics of the bucket and do not provide information on daily storage - metrics. You can have up to 1,000 configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For more information about metrics configurations and CloudWatch request metrics, - see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to ListBucketMetricsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketMetricsConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketMetricsConfigurations service method, as returned by S3. - REST API Reference for ListBucketMetricsConfigurations Operation - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - - The response from the ListBuckets service method, as returned by S3. - REST API Reference for ListBuckets Operation - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - Container for the necessary parameters to execute the ListBuckets service method. - - The response from the ListBuckets service method, as returned by S3. - REST API Reference for ListBuckets Operation - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBuckets service method, as returned by S3. - REST API Reference for ListBuckets Operation - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - Container for the necessary parameters to execute the ListBuckets service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBuckets service method, as returned by S3. - REST API Reference for ListBuckets Operation - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Container for the necessary parameters to execute the ListMultipartUploads service method. - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Container for the necessary parameters to execute the ListMultipartUploads service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. - Limits the response to keys that begin with the specified prefix. - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - Container for the necessary parameters to execute the ListObjects service method. - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. - Limits the response to keys that begin with the specified prefix. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - Container for the necessary parameters to execute the ListObjects service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Make sure to design - your application to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - To use this operation in an AWS Identity and Access Management (IAM) policy, you must - have permissions to perform the s3:ListBucket action. The bucket owner - has this permission by default and can grant this permission to others. For more information - about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - This section describes the latest revision of the API. We recommend that you use this - revised API for application development. For backward compatibility, Amazon S3 continues - to support the prior version of this API, ListObjects. - - - - To get a list of your buckets, see ListBuckets. - - - - The following operations are related to ListObjectsV2: - - - - Container for the necessary parameters to execute the ListObjectsV2 service method. - - The response from the ListObjectsV2 service method, as returned by S3. - REST API Reference for ListObjectsV2 Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Make sure to design - your application to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - To use this operation in an AWS Identity and Access Management (IAM) policy, you must - have permissions to perform the s3:ListBucket action. The bucket owner - has this permission by default and can grant this permission to others. For more information - about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - This section describes the latest revision of the API. We recommend that you use this - revised API for application development. For backward compatibility, Amazon S3 continues - to support the prior version of this API, ListObjects. - - - - To get a list of your buckets, see ListBuckets. - - - - The following operations are related to ListObjectsV2: - - - - Container for the necessary parameters to execute the ListObjectsV2 service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjectsV2 service method, as returned by S3. - REST API Reference for ListObjectsV2 Operation - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). This request returns a maximum of 1,000 - uploaded parts. The default number of parts returned is 1,000 parts. You can restrict - the number of parts returned by specifying the max-parts request parameter. - If your multipart upload consists of more than 1,000 parts, the response returns an - IsTruncated field with the value of true, and a NextPartNumberMarker - element. In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListParts: - - - - Name of the bucket to which the parts are being uploaded. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Object key for which the multipart upload was initiated. - Upload ID identifying the multipart upload whose parts are being listed. - - The response from the ListParts service method, as returned by S3. - REST API Reference for ListParts Operation - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). This request returns a maximum of 1,000 - uploaded parts. The default number of parts returned is 1,000 parts. You can restrict - the number of parts returned by specifying the max-parts request parameter. - If your multipart upload consists of more than 1,000 parts, the response returns an - IsTruncated field with the value of true, and a NextPartNumberMarker - element. In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListParts: - - - - Container for the necessary parameters to execute the ListParts service method. - - The response from the ListParts service method, as returned by S3. - REST API Reference for ListParts Operation - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). This request returns a maximum of 1,000 - uploaded parts. The default number of parts returned is 1,000 parts. You can restrict - the number of parts returned by specifying the max-parts request parameter. - If your multipart upload consists of more than 1,000 parts, the response returns an - IsTruncated field with the value of true, and a NextPartNumberMarker - element. In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListParts: - - - - Name of the bucket to which the parts are being uploaded. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Object key for which the multipart upload was initiated. - Upload ID identifying the multipart upload whose parts are being listed. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListParts service method, as returned by S3. - REST API Reference for ListParts Operation - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). This request returns a maximum of 1,000 - uploaded parts. The default number of parts returned is 1,000 parts. You can restrict - the number of parts returned by specifying the max-parts request parameter. - If your multipart upload consists of more than 1,000 parts, the response returns an - IsTruncated field with the value of true, and a NextPartNumberMarker - element. In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListParts: - - - - Container for the necessary parameters to execute the ListParts service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListParts service method, as returned by S3. - REST API Reference for ListParts Operation - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes. - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - Container for the necessary parameters to execute the ListVersions service method. - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - Container for the necessary parameters to execute the ListVersions service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - - - Creates a new bucket. To create a bucket, you must register with Amazon S3 and have - a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed - to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information on bucket naming restrictions, - see Working - with Amazon S3 Buckets. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) - Region. For more information, see How - to Select a Region for Your Buckets. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - Hosting of Buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - The name of the bucket to create. - - The response from the PutBucket service method, as returned by S3. - REST API Reference for PutBucket Operation - - - - Creates a new bucket. To create a bucket, you must register with Amazon S3 and have - a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed - to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information on bucket naming restrictions, - see Working - with Amazon S3 Buckets. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) - Region. For more information, see How - to Select a Region for Your Buckets. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - Hosting of Buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - Container for the necessary parameters to execute the PutBucket service method. - - The response from the PutBucket service method, as returned by S3. - REST API Reference for PutBucket Operation - - - - Creates a new bucket. To create a bucket, you must register with Amazon S3 and have - a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed - to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information on bucket naming restrictions, - see Working - with Amazon S3 Buckets. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) - Region. For more information, see How - to Select a Region for Your Buckets. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - Hosting of Buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - The name of the bucket to create. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucket service method, as returned by S3. - REST API Reference for PutBucket Operation - - - - Creates a new bucket. To create a bucket, you must register with Amazon S3 and have - a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed - to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information on bucket naming restrictions, - see Working - with Amazon S3 Buckets. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) - Region. For more information, see How - to Select a Region for Your Buckets. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - Hosting of Buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - Container for the necessary parameters to execute the PutBucket service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucket service method, as returned by S3. - REST API Reference for PutBucket Operation - - - - Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration - is a bucket-level feature that enables you to perform faster data transfers to Amazon - S3. - - - - To use this operation, you must have permission to perform the s3:PutAccelerateConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The Transfer Acceleration state of a bucket can be set to one of the following two - values: - -
  • - - Enabled – Enables accelerated data transfers to the bucket. - -
  • - - Suspended – Disables accelerated data transfers to the bucket. - -
- - The GetBucketAccelerateConfiguration operation returns the transfer acceleration - state of a bucket. - - - - After setting the Transfer Acceleration state of a bucket to Enabled, it might take - up to thirty minutes before the data transfer rates to the bucket increase. - - - - The name of the bucket used for Transfer Acceleration must be DNS-compliant and must - not contain periods ("."). - - - - For more information about transfer acceleration, see Transfer - Acceleration. - - - - The following operations are related to PutBucketAccelerateConfiguration: - - - - Container for the necessary parameters to execute the PutBucketAccelerateConfiguration service method. - - The response from the PutBucketAccelerateConfiguration service method, as returned by S3. - REST API Reference for PutBucketAccelerateConfiguration Operation - - - - Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration - is a bucket-level feature that enables you to perform faster data transfers to Amazon - S3. - - - - To use this operation, you must have permission to perform the s3:PutAccelerateConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The Transfer Acceleration state of a bucket can be set to one of the following two - values: - -
  • - - Enabled – Enables accelerated data transfers to the bucket. - -
  • - - Suspended – Disables accelerated data transfers to the bucket. - -
- - The GetBucketAccelerateConfiguration operation returns the transfer acceleration - state of a bucket. - - - - After setting the Transfer Acceleration state of a bucket to Enabled, it might take - up to thirty minutes before the data transfer rates to the bucket increase. - - - - The name of the bucket used for Transfer Acceleration must be DNS-compliant and must - not contain periods ("."). - - - - For more information about transfer acceleration, see Transfer - Acceleration. - - - - The following operations are related to PutBucketAccelerateConfiguration: - - - - Container for the necessary parameters to execute the PutBucketAccelerateConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketAccelerateConfiguration service method, as returned by S3. - REST API Reference for PutBucketAccelerateConfiguration Operation - - - - - - - - - - Set the logging parameters for a bucket and to specify permissions for who can view - and modify the logging parameters. All logs are saved to buckets in the same AWS Region - as the source bucket. To set the logging status of a bucket, you must be the bucket - owner. - - - - The bucket owner is automatically granted FULL_CONTROL to all logs. You use the Grantee - request element to grant access to other people. The Permissions request - element specifies the kind of access the grantee has to the logs. - - - - Grantee Values - - - - You can specify the person (grantee) to whom you're assigning access rights (using - request elements) in the following ways: - -
  • - - By the person's ID: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> - </Grantee> - - - - DisplayName is optional and ignored in the request. - -
  • - - By Email address: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee> - - - - - The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl - request, appears as the CanonicalUser. - -
  • - - By URI: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee> - - -
- - To enable logging, you use LoggingEnabled and its children request elements. To disable - logging, you use an empty BucketLoggingStatus request element: - - - - <BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01" /> - - - - - For more information about server access logging, see Server - Access Logging. - - - - For more information about creating a bucket, see CreateBucket. For more information - about returning the logging status of a bucket, see GetBucketLogging. - - - - The following operations are related to PutBucketLogging: - - - - Container for the necessary parameters to execute the PutBucketLogging service method. - - The response from the PutBucketLogging service method, as returned by S3. - REST API Reference for PutBucketLogging Operation - - - - Set the logging parameters for a bucket and to specify permissions for who can view - and modify the logging parameters. All logs are saved to buckets in the same AWS Region - as the source bucket. To set the logging status of a bucket, you must be the bucket - owner. - - - - The bucket owner is automatically granted FULL_CONTROL to all logs. You use the Grantee - request element to grant access to other people. The Permissions request - element specifies the kind of access the grantee has to the logs. - - - - Grantee Values - - - - You can specify the person (grantee) to whom you're assigning access rights (using - request elements) in the following ways: - -
  • - - By the person's ID: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> - </Grantee> - - - - DisplayName is optional and ignored in the request. - -
  • - - By Email address: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee> - - - - - The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl - request, appears as the CanonicalUser. - -
  • - - By URI: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee> - - -
- - To enable logging, you use LoggingEnabled and its children request elements. To disable - logging, you use an empty BucketLoggingStatus request element: - - - - <BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01" /> - - - - - For more information about server access logging, see Server - Access Logging. - - - - For more information about creating a bucket, see CreateBucket. For more information - about returning the logging status of a bucket, see GetBucketLogging. - - - - The following operations are related to PutBucketLogging: - - - - Container for the necessary parameters to execute the PutBucketLogging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketLogging service method, as returned by S3. - REST API Reference for PutBucketLogging Operation - - - - Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. - You can have up to 1,000 metrics configurations per bucket. If you're updating an - existing metrics configuration, note that this is a full replacement of the existing - metrics configuration. If you don't include the elements you want to keep, they are - erased. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to PutBucketMetricsConfiguration: - - - - GetBucketLifecycle has the following special error: - -
  • - - Error code: TooManyConfigurations - -
    • - - Description: You are attempting to create a new configuration but have already reached - the 1,000-configuration limit. - -
    • - - HTTP Status Code: HTTP 400 Bad Request - -
- - Container for the necessary parameters to execute the PutBucketMetricsConfiguration service method. - - The response from the PutBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for PutBucketMetricsConfiguration Operation - - - - Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. - You can have up to 1,000 metrics configurations per bucket. If you're updating an - existing metrics configuration, note that this is a full replacement of the existing - metrics configuration. If you don't include the elements you want to keep, they are - erased. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to PutBucketMetricsConfiguration: - - - - GetBucketLifecycle has the following special error: - -
  • - - Error code: TooManyConfigurations - -
    • - - Description: You are attempting to create a new configuration but have already reached - the 1,000-configuration limit. - -
    • - - HTTP Status Code: HTTP 400 Bad Request - -
- - Container for the necessary parameters to execute the PutBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for PutBucketMetricsConfiguration Operation - - - - Enables notifications of specified events for a bucket. For more information about - event notifications, see Configuring - Event Notifications. - - - - Using this API, you can replace an existing notification configuration. The configuration - is an XML file that defines the event types that you want Amazon S3 to publish and - the destination where you want Amazon S3 to publish an event notification when it - detects an event of the specified type. - - - - By default, your bucket has no event notifications configured. That is, the notification - configuration will be an empty NotificationConfiguration. - - - - <NotificationConfiguration> - - - - </NotificationConfiguration> - - - - This operation replaces the existing notification configuration with the configuration - you include in the request body. - - - - After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification - Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, - and that the bucket owner has permission to publish to it by sending a test notification. - In the case of AWS Lambda destinations, Amazon S3 verifies that the Lambda function - permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. - For more information, see Configuring - Notifications for Amazon S3 Events. - - - - You can disable notifications by adding the empty NotificationConfiguration element. - - - - By default, only the bucket owner can configure notifications on a bucket. However, - bucket owners can use a bucket policy to grant permission to other users to set this - configuration with s3:PutBucketNotification permission. - - - - The PUT notification is an atomic operation. For example, suppose your notification - configuration includes SNS topic, SQS queue, and Lambda function configurations. When - you send a PUT request with this configuration, Amazon S3 sends test messages to your - SNS topic. If the message fails, the entire PUT operation will fail, and Amazon S3 - will not add the configuration to your bucket. - - - - Responses - - - - If the configuration in the request body includes only one TopicConfiguration - specifying only the s3:ReducedRedundancyLostObject event type, the response - will also include the x-amz-sns-test-message-id header containing the - message ID of the test notification sent to the topic. - - - - The following operation is related to PutBucketNotificationConfiguration: - - - - Container for the necessary parameters to execute the PutBucketNotification service method. - - The response from the PutBucketNotification service method, as returned by S3. - REST API Reference for PutBucketNotification Operation - - - - Enables notifications of specified events for a bucket. For more information about - event notifications, see Configuring - Event Notifications. - - - - Using this API, you can replace an existing notification configuration. The configuration - is an XML file that defines the event types that you want Amazon S3 to publish and - the destination where you want Amazon S3 to publish an event notification when it - detects an event of the specified type. - - - - By default, your bucket has no event notifications configured. That is, the notification - configuration will be an empty NotificationConfiguration. - - - - <NotificationConfiguration> - - - - </NotificationConfiguration> - - - - This operation replaces the existing notification configuration with the configuration - you include in the request body. - - - - After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification - Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, - and that the bucket owner has permission to publish to it by sending a test notification. - In the case of AWS Lambda destinations, Amazon S3 verifies that the Lambda function - permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. - For more information, see Configuring - Notifications for Amazon S3 Events. - - - - You can disable notifications by adding the empty NotificationConfiguration element. - - - - By default, only the bucket owner can configure notifications on a bucket. However, - bucket owners can use a bucket policy to grant permission to other users to set this - configuration with s3:PutBucketNotification permission. - - - - The PUT notification is an atomic operation. For example, suppose your notification - configuration includes SNS topic, SQS queue, and Lambda function configurations. When - you send a PUT request with this configuration, Amazon S3 sends test messages to your - SNS topic. If the message fails, the entire PUT operation will fail, and Amazon S3 - will not add the configuration to your bucket. - - - - Responses - - - - If the configuration in the request body includes only one TopicConfiguration - specifying only the s3:ReducedRedundancyLostObject event type, the response - will also include the x-amz-sns-test-message-id header containing the - message ID of the test notification sent to the topic. - - - - The following operation is related to PutBucketNotificationConfiguration: - - - - Container for the necessary parameters to execute the PutBucketNotification service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketNotification service method, as returned by S3. - REST API Reference for PutBucketNotification Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - The MD5 hash of the request body. - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - Container for the necessary parameters to execute the PutBucketPolicy service method. - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - The MD5 hash of the request body. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - Container for the necessary parameters to execute the PutBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Creates a replication configuration or replaces an existing one. For more information, - see Replication - in the Amazon S3 Developer Guide. - - - - To perform this operation, the user or role performing the operation must have the - iam:PassRole - permission. - - - - Specify the replication configuration in the request body. In the replication configuration, - you provide the name of the destination bucket where you want Amazon S3 to replicate - objects, the IAM role that Amazon S3 can assume to replicate objects on your behalf, - and other relevant information. - - - - A replication configuration must include at least one rule, and can contain a maximum - of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects - in the source bucket. To choose additional subsets of objects to replicate, add a - rule for each subset. All rules must specify the same destination bucket. - - - - To specify a subset of the objects in the source bucket to apply a replication rule - to, add the Filter element as a child of the Rule element. You can filter objects - based on an object key prefix, one or more object tags, or both. When you add the - Filter element in the configuration, you must also add the following elements: DeleteMarkerReplication, - Status, and Priority. - - - - For information about enabling versioning on a bucket, see Using - Versioning. - - - - By default, a resource owner, in this case the AWS account that created the bucket, - can perform this operation. The resource owner can also grant others permissions to - perform the operation. For more information about permissions, see Specifying - Permissions in a Policy and Managing - Access Permissions to Your Amazon S3 Resources. - - - - Handling Replication of Encrypted Objects - - - - By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side - encryption with CMKs stored in AWS KMS. To replicate AWS KMS-encrypted objects, add - the following: SourceSelectionCriteria, SseKmsEncryptedObjects, - Status, EncryptionConfiguration, and ReplicaKmsKeyID. - For information about replication configuration, see Replicating - Objects Created with SSE Using CMKs stored in AWS KMS. - - - - For information on PutBucketReplication errors, see ReplicationErrorCodeList - - - - - The following operations are related to PutBucketReplication: - - - - Container for the necessary parameters to execute the PutBucketReplication service method. - - The response from the PutBucketReplication service method, as returned by S3. - REST API Reference for PutBucketReplication Operation - - - - Creates a replication configuration or replaces an existing one. For more information, - see Replication - in the Amazon S3 Developer Guide. - - - - To perform this operation, the user or role performing the operation must have the - iam:PassRole - permission. - - - - Specify the replication configuration in the request body. In the replication configuration, - you provide the name of the destination bucket where you want Amazon S3 to replicate - objects, the IAM role that Amazon S3 can assume to replicate objects on your behalf, - and other relevant information. - - - - A replication configuration must include at least one rule, and can contain a maximum - of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects - in the source bucket. To choose additional subsets of objects to replicate, add a - rule for each subset. All rules must specify the same destination bucket. - - - - To specify a subset of the objects in the source bucket to apply a replication rule - to, add the Filter element as a child of the Rule element. You can filter objects - based on an object key prefix, one or more object tags, or both. When you add the - Filter element in the configuration, you must also add the following elements: DeleteMarkerReplication, - Status, and Priority. - - - - For information about enabling versioning on a bucket, see Using - Versioning. - - - - By default, a resource owner, in this case the AWS account that created the bucket, - can perform this operation. The resource owner can also grant others permissions to - perform the operation. For more information about permissions, see Specifying - Permissions in a Policy and Managing - Access Permissions to Your Amazon S3 Resources. - - - - Handling Replication of Encrypted Objects - - - - By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side - encryption with CMKs stored in AWS KMS. To replicate AWS KMS-encrypted objects, add - the following: SourceSelectionCriteria, SseKmsEncryptedObjects, - Status, EncryptionConfiguration, and ReplicaKmsKeyID. - For information about replication configuration, see Replicating - Objects Created with SSE Using CMKs stored in AWS KMS. - - - - For information on PutBucketReplication errors, see ReplicationErrorCodeList - - - - - The following operations are related to PutBucketReplication: - - - - Container for the necessary parameters to execute the PutBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketReplication service method, as returned by S3. - REST API Reference for PutBucketReplication Operation - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - The bucket name. - Container for Payer. - - The response from the PutBucketRequestPayment service method, as returned by S3. - REST API Reference for PutBucketRequestPayment Operation - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - Container for the necessary parameters to execute the PutBucketRequestPayment service method. - - The response from the PutBucketRequestPayment service method, as returned by S3. - REST API Reference for PutBucketRequestPayment Operation - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - The bucket name. - Container for Payer. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketRequestPayment service method, as returned by S3. - REST API Reference for PutBucketRequestPayment Operation - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - Container for the necessary parameters to execute the PutBucketRequestPayment service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketRequestPayment service method, as returned by S3. - REST API Reference for PutBucketRequestPayment Operation - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging. - - - - Within a bucket, if you add a tag that has the same key as an existing tag, the new - value overwrites the old value. For more information, see Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional operation is currently in progress against - this resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - The bucket name. - A property of PutBucketTaggingRequest used to execute the PutBucketTagging service method. - - The response from the PutBucketTagging service method, as returned by S3. - REST API Reference for PutBucketTagging Operation - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging. - - - - Within a bucket, if you add a tag that has the same key as an existing tag, the new - value overwrites the old value. For more information, see Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional operation is currently in progress against - this resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - Container for the necessary parameters to execute the PutBucketTagging service method. - - The response from the PutBucketTagging service method, as returned by S3. - REST API Reference for PutBucketTagging Operation - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging. - - - - Within a bucket, if you add a tag that has the same key as an existing tag, the new - value overwrites the old value. For more information, see Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional operation is currently in progress against - this resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - The bucket name. - A property of PutBucketTaggingRequest used to execute the PutBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketTagging service method, as returned by S3. - REST API Reference for PutBucketTagging Operation - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging. - - - - Within a bucket, if you add a tag that has the same key as an existing tag, the new - value overwrites the old value. For more information, see Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional operation is currently in progress against - this resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - Container for the necessary parameters to execute the PutBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketTagging service method, as returned by S3. - REST API Reference for PutBucketTagging Operation - - - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT operation requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - Amazon S3 has a limitation of 50 routing rules per website configuration. If you require - more than 50 routing rules, you can use object redirect. For more information, see - Configuring - an Object Redirect in the Amazon Simple Storage Service Developer Guide. - - - The bucket name. - Container for the request. - - The response from the PutBucketWebsite service method, as returned by S3. - REST API Reference for PutBucketWebsite Operation - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT operation requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - Amazon S3 has a limitation of 50 routing rules per website configuration. If you require - more than 50 routing rules, you can use object redirect. For more information, see - Configuring - an Object Redirect in the Amazon Simple Storage Service Developer Guide. - - - Container for the necessary parameters to execute the PutBucketWebsite service method. - - The response from the PutBucketWebsite service method, as returned by S3. - REST API Reference for PutBucketWebsite Operation - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT operation requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - Amazon S3 has a limitation of 50 routing rules per website configuration. If you require - more than 50 routing rules, you can use object redirect. For more information, see - Configuring - an Object Redirect in the Amazon Simple Storage Service Developer Guide. - - - The bucket name. - Container for the request. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketWebsite service method, as returned by S3. - REST API Reference for PutBucketWebsite Operation - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT operation requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - Amazon S3 has a limitation of 50 routing rules per website configuration. If you require - more than 50 routing rules, you can use object redirect. For more information, see - Configuring - an Object Redirect in the Amazon Simple Storage Service Developer Guide. - - - Container for the necessary parameters to execute the PutBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketWebsite service method, as returned by S3. - REST API Reference for PutBucketWebsite Operation - - - - - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - The name of the bucket for which to set the configuration. - A property of PutLifecycleConfigurationRequest used to execute the PutLifecycleConfiguration service method. - - The response from the PutLifecycleConfiguration service method, as returned by S3. - REST API Reference for PutLifecycleConfiguration Operation - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - Container for the necessary parameters to execute the PutLifecycleConfiguration service method. - - The response from the PutLifecycleConfiguration service method, as returned by S3. - REST API Reference for PutLifecycleConfiguration Operation - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - The name of the bucket for which to set the configuration. - A property of PutLifecycleConfigurationRequest used to execute the PutLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutLifecycleConfiguration service method, as returned by S3. - REST API Reference for PutLifecycleConfiguration Operation - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - Container for the necessary parameters to execute the PutLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutLifecycleConfiguration service method, as returned by S3. - REST API Reference for PutLifecycleConfiguration Operation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Configuration for accessing AmazonS3 service - - - Configuration for accessing Amazon S3 service - - - - - When true, requests will always use path style addressing. - - - - - Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. - To use this feature, the bucket name should be DNS compliant names and should not contain periods (.). - The following APIs are not supported and are sent to the regular region endpoint, even if this option is enabled: -
    -
  1. PutBucket
    2. -
  2. ListBuckets
    3. -
  3. DeleteBucket
    4. -
- - - This option cannot be used at the same time as UseDualstackEndpoint. - - - - - If set to true and the service package supports it the region identified in the arn for a resource - will be used when making the service request. - - - - - USEast1RegionalEndpointValue determines wheter or not - to send the us-east-1 s3 requests to the regional endpoint or to - the legacy global endpoint. - This flags takes precedence over the AWS_S3_US_EAST_1_REGIONAL_ENDPOINT - environment variable and the credential file. - - - - - This method contains custom initializations for the config object. - - - - - Given this client configuration, returns the service url - - The service url in the form of a string - - - - If the client is configured to hit us-east-1 with the S3UsEast1RegionalEndpointValue flag not set, - this method checks whether the environment variable is present or the credential file contains a valid value - - A Nullable of S3UsEast1RegionalEndpointValue representing the client configuration for the regional us-east-1 endpoint - - - - Validate that the config object is properly configured. - - - - - Checks the AWS_S3_US_EAST_1_REGIONAL_ENDPOINT environment variable for the presence of the s3 regional flag - - A nullable of S3UsEast1RegionalEndpointValue - - - - Checks the credential file for the presence of the s3 regional flag - - A nullable of S3UsEast1RegionalEndpointValue - - - - Default constructor - - - - - The constant used to lookup in the region hash the endpoint. - - - - - Gets the ServiceVersion property. - - - - - Gets the value of UserAgent property. - - - - - Base exception for S3 errors. - - - - - Construct an instance of AmazonS3Exception - - - - - - Construct an instance of AmazonS3Exception - - - - - - - Construct an instance of AmazonS3Exception - - - - - - Construct an instance of AmazonS3Exception - - - - - - - - - - Construct an instance of AmazonS3Exception - - - - - - - - - - - Construct an instance of AmazonS3Exception - - - - - - - - - - - - Construct an instance of AmazonS3Exception - - - - - - - - - - - - - A special token that helps AWS troubleshoot problems. - - - - - A special token that helps AWS troubleshoot S3 accelerate problems. - - - - - The entire response body for this exception, if available. - - - - - The region that the AmazonS3Exception relates to. - - - - - Gets the exception message. - - - - - Constructs a new instance of the AmazonS3Exception class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - Extensions methods added to Amazon.Arn type to help parse S3 specific resources from the ARN. - - - - - Attempt to parse the resource component of the ARN into access point resource name. - - An AWS ARN to parse - The access point resouce identifier found in the ARN. - True if the ARN contains an access point resource identifier. - - - - Attempt to parse the resource component of the ARN into bucket name. - - An AWS ARN to parse - The bucket name found in the ARN. - True if the ARN contains a bucket name. - - - - Custom pipeline handler to clean up streams in case of an exception. - - - - - Catch exceptions and clean up any open streams. - - - - - - Catch exceptions and clean up any open streams. - - - - - - - Custom pipeline handler to enable sig V4 for Get requests. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Custom pipeline handler to enable sig V4 for Get requests. - - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Calls the post invoke logic after calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls the and post invoke logic after calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Constructor for AmazonS3RetryPolicy. - - The IClientConfig object - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - - - a value if it can be determined, or null if the IO-bound calculations need to be done - - - - Return true if the request should be retried. Implements additional checks - specific to S3 on top of the checks in DefaultRetryPolicy. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Return true if the request should be retried. Implements additional checks - specific to S3 on top of the checks in DefaultRetryPolicy. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Constructor for AmazonS3StandardRetryPolicy. - - The IClientConfig object - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - - - a value if it can be determined, or null if the IO-bound calculations need to be done - - - - Return true if the request should be retried. Implements additional checks - specific to S3 on top of the checks in StandardRetryPolicy. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Return true if the request should be retried. Implements additional checks - specific to S3 on top of the checks in StandardRetryPolicy. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Constructor for AmazonS3AdaptiveRetryPolicy. - - The IClientConfig object - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - - - a value if it can be determined, or null if the IO-bound calculations need to be done - - - - Return true if the request should be retried. Implements additional checks - specific to S3 on top of the checks in AdaptiveRetryPolicy. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Return true if the request should be retried. Implements additional checks - specific to S3 on top of the checks in AdaptiveRetryPolicy. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Marker interface to identify AmazonS3EncryptionClient. - - - - - Service metadata for Amazon S3 service - - - - - Gets the value of the Service Id. - - - - - Gets the dictionary that gives mapping of renamed operations - - - - - The parameters to request an abort of a multipart upload. - - - After a multipart upload is aborted, no additional parts can be uploaded using that upload ID. - The storage consumed by any previously uploaded parts will be freed. However, if any part uploads - are currently in progress, those part uploads might or might not succeed. As a result, it might be - necessary to abort a given multipart upload multiple times in order to completely free all storage - consumed by all parts. - - - - - The bucket name to which the upload was taking place. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The key of the S3 object that was being uploaded. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - The upload id for the in-progress multipart upload that should be aborted. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the AbortMultipartUpload response metadata. - The AbortMultipartUpload operation has a void result type. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Bucket accelerate configuration. - - - - - The accelerate status of the bucket. - - - - - AccessControlTranslation class - - - - - The override value for the owner of the replica object. - - - - - Class for AnalyticsAndOperator - A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. - The operator must have at least two predicates, and an object must match all of the predicates - in order for the filter to apply. - - Note: The current implementation restricts the usage to atmost one AnalyticsPrefixPredicate - and any number of AnalyticsTagPredicates. - - - - Class for AnalyticsConfiguration - - - - - The identifier used to represent an analytics configuration. - - - - - The filter used to describe a set of objects for analyses. - A filter must have exactly one prefix, one tag, or one conjunction (AnalyticsAndOperator). - If no filter is provided, all objects will be considered in any analysis. - - - - - If present, it indicates that data related to access patterns will be collected - and made available to analyze the tradeoffs between different storage classes. - - - - - Class for AnalyticsExportDestination - - - - - A destination signifying output to an S3 bucket. - - - - - Filter class for Metrics. - - - - - Filter Predicate setup for specific filter types. - - - - - Filter Predicate abstract class for specific filter types to be derived from. - - - - - Abstract class that can be used over logical filter predicates,i.e. AND/OR. - - - - - Internal implementation of Metrics Predicate visitor interface. - - - - - Interface for implementing visitor pattern in Analytics Predicate Filter. - - - - - Interface for implementing visitor pattern in Inventory Predicate Filter. - - - - - Interface for implementing visitor pattern in Metrics Predicate Filter. - - - - - Defines the interface that is used to visit all the different - implementations of - - - - - Visit a - - - - - - Visit a - - - - - - Visit a - - - - - - Implementation of to marshall . - - - - - AbortIncompleteMultipartUpload Unmarshaller - - - - - Abort Multipart Upload Request Marshaller - - - - - Response Unmarshaller for AbortMultipartUpload operation - - - - - AnalyticsConfiguration Unmarshaller - - - - - AnalyticsExportDestinationUnmarshaller - - - - - AnalyticsFilter Unmarshaller - - - - - AnalyticsS3BucketDestination Unmarshaller - - - - - Bucket Unmarshaller - - - - - CommonPrefixesItem Unmarshaller - - - - - Complete Multipart Upload Request Marshaller - - - - - Response Unmarshaller for CompleteMultipartUpload operation - - - - - ContentsItem Unmarshaller - - - - - Copy Object Request Marshaller - - - - - Response Unmarshaller for CopyObject operation - - - - - Upload Part Copy Request Marshaller - - - - - Response Unmarshaller for CopyPart operation - - - - - CORSRule Unmarshaller - - - - - Response Unmarshaller for DefaultRetention Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Delete InventoryConfiguration Request Marshaller - - - - - Response Unmarshaller for DeleteAnalyticsConfiguration operation - - - - - Response Unmarshaller for DeleteCORSConfiguration operation - - - - - Delete InventoryConfiguration Request Marshaller - - - - - Response Unmarshaller for DeleteInventoryConfiguration operation - - - - - Delete Bucket MetricsConfiguration Request Marshaller - - - - - Response Unmarshaller for DeleteBucketMetricsConfiguration operation - - - - - Delete Bucket Policy Request Marshaller - - - - - Response Unmarshaller for DeleteBucketPolicy operation - - - - - Delete Bucket Request Marshaller - - - - - Response Unmarshaller for DeleteBucket operation - - - - - Delete Bucket Tagging Request Marshaller - - - - - Response Unmarshaller for DeleteBucketTagging operation - - - - - Delete Bucket Website Request Marshaller - - - - - Response Unmarshaller for DeleteBucketWebsite operation - - - - - Delete Bucket Cors Request Marshaller - - - - - DeletedObject Unmarshaller - - - - - Delete Bucket Lifecycle Request Marshaller - - - - - Response Unmarshaller for DeleteBucketLifecycle operation - - - - - Delete Object Request Marshaller - - - - - Response Unmarshaller for DeleteObject operation - - - - - Delete Objects Request Marshaller - - - - - Response Unmarshaller for DeleteObjects operation - - - - - DeleteObjectTaggingRequest Marshaller - - - - - Marshall DeleteObjectTaggingRequest object into an http request. - - - - - Marshall DeleteObjectTaggingRequest object into an http request. - - - - - Response Unmarshaller for DeleteObjectTagging operation - - - - - DeletePublicAccessBlock Request Marshaller - - - - - Response Unmarshaller for DeletePublicAccessBlock operation - - - - - ErrorsItem Unmarshaller - - - - - Expiration Unmarshaller - - - - - FilterRule Unmarshaller - - - - - Filter Unmarshaller - - - - - Get Object Acl Request Marshaller - - - - - Response Unmarshaller for GetACL operation - - - - - Get Object Accelerate Configuration Request Marshaller - - - - - Response Unmarshaller for GetACL operation - - - - - Get BucketAnalyticsConfiguration Request Marshaller - - - - - Response Unmarshaller for GetAnalyticsConfiguration operation - - - - - Get InventoryConfiguration Request Marshaller - - - - - Response Unmarshaller for GetInventoryConfiguration operation - - - - - Get Bucket Location Request Marshaller - - - - - Response Unmarshaller for GetBucketLocation operation - - - - - Get Bucket Logging Request Marshaller - - - - - Response Unmarshaller for GetBucketLogging operation - - - - - Get Bucket MetricsConfigurationRequest Marshaller - - - - - Response Unmarshaller for GetBucketMetricsConfiguration operation - - - - - Get Bucket Notification Request Marshaller - - - - - Response Unmarshaller for GetBucketNotification operation - - - - - Get BucketName Policy Request Marshaller - - - - - Response Unmarshaller for GetBucketPolicy operation - - - - - GetBucketPolicyStatusRequestMarshaller - - - - - Response Unmarshaller for GetBucketPolicyStatus operation - - - - - Get Bucket Request Payment Request Marshaller - - - - - Response Unmarshaller for GetBucketRequestPayment operation - - - - - Get Bucket Tagging Request Marshaller - - - - - Response Unmarshaller for GetBucketTagging operation - - - - - Get Bucket Versioning Request Marshaller - - - - - Response Unmarshaller for GetBucketVersioning operation - - - - - Get Bucket Website Request Marshaller - - - - - Response Unmarshaller for GetBucketWebsite operation - - - - - Get Bucket Cors Request Marshaller - - - - - Response Unmarshaller for GetCORSConfiguration operation - - - - - Get Bucket Lifecycle Request Marshaller - - - - - Response Unmarshaller for GetLifecycleConfiguration operation - - - - - GetObjectLegalHold Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for GetObjectLegalHold operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - GetObjectLockConfiguration Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for GetObjectLockConfiguration operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - GetObjectMetadata Marshaller - - - - - Response Unmarshaller for GetObjectMetadata operation - - - - - Get Object Request Marshaller - - - - - Response Unmarshaller for GetObject operation - - - - - GetObjectRetention Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for GetObjectRetention operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - GetObjectTaggingRequest Marshaller - - - - - Marshall GetObjectTaggingRequest into an http request. - - - - - Marshall GetObjectTaggingRequest into an http request. - - - - - Response Unmarshaller for GetObjectTagging operation - - - - - Get Object Torrent Request Marshaller - - - - - Response Unmarshaller for GetObjectTorrent operation - - - - - GetPublicAccessBlockRequestMarshaller - - - - - Response Unmarshaller for GetPublicAccessBlock operation - - - - - Grantee Unmarshaller - - - - - Grant Unmarshaller - - - - - Head Bucket Request Marshaller - - - - - Response Unmarshaller for HeadBucket operation - - - - - Create Multipart Upload Request Marshaller - - - - - Response Unmarshaller for InitiateMultipartUpload operation - - - - - Initiator Unmarshaller - - - - - InventoryConfiguration Unmarshaller - - - - - InventoryDestination Unmarshaller - - - - - InventoryEncryption Unmarshaller - - - - - InventoryFilter Unmarshaller - - - - - InventoryS3BucketDestination Unmarshaller - - - - - InventorySchedule Unmarshaller - - - - - LifecycleFilterPredicate Unmarshaller - - - - - LifecycleRuleNoncurrentVersionExpiration Unmarshaller - - - - - LifecycleRuleNoncurrentVersionTransition Unmarshaller - - - - - List AnalyticsConfiguration Request Marshaller - - - - - Response Unmarshaller for ListAnalyticsConfiguration operation - - - - - List InventoryConfiguration Request Marshaller - - - - - Response Unmarshaller for ListInventoryConfiguration operation - - - - - List Bucket MetricsConfigurationRequest Marshaller - - - - - Response Unmarshaller for ListBucketMetricsConfiguration operation - - - - - List Buckets Request Marshaller - - - - - Response Unmarshaller for ListBuckets operation - - - - - List Multipart Uploads Request Marshaller - - - - - Response Unmarshaller for ListMultipartUploads operation - - - - - List Objects Request Marshaller - - - - - Response Unmarshaller for ListObjects operation - - - - - List Objects Request Marshaller - - - - - Response Unmarshaller for ListObjects operation - - - - - List Parts Request Marshaller - - - - - Response Unmarshaller for ListParts operation - - - - - List Object Versions Request Marshaller - - - - - Response Unmarshaller for ListVersions operation - - - - - LoggingEnabled Unmarshaller - - - - - MetricsConfiguration Unmarshaller - - - - - MetricsFilte Unmarshaller - - - - - UploadsItem Unmarshaller - - - - - Response Unmarshaller for ObjectLockConfiguration Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Response Unmarshaller for ObjectLockLegalHold Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Response Unmarshaller for ObjectLockRetention Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Response Unmarshaller for ObjectLockRule Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Owner Unmarshaller - - - - - PartsItem Unmarshaller - - - - - PolicyStatus Unmarshaller - - - - - PublicAccessBlockConfiguration Unmarshaller - - - - - Put Object Acl Request Marshaller - - - - - Response Unmarshaller for PutObjectAcl operation - - - - - Put Object Acl Request Marshaller - - - - - Response Unmarshaller for PutBucketAccelerate operation - - - - - Request Marshaller for PutAnalyticsConfiguration operation - - - - - Response Unmarshaller for PutBucketAnalytics operation - - - - - Request Marshaller for PutInventoryConfiguration operation - - - - - Response Unmarshaller for PutBucketWebsite operation - - - - - Enable Bucket Logging Request Marshaller - - - - - Response Unmarshaller for PutBucketLogging operation - - - - - Put Bucket MetricsConfigurationRequest Marshaller - - - - - Response Unmarshaller for PutBucketMetricsConfiguration operation - - - - - Put Bucket Notification Request Marshaller - - - - - Response Unmarshaller for PutBucketNotification operation - - - - - Put Bucket Policy Request Marshaller - - - - - Response Unmarshaller for PutBucketPolicy operation - - - - - Put Buckeyt Replication Request Marshaller - - - - - Response Unmarshaller for PutBucketReplication operation. - - - - - Put Bucket Request Marshaller - - - - - Put Bucket Request Payment Request Marshaller - - - - - Response Unmarshaller for PutBucketRequestPayment operation - - - - - Response Unmarshaller for PutBucket operation - - - - - Put Bucket Tagging Request Marshaller - - - - - Response Unmarshaller for PutBucketTagging operation - - - - - Put Bucket Versioning Request Marshaller - - - - - Response Unmarshaller for PutBucketVersioning operation - - - - - Put Bucket Website Request Marshaller - - - - - Response Unmarshaller for PutBucketWebsite operation - - - - - Put Bucket Cors Request Marshaller - - - - - Response Unmarshaller for PutCORSConfiguration operation - - - - - Put Bucket Lifecycle Request Marshaller - - - - - Response Unmarshaller for PutLifecycleConfiguration operation - - - - - PutObjectLegalHold Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for PutObjectLegalHold operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - PutObjectLockConfiguration Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for PutObjectLockConfiguration operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Put Object Request Marshaller - - - - - Response Unmarshaller for PutObject operation - - - - - PutObjectRetention Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for PutObjectRetention operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Delete Object Tagging Request Marshaller - - - - - Marshall PutObjectTaggingRequest into an http request. - - - - - Marshall PutObjectTaggingRequest into an http request. - - - - - Response Unmarshaller for DeleteObjectTagging operation - - - - - PutPublicAccessBlock Request Marshaller - - - - - Response Unmarshaller for PutPublicAccessBlock operation - - - - - Restore Object Request Marshaller - - - - - Response Unmarshaller for RestoreObject operation - - - - - Condition Unmarshaller - - - - - Redirect Unmarshaller - - - - - RoutingRule Unmarshaller - - - - - RulesItem Unmarshaller - - - - - Response Unmarshaller for all Errors - - - - - Build an S3ErrorResponse from XML - - The XML parsing context. - Usually an Amazon.Runtime.Internal.UnmarshallerContext. - An S3ErrorResponse object. - - - - Grant Unmarshaller - - - - - Class for unmarshalling S3 service responses - - - - - Specialized S3 unmarshaller context. - - - - - Wrap an XmlTextReader with state for event-based parsing of an XML stream. - - Stream with the XML from a service response. - If set to true, maintains a copy of the complete response body as the stream is being read. - Response data coming back from the request - If set to is true, configure unmarshaller with exception specifics. - - - - Reads to the next node in the XML document, and updates the context accordingly. - If node is RequestId, reads the contents and stores in RequestId property. - - - True if a node was read, false if there are no more elements to read./ - - - - - SSEKMS Unmarshaller - - - - - StorageClassAnalysisDataExportDataExportUnmarshaller - - - - - StorageClassAnalysisUnmarshaller - - - - - Tag Unmarshaller - - - - - TopicConfiguration Unmarshaller - - - - - Transition Unmarshaller - - - - - Upload Part Request Marshaller - - - - - Response Unmarshaller for UploadPart operation - - - - - VersionsItem Unmarshaller - - - - - Internal implementation of Inventory Predicate visitor interface. - - - - - Internal implementation of Metrics Predicate visitor interface. - - - - - Class for AnalyticsPrefixPredicate - The prefix used when evaluating a metrics filter. - - - - - Class for AnalyticsS3BucketDestination - - - - - The file format used when exporting data to Amazon S3. - - - - - The account ID that owns the destination bucket. If no account ID is provided, the owner will not be validated prior to exporting data. - - - - - The Amazon resource name (ARN) of the bucket to which data is exported. - - - - - The prefix to use when exporting data. The exported data begins with this prefix. - - - - - Class for MetricsTagPredicate - The tag used when evaluating a metrics filter. - - - - - This class represents the byte range for a range GET from S3. - - - - - Constructs a ByteRange and sets the start and end. - - - - - - - Constructs a ByteRange and sets the header to the value specified. - - - - - - A private string, represending the byte range. - - - - - The starting byte number of the range - - - - - The ending byte number of the range - - - - - The formatted string representing the byte range to be set for the range header. - - - - - Container for the parameters to the CompleteMultipartUpload operation. - Completes a multipart upload by assembling previously uploaded parts. - - - - - The name of the bucketName containing the S3 object that was being uploaded in parts. - - - - - The key of the S3 object that was being uploaded. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - A collection of part numbers and corresponding etags. - - - - - Adds a collection of part numbers and corresponding etags. - - PartETags that will added to this request. - - - - Adds a collection of part numbers and corresponding etags. - - PartETags that will added to this request. - - - - Adds a collection of part numbers and corresponding etags by transforming the UploadPartResponses into PartETags. - - The list of response objects return from UploadParts. - - - - Adds a collection of part numbers and corresponding etags by transforming the UploadPartResponses into PartETags. - - The list of response objects return from UploadParts. - - - - Adds a collection of part numbers and corresponding etags by transforming the CopyPartResponse into PartETags. - - The list of response objects return from CopyParts. - - - - Adds a collection of part numbers and corresponding etags by transforming the CopyPartResponse into PartETags. - - The list of response objects return from CopyParts. - - - - The upload id for the in-progress multipart upload that should be completed. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the CompleteMultipartUpload response and response metadata. - - - - - Gets and sets the URI that identifies the newly created object. - - - - - Gets and sets the name of the bucketName that contains the newly created object. - - - - - Gets and sets the object key of the newly created object. - - - - - Gets and sets Entity tag that identifies the newly created object's data. Objects with different - object data will have different entity tags. The entity tag is an opaque string. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - Gets and sets the ServerSideEncryptionMethod property. - Specifies the encryption used on the server to - store the content. - Default is None. - - - - - Gets and sets the VersionId property. - This is the version-id of the S3 object - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the CopyObject operation. - Creates a copy of an object that is already stored in Amazon S3. - - - Container for the parameters to the CopyObject operation. - Creates a copy of an object that is already stored in Amazon S3. - - - - - The name of the bucket containing the object to copy. - - - - - Checks if SourceBucket property is set. - - true if SourceBucket property is set. - - - - The key of the object to copy. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Checks if SourceKey property is set. - - true if SourceKey property is set. - - - - Specifies a particular version of the source object to copy. By default the latest version is copied. - - - - - Checks if SourceVersionId property is set. - - true if SourceVersionId property is set. - - - - The name of the bucket to contain the copy of the source object. - - - - - Checks if DestinationBucket property is set. - - true if DestinationBucket property is set. - - - - The key to be given to the copy of the source object. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Checks if DestinationKey property is set. - - true if DestinationKey property is set. - - - - A canned access control list (CACL) to apply to the object. - Please refer to for - information on S3 Canned ACLs. - - - - - ETag to be matched as a pre-condition for copying the source object - otherwise returns a PreconditionFailed. - - - Copies the object if its entity tag (ETag) matches - the specified tag; otherwise return a 412 (precondition failed). - Constraints: This property can be used with IfUnmodifiedSince, - but cannot be used with other conditional copy properties. - - - - - Checks if ETagToMatch property is set. - - - Copies the object if its entity tag (ETag) is different - than the specified Etag; otherwise returns a 412 (failed condition). - Constraints: This header can be used with IfModifiedSince, but cannot - be used with other conditional copy properties. - - true if ETagToMatch property is set. - - - - ETag that must not be matched as a pre-condition for copying the source object, - otherwise returns a PreconditionFailed. - - - - - Checks if ETagToNotMatch property is set. - - true if ETagToNotMatch property is set. - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or - ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Copies the object if it has been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it has been modified since the - specified time; otherwise returns a 412 (failed condition). - Constraints: This property can be used with ETagToNotMatch, - but cannot be used with other conditional copy properties. - - - - - Copies the object if it has been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it has been modified since the - specified time; otherwise returns a 412 (failed condition). - Constraints: This property can be used with ETagToNotMatch, - but cannot be used with other conditional copy properties. - - - - - Checks if ModifiedSinceDateUtc property is set. - - true if ModifiedSinceDateUtc property is set. - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or - UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Copies the object if it has not been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it hasn't been modified since the - specified time; otherwise returns a 412 (precondition failed). - Constraints: This property can be used with ETagToMatch, - but cannot be used with other conditional copy properties. - - - - - Copies the object if it has not been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it hasn't been modified since the - specified time; otherwise returns a 412 (precondition failed). - Constraints: This property can be used with ETagToMatch, - but cannot be used with other conditional copy properties. - - - - - Checks if UnmodifiedSinceDateUtc property is set. - - true if UnmodifiedSinceDateUtc property is set. - - - - Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request. - - - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - Specifies whether you want to apply a Legal Hold to the copied object. - - - - - - Gets and sets the property ObjectLockMode. - - The Object Lock mode that you want to apply to the copied object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - The date and time when you want the copied object's Object Lock to expire. - - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - Checks if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - true if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - - - The type of storage to use for the object. Defaults to 'STANDARD'. - - - - - - If the bucketName is configured as a website, redirects requests for this object to another object in the same bucketName or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - This is a convenience property for Headers.ContentType. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - /// - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The customer provided encryption key for the source object of the copy. - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - true if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the CopySourceServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if CopySourceServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - The tag-set for the object destination object this value must be used in conjunction with the TaggingDirective. The tag-set must be encoded as URL Query parameters. - - - - - Checks if Tagging property is set - - true if Tagging is set. - - - - Overrides the default request timeout value. - - - - If the value is set, the value is assigned to the Timeout property of the HTTPWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Overrides the default ReadWriteTimeout value. - - - - If the value is set, the value is assigned to the ReadWriteTimeout property of the HTTPWebRequest/WebRequestHandler object used - to send requests. - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - - Returns information about the CopyObject response and response metadata. - - - - - Gets and sets the ETag property. - - - - - Gets and sets the LastModified property. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - Gets and sets the SourceVersionId property. - This is the Version Id of the Source Object - - - - - Version ID of the newly created copy. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the CopyPart operation. - Uploads a part by copying data from an existing object as data source. - - - Container for the parameters to the CopyPart operation. - Uploads a part by copying data from an existing object as data source. - - - - - The name of the bucket containing the object to copy. - - - - - Checks if SourceBucket property is set. - - true if SourceBucket property is set. - - - - The key of the object to copy. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Checks if SourceKey property is set. - - true if SourceKey property is set. - - - - Specifies a particular version of the source object to copy. By default the latest version is copied. - - - - - Checks if SourceVersionId property is set. - - true if SourceVersionId property is set. - - - - The name of the bucket to contain the copy of the source object. - - - - - Checks if DestinationBucket property is set. - - true if DestinationBucket property is set. - - - - The key to be given to the copy of the source object. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Checks if DestinationKey property is set. - - true if DestinationKey property is set. - - - - The ID identifying multipart upload for which we are copying a part. - - - - - Checks if UploadId property is set. - - true if UploadId property is set. - - - - Collection of ETags to be matched as a pre-condition for copying the source object - otherwise returns a PreconditionFailed. - - - Copies the object if its entity tag (ETag) matches one of - the specified tags; otherwise return a 412 (precondition failed). - Constraints: This property can be used with IfUnmodifiedSince, - but cannot be used with other conditional copy properties. - - - - - Checks if ETagsToMatch property is set. - - true if ETagToMatch property is set. - - - - Collection of ETags that must not be matched as a pre-condition for copying the source object - otherwise returns a PreconditionFailed. - - - Copies the object if its entity tag (ETag) does not match any of the specified - tags; otherwise returns a 412 (failed condition). - Constraints: This header can be used with IfModifiedSince, but cannot - be used with other conditional copy properties. - - - - - Checks if ETagToNotMatch property is set. - - true if ETagToNotMatch property is set. - - - - Copies the object if it has been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it has been modified since the - specified time; otherwise returns a 412 (failed condition). - Constraints: This property can be used with ETagToNotMatch, - but cannot be used with other conditional copy properties. - - - - - Checks if ModifiedSinceDate property is set. - - true if ModifiedSinceDate property is set. - - - - Copies the object if it has not been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it hasn't been modified since the - specified time; otherwise returns a 412 (precondition failed). - Constraints: This property can be used with ETagToMatch, - but cannot be used with other conditional copy properties. - - - - - Checks if UnmodifiedSinceDate property is set. - - true if UnmodifiedSinceDate property is set. - - - - The number of the part to be copied. - - - Valid part numbers are from 1 to 10,000 inclusive and will uniquely identify the part - and determine the relative ordering within the destination object. If a part already - exists with the PartNumber it will be overwritten. - - - - - Checks if PartNumber property is set. - - true if PartNumber property is set. - - - - The location of the first byte in the range if only a portion of the - source object is to be copied as the part. - - - The LastByte property must also be set or this value will be ignored. - - - - - Checks if FirstByte property is set. - - true if FirstByte property is set. - - - - The location of the last byte in the range if only a portion of the - source object is to be copied as the part. - - - The FirstByte property must also be set or this value will be ignored. - - - - - Checks if LastByte property is set. - - true if LastByte property is set. - - - - - This property is obsolete. Use ServerSideEncryptionMethod in InitiateMultipartUploadRequest instead. - - - Default: None - - - - - - Checks if ServerSideEncryptionMethod property is set. - - true if ServerSideEncryptionMethod property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - This property is obsolete. Use ServerSideEncryptionKeyManagementServiceKeyId in InitiateMultipartUploadRequest instead. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The customer provided encryption key for the source object of the copy. - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - true if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the CopySourceServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if CopySourceServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - - - Overrides the default request timeout value. - - - - If the value is set, the value is assigned to the Timeout property of the HTTPWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Overrides the default ReadWriteTimeout value. - - - - If the value is set, the value is assigned to the ReadWriteTimeout property of the HTTPWebRequest/WebRequestHandler object used - to send requests. - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - - Returns information about the CopyPart response and response metadata. - - - - - The version of the source object that was copied, if you have enabled versioning on the source bucketName. - - - - - - Entity tag of the object. - - - - - - Date and time at which the object was uploaded. - - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - Gets and sets the PartNumber property. - This is the part number in it's multi-part upload that will uniquely identify the part - and determine the relative ordering within the destination object. - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - A collection of up to 100 cross-origin resource sharing (CORS) rules. - - - - - The collection of rules in this configuration. - - - - C O R S Rule - - - - - Identifies HTTP methods that the domain/origin specified in the rule is allowed to execute. - - - - - - One or more origins you want customers to be able to access the bucket from. - - - - - - An optional unique identifier for the rule. - - - The ID value can be up to 255 characters long. The IDs help you find a rule in the configuration. - - - - - Checks if Id property is set. - - true if Id property is set. - - - - One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript - XMLHttpRequest object). - - - - - - The time in seconds that your browser is to cache the preflight response for the specified resource. - - - - - - Specifies which headers are allowed in a pre-flight OPTIONS request through the - Access-Control-Request-Headers header. - - - Each header name specified in the Access-Control-Request-Headers must have a corresponding - entry in the rule. Only the headers that were requested will be sent back. - This element can contain at most one * wildcard character. - - - - - Checks if AllowedHeaders property is set. - - true if AllowedHeaders property is set. - - - - Describes how a CSV-formatted input object is formatted. - - - - - Describes the first line of input. Valid values: None, Ignore, Use. - - - - - Single character used to indicate a row should be ignored when present at the start of a row. - - - - - Single character used for escaping the quote character inside an already escaped value. - - - - - Value used to separate individual records. - - - - - Value used to separate individual fields in a record. - - - - - Value used for escaping where the field delimiter is part of the value. - - - - - Specifies that CSV field values may contain quoted record delimiters and such records should be allowed. Default value is FALSE. Setting this value to TRUE may lower performance. - - - - - Describes how CSV-formatted results are formatted. - - - - - Indicates whether or not all output fields should be quoted. - - - - - Single character used for escaping the quote character inside an already escaped value. - - - - - Value used to separate individual records. - - - - - Value used to separate individual fields in a record. - - - - - Value used for escaping where the field delimiter is part of the value. - - - - - The container element for specifying the default Object Lock retention settings for - new objects placed in the specified bucket. - - - - - Gets and sets the property Days. - - The number of days that you want to specify for the default retention period. - - - - - - Gets and sets the property Mode. - - The default Object Lock retention mode you want to apply to new objects placed in - the specified bucket. - - - - - - Gets and sets the property Years. - - The number of years that you want to specify for the default retention period. - - - - - - Container for the parameters to the DeleteBucketAnalyticsConfiguration operation. - Deletes an analytics configuration for the bucket (specified by the analytics configuration ID). - - - - - The name of the bucket from which an analytics configuration is deleted. - - - - - The identifier used to represent an analytics configuration. - - - - - Returns information about the DeleteBucketAnalyticsConfiguration response metadata. - The DeleteBucketAnalyticsConfiguration operation has a void result type. - - - - - Request object for the DeleteBucketEncryption operation. - Request Deletes the server-side encryption configuration from the bucket. - - - - - The name of the bucket containing the server-side encryption configuration to delete. - - - - - Returns information about the DeleteBucketEncryption response metadata. - The DeleteBucketEncryption operation has a void result type. - - - - - Container for the parameters to the DeleteInventoryConfiguration operation. - Deletes an inventory configuration (identified by the inventory ID) from the bucket. - - - - - The name of the bucket containing the inventory configuration to delete. - - - - - The ID used to identify the inventory configuration. - - - - - Returns information about the DeleteInventoryConfiguration response metadata. - The DeleteInventoryConfiguration operation has a void result type. - - - - - Container for the parameters to the DeleteBucketMetricsConfiguration operation. - Deletes a metrics configuration (specified by the metrics configuration ID) from the bucket. - - - - - The name of the bucket on which Inventory configuration is to be removed. - - - - - The ID used to identify the metrics configuration. - - - - - Returns information about the DeleteBucketMetricsConfiguration response metadata. - The DeleteBucketMetricsConfiguration operation has a void result type. - - - - - Container for the parameters to the DeleteBucketPolicy operation. - Deletes the policy from the bucket. - - - - - The bucket on which the policy is to be deleted. - - - - - Returns information about the DeleteBucketPolicy response metadata. - The DeleteBucketPolicy operation has a void result type. - - - - - Request object for the DeleteBucketReplication operation. - - - - - Gets and sets the property BucketName. -

Deletes the replication subresource associated with the specified - bucket.

There is usually some time lag before - replication configuration deletion is fully propagated to all the - Amazon S3 systems.

For more information, see - - Cross-Region Replication (CRR) in the Amazon S3 Developer - Guide.

- - - - - Returns information about the DeleteBucketReplication response metadata. - The DeleteBucketReplication operation has a void result type. - - - - - Container for the parameters to the DeleteBucket operation. - Deletes the bucket. All objects (including all object versions and Delete Markers) in the bucket must be deleted before the bucket - itself can be deleted. - - - - - The name of the bucket to be created. - - - - - The region locality for the bucket. - - - When set, this will determine the region the bucket exists in. - Refer - for a list of possible values. - - - - - If set to true the bucket will be deleted in the same region as the configuration of the AmazonS3 client. - DeleteBucketRequest.BucketRegion takes precedence over this property if both are set. - Default: true. - - - - - Returns information about the DeleteBucket response metadata. - The DeleteBucket operation has a void result type. - - - - - The parameters to request deletion of a tag set from a bucket. - - - To use this operation, you must have permission to perform the s3:PutBucketTagging action. - By default, the bucket owner has this permission and can grant this permission to others. - - - - - The name of the bucket on which the tag set is to be removed. - - - - - Returns information about the DeleteBucketTagging response metadata. - The DeleteBucketTagging operation has a void result type. - - - - - Container for the parameters to the DeleteBucketWebsite operation. - This operation removes the website configuration from the bucket. - - - - - The name of the bucket on which website configuration is to be removed. - - - - - Returns information about the DeleteBucketWebsite response metadata. - The DeleteBucketWebsite operation has a void result type. - - - - - Container for the parameters to the DeleteCORSConfiguration operation. - Deletes the cors configuration information set for the bucket. - - - - - Gets and sets the BucketName property. - - - - - Returns information about the DeleteCORSConfiguration response metadata. - The DeleteCORSConfiguration operation has a void result type. - - - - - Contains information about a successful delete operation against a specific S3 object. - - - - - Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a - delete marker. In a simple DELETE, this header indicates whether (true) or not (false) a delete - marker was created. - - - - - The version ID of the delete marker created as a result of the DELETE operation. If you delete a - specific object version, the value returned by this header is the version ID of the object version - deleted. - - - - - The key of the deleted S3 object. - - - - - The version of the deleted S3 object. - - - - - Contains information about a failed delete operation against a specific S3 object. - - - - - The key of the S3 object. - - - - - The version of the S3 object. - - - - - The failure code for the delete error. - - - - - The failure message for the delete error. - - - - - The parameters to request deletion of the lifecycle configuration on a bucket. - - - - Amazon S3 removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. - Your objects never expire, and Amazon S3 no longer automatically deletes any objects on the basis of rules contained - in the deleted lifecycle configuration. - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration action. By default, the - bucket owner has this permission and the bucket owner can grant this permission to others. - - - There is usually some time lag before lifecycle configuration deletion is fully propagated to all the Amazon S3 systems. - - - - - - The name of the bucket on which the lifecycle configuration is to be deleted. - - - - - Returns information about the DeleteLifecycleConfiguration response metadata. - The DeleteLifecycleConfiguration operation has a void result type. - - - - -

Specifies whether Amazon S3 should replicate delete makers.

- - - - - Gets and sets the property Status. -

The status of the delete marker replication.

-

In the current implementation, Amazon S3 does not replicate - the delete markers. Therefore, the status must be - Disabled.

- - - - - The parameters to request deletion of an object in a bucket. - The operation removes the null version (if there is one) of an object and inserts a delete marker, which - becomes the latest version of the object. - - - - To remove a specific version, you must be the bucket owner and you must use the versionId subresource. - Using this subresource permanently deletes the version. - - - If the object you want to delete is in a bucket where the bucket versioning configuration is MFA Delete enabled, - you must include specify the MFA serial number and value in the request. - - - If there isn't a null version, Amazon S3 does not remove any objects. - - - - - - The bucket name of the bucket containing the object. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property BypassGovernanceRetention. - - - - - The key identifying the object to delete. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - The identifier for the specific version of the object to be deleted, if required. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - The MfaCodes Tuple associates the Serial Number and the current Token/Code displayed on the - Multi-Factor Authentication device associated with your AWS Account. - - - This is a required property for this request if:
- 1. EnableMfaDelete was configured on the bucket - containing this object's version.
- 2. You are deleting an object's version - - - - - Checks if the MfaCodes property is set. - - true if the MfaCodes property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the DeleteObject response and response metadata. - - - - - Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a delete marker. - - - - - - Returns the version ID of the delete marker created as a result of the DELETE operation. - - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the DeleteObjects operation. - This operation enables you to delete multiple objects from a bucket using a single HTTP request. You may specify up to 1000 - keys. - - - Container for the parameters to the DeleteObjects operation. - This operation enables you to delete multiple objects from a bucket using a single HTTP request. You may specify up to 1000 - keys. - - - - - The bucket name containing the objects to delete. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property BypassGovernanceRetention. - - Specifies whether you want to delete this object even if it has a Governance-type - Object Lock in place. You must have sufficient permissions to perform this operation. - - - - - - List of object keys to delete. - - - - - Toggles between Quiet and Verbose mode for the operation. - If set to true (Quiet mode), the response includes only those keys for objects on which - the delete operation failed. - - - By default this property is false and keys for both successful deletes - and failures are returned in the response. - - - - - The MfaCodes Tuple associates the Serial Number and the current Token/Code displayed on the - Multi-Factor Authentication device associated with your AWS Account. - - - This is a required property for this request if:
- 1. EnableMfaDelete was configured on the bucket - containing this object's version.
- 2. You are deleting an object's version - - - - - Checks if the MfaCodes property is set. - - true if the MfaCodes property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Add a key to the set of keys of objects to be deleted. - - Object key - - - - Add a key and a version to be deleted. - - Key of the object to be deleted. - Version of the object to be deleted. - - - - Add a KeyVersion object representing the S3 object to be deleted. - - KeyVersion representation of object to be deleted. - - - - Returns information about the DeleteObjects response and response metadata. - - - - - A default constructor for DeleteObjectsResponse - - - - - Gets and sets the DeletedObjects property. - A list of successful deletes. - Set only when Quiet=false on DeleteObjectsRequest. - - - - - Gets and sets the DeleteErrors property. - A list of errors encountered while deleting objects. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Sets the with information about DeleteObjectsResponse - - The that holds the serialized object data. - The that contains contextual information about the source or destination. - - - - Sets the with information about the DeleteObjectsResponse. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - - - - Container for the parameters to the DeleteObjectTaggingRequest operation. - - - - - The bucket name containing the objects from which to remove the tags. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Check to see if Bucket property is set - - - - - The key identifying the object tagging to delete. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Check to see if Key property is set - - - - - The identifier for the specific version of the object to be deleted, if required. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - Returns information about the DeleteObjectTagging response and response metadata. - - - - - Returns the version ID of the delete marker created as a result of the DELETE operation. - - - - - Check to see if VersionId property is set - - - - - Container for the parameters to the DeletePublicAccessBlock operation. - Removes the Public Access Block configuration for an Amazon S3 bucket. - - - - - Gets and sets the property BucketName. - - The Amazon S3 bucket whose Public Access Block configuration you want to delete. - - - - - - This is the response object from the DeletePublicAccessBlock operation. - - - - - EncryptionConfiguration class - - - - - The ID of the AWS KMS key for the region where the destination bucket - resides. Amazon S3 uses this key to encrypt the replica object. - - - - - The Continuation Event. - - - - - Constructs a Continuation Event. - - - - - Constructs a Continuation Event. - - - - - - The End Event. - - - - - Constructs an End Event. - - - - - Constructs an End Event. - - - - - - Common Contract for S3 Events. - - - - - The Progress event details. - - - - - Current number of object bytes scanned. - - - - - Current number of uncompressed object bytes processed. - - - - - Total number of bytes of records payload data returned. - - - - - Constructs a instance of Progress. - - - - - The Progress Event. - - - - - The Progress event details. - - - - - Constructs a ProgressEvent. - - - - - Constructs a ProgressEvent. - - - - - - The Records Event - - - - - The byte array of partial, one or more result records. - - Payload is a , which is not thread-safe. - - - - - Constructs a RecordsEvent - - - - - Creates a new End Event. - - - - - - Modeled Exception that either comes over the stream from the service model, or wraps other exceptions for the purpose of raising events. If it is - modelled, it will be a subclass. - - - - - Creates a new S3EventStreamException - - - - - Creates a new S3EventStreamException - - - - - - Creates a new S3EventStreamException - - - - - - - Constructs a new instance of the S3EventStreamException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - The contract for the SelectObjectContentEventStream. - - - - - Event that encompasses all IS3Events. - - - - - Event that encompasses S3EventStreamExceptions. - - - - - Reaised when a Records event is received. - - - - - Reaised when a Stats event is received. - - - - - Reaised when a Progress event is received. - - - - - Reaised when a Continuation event is received. - - - - - Reaised when an End event is received. - - - - - A Stream of Events returned by the SelectObjectContent operation. Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treaded as mutually exclusive. - - - - - The mapping of event message to a generator function to construct the matching Event Stream event. - - - - - The mapping of event message to a generator function to construct the matching Event Stream exception. - - - - - Whether the backround processing loop is running. - - - - - Event that encompasses all IS3Events. - - - - - Event that encompasses S3EventStreamExceptions. - - - - - Reaised when a Records event is received. - - - - - Reaised when a Stats event is received. - - - - - Reaised when a Progress event is received. - - - - - Reaised when a Continuation event is received. - - - - - Reaised when an End event is received. - - - - - Event Stream returned by SelectObjectContentStream. - - Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treated as mutually exclusive. - - The network stream which events will be parsed from. - - - - Event Stream returned by SelectObjectContentStream. - - Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treaded as mutually exclusive. - - The network stream which events will be parsed from. - The decoder responsible for parsing events. - - - - The Stats event details. - - - - - Total number of object bytes scanned. - - - - - Total number of uncompressed object bytes processed. - - - - - Total number of bytes of records payload data returned. - - - - - Constructs an instance of Stats. - - - - - The Stats Event. - - - - - The Stats event details. - - - - - Constructs a StatsEvent - - - - - Constructs a ProgressEvent. - - - - - - This Event is returned if an event is retrieved from the event stream, but a generator function - for the event is not defined. - - - - - Constructs an UnknownEventStreamEvent. - - - - - Constructs an UnknownEventStreamEvent. - - The Message recieved from the event stream before conversion. - - - - Constructs an UnknownEventStreamEvent. - - The Message recieved from the event stream before conversion. - The event type. - - - - A container that specifies information about existing object replication. You can choose whether to enable or disable the replication of existing objects. - - - - - Specifies whether existing object replication is enabled. - - - - - Defines the expiration policy for a given object. - - - - - This property is deprecated. This property exposes a DateTime of kind Unspecified. Use ExpiryDateUtc instead. - The date and time for expiry. - - - - - The date and time for expiry. - - - - - Id of the configuration rule for this expiry. - - - - - Constructs an empty instance of an Expiration object - - - - Bucket - Represents a set of filter criteria that limits the objects that can trigger event notifications - - - - - Filter criteria that limits the objects that can trigger event notifications based on their S3 Key name. - - - - - Bucket - Represents a Filter Rule for a NotificationConfiguration. - - - - - Constructs an empty FilterRule. - - - - - Constructs a FilterRule with a specific name and value. - - - - - - - The name of the filter rule. - - - - - The value of the filter rule. - - - - - Container for the parameters to the GetACL operation. - Returns the access control list (ACL) of an object. - - - - - The bucket name that contains the object for which to get the ACL information. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The key of the S3 object to be queried. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - VersionId used to reference a specific version of the object. - - - - - Returns information about the GetACL response and response metadata. - - - - - Gets and sets the AccessControlList property. - - - - - Container for the parameters to the GetBucketAccelerateConfiguration operation. - - - - - The name of the bucket. - - - - - The response class for GetBucketAccelerateConfiguration operation. - - - - - The accelerate status of the bucket. - - - - - Container for the parameters to the GetBucketAnalyticsConfiguration operation. - Gets an analytics configuration for the bucket (specified by the analytics configuration ID). - - - - - The name of the bucket from which an analytics configuration is retrieved. - - - - - The identifier used to represent an analytics configuration. - - - - - GetBucketAnalyticsConfigurationResponse Response - - - - - The configuration and any analyses for the analytics filter. - - - - - Container for the parameters to the GetBucketEncryptionRequest operation. - Returns the server-side encryption configuration of a bucket. - - - - - The name of the bucket. - - - - - GetBucketEncryptionResponse Response - - - - - Container for server-side encryption configuration rules. Currently S3 supports one rule only. - - - - - Container for the parameters to the GetInventoryConfigurationRequest operation. - Returns an inventory configuration (identified by the inventory ID) from the bucket. - - - - - The name of the bucket containing the inventory configuration to retrieve. - - - - - The ID used to identify the inventory configuration. - - - - - GetInventoryConfigurationResponse Response - - - - - Specifies the inventory configuration. - - - - - Container for the parameters to the GetBucketLocation operation. - Returns the region the bucket resides in. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetBucketLocation response and response metadata. - - - - - Gets and sets the Location property. - If the the bucket is located in us-east-1 S3Region.US will be return which has a - value of empty string. - - - - - Container for the parameters to the GetBucketLogging operation. - Returns the logging status of a bucket and the permissions users have to view and modify that status. To use GET, you must be the - bucket owner. - - - - - The name of the bucket to query. - - - - - Returns information about the GetBucketLogging response and response metadata. - - - - - Gets and sets the LoggingConfig property. - - - - - Container for the parameters to the GetBucketMetricsConfiguration operation. - Gets a metrics configuration (specified by the metrics configuration ID) from the bucket. - - - - - The name of the bucket containing the metrics configuration to retrieve. - - - - - The ID used to identify the metrics configuration. - - - - - GetBucketMetricsConfiguration Response - - - - - Specifies the metrics configuration. - - - - - Container for the parameters to the GetBucketNotification operation. - Return the notification configuration of a bucket. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetBucketNotification response and response metadata. - - - - - Gets and sets the TopicConfigurations property. TopicConfigurations are configuration - for Amazon S3 events to be sent to Amazon SNS topics. - - - - - Gets and sets the QueueConfigurations property. QueueConfigurations are configuration - for Amazon S3 events to be sent to Amazon SQS queues. - - - - - Gets and sets the LambdaFunctionConfigurations property. LambdaFunctionConfigurations are configuration - for Amazon S3 events to be sent to an Amazon Lambda cloud function. - - - - - Container for the parameters to the GetBucketPolicy operation. - Returns the policy of a specified bucket. - - - - - The name of the bucket. - - - - - Get BucketName Policy Response - - - - - The bucket policy as a JSON document. - - - - - Container for the parameters to the GetBucketPolicyStatus operation. - Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket - is public. - - - - - Gets and sets the property BucketName. - - The name of the Amazon S3 bucket whose public-policy status you want to retrieve. - - - - - - This is the response object from the GetBucketPolicyStatus operation. - - - - - The public-policy status for this bucket. - - - - - Container for the parameters to the GetBucketReplicationConfiguration operation. - Returns the replication configuration information set on the bucket. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetReplicationConfiguration response and response metadata. - - - - - The replication configuration for the buccket specified in the request. - - - - - Container for the parameters to the GetBucketRequestPayment operation. - Returns the request payment configuration of a bucket. - - - - - The name of the bucket. - - - - - Returns information about the GetBucketRequestPayment response and response metadata. - - - - - Specifies who pays for the download and request fees. - - - - - - Container for the parameters to the GetBucketTagging operation. - Returns the tag set associated with the bucket. - - - - - The name of the bucket to be queried. - - - - - Returns information about the GetBucketTagging response and response metadata. - - - - - The collection of tags. - - - - - Container for the parameters to the GetBucketVersioning operation. - Returns the versioning state of a bucket. - - - - - The name of the bucket to be queried. - - - - - Returns information about the GetBucketVersioning response and response metadata. - - - - - Gets and sets the Versioning property. - Unless Versioning has been explicitly "Enabled" on a bucket, - Versioning Status is "Off". Once Versioning has been - "Enabled", it can be "Suspended" but cannot be switched "Off". - - - - - Container for the parameters to the GetBucketWebsite operation. - Returns the website configuration for a bucket. - - - - - The name of the bucket to be queried. - - - - - Returns information about the GetBucketWebsite response and response metadata. - - - - - Gets and sets the WebsiteConfiguration property. - - This is where the index document suffix and custom error page are defined. - - - - - Container for the parameters to the GetBucketCors operation. - Returns the cors configuration for the bucket. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetBucketCors response and response metadata. - - - - - The current CORSConfiguration for the bucket. - - - - - Container for the parameters to the GetLifecycleConfiguration operation. - Returns the lifecycle configuration information set on the bucket. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetLifecycleConfiguration response and response metadata. - - - - - Gets and Sets the property that governs whether - the response includes successful deletes as well as errors - following the DeleteObjects call against S3. - - By default this property is false and successful deletes - are returned in the response. - - - - - Container for the parameters to the GetObjectLegalHold operation. - Gets an object's current Legal Hold status. - - - - - The bucket name containing the object whose Legal Hold status you want to retrieve. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property Key. - - The key name for the object whose Legal Hold status you want to retrieve. - - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property VersionId. - - The version ID of the object whose Legal Hold status you want to retrieve. - - - - - - This is the response object from the GetObjectLegalHold operation. - - - - - Gets and sets the property LegalHold. - - The current Legal Hold status for the specified object. - - - - - - Container for the parameters to the GetObjectLockConfiguration operation. - Gets the Object Lock configuration for a bucket. The rule specified in the Object - Lock configuration will be applied by default to every new object placed in the specified - bucket. - - - - - Gets and sets the property BucketName. - - The bucket whose Object Lock configuration you want to retrieve. - - - - - - This is the response object from the GetObjectLockConfiguration operation. - - - - - Gets and sets the property ObjectLockConfiguration. - - The specified bucket's Object Lock configuration. - - - - - - Container for the parameters to the HeadObject operation. - The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you''re only - interested in an object''s metadata. To use HEAD, you must have READ access to the object. - - - - - The name of the bucket that contains the object. - - - - - ETag to be matched as a pre-condition for returning the object, - otherwise a PreconditionFailed signal is returned. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or - ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Returns the object only if it has been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Returns the object only if it has been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - ETag that should not be matched as a pre-condition for returning the object, - otherwise a PreconditionFailed signal is returned. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or - UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Returns the object only if it has not been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Returns the object only if it has not been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - The key of the object. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - VersionId used to reference a specific version of the object. - - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to decrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - Part number of the object being read. This is a positive integer between 1 and 10,000. - Effectively performs a 'ranged' HEAD request for the part specified. - Useful querying about the size of the part and the number of parts in this object. - - - - - Check if PartNumber property is set. - - true if PartNumber property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the HeadObject response and response metadata. - - - - - Flag which returns true if the Expires property has been unmarshalled - from the raw value or set by user code. - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the - response. - - - - - - Gets and sets the AcceptRanges. - - - - - Gets and sets the ContentRange. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - Gets and sets the RestoreExpiration property. - RestoreExpiration will be set for objects that have been restored from Amazon Glacier. - It indiciates for those objects how long the restored object will exist. - - - - - Gets and sets the RestoreInProgress - Will be true when the object is in the process of being restored from Amazon Glacier. - - - - - Last modified date of the object - - - - - - An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL - - - - - - This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like - SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal - HTTP headers. - - - - - - Version of the object. - - - - - - The date and time at which the object is no longer cacheable. - - - - - - If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The status of the replication job associated with this source object. - - - - - Checks if ReplicationStatus property is set. - - true if ReplicationStatus property is set. - - - - The count of parts this object has. - - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - The Legal Hold status for the specified object. - - - - - - Gets and sets the property ObjectLockMode. - - The Object Lock mode currently in place for this object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - The date and time when this object's Object Lock will expire. - - - - - - The class of storage used to store the object. - - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the GetObject operation. - Retrieves objects from Amazon S3. - - - - - The bucket name containing the object. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - ETag to be matched as a pre-condition for returning the object, - otherwise a PreconditionFailed signal is returned. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or - ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Returns the object only if it has been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Returns the object only if it has been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - ETag that should not be matched as a pre-condition for returning the object, - otherwise a PreconditionFailed signal is returned. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or - UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Returns the object only if it has not been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Returns the object only if it has not been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Gets and sets the Key property. This is the user defined key that identifies the object in the bucket. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Downloads the specified range bytes of an object. - - - - - A set of response headers that should be returned with the object. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ResponseExpiresUtc instead. Setting either ResponseExpires or - ResponseExpiresUtc results in both ResponseExpires and ResponseExpiresUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ResponseExpires is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Sets the Expires header of the response. - - - - - Sets the Expires header of the response. - - - - - VersionId used to reference a specific version of the object. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to decrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - Part number of the object being read. This is a positive integer between 1 and 10,000. - Effectively performs a 'ranged' GET request for the part specified. Useful for downloading just a part of an object. - - - - - Checks if PartNumber property is set. - - true if PartNumber property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the GetObject response and response metadata. - - - - - Flag which returns true if the Expires property has been unmarshalled - from the raw value or set by user code. - - - - - Gets and sets the BucketName property. - - - - - Gets and sets the Key property. - - - - - Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the - response. - - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - Gets and sets the AcceptRanges. - - - - - Gets and sets the ContentRange. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - Gets and sets the RestoreExpiration property. - RestoreExpiration will be set for objects that have been restored from Amazon Glacier. - It indiciates for those objects how long the restored object will exist. - - - - - Gets and sets the RestoreInProgress - Will be true when the object is in the process of being restored from Amazon Glacier. - - - - - Last modified date of the object - - - - - - An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL - - - - - - This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like - SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal - HTTP headers. - - - - - - Version of the object. - - - - - - The date and time at which the object is no longer cacheable. - - - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - - - - Gets and sets the property ObjectLockMode. - - The Object Lock mode currently in place for this object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - The date and time when this object's Object Lock will expire. - - - - - - If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The class of storage used to store the object. - - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The status of the replication job associated with this source object. - - - - - Checks if ReplicationStatus property is set. - - true if ReplicationStatus property is set. - - - - The number of parts this oject has. - - - - - Checks if PartsCount is set. - - true if PartsCount property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - The number of tags, if any, on the object. - - - - - Writes the content of the ResponseStream a file indicated by the filePath argument. - - The location where to write the ResponseStream - - - - Writes the content of the ResponseStream a file indicated by the filePath argument. - - The location where to write the ResponseStream - Whether or not to append to the file if it exists - - - - The event for Write Object progress notifications. All - subscribers will be notified when a new progress - event is raised. - - - Subscribe to this event if you want to receive - put object progress notifications. Here is how:
- 1. Define a method with a signature similar to this one: - - private void displayProgress(object sender, WriteObjectProgressArgs args) - { - Console.WriteLine(args); - } - - 2. Add this method to the Put Object Progress Event delegate's invocation list - - GetObjectResponse response = s3Client.GetObject(request); - response.WriteObjectProgressEvent += displayProgress; - - - - - - This method is called by a producer of write object progress - notifications. When called, all the subscribers in the - invocation list will be called sequentially. - - The file being written. - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - True if transfer is complete - - - - Writes the content of the ResponseStream a file indicated by the filePath argument. - - The location where to write the ResponseStream - Whether or not to append to the file if it exists - Cancellation token which can be used to cancel this operation. - - - - Encapsulates the information needed to provide - download progress for the Write Object Event. - - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The bucket name for the S3 object being written. - The object key for the S3 object being written. - The version-id of the S3 object. - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - True if finished writing - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The bucket name for the S3 object being written. - The object key for the S3 object being written. - The file for the S3 object being written. - The version-id of the S3 object. - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - True if finished writing - - - - Gets the bucket name for the S3 object being written. - - - - - Gets the object key for the S3 object being written. - - - - - Gets the version-id of the S3 object. - - - - - The file for the S3 object being written. - - - - - True if writing is complete - - - - - Container for the parameters to the GetObjectRetention operation. - Retrieves an object's retention settings. - - - - - The bucket name containing the object whose retention settings you want to retrieve. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property Key. - - The key name for the object whose retention settings you want to retrieve. - - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property VersionId. - - The version ID for the object whose retention settings you want to retrieve. - - - - - - This is the response object from the GetObjectRetention operation. - - - - - Gets and sets the property Retention. - - The container element for an object's retention settings. - - - - - - Container for the parameters to the GetObjectTaggingRequest operation. - - - - - The bucket name containing the object for which to get the tagging information. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Check to see if Bucket property is set - - - - - Gets and sets the Key property. This is the user defined key that identifies the object in the bucket. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Check to see if Key property is set - - - - - VersionId used to reference a specific version of the object. - - - - - - Returns information about the GetObjectTagging response and response metadata. - - - - - Gets or sets tag-set for a given object - - - - - Container for the parameters to the GetObjectTorrent operation. - Return torrent files from a bucket. - - - - - The name of the bucket containing the object. - - - - - The key identifying the object. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the GetObjectTorrent response and response metadata. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - The parameters to create a pre-signed URL to a bucket or object. - - - For more information, refer to: . -
Required Parameters: BucketName, Expires -
Optional Parameters: Key, VersionId, Verb: default is GET - - - - - The name of the bucket to create a pre-signed url to, or containing the object. - - - - - Checks if BucketName property is set. - - true if BucketName property is set. - - - - The key to the object for which a pre-signed url should be created. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Checks if Key property is set. - - true if Key property is set. - - - - A standard MIME type describing the format of the object data. - - - - The content type for the content being uploaded. This property defaults to "binary/octet-stream". - For more information, refer to: . - - - Note that if content type is specified, it should also be included in the HttpRequest headers - of the eventual upload request, otherwise a signature error may result. - - - - - - The expiry date and time for the pre-signed url. - - - - - Checks if Expires property is set. - - true if Expires property is set. - - - - The requested protocol (http/https) for the pre-signed url. - - - Defaults to https. - - - - - The verb for the pre-signed url. - - - Accepted verbs are GET, PUT, DELETE and HEAD. - Default is GET. - - - - - Version id for the object that the pre-signed url will reference. If not set, - the url will reference the latest version of the object. - - - This is the VersionId for the S3 Object you want to get - a PreSigned URL for. The VersionId property will be ignored - for PreSigned "PUT" requests and for requests that don't specify - the Key property. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - The upload id for the multipart upload for which a pre-signed url should be created. - - - - - Checks if UploadId property is set. - - true if UploadId property is set. - - - - The part number for the multipart upload for which a pre-signed url should be created. - - - - - Checks if PartNumber property is set. - - true if PartNumber property is set. - - - - Specifies the encryption used on the server to store the content. - - - - Default is None. - - - If specifying encryption (not None), the corresponding request must include header - "x-amz-server-side-encryption" with the value of the encryption. - - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - Confirms that the requester knows that she or he will be charged for the request. - Bucket owners need not specify this parameter in their requests. - - - - - A set of response headers that should be returned with the pre-signed url creation response. - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - Custom parameters to include in the signed request, so that they are tamper-proof. - - - - - The parameters for a pre-signed URL to a bucket or object as a string. - - - For more information, refer to: . - - - - - The PreSignedURL as a string - - - - - Constructor - - A url returned from GetPreSignedUrlRequest - - - - Container for the parameters to the GetPublicAccessBlock operation. - Retrieves the Public Access Block configuration for an Amazon S3 bucket. - - - - - Gets and sets the property BucketName. - - The name of the Amazon S3 bucket whose Public Access Block configuration you want - to retrieve. - - - - - - This is the response object from the GetPublicAccessBlock operation. - - - - - The Public Access Block configuration currently in effect for this Amazon S3 bucket. - - - - - Container for the parameters to the HeadBucket operation. - This operation is useful to determine if a bucket exists and you have permission to access it. - - - - - Returns information about the HeadBucket response metadata. - The HeadBucket operation has a void result type. - - - - - This class contains the headers for an S3 object. - - - - - Gets and sets headers to set for the object. - - The name of the header - The value for the header - - - - Gets the count of headers. - - - - - Gets the names of the headers set. - - - - - Specifies caching behavior along the request/reply chain. - - - - - - Specifies presentational information for the object. - - - - - - Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type - referenced by the Content-Type header field. - - - - - - The size of the object, in bytes. - - - - - The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. This - header can be used as a message integrity check to verify that the data is the same data that was originally sent. - - - - - A standard MIME type describing the format of the object data. - - - - - - The date and time at which the object is no longer cacheable. - - - - - - - Container for the parameters to the InitiateMultipartUpload operation. - Initiates a multipart upload and returns an upload ID. - - - - - Envelope Key to Encrypt data - - - - - Encrypted Envelope Key to Encrypt data - - - - - Initialization Vector for encryption - - - - - Storage mode for encryption information. - - - - - A canned access control list (ACL) to apply to the object. - Please refer to for information on S3 Canned ACLs. - - - - - The name of the bucketName where the new object will be created, or existing object updated. - - - - - The key of the object to create or update. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - StorageClass property for the object. - - - Default: S3StorageClass.Standard. Set this property - only if you want reduced redundancy for this object. - Please refer to - for - information on S3 Storage Classes. - - - - - If the bucketName is configured as a website, redirects requests for this object to another object in the same bucketName or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - This is a convenience property for Headers.ContentType. - - - - - - Specifies the encryption to be used on the server for the new object. - - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - Checks if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - true if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - Specifies whether you want to apply a Legal Hold to the uploaded object. - - - - - - Gets and sets the property ObjectLockMode. - - Specifies the Object Lock mode that you want to apply to the uploaded object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - Specifies the date and time when you want the Object Lock to expire. - - - - - - The tag-set for the object. The tag-set must be encoded as URL Query parameters. - - - - - Checks if Tagging property is set - - true if Tagging is set. - - - - Returns information about the InitiateMultipartUpload response and response metadata. - - - - - Name of the bucketName to which the multipart upload was initiated. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Object key for which the multipart upload was initiated. - - - - - - Gets and sets the initiated multipart upload id. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - Date when multipart upload will become eligible for abort operation by lifecycle. - - - - - Id of the lifecycle rule that makes a multipart upload eligible for abort operation. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Identifies who initiated the multipart upload. - - - - - Name of the Principal. - - - - - - If the principal is an AWS account, it provides the Canonical User ID. If the principal is an IAM User, it provides a user ARN value. - - - - - - Describes the serialization format of the object. - - - - - Describes the serialization of a CSV-encoded object. - - - - - Specifies object's compression format. Valid values: NONE, GZIP. Default Value: NONE. - - - - - Specifies JSON as object's input serialization format. - - - - - Specifies Parquet as object's input serialization format. - - - - - Class for MetricsConfiguration - - - - - Contains information about where to publish the inventory results. - - - - - Specifies whether the inventory is enabled or disabled. - - - - - Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria. - - - - - The ID used to identify the inventory configuration. - - - - - Specifies which object version(s) to included in the inventory results. - - - - - Contains the optional fields that are included in the inventory results. - - - - - Specifies the schedule for generating inventory results. - - - - - Class for InventoryDestination - - - - - Contains the bucket name, file format, bucket owner (optional), and prefix (optional) where inventory results are published. - - - - - InventoryEncryption class - - - - - Specifies the use of SSE-S3 to encrypt delievered Inventory reports. - - - - - Specifies the use of SSE-KMS to encrypt delievered Inventory reports. - - - - - Class for InventoryFilter - - - - - Filter Predicate setup for specific filter types. - - - - - Filter Predicate abstract class for specific filter types to be derived from. - - - - - Class for InventoryPrefixPredicate - The prefix that an object must have to be included in the inventory results. - - - - - The ID of the account that owns the destination bucket. - - - - - The Amazon resource name (ARN) of the bucket where inventory results will be published. - - - - - The prefix that is prepended to all inventory results. - - - - - Specifies the output format of the inventory results. - - - - - Contains the type of server-side encryption used to encrypt the inventory results. - - - - - Class for InventorySchedule - - - - - Specifies how frequently inventory results are produced. - - - - - Specifies JSON as object's input serialization format. - - - - - The type of JSON. Valid values: Document, Lines. - - - - - Specifies JSON as request's output serialization format - - - - - The value used to separate individual records in the output. - - - - - Specifies an object key and optional object version. - - - - - Key name of the object to delete. - - - - - - VersionId for the specific version of the object to delete. - - - - - - This class contains the configuration Amazon S3 uses to figure out what events you want to listen - and send the event to an Amazon Lambda cloud function. - - - - - Gets and set the Id property. The Id will be provided in the event content and can be used - to identify which configuration caused an event to fire. If the Id is not provided for the configuration, one will be generated. - - - - - Gets and sets the FunctionArn property. This is the Amazon Lambda cloud function to which Amazon S3 will invoke with the events. - - - - Lifecycle Configuration - - - - - Gets and sets the Rules property. These rules defined the lifecycle configuration. - - - - - Base class for all the different predicates that can be used - in a filter. - - - - - This method is called by the visitor when it wants to visit the predicate. - - - - - - Filter identifying one or more objects to which a applies. - - - - - The predicate used by the filter. - - - - - Base class for lifecycle operators. - - - - - The list of objects - that this operator operates on. - - - - - The logical and operator for filtering objects for a - - - - - Accept a visit from an - - - This method is used internally by the SDK. - - - - - - A predicate that filters objects for a - by matching a particular prefix. - - - - - The prefix to be matched by filtered objects. - - - - - Accept a visit from an - - - This method is used internally by the SDK. - - - - - - A predicate that filters objects for a - by matching a particular key and value. - - - - - The Tag to be matched by filtered objects. - - - - - Accept a visit from an - - - This method is used internally by the SDK. - - - - - - Rules Item - - - - - Defines the length of time, in days, before objects expire. - - - - - Unique identifier for the rule. The value cannot be longer than 255 characters. - - - - - Prefix identifying one or more objects to which the rule applies. - - - - - - Filter identifying one or more objects to which the rule applies. - - - - - If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied. - - - - - - The transition rule that describes when objects transition to a different storage class. - - Lifecycle rules can now contain multiple transitions. This property is obsolete in favor of the Transitions property. - This property will always get or set the the zeroth element in the Transitions collection. - - - - - - Defines the length of time, in days, before noncurrent versions expire. - - - - - The transition rule that describes when noncurrent versions transition to - a different storage class. - - Lifecycle rules can now contain multiple noncurrent version transitions. This property - is obsolete in favor of the NoncurrentVersionTransitions property. - This property will always get or set the the zeroth element in the NoncurrentVersionTransitions collection. - - - - - - The transition rules that describe when objects transition to a different storage class. - - - - - The transition rules that describe when noncurrent versions transition to - a different storage class. - - - - - Specifies the days since the initiation of an Incomplete Multipart Upload - that Lifecycle will wait before permanently removing all parts of the upload. - - - - - Specifies the days since the initiation of an Incomplete Multipart Upload - that Lifecycle will wait before permanently removing all parts of the upload. - - - - - Indicates the number of days that must pass since initiation for Lifecycle - to abort an Incomplete Multipart Upload. - - - - Expiration - - - - - Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format. - - - - - - Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer. - - - - - - Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set to true, the delete marker will be expired; if set to false the policy takes no action. This cannot be specified with Days or Date in a Lifecycle Expiration Policy. - - - - - - Noncurrent Version Expiration - - - - - Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated - action. For information about the noncurrent days calculations, see - How Amazon S3 Calculates When an Object Became Noncurrent - in the Amazon Simple Storage Service Developer Guide. - - - - - LifecycleTransition defines when and how objects transition. - - - - - Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated - action. For information about the noncurrent days calculations, see - How Amazon S3 Calculates When an Object Became Noncurrent - in the Amazon Simple Storage Service Developer Guide. - - - - - The class of storage used to store the object. - - - - - - LifecycleTransition defines when and how objects transition. - - - - - Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format. - - - - - - Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer. - - - - - - The class of storage used to store the object. - - - - - - Container for the parameters to the ListInventoryConfigurationsRequest operation. - Lists the analytics configurations for the bucket. - - - - - The name of the bucket containing the analytics configurations to retrieve. - - - - - The ContinuationToken that represents a placeholder from where this request should begin. - - - - - Returns information about the ListBucketAnalyticsConfigurationsResponse response and response metadata. - - - - - The ContinuationToken that represents where this request began. - - - - - The list of analytics configurations for a bucket. - - - - - Indicates whether the returned list of analytics configurations is complete. - A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request. - - - - - NextContinuationToken is sent when isTruncated is true, which indicates that there are more analytics configurations to list. - The next request must include this NextContinuationToken. The token is obfuscated and is not a usable value. - - - - - Container for the parameters to the ListInventoryConfigurationsRequest operation. - Returns a list of inventory configurations for the bucket. - - - - - The name of the bucket containing the inventory configurations to retrieve. - - - - - The marker used to continue an inventory configuration listing that has been truncated. - Use the NextContinuationToken from a previously truncated list response to continue the listing. - The continuation token is an opaque value that Amazon S3 understands. - - - - - Returns information about the ListInventoryConfigurationsResponse response and response metadata. - - - - - If sent in the request, the marker that is used as a starting point for this inventory configuration list response. - - - - - The list of inventory configurations for a bucket. - - - - - Indicates whether the returned list of inventory configurations is truncated in this response. A value of true indicates that the list is truncated. - - - - - The marker used to continue this inventory configuration listing. Use the NextContinuationToken from this response to continue the listing in a subsequent request. - The continuation token is an opaque value that Amazon S3 understands. - - - - - Container for the parameters to the ListBucketMetricsConfigurationRequest operation. - Lists the metrics configurations for the bucket. - - - - - The name of the bucket containing the metrics configurations to retrieve. - - - - - - The marker that is used to continue a metrics configuration listing that has been truncated. - Use the NextContinuationToken from a previously truncated list response to continue the listing. - The continuation token is an opaque value that Amazon S3 understands. - - - - - - Returns information about the ListBucketMetricsConfiguration response and response metadata. - - - - - - The marker that is used to continue a metrics configuration listing that has been truncated. - Use the NextContinuationToken from a previously truncated list response to continue the listing. - The continuation token is an opaque value that Amazon S3 understands. - - - - - - The list of metrics configurations for a bucket. - - - - - - Indicates whether the returned list of metrics configurations is complete. - A value of true indicates that the list is not complete and the NextContinuationToken will be provided for - a subsequent request. - - - - - - - The marker used to continue a metrics configuration listing that has been truncated. - Use the NextContinuationToken from a previously truncated list response to continue the listing. - The continuation token is an opaque value that Amazon S3 understands. - - - - - - Container for the parameters to the ListBuckets operation. - Returns a list of all buckets owned by the authenticated sender of the request. - - - - - Returns information about the ListBuckets response and response metadata. - - - - - List of buckets. - - - - - Owner of the buckets. - - - - - Container for the parameters to the ListMultipartUploads operation. - This operation lists in-progress multipart uploads. - - - - - Name of the bucket to which the multipart upload was initiated. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Character you use to group keys. - - - - - - Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin. - - - - - - Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response body. 1,000 is the maximum number of uploads that - can be returned in a response. - - - - - - Lists in-progress uploads only for those keys that begin with the specified prefix. - - - - - - Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the - upload-id-marker parameter is ignored. - - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - Returns information about the ListMultipartUploads response and response metadata. - - - - - Name of the bucketName to which the multipart upload was initiated. - - - - - - The key at or after which the listing began. - - - - - - Upload ID after which listing began. - - - - - - When a list is truncated, this element specifies the value that should be used for the key-marker request parameter in a subsequent request. - - - - - - When a list is truncated, this element specifies the value that should be used for the upload-id-marker request parameter in a subsequent - request. - - - - - - Maximum number of multipart uploads that could have been included in the response. - - - - - - Indicates whether the returned list of multipart uploads is truncated. A value of true indicates that the list was truncated. The list can - be truncated if the number of multipart uploads exceeds the limit allowed or specified by max uploads. - - - - - - Gets and sets the MultipartUploads property. - - Container for elements related to a particular multipart upload. A response - can contain zero or more Upload elements. - - - - - - Gets and sets the Prefix property. - - - - - Gets and sets the Delimiter property. - - - - - Gets the CommonPrefixes property. - A response can contain CommonPrefixes only if you specify a delimiter. - When you do, CommonPrefixes contains all (if there are any) keys between - Prefix and the next occurrence of the string specified by delimiter. In effect, - CommonPrefixes lists keys that act like subdirectories in the directory specified - by Prefix. For example, if prefix is notes/ and delimiter is a slash (/), in - notes/summer/july, the common prefix is notes/summer/. - - - - - Container for the parameters to the ListObjects operation. - Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a - subset of the objects in a bucket. - - - - - The name of the bucket containing the objects whose keys are to be listed. - - - - - A delimiter is a character you use to group keys. - - - - - Specifies the key to start with when listing objects in a bucket. - - - - - Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more. - - - - - Limits the response to keys that begin with the specified prefix. - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the ListObjects response and response metadata. - - - - - A flag that indicates whether or not Amazon S3 returned all of the results that satisfied - the search criteria. - - - - - Gets and sets the NextMarker property. - NextMarker is set by S3 only if a Delimiter was specified - in the original ListObjects request. If a delimiter was - not specified, the AWS SDK for .NET returns the last Key - of the List of Objects retrieved from S3 as the NextMarker. - - - - - Gets the S3Objects property. This is a list of - objects in the bucket that match your search criteria. - - - - - Gets and sets the Name property which is the name of the bucket. - - - - - Gets and sets the Prefix property. - - - - - Gets and sets the MaxKeys property. This is max number of object keys returned by the list operation. - - - - - Gets the CommonPrefixes property. - A response can contain CommonPrefixes only if you specify a delimiter. - When you do, CommonPrefixes contains all (if there are any) keys between - Prefix and the next occurrence of the string specified by delimiter. In effect, - CommonPrefixes lists keys that act like subdirectories in the directory specified - by Prefix. For example, if prefix is notes/ and delimiter is a slash (/), in - notes/summer/july, the common prefix is notes/summer/. - - - - - Gets and sets the Delimiter property. - Causes keys that contain the same string between the prefix and the - first occurrence of the delimiter to be rolled up into a single result - element in the CommonPrefixes collection. - - - These rolled-up keys are not returned elsewhere in the response. - - - - - Container for the parameters to the ListObjects operation. - Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a - subset of the objects in a bucket. - - - - - Bucket name to list. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - A delimiter is a character you use to group keys. - - - - - Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more. - - - - - Limits the response to keys that begin with the specified prefix. - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts - listing after this specified key. StartAfter can be any key in the bucket. - Cannot be set at the same time as ContinuationToken. - - - - - ContinuationToken indicates Amazon S3 that the list is being continued on this - bucket with a token. ContinuationToken is obfuscated and is not a real key. - - - - - The owner field is not present in ListObjectsV2 responses by default. - If you want to return owner field with each key in the result then set this field to true. - If not specified, the Owner field on S3Object will be null. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the ListObjects response and response metadata. - - - - - A flag that indicates whether or not Amazon S3 returned all of the results that satisfied - the search criteria. - - - - - Gets and sets the S3Objects property. Metadata about each object returned. - - - - - Bucket name. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the Prefix property. - - - - - Gets and sets the MaxKeys property. This is max number of object keys returned by the list operation. - - - - - Gets and sets the CommonPrefixes property. - CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence - of the string specified by delimiter - - - - - Gets and sets the Delimiter property. - Causes keys that contain the same string between the prefix and the - first occurrence of the delimiter to be rolled up into a single result - element in the CommonPrefixes collection. - - - These rolled-up keys are not returned elsewhere in the response. - - - - - Encoding type used by Amazon S3 to encode object keys in the response. - - - - - KeyCount is the number of keys returned with this request. - KeyCount will always be less than or equal to MaxKeys field. - - - - - ContinuationToken indicates Amazon S3 that the list is being continued - on this bucket with a token. - ContinuationToken is obfuscated and is not a real key - - - - - NextContinuationToken is sent when isTruncated is true which means there - are more keys in the bucket that can be listed. The next ListObjectV2 call - to Amazon S3 can be continued with this NextContinuationToken. - NextContinuationToken is obfuscated and is not a real key. - - - - - StartAfter is where you want Amazon S3 to start listing from. - Amazon S3 starts listing after this specified key. - StartAfter can be any key in the bucket. - - - - - Container for the parameters to the ListParts operation. - Lists the parts that have been uploaded for a specific multipart upload. - - - - - Name of the bucket to which the parts are being uploaded. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The object key for which the multipart upload was initiated. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Sets the maximum number of parts to return. - - - - - - Specifies the part after which listing should begin. Only parts with higher part numbers will be listed. - - - - - - Upload ID identifying the multipart upload whose parts are being listed. - - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the ListParts response and response metadata. - - - - - Name of the bucketName to which the multipart upload was initiated. - - - - - - Object key for which the multipart upload was initiated. - - - - - - Upload ID identifying the multipart upload whose parts are being listed. - - - - - - Part number after which listing begins. - - - - - - When a list is truncated, this element specifies the last part in the list, as well as the value to use for the part-number-marker request - parameter in a subsequent request. - - - - - - Maximum number of parts that were allowed in the response. - - - - - - Indicates whether the returned list of parts is truncated. - - - - - - Gets and sets the Parts property. - - PartDetails is a container for elements related to a particular part. A response can contain - zero or more Part elements. - - - - - - Identifies who initiated the multipart upload. - - - - - - Gets and sets the Owner property. - - - - - The class of storage used to store the object. - - - - - - Date when multipart upload will become eligible for abort operation by lifecycle. - - - - - Id of the lifecycle rule that makes a multipart upload eligible for abort operation. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the ListVersions operation. - Returns metadata about all of the versions of objects in a bucket. - - - - - The bucket name that contains the objects. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - A delimiter is a character you use to group keys. - - - - - Specifies the key to start with when listing objects in a bucket. - - - - - Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more. - - - - - Limits the response to keys that begin with the specified prefix. - - - - - Specifies the object version you want to start listing from. - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - Returns information about the ListVersions response and response metadata. - - - - - A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria. If your results were - truncated, you can make a follow-up paginated request using the NextKeyMarker and NextVersionIdMarker response parameters as a starting - place in another request to return the rest of the results. - - - - - - Marks the last Key returned in a truncated response. - - - - - - Gets and sets the VersionIdMarker property. - Marks the last Version-Id returned in a truncated response. - - - - - Use this value for the key marker request parameter in a subsequent request. - - - - - - Use this value for the next version id marker parameter in a subsequent request. - - - - - - Gets and sets the Versions property. This is a list of - object versions in the bucket that match your search criteria. - - - - - Gets and sets the Name property. - The bucket's name. - - - - - Gets and sets the Prefix property. - Keys that begin with the indicated prefix are listed. - - - - - Gets and sets the MaxKeys property. - This is the maximum number of keys in the S3ObjectVersions collection. - The value is derived from the MaxKeys parameter to ListVersionsRequest. - - - - - Gets the CommonPrefixes property. - A response can contain CommonPrefixes only if you specify a delimiter. - When you do, CommonPrefixes contains all (if there are any) keys between - Prefix and the next occurrence of the string specified by delimiter. - - - - - Gets and sets the Delimiter property. - Causes keys that contain the same string between the prefix and the - first occurrence of the delimiter to be rolled up into a single result - element in the CommonPrefixes collection. - - - These rolled-up keys are not returned elsewhere in the response. - - - - - This class contains the meta data for an S3 object. - - - - - Gets and sets meta data for the object. Meta data names must start with "x-amz-meta-". If the name passeed in as the indexer - doesn't start with "x-amz-meta-" then it will be prepended. - - The name of the meta data. - The value for the meta data - - - - Adds the metadata to the collection, if the name already exists it will be overwritten. - - The name of the metadata element - The value for the metadata - - - - Gets the count of headers. - - - - - Gets the names of the meta data elements. - - - - - A metadata key-value pair to store with an object. - - - - - Key of metadata key-value pair - - - - - Value of metadata key-value pair - - - - - A container specifying replication metrics-related information, including whether - emitting metrics and Amazon S3 events for replication are enabled. In addition, contains - configurations related to specific metrics or events. Must be specified together with a - ReplicationTime block. - - - - - Specifies whether the replication metrics are enabled. - - - - - A container specifying the time threshold for emitting the - s3:Replication:OperationMissedThreshold event. - - - - - Class for MetricsAndOperatorPredicate - A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. - The operator must have at least two predicates, and an object must match all of the predicates - in order for the filter to apply. - - Note: The current implementation restricts the usage to atmost one MetricsPrefixPredicate - and any number of MetricsTagPredicates. - - - - Class for MetricsConfiguration - - - - - The ID used to identify the metrics configuration. - - - - - Specifies a metrics configuration filter. - The metrics configuration will only include objects that meet the filter's criteria. - A filter must be a prefix, a tag, or a conjunction (MetricsAndOperator). - - - - - Filter class for Metrics. - - - - - Filter Predicate setup for specific filter types. - - - - - Filter Predicate abstract class for specific filter types to be derived from. - - - - - Abstract class that can be used over logical filter predicates,i.e. AND/OR. - - - - - Class for MetricsPrefixPredicate - The prefix used when evaluating a metrics filter. - - - - - Class for MetricsTagPredicate - The tag used when evaluating a metrics filter. - - - - - This class contains the mfa codes used authentication - - - - - Gets and sets the serial number of the authentication device - - - - - Gets and sets the displated value on the authentication device - - - - - The formatted string of the mfa codes to be passed to S3. - - - - - Container for elements related to a particular multipart upload. - - - - - Date and time at which the multipart upload was initiated. - - - - - - Identifies who initiated the multipart upload. - - - - - - Key of the object for which the multipart upload was initiated. - - - - - - Gets and sets the Owner property. - - - - - The class of storage used to store the object. - - - - - - Upload ID that identifies the multipart upload. - - - - - - An abstract class for all the notification configurations associated with an Amazon S3 bucket. - - - - - Gets and sets the Events property. These are the events the configuration will listen to. - - - - - Filter criteria for determining which S3 objects trigger event notifications. - - - - - - The container element for Object Lock configuration parameters. - - - - - Gets and sets the property ObjectLockEnabled. - - Indicates whether this object has an Object Lock configuration enabled. - - - - - - Gets and sets the property Rule. - - The Object Lock rule in place for the specified object. - - - - - - A Legal Hold configuration for an object. - - - - - Gets and sets the property Status. - - Indicates whether the specified object has a Legal Hold in place. - - - - - - A Retention configuration for an object. - - - - - Gets and sets the property Mode. - - Indicates the Retention mode for the specified object. - - - - - - Gets and sets the property RetainUntilDate. - - - - - The container element for an Object Lock rule. - - - - - Gets and sets the property DefaultRetention. - - The default retention period that you want to apply to new objects placed in the specified - bucket. - - - - - - Describes the location where the restore job's output is stored. - - - - - Describes an S3 location that will receive the results of the restore request. - - - - - Describes how results of the Select job are serialized. - - - - - Describes the serialization of CSV-encoded Select results. - - - - - Specifies JSON as request's output serialization format. - - - - - The owner of an S3 bucket. - - - - - The display name of the owner. - - - - - The unique identifier of the owner. - - - - - This class contains custom querystring parameters for an S3 object, which can then be signed as part of a Pre-signed URL request - - - - - Gets and sets parameters for the object. Parameter names must start with "x-". If the name passeed in as the indexer - doesn't start with "x-" then it will be prepended. - - The name of the parameter. - The value for the meta data - - - - Adds the parameter to the collection, if the name already exists it will be overwritten. - - The name of the parameter - The value for the parameter - - - - Gets the count of parameters. - - - - - Gets the names of the parameter elements. - - - - - Specifies Parquet as object's input serialization format. - - - - - A container for elements related to a particular part in a multipart operation. - A response can contain zero or more Part elements. - - - - - The date and time at which the part was uploaded. - - - - - The size of the uploaded part data. - - - - - A container holding the part number and etag used when completing a multipart upload. - - - - - Default constructor. - - - - - Constructs an instance of PartETag and sets the part number and etag. - - The part number. - the associated ETag for the part number. - - - - Compares the current object with another object of the same type. - - An object to compare with this object. - - A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has the following meanings: - Value - Meaning - Less than zero - This object is less than the parameter. - Zero - This object is equal to . - Greater than zero - This object is greater than . - - - - - The part number identifying the part. - - - - - The entity tag associated with the part. - - - - - The container element for this bucket's public-policy status. - - - - - Gets and sets the property IsPublic. - - The public-policy status for this bucket. TRUE indicates that this bucket - is public. FALSE indicates that the bucket is not public. - - - - - - The container element for all Public Access Block configuration options. You can enable - the configuration options in any combination. - - - - Amazon S3 considers a bucket policy public unless at least one of the following conditions - is true: - -
  1. - - The policy limits access to a set of CIDRs using aws:SourceIp. For more - information on CIDR, see http://www.rfc-editor.org/rfc/rfc4632.txt - - -
  2. - - The policy grants permissions, not including any "bad actions," to one of the following: - -
    • - - A fixed AWS principal, user, role, or service principal - -
    • - - A fixed aws:SourceArn - -
    • - - A fixed aws:SourceVpc - -
    • - - A fixed aws:SourceVpce - -
    • - - A fixed aws:SourceOwner - -
    • - - A fixed aws:SourceAccount - -
    • - - A fixed value of s3:x-amz-server-side-encryption-aws-kms-key-id - -
    • - - A fixed value of aws:userid outside the pattern "AROLEID:*" - -
- - "Bad actions" are those that could expose the data inside a bucket to reads or writes - by the public. These actions are s3:Get*, s3:List*, s3:AbortMultipartUpload, - s3:Delete*, s3:Put*, and s3:RestoreObject. - - - - The star notation for bad actions indicates that all matching operations are considered - bad actions. For example, because s3:Get* is a bad action, s3:GetObject, - s3:GetObjectVersion, and s3:GetObjectAcl are all bad actions. - - - - - - Gets and sets the property BlockPublicAcls. - - Specifies whether Amazon S3 should block public ACLs for this bucket. Setting this - element to TRUE causes the following behavior: - -
  • - - PUT Bucket acl and PUT Object acl calls will fail if the specified ACL allows public - access. - -
  • - - PUT Object calls will fail if the request includes an object ACL. - -
- - Note that enabling this setting doesn't affect existing policies or ACLs. - - - - - - Gets and sets the property IgnorePublicAcls. - - Specifies whether Amazon S3 should ignore public ACLs for this bucket. Setting this - element to TRUE causes Amazon S3 to ignore all public ACLs on this bucket - and any objects that it contains. - - - - Note that enabling this setting doesn't affect the persistence of any existing ACLs - and doesn't prevent new public ACLs from being set. - - - - - - Gets and sets the property BlockPublicPolicy. - - Specifies whether Amazon S3 should block public bucket policies for this bucket. Setting - this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy - if the specified bucket policy allows public access. - - - - Note that enabling this setting doesn't affect existing bucket policies. - - - - - - Gets and sets the property RestrictPublicBuckets. - - Specifies whether Amazon S3 should restrict public bucket policies for this bucket. - If this element is set to TRUE, then only the bucket owner and AWS Services - can access this bucket if it has a public policy. - - - - Note that enabling this setting doesn't affect previously stored bucket policies, - except that public and cross-account access within any public bucket policy, including - non-public delegation to specific accounts, is blocked. - - - - - - Container for the parameters to the PutAcl operation. - uses the acl subresource to set the access control list (ACL) permissions for an object that already exists in a bucket - - - - - The canned ACL to apply to the bucket. - - - - - - Custom ACLs to be applied to the bucket or object. - - - - - The bucket name that contains the object to which you want to attach the ACL. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The key of an S3 object. - If not specified, the ACLs are applied to the bucket. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - If set and an object key has been specified, the ACLs are applied - to the specific version of the object. - This property is ignored if the ACL is to be set on a Bucket. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - Returns information about the PutObjectAcl response metadata. - The PutAcl operation has a void result type. - - - - - The response for the PutBucketAccelerateConfiguration operation. - Adds an object to a bucket. - - - - - Container for the parameters to the PutBucketAccelerateConfiguration request. - - - - - The name of the bucket to contain the object. - - - - - Accelerate configuration for the bucket. - - - - - Container for the parameters to the PutBucketAnalyticsConfiguration operation. - Sets an analytics configuration for the bucket (specified by the analytics configuration ID). - - - - - The name of the bucket to which an analytics configuration is stored. - - - - - The identifier used to represent an analytics configuration. - - - - - The configuration and any analyses for the analytics filter. - - - - - Returns information about the PutBucketAnalyticsConfigurationResponse response metadata. - The PutBucketAnalyticsConfigurationResponse operation has a void result type. - - - - - Container for the parameters to the PutBucketRequestPayment operation. - Creates a new server-side encryption configuration (or replaces an existing one, if present). - - - - - The name of the bucket for which the server-side encryption configuration is set. - - - - - The base64-encoded 128-bit MD5 digest of the server-side encryption configuration. - - - This header can be used as a message integrity check to verify that the data is the same data that was originally sent. - Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. - - - - - Container for server-side encryption configuration rules. Currently S3 supports one rule only. - - - - - Container for the parameters to the PutBucketRequestPayment operation. - Adds an inventory configuration (identified by the inventory ID) from the bucket. - - - - - The name of the bucket where the inventory configuration will be stored. - - - - - Specifies the inventory Id. - - - - - Specifies the inventory configuration. - - - - - Returns information about the PutInventoryConfigurationResponse response metadata. - The PutInventoryConfigurationResponse operation has a void result type. - - - - - Container for the parameters to the PutBucketLoggingRequest operation. - Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. To set the - logging status of a bucket, you must be the bucket owner. - - - - - Gets and sets the BucketName property. - - - - - Gets and sets the LoggingConfig property. - - - - - Returns information about the PutBucketLogging response metadata. - The EnableBucketLogging operation has a void result type. - - - - - Container for the parameters to the PutBucketMetricsConfigurationRequest operation. - Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. - - - - - The name of the bucket for which the metrics configuration is set. - - - - - The ID used to identify the metrics configuration. - - - - - Specifies the metrics configuration. - - - - - Returns information about the PutBucketMetricsConfiguration response metadata. - The PutBucketMetricsConfiguration operation has a void result type. - - - - - Container for the parameters to the PutBucketNotification operation. - Enables notifications of specified events for a bucket. - - - - - Gets and sets the BucketName property. - - - - - Gets and sets the TopicConfigurations property. TopicConfigurations are configuration for Amazon S3 - events to be sent to Amazon SNS topics. - - - - - Gets and sets the QueueConfigurations property. QueueConfigurations are configuration for Amazon S3 - events to be sent to Amazon SQS queues. - - - - - Gets and sets the LambdaFunctionConfigurations property. LambdaFunctionConfigurations are configuration for - Amazon S3 events to be sent to an Amazon Lambda cloud function. - - - - - Returns information about the PutBucketNotification response metadata. - The PutBucketNotification operation has a void result type. - - - - - Container for the parameters to the PutBucketPolicy operation. - Replaces a policy on a bucket. If the bucket already has a policy, the one in this request completely replaces it. - - - - - The name of the bucket. - - - - - The base64 encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. - - - This header can be used as a message integrity check to verify that the data is the same data that was originally sent. - Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. - - - - - The bucket policy as a JSON document. - - - - - Set this parameter to true to confirm that you want to remove your - permissions to change this bucket policy in the future. - - - - - Overriden to turn off sending SHA256 header. - - - - - Returns information about the PutBucketPolicy response metadata. - The PutBucketPolicy operation has a void result type. - - - - - Container for the parameters to the PutBucketReplication operation. - Sets replication configuration for your bucket. If a replication configuration exists, this replaces it. - - - - - The name of the bucket to have the replication configuration applied. - - - - - The replication configuration to be applied. - - - - - Gets and sets the property Token. - - - - - Returns information about the PutBucketReplicationConfiguration response metadata. - The PutBucketReplicationConfiguration operation has a void result type. - - - - - Container for the parameters to the PutBucket operation. - Creates a new bucket. - - - - - The canned ACL to apply to the bucket. - - - - - - If set to true the bucket will be created in the same region - as the configuration of the AmazonS3 client. - If PutBucketRequest.BucketRegion or PutBucketRequest.BucketRegionName are set they take precedence over - this property. - Default: true. - - - - - The name of the bucket to be created. - - - - - The region locality for the bucket. - - - When set, this will determine where your data will - reside in S3. Refer - for a list of possible values. - - - - - The bucket region locality expressed using the name of the region. - When set, this will determine where your data will reside in S3. - Valid values: us-east-1, us-west-1, us-west-2, eu-west-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, sa-east-1 - - - - - Gets and sets the property ObjectLockEnabledForBucket. - - Specifies whether you want S3 Object Lock to be enabled for the new bucket. - - - - - - Container for the parameters to the PutBucketRequestPayment operation. - Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This - configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the - download. - - - - - The name of the bucket to set payment config. - - - - - Gets and sets request payment configuration - - - - - Returns information about the PutBucketRequestPayment response metadata. - The PutBucketRequestPayment operation has a void result type. - - - - - Returns information about the PutBucket response and response metadata. - - - - - Container for the parameters to the PutBucketTagging operation. - Sets the tags for a bucket. - - - - - The name of the bucket to apply the tags to. - - - - - The collection of tags. - - - - - Returns information about the PutBucketTagging response metadata. - The PutBucketTagging operation has a void result type. - - - - - Container for the parameters to the PutBucketVersioning operation. - Sets the versioning state of an existing bucket. To set the versioning state, you must be the bucket owner. - - - - - The name of the bucket to be updated. - - - - - The MfaCodes Tuple associates the Serial Number and the current Token/Code displayed on the - Multi-Factor Authentication device associated with your AWS Account. - - - This is a required property for this request if:
- 1. EnableMfaDelete was configured on the bucket - containing this object's version.
- 2. You are deleting an object's version - - - - - Checks if the MfaCodes property is set. - - true if the MfaCodes property is set. - - - - The versioning configuration to apply to the bucket. - - - Once Versioning has been "Enabled" on a bucket, it can be "Suspended" - but cannot be switched "Off". If EnableMfaDelete is set, - the MfaCodes property needs to contain the Serial of and current Token - displayed on the MFA device. - - - - - Returns information about the PutBucketVersioning response metadata. - The PutBucketVersioning operation has a void result type. - - - - - Container for the parameters to the PutBucketWebsite operation. - Set the website configuration for a bucket. - - - - - The name of the bucket to apply the configuration to. - - - - - The website configuration to apply. The configuration defines the index - document suffix and custom error page. - - - - - Returns information about the PutBucketWebsite response metadata. - The PutBucketWebsite operation has a void result type. - - - - - Container for the parameters to the PutCORSConfiguration operation. - Sets the cors configuration for a bucket. - - - - - The name of the bucket to have the CORS configuration applied. - - - - - The CORS configuration to apply. - - - - - Returns information about the PutCORSConfiguration response metadata. - The PutCORSConfiguration operation has a void result type. - - - - - Container for the parameters to the PutLifecycleConfiguration operation. - Sets lifecycle configuration for your bucket. If a lifecycle configuration exists, it replaces it. - - - - - The name of the bucket to have the lifecycle configuration applied. - - - - - The lifecycle configuration to be applied. - - - - - Returns information about the PutLifecycleConfiguration response metadata. - The PutLifecycleConfiguration operation has a void result type. - - - - - Container for the parameters to the PutObjectLegalHold operation. - Applies a Legal Hold configuration to the specified object. - - - - - The bucket name containing the object that you want to place a Legal Hold on. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property ContentMD5. - - The MD5 signature for the configuration included in your request. - - - - - - Gets and sets the property Key. - - The key name for the object that you want to place a Legal Hold on. - - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Gets and sets the property LegalHold. - - Container element for the Legal Hold configuration you want to apply to the specified - object. - - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property VersionId. - - The version ID of the object that you want to place a Legal Hold on. - - - - - - This is the response object from the PutObjectLegalHold operation. - - - - - Gets and sets the property RequestCharged. - - - - - Container for the parameters to the PutObjectLockConfiguration operation. - Places an Object Lock configuration on the specified bucket. The rule specified in - the Object Lock configuration will be applied by default to every new object placed - in the specified bucket. - - - - - Gets and sets the property BucketName. - - The bucket whose Object Lock configuration you want to create or replace. - - - - - - Gets and sets the property ContentMD5. - - The MD5 signature for the configuration included in your request. - - - - - - Gets and sets the property ObjectLockConfiguration. - - The Object Lock configuration that you want to apply to the specified bucket. - - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property Token. - - - - - This is the response object from the PutObjectLockConfiguration operation. - - - - - Gets and sets the property RequestCharged. - - - - - Container for the parameters to the PutObject operation. - Adds an object to a bucket. - - - Container for the parameters to the PutObject operation. - Adds an object to a bucket. - - - - - A canned access control list (CACL) to apply to the object. - Please refer to for - information on S3 Canned ACLs. - - - - - Input stream for the request; content for the request will be read from the stream. - - - - - - The full path and name to a file to be uploaded. - If this is set the request will upload the specified file to S3. - - - For WinRT and Windows Phone this property must be in the form of "ms-appdata:///local/file.txt". - - - - - - Text content to be uploaded. Use this property if you want to upload plaintext to S3. - The content type will be set to 'text/plain'. - - - - - If this value is set to true then the stream used with this request will be closed when all the content - is read from the stream. - Default: true. - - - - - If this value is set to true then the stream will be seeked back to the start before being read for upload. - Default: true. - - - - - If this value is set to true then a chunked encoding upload will be used for the request. - Default: true. - - - - - Bucket name to which the PUT operation was initiated. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - Gets and sets Key property. This key is used to identify the object in S3. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - Checks if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - true if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - - - The type of storage to use for the object. Defaults to 'STANDARD'. - - - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - The Legal Hold status that you want to apply to the specified object. - - - - - - Gets and sets the property ObjectLockMode. - - The Object Lock mode that you want to apply to this object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - The date and time when you want this object's Object Lock to expire. - - - - - - If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - Attach a callback that will be called as data is being sent to the AWS Service. - - - - - This is a convenience property for Headers.ContentType. - - - - - An MD5 digest for the content. - - - - The base64 encoded 128-bit MD5 digest of the message - (without the headers) according to RFC 1864. This header - can be used as a message integrity check to verify that - the data is the same data that was originally sent. - - - If supplied, after the file has been uploaded to S3, - S3 checks to ensure that the MD5 hash of the uploaded file - matches the hash supplied. - - - Although it is optional, we recommend using the - Content-MD5 mechanism as an end-to-end integrity check. - - - - - - Checks if MD5Digest property is set. - - true if MD5Digest property is set. - - - - Overriden to turn off sending SHA256 header. - - - - - Overriden to turn on expect 100 continue. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - The tag-set for the object. The tag-set must be encoded as URL Query parameters. - - - - - Checks if Tagging property is set - - true if Tagging is set. - - - - Overrides the default request timeout value. - - - - If the value is set, the value is assigned to the Timeout property of the HTTPWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Overrides the default ReadWriteTimeout value. - - - - If the value is set, the value is assigned to the ReadWriteTimeout property of the HTTPWebRequest/WebRequestHandler object used - to send requests. - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - - Returns information about the PutObject response and response metadata. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - Entity tag for the uploaded object. - - - - - - Version of the object. - - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the PutObjectRetention operation. - Places an Object Retention configuration on an object. - - - - - The bucket name that contains the object you want to apply this Object Retention configuration to. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property BypassGovernanceRetention. - - - - - Gets and sets the property ContentMD5. - - The MD5 signature for the configuration included in your request. - - - - - - Gets and sets the property Key. - - The key name for the object that you want to apply this Object Retention configuration - to. - - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property Retention. - - The container element for the Object Retention configuration. - - - - - - Gets and sets the property VersionId. - - The version ID for the object that you want to apply this Object Retention configuration - to. - - - - - - This is the response object from the PutObjectRetention operation. - - - - - Gets and sets the property RequestCharged. - - - - - Container for the parameters to the PutObjectTagging operation. - - - - - The bucket name containing the object. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Check to see if Bucket property is set - - - - - Gets and sets Key property. This key is used to identify the object in S3. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Check to see if Key property is set - - - - - The tag-set for the object. The tag-set must be encoded as URL Query parameters - - - - - Checks if Tagging property is set. - - - - - VersionId used to reference a specific version of the object. - - - - - - Returns information about the PutObjectTagging response and response metadata. - - - - - Version of the object. - - - - - Container for the parameters to the PutPublicAccessBlock operation. - Creates or modifies the Public Access Block configuration for an Amazon S3 bucket. - - - - - Gets and sets the property BucketName. - - The name of the Amazon S3 bucket whose Public Access Block configuration you want - to set. - - - - - - Gets and sets the property ContentMD5. - - The MD5 hash of the PutPublicBlock request body. - - - - - - Gets and sets the property PublicAccessBlockConfiguration. - - The Public Access Block configuration that you want to apply to this Amazon S3 bucket. - - - - - - This is the response object from the PutPublicAccessBlock operation. - - - - - Base class for put operations that can also put an ACL. - - - - - Gets the access control lists (ACLs) for this request. - Please refer to for information on - S3 Grants. - - - - - This class contains the configuration Amazon S3 uses to figure out what events you want to listen - and send the event to an Amazon SQS queue. - - The queue's policy must allow S3 to send messages to it. The utility method - Amazon.SQS.AmazonSQSClient.AuthorizeS3ToSendMessage(string,string) - can be used to help setup the queue policy. - - - - - - Gets and set the Id property. The Id will be provided in the event content and can be used - to identify which configuration caused an event to fire. If the Id is not provided for the configuration, one will be generated. - - - - - Gets and sets the Queue property. Amazon SQS queue to which Amazon S3 will publish a message - to report the specified events for the bucket. - - The queue's policy must allow S3 to send messages to it. The utility method - Amazon.SQS.AmazonSQSClient.AuthorizeS3ToSendMessage(string,string) - can be used to help setup the queue policy. - - - - - - This class defines the configuration for replication. - - - - - Indicates the ARN of the role to assume. - - - - - Check to see if the Role property is set. - - true if the Role property is set. - - - - Container for information about a particular replication rule. - Replication configuration must have at least one rule and can contain up to 1,000 rules. - - - - - Checks to see if the Rules property is set. - - true if the Rules property is set. - - - - Destination configuration for a replication rule. - - - - -

Amazon resource name (ARN) of the bucket where you want Amazon - S3 to store replicas of the object identified by the rule.

- If you have multiple rules in your replication configuration, all - rules must specify the same bucket as the destination. A replication - configuration can replicate objects only to one destination bucket.

- - - - - Checks to see if BucketArn property is set. - - true if BucketArn property is set. - - - - The class of storage used to store the object. - - - - - -

Account ID of the destination bucket. Currently Amazon S3 verifies this - value only if Access Control Translation is enabled.

In a cross-account - scenario, if you tell Amazon S3 to change replica ownership to the AWS account - that owns the destination bucket by adding the AccessControlTranslation - element, this is the account ID of the destination bucket owner.

- - - - -

Container for information regarding the access control for replicas.

-

Use only in a cross-account scenario, where source and destination bucket - owners are not the same, when you want to change replica ownership to the AWS - account that owns the destination bucket. If you don't add this element to the - replication configuration, the replicas are owned by same AWS account that - owns the source object.

- - - - -

Container that provides encryption-related information. You must - specify this element if the SourceSelectionCriteria is - specified.

- - - - - A container specifying the time when all objects and operations on objects are - replicated. Must be specified together with a Metrics block. - - - - - A container specifying replication metrics-related information, including whether - emitting metrics and Amazon S3 events for replication are enabled. In addition, - contains configurations related to specific metrics or events. Must be specified - together with a ReplicationTime block. - - - - - Rule that specifies the replication configuration. - - - - - Unique identifier for the rule. The value cannot be longer than 255 characters. - - - - - Checks to see if Id property is set. - - true if Id property is set. - - - -

The priority associated with the rule. If you specify multiple rules in a - replication configuration, then Amazon S3 applies rule priority in the event - there are conflicts (two or more rules identify the same object based on - filter specified). The rule with higher priority takes precedence. For - example,

  • Same object quality prefix based filter criteria - If prefixes you specified in multiple rules overlap.

  • Same - object qualify tag based filter criteria specified in multiple rules

    • -

For more information, see - - Cross-Region Replication (CRR) in the Amazon S3 Developer Guide.

- - - - - Checks to see if Priority property is set. - - true if Priority property is set. - - - - Object keyname prefix identifying one or more objects to which the - rule applies. Maximum prefix length can be up to 1,024 characters. - - - - - Checks to see if Prefix property is set. - - true if Prefix property is set. - - - - Gets and sets the property Filter. - - - - - Checks to see if Filter property is set. - - true if Filter property is set. - - - - Whether the rule is applied or ignored. - - - - - Checks to see if Status property is set. - - true if Status property is set. - - - - Container for replication destination information. - - - - - Checks to see if Destination property is set. - - true if Destination property is set. - - - -

Container that describes additional filters in identifying source objects that - you want to replicate. Currently, Amazon S3 supports only the filter that you can - specify for objects created with server-side encryption using an AWS KMS-managed - key. You can choose to enable or disable replication of these objects.

if - you want Amazon S3 to replicate objects created with server-side encryption using - AWS KMS-managed keys.

- - - - - A container that specifies information about existing object replication. - You can choose whether to enable or disable the replication of existing objects. - - - - - Checks to see if ExistingObjectReplication property is set. - - true if ExistingObjectReplication property is set. - - - - Specifies whether Amazon S3 should replicate delete makers. - - - - - Checks to see if DeleteMarkerReplication property is set. - - true if DeleteMarkerReplication property is set. - - - - - - - - Object keyname prefix that identifies subset of objects to which the rule applies. - - - - - Checks to see if Prefix property is set. - - true if Prefix property is set. - - - - All of these tags must exist in the object's tag set in order for the rule to apply. - - - - - Checks to see if Tags property is set. - - true if Tags property is set. - - - - Filter that identifies subset of objects to which the replication rule applies. - A Filter must specify exactly one Prefix, - Tag, or an And child element. - - - - - Object keyname prefix that identifies subset of objects to which the rule applies. - - - - - Checks to see if Prefix property is set. - - true if Prefix property is set. - - - -

Container for specifying a tag key and value.

-

The rule applies only to objects having the tag in its tagset.

- - - - - Checks to see if Tag property is set. - - true if Tag property is set. - - - -

Container for specifying rule filters. These filters determine the - subset of objects to which the rule applies. The element is required - only if you specify more than one filter. For example:

  • -

    You specify both a Prefix and a Tag - filters. Then you wrap these in an And tag.

    • -

  • You specify filter based on multiple tags. Then you wrap the - Tag elements in an And tag.

- - - - - Checks to see if And property is set. - - true if And property is set. - - - - A container specifying the time when all objects and operations on objects are replicated. Must be specified together with a Metrics block. - - - - - Specifies whether the replication time is enabled. - - - - - A container specifying the time by which replication should complete for all objects and operations on objects. - - - - - A container specifying the time value. - - - - - Contains an integer specifying time in minutes. - - - - - Request Payment Configuration - - - - - Specifies who pays for the download and request fees. - - - - - Container for values of the response headers that will be set on a response from a GetObject request. - These values override any headers that were set when the object was uploaded to S3. - - - - - A standard MIME type describing the format of the object data. - - - The content type for the content being uploaded. This property defaults to "binary/octet-stream". - For more information, refer to: - - - - - ContentLanguage header value. - - - - - Expiry header value. - - - - - CacheControl header value. - - - - - The ContentDisposition header value. - - - - - The ContentEncoding header value. - - - - - Container for the parameters to the RestoreObject operation. - Restores an archived copy of an object back into Amazon S3 - - - - - The bucket name or containing the object to restore. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the Key property. This key indicates the S3 object to restore. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Lifetime of the active copy in days - ** Do not use with restores that specify OutputLocation ** - - - - - VersionId used to reference a specific version of the object. - - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Glacier retrieval tier at which the restore will be processed. - ** Do not use with restores that specify OutputLocation ** - - - - - Glacier retrieval tier at which the restore will be processed. - ** Only use with restores that require OutputLocation ** - - - - - Type of restore request. - - - - - The optional description for the job. - - - - - Describes the parameters for Select job types. - - - - - Describes the location where the restore job's output is stored. - - - - - Returns information about the RestoreObject response metadata. - The RestoreObject operation has a void result type. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Indicates the path in the provided S3 output location where Select results will be restored to. - - - - Routing Rule - - - - - A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the - /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might - process the error. - - - - - - Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event of an - error, you can can specify a different error code to return. - - - - - - A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages - in the /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you - might process the error. - - - - - The HTTP error code when the redirect is applied. In the event of an error, if the error code equals this value, then the specified redirect - is applied. Required when parent element Condition is specified and sibling KeyPrefixEquals is not specified. If both are specified, then - both must be true for the redirect to be applied. - - - - - - The object key name prefix when the redirect is applied. For example, to redirect requests for ExamplePage.html, the key prefix will be - ExamplePage.html. To redirect request for all pages with the prefix docs/, the key prefix will be /docs, which identifies all objects in the - docs/ folder. Required when the parent element Condition is specified and sibling HttpErrorCodeReturnedEquals is not specified. If both - conditions are specified, both must be true for the redirect to be applied. - - - - - - Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event - of an error, you can can specify a different error code to return. - - - - - Name of the host where requests will be redirected. - - - - - - The HTTP redirect code to use on the response. Not required if one of the siblings is present. - - - - - - Protocol to use (http, https) when redirecting requests. The default is the protocol that is used in the original request. - - - - - - The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix docs/ (objects in the - docs/ folder) to documents/, you can set a condition block with KeyPrefixEquals set to docs/ and in the Redirect set ReplaceKeyPrefixWith to - /documents. Not required if one of the siblings is present. Can be present only if ReplaceKeyWith is not provided. - - - - - - The specific object key to use in the redirect request. For example, redirect request to error.html. Not required if one of the sibling is - present. Can be present only if ReplaceKeyPrefixWith is not provided. - - - - - - Represents an access control list (ACL) for S3. An AccessControlList is represented by an Owner, - and a List of Grants, where each Grant is a Grantee and a Permission. - - - - Each bucket and object in Amazon S3 has an ACL that defines its access control policy. - When a request is made, Amazon S3 authenticates the request using its standard - authentication procedure and then checks the ACL to verify the sender was granted access - to the bucket or object. If the sender is approved, the request proceeds. - Otherwise, Amazon S3 returns an error. - - - An ACL is a list of grants. A grant consists of one grantee and one permission. - ACLs only grant permissions; they do not deny them. - - - For convenience, some commonly used Access Control Lists are defined in - S3CannedACL. - - - Note: BucketName and object ACLs are completely independent; an object does not inherit the ACL - from its bucket. For example, if you create a bucket and grant write access to another user, - you will not be able to access the user's objects unless the user explicitly grants access. - This also applies if you grant anonymous write access to a bucket. Only the user "anonymous" - will be able to access objects the user created unless permission is explicitly granted to - the bucket owner. - - - Important: We highly recommend that you do not grant the anonymous group write access to your - buckets as you will have no control over the objects others can store and their associated charges. - For more information, see Grantees and Permissions - - - - - Creates a S3Grant and adds it to the list of grants. - - The grantee for the grant. - The permission for the grantee. - - - - Removes a specific permission for the given grantee. - - The grantee - The permission for the grantee to remove - - - - Removes all permissions for the given grantee. - - - - - - The owner of the bucket or object. - - - - Every bucket and object in Amazon S3 has an owner, the user that - created the bucket or object. The owner of a bucket or object cannot - be changed. However, if the object is overwritten by another user - (deleted and rewritten), the new object will have a new owner. - - - Note: Even the owner is subject to the ACL. For example, if an owner - does not have Permission.READ access to an object, the owner cannot read - that object. However, the owner of an object always has write access to the - access control policy (Permission.WriteAcp) and can change the ACL to - read the object. - - - - - - Checks if Owner property is set. - - true if Owner property is set. - - - - A collection of grants. - - - - - Checks if Grants property is set. - - true if Grants property is set. - - - Bucket - Represents an S3 bucket, contains the name of the S3 bucket and the date that the bucket was created. - - - - - Date the bucket was created. - - - - - - The name of the bucket. - - - - - Logging Enabled - - - - - Specifies the bucket where you want Amazon S3 to store server access logs. You can have your logs delivered to any bucket that you own, - including the same bucket that is being logged. You can also configure multiple buckets to deliver their logs to the same target bucket. In - this case you should choose a different TargetPrefix for each source bucket so that the delivered log files can be distinguished by key. - - - - - A collection of grants. - - - - - This element lets you specify a prefix for the keys that the log files will be stored under. - - - - - Creates a S3Grant and adds it to the list of grants. - - The grantee for the grant. - The permission for the grantee. - - - - Removes a specific permission for the given grantee. - - The grantee - The permission for the grantee to remove - - - - Removes all permissions for the given grantee. - - - - - - An S3 bucket versioning configuration. - - - Contains the bucket's versioning status (Off, Enabled, Suspended) and whether an MFADelete - has been enabled for the bucket. - - - - - Versioning status for the bucket. - Accepted values: Off, Enabled, Suspended. - - - - - Checks if Status property is set - - true if Status property is set - - - - Specifies whether MFA Delete is enabled on this S3 Bucket. - - - If this property is set, please ensure that the - PutBucketVersioningRequest's MfaCodes property is set with - the Serial of and Token on the MFA device. - - - - - Checks if EnableMfaDelete property is set. - - true if Status property is set - - - - Describes the server-side encryption that will be applied to the restore results. - - - - - The server-side encryption algorithm used when storing job results in Amazon S3 (e.g., AES256, aws:kms). - - - - - Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by - AWS KMS will fail if not made via SSL or using SigV4. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at - http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version - - - - - If the encryption type is aws:kms, this optional value can be used to specify the encryption context for the restore results. - - - - Grant - - - - - The grantee details. - - - - - Specifies the permission given to the grantee. - - - - - Grantee - - - - - Type of grantee - - - - - - Screen name of the grantee. - - - - - - Email address of the grantee. - - - - - - The canonical user ID of the grantee. - - - - - - URI of the grantee group. - - - - - - Filter criteria that allows for event notification filtering based on an S3 Object's key name. - - - - - Gets and sets the filterRules property. - These are the filter rules for this filter. - - - - - Describes an S3 location that will receive the results of the restore request. - - - - - The name of the bucket where the restore results will be placed. - - - - - The prefix that is prepended to the restore results for this request. - - - - - The canned ACL to apply to the restore results. - - - - - A list of grants that control access to the staged results. - - - - - The tag-set that is applied to the restore results. - - - - - A map of metadata to store with the restore results in S3. - - - - - The class of storage used to store the restore results. - - - - - Represents an S3 Object. Contains all attributes that an S3 Object has. - For more information about S3 Objects refer: - - - - - - Any ETag set on the object. - - - - - The name of the bucket containing this object. - - - - - The key of the object. - - - - - The date and time the object was last modified. - - The date retrieved from S3 is in ISO8601 format. A GMT formatted date is passed back to the user. - - - - - - The owner of the object. - - - - - The size of the object. - - - - - The class of storage used to store the object. - - - - - - Represents a version of an object in an S3 Bucket. An S3 object version is an S3 object - that also has a version identifier, an indication of whether this is the latest version of the object - and whether it's a DeleteMarker or not. - - - - - Specifies whether the object is (true) or is not (false) the latest version of an object. - - - - - Version ID of an object. - - - - - If true, the object is a delete marker for a deleted object. - - - - - Specifies the byte range of the object to get the records from. A record is processed when its first byte is contained by the range. - - - - - Specifies the start of the byte range. This parameter is optional. Valid values: non-negative integers. The default value is 0. - - - - - Specifies the end of the byte range. This parameter is optional. Valid values: non-negative integers. The default value is one less than the size of the object being queried. - - - - - Request to filter the contents of an Amazon S3 object based on a simple Structured Query Language (SQL) statement. - - In the request, along with the SQL expression, you must also specify a data serialization format (JSON or CSV) of the object. - Amazon S3 uses this to parse object data into records, and returns only records - that match the specified SQL expression. You must also specify the data serialization format for the response. - - - - S3Select API Documentation - - - - - The S3 Bucket. - - - - - The Object Key. - - - - - The SSE Algorithm used to encrypt the object. - - - Server-Side Encryption (Using Customer-Provided Encryption Keys. - - - - - The SSE Customer Key. - - - Server-Side Encryption (Using Customer-Provided Encryption Keys. - - - - - The SSE Customer Key MD5. - - - Server-Side Encryption (Using Customer-Provided Encryption Keys. - - - - - The expression that is used to query the object. - - - - - The type of the provided expression (e.g., SQL). - - - - - Specifies if periodic request progress information should be enabled. - - - - - Describes the format of the data in the object that is being queried. - - - - - Describes the format of the data that you want Amazon S3 to return in response. - - - - - The byte range of the object to get the records from. - - - - - Contains the response Payload for the SelectObjectContent request - - - - - The Event Stream result of SelectObjectContent - - - - - Describes the parameters for Select job types. - - - - - Describes the serialization format of the object. - - - - - The type of the provided expression (e.g., SQL). - - - - - The expression that is used to query the object. - - - - - Describes how the results of the Select job are serialized. - - - - - ServerSideEncryptionByDefault class - - - - - Server-side encryption algorithm to use for the default encryption. - - - - - KMS master key ID to use for the default encryption. - This parameter is allowed if SSEAlgorithm is aws:kms. - - - - - ServerSideEncryptionConfiguration class - - - - - Container for information about a particular server-side encryption configuration rule. - - - - - ServerSideEncryptionRule class - - - - - Describes the default server-side encryption to apply to - new objects in the bucket. If Put Object request - does not specify any server-side encryption, - this default encryption will be applied. - - - - - SourceSelectionCriteria class - - - - - Container for filter information of selection of KMS Encrypted - S3 objects. The element is required if you include - SourceSelectionCriteria in the replication - configuration. - - - - - SSEKMS class - - - - - Specifies the ID of the AWS Key Management Service (KMS) - master encryption key to use for encrypting Inventory reports. - - - - - SseKmsEncryptedObjects class - - - - - The replication for KMS encrypted S3 objects is disabled if status is not Enabled. - - - - - SSES3 class - - - - - Class for StorageClassAnalysis - - - - - A container used to describe how data related to the storage class analysis should be exported. - - - - - Class for StorageClassAnalysisDataExport - - - - - The version of the output schema to use when exporting data. Must be V_1. - - - - - The place to store the data for an analysis. - - - - - Base class for responses that return a stream. - - - - - Disposes of all managed and unmanaged resources. - - - - - An open stream read from to get the data from S3. In order to - use this stream without leaking the underlying resource, please - wrap access to the stream within a using block. - - - - - The exception that is thrown when the size of a stream does not match it's expected size. - - - - - Gets and sets ExpectedSize property. - - - - - Gets and sets ActualSize property. - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - - - Constructs a new instance of the AmazonServiceException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - Tag is a key-value pair of metadata associated with an S3Object - - - - - Name of the tag. - - - - - Value of the tag. - - - - - Structure that contains list of Tags - - - - - TagSet - - - - - This class contains the configuration Amazon S3 uses to figure out what events you want to listen - and send the event to an Amazon SNS topic. - - The topic's policy must allow S3 to publish messages to it. The utility method - Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.AuthorizeS3ToPublish(string,string) - can be used to help setup the topic policy. - - - - - - Gets and set the Id property. The Id will be provided in the event content and can be used - to identify which configuration caused an event to fire. If the Id is not provided for the configuration, one will be generated. - - - - - Bucket event for which to send notifications. - - Topic configurations can now contain multiple events. This property is obsolete in favor of the Events property. - This property will always get or set the the zeroth element in the Events collection. - - - - - - Gets and sets the Topic property. Amazon SNS topic to which Amazon S3 will publish a message to report the - specified events for the bucket. - - The topic's policy must allow S3 to publish messages to it. The utility method - Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.AuthorizeS3ToPublish(string,string) - can be used to help setup the topic policy. - - - - - - The parameters to request upload of a part in a multipart upload operation. - - - - If PartSize is not specified then the rest of the content from the file - or stream will be sent to Amazon S3. - - - You must set either the FilePath or InputStream. If FilePath is set then the FilePosition - property must be set. - - - - The parameters to request upload of a part in a multipart upload operation. - - - - If PartSize is not specified then the rest of the content from the file - or stream will be sent to Amazon S3. - - - You must set either the FilePath or InputStream. If FilePath is set then the FilePosition - property must be set. - - - - - - Caller needs to set this to true when uploading the last part. This property only needs to be set - when using the AmazonS3EncryptionClient. - - - - - Input stream for the request; content for the request will be read from the stream. - - - - - The name of the bucket containing the object to receive the part. - - - - - The key of the object. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Part number of part being uploaded. - - - - - - The size of the part to be uploaded. - - - - - Checks if PartSize property is set. - - true if PartSize property is set. - - - - Upload ID identifying the multipart upload whose part is being uploaded. - - - - - - An MD5 digest for the part. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - - Full path and name of a file from which the content for the part is retrieved. - - - For WinRT and Windows Phone this property must be in the form of "ms-appdata:///local/file.txt". - - - - - - Checks if the FilePath property is set. - - true if FilePath property is set. - - - - Position in the file specified by FilePath from which to retrieve the content of the part. - This field is required when a file path is specified. It is ignored when using the InputStream property. - - - - - If this value is set to true then a chunked encoding upload will be used for the request. - Default: true. - - - - - Checks if the FilePosition property is set. - - true if FilePosition property is set. - - - - Checks if the MD5Digest property is set. - - true if Md5Digest property is set. - - - - Attach a callback that will be called as data is being sent to the AWS Service. - - - - - Overriden to turn off sending SHA256 header. - - - - - Overriden to turn on Expect 100 continue. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Overrides the default request timeout value. - - - - If the value is set, the value is assigned to the Timeout property of the HTTPWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Overrides the default ReadWriteTimeout value. - - - - If the value is set, the value is assigned to the ReadWriteTimeout property of the HTTPWebRequest/WebRequestHandler object used - to send requests. - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - - Returns information about the UploadPart response and response metadata. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - Entity tag for the uploaded object. - - - - - - Gets and sets the part number specified for the part upload. This is needed when - completing the multipart upload. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - Website Configuration - - - - - The ErrorDocument value, an object key name to use when a 4XX class error occurs. - - - - - - This value is a suffix that is appended to a request that is for a "directory" - on the website endpoint (e.g. if the suffix is index.html and - you make a request to samplebucket/images/ the data that - is returned will be for the object with the key name - images/index.html) - - - The suffix must not be empty and must not include a slash - character. - - - - - - Container for redirect information where all requests will be redirect - to. You can redirect requests to another host, to another page, or with - another protocol. In the event of an error, you can can specify a - different error code to return. . - - - - - The list of routing rules that can be used for configuring redirects if certain conditions are meet. - - - - - Arguments containing event details for an in-flight transfer. - - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - - - - Gets the percentage of transfer completed - - - - - Gets the number of bytes transferred since last event - - - - - Gets the number of bytes transferred - - - - - Gets the total number of bytes to be transferred - - - - - Returns a string representation of this object - - - - - - AmazonS3 exception. - Thrown when DeleteObjects returns successfully, but some of the objects - were not deleted. - - - - - Gets and sets the ErrorResponse property. - The DeleteObjectsErrorResponse associated with this exception. - - - - - Constructs an instance of DeleteObjectsException - - - - - - Constructs a new instance of the DeleteObjectsException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - The file format used when exporting data to Amazon S3. - - - - - CSV file format. - - - - - Construct instance of AnalyticsS3ExportFileFormat. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to an AnalyticsS3ExportFileFormat. - - - - - - - Represents the accelerate status for a bucket. - - - - - Bucket acceleration is enabled. - - - - - Bucket acceleration is suspended. - - - - - Construct instance of BucketAccelerateStatus. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to an BucketAccelerateStatus - - - - - - - The status of the delete marker replication. - - - - - Delete marker replication is enabled. - - - - - Delete marker replication is disabled. - - - - - Construct instance of DeleteMarkerReplicationStatus. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to a DeleteMarkerReplicationStatus - - - - - - - A list of all possible CannedACLs that can be used - for S3 Buckets or S3 Objects. For more information about CannedACLs, refer to - . - - - - - Owner gets FULL_CONTROL. - No one else has access rights (default). - - - - - Owner gets FULL_CONTROL. - No one else has access rights (default). - - - - - Owner gets FULL_CONTROL and the anonymous principal is granted READ access. - If this policy is used on an object, it can be read from a browser with no authentication. - - - - - Owner gets FULL_CONTROL, the anonymous principal is granted READ and WRITE access. - This can be a useful policy to apply to a bucket, but is generally not recommended. - - - - - Owner gets FULL_CONTROL, and any principal authenticated as a registered Amazon - S3 user is granted READ access. - - - - - Owner gets FULL_CONTROL. Amazon EC2 gets READ access to GET an - Amazon Machine Image (AMI) bundle from Amazon S3. - - - - - Object Owner gets FULL_CONTROL, Bucket Owner gets READ - This ACL applies only to objects and is equivalent to private when used with PUT Bucket. - You use this ACL to let someone other than the bucket owner write content (get full control) - in the bucket but still grant the bucket owner read access to the objects. - - - - - Object Owner gets FULL_CONTROL, Bucket Owner gets FULL_CONTROL. - This ACL applies only to objects and is equivalent to private when used with PUT Bucket. - You use this ACL to let someone other than the bucket owner write content (get full control) - in the bucket but still grant the bucket owner full rights over the objects. - - - - - The LogDelivery group gets WRITE and READ_ACP permissions on the bucket. - - - - - Construct instance of S3CannedACL. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to an S3CannedACL - - - - - - - A list of all possible S3 Bucket region possibilities. For - more information, refer to - . - - - - - Specifies that the S3 Bucket should use US locality. - This is the default value. - - - - - Specifies that the S3 Bucket should use US-EAST-2 locality. - - - - - Specifies that the S3 Bucket should use EU locality which defaults to EU-WEST-1 - - - - - Specifies that the S3 Bucket should use the EU-NORTH-1 locality. - - - - - Specifies that the S3 Bucket should use the EU-WEST-1 locality. - - - - - Specifies that the S3 Bucket should use the EU-WEST-2 locality. - - - - - Specifies that the S3 Bucket should use the EU-WEST-3 locality. - - - - - Specifies that the S3 Bucket should use the EU-CENTRAL-1 locality. - - - - - Specifies that the S3 Bucket should use US-WEST-1 locality. - - - - - Specifies that the S3 Bucket should use US-WEST-2 locality. - - - - - Specifies that the S3 Bucket should use US-GOV-EAST-1 locality. - - - - - Specifies that the S3 Bucket should use US-GOV-WEST-1 locality. - - - - - Specifies that the S3 Bucket should use the AP-EAST-1 locality. - - - - - Specifies that the S3 Bucket should use the AP-SOUTHEAST-1 locality. - - - - - Specifies that the S3 Bucket should use the AP-SOUTHEAST-2 locality. - - - - - Specifies that the S3 Bucket should use the AP-NORTHEAST-1 locality. - - - - - Specifies that the S3 Bucket should use the AP-NORTHEAST-2 locality. - - - - - Specifies that the S3 Bucket should use the AP-NORTHEAST-3 locality. - - - - - Specifies that the S3 Bucket should use the AP-SOUTH-1 locality. - - - - - Specifies that the S3 Bucket should use the SA-EAST-1 locality. - - - - - Specifies that the S3 Bucket should use CN-NORTH-1 locality. - - - - - Specifies that the S3 Bucket should use CN-NORTHWEST-1 locality. - - - - - Specifies that the S3 Bucket should use CA-CENTRAL-1 locality. - - - - - Specifies that the S3 Bucket should use US-WEST-1 locality. - - - - - Specifies that the S3 Bucket should use CN-NORTH-1 locality. - - - - - Specifies that the S3 Bucket should use US-GOV-WEST-1 locality. - - - - - Construct instance of S3Region. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to the S3Region class - - - - - - - A list of all ACL permissions. For more information, refer to - . - - - - - When applied to a bucket, grants permission to list the bucket. - When applied to an object, this grants permission to read the - object data and/or metadata. - - - - - When applied to a bucket, grants permission to create, overwrite, - and delete any object in the bucket. This permission is not - supported for objects. - - - - - Grants permission to read the ACL for the applicable bucket or object. - The owner of a bucket or object always has this permission implicitly. - - - - - Gives permission to overwrite the ACP for the applicable bucket or object. - The owner of a bucket or object always has this permission implicitly. - Granting this permission is equivalent to granting FULL_CONTROL because - the grant recipient can make any changes to the ACP. - - - - - Provides READ, WRITE, READ_ACP, and WRITE_ACP permissions. - It does not convey additional rights and is provided only for convenience. - - - - - Gives permission to restore an object that is currently stored in Amazon Glacier - for archival storage. - - - - - Construct S3Permission. - - - - - - Construct instance of S3Permission. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - - Gets and sets the HeaderName property. - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to an S3Permission - - - - - - - An enumeration of all Metadata directives that - can be used for the CopyObject operation. - - - - - Specifies that the metadata is copied from the source object. - - - - - Specifies that the metadata is replaced with metadata provided in the request. - All original metadata is replaced by the metadata you specify. - - - - - An enumeration of all protocols that the pre-signed - URL can be created against. - - - - - https protocol will be used in the pre-signed URL. - - - - - http protocol will be used in the pre-signed URL. - - - - - An enumeration of supported HTTP verbs - - - - - The GET HTTP verb. - - - - - The HEAD HTTP verb. - - - - - The PUT HTTP verb. - - - - - The DELETE HTTP verb. - - - - - S3 Storage Class Definitions - - - - - The STANDARD storage class, which is the default - storage class for S3. - - Durability 99.999999999%; Availability 99.99% over a given year. - - - - - REDUCED_REDUNDANCY provides the same availability as standard, but at a lower durability. - - Durability 99.99%; Availability 99.99% over a given year. - - - - - The GLACIER storage is for object that are stored in Amazon Glacier. - This storage class is for objects that are for archival purpose and - get operations are rare. - - Durability 99.999999999% - - - - - The STANDARD_IA storage is for infrequently accessed objects. - This storage class is for objects that are long-lived and less frequently accessed, - like backups and older data. - - Durability 99.999999999%; Availability 99.9% over a given year. - - - - - The ONEZONE_IA storage is for infrequently accessed objects. It is similiar to STANDARD_IA, but - only stores object data within one Availablity Zone in a given region. - - Durability 99.999999999%; Availability 99% over a given year. - - - - - IntelligentTiering makes it easy to lower your overall cost of storage by automatically placing data in the storage - class that best matches the access patterns for the storage. With IntelligentTiering, you don’t need to define - and manage individual policies for lifecycle data management or write code to transition objects - between storage classes. Instead, you can use IntelligentTiering to manage transitions between Standard and - S-IA without writing any application code. IntelligentTiering also manages transitions automatically to - Glacier for long term archive in addition to S3 storage classes. - - - - - S3 Glacier Deep Archive provides secure, durable object storage class for long term data archival. - It is the ideal storage class to make an archival, durable copy of data that rarely, if ever, needs to be accessed. - It can be used as an offline backup for their most important data assets and to meet long-term retention needs. - - - - - Construct an instance of S3StorageClass. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to S3StorageClass. - - - - - - - The constants for the known event names used by S3 notification. S3 might add new - events before the SDK is updated. In which case the names listed in the S3 documentation - will work as well as these constants. - - - - - An event that says an object has been lost in the reduced redundancy storage. - - - - - A list of all server-side encryption methods for customer provided encryption keys. - - - - - No server side encryption to be used. - - - - - Use AES 256 server side encryption. - - - - - Constructs an instance of ServerSideEncryptionCustomerMethod. - - - - - - Finds the constant for the unique value. - - - - - - - Converts string to ServerSideEncryptionCustomerMethod. - - - - - - - A list of all server-side encryption methods. - - - - - No server side encryption to be used. - - - - - Use AES 256 server side encryption. - - - - - Use AWS Key Management Service for server side encryption. - - - - - Construct instance of ServerSideEncryptionMethod. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to ServerSideEncryptionCustomerMethod. - - - - - - - A list of all grantee types. - - - - - The predefined group. - - - - - The email address of an AWS account - - - - - The canonical user ID of an AWS account - - - - - Construct an instance of GranteeType. - - - - - - Finds the constant for the unique value. - - - - - - - Convert a string to GranteeType. - - - - - - - A list of all lifecycle statuses. - - - - - The rule is enabled. - - - - - The rule is disabled. - - - - - Constructs an instance LifecycleRuleStatus. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to LifecycleRuleStatus. - - - - - - - A list of all version statuses. - - - - - The rule is off. - - - - - The rule is suspended. - - - - - The rule is enabled. - - - - - Construct an instance of VersionStatus. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to VersionStatus. - - - - - - - A list of all encoding types. - - - - - Url encoding. - - - - - Constructs intance of EncodingType - - - - - - Finds the constant for the unique value. - - - - - - - Converts string to EncodingType - - - - - - - The bucket event for which to send notifications. - - - - - The event encapsulates all the object create events - - - - - Event for put operations - - - - - Event for post operations - - - - - Event for copy operations - - - - - Event for completing a multi part upload - - - - - This event encapsulates all the object removed events - - - - - Event for object removed, delete operation. - - - - - Event for object removed, delete marker created operation. - - - - - Event for objects stored in reduced redundancy and S3 detects the object is lost - - - - - Event for all object restore - - - - - Event for restore post operations. - - - - - Event for when object restore is completed. - - - - - Event for replication of all - - - - - Event for operation failed replication - - - - - Evemt for replication operation not tracked - - - - - Event for replication operation missed threshold - - - - - Event for operation replicated after threshold - - - - - Constructs instance of EventType. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to EventType. - - - - - - - Compares if the ConstantClass instances are equals. - - - - - - - Compares if the ConstantClass instances are equals. This is ovewritten to handle the - discrepancy with S3 events coming from Lambda that don't have the prefix "s3:". - - - - - - - A list of all Inventory Formats. - - - - - CSV inventory format - - - - - ORC inventory format - - - - - Parquet inventory format - - - - - Construct instance of InventoryFormat. - - - - - - Finds the constant for the unique value. - - The string representation of the InventoryFormat. - The InventoryFormat object for that string. - - - - Convert string to InventoryFormat. - - - - - - - A list of inventory included object versions. - - - - - All Inventory Included Object Versions - - - - - Current Inventory Included Object Versions - - - - - Construct instance of InventoryIncludedObjectVersions. - - - - - - Finds the constant for the unique value. - - The string representation of the InventoryIncludedObjectVersions. - The InventoryIncludedObjectVersions object for that string. - - - - Convert string to InventoryIncludedObjectVersions. - - - - - - - A list of inventory frequencies. - - - - - Daily Inventory Frequency - - - - - Weekly Inventory Frequency - - - - - Construct instance of InventoryFrequency. - - - - - - Finds the constant for the unique value. - - The string representation of the InventoryFrequency. - The InventoryFrequency object for that string. - - - - Convert string to InventoryFrequency. - - - - - - - A list of inventory optional fields. - - - - - InventoryOptionalField for Size - - - - - InventoryOptionalField for LastModifiedDate - - - - - InventoryOptionalField for StorageClass - - - - - InventoryOptionalField for ETag - - - - - InventoryOptionalField for IsMultipartUploaded - - - - - InventoryOptionalField for ReplicationStatus - - - - - InventoryOptionalField for EncryptionStatus - - - - - InventoryOptionalField for ObjectLockRetainUntilDate - - - - - InventoryOptionalField for ObjectLockMode - - - - - InventoryOptionalField for ObjectLockLegalHoldStatus - - - - - InventoryOptionalField for IntelligentTieringAccessTier - - - - - Construct instance of InventoryOptionalField. - - - - - - Finds the constant for the unique value. - - The string representation of the InventoryOptionalField. - The InventoryIncludedObjectVersions object for that string. - - - - Convert string to InventoryOptionalField. - - - - - - - The status of the replication job associated with this source object. - - - - - The object is pending replication. - - - - - The object has been replicated. - - - - - The object was created as a result of replication. - - - - - The object replication has failed due to a customer-attributable reason, and the replication will not be attempted again. - - - - - Construct instance of ReplicationStatus. - - - - - - Finds the constant for the unique value. - - The string representation of the ReplicationStatus. - The ReplicationStatus object for that string. - - - - Convert string to ReplicationStatus. - - - - - - - Whether a replication rule is applied or ignored. - - - - - The rule will be applied. - - - - - The rule will be ignored. - - - - - Construct instance of ReplicationRuleStatus - - - - - - Finds the constant for the unique value. - - The string representation of the ReplicationRuleStatus. - The ReplicationRuleStatus object for that string. - - - - Convert string to ReplicationRuleStatus. - - - - - - - Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request. - - - - - The object tag-set is copied from the source object. - - - - - The object tag-set is replaced with tag-set provided in the request. - - - - - Construct instance of TaggingDirective - - - - - Finds the constant for the unique value. - - The string representation of the TaggingDirective. - The TaggingDirective object for that string. - - - - Convert string to TaggingDirective. - - - - - All enumerations type for retrieval tier for Glacier restore. - - - - - Standard Tier for Glacier restore. - - - - - Bulk Tier for Glacier restore. - - - - - Expedited Tier for Glacier restore. - - - - - Construct instance of RestoreObjectRequestGlacierJobTier - - - - - - Finds the constant for the unique value. - - The string representation of the RestoreObjectRequestGlacierJobTier. - The RestoreObjectRequestGlacierJobTier object for that string. - - - - Convert string to RestoreObjectRequestGlacierJobTier. - - - - - - - The version of the output schema to use when exporting data. - - - - - The schema output version V_1. - - - - - Construct instance of StorageClassAnalysisSchemaVersion - - - - - - Finds the constant for the unique value. - - The string representation of the StorageClassAnalysisSchemaVersion. - The StorageClassAnalysisSchemaVersion object for that string. - - - - Convert string to StorageClassAnalysisSchemaVersion. - - - - - - - Acknowledges that requester pays for the operation. - - - - - Requester pays for the operation. - - - - - Finds the RequestPayer instance for the string value. - - - - - Converts string to RequestPayer instance - - - - - The response from S3 that it confirms that requester pays. - - - - - S3 acknowledges that the requester pays. - - - - - Finds the RequestCharged instance for the string value - - - - - converts the string to RequestCharged instance - - - - - The override value for the owner of the replica object. - - - - - Overrides destination bucket's owner. - - - - - Finds the OwnerOverride instance for the string value - - - - - converts the string to OwnerOverride instance - - - - - The replication for KMS encrypted S3 objects is disabled if status is not Enabled. - - - - - The replication for KMS encrypted S3 objects is enabled. - - - - - The replication for KMS encrypted S3 objects is disabled. - - - - - - - - - - Finds the SseKmsEncryptedObjectsStatus instance for the string value - - - - - Converts the string to SseKmsEncryptedObjectsStatus instance - - - - - Specify how headers will be handled. - - - - - Headers will be usable in SELECT clause. - - - - - Headers will be skipped - - - - - No header is present. - - - - - Finds the FileHeaderInfo instance for the string value - - - - - - - Converts the string to FileHeaderInfo instance - - - - - Specifies whether existing object replication is enabled. - - - - - Enable the replication of existing objects - - - - - Disable the replication of existing objects - - - - - Finds the ExistingObjectReplicationStatus instance for the string value - - - - - - - Converts the string to ExistingObjectReplicationStatus instance - - - - - Describes when fields in output should be surrounded with quotes. - - - - - Specifies that fields in output should always be surrounded in quotes. - - - - - Specifies that fields in output should be surrounded in quotes as necessary. - - - - - Finds the QuoteFields instance for the string value - - string value that maps to QuoteFields enum - QuoteFields enum - - - - Converts the string to QuoteFields instance - - - - - Type of the expression provided in the Expression member. - - - - - SQL expression - - - - - Finds the ExpressionType instance for the string value - - string value that maps to ExpressionType enum - ExpressionType enum - - - - Converts the string to ExpressionType instance - - - - - Indicates what type of job is being initiated. - - - - - Finds the RestoreRequestType instance for the string value - - - - - Converts the string to RestoreRequestType instance - - - - - The type of JSON. - - - - - Finds the JsonType instance for the string value - - - - - Converts the string to JsonType instance - - - - - Specifies object's compression format. - - - - - Finds the CompressionType instance for the string value - - - - - Converts the string to CompressionType instance - - - - - The type of ObjectLockEnabled - - - - - Finds the ObjectLockEnabled instance for the string value - - - - - Converts the string to ObjectLockEnabled instance - - - - - The type of ObjectLockLegalHoldStatus - - - - - Finds the ObjectLockLegalHoldStatus instance for the string value - - - - - Converts the string to ObjectLockLegalHoldStatus instance - - - - - The type of ObjectLockRetentionMode - - - - - Finds the ObjectLockRetentionMode instance for the string value - - - - - Converts the string to ObjectLockRetentionMode instance - - - - - The type of ObjectLockMode - - - - - Finds the ObjectLockMode instance for the string value - - - - - Converts the string to ObjectLockMode instance - - - - - Specifies whether the replication time is enabled. - - - - - Replication time is enabled. - - - - - Replication time is disabled. - - - - - Finds the ReplicationTimeStatus instance for the string value - - - - - - - Converts the string to ReplicationTimeStatus instance - - - - - - Specifies whether the replication metrics are enabled. - - - - - Replication metrics are enabled. - - - - - Replication metrics are disabled. - - - - - Finds the MetricsStatus instance for the string value - - - - - - - Converts the string to MetricsStatus instance - - - - - - Uri wrapper that can parse out information (bucket, key, region, style) from an - S3 URI. - - - - - True if the URI contains the bucket in the path, false if it contains the bucket in the authority. - - - - - The bucket name parsed from the URI (or null if no bucket specified). - - - - - The key parsed from the URI (or null if no key specified). - - - - - The region parsed from the URI (or null if no region specified). - - - - - Constructs a parser for the S3 URI specified as a string. - - The S3 URI to be parsed. - - - - Constructs a parser for the S3 URI specified as a Uri instance. - - The S3 URI to be parsed. - - - - If the given string is an AmazonS3Endpoint return true and set the AmazonS3Uri out parameter. - - - - true if the string is an AmazonS3Endpoint, and the out paramter has been filled in, false otherwise - - - - If the given Uri is an AmazonS3Endpoint return true and set the AmazonS3Uri out parameter. - - - - true if the Uri is an AmazonS3Endpoint, and the out paramter has been filled in, false otherwise - - - - Checks whether the given URI is a Amazon S3 URI. - - The S3 URI to be checked. - true if the URI is a Amazon S3 URI, false; otherwise. - - - - Checks whether the given URI is a Amazon S3 URI. - - The S3 URI to be checked. - true if the URI is a Amazon S3 URI, false; otherwise. - - - - Percent-decodes the given string, with a fast path for strings that are not - percent-encoded. - - The string to decode - The decoded string - - - - Percent-decodes the given string. - - The string to decode - The index of the first '%' in the string - The decoded string - - - - Decodes the percent-encoded character at the given index in the string - and appends the decoded value to the string under construction. - - - The string under construction to which the decoded character will be - appended. - - The string being decoded. - The index of the '%' character in the string. - - - - Converts a hex character (0-9A-Fa-f) into its corresponding quad value. - - The hex character - The quad value - - - - Provides utilities used by the Amazon S3 client implementation. - These utilities might be useful to consumers of the Amazon S3 - library. - - - Provides utilities used by the Amazon S3 client implementation. - These utilities might be useful to consumers of the Amazon S3 - library. - - - Provides utilities used by the Amazon S3 client implementation. - These utilities might be useful to consumers of the Amazon S3 - library. - - - - - Determines MIME type from a file extension - - The extension of the file - The MIME type for the extension, or text/plain - - - - URL encodes a string. If the path property is specified, - the accepted path characters {/+:} are not encoded. - - The string to encode - Whether the string is a URL path or not - - - - - Converts a non-seekable stream into a System.IO.MemoryStream. - A MemoryStream's position can be moved arbitrarily - - The stream to be converted - A seekable MemoryStream - MemoryStreams use byte arrays as their backing store. - Please use this judicially as it is likely that a very large - stream will cause system resources to be used up. - - - - - Formats the current date as a GMT timestamp - - A GMT formatted string representation - of the current date and time - - - - - Generates an MD5 Digest for the string-based content - - The content for which the MD5 Digest needs - to be computed. - - Whether the returned checksum should be - base64 encoded. - - A string representation of the hash with or w/o base64 encoding - - - - - Only escape non-ascii characters in a string - - - - - - - Version2 S3 buckets adhere to RFC 1035: - - Less than 255 characters, with each label less than 63 characters. - Label must start with a letter - Label must end with a letter or digit - Label can have a string of letter, digits and hyphens in the middle. - Although names can be case-sensitive, no significance is attached to the case. - RFC 1123: Allow label to start with letter or digit (e.g. 3ware.com works) - RFC 2181: No restrictions apart from the length restrictions. - - S3 V2 will start with RFCs 1035 and 1123 and impose the following additional restrictions: - - Length between 3 and 63 characters (to allow headroom for upper-level domains, - as well as to avoid separate length restrictions for bucket-name and its labels - Only lower-case to avoid user confusion. - No dotted-decimal IPv4-like strings - - - The BucketName to validate if V2 addressing should be used - True if the BucketName should use V2 bucket addressing, false otherwise - - S3 v2 Bucket restrictions - - - - Determines whether an S3 bucket exists or not. - - The name of the bucket to check. - The Amazon S3 Client to use for S3 specific operations. - False is returned in case S3 responds with a NoSuchBucket error. - True is returned in case of success, AccessDenied error or PermanentRedirect error. - An exception is thrown in case of any other error. - This method calls GetACL for the bucket. - - - - Determines whether an S3 bucket exists or not. - This is done by: - 1. Creating a PreSigned Url for the bucket. To work with Signature V4 only regions, as - well as Signature V4-optional regions, we keep the expiry to within the maximum for V4 - (which is one week). - 2. Making a HEAD request to the Url - - The name of the bucket to check. - The Amazon S3 Client to use for S3 specific operations. - - - - - Deletes an S3 bucket which contains objects. - An S3 bucket which contains objects cannot be deleted until all the objects - in it are deleted. This method deletes all the objects in the specified - bucket and then deletes the bucket itself. - - The bucket to be deleted. - The Amazon S3 Client to use for S3 specific operations. - - - - Deletes an S3 bucket which contains objects. - An S3 bucket which contains objects cannot be deleted until all the objects - in it are deleted. This method deletes all the objects in the specified - bucket and then deletes the bucket itself. - - The bucket to be deleted. - The Amazon S3 Client to use for S3 specific operations. - Options to control the behavior of the delete operation. - - - - Initiates the asynchronous execution of the DeleteS3BucketWithObjects operation. - DeleteS3BucketWithObjects deletes an S3 bucket which contains objects. - An S3 bucket which contains objects cannot be deleted until all the objects - in it are deleted. This method deletes all the objects in the specified - bucket and then deletes the bucket itself. - - The bucket to be deleted. - The Amazon S3 Client to use for S3 specific operations. - token to check if the operation has been request to cancel. - An IAsyncCancelableResult that can be used to poll or wait for results, or both; - this value is also needed when invoking EndDeleteS3BucketWithObjects. IAsyncCancelableResult can also - be used to cancel the operation while it's in progress. - - - - Initiates the asynchronous execution of the DeleteS3BucketWithObjects operation. - DeleteS3BucketWithObjects deletes an S3 bucket which contains objects. - An S3 bucket which contains objects cannot be deleted until all the objects - in it are deleted. This method deletes all the objects in the specified - bucket and then deletes the bucket itself. - - The bucket to be deleted. - The Amazon S3 Client to use for S3 specific operations. - Options to control the behavior of the delete operation. - token to check if the operation has been request to cancel. - An IAsyncCancelableResult that can be used to poll or wait for results, or both; - this value is also needed when invoking EndDeleteS3BucketWithObjects. IAsyncCancelableResult can also - be used to cancel the operation while it's in progress. - - - - Initiates the asynchronous execution of the DeleteS3BucketWithObjects operation. - DeleteS3BucketWithObjects deletes an S3 bucket which contains objects. - An S3 bucket which contains objects cannot be deleted until all the objects - in it are deleted. This method deletes all the objects in the specified - bucket and then deletes the bucket itself. - - The bucket to be deleted. - The Amazon S3 Client to use for S3 specific operations. - >Options to control the behavior of the delete operation. - An callback that is invoked to send updates while delete operation is in progress. - token to check if the operation has been request to cancel. - An IAsyncCancelableResult that can be used to poll or wait for results, or both; - this value is also needed when invoking EndDeleteS3BucketWithObjects. IAsyncCancelableResult can also - be used to cancel the operation while it's in progress. - - - - Invokes the DeleteS3BucketWithObjectsInternal method. - - The Request object that has all the data to complete the operation. - token to request the operation to be cancelled. - - - - Deletes an S3 bucket which contains objects. - An S3 bucket which contains objects cannot be deleted until all the objects - in it are deleted. The function deletes all the objects in the specified - bucket and then deletes the bucket itself. - - The bucket to be deleted. - The Amazon S3 Client to use for S3 specific operations. - Options to control the behavior of the delete operation. - The callback which is used to send updates about the delete operation. - token to check if the operation has been request to cancel. - - - - Invokes the callback which provides updated about the delete operation. - - The callback to be invoked. - The data being passed to the callback. - 8 - - - - Determines whether an S3 bucket exists or not. - - The name of the bucket to check. - The Amazon S3 Client to use for S3 specific operations. - False is returned in case S3 responds with a NoSuchBucket error. - True is returned in case of success, AccessDenied error or PermanentRedirect error. - An exception is thrown in case of any other error. - This method calls GetACL for the bucket. - - - - Determines whether an S3 bucket exists or not. - This is done by: - 1. Creating a PreSigned Url for the bucket. To work with Signature V4 only regions, as - well as Signature V4-optional regions, we keep the expiry to within the maximum for V4 - (which is one week). - 2. Making a HEAD request to the Url - - The name of the bucket to check. - The Amazon S3 Client to use for S3 specific operations. - - - - - Sets the storage class for the S3 Object to the value - specified. - - The name of the bucket in which the key is stored - The key of the S3 Object whose storage class needs changing - The new Storage Class for the object - The Amazon S3 Client to use for S3 specific operations. - - - - - Sets the storage class for the S3 Object's Version to the value - specified. - - The name of the bucket in which the key is stored - The key of the S3 Object whose storage class needs changing - The version of the S3 Object whose storage class needs changing - The new Storage Class for the object - The Amazon S3 Client to use for S3 specific operations. - - - - - Sets the server side encryption method for the S3 Object to the value - specified. - - The name of the bucket in which the key is stored - The key of the S3 Object - The server side encryption method - The Amazon S3 Client to use for S3 specific operations. - - - - Sets the server side encryption method for the S3 Object's Version to the value - specified. - - The name of the bucket in which the key is stored - The key of the S3 Object - The version of the S3 Object - The server side encryption method - The Amazon S3 Client to use for S3 specific operations. - - - - Sets the redirect location for the S3 Object's when being accessed through the S3 website endpoint. - - The name of the bucket in which the key is stored - The key of the S3 Object - The redirect location - The Amazon S3 Client to use for S3 specific operations. - - - - Sets up the request needed to make an exact copy of the object leaving the parent method - the ability to change just the attribute being requested to change. - - - - - - - - - - - Converts the string representing a storage class that would come back from a ListObjects request - to the S3StorageClass enumeration. - - Amazon S3 string values for storage class - The converted S3StorageClass enumeration - - - - Upload data to Amazon S3 using HTTP POST. - - - For more information, - - Request object which describes the data to POST - Thrown if the service returns an error - - - - Deletes an S3 bucket which contains objects. - An S3 bucket which contains objects cannot be deleted until all the objects - in it are deleted. This method deletes all the objects in the specified - bucket and then deletes the bucket itself. - - The bucket to be deleted. - The Amazon S3 Client to use for S3 specific operations. - - - - Deletes an S3 bucket which contains objects. - An S3 bucket which contains objects cannot be deleted until all the objects - in it are deleted. This method deletes all the objects in the specified - bucket and then deletes the bucket itself. - - The bucket to be deleted. - The Amazon S3 Client to use for S3 specific operations. - Options to control the behavior of the delete operation. - - - - Class to manage and cache the correct region for buckets accessed without an explicit region. - - - Class to manage and cache the correct region for buckets accessed without an explicit region. - - - Class to manage and cache the correct region for buckets accessed without an explicit region. - - - - - A cache of BucketName -> RegionEndpoint pairs. - The cache is used to make sure that bucket requests are signed for the correct region, - even when requesting them without an explicit region. - - - - - Detect a bucket region mismatch based on the x-amz-bucket-region header, and the status code provided. - - - - - - - - - Detects if the signature is malformed, and the requested bucket is in a Region - different from the Region of the request. - - - - the correct region if a mismatch was detected, null otherwise - - - - Detects if the signature is malformed, and the requested bucket is in a Region - different from the Region of the request. - - - - - the correct region if a mismatch was detected, null otherwise - - - - Use a HEAD bucket request to get the region for the given bucket. - - This method creates an AmazonS3Client from the credentials passed in. - It's critical that the AmazonS3Client is not used to make any requests that will - be routed through the pipeline. - - - - the value of the x-amz-bucket-region header from the response - - - - Detects if the signature is malformed, and the requested bucket is in a Region - different from the Region of the request. - - - - - the correct region if a mismatch was detected, null otherwise - - - - Use a HEAD bucket request to get the region for the given bucket. - - This method creates an AmazonS3Client from the credentials passed in. - It's critical that the AmazonS3Client is not used to make any requests that will - be routed through the pipeline. - - - - the value of the x-amz-bucket-region header from the response - - - - A helper class that represents a strongly typed S3 EventNotification item sent to SQS - - - - - Parse the JSON string into a S3EventNotification object. - - The function will try its best to parse input JSON string as best as it can. - It will not fail even if the JSON string contains unknown properties. - - For any parsing errors - - - - - Gets and sets the records for the S3 event notification - - - - - The class holds the user identity properties. - - - - - Gets and sets the PrincipalId property. - - - - - This class contains the identity information for an S3 bucket. - - - - - Gets and sets the name of the bucket. - - - - - Gets and sets the bucket owner id. - - - - - Gets and sets the S3 bucket arn. - - - - - This class contains the information for an object in S3. - - - - - Gets and sets the key for the object stored in S3. - - - - - Gets and sets the size of the object in S3. - - - - - Gets and sets the etag of the object. This can be used to determine if the object has changed. - - - - - Gets and sets the version id of the object in S3. - - - - - Gets and sets the sequencer a string representation of a hexadecimal value used to determine event sequence, only used with PUTs and DELETEs. - - - - - Gets and sets the meta information describing S3. - - - - - Gets and sets the ConfigurationId. This ID can be found in the bucket notification configuration. - - - - - Gets and sets the Bucket property. - - - - - Gets and sets the Object property. - - - - - Gets and sets the S3SchemaVersion property. - - - - - The class holds the request parameters - - - - - Gets and sets the SourceIPAddress. This is the ip address where the request came from. - - - - - This class holds the response elements. - - - - - Gets and sets the XAmzId2 Property. This is the Amazon S3 host that processed the request. - - - - - Gets and sets the XAmzRequestId. This is the Amazon S3 generated request ID. - - - - - The class holds the glacier event data elements. - - - - - Gets and sets the RestoreEventData property. - - - - - The class holds the restore event data elements. - - - - - Gets and sets the LifecycleRestorationExpiryTime the time when the object restoration will be expired. - - - - - Gets and sets the LifecycleRestoreStorageClass the source storage class for restore. - - - - - The class holds the event notification. - - - - - Gets and sets the AwsRegion property. - - - - - Gets and sets the EventName property. This identities what type of event occurred. - For example for an object just put in S3 this will be set to EventType.ObjectCreatedPut. - - - - - Gets and sets the EventSource property. - - - - - Gets and sets the EventType property. The time when S3 finished processing the request. - - - - - Gets and sets the EventVersion property. - - - - - Gets and sets the RequestParameters property. - - - - - Gets and sets the ResponseElements property. - - - - - Gets and sets the S3 property. - - - - - Gets and sets the UserIdentity property. - - - - - Get and sets the GlacierEventData property. - - - - - Options which control the behaviour of the DeleteS3BucketWithObjects operation. - - - - - Gets or sets a value which indicates whether the - operation should be aborted if an error is encountered during execution. - - - - - Gets or sets a value which indicated whether verbose results shoule be returned to the - callback. - If quiet mode is true the callback will receive only keys where the delete operation encountered an error. - If quiet mode is false the callback will receive keys for both successful and unsuccessful delete operations. - - - - - Internal class used to pass the parameters for DeleteS3BucketWithObjects operation. - - - Internal class used to pass the parameters for DeleteS3BucketWithObjects operation. - - - - - Name of the bucket to be deleted. - - - - - The Amazon S3 Client to use for S3 specific operations. - - - - - Options to control the behavior of the delete operation. - - - - - The callback which is used to send updates about the delete operation. - - - - - Contains updates from DeleteS3BucketWithObjects operation. - - - - - The list of objects which were successfully deleted. - - - - - The list of objects for which the delete operation failed. - - - - - Represents the status of an asynchronous operation. - It adds support for Cancelation of the asynchronous operation. - - - - - Gets a value that indicated whether the asynchronous operation has been canceled. - - - - - Gets a user-defined object that qualifies or contains information about an - asynchronous operation. - - - - - Gets a System.Threading.WaitHandle that is used to wait for an asynchronous - operation to complete. - - - - - Gets a value that indicates whether the asynchronous operation completed - synchronously. - - - - - Gets a value that indicates whether the asynchronous operation has completed. - - - - - Gets a value that indicates whether a cancel is requested. - - - - - The last exception that when the asynchronous operation was executed. - This is used to capture the exception and re-throw it when EndOperation is called. - - - - - The callback to be invoked when the asynchronous operation is completed. - - - - - Constructor for AsyncCancelableResult. - - The callback to be invoked when the asynchronous operation is completed. - Gets a user-defined object that qualifies or contains information about an - asynchronous operation. - - - - - Cancels the asynchronous operation if it's in progress. - - - - - Signals that the operaton is canceled and invokes the callback. - - - - - Signals that the operation is completed and invoked the callback. - - - - - Performs application-defined tasks associated with freeing, releasing, or - resetting unmanaged resources. - - - - - Disposes any managed and unmanaged resources. - - Should pass true if called by Dispose(), pass false if - called during finalization. - - - - Represents the status of an asynchronous operation. This interface extends - IAsyncResult and adds support for Cancelation of the asynchronous operation. - - - - - Cancels the asynchronous operation if it's in progress. - - - - - Gets a value that indicated whether the asynchronous operation has been canceled. - - - - - An exception detailing a failed HTTP POST upload atempt to Amazon S3. - - - - - Initializes a new instance of S3PostUploadException with a specified error message - - The error message - - - - Initializes a new instance of S3PostUploadException with a specified error code and error message - - The error code - The error message - - - - The error code returned by S3 - - - - - The S3 request id - - - - - The S3 host id - - - - - The HTTP error status code returned by S3 - - - - - Additional information about the error - - - Some errors are accompanied by more specific information, which vary from error to error - - - - - Parse an S3 Error response and create an S3PostUploadException - - The response from S3 - An S3PostUploadException with the information from the response - - - - Constructs a new instance of the S3PostUploadException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - Class for unmarshalling response XML - - - - - Gets and sets the ErrorCode property. - - - - - Gets and sets the ErrorMessage property. - - - - - Gets and sets the RequestId property. - - - - - Gets and sets the HostId property. - - - - - Gets and sets the elements property. - - - - - Parameters for uploading to Amazon S3 a file using HTTP POS - - - - If a S3PostUploadSignedPolicy is assigned, then values set (other than InputStream or Path) on this object must adhere to the policy. - This includes metadata. If metadata is specified in the policy, then it must be included in the request. Adding metadata not in the - policy will cause the POST to fail. - - For more information, - - - - - - Default constructor. - - - - - S3 Bucket to upload the object to - - - - - The name of the uploaded key. - - - - - Stream to read the upload data for - - - If you use InputStream, then you also need to set ContentLength - - - - - File path to read the upload data from - - - - - Content type for the uploaded data - - - If this is not set, an attempt will be made to infer it from the extension on Key or Path (in that order), - otherwise 'application/octet-stream' will be assumed. - - - - - Specifies an Amazon S3 access control list - - - - - Signed policy from bucket owner. - - - - - Where to redirect browsers on a successful upload - - - - - The status code returned to the client upon successful upload if success_action_redirect is not specified - - - - Accepts the values OK (200) , Created (201), or NoContent (204, default). - - If the value is set to OK or NoContent, Amazon S3 returns an empty document with a 200 or 204 status code. - - If the value is set to Created, Amazon S3 returns an XML document with a 201 status code. - - If the value is not set or if it is set to an invalid value, Amazon S3 returns an empty document with a 204 status code. - - - - - - Storage class to use for storing the object - - - Default: STANDARD - - - - - The AWS region where the bucket is located. - - - Depending upon the bucket name, POST uploads will be - successfully redirected, but for buckets with non-DNS-compliant - characters, redirects will fail. Setting this to the appropriate - region will avoid the redirect. - - - - - Metadata to set on the uploaded object - - - If keys do not begin with 'x-amz-meta-' it will be added at POST time. - - - - - Write the multipart/form-data for this request for all fields except the file data to a stream - - - - - Class holds Response data for a post upload. - - - - - Gets and sets the StatusCode property. - - - - - Gets and sets the RequestId property. - - - - - Gets and sets the HostId property. - - - - - Gets and sets the CloudFront request ID. - - - - - Utility class for managing and exchanging HTTP POST uploads of objects to Amazon S3. - - - - This object supports creating, marshalling, and unmarshalling of the information needed to build - an authenticated HTTP POST request to S3 for uploading objects according to a policy. - - For more information, - - - - - Given a policy and AWS credentials, produce a S3PostUploadSignedPolicy. - - JSON string representing the policy to sign - Credentials to sign the policy with - A signed policy object for use with an S3PostUploadRequest. - - - - Given a policy and AWS credentials, produce a S3PostUploadSignedPolicy. - - JSON string representing the policy to sign - Credentials to sign the policy with - Service region endpoint. - A signed policy object for use with an S3PostUploadRequest. - - - - The policy document which governs what uploads can be done. - - - - - The signature for the policy. - - - - - The AWS Access Key Id for the credential pair that produced the signature. - - - - - The security token from session or instance credentials. - - - - - The signature version usedd. Either "2" or "4". - - - - - The signing algorithm used. Required as a field in the post Amazon - S3 can re-calculate the signature. - - - - - The date value in ISO8601 format. It is the same date used in - creating the signing key. - - - - - In addition to the access key ID, this provides scope information - used in calculating the signing key for signature calculation. - - - - - Get the policy document as a human readable string. - - Human readable policy document. - - - - JSON representation of this object - - JSON string - - - - XML Representation of this object - - XML String - - - - Create an instance of this class from a JSON string. - - JSON string - Instance of S3PostUploadSignedPolicy - - - - Create an instance of this class from an XML string. - - XML string generated by ToXml() - Instance of S3PostUploadSignedPolicy - - - - Interface for accessing S3 - - - - - - - Create a signed URL allowing access to a resource that would - usually require authentication. - - - - When using query string authentication you create a query, - specify an expiration time for the query, sign it with your - signature, place the data in an HTTP request, and distribute - the request to a user or embed the request in a web page. - - - A PreSigned URL can be generated for GET, PUT, DELETE and HEAD - operations on your bucketName, keys, and versions. - - - The GetPreSignedUrlRequest that defines the - parameters of the operation. - A string that is the signed http request. - - - - - - This operation aborts a multipart upload. After a multipart upload is aborted, no - additional parts can be uploaded using that upload ID. The storage consumed by any - previously uploaded parts will be freed. However, if any part uploads are currently - in progress, those part uploads might or might not succeed. As a result, it might - be necessary to abort a given multipart upload multiple times in order to completely - free all storage consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts operation and ensure that the parts - list is empty. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - The bucket name to which the upload was taking place. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object for which the multipart upload was initiated. - Upload ID that identifies the multipart upload. - - The response from the AbortMultipartUpload service method, as returned by S3. - REST API Reference for AbortMultipartUpload Operation - - - - This operation aborts a multipart upload. After a multipart upload is aborted, no - additional parts can be uploaded using that upload ID. The storage consumed by any - previously uploaded parts will be freed. However, if any part uploads are currently - in progress, those part uploads might or might not succeed. As a result, it might - be necessary to abort a given multipart upload multiple times in order to completely - free all storage consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts operation and ensure that the parts - list is empty. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - Container for the necessary parameters to execute the AbortMultipartUpload service method. - - The response from the AbortMultipartUpload service method, as returned by S3. - REST API Reference for AbortMultipartUpload Operation - - - - This operation aborts a multipart upload. After a multipart upload is aborted, no - additional parts can be uploaded using that upload ID. The storage consumed by any - previously uploaded parts will be freed. However, if any part uploads are currently - in progress, those part uploads might or might not succeed. As a result, it might - be necessary to abort a given multipart upload multiple times in order to completely - free all storage consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts operation and ensure that the parts - list is empty. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - The bucket name to which the upload was taking place. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object for which the multipart upload was initiated. - Upload ID that identifies the multipart upload. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AbortMultipartUpload service method, as returned by S3. - REST API Reference for AbortMultipartUpload Operation - - - - This operation aborts a multipart upload. After a multipart upload is aborted, no - additional parts can be uploaded using that upload ID. The storage consumed by any - previously uploaded parts will be freed. However, if any part uploads are currently - in progress, those part uploads might or might not succeed. As a result, it might - be necessary to abort a given multipart upload multiple times in order to completely - free all storage consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts operation and ensure that the parts - list is empty. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - Container for the necessary parameters to execute the AbortMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AbortMultipartUpload service method, as returned by S3. - REST API Reference for AbortMultipartUpload Operation - - - - Completes a multipart upload by assembling previously uploaded parts. - - - - You first initiate the multipart upload and then upload all parts using the UploadPart - operation. After successfully uploading all relevant parts of an upload, you call - this operation to complete the upload. Upon receiving this request, Amazon S3 concatenates - all the parts in ascending order by part number to create a new object. In the Complete - Multipart Upload request, you must provide the parts list. You must ensure that the - parts list is complete. This operation concatenates the parts that you provide in - the list. For each part in the list, you must provide the part number and the ETag - value, returned after that part was uploaded. - - - - Processing of a Complete Multipart Upload request could take several minutes to complete. - After Amazon S3 begins processing the request, it sends an HTTP response header that - specifies a 200 OK response. While processing is in progress, Amazon S3 periodically - sends white space characters to keep the connection from timing out. Because a request - could fail after the initial 200 OK response has been sent, it is important that you - check the response body to determine whether the request succeeded. - - - - Note that if CompleteMultipartUpload fails, applications should be prepared - to retry the failed requests. For more information, see Amazon - S3 Error Best Practices. - - - - For more information about multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - GetBucketLifecycle has the following special errors: - -
  • - - Error code: EntityTooSmall - -
    • - - Description: Your proposed upload is smaller than the minimum allowed object size. - Each part must be at least 5 MB in size, except the last part. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPart - -
    • - - Description: One or more of the specified parts could not be found. The part might - not have been uploaded, or the specified entity tag might not have matched the part's - entity tag. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPartOrder - -
    • - - Description: The list of parts was not in ascending order. The parts list must be - specified in order by part number. - -
    • - - 400 Bad Request - -
  • - - Error code: NoSuchUpload - -
    • - - Description: The specified multipart upload does not exist. The upload ID might be - invalid, or the multipart upload might have been aborted or completed. - -
    • - - 404 Not Found - -
- - The following operations are related to CompleteMultipartUpload: - - - - Container for the necessary parameters to execute the CompleteMultipartUpload service method. - - The response from the CompleteMultipartUpload service method, as returned by S3. - REST API Reference for CompleteMultipartUpload Operation - - - - Completes a multipart upload by assembling previously uploaded parts. - - - - You first initiate the multipart upload and then upload all parts using the UploadPart - operation. After successfully uploading all relevant parts of an upload, you call - this operation to complete the upload. Upon receiving this request, Amazon S3 concatenates - all the parts in ascending order by part number to create a new object. In the Complete - Multipart Upload request, you must provide the parts list. You must ensure that the - parts list is complete. This operation concatenates the parts that you provide in - the list. For each part in the list, you must provide the part number and the ETag - value, returned after that part was uploaded. - - - - Processing of a Complete Multipart Upload request could take several minutes to complete. - After Amazon S3 begins processing the request, it sends an HTTP response header that - specifies a 200 OK response. While processing is in progress, Amazon S3 periodically - sends white space characters to keep the connection from timing out. Because a request - could fail after the initial 200 OK response has been sent, it is important that you - check the response body to determine whether the request succeeded. - - - - Note that if CompleteMultipartUpload fails, applications should be prepared - to retry the failed requests. For more information, see Amazon - S3 Error Best Practices. - - - - For more information about multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - GetBucketLifecycle has the following special errors: - -
  • - - Error code: EntityTooSmall - -
    • - - Description: Your proposed upload is smaller than the minimum allowed object size. - Each part must be at least 5 MB in size, except the last part. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPart - -
    • - - Description: One or more of the specified parts could not be found. The part might - not have been uploaded, or the specified entity tag might not have matched the part's - entity tag. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPartOrder - -
    • - - Description: The list of parts was not in ascending order. The parts list must be - specified in order by part number. - -
    • - - 400 Bad Request - -
  • - - Error code: NoSuchUpload - -
    • - - Description: The specified multipart upload does not exist. The upload ID might be - invalid, or the multipart upload might have been aborted or completed. - -
    • - - 404 Not Found - -
- - The following operations are related to CompleteMultipartUpload: - - - - Container for the necessary parameters to execute the CompleteMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CompleteMultipartUpload service method, as returned by S3. - REST API Reference for CompleteMultipartUpload Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 Developer Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Encryption - - - - The source object that you are copying can be encrypted or unencrypted. The source - object can be encrypted with server-side encryption using AWS managed encryption keys - (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side - encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers - and decrypts the data when you access it. - - - - You can optionally use the appropriate encryption-related headers to request server-side - encryption for the target object. You have the option to provide your own encryption - key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that - was used to encrypt the source object. You can even request encryption if the source - object was not encrypted. For more information about server-side encryption, see Using - Server-Side Encryption. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject operation to change the storage class of an - object that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 Service Developer Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 Developer Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Encryption - - - - The source object that you are copying can be encrypted or unencrypted. The source - object can be encrypted with server-side encryption using AWS managed encryption keys - (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side - encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers - and decrypts the data when you access it. - - - - You can optionally use the appropriate encryption-related headers to request server-side - encryption for the target object. You have the option to provide your own encryption - key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that - was used to encrypt the source object. You can even request encryption if the source - object was not encrypted. For more information about server-side encryption, see Using - Server-Side Encryption. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject operation to change the storage class of an - object that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 Service Developer Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 Developer Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Encryption - - - - The source object that you are copying can be encrypted or unencrypted. The source - object can be encrypted with server-side encryption using AWS managed encryption keys - (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side - encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers - and decrypts the data when you access it. - - - - You can optionally use the appropriate encryption-related headers to request server-side - encryption for the target object. You have the option to provide your own encryption - key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that - was used to encrypt the source object. You can even request encryption if the source - object was not encrypted. For more information about server-side encryption, see Using - Server-Side Encryption. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject operation to change the storage class of an - object that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 Service Developer Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - Container for the necessary parameters to execute the CopyObject service method. - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 Developer Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Encryption - - - - The source object that you are copying can be encrypted or unencrypted. The source - object can be encrypted with server-side encryption using AWS managed encryption keys - (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side - encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers - and decrypts the data when you access it. - - - - You can optionally use the appropriate encryption-related headers to request server-side - encryption for the target object. You have the option to provide your own encryption - key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that - was used to encrypt the source object. You can even request encryption if the source - object was not encrypted. For more information about server-side encryption, see Using - Server-Side Encryption. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject operation to change the storage class of an - object that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 Service Developer Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 Developer Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Encryption - - - - The source object that you are copying can be encrypted or unencrypted. The source - object can be encrypted with server-side encryption using AWS managed encryption keys - (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side - encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers - and decrypts the data when you access it. - - - - You can optionally use the appropriate encryption-related headers to request server-side - encryption for the target object. You have the option to provide your own encryption - key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that - was used to encrypt the source object. You can even request encryption if the source - object was not encrypted. For more information about server-side encryption, see Using - Server-Side Encryption. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject operation to change the storage class of an - object that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 Service Developer Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 Developer Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Encryption - - - - The source object that you are copying can be encrypted or unencrypted. The source - object can be encrypted with server-side encryption using AWS managed encryption keys - (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side - encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers - and decrypts the data when you access it. - - - - You can optionally use the appropriate encryption-related headers to request server-side - encryption for the target object. You have the option to provide your own encryption - key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that - was used to encrypt the source object. You can even request encryption if the source - object was not encrypted. For more information about server-side encryption, see Using - Server-Side Encryption. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject operation to change the storage class of an - object that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 Service Developer Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - Container for the necessary parameters to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - - - - - - - - - - - Deletes an analytics configuration for the bucket (specified by the analytics configuration - ID). - - - - To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to DeleteBucketAnalyticsConfiguration: - -
  • - - - -
  • - - - -
  • - - - -
- - Container for the necessary parameters to execute the DeleteBucketAnalyticsConfiguration service method. - - The response from the DeleteBucketAnalyticsConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketAnalyticsConfiguration Operation - - - - Deletes an analytics configuration for the bucket (specified by the analytics configuration - ID). - - - - To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to DeleteBucketAnalyticsConfiguration: - -
  • - - - -
  • - - - -
  • - - - -
- - Container for the necessary parameters to execute the DeleteBucketAnalyticsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketAnalyticsConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketAnalyticsConfiguration Operation - - - - - - Deletes an inventory configuration (identified by the inventory ID) from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - Operations related to DeleteBucketInventoryConfiguration include: - - - - Container for the necessary parameters to execute the DeleteBucketInventoryConfiguration service method. - - The response from the DeleteBucketInventoryConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketInventoryConfiguration Operation - - - - Deletes an inventory configuration (identified by the inventory ID) from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - Operations related to DeleteBucketInventoryConfiguration include: - - - - Container for the necessary parameters to execute the DeleteBucketInventoryConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketInventoryConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketInventoryConfiguration Operation - - - - Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified - by the metrics configuration ID) from the bucket. Note that this doesn't include the - daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteBucketMetricsConfiguration service method. - - The response from the DeleteBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketMetricsConfiguration Operation - - - - Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified - by the metrics configuration ID) from the bucket. Note that this doesn't include the - daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketMetricsConfiguration Operation - - - - This implementation of the DELETE operation uses the policy subresource to delete - the policy of a specified bucket. If you are using an identity other than the root - user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - The bucket name. - - The response from the DeleteBucketPolicy service method, as returned by S3. - REST API Reference for DeleteBucketPolicy Operation - - - - This implementation of the DELETE operation uses the policy subresource to delete - the policy of a specified bucket. If you are using an identity other than the root - user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - Container for the necessary parameters to execute the DeleteBucketPolicy service method. - - The response from the DeleteBucketPolicy service method, as returned by S3. - REST API Reference for DeleteBucketPolicy Operation - - - - This implementation of the DELETE operation uses the policy subresource to delete - the policy of a specified bucket. If you are using an identity other than the root - user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - The bucket name. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketPolicy service method, as returned by S3. - REST API Reference for DeleteBucketPolicy Operation - - - - This implementation of the DELETE operation uses the policy subresource to delete - the policy of a specified bucket. If you are using an identity other than the root - user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - Container for the necessary parameters to execute the DeleteBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketPolicy service method, as returned by S3. - REST API Reference for DeleteBucketPolicy Operation - - - - Deletes the replication configuration from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutReplicationConfiguration - action. The bucket owner has these permissions by default and can grant it to others. - For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - It can take a while for the deletion of a replication configuration to fully propagate. - - - - For information about replication configuration, see Replication - in the Amazon S3 Developer Guide. - - - - The following operations are related to DeleteBucketReplication: - - - - Container for the necessary parameters to execute the DeleteBucketReplication service method. - - The response from the DeleteBucketReplication service method, as returned by S3. - REST API Reference for DeleteBucketReplication Operation - - - - Deletes the replication configuration from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutReplicationConfiguration - action. The bucket owner has these permissions by default and can grant it to others. - For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - It can take a while for the deletion of a replication configuration to fully propagate. - - - - For information about replication configuration, see Replication - in the Amazon S3 Developer Guide. - - - - The following operations are related to DeleteBucketReplication: - - - - Container for the necessary parameters to execute the DeleteBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketReplication service method, as returned by S3. - REST API Reference for DeleteBucketReplication Operation - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - The bucket that has the tag set to be removed. - - The response from the DeleteBucketTagging service method, as returned by S3. - REST API Reference for DeleteBucketTagging Operation - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - Container for the necessary parameters to execute the DeleteBucketTagging service method. - - The response from the DeleteBucketTagging service method, as returned by S3. - REST API Reference for DeleteBucketTagging Operation - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - The bucket that has the tag set to be removed. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketTagging service method, as returned by S3. - REST API Reference for DeleteBucketTagging Operation - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - Container for the necessary parameters to execute the DeleteBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketTagging service method, as returned by S3. - REST API Reference for DeleteBucketTagging Operation - - - - This operation removes the website configuration for a bucket. Amazon S3 returns a - 200 OK response upon successfully deleting a website configuration on - the specified bucket. You will get a 200 OK response if the website configuration - you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE operation requires the S3:DeleteBucketWebsite permission. - By default, only the bucket owner can delete the website configuration attached to - a bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which you want to remove the website configuration. - - The response from the DeleteBucketWebsite service method, as returned by S3. - REST API Reference for DeleteBucketWebsite Operation - - - - This operation removes the website configuration for a bucket. Amazon S3 returns a - 200 OK response upon successfully deleting a website configuration on - the specified bucket. You will get a 200 OK response if the website configuration - you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE operation requires the S3:DeleteBucketWebsite permission. - By default, only the bucket owner can delete the website configuration attached to - a bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the DeleteBucketWebsite service method. - - The response from the DeleteBucketWebsite service method, as returned by S3. - REST API Reference for DeleteBucketWebsite Operation - - - - This operation removes the website configuration for a bucket. Amazon S3 returns a - 200 OK response upon successfully deleting a website configuration on - the specified bucket. You will get a 200 OK response if the website configuration - you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE operation requires the S3:DeleteBucketWebsite permission. - By default, only the bucket owner can delete the website configuration attached to - a bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which you want to remove the website configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketWebsite service method, as returned by S3. - REST API Reference for DeleteBucketWebsite Operation - - - - This operation removes the website configuration for a bucket. Amazon S3 returns a - 200 OK response upon successfully deleting a website configuration on - the specified bucket. You will get a 200 OK response if the website configuration - you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE operation requires the S3:DeleteBucketWebsite permission. - By default, only the bucket owner can delete the website configuration attached to - a bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the DeleteBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketWebsite service method, as returned by S3. - REST API Reference for DeleteBucketWebsite Operation - - - - - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - The bucket name of the lifecycle to delete. - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - REST API Reference for DeleteLifecycleConfiguration Operation - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - Container for the necessary parameters to execute the DeleteLifecycleConfiguration service method. - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - REST API Reference for DeleteLifecycleConfiguration Operation - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - The bucket name of the lifecycle to delete. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - REST API Reference for DeleteLifecycleConfiguration Operation - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - Container for the necessary parameters to execute the DeleteLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - REST API Reference for DeleteLifecycleConfiguration Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key name of the object to delete. - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key name of the object to delete. - VersionId used to reference a specific version of the object. - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - Container for the necessary parameters to execute the DeleteObject service method. - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key name of the object to delete. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key name of the object to delete. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - Container for the necessary parameters to execute the DeleteObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - This operation enables you to delete multiple objects from a bucket using a single - HTTP request. If you know the object keys that you want to delete, then this operation - provides a suitable alternative to sending individual delete requests, reducing per-request - overhead. - - - - The request contains a list of up to 1000 keys that you want to delete. In the XML, - you provide the object key names, and optionally, version IDs if you want to delete - a specific version of the object from a versioning-enabled bucket. For each key, Amazon - S3 performs a delete operation and returns the result of that delete, success, or - failure, in the response. Note that if the object specified in the request is not - found, Amazon S3 returns the result as deleted. - - - - The operation supports two modes for the response: verbose and quiet. By default, - the operation uses verbose mode in which the response includes the result of deletion - of each key in your request. In quiet mode the response includes only keys where the - delete operation encountered an error. For a successful deletion, the operation does - not return any information about the delete in the response body. - - - - When performing this operation on an MFA Delete enabled bucket, that attempts to delete - any versioned objects, you must include an MFA token. If you do not provide one, the - entire request will fail, even if there are non-versioned objects you are trying to - delete. If you provide an invalid token, whether there are versioned keys in the request - or not, the entire Multi-Object Delete request will fail. For information about MFA - Delete, see - MFA Delete. - - - - Finally, the Content-MD5 header is required for all Multi-Object Delete requests. - Amazon S3 uses the header value to ensure that your request body has not been altered - in transit. - - - - The following operations are related to DeleteObjects: - - - - Container for the necessary parameters to execute the DeleteObjects service method. - - The response from the DeleteObjects service method, as returned by S3. - REST API Reference for DeleteObjects Operation - - - - This operation enables you to delete multiple objects from a bucket using a single - HTTP request. If you know the object keys that you want to delete, then this operation - provides a suitable alternative to sending individual delete requests, reducing per-request - overhead. - - - - The request contains a list of up to 1000 keys that you want to delete. In the XML, - you provide the object key names, and optionally, version IDs if you want to delete - a specific version of the object from a versioning-enabled bucket. For each key, Amazon - S3 performs a delete operation and returns the result of that delete, success, or - failure, in the response. Note that if the object specified in the request is not - found, Amazon S3 returns the result as deleted. - - - - The operation supports two modes for the response: verbose and quiet. By default, - the operation uses verbose mode in which the response includes the result of deletion - of each key in your request. In quiet mode the response includes only keys where the - delete operation encountered an error. For a successful deletion, the operation does - not return any information about the delete in the response body. - - - - When performing this operation on an MFA Delete enabled bucket, that attempts to delete - any versioned objects, you must include an MFA token. If you do not provide one, the - entire request will fail, even if there are non-versioned objects you are trying to - delete. If you provide an invalid token, whether there are versioned keys in the request - or not, the entire Multi-Object Delete request will fail. For information about MFA - Delete, see - MFA Delete. - - - - Finally, the Content-MD5 header is required for all Multi-Object Delete requests. - Amazon S3 uses the header value to ensure that your request body has not been altered - in transit. - - - - The following operations are related to DeleteObjects: - - - - Container for the necessary parameters to execute the DeleteObjects service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObjects service method, as returned by S3. - REST API Reference for DeleteObjects Operation - - - - Removes the entire tag set from the specified object. For more information about managing - object tags, see - Object Tagging. - - - - To use this operation, you must have permission to perform the s3:DeleteObjectTagging - action. - - - - To delete tags of a specific object version, add the versionId query - parameter in the request. You will need permission for the s3:DeleteObjectVersionTagging - action. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteObjectTagging service method. - - The response from the DeleteObjectTagging service method, as returned by S3. - REST API Reference for DeleteObjectTagging Operation - - - - Removes the entire tag set from the specified object. For more information about managing - object tags, see - Object Tagging. - - - - To use this operation, you must have permission to perform the s3:DeleteObjectTagging - action. - - - - To delete tags of a specific object version, add the versionId query - parameter in the request. You will need permission for the s3:DeleteObjectVersionTagging - action. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteObjectTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObjectTagging service method, as returned by S3. - REST API Reference for DeleteObjectTagging Operation - - - - Removes the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:PutBucketPublicAccessBlock - permission. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to DeletePublicAccessBlock: - - - - Container for the necessary parameters to execute the DeletePublicAccessBlock service method. - - The response from the DeletePublicAccessBlock service method, as returned by S3. - REST API Reference for DeletePublicAccessBlock Operation - - - - Removes the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:PutBucketPublicAccessBlock - permission. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to DeletePublicAccessBlock: - - - - Container for the necessary parameters to execute the DeletePublicAccessBlock service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeletePublicAccessBlock service method, as returned by S3. - REST API Reference for DeletePublicAccessBlock Operation - - - - - - - - - - - - - - Returns the default encryption configuration for an Amazon S3 bucket. For information - about the Amazon S3 default encryption feature, see Amazon - S3 Default Bucket Encryption. - - - - To use this operation, you must have permission to perform the s3:GetEncryptionConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to GetBucketEncryption: - - - - Container for the necessary parameters to execute the GetBucketEncryption service method. - - The response from the GetBucketEncryption service method, as returned by S3. - REST API Reference for GetBucketEncryption Operation - - - - Returns the default encryption configuration for an Amazon S3 bucket. For information - about the Amazon S3 default encryption feature, see Amazon - S3 Default Bucket Encryption. - - - - To use this operation, you must have permission to perform the s3:GetEncryptionConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to GetBucketEncryption: - - - - Container for the necessary parameters to execute the GetBucketEncryption service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketEncryption service method, as returned by S3. - REST API Reference for GetBucketEncryption Operation - - - - Returns an inventory configuration (identified by the inventory configuration ID) - from the bucket. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - The following operations are related to GetBucketInventoryConfiguration: - - - - Container for the necessary parameters to execute the GetBucketInventoryConfiguration service method. - - The response from the GetBucketInventoryConfiguration service method, as returned by S3. - REST API Reference for GetBucketInventoryConfiguration Operation - - - - Returns an inventory configuration (identified by the inventory configuration ID) - from the bucket. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - The following operations are related to GetBucketInventoryConfiguration: - - - - Container for the necessary parameters to execute the GetBucketInventoryConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketInventoryConfiguration service method, as returned by S3. - REST API Reference for GetBucketInventoryConfiguration Operation - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - The name of the bucket for which to get the location. - - The response from the GetBucketLocation service method, as returned by S3. - REST API Reference for GetBucketLocation Operation - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - Container for the necessary parameters to execute the GetBucketLocation service method. - - The response from the GetBucketLocation service method, as returned by S3. - REST API Reference for GetBucketLocation Operation - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - The name of the bucket for which to get the location. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLocation service method, as returned by S3. - REST API Reference for GetBucketLocation Operation - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - Container for the necessary parameters to execute the GetBucketLocation service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLocation service method, as returned by S3. - REST API Reference for GetBucketLocation Operation - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - The bucket name for which to get the logging information. - - The response from the GetBucketLogging service method, as returned by S3. - REST API Reference for GetBucketLogging Operation - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - Container for the necessary parameters to execute the GetBucketLogging service method. - - The response from the GetBucketLogging service method, as returned by S3. - REST API Reference for GetBucketLogging Operation - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - The bucket name for which to get the logging information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLogging service method, as returned by S3. - REST API Reference for GetBucketLogging Operation - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - Container for the necessary parameters to execute the GetBucketLogging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLogging service method, as returned by S3. - REST API Reference for GetBucketLogging Operation - - - - Gets a metrics configuration (specified by the metrics configuration ID) from the - bucket. Note that this doesn't include the daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to GetBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the GetBucketMetricsConfiguration service method. - - The response from the GetBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for GetBucketMetricsConfiguration Operation - - - - Gets a metrics configuration (specified by the metrics configuration ID) from the - bucket. Note that this doesn't include the daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to GetBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the GetBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for GetBucketMetricsConfiguration Operation - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following operation is related to GetBucketNotification: - - - - Name of the bucket for which to get the notification configuration. - - The response from the GetBucketNotification service method, as returned by S3. - REST API Reference for GetBucketNotification Operation - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following operation is related to GetBucketNotification: - - - - Container for the necessary parameters to execute the GetBucketNotification service method. - - The response from the GetBucketNotification service method, as returned by S3. - REST API Reference for GetBucketNotification Operation - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following operation is related to GetBucketNotification: - - - - Name of the bucket for which to get the notification configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketNotification service method, as returned by S3. - REST API Reference for GetBucketNotification Operation - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following operation is related to GetBucketNotification: - - - - Container for the necessary parameters to execute the GetBucketNotification service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketNotification service method, as returned by S3. - REST API Reference for GetBucketNotification Operation - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operation is related to GetBucketPolicy: - - - - The bucket name for which to get the bucket policy. - - The response from the GetBucketPolicy service method, as returned by S3. - REST API Reference for GetBucketPolicy Operation - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operation is related to GetBucketPolicy: - - - - Container for the necessary parameters to execute the GetBucketPolicy service method. - - The response from the GetBucketPolicy service method, as returned by S3. - REST API Reference for GetBucketPolicy Operation - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operation is related to GetBucketPolicy: - - - - The bucket name for which to get the bucket policy. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicy service method, as returned by S3. - REST API Reference for GetBucketPolicy Operation - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operation is related to GetBucketPolicy: - - - - Container for the necessary parameters to execute the GetBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicy service method, as returned by S3. - REST API Reference for GetBucketPolicy Operation - - - - Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket - is public. In order to use this operation, you must have the s3:GetBucketPolicyStatus - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - For more information about when Amazon S3 considers a bucket public, see The - Meaning of "Public". - - - - The following operations are related to GetBucketPolicyStatus: - - - - Container for the necessary parameters to execute the GetBucketPolicyStatus service method. - - The response from the GetBucketPolicyStatus service method, as returned by S3. - REST API Reference for GetBucketPolicyStatus Operation - - - - Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket - is public. In order to use this operation, you must have the s3:GetBucketPolicyStatus - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - For more information about when Amazon S3 considers a bucket public, see The - Meaning of "Public". - - - - The following operations are related to GetBucketPolicyStatus: - - - - Container for the necessary parameters to execute the GetBucketPolicyStatus service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicyStatus service method, as returned by S3. - REST API Reference for GetBucketPolicyStatus Operation - - - - Retrieves the replication configuration for the given Amazon S3 bucket. - - Container for the necessary parameters to execute the GetBucketReplication service method. - - The response from the GetBucketReplication service method, as returned by S3. - REST API Reference for GetBucketReplication Operation - - - - Retrieves the replication configuration for the given Amazon S3 bucket. - - Container for the necessary parameters to execute the GetBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketReplication service method, as returned by S3. - REST API Reference for GetBucketReplication Operation - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - The name of the bucket for which to get the payment request configuration - - The response from the GetBucketRequestPayment service method, as returned by S3. - REST API Reference for GetBucketRequestPayment Operation - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - Container for the necessary parameters to execute the GetBucketRequestPayment service method. - - The response from the GetBucketRequestPayment service method, as returned by S3. - REST API Reference for GetBucketRequestPayment Operation - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - The name of the bucket for which to get the payment request configuration - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketRequestPayment service method, as returned by S3. - REST API Reference for GetBucketRequestPayment Operation - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - Container for the necessary parameters to execute the GetBucketRequestPayment service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketRequestPayment service method, as returned by S3. - REST API Reference for GetBucketRequestPayment Operation - - - - Returns the tag set associated with the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - GetBucketTagging has the following special error: - -
  • - - Error code: NoSuchTagSetError - -
    • - - Description: There is no tag set associated with the bucket. - -
- - The following operations are related to GetBucketTagging: - - - - Container for the necessary parameters to execute the GetBucketTagging service method. - - The response from the GetBucketTagging service method, as returned by S3. - REST API Reference for GetBucketTagging Operation - - - - Returns the tag set associated with the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - GetBucketTagging has the following special error: - -
  • - - Error code: NoSuchTagSetError - -
    • - - Description: There is no tag set associated with the bucket. - -
- - The following operations are related to GetBucketTagging: - - - - Container for the necessary parameters to execute the GetBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketTagging service method, as returned by S3. - REST API Reference for GetBucketTagging Operation - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - The name of the bucket for which to get the versioning information. - - The response from the GetBucketVersioning service method, as returned by S3. - REST API Reference for GetBucketVersioning Operation - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - Container for the necessary parameters to execute the GetBucketVersioning service method. - - The response from the GetBucketVersioning service method, as returned by S3. - REST API Reference for GetBucketVersioning Operation - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - The name of the bucket for which to get the versioning information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketVersioning service method, as returned by S3. - REST API Reference for GetBucketVersioning Operation - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - Container for the necessary parameters to execute the GetBucketVersioning service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketVersioning service method, as returned by S3. - REST API Reference for GetBucketVersioning Operation - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET operation requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which to get the website configuration. - - The response from the GetBucketWebsite service method, as returned by S3. - REST API Reference for GetBucketWebsite Operation - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET operation requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the GetBucketWebsite service method. - - The response from the GetBucketWebsite service method, as returned by S3. - REST API Reference for GetBucketWebsite Operation - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET operation requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which to get the website configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketWebsite service method, as returned by S3. - REST API Reference for GetBucketWebsite Operation - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET operation requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the GetBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketWebsite service method, as returned by S3. - REST API Reference for GetBucketWebsite Operation - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - The bucket name for which to get the cors configuration. - - The response from the GetCORSConfiguration service method, as returned by S3. - REST API Reference for GetCORSConfiguration Operation - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - Container for the necessary parameters to execute the GetCORSConfiguration service method. - - The response from the GetCORSConfiguration service method, as returned by S3. - REST API Reference for GetCORSConfiguration Operation - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - The bucket name for which to get the cors configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetCORSConfiguration service method, as returned by S3. - REST API Reference for GetCORSConfiguration Operation - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - Container for the necessary parameters to execute the GetCORSConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetCORSConfiguration service method, as returned by S3. - REST API Reference for GetCORSConfiguration Operation - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are still using previous version of the lifecycle configuration, it works. - For the earlier API description, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to GetBucketLifecycleConfiguration: - - - - The name of the bucket for which to get the lifecycle information. - - The response from the GetLifecycleConfiguration service method, as returned by S3. - REST API Reference for GetLifecycleConfiguration Operation - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are still using previous version of the lifecycle configuration, it works. - For the earlier API description, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to GetBucketLifecycleConfiguration: - - - - Container for the necessary parameters to execute the GetLifecycleConfiguration service method. - - The response from the GetLifecycleConfiguration service method, as returned by S3. - REST API Reference for GetLifecycleConfiguration Operation - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are still using previous version of the lifecycle configuration, it works. - For the earlier API description, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to GetBucketLifecycleConfiguration: - - - - The name of the bucket for which to get the lifecycle information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetLifecycleConfiguration service method, as returned by S3. - REST API Reference for GetLifecycleConfiguration Operation - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are still using previous version of the lifecycle configuration, it works. - For the earlier API description, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to GetBucketLifecycleConfiguration: - - - - Container for the necessary parameters to execute the GetLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetLifecycleConfiguration service method, as returned by S3. - REST API Reference for GetLifecycleConfiguration Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object to get. - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object to get. - VersionId used to reference a specific version of the object. - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - Container for the necessary parameters to execute the GetObject service method. - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object to get. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object to get. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - Container for the necessary parameters to execute the GetObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Gets an object's current Legal Hold status. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLegalHold service method. - - The response from the GetObjectLegalHold service method, as returned by S3. - REST API Reference for GetObjectLegalHold Operation - - - - Gets an object's current Legal Hold status. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLegalHold service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectLegalHold service method, as returned by S3. - REST API Reference for GetObjectLegalHold Operation - - - - Gets the Object Lock configuration for a bucket. The rule specified in the Object - Lock configuration will be applied by default to every new object placed in the specified - bucket. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLockConfiguration service method. - - The response from the GetObjectLockConfiguration service method, as returned by S3. - REST API Reference for GetObjectLockConfiguration Operation - - - - Gets the Object Lock configuration for a bucket. The rule specified in the Object - Lock configuration will be applied by default to every new object placed in the specified - bucket. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLockConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectLockConfiguration service method, as returned by S3. - REST API Reference for GetObjectLockConfiguration Operation - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - The name of the bucket containing the object. - The object key. - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - The name of the bucket containing the object. - The object key. - VersionId used to reference a specific version of the object. - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - Container for the necessary parameters to execute the GetObjectMetadata service method. - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - The name of the bucket containing the object. - The object key. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - The name of the bucket containing the object. - The object key. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - Container for the necessary parameters to execute the GetObjectMetadata service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - Retrieves an object's retention settings. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectRetention service method. - - The response from the GetObjectRetention service method, as returned by S3. - REST API Reference for GetObjectRetention Operation - - - - Retrieves an object's retention settings. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectRetention service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectRetention service method, as returned by S3. - REST API Reference for GetObjectRetention Operation - - - - Returns the tag-set of an object. You send the GET request against the tagging subresource - associated with the object. - - - - To use this operation, you must have permission to perform the s3:GetObjectTagging - action. By default, the GET operation returns information about current version of - an object. For a versioned bucket, you can have multiple versions of an object in - your bucket. To retrieve tags of any other version, use the versionId query parameter. - You also need permission for the s3:GetObjectVersionTagging action. - - - - By default, the bucket owner has this permission and can grant this permission to - others. - - - - For information about the Amazon S3 object tagging feature, see Object - Tagging. - - - - The following operation is related to GetObjectTagging: - - - - Container for the necessary parameters to execute the GetObjectTagging service method. - - The response from the GetObjectTagging service method, as returned by S3. - REST API Reference for GetObjectTagging Operation - - - - Returns the tag-set of an object. You send the GET request against the tagging subresource - associated with the object. - - - - To use this operation, you must have permission to perform the s3:GetObjectTagging - action. By default, the GET operation returns information about current version of - an object. For a versioned bucket, you can have multiple versions of an object in - your bucket. To retrieve tags of any other version, use the versionId query parameter. - You also need permission for the s3:GetObjectVersionTagging action. - - - - By default, the bucket owner has this permission and can grant this permission to - others. - - - - For information about the Amazon S3 object tagging feature, see Object - Tagging. - - - - The following operation is related to GetObjectTagging: - - - - Container for the necessary parameters to execute the GetObjectTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTagging service method, as returned by S3. - REST API Reference for GetObjectTagging Operation - - - - Return torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Amazon - S3 Torrent. - - - - You can get torrent only for objects that are less than 5 GB in size and that are - not encrypted using server-side encryption with customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - The following operation is related to GetObjectTorrent: - - - - The name of the bucket containing the object for which to get the torrent files. - The object key for which to get the information. - - The response from the GetObjectTorrent service method, as returned by S3. - REST API Reference for GetObjectTorrent Operation - - - - Return torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Amazon - S3 Torrent. - - - - You can get torrent only for objects that are less than 5 GB in size and that are - not encrypted using server-side encryption with customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - The following operation is related to GetObjectTorrent: - - - - Container for the necessary parameters to execute the GetObjectTorrent service method. - - The response from the GetObjectTorrent service method, as returned by S3. - REST API Reference for GetObjectTorrent Operation - - - - Return torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Amazon - S3 Torrent. - - - - You can get torrent only for objects that are less than 5 GB in size and that are - not encrypted using server-side encryption with customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - The following operation is related to GetObjectTorrent: - - - - The name of the bucket containing the object for which to get the torrent files. - The object key for which to get the information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTorrent service method, as returned by S3. - REST API Reference for GetObjectTorrent Operation - - - - Return torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Amazon - S3 Torrent. - - - - You can get torrent only for objects that are less than 5 GB in size and that are - not encrypted using server-side encryption with customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - The following operation is related to GetObjectTorrent: - - - - Container for the necessary parameters to execute the GetObjectTorrent service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTorrent service method, as returned by S3. - REST API Reference for GetObjectTorrent Operation - - - - Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:GetBucketPublicAccessBlock - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket - or an object, it checks the PublicAccessBlock configuration for both - the bucket (or the bucket that contains the object) and the bucket owner's account. - If the PublicAccessBlock settings are different between the bucket and - the account, Amazon S3 uses the most restrictive combination of the bucket-level and - account-level settings. - - - - For more information about when Amazon S3 considers a bucket or an object public, - see The - Meaning of "Public". - - - - The following operations are related to GetPublicAccessBlock: - - - - Container for the necessary parameters to execute the GetPublicAccessBlock service method. - - The response from the GetPublicAccessBlock service method, as returned by S3. - REST API Reference for GetPublicAccessBlock Operation - - - - Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:GetBucketPublicAccessBlock - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket - or an object, it checks the PublicAccessBlock configuration for both - the bucket (or the bucket that contains the object) and the bucket owner's account. - If the PublicAccessBlock settings are different between the bucket and - the account, Amazon S3 uses the most restrictive combination of the bucket-level and - account-level settings. - - - - For more information about when Amazon S3 considers a bucket or an object public, - see The - Meaning of "Public". - - - - The following operations are related to GetPublicAccessBlock: - - - - Container for the necessary parameters to execute the GetPublicAccessBlock service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetPublicAccessBlock service method, as returned by S3. - REST API Reference for GetPublicAccessBlock Operation - - - - This operation initiates a multipart upload and returns an upload ID. This upload - ID is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort operation - and Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload API and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart) and UploadPartCopy) requests must match the headers you - used in the request to initiate the upload by using CreateMultipartUpload. - - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, - kms:GenerateDataKey*, and kms:DescribeKey actions on the - key. These permissions are required because Amazon S3 must decrypt and read data from - the encrypted file parts before it completes the multipart upload. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - The following operations are related to CreateMultipartUpload: - - - - The name of the bucket to which to initiate the upload - Object key for which the multipart upload is to be initiated. - - The response from the InitiateMultipartUpload service method, as returned by S3. - REST API Reference for InitiateMultipartUpload Operation - - - - This operation initiates a multipart upload and returns an upload ID. This upload - ID is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort operation - and Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload API and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart) and UploadPartCopy) requests must match the headers you - used in the request to initiate the upload by using CreateMultipartUpload. - - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, - kms:GenerateDataKey*, and kms:DescribeKey actions on the - key. These permissions are required because Amazon S3 must decrypt and read data from - the encrypted file parts before it completes the multipart upload. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - The following operations are related to CreateMultipartUpload: - - - - Container for the necessary parameters to execute the InitiateMultipartUpload service method. - - The response from the InitiateMultipartUpload service method, as returned by S3. - REST API Reference for InitiateMultipartUpload Operation - - - - This operation initiates a multipart upload and returns an upload ID. This upload - ID is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort operation - and Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload API and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart) and UploadPartCopy) requests must match the headers you - used in the request to initiate the upload by using CreateMultipartUpload. - - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, - kms:GenerateDataKey*, and kms:DescribeKey actions on the - key. These permissions are required because Amazon S3 must decrypt and read data from - the encrypted file parts before it completes the multipart upload. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - The following operations are related to CreateMultipartUpload: - - - - The name of the bucket to which to initiate the upload - Object key for which the multipart upload is to be initiated. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the InitiateMultipartUpload service method, as returned by S3. - REST API Reference for InitiateMultipartUpload Operation - - - - This operation initiates a multipart upload and returns an upload ID. This upload - ID is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort operation - and Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload API and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart) and UploadPartCopy) requests must match the headers you - used in the request to initiate the upload by using CreateMultipartUpload. - - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, - kms:GenerateDataKey*, and kms:DescribeKey actions on the - key. These permissions are required because Amazon S3 must decrypt and read data from - the encrypted file parts before it completes the multipart upload. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - The following operations are related to CreateMultipartUpload: - - - - Container for the necessary parameters to execute the InitiateMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the InitiateMultipartUpload service method, as returned by S3. - REST API Reference for InitiateMultipartUpload Operation - - - - Lists the analytics configurations for the bucket. You can have up to 1,000 analytics - configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. You should always check the IsTruncated element in the response. - If there are no more configurations to list, IsTruncated is set to false. - If there are more configurations to list, IsTruncated is set to true, - and there will be a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to ListBucketAnalyticsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketAnalyticsConfigurations service method. - - The response from the ListBucketAnalyticsConfigurations service method, as returned by S3. - REST API Reference for ListBucketAnalyticsConfigurations Operation - - - - Lists the analytics configurations for the bucket. You can have up to 1,000 analytics - configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. You should always check the IsTruncated element in the response. - If there are no more configurations to list, IsTruncated is set to false. - If there are more configurations to list, IsTruncated is set to true, - and there will be a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to ListBucketAnalyticsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketAnalyticsConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketAnalyticsConfigurations service method, as returned by S3. - REST API Reference for ListBucketAnalyticsConfigurations Operation - - - - Returns a list of inventory configurations for the bucket. You can have up to 1,000 - analytics configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory - - - - The following operations are related to ListBucketInventoryConfigurations: - - - - Container for the necessary parameters to execute the ListBucketInventoryConfigurations service method. - - The response from the ListBucketInventoryConfigurations service method, as returned by S3. - REST API Reference for ListBucketInventoryConfigurations Operation - - - - Returns a list of inventory configurations for the bucket. You can have up to 1,000 - analytics configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory - - - - The following operations are related to ListBucketInventoryConfigurations: - - - - Container for the necessary parameters to execute the ListBucketInventoryConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketInventoryConfigurations service method, as returned by S3. - REST API Reference for ListBucketInventoryConfigurations Operation - - - - Lists the metrics configurations for the bucket. The metrics configurations are only - for the request metrics of the bucket and do not provide information on daily storage - metrics. You can have up to 1,000 configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For more information about metrics configurations and CloudWatch request metrics, - see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to ListBucketMetricsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketMetricsConfigurations service method. - - The response from the ListBucketMetricsConfigurations service method, as returned by S3. - REST API Reference for ListBucketMetricsConfigurations Operation - - - - Lists the metrics configurations for the bucket. The metrics configurations are only - for the request metrics of the bucket and do not provide information on daily storage - metrics. You can have up to 1,000 configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For more information about metrics configurations and CloudWatch request metrics, - see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to ListBucketMetricsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketMetricsConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketMetricsConfigurations service method, as returned by S3. - REST API Reference for ListBucketMetricsConfigurations Operation - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - - The response from the ListBuckets service method, as returned by S3. - REST API Reference for ListBuckets Operation - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - Container for the necessary parameters to execute the ListBuckets service method. - - The response from the ListBuckets service method, as returned by S3. - REST API Reference for ListBuckets Operation - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBuckets service method, as returned by S3. - REST API Reference for ListBuckets Operation - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - Container for the necessary parameters to execute the ListBuckets service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBuckets service method, as returned by S3. - REST API Reference for ListBuckets Operation - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Container for the necessary parameters to execute the ListMultipartUploads service method. - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Container for the necessary parameters to execute the ListMultipartUploads service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. - Limits the response to keys that begin with the specified prefix. - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - Container for the necessary parameters to execute the ListObjects service method. - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. - Limits the response to keys that begin with the specified prefix. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - Container for the necessary parameters to execute the ListObjects service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Make sure to design - your application to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - To use this operation in an AWS Identity and Access Management (IAM) policy, you must - have permissions to perform the s3:ListBucket action. The bucket owner - has this permission by default and can grant this permission to others. For more information - about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - This section describes the latest revision of the API. We recommend that you use this - revised API for application development. For backward compatibility, Amazon S3 continues - to support the prior version of this API, ListObjects. - - - - To get a list of your buckets, see ListBuckets. - - - - The following operations are related to ListObjectsV2: - - - - Container for the necessary parameters to execute the ListObjectsV2 service method. - - The response from the ListObjectsV2 service method, as returned by S3. - REST API Reference for ListObjectsV2 Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Make sure to design - your application to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - To use this operation in an AWS Identity and Access Management (IAM) policy, you must - have permissions to perform the s3:ListBucket action. The bucket owner - has this permission by default and can grant this permission to others. For more information - about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - This section describes the latest revision of the API. We recommend that you use this - revised API for application development. For backward compatibility, Amazon S3 continues - to support the prior version of this API, ListObjects. - - - - To get a list of your buckets, see ListBuckets. - - - - The following operations are related to ListObjectsV2: - - - - Container for the necessary parameters to execute the ListObjectsV2 service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjectsV2 service method, as returned by S3. - REST API Reference for ListObjectsV2 Operation - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). This request returns a maximum of 1,000 - uploaded parts. The default number of parts returned is 1,000 parts. You can restrict - the number of parts returned by specifying the max-parts request parameter. - If your multipart upload consists of more than 1,000 parts, the response returns an - IsTruncated field with the value of true, and a NextPartNumberMarker - element. In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListParts: - - - - Name of the bucket to which the parts are being uploaded. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Object key for which the multipart upload was initiated. - Upload ID identifying the multipart upload whose parts are being listed. - - The response from the ListParts service method, as returned by S3. - REST API Reference for ListParts Operation - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). This request returns a maximum of 1,000 - uploaded parts. The default number of parts returned is 1,000 parts. You can restrict - the number of parts returned by specifying the max-parts request parameter. - If your multipart upload consists of more than 1,000 parts, the response returns an - IsTruncated field with the value of true, and a NextPartNumberMarker - element. In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListParts: - - - - Container for the necessary parameters to execute the ListParts service method. - - The response from the ListParts service method, as returned by S3. - REST API Reference for ListParts Operation - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). This request returns a maximum of 1,000 - uploaded parts. The default number of parts returned is 1,000 parts. You can restrict - the number of parts returned by specifying the max-parts request parameter. - If your multipart upload consists of more than 1,000 parts, the response returns an - IsTruncated field with the value of true, and a NextPartNumberMarker - element. In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListParts: - - - - Name of the bucket to which the parts are being uploaded. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Object key for which the multipart upload was initiated. - Upload ID identifying the multipart upload whose parts are being listed. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListParts service method, as returned by S3. - REST API Reference for ListParts Operation - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). This request returns a maximum of 1,000 - uploaded parts. The default number of parts returned is 1,000 parts. You can restrict - the number of parts returned by specifying the max-parts request parameter. - If your multipart upload consists of more than 1,000 parts, the response returns an - IsTruncated field with the value of true, and a NextPartNumberMarker - element. In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListParts: - - - - Container for the necessary parameters to execute the ListParts service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListParts service method, as returned by S3. - REST API Reference for ListParts Operation - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes. - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - Container for the necessary parameters to execute the ListVersions service method. - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - Container for the necessary parameters to execute the ListVersions service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - - - Creates a new bucket. To create a bucket, you must register with Amazon S3 and have - a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed - to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information on bucket naming restrictions, - see Working - with Amazon S3 Buckets. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) - Region. For more information, see How - to Select a Region for Your Buckets. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - Hosting of Buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - The name of the bucket to create. - - The response from the PutBucket service method, as returned by S3. - REST API Reference for PutBucket Operation - - - - Creates a new bucket. To create a bucket, you must register with Amazon S3 and have - a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed - to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information on bucket naming restrictions, - see Working - with Amazon S3 Buckets. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) - Region. For more information, see How - to Select a Region for Your Buckets. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - Hosting of Buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - Container for the necessary parameters to execute the PutBucket service method. - - The response from the PutBucket service method, as returned by S3. - REST API Reference for PutBucket Operation - - - - Creates a new bucket. To create a bucket, you must register with Amazon S3 and have - a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed - to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information on bucket naming restrictions, - see Working - with Amazon S3 Buckets. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) - Region. For more information, see How - to Select a Region for Your Buckets. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - Hosting of Buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - The name of the bucket to create. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucket service method, as returned by S3. - REST API Reference for PutBucket Operation - - - - Creates a new bucket. To create a bucket, you must register with Amazon S3 and have - a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed - to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information on bucket naming restrictions, - see Working - with Amazon S3 Buckets. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) - Region. For more information, see How - to Select a Region for Your Buckets. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - Hosting of Buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - Container for the necessary parameters to execute the PutBucket service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucket service method, as returned by S3. - REST API Reference for PutBucket Operation - - - - Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration - is a bucket-level feature that enables you to perform faster data transfers to Amazon - S3. - - - - To use this operation, you must have permission to perform the s3:PutAccelerateConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The Transfer Acceleration state of a bucket can be set to one of the following two - values: - -
  • - - Enabled – Enables accelerated data transfers to the bucket. - -
  • - - Suspended – Disables accelerated data transfers to the bucket. - -
- - The GetBucketAccelerateConfiguration operation returns the transfer acceleration - state of a bucket. - - - - After setting the Transfer Acceleration state of a bucket to Enabled, it might take - up to thirty minutes before the data transfer rates to the bucket increase. - - - - The name of the bucket used for Transfer Acceleration must be DNS-compliant and must - not contain periods ("."). - - - - For more information about transfer acceleration, see Transfer - Acceleration. - - - - The following operations are related to PutBucketAccelerateConfiguration: - - - - Container for the necessary parameters to execute the PutBucketAccelerateConfiguration service method. - - The response from the PutBucketAccelerateConfiguration service method, as returned by S3. - REST API Reference for PutBucketAccelerateConfiguration Operation - - - - Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration - is a bucket-level feature that enables you to perform faster data transfers to Amazon - S3. - - - - To use this operation, you must have permission to perform the s3:PutAccelerateConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The Transfer Acceleration state of a bucket can be set to one of the following two - values: - -
  • - - Enabled – Enables accelerated data transfers to the bucket. - -
  • - - Suspended – Disables accelerated data transfers to the bucket. - -
- - The GetBucketAccelerateConfiguration operation returns the transfer acceleration - state of a bucket. - - - - After setting the Transfer Acceleration state of a bucket to Enabled, it might take - up to thirty minutes before the data transfer rates to the bucket increase. - - - - The name of the bucket used for Transfer Acceleration must be DNS-compliant and must - not contain periods ("."). - - - - For more information about transfer acceleration, see Transfer - Acceleration. - - - - The following operations are related to PutBucketAccelerateConfiguration: - - - - Container for the necessary parameters to execute the PutBucketAccelerateConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketAccelerateConfiguration service method, as returned by S3. - REST API Reference for PutBucketAccelerateConfiguration Operation - - - - - - - - - - Set the logging parameters for a bucket and to specify permissions for who can view - and modify the logging parameters. All logs are saved to buckets in the same AWS Region - as the source bucket. To set the logging status of a bucket, you must be the bucket - owner. - - - - The bucket owner is automatically granted FULL_CONTROL to all logs. You use the Grantee - request element to grant access to other people. The Permissions request - element specifies the kind of access the grantee has to the logs. - - - - Grantee Values - - - - You can specify the person (grantee) to whom you're assigning access rights (using - request elements) in the following ways: - -
  • - - By the person's ID: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> - </Grantee> - - - - DisplayName is optional and ignored in the request. - -
  • - - By Email address: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee> - - - - - The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl - request, appears as the CanonicalUser. - -
  • - - By URI: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee> - - -
- - To enable logging, you use LoggingEnabled and its children request elements. To disable - logging, you use an empty BucketLoggingStatus request element: - - - - <BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01" /> - - - - - For more information about server access logging, see Server - Access Logging. - - - - For more information about creating a bucket, see CreateBucket. For more information - about returning the logging status of a bucket, see GetBucketLogging. - - - - The following operations are related to PutBucketLogging: - - - - Container for the necessary parameters to execute the PutBucketLogging service method. - - The response from the PutBucketLogging service method, as returned by S3. - REST API Reference for PutBucketLogging Operation - - - - Set the logging parameters for a bucket and to specify permissions for who can view - and modify the logging parameters. All logs are saved to buckets in the same AWS Region - as the source bucket. To set the logging status of a bucket, you must be the bucket - owner. - - - - The bucket owner is automatically granted FULL_CONTROL to all logs. You use the Grantee - request element to grant access to other people. The Permissions request - element specifies the kind of access the grantee has to the logs. - - - - Grantee Values - - - - You can specify the person (grantee) to whom you're assigning access rights (using - request elements) in the following ways: - -
  • - - By the person's ID: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> - </Grantee> - - - - DisplayName is optional and ignored in the request. - -
  • - - By Email address: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee> - - - - - The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl - request, appears as the CanonicalUser. - -
  • - - By URI: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee> - - -
- - To enable logging, you use LoggingEnabled and its children request elements. To disable - logging, you use an empty BucketLoggingStatus request element: - - - - <BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01" /> - - - - - For more information about server access logging, see Server - Access Logging. - - - - For more information about creating a bucket, see CreateBucket. For more information - about returning the logging status of a bucket, see GetBucketLogging. - - - - The following operations are related to PutBucketLogging: - - - - Container for the necessary parameters to execute the PutBucketLogging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketLogging service method, as returned by S3. - REST API Reference for PutBucketLogging Operation - - - - Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. - You can have up to 1,000 metrics configurations per bucket. If you're updating an - existing metrics configuration, note that this is a full replacement of the existing - metrics configuration. If you don't include the elements you want to keep, they are - erased. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to PutBucketMetricsConfiguration: - - - - GetBucketLifecycle has the following special error: - -
  • - - Error code: TooManyConfigurations - -
    • - - Description: You are attempting to create a new configuration but have already reached - the 1,000-configuration limit. - -
    • - - HTTP Status Code: HTTP 400 Bad Request - -
- - Container for the necessary parameters to execute the PutBucketMetricsConfiguration service method. - - The response from the PutBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for PutBucketMetricsConfiguration Operation - - - - Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. - You can have up to 1,000 metrics configurations per bucket. If you're updating an - existing metrics configuration, note that this is a full replacement of the existing - metrics configuration. If you don't include the elements you want to keep, they are - erased. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to PutBucketMetricsConfiguration: - - - - GetBucketLifecycle has the following special error: - -
  • - - Error code: TooManyConfigurations - -
    • - - Description: You are attempting to create a new configuration but have already reached - the 1,000-configuration limit. - -
    • - - HTTP Status Code: HTTP 400 Bad Request - -
- - Container for the necessary parameters to execute the PutBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for PutBucketMetricsConfiguration Operation - - - - Enables notifications of specified events for a bucket. For more information about - event notifications, see Configuring - Event Notifications. - - - - Using this API, you can replace an existing notification configuration. The configuration - is an XML file that defines the event types that you want Amazon S3 to publish and - the destination where you want Amazon S3 to publish an event notification when it - detects an event of the specified type. - - - - By default, your bucket has no event notifications configured. That is, the notification - configuration will be an empty NotificationConfiguration. - - - - <NotificationConfiguration> - - - - </NotificationConfiguration> - - - - This operation replaces the existing notification configuration with the configuration - you include in the request body. - - - - After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification - Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, - and that the bucket owner has permission to publish to it by sending a test notification. - In the case of AWS Lambda destinations, Amazon S3 verifies that the Lambda function - permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. - For more information, see Configuring - Notifications for Amazon S3 Events. - - - - You can disable notifications by adding the empty NotificationConfiguration element. - - - - By default, only the bucket owner can configure notifications on a bucket. However, - bucket owners can use a bucket policy to grant permission to other users to set this - configuration with s3:PutBucketNotification permission. - - - - The PUT notification is an atomic operation. For example, suppose your notification - configuration includes SNS topic, SQS queue, and Lambda function configurations. When - you send a PUT request with this configuration, Amazon S3 sends test messages to your - SNS topic. If the message fails, the entire PUT operation will fail, and Amazon S3 - will not add the configuration to your bucket. - - - - Responses - - - - If the configuration in the request body includes only one TopicConfiguration - specifying only the s3:ReducedRedundancyLostObject event type, the response - will also include the x-amz-sns-test-message-id header containing the - message ID of the test notification sent to the topic. - - - - The following operation is related to PutBucketNotificationConfiguration: - - - - Container for the necessary parameters to execute the PutBucketNotification service method. - - The response from the PutBucketNotification service method, as returned by S3. - REST API Reference for PutBucketNotification Operation - - - - Enables notifications of specified events for a bucket. For more information about - event notifications, see Configuring - Event Notifications. - - - - Using this API, you can replace an existing notification configuration. The configuration - is an XML file that defines the event types that you want Amazon S3 to publish and - the destination where you want Amazon S3 to publish an event notification when it - detects an event of the specified type. - - - - By default, your bucket has no event notifications configured. That is, the notification - configuration will be an empty NotificationConfiguration. - - - - <NotificationConfiguration> - - - - </NotificationConfiguration> - - - - This operation replaces the existing notification configuration with the configuration - you include in the request body. - - - - After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification - Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, - and that the bucket owner has permission to publish to it by sending a test notification. - In the case of AWS Lambda destinations, Amazon S3 verifies that the Lambda function - permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. - For more information, see Configuring - Notifications for Amazon S3 Events. - - - - You can disable notifications by adding the empty NotificationConfiguration element. - - - - By default, only the bucket owner can configure notifications on a bucket. However, - bucket owners can use a bucket policy to grant permission to other users to set this - configuration with s3:PutBucketNotification permission. - - - - The PUT notification is an atomic operation. For example, suppose your notification - configuration includes SNS topic, SQS queue, and Lambda function configurations. When - you send a PUT request with this configuration, Amazon S3 sends test messages to your - SNS topic. If the message fails, the entire PUT operation will fail, and Amazon S3 - will not add the configuration to your bucket. - - - - Responses - - - - If the configuration in the request body includes only one TopicConfiguration - specifying only the s3:ReducedRedundancyLostObject event type, the response - will also include the x-amz-sns-test-message-id header containing the - message ID of the test notification sent to the topic. - - - - The following operation is related to PutBucketNotificationConfiguration: - - - - Container for the necessary parameters to execute the PutBucketNotification service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketNotification service method, as returned by S3. - REST API Reference for PutBucketNotification Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - The MD5 hash of the request body. - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - Container for the necessary parameters to execute the PutBucketPolicy service method. - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - The MD5 hash of the request body. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - Container for the necessary parameters to execute the PutBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Creates a replication configuration or replaces an existing one. For more information, - see Replication - in the Amazon S3 Developer Guide. - - - - To perform this operation, the user or role performing the operation must have the - iam:PassRole - permission. - - - - Specify the replication configuration in the request body. In the replication configuration, - you provide the name of the destination bucket where you want Amazon S3 to replicate - objects, the IAM role that Amazon S3 can assume to replicate objects on your behalf, - and other relevant information. - - - - A replication configuration must include at least one rule, and can contain a maximum - of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects - in the source bucket. To choose additional subsets of objects to replicate, add a - rule for each subset. All rules must specify the same destination bucket. - - - - To specify a subset of the objects in the source bucket to apply a replication rule - to, add the Filter element as a child of the Rule element. You can filter objects - based on an object key prefix, one or more object tags, or both. When you add the - Filter element in the configuration, you must also add the following elements: DeleteMarkerReplication, - Status, and Priority. - - - - For information about enabling versioning on a bucket, see Using - Versioning. - - - - By default, a resource owner, in this case the AWS account that created the bucket, - can perform this operation. The resource owner can also grant others permissions to - perform the operation. For more information about permissions, see Specifying - Permissions in a Policy and Managing - Access Permissions to Your Amazon S3 Resources. - - - - Handling Replication of Encrypted Objects - - - - By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side - encryption with CMKs stored in AWS KMS. To replicate AWS KMS-encrypted objects, add - the following: SourceSelectionCriteria, SseKmsEncryptedObjects, - Status, EncryptionConfiguration, and ReplicaKmsKeyID. - For information about replication configuration, see Replicating - Objects Created with SSE Using CMKs stored in AWS KMS. - - - - For information on PutBucketReplication errors, see ReplicationErrorCodeList - - - - - The following operations are related to PutBucketReplication: - - - - Container for the necessary parameters to execute the PutBucketReplication service method. - - The response from the PutBucketReplication service method, as returned by S3. - REST API Reference for PutBucketReplication Operation - - - - Creates a replication configuration or replaces an existing one. For more information, - see Replication - in the Amazon S3 Developer Guide. - - - - To perform this operation, the user or role performing the operation must have the - iam:PassRole - permission. - - - - Specify the replication configuration in the request body. In the replication configuration, - you provide the name of the destination bucket where you want Amazon S3 to replicate - objects, the IAM role that Amazon S3 can assume to replicate objects on your behalf, - and other relevant information. - - - - A replication configuration must include at least one rule, and can contain a maximum - of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects - in the source bucket. To choose additional subsets of objects to replicate, add a - rule for each subset. All rules must specify the same destination bucket. - - - - To specify a subset of the objects in the source bucket to apply a replication rule - to, add the Filter element as a child of the Rule element. You can filter objects - based on an object key prefix, one or more object tags, or both. When you add the - Filter element in the configuration, you must also add the following elements: DeleteMarkerReplication, - Status, and Priority. - - - - For information about enabling versioning on a bucket, see Using - Versioning. - - - - By default, a resource owner, in this case the AWS account that created the bucket, - can perform this operation. The resource owner can also grant others permissions to - perform the operation. For more information about permissions, see Specifying - Permissions in a Policy and Managing - Access Permissions to Your Amazon S3 Resources. - - - - Handling Replication of Encrypted Objects - - - - By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side - encryption with CMKs stored in AWS KMS. To replicate AWS KMS-encrypted objects, add - the following: SourceSelectionCriteria, SseKmsEncryptedObjects, - Status, EncryptionConfiguration, and ReplicaKmsKeyID. - For information about replication configuration, see Replicating - Objects Created with SSE Using CMKs stored in AWS KMS. - - - - For information on PutBucketReplication errors, see ReplicationErrorCodeList - - - - - The following operations are related to PutBucketReplication: - - - - Container for the necessary parameters to execute the PutBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketReplication service method, as returned by S3. - REST API Reference for PutBucketReplication Operation - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - The bucket name. - Container for Payer. - - The response from the PutBucketRequestPayment service method, as returned by S3. - REST API Reference for PutBucketRequestPayment Operation - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - Container for the necessary parameters to execute the PutBucketRequestPayment service method. - - The response from the PutBucketRequestPayment service method, as returned by S3. - REST API Reference for PutBucketRequestPayment Operation - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - The bucket name. - Container for Payer. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketRequestPayment service method, as returned by S3. - REST API Reference for PutBucketRequestPayment Operation - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - Container for the necessary parameters to execute the PutBucketRequestPayment service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketRequestPayment service method, as returned by S3. - REST API Reference for PutBucketRequestPayment Operation - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging. - - - - Within a bucket, if you add a tag that has the same key as an existing tag, the new - value overwrites the old value. For more information, see Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional operation is currently in progress against - this resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - The bucket name. - A property of PutBucketTaggingRequest used to execute the PutBucketTagging service method. - - The response from the PutBucketTagging service method, as returned by S3. - REST API Reference for PutBucketTagging Operation - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging. - - - - Within a bucket, if you add a tag that has the same key as an existing tag, the new - value overwrites the old value. For more information, see Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional operation is currently in progress against - this resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - Container for the necessary parameters to execute the PutBucketTagging service method. - - The response from the PutBucketTagging service method, as returned by S3. - REST API Reference for PutBucketTagging Operation - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging. - - - - Within a bucket, if you add a tag that has the same key as an existing tag, the new - value overwrites the old value. For more information, see Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional operation is currently in progress against - this resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - The bucket name. - A property of PutBucketTaggingRequest used to execute the PutBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketTagging service method, as returned by S3. - REST API Reference for PutBucketTagging Operation - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging. - - - - Within a bucket, if you add a tag that has the same key as an existing tag, the new - value overwrites the old value. For more information, see Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional operation is currently in progress against - this resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - Container for the necessary parameters to execute the PutBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketTagging service method, as returned by S3. - REST API Reference for PutBucketTagging Operation - - - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT operation requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - Amazon S3 has a limitation of 50 routing rules per website configuration. If you require - more than 50 routing rules, you can use object redirect. For more information, see - Configuring - an Object Redirect in the Amazon Simple Storage Service Developer Guide. - - - The bucket name. - Container for the request. - - The response from the PutBucketWebsite service method, as returned by S3. - REST API Reference for PutBucketWebsite Operation - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT operation requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - Amazon S3 has a limitation of 50 routing rules per website configuration. If you require - more than 50 routing rules, you can use object redirect. For more information, see - Configuring - an Object Redirect in the Amazon Simple Storage Service Developer Guide. - - - Container for the necessary parameters to execute the PutBucketWebsite service method. - - The response from the PutBucketWebsite service method, as returned by S3. - REST API Reference for PutBucketWebsite Operation - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT operation requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - Amazon S3 has a limitation of 50 routing rules per website configuration. If you require - more than 50 routing rules, you can use object redirect. For more information, see - Configuring - an Object Redirect in the Amazon Simple Storage Service Developer Guide. - - - The bucket name. - Container for the request. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketWebsite service method, as returned by S3. - REST API Reference for PutBucketWebsite Operation - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT operation requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - Amazon S3 has a limitation of 50 routing rules per website configuration. If you require - more than 50 routing rules, you can use object redirect. For more information, see - Configuring - an Object Redirect in the Amazon Simple Storage Service Developer Guide. - - - Container for the necessary parameters to execute the PutBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketWebsite service method, as returned by S3. - REST API Reference for PutBucketWebsite Operation - - - - - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - The name of the bucket for which to set the configuration. - A property of PutLifecycleConfigurationRequest used to execute the PutLifecycleConfiguration service method. - - The response from the PutLifecycleConfiguration service method, as returned by S3. - REST API Reference for PutLifecycleConfiguration Operation - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - Container for the necessary parameters to execute the PutLifecycleConfiguration service method. - - The response from the PutLifecycleConfiguration service method, as returned by S3. - REST API Reference for PutLifecycleConfiguration Operation - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - The name of the bucket for which to set the configuration. - A property of PutLifecycleConfigurationRequest used to execute the PutLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutLifecycleConfiguration service method, as returned by S3. - REST API Reference for PutLifecycleConfiguration Operation - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - Container for the necessary parameters to execute the PutLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutLifecycleConfiguration service method, as returned by S3. - REST API Reference for PutLifecycleConfiguration Operation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - The base class for requests that return Amazon S3 objects. - - - - - Gets or sets the name of the bucket. - - - The name of the bucket. - - - - - Gets whether or not the bucket name is set. - - - A value of true if the bucket name is set. - Returns false if otherwise. - - - - - Gets or sets the key under which the Amazon S3 object is stored. - - - The key under which the Amazon S3 object is stored. - - - - - Gets whether or not the key property is set. - - - A value of true if key property is set. - Returns false if otherwise. - - - - - Gets or sets the version ID of the Amazon S3 object. - - - The version ID of the Amazon S3 object. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or - ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Gets or sets the ModifiedSinceDate property. - - - The ModifiedSinceDate property. - - - - - Gets or sets the ModifiedSinceDate property. - - - The ModifiedSinceDate property. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or - UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Gets or sets the UnmodifiedSinceDate property. - - - The UnmodifiedSinceDate property. - - - - - Gets or sets the UnmodifiedSinceDate property. - - - The UnmodifiedSinceDate property. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to decrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - The base class TransferUtility request classes. - - - - - Waits for all of the tasks to complete or till any task fails or is canceled. - - - - - Waits for all of the tasks to complete or till any task fails or is canceled. - - - - - Returns the amount of bytes remaining that need to be pulled down from S3. - - The fully qualified path of the file. - - - - - The command to manage an upload using the S3 multipart API. - - - - - Initializes a new instance of the class. - - The s3 client. - The config object that has the number of threads to use. - The file transporter request. - - - - This command is for doing regular PutObject requests. - - - - - This command files all the files that meets the criteria specified in the TransferUtilityUploadDirectoryRequest request - and uploads them. - - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - - Gets the Amazon S3 client used for making calls into Amazon S3. - - - The Amazon S3 client used for making calls into Amazon S3. - - - - - Uploads the specified file. - The object key is derived from the file's name. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the specified file. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the contents of the specified stream. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The stream to read to obtain the content to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the stream to. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the file or stream specified by the request. - To track the progress of the upload, - add an event listener to the request's UploadProgressEvent. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - Contains all the parameters required to upload to Amazon S3. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Aborts the multipart uploads that were initiated before the specified date. - - - The name of the bucket containing multipart uploads. - - - The date before which the multipart uploads were initiated. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the content from Amazon S3 and writes it to the specified file. - If the key is not specified in the request parameter, - the file name will used as the key name. - - - Contains all the parameters required to download an Amazon S3 object. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Returns a stream from which the caller can read the content from the specified - Amazon S3 bucket and key. - The caller of this method is responsible for closing the stream. - - - The name of the bucket. - - - The object key. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Returns a stream to read the contents from Amazon S3 as - specified by the TransferUtilityOpenStreamRequest. - The caller of this method is responsible for closing the stream. - - - Contains all the parameters required for the OpenStream operation. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - A pattern used to identify the files from the source directory to upload. - - - A search option that specifies whether to recursively search for files to upload - in subdirectories. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The request that contains all the parameters required to upload a directory. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by s3Directory. - - - The name of the bucket containing the Amazon S3 objects to download. - - - The directory in Amazon S3 to download. - - - The local directory to download the objects to. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by the S3Directory - property of the passed in TransferUtilityDownloadDirectoryRequest object. - - - Contains all the parameters required to download objects from Amazon S3 - into a local directory. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the content from Amazon S3 and writes it to the specified file. - - - The file path where the content from Amazon S3 will be written to. - - - The name of the bucket containing the Amazon S3 object to download. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - A pattern used to identify the files from the source directory to upload. - - - A search option that specifies whether to recursively search for files to upload - in subdirectories. - - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The request that contains all the parameters required to upload a directory. - - - - - Uploads the specified file. - The object key is derived from the file's name. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - - - Uploads the specified file. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - The key under which the Amazon S3 object is stored. - - - - - Uploads the contents of the specified stream. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The stream to read to obtain the content to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the stream to. - - - The key under which the Amazon S3 object is stored. - - - - - Uploads the file or stream specified by the request. - To track the progress of the upload, - add an event listener to the request's UploadProgressEvent. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - Contains all the parameters required to upload to Amazon S3. - - - - - Returns a stream from which the caller can read the content from the specified - Amazon S3 bucket and key. - The caller of this method is responsible for closing the stream. - - - The name of the bucket. - - - The object key. - - - A stream of the contents from the specified Amazon S3 and key. - - - - - Returns a stream to read the contents from Amazon S3 as - specified by the TransferUtilityOpenStreamRequest. - The caller of this method is responsible for closing the stream. - - - Contains all the parameters required to open a stream to an S3 object. - - - A stream of the contents from Amazon S3. - - - - - Downloads the content from Amazon S3 and writes it to the specified file. - - - The file path where the content from Amazon S3 will be written to. - - - The name of the bucket containing the Amazon S3 object to download. - - - The key under which the Amazon S3 object is stored. - - - - - Downloads the content from Amazon S3 and writes it to the specified file. - If the key is not specified in the request parameter, - the file name will used as the key name. - - - Contains all the parameters required to download an Amazon S3 object. - - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by s3Directory. - - - The name of the bucket containing the Amazon S3 objects to download. - - - The directory in Amazon S3 to download. - - - The local directory to download the objects to. - - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by the S3Directory - property of the passed in TransferUtilityDownloadDirectoryRequest object. - - - Contains all the parameters required to download objects from Amazon S3 - into a local directory. - - - - - Aborts the multipart uploads that were initiated before the specified date. - - - The name of the bucket containing multipart uploads. - - - The date before which the multipart uploads were initiated. - - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - - Constructs a new class. - - - The AWS Access Key ID. - - - The AWS Secret Access Key. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new class. - - - The AWS Access Key ID. - - - The AWS Secret Access Key. - - - The region to configure the transfer utility for. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new instance of the class. - - - The AWS Access Key ID. - - - The AWS Secret Access Key. - - - Specifies advanced settings. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new instance of the class. - - - The AWS Access Key ID. - - - The AWS Secret Access Key. - - - The region to configure the transfer utility for. - - - Specifies advanced settings. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new instance of the class. - - - The Amazon S3 client. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Initializes a new instance of the class. - - - The Amazon S3 client. - - - Specifies advanced configuration settings for . - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Gets the Amazon S3 client used for making calls into Amazon S3. - - - The Amazon S3 client used for making calls into Amazon S3. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Uploads the specified file. - The object key is derived from the file's name. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the specified file. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the contents of the specified stream. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The stream to read to obtain the content to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the stream to. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the file or stream specified by the request. - To track the progress of the upload, - add an event listener to the request's UploadProgressEvent. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - Contains all the parameters required to upload to Amazon S3. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Aborts the multipart uploads that were initiated before the specified date. - - - The name of the bucket containing multipart uploads. - - - The date before which the multipart uploads were initiated. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the content from Amazon S3 and writes it to the specified file. - If the key is not specified in the request parameter, - the file name will used as the key name. - - - Contains all the parameters required to download an Amazon S3 object. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Returns a stream from which the caller can read the content from the specified - Amazon S3 bucket and key. - The caller of this method is responsible for closing the stream. - - - The name of the bucket. - - - The object key. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Returns a stream to read the contents from Amazon S3 as - specified by the TransferUtilityOpenStreamRequest. - The caller of this method is responsible for closing the stream. - - - Contains all the parameters required for the OpenStream operation. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Constructs a new class. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new class. - - - The region to configure the transfer utility for. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new class. - - - Specifies advanced configuration settings for . - - - - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - A pattern used to identify the files from the source directory to upload. - - - A search option that specifies whether to recursively search for files to upload - in subdirectories. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The request that contains all the parameters required to upload a directory. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by s3Directory. - - - The name of the bucket containing the Amazon S3 objects to download. - - - The directory in Amazon S3 to download. - - - The local directory to download the objects to. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by the S3Directory - property of the passed in TransferUtilityDownloadDirectoryRequest object. - - - Contains all the parameters required to download objects from Amazon S3 - into a local directory. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the content from Amazon S3 and writes it to the specified file. - - - The file path where the content from Amazon S3 will be written to. - - - The name of the bucket containing the Amazon S3 object to download. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - A pattern used to identify the files from the source directory to upload. - - - A search option that specifies whether to recursively search for files to upload - in subdirectories. - - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The request that contains all the parameters required to upload a directory. - - - - - Uploads the specified file. - The object key is derived from the file's name. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - - - Uploads the specified file. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - The key under which the Amazon S3 object is stored. - - - - - Uploads the contents of the specified stream. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The stream to read to obtain the content to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the stream to. - - - The key under which the Amazon S3 object is stored. - - - - - Uploads the file or stream specified by the request. - To track the progress of the upload, - add an event listener to the request's UploadProgressEvent. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - Contains all the parameters required to upload to Amazon S3. - - - - - Returns a stream from which the caller can read the content from the specified - Amazon S3 bucket and key. - The caller of this method is responsible for closing the stream. - - - The name of the bucket. - - - The object key. - - - A stream of the contents from the specified Amazon S3 and key. - - - - - Returns a stream to read the contents from Amazon S3 as - specified by the TransferUtilityOpenStreamRequest. - The caller of this method is responsible for closing the stream. - - - Contains all the parameters required to open a stream to an S3 object. - - - A stream of the contents from Amazon S3. - - - - - Downloads the content from Amazon S3 and writes it to the specified file. - - - The file path where the content from Amazon S3 will be written to. - - - The name of the bucket containing the Amazon S3 object to download. - - - The key under which the Amazon S3 object is stored. - - - - - Downloads the content from Amazon S3 and writes it to the specified file. - If the key is not specified in the request parameter, - the file name will used as the key name. - - - Contains all the parameters required to download an Amazon S3 object. - - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by s3Directory. - - - The name of the bucket containing the Amazon S3 objects to download. - - - The directory in Amazon S3 to download. - - - The local directory to download the objects to. - - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by the S3Directory - property of the passed in TransferUtilityDownloadDirectoryRequest object. - - - Contains all the parameters required to download objects from Amazon S3 - into a local directory. - - - - - Aborts the multipart uploads that were initiated before the specified date. - - - The name of the bucket containing multipart uploads. - - - The date before which the multipart uploads were initiated. - - - - - - Provides configuration options for how processes requests. - - - The best configuration settings depend on network - configuration, latency and bandwidth. - The default configuration settings are suitable - for most applications, but this class enables developers to experiment with - different configurations and tune transfer manager performance. - - - - - - Default constructor. - - - - - Gets or sets the minimum part size for upload parts in bytes. The default is 16 MB. - Decreasing the minimum part size causes - multipart uploads to be split into a larger number - of smaller parts. Setting this value too low has a negative effect - on transfer speeds, causing extra latency and network - communication for each part. - - - - - This property determines how many active threads - or the number of concurrent asynchronous web requests - will be used to upload/download the file . - The default value is 10. - - - A value less than or equal to 0 will be silently ignored. - - - - - Gets or sets the number of executing threads. - This property determines how many active threads will be used to upload - the file. The default value is 10 threads. - - - A value less than or equal to 0 will be silently ignored. - - - - - Contains all the parameters - that can be set when making a this request with the - TransferUtility method. - - - - - Get or sets the file path location of where the - downloaded Amazon S3 object will be written to. - - - The file path location of where the downloaded Amazon S3 object will be written to. - - - - - Checks if FilePath property is set. - - True if FilePath property is set. - - - - The event for WriteObjectProgressEvent notifications. All - subscribers will be notified when a new progress - event is raised. - - The WriteObjectProgressEvent is fired as data - is downloaded from S3. The delegates attached to the event - will be passed information detailing how much data - has been downloaded as well as how much will be downloaded. - - - - Subscribe to this event if you want to receive - WriteObjectProgressEvent notifications. Here is how:
- 1. Define a method with a signature similar to this one: - - private void displayProgress(object sender, WriteObjectProgressArgs args) - { - Console.WriteLine(args); - } - - 2. Add this method to the WriteObjectProgressEvent delegate's invocation list - - TransferUtilityDownloadRequest request = new TransferUtilityDownloadRequest(); - request.WriteObjectProgressEvent += displayProgress; - - - - - - Causes the WriteObjectProgressEvent event to be fired. - - Progress data for the stream being written to file. - - - - Contains all the parameters - that can be set when making a this request with the - TransferUtility method. - - - - - Contains all the parameters - that can be set when making a this request with the - TransferUtility method. - - - - - Gets or sets the name of the bucket. - - - The name of the bucket. - - - - - Checks if BucketName property is set. - - true if BucketName property is set. - - - - Gets or sets the key under which the Amazon S3 object is to be stored. - - - The key under which the Amazon S3 object is to be stored. - - - - - Checks if Key property is set. - - true if Key property is set. - - - - Gets or sets the canned access control list (ACL) - for the uploaded object. - Please refer to - for - information on Amazon S3 canned ACLs. - - - The canned access control list (ACL) - for the uploaded object. - - - - - Checks if the CannedACL property is set. - - true if there is the CannedACL property is set. - - - - Removes the cannned access control list (ACL) - for the uploaded object. - - - - - Gets or sets the content type of the uploaded Amazon S3 object. - - - The content type of the uploaded Amazon S3 object. - - - - - Checks if ContentType property is set. - - true if ContentType property is set. - - - - Gets or sets the storage class for the uploaded Amazon S3 object. - Please refer to - for - information on S3 Storage Classes. - - - The storage class for the uploaded Amazon S3 object. - - - - - Gets and sets the ServerSideEncryptionMethod property. - Specifies the encryption used on the server to - store the content. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Input stream for the request; content for the request will be read from the stream. - - - - - - Gets or sets the file path - where the Amazon S3 object will be uploaded from. - - - For WinRT and Windows Phone this property must be in the form of "ms-appdata:///local/file.txt". - - - - The file path where the Amazon S3 object will be uploaded from. - - - - - Checks if FilePath property is set. - - true if FilePath property is set. - - - - Gets or sets the part size of the upload in bytes. - The uploaded file will be divided into - parts the size specified and - uploaded to Amazon S3 individually. - - - The part size of the upload. - - - - - Checks if PartSize property is set. - - true if PartSize property is set. - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - The tag-set for the object. - - - - - The event for UploadProgressEvent notifications. All - subscribers will be notified when a new progress - event is raised. - - The UploadProgressEvent is fired as data - is uploaded to S3. The delegates attached to the event - will be passed information detailing how much data - has been uploaded as well as how much will be uploaded. - - - - Subscribe to this event if you want to receive - UploadProgressEvent notifications. Here is how:
- 1. Define a method with a signature similar to this one: - - private void displayProgress(object sender, UploadProgressArgs args) - { - Console.WriteLine(args); - } - - 2. Add this method to the UploadProgressEvent delegate's invocation list - - TransferUtilityUploadRequest request = new TransferUtilityUploadRequest(); - request.UploadProgressEvent += displayProgress; - - - - - - Causes the UploadProgressEvent event to be fired. - - Progress data for the file being uploaded. - - - - Gets the length of the content by either checking the FileInfo.Length property or the Stream.Length property. - - The length of the content. - - - - Gets or sets whether or not the stream used with this request is - automatically closed when all of the content is read from the stream. - - - A value of true if the if the stream is - automatically closed when all of the content is read from the stream. - A value of false if otherwise. - - - - - If this value is set to true then the stream's position will be reset to the start before being read for upload. - Default: true. - - - - - Sets whether or not the stream used with this request is - automatically closed when all of the content is read from the stream - and returns this object instance, - enabling additional method calls to be chained together. - - - A value of true if the if the stream is - automatically closed when all of the content is read from the stream. - A value of false if otherwise. - - - This object instance, enabling additional method calls to be chained together. - - - - - Encapsulates the information needed to provide - transfer progress to subscribers of the Put Object - Event. - - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The how many bytes were transferred since last event. - The number of bytes transferred - The total number of bytes to be transferred - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The how many bytes were transferred since last event. - The number of bytes transferred - The total number of bytes to be transferred - The file being uploaded - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The how many bytes were transferred since last event. - The number of bytes transferred - The total number of bytes to be transferred - A compensation for any upstream aggregators if this event to correct theit totalTransferred count, - in case the underlying request is retried. - The file being uploaded - - - - Gets the FilePath. - - - - - Request object for downloading a directory with the TransferUtility. - - - - - Gets or sets the name of the bucket. - - - The name of the bucket. - - - - - Gets whether or not the bucket name is set. - - - A value of true if the bucket name is set. - Otherwise, returns false. - - - - - Gets or sets the local directory where objects from Amazon S3 will be downloaded. - If the directory doesn't exist, it will be created. - - - The local directory where objects from Amazon S3 will be downloaded. - - - - - Gets whether or not the LocalDirectory property is set. - - - A value of true if LocalDirectory property is set. - Otherwise, returns false. - - - - - Gets or sets the Amazon S3 directory to download from. - This is translated to a key prefix; keys that have this prefix will be - downloaded. - - - - - Gets whether or not the S3Directory property is set. - - - A value of true if S3Directory property is set. - Otherwise, returns false. - - - - - - This property is deprecated. This property doesn't honor the DateTimeKind, please - use ModifiedSinceDateUtc instead. - - Gets or sets the ModifiedSinceDate property. - Only objects that have been modified since this date will be - downloaded. - - - The ModifiedSinceDate property. - - - - - Checks if ModifiedSinceDate property is set. - - A value of true if ModifiedSinceDate property is set. - Otherwise, returns false. - - - - Gets or sets the ModifiedSinceDateUtc property. - Only objects that have been modified since this date will be - downloaded. - - - The ModifiedSinceDateUtc property. - - - - - Checks if ModifiedSinceDateUtc property is set. - - A value of true if ModifiedSinceDateUtc property is set. - Otherwise, returns false. - - - - - This property is deprecated. This property doesn't honor the DateTimeKind, please - use UnmodifiedSinceDateUtc instead. - - Gets or sets the UnmodifiedSinceDate property. - Only objects that have not been modified since this date will be downloaded. - - - The UnmodifiedSinceDate property. - - - - - Checks if UnmodifiedSinceDate property is set. - - true if UnmodifiedSinceDate property is set. - - - - Gets or sets the UnmodifiedSinceDateUtc property. - Only objects that have not been modified since this date will be downloaded. - - - The UnmodifiedSinceDateUtc property. - - - - - Checks if UnmodifiedSinceDateUtc property is set. - - true if UnmodifiedSinceDateUtc property is set. - - - - Gets or sets the DownloadFilesConcurrently property. - Specifies if multiple files will be downloaded concurrently. - The number of concurrent web requests used is controlled - by the TransferUtilityConfig.ConcurrencyLevel property. - - - - - The event for DownloadedDirectoryProgressEvent notifications. All - subscribers will be notified when a new progress - event is raised. - - The DownloadedDirectoryProgressEvent is fired as data - is downloaded from Amazon S3. The delegates attached to the event - will be passed information detailing how much data - has been downloaded as well as how much will be downloaded. - - - - Subscribe to this event if you want to receive - DownloadedDirectoryProgressEvent notifications. Here is how:
- 1. Define a method with a signature similar to this one: - - private void displayProgress(object sender, DownloadDirectoryProgressArgs args) - { - Console.WriteLine(args); - } - - 2. Add this method to the DownloadedDirectoryProgressEvent delegate's invocation list - - TransferUtilityDownloadDirectoryRequest request = new TransferUtilityDownloadDirectoryRequest(); - request.DownloadedDirectoryProgressEvent += displayProgress; - - - - - - Encapsulates the information needed to provide - transfer progress to subscribers of the DownloadDirectory - event. - - - - - Constructs a new instance of DownloadDirectoryProgressArgs. - - - The number of files downloaded. - - - The total number of files to download. - - - The current file being downloaded - - - The number of transferred bytes for the current file. - - - The size of the current file in bytes. - - - - - Constructs a new instance of DownloadDirectoryProgressArgs. - - - The number of files downloaded. - - - The total number of files to download. - - - The bytes transferred across all files being downloaded. - - - The total number of bytes across all files being downloaded. - - - The current file being downloaded. - - - The number of transferred bytes for the current file. - - - The size of the current file in bytes. - - - - - Gets or sets the total number of files. - - The total number of files. - - - - Gets or sets the number of files downloaded so far. - - The number of files downloaded. - - - - Gets or sets the total number of bytes across all files being downloaded. - - The total number of bytes across all files being downloaded. - - - - Gets or sets the bytes transferred across all files being downloaded. - - The bytes transferred across all files being downloaded. - - - - Gets or sets the current file being downloaded. - - - This property is only valid if DownloadDirectory is used without enabling concurrent file downloads (by default concurrent download is disabled). - If concurrent file downloads are enabled by setting TransferUtilityDownloadDirectoryRequest.DownloadFilesConcurrently to true, this property - will return null. - - The current file being downloaded. - - - - Gets or sets the transferred bytes for the current file. - - - This property is only valid if DownloadDirectory is used without enabling concurrent file downloads (by default concurrent download is disabled). - If concurrent file downloads are enabled by setting TransferUtilityDownloadDirectoryRequest.DownloadFilesConcurrently to true, this property - will return 0. - - The transferred bytes for the current file. - - - - Gets or sets the total number of bytes for the current file. - - - This property is only valid if DownloadDirectory is used without enabling concurrent file downloads (by default concurrent download is disabled). - If concurrent file downloads are enabled by setting TransferUtilityDownloadDirectoryRequest.DownloadFilesConcurrently to true, this property - will return 0. - - The total number of bytes for the current file. - - - - The string representation of this instance of DownloadDirectoryProgressArgs. - - The string representation of this instance of DownloadDirectoryProgressArgs. - - - - Contains all the parameters - that can be set when making a this request with the - TransferUtility method. - - - - - Gets or sets the directory where files are uploaded from. - - - The directory where files are uploaded from. - - - - - Checks if Directory property is set. - - true if Directory property is set. - - - - Gets or sets the KeyPrefix property. As object keys are generated for the - files being uploaded this value will prefix the key. This is useful when a directory - needs to be uploaded into sub directory in the S3 Bucket. - - - The directory where files are uploaded from. - - - - - Checks if KeyPrefix property is set. - - true if KeyPrefix property is set. - - - - Gets and sets the search pattern used to determine which - files in the directory are uploaded. - - - The search pattern used to deterimine which - files in the directory are uploaded. - The default value is "*", specifying that all files - in the directory will be uploaded. - - - - - Checks if SearchPattern property is set. - - true if SearchPattern property is set. - - - - Gets or sets the recursive options for the directory upload. - - - The recursive options for the directory upload. - Set by default to TopDirectoryOnly, - specifying that files will be uploaded from the root directory only. - - - - - Gets or sets the name of the bucket. - - - The name of the bucket. - - - - - Checks if BucketName property is set. - - true if BucketName property is set. - - - - Gets or sets the canned access control list (ACL) - for the uploaded objects. - Please refer to - for - information on Amazon S3 canned ACLs. - - - The canned access control list (ACL) - for the uploaded objects. - - - - - Checks if the CannedACL property is set. - - true if there is the CannedACL property is set. - - - - Gets or sets the content type for the uploaded Amazon S3 objects. - The default behavior when this field is not set is to use the file - extension to set the content type. If this field is set to a value it - will be applied to all uploaded files in the directory, overriding - file extension inspection. - - - The content type for all the uploaded Amazon S3 objects. - - - - - Gets or sets the storage class for the uploaded Amazon S3 objects. - Please refer to - for - information on S3 Storage Classes. - - - The storage class for the uploaded Amazon S3 objects. - - - - - The collection of meta data for the request. - - - - - Gets or sets the ServerSideEncryptionMethod property. - Specifies the encryption used on the server to - store the content. - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Gets or sets the UploadFilesConcurrently property. - Specifies if multiple files will be uploaded concurrently. - The number of concurrent web requests used is controlled - by the TransferUtilityConfig.ConcurrencyLevel property. - - - - - The event for UploadDirectoryProgressEvent notifications. All - subscribers will be notified when a new progress - event is raised. - - The UploadDirectoryProgressEvent is fired as data - is uploaded to S3. The delegates attached to the event - will be passed information detailing how much data - has been uploaded as well as how much will be uploaded. - - - - Subscribe to this event if you want to receive - UploadDirectoryProgressEvent notifications. Here is how:
- 1. Define a method with a signature similar to this one: - - private void displayProgress(object sender, UploadDirectoryProgressArgs args) - { - Console.WriteLine(args); - } - - 2. Add this method to the UploadDirectoryProgressEvent delegate's invocation list - - TransferUtilityUploadDirectoryRequest request = new TransferUtilityUploadDirectoryRequest(); - request.UploadDirectoryProgressEvent += displayProgress; - - - - - - The event for modifying individual TransferUtilityUploadRequest for each file - being uploaded. - - - - - Causes the UploadDirectoryProgressEvent event to be fired. - - Progress data for files currently being uploaded. - - - - Tags that will be applied to all objects in the diretory. - - - - - Encapsulates the information needed to provide - transfer progress to subscribers of the UploadDirectory - event. - - - - - Constructs a new instance of UploadDirectoryProgressArgs. - - - The number of files uploaded. - - - The total number of files to upload. - - - The current file - - - The number of transferred bytes for current file. - - - The size of the current file in bytes. - - - - - Constructs a new instance of UploadDirectoryProgressArgs. - - - The number of files uploaded. - - - The total number of files to upload. - - - The bytes transferred across all files being uploaded. - - - The total number of bytes across all files being uploaded. - - - The current file being uploaded. - - - The number of transferred bytes for current file. - - - The size of the current file in bytes. - - - - - Gets or sets the total number of files. - - The total number of files. - - - - Gets or sets the number of files uploaded. - - The number of files uploaded. - - - - Gets or sets the total number of bytes across all files being uploaded. - - The total number of bytes across all files being uploaded. - - - - Gets or sets the bytes transferred across all files being uploaded. - - The bytes transferred across all files being uploaded. - - - - Gets or sets the current file. - - - This property is only valid if UploadDirectory is used without enabling concurrent file uploads (by default concurrent upload is disabled). - If concurrent file uploads are enabled by setting TransferUtilityUploadDirectoryRequest.UploadFilesConcurrently to true, this property - will return null. - - The current file. - - - - Gets or sets the transferred bytes for current file. - - - This property is only valid if UploadDirectory is used without enabling concurrent file uploads (by default concurrent upload is disabled). - If concurrent file uploads are enabled by setting TransferUtilityUploadDirectoryRequest.UploadFilesConcurrently to true, this property - will return 0. - - The transferred bytes for current file. - - - - Gets or sets the total number of bytes for current file. - - - This property is only valid if UploadDirectory is used without enabling concurrent file uploads (by default concurrent upload is disabled). - If concurrent file uploads are enabled by setting TransferUtilityUploadDirectoryRequest.UploadFilesConcurrently to true, this property - will return 0. - - The total number of bytes for current file. - - - - The string representation of this instance of UploadDirectoryProgressArgs. - - The string representation of this instance of UploadDirectoryProgressArgs. - - - - Contains a single TransferUtilityUploadRequest corresponding - to a single file about to be uploaded, allowing changes to - the request before it is executed. - - - - - Constructs a new UploadDirectoryFileRequestArgs instance. - - Request being processed. - - - - Gets and sets the UploadRequest property. - - - - - This class extends the AmazonS3Client and provides client side encryption when reading or writing S3 objects. - - - - - Constructs AmazonS3EncryptionClient with the Encryption materials and credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Constructs AmazonS3EncryptionClient with the Encryption materials and credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - - The region to connect. - - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Constructs AmazonS3EncryptionClient with the Encryption materials, - AmazonS3 CryptoConfiguration object and credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - - The AmazonS3EncryptionClient CryptoConfiguration Object - - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Constructs AmazonS3EncryptionClient with AWS Credentials and Encryption materials. - - - The encryption materials to be used to encrypt and decrypt envelope key. - - AWS Credentials - - - - Constructs AmazonS3EncryptionClient with AWS Credentials, Region and Encryption materials - - AWS Credentials - The region to connect. - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Constructs AmazonS3EncryptionClient with AWS Credentials, AmazonS3CryptoConfiguration Configuration object - and Encryption materials - - AWS Credentials - The AmazonS3EncryptionClient CryptoConfiguration Object - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Constructs AmazonS3EncryptionClient with AWS Access Key ID, - AWS Secret Key and Encryption materials - - AWS Access Key ID - AWS Secret Access Key - The encryption materials to be used to encrypt and decrypt envelope key. - - - - Constructs AmazonS3EncryptionClient with AWS Access Key ID, - AWS Secret Key, Region and Encryption materials - - AWS Access Key ID - AWS Secret Access Key - The region to connect. - The encryption materials to be used to encrypt and decrypt envelope key. - - - - Constructs AmazonS3EncryptionClient with AWS Access Key ID, Secret Key, - AmazonS3 CryptoConfiguration object and Encryption materials. - - AWS Access Key ID - AWS Secret Access Key - The AmazonS3EncryptionClient CryptoConfiguration Object - The encryption materials to be used to encrypt and decrypt envelope key. - - - - Constructs AmazonS3EncryptionClient with AWS Access Key ID, Secret Key, - SessionToken and Encryption materials. - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Constructs AmazonS3EncryptionClient with AWS Access Key ID, Secret Key, - SessionToken, Region and Encryption materials. - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - The region to connect. - The encryption materials to be used to encrypt and decrypt envelope key. - - - - Constructs AmazonS3EncryptionClient with AWS Access Key ID, Secret Key, SessionToken - AmazonS3EncryptionClient CryptoConfiguration object and Encryption materials. - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - The AmazonS3EncryptionClient CryptoConfiguration Object - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Turn off response logging because it will interfere with decrypt of the data coming back from S3. - - - - - Customize the pipeline to allow encryption. - - - - - - Dispose this instance - - - - - - AmazonS3CryptoConfiguration allows customers - to set storage mode for encryption credentials - - - - - Default Constructor. - - - - - Gets and sets the StorageMode property. This determines if the crypto metadata is stored as metadata on the object or as a separate object in S3. - The default is ObjectMetadata. - - - - - Mode for string the encryption information for an object. - - - - - Store the information in a separate S3 Object. - - - - - Store the information as metadata on the encrypted object. - - - - - Encryption Instructions store the encryption credentials - - - - - Construct an instance EncryptionInstructions. - - - - - - - - - Construct an instance EncryptionInstructions. - - - - - - - - The "key encrypting key" materials used in encrypt/decryption. - These materials may be an asymmetric key, a symmetric key, or a KMS key ID. - - - - - Constructs a new EncryptionMaterials object, storing an asymmetric key. - - - - - - Constructs a new EncryptionMaterials object, storing a symmetric key. - - - - - - Constructs a new EncryptionMaterials object, storing a KMS Key ID - - - - - - The EncryptionUtils class encrypts and decrypts data stored in S3. - It can be used to prepare requests for encryption before they are stored in S3 - and to decrypt objects that are retrieved from S3. - - - - - Decrypts an encrypted Envelope key using the provided encryption materials - and returns it in raw byte array form. - - Encrypted envelope key - Encryption materials needed to decrypt the encrypted envlelope key - - - - - Returns an updated stream where the stream contains the encrypted object contents. - The specified instruction will be used to encrypt data. - - - The stream whose contents are to be encrypted. - - - The instruction that will be used to encrypt the object data. - - - Encrypted stream, i.e input stream wrapped into encrypted stream - - - - - Returns an updated input stream where the input stream contains the encrypted object contents. - The specified instruction will be used to encrypt data. - - - The stream whose contents are to be encrypted. - - - The instruction that will be used to encrypt the object data. - - - Encrypted stream, i.e input stream wrapped into encrypted stream - - - - - Updates object where the object - input stream contains the decrypted contents. - - - The getObject response whose contents are to be decrypted. - - - The instruction that will be used to encrypt the object data. - - - - - Generates an instruction that will be used to encrypt an object - using materials with the KMSKeyID set. - - - Used to call KMS to generate a data key. - - - The encryption materials to be used to encrypt and decrypt data. - - - The instruction that will be used to encrypt an object. - - - - - Generates an instruction that will be used to encrypt an object - using materials with the KMSKeyID set. - - - Used to call KMS to generate a data key. - - - The encryption materials to be used to encrypt and decrypt data. - - - The instruction that will be used to encrypt an object. - - - - - Generates an instruction that will be used to encrypt an object - using materials with the AsymmetricProvider or SymmetricProvider set. - - - The encryption materials to be used to encrypt and decrypt data. - - - The instruction that will be used to encrypt an object. - - - - - Builds an instruction object from the object metadata. - - - A non-null object response that contains encryption information in its metadata. - - - The non-null encryption materials to be used to encrypt and decrypt Envelope key. - - - The decrypted envelope key to be use if KMS key wrapping is being used. Or null if non-KMS key wrapping is being used. - - - - - - - Builds an instruction object from the instruction file. - - Instruction file GetObject response - - The non-null encryption materials to be used to encrypt and decrypt Envelope key. - - - A non-null instruction object containing encryption information. - - - - - Update the request's ObjectMetadata with the necessary information for decrypting the object. - - - AmazonWebServiceRequest encrypted using the given instruction - - - Non-null instruction used to encrypt the data in this AmazonWebServiceRequest . - - - If true use V2 metadata format, otherwise use V1. - - - - - Adds UnEncrypted content length to object metadata - - - - - - checks if encryption credentials are in object metadata - - Response of the object - - - - - checks if encryption credentials are in the instructionfile - - Instruction file response that contains encryption information - - - - - Custom the pipeline handler to decrypt objects. - - - - - Construct instance of SetupDecryptionHandler. - - - - - - Gets the EncryptionClient property which is the AmazonS3EncryptionClient that is decrypting the object. - - - - - Calls the post invoke logic after calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Decrypt the object being downloaded. - - - - - - Calls the and post invoke logic after calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Decrypt the object being downloaded. - - - - - - Decrypt the object being downloaded. - - - - - - - Updates object where the object input stream contains the decrypted contents. - - - The getObject response of InstructionFile. - - - The getObject response whose contents are to be decrypted. - - - - - Updates object where the object input stream contains the decrypted contents. - - - The getObject response whose contents are to be decrypted. - - - The decrypted envelope key to be use if KMS key wrapping is being used. Or null if non-KMS key wrapping is being used. - - - - - Custom pipeline handler to encrypt the data as it is being uploaded to S3. - - - - - Construct an instance SetupEncryptionHandler. - - - - - - Gets the EncryptionClient property which is the AmazonS3EncryptionClient that is encrypting the object. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Encrypts the S3 object being uploaded. - - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Encrypts the S3 object being uploaded. - - - - - - Make sure that the storage mode and encryption materials are compatible. - The client only supports KMS key wrapping in metadata storage mode. - - - - - Updates the request where the metadata contains encryption information - and the input stream contains the encrypted object contents. - - - The request whose contents are to be encrypted. - - - - - Updates the request where the instruction file contains encryption information - and the input stream contains the encrypted object contents. - - - - - - Updates the request where the input stream contains the encrypted object contents. - - - - - - Adds the crypto token to the user agent - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Customize the user agent. - - - - - - Mimics the System.IO.DirectoryInfo for a virtual directory in S3. It exposes properties and methods for enumerating directories and files as well as - methods manipulate directories. - - - It is important to keep in mind that S3 is not a filesystem. It is possible for S3 object keys to contain - characters which are not not legal file path characters, and so some pre-existing objects in a bucket that were created with - other software may not be compatible with this class. - - - - - Initialize a new instance of the S3DirectoryInfo class for the specified S3 bucket. - - S3 client which is used to access the S3 resources. - Name of the S3 bucket. - - - - - Initialize a new instance of the S3DirectoryInfo class for the specified S3 bucket and S3 object key. - - S3 client which is used to access the S3 resources. - Name of the S3 bucket. - The S3 object key. - - - - - The S3DirectoryInfo for the root of the S3 bucket. - - - - - Checks with S3 to see if the directory exists and if so returns true. - - Due to Amazon S3's eventual consistency model this property can return false for newly created buckets. - - - - - - - Returns empty string for directories. - - - - - The full path of the directory including bucket name. - - - - - Returns the last write time of the the latest file written to the directory. - - - - - - - UTC converted version of LastWriteTime. - - - - - - - Returns the name of the folder. - - - - - Return the S3DirectoryInfo of the parent directory. - - - - - Returns the S3DirectroyInfo for the S3 account. - - - - - Returns the type of file system element. - - - - - Creates the directory in S3. If no object key was specified when creating the S3DirectoryInfo then the bucket will be created. - - - - - - - Creates a sub directory inside the instance of S3DirectoryInfo. - - - - - - - - - Deletes all the files in this directory as well as this directory. - - - - - - - - Deletes all the files in this directory as well as this directory. If recursive is set to true then all sub directories will be - deleted as well. - - - - - If true then sub directories will be deleted as well. - - - - Enumerate the sub directories of this directory. - - - - An enumerable collection of directories. - - - - Enumerate the sub directories of this directory. - - The search string. The default pattern is "*", which returns all directories. - - - An enumerable collection of directories that matches searchPattern. - - - - Enumerate the sub directories of this directory. - - The search string. The default pattern is "*", which returns all directories. - One of the enumeration values that specifies whether the search operation should include only the current directory or all subdirectories. The default value is TopDirectoryOnly. - - - An enumerable collection of directories that matches searchPattern and searchOption. - - - - Enumerate the files of this directory. - - - - An enumerable collection of files. - - - - Enumerate the sub directories of this directory. - - The search string. The default pattern is "*", which returns all files. - - - An enumerable collection of files that matches searchPattern. - - - - Enumerate the files of this directory. - - The search string. The default pattern is "*", which returns all files. - One of the enumeration values that specifies whether the search operation should include only the current directory or all subdirectories. The default value is TopDirectoryOnly. - - - An enumerable collection of files that matches searchPattern and searchOption. - - - - Enumerate the files of this directory. - - - - An enumerable collection of files. - - - - Enumerate the files of this directory. - - The search string. The default pattern is "*", which returns all files. - - - An enumerable collection of files that matches searchPattern. - - - - Enumerate the files of this directory. - - The search string. The default pattern is "*", which returns all files. - One of the enumeration values that specifies whether the search operation should include only the current directory or all subdirectories. The default value is TopDirectoryOnly. - - - An enumerable collection of files that matches searchPattern and searchOption. - - - - Returns the S3DirectoryInfo for the specified sub directory. - - Directory to get the S3DirectroyInfo for. - The S3DirectoryInfo for the specified sub directory. - - - - Returns an array of S3DirectoryInfos for the directories in this directory. - - - - An array of directories. - - - - Returns an array of S3DirectoryInfos for the directories in this directory. - - The search string. The default pattern is "*", which returns all files. - An array of files that matches searchPattern. - - - - Returns an array of S3DirectoryInfos for the directories in this directory. - - The search string. The default pattern is "*", which returns all directories. - One of the enumeration values that specifies whether the search operation should include only the current directory or all subdirectories. The default value is TopDirectoryOnly. - - - An array of directories that matches searchPattern and searchOption. - - - - Returns the S3FileInfo for the specified file. - - File to get the S3FileInfo for. - The S3FileInfo for the specified file. - - - - Returns an array of S3FileInfos for the files in this directory. - - - - An array of files. - - - - Returns an array of S3FileInfos for the files in this directory. - - The search string. The default pattern is "*", which returns all files. - - - An array of files that matches searchPattern. - - - - Returns an array of S3FileInfos for the files in this directory. - - The search string. The default pattern is "*", which returns all files. - One of the enumeration values that specifies whether the search operation should include only the current directory or all subdirectories. The default value is TopDirectoryOnly. - - - An array of files that matches searchPattern and searchOption. - - - - Returns an array of IS3FileSystemInfos for the files in this directory. - - - - An array of files. - - - - Returns an array of IS3FileSystemInfos for the files in this directory. - - The search string. The default pattern is "*", which returns all files. - - - An array of files that matches searchPattern. - - - - Returns an array of IS3FileSystemInfos for the files in this directory. - - The search string. The default pattern is "*", which returns all files. - One of the enumeration values that specifies whether the search operation should include only the current directory or all subdirectories. The default value is TopDirectoryOnly. - - - An array of files that matches searchPattern and searchOption. - - - - Copies the files from this directory to the target directory specified by the bucket and object key. - - The target bucket to copy to. - The target object key which represents a directory in S3. - - - - S3DirectoryInfo for the target location. - - - - Copies the files from this directory to the target directory specified by the bucket and object key. Only - files that have changed since the changeSince date will be copied. - - The target bucket to copy to. - The target object key which represents a directory in S3. - Date which files must have changed since in ordered to be copied. - - - - S3DirectoryInfo for the target location. - - - - Copies the files from this directory to the target directory. - - The target directory to copy to. - - - - S3DirectoryInfo for the target location. - - - - Copies the files from this directory to the target directory. Only - files that have changed since the changeSince date will be copied. - - The target directory to copy to. - Date which files must have changed since in ordered to be copied. - - - - S3DirectoryInfo for the target location. - - - - Copies the files from the S3 directory to the local file system in the location indicated by the path parameter. - - The location on the local file system to copy the files to. - - - DirectoryInfo for the local directory where files are copied to. - - - - Copies the files from the S3 directory to the local file system in the location indicated by the path parameter. - Only files that have been modified since the changesSince property will be copied. - - The location on the local file system to copy the files to. - Date which files must have changed since in ordered to be copied. - - - - DirectoryInfo for the local directory where files are copied to. - - - - Copies files from the local file system to S3 in this directory. Sub directories are copied as well. - - The local file system path where the files are to be copied. - - - - S3DirectoryInfo where the files are copied to. - - - - Copies files from the local file system to S3 in this directory. Sub directories are copied as well. - Only files that have been modified since the changesSince property will be copied. - - The local file system path where the files are to copy. - Date which files must have changed since in ordered to be copied. - - - - S3DirectoryInfo where the files are copied to. - - - - Moves the directory to the target directory specified by the bucket and object key. - - The target bucket to move to. - The target object key which represents a directory in S3. - - - - S3DirectoryInfo for the target location. - - - - Moves the directory to the target S3 directory. - - The target directory to copy to. - - - - S3DirectoryInfo for the target location. - - - - Moves the files from the S3 directory to the local file system in the location indicated by the path parameter. - - The location on the local file system to move the files to. - - - - DirectoryInfo for the local directory where files are moved to. - - - - Moves files from the local file system to S3 in this directory. Sub directories are moved as well. - - The local file system path where the files are to be moved. - - - - S3DirectoryInfo where the files are moved to. - - - - Implement the ToString method. - - - - - - Creating and deleting buckets can sometimes take a little bit of time. To make sure - users of this API do not experience the side effects of the eventual consistency - we block until the state change has happened. - - - - - - Mimics the System.IO.FileInfo for a file in S3. It exposes properties and methods manipulating files in S3. - - - - - Initialize a new instance of the S3FileInfo class for the specified S3 bucket and S3 object key. - - S3 client which is used to access the S3 resources. - Name of the S3 bucket. - The S3 object key. - - - - - Returns the parent S3DirectoryInfo. - - - - - The full name of parent directory. - - - - - Checks S3 if the file exists in S3 and return true if it does. - - - - - - - Gets the file's extension. - - - - - Returns the full path including the bucket. - - - - - Returns the last time the file was modified. - - - - - - - Returns the last time the file was modified in UTC. - - - - - - - Returns the content length of the file. - - - - - - - Returns the file name without its directory name. - - - - - Returns the type of file system element. - - - - - Copies this file's content to the file indicated by the S3 bucket and object key. - If the file already exists in S3 than an ArgumentException is thrown. - - S3 bucket to copy the file to. - S3 object key to copy the file to. - - - - S3FileInfo of the newly copied file. - - - - Copies this file's content to the file indicated by the S3 bucket and object key. - If the file already exists in S3 and overwrite is set to false than an ArgumentException is thrown. - - S3 bucket to copy the file to. - S3 object key to copy the file to. - Determines whether the file can be overwritten. - If the file already exists in S3 and overwrite is set to false. - - - - S3FileInfo of the newly copied file. - - - - Copies this file to the target directory. - If the file already exists in S3 than an ArgumentException is thrown. - - Target directory where to copy the file to. - If the directory does not exist. - If the file already exists in S3. - - - S3FileInfo of the newly copied file. - - - - Copies this file to the target directory. - If the file already exists in S3 and overwrite is set to false than an ArgumentException is thrown. - - Target directory where to copy the file to. - Determines whether the file can be overwritten. - If the directory does not exist. - If the file already exists in S3 and overwrite is set to false. - - - S3FileInfo of the newly copied file. - - - - Copies this file to the location indicated by the passed in S3FileInfo. - If the file already exists in S3 than an ArgumentException is thrown. - - The target location to copy this file to. - If the file already exists in S3. - - - S3FileInfo of the newly copied file. - - - - Copies this file to the location indicated by the passed in S3FileInfo. - If the file already exists in S3 and overwrite is set to false than an ArgumentException is thrown. - - The target location to copy this file to. - Determines whether the file can be overwritten. - If the file already exists in S3 and overwrite is set to false. - - - S3FileInfo of the newly copied file. - - - - Copies from S3 to the local file system. - If the file already exists on the local file system than an ArgumentException is thrown. - - The path where to copy the file to. - If the file already exists locally. - - - FileInfo for the local file where file is copied to. - - - - Copies from S3 to the local file system. - If the file already exists on the local file system and overwrite is set to false than an ArgumentException is thrown. - - The path where to copy the file to. - Determines whether the file can be overwritten. - If the file already exists locally and overwrite is set to false. - - - FileInfo for the local file where file is copied to. - - - - Copies the file from the local file system to S3. - If the file already exists in S3 than an ArgumentException is thrown. - - Location of the file on the local file system to copy. - If the file already exists in S3. - - - S3FileInfo where the file is copied to. - - - - Copies the file from the local file system to S3. - If the file already exists in S3 and overwrite is set to false than an ArgumentException is thrown. - - Location of the file on the local file system to copy. - Determines whether the file can be overwritten. - If the file already exists in S3 and overwrite is set to false. - - - S3FileInfo where the file is copied to. - - - - Returns a Stream that can be used to write data to S3. - - - The content will not be written to S3 until the Stream is closed. - - - - Stream to write content to. - - - - Returns a StreamWriter that can be used to write data to S3. - - - The content will not be written to S3 until the Stream is closed. - - - - Stream to write content to. - - - - Deletes the from S3. - - - - - - - Moves the file to a a new location in S3. - - Bucket to move the file to. - Object key to move the file to. - If the file already exists in S3. - - - - S3FileInfo for the target location. - - - - Moves the file to a a new location in S3. - - The target directory to copy to. - If the file already exists in S3. - - - - S3FileInfo for the target location. - - - - Moves the file to a a new location in S3. - - The target file to copy to. - If the file already exists in S3. - - - - S3FileInfo for the target location. - - - - Moves the file from S3 to the local file system in the location indicated by the path parameter. - - The location on the local file system to move the file to. - If the file already exists locally. - - - - FileInfo for the local file where file is moved to. - - - - Moves the file from the local file system to S3 in this directory. - If the file already exists in S3 than an ArgumentException is thrown. - - The local file system path where the files are to be moved. - If the file already exists locally. - - - - S3FileInfo where the file is moved to. - - - - Moves the file from the local file system to S3 in this directory. - If the file already exists in S3 and overwrite is set to false than an ArgumentException is thrown. - - The local file system path where the files are to be moved. - Determines whether the file can be overwritten. - If the file already exists in S3 and overwrite is set to false. - - - - S3FileInfo where the file is moved to. - - - - Returns a Stream for reading the contents of the file. - - The file is already open. - - - Stream to read from. - - - - Returns a StreamReader for reading the contents of the file. - - The file is already open. - - - StreamReader to read from. - - - - Returns a Stream for writing to S3. If the file already exists it will be overwritten. - - - The content will not be written to S3 until the Stream is closed. - - The file is already open. - - - Stream to write from. - - - - Replaces the destination file with the content of this file and then deletes the orignial file. If a backup location is specifed then the content of destination file is - backup to it. - - Destination bucket of this file will be copy to. - Destination object key of this file will be copy to. - Backup bucket to store the contents of the destination file. - Backup object key to store the contents of the destination file. - - - - - S3FileInfo of the destination file. - - - - Replaces the destination file with the content of this file and then deletes the orignial file. If a backupDir is specifed then the content of destination file is - backup to it. - - Where the contents of this file will be copy to. - If specified the destFile is backup to it. - - - - - S3FileInfo of the destination file. - - - - Replaces the destination file with the content of this file and then deletes the orignial file. If a backupFile is specifed then the content of destination file is - backup to it. - - Where the contents of this file will be copy to. - If specified the destFile is backup to it. - - - - - S3FileInfo of the destination file. - - - - Replaces the content of the destination file on the local file system with the content from this file from S3. - If a backup file is specified then the content of the destination file is backup to it. - - - - - - - - - - - - Implement the ToString method. - - - - - - Enumeration indicated whether a file system element is a file or directory. - - - - - Type is a directory. - - - - - Type is a file. - - - - - Common interface for both S3FileInfo and S3DirectoryInfo. - - - - - Returns true if the item exists in S3. - - - - - Returns the extension of the item. - - - - - Returns the fully qualified path to the item. - - - - - Returns the last modified time for this item from S3 in local timezone. - - - - - Returns the last modified time for this item from S3 in UTC timezone. - - - - - Returns the name of the item without parent information. - - - - - Indicates what type of item this object represents. - - - - - Deletes this item from S3. - - - - - Configuration for the S3 section of AWS configuration. - Changes to some settings may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws> - <s3 useSignatureVersion4="true" /> - </aws> - - - - - - Key for the S3UseSignatureVersion4Key property. - - - - - - Configures if the S3 client should use Signature Version 4 signing with requests. - By default, this setting is set to true which will use Signature Version 4 for all - requests except presigned URL requests when the region is set to us-east-1. When - UseSignatureVersion4 is explicitly set to true by directly setting this property or - directly setting this property through configuration, Signature Version 4 will be - used for all requests when able to do so. - When this setting is false, Signature Version 2 will be used. Note that when the - setting is false, Signature Version 4 may still be used by default in some cases - or with some regions. - - - - - Escape and unescape S3 metadata for S3 Put/Get object requests. - Escape only escapes non-ascii values in metadata - Any "%" values in metadata could interfere with this option. - Default value is false. - - - - - Was the value of the UseSignatureVersion4 property set explicitly? - This can be done via configuration or by directly setting the property. - - This is used to determine if the user set UseSignatureVersion4 to true, - or if it's true because the default was changed to true in the SDK. - - - - - V4-enabling section - - - - diff --git a/packages/AWSSDK.S3.3.3.111.14/lib/netstandard1.3/AWSSDK.S3.dll b/packages/AWSSDK.S3.3.3.111.14/lib/netstandard1.3/AWSSDK.S3.dll deleted file mode 100644 index 37afc0e..0000000 Binary files a/packages/AWSSDK.S3.3.3.111.14/lib/netstandard1.3/AWSSDK.S3.dll and /dev/null differ diff --git a/packages/AWSSDK.S3.3.3.111.14/lib/netstandard1.3/AWSSDK.S3.xml b/packages/AWSSDK.S3.3.3.111.14/lib/netstandard1.3/AWSSDK.S3.xml deleted file mode 100644 index b513fc3..0000000 --- a/packages/AWSSDK.S3.3.3.111.14/lib/netstandard1.3/AWSSDK.S3.xml +++ /dev/null @@ -1,30912 +0,0 @@ - - - - AWSSDK.S3 - - - - - Implementation for accessing S3 - - - - - - - Specialize the initialize of the client. - - - - - Create a signed URL allowing access to a resource that would - usually require authentication. - - - - When using query string authentication you create a query, - specify an expiration time for the query, sign it with your - signature, place the data in an HTTP request, and distribute - the request to a user or embed the request in a web page. - - - A PreSigned URL can be generated for GET, PUT, DELETE and HEAD - operations on your bucketName, keys, and versions. - - - The GetPreSignedUrlRequest that defines the - parameters of the operation. - determines if signing will fall back to SigV2 if the - signing region is us-east-1 - A string that is the signed http request. - - - - - - Marshalls the parameters for a presigned url for a preferred signing protocol. - - - - - - True if AWS4 signing will be used; if the expiry period in the request exceeds the - maximum allowed for AWS4 (one week), an ArgumentException is thrown. - - - - - - Create a signed URL allowing access to a resource that would - usually require authentication. - - - - When using query string authentication you create a query, - specify an expiration time for the query, sign it with your - signature, place the data in an HTTP request, and distribute - the request to a user or embed the request in a web page. - - - A PreSigned URL can be generated for GET, PUT, DELETE and HEAD - operations on your bucketName, keys, and versions. - - - The GetPreSignedUrlRequest that defines the - parameters of the operation. - A string that is the signed http request. - - - - - - Constructs AmazonS3Client with the credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - - - - Constructs AmazonS3Client with the credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - The region to connect. - - - - Constructs AmazonS3Client with the credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - The AmazonS3Client Configuration Object - - - - Constructs AmazonS3Client with AWS Credentials - - AWS Credentials - - - - Constructs AmazonS3Client with AWS Credentials - - AWS Credentials - The region to connect. - - - - Constructs AmazonS3Client with AWS Credentials and an - AmazonS3Client Configuration object. - - AWS Credentials - The AmazonS3Client Configuration Object - - - - Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - - - - Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - The region to connect. - - - - Constructs AmazonS3Client with AWS Access Key ID, AWS Secret Key and an - AmazonS3Client Configuration object. - - AWS Access Key ID - AWS Secret Access Key - The AmazonS3Client Configuration Object - - - - Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - - - - Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - The region to connect. - - - - Constructs AmazonS3Client with AWS Access Key ID, AWS Secret Key and an - AmazonS3Client Configuration object. - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - The AmazonS3Client Configuration Object - - - - Creates the signer for the service. - - - - - Customizes the runtime pipeline. - - Runtime pipeline for the current client. - - - - Capture metadata for the service. - - - - - Disposes the service client. - - - - - This operation aborts a multipart upload. After a multipart upload is aborted, no - additional parts can be uploaded using that upload ID. The storage consumed by any - previously uploaded parts will be freed. However, if any part uploads are currently - in progress, those part uploads might or might not succeed. As a result, it might - be necessary to abort a given multipart upload multiple times in order to completely - free all storage consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts operation and ensure that the parts - list is empty. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - The bucket name to which the upload was taking place. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object for which the multipart upload was initiated. - Upload ID that identifies the multipart upload. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AbortMultipartUpload service method, as returned by S3. - REST API Reference for AbortMultipartUpload Operation - - - - This operation aborts a multipart upload. After a multipart upload is aborted, no - additional parts can be uploaded using that upload ID. The storage consumed by any - previously uploaded parts will be freed. However, if any part uploads are currently - in progress, those part uploads might or might not succeed. As a result, it might - be necessary to abort a given multipart upload multiple times in order to completely - free all storage consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts operation and ensure that the parts - list is empty. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - Container for the necessary parameters to execute the AbortMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AbortMultipartUpload service method, as returned by S3. - REST API Reference for AbortMultipartUpload Operation - - - - Completes a multipart upload by assembling previously uploaded parts. - - - - You first initiate the multipart upload and then upload all parts using the UploadPart - operation. After successfully uploading all relevant parts of an upload, you call - this operation to complete the upload. Upon receiving this request, Amazon S3 concatenates - all the parts in ascending order by part number to create a new object. In the Complete - Multipart Upload request, you must provide the parts list. You must ensure that the - parts list is complete. This operation concatenates the parts that you provide in - the list. For each part in the list, you must provide the part number and the ETag - value, returned after that part was uploaded. - - - - Processing of a Complete Multipart Upload request could take several minutes to complete. - After Amazon S3 begins processing the request, it sends an HTTP response header that - specifies a 200 OK response. While processing is in progress, Amazon S3 periodically - sends white space characters to keep the connection from timing out. Because a request - could fail after the initial 200 OK response has been sent, it is important that you - check the response body to determine whether the request succeeded. - - - - Note that if CompleteMultipartUpload fails, applications should be prepared - to retry the failed requests. For more information, see Amazon - S3 Error Best Practices. - - - - For more information about multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - GetBucketLifecycle has the following special errors: - -
  • - - Error code: EntityTooSmall - -
    • - - Description: Your proposed upload is smaller than the minimum allowed object size. - Each part must be at least 5 MB in size, except the last part. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPart - -
    • - - Description: One or more of the specified parts could not be found. The part might - not have been uploaded, or the specified entity tag might not have matched the part's - entity tag. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPartOrder - -
    • - - Description: The list of parts was not in ascending order. The parts list must be - specified in order by part number. - -
    • - - 400 Bad Request - -
  • - - Error code: NoSuchUpload - -
    • - - Description: The specified multipart upload does not exist. The upload ID might be - invalid, or the multipart upload might have been aborted or completed. - -
    • - - 404 Not Found - -
- - The following operations are related to CompleteMultipartUpload: - - - - Container for the necessary parameters to execute the CompleteMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CompleteMultipartUpload service method, as returned by S3. - REST API Reference for CompleteMultipartUpload Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 Developer Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Encryption - - - - The source object that you are copying can be encrypted or unencrypted. The source - object can be encrypted with server-side encryption using AWS managed encryption keys - (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side - encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers - and decrypts the data when you access it. - - - - You can optionally use the appropriate encryption-related headers to request server-side - encryption for the target object. You have the option to provide your own encryption - key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that - was used to encrypt the source object. You can even request encryption if the source - object was not encrypted. For more information about server-side encryption, see Using - Server-Side Encryption. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject operation to change the storage class of an - object that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 Service Developer Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 Developer Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Encryption - - - - The source object that you are copying can be encrypted or unencrypted. The source - object can be encrypted with server-side encryption using AWS managed encryption keys - (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side - encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers - and decrypts the data when you access it. - - - - You can optionally use the appropriate encryption-related headers to request server-side - encryption for the target object. You have the option to provide your own encryption - key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that - was used to encrypt the source object. You can even request encryption if the source - object was not encrypted. For more information about server-side encryption, see Using - Server-Side Encryption. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject operation to change the storage class of an - object that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 Service Developer Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 Developer Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Encryption - - - - The source object that you are copying can be encrypted or unencrypted. The source - object can be encrypted with server-side encryption using AWS managed encryption keys - (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side - encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers - and decrypts the data when you access it. - - - - You can optionally use the appropriate encryption-related headers to request server-side - encryption for the target object. You have the option to provide your own encryption - key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that - was used to encrypt the source object. You can even request encryption if the source - object was not encrypted. For more information about server-side encryption, see Using - Server-Side Encryption. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject operation to change the storage class of an - object that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 Service Developer Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - Container for the necessary parameters to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - - - - - - Deletes an analytics configuration for the bucket (specified by the analytics configuration - ID). - - - - To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to DeleteBucketAnalyticsConfiguration: - -
  • - - - -
  • - - - -
  • - - - -
- - Container for the necessary parameters to execute the DeleteBucketAnalyticsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketAnalyticsConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketAnalyticsConfiguration Operation - - - - - Deletes an inventory configuration (identified by the inventory ID) from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - Operations related to DeleteBucketInventoryConfiguration include: - - - - Container for the necessary parameters to execute the DeleteBucketInventoryConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketInventoryConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketInventoryConfiguration Operation - - - - Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified - by the metrics configuration ID) from the bucket. Note that this doesn't include the - daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketMetricsConfiguration Operation - - - - This implementation of the DELETE operation uses the policy subresource to delete - the policy of a specified bucket. If you are using an identity other than the root - user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - The bucket name. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketPolicy service method, as returned by S3. - REST API Reference for DeleteBucketPolicy Operation - - - - This implementation of the DELETE operation uses the policy subresource to delete - the policy of a specified bucket. If you are using an identity other than the root - user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - Container for the necessary parameters to execute the DeleteBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketPolicy service method, as returned by S3. - REST API Reference for DeleteBucketPolicy Operation - - - - Deletes the replication configuration from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutReplicationConfiguration - action. The bucket owner has these permissions by default and can grant it to others. - For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - It can take a while for the deletion of a replication configuration to fully propagate. - - - - For information about replication configuration, see Replication - in the Amazon S3 Developer Guide. - - - - The following operations are related to DeleteBucketReplication: - - - - Container for the necessary parameters to execute the DeleteBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketReplication service method, as returned by S3. - REST API Reference for DeleteBucketReplication Operation - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - The bucket that has the tag set to be removed. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketTagging service method, as returned by S3. - REST API Reference for DeleteBucketTagging Operation - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - Container for the necessary parameters to execute the DeleteBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketTagging service method, as returned by S3. - REST API Reference for DeleteBucketTagging Operation - - - - This operation removes the website configuration for a bucket. Amazon S3 returns a - 200 OK response upon successfully deleting a website configuration on - the specified bucket. You will get a 200 OK response if the website configuration - you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE operation requires the S3:DeleteBucketWebsite permission. - By default, only the bucket owner can delete the website configuration attached to - a bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which you want to remove the website configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketWebsite service method, as returned by S3. - REST API Reference for DeleteBucketWebsite Operation - - - - This operation removes the website configuration for a bucket. Amazon S3 returns a - 200 OK response upon successfully deleting a website configuration on - the specified bucket. You will get a 200 OK response if the website configuration - you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE operation requires the S3:DeleteBucketWebsite permission. - By default, only the bucket owner can delete the website configuration attached to - a bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the DeleteBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketWebsite service method, as returned by S3. - REST API Reference for DeleteBucketWebsite Operation - - - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - The bucket name of the lifecycle to delete. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - REST API Reference for DeleteLifecycleConfiguration Operation - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - Container for the necessary parameters to execute the DeleteLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - REST API Reference for DeleteLifecycleConfiguration Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key name of the object to delete. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key name of the object to delete. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - Container for the necessary parameters to execute the DeleteObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - This operation enables you to delete multiple objects from a bucket using a single - HTTP request. If you know the object keys that you want to delete, then this operation - provides a suitable alternative to sending individual delete requests, reducing per-request - overhead. - - - - The request contains a list of up to 1000 keys that you want to delete. In the XML, - you provide the object key names, and optionally, version IDs if you want to delete - a specific version of the object from a versioning-enabled bucket. For each key, Amazon - S3 performs a delete operation and returns the result of that delete, success, or - failure, in the response. Note that if the object specified in the request is not - found, Amazon S3 returns the result as deleted. - - - - The operation supports two modes for the response: verbose and quiet. By default, - the operation uses verbose mode in which the response includes the result of deletion - of each key in your request. In quiet mode the response includes only keys where the - delete operation encountered an error. For a successful deletion, the operation does - not return any information about the delete in the response body. - - - - When performing this operation on an MFA Delete enabled bucket, that attempts to delete - any versioned objects, you must include an MFA token. If you do not provide one, the - entire request will fail, even if there are non-versioned objects you are trying to - delete. If you provide an invalid token, whether there are versioned keys in the request - or not, the entire Multi-Object Delete request will fail. For information about MFA - Delete, see - MFA Delete. - - - - Finally, the Content-MD5 header is required for all Multi-Object Delete requests. - Amazon S3 uses the header value to ensure that your request body has not been altered - in transit. - - - - The following operations are related to DeleteObjects: - - - - Container for the necessary parameters to execute the DeleteObjects service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObjects service method, as returned by S3. - REST API Reference for DeleteObjects Operation - - - - Removes the entire tag set from the specified object. For more information about managing - object tags, see - Object Tagging. - - - - To use this operation, you must have permission to perform the s3:DeleteObjectTagging - action. - - - - To delete tags of a specific object version, add the versionId query - parameter in the request. You will need permission for the s3:DeleteObjectVersionTagging - action. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteObjectTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObjectTagging service method, as returned by S3. - REST API Reference for DeleteObjectTagging Operation - - - - Removes the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:PutBucketPublicAccessBlock - permission. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to DeletePublicAccessBlock: - - - - Container for the necessary parameters to execute the DeletePublicAccessBlock service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeletePublicAccessBlock service method, as returned by S3. - REST API Reference for DeletePublicAccessBlock Operation - - - - - - - - - Returns the default encryption configuration for an Amazon S3 bucket. For information - about the Amazon S3 default encryption feature, see Amazon - S3 Default Bucket Encryption. - - - - To use this operation, you must have permission to perform the s3:GetEncryptionConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to GetBucketEncryption: - - - - Container for the necessary parameters to execute the GetBucketEncryption service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketEncryption service method, as returned by S3. - REST API Reference for GetBucketEncryption Operation - - - - Returns an inventory configuration (identified by the inventory configuration ID) - from the bucket. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - The following operations are related to GetBucketInventoryConfiguration: - - - - Container for the necessary parameters to execute the GetBucketInventoryConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketInventoryConfiguration service method, as returned by S3. - REST API Reference for GetBucketInventoryConfiguration Operation - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - The name of the bucket for which to get the location. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLocation service method, as returned by S3. - REST API Reference for GetBucketLocation Operation - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - Container for the necessary parameters to execute the GetBucketLocation service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLocation service method, as returned by S3. - REST API Reference for GetBucketLocation Operation - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - The bucket name for which to get the logging information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLogging service method, as returned by S3. - REST API Reference for GetBucketLogging Operation - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - Container for the necessary parameters to execute the GetBucketLogging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLogging service method, as returned by S3. - REST API Reference for GetBucketLogging Operation - - - - Gets a metrics configuration (specified by the metrics configuration ID) from the - bucket. Note that this doesn't include the daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to GetBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the GetBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for GetBucketMetricsConfiguration Operation - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following operation is related to GetBucketNotification: - - - - Name of the bucket for which to get the notification configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketNotification service method, as returned by S3. - REST API Reference for GetBucketNotification Operation - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following operation is related to GetBucketNotification: - - - - Container for the necessary parameters to execute the GetBucketNotification service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketNotification service method, as returned by S3. - REST API Reference for GetBucketNotification Operation - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operation is related to GetBucketPolicy: - - - - The bucket name for which to get the bucket policy. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicy service method, as returned by S3. - REST API Reference for GetBucketPolicy Operation - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operation is related to GetBucketPolicy: - - - - Container for the necessary parameters to execute the GetBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicy service method, as returned by S3. - REST API Reference for GetBucketPolicy Operation - - - - Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket - is public. In order to use this operation, you must have the s3:GetBucketPolicyStatus - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - For more information about when Amazon S3 considers a bucket public, see The - Meaning of "Public". - - - - The following operations are related to GetBucketPolicyStatus: - - - - Container for the necessary parameters to execute the GetBucketPolicyStatus service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicyStatus service method, as returned by S3. - REST API Reference for GetBucketPolicyStatus Operation - - - - Retrieves the replication configuration for the given Amazon S3 bucket. - - Container for the necessary parameters to execute the GetBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketReplication service method, as returned by S3. - REST API Reference for GetBucketReplication Operation - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - The name of the bucket for which to get the payment request configuration - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketRequestPayment service method, as returned by S3. - REST API Reference for GetBucketRequestPayment Operation - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - Container for the necessary parameters to execute the GetBucketRequestPayment service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketRequestPayment service method, as returned by S3. - REST API Reference for GetBucketRequestPayment Operation - - - - Returns the tag set associated with the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - GetBucketTagging has the following special error: - -
  • - - Error code: NoSuchTagSetError - -
    • - - Description: There is no tag set associated with the bucket. - -
- - The following operations are related to GetBucketTagging: - - - - Container for the necessary parameters to execute the GetBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketTagging service method, as returned by S3. - REST API Reference for GetBucketTagging Operation - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - The name of the bucket for which to get the versioning information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketVersioning service method, as returned by S3. - REST API Reference for GetBucketVersioning Operation - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - Container for the necessary parameters to execute the GetBucketVersioning service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketVersioning service method, as returned by S3. - REST API Reference for GetBucketVersioning Operation - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET operation requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which to get the website configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketWebsite service method, as returned by S3. - REST API Reference for GetBucketWebsite Operation - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET operation requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the GetBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketWebsite service method, as returned by S3. - REST API Reference for GetBucketWebsite Operation - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - The bucket name for which to get the cors configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetCORSConfiguration service method, as returned by S3. - REST API Reference for GetCORSConfiguration Operation - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - Container for the necessary parameters to execute the GetCORSConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetCORSConfiguration service method, as returned by S3. - REST API Reference for GetCORSConfiguration Operation - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are still using previous version of the lifecycle configuration, it works. - For the earlier API description, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to GetBucketLifecycleConfiguration: - - - - The name of the bucket for which to get the lifecycle information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetLifecycleConfiguration service method, as returned by S3. - REST API Reference for GetLifecycleConfiguration Operation - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are still using previous version of the lifecycle configuration, it works. - For the earlier API description, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to GetBucketLifecycleConfiguration: - - - - Container for the necessary parameters to execute the GetLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetLifecycleConfiguration service method, as returned by S3. - REST API Reference for GetLifecycleConfiguration Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object to get. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object to get. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - Container for the necessary parameters to execute the GetObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Gets an object's current Legal Hold status. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLegalHold service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectLegalHold service method, as returned by S3. - REST API Reference for GetObjectLegalHold Operation - - - - Gets the Object Lock configuration for a bucket. The rule specified in the Object - Lock configuration will be applied by default to every new object placed in the specified - bucket. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLockConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectLockConfiguration service method, as returned by S3. - REST API Reference for GetObjectLockConfiguration Operation - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - The name of the bucket containing the object. - The object key. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - The name of the bucket containing the object. - The object key. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - Container for the necessary parameters to execute the GetObjectMetadata service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - Retrieves an object's retention settings. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectRetention service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectRetention service method, as returned by S3. - REST API Reference for GetObjectRetention Operation - - - - Returns the tag-set of an object. You send the GET request against the tagging subresource - associated with the object. - - - - To use this operation, you must have permission to perform the s3:GetObjectTagging - action. By default, the GET operation returns information about current version of - an object. For a versioned bucket, you can have multiple versions of an object in - your bucket. To retrieve tags of any other version, use the versionId query parameter. - You also need permission for the s3:GetObjectVersionTagging action. - - - - By default, the bucket owner has this permission and can grant this permission to - others. - - - - For information about the Amazon S3 object tagging feature, see Object - Tagging. - - - - The following operation is related to GetObjectTagging: - - - - Container for the necessary parameters to execute the GetObjectTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTagging service method, as returned by S3. - REST API Reference for GetObjectTagging Operation - - - - Return torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Amazon - S3 Torrent. - - - - You can get torrent only for objects that are less than 5 GB in size and that are - not encrypted using server-side encryption with customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - The following operation is related to GetObjectTorrent: - - - - The name of the bucket containing the object for which to get the torrent files. - The object key for which to get the information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTorrent service method, as returned by S3. - REST API Reference for GetObjectTorrent Operation - - - - Return torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Amazon - S3 Torrent. - - - - You can get torrent only for objects that are less than 5 GB in size and that are - not encrypted using server-side encryption with customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - The following operation is related to GetObjectTorrent: - - - - Container for the necessary parameters to execute the GetObjectTorrent service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTorrent service method, as returned by S3. - REST API Reference for GetObjectTorrent Operation - - - - Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:GetBucketPublicAccessBlock - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket - or an object, it checks the PublicAccessBlock configuration for both - the bucket (or the bucket that contains the object) and the bucket owner's account. - If the PublicAccessBlock settings are different between the bucket and - the account, Amazon S3 uses the most restrictive combination of the bucket-level and - account-level settings. - - - - For more information about when Amazon S3 considers a bucket or an object public, - see The - Meaning of "Public". - - - - The following operations are related to GetPublicAccessBlock: - - - - Container for the necessary parameters to execute the GetPublicAccessBlock service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetPublicAccessBlock service method, as returned by S3. - REST API Reference for GetPublicAccessBlock Operation - - - - This operation is useful to determine if a bucket exists and you have permission to - access it. The operation returns a 200 OK if the bucket exists and you - have permission to access it. Otherwise, the operation might return responses such - as 404 Not Found and 403 Forbidden. - - - - To use this operation, you must have permissions to perform the s3:ListBucket - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - Container for the necessary parameters to execute the HeadBucket service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the HeadBucket service method, as returned by S3. - REST API Reference for HeadBucket Operation - - - - This operation initiates a multipart upload and returns an upload ID. This upload - ID is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort operation - and Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload API and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart) and UploadPartCopy) requests must match the headers you - used in the request to initiate the upload by using CreateMultipartUpload. - - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, - kms:GenerateDataKey*, and kms:DescribeKey actions on the - key. These permissions are required because Amazon S3 must decrypt and read data from - the encrypted file parts before it completes the multipart upload. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - The following operations are related to CreateMultipartUpload: - - - - The name of the bucket to which to initiate the upload - Object key for which the multipart upload is to be initiated. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the InitiateMultipartUpload service method, as returned by S3. - REST API Reference for InitiateMultipartUpload Operation - - - - This operation initiates a multipart upload and returns an upload ID. This upload - ID is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort operation - and Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload API and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart) and UploadPartCopy) requests must match the headers you - used in the request to initiate the upload by using CreateMultipartUpload. - - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, - kms:GenerateDataKey*, and kms:DescribeKey actions on the - key. These permissions are required because Amazon S3 must decrypt and read data from - the encrypted file parts before it completes the multipart upload. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - The following operations are related to CreateMultipartUpload: - - - - Container for the necessary parameters to execute the InitiateMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the InitiateMultipartUpload service method, as returned by S3. - REST API Reference for InitiateMultipartUpload Operation - - - - Lists the analytics configurations for the bucket. You can have up to 1,000 analytics - configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. You should always check the IsTruncated element in the response. - If there are no more configurations to list, IsTruncated is set to false. - If there are more configurations to list, IsTruncated is set to true, - and there will be a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to ListBucketAnalyticsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketAnalyticsConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketAnalyticsConfigurations service method, as returned by S3. - REST API Reference for ListBucketAnalyticsConfigurations Operation - - - - Returns a list of inventory configurations for the bucket. You can have up to 1,000 - analytics configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory - - - - The following operations are related to ListBucketInventoryConfigurations: - - - - Container for the necessary parameters to execute the ListBucketInventoryConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketInventoryConfigurations service method, as returned by S3. - REST API Reference for ListBucketInventoryConfigurations Operation - - - - Lists the metrics configurations for the bucket. The metrics configurations are only - for the request metrics of the bucket and do not provide information on daily storage - metrics. You can have up to 1,000 configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For more information about metrics configurations and CloudWatch request metrics, - see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to ListBucketMetricsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketMetricsConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketMetricsConfigurations service method, as returned by S3. - REST API Reference for ListBucketMetricsConfigurations Operation - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBuckets service method, as returned by S3. - REST API Reference for ListBuckets Operation - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - Container for the necessary parameters to execute the ListBuckets service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBuckets service method, as returned by S3. - REST API Reference for ListBuckets Operation - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Container for the necessary parameters to execute the ListMultipartUploads service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. - Limits the response to keys that begin with the specified prefix. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - Container for the necessary parameters to execute the ListObjects service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Make sure to design - your application to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - To use this operation in an AWS Identity and Access Management (IAM) policy, you must - have permissions to perform the s3:ListBucket action. The bucket owner - has this permission by default and can grant this permission to others. For more information - about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - This section describes the latest revision of the API. We recommend that you use this - revised API for application development. For backward compatibility, Amazon S3 continues - to support the prior version of this API, ListObjects. - - - - To get a list of your buckets, see ListBuckets. - - - - The following operations are related to ListObjectsV2: - - - - Container for the necessary parameters to execute the ListObjectsV2 service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjectsV2 service method, as returned by S3. - REST API Reference for ListObjectsV2 Operation - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). This request returns a maximum of 1,000 - uploaded parts. The default number of parts returned is 1,000 parts. You can restrict - the number of parts returned by specifying the max-parts request parameter. - If your multipart upload consists of more than 1,000 parts, the response returns an - IsTruncated field with the value of true, and a NextPartNumberMarker - element. In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListParts: - - - - Name of the bucket to which the parts are being uploaded. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Object key for which the multipart upload was initiated. - Upload ID identifying the multipart upload whose parts are being listed. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListParts service method, as returned by S3. - REST API Reference for ListParts Operation - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). This request returns a maximum of 1,000 - uploaded parts. The default number of parts returned is 1,000 parts. You can restrict - the number of parts returned by specifying the max-parts request parameter. - If your multipart upload consists of more than 1,000 parts, the response returns an - IsTruncated field with the value of true, and a NextPartNumberMarker - element. In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListParts: - - - - Container for the necessary parameters to execute the ListParts service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListParts service method, as returned by S3. - REST API Reference for ListParts Operation - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - Container for the necessary parameters to execute the ListVersions service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - - Creates a new bucket. To create a bucket, you must register with Amazon S3 and have - a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed - to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information on bucket naming restrictions, - see Working - with Amazon S3 Buckets. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) - Region. For more information, see How - to Select a Region for Your Buckets. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - Hosting of Buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - The name of the bucket to create. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucket service method, as returned by S3. - REST API Reference for PutBucket Operation - - - - Creates a new bucket. To create a bucket, you must register with Amazon S3 and have - a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed - to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information on bucket naming restrictions, - see Working - with Amazon S3 Buckets. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) - Region. For more information, see How - to Select a Region for Your Buckets. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - Hosting of Buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - Container for the necessary parameters to execute the PutBucket service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucket service method, as returned by S3. - REST API Reference for PutBucket Operation - - - - Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration - is a bucket-level feature that enables you to perform faster data transfers to Amazon - S3. - - - - To use this operation, you must have permission to perform the s3:PutAccelerateConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The Transfer Acceleration state of a bucket can be set to one of the following two - values: - -
  • - - Enabled – Enables accelerated data transfers to the bucket. - -
  • - - Suspended – Disables accelerated data transfers to the bucket. - -
- - The GetBucketAccelerateConfiguration operation returns the transfer acceleration - state of a bucket. - - - - After setting the Transfer Acceleration state of a bucket to Enabled, it might take - up to thirty minutes before the data transfer rates to the bucket increase. - - - - The name of the bucket used for Transfer Acceleration must be DNS-compliant and must - not contain periods ("."). - - - - For more information about transfer acceleration, see Transfer - Acceleration. - - - - The following operations are related to PutBucketAccelerateConfiguration: - - - - Container for the necessary parameters to execute the PutBucketAccelerateConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketAccelerateConfiguration service method, as returned by S3. - REST API Reference for PutBucketAccelerateConfiguration Operation - - - - - - - Set the logging parameters for a bucket and to specify permissions for who can view - and modify the logging parameters. All logs are saved to buckets in the same AWS Region - as the source bucket. To set the logging status of a bucket, you must be the bucket - owner. - - - - The bucket owner is automatically granted FULL_CONTROL to all logs. You use the Grantee - request element to grant access to other people. The Permissions request - element specifies the kind of access the grantee has to the logs. - - - - Grantee Values - - - - You can specify the person (grantee) to whom you're assigning access rights (using - request elements) in the following ways: - -
  • - - By the person's ID: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> - </Grantee> - - - - DisplayName is optional and ignored in the request. - -
  • - - By Email address: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee> - - - - - The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl - request, appears as the CanonicalUser. - -
  • - - By URI: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee> - - -
- - To enable logging, you use LoggingEnabled and its children request elements. To disable - logging, you use an empty BucketLoggingStatus request element: - - - - <BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01" /> - - - - - For more information about server access logging, see Server - Access Logging. - - - - For more information about creating a bucket, see CreateBucket. For more information - about returning the logging status of a bucket, see GetBucketLogging. - - - - The following operations are related to PutBucketLogging: - - - - Container for the necessary parameters to execute the PutBucketLogging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketLogging service method, as returned by S3. - REST API Reference for PutBucketLogging Operation - - - - Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. - You can have up to 1,000 metrics configurations per bucket. If you're updating an - existing metrics configuration, note that this is a full replacement of the existing - metrics configuration. If you don't include the elements you want to keep, they are - erased. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to PutBucketMetricsConfiguration: - - - - GetBucketLifecycle has the following special error: - -
  • - - Error code: TooManyConfigurations - -
    • - - Description: You are attempting to create a new configuration but have already reached - the 1,000-configuration limit. - -
    • - - HTTP Status Code: HTTP 400 Bad Request - -
- - Container for the necessary parameters to execute the PutBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for PutBucketMetricsConfiguration Operation - - - - Enables notifications of specified events for a bucket. For more information about - event notifications, see Configuring - Event Notifications. - - - - Using this API, you can replace an existing notification configuration. The configuration - is an XML file that defines the event types that you want Amazon S3 to publish and - the destination where you want Amazon S3 to publish an event notification when it - detects an event of the specified type. - - - - By default, your bucket has no event notifications configured. That is, the notification - configuration will be an empty NotificationConfiguration. - - - - <NotificationConfiguration> - - - - </NotificationConfiguration> - - - - This operation replaces the existing notification configuration with the configuration - you include in the request body. - - - - After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification - Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, - and that the bucket owner has permission to publish to it by sending a test notification. - In the case of AWS Lambda destinations, Amazon S3 verifies that the Lambda function - permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. - For more information, see Configuring - Notifications for Amazon S3 Events. - - - - You can disable notifications by adding the empty NotificationConfiguration element. - - - - By default, only the bucket owner can configure notifications on a bucket. However, - bucket owners can use a bucket policy to grant permission to other users to set this - configuration with s3:PutBucketNotification permission. - - - - The PUT notification is an atomic operation. For example, suppose your notification - configuration includes SNS topic, SQS queue, and Lambda function configurations. When - you send a PUT request with this configuration, Amazon S3 sends test messages to your - SNS topic. If the message fails, the entire PUT operation will fail, and Amazon S3 - will not add the configuration to your bucket. - - - - Responses - - - - If the configuration in the request body includes only one TopicConfiguration - specifying only the s3:ReducedRedundancyLostObject event type, the response - will also include the x-amz-sns-test-message-id header containing the - message ID of the test notification sent to the topic. - - - - The following operation is related to PutBucketNotificationConfiguration: - - - - Container for the necessary parameters to execute the PutBucketNotification service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketNotification service method, as returned by S3. - REST API Reference for PutBucketNotification Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - The MD5 hash of the request body. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - Container for the necessary parameters to execute the PutBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Creates a replication configuration or replaces an existing one. For more information, - see Replication - in the Amazon S3 Developer Guide. - - - - To perform this operation, the user or role performing the operation must have the - iam:PassRole - permission. - - - - Specify the replication configuration in the request body. In the replication configuration, - you provide the name of the destination bucket where you want Amazon S3 to replicate - objects, the IAM role that Amazon S3 can assume to replicate objects on your behalf, - and other relevant information. - - - - A replication configuration must include at least one rule, and can contain a maximum - of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects - in the source bucket. To choose additional subsets of objects to replicate, add a - rule for each subset. All rules must specify the same destination bucket. - - - - To specify a subset of the objects in the source bucket to apply a replication rule - to, add the Filter element as a child of the Rule element. You can filter objects - based on an object key prefix, one or more object tags, or both. When you add the - Filter element in the configuration, you must also add the following elements: DeleteMarkerReplication, - Status, and Priority. - - - - For information about enabling versioning on a bucket, see Using - Versioning. - - - - By default, a resource owner, in this case the AWS account that created the bucket, - can perform this operation. The resource owner can also grant others permissions to - perform the operation. For more information about permissions, see Specifying - Permissions in a Policy and Managing - Access Permissions to Your Amazon S3 Resources. - - - - Handling Replication of Encrypted Objects - - - - By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side - encryption with CMKs stored in AWS KMS. To replicate AWS KMS-encrypted objects, add - the following: SourceSelectionCriteria, SseKmsEncryptedObjects, - Status, EncryptionConfiguration, and ReplicaKmsKeyID. - For information about replication configuration, see Replicating - Objects Created with SSE Using CMKs stored in AWS KMS. - - - - For information on PutBucketReplication errors, see ReplicationErrorCodeList - - - - - The following operations are related to PutBucketReplication: - - - - Container for the necessary parameters to execute the PutBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketReplication service method, as returned by S3. - REST API Reference for PutBucketReplication Operation - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - The bucket name. - Container for Payer. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketRequestPayment service method, as returned by S3. - REST API Reference for PutBucketRequestPayment Operation - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - Container for the necessary parameters to execute the PutBucketRequestPayment service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketRequestPayment service method, as returned by S3. - REST API Reference for PutBucketRequestPayment Operation - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging. - - - - Within a bucket, if you add a tag that has the same key as an existing tag, the new - value overwrites the old value. For more information, see Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional operation is currently in progress against - this resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - The bucket name. - A property of PutBucketTaggingRequest used to execute the PutBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketTagging service method, as returned by S3. - REST API Reference for PutBucketTagging Operation - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging. - - - - Within a bucket, if you add a tag that has the same key as an existing tag, the new - value overwrites the old value. For more information, see Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional operation is currently in progress against - this resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - Container for the necessary parameters to execute the PutBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketTagging service method, as returned by S3. - REST API Reference for PutBucketTagging Operation - - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT operation requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - Amazon S3 has a limitation of 50 routing rules per website configuration. If you require - more than 50 routing rules, you can use object redirect. For more information, see - Configuring - an Object Redirect in the Amazon Simple Storage Service Developer Guide. - - - The bucket name. - Container for the request. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketWebsite service method, as returned by S3. - REST API Reference for PutBucketWebsite Operation - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT operation requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - Amazon S3 has a limitation of 50 routing rules per website configuration. If you require - more than 50 routing rules, you can use object redirect. For more information, see - Configuring - an Object Redirect in the Amazon Simple Storage Service Developer Guide. - - - Container for the necessary parameters to execute the PutBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketWebsite service method, as returned by S3. - REST API Reference for PutBucketWebsite Operation - - - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - The name of the bucket for which to set the configuration. - A property of PutLifecycleConfigurationRequest used to execute the PutLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutLifecycleConfiguration service method, as returned by S3. - REST API Reference for PutLifecycleConfiguration Operation - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - Container for the necessary parameters to execute the PutLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutLifecycleConfiguration service method, as returned by S3. - REST API Reference for PutLifecycleConfiguration Operation - - - - - - - - - - - - - - - - - Configuration for accessing AmazonS3 service - - - Configuration for accessing Amazon S3 service - - - - - When true, requests will always use path style addressing. - - - - - Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. - To use this feature, the bucket name should be DNS compliant names and should not contain periods (.). - The following APIs are not supported and are sent to the regular region endpoint, even if this option is enabled: -
    -
  1. PutBucket
    2. -
  2. ListBuckets
    3. -
  3. DeleteBucket
    4. -
- - - This option cannot be used at the same time as UseDualstackEndpoint. - - - - - If set to true and the service package supports it the region identified in the arn for a resource - will be used when making the service request. - - - - - USEast1RegionalEndpointValue determines wheter or not - to send the us-east-1 s3 requests to the regional endpoint or to - the legacy global endpoint. - This flags takes precedence over the AWS_S3_US_EAST_1_REGIONAL_ENDPOINT - environment variable and the credential file. - - - - - This method contains custom initializations for the config object. - - - - - Given this client configuration, returns the service url - - The service url in the form of a string - - - - If the client is configured to hit us-east-1 with the S3UsEast1RegionalEndpointValue flag not set, - this method checks whether the environment variable is present or the credential file contains a valid value - - A Nullable of S3UsEast1RegionalEndpointValue representing the client configuration for the regional us-east-1 endpoint - - - - Validate that the config object is properly configured. - - - - - Checks the AWS_S3_US_EAST_1_REGIONAL_ENDPOINT environment variable for the presence of the s3 regional flag - - A nullable of S3UsEast1RegionalEndpointValue - - - - Checks the credential file for the presence of the s3 regional flag - - A nullable of S3UsEast1RegionalEndpointValue - - - - Default constructor - - - - - The constant used to lookup in the region hash the endpoint. - - - - - Gets the ServiceVersion property. - - - - - Gets the value of UserAgent property. - - - - - Base exception for S3 errors. - - - - - Construct an instance of AmazonS3Exception - - - - - - Construct an instance of AmazonS3Exception - - - - - - - Construct an instance of AmazonS3Exception - - - - - - Construct an instance of AmazonS3Exception - - - - - - - - - - Construct an instance of AmazonS3Exception - - - - - - - - - - - Construct an instance of AmazonS3Exception - - - - - - - - - - - - Construct an instance of AmazonS3Exception - - - - - - - - - - - - - A special token that helps AWS troubleshoot problems. - - - - - A special token that helps AWS troubleshoot S3 accelerate problems. - - - - - The entire response body for this exception, if available. - - - - - The region that the AmazonS3Exception relates to. - - - - - Gets the exception message. - - - - - Extensions methods added to Amazon.Arn type to help parse S3 specific resources from the ARN. - - - - - Attempt to parse the resource component of the ARN into access point resource name. - - An AWS ARN to parse - The access point resouce identifier found in the ARN. - True if the ARN contains an access point resource identifier. - - - - Attempt to parse the resource component of the ARN into bucket name. - - An AWS ARN to parse - The bucket name found in the ARN. - True if the ARN contains a bucket name. - - - - Custom pipeline handler to clean up streams in case of an exception. - - - - - Catch exceptions and clean up any open streams. - - - - - - Catch exceptions and clean up any open streams. - - - - - - - Custom pipeline handler to enable sig V4 for Get requests. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Custom pipeline handler to enable sig V4 for Get requests. - - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Calls the post invoke logic after calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls the and post invoke logic after calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Constructor for AmazonS3RetryPolicy. - - The IClientConfig object - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - - - a value if it can be determined, or null if the IO-bound calculations need to be done - - - - Return true if the request should be retried. Implements additional checks - specific to S3 on top of the checks in DefaultRetryPolicy. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Constructor for AmazonS3StandardRetryPolicy. - - The IClientConfig object - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - - - a value if it can be determined, or null if the IO-bound calculations need to be done - - - - Return true if the request should be retried. Implements additional checks - specific to S3 on top of the checks in StandardRetryPolicy. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Constructor for AmazonS3AdaptiveRetryPolicy. - - The IClientConfig object - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - - - a value if it can be determined, or null if the IO-bound calculations need to be done - - - - Return true if the request should be retried. Implements additional checks - specific to S3 on top of the checks in AdaptiveRetryPolicy. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Marker interface to identify AmazonS3EncryptionClient. - - - - - Service metadata for Amazon S3 service - - - - - Gets the value of the Service Id. - - - - - Gets the dictionary that gives mapping of renamed operations - - - - - The parameters to request an abort of a multipart upload. - - - After a multipart upload is aborted, no additional parts can be uploaded using that upload ID. - The storage consumed by any previously uploaded parts will be freed. However, if any part uploads - are currently in progress, those part uploads might or might not succeed. As a result, it might be - necessary to abort a given multipart upload multiple times in order to completely free all storage - consumed by all parts. - - - - - The bucket name to which the upload was taking place. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The key of the S3 object that was being uploaded. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - The upload id for the in-progress multipart upload that should be aborted. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the AbortMultipartUpload response metadata. - The AbortMultipartUpload operation has a void result type. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Bucket accelerate configuration. - - - - - The accelerate status of the bucket. - - - - - AccessControlTranslation class - - - - - The override value for the owner of the replica object. - - - - - Class for AnalyticsAndOperator - A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. - The operator must have at least two predicates, and an object must match all of the predicates - in order for the filter to apply. - - Note: The current implementation restricts the usage to atmost one AnalyticsPrefixPredicate - and any number of AnalyticsTagPredicates. - - - - Class for AnalyticsConfiguration - - - - - The identifier used to represent an analytics configuration. - - - - - The filter used to describe a set of objects for analyses. - A filter must have exactly one prefix, one tag, or one conjunction (AnalyticsAndOperator). - If no filter is provided, all objects will be considered in any analysis. - - - - - If present, it indicates that data related to access patterns will be collected - and made available to analyze the tradeoffs between different storage classes. - - - - - Class for AnalyticsExportDestination - - - - - A destination signifying output to an S3 bucket. - - - - - Filter class for Metrics. - - - - - Filter Predicate setup for specific filter types. - - - - - Filter Predicate abstract class for specific filter types to be derived from. - - - - - Abstract class that can be used over logical filter predicates,i.e. AND/OR. - - - - - Internal implementation of Metrics Predicate visitor interface. - - - - - Interface for implementing visitor pattern in Analytics Predicate Filter. - - - - - Interface for implementing visitor pattern in Inventory Predicate Filter. - - - - - Interface for implementing visitor pattern in Metrics Predicate Filter. - - - - - Defines the interface that is used to visit all the different - implementations of - - - - - Visit a - - - - - - Visit a - - - - - - Visit a - - - - - - Implementation of to marshall . - - - - - AbortIncompleteMultipartUpload Unmarshaller - - - - - Abort Multipart Upload Request Marshaller - - - - - Response Unmarshaller for AbortMultipartUpload operation - - - - - AnalyticsConfiguration Unmarshaller - - - - - AnalyticsExportDestinationUnmarshaller - - - - - AnalyticsFilter Unmarshaller - - - - - AnalyticsS3BucketDestination Unmarshaller - - - - - Bucket Unmarshaller - - - - - CommonPrefixesItem Unmarshaller - - - - - Complete Multipart Upload Request Marshaller - - - - - Response Unmarshaller for CompleteMultipartUpload operation - - - - - ContentsItem Unmarshaller - - - - - Copy Object Request Marshaller - - - - - Response Unmarshaller for CopyObject operation - - - - - Upload Part Copy Request Marshaller - - - - - Response Unmarshaller for CopyPart operation - - - - - CORSRule Unmarshaller - - - - - Response Unmarshaller for DefaultRetention Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Delete InventoryConfiguration Request Marshaller - - - - - Response Unmarshaller for DeleteAnalyticsConfiguration operation - - - - - Response Unmarshaller for DeleteCORSConfiguration operation - - - - - Delete InventoryConfiguration Request Marshaller - - - - - Response Unmarshaller for DeleteInventoryConfiguration operation - - - - - Delete Bucket MetricsConfiguration Request Marshaller - - - - - Response Unmarshaller for DeleteBucketMetricsConfiguration operation - - - - - Delete Bucket Policy Request Marshaller - - - - - Response Unmarshaller for DeleteBucketPolicy operation - - - - - Delete Bucket Request Marshaller - - - - - Response Unmarshaller for DeleteBucket operation - - - - - Delete Bucket Tagging Request Marshaller - - - - - Response Unmarshaller for DeleteBucketTagging operation - - - - - Delete Bucket Website Request Marshaller - - - - - Response Unmarshaller for DeleteBucketWebsite operation - - - - - Delete Bucket Cors Request Marshaller - - - - - DeletedObject Unmarshaller - - - - - Delete Bucket Lifecycle Request Marshaller - - - - - Response Unmarshaller for DeleteBucketLifecycle operation - - - - - Delete Object Request Marshaller - - - - - Response Unmarshaller for DeleteObject operation - - - - - Delete Objects Request Marshaller - - - - - Response Unmarshaller for DeleteObjects operation - - - - - DeleteObjectTaggingRequest Marshaller - - - - - Marshall DeleteObjectTaggingRequest object into an http request. - - - - - Marshall DeleteObjectTaggingRequest object into an http request. - - - - - Response Unmarshaller for DeleteObjectTagging operation - - - - - DeletePublicAccessBlock Request Marshaller - - - - - Response Unmarshaller for DeletePublicAccessBlock operation - - - - - ErrorsItem Unmarshaller - - - - - Expiration Unmarshaller - - - - - FilterRule Unmarshaller - - - - - Filter Unmarshaller - - - - - Get Object Acl Request Marshaller - - - - - Response Unmarshaller for GetACL operation - - - - - Get Object Accelerate Configuration Request Marshaller - - - - - Response Unmarshaller for GetACL operation - - - - - Get BucketAnalyticsConfiguration Request Marshaller - - - - - Response Unmarshaller for GetAnalyticsConfiguration operation - - - - - Get InventoryConfiguration Request Marshaller - - - - - Response Unmarshaller for GetInventoryConfiguration operation - - - - - Get Bucket Location Request Marshaller - - - - - Response Unmarshaller for GetBucketLocation operation - - - - - Get Bucket Logging Request Marshaller - - - - - Response Unmarshaller for GetBucketLogging operation - - - - - Get Bucket MetricsConfigurationRequest Marshaller - - - - - Response Unmarshaller for GetBucketMetricsConfiguration operation - - - - - Get Bucket Notification Request Marshaller - - - - - Response Unmarshaller for GetBucketNotification operation - - - - - Get BucketName Policy Request Marshaller - - - - - Response Unmarshaller for GetBucketPolicy operation - - - - - GetBucketPolicyStatusRequestMarshaller - - - - - Response Unmarshaller for GetBucketPolicyStatus operation - - - - - Get Bucket Request Payment Request Marshaller - - - - - Response Unmarshaller for GetBucketRequestPayment operation - - - - - Get Bucket Tagging Request Marshaller - - - - - Response Unmarshaller for GetBucketTagging operation - - - - - Get Bucket Versioning Request Marshaller - - - - - Response Unmarshaller for GetBucketVersioning operation - - - - - Get Bucket Website Request Marshaller - - - - - Response Unmarshaller for GetBucketWebsite operation - - - - - Get Bucket Cors Request Marshaller - - - - - Response Unmarshaller for GetCORSConfiguration operation - - - - - Get Bucket Lifecycle Request Marshaller - - - - - Response Unmarshaller for GetLifecycleConfiguration operation - - - - - GetObjectLegalHold Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for GetObjectLegalHold operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - GetObjectLockConfiguration Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for GetObjectLockConfiguration operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - GetObjectMetadata Marshaller - - - - - Response Unmarshaller for GetObjectMetadata operation - - - - - Get Object Request Marshaller - - - - - Response Unmarshaller for GetObject operation - - - - - GetObjectRetention Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for GetObjectRetention operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - GetObjectTaggingRequest Marshaller - - - - - Marshall GetObjectTaggingRequest into an http request. - - - - - Marshall GetObjectTaggingRequest into an http request. - - - - - Response Unmarshaller for GetObjectTagging operation - - - - - Get Object Torrent Request Marshaller - - - - - Response Unmarshaller for GetObjectTorrent operation - - - - - GetPublicAccessBlockRequestMarshaller - - - - - Response Unmarshaller for GetPublicAccessBlock operation - - - - - Grantee Unmarshaller - - - - - Grant Unmarshaller - - - - - Head Bucket Request Marshaller - - - - - Response Unmarshaller for HeadBucket operation - - - - - Create Multipart Upload Request Marshaller - - - - - Response Unmarshaller for InitiateMultipartUpload operation - - - - - Initiator Unmarshaller - - - - - InventoryConfiguration Unmarshaller - - - - - InventoryDestination Unmarshaller - - - - - InventoryEncryption Unmarshaller - - - - - InventoryFilter Unmarshaller - - - - - InventoryS3BucketDestination Unmarshaller - - - - - InventorySchedule Unmarshaller - - - - - LifecycleFilterPredicate Unmarshaller - - - - - LifecycleRuleNoncurrentVersionExpiration Unmarshaller - - - - - LifecycleRuleNoncurrentVersionTransition Unmarshaller - - - - - List AnalyticsConfiguration Request Marshaller - - - - - Response Unmarshaller for ListAnalyticsConfiguration operation - - - - - List InventoryConfiguration Request Marshaller - - - - - Response Unmarshaller for ListInventoryConfiguration operation - - - - - List Bucket MetricsConfigurationRequest Marshaller - - - - - Response Unmarshaller for ListBucketMetricsConfiguration operation - - - - - List Buckets Request Marshaller - - - - - Response Unmarshaller for ListBuckets operation - - - - - List Multipart Uploads Request Marshaller - - - - - Response Unmarshaller for ListMultipartUploads operation - - - - - List Objects Request Marshaller - - - - - Response Unmarshaller for ListObjects operation - - - - - List Objects Request Marshaller - - - - - Response Unmarshaller for ListObjects operation - - - - - List Parts Request Marshaller - - - - - Response Unmarshaller for ListParts operation - - - - - List Object Versions Request Marshaller - - - - - Response Unmarshaller for ListVersions operation - - - - - LoggingEnabled Unmarshaller - - - - - MetricsConfiguration Unmarshaller - - - - - MetricsFilte Unmarshaller - - - - - UploadsItem Unmarshaller - - - - - Response Unmarshaller for ObjectLockConfiguration Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Response Unmarshaller for ObjectLockLegalHold Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Response Unmarshaller for ObjectLockRetention Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Response Unmarshaller for ObjectLockRule Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Owner Unmarshaller - - - - - PartsItem Unmarshaller - - - - - PolicyStatus Unmarshaller - - - - - PublicAccessBlockConfiguration Unmarshaller - - - - - Put Object Acl Request Marshaller - - - - - Response Unmarshaller for PutObjectAcl operation - - - - - Put Object Acl Request Marshaller - - - - - Response Unmarshaller for PutBucketAccelerate operation - - - - - Request Marshaller for PutAnalyticsConfiguration operation - - - - - Response Unmarshaller for PutBucketAnalytics operation - - - - - Request Marshaller for PutInventoryConfiguration operation - - - - - Response Unmarshaller for PutBucketWebsite operation - - - - - Enable Bucket Logging Request Marshaller - - - - - Response Unmarshaller for PutBucketLogging operation - - - - - Put Bucket MetricsConfigurationRequest Marshaller - - - - - Response Unmarshaller for PutBucketMetricsConfiguration operation - - - - - Put Bucket Notification Request Marshaller - - - - - Response Unmarshaller for PutBucketNotification operation - - - - - Put Bucket Policy Request Marshaller - - - - - Response Unmarshaller for PutBucketPolicy operation - - - - - Put Buckeyt Replication Request Marshaller - - - - - Response Unmarshaller for PutBucketReplication operation. - - - - - Put Bucket Request Marshaller - - - - - Put Bucket Request Payment Request Marshaller - - - - - Response Unmarshaller for PutBucketRequestPayment operation - - - - - Response Unmarshaller for PutBucket operation - - - - - Put Bucket Tagging Request Marshaller - - - - - Response Unmarshaller for PutBucketTagging operation - - - - - Put Bucket Versioning Request Marshaller - - - - - Response Unmarshaller for PutBucketVersioning operation - - - - - Put Bucket Website Request Marshaller - - - - - Response Unmarshaller for PutBucketWebsite operation - - - - - Put Bucket Cors Request Marshaller - - - - - Response Unmarshaller for PutCORSConfiguration operation - - - - - Put Bucket Lifecycle Request Marshaller - - - - - Response Unmarshaller for PutLifecycleConfiguration operation - - - - - PutObjectLegalHold Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for PutObjectLegalHold operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - PutObjectLockConfiguration Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for PutObjectLockConfiguration operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Put Object Request Marshaller - - - - - Response Unmarshaller for PutObject operation - - - - - PutObjectRetention Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for PutObjectRetention operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Delete Object Tagging Request Marshaller - - - - - Marshall PutObjectTaggingRequest into an http request. - - - - - Marshall PutObjectTaggingRequest into an http request. - - - - - Response Unmarshaller for DeleteObjectTagging operation - - - - - PutPublicAccessBlock Request Marshaller - - - - - Response Unmarshaller for PutPublicAccessBlock operation - - - - - Restore Object Request Marshaller - - - - - Response Unmarshaller for RestoreObject operation - - - - - Condition Unmarshaller - - - - - Redirect Unmarshaller - - - - - RoutingRule Unmarshaller - - - - - RulesItem Unmarshaller - - - - - Response Unmarshaller for all Errors - - - - - Build an S3ErrorResponse from XML - - The XML parsing context. - Usually an Amazon.Runtime.Internal.UnmarshallerContext. - An S3ErrorResponse object. - - - - Grant Unmarshaller - - - - - Class for unmarshalling S3 service responses - - - - - Specialized S3 unmarshaller context. - - - - - Wrap an XmlTextReader with state for event-based parsing of an XML stream. - - Stream with the XML from a service response. - If set to true, maintains a copy of the complete response body as the stream is being read. - Response data coming back from the request - If set to is true, configure unmarshaller with exception specifics. - - - - Reads to the next node in the XML document, and updates the context accordingly. - If node is RequestId, reads the contents and stores in RequestId property. - - - True if a node was read, false if there are no more elements to read./ - - - - - SSEKMS Unmarshaller - - - - - StorageClassAnalysisDataExportDataExportUnmarshaller - - - - - StorageClassAnalysisUnmarshaller - - - - - Tag Unmarshaller - - - - - TopicConfiguration Unmarshaller - - - - - Transition Unmarshaller - - - - - Upload Part Request Marshaller - - - - - Response Unmarshaller for UploadPart operation - - - - - VersionsItem Unmarshaller - - - - - Internal implementation of Inventory Predicate visitor interface. - - - - - Internal implementation of Metrics Predicate visitor interface. - - - - - Class for AnalyticsPrefixPredicate - The prefix used when evaluating a metrics filter. - - - - - Class for AnalyticsS3BucketDestination - - - - - The file format used when exporting data to Amazon S3. - - - - - The account ID that owns the destination bucket. If no account ID is provided, the owner will not be validated prior to exporting data. - - - - - The Amazon resource name (ARN) of the bucket to which data is exported. - - - - - The prefix to use when exporting data. The exported data begins with this prefix. - - - - - Class for MetricsTagPredicate - The tag used when evaluating a metrics filter. - - - - - This class represents the byte range for a range GET from S3. - - - - - Constructs a ByteRange and sets the start and end. - - - - - - - Constructs a ByteRange and sets the header to the value specified. - - - - - - A private string, represending the byte range. - - - - - The starting byte number of the range - - - - - The ending byte number of the range - - - - - The formatted string representing the byte range to be set for the range header. - - - - - Container for the parameters to the CompleteMultipartUpload operation. - Completes a multipart upload by assembling previously uploaded parts. - - - - - The name of the bucketName containing the S3 object that was being uploaded in parts. - - - - - The key of the S3 object that was being uploaded. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - A collection of part numbers and corresponding etags. - - - - - Adds a collection of part numbers and corresponding etags. - - PartETags that will added to this request. - - - - Adds a collection of part numbers and corresponding etags. - - PartETags that will added to this request. - - - - Adds a collection of part numbers and corresponding etags by transforming the UploadPartResponses into PartETags. - - The list of response objects return from UploadParts. - - - - Adds a collection of part numbers and corresponding etags by transforming the UploadPartResponses into PartETags. - - The list of response objects return from UploadParts. - - - - Adds a collection of part numbers and corresponding etags by transforming the CopyPartResponse into PartETags. - - The list of response objects return from CopyParts. - - - - Adds a collection of part numbers and corresponding etags by transforming the CopyPartResponse into PartETags. - - The list of response objects return from CopyParts. - - - - The upload id for the in-progress multipart upload that should be completed. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the CompleteMultipartUpload response and response metadata. - - - - - Gets and sets the URI that identifies the newly created object. - - - - - Gets and sets the name of the bucketName that contains the newly created object. - - - - - Gets and sets the object key of the newly created object. - - - - - Gets and sets Entity tag that identifies the newly created object's data. Objects with different - object data will have different entity tags. The entity tag is an opaque string. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - Gets and sets the ServerSideEncryptionMethod property. - Specifies the encryption used on the server to - store the content. - Default is None. - - - - - Gets and sets the VersionId property. - This is the version-id of the S3 object - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the CopyObject operation. - Creates a copy of an object that is already stored in Amazon S3. - - - - - The name of the bucket containing the object to copy. - - - - - Checks if SourceBucket property is set. - - true if SourceBucket property is set. - - - - The key of the object to copy. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Checks if SourceKey property is set. - - true if SourceKey property is set. - - - - Specifies a particular version of the source object to copy. By default the latest version is copied. - - - - - Checks if SourceVersionId property is set. - - true if SourceVersionId property is set. - - - - The name of the bucket to contain the copy of the source object. - - - - - Checks if DestinationBucket property is set. - - true if DestinationBucket property is set. - - - - The key to be given to the copy of the source object. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Checks if DestinationKey property is set. - - true if DestinationKey property is set. - - - - A canned access control list (CACL) to apply to the object. - Please refer to for - information on S3 Canned ACLs. - - - - - ETag to be matched as a pre-condition for copying the source object - otherwise returns a PreconditionFailed. - - - Copies the object if its entity tag (ETag) matches - the specified tag; otherwise return a 412 (precondition failed). - Constraints: This property can be used with IfUnmodifiedSince, - but cannot be used with other conditional copy properties. - - - - - Checks if ETagToMatch property is set. - - - Copies the object if its entity tag (ETag) is different - than the specified Etag; otherwise returns a 412 (failed condition). - Constraints: This header can be used with IfModifiedSince, but cannot - be used with other conditional copy properties. - - true if ETagToMatch property is set. - - - - ETag that must not be matched as a pre-condition for copying the source object, - otherwise returns a PreconditionFailed. - - - - - Checks if ETagToNotMatch property is set. - - true if ETagToNotMatch property is set. - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or - ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Copies the object if it has been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it has been modified since the - specified time; otherwise returns a 412 (failed condition). - Constraints: This property can be used with ETagToNotMatch, - but cannot be used with other conditional copy properties. - - - - - Copies the object if it has been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it has been modified since the - specified time; otherwise returns a 412 (failed condition). - Constraints: This property can be used with ETagToNotMatch, - but cannot be used with other conditional copy properties. - - - - - Checks if ModifiedSinceDateUtc property is set. - - true if ModifiedSinceDateUtc property is set. - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or - UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Copies the object if it has not been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it hasn't been modified since the - specified time; otherwise returns a 412 (precondition failed). - Constraints: This property can be used with ETagToMatch, - but cannot be used with other conditional copy properties. - - - - - Copies the object if it has not been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it hasn't been modified since the - specified time; otherwise returns a 412 (precondition failed). - Constraints: This property can be used with ETagToMatch, - but cannot be used with other conditional copy properties. - - - - - Checks if UnmodifiedSinceDateUtc property is set. - - true if UnmodifiedSinceDateUtc property is set. - - - - Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request. - - - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - Specifies whether you want to apply a Legal Hold to the copied object. - - - - - - Gets and sets the property ObjectLockMode. - - The Object Lock mode that you want to apply to the copied object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - The date and time when you want the copied object's Object Lock to expire. - - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - Checks if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - true if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - - - The type of storage to use for the object. Defaults to 'STANDARD'. - - - - - - If the bucketName is configured as a website, redirects requests for this object to another object in the same bucketName or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - This is a convenience property for Headers.ContentType. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - /// - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The customer provided encryption key for the source object of the copy. - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - true if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the CopySourceServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if CopySourceServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - The tag-set for the object destination object this value must be used in conjunction with the TaggingDirective. The tag-set must be encoded as URL Query parameters. - - - - - Checks if Tagging property is set - - true if Tagging is set. - - - - Returns information about the CopyObject response and response metadata. - - - - - Gets and sets the ETag property. - - - - - Gets and sets the LastModified property. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - Gets and sets the SourceVersionId property. - This is the Version Id of the Source Object - - - - - Version ID of the newly created copy. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the CopyPart operation. - Uploads a part by copying data from an existing object as data source. - - - - - The name of the bucket containing the object to copy. - - - - - Checks if SourceBucket property is set. - - true if SourceBucket property is set. - - - - The key of the object to copy. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Checks if SourceKey property is set. - - true if SourceKey property is set. - - - - Specifies a particular version of the source object to copy. By default the latest version is copied. - - - - - Checks if SourceVersionId property is set. - - true if SourceVersionId property is set. - - - - The name of the bucket to contain the copy of the source object. - - - - - Checks if DestinationBucket property is set. - - true if DestinationBucket property is set. - - - - The key to be given to the copy of the source object. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Checks if DestinationKey property is set. - - true if DestinationKey property is set. - - - - The ID identifying multipart upload for which we are copying a part. - - - - - Checks if UploadId property is set. - - true if UploadId property is set. - - - - Collection of ETags to be matched as a pre-condition for copying the source object - otherwise returns a PreconditionFailed. - - - Copies the object if its entity tag (ETag) matches one of - the specified tags; otherwise return a 412 (precondition failed). - Constraints: This property can be used with IfUnmodifiedSince, - but cannot be used with other conditional copy properties. - - - - - Checks if ETagsToMatch property is set. - - true if ETagToMatch property is set. - - - - Collection of ETags that must not be matched as a pre-condition for copying the source object - otherwise returns a PreconditionFailed. - - - Copies the object if its entity tag (ETag) does not match any of the specified - tags; otherwise returns a 412 (failed condition). - Constraints: This header can be used with IfModifiedSince, but cannot - be used with other conditional copy properties. - - - - - Checks if ETagToNotMatch property is set. - - true if ETagToNotMatch property is set. - - - - Copies the object if it has been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it has been modified since the - specified time; otherwise returns a 412 (failed condition). - Constraints: This property can be used with ETagToNotMatch, - but cannot be used with other conditional copy properties. - - - - - Checks if ModifiedSinceDate property is set. - - true if ModifiedSinceDate property is set. - - - - Copies the object if it has not been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it hasn't been modified since the - specified time; otherwise returns a 412 (precondition failed). - Constraints: This property can be used with ETagToMatch, - but cannot be used with other conditional copy properties. - - - - - Checks if UnmodifiedSinceDate property is set. - - true if UnmodifiedSinceDate property is set. - - - - The number of the part to be copied. - - - Valid part numbers are from 1 to 10,000 inclusive and will uniquely identify the part - and determine the relative ordering within the destination object. If a part already - exists with the PartNumber it will be overwritten. - - - - - Checks if PartNumber property is set. - - true if PartNumber property is set. - - - - The location of the first byte in the range if only a portion of the - source object is to be copied as the part. - - - The LastByte property must also be set or this value will be ignored. - - - - - Checks if FirstByte property is set. - - true if FirstByte property is set. - - - - The location of the last byte in the range if only a portion of the - source object is to be copied as the part. - - - The FirstByte property must also be set or this value will be ignored. - - - - - Checks if LastByte property is set. - - true if LastByte property is set. - - - - - This property is obsolete. Use ServerSideEncryptionMethod in InitiateMultipartUploadRequest instead. - - - Default: None - - - - - - Checks if ServerSideEncryptionMethod property is set. - - true if ServerSideEncryptionMethod property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - This property is obsolete. Use ServerSideEncryptionKeyManagementServiceKeyId in InitiateMultipartUploadRequest instead. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The customer provided encryption key for the source object of the copy. - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - true if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the CopySourceServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if CopySourceServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - - - Returns information about the CopyPart response and response metadata. - - - - - The version of the source object that was copied, if you have enabled versioning on the source bucketName. - - - - - - Entity tag of the object. - - - - - - Date and time at which the object was uploaded. - - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - Gets and sets the PartNumber property. - This is the part number in it's multi-part upload that will uniquely identify the part - and determine the relative ordering within the destination object. - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - A collection of up to 100 cross-origin resource sharing (CORS) rules. - - - - - The collection of rules in this configuration. - - - - C O R S Rule - - - - - Identifies HTTP methods that the domain/origin specified in the rule is allowed to execute. - - - - - - One or more origins you want customers to be able to access the bucket from. - - - - - - An optional unique identifier for the rule. - - - The ID value can be up to 255 characters long. The IDs help you find a rule in the configuration. - - - - - Checks if Id property is set. - - true if Id property is set. - - - - One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript - XMLHttpRequest object). - - - - - - The time in seconds that your browser is to cache the preflight response for the specified resource. - - - - - - Specifies which headers are allowed in a pre-flight OPTIONS request through the - Access-Control-Request-Headers header. - - - Each header name specified in the Access-Control-Request-Headers must have a corresponding - entry in the rule. Only the headers that were requested will be sent back. - This element can contain at most one * wildcard character. - - - - - Checks if AllowedHeaders property is set. - - true if AllowedHeaders property is set. - - - - Describes how a CSV-formatted input object is formatted. - - - - - Describes the first line of input. Valid values: None, Ignore, Use. - - - - - Single character used to indicate a row should be ignored when present at the start of a row. - - - - - Single character used for escaping the quote character inside an already escaped value. - - - - - Value used to separate individual records. - - - - - Value used to separate individual fields in a record. - - - - - Value used for escaping where the field delimiter is part of the value. - - - - - Specifies that CSV field values may contain quoted record delimiters and such records should be allowed. Default value is FALSE. Setting this value to TRUE may lower performance. - - - - - Describes how CSV-formatted results are formatted. - - - - - Indicates whether or not all output fields should be quoted. - - - - - Single character used for escaping the quote character inside an already escaped value. - - - - - Value used to separate individual records. - - - - - Value used to separate individual fields in a record. - - - - - Value used for escaping where the field delimiter is part of the value. - - - - - The container element for specifying the default Object Lock retention settings for - new objects placed in the specified bucket. - - - - - Gets and sets the property Days. - - The number of days that you want to specify for the default retention period. - - - - - - Gets and sets the property Mode. - - The default Object Lock retention mode you want to apply to new objects placed in - the specified bucket. - - - - - - Gets and sets the property Years. - - The number of years that you want to specify for the default retention period. - - - - - - Container for the parameters to the DeleteBucketAnalyticsConfiguration operation. - Deletes an analytics configuration for the bucket (specified by the analytics configuration ID). - - - - - The name of the bucket from which an analytics configuration is deleted. - - - - - The identifier used to represent an analytics configuration. - - - - - Returns information about the DeleteBucketAnalyticsConfiguration response metadata. - The DeleteBucketAnalyticsConfiguration operation has a void result type. - - - - - Request object for the DeleteBucketEncryption operation. - Request Deletes the server-side encryption configuration from the bucket. - - - - - The name of the bucket containing the server-side encryption configuration to delete. - - - - - Returns information about the DeleteBucketEncryption response metadata. - The DeleteBucketEncryption operation has a void result type. - - - - - Container for the parameters to the DeleteInventoryConfiguration operation. - Deletes an inventory configuration (identified by the inventory ID) from the bucket. - - - - - The name of the bucket containing the inventory configuration to delete. - - - - - The ID used to identify the inventory configuration. - - - - - Returns information about the DeleteInventoryConfiguration response metadata. - The DeleteInventoryConfiguration operation has a void result type. - - - - - Container for the parameters to the DeleteBucketMetricsConfiguration operation. - Deletes a metrics configuration (specified by the metrics configuration ID) from the bucket. - - - - - The name of the bucket on which Inventory configuration is to be removed. - - - - - The ID used to identify the metrics configuration. - - - - - Returns information about the DeleteBucketMetricsConfiguration response metadata. - The DeleteBucketMetricsConfiguration operation has a void result type. - - - - - Container for the parameters to the DeleteBucketPolicy operation. - Deletes the policy from the bucket. - - - - - The bucket on which the policy is to be deleted. - - - - - Returns information about the DeleteBucketPolicy response metadata. - The DeleteBucketPolicy operation has a void result type. - - - - - Request object for the DeleteBucketReplication operation. - - - - - Gets and sets the property BucketName. -

Deletes the replication subresource associated with the specified - bucket.

There is usually some time lag before - replication configuration deletion is fully propagated to all the - Amazon S3 systems.

For more information, see - - Cross-Region Replication (CRR) in the Amazon S3 Developer - Guide.

- - - - - Returns information about the DeleteBucketReplication response metadata. - The DeleteBucketReplication operation has a void result type. - - - - - Container for the parameters to the DeleteBucket operation. - Deletes the bucket. All objects (including all object versions and Delete Markers) in the bucket must be deleted before the bucket - itself can be deleted. - - - - - The name of the bucket to be created. - - - - - The region locality for the bucket. - - - When set, this will determine the region the bucket exists in. - Refer - for a list of possible values. - - - - - If set to true the bucket will be deleted in the same region as the configuration of the AmazonS3 client. - DeleteBucketRequest.BucketRegion takes precedence over this property if both are set. - Default: true. - - - - - Returns information about the DeleteBucket response metadata. - The DeleteBucket operation has a void result type. - - - - - The parameters to request deletion of a tag set from a bucket. - - - To use this operation, you must have permission to perform the s3:PutBucketTagging action. - By default, the bucket owner has this permission and can grant this permission to others. - - - - - The name of the bucket on which the tag set is to be removed. - - - - - Returns information about the DeleteBucketTagging response metadata. - The DeleteBucketTagging operation has a void result type. - - - - - Container for the parameters to the DeleteBucketWebsite operation. - This operation removes the website configuration from the bucket. - - - - - The name of the bucket on which website configuration is to be removed. - - - - - Returns information about the DeleteBucketWebsite response metadata. - The DeleteBucketWebsite operation has a void result type. - - - - - Container for the parameters to the DeleteCORSConfiguration operation. - Deletes the cors configuration information set for the bucket. - - - - - Gets and sets the BucketName property. - - - - - Returns information about the DeleteCORSConfiguration response metadata. - The DeleteCORSConfiguration operation has a void result type. - - - - - Contains information about a successful delete operation against a specific S3 object. - - - - - Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a - delete marker. In a simple DELETE, this header indicates whether (true) or not (false) a delete - marker was created. - - - - - The version ID of the delete marker created as a result of the DELETE operation. If you delete a - specific object version, the value returned by this header is the version ID of the object version - deleted. - - - - - The key of the deleted S3 object. - - - - - The version of the deleted S3 object. - - - - - Contains information about a failed delete operation against a specific S3 object. - - - - - The key of the S3 object. - - - - - The version of the S3 object. - - - - - The failure code for the delete error. - - - - - The failure message for the delete error. - - - - - The parameters to request deletion of the lifecycle configuration on a bucket. - - - - Amazon S3 removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. - Your objects never expire, and Amazon S3 no longer automatically deletes any objects on the basis of rules contained - in the deleted lifecycle configuration. - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration action. By default, the - bucket owner has this permission and the bucket owner can grant this permission to others. - - - There is usually some time lag before lifecycle configuration deletion is fully propagated to all the Amazon S3 systems. - - - - - - The name of the bucket on which the lifecycle configuration is to be deleted. - - - - - Returns information about the DeleteLifecycleConfiguration response metadata. - The DeleteLifecycleConfiguration operation has a void result type. - - - - -

Specifies whether Amazon S3 should replicate delete makers.

- - - - - Gets and sets the property Status. -

The status of the delete marker replication.

-

In the current implementation, Amazon S3 does not replicate - the delete markers. Therefore, the status must be - Disabled.

- - - - - The parameters to request deletion of an object in a bucket. - The operation removes the null version (if there is one) of an object and inserts a delete marker, which - becomes the latest version of the object. - - - - To remove a specific version, you must be the bucket owner and you must use the versionId subresource. - Using this subresource permanently deletes the version. - - - If the object you want to delete is in a bucket where the bucket versioning configuration is MFA Delete enabled, - you must include specify the MFA serial number and value in the request. - - - If there isn't a null version, Amazon S3 does not remove any objects. - - - - - - The bucket name of the bucket containing the object. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property BypassGovernanceRetention. - - - - - The key identifying the object to delete. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - The identifier for the specific version of the object to be deleted, if required. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - The MfaCodes Tuple associates the Serial Number and the current Token/Code displayed on the - Multi-Factor Authentication device associated with your AWS Account. - - - This is a required property for this request if:
- 1. EnableMfaDelete was configured on the bucket - containing this object's version.
- 2. You are deleting an object's version - - - - - Checks if the MfaCodes property is set. - - true if the MfaCodes property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the DeleteObject response and response metadata. - - - - - Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a delete marker. - - - - - - Returns the version ID of the delete marker created as a result of the DELETE operation. - - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the DeleteObjects operation. - This operation enables you to delete multiple objects from a bucket using a single HTTP request. You may specify up to 1000 - keys. - - - Container for the parameters to the DeleteObjects operation. - This operation enables you to delete multiple objects from a bucket using a single HTTP request. You may specify up to 1000 - keys. - - - - - The bucket name containing the objects to delete. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property BypassGovernanceRetention. - - Specifies whether you want to delete this object even if it has a Governance-type - Object Lock in place. You must have sufficient permissions to perform this operation. - - - - - - List of object keys to delete. - - - - - Toggles between Quiet and Verbose mode for the operation. - If set to true (Quiet mode), the response includes only those keys for objects on which - the delete operation failed. - - - By default this property is false and keys for both successful deletes - and failures are returned in the response. - - - - - The MfaCodes Tuple associates the Serial Number and the current Token/Code displayed on the - Multi-Factor Authentication device associated with your AWS Account. - - - This is a required property for this request if:
- 1. EnableMfaDelete was configured on the bucket - containing this object's version.
- 2. You are deleting an object's version - - - - - Checks if the MfaCodes property is set. - - true if the MfaCodes property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Add a key to the set of keys of objects to be deleted. - - Object key - - - - Add a key and a version to be deleted. - - Key of the object to be deleted. - Version of the object to be deleted. - - - - Add a KeyVersion object representing the S3 object to be deleted. - - KeyVersion representation of object to be deleted. - - - - Returns information about the DeleteObjects response and response metadata. - - - - - A default constructor for DeleteObjectsResponse - - - - - Gets and sets the DeletedObjects property. - A list of successful deletes. - Set only when Quiet=false on DeleteObjectsRequest. - - - - - Gets and sets the DeleteErrors property. - A list of errors encountered while deleting objects. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the DeleteObjectTaggingRequest operation. - - - - - The bucket name containing the objects from which to remove the tags. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Check to see if Bucket property is set - - - - - The key identifying the object tagging to delete. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Check to see if Key property is set - - - - - The identifier for the specific version of the object to be deleted, if required. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - Returns information about the DeleteObjectTagging response and response metadata. - - - - - Returns the version ID of the delete marker created as a result of the DELETE operation. - - - - - Check to see if VersionId property is set - - - - - Container for the parameters to the DeletePublicAccessBlock operation. - Removes the Public Access Block configuration for an Amazon S3 bucket. - - - - - Gets and sets the property BucketName. - - The Amazon S3 bucket whose Public Access Block configuration you want to delete. - - - - - - This is the response object from the DeletePublicAccessBlock operation. - - - - - EncryptionConfiguration class - - - - - The ID of the AWS KMS key for the region where the destination bucket - resides. Amazon S3 uses this key to encrypt the replica object. - - - - - The Continuation Event. - - - - - Constructs a Continuation Event. - - - - - Constructs a Continuation Event. - - - - - - The End Event. - - - - - Constructs an End Event. - - - - - Constructs an End Event. - - - - - - Common Contract for S3 Events. - - - - - The Progress event details. - - - - - Current number of object bytes scanned. - - - - - Current number of uncompressed object bytes processed. - - - - - Total number of bytes of records payload data returned. - - - - - Constructs a instance of Progress. - - - - - The Progress Event. - - - - - The Progress event details. - - - - - Constructs a ProgressEvent. - - - - - Constructs a ProgressEvent. - - - - - - The Records Event - - - - - The byte array of partial, one or more result records. - - Payload is a , which is not thread-safe. - - - - - Constructs a RecordsEvent - - - - - Creates a new End Event. - - - - - - Modeled Exception that either comes over the stream from the service model, or wraps other exceptions for the purpose of raising events. If it is - modelled, it will be a subclass. - - - - - Creates a new S3EventStreamException - - - - - Creates a new S3EventStreamException - - - - - - Creates a new S3EventStreamException - - - - - - - The contract for the SelectObjectContentEventStream. - - - - - Event that encompasses all IS3Events. - - - - - Event that encompasses S3EventStreamExceptions. - - - - - Reaised when a Records event is received. - - - - - Reaised when a Stats event is received. - - - - - Reaised when a Progress event is received. - - - - - Reaised when a Continuation event is received. - - - - - Reaised when an End event is received. - - - - - A Stream of Events returned by the SelectObjectContent operation. Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treaded as mutually exclusive. - - - - - The mapping of event message to a generator function to construct the matching Event Stream event. - - - - - The mapping of event message to a generator function to construct the matching Event Stream exception. - - - - - Whether the backround processing loop is running. - - - - - Event that encompasses all IS3Events. - - - - - Event that encompasses S3EventStreamExceptions. - - - - - Reaised when a Records event is received. - - - - - Reaised when a Stats event is received. - - - - - Reaised when a Progress event is received. - - - - - Reaised when a Continuation event is received. - - - - - Reaised when an End event is received. - - - - - Event Stream returned by SelectObjectContentStream. - - Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treated as mutually exclusive. - - The network stream which events will be parsed from. - - - - Event Stream returned by SelectObjectContentStream. - - Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treaded as mutually exclusive. - - The network stream which events will be parsed from. - The decoder responsible for parsing events. - - - - The Stats event details. - - - - - Total number of object bytes scanned. - - - - - Total number of uncompressed object bytes processed. - - - - - Total number of bytes of records payload data returned. - - - - - Constructs an instance of Stats. - - - - - The Stats Event. - - - - - The Stats event details. - - - - - Constructs a StatsEvent - - - - - Constructs a ProgressEvent. - - - - - - This Event is returned if an event is retrieved from the event stream, but a generator function - for the event is not defined. - - - - - Constructs an UnknownEventStreamEvent. - - - - - Constructs an UnknownEventStreamEvent. - - The Message recieved from the event stream before conversion. - - - - Constructs an UnknownEventStreamEvent. - - The Message recieved from the event stream before conversion. - The event type. - - - - A container that specifies information about existing object replication. You can choose whether to enable or disable the replication of existing objects. - - - - - Specifies whether existing object replication is enabled. - - - - - Defines the expiration policy for a given object. - - - - - This property is deprecated. This property exposes a DateTime of kind Unspecified. Use ExpiryDateUtc instead. - The date and time for expiry. - - - - - The date and time for expiry. - - - - - Id of the configuration rule for this expiry. - - - - - Constructs an empty instance of an Expiration object - - - - Bucket - Represents a set of filter criteria that limits the objects that can trigger event notifications - - - - - Filter criteria that limits the objects that can trigger event notifications based on their S3 Key name. - - - - - Bucket - Represents a Filter Rule for a NotificationConfiguration. - - - - - Constructs an empty FilterRule. - - - - - Constructs a FilterRule with a specific name and value. - - - - - - - The name of the filter rule. - - - - - The value of the filter rule. - - - - - Container for the parameters to the GetACL operation. - Returns the access control list (ACL) of an object. - - - - - The bucket name that contains the object for which to get the ACL information. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The key of the S3 object to be queried. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - VersionId used to reference a specific version of the object. - - - - - Returns information about the GetACL response and response metadata. - - - - - Gets and sets the AccessControlList property. - - - - - Container for the parameters to the GetBucketAccelerateConfiguration operation. - - - - - The name of the bucket. - - - - - The response class for GetBucketAccelerateConfiguration operation. - - - - - The accelerate status of the bucket. - - - - - Container for the parameters to the GetBucketAnalyticsConfiguration operation. - Gets an analytics configuration for the bucket (specified by the analytics configuration ID). - - - - - The name of the bucket from which an analytics configuration is retrieved. - - - - - The identifier used to represent an analytics configuration. - - - - - GetBucketAnalyticsConfigurationResponse Response - - - - - The configuration and any analyses for the analytics filter. - - - - - Container for the parameters to the GetBucketEncryptionRequest operation. - Returns the server-side encryption configuration of a bucket. - - - - - The name of the bucket. - - - - - GetBucketEncryptionResponse Response - - - - - Container for server-side encryption configuration rules. Currently S3 supports one rule only. - - - - - Container for the parameters to the GetInventoryConfigurationRequest operation. - Returns an inventory configuration (identified by the inventory ID) from the bucket. - - - - - The name of the bucket containing the inventory configuration to retrieve. - - - - - The ID used to identify the inventory configuration. - - - - - GetInventoryConfigurationResponse Response - - - - - Specifies the inventory configuration. - - - - - Container for the parameters to the GetBucketLocation operation. - Returns the region the bucket resides in. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetBucketLocation response and response metadata. - - - - - Gets and sets the Location property. - If the the bucket is located in us-east-1 S3Region.US will be return which has a - value of empty string. - - - - - Container for the parameters to the GetBucketLogging operation. - Returns the logging status of a bucket and the permissions users have to view and modify that status. To use GET, you must be the - bucket owner. - - - - - The name of the bucket to query. - - - - - Returns information about the GetBucketLogging response and response metadata. - - - - - Gets and sets the LoggingConfig property. - - - - - Container for the parameters to the GetBucketMetricsConfiguration operation. - Gets a metrics configuration (specified by the metrics configuration ID) from the bucket. - - - - - The name of the bucket containing the metrics configuration to retrieve. - - - - - The ID used to identify the metrics configuration. - - - - - GetBucketMetricsConfiguration Response - - - - - Specifies the metrics configuration. - - - - - Container for the parameters to the GetBucketNotification operation. - Return the notification configuration of a bucket. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetBucketNotification response and response metadata. - - - - - Gets and sets the TopicConfigurations property. TopicConfigurations are configuration - for Amazon S3 events to be sent to Amazon SNS topics. - - - - - Gets and sets the QueueConfigurations property. QueueConfigurations are configuration - for Amazon S3 events to be sent to Amazon SQS queues. - - - - - Gets and sets the LambdaFunctionConfigurations property. LambdaFunctionConfigurations are configuration - for Amazon S3 events to be sent to an Amazon Lambda cloud function. - - - - - Container for the parameters to the GetBucketPolicy operation. - Returns the policy of a specified bucket. - - - - - The name of the bucket. - - - - - Get BucketName Policy Response - - - - - The bucket policy as a JSON document. - - - - - Container for the parameters to the GetBucketPolicyStatus operation. - Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket - is public. - - - - - Gets and sets the property BucketName. - - The name of the Amazon S3 bucket whose public-policy status you want to retrieve. - - - - - - This is the response object from the GetBucketPolicyStatus operation. - - - - - The public-policy status for this bucket. - - - - - Container for the parameters to the GetBucketReplicationConfiguration operation. - Returns the replication configuration information set on the bucket. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetReplicationConfiguration response and response metadata. - - - - - The replication configuration for the buccket specified in the request. - - - - - Container for the parameters to the GetBucketRequestPayment operation. - Returns the request payment configuration of a bucket. - - - - - The name of the bucket. - - - - - Returns information about the GetBucketRequestPayment response and response metadata. - - - - - Specifies who pays for the download and request fees. - - - - - - Container for the parameters to the GetBucketTagging operation. - Returns the tag set associated with the bucket. - - - - - The name of the bucket to be queried. - - - - - Returns information about the GetBucketTagging response and response metadata. - - - - - The collection of tags. - - - - - Container for the parameters to the GetBucketVersioning operation. - Returns the versioning state of a bucket. - - - - - The name of the bucket to be queried. - - - - - Returns information about the GetBucketVersioning response and response metadata. - - - - - Gets and sets the Versioning property. - Unless Versioning has been explicitly "Enabled" on a bucket, - Versioning Status is "Off". Once Versioning has been - "Enabled", it can be "Suspended" but cannot be switched "Off". - - - - - Container for the parameters to the GetBucketWebsite operation. - Returns the website configuration for a bucket. - - - - - The name of the bucket to be queried. - - - - - Returns information about the GetBucketWebsite response and response metadata. - - - - - Gets and sets the WebsiteConfiguration property. - - This is where the index document suffix and custom error page are defined. - - - - - Container for the parameters to the GetBucketCors operation. - Returns the cors configuration for the bucket. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetBucketCors response and response metadata. - - - - - The current CORSConfiguration for the bucket. - - - - - Container for the parameters to the GetLifecycleConfiguration operation. - Returns the lifecycle configuration information set on the bucket. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetLifecycleConfiguration response and response metadata. - - - - - Gets and Sets the property that governs whether - the response includes successful deletes as well as errors - following the DeleteObjects call against S3. - - By default this property is false and successful deletes - are returned in the response. - - - - - Container for the parameters to the GetObjectLegalHold operation. - Gets an object's current Legal Hold status. - - - - - The bucket name containing the object whose Legal Hold status you want to retrieve. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property Key. - - The key name for the object whose Legal Hold status you want to retrieve. - - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property VersionId. - - The version ID of the object whose Legal Hold status you want to retrieve. - - - - - - This is the response object from the GetObjectLegalHold operation. - - - - - Gets and sets the property LegalHold. - - The current Legal Hold status for the specified object. - - - - - - Container for the parameters to the GetObjectLockConfiguration operation. - Gets the Object Lock configuration for a bucket. The rule specified in the Object - Lock configuration will be applied by default to every new object placed in the specified - bucket. - - - - - Gets and sets the property BucketName. - - The bucket whose Object Lock configuration you want to retrieve. - - - - - - This is the response object from the GetObjectLockConfiguration operation. - - - - - Gets and sets the property ObjectLockConfiguration. - - The specified bucket's Object Lock configuration. - - - - - - Container for the parameters to the HeadObject operation. - The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you''re only - interested in an object''s metadata. To use HEAD, you must have READ access to the object. - - - - - The name of the bucket that contains the object. - - - - - ETag to be matched as a pre-condition for returning the object, - otherwise a PreconditionFailed signal is returned. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or - ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Returns the object only if it has been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Returns the object only if it has been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - ETag that should not be matched as a pre-condition for returning the object, - otherwise a PreconditionFailed signal is returned. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or - UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Returns the object only if it has not been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Returns the object only if it has not been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - The key of the object. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - VersionId used to reference a specific version of the object. - - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to decrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - Part number of the object being read. This is a positive integer between 1 and 10,000. - Effectively performs a 'ranged' HEAD request for the part specified. - Useful querying about the size of the part and the number of parts in this object. - - - - - Check if PartNumber property is set. - - true if PartNumber property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the HeadObject response and response metadata. - - - - - Flag which returns true if the Expires property has been unmarshalled - from the raw value or set by user code. - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the - response. - - - - - - Gets and sets the AcceptRanges. - - - - - Gets and sets the ContentRange. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - Gets and sets the RestoreExpiration property. - RestoreExpiration will be set for objects that have been restored from Amazon Glacier. - It indiciates for those objects how long the restored object will exist. - - - - - Gets and sets the RestoreInProgress - Will be true when the object is in the process of being restored from Amazon Glacier. - - - - - Last modified date of the object - - - - - - An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL - - - - - - This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like - SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal - HTTP headers. - - - - - - Version of the object. - - - - - - The date and time at which the object is no longer cacheable. - - - - - - If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The status of the replication job associated with this source object. - - - - - Checks if ReplicationStatus property is set. - - true if ReplicationStatus property is set. - - - - The count of parts this object has. - - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - The Legal Hold status for the specified object. - - - - - - Gets and sets the property ObjectLockMode. - - The Object Lock mode currently in place for this object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - The date and time when this object's Object Lock will expire. - - - - - - The class of storage used to store the object. - - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the GetObject operation. - Retrieves objects from Amazon S3. - - - - - The bucket name containing the object. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - ETag to be matched as a pre-condition for returning the object, - otherwise a PreconditionFailed signal is returned. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or - ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Returns the object only if it has been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Returns the object only if it has been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - ETag that should not be matched as a pre-condition for returning the object, - otherwise a PreconditionFailed signal is returned. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or - UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Returns the object only if it has not been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Returns the object only if it has not been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Gets and sets the Key property. This is the user defined key that identifies the object in the bucket. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Downloads the specified range bytes of an object. - - - - - A set of response headers that should be returned with the object. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ResponseExpiresUtc instead. Setting either ResponseExpires or - ResponseExpiresUtc results in both ResponseExpires and ResponseExpiresUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ResponseExpires is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Sets the Expires header of the response. - - - - - Sets the Expires header of the response. - - - - - VersionId used to reference a specific version of the object. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to decrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - Part number of the object being read. This is a positive integer between 1 and 10,000. - Effectively performs a 'ranged' GET request for the part specified. Useful for downloading just a part of an object. - - - - - Checks if PartNumber property is set. - - true if PartNumber property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the GetObject response and response metadata. - - - - - Flag which returns true if the Expires property has been unmarshalled - from the raw value or set by user code. - - - - - Gets and sets the BucketName property. - - - - - Gets and sets the Key property. - - - - - Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the - response. - - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - Gets and sets the AcceptRanges. - - - - - Gets and sets the ContentRange. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - Gets and sets the RestoreExpiration property. - RestoreExpiration will be set for objects that have been restored from Amazon Glacier. - It indiciates for those objects how long the restored object will exist. - - - - - Gets and sets the RestoreInProgress - Will be true when the object is in the process of being restored from Amazon Glacier. - - - - - Last modified date of the object - - - - - - An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL - - - - - - This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like - SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal - HTTP headers. - - - - - - Version of the object. - - - - - - The date and time at which the object is no longer cacheable. - - - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - - - - Gets and sets the property ObjectLockMode. - - The Object Lock mode currently in place for this object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - The date and time when this object's Object Lock will expire. - - - - - - If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The class of storage used to store the object. - - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The status of the replication job associated with this source object. - - - - - Checks if ReplicationStatus property is set. - - true if ReplicationStatus property is set. - - - - The number of parts this oject has. - - - - - Checks if PartsCount is set. - - true if PartsCount property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - The number of tags, if any, on the object. - - - - - The event for Write Object progress notifications. All - subscribers will be notified when a new progress - event is raised. - - - Subscribe to this event if you want to receive - put object progress notifications. Here is how:
- 1. Define a method with a signature similar to this one: - - private void displayProgress(object sender, WriteObjectProgressArgs args) - { - Console.WriteLine(args); - } - - 2. Add this method to the Put Object Progress Event delegate's invocation list - - GetObjectResponse response = s3Client.GetObject(request); - response.WriteObjectProgressEvent += displayProgress; - - - - - - This method is called by a producer of write object progress - notifications. When called, all the subscribers in the - invocation list will be called sequentially. - - The file being written. - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - True if transfer is complete - - - - Writes the content of the ResponseStream a file indicated by the filePath argument. - - The location where to write the ResponseStream - Whether or not to append to the file if it exists - Cancellation token which can be used to cancel this operation. - - - - Encapsulates the information needed to provide - download progress for the Write Object Event. - - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The bucket name for the S3 object being written. - The object key for the S3 object being written. - The version-id of the S3 object. - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - True if finished writing - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The bucket name for the S3 object being written. - The object key for the S3 object being written. - The file for the S3 object being written. - The version-id of the S3 object. - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - True if finished writing - - - - Gets the bucket name for the S3 object being written. - - - - - Gets the object key for the S3 object being written. - - - - - Gets the version-id of the S3 object. - - - - - The file for the S3 object being written. - - - - - True if writing is complete - - - - - Container for the parameters to the GetObjectRetention operation. - Retrieves an object's retention settings. - - - - - The bucket name containing the object whose retention settings you want to retrieve. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property Key. - - The key name for the object whose retention settings you want to retrieve. - - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property VersionId. - - The version ID for the object whose retention settings you want to retrieve. - - - - - - This is the response object from the GetObjectRetention operation. - - - - - Gets and sets the property Retention. - - The container element for an object's retention settings. - - - - - - Container for the parameters to the GetObjectTaggingRequest operation. - - - - - The bucket name containing the object for which to get the tagging information. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Check to see if Bucket property is set - - - - - Gets and sets the Key property. This is the user defined key that identifies the object in the bucket. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Check to see if Key property is set - - - - - VersionId used to reference a specific version of the object. - - - - - - Returns information about the GetObjectTagging response and response metadata. - - - - - Gets or sets tag-set for a given object - - - - - Container for the parameters to the GetObjectTorrent operation. - Return torrent files from a bucket. - - - - - The name of the bucket containing the object. - - - - - The key identifying the object. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the GetObjectTorrent response and response metadata. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - The parameters to create a pre-signed URL to a bucket or object. - - - For more information, refer to: . -
Required Parameters: BucketName, Expires -
Optional Parameters: Key, VersionId, Verb: default is GET - - - - - The name of the bucket to create a pre-signed url to, or containing the object. - - - - - Checks if BucketName property is set. - - true if BucketName property is set. - - - - The key to the object for which a pre-signed url should be created. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Checks if Key property is set. - - true if Key property is set. - - - - A standard MIME type describing the format of the object data. - - - - The content type for the content being uploaded. This property defaults to "binary/octet-stream". - For more information, refer to: . - - - Note that if content type is specified, it should also be included in the HttpRequest headers - of the eventual upload request, otherwise a signature error may result. - - - - - - The expiry date and time for the pre-signed url. - - - - - Checks if Expires property is set. - - true if Expires property is set. - - - - The requested protocol (http/https) for the pre-signed url. - - - Defaults to https. - - - - - The verb for the pre-signed url. - - - Accepted verbs are GET, PUT, DELETE and HEAD. - Default is GET. - - - - - Version id for the object that the pre-signed url will reference. If not set, - the url will reference the latest version of the object. - - - This is the VersionId for the S3 Object you want to get - a PreSigned URL for. The VersionId property will be ignored - for PreSigned "PUT" requests and for requests that don't specify - the Key property. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - The upload id for the multipart upload for which a pre-signed url should be created. - - - - - Checks if UploadId property is set. - - true if UploadId property is set. - - - - The part number for the multipart upload for which a pre-signed url should be created. - - - - - Checks if PartNumber property is set. - - true if PartNumber property is set. - - - - Specifies the encryption used on the server to store the content. - - - - Default is None. - - - If specifying encryption (not None), the corresponding request must include header - "x-amz-server-side-encryption" with the value of the encryption. - - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - Confirms that the requester knows that she or he will be charged for the request. - Bucket owners need not specify this parameter in their requests. - - - - - A set of response headers that should be returned with the pre-signed url creation response. - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - Custom parameters to include in the signed request, so that they are tamper-proof. - - - - - The parameters for a pre-signed URL to a bucket or object as a string. - - - For more information, refer to: . - - - - - The PreSignedURL as a string - - - - - Constructor - - A url returned from GetPreSignedUrlRequest - - - - Container for the parameters to the GetPublicAccessBlock operation. - Retrieves the Public Access Block configuration for an Amazon S3 bucket. - - - - - Gets and sets the property BucketName. - - The name of the Amazon S3 bucket whose Public Access Block configuration you want - to retrieve. - - - - - - This is the response object from the GetPublicAccessBlock operation. - - - - - The Public Access Block configuration currently in effect for this Amazon S3 bucket. - - - - - Container for the parameters to the HeadBucket operation. - This operation is useful to determine if a bucket exists and you have permission to access it. - - - - - Returns information about the HeadBucket response metadata. - The HeadBucket operation has a void result type. - - - - - This class contains the headers for an S3 object. - - - - - Gets and sets headers to set for the object. - - The name of the header - The value for the header - - - - Gets the count of headers. - - - - - Gets the names of the headers set. - - - - - Specifies caching behavior along the request/reply chain. - - - - - - Specifies presentational information for the object. - - - - - - Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type - referenced by the Content-Type header field. - - - - - - The size of the object, in bytes. - - - - - The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. This - header can be used as a message integrity check to verify that the data is the same data that was originally sent. - - - - - A standard MIME type describing the format of the object data. - - - - - - The date and time at which the object is no longer cacheable. - - - - - - - Container for the parameters to the InitiateMultipartUpload operation. - Initiates a multipart upload and returns an upload ID. - - - - - Envelope Key to Encrypt data - - - - - Encrypted Envelope Key to Encrypt data - - - - - Initialization Vector for encryption - - - - - Storage mode for encryption information. - - - - - A canned access control list (ACL) to apply to the object. - Please refer to for information on S3 Canned ACLs. - - - - - The name of the bucketName where the new object will be created, or existing object updated. - - - - - The key of the object to create or update. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - StorageClass property for the object. - - - Default: S3StorageClass.Standard. Set this property - only if you want reduced redundancy for this object. - Please refer to - for - information on S3 Storage Classes. - - - - - If the bucketName is configured as a website, redirects requests for this object to another object in the same bucketName or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - This is a convenience property for Headers.ContentType. - - - - - - Specifies the encryption to be used on the server for the new object. - - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - Checks if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - true if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - Specifies whether you want to apply a Legal Hold to the uploaded object. - - - - - - Gets and sets the property ObjectLockMode. - - Specifies the Object Lock mode that you want to apply to the uploaded object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - Specifies the date and time when you want the Object Lock to expire. - - - - - - The tag-set for the object. The tag-set must be encoded as URL Query parameters. - - - - - Checks if Tagging property is set - - true if Tagging is set. - - - - Returns information about the InitiateMultipartUpload response and response metadata. - - - - - Name of the bucketName to which the multipart upload was initiated. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Object key for which the multipart upload was initiated. - - - - - - Gets and sets the initiated multipart upload id. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - Date when multipart upload will become eligible for abort operation by lifecycle. - - - - - Id of the lifecycle rule that makes a multipart upload eligible for abort operation. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Identifies who initiated the multipart upload. - - - - - Name of the Principal. - - - - - - If the principal is an AWS account, it provides the Canonical User ID. If the principal is an IAM User, it provides a user ARN value. - - - - - - Describes the serialization format of the object. - - - - - Describes the serialization of a CSV-encoded object. - - - - - Specifies object's compression format. Valid values: NONE, GZIP. Default Value: NONE. - - - - - Specifies JSON as object's input serialization format. - - - - - Specifies Parquet as object's input serialization format. - - - - - Class for MetricsConfiguration - - - - - Contains information about where to publish the inventory results. - - - - - Specifies whether the inventory is enabled or disabled. - - - - - Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria. - - - - - The ID used to identify the inventory configuration. - - - - - Specifies which object version(s) to included in the inventory results. - - - - - Contains the optional fields that are included in the inventory results. - - - - - Specifies the schedule for generating inventory results. - - - - - Class for InventoryDestination - - - - - Contains the bucket name, file format, bucket owner (optional), and prefix (optional) where inventory results are published. - - - - - InventoryEncryption class - - - - - Specifies the use of SSE-S3 to encrypt delievered Inventory reports. - - - - - Specifies the use of SSE-KMS to encrypt delievered Inventory reports. - - - - - Class for InventoryFilter - - - - - Filter Predicate setup for specific filter types. - - - - - Filter Predicate abstract class for specific filter types to be derived from. - - - - - Class for InventoryPrefixPredicate - The prefix that an object must have to be included in the inventory results. - - - - - The ID of the account that owns the destination bucket. - - - - - The Amazon resource name (ARN) of the bucket where inventory results will be published. - - - - - The prefix that is prepended to all inventory results. - - - - - Specifies the output format of the inventory results. - - - - - Contains the type of server-side encryption used to encrypt the inventory results. - - - - - Class for InventorySchedule - - - - - Specifies how frequently inventory results are produced. - - - - - Specifies JSON as object's input serialization format. - - - - - The type of JSON. Valid values: Document, Lines. - - - - - Specifies JSON as request's output serialization format - - - - - The value used to separate individual records in the output. - - - - - Specifies an object key and optional object version. - - - - - Key name of the object to delete. - - - - - - VersionId for the specific version of the object to delete. - - - - - - This class contains the configuration Amazon S3 uses to figure out what events you want to listen - and send the event to an Amazon Lambda cloud function. - - - - - Gets and set the Id property. The Id will be provided in the event content and can be used - to identify which configuration caused an event to fire. If the Id is not provided for the configuration, one will be generated. - - - - - Gets and sets the FunctionArn property. This is the Amazon Lambda cloud function to which Amazon S3 will invoke with the events. - - - - Lifecycle Configuration - - - - - Gets and sets the Rules property. These rules defined the lifecycle configuration. - - - - - Base class for all the different predicates that can be used - in a filter. - - - - - This method is called by the visitor when it wants to visit the predicate. - - - - - - Filter identifying one or more objects to which a applies. - - - - - The predicate used by the filter. - - - - - Base class for lifecycle operators. - - - - - The list of objects - that this operator operates on. - - - - - The logical and operator for filtering objects for a - - - - - Accept a visit from an - - - This method is used internally by the SDK. - - - - - - A predicate that filters objects for a - by matching a particular prefix. - - - - - The prefix to be matched by filtered objects. - - - - - Accept a visit from an - - - This method is used internally by the SDK. - - - - - - A predicate that filters objects for a - by matching a particular key and value. - - - - - The Tag to be matched by filtered objects. - - - - - Accept a visit from an - - - This method is used internally by the SDK. - - - - - - Rules Item - - - - - Defines the length of time, in days, before objects expire. - - - - - Unique identifier for the rule. The value cannot be longer than 255 characters. - - - - - Prefix identifying one or more objects to which the rule applies. - - - - - - Filter identifying one or more objects to which the rule applies. - - - - - If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied. - - - - - - The transition rule that describes when objects transition to a different storage class. - - Lifecycle rules can now contain multiple transitions. This property is obsolete in favor of the Transitions property. - This property will always get or set the the zeroth element in the Transitions collection. - - - - - - Defines the length of time, in days, before noncurrent versions expire. - - - - - The transition rule that describes when noncurrent versions transition to - a different storage class. - - Lifecycle rules can now contain multiple noncurrent version transitions. This property - is obsolete in favor of the NoncurrentVersionTransitions property. - This property will always get or set the the zeroth element in the NoncurrentVersionTransitions collection. - - - - - - The transition rules that describe when objects transition to a different storage class. - - - - - The transition rules that describe when noncurrent versions transition to - a different storage class. - - - - - Specifies the days since the initiation of an Incomplete Multipart Upload - that Lifecycle will wait before permanently removing all parts of the upload. - - - - - Specifies the days since the initiation of an Incomplete Multipart Upload - that Lifecycle will wait before permanently removing all parts of the upload. - - - - - Indicates the number of days that must pass since initiation for Lifecycle - to abort an Incomplete Multipart Upload. - - - - Expiration - - - - - Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format. - - - - - - Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer. - - - - - - Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set to true, the delete marker will be expired; if set to false the policy takes no action. This cannot be specified with Days or Date in a Lifecycle Expiration Policy. - - - - - - Noncurrent Version Expiration - - - - - Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated - action. For information about the noncurrent days calculations, see - How Amazon S3 Calculates When an Object Became Noncurrent - in the Amazon Simple Storage Service Developer Guide. - - - - - LifecycleTransition defines when and how objects transition. - - - - - Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated - action. For information about the noncurrent days calculations, see - How Amazon S3 Calculates When an Object Became Noncurrent - in the Amazon Simple Storage Service Developer Guide. - - - - - The class of storage used to store the object. - - - - - - LifecycleTransition defines when and how objects transition. - - - - - Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format. - - - - - - Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer. - - - - - - The class of storage used to store the object. - - - - - - Container for the parameters to the ListInventoryConfigurationsRequest operation. - Lists the analytics configurations for the bucket. - - - - - The name of the bucket containing the analytics configurations to retrieve. - - - - - The ContinuationToken that represents a placeholder from where this request should begin. - - - - - Returns information about the ListBucketAnalyticsConfigurationsResponse response and response metadata. - - - - - The ContinuationToken that represents where this request began. - - - - - The list of analytics configurations for a bucket. - - - - - Indicates whether the returned list of analytics configurations is complete. - A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request. - - - - - NextContinuationToken is sent when isTruncated is true, which indicates that there are more analytics configurations to list. - The next request must include this NextContinuationToken. The token is obfuscated and is not a usable value. - - - - - Container for the parameters to the ListInventoryConfigurationsRequest operation. - Returns a list of inventory configurations for the bucket. - - - - - The name of the bucket containing the inventory configurations to retrieve. - - - - - The marker used to continue an inventory configuration listing that has been truncated. - Use the NextContinuationToken from a previously truncated list response to continue the listing. - The continuation token is an opaque value that Amazon S3 understands. - - - - - Returns information about the ListInventoryConfigurationsResponse response and response metadata. - - - - - If sent in the request, the marker that is used as a starting point for this inventory configuration list response. - - - - - The list of inventory configurations for a bucket. - - - - - Indicates whether the returned list of inventory configurations is truncated in this response. A value of true indicates that the list is truncated. - - - - - The marker used to continue this inventory configuration listing. Use the NextContinuationToken from this response to continue the listing in a subsequent request. - The continuation token is an opaque value that Amazon S3 understands. - - - - - Container for the parameters to the ListBucketMetricsConfigurationRequest operation. - Lists the metrics configurations for the bucket. - - - - - The name of the bucket containing the metrics configurations to retrieve. - - - - - - The marker that is used to continue a metrics configuration listing that has been truncated. - Use the NextContinuationToken from a previously truncated list response to continue the listing. - The continuation token is an opaque value that Amazon S3 understands. - - - - - - Returns information about the ListBucketMetricsConfiguration response and response metadata. - - - - - - The marker that is used to continue a metrics configuration listing that has been truncated. - Use the NextContinuationToken from a previously truncated list response to continue the listing. - The continuation token is an opaque value that Amazon S3 understands. - - - - - - The list of metrics configurations for a bucket. - - - - - - Indicates whether the returned list of metrics configurations is complete. - A value of true indicates that the list is not complete and the NextContinuationToken will be provided for - a subsequent request. - - - - - - - The marker used to continue a metrics configuration listing that has been truncated. - Use the NextContinuationToken from a previously truncated list response to continue the listing. - The continuation token is an opaque value that Amazon S3 understands. - - - - - - Container for the parameters to the ListBuckets operation. - Returns a list of all buckets owned by the authenticated sender of the request. - - - - - Returns information about the ListBuckets response and response metadata. - - - - - List of buckets. - - - - - Owner of the buckets. - - - - - Container for the parameters to the ListMultipartUploads operation. - This operation lists in-progress multipart uploads. - - - - - Name of the bucket to which the multipart upload was initiated. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Character you use to group keys. - - - - - - Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin. - - - - - - Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response body. 1,000 is the maximum number of uploads that - can be returned in a response. - - - - - - Lists in-progress uploads only for those keys that begin with the specified prefix. - - - - - - Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the - upload-id-marker parameter is ignored. - - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - Returns information about the ListMultipartUploads response and response metadata. - - - - - Name of the bucketName to which the multipart upload was initiated. - - - - - - The key at or after which the listing began. - - - - - - Upload ID after which listing began. - - - - - - When a list is truncated, this element specifies the value that should be used for the key-marker request parameter in a subsequent request. - - - - - - When a list is truncated, this element specifies the value that should be used for the upload-id-marker request parameter in a subsequent - request. - - - - - - Maximum number of multipart uploads that could have been included in the response. - - - - - - Indicates whether the returned list of multipart uploads is truncated. A value of true indicates that the list was truncated. The list can - be truncated if the number of multipart uploads exceeds the limit allowed or specified by max uploads. - - - - - - Gets and sets the MultipartUploads property. - - Container for elements related to a particular multipart upload. A response - can contain zero or more Upload elements. - - - - - - Gets and sets the Prefix property. - - - - - Gets and sets the Delimiter property. - - - - - Gets the CommonPrefixes property. - A response can contain CommonPrefixes only if you specify a delimiter. - When you do, CommonPrefixes contains all (if there are any) keys between - Prefix and the next occurrence of the string specified by delimiter. In effect, - CommonPrefixes lists keys that act like subdirectories in the directory specified - by Prefix. For example, if prefix is notes/ and delimiter is a slash (/), in - notes/summer/july, the common prefix is notes/summer/. - - - - - Container for the parameters to the ListObjects operation. - Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a - subset of the objects in a bucket. - - - - - The name of the bucket containing the objects whose keys are to be listed. - - - - - A delimiter is a character you use to group keys. - - - - - Specifies the key to start with when listing objects in a bucket. - - - - - Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more. - - - - - Limits the response to keys that begin with the specified prefix. - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the ListObjects response and response metadata. - - - - - A flag that indicates whether or not Amazon S3 returned all of the results that satisfied - the search criteria. - - - - - Gets and sets the NextMarker property. - NextMarker is set by S3 only if a Delimiter was specified - in the original ListObjects request. If a delimiter was - not specified, the AWS SDK for .NET returns the last Key - of the List of Objects retrieved from S3 as the NextMarker. - - - - - Gets the S3Objects property. This is a list of - objects in the bucket that match your search criteria. - - - - - Gets and sets the Name property which is the name of the bucket. - - - - - Gets and sets the Prefix property. - - - - - Gets and sets the MaxKeys property. This is max number of object keys returned by the list operation. - - - - - Gets the CommonPrefixes property. - A response can contain CommonPrefixes only if you specify a delimiter. - When you do, CommonPrefixes contains all (if there are any) keys between - Prefix and the next occurrence of the string specified by delimiter. In effect, - CommonPrefixes lists keys that act like subdirectories in the directory specified - by Prefix. For example, if prefix is notes/ and delimiter is a slash (/), in - notes/summer/july, the common prefix is notes/summer/. - - - - - Gets and sets the Delimiter property. - Causes keys that contain the same string between the prefix and the - first occurrence of the delimiter to be rolled up into a single result - element in the CommonPrefixes collection. - - - These rolled-up keys are not returned elsewhere in the response. - - - - - Container for the parameters to the ListObjects operation. - Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a - subset of the objects in a bucket. - - - - - Bucket name to list. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - A delimiter is a character you use to group keys. - - - - - Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more. - - - - - Limits the response to keys that begin with the specified prefix. - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts - listing after this specified key. StartAfter can be any key in the bucket. - Cannot be set at the same time as ContinuationToken. - - - - - ContinuationToken indicates Amazon S3 that the list is being continued on this - bucket with a token. ContinuationToken is obfuscated and is not a real key. - - - - - The owner field is not present in ListObjectsV2 responses by default. - If you want to return owner field with each key in the result then set this field to true. - If not specified, the Owner field on S3Object will be null. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the ListObjects response and response metadata. - - - - - A flag that indicates whether or not Amazon S3 returned all of the results that satisfied - the search criteria. - - - - - Gets and sets the S3Objects property. Metadata about each object returned. - - - - - Bucket name. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the Prefix property. - - - - - Gets and sets the MaxKeys property. This is max number of object keys returned by the list operation. - - - - - Gets and sets the CommonPrefixes property. - CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence - of the string specified by delimiter - - - - - Gets and sets the Delimiter property. - Causes keys that contain the same string between the prefix and the - first occurrence of the delimiter to be rolled up into a single result - element in the CommonPrefixes collection. - - - These rolled-up keys are not returned elsewhere in the response. - - - - - Encoding type used by Amazon S3 to encode object keys in the response. - - - - - KeyCount is the number of keys returned with this request. - KeyCount will always be less than or equal to MaxKeys field. - - - - - ContinuationToken indicates Amazon S3 that the list is being continued - on this bucket with a token. - ContinuationToken is obfuscated and is not a real key - - - - - NextContinuationToken is sent when isTruncated is true which means there - are more keys in the bucket that can be listed. The next ListObjectV2 call - to Amazon S3 can be continued with this NextContinuationToken. - NextContinuationToken is obfuscated and is not a real key. - - - - - StartAfter is where you want Amazon S3 to start listing from. - Amazon S3 starts listing after this specified key. - StartAfter can be any key in the bucket. - - - - - Container for the parameters to the ListParts operation. - Lists the parts that have been uploaded for a specific multipart upload. - - - - - Name of the bucket to which the parts are being uploaded. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The object key for which the multipart upload was initiated. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Sets the maximum number of parts to return. - - - - - - Specifies the part after which listing should begin. Only parts with higher part numbers will be listed. - - - - - - Upload ID identifying the multipart upload whose parts are being listed. - - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the ListParts response and response metadata. - - - - - Name of the bucketName to which the multipart upload was initiated. - - - - - - Object key for which the multipart upload was initiated. - - - - - - Upload ID identifying the multipart upload whose parts are being listed. - - - - - - Part number after which listing begins. - - - - - - When a list is truncated, this element specifies the last part in the list, as well as the value to use for the part-number-marker request - parameter in a subsequent request. - - - - - - Maximum number of parts that were allowed in the response. - - - - - - Indicates whether the returned list of parts is truncated. - - - - - - Gets and sets the Parts property. - - PartDetails is a container for elements related to a particular part. A response can contain - zero or more Part elements. - - - - - - Identifies who initiated the multipart upload. - - - - - - Gets and sets the Owner property. - - - - - The class of storage used to store the object. - - - - - - Date when multipart upload will become eligible for abort operation by lifecycle. - - - - - Id of the lifecycle rule that makes a multipart upload eligible for abort operation. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the ListVersions operation. - Returns metadata about all of the versions of objects in a bucket. - - - - - The bucket name that contains the objects. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - A delimiter is a character you use to group keys. - - - - - Specifies the key to start with when listing objects in a bucket. - - - - - Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more. - - - - - Limits the response to keys that begin with the specified prefix. - - - - - Specifies the object version you want to start listing from. - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - Returns information about the ListVersions response and response metadata. - - - - - A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria. If your results were - truncated, you can make a follow-up paginated request using the NextKeyMarker and NextVersionIdMarker response parameters as a starting - place in another request to return the rest of the results. - - - - - - Marks the last Key returned in a truncated response. - - - - - - Gets and sets the VersionIdMarker property. - Marks the last Version-Id returned in a truncated response. - - - - - Use this value for the key marker request parameter in a subsequent request. - - - - - - Use this value for the next version id marker parameter in a subsequent request. - - - - - - Gets and sets the Versions property. This is a list of - object versions in the bucket that match your search criteria. - - - - - Gets and sets the Name property. - The bucket's name. - - - - - Gets and sets the Prefix property. - Keys that begin with the indicated prefix are listed. - - - - - Gets and sets the MaxKeys property. - This is the maximum number of keys in the S3ObjectVersions collection. - The value is derived from the MaxKeys parameter to ListVersionsRequest. - - - - - Gets the CommonPrefixes property. - A response can contain CommonPrefixes only if you specify a delimiter. - When you do, CommonPrefixes contains all (if there are any) keys between - Prefix and the next occurrence of the string specified by delimiter. - - - - - Gets and sets the Delimiter property. - Causes keys that contain the same string between the prefix and the - first occurrence of the delimiter to be rolled up into a single result - element in the CommonPrefixes collection. - - - These rolled-up keys are not returned elsewhere in the response. - - - - - This class contains the meta data for an S3 object. - - - - - Gets and sets meta data for the object. Meta data names must start with "x-amz-meta-". If the name passeed in as the indexer - doesn't start with "x-amz-meta-" then it will be prepended. - - The name of the meta data. - The value for the meta data - - - - Adds the metadata to the collection, if the name already exists it will be overwritten. - - The name of the metadata element - The value for the metadata - - - - Gets the count of headers. - - - - - Gets the names of the meta data elements. - - - - - A metadata key-value pair to store with an object. - - - - - Key of metadata key-value pair - - - - - Value of metadata key-value pair - - - - - A container specifying replication metrics-related information, including whether - emitting metrics and Amazon S3 events for replication are enabled. In addition, contains - configurations related to specific metrics or events. Must be specified together with a - ReplicationTime block. - - - - - Specifies whether the replication metrics are enabled. - - - - - A container specifying the time threshold for emitting the - s3:Replication:OperationMissedThreshold event. - - - - - Class for MetricsAndOperatorPredicate - A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. - The operator must have at least two predicates, and an object must match all of the predicates - in order for the filter to apply. - - Note: The current implementation restricts the usage to atmost one MetricsPrefixPredicate - and any number of MetricsTagPredicates. - - - - Class for MetricsConfiguration - - - - - The ID used to identify the metrics configuration. - - - - - Specifies a metrics configuration filter. - The metrics configuration will only include objects that meet the filter's criteria. - A filter must be a prefix, a tag, or a conjunction (MetricsAndOperator). - - - - - Filter class for Metrics. - - - - - Filter Predicate setup for specific filter types. - - - - - Filter Predicate abstract class for specific filter types to be derived from. - - - - - Abstract class that can be used over logical filter predicates,i.e. AND/OR. - - - - - Class for MetricsPrefixPredicate - The prefix used when evaluating a metrics filter. - - - - - Class for MetricsTagPredicate - The tag used when evaluating a metrics filter. - - - - - This class contains the mfa codes used authentication - - - - - Gets and sets the serial number of the authentication device - - - - - Gets and sets the displated value on the authentication device - - - - - The formatted string of the mfa codes to be passed to S3. - - - - - Container for elements related to a particular multipart upload. - - - - - Date and time at which the multipart upload was initiated. - - - - - - Identifies who initiated the multipart upload. - - - - - - Key of the object for which the multipart upload was initiated. - - - - - - Gets and sets the Owner property. - - - - - The class of storage used to store the object. - - - - - - Upload ID that identifies the multipart upload. - - - - - - An abstract class for all the notification configurations associated with an Amazon S3 bucket. - - - - - Gets and sets the Events property. These are the events the configuration will listen to. - - - - - Filter criteria for determining which S3 objects trigger event notifications. - - - - - - The container element for Object Lock configuration parameters. - - - - - Gets and sets the property ObjectLockEnabled. - - Indicates whether this object has an Object Lock configuration enabled. - - - - - - Gets and sets the property Rule. - - The Object Lock rule in place for the specified object. - - - - - - A Legal Hold configuration for an object. - - - - - Gets and sets the property Status. - - Indicates whether the specified object has a Legal Hold in place. - - - - - - A Retention configuration for an object. - - - - - Gets and sets the property Mode. - - Indicates the Retention mode for the specified object. - - - - - - Gets and sets the property RetainUntilDate. - - - - - The container element for an Object Lock rule. - - - - - Gets and sets the property DefaultRetention. - - The default retention period that you want to apply to new objects placed in the specified - bucket. - - - - - - Describes the location where the restore job's output is stored. - - - - - Describes an S3 location that will receive the results of the restore request. - - - - - Describes how results of the Select job are serialized. - - - - - Describes the serialization of CSV-encoded Select results. - - - - - Specifies JSON as request's output serialization format. - - - - - The owner of an S3 bucket. - - - - - The display name of the owner. - - - - - The unique identifier of the owner. - - - - - This class contains custom querystring parameters for an S3 object, which can then be signed as part of a Pre-signed URL request - - - - - Gets and sets parameters for the object. Parameter names must start with "x-". If the name passeed in as the indexer - doesn't start with "x-" then it will be prepended. - - The name of the parameter. - The value for the meta data - - - - Adds the parameter to the collection, if the name already exists it will be overwritten. - - The name of the parameter - The value for the parameter - - - - Gets the count of parameters. - - - - - Gets the names of the parameter elements. - - - - - Specifies Parquet as object's input serialization format. - - - - - A container for elements related to a particular part in a multipart operation. - A response can contain zero or more Part elements. - - - - - The date and time at which the part was uploaded. - - - - - The size of the uploaded part data. - - - - - A container holding the part number and etag used when completing a multipart upload. - - - - - Default constructor. - - - - - Constructs an instance of PartETag and sets the part number and etag. - - The part number. - the associated ETag for the part number. - - - - Compares the current object with another object of the same type. - - An object to compare with this object. - - A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has the following meanings: - Value - Meaning - Less than zero - This object is less than the parameter. - Zero - This object is equal to . - Greater than zero - This object is greater than . - - - - - The part number identifying the part. - - - - - The entity tag associated with the part. - - - - - The container element for this bucket's public-policy status. - - - - - Gets and sets the property IsPublic. - - The public-policy status for this bucket. TRUE indicates that this bucket - is public. FALSE indicates that the bucket is not public. - - - - - - The container element for all Public Access Block configuration options. You can enable - the configuration options in any combination. - - - - Amazon S3 considers a bucket policy public unless at least one of the following conditions - is true: - -
  1. - - The policy limits access to a set of CIDRs using aws:SourceIp. For more - information on CIDR, see http://www.rfc-editor.org/rfc/rfc4632.txt - - -
  2. - - The policy grants permissions, not including any "bad actions," to one of the following: - -
    • - - A fixed AWS principal, user, role, or service principal - -
    • - - A fixed aws:SourceArn - -
    • - - A fixed aws:SourceVpc - -
    • - - A fixed aws:SourceVpce - -
    • - - A fixed aws:SourceOwner - -
    • - - A fixed aws:SourceAccount - -
    • - - A fixed value of s3:x-amz-server-side-encryption-aws-kms-key-id - -
    • - - A fixed value of aws:userid outside the pattern "AROLEID:*" - -
- - "Bad actions" are those that could expose the data inside a bucket to reads or writes - by the public. These actions are s3:Get*, s3:List*, s3:AbortMultipartUpload, - s3:Delete*, s3:Put*, and s3:RestoreObject. - - - - The star notation for bad actions indicates that all matching operations are considered - bad actions. For example, because s3:Get* is a bad action, s3:GetObject, - s3:GetObjectVersion, and s3:GetObjectAcl are all bad actions. - - - - - - Gets and sets the property BlockPublicAcls. - - Specifies whether Amazon S3 should block public ACLs for this bucket. Setting this - element to TRUE causes the following behavior: - -
  • - - PUT Bucket acl and PUT Object acl calls will fail if the specified ACL allows public - access. - -
  • - - PUT Object calls will fail if the request includes an object ACL. - -
- - Note that enabling this setting doesn't affect existing policies or ACLs. - - - - - - Gets and sets the property IgnorePublicAcls. - - Specifies whether Amazon S3 should ignore public ACLs for this bucket. Setting this - element to TRUE causes Amazon S3 to ignore all public ACLs on this bucket - and any objects that it contains. - - - - Note that enabling this setting doesn't affect the persistence of any existing ACLs - and doesn't prevent new public ACLs from being set. - - - - - - Gets and sets the property BlockPublicPolicy. - - Specifies whether Amazon S3 should block public bucket policies for this bucket. Setting - this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy - if the specified bucket policy allows public access. - - - - Note that enabling this setting doesn't affect existing bucket policies. - - - - - - Gets and sets the property RestrictPublicBuckets. - - Specifies whether Amazon S3 should restrict public bucket policies for this bucket. - If this element is set to TRUE, then only the bucket owner and AWS Services - can access this bucket if it has a public policy. - - - - Note that enabling this setting doesn't affect previously stored bucket policies, - except that public and cross-account access within any public bucket policy, including - non-public delegation to specific accounts, is blocked. - - - - - - Container for the parameters to the PutAcl operation. - uses the acl subresource to set the access control list (ACL) permissions for an object that already exists in a bucket - - - - - The canned ACL to apply to the bucket. - - - - - - Custom ACLs to be applied to the bucket or object. - - - - - The bucket name that contains the object to which you want to attach the ACL. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The key of an S3 object. - If not specified, the ACLs are applied to the bucket. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - If set and an object key has been specified, the ACLs are applied - to the specific version of the object. - This property is ignored if the ACL is to be set on a Bucket. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - Returns information about the PutObjectAcl response metadata. - The PutAcl operation has a void result type. - - - - - The response for the PutBucketAccelerateConfiguration operation. - Adds an object to a bucket. - - - - - Container for the parameters to the PutBucketAccelerateConfiguration request. - - - - - The name of the bucket to contain the object. - - - - - Accelerate configuration for the bucket. - - - - - Container for the parameters to the PutBucketAnalyticsConfiguration operation. - Sets an analytics configuration for the bucket (specified by the analytics configuration ID). - - - - - The name of the bucket to which an analytics configuration is stored. - - - - - The identifier used to represent an analytics configuration. - - - - - The configuration and any analyses for the analytics filter. - - - - - Returns information about the PutBucketAnalyticsConfigurationResponse response metadata. - The PutBucketAnalyticsConfigurationResponse operation has a void result type. - - - - - Container for the parameters to the PutBucketRequestPayment operation. - Creates a new server-side encryption configuration (or replaces an existing one, if present). - - - - - The name of the bucket for which the server-side encryption configuration is set. - - - - - The base64-encoded 128-bit MD5 digest of the server-side encryption configuration. - - - This header can be used as a message integrity check to verify that the data is the same data that was originally sent. - Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. - - - - - Container for server-side encryption configuration rules. Currently S3 supports one rule only. - - - - - Container for the parameters to the PutBucketRequestPayment operation. - Adds an inventory configuration (identified by the inventory ID) from the bucket. - - - - - The name of the bucket where the inventory configuration will be stored. - - - - - Specifies the inventory Id. - - - - - Specifies the inventory configuration. - - - - - Returns information about the PutInventoryConfigurationResponse response metadata. - The PutInventoryConfigurationResponse operation has a void result type. - - - - - Container for the parameters to the PutBucketLoggingRequest operation. - Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. To set the - logging status of a bucket, you must be the bucket owner. - - - - - Gets and sets the BucketName property. - - - - - Gets and sets the LoggingConfig property. - - - - - Returns information about the PutBucketLogging response metadata. - The EnableBucketLogging operation has a void result type. - - - - - Container for the parameters to the PutBucketMetricsConfigurationRequest operation. - Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. - - - - - The name of the bucket for which the metrics configuration is set. - - - - - The ID used to identify the metrics configuration. - - - - - Specifies the metrics configuration. - - - - - Returns information about the PutBucketMetricsConfiguration response metadata. - The PutBucketMetricsConfiguration operation has a void result type. - - - - - Container for the parameters to the PutBucketNotification operation. - Enables notifications of specified events for a bucket. - - - - - Gets and sets the BucketName property. - - - - - Gets and sets the TopicConfigurations property. TopicConfigurations are configuration for Amazon S3 - events to be sent to Amazon SNS topics. - - - - - Gets and sets the QueueConfigurations property. QueueConfigurations are configuration for Amazon S3 - events to be sent to Amazon SQS queues. - - - - - Gets and sets the LambdaFunctionConfigurations property. LambdaFunctionConfigurations are configuration for - Amazon S3 events to be sent to an Amazon Lambda cloud function. - - - - - Returns information about the PutBucketNotification response metadata. - The PutBucketNotification operation has a void result type. - - - - - Container for the parameters to the PutBucketPolicy operation. - Replaces a policy on a bucket. If the bucket already has a policy, the one in this request completely replaces it. - - - - - The name of the bucket. - - - - - The base64 encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. - - - This header can be used as a message integrity check to verify that the data is the same data that was originally sent. - Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. - - - - - The bucket policy as a JSON document. - - - - - Set this parameter to true to confirm that you want to remove your - permissions to change this bucket policy in the future. - - - - - Overriden to turn off sending SHA256 header. - - - - - Returns information about the PutBucketPolicy response metadata. - The PutBucketPolicy operation has a void result type. - - - - - Container for the parameters to the PutBucketReplication operation. - Sets replication configuration for your bucket. If a replication configuration exists, this replaces it. - - - - - The name of the bucket to have the replication configuration applied. - - - - - The replication configuration to be applied. - - - - - Gets and sets the property Token. - - - - - Returns information about the PutBucketReplicationConfiguration response metadata. - The PutBucketReplicationConfiguration operation has a void result type. - - - - - Container for the parameters to the PutBucket operation. - Creates a new bucket. - - - - - The canned ACL to apply to the bucket. - - - - - - If set to true the bucket will be created in the same region - as the configuration of the AmazonS3 client. - If PutBucketRequest.BucketRegion or PutBucketRequest.BucketRegionName are set they take precedence over - this property. - Default: true. - - - - - The name of the bucket to be created. - - - - - The region locality for the bucket. - - - When set, this will determine where your data will - reside in S3. Refer - for a list of possible values. - - - - - The bucket region locality expressed using the name of the region. - When set, this will determine where your data will reside in S3. - Valid values: us-east-1, us-west-1, us-west-2, eu-west-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, sa-east-1 - - - - - Gets and sets the property ObjectLockEnabledForBucket. - - Specifies whether you want S3 Object Lock to be enabled for the new bucket. - - - - - - Container for the parameters to the PutBucketRequestPayment operation. - Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This - configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the - download. - - - - - The name of the bucket to set payment config. - - - - - Gets and sets request payment configuration - - - - - Returns information about the PutBucketRequestPayment response metadata. - The PutBucketRequestPayment operation has a void result type. - - - - - Returns information about the PutBucket response and response metadata. - - - - - Container for the parameters to the PutBucketTagging operation. - Sets the tags for a bucket. - - - - - The name of the bucket to apply the tags to. - - - - - The collection of tags. - - - - - Returns information about the PutBucketTagging response metadata. - The PutBucketTagging operation has a void result type. - - - - - Container for the parameters to the PutBucketVersioning operation. - Sets the versioning state of an existing bucket. To set the versioning state, you must be the bucket owner. - - - - - The name of the bucket to be updated. - - - - - The MfaCodes Tuple associates the Serial Number and the current Token/Code displayed on the - Multi-Factor Authentication device associated with your AWS Account. - - - This is a required property for this request if:
- 1. EnableMfaDelete was configured on the bucket - containing this object's version.
- 2. You are deleting an object's version - - - - - Checks if the MfaCodes property is set. - - true if the MfaCodes property is set. - - - - The versioning configuration to apply to the bucket. - - - Once Versioning has been "Enabled" on a bucket, it can be "Suspended" - but cannot be switched "Off". If EnableMfaDelete is set, - the MfaCodes property needs to contain the Serial of and current Token - displayed on the MFA device. - - - - - Returns information about the PutBucketVersioning response metadata. - The PutBucketVersioning operation has a void result type. - - - - - Container for the parameters to the PutBucketWebsite operation. - Set the website configuration for a bucket. - - - - - The name of the bucket to apply the configuration to. - - - - - The website configuration to apply. The configuration defines the index - document suffix and custom error page. - - - - - Returns information about the PutBucketWebsite response metadata. - The PutBucketWebsite operation has a void result type. - - - - - Container for the parameters to the PutCORSConfiguration operation. - Sets the cors configuration for a bucket. - - - - - The name of the bucket to have the CORS configuration applied. - - - - - The CORS configuration to apply. - - - - - Returns information about the PutCORSConfiguration response metadata. - The PutCORSConfiguration operation has a void result type. - - - - - Container for the parameters to the PutLifecycleConfiguration operation. - Sets lifecycle configuration for your bucket. If a lifecycle configuration exists, it replaces it. - - - - - The name of the bucket to have the lifecycle configuration applied. - - - - - The lifecycle configuration to be applied. - - - - - Returns information about the PutLifecycleConfiguration response metadata. - The PutLifecycleConfiguration operation has a void result type. - - - - - Container for the parameters to the PutObjectLegalHold operation. - Applies a Legal Hold configuration to the specified object. - - - - - The bucket name containing the object that you want to place a Legal Hold on. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property ContentMD5. - - The MD5 signature for the configuration included in your request. - - - - - - Gets and sets the property Key. - - The key name for the object that you want to place a Legal Hold on. - - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Gets and sets the property LegalHold. - - Container element for the Legal Hold configuration you want to apply to the specified - object. - - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property VersionId. - - The version ID of the object that you want to place a Legal Hold on. - - - - - - This is the response object from the PutObjectLegalHold operation. - - - - - Gets and sets the property RequestCharged. - - - - - Container for the parameters to the PutObjectLockConfiguration operation. - Places an Object Lock configuration on the specified bucket. The rule specified in - the Object Lock configuration will be applied by default to every new object placed - in the specified bucket. - - - - - Gets and sets the property BucketName. - - The bucket whose Object Lock configuration you want to create or replace. - - - - - - Gets and sets the property ContentMD5. - - The MD5 signature for the configuration included in your request. - - - - - - Gets and sets the property ObjectLockConfiguration. - - The Object Lock configuration that you want to apply to the specified bucket. - - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property Token. - - - - - This is the response object from the PutObjectLockConfiguration operation. - - - - - Gets and sets the property RequestCharged. - - - - - Container for the parameters to the PutObject operation. - Adds an object to a bucket. - - - Container for the parameters to the PutObject operation. - Adds an object to a bucket. - - - - - A canned access control list (CACL) to apply to the object. - Please refer to for - information on S3 Canned ACLs. - - - - - Input stream for the request; content for the request will be read from the stream. - - - - - - The full path and name to a file to be uploaded. - If this is set the request will upload the specified file to S3. - - - For WinRT and Windows Phone this property must be in the form of "ms-appdata:///local/file.txt". - - - - - - Text content to be uploaded. Use this property if you want to upload plaintext to S3. - The content type will be set to 'text/plain'. - - - - - If this value is set to true then the stream used with this request will be closed when all the content - is read from the stream. - Default: true. - - - - - If this value is set to true then the stream will be seeked back to the start before being read for upload. - Default: true. - - - - - If this value is set to true then a chunked encoding upload will be used for the request. - Default: true. - - - - - Bucket name to which the PUT operation was initiated. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - Gets and sets Key property. This key is used to identify the object in S3. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - Checks if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - true if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - - - The type of storage to use for the object. Defaults to 'STANDARD'. - - - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - The Legal Hold status that you want to apply to the specified object. - - - - - - Gets and sets the property ObjectLockMode. - - The Object Lock mode that you want to apply to this object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - The date and time when you want this object's Object Lock to expire. - - - - - - If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - Attach a callback that will be called as data is being sent to the AWS Service. - - - - - This is a convenience property for Headers.ContentType. - - - - - An MD5 digest for the content. - - - - The base64 encoded 128-bit MD5 digest of the message - (without the headers) according to RFC 1864. This header - can be used as a message integrity check to verify that - the data is the same data that was originally sent. - - - If supplied, after the file has been uploaded to S3, - S3 checks to ensure that the MD5 hash of the uploaded file - matches the hash supplied. - - - Although it is optional, we recommend using the - Content-MD5 mechanism as an end-to-end integrity check. - - - - - - Checks if MD5Digest property is set. - - true if MD5Digest property is set. - - - - Overriden to turn off sending SHA256 header. - - - - - Overriden to turn on expect 100 continue. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - The tag-set for the object. The tag-set must be encoded as URL Query parameters. - - - - - Checks if Tagging property is set - - true if Tagging is set. - - - - Returns information about the PutObject response and response metadata. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - Entity tag for the uploaded object. - - - - - - Version of the object. - - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the PutObjectRetention operation. - Places an Object Retention configuration on an object. - - - - - The bucket name that contains the object you want to apply this Object Retention configuration to. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property BypassGovernanceRetention. - - - - - Gets and sets the property ContentMD5. - - The MD5 signature for the configuration included in your request. - - - - - - Gets and sets the property Key. - - The key name for the object that you want to apply this Object Retention configuration - to. - - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property Retention. - - The container element for the Object Retention configuration. - - - - - - Gets and sets the property VersionId. - - The version ID for the object that you want to apply this Object Retention configuration - to. - - - - - - This is the response object from the PutObjectRetention operation. - - - - - Gets and sets the property RequestCharged. - - - - - Container for the parameters to the PutObjectTagging operation. - - - - - The bucket name containing the object. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Check to see if Bucket property is set - - - - - Gets and sets Key property. This key is used to identify the object in S3. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Check to see if Key property is set - - - - - The tag-set for the object. The tag-set must be encoded as URL Query parameters - - - - - Checks if Tagging property is set. - - - - - VersionId used to reference a specific version of the object. - - - - - - Returns information about the PutObjectTagging response and response metadata. - - - - - Version of the object. - - - - - Container for the parameters to the PutPublicAccessBlock operation. - Creates or modifies the Public Access Block configuration for an Amazon S3 bucket. - - - - - Gets and sets the property BucketName. - - The name of the Amazon S3 bucket whose Public Access Block configuration you want - to set. - - - - - - Gets and sets the property ContentMD5. - - The MD5 hash of the PutPublicBlock request body. - - - - - - Gets and sets the property PublicAccessBlockConfiguration. - - The Public Access Block configuration that you want to apply to this Amazon S3 bucket. - - - - - - This is the response object from the PutPublicAccessBlock operation. - - - - - Base class for put operations that can also put an ACL. - - - - - Gets the access control lists (ACLs) for this request. - Please refer to for information on - S3 Grants. - - - - - This class contains the configuration Amazon S3 uses to figure out what events you want to listen - and send the event to an Amazon SQS queue. - - The queue's policy must allow S3 to send messages to it. The utility method - Amazon.SQS.AmazonSQSClient.AuthorizeS3ToSendMessage(string,string) - can be used to help setup the queue policy. - - - - - - Gets and set the Id property. The Id will be provided in the event content and can be used - to identify which configuration caused an event to fire. If the Id is not provided for the configuration, one will be generated. - - - - - Gets and sets the Queue property. Amazon SQS queue to which Amazon S3 will publish a message - to report the specified events for the bucket. - - The queue's policy must allow S3 to send messages to it. The utility method - Amazon.SQS.AmazonSQSClient.AuthorizeS3ToSendMessage(string,string) - can be used to help setup the queue policy. - - - - - - This class defines the configuration for replication. - - - - - Indicates the ARN of the role to assume. - - - - - Check to see if the Role property is set. - - true if the Role property is set. - - - - Container for information about a particular replication rule. - Replication configuration must have at least one rule and can contain up to 1,000 rules. - - - - - Checks to see if the Rules property is set. - - true if the Rules property is set. - - - - Destination configuration for a replication rule. - - - - -

Amazon resource name (ARN) of the bucket where you want Amazon - S3 to store replicas of the object identified by the rule.

- If you have multiple rules in your replication configuration, all - rules must specify the same bucket as the destination. A replication - configuration can replicate objects only to one destination bucket.

- - - - - Checks to see if BucketArn property is set. - - true if BucketArn property is set. - - - - The class of storage used to store the object. - - - - - -

Account ID of the destination bucket. Currently Amazon S3 verifies this - value only if Access Control Translation is enabled.

In a cross-account - scenario, if you tell Amazon S3 to change replica ownership to the AWS account - that owns the destination bucket by adding the AccessControlTranslation - element, this is the account ID of the destination bucket owner.

- - - - -

Container for information regarding the access control for replicas.

-

Use only in a cross-account scenario, where source and destination bucket - owners are not the same, when you want to change replica ownership to the AWS - account that owns the destination bucket. If you don't add this element to the - replication configuration, the replicas are owned by same AWS account that - owns the source object.

- - - - -

Container that provides encryption-related information. You must - specify this element if the SourceSelectionCriteria is - specified.

- - - - - A container specifying the time when all objects and operations on objects are - replicated. Must be specified together with a Metrics block. - - - - - A container specifying replication metrics-related information, including whether - emitting metrics and Amazon S3 events for replication are enabled. In addition, - contains configurations related to specific metrics or events. Must be specified - together with a ReplicationTime block. - - - - - Rule that specifies the replication configuration. - - - - - Unique identifier for the rule. The value cannot be longer than 255 characters. - - - - - Checks to see if Id property is set. - - true if Id property is set. - - - -

The priority associated with the rule. If you specify multiple rules in a - replication configuration, then Amazon S3 applies rule priority in the event - there are conflicts (two or more rules identify the same object based on - filter specified). The rule with higher priority takes precedence. For - example,

  • Same object quality prefix based filter criteria - If prefixes you specified in multiple rules overlap.

  • Same - object qualify tag based filter criteria specified in multiple rules

    • -

For more information, see - - Cross-Region Replication (CRR) in the Amazon S3 Developer Guide.

- - - - - Checks to see if Priority property is set. - - true if Priority property is set. - - - - Object keyname prefix identifying one or more objects to which the - rule applies. Maximum prefix length can be up to 1,024 characters. - - - - - Checks to see if Prefix property is set. - - true if Prefix property is set. - - - - Gets and sets the property Filter. - - - - - Checks to see if Filter property is set. - - true if Filter property is set. - - - - Whether the rule is applied or ignored. - - - - - Checks to see if Status property is set. - - true if Status property is set. - - - - Container for replication destination information. - - - - - Checks to see if Destination property is set. - - true if Destination property is set. - - - -

Container that describes additional filters in identifying source objects that - you want to replicate. Currently, Amazon S3 supports only the filter that you can - specify for objects created with server-side encryption using an AWS KMS-managed - key. You can choose to enable or disable replication of these objects.

if - you want Amazon S3 to replicate objects created with server-side encryption using - AWS KMS-managed keys.

- - - - - A container that specifies information about existing object replication. - You can choose whether to enable or disable the replication of existing objects. - - - - - Checks to see if ExistingObjectReplication property is set. - - true if ExistingObjectReplication property is set. - - - - Specifies whether Amazon S3 should replicate delete makers. - - - - - Checks to see if DeleteMarkerReplication property is set. - - true if DeleteMarkerReplication property is set. - - - - - - - - Object keyname prefix that identifies subset of objects to which the rule applies. - - - - - Checks to see if Prefix property is set. - - true if Prefix property is set. - - - - All of these tags must exist in the object's tag set in order for the rule to apply. - - - - - Checks to see if Tags property is set. - - true if Tags property is set. - - - - Filter that identifies subset of objects to which the replication rule applies. - A Filter must specify exactly one Prefix, - Tag, or an And child element. - - - - - Object keyname prefix that identifies subset of objects to which the rule applies. - - - - - Checks to see if Prefix property is set. - - true if Prefix property is set. - - - -

Container for specifying a tag key and value.

-

The rule applies only to objects having the tag in its tagset.

- - - - - Checks to see if Tag property is set. - - true if Tag property is set. - - - -

Container for specifying rule filters. These filters determine the - subset of objects to which the rule applies. The element is required - only if you specify more than one filter. For example:

  • -

    You specify both a Prefix and a Tag - filters. Then you wrap these in an And tag.

    • -

  • You specify filter based on multiple tags. Then you wrap the - Tag elements in an And tag.

- - - - - Checks to see if And property is set. - - true if And property is set. - - - - A container specifying the time when all objects and operations on objects are replicated. Must be specified together with a Metrics block. - - - - - Specifies whether the replication time is enabled. - - - - - A container specifying the time by which replication should complete for all objects and operations on objects. - - - - - A container specifying the time value. - - - - - Contains an integer specifying time in minutes. - - - - - Request Payment Configuration - - - - - Specifies who pays for the download and request fees. - - - - - Container for values of the response headers that will be set on a response from a GetObject request. - These values override any headers that were set when the object was uploaded to S3. - - - - - A standard MIME type describing the format of the object data. - - - The content type for the content being uploaded. This property defaults to "binary/octet-stream". - For more information, refer to: - - - - - ContentLanguage header value. - - - - - Expiry header value. - - - - - CacheControl header value. - - - - - The ContentDisposition header value. - - - - - The ContentEncoding header value. - - - - - Container for the parameters to the RestoreObject operation. - Restores an archived copy of an object back into Amazon S3 - - - - - The bucket name or containing the object to restore. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the Key property. This key indicates the S3 object to restore. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Lifetime of the active copy in days - ** Do not use with restores that specify OutputLocation ** - - - - - VersionId used to reference a specific version of the object. - - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Glacier retrieval tier at which the restore will be processed. - ** Do not use with restores that specify OutputLocation ** - - - - - Glacier retrieval tier at which the restore will be processed. - ** Only use with restores that require OutputLocation ** - - - - - Type of restore request. - - - - - The optional description for the job. - - - - - Describes the parameters for Select job types. - - - - - Describes the location where the restore job's output is stored. - - - - - Returns information about the RestoreObject response metadata. - The RestoreObject operation has a void result type. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Indicates the path in the provided S3 output location where Select results will be restored to. - - - - Routing Rule - - - - - A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the - /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might - process the error. - - - - - - Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event of an - error, you can can specify a different error code to return. - - - - - - A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages - in the /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you - might process the error. - - - - - The HTTP error code when the redirect is applied. In the event of an error, if the error code equals this value, then the specified redirect - is applied. Required when parent element Condition is specified and sibling KeyPrefixEquals is not specified. If both are specified, then - both must be true for the redirect to be applied. - - - - - - The object key name prefix when the redirect is applied. For example, to redirect requests for ExamplePage.html, the key prefix will be - ExamplePage.html. To redirect request for all pages with the prefix docs/, the key prefix will be /docs, which identifies all objects in the - docs/ folder. Required when the parent element Condition is specified and sibling HttpErrorCodeReturnedEquals is not specified. If both - conditions are specified, both must be true for the redirect to be applied. - - - - - - Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event - of an error, you can can specify a different error code to return. - - - - - Name of the host where requests will be redirected. - - - - - - The HTTP redirect code to use on the response. Not required if one of the siblings is present. - - - - - - Protocol to use (http, https) when redirecting requests. The default is the protocol that is used in the original request. - - - - - - The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix docs/ (objects in the - docs/ folder) to documents/, you can set a condition block with KeyPrefixEquals set to docs/ and in the Redirect set ReplaceKeyPrefixWith to - /documents. Not required if one of the siblings is present. Can be present only if ReplaceKeyWith is not provided. - - - - - - The specific object key to use in the redirect request. For example, redirect request to error.html. Not required if one of the sibling is - present. Can be present only if ReplaceKeyPrefixWith is not provided. - - - - - - Represents an access control list (ACL) for S3. An AccessControlList is represented by an Owner, - and a List of Grants, where each Grant is a Grantee and a Permission. - - - - Each bucket and object in Amazon S3 has an ACL that defines its access control policy. - When a request is made, Amazon S3 authenticates the request using its standard - authentication procedure and then checks the ACL to verify the sender was granted access - to the bucket or object. If the sender is approved, the request proceeds. - Otherwise, Amazon S3 returns an error. - - - An ACL is a list of grants. A grant consists of one grantee and one permission. - ACLs only grant permissions; they do not deny them. - - - For convenience, some commonly used Access Control Lists are defined in - S3CannedACL. - - - Note: BucketName and object ACLs are completely independent; an object does not inherit the ACL - from its bucket. For example, if you create a bucket and grant write access to another user, - you will not be able to access the user's objects unless the user explicitly grants access. - This also applies if you grant anonymous write access to a bucket. Only the user "anonymous" - will be able to access objects the user created unless permission is explicitly granted to - the bucket owner. - - - Important: We highly recommend that you do not grant the anonymous group write access to your - buckets as you will have no control over the objects others can store and their associated charges. - For more information, see Grantees and Permissions - - - - - Creates a S3Grant and adds it to the list of grants. - - The grantee for the grant. - The permission for the grantee. - - - - Removes a specific permission for the given grantee. - - The grantee - The permission for the grantee to remove - - - - Removes all permissions for the given grantee. - - - - - - The owner of the bucket or object. - - - - Every bucket and object in Amazon S3 has an owner, the user that - created the bucket or object. The owner of a bucket or object cannot - be changed. However, if the object is overwritten by another user - (deleted and rewritten), the new object will have a new owner. - - - Note: Even the owner is subject to the ACL. For example, if an owner - does not have Permission.READ access to an object, the owner cannot read - that object. However, the owner of an object always has write access to the - access control policy (Permission.WriteAcp) and can change the ACL to - read the object. - - - - - - Checks if Owner property is set. - - true if Owner property is set. - - - - A collection of grants. - - - - - Checks if Grants property is set. - - true if Grants property is set. - - - Bucket - Represents an S3 bucket, contains the name of the S3 bucket and the date that the bucket was created. - - - - - Date the bucket was created. - - - - - - The name of the bucket. - - - - - Logging Enabled - - - - - Specifies the bucket where you want Amazon S3 to store server access logs. You can have your logs delivered to any bucket that you own, - including the same bucket that is being logged. You can also configure multiple buckets to deliver their logs to the same target bucket. In - this case you should choose a different TargetPrefix for each source bucket so that the delivered log files can be distinguished by key. - - - - - A collection of grants. - - - - - This element lets you specify a prefix for the keys that the log files will be stored under. - - - - - Creates a S3Grant and adds it to the list of grants. - - The grantee for the grant. - The permission for the grantee. - - - - Removes a specific permission for the given grantee. - - The grantee - The permission for the grantee to remove - - - - Removes all permissions for the given grantee. - - - - - - An S3 bucket versioning configuration. - - - Contains the bucket's versioning status (Off, Enabled, Suspended) and whether an MFADelete - has been enabled for the bucket. - - - - - Versioning status for the bucket. - Accepted values: Off, Enabled, Suspended. - - - - - Checks if Status property is set - - true if Status property is set - - - - Specifies whether MFA Delete is enabled on this S3 Bucket. - - - If this property is set, please ensure that the - PutBucketVersioningRequest's MfaCodes property is set with - the Serial of and Token on the MFA device. - - - - - Checks if EnableMfaDelete property is set. - - true if Status property is set - - - - Describes the server-side encryption that will be applied to the restore results. - - - - - The server-side encryption algorithm used when storing job results in Amazon S3 (e.g., AES256, aws:kms). - - - - - Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by - AWS KMS will fail if not made via SSL or using SigV4. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at - http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version - - - - - If the encryption type is aws:kms, this optional value can be used to specify the encryption context for the restore results. - - - - Grant - - - - - The grantee details. - - - - - Specifies the permission given to the grantee. - - - - - Grantee - - - - - Type of grantee - - - - - - Screen name of the grantee. - - - - - - Email address of the grantee. - - - - - - The canonical user ID of the grantee. - - - - - - URI of the grantee group. - - - - - - Filter criteria that allows for event notification filtering based on an S3 Object's key name. - - - - - Gets and sets the filterRules property. - These are the filter rules for this filter. - - - - - Describes an S3 location that will receive the results of the restore request. - - - - - The name of the bucket where the restore results will be placed. - - - - - The prefix that is prepended to the restore results for this request. - - - - - The canned ACL to apply to the restore results. - - - - - A list of grants that control access to the staged results. - - - - - The tag-set that is applied to the restore results. - - - - - A map of metadata to store with the restore results in S3. - - - - - The class of storage used to store the restore results. - - - - - Represents an S3 Object. Contains all attributes that an S3 Object has. - For more information about S3 Objects refer: - - - - - - Any ETag set on the object. - - - - - The name of the bucket containing this object. - - - - - The key of the object. - - - - - The date and time the object was last modified. - - The date retrieved from S3 is in ISO8601 format. A GMT formatted date is passed back to the user. - - - - - - The owner of the object. - - - - - The size of the object. - - - - - The class of storage used to store the object. - - - - - - Represents a version of an object in an S3 Bucket. An S3 object version is an S3 object - that also has a version identifier, an indication of whether this is the latest version of the object - and whether it's a DeleteMarker or not. - - - - - Specifies whether the object is (true) or is not (false) the latest version of an object. - - - - - Version ID of an object. - - - - - If true, the object is a delete marker for a deleted object. - - - - - Specifies the byte range of the object to get the records from. A record is processed when its first byte is contained by the range. - - - - - Specifies the start of the byte range. This parameter is optional. Valid values: non-negative integers. The default value is 0. - - - - - Specifies the end of the byte range. This parameter is optional. Valid values: non-negative integers. The default value is one less than the size of the object being queried. - - - - - Request to filter the contents of an Amazon S3 object based on a simple Structured Query Language (SQL) statement. - - In the request, along with the SQL expression, you must also specify a data serialization format (JSON or CSV) of the object. - Amazon S3 uses this to parse object data into records, and returns only records - that match the specified SQL expression. You must also specify the data serialization format for the response. - - - - S3Select API Documentation - - - - - The S3 Bucket. - - - - - The Object Key. - - - - - The SSE Algorithm used to encrypt the object. - - - Server-Side Encryption (Using Customer-Provided Encryption Keys. - - - - - The SSE Customer Key. - - - Server-Side Encryption (Using Customer-Provided Encryption Keys. - - - - - The SSE Customer Key MD5. - - - Server-Side Encryption (Using Customer-Provided Encryption Keys. - - - - - The expression that is used to query the object. - - - - - The type of the provided expression (e.g., SQL). - - - - - Specifies if periodic request progress information should be enabled. - - - - - Describes the format of the data in the object that is being queried. - - - - - Describes the format of the data that you want Amazon S3 to return in response. - - - - - The byte range of the object to get the records from. - - - - - Contains the response Payload for the SelectObjectContent request - - - - - The Event Stream result of SelectObjectContent - - - - - Describes the parameters for Select job types. - - - - - Describes the serialization format of the object. - - - - - The type of the provided expression (e.g., SQL). - - - - - The expression that is used to query the object. - - - - - Describes how the results of the Select job are serialized. - - - - - ServerSideEncryptionByDefault class - - - - - Server-side encryption algorithm to use for the default encryption. - - - - - KMS master key ID to use for the default encryption. - This parameter is allowed if SSEAlgorithm is aws:kms. - - - - - ServerSideEncryptionConfiguration class - - - - - Container for information about a particular server-side encryption configuration rule. - - - - - ServerSideEncryptionRule class - - - - - Describes the default server-side encryption to apply to - new objects in the bucket. If Put Object request - does not specify any server-side encryption, - this default encryption will be applied. - - - - - SourceSelectionCriteria class - - - - - Container for filter information of selection of KMS Encrypted - S3 objects. The element is required if you include - SourceSelectionCriteria in the replication - configuration. - - - - - SSEKMS class - - - - - Specifies the ID of the AWS Key Management Service (KMS) - master encryption key to use for encrypting Inventory reports. - - - - - SseKmsEncryptedObjects class - - - - - The replication for KMS encrypted S3 objects is disabled if status is not Enabled. - - - - - SSES3 class - - - - - Class for StorageClassAnalysis - - - - - A container used to describe how data related to the storage class analysis should be exported. - - - - - Class for StorageClassAnalysisDataExport - - - - - The version of the output schema to use when exporting data. Must be V_1. - - - - - The place to store the data for an analysis. - - - - - Base class for responses that return a stream. - - - - - Disposes of all managed and unmanaged resources. - - - - - An open stream read from to get the data from S3. In order to - use this stream without leaking the underlying resource, please - wrap access to the stream within a using block. - - - - - The exception that is thrown when the size of a stream does not match it's expected size. - - - - - Gets and sets ExpectedSize property. - - - - - Gets and sets ActualSize property. - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - - - Tag is a key-value pair of metadata associated with an S3Object - - - - - Name of the tag. - - - - - Value of the tag. - - - - - Structure that contains list of Tags - - - - - TagSet - - - - - This class contains the configuration Amazon S3 uses to figure out what events you want to listen - and send the event to an Amazon SNS topic. - - The topic's policy must allow S3 to publish messages to it. The utility method - Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.AuthorizeS3ToPublish(string,string) - can be used to help setup the topic policy. - - - - - - Gets and set the Id property. The Id will be provided in the event content and can be used - to identify which configuration caused an event to fire. If the Id is not provided for the configuration, one will be generated. - - - - - Bucket event for which to send notifications. - - Topic configurations can now contain multiple events. This property is obsolete in favor of the Events property. - This property will always get or set the the zeroth element in the Events collection. - - - - - - Gets and sets the Topic property. Amazon SNS topic to which Amazon S3 will publish a message to report the - specified events for the bucket. - - The topic's policy must allow S3 to publish messages to it. The utility method - Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.AuthorizeS3ToPublish(string,string) - can be used to help setup the topic policy. - - - - - - The parameters to request upload of a part in a multipart upload operation. - - - - If PartSize is not specified then the rest of the content from the file - or stream will be sent to Amazon S3. - - - You must set either the FilePath or InputStream. If FilePath is set then the FilePosition - property must be set. - - - - The parameters to request upload of a part in a multipart upload operation. - - - - If PartSize is not specified then the rest of the content from the file - or stream will be sent to Amazon S3. - - - You must set either the FilePath or InputStream. If FilePath is set then the FilePosition - property must be set. - - - - - - Caller needs to set this to true when uploading the last part. This property only needs to be set - when using the AmazonS3EncryptionClient. - - - - - Input stream for the request; content for the request will be read from the stream. - - - - - The name of the bucket containing the object to receive the part. - - - - - The key of the object. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Part number of part being uploaded. - - - - - - The size of the part to be uploaded. - - - - - Checks if PartSize property is set. - - true if PartSize property is set. - - - - Upload ID identifying the multipart upload whose part is being uploaded. - - - - - - An MD5 digest for the part. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - - Full path and name of a file from which the content for the part is retrieved. - - - For WinRT and Windows Phone this property must be in the form of "ms-appdata:///local/file.txt". - - - - - - Checks if the FilePath property is set. - - true if FilePath property is set. - - - - Position in the file specified by FilePath from which to retrieve the content of the part. - This field is required when a file path is specified. It is ignored when using the InputStream property. - - - - - If this value is set to true then a chunked encoding upload will be used for the request. - Default: true. - - - - - Checks if the FilePosition property is set. - - true if FilePosition property is set. - - - - Checks if the MD5Digest property is set. - - true if Md5Digest property is set. - - - - Attach a callback that will be called as data is being sent to the AWS Service. - - - - - Overriden to turn off sending SHA256 header. - - - - - Overriden to turn on Expect 100 continue. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the UploadPart response and response metadata. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - Entity tag for the uploaded object. - - - - - - Gets and sets the part number specified for the part upload. This is needed when - completing the multipart upload. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - Website Configuration - - - - - The ErrorDocument value, an object key name to use when a 4XX class error occurs. - - - - - - This value is a suffix that is appended to a request that is for a "directory" - on the website endpoint (e.g. if the suffix is index.html and - you make a request to samplebucket/images/ the data that - is returned will be for the object with the key name - images/index.html) - - - The suffix must not be empty and must not include a slash - character. - - - - - - Container for redirect information where all requests will be redirect - to. You can redirect requests to another host, to another page, or with - another protocol. In the event of an error, you can can specify a - different error code to return. . - - - - - The list of routing rules that can be used for configuring redirects if certain conditions are meet. - - - - - Arguments containing event details for an in-flight transfer. - - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - - - - Gets the percentage of transfer completed - - - - - Gets the number of bytes transferred since last event - - - - - Gets the number of bytes transferred - - - - - Gets the total number of bytes to be transferred - - - - - Returns a string representation of this object - - - - - - AmazonS3 exception. - Thrown when DeleteObjects returns successfully, but some of the objects - were not deleted. - - - - - Gets and sets the ErrorResponse property. - The DeleteObjectsErrorResponse associated with this exception. - - - - - Constructs an instance of DeleteObjectsException - - - - - - The file format used when exporting data to Amazon S3. - - - - - CSV file format. - - - - - Construct instance of AnalyticsS3ExportFileFormat. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to an AnalyticsS3ExportFileFormat. - - - - - - - Represents the accelerate status for a bucket. - - - - - Bucket acceleration is enabled. - - - - - Bucket acceleration is suspended. - - - - - Construct instance of BucketAccelerateStatus. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to an BucketAccelerateStatus - - - - - - - The status of the delete marker replication. - - - - - Delete marker replication is enabled. - - - - - Delete marker replication is disabled. - - - - - Construct instance of DeleteMarkerReplicationStatus. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to a DeleteMarkerReplicationStatus - - - - - - - A list of all possible CannedACLs that can be used - for S3 Buckets or S3 Objects. For more information about CannedACLs, refer to - . - - - - - Owner gets FULL_CONTROL. - No one else has access rights (default). - - - - - Owner gets FULL_CONTROL. - No one else has access rights (default). - - - - - Owner gets FULL_CONTROL and the anonymous principal is granted READ access. - If this policy is used on an object, it can be read from a browser with no authentication. - - - - - Owner gets FULL_CONTROL, the anonymous principal is granted READ and WRITE access. - This can be a useful policy to apply to a bucket, but is generally not recommended. - - - - - Owner gets FULL_CONTROL, and any principal authenticated as a registered Amazon - S3 user is granted READ access. - - - - - Owner gets FULL_CONTROL. Amazon EC2 gets READ access to GET an - Amazon Machine Image (AMI) bundle from Amazon S3. - - - - - Object Owner gets FULL_CONTROL, Bucket Owner gets READ - This ACL applies only to objects and is equivalent to private when used with PUT Bucket. - You use this ACL to let someone other than the bucket owner write content (get full control) - in the bucket but still grant the bucket owner read access to the objects. - - - - - Object Owner gets FULL_CONTROL, Bucket Owner gets FULL_CONTROL. - This ACL applies only to objects and is equivalent to private when used with PUT Bucket. - You use this ACL to let someone other than the bucket owner write content (get full control) - in the bucket but still grant the bucket owner full rights over the objects. - - - - - The LogDelivery group gets WRITE and READ_ACP permissions on the bucket. - - - - - Construct instance of S3CannedACL. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to an S3CannedACL - - - - - - - A list of all possible S3 Bucket region possibilities. For - more information, refer to - . - - - - - Specifies that the S3 Bucket should use US locality. - This is the default value. - - - - - Specifies that the S3 Bucket should use US-EAST-2 locality. - - - - - Specifies that the S3 Bucket should use EU locality which defaults to EU-WEST-1 - - - - - Specifies that the S3 Bucket should use the EU-NORTH-1 locality. - - - - - Specifies that the S3 Bucket should use the EU-WEST-1 locality. - - - - - Specifies that the S3 Bucket should use the EU-WEST-2 locality. - - - - - Specifies that the S3 Bucket should use the EU-WEST-3 locality. - - - - - Specifies that the S3 Bucket should use the EU-CENTRAL-1 locality. - - - - - Specifies that the S3 Bucket should use US-WEST-1 locality. - - - - - Specifies that the S3 Bucket should use US-WEST-2 locality. - - - - - Specifies that the S3 Bucket should use US-GOV-EAST-1 locality. - - - - - Specifies that the S3 Bucket should use US-GOV-WEST-1 locality. - - - - - Specifies that the S3 Bucket should use the AP-EAST-1 locality. - - - - - Specifies that the S3 Bucket should use the AP-SOUTHEAST-1 locality. - - - - - Specifies that the S3 Bucket should use the AP-SOUTHEAST-2 locality. - - - - - Specifies that the S3 Bucket should use the AP-NORTHEAST-1 locality. - - - - - Specifies that the S3 Bucket should use the AP-NORTHEAST-2 locality. - - - - - Specifies that the S3 Bucket should use the AP-NORTHEAST-3 locality. - - - - - Specifies that the S3 Bucket should use the AP-SOUTH-1 locality. - - - - - Specifies that the S3 Bucket should use the SA-EAST-1 locality. - - - - - Specifies that the S3 Bucket should use CN-NORTH-1 locality. - - - - - Specifies that the S3 Bucket should use CN-NORTHWEST-1 locality. - - - - - Specifies that the S3 Bucket should use CA-CENTRAL-1 locality. - - - - - Specifies that the S3 Bucket should use US-WEST-1 locality. - - - - - Specifies that the S3 Bucket should use CN-NORTH-1 locality. - - - - - Specifies that the S3 Bucket should use US-GOV-WEST-1 locality. - - - - - Construct instance of S3Region. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to the S3Region class - - - - - - - A list of all ACL permissions. For more information, refer to - . - - - - - When applied to a bucket, grants permission to list the bucket. - When applied to an object, this grants permission to read the - object data and/or metadata. - - - - - When applied to a bucket, grants permission to create, overwrite, - and delete any object in the bucket. This permission is not - supported for objects. - - - - - Grants permission to read the ACL for the applicable bucket or object. - The owner of a bucket or object always has this permission implicitly. - - - - - Gives permission to overwrite the ACP for the applicable bucket or object. - The owner of a bucket or object always has this permission implicitly. - Granting this permission is equivalent to granting FULL_CONTROL because - the grant recipient can make any changes to the ACP. - - - - - Provides READ, WRITE, READ_ACP, and WRITE_ACP permissions. - It does not convey additional rights and is provided only for convenience. - - - - - Gives permission to restore an object that is currently stored in Amazon Glacier - for archival storage. - - - - - Construct S3Permission. - - - - - - Construct instance of S3Permission. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - - Gets and sets the HeaderName property. - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to an S3Permission - - - - - - - An enumeration of all Metadata directives that - can be used for the CopyObject operation. - - - - - Specifies that the metadata is copied from the source object. - - - - - Specifies that the metadata is replaced with metadata provided in the request. - All original metadata is replaced by the metadata you specify. - - - - - An enumeration of all protocols that the pre-signed - URL can be created against. - - - - - https protocol will be used in the pre-signed URL. - - - - - http protocol will be used in the pre-signed URL. - - - - - An enumeration of supported HTTP verbs - - - - - The GET HTTP verb. - - - - - The HEAD HTTP verb. - - - - - The PUT HTTP verb. - - - - - The DELETE HTTP verb. - - - - - S3 Storage Class Definitions - - - - - The STANDARD storage class, which is the default - storage class for S3. - - Durability 99.999999999%; Availability 99.99% over a given year. - - - - - REDUCED_REDUNDANCY provides the same availability as standard, but at a lower durability. - - Durability 99.99%; Availability 99.99% over a given year. - - - - - The GLACIER storage is for object that are stored in Amazon Glacier. - This storage class is for objects that are for archival purpose and - get operations are rare. - - Durability 99.999999999% - - - - - The STANDARD_IA storage is for infrequently accessed objects. - This storage class is for objects that are long-lived and less frequently accessed, - like backups and older data. - - Durability 99.999999999%; Availability 99.9% over a given year. - - - - - The ONEZONE_IA storage is for infrequently accessed objects. It is similiar to STANDARD_IA, but - only stores object data within one Availablity Zone in a given region. - - Durability 99.999999999%; Availability 99% over a given year. - - - - - IntelligentTiering makes it easy to lower your overall cost of storage by automatically placing data in the storage - class that best matches the access patterns for the storage. With IntelligentTiering, you don’t need to define - and manage individual policies for lifecycle data management or write code to transition objects - between storage classes. Instead, you can use IntelligentTiering to manage transitions between Standard and - S-IA without writing any application code. IntelligentTiering also manages transitions automatically to - Glacier for long term archive in addition to S3 storage classes. - - - - - S3 Glacier Deep Archive provides secure, durable object storage class for long term data archival. - It is the ideal storage class to make an archival, durable copy of data that rarely, if ever, needs to be accessed. - It can be used as an offline backup for their most important data assets and to meet long-term retention needs. - - - - - Construct an instance of S3StorageClass. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to S3StorageClass. - - - - - - - The constants for the known event names used by S3 notification. S3 might add new - events before the SDK is updated. In which case the names listed in the S3 documentation - will work as well as these constants. - - - - - An event that says an object has been lost in the reduced redundancy storage. - - - - - A list of all server-side encryption methods for customer provided encryption keys. - - - - - No server side encryption to be used. - - - - - Use AES 256 server side encryption. - - - - - Constructs an instance of ServerSideEncryptionCustomerMethod. - - - - - - Finds the constant for the unique value. - - - - - - - Converts string to ServerSideEncryptionCustomerMethod. - - - - - - - A list of all server-side encryption methods. - - - - - No server side encryption to be used. - - - - - Use AES 256 server side encryption. - - - - - Use AWS Key Management Service for server side encryption. - - - - - Construct instance of ServerSideEncryptionMethod. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to ServerSideEncryptionCustomerMethod. - - - - - - - A list of all grantee types. - - - - - The predefined group. - - - - - The email address of an AWS account - - - - - The canonical user ID of an AWS account - - - - - Construct an instance of GranteeType. - - - - - - Finds the constant for the unique value. - - - - - - - Convert a string to GranteeType. - - - - - - - A list of all lifecycle statuses. - - - - - The rule is enabled. - - - - - The rule is disabled. - - - - - Constructs an instance LifecycleRuleStatus. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to LifecycleRuleStatus. - - - - - - - A list of all version statuses. - - - - - The rule is off. - - - - - The rule is suspended. - - - - - The rule is enabled. - - - - - Construct an instance of VersionStatus. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to VersionStatus. - - - - - - - A list of all encoding types. - - - - - Url encoding. - - - - - Constructs intance of EncodingType - - - - - - Finds the constant for the unique value. - - - - - - - Converts string to EncodingType - - - - - - - The bucket event for which to send notifications. - - - - - The event encapsulates all the object create events - - - - - Event for put operations - - - - - Event for post operations - - - - - Event for copy operations - - - - - Event for completing a multi part upload - - - - - This event encapsulates all the object removed events - - - - - Event for object removed, delete operation. - - - - - Event for object removed, delete marker created operation. - - - - - Event for objects stored in reduced redundancy and S3 detects the object is lost - - - - - Event for all object restore - - - - - Event for restore post operations. - - - - - Event for when object restore is completed. - - - - - Event for replication of all - - - - - Event for operation failed replication - - - - - Evemt for replication operation not tracked - - - - - Event for replication operation missed threshold - - - - - Event for operation replicated after threshold - - - - - Constructs instance of EventType. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to EventType. - - - - - - - Compares if the ConstantClass instances are equals. - - - - - - - Compares if the ConstantClass instances are equals. This is ovewritten to handle the - discrepancy with S3 events coming from Lambda that don't have the prefix "s3:". - - - - - - - A list of all Inventory Formats. - - - - - CSV inventory format - - - - - ORC inventory format - - - - - Parquet inventory format - - - - - Construct instance of InventoryFormat. - - - - - - Finds the constant for the unique value. - - The string representation of the InventoryFormat. - The InventoryFormat object for that string. - - - - Convert string to InventoryFormat. - - - - - - - A list of inventory included object versions. - - - - - All Inventory Included Object Versions - - - - - Current Inventory Included Object Versions - - - - - Construct instance of InventoryIncludedObjectVersions. - - - - - - Finds the constant for the unique value. - - The string representation of the InventoryIncludedObjectVersions. - The InventoryIncludedObjectVersions object for that string. - - - - Convert string to InventoryIncludedObjectVersions. - - - - - - - A list of inventory frequencies. - - - - - Daily Inventory Frequency - - - - - Weekly Inventory Frequency - - - - - Construct instance of InventoryFrequency. - - - - - - Finds the constant for the unique value. - - The string representation of the InventoryFrequency. - The InventoryFrequency object for that string. - - - - Convert string to InventoryFrequency. - - - - - - - A list of inventory optional fields. - - - - - InventoryOptionalField for Size - - - - - InventoryOptionalField for LastModifiedDate - - - - - InventoryOptionalField for StorageClass - - - - - InventoryOptionalField for ETag - - - - - InventoryOptionalField for IsMultipartUploaded - - - - - InventoryOptionalField for ReplicationStatus - - - - - InventoryOptionalField for EncryptionStatus - - - - - InventoryOptionalField for ObjectLockRetainUntilDate - - - - - InventoryOptionalField for ObjectLockMode - - - - - InventoryOptionalField for ObjectLockLegalHoldStatus - - - - - InventoryOptionalField for IntelligentTieringAccessTier - - - - - Construct instance of InventoryOptionalField. - - - - - - Finds the constant for the unique value. - - The string representation of the InventoryOptionalField. - The InventoryIncludedObjectVersions object for that string. - - - - Convert string to InventoryOptionalField. - - - - - - - The status of the replication job associated with this source object. - - - - - The object is pending replication. - - - - - The object has been replicated. - - - - - The object was created as a result of replication. - - - - - The object replication has failed due to a customer-attributable reason, and the replication will not be attempted again. - - - - - Construct instance of ReplicationStatus. - - - - - - Finds the constant for the unique value. - - The string representation of the ReplicationStatus. - The ReplicationStatus object for that string. - - - - Convert string to ReplicationStatus. - - - - - - - Whether a replication rule is applied or ignored. - - - - - The rule will be applied. - - - - - The rule will be ignored. - - - - - Construct instance of ReplicationRuleStatus - - - - - - Finds the constant for the unique value. - - The string representation of the ReplicationRuleStatus. - The ReplicationRuleStatus object for that string. - - - - Convert string to ReplicationRuleStatus. - - - - - - - Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request. - - - - - The object tag-set is copied from the source object. - - - - - The object tag-set is replaced with tag-set provided in the request. - - - - - Construct instance of TaggingDirective - - - - - Finds the constant for the unique value. - - The string representation of the TaggingDirective. - The TaggingDirective object for that string. - - - - Convert string to TaggingDirective. - - - - - All enumerations type for retrieval tier for Glacier restore. - - - - - Standard Tier for Glacier restore. - - - - - Bulk Tier for Glacier restore. - - - - - Expedited Tier for Glacier restore. - - - - - Construct instance of RestoreObjectRequestGlacierJobTier - - - - - - Finds the constant for the unique value. - - The string representation of the RestoreObjectRequestGlacierJobTier. - The RestoreObjectRequestGlacierJobTier object for that string. - - - - Convert string to RestoreObjectRequestGlacierJobTier. - - - - - - - The version of the output schema to use when exporting data. - - - - - The schema output version V_1. - - - - - Construct instance of StorageClassAnalysisSchemaVersion - - - - - - Finds the constant for the unique value. - - The string representation of the StorageClassAnalysisSchemaVersion. - The StorageClassAnalysisSchemaVersion object for that string. - - - - Convert string to StorageClassAnalysisSchemaVersion. - - - - - - - Acknowledges that requester pays for the operation. - - - - - Requester pays for the operation. - - - - - Finds the RequestPayer instance for the string value. - - - - - Converts string to RequestPayer instance - - - - - The response from S3 that it confirms that requester pays. - - - - - S3 acknowledges that the requester pays. - - - - - Finds the RequestCharged instance for the string value - - - - - converts the string to RequestCharged instance - - - - - The override value for the owner of the replica object. - - - - - Overrides destination bucket's owner. - - - - - Finds the OwnerOverride instance for the string value - - - - - converts the string to OwnerOverride instance - - - - - The replication for KMS encrypted S3 objects is disabled if status is not Enabled. - - - - - The replication for KMS encrypted S3 objects is enabled. - - - - - The replication for KMS encrypted S3 objects is disabled. - - - - - - - - - - Finds the SseKmsEncryptedObjectsStatus instance for the string value - - - - - Converts the string to SseKmsEncryptedObjectsStatus instance - - - - - Specify how headers will be handled. - - - - - Headers will be usable in SELECT clause. - - - - - Headers will be skipped - - - - - No header is present. - - - - - Finds the FileHeaderInfo instance for the string value - - - - - - - Converts the string to FileHeaderInfo instance - - - - - Specifies whether existing object replication is enabled. - - - - - Enable the replication of existing objects - - - - - Disable the replication of existing objects - - - - - Finds the ExistingObjectReplicationStatus instance for the string value - - - - - - - Converts the string to ExistingObjectReplicationStatus instance - - - - - Describes when fields in output should be surrounded with quotes. - - - - - Specifies that fields in output should always be surrounded in quotes. - - - - - Specifies that fields in output should be surrounded in quotes as necessary. - - - - - Finds the QuoteFields instance for the string value - - string value that maps to QuoteFields enum - QuoteFields enum - - - - Converts the string to QuoteFields instance - - - - - Type of the expression provided in the Expression member. - - - - - SQL expression - - - - - Finds the ExpressionType instance for the string value - - string value that maps to ExpressionType enum - ExpressionType enum - - - - Converts the string to ExpressionType instance - - - - - Indicates what type of job is being initiated. - - - - - Finds the RestoreRequestType instance for the string value - - - - - Converts the string to RestoreRequestType instance - - - - - The type of JSON. - - - - - Finds the JsonType instance for the string value - - - - - Converts the string to JsonType instance - - - - - Specifies object's compression format. - - - - - Finds the CompressionType instance for the string value - - - - - Converts the string to CompressionType instance - - - - - The type of ObjectLockEnabled - - - - - Finds the ObjectLockEnabled instance for the string value - - - - - Converts the string to ObjectLockEnabled instance - - - - - The type of ObjectLockLegalHoldStatus - - - - - Finds the ObjectLockLegalHoldStatus instance for the string value - - - - - Converts the string to ObjectLockLegalHoldStatus instance - - - - - The type of ObjectLockRetentionMode - - - - - Finds the ObjectLockRetentionMode instance for the string value - - - - - Converts the string to ObjectLockRetentionMode instance - - - - - The type of ObjectLockMode - - - - - Finds the ObjectLockMode instance for the string value - - - - - Converts the string to ObjectLockMode instance - - - - - Specifies whether the replication time is enabled. - - - - - Replication time is enabled. - - - - - Replication time is disabled. - - - - - Finds the ReplicationTimeStatus instance for the string value - - - - - - - Converts the string to ReplicationTimeStatus instance - - - - - - Specifies whether the replication metrics are enabled. - - - - - Replication metrics are enabled. - - - - - Replication metrics are disabled. - - - - - Finds the MetricsStatus instance for the string value - - - - - - - Converts the string to MetricsStatus instance - - - - - - Uri wrapper that can parse out information (bucket, key, region, style) from an - S3 URI. - - - - - True if the URI contains the bucket in the path, false if it contains the bucket in the authority. - - - - - The bucket name parsed from the URI (or null if no bucket specified). - - - - - The key parsed from the URI (or null if no key specified). - - - - - The region parsed from the URI (or null if no region specified). - - - - - Constructs a parser for the S3 URI specified as a string. - - The S3 URI to be parsed. - - - - Constructs a parser for the S3 URI specified as a Uri instance. - - The S3 URI to be parsed. - - - - If the given string is an AmazonS3Endpoint return true and set the AmazonS3Uri out parameter. - - - - true if the string is an AmazonS3Endpoint, and the out paramter has been filled in, false otherwise - - - - If the given Uri is an AmazonS3Endpoint return true and set the AmazonS3Uri out parameter. - - - - true if the Uri is an AmazonS3Endpoint, and the out paramter has been filled in, false otherwise - - - - Checks whether the given URI is a Amazon S3 URI. - - The S3 URI to be checked. - true if the URI is a Amazon S3 URI, false; otherwise. - - - - Checks whether the given URI is a Amazon S3 URI. - - The S3 URI to be checked. - true if the URI is a Amazon S3 URI, false; otherwise. - - - - Percent-decodes the given string, with a fast path for strings that are not - percent-encoded. - - The string to decode - The decoded string - - - - Percent-decodes the given string. - - The string to decode - The index of the first '%' in the string - The decoded string - - - - Decodes the percent-encoded character at the given index in the string - and appends the decoded value to the string under construction. - - - The string under construction to which the decoded character will be - appended. - - The string being decoded. - The index of the '%' character in the string. - - - - Converts a hex character (0-9A-Fa-f) into its corresponding quad value. - - The hex character - The quad value - - - - Provides utilities used by the Amazon S3 client implementation. - These utilities might be useful to consumers of the Amazon S3 - library. - - - Provides utilities used by the Amazon S3 client implementation. - These utilities might be useful to consumers of the Amazon S3 - library. - - - - - Determines MIME type from a file extension - - The extension of the file - The MIME type for the extension, or text/plain - - - - URL encodes a string. If the path property is specified, - the accepted path characters {/+:} are not encoded. - - The string to encode - Whether the string is a URL path or not - - - - - Converts a non-seekable stream into a System.IO.MemoryStream. - A MemoryStream's position can be moved arbitrarily - - The stream to be converted - A seekable MemoryStream - MemoryStreams use byte arrays as their backing store. - Please use this judicially as it is likely that a very large - stream will cause system resources to be used up. - - - - - Formats the current date as a GMT timestamp - - A GMT formatted string representation - of the current date and time - - - - - Generates an MD5 Digest for the string-based content - - The content for which the MD5 Digest needs - to be computed. - - Whether the returned checksum should be - base64 encoded. - - A string representation of the hash with or w/o base64 encoding - - - - - Only escape non-ascii characters in a string - - - - - - - Version2 S3 buckets adhere to RFC 1035: - - Less than 255 characters, with each label less than 63 characters. - Label must start with a letter - Label must end with a letter or digit - Label can have a string of letter, digits and hyphens in the middle. - Although names can be case-sensitive, no significance is attached to the case. - RFC 1123: Allow label to start with letter or digit (e.g. 3ware.com works) - RFC 2181: No restrictions apart from the length restrictions. - - S3 V2 will start with RFCs 1035 and 1123 and impose the following additional restrictions: - - Length between 3 and 63 characters (to allow headroom for upper-level domains, - as well as to avoid separate length restrictions for bucket-name and its labels - Only lower-case to avoid user confusion. - No dotted-decimal IPv4-like strings - - - The BucketName to validate if V2 addressing should be used - True if the BucketName should use V2 bucket addressing, false otherwise - - S3 v2 Bucket restrictions - - - - Determines whether an S3 bucket exists or not. - - The name of the bucket to check. - The Amazon S3 Client to use for S3 specific operations. - False is returned in case S3 responds with a NoSuchBucket error. - True is returned in case of success, AccessDenied error or PermanentRedirect error. - An exception is thrown in case of any other error. - This method calls GetACL for the bucket. - - - - Determines whether an S3 bucket exists or not. - This is done by: - 1. Creating a PreSigned Url for the bucket. To work with Signature V4 only regions, as - well as Signature V4-optional regions, we keep the expiry to within the maximum for V4 - (which is one week). - 2. Making a HEAD request to the Url - - The name of the bucket to check. - The Amazon S3 Client to use for S3 specific operations. - - - - - Deletes an S3 bucket which contains objects. - An S3 bucket which contains objects cannot be deleted until all the objects - in it are deleted. This method deletes all the objects in the specified - bucket and then deletes the bucket itself. - - The bucket to be deleted. - The Amazon S3 Client to use for S3 specific operations. - - - - Deletes an S3 bucket which contains objects. - An S3 bucket which contains objects cannot be deleted until all the objects - in it are deleted. This method deletes all the objects in the specified - bucket and then deletes the bucket itself. - - The bucket to be deleted. - The Amazon S3 Client to use for S3 specific operations. - Options to control the behavior of the delete operation. - - - - Initiates the asynchronous execution of the DeleteS3BucketWithObjects operation. - DeleteS3BucketWithObjects deletes an S3 bucket which contains objects. - An S3 bucket which contains objects cannot be deleted until all the objects - in it are deleted. This method deletes all the objects in the specified - bucket and then deletes the bucket itself. - - The bucket to be deleted. - The Amazon S3 Client to use for S3 specific operations. - token to check if the operation has been request to cancel. - An IAsyncCancelableResult that can be used to poll or wait for results, or both; - this value is also needed when invoking EndDeleteS3BucketWithObjects. IAsyncCancelableResult can also - be used to cancel the operation while it's in progress. - - - - Initiates the asynchronous execution of the DeleteS3BucketWithObjects operation. - DeleteS3BucketWithObjects deletes an S3 bucket which contains objects. - An S3 bucket which contains objects cannot be deleted until all the objects - in it are deleted. This method deletes all the objects in the specified - bucket and then deletes the bucket itself. - - The bucket to be deleted. - The Amazon S3 Client to use for S3 specific operations. - Options to control the behavior of the delete operation. - token to check if the operation has been request to cancel. - An IAsyncCancelableResult that can be used to poll or wait for results, or both; - this value is also needed when invoking EndDeleteS3BucketWithObjects. IAsyncCancelableResult can also - be used to cancel the operation while it's in progress. - - - - Initiates the asynchronous execution of the DeleteS3BucketWithObjects operation. - DeleteS3BucketWithObjects deletes an S3 bucket which contains objects. - An S3 bucket which contains objects cannot be deleted until all the objects - in it are deleted. This method deletes all the objects in the specified - bucket and then deletes the bucket itself. - - The bucket to be deleted. - The Amazon S3 Client to use for S3 specific operations. - >Options to control the behavior of the delete operation. - An callback that is invoked to send updates while delete operation is in progress. - token to check if the operation has been request to cancel. - An IAsyncCancelableResult that can be used to poll or wait for results, or both; - this value is also needed when invoking EndDeleteS3BucketWithObjects. IAsyncCancelableResult can also - be used to cancel the operation while it's in progress. - - - - Invokes the DeleteS3BucketWithObjectsInternal method. - - The Request object that has all the data to complete the operation. - token to request the operation to be cancelled. - - - - Deletes an S3 bucket which contains objects. - An S3 bucket which contains objects cannot be deleted until all the objects - in it are deleted. The function deletes all the objects in the specified - bucket and then deletes the bucket itself. - - The bucket to be deleted. - The Amazon S3 Client to use for S3 specific operations. - Options to control the behavior of the delete operation. - The callback which is used to send updates about the delete operation. - token to check if the operation has been request to cancel. - - - - Invokes the callback which provides updated about the delete operation. - - The callback to be invoked. - The data being passed to the callback. - 8 - - - - Class to manage and cache the correct region for buckets accessed without an explicit region. - - - Class to manage and cache the correct region for buckets accessed without an explicit region. - - - - - A cache of BucketName -> RegionEndpoint pairs. - The cache is used to make sure that bucket requests are signed for the correct region, - even when requesting them without an explicit region. - - - - - Detect a bucket region mismatch based on the x-amz-bucket-region header, and the status code provided. - - - - - - - - - Detects if the signature is malformed, and the requested bucket is in a Region - different from the Region of the request. - - - - the correct region if a mismatch was detected, null otherwise - - - - Detects if the signature is malformed, and the requested bucket is in a Region - different from the Region of the request. - - - - - the correct region if a mismatch was detected, null otherwise - - - - Use a HEAD bucket request to get the region for the given bucket. - - This method creates an AmazonS3Client from the credentials passed in. - It's critical that the AmazonS3Client is not used to make any requests that will - be routed through the pipeline. - - - - the value of the x-amz-bucket-region header from the response - - - - A helper class that represents a strongly typed S3 EventNotification item sent to SQS - - - - - Parse the JSON string into a S3EventNotification object. - - The function will try its best to parse input JSON string as best as it can. - It will not fail even if the JSON string contains unknown properties. - - For any parsing errors - - - - - Gets and sets the records for the S3 event notification - - - - - The class holds the user identity properties. - - - - - Gets and sets the PrincipalId property. - - - - - This class contains the identity information for an S3 bucket. - - - - - Gets and sets the name of the bucket. - - - - - Gets and sets the bucket owner id. - - - - - Gets and sets the S3 bucket arn. - - - - - This class contains the information for an object in S3. - - - - - Gets and sets the key for the object stored in S3. - - - - - Gets and sets the size of the object in S3. - - - - - Gets and sets the etag of the object. This can be used to determine if the object has changed. - - - - - Gets and sets the version id of the object in S3. - - - - - Gets and sets the sequencer a string representation of a hexadecimal value used to determine event sequence, only used with PUTs and DELETEs. - - - - - Gets and sets the meta information describing S3. - - - - - Gets and sets the ConfigurationId. This ID can be found in the bucket notification configuration. - - - - - Gets and sets the Bucket property. - - - - - Gets and sets the Object property. - - - - - Gets and sets the S3SchemaVersion property. - - - - - The class holds the request parameters - - - - - Gets and sets the SourceIPAddress. This is the ip address where the request came from. - - - - - This class holds the response elements. - - - - - Gets and sets the XAmzId2 Property. This is the Amazon S3 host that processed the request. - - - - - Gets and sets the XAmzRequestId. This is the Amazon S3 generated request ID. - - - - - The class holds the glacier event data elements. - - - - - Gets and sets the RestoreEventData property. - - - - - The class holds the restore event data elements. - - - - - Gets and sets the LifecycleRestorationExpiryTime the time when the object restoration will be expired. - - - - - Gets and sets the LifecycleRestoreStorageClass the source storage class for restore. - - - - - The class holds the event notification. - - - - - Gets and sets the AwsRegion property. - - - - - Gets and sets the EventName property. This identities what type of event occurred. - For example for an object just put in S3 this will be set to EventType.ObjectCreatedPut. - - - - - Gets and sets the EventSource property. - - - - - Gets and sets the EventType property. The time when S3 finished processing the request. - - - - - Gets and sets the EventVersion property. - - - - - Gets and sets the RequestParameters property. - - - - - Gets and sets the ResponseElements property. - - - - - Gets and sets the S3 property. - - - - - Gets and sets the UserIdentity property. - - - - - Get and sets the GlacierEventData property. - - - - - Options which control the behaviour of the DeleteS3BucketWithObjects operation. - - - - - Gets or sets a value which indicates whether the - operation should be aborted if an error is encountered during execution. - - - - - Gets or sets a value which indicated whether verbose results shoule be returned to the - callback. - If quiet mode is true the callback will receive only keys where the delete operation encountered an error. - If quiet mode is false the callback will receive keys for both successful and unsuccessful delete operations. - - - - - Internal class used to pass the parameters for DeleteS3BucketWithObjects operation. - - - - - Name of the bucket to be deleted. - - - - - The Amazon S3 Client to use for S3 specific operations. - - - - - Options to control the behavior of the delete operation. - - - - - The callback which is used to send updates about the delete operation. - - - - - Contains updates from DeleteS3BucketWithObjects operation. - - - - - The list of objects which were successfully deleted. - - - - - The list of objects for which the delete operation failed. - - - - - Interface for accessing S3 - - - - - - - Create a signed URL allowing access to a resource that would - usually require authentication. - - - - When using query string authentication you create a query, - specify an expiration time for the query, sign it with your - signature, place the data in an HTTP request, and distribute - the request to a user or embed the request in a web page. - - - A PreSigned URL can be generated for GET, PUT, DELETE and HEAD - operations on your bucketName, keys, and versions. - - - The GetPreSignedUrlRequest that defines the - parameters of the operation. - A string that is the signed http request. - - - - - - This operation aborts a multipart upload. After a multipart upload is aborted, no - additional parts can be uploaded using that upload ID. The storage consumed by any - previously uploaded parts will be freed. However, if any part uploads are currently - in progress, those part uploads might or might not succeed. As a result, it might - be necessary to abort a given multipart upload multiple times in order to completely - free all storage consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts operation and ensure that the parts - list is empty. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - The bucket name to which the upload was taking place. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object for which the multipart upload was initiated. - Upload ID that identifies the multipart upload. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AbortMultipartUpload service method, as returned by S3. - REST API Reference for AbortMultipartUpload Operation - - - - This operation aborts a multipart upload. After a multipart upload is aborted, no - additional parts can be uploaded using that upload ID. The storage consumed by any - previously uploaded parts will be freed. However, if any part uploads are currently - in progress, those part uploads might or might not succeed. As a result, it might - be necessary to abort a given multipart upload multiple times in order to completely - free all storage consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts operation and ensure that the parts - list is empty. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - Container for the necessary parameters to execute the AbortMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AbortMultipartUpload service method, as returned by S3. - REST API Reference for AbortMultipartUpload Operation - - - - Completes a multipart upload by assembling previously uploaded parts. - - - - You first initiate the multipart upload and then upload all parts using the UploadPart - operation. After successfully uploading all relevant parts of an upload, you call - this operation to complete the upload. Upon receiving this request, Amazon S3 concatenates - all the parts in ascending order by part number to create a new object. In the Complete - Multipart Upload request, you must provide the parts list. You must ensure that the - parts list is complete. This operation concatenates the parts that you provide in - the list. For each part in the list, you must provide the part number and the ETag - value, returned after that part was uploaded. - - - - Processing of a Complete Multipart Upload request could take several minutes to complete. - After Amazon S3 begins processing the request, it sends an HTTP response header that - specifies a 200 OK response. While processing is in progress, Amazon S3 periodically - sends white space characters to keep the connection from timing out. Because a request - could fail after the initial 200 OK response has been sent, it is important that you - check the response body to determine whether the request succeeded. - - - - Note that if CompleteMultipartUpload fails, applications should be prepared - to retry the failed requests. For more information, see Amazon - S3 Error Best Practices. - - - - For more information about multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - GetBucketLifecycle has the following special errors: - -
  • - - Error code: EntityTooSmall - -
    • - - Description: Your proposed upload is smaller than the minimum allowed object size. - Each part must be at least 5 MB in size, except the last part. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPart - -
    • - - Description: One or more of the specified parts could not be found. The part might - not have been uploaded, or the specified entity tag might not have matched the part's - entity tag. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPartOrder - -
    • - - Description: The list of parts was not in ascending order. The parts list must be - specified in order by part number. - -
    • - - 400 Bad Request - -
  • - - Error code: NoSuchUpload - -
    • - - Description: The specified multipart upload does not exist. The upload ID might be - invalid, or the multipart upload might have been aborted or completed. - -
    • - - 404 Not Found - -
- - The following operations are related to CompleteMultipartUpload: - - - - Container for the necessary parameters to execute the CompleteMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CompleteMultipartUpload service method, as returned by S3. - REST API Reference for CompleteMultipartUpload Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 Developer Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Encryption - - - - The source object that you are copying can be encrypted or unencrypted. The source - object can be encrypted with server-side encryption using AWS managed encryption keys - (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side - encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers - and decrypts the data when you access it. - - - - You can optionally use the appropriate encryption-related headers to request server-side - encryption for the target object. You have the option to provide your own encryption - key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that - was used to encrypt the source object. You can even request encryption if the source - object was not encrypted. For more information about server-side encryption, see Using - Server-Side Encryption. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject operation to change the storage class of an - object that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 Service Developer Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 Developer Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Encryption - - - - The source object that you are copying can be encrypted or unencrypted. The source - object can be encrypted with server-side encryption using AWS managed encryption keys - (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side - encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers - and decrypts the data when you access it. - - - - You can optionally use the appropriate encryption-related headers to request server-side - encryption for the target object. You have the option to provide your own encryption - key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that - was used to encrypt the source object. You can even request encryption if the source - object was not encrypted. For more information about server-side encryption, see Using - Server-Side Encryption. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject operation to change the storage class of an - object that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 Service Developer Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 Developer Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Encryption - - - - The source object that you are copying can be encrypted or unencrypted. The source - object can be encrypted with server-side encryption using AWS managed encryption keys - (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side - encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers - and decrypts the data when you access it. - - - - You can optionally use the appropriate encryption-related headers to request server-side - encryption for the target object. You have the option to provide your own encryption - key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that - was used to encrypt the source object. You can even request encryption if the source - object was not encrypted. For more information about server-side encryption, see Using - Server-Side Encryption. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject operation to change the storage class of an - object that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 Service Developer Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - Container for the necessary parameters to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - - - - - - Deletes an analytics configuration for the bucket (specified by the analytics configuration - ID). - - - - To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to DeleteBucketAnalyticsConfiguration: - -
  • - - - -
  • - - - -
  • - - - -
- - Container for the necessary parameters to execute the DeleteBucketAnalyticsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketAnalyticsConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketAnalyticsConfiguration Operation - - - - - Deletes an inventory configuration (identified by the inventory ID) from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - Operations related to DeleteBucketInventoryConfiguration include: - - - - Container for the necessary parameters to execute the DeleteBucketInventoryConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketInventoryConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketInventoryConfiguration Operation - - - - Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified - by the metrics configuration ID) from the bucket. Note that this doesn't include the - daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketMetricsConfiguration Operation - - - - This implementation of the DELETE operation uses the policy subresource to delete - the policy of a specified bucket. If you are using an identity other than the root - user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - The bucket name. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketPolicy service method, as returned by S3. - REST API Reference for DeleteBucketPolicy Operation - - - - This implementation of the DELETE operation uses the policy subresource to delete - the policy of a specified bucket. If you are using an identity other than the root - user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - Container for the necessary parameters to execute the DeleteBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketPolicy service method, as returned by S3. - REST API Reference for DeleteBucketPolicy Operation - - - - Deletes the replication configuration from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutReplicationConfiguration - action. The bucket owner has these permissions by default and can grant it to others. - For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - It can take a while for the deletion of a replication configuration to fully propagate. - - - - For information about replication configuration, see Replication - in the Amazon S3 Developer Guide. - - - - The following operations are related to DeleteBucketReplication: - - - - Container for the necessary parameters to execute the DeleteBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketReplication service method, as returned by S3. - REST API Reference for DeleteBucketReplication Operation - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - The bucket that has the tag set to be removed. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketTagging service method, as returned by S3. - REST API Reference for DeleteBucketTagging Operation - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - Container for the necessary parameters to execute the DeleteBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketTagging service method, as returned by S3. - REST API Reference for DeleteBucketTagging Operation - - - - This operation removes the website configuration for a bucket. Amazon S3 returns a - 200 OK response upon successfully deleting a website configuration on - the specified bucket. You will get a 200 OK response if the website configuration - you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE operation requires the S3:DeleteBucketWebsite permission. - By default, only the bucket owner can delete the website configuration attached to - a bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which you want to remove the website configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketWebsite service method, as returned by S3. - REST API Reference for DeleteBucketWebsite Operation - - - - This operation removes the website configuration for a bucket. Amazon S3 returns a - 200 OK response upon successfully deleting a website configuration on - the specified bucket. You will get a 200 OK response if the website configuration - you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE operation requires the S3:DeleteBucketWebsite permission. - By default, only the bucket owner can delete the website configuration attached to - a bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the DeleteBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketWebsite service method, as returned by S3. - REST API Reference for DeleteBucketWebsite Operation - - - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - The bucket name of the lifecycle to delete. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - REST API Reference for DeleteLifecycleConfiguration Operation - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - Container for the necessary parameters to execute the DeleteLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - REST API Reference for DeleteLifecycleConfiguration Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key name of the object to delete. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key name of the object to delete. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - Container for the necessary parameters to execute the DeleteObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - This operation enables you to delete multiple objects from a bucket using a single - HTTP request. If you know the object keys that you want to delete, then this operation - provides a suitable alternative to sending individual delete requests, reducing per-request - overhead. - - - - The request contains a list of up to 1000 keys that you want to delete. In the XML, - you provide the object key names, and optionally, version IDs if you want to delete - a specific version of the object from a versioning-enabled bucket. For each key, Amazon - S3 performs a delete operation and returns the result of that delete, success, or - failure, in the response. Note that if the object specified in the request is not - found, Amazon S3 returns the result as deleted. - - - - The operation supports two modes for the response: verbose and quiet. By default, - the operation uses verbose mode in which the response includes the result of deletion - of each key in your request. In quiet mode the response includes only keys where the - delete operation encountered an error. For a successful deletion, the operation does - not return any information about the delete in the response body. - - - - When performing this operation on an MFA Delete enabled bucket, that attempts to delete - any versioned objects, you must include an MFA token. If you do not provide one, the - entire request will fail, even if there are non-versioned objects you are trying to - delete. If you provide an invalid token, whether there are versioned keys in the request - or not, the entire Multi-Object Delete request will fail. For information about MFA - Delete, see - MFA Delete. - - - - Finally, the Content-MD5 header is required for all Multi-Object Delete requests. - Amazon S3 uses the header value to ensure that your request body has not been altered - in transit. - - - - The following operations are related to DeleteObjects: - - - - Container for the necessary parameters to execute the DeleteObjects service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObjects service method, as returned by S3. - REST API Reference for DeleteObjects Operation - - - - Removes the entire tag set from the specified object. For more information about managing - object tags, see - Object Tagging. - - - - To use this operation, you must have permission to perform the s3:DeleteObjectTagging - action. - - - - To delete tags of a specific object version, add the versionId query - parameter in the request. You will need permission for the s3:DeleteObjectVersionTagging - action. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteObjectTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObjectTagging service method, as returned by S3. - REST API Reference for DeleteObjectTagging Operation - - - - Removes the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:PutBucketPublicAccessBlock - permission. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to DeletePublicAccessBlock: - - - - Container for the necessary parameters to execute the DeletePublicAccessBlock service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeletePublicAccessBlock service method, as returned by S3. - REST API Reference for DeletePublicAccessBlock Operation - - - - - - - - - Returns the default encryption configuration for an Amazon S3 bucket. For information - about the Amazon S3 default encryption feature, see Amazon - S3 Default Bucket Encryption. - - - - To use this operation, you must have permission to perform the s3:GetEncryptionConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to GetBucketEncryption: - - - - Container for the necessary parameters to execute the GetBucketEncryption service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketEncryption service method, as returned by S3. - REST API Reference for GetBucketEncryption Operation - - - - Returns an inventory configuration (identified by the inventory configuration ID) - from the bucket. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - The following operations are related to GetBucketInventoryConfiguration: - - - - Container for the necessary parameters to execute the GetBucketInventoryConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketInventoryConfiguration service method, as returned by S3. - REST API Reference for GetBucketInventoryConfiguration Operation - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - The name of the bucket for which to get the location. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLocation service method, as returned by S3. - REST API Reference for GetBucketLocation Operation - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - Container for the necessary parameters to execute the GetBucketLocation service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLocation service method, as returned by S3. - REST API Reference for GetBucketLocation Operation - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - The bucket name for which to get the logging information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLogging service method, as returned by S3. - REST API Reference for GetBucketLogging Operation - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - Container for the necessary parameters to execute the GetBucketLogging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLogging service method, as returned by S3. - REST API Reference for GetBucketLogging Operation - - - - Gets a metrics configuration (specified by the metrics configuration ID) from the - bucket. Note that this doesn't include the daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to GetBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the GetBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for GetBucketMetricsConfiguration Operation - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following operation is related to GetBucketNotification: - - - - Name of the bucket for which to get the notification configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketNotification service method, as returned by S3. - REST API Reference for GetBucketNotification Operation - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following operation is related to GetBucketNotification: - - - - Container for the necessary parameters to execute the GetBucketNotification service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketNotification service method, as returned by S3. - REST API Reference for GetBucketNotification Operation - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operation is related to GetBucketPolicy: - - - - The bucket name for which to get the bucket policy. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicy service method, as returned by S3. - REST API Reference for GetBucketPolicy Operation - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operation is related to GetBucketPolicy: - - - - Container for the necessary parameters to execute the GetBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicy service method, as returned by S3. - REST API Reference for GetBucketPolicy Operation - - - - Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket - is public. In order to use this operation, you must have the s3:GetBucketPolicyStatus - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - For more information about when Amazon S3 considers a bucket public, see The - Meaning of "Public". - - - - The following operations are related to GetBucketPolicyStatus: - - - - Container for the necessary parameters to execute the GetBucketPolicyStatus service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicyStatus service method, as returned by S3. - REST API Reference for GetBucketPolicyStatus Operation - - - - Retrieves the replication configuration for the given Amazon S3 bucket. - - Container for the necessary parameters to execute the GetBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketReplication service method, as returned by S3. - REST API Reference for GetBucketReplication Operation - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - The name of the bucket for which to get the payment request configuration - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketRequestPayment service method, as returned by S3. - REST API Reference for GetBucketRequestPayment Operation - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - Container for the necessary parameters to execute the GetBucketRequestPayment service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketRequestPayment service method, as returned by S3. - REST API Reference for GetBucketRequestPayment Operation - - - - Returns the tag set associated with the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - GetBucketTagging has the following special error: - -
  • - - Error code: NoSuchTagSetError - -
    • - - Description: There is no tag set associated with the bucket. - -
- - The following operations are related to GetBucketTagging: - - - - Container for the necessary parameters to execute the GetBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketTagging service method, as returned by S3. - REST API Reference for GetBucketTagging Operation - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - The name of the bucket for which to get the versioning information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketVersioning service method, as returned by S3. - REST API Reference for GetBucketVersioning Operation - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - Container for the necessary parameters to execute the GetBucketVersioning service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketVersioning service method, as returned by S3. - REST API Reference for GetBucketVersioning Operation - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET operation requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which to get the website configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketWebsite service method, as returned by S3. - REST API Reference for GetBucketWebsite Operation - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET operation requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the GetBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketWebsite service method, as returned by S3. - REST API Reference for GetBucketWebsite Operation - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - The bucket name for which to get the cors configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetCORSConfiguration service method, as returned by S3. - REST API Reference for GetCORSConfiguration Operation - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - Container for the necessary parameters to execute the GetCORSConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetCORSConfiguration service method, as returned by S3. - REST API Reference for GetCORSConfiguration Operation - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are still using previous version of the lifecycle configuration, it works. - For the earlier API description, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to GetBucketLifecycleConfiguration: - - - - The name of the bucket for which to get the lifecycle information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetLifecycleConfiguration service method, as returned by S3. - REST API Reference for GetLifecycleConfiguration Operation - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are still using previous version of the lifecycle configuration, it works. - For the earlier API description, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to GetBucketLifecycleConfiguration: - - - - Container for the necessary parameters to execute the GetLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetLifecycleConfiguration service method, as returned by S3. - REST API Reference for GetLifecycleConfiguration Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object to get. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object to get. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - Container for the necessary parameters to execute the GetObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Gets an object's current Legal Hold status. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLegalHold service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectLegalHold service method, as returned by S3. - REST API Reference for GetObjectLegalHold Operation - - - - Gets the Object Lock configuration for a bucket. The rule specified in the Object - Lock configuration will be applied by default to every new object placed in the specified - bucket. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLockConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectLockConfiguration service method, as returned by S3. - REST API Reference for GetObjectLockConfiguration Operation - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - The name of the bucket containing the object. - The object key. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - The name of the bucket containing the object. - The object key. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - Container for the necessary parameters to execute the GetObjectMetadata service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - Retrieves an object's retention settings. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectRetention service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectRetention service method, as returned by S3. - REST API Reference for GetObjectRetention Operation - - - - Returns the tag-set of an object. You send the GET request against the tagging subresource - associated with the object. - - - - To use this operation, you must have permission to perform the s3:GetObjectTagging - action. By default, the GET operation returns information about current version of - an object. For a versioned bucket, you can have multiple versions of an object in - your bucket. To retrieve tags of any other version, use the versionId query parameter. - You also need permission for the s3:GetObjectVersionTagging action. - - - - By default, the bucket owner has this permission and can grant this permission to - others. - - - - For information about the Amazon S3 object tagging feature, see Object - Tagging. - - - - The following operation is related to GetObjectTagging: - - - - Container for the necessary parameters to execute the GetObjectTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTagging service method, as returned by S3. - REST API Reference for GetObjectTagging Operation - - - - Return torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Amazon - S3 Torrent. - - - - You can get torrent only for objects that are less than 5 GB in size and that are - not encrypted using server-side encryption with customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - The following operation is related to GetObjectTorrent: - - - - The name of the bucket containing the object for which to get the torrent files. - The object key for which to get the information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTorrent service method, as returned by S3. - REST API Reference for GetObjectTorrent Operation - - - - Return torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Amazon - S3 Torrent. - - - - You can get torrent only for objects that are less than 5 GB in size and that are - not encrypted using server-side encryption with customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - The following operation is related to GetObjectTorrent: - - - - Container for the necessary parameters to execute the GetObjectTorrent service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTorrent service method, as returned by S3. - REST API Reference for GetObjectTorrent Operation - - - - Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:GetBucketPublicAccessBlock - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket - or an object, it checks the PublicAccessBlock configuration for both - the bucket (or the bucket that contains the object) and the bucket owner's account. - If the PublicAccessBlock settings are different between the bucket and - the account, Amazon S3 uses the most restrictive combination of the bucket-level and - account-level settings. - - - - For more information about when Amazon S3 considers a bucket or an object public, - see The - Meaning of "Public". - - - - The following operations are related to GetPublicAccessBlock: - - - - Container for the necessary parameters to execute the GetPublicAccessBlock service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetPublicAccessBlock service method, as returned by S3. - REST API Reference for GetPublicAccessBlock Operation - - - - This operation initiates a multipart upload and returns an upload ID. This upload - ID is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort operation - and Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload API and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart) and UploadPartCopy) requests must match the headers you - used in the request to initiate the upload by using CreateMultipartUpload. - - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, - kms:GenerateDataKey*, and kms:DescribeKey actions on the - key. These permissions are required because Amazon S3 must decrypt and read data from - the encrypted file parts before it completes the multipart upload. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - The following operations are related to CreateMultipartUpload: - - - - The name of the bucket to which to initiate the upload - Object key for which the multipart upload is to be initiated. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the InitiateMultipartUpload service method, as returned by S3. - REST API Reference for InitiateMultipartUpload Operation - - - - This operation initiates a multipart upload and returns an upload ID. This upload - ID is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort operation - and Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload API and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart) and UploadPartCopy) requests must match the headers you - used in the request to initiate the upload by using CreateMultipartUpload. - - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, - kms:GenerateDataKey*, and kms:DescribeKey actions on the - key. These permissions are required because Amazon S3 must decrypt and read data from - the encrypted file parts before it completes the multipart upload. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - The following operations are related to CreateMultipartUpload: - - - - Container for the necessary parameters to execute the InitiateMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the InitiateMultipartUpload service method, as returned by S3. - REST API Reference for InitiateMultipartUpload Operation - - - - Lists the analytics configurations for the bucket. You can have up to 1,000 analytics - configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. You should always check the IsTruncated element in the response. - If there are no more configurations to list, IsTruncated is set to false. - If there are more configurations to list, IsTruncated is set to true, - and there will be a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to ListBucketAnalyticsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketAnalyticsConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketAnalyticsConfigurations service method, as returned by S3. - REST API Reference for ListBucketAnalyticsConfigurations Operation - - - - Returns a list of inventory configurations for the bucket. You can have up to 1,000 - analytics configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory - - - - The following operations are related to ListBucketInventoryConfigurations: - - - - Container for the necessary parameters to execute the ListBucketInventoryConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketInventoryConfigurations service method, as returned by S3. - REST API Reference for ListBucketInventoryConfigurations Operation - - - - Lists the metrics configurations for the bucket. The metrics configurations are only - for the request metrics of the bucket and do not provide information on daily storage - metrics. You can have up to 1,000 configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For more information about metrics configurations and CloudWatch request metrics, - see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to ListBucketMetricsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketMetricsConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketMetricsConfigurations service method, as returned by S3. - REST API Reference for ListBucketMetricsConfigurations Operation - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBuckets service method, as returned by S3. - REST API Reference for ListBuckets Operation - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - Container for the necessary parameters to execute the ListBuckets service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBuckets service method, as returned by S3. - REST API Reference for ListBuckets Operation - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Container for the necessary parameters to execute the ListMultipartUploads service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. - Limits the response to keys that begin with the specified prefix. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - Container for the necessary parameters to execute the ListObjects service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Make sure to design - your application to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - To use this operation in an AWS Identity and Access Management (IAM) policy, you must - have permissions to perform the s3:ListBucket action. The bucket owner - has this permission by default and can grant this permission to others. For more information - about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - This section describes the latest revision of the API. We recommend that you use this - revised API for application development. For backward compatibility, Amazon S3 continues - to support the prior version of this API, ListObjects. - - - - To get a list of your buckets, see ListBuckets. - - - - The following operations are related to ListObjectsV2: - - - - Container for the necessary parameters to execute the ListObjectsV2 service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjectsV2 service method, as returned by S3. - REST API Reference for ListObjectsV2 Operation - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). This request returns a maximum of 1,000 - uploaded parts. The default number of parts returned is 1,000 parts. You can restrict - the number of parts returned by specifying the max-parts request parameter. - If your multipart upload consists of more than 1,000 parts, the response returns an - IsTruncated field with the value of true, and a NextPartNumberMarker - element. In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListParts: - - - - Name of the bucket to which the parts are being uploaded. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Object key for which the multipart upload was initiated. - Upload ID identifying the multipart upload whose parts are being listed. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListParts service method, as returned by S3. - REST API Reference for ListParts Operation - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). This request returns a maximum of 1,000 - uploaded parts. The default number of parts returned is 1,000 parts. You can restrict - the number of parts returned by specifying the max-parts request parameter. - If your multipart upload consists of more than 1,000 parts, the response returns an - IsTruncated field with the value of true, and a NextPartNumberMarker - element. In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListParts: - - - - Container for the necessary parameters to execute the ListParts service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListParts service method, as returned by S3. - REST API Reference for ListParts Operation - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - Container for the necessary parameters to execute the ListVersions service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - - Creates a new bucket. To create a bucket, you must register with Amazon S3 and have - a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed - to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information on bucket naming restrictions, - see Working - with Amazon S3 Buckets. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) - Region. For more information, see How - to Select a Region for Your Buckets. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - Hosting of Buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - The name of the bucket to create. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucket service method, as returned by S3. - REST API Reference for PutBucket Operation - - - - Creates a new bucket. To create a bucket, you must register with Amazon S3 and have - a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed - to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information on bucket naming restrictions, - see Working - with Amazon S3 Buckets. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) - Region. For more information, see How - to Select a Region for Your Buckets. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - Hosting of Buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - Container for the necessary parameters to execute the PutBucket service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucket service method, as returned by S3. - REST API Reference for PutBucket Operation - - - - Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration - is a bucket-level feature that enables you to perform faster data transfers to Amazon - S3. - - - - To use this operation, you must have permission to perform the s3:PutAccelerateConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The Transfer Acceleration state of a bucket can be set to one of the following two - values: - -
  • - - Enabled – Enables accelerated data transfers to the bucket. - -
  • - - Suspended – Disables accelerated data transfers to the bucket. - -
- - The GetBucketAccelerateConfiguration operation returns the transfer acceleration - state of a bucket. - - - - After setting the Transfer Acceleration state of a bucket to Enabled, it might take - up to thirty minutes before the data transfer rates to the bucket increase. - - - - The name of the bucket used for Transfer Acceleration must be DNS-compliant and must - not contain periods ("."). - - - - For more information about transfer acceleration, see Transfer - Acceleration. - - - - The following operations are related to PutBucketAccelerateConfiguration: - - - - Container for the necessary parameters to execute the PutBucketAccelerateConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketAccelerateConfiguration service method, as returned by S3. - REST API Reference for PutBucketAccelerateConfiguration Operation - - - - - - - Set the logging parameters for a bucket and to specify permissions for who can view - and modify the logging parameters. All logs are saved to buckets in the same AWS Region - as the source bucket. To set the logging status of a bucket, you must be the bucket - owner. - - - - The bucket owner is automatically granted FULL_CONTROL to all logs. You use the Grantee - request element to grant access to other people. The Permissions request - element specifies the kind of access the grantee has to the logs. - - - - Grantee Values - - - - You can specify the person (grantee) to whom you're assigning access rights (using - request elements) in the following ways: - -
  • - - By the person's ID: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> - </Grantee> - - - - DisplayName is optional and ignored in the request. - -
  • - - By Email address: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee> - - - - - The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl - request, appears as the CanonicalUser. - -
  • - - By URI: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee> - - -
- - To enable logging, you use LoggingEnabled and its children request elements. To disable - logging, you use an empty BucketLoggingStatus request element: - - - - <BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01" /> - - - - - For more information about server access logging, see Server - Access Logging. - - - - For more information about creating a bucket, see CreateBucket. For more information - about returning the logging status of a bucket, see GetBucketLogging. - - - - The following operations are related to PutBucketLogging: - - - - Container for the necessary parameters to execute the PutBucketLogging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketLogging service method, as returned by S3. - REST API Reference for PutBucketLogging Operation - - - - Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. - You can have up to 1,000 metrics configurations per bucket. If you're updating an - existing metrics configuration, note that this is a full replacement of the existing - metrics configuration. If you don't include the elements you want to keep, they are - erased. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to PutBucketMetricsConfiguration: - - - - GetBucketLifecycle has the following special error: - -
  • - - Error code: TooManyConfigurations - -
    • - - Description: You are attempting to create a new configuration but have already reached - the 1,000-configuration limit. - -
    • - - HTTP Status Code: HTTP 400 Bad Request - -
- - Container for the necessary parameters to execute the PutBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for PutBucketMetricsConfiguration Operation - - - - Enables notifications of specified events for a bucket. For more information about - event notifications, see Configuring - Event Notifications. - - - - Using this API, you can replace an existing notification configuration. The configuration - is an XML file that defines the event types that you want Amazon S3 to publish and - the destination where you want Amazon S3 to publish an event notification when it - detects an event of the specified type. - - - - By default, your bucket has no event notifications configured. That is, the notification - configuration will be an empty NotificationConfiguration. - - - - <NotificationConfiguration> - - - - </NotificationConfiguration> - - - - This operation replaces the existing notification configuration with the configuration - you include in the request body. - - - - After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification - Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, - and that the bucket owner has permission to publish to it by sending a test notification. - In the case of AWS Lambda destinations, Amazon S3 verifies that the Lambda function - permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. - For more information, see Configuring - Notifications for Amazon S3 Events. - - - - You can disable notifications by adding the empty NotificationConfiguration element. - - - - By default, only the bucket owner can configure notifications on a bucket. However, - bucket owners can use a bucket policy to grant permission to other users to set this - configuration with s3:PutBucketNotification permission. - - - - The PUT notification is an atomic operation. For example, suppose your notification - configuration includes SNS topic, SQS queue, and Lambda function configurations. When - you send a PUT request with this configuration, Amazon S3 sends test messages to your - SNS topic. If the message fails, the entire PUT operation will fail, and Amazon S3 - will not add the configuration to your bucket. - - - - Responses - - - - If the configuration in the request body includes only one TopicConfiguration - specifying only the s3:ReducedRedundancyLostObject event type, the response - will also include the x-amz-sns-test-message-id header containing the - message ID of the test notification sent to the topic. - - - - The following operation is related to PutBucketNotificationConfiguration: - - - - Container for the necessary parameters to execute the PutBucketNotification service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketNotification service method, as returned by S3. - REST API Reference for PutBucketNotification Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - The MD5 hash of the request body. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - Container for the necessary parameters to execute the PutBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Creates a replication configuration or replaces an existing one. For more information, - see Replication - in the Amazon S3 Developer Guide. - - - - To perform this operation, the user or role performing the operation must have the - iam:PassRole - permission. - - - - Specify the replication configuration in the request body. In the replication configuration, - you provide the name of the destination bucket where you want Amazon S3 to replicate - objects, the IAM role that Amazon S3 can assume to replicate objects on your behalf, - and other relevant information. - - - - A replication configuration must include at least one rule, and can contain a maximum - of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects - in the source bucket. To choose additional subsets of objects to replicate, add a - rule for each subset. All rules must specify the same destination bucket. - - - - To specify a subset of the objects in the source bucket to apply a replication rule - to, add the Filter element as a child of the Rule element. You can filter objects - based on an object key prefix, one or more object tags, or both. When you add the - Filter element in the configuration, you must also add the following elements: DeleteMarkerReplication, - Status, and Priority. - - - - For information about enabling versioning on a bucket, see Using - Versioning. - - - - By default, a resource owner, in this case the AWS account that created the bucket, - can perform this operation. The resource owner can also grant others permissions to - perform the operation. For more information about permissions, see Specifying - Permissions in a Policy and Managing - Access Permissions to Your Amazon S3 Resources. - - - - Handling Replication of Encrypted Objects - - - - By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side - encryption with CMKs stored in AWS KMS. To replicate AWS KMS-encrypted objects, add - the following: SourceSelectionCriteria, SseKmsEncryptedObjects, - Status, EncryptionConfiguration, and ReplicaKmsKeyID. - For information about replication configuration, see Replicating - Objects Created with SSE Using CMKs stored in AWS KMS. - - - - For information on PutBucketReplication errors, see ReplicationErrorCodeList - - - - - The following operations are related to PutBucketReplication: - - - - Container for the necessary parameters to execute the PutBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketReplication service method, as returned by S3. - REST API Reference for PutBucketReplication Operation - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - The bucket name. - Container for Payer. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketRequestPayment service method, as returned by S3. - REST API Reference for PutBucketRequestPayment Operation - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - Container for the necessary parameters to execute the PutBucketRequestPayment service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketRequestPayment service method, as returned by S3. - REST API Reference for PutBucketRequestPayment Operation - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging. - - - - Within a bucket, if you add a tag that has the same key as an existing tag, the new - value overwrites the old value. For more information, see Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional operation is currently in progress against - this resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - The bucket name. - A property of PutBucketTaggingRequest used to execute the PutBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketTagging service method, as returned by S3. - REST API Reference for PutBucketTagging Operation - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging. - - - - Within a bucket, if you add a tag that has the same key as an existing tag, the new - value overwrites the old value. For more information, see Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional operation is currently in progress against - this resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - Container for the necessary parameters to execute the PutBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketTagging service method, as returned by S3. - REST API Reference for PutBucketTagging Operation - - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT operation requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - Amazon S3 has a limitation of 50 routing rules per website configuration. If you require - more than 50 routing rules, you can use object redirect. For more information, see - Configuring - an Object Redirect in the Amazon Simple Storage Service Developer Guide. - - - The bucket name. - Container for the request. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketWebsite service method, as returned by S3. - REST API Reference for PutBucketWebsite Operation - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT operation requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - Amazon S3 has a limitation of 50 routing rules per website configuration. If you require - more than 50 routing rules, you can use object redirect. For more information, see - Configuring - an Object Redirect in the Amazon Simple Storage Service Developer Guide. - - - Container for the necessary parameters to execute the PutBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketWebsite service method, as returned by S3. - REST API Reference for PutBucketWebsite Operation - - - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - The name of the bucket for which to set the configuration. - A property of PutLifecycleConfigurationRequest used to execute the PutLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutLifecycleConfiguration service method, as returned by S3. - REST API Reference for PutLifecycleConfiguration Operation - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - Container for the necessary parameters to execute the PutLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutLifecycleConfiguration service method, as returned by S3. - REST API Reference for PutLifecycleConfiguration Operation - - - - - - - - - - - - - - - - - The base class for requests that return Amazon S3 objects. - - - - - Gets or sets the name of the bucket. - - - The name of the bucket. - - - - - Gets whether or not the bucket name is set. - - - A value of true if the bucket name is set. - Returns false if otherwise. - - - - - Gets or sets the key under which the Amazon S3 object is stored. - - - The key under which the Amazon S3 object is stored. - - - - - Gets whether or not the key property is set. - - - A value of true if key property is set. - Returns false if otherwise. - - - - - Gets or sets the version ID of the Amazon S3 object. - - - The version ID of the Amazon S3 object. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or - ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Gets or sets the ModifiedSinceDate property. - - - The ModifiedSinceDate property. - - - - - Gets or sets the ModifiedSinceDate property. - - - The ModifiedSinceDate property. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or - UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Gets or sets the UnmodifiedSinceDate property. - - - The UnmodifiedSinceDate property. - - - - - Gets or sets the UnmodifiedSinceDate property. - - - The UnmodifiedSinceDate property. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to decrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - The base class TransferUtility request classes. - - - - - Waits for all of the tasks to complete or till any task fails or is canceled. - - - - - Waits for all of the tasks to complete or till any task fails or is canceled. - - - - - Returns the amount of bytes remaining that need to be pulled down from S3. - - The fully qualified path of the file. - - - - - The command to manage an upload using the S3 multipart API. - - - - - Initializes a new instance of the class. - - The s3 client. - The config object that has the number of threads to use. - The file transporter request. - - - - This command is for doing regular PutObject requests. - - - - - This command files all the files that meets the criteria specified in the TransferUtilityUploadDirectoryRequest request - and uploads them. - - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - - Gets the Amazon S3 client used for making calls into Amazon S3. - - - The Amazon S3 client used for making calls into Amazon S3. - - - - - Uploads the specified file. - The object key is derived from the file's name. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the specified file. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the contents of the specified stream. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The stream to read to obtain the content to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the stream to. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the file or stream specified by the request. - To track the progress of the upload, - add an event listener to the request's UploadProgressEvent. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - Contains all the parameters required to upload to Amazon S3. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Aborts the multipart uploads that were initiated before the specified date. - - - The name of the bucket containing multipart uploads. - - - The date before which the multipart uploads were initiated. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the content from Amazon S3 and writes it to the specified file. - If the key is not specified in the request parameter, - the file name will used as the key name. - - - Contains all the parameters required to download an Amazon S3 object. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Returns a stream from which the caller can read the content from the specified - Amazon S3 bucket and key. - The caller of this method is responsible for closing the stream. - - - The name of the bucket. - - - The object key. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Returns a stream to read the contents from Amazon S3 as - specified by the TransferUtilityOpenStreamRequest. - The caller of this method is responsible for closing the stream. - - - Contains all the parameters required for the OpenStream operation. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - A pattern used to identify the files from the source directory to upload. - - - A search option that specifies whether to recursively search for files to upload - in subdirectories. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The request that contains all the parameters required to upload a directory. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by s3Directory. - - - The name of the bucket containing the Amazon S3 objects to download. - - - The directory in Amazon S3 to download. - - - The local directory to download the objects to. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by the S3Directory - property of the passed in TransferUtilityDownloadDirectoryRequest object. - - - Contains all the parameters required to download objects from Amazon S3 - into a local directory. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the content from Amazon S3 and writes it to the specified file. - - - The file path where the content from Amazon S3 will be written to. - - - The name of the bucket containing the Amazon S3 object to download. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - A pattern used to identify the files from the source directory to upload. - - - A search option that specifies whether to recursively search for files to upload - in subdirectories. - - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The request that contains all the parameters required to upload a directory. - - - - - Uploads the specified file. - The object key is derived from the file's name. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - - - Uploads the specified file. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - The key under which the Amazon S3 object is stored. - - - - - Uploads the contents of the specified stream. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The stream to read to obtain the content to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the stream to. - - - The key under which the Amazon S3 object is stored. - - - - - Uploads the file or stream specified by the request. - To track the progress of the upload, - add an event listener to the request's UploadProgressEvent. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - Contains all the parameters required to upload to Amazon S3. - - - - - Returns a stream from which the caller can read the content from the specified - Amazon S3 bucket and key. - The caller of this method is responsible for closing the stream. - - - The name of the bucket. - - - The object key. - - - A stream of the contents from the specified Amazon S3 and key. - - - - - Returns a stream to read the contents from Amazon S3 as - specified by the TransferUtilityOpenStreamRequest. - The caller of this method is responsible for closing the stream. - - - Contains all the parameters required to open a stream to an S3 object. - - - A stream of the contents from Amazon S3. - - - - - Downloads the content from Amazon S3 and writes it to the specified file. - - - The file path where the content from Amazon S3 will be written to. - - - The name of the bucket containing the Amazon S3 object to download. - - - The key under which the Amazon S3 object is stored. - - - - - Downloads the content from Amazon S3 and writes it to the specified file. - If the key is not specified in the request parameter, - the file name will used as the key name. - - - Contains all the parameters required to download an Amazon S3 object. - - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by s3Directory. - - - The name of the bucket containing the Amazon S3 objects to download. - - - The directory in Amazon S3 to download. - - - The local directory to download the objects to. - - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by the S3Directory - property of the passed in TransferUtilityDownloadDirectoryRequest object. - - - Contains all the parameters required to download objects from Amazon S3 - into a local directory. - - - - - Aborts the multipart uploads that were initiated before the specified date. - - - The name of the bucket containing multipart uploads. - - - The date before which the multipart uploads were initiated. - - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - - Constructs a new class. - - - The AWS Access Key ID. - - - The AWS Secret Access Key. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new class. - - - The AWS Access Key ID. - - - The AWS Secret Access Key. - - - The region to configure the transfer utility for. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new instance of the class. - - - The AWS Access Key ID. - - - The AWS Secret Access Key. - - - Specifies advanced settings. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new instance of the class. - - - The AWS Access Key ID. - - - The AWS Secret Access Key. - - - The region to configure the transfer utility for. - - - Specifies advanced settings. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new instance of the class. - - - The Amazon S3 client. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Initializes a new instance of the class. - - - The Amazon S3 client. - - - Specifies advanced configuration settings for . - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Gets the Amazon S3 client used for making calls into Amazon S3. - - - The Amazon S3 client used for making calls into Amazon S3. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Uploads the specified file. - The object key is derived from the file's name. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the specified file. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the contents of the specified stream. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The stream to read to obtain the content to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the stream to. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the file or stream specified by the request. - To track the progress of the upload, - add an event listener to the request's UploadProgressEvent. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - Contains all the parameters required to upload to Amazon S3. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Aborts the multipart uploads that were initiated before the specified date. - - - The name of the bucket containing multipart uploads. - - - The date before which the multipart uploads were initiated. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the content from Amazon S3 and writes it to the specified file. - If the key is not specified in the request parameter, - the file name will used as the key name. - - - Contains all the parameters required to download an Amazon S3 object. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Returns a stream from which the caller can read the content from the specified - Amazon S3 bucket and key. - The caller of this method is responsible for closing the stream. - - - The name of the bucket. - - - The object key. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Returns a stream to read the contents from Amazon S3 as - specified by the TransferUtilityOpenStreamRequest. - The caller of this method is responsible for closing the stream. - - - Contains all the parameters required for the OpenStream operation. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Constructs a new class. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new class. - - - The region to configure the transfer utility for. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new class. - - - Specifies advanced configuration settings for . - - - - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - A pattern used to identify the files from the source directory to upload. - - - A search option that specifies whether to recursively search for files to upload - in subdirectories. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The request that contains all the parameters required to upload a directory. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by s3Directory. - - - The name of the bucket containing the Amazon S3 objects to download. - - - The directory in Amazon S3 to download. - - - The local directory to download the objects to. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by the S3Directory - property of the passed in TransferUtilityDownloadDirectoryRequest object. - - - Contains all the parameters required to download objects from Amazon S3 - into a local directory. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the content from Amazon S3 and writes it to the specified file. - - - The file path where the content from Amazon S3 will be written to. - - - The name of the bucket containing the Amazon S3 object to download. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - A pattern used to identify the files from the source directory to upload. - - - A search option that specifies whether to recursively search for files to upload - in subdirectories. - - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The request that contains all the parameters required to upload a directory. - - - - - Uploads the specified file. - The object key is derived from the file's name. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - - - Uploads the specified file. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - The key under which the Amazon S3 object is stored. - - - - - Uploads the contents of the specified stream. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The stream to read to obtain the content to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the stream to. - - - The key under which the Amazon S3 object is stored. - - - - - Uploads the file or stream specified by the request. - To track the progress of the upload, - add an event listener to the request's UploadProgressEvent. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - Contains all the parameters required to upload to Amazon S3. - - - - - Returns a stream from which the caller can read the content from the specified - Amazon S3 bucket and key. - The caller of this method is responsible for closing the stream. - - - The name of the bucket. - - - The object key. - - - A stream of the contents from the specified Amazon S3 and key. - - - - - Returns a stream to read the contents from Amazon S3 as - specified by the TransferUtilityOpenStreamRequest. - The caller of this method is responsible for closing the stream. - - - Contains all the parameters required to open a stream to an S3 object. - - - A stream of the contents from Amazon S3. - - - - - Downloads the content from Amazon S3 and writes it to the specified file. - - - The file path where the content from Amazon S3 will be written to. - - - The name of the bucket containing the Amazon S3 object to download. - - - The key under which the Amazon S3 object is stored. - - - - - Downloads the content from Amazon S3 and writes it to the specified file. - If the key is not specified in the request parameter, - the file name will used as the key name. - - - Contains all the parameters required to download an Amazon S3 object. - - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by s3Directory. - - - The name of the bucket containing the Amazon S3 objects to download. - - - The directory in Amazon S3 to download. - - - The local directory to download the objects to. - - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by the S3Directory - property of the passed in TransferUtilityDownloadDirectoryRequest object. - - - Contains all the parameters required to download objects from Amazon S3 - into a local directory. - - - - - Aborts the multipart uploads that were initiated before the specified date. - - - The name of the bucket containing multipart uploads. - - - The date before which the multipart uploads were initiated. - - - - - - Provides configuration options for how processes requests. - - - The best configuration settings depend on network - configuration, latency and bandwidth. - The default configuration settings are suitable - for most applications, but this class enables developers to experiment with - different configurations and tune transfer manager performance. - - - - - - Default constructor. - - - - - Gets or sets the minimum part size for upload parts in bytes. The default is 16 MB. - Decreasing the minimum part size causes - multipart uploads to be split into a larger number - of smaller parts. Setting this value too low has a negative effect - on transfer speeds, causing extra latency and network - communication for each part. - - - - - This property determines how many active threads - or the number of concurrent asynchronous web requests - will be used to upload/download the file . - The default value is 10. - - - A value less than or equal to 0 will be silently ignored. - - - - - Gets or sets the number of executing threads. - This property determines how many active threads will be used to upload - the file. The default value is 10 threads. - - - A value less than or equal to 0 will be silently ignored. - - - - - Contains all the parameters - that can be set when making a this request with the - TransferUtility method. - - - - - Get or sets the file path location of where the - downloaded Amazon S3 object will be written to. - - - The file path location of where the downloaded Amazon S3 object will be written to. - - - - - Checks if FilePath property is set. - - True if FilePath property is set. - - - - The event for WriteObjectProgressEvent notifications. All - subscribers will be notified when a new progress - event is raised. - - The WriteObjectProgressEvent is fired as data - is downloaded from S3. The delegates attached to the event - will be passed information detailing how much data - has been downloaded as well as how much will be downloaded. - - - - Subscribe to this event if you want to receive - WriteObjectProgressEvent notifications. Here is how:
- 1. Define a method with a signature similar to this one: - - private void displayProgress(object sender, WriteObjectProgressArgs args) - { - Console.WriteLine(args); - } - - 2. Add this method to the WriteObjectProgressEvent delegate's invocation list - - TransferUtilityDownloadRequest request = new TransferUtilityDownloadRequest(); - request.WriteObjectProgressEvent += displayProgress; - - - - - - Causes the WriteObjectProgressEvent event to be fired. - - Progress data for the stream being written to file. - - - - Contains all the parameters - that can be set when making a this request with the - TransferUtility method. - - - - - Contains all the parameters - that can be set when making a this request with the - TransferUtility method. - - - - - Gets or sets the name of the bucket. - - - The name of the bucket. - - - - - Checks if BucketName property is set. - - true if BucketName property is set. - - - - Gets or sets the key under which the Amazon S3 object is to be stored. - - - The key under which the Amazon S3 object is to be stored. - - - - - Checks if Key property is set. - - true if Key property is set. - - - - Gets or sets the canned access control list (ACL) - for the uploaded object. - Please refer to - for - information on Amazon S3 canned ACLs. - - - The canned access control list (ACL) - for the uploaded object. - - - - - Checks if the CannedACL property is set. - - true if there is the CannedACL property is set. - - - - Removes the cannned access control list (ACL) - for the uploaded object. - - - - - Gets or sets the content type of the uploaded Amazon S3 object. - - - The content type of the uploaded Amazon S3 object. - - - - - Checks if ContentType property is set. - - true if ContentType property is set. - - - - Gets or sets the storage class for the uploaded Amazon S3 object. - Please refer to - for - information on S3 Storage Classes. - - - The storage class for the uploaded Amazon S3 object. - - - - - Gets and sets the ServerSideEncryptionMethod property. - Specifies the encryption used on the server to - store the content. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Input stream for the request; content for the request will be read from the stream. - - - - - - Gets or sets the file path - where the Amazon S3 object will be uploaded from. - - - For WinRT and Windows Phone this property must be in the form of "ms-appdata:///local/file.txt". - - - - The file path where the Amazon S3 object will be uploaded from. - - - - - Checks if FilePath property is set. - - true if FilePath property is set. - - - - Gets or sets the part size of the upload in bytes. - The uploaded file will be divided into - parts the size specified and - uploaded to Amazon S3 individually. - - - The part size of the upload. - - - - - Checks if PartSize property is set. - - true if PartSize property is set. - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - The tag-set for the object. - - - - - The event for UploadProgressEvent notifications. All - subscribers will be notified when a new progress - event is raised. - - The UploadProgressEvent is fired as data - is uploaded to S3. The delegates attached to the event - will be passed information detailing how much data - has been uploaded as well as how much will be uploaded. - - - - Subscribe to this event if you want to receive - UploadProgressEvent notifications. Here is how:
- 1. Define a method with a signature similar to this one: - - private void displayProgress(object sender, UploadProgressArgs args) - { - Console.WriteLine(args); - } - - 2. Add this method to the UploadProgressEvent delegate's invocation list - - TransferUtilityUploadRequest request = new TransferUtilityUploadRequest(); - request.UploadProgressEvent += displayProgress; - - - - - - Causes the UploadProgressEvent event to be fired. - - Progress data for the file being uploaded. - - - - Gets the length of the content by either checking the FileInfo.Length property or the Stream.Length property. - - The length of the content. - - - - Gets or sets whether or not the stream used with this request is - automatically closed when all of the content is read from the stream. - - - A value of true if the if the stream is - automatically closed when all of the content is read from the stream. - A value of false if otherwise. - - - - - If this value is set to true then the stream's position will be reset to the start before being read for upload. - Default: true. - - - - - Sets whether or not the stream used with this request is - automatically closed when all of the content is read from the stream - and returns this object instance, - enabling additional method calls to be chained together. - - - A value of true if the if the stream is - automatically closed when all of the content is read from the stream. - A value of false if otherwise. - - - This object instance, enabling additional method calls to be chained together. - - - - - Encapsulates the information needed to provide - transfer progress to subscribers of the Put Object - Event. - - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The how many bytes were transferred since last event. - The number of bytes transferred - The total number of bytes to be transferred - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The how many bytes were transferred since last event. - The number of bytes transferred - The total number of bytes to be transferred - The file being uploaded - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The how many bytes were transferred since last event. - The number of bytes transferred - The total number of bytes to be transferred - A compensation for any upstream aggregators if this event to correct theit totalTransferred count, - in case the underlying request is retried. - The file being uploaded - - - - Gets the FilePath. - - - - - Request object for downloading a directory with the TransferUtility. - - - - - Gets or sets the name of the bucket. - - - The name of the bucket. - - - - - Gets whether or not the bucket name is set. - - - A value of true if the bucket name is set. - Otherwise, returns false. - - - - - Gets or sets the local directory where objects from Amazon S3 will be downloaded. - If the directory doesn't exist, it will be created. - - - The local directory where objects from Amazon S3 will be downloaded. - - - - - Gets whether or not the LocalDirectory property is set. - - - A value of true if LocalDirectory property is set. - Otherwise, returns false. - - - - - Gets or sets the Amazon S3 directory to download from. - This is translated to a key prefix; keys that have this prefix will be - downloaded. - - - - - Gets whether or not the S3Directory property is set. - - - A value of true if S3Directory property is set. - Otherwise, returns false. - - - - - - This property is deprecated. This property doesn't honor the DateTimeKind, please - use ModifiedSinceDateUtc instead. - - Gets or sets the ModifiedSinceDate property. - Only objects that have been modified since this date will be - downloaded. - - - The ModifiedSinceDate property. - - - - - Checks if ModifiedSinceDate property is set. - - A value of true if ModifiedSinceDate property is set. - Otherwise, returns false. - - - - Gets or sets the ModifiedSinceDateUtc property. - Only objects that have been modified since this date will be - downloaded. - - - The ModifiedSinceDateUtc property. - - - - - Checks if ModifiedSinceDateUtc property is set. - - A value of true if ModifiedSinceDateUtc property is set. - Otherwise, returns false. - - - - - This property is deprecated. This property doesn't honor the DateTimeKind, please - use UnmodifiedSinceDateUtc instead. - - Gets or sets the UnmodifiedSinceDate property. - Only objects that have not been modified since this date will be downloaded. - - - The UnmodifiedSinceDate property. - - - - - Checks if UnmodifiedSinceDate property is set. - - true if UnmodifiedSinceDate property is set. - - - - Gets or sets the UnmodifiedSinceDateUtc property. - Only objects that have not been modified since this date will be downloaded. - - - The UnmodifiedSinceDateUtc property. - - - - - Checks if UnmodifiedSinceDateUtc property is set. - - true if UnmodifiedSinceDateUtc property is set. - - - - Gets or sets the DownloadFilesConcurrently property. - Specifies if multiple files will be downloaded concurrently. - The number of concurrent web requests used is controlled - by the TransferUtilityConfig.ConcurrencyLevel property. - - - - - The event for DownloadedDirectoryProgressEvent notifications. All - subscribers will be notified when a new progress - event is raised. - - The DownloadedDirectoryProgressEvent is fired as data - is downloaded from Amazon S3. The delegates attached to the event - will be passed information detailing how much data - has been downloaded as well as how much will be downloaded. - - - - Subscribe to this event if you want to receive - DownloadedDirectoryProgressEvent notifications. Here is how:
- 1. Define a method with a signature similar to this one: - - private void displayProgress(object sender, DownloadDirectoryProgressArgs args) - { - Console.WriteLine(args); - } - - 2. Add this method to the DownloadedDirectoryProgressEvent delegate's invocation list - - TransferUtilityDownloadDirectoryRequest request = new TransferUtilityDownloadDirectoryRequest(); - request.DownloadedDirectoryProgressEvent += displayProgress; - - - - - - Encapsulates the information needed to provide - transfer progress to subscribers of the DownloadDirectory - event. - - - - - Constructs a new instance of DownloadDirectoryProgressArgs. - - - The number of files downloaded. - - - The total number of files to download. - - - The current file being downloaded - - - The number of transferred bytes for the current file. - - - The size of the current file in bytes. - - - - - Constructs a new instance of DownloadDirectoryProgressArgs. - - - The number of files downloaded. - - - The total number of files to download. - - - The bytes transferred across all files being downloaded. - - - The total number of bytes across all files being downloaded. - - - The current file being downloaded. - - - The number of transferred bytes for the current file. - - - The size of the current file in bytes. - - - - - Gets or sets the total number of files. - - The total number of files. - - - - Gets or sets the number of files downloaded so far. - - The number of files downloaded. - - - - Gets or sets the total number of bytes across all files being downloaded. - - The total number of bytes across all files being downloaded. - - - - Gets or sets the bytes transferred across all files being downloaded. - - The bytes transferred across all files being downloaded. - - - - Gets or sets the current file being downloaded. - - The current file being downloaded. - - - - Gets or sets the transferred bytes for the current file. - - The transferred bytes for the current file. - - - - Gets or sets the total number of bytes for the current file. - - The total number of bytes for the current file. - - - - The string representation of this instance of DownloadDirectoryProgressArgs. - - The string representation of this instance of DownloadDirectoryProgressArgs. - - - - Contains all the parameters - that can be set when making a this request with the - TransferUtility method. - - - - - Gets or sets the directory where files are uploaded from. - - - The directory where files are uploaded from. - - - - - Checks if Directory property is set. - - true if Directory property is set. - - - - Gets or sets the KeyPrefix property. As object keys are generated for the - files being uploaded this value will prefix the key. This is useful when a directory - needs to be uploaded into sub directory in the S3 Bucket. - - - The directory where files are uploaded from. - - - - - Checks if KeyPrefix property is set. - - true if KeyPrefix property is set. - - - - Gets and sets the search pattern used to determine which - files in the directory are uploaded. - - - The search pattern used to deterimine which - files in the directory are uploaded. - The default value is "*", specifying that all files - in the directory will be uploaded. - - - - - Checks if SearchPattern property is set. - - true if SearchPattern property is set. - - - - Gets or sets the recursive options for the directory upload. - - - The recursive options for the directory upload. - Set by default to TopDirectoryOnly, - specifying that files will be uploaded from the root directory only. - - - - - Gets or sets the name of the bucket. - - - The name of the bucket. - - - - - Checks if BucketName property is set. - - true if BucketName property is set. - - - - Gets or sets the canned access control list (ACL) - for the uploaded objects. - Please refer to - for - information on Amazon S3 canned ACLs. - - - The canned access control list (ACL) - for the uploaded objects. - - - - - Checks if the CannedACL property is set. - - true if there is the CannedACL property is set. - - - - Gets or sets the content type for the uploaded Amazon S3 objects. - The default behavior when this field is not set is to use the file - extension to set the content type. If this field is set to a value it - will be applied to all uploaded files in the directory, overriding - file extension inspection. - - - The content type for all the uploaded Amazon S3 objects. - - - - - Gets or sets the storage class for the uploaded Amazon S3 objects. - Please refer to - for - information on S3 Storage Classes. - - - The storage class for the uploaded Amazon S3 objects. - - - - - The collection of meta data for the request. - - - - - Gets or sets the ServerSideEncryptionMethod property. - Specifies the encryption used on the server to - store the content. - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Gets or sets the UploadFilesConcurrently property. - Specifies if multiple files will be uploaded concurrently. - The number of concurrent web requests used is controlled - by the TransferUtilityConfig.ConcurrencyLevel property. - - - - - The event for UploadDirectoryProgressEvent notifications. All - subscribers will be notified when a new progress - event is raised. - - The UploadDirectoryProgressEvent is fired as data - is uploaded to S3. The delegates attached to the event - will be passed information detailing how much data - has been uploaded as well as how much will be uploaded. - - - - Subscribe to this event if you want to receive - UploadDirectoryProgressEvent notifications. Here is how:
- 1. Define a method with a signature similar to this one: - - private void displayProgress(object sender, UploadDirectoryProgressArgs args) - { - Console.WriteLine(args); - } - - 2. Add this method to the UploadDirectoryProgressEvent delegate's invocation list - - TransferUtilityUploadDirectoryRequest request = new TransferUtilityUploadDirectoryRequest(); - request.UploadDirectoryProgressEvent += displayProgress; - - - - - - The event for modifying individual TransferUtilityUploadRequest for each file - being uploaded. - - - - - Causes the UploadDirectoryProgressEvent event to be fired. - - Progress data for files currently being uploaded. - - - - Tags that will be applied to all objects in the diretory. - - - - - Encapsulates the information needed to provide - transfer progress to subscribers of the UploadDirectory - event. - - - - - Constructs a new instance of UploadDirectoryProgressArgs. - - - The number of files uploaded. - - - The total number of files to upload. - - - The current file - - - The number of transferred bytes for current file. - - - The size of the current file in bytes. - - - - - Constructs a new instance of UploadDirectoryProgressArgs. - - - The number of files uploaded. - - - The total number of files to upload. - - - The bytes transferred across all files being uploaded. - - - The total number of bytes across all files being uploaded. - - - The current file being uploaded. - - - The number of transferred bytes for current file. - - - The size of the current file in bytes. - - - - - Gets or sets the total number of files. - - The total number of files. - - - - Gets or sets the number of files uploaded. - - The number of files uploaded. - - - - Gets or sets the total number of bytes across all files being uploaded. - - The total number of bytes across all files being uploaded. - - - - Gets or sets the bytes transferred across all files being uploaded. - - The bytes transferred across all files being uploaded. - - - - Gets or sets the current file. - - - This property is only valid if UploadDirectory is used without enabling concurrent file uploads (by default concurrent upload is disabled). - If concurrent file uploads are enabled by setting TransferUtilityUploadDirectoryRequest.UploadFilesConcurrently to true, this property - will return null. - - The current file. - - - - Gets or sets the transferred bytes for current file. - - - This property is only valid if UploadDirectory is used without enabling concurrent file uploads (by default concurrent upload is disabled). - If concurrent file uploads are enabled by setting TransferUtilityUploadDirectoryRequest.UploadFilesConcurrently to true, this property - will return 0. - - The transferred bytes for current file. - - - - Gets or sets the total number of bytes for current file. - - - This property is only valid if UploadDirectory is used without enabling concurrent file uploads (by default concurrent upload is disabled). - If concurrent file uploads are enabled by setting TransferUtilityUploadDirectoryRequest.UploadFilesConcurrently to true, this property - will return 0. - - The total number of bytes for current file. - - - - The string representation of this instance of UploadDirectoryProgressArgs. - - The string representation of this instance of UploadDirectoryProgressArgs. - - - - Contains a single TransferUtilityUploadRequest corresponding - to a single file about to be uploaded, allowing changes to - the request before it is executed. - - - - - Constructs a new UploadDirectoryFileRequestArgs instance. - - Request being processed. - - - - Gets and sets the UploadRequest property. - - - - - This class extends the AmazonS3Client and provides client side encryption when reading or writing S3 objects. - - - - - Constructs AmazonS3EncryptionClient with the Encryption materials and credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Constructs AmazonS3EncryptionClient with the Encryption materials and credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - - The region to connect. - - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Constructs AmazonS3EncryptionClient with the Encryption materials, - AmazonS3 CryptoConfiguration object and credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - - The AmazonS3EncryptionClient CryptoConfiguration Object - - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Constructs AmazonS3EncryptionClient with AWS Credentials and Encryption materials. - - - The encryption materials to be used to encrypt and decrypt envelope key. - - AWS Credentials - - - - Constructs AmazonS3EncryptionClient with AWS Credentials, Region and Encryption materials - - AWS Credentials - The region to connect. - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Constructs AmazonS3EncryptionClient with AWS Credentials, AmazonS3CryptoConfiguration Configuration object - and Encryption materials - - AWS Credentials - The AmazonS3EncryptionClient CryptoConfiguration Object - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Constructs AmazonS3EncryptionClient with AWS Access Key ID, - AWS Secret Key and Encryption materials - - AWS Access Key ID - AWS Secret Access Key - The encryption materials to be used to encrypt and decrypt envelope key. - - - - Constructs AmazonS3EncryptionClient with AWS Access Key ID, - AWS Secret Key, Region and Encryption materials - - AWS Access Key ID - AWS Secret Access Key - The region to connect. - The encryption materials to be used to encrypt and decrypt envelope key. - - - - Constructs AmazonS3EncryptionClient with AWS Access Key ID, Secret Key, - AmazonS3 CryptoConfiguration object and Encryption materials. - - AWS Access Key ID - AWS Secret Access Key - The AmazonS3EncryptionClient CryptoConfiguration Object - The encryption materials to be used to encrypt and decrypt envelope key. - - - - Constructs AmazonS3EncryptionClient with AWS Access Key ID, Secret Key, - SessionToken and Encryption materials. - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Constructs AmazonS3EncryptionClient with AWS Access Key ID, Secret Key, - SessionToken, Region and Encryption materials. - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - The region to connect. - The encryption materials to be used to encrypt and decrypt envelope key. - - - - Constructs AmazonS3EncryptionClient with AWS Access Key ID, Secret Key, SessionToken - AmazonS3EncryptionClient CryptoConfiguration object and Encryption materials. - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - The AmazonS3EncryptionClient CryptoConfiguration Object - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Turn off response logging because it will interfere with decrypt of the data coming back from S3. - - - - - Customize the pipeline to allow encryption. - - - - - - Dispose this instance - - - - - - AmazonS3CryptoConfiguration allows customers - to set storage mode for encryption credentials - - - - - Default Constructor. - - - - - Gets and sets the StorageMode property. This determines if the crypto metadata is stored as metadata on the object or as a separate object in S3. - The default is ObjectMetadata. - - - - - Mode for string the encryption information for an object. - - - - - Store the information in a separate S3 Object. - - - - - Store the information as metadata on the encrypted object. - - - - - Encryption Instructions store the encryption credentials - - - - - Construct an instance EncryptionInstructions. - - - - - - - - - Construct an instance EncryptionInstructions. - - - - - - - - The "key encrypting key" materials used in encrypt/decryption. - These materials may be an asymmetric key, a symmetric key, or a KMS key ID. - - - - - Constructs a new EncryptionMaterials object, storing an asymmetric key. - - - - - - Constructs a new EncryptionMaterials object, storing a symmetric key. - - - - - - Constructs a new EncryptionMaterials object, storing a KMS Key ID - - - - - - The EncryptionUtils class encrypts and decrypts data stored in S3. - It can be used to prepare requests for encryption before they are stored in S3 - and to decrypt objects that are retrieved from S3. - - - - - Decrypts an encrypted Envelope key using the provided encryption materials - and returns it in raw byte array form. - - Encrypted envelope key - Encryption materials needed to decrypt the encrypted envlelope key - - - - - Returns an updated stream where the stream contains the encrypted object contents. - The specified instruction will be used to encrypt data. - - - The stream whose contents are to be encrypted. - - - The instruction that will be used to encrypt the object data. - - - Encrypted stream, i.e input stream wrapped into encrypted stream - - - - - Returns an updated input stream where the input stream contains the encrypted object contents. - The specified instruction will be used to encrypt data. - - - The stream whose contents are to be encrypted. - - - The instruction that will be used to encrypt the object data. - - - Encrypted stream, i.e input stream wrapped into encrypted stream - - - - - Updates object where the object - input stream contains the decrypted contents. - - - The getObject response whose contents are to be decrypted. - - - The instruction that will be used to encrypt the object data. - - - - - Generates an instruction that will be used to encrypt an object - using materials with the KMSKeyID set. - - - Used to call KMS to generate a data key. - - - The encryption materials to be used to encrypt and decrypt data. - - - The instruction that will be used to encrypt an object. - - - - - Generates an instruction that will be used to encrypt an object - using materials with the KMSKeyID set. - - - Used to call KMS to generate a data key. - - - The encryption materials to be used to encrypt and decrypt data. - - - The instruction that will be used to encrypt an object. - - - - - Generates an instruction that will be used to encrypt an object - using materials with the AsymmetricProvider or SymmetricProvider set. - - - The encryption materials to be used to encrypt and decrypt data. - - - The instruction that will be used to encrypt an object. - - - - - Builds an instruction object from the object metadata. - - - A non-null object response that contains encryption information in its metadata. - - - The non-null encryption materials to be used to encrypt and decrypt Envelope key. - - - The decrypted envelope key to be use if KMS key wrapping is being used. Or null if non-KMS key wrapping is being used. - - - - - - - Builds an instruction object from the instruction file. - - Instruction file GetObject response - - The non-null encryption materials to be used to encrypt and decrypt Envelope key. - - - A non-null instruction object containing encryption information. - - - - - Update the request's ObjectMetadata with the necessary information for decrypting the object. - - - AmazonWebServiceRequest encrypted using the given instruction - - - Non-null instruction used to encrypt the data in this AmazonWebServiceRequest . - - - If true use V2 metadata format, otherwise use V1. - - - - - Adds UnEncrypted content length to object metadata - - - - - - checks if encryption credentials are in object metadata - - Response of the object - - - - - checks if encryption credentials are in the instructionfile - - Instruction file response that contains encryption information - - - - - Custom the pipeline handler to decrypt objects. - - - - - Construct instance of SetupDecryptionHandler. - - - - - - Gets the EncryptionClient property which is the AmazonS3EncryptionClient that is decrypting the object. - - - - - Calls the post invoke logic after calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Decrypt the object being downloaded. - - - - - - Calls the and post invoke logic after calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Decrypt the object being downloaded. - - - - - - Decrypt the object being downloaded. - - - - - - - Updates object where the object input stream contains the decrypted contents. - - - The getObject response of InstructionFile. - - - The getObject response whose contents are to be decrypted. - - - - - Updates object where the object input stream contains the decrypted contents. - - - The getObject response whose contents are to be decrypted. - - - The decrypted envelope key to be use if KMS key wrapping is being used. Or null if non-KMS key wrapping is being used. - - - - - Custom pipeline handler to encrypt the data as it is being uploaded to S3. - - - - - Construct an instance SetupEncryptionHandler. - - - - - - Gets the EncryptionClient property which is the AmazonS3EncryptionClient that is encrypting the object. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Encrypts the S3 object being uploaded. - - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Encrypts the S3 object being uploaded. - - - - - - Make sure that the storage mode and encryption materials are compatible. - The client only supports KMS key wrapping in metadata storage mode. - - - - - Updates the request where the metadata contains encryption information - and the input stream contains the encrypted object contents. - - - The request whose contents are to be encrypted. - - - - - Updates the request where the instruction file contains encryption information - and the input stream contains the encrypted object contents. - - - - - - Updates the request where the input stream contains the encrypted object contents. - - - - - - Adds the crypto token to the user agent - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Customize the user agent. - - - - - - Configuration for the S3 section of AWS configuration. - Changes to some settings may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws> - <s3 useSignatureVersion4="true" /> - </aws> - - - - - - Key for the S3UseSignatureVersion4Key property. - - - - - - Configures if the S3 client should use Signature Version 4 signing with requests. - By default, this setting is set to true which will use Signature Version 4 for all - requests except presigned URL requests when the region is set to us-east-1. When - UseSignatureVersion4 is explicitly set to true by directly setting this property or - directly setting this property through configuration, Signature Version 4 will be - used for all requests when able to do so. - When this setting is false, Signature Version 2 will be used. Note that when the - setting is false, Signature Version 4 may still be used by default in some cases - or with some regions. - - - - - Escape and unescape S3 metadata for S3 Put/Get object requests. - Escape only escapes non-ascii values in metadata - Any "%" values in metadata could interfere with this option. - Default value is false. - - - - - Was the value of the UseSignatureVersion4 property set explicitly? - This can be done via configuration or by directly setting the property. - - This is used to determine if the user set UseSignatureVersion4 to true, - or if it's true because the default was changed to true in the SDK. - - - - diff --git a/packages/AWSSDK.S3.3.3.111.14/lib/netstandard2.0/AWSSDK.S3.dll b/packages/AWSSDK.S3.3.3.111.14/lib/netstandard2.0/AWSSDK.S3.dll deleted file mode 100644 index 68b239d..0000000 Binary files a/packages/AWSSDK.S3.3.3.111.14/lib/netstandard2.0/AWSSDK.S3.dll and /dev/null differ diff --git a/packages/AWSSDK.S3.3.3.111.14/lib/netstandard2.0/AWSSDK.S3.xml b/packages/AWSSDK.S3.3.3.111.14/lib/netstandard2.0/AWSSDK.S3.xml deleted file mode 100644 index b513fc3..0000000 --- a/packages/AWSSDK.S3.3.3.111.14/lib/netstandard2.0/AWSSDK.S3.xml +++ /dev/null @@ -1,30912 +0,0 @@ - - - - AWSSDK.S3 - - - - - Implementation for accessing S3 - - - - - - - Specialize the initialize of the client. - - - - - Create a signed URL allowing access to a resource that would - usually require authentication. - - - - When using query string authentication you create a query, - specify an expiration time for the query, sign it with your - signature, place the data in an HTTP request, and distribute - the request to a user or embed the request in a web page. - - - A PreSigned URL can be generated for GET, PUT, DELETE and HEAD - operations on your bucketName, keys, and versions. - - - The GetPreSignedUrlRequest that defines the - parameters of the operation. - determines if signing will fall back to SigV2 if the - signing region is us-east-1 - A string that is the signed http request. - - - - - - Marshalls the parameters for a presigned url for a preferred signing protocol. - - - - - - True if AWS4 signing will be used; if the expiry period in the request exceeds the - maximum allowed for AWS4 (one week), an ArgumentException is thrown. - - - - - - Create a signed URL allowing access to a resource that would - usually require authentication. - - - - When using query string authentication you create a query, - specify an expiration time for the query, sign it with your - signature, place the data in an HTTP request, and distribute - the request to a user or embed the request in a web page. - - - A PreSigned URL can be generated for GET, PUT, DELETE and HEAD - operations on your bucketName, keys, and versions. - - - The GetPreSignedUrlRequest that defines the - parameters of the operation. - A string that is the signed http request. - - - - - - Constructs AmazonS3Client with the credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - - - - Constructs AmazonS3Client with the credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - The region to connect. - - - - Constructs AmazonS3Client with the credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - The AmazonS3Client Configuration Object - - - - Constructs AmazonS3Client with AWS Credentials - - AWS Credentials - - - - Constructs AmazonS3Client with AWS Credentials - - AWS Credentials - The region to connect. - - - - Constructs AmazonS3Client with AWS Credentials and an - AmazonS3Client Configuration object. - - AWS Credentials - The AmazonS3Client Configuration Object - - - - Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - - - - Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - The region to connect. - - - - Constructs AmazonS3Client with AWS Access Key ID, AWS Secret Key and an - AmazonS3Client Configuration object. - - AWS Access Key ID - AWS Secret Access Key - The AmazonS3Client Configuration Object - - - - Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - - - - Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - The region to connect. - - - - Constructs AmazonS3Client with AWS Access Key ID, AWS Secret Key and an - AmazonS3Client Configuration object. - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - The AmazonS3Client Configuration Object - - - - Creates the signer for the service. - - - - - Customizes the runtime pipeline. - - Runtime pipeline for the current client. - - - - Capture metadata for the service. - - - - - Disposes the service client. - - - - - This operation aborts a multipart upload. After a multipart upload is aborted, no - additional parts can be uploaded using that upload ID. The storage consumed by any - previously uploaded parts will be freed. However, if any part uploads are currently - in progress, those part uploads might or might not succeed. As a result, it might - be necessary to abort a given multipart upload multiple times in order to completely - free all storage consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts operation and ensure that the parts - list is empty. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - The bucket name to which the upload was taking place. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object for which the multipart upload was initiated. - Upload ID that identifies the multipart upload. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AbortMultipartUpload service method, as returned by S3. - REST API Reference for AbortMultipartUpload Operation - - - - This operation aborts a multipart upload. After a multipart upload is aborted, no - additional parts can be uploaded using that upload ID. The storage consumed by any - previously uploaded parts will be freed. However, if any part uploads are currently - in progress, those part uploads might or might not succeed. As a result, it might - be necessary to abort a given multipart upload multiple times in order to completely - free all storage consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts operation and ensure that the parts - list is empty. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - Container for the necessary parameters to execute the AbortMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AbortMultipartUpload service method, as returned by S3. - REST API Reference for AbortMultipartUpload Operation - - - - Completes a multipart upload by assembling previously uploaded parts. - - - - You first initiate the multipart upload and then upload all parts using the UploadPart - operation. After successfully uploading all relevant parts of an upload, you call - this operation to complete the upload. Upon receiving this request, Amazon S3 concatenates - all the parts in ascending order by part number to create a new object. In the Complete - Multipart Upload request, you must provide the parts list. You must ensure that the - parts list is complete. This operation concatenates the parts that you provide in - the list. For each part in the list, you must provide the part number and the ETag - value, returned after that part was uploaded. - - - - Processing of a Complete Multipart Upload request could take several minutes to complete. - After Amazon S3 begins processing the request, it sends an HTTP response header that - specifies a 200 OK response. While processing is in progress, Amazon S3 periodically - sends white space characters to keep the connection from timing out. Because a request - could fail after the initial 200 OK response has been sent, it is important that you - check the response body to determine whether the request succeeded. - - - - Note that if CompleteMultipartUpload fails, applications should be prepared - to retry the failed requests. For more information, see Amazon - S3 Error Best Practices. - - - - For more information about multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - GetBucketLifecycle has the following special errors: - -
  • - - Error code: EntityTooSmall - -
    • - - Description: Your proposed upload is smaller than the minimum allowed object size. - Each part must be at least 5 MB in size, except the last part. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPart - -
    • - - Description: One or more of the specified parts could not be found. The part might - not have been uploaded, or the specified entity tag might not have matched the part's - entity tag. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPartOrder - -
    • - - Description: The list of parts was not in ascending order. The parts list must be - specified in order by part number. - -
    • - - 400 Bad Request - -
  • - - Error code: NoSuchUpload - -
    • - - Description: The specified multipart upload does not exist. The upload ID might be - invalid, or the multipart upload might have been aborted or completed. - -
    • - - 404 Not Found - -
- - The following operations are related to CompleteMultipartUpload: - - - - Container for the necessary parameters to execute the CompleteMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CompleteMultipartUpload service method, as returned by S3. - REST API Reference for CompleteMultipartUpload Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 Developer Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Encryption - - - - The source object that you are copying can be encrypted or unencrypted. The source - object can be encrypted with server-side encryption using AWS managed encryption keys - (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side - encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers - and decrypts the data when you access it. - - - - You can optionally use the appropriate encryption-related headers to request server-side - encryption for the target object. You have the option to provide your own encryption - key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that - was used to encrypt the source object. You can even request encryption if the source - object was not encrypted. For more information about server-side encryption, see Using - Server-Side Encryption. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject operation to change the storage class of an - object that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 Service Developer Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 Developer Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Encryption - - - - The source object that you are copying can be encrypted or unencrypted. The source - object can be encrypted with server-side encryption using AWS managed encryption keys - (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side - encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers - and decrypts the data when you access it. - - - - You can optionally use the appropriate encryption-related headers to request server-side - encryption for the target object. You have the option to provide your own encryption - key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that - was used to encrypt the source object. You can even request encryption if the source - object was not encrypted. For more information about server-side encryption, see Using - Server-Side Encryption. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject operation to change the storage class of an - object that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 Service Developer Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 Developer Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Encryption - - - - The source object that you are copying can be encrypted or unencrypted. The source - object can be encrypted with server-side encryption using AWS managed encryption keys - (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side - encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers - and decrypts the data when you access it. - - - - You can optionally use the appropriate encryption-related headers to request server-side - encryption for the target object. You have the option to provide your own encryption - key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that - was used to encrypt the source object. You can even request encryption if the source - object was not encrypted. For more information about server-side encryption, see Using - Server-Side Encryption. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject operation to change the storage class of an - object that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 Service Developer Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - Container for the necessary parameters to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - - - - - - Deletes an analytics configuration for the bucket (specified by the analytics configuration - ID). - - - - To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to DeleteBucketAnalyticsConfiguration: - -
  • - - - -
  • - - - -
  • - - - -
- - Container for the necessary parameters to execute the DeleteBucketAnalyticsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketAnalyticsConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketAnalyticsConfiguration Operation - - - - - Deletes an inventory configuration (identified by the inventory ID) from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - Operations related to DeleteBucketInventoryConfiguration include: - - - - Container for the necessary parameters to execute the DeleteBucketInventoryConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketInventoryConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketInventoryConfiguration Operation - - - - Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified - by the metrics configuration ID) from the bucket. Note that this doesn't include the - daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketMetricsConfiguration Operation - - - - This implementation of the DELETE operation uses the policy subresource to delete - the policy of a specified bucket. If you are using an identity other than the root - user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - The bucket name. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketPolicy service method, as returned by S3. - REST API Reference for DeleteBucketPolicy Operation - - - - This implementation of the DELETE operation uses the policy subresource to delete - the policy of a specified bucket. If you are using an identity other than the root - user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - Container for the necessary parameters to execute the DeleteBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketPolicy service method, as returned by S3. - REST API Reference for DeleteBucketPolicy Operation - - - - Deletes the replication configuration from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutReplicationConfiguration - action. The bucket owner has these permissions by default and can grant it to others. - For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - It can take a while for the deletion of a replication configuration to fully propagate. - - - - For information about replication configuration, see Replication - in the Amazon S3 Developer Guide. - - - - The following operations are related to DeleteBucketReplication: - - - - Container for the necessary parameters to execute the DeleteBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketReplication service method, as returned by S3. - REST API Reference for DeleteBucketReplication Operation - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - The bucket that has the tag set to be removed. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketTagging service method, as returned by S3. - REST API Reference for DeleteBucketTagging Operation - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - Container for the necessary parameters to execute the DeleteBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketTagging service method, as returned by S3. - REST API Reference for DeleteBucketTagging Operation - - - - This operation removes the website configuration for a bucket. Amazon S3 returns a - 200 OK response upon successfully deleting a website configuration on - the specified bucket. You will get a 200 OK response if the website configuration - you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE operation requires the S3:DeleteBucketWebsite permission. - By default, only the bucket owner can delete the website configuration attached to - a bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which you want to remove the website configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketWebsite service method, as returned by S3. - REST API Reference for DeleteBucketWebsite Operation - - - - This operation removes the website configuration for a bucket. Amazon S3 returns a - 200 OK response upon successfully deleting a website configuration on - the specified bucket. You will get a 200 OK response if the website configuration - you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE operation requires the S3:DeleteBucketWebsite permission. - By default, only the bucket owner can delete the website configuration attached to - a bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the DeleteBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketWebsite service method, as returned by S3. - REST API Reference for DeleteBucketWebsite Operation - - - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - The bucket name of the lifecycle to delete. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - REST API Reference for DeleteLifecycleConfiguration Operation - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - Container for the necessary parameters to execute the DeleteLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - REST API Reference for DeleteLifecycleConfiguration Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key name of the object to delete. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key name of the object to delete. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - Container for the necessary parameters to execute the DeleteObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - This operation enables you to delete multiple objects from a bucket using a single - HTTP request. If you know the object keys that you want to delete, then this operation - provides a suitable alternative to sending individual delete requests, reducing per-request - overhead. - - - - The request contains a list of up to 1000 keys that you want to delete. In the XML, - you provide the object key names, and optionally, version IDs if you want to delete - a specific version of the object from a versioning-enabled bucket. For each key, Amazon - S3 performs a delete operation and returns the result of that delete, success, or - failure, in the response. Note that if the object specified in the request is not - found, Amazon S3 returns the result as deleted. - - - - The operation supports two modes for the response: verbose and quiet. By default, - the operation uses verbose mode in which the response includes the result of deletion - of each key in your request. In quiet mode the response includes only keys where the - delete operation encountered an error. For a successful deletion, the operation does - not return any information about the delete in the response body. - - - - When performing this operation on an MFA Delete enabled bucket, that attempts to delete - any versioned objects, you must include an MFA token. If you do not provide one, the - entire request will fail, even if there are non-versioned objects you are trying to - delete. If you provide an invalid token, whether there are versioned keys in the request - or not, the entire Multi-Object Delete request will fail. For information about MFA - Delete, see - MFA Delete. - - - - Finally, the Content-MD5 header is required for all Multi-Object Delete requests. - Amazon S3 uses the header value to ensure that your request body has not been altered - in transit. - - - - The following operations are related to DeleteObjects: - - - - Container for the necessary parameters to execute the DeleteObjects service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObjects service method, as returned by S3. - REST API Reference for DeleteObjects Operation - - - - Removes the entire tag set from the specified object. For more information about managing - object tags, see - Object Tagging. - - - - To use this operation, you must have permission to perform the s3:DeleteObjectTagging - action. - - - - To delete tags of a specific object version, add the versionId query - parameter in the request. You will need permission for the s3:DeleteObjectVersionTagging - action. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteObjectTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObjectTagging service method, as returned by S3. - REST API Reference for DeleteObjectTagging Operation - - - - Removes the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:PutBucketPublicAccessBlock - permission. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to DeletePublicAccessBlock: - - - - Container for the necessary parameters to execute the DeletePublicAccessBlock service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeletePublicAccessBlock service method, as returned by S3. - REST API Reference for DeletePublicAccessBlock Operation - - - - - - - - - Returns the default encryption configuration for an Amazon S3 bucket. For information - about the Amazon S3 default encryption feature, see Amazon - S3 Default Bucket Encryption. - - - - To use this operation, you must have permission to perform the s3:GetEncryptionConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to GetBucketEncryption: - - - - Container for the necessary parameters to execute the GetBucketEncryption service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketEncryption service method, as returned by S3. - REST API Reference for GetBucketEncryption Operation - - - - Returns an inventory configuration (identified by the inventory configuration ID) - from the bucket. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - The following operations are related to GetBucketInventoryConfiguration: - - - - Container for the necessary parameters to execute the GetBucketInventoryConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketInventoryConfiguration service method, as returned by S3. - REST API Reference for GetBucketInventoryConfiguration Operation - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - The name of the bucket for which to get the location. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLocation service method, as returned by S3. - REST API Reference for GetBucketLocation Operation - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - Container for the necessary parameters to execute the GetBucketLocation service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLocation service method, as returned by S3. - REST API Reference for GetBucketLocation Operation - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - The bucket name for which to get the logging information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLogging service method, as returned by S3. - REST API Reference for GetBucketLogging Operation - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - Container for the necessary parameters to execute the GetBucketLogging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLogging service method, as returned by S3. - REST API Reference for GetBucketLogging Operation - - - - Gets a metrics configuration (specified by the metrics configuration ID) from the - bucket. Note that this doesn't include the daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to GetBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the GetBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for GetBucketMetricsConfiguration Operation - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following operation is related to GetBucketNotification: - - - - Name of the bucket for which to get the notification configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketNotification service method, as returned by S3. - REST API Reference for GetBucketNotification Operation - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following operation is related to GetBucketNotification: - - - - Container for the necessary parameters to execute the GetBucketNotification service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketNotification service method, as returned by S3. - REST API Reference for GetBucketNotification Operation - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operation is related to GetBucketPolicy: - - - - The bucket name for which to get the bucket policy. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicy service method, as returned by S3. - REST API Reference for GetBucketPolicy Operation - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operation is related to GetBucketPolicy: - - - - Container for the necessary parameters to execute the GetBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicy service method, as returned by S3. - REST API Reference for GetBucketPolicy Operation - - - - Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket - is public. In order to use this operation, you must have the s3:GetBucketPolicyStatus - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - For more information about when Amazon S3 considers a bucket public, see The - Meaning of "Public". - - - - The following operations are related to GetBucketPolicyStatus: - - - - Container for the necessary parameters to execute the GetBucketPolicyStatus service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicyStatus service method, as returned by S3. - REST API Reference for GetBucketPolicyStatus Operation - - - - Retrieves the replication configuration for the given Amazon S3 bucket. - - Container for the necessary parameters to execute the GetBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketReplication service method, as returned by S3. - REST API Reference for GetBucketReplication Operation - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - The name of the bucket for which to get the payment request configuration - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketRequestPayment service method, as returned by S3. - REST API Reference for GetBucketRequestPayment Operation - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - Container for the necessary parameters to execute the GetBucketRequestPayment service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketRequestPayment service method, as returned by S3. - REST API Reference for GetBucketRequestPayment Operation - - - - Returns the tag set associated with the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - GetBucketTagging has the following special error: - -
  • - - Error code: NoSuchTagSetError - -
    • - - Description: There is no tag set associated with the bucket. - -
- - The following operations are related to GetBucketTagging: - - - - Container for the necessary parameters to execute the GetBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketTagging service method, as returned by S3. - REST API Reference for GetBucketTagging Operation - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - The name of the bucket for which to get the versioning information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketVersioning service method, as returned by S3. - REST API Reference for GetBucketVersioning Operation - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - Container for the necessary parameters to execute the GetBucketVersioning service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketVersioning service method, as returned by S3. - REST API Reference for GetBucketVersioning Operation - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET operation requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which to get the website configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketWebsite service method, as returned by S3. - REST API Reference for GetBucketWebsite Operation - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET operation requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the GetBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketWebsite service method, as returned by S3. - REST API Reference for GetBucketWebsite Operation - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - The bucket name for which to get the cors configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetCORSConfiguration service method, as returned by S3. - REST API Reference for GetCORSConfiguration Operation - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - Container for the necessary parameters to execute the GetCORSConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetCORSConfiguration service method, as returned by S3. - REST API Reference for GetCORSConfiguration Operation - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are still using previous version of the lifecycle configuration, it works. - For the earlier API description, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to GetBucketLifecycleConfiguration: - - - - The name of the bucket for which to get the lifecycle information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetLifecycleConfiguration service method, as returned by S3. - REST API Reference for GetLifecycleConfiguration Operation - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are still using previous version of the lifecycle configuration, it works. - For the earlier API description, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to GetBucketLifecycleConfiguration: - - - - Container for the necessary parameters to execute the GetLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetLifecycleConfiguration service method, as returned by S3. - REST API Reference for GetLifecycleConfiguration Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object to get. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object to get. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - Container for the necessary parameters to execute the GetObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Gets an object's current Legal Hold status. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLegalHold service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectLegalHold service method, as returned by S3. - REST API Reference for GetObjectLegalHold Operation - - - - Gets the Object Lock configuration for a bucket. The rule specified in the Object - Lock configuration will be applied by default to every new object placed in the specified - bucket. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLockConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectLockConfiguration service method, as returned by S3. - REST API Reference for GetObjectLockConfiguration Operation - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - The name of the bucket containing the object. - The object key. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - The name of the bucket containing the object. - The object key. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - Container for the necessary parameters to execute the GetObjectMetadata service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - Retrieves an object's retention settings. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectRetention service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectRetention service method, as returned by S3. - REST API Reference for GetObjectRetention Operation - - - - Returns the tag-set of an object. You send the GET request against the tagging subresource - associated with the object. - - - - To use this operation, you must have permission to perform the s3:GetObjectTagging - action. By default, the GET operation returns information about current version of - an object. For a versioned bucket, you can have multiple versions of an object in - your bucket. To retrieve tags of any other version, use the versionId query parameter. - You also need permission for the s3:GetObjectVersionTagging action. - - - - By default, the bucket owner has this permission and can grant this permission to - others. - - - - For information about the Amazon S3 object tagging feature, see Object - Tagging. - - - - The following operation is related to GetObjectTagging: - - - - Container for the necessary parameters to execute the GetObjectTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTagging service method, as returned by S3. - REST API Reference for GetObjectTagging Operation - - - - Return torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Amazon - S3 Torrent. - - - - You can get torrent only for objects that are less than 5 GB in size and that are - not encrypted using server-side encryption with customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - The following operation is related to GetObjectTorrent: - - - - The name of the bucket containing the object for which to get the torrent files. - The object key for which to get the information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTorrent service method, as returned by S3. - REST API Reference for GetObjectTorrent Operation - - - - Return torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Amazon - S3 Torrent. - - - - You can get torrent only for objects that are less than 5 GB in size and that are - not encrypted using server-side encryption with customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - The following operation is related to GetObjectTorrent: - - - - Container for the necessary parameters to execute the GetObjectTorrent service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTorrent service method, as returned by S3. - REST API Reference for GetObjectTorrent Operation - - - - Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:GetBucketPublicAccessBlock - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket - or an object, it checks the PublicAccessBlock configuration for both - the bucket (or the bucket that contains the object) and the bucket owner's account. - If the PublicAccessBlock settings are different between the bucket and - the account, Amazon S3 uses the most restrictive combination of the bucket-level and - account-level settings. - - - - For more information about when Amazon S3 considers a bucket or an object public, - see The - Meaning of "Public". - - - - The following operations are related to GetPublicAccessBlock: - - - - Container for the necessary parameters to execute the GetPublicAccessBlock service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetPublicAccessBlock service method, as returned by S3. - REST API Reference for GetPublicAccessBlock Operation - - - - This operation is useful to determine if a bucket exists and you have permission to - access it. The operation returns a 200 OK if the bucket exists and you - have permission to access it. Otherwise, the operation might return responses such - as 404 Not Found and 403 Forbidden. - - - - To use this operation, you must have permissions to perform the s3:ListBucket - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - Container for the necessary parameters to execute the HeadBucket service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the HeadBucket service method, as returned by S3. - REST API Reference for HeadBucket Operation - - - - This operation initiates a multipart upload and returns an upload ID. This upload - ID is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort operation - and Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload API and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart) and UploadPartCopy) requests must match the headers you - used in the request to initiate the upload by using CreateMultipartUpload. - - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, - kms:GenerateDataKey*, and kms:DescribeKey actions on the - key. These permissions are required because Amazon S3 must decrypt and read data from - the encrypted file parts before it completes the multipart upload. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - The following operations are related to CreateMultipartUpload: - - - - The name of the bucket to which to initiate the upload - Object key for which the multipart upload is to be initiated. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the InitiateMultipartUpload service method, as returned by S3. - REST API Reference for InitiateMultipartUpload Operation - - - - This operation initiates a multipart upload and returns an upload ID. This upload - ID is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort operation - and Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload API and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart) and UploadPartCopy) requests must match the headers you - used in the request to initiate the upload by using CreateMultipartUpload. - - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, - kms:GenerateDataKey*, and kms:DescribeKey actions on the - key. These permissions are required because Amazon S3 must decrypt and read data from - the encrypted file parts before it completes the multipart upload. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - The following operations are related to CreateMultipartUpload: - - - - Container for the necessary parameters to execute the InitiateMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the InitiateMultipartUpload service method, as returned by S3. - REST API Reference for InitiateMultipartUpload Operation - - - - Lists the analytics configurations for the bucket. You can have up to 1,000 analytics - configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. You should always check the IsTruncated element in the response. - If there are no more configurations to list, IsTruncated is set to false. - If there are more configurations to list, IsTruncated is set to true, - and there will be a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to ListBucketAnalyticsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketAnalyticsConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketAnalyticsConfigurations service method, as returned by S3. - REST API Reference for ListBucketAnalyticsConfigurations Operation - - - - Returns a list of inventory configurations for the bucket. You can have up to 1,000 - analytics configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory - - - - The following operations are related to ListBucketInventoryConfigurations: - - - - Container for the necessary parameters to execute the ListBucketInventoryConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketInventoryConfigurations service method, as returned by S3. - REST API Reference for ListBucketInventoryConfigurations Operation - - - - Lists the metrics configurations for the bucket. The metrics configurations are only - for the request metrics of the bucket and do not provide information on daily storage - metrics. You can have up to 1,000 configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For more information about metrics configurations and CloudWatch request metrics, - see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to ListBucketMetricsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketMetricsConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketMetricsConfigurations service method, as returned by S3. - REST API Reference for ListBucketMetricsConfigurations Operation - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBuckets service method, as returned by S3. - REST API Reference for ListBuckets Operation - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - Container for the necessary parameters to execute the ListBuckets service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBuckets service method, as returned by S3. - REST API Reference for ListBuckets Operation - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Container for the necessary parameters to execute the ListMultipartUploads service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. - Limits the response to keys that begin with the specified prefix. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - Container for the necessary parameters to execute the ListObjects service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Make sure to design - your application to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - To use this operation in an AWS Identity and Access Management (IAM) policy, you must - have permissions to perform the s3:ListBucket action. The bucket owner - has this permission by default and can grant this permission to others. For more information - about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - This section describes the latest revision of the API. We recommend that you use this - revised API for application development. For backward compatibility, Amazon S3 continues - to support the prior version of this API, ListObjects. - - - - To get a list of your buckets, see ListBuckets. - - - - The following operations are related to ListObjectsV2: - - - - Container for the necessary parameters to execute the ListObjectsV2 service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjectsV2 service method, as returned by S3. - REST API Reference for ListObjectsV2 Operation - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). This request returns a maximum of 1,000 - uploaded parts. The default number of parts returned is 1,000 parts. You can restrict - the number of parts returned by specifying the max-parts request parameter. - If your multipart upload consists of more than 1,000 parts, the response returns an - IsTruncated field with the value of true, and a NextPartNumberMarker - element. In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListParts: - - - - Name of the bucket to which the parts are being uploaded. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Object key for which the multipart upload was initiated. - Upload ID identifying the multipart upload whose parts are being listed. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListParts service method, as returned by S3. - REST API Reference for ListParts Operation - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). This request returns a maximum of 1,000 - uploaded parts. The default number of parts returned is 1,000 parts. You can restrict - the number of parts returned by specifying the max-parts request parameter. - If your multipart upload consists of more than 1,000 parts, the response returns an - IsTruncated field with the value of true, and a NextPartNumberMarker - element. In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListParts: - - - - Container for the necessary parameters to execute the ListParts service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListParts service method, as returned by S3. - REST API Reference for ListParts Operation - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - Container for the necessary parameters to execute the ListVersions service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - - Creates a new bucket. To create a bucket, you must register with Amazon S3 and have - a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed - to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information on bucket naming restrictions, - see Working - with Amazon S3 Buckets. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) - Region. For more information, see How - to Select a Region for Your Buckets. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - Hosting of Buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - The name of the bucket to create. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucket service method, as returned by S3. - REST API Reference for PutBucket Operation - - - - Creates a new bucket. To create a bucket, you must register with Amazon S3 and have - a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed - to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information on bucket naming restrictions, - see Working - with Amazon S3 Buckets. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) - Region. For more information, see How - to Select a Region for Your Buckets. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - Hosting of Buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - Container for the necessary parameters to execute the PutBucket service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucket service method, as returned by S3. - REST API Reference for PutBucket Operation - - - - Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration - is a bucket-level feature that enables you to perform faster data transfers to Amazon - S3. - - - - To use this operation, you must have permission to perform the s3:PutAccelerateConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The Transfer Acceleration state of a bucket can be set to one of the following two - values: - -
  • - - Enabled – Enables accelerated data transfers to the bucket. - -
  • - - Suspended – Disables accelerated data transfers to the bucket. - -
- - The GetBucketAccelerateConfiguration operation returns the transfer acceleration - state of a bucket. - - - - After setting the Transfer Acceleration state of a bucket to Enabled, it might take - up to thirty minutes before the data transfer rates to the bucket increase. - - - - The name of the bucket used for Transfer Acceleration must be DNS-compliant and must - not contain periods ("."). - - - - For more information about transfer acceleration, see Transfer - Acceleration. - - - - The following operations are related to PutBucketAccelerateConfiguration: - - - - Container for the necessary parameters to execute the PutBucketAccelerateConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketAccelerateConfiguration service method, as returned by S3. - REST API Reference for PutBucketAccelerateConfiguration Operation - - - - - - - Set the logging parameters for a bucket and to specify permissions for who can view - and modify the logging parameters. All logs are saved to buckets in the same AWS Region - as the source bucket. To set the logging status of a bucket, you must be the bucket - owner. - - - - The bucket owner is automatically granted FULL_CONTROL to all logs. You use the Grantee - request element to grant access to other people. The Permissions request - element specifies the kind of access the grantee has to the logs. - - - - Grantee Values - - - - You can specify the person (grantee) to whom you're assigning access rights (using - request elements) in the following ways: - -
  • - - By the person's ID: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> - </Grantee> - - - - DisplayName is optional and ignored in the request. - -
  • - - By Email address: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee> - - - - - The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl - request, appears as the CanonicalUser. - -
  • - - By URI: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee> - - -
- - To enable logging, you use LoggingEnabled and its children request elements. To disable - logging, you use an empty BucketLoggingStatus request element: - - - - <BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01" /> - - - - - For more information about server access logging, see Server - Access Logging. - - - - For more information about creating a bucket, see CreateBucket. For more information - about returning the logging status of a bucket, see GetBucketLogging. - - - - The following operations are related to PutBucketLogging: - - - - Container for the necessary parameters to execute the PutBucketLogging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketLogging service method, as returned by S3. - REST API Reference for PutBucketLogging Operation - - - - Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. - You can have up to 1,000 metrics configurations per bucket. If you're updating an - existing metrics configuration, note that this is a full replacement of the existing - metrics configuration. If you don't include the elements you want to keep, they are - erased. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to PutBucketMetricsConfiguration: - - - - GetBucketLifecycle has the following special error: - -
  • - - Error code: TooManyConfigurations - -
    • - - Description: You are attempting to create a new configuration but have already reached - the 1,000-configuration limit. - -
    • - - HTTP Status Code: HTTP 400 Bad Request - -
- - Container for the necessary parameters to execute the PutBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for PutBucketMetricsConfiguration Operation - - - - Enables notifications of specified events for a bucket. For more information about - event notifications, see Configuring - Event Notifications. - - - - Using this API, you can replace an existing notification configuration. The configuration - is an XML file that defines the event types that you want Amazon S3 to publish and - the destination where you want Amazon S3 to publish an event notification when it - detects an event of the specified type. - - - - By default, your bucket has no event notifications configured. That is, the notification - configuration will be an empty NotificationConfiguration. - - - - <NotificationConfiguration> - - - - </NotificationConfiguration> - - - - This operation replaces the existing notification configuration with the configuration - you include in the request body. - - - - After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification - Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, - and that the bucket owner has permission to publish to it by sending a test notification. - In the case of AWS Lambda destinations, Amazon S3 verifies that the Lambda function - permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. - For more information, see Configuring - Notifications for Amazon S3 Events. - - - - You can disable notifications by adding the empty NotificationConfiguration element. - - - - By default, only the bucket owner can configure notifications on a bucket. However, - bucket owners can use a bucket policy to grant permission to other users to set this - configuration with s3:PutBucketNotification permission. - - - - The PUT notification is an atomic operation. For example, suppose your notification - configuration includes SNS topic, SQS queue, and Lambda function configurations. When - you send a PUT request with this configuration, Amazon S3 sends test messages to your - SNS topic. If the message fails, the entire PUT operation will fail, and Amazon S3 - will not add the configuration to your bucket. - - - - Responses - - - - If the configuration in the request body includes only one TopicConfiguration - specifying only the s3:ReducedRedundancyLostObject event type, the response - will also include the x-amz-sns-test-message-id header containing the - message ID of the test notification sent to the topic. - - - - The following operation is related to PutBucketNotificationConfiguration: - - - - Container for the necessary parameters to execute the PutBucketNotification service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketNotification service method, as returned by S3. - REST API Reference for PutBucketNotification Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - The MD5 hash of the request body. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - Container for the necessary parameters to execute the PutBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Creates a replication configuration or replaces an existing one. For more information, - see Replication - in the Amazon S3 Developer Guide. - - - - To perform this operation, the user or role performing the operation must have the - iam:PassRole - permission. - - - - Specify the replication configuration in the request body. In the replication configuration, - you provide the name of the destination bucket where you want Amazon S3 to replicate - objects, the IAM role that Amazon S3 can assume to replicate objects on your behalf, - and other relevant information. - - - - A replication configuration must include at least one rule, and can contain a maximum - of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects - in the source bucket. To choose additional subsets of objects to replicate, add a - rule for each subset. All rules must specify the same destination bucket. - - - - To specify a subset of the objects in the source bucket to apply a replication rule - to, add the Filter element as a child of the Rule element. You can filter objects - based on an object key prefix, one or more object tags, or both. When you add the - Filter element in the configuration, you must also add the following elements: DeleteMarkerReplication, - Status, and Priority. - - - - For information about enabling versioning on a bucket, see Using - Versioning. - - - - By default, a resource owner, in this case the AWS account that created the bucket, - can perform this operation. The resource owner can also grant others permissions to - perform the operation. For more information about permissions, see Specifying - Permissions in a Policy and Managing - Access Permissions to Your Amazon S3 Resources. - - - - Handling Replication of Encrypted Objects - - - - By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side - encryption with CMKs stored in AWS KMS. To replicate AWS KMS-encrypted objects, add - the following: SourceSelectionCriteria, SseKmsEncryptedObjects, - Status, EncryptionConfiguration, and ReplicaKmsKeyID. - For information about replication configuration, see Replicating - Objects Created with SSE Using CMKs stored in AWS KMS. - - - - For information on PutBucketReplication errors, see ReplicationErrorCodeList - - - - - The following operations are related to PutBucketReplication: - - - - Container for the necessary parameters to execute the PutBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketReplication service method, as returned by S3. - REST API Reference for PutBucketReplication Operation - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - The bucket name. - Container for Payer. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketRequestPayment service method, as returned by S3. - REST API Reference for PutBucketRequestPayment Operation - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - Container for the necessary parameters to execute the PutBucketRequestPayment service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketRequestPayment service method, as returned by S3. - REST API Reference for PutBucketRequestPayment Operation - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging. - - - - Within a bucket, if you add a tag that has the same key as an existing tag, the new - value overwrites the old value. For more information, see Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional operation is currently in progress against - this resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - The bucket name. - A property of PutBucketTaggingRequest used to execute the PutBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketTagging service method, as returned by S3. - REST API Reference for PutBucketTagging Operation - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging. - - - - Within a bucket, if you add a tag that has the same key as an existing tag, the new - value overwrites the old value. For more information, see Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional operation is currently in progress against - this resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - Container for the necessary parameters to execute the PutBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketTagging service method, as returned by S3. - REST API Reference for PutBucketTagging Operation - - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT operation requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - Amazon S3 has a limitation of 50 routing rules per website configuration. If you require - more than 50 routing rules, you can use object redirect. For more information, see - Configuring - an Object Redirect in the Amazon Simple Storage Service Developer Guide. - - - The bucket name. - Container for the request. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketWebsite service method, as returned by S3. - REST API Reference for PutBucketWebsite Operation - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT operation requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - Amazon S3 has a limitation of 50 routing rules per website configuration. If you require - more than 50 routing rules, you can use object redirect. For more information, see - Configuring - an Object Redirect in the Amazon Simple Storage Service Developer Guide. - - - Container for the necessary parameters to execute the PutBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketWebsite service method, as returned by S3. - REST API Reference for PutBucketWebsite Operation - - - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - The name of the bucket for which to set the configuration. - A property of PutLifecycleConfigurationRequest used to execute the PutLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutLifecycleConfiguration service method, as returned by S3. - REST API Reference for PutLifecycleConfiguration Operation - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - Container for the necessary parameters to execute the PutLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutLifecycleConfiguration service method, as returned by S3. - REST API Reference for PutLifecycleConfiguration Operation - - - - - - - - - - - - - - - - - Configuration for accessing AmazonS3 service - - - Configuration for accessing Amazon S3 service - - - - - When true, requests will always use path style addressing. - - - - - Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. - To use this feature, the bucket name should be DNS compliant names and should not contain periods (.). - The following APIs are not supported and are sent to the regular region endpoint, even if this option is enabled: -
    -
  1. PutBucket
    2. -
  2. ListBuckets
    3. -
  3. DeleteBucket
    4. -
- - - This option cannot be used at the same time as UseDualstackEndpoint. - - - - - If set to true and the service package supports it the region identified in the arn for a resource - will be used when making the service request. - - - - - USEast1RegionalEndpointValue determines wheter or not - to send the us-east-1 s3 requests to the regional endpoint or to - the legacy global endpoint. - This flags takes precedence over the AWS_S3_US_EAST_1_REGIONAL_ENDPOINT - environment variable and the credential file. - - - - - This method contains custom initializations for the config object. - - - - - Given this client configuration, returns the service url - - The service url in the form of a string - - - - If the client is configured to hit us-east-1 with the S3UsEast1RegionalEndpointValue flag not set, - this method checks whether the environment variable is present or the credential file contains a valid value - - A Nullable of S3UsEast1RegionalEndpointValue representing the client configuration for the regional us-east-1 endpoint - - - - Validate that the config object is properly configured. - - - - - Checks the AWS_S3_US_EAST_1_REGIONAL_ENDPOINT environment variable for the presence of the s3 regional flag - - A nullable of S3UsEast1RegionalEndpointValue - - - - Checks the credential file for the presence of the s3 regional flag - - A nullable of S3UsEast1RegionalEndpointValue - - - - Default constructor - - - - - The constant used to lookup in the region hash the endpoint. - - - - - Gets the ServiceVersion property. - - - - - Gets the value of UserAgent property. - - - - - Base exception for S3 errors. - - - - - Construct an instance of AmazonS3Exception - - - - - - Construct an instance of AmazonS3Exception - - - - - - - Construct an instance of AmazonS3Exception - - - - - - Construct an instance of AmazonS3Exception - - - - - - - - - - Construct an instance of AmazonS3Exception - - - - - - - - - - - Construct an instance of AmazonS3Exception - - - - - - - - - - - - Construct an instance of AmazonS3Exception - - - - - - - - - - - - - A special token that helps AWS troubleshoot problems. - - - - - A special token that helps AWS troubleshoot S3 accelerate problems. - - - - - The entire response body for this exception, if available. - - - - - The region that the AmazonS3Exception relates to. - - - - - Gets the exception message. - - - - - Extensions methods added to Amazon.Arn type to help parse S3 specific resources from the ARN. - - - - - Attempt to parse the resource component of the ARN into access point resource name. - - An AWS ARN to parse - The access point resouce identifier found in the ARN. - True if the ARN contains an access point resource identifier. - - - - Attempt to parse the resource component of the ARN into bucket name. - - An AWS ARN to parse - The bucket name found in the ARN. - True if the ARN contains a bucket name. - - - - Custom pipeline handler to clean up streams in case of an exception. - - - - - Catch exceptions and clean up any open streams. - - - - - - Catch exceptions and clean up any open streams. - - - - - - - Custom pipeline handler to enable sig V4 for Get requests. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Custom pipeline handler to enable sig V4 for Get requests. - - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Calls the post invoke logic after calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls the and post invoke logic after calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Constructor for AmazonS3RetryPolicy. - - The IClientConfig object - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - - - a value if it can be determined, or null if the IO-bound calculations need to be done - - - - Return true if the request should be retried. Implements additional checks - specific to S3 on top of the checks in DefaultRetryPolicy. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Constructor for AmazonS3StandardRetryPolicy. - - The IClientConfig object - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - - - a value if it can be determined, or null if the IO-bound calculations need to be done - - - - Return true if the request should be retried. Implements additional checks - specific to S3 on top of the checks in StandardRetryPolicy. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Constructor for AmazonS3AdaptiveRetryPolicy. - - The IClientConfig object - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - - - a value if it can be determined, or null if the IO-bound calculations need to be done - - - - Return true if the request should be retried. Implements additional checks - specific to S3 on top of the checks in AdaptiveRetryPolicy. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Marker interface to identify AmazonS3EncryptionClient. - - - - - Service metadata for Amazon S3 service - - - - - Gets the value of the Service Id. - - - - - Gets the dictionary that gives mapping of renamed operations - - - - - The parameters to request an abort of a multipart upload. - - - After a multipart upload is aborted, no additional parts can be uploaded using that upload ID. - The storage consumed by any previously uploaded parts will be freed. However, if any part uploads - are currently in progress, those part uploads might or might not succeed. As a result, it might be - necessary to abort a given multipart upload multiple times in order to completely free all storage - consumed by all parts. - - - - - The bucket name to which the upload was taking place. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The key of the S3 object that was being uploaded. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - The upload id for the in-progress multipart upload that should be aborted. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the AbortMultipartUpload response metadata. - The AbortMultipartUpload operation has a void result type. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Bucket accelerate configuration. - - - - - The accelerate status of the bucket. - - - - - AccessControlTranslation class - - - - - The override value for the owner of the replica object. - - - - - Class for AnalyticsAndOperator - A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. - The operator must have at least two predicates, and an object must match all of the predicates - in order for the filter to apply. - - Note: The current implementation restricts the usage to atmost one AnalyticsPrefixPredicate - and any number of AnalyticsTagPredicates. - - - - Class for AnalyticsConfiguration - - - - - The identifier used to represent an analytics configuration. - - - - - The filter used to describe a set of objects for analyses. - A filter must have exactly one prefix, one tag, or one conjunction (AnalyticsAndOperator). - If no filter is provided, all objects will be considered in any analysis. - - - - - If present, it indicates that data related to access patterns will be collected - and made available to analyze the tradeoffs between different storage classes. - - - - - Class for AnalyticsExportDestination - - - - - A destination signifying output to an S3 bucket. - - - - - Filter class for Metrics. - - - - - Filter Predicate setup for specific filter types. - - - - - Filter Predicate abstract class for specific filter types to be derived from. - - - - - Abstract class that can be used over logical filter predicates,i.e. AND/OR. - - - - - Internal implementation of Metrics Predicate visitor interface. - - - - - Interface for implementing visitor pattern in Analytics Predicate Filter. - - - - - Interface for implementing visitor pattern in Inventory Predicate Filter. - - - - - Interface for implementing visitor pattern in Metrics Predicate Filter. - - - - - Defines the interface that is used to visit all the different - implementations of - - - - - Visit a - - - - - - Visit a - - - - - - Visit a - - - - - - Implementation of to marshall . - - - - - AbortIncompleteMultipartUpload Unmarshaller - - - - - Abort Multipart Upload Request Marshaller - - - - - Response Unmarshaller for AbortMultipartUpload operation - - - - - AnalyticsConfiguration Unmarshaller - - - - - AnalyticsExportDestinationUnmarshaller - - - - - AnalyticsFilter Unmarshaller - - - - - AnalyticsS3BucketDestination Unmarshaller - - - - - Bucket Unmarshaller - - - - - CommonPrefixesItem Unmarshaller - - - - - Complete Multipart Upload Request Marshaller - - - - - Response Unmarshaller for CompleteMultipartUpload operation - - - - - ContentsItem Unmarshaller - - - - - Copy Object Request Marshaller - - - - - Response Unmarshaller for CopyObject operation - - - - - Upload Part Copy Request Marshaller - - - - - Response Unmarshaller for CopyPart operation - - - - - CORSRule Unmarshaller - - - - - Response Unmarshaller for DefaultRetention Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Delete InventoryConfiguration Request Marshaller - - - - - Response Unmarshaller for DeleteAnalyticsConfiguration operation - - - - - Response Unmarshaller for DeleteCORSConfiguration operation - - - - - Delete InventoryConfiguration Request Marshaller - - - - - Response Unmarshaller for DeleteInventoryConfiguration operation - - - - - Delete Bucket MetricsConfiguration Request Marshaller - - - - - Response Unmarshaller for DeleteBucketMetricsConfiguration operation - - - - - Delete Bucket Policy Request Marshaller - - - - - Response Unmarshaller for DeleteBucketPolicy operation - - - - - Delete Bucket Request Marshaller - - - - - Response Unmarshaller for DeleteBucket operation - - - - - Delete Bucket Tagging Request Marshaller - - - - - Response Unmarshaller for DeleteBucketTagging operation - - - - - Delete Bucket Website Request Marshaller - - - - - Response Unmarshaller for DeleteBucketWebsite operation - - - - - Delete Bucket Cors Request Marshaller - - - - - DeletedObject Unmarshaller - - - - - Delete Bucket Lifecycle Request Marshaller - - - - - Response Unmarshaller for DeleteBucketLifecycle operation - - - - - Delete Object Request Marshaller - - - - - Response Unmarshaller for DeleteObject operation - - - - - Delete Objects Request Marshaller - - - - - Response Unmarshaller for DeleteObjects operation - - - - - DeleteObjectTaggingRequest Marshaller - - - - - Marshall DeleteObjectTaggingRequest object into an http request. - - - - - Marshall DeleteObjectTaggingRequest object into an http request. - - - - - Response Unmarshaller for DeleteObjectTagging operation - - - - - DeletePublicAccessBlock Request Marshaller - - - - - Response Unmarshaller for DeletePublicAccessBlock operation - - - - - ErrorsItem Unmarshaller - - - - - Expiration Unmarshaller - - - - - FilterRule Unmarshaller - - - - - Filter Unmarshaller - - - - - Get Object Acl Request Marshaller - - - - - Response Unmarshaller for GetACL operation - - - - - Get Object Accelerate Configuration Request Marshaller - - - - - Response Unmarshaller for GetACL operation - - - - - Get BucketAnalyticsConfiguration Request Marshaller - - - - - Response Unmarshaller for GetAnalyticsConfiguration operation - - - - - Get InventoryConfiguration Request Marshaller - - - - - Response Unmarshaller for GetInventoryConfiguration operation - - - - - Get Bucket Location Request Marshaller - - - - - Response Unmarshaller for GetBucketLocation operation - - - - - Get Bucket Logging Request Marshaller - - - - - Response Unmarshaller for GetBucketLogging operation - - - - - Get Bucket MetricsConfigurationRequest Marshaller - - - - - Response Unmarshaller for GetBucketMetricsConfiguration operation - - - - - Get Bucket Notification Request Marshaller - - - - - Response Unmarshaller for GetBucketNotification operation - - - - - Get BucketName Policy Request Marshaller - - - - - Response Unmarshaller for GetBucketPolicy operation - - - - - GetBucketPolicyStatusRequestMarshaller - - - - - Response Unmarshaller for GetBucketPolicyStatus operation - - - - - Get Bucket Request Payment Request Marshaller - - - - - Response Unmarshaller for GetBucketRequestPayment operation - - - - - Get Bucket Tagging Request Marshaller - - - - - Response Unmarshaller for GetBucketTagging operation - - - - - Get Bucket Versioning Request Marshaller - - - - - Response Unmarshaller for GetBucketVersioning operation - - - - - Get Bucket Website Request Marshaller - - - - - Response Unmarshaller for GetBucketWebsite operation - - - - - Get Bucket Cors Request Marshaller - - - - - Response Unmarshaller for GetCORSConfiguration operation - - - - - Get Bucket Lifecycle Request Marshaller - - - - - Response Unmarshaller for GetLifecycleConfiguration operation - - - - - GetObjectLegalHold Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for GetObjectLegalHold operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - GetObjectLockConfiguration Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for GetObjectLockConfiguration operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - GetObjectMetadata Marshaller - - - - - Response Unmarshaller for GetObjectMetadata operation - - - - - Get Object Request Marshaller - - - - - Response Unmarshaller for GetObject operation - - - - - GetObjectRetention Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for GetObjectRetention operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - GetObjectTaggingRequest Marshaller - - - - - Marshall GetObjectTaggingRequest into an http request. - - - - - Marshall GetObjectTaggingRequest into an http request. - - - - - Response Unmarshaller for GetObjectTagging operation - - - - - Get Object Torrent Request Marshaller - - - - - Response Unmarshaller for GetObjectTorrent operation - - - - - GetPublicAccessBlockRequestMarshaller - - - - - Response Unmarshaller for GetPublicAccessBlock operation - - - - - Grantee Unmarshaller - - - - - Grant Unmarshaller - - - - - Head Bucket Request Marshaller - - - - - Response Unmarshaller for HeadBucket operation - - - - - Create Multipart Upload Request Marshaller - - - - - Response Unmarshaller for InitiateMultipartUpload operation - - - - - Initiator Unmarshaller - - - - - InventoryConfiguration Unmarshaller - - - - - InventoryDestination Unmarshaller - - - - - InventoryEncryption Unmarshaller - - - - - InventoryFilter Unmarshaller - - - - - InventoryS3BucketDestination Unmarshaller - - - - - InventorySchedule Unmarshaller - - - - - LifecycleFilterPredicate Unmarshaller - - - - - LifecycleRuleNoncurrentVersionExpiration Unmarshaller - - - - - LifecycleRuleNoncurrentVersionTransition Unmarshaller - - - - - List AnalyticsConfiguration Request Marshaller - - - - - Response Unmarshaller for ListAnalyticsConfiguration operation - - - - - List InventoryConfiguration Request Marshaller - - - - - Response Unmarshaller for ListInventoryConfiguration operation - - - - - List Bucket MetricsConfigurationRequest Marshaller - - - - - Response Unmarshaller for ListBucketMetricsConfiguration operation - - - - - List Buckets Request Marshaller - - - - - Response Unmarshaller for ListBuckets operation - - - - - List Multipart Uploads Request Marshaller - - - - - Response Unmarshaller for ListMultipartUploads operation - - - - - List Objects Request Marshaller - - - - - Response Unmarshaller for ListObjects operation - - - - - List Objects Request Marshaller - - - - - Response Unmarshaller for ListObjects operation - - - - - List Parts Request Marshaller - - - - - Response Unmarshaller for ListParts operation - - - - - List Object Versions Request Marshaller - - - - - Response Unmarshaller for ListVersions operation - - - - - LoggingEnabled Unmarshaller - - - - - MetricsConfiguration Unmarshaller - - - - - MetricsFilte Unmarshaller - - - - - UploadsItem Unmarshaller - - - - - Response Unmarshaller for ObjectLockConfiguration Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Response Unmarshaller for ObjectLockLegalHold Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Response Unmarshaller for ObjectLockRetention Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Response Unmarshaller for ObjectLockRule Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Owner Unmarshaller - - - - - PartsItem Unmarshaller - - - - - PolicyStatus Unmarshaller - - - - - PublicAccessBlockConfiguration Unmarshaller - - - - - Put Object Acl Request Marshaller - - - - - Response Unmarshaller for PutObjectAcl operation - - - - - Put Object Acl Request Marshaller - - - - - Response Unmarshaller for PutBucketAccelerate operation - - - - - Request Marshaller for PutAnalyticsConfiguration operation - - - - - Response Unmarshaller for PutBucketAnalytics operation - - - - - Request Marshaller for PutInventoryConfiguration operation - - - - - Response Unmarshaller for PutBucketWebsite operation - - - - - Enable Bucket Logging Request Marshaller - - - - - Response Unmarshaller for PutBucketLogging operation - - - - - Put Bucket MetricsConfigurationRequest Marshaller - - - - - Response Unmarshaller for PutBucketMetricsConfiguration operation - - - - - Put Bucket Notification Request Marshaller - - - - - Response Unmarshaller for PutBucketNotification operation - - - - - Put Bucket Policy Request Marshaller - - - - - Response Unmarshaller for PutBucketPolicy operation - - - - - Put Buckeyt Replication Request Marshaller - - - - - Response Unmarshaller for PutBucketReplication operation. - - - - - Put Bucket Request Marshaller - - - - - Put Bucket Request Payment Request Marshaller - - - - - Response Unmarshaller for PutBucketRequestPayment operation - - - - - Response Unmarshaller for PutBucket operation - - - - - Put Bucket Tagging Request Marshaller - - - - - Response Unmarshaller for PutBucketTagging operation - - - - - Put Bucket Versioning Request Marshaller - - - - - Response Unmarshaller for PutBucketVersioning operation - - - - - Put Bucket Website Request Marshaller - - - - - Response Unmarshaller for PutBucketWebsite operation - - - - - Put Bucket Cors Request Marshaller - - - - - Response Unmarshaller for PutCORSConfiguration operation - - - - - Put Bucket Lifecycle Request Marshaller - - - - - Response Unmarshaller for PutLifecycleConfiguration operation - - - - - PutObjectLegalHold Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for PutObjectLegalHold operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - PutObjectLockConfiguration Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for PutObjectLockConfiguration operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Put Object Request Marshaller - - - - - Response Unmarshaller for PutObject operation - - - - - PutObjectRetention Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for PutObjectRetention operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Delete Object Tagging Request Marshaller - - - - - Marshall PutObjectTaggingRequest into an http request. - - - - - Marshall PutObjectTaggingRequest into an http request. - - - - - Response Unmarshaller for DeleteObjectTagging operation - - - - - PutPublicAccessBlock Request Marshaller - - - - - Response Unmarshaller for PutPublicAccessBlock operation - - - - - Restore Object Request Marshaller - - - - - Response Unmarshaller for RestoreObject operation - - - - - Condition Unmarshaller - - - - - Redirect Unmarshaller - - - - - RoutingRule Unmarshaller - - - - - RulesItem Unmarshaller - - - - - Response Unmarshaller for all Errors - - - - - Build an S3ErrorResponse from XML - - The XML parsing context. - Usually an Amazon.Runtime.Internal.UnmarshallerContext. - An S3ErrorResponse object. - - - - Grant Unmarshaller - - - - - Class for unmarshalling S3 service responses - - - - - Specialized S3 unmarshaller context. - - - - - Wrap an XmlTextReader with state for event-based parsing of an XML stream. - - Stream with the XML from a service response. - If set to true, maintains a copy of the complete response body as the stream is being read. - Response data coming back from the request - If set to is true, configure unmarshaller with exception specifics. - - - - Reads to the next node in the XML document, and updates the context accordingly. - If node is RequestId, reads the contents and stores in RequestId property. - - - True if a node was read, false if there are no more elements to read./ - - - - - SSEKMS Unmarshaller - - - - - StorageClassAnalysisDataExportDataExportUnmarshaller - - - - - StorageClassAnalysisUnmarshaller - - - - - Tag Unmarshaller - - - - - TopicConfiguration Unmarshaller - - - - - Transition Unmarshaller - - - - - Upload Part Request Marshaller - - - - - Response Unmarshaller for UploadPart operation - - - - - VersionsItem Unmarshaller - - - - - Internal implementation of Inventory Predicate visitor interface. - - - - - Internal implementation of Metrics Predicate visitor interface. - - - - - Class for AnalyticsPrefixPredicate - The prefix used when evaluating a metrics filter. - - - - - Class for AnalyticsS3BucketDestination - - - - - The file format used when exporting data to Amazon S3. - - - - - The account ID that owns the destination bucket. If no account ID is provided, the owner will not be validated prior to exporting data. - - - - - The Amazon resource name (ARN) of the bucket to which data is exported. - - - - - The prefix to use when exporting data. The exported data begins with this prefix. - - - - - Class for MetricsTagPredicate - The tag used when evaluating a metrics filter. - - - - - This class represents the byte range for a range GET from S3. - - - - - Constructs a ByteRange and sets the start and end. - - - - - - - Constructs a ByteRange and sets the header to the value specified. - - - - - - A private string, represending the byte range. - - - - - The starting byte number of the range - - - - - The ending byte number of the range - - - - - The formatted string representing the byte range to be set for the range header. - - - - - Container for the parameters to the CompleteMultipartUpload operation. - Completes a multipart upload by assembling previously uploaded parts. - - - - - The name of the bucketName containing the S3 object that was being uploaded in parts. - - - - - The key of the S3 object that was being uploaded. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - A collection of part numbers and corresponding etags. - - - - - Adds a collection of part numbers and corresponding etags. - - PartETags that will added to this request. - - - - Adds a collection of part numbers and corresponding etags. - - PartETags that will added to this request. - - - - Adds a collection of part numbers and corresponding etags by transforming the UploadPartResponses into PartETags. - - The list of response objects return from UploadParts. - - - - Adds a collection of part numbers and corresponding etags by transforming the UploadPartResponses into PartETags. - - The list of response objects return from UploadParts. - - - - Adds a collection of part numbers and corresponding etags by transforming the CopyPartResponse into PartETags. - - The list of response objects return from CopyParts. - - - - Adds a collection of part numbers and corresponding etags by transforming the CopyPartResponse into PartETags. - - The list of response objects return from CopyParts. - - - - The upload id for the in-progress multipart upload that should be completed. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the CompleteMultipartUpload response and response metadata. - - - - - Gets and sets the URI that identifies the newly created object. - - - - - Gets and sets the name of the bucketName that contains the newly created object. - - - - - Gets and sets the object key of the newly created object. - - - - - Gets and sets Entity tag that identifies the newly created object's data. Objects with different - object data will have different entity tags. The entity tag is an opaque string. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - Gets and sets the ServerSideEncryptionMethod property. - Specifies the encryption used on the server to - store the content. - Default is None. - - - - - Gets and sets the VersionId property. - This is the version-id of the S3 object - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the CopyObject operation. - Creates a copy of an object that is already stored in Amazon S3. - - - - - The name of the bucket containing the object to copy. - - - - - Checks if SourceBucket property is set. - - true if SourceBucket property is set. - - - - The key of the object to copy. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Checks if SourceKey property is set. - - true if SourceKey property is set. - - - - Specifies a particular version of the source object to copy. By default the latest version is copied. - - - - - Checks if SourceVersionId property is set. - - true if SourceVersionId property is set. - - - - The name of the bucket to contain the copy of the source object. - - - - - Checks if DestinationBucket property is set. - - true if DestinationBucket property is set. - - - - The key to be given to the copy of the source object. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Checks if DestinationKey property is set. - - true if DestinationKey property is set. - - - - A canned access control list (CACL) to apply to the object. - Please refer to for - information on S3 Canned ACLs. - - - - - ETag to be matched as a pre-condition for copying the source object - otherwise returns a PreconditionFailed. - - - Copies the object if its entity tag (ETag) matches - the specified tag; otherwise return a 412 (precondition failed). - Constraints: This property can be used with IfUnmodifiedSince, - but cannot be used with other conditional copy properties. - - - - - Checks if ETagToMatch property is set. - - - Copies the object if its entity tag (ETag) is different - than the specified Etag; otherwise returns a 412 (failed condition). - Constraints: This header can be used with IfModifiedSince, but cannot - be used with other conditional copy properties. - - true if ETagToMatch property is set. - - - - ETag that must not be matched as a pre-condition for copying the source object, - otherwise returns a PreconditionFailed. - - - - - Checks if ETagToNotMatch property is set. - - true if ETagToNotMatch property is set. - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or - ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Copies the object if it has been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it has been modified since the - specified time; otherwise returns a 412 (failed condition). - Constraints: This property can be used with ETagToNotMatch, - but cannot be used with other conditional copy properties. - - - - - Copies the object if it has been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it has been modified since the - specified time; otherwise returns a 412 (failed condition). - Constraints: This property can be used with ETagToNotMatch, - but cannot be used with other conditional copy properties. - - - - - Checks if ModifiedSinceDateUtc property is set. - - true if ModifiedSinceDateUtc property is set. - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or - UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Copies the object if it has not been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it hasn't been modified since the - specified time; otherwise returns a 412 (precondition failed). - Constraints: This property can be used with ETagToMatch, - but cannot be used with other conditional copy properties. - - - - - Copies the object if it has not been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it hasn't been modified since the - specified time; otherwise returns a 412 (precondition failed). - Constraints: This property can be used with ETagToMatch, - but cannot be used with other conditional copy properties. - - - - - Checks if UnmodifiedSinceDateUtc property is set. - - true if UnmodifiedSinceDateUtc property is set. - - - - Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request. - - - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - Specifies whether you want to apply a Legal Hold to the copied object. - - - - - - Gets and sets the property ObjectLockMode. - - The Object Lock mode that you want to apply to the copied object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - The date and time when you want the copied object's Object Lock to expire. - - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - Checks if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - true if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - - - The type of storage to use for the object. Defaults to 'STANDARD'. - - - - - - If the bucketName is configured as a website, redirects requests for this object to another object in the same bucketName or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - This is a convenience property for Headers.ContentType. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - /// - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The customer provided encryption key for the source object of the copy. - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - true if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the CopySourceServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if CopySourceServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - The tag-set for the object destination object this value must be used in conjunction with the TaggingDirective. The tag-set must be encoded as URL Query parameters. - - - - - Checks if Tagging property is set - - true if Tagging is set. - - - - Returns information about the CopyObject response and response metadata. - - - - - Gets and sets the ETag property. - - - - - Gets and sets the LastModified property. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - Gets and sets the SourceVersionId property. - This is the Version Id of the Source Object - - - - - Version ID of the newly created copy. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the CopyPart operation. - Uploads a part by copying data from an existing object as data source. - - - - - The name of the bucket containing the object to copy. - - - - - Checks if SourceBucket property is set. - - true if SourceBucket property is set. - - - - The key of the object to copy. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Checks if SourceKey property is set. - - true if SourceKey property is set. - - - - Specifies a particular version of the source object to copy. By default the latest version is copied. - - - - - Checks if SourceVersionId property is set. - - true if SourceVersionId property is set. - - - - The name of the bucket to contain the copy of the source object. - - - - - Checks if DestinationBucket property is set. - - true if DestinationBucket property is set. - - - - The key to be given to the copy of the source object. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Checks if DestinationKey property is set. - - true if DestinationKey property is set. - - - - The ID identifying multipart upload for which we are copying a part. - - - - - Checks if UploadId property is set. - - true if UploadId property is set. - - - - Collection of ETags to be matched as a pre-condition for copying the source object - otherwise returns a PreconditionFailed. - - - Copies the object if its entity tag (ETag) matches one of - the specified tags; otherwise return a 412 (precondition failed). - Constraints: This property can be used with IfUnmodifiedSince, - but cannot be used with other conditional copy properties. - - - - - Checks if ETagsToMatch property is set. - - true if ETagToMatch property is set. - - - - Collection of ETags that must not be matched as a pre-condition for copying the source object - otherwise returns a PreconditionFailed. - - - Copies the object if its entity tag (ETag) does not match any of the specified - tags; otherwise returns a 412 (failed condition). - Constraints: This header can be used with IfModifiedSince, but cannot - be used with other conditional copy properties. - - - - - Checks if ETagToNotMatch property is set. - - true if ETagToNotMatch property is set. - - - - Copies the object if it has been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it has been modified since the - specified time; otherwise returns a 412 (failed condition). - Constraints: This property can be used with ETagToNotMatch, - but cannot be used with other conditional copy properties. - - - - - Checks if ModifiedSinceDate property is set. - - true if ModifiedSinceDate property is set. - - - - Copies the object if it has not been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it hasn't been modified since the - specified time; otherwise returns a 412 (precondition failed). - Constraints: This property can be used with ETagToMatch, - but cannot be used with other conditional copy properties. - - - - - Checks if UnmodifiedSinceDate property is set. - - true if UnmodifiedSinceDate property is set. - - - - The number of the part to be copied. - - - Valid part numbers are from 1 to 10,000 inclusive and will uniquely identify the part - and determine the relative ordering within the destination object. If a part already - exists with the PartNumber it will be overwritten. - - - - - Checks if PartNumber property is set. - - true if PartNumber property is set. - - - - The location of the first byte in the range if only a portion of the - source object is to be copied as the part. - - - The LastByte property must also be set or this value will be ignored. - - - - - Checks if FirstByte property is set. - - true if FirstByte property is set. - - - - The location of the last byte in the range if only a portion of the - source object is to be copied as the part. - - - The FirstByte property must also be set or this value will be ignored. - - - - - Checks if LastByte property is set. - - true if LastByte property is set. - - - - - This property is obsolete. Use ServerSideEncryptionMethod in InitiateMultipartUploadRequest instead. - - - Default: None - - - - - - Checks if ServerSideEncryptionMethod property is set. - - true if ServerSideEncryptionMethod property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - This property is obsolete. Use ServerSideEncryptionKeyManagementServiceKeyId in InitiateMultipartUploadRequest instead. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The customer provided encryption key for the source object of the copy. - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - true if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the CopySourceServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if CopySourceServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - - - Returns information about the CopyPart response and response metadata. - - - - - The version of the source object that was copied, if you have enabled versioning on the source bucketName. - - - - - - Entity tag of the object. - - - - - - Date and time at which the object was uploaded. - - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - Gets and sets the PartNumber property. - This is the part number in it's multi-part upload that will uniquely identify the part - and determine the relative ordering within the destination object. - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - A collection of up to 100 cross-origin resource sharing (CORS) rules. - - - - - The collection of rules in this configuration. - - - - C O R S Rule - - - - - Identifies HTTP methods that the domain/origin specified in the rule is allowed to execute. - - - - - - One or more origins you want customers to be able to access the bucket from. - - - - - - An optional unique identifier for the rule. - - - The ID value can be up to 255 characters long. The IDs help you find a rule in the configuration. - - - - - Checks if Id property is set. - - true if Id property is set. - - - - One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript - XMLHttpRequest object). - - - - - - The time in seconds that your browser is to cache the preflight response for the specified resource. - - - - - - Specifies which headers are allowed in a pre-flight OPTIONS request through the - Access-Control-Request-Headers header. - - - Each header name specified in the Access-Control-Request-Headers must have a corresponding - entry in the rule. Only the headers that were requested will be sent back. - This element can contain at most one * wildcard character. - - - - - Checks if AllowedHeaders property is set. - - true if AllowedHeaders property is set. - - - - Describes how a CSV-formatted input object is formatted. - - - - - Describes the first line of input. Valid values: None, Ignore, Use. - - - - - Single character used to indicate a row should be ignored when present at the start of a row. - - - - - Single character used for escaping the quote character inside an already escaped value. - - - - - Value used to separate individual records. - - - - - Value used to separate individual fields in a record. - - - - - Value used for escaping where the field delimiter is part of the value. - - - - - Specifies that CSV field values may contain quoted record delimiters and such records should be allowed. Default value is FALSE. Setting this value to TRUE may lower performance. - - - - - Describes how CSV-formatted results are formatted. - - - - - Indicates whether or not all output fields should be quoted. - - - - - Single character used for escaping the quote character inside an already escaped value. - - - - - Value used to separate individual records. - - - - - Value used to separate individual fields in a record. - - - - - Value used for escaping where the field delimiter is part of the value. - - - - - The container element for specifying the default Object Lock retention settings for - new objects placed in the specified bucket. - - - - - Gets and sets the property Days. - - The number of days that you want to specify for the default retention period. - - - - - - Gets and sets the property Mode. - - The default Object Lock retention mode you want to apply to new objects placed in - the specified bucket. - - - - - - Gets and sets the property Years. - - The number of years that you want to specify for the default retention period. - - - - - - Container for the parameters to the DeleteBucketAnalyticsConfiguration operation. - Deletes an analytics configuration for the bucket (specified by the analytics configuration ID). - - - - - The name of the bucket from which an analytics configuration is deleted. - - - - - The identifier used to represent an analytics configuration. - - - - - Returns information about the DeleteBucketAnalyticsConfiguration response metadata. - The DeleteBucketAnalyticsConfiguration operation has a void result type. - - - - - Request object for the DeleteBucketEncryption operation. - Request Deletes the server-side encryption configuration from the bucket. - - - - - The name of the bucket containing the server-side encryption configuration to delete. - - - - - Returns information about the DeleteBucketEncryption response metadata. - The DeleteBucketEncryption operation has a void result type. - - - - - Container for the parameters to the DeleteInventoryConfiguration operation. - Deletes an inventory configuration (identified by the inventory ID) from the bucket. - - - - - The name of the bucket containing the inventory configuration to delete. - - - - - The ID used to identify the inventory configuration. - - - - - Returns information about the DeleteInventoryConfiguration response metadata. - The DeleteInventoryConfiguration operation has a void result type. - - - - - Container for the parameters to the DeleteBucketMetricsConfiguration operation. - Deletes a metrics configuration (specified by the metrics configuration ID) from the bucket. - - - - - The name of the bucket on which Inventory configuration is to be removed. - - - - - The ID used to identify the metrics configuration. - - - - - Returns information about the DeleteBucketMetricsConfiguration response metadata. - The DeleteBucketMetricsConfiguration operation has a void result type. - - - - - Container for the parameters to the DeleteBucketPolicy operation. - Deletes the policy from the bucket. - - - - - The bucket on which the policy is to be deleted. - - - - - Returns information about the DeleteBucketPolicy response metadata. - The DeleteBucketPolicy operation has a void result type. - - - - - Request object for the DeleteBucketReplication operation. - - - - - Gets and sets the property BucketName. -

Deletes the replication subresource associated with the specified - bucket.

There is usually some time lag before - replication configuration deletion is fully propagated to all the - Amazon S3 systems.

For more information, see - - Cross-Region Replication (CRR) in the Amazon S3 Developer - Guide.

- - - - - Returns information about the DeleteBucketReplication response metadata. - The DeleteBucketReplication operation has a void result type. - - - - - Container for the parameters to the DeleteBucket operation. - Deletes the bucket. All objects (including all object versions and Delete Markers) in the bucket must be deleted before the bucket - itself can be deleted. - - - - - The name of the bucket to be created. - - - - - The region locality for the bucket. - - - When set, this will determine the region the bucket exists in. - Refer - for a list of possible values. - - - - - If set to true the bucket will be deleted in the same region as the configuration of the AmazonS3 client. - DeleteBucketRequest.BucketRegion takes precedence over this property if both are set. - Default: true. - - - - - Returns information about the DeleteBucket response metadata. - The DeleteBucket operation has a void result type. - - - - - The parameters to request deletion of a tag set from a bucket. - - - To use this operation, you must have permission to perform the s3:PutBucketTagging action. - By default, the bucket owner has this permission and can grant this permission to others. - - - - - The name of the bucket on which the tag set is to be removed. - - - - - Returns information about the DeleteBucketTagging response metadata. - The DeleteBucketTagging operation has a void result type. - - - - - Container for the parameters to the DeleteBucketWebsite operation. - This operation removes the website configuration from the bucket. - - - - - The name of the bucket on which website configuration is to be removed. - - - - - Returns information about the DeleteBucketWebsite response metadata. - The DeleteBucketWebsite operation has a void result type. - - - - - Container for the parameters to the DeleteCORSConfiguration operation. - Deletes the cors configuration information set for the bucket. - - - - - Gets and sets the BucketName property. - - - - - Returns information about the DeleteCORSConfiguration response metadata. - The DeleteCORSConfiguration operation has a void result type. - - - - - Contains information about a successful delete operation against a specific S3 object. - - - - - Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a - delete marker. In a simple DELETE, this header indicates whether (true) or not (false) a delete - marker was created. - - - - - The version ID of the delete marker created as a result of the DELETE operation. If you delete a - specific object version, the value returned by this header is the version ID of the object version - deleted. - - - - - The key of the deleted S3 object. - - - - - The version of the deleted S3 object. - - - - - Contains information about a failed delete operation against a specific S3 object. - - - - - The key of the S3 object. - - - - - The version of the S3 object. - - - - - The failure code for the delete error. - - - - - The failure message for the delete error. - - - - - The parameters to request deletion of the lifecycle configuration on a bucket. - - - - Amazon S3 removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. - Your objects never expire, and Amazon S3 no longer automatically deletes any objects on the basis of rules contained - in the deleted lifecycle configuration. - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration action. By default, the - bucket owner has this permission and the bucket owner can grant this permission to others. - - - There is usually some time lag before lifecycle configuration deletion is fully propagated to all the Amazon S3 systems. - - - - - - The name of the bucket on which the lifecycle configuration is to be deleted. - - - - - Returns information about the DeleteLifecycleConfiguration response metadata. - The DeleteLifecycleConfiguration operation has a void result type. - - - - -

Specifies whether Amazon S3 should replicate delete makers.

- - - - - Gets and sets the property Status. -

The status of the delete marker replication.

-

In the current implementation, Amazon S3 does not replicate - the delete markers. Therefore, the status must be - Disabled.

- - - - - The parameters to request deletion of an object in a bucket. - The operation removes the null version (if there is one) of an object and inserts a delete marker, which - becomes the latest version of the object. - - - - To remove a specific version, you must be the bucket owner and you must use the versionId subresource. - Using this subresource permanently deletes the version. - - - If the object you want to delete is in a bucket where the bucket versioning configuration is MFA Delete enabled, - you must include specify the MFA serial number and value in the request. - - - If there isn't a null version, Amazon S3 does not remove any objects. - - - - - - The bucket name of the bucket containing the object. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property BypassGovernanceRetention. - - - - - The key identifying the object to delete. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - The identifier for the specific version of the object to be deleted, if required. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - The MfaCodes Tuple associates the Serial Number and the current Token/Code displayed on the - Multi-Factor Authentication device associated with your AWS Account. - - - This is a required property for this request if:
- 1. EnableMfaDelete was configured on the bucket - containing this object's version.
- 2. You are deleting an object's version - - - - - Checks if the MfaCodes property is set. - - true if the MfaCodes property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the DeleteObject response and response metadata. - - - - - Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a delete marker. - - - - - - Returns the version ID of the delete marker created as a result of the DELETE operation. - - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the DeleteObjects operation. - This operation enables you to delete multiple objects from a bucket using a single HTTP request. You may specify up to 1000 - keys. - - - Container for the parameters to the DeleteObjects operation. - This operation enables you to delete multiple objects from a bucket using a single HTTP request. You may specify up to 1000 - keys. - - - - - The bucket name containing the objects to delete. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property BypassGovernanceRetention. - - Specifies whether you want to delete this object even if it has a Governance-type - Object Lock in place. You must have sufficient permissions to perform this operation. - - - - - - List of object keys to delete. - - - - - Toggles between Quiet and Verbose mode for the operation. - If set to true (Quiet mode), the response includes only those keys for objects on which - the delete operation failed. - - - By default this property is false and keys for both successful deletes - and failures are returned in the response. - - - - - The MfaCodes Tuple associates the Serial Number and the current Token/Code displayed on the - Multi-Factor Authentication device associated with your AWS Account. - - - This is a required property for this request if:
- 1. EnableMfaDelete was configured on the bucket - containing this object's version.
- 2. You are deleting an object's version - - - - - Checks if the MfaCodes property is set. - - true if the MfaCodes property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Add a key to the set of keys of objects to be deleted. - - Object key - - - - Add a key and a version to be deleted. - - Key of the object to be deleted. - Version of the object to be deleted. - - - - Add a KeyVersion object representing the S3 object to be deleted. - - KeyVersion representation of object to be deleted. - - - - Returns information about the DeleteObjects response and response metadata. - - - - - A default constructor for DeleteObjectsResponse - - - - - Gets and sets the DeletedObjects property. - A list of successful deletes. - Set only when Quiet=false on DeleteObjectsRequest. - - - - - Gets and sets the DeleteErrors property. - A list of errors encountered while deleting objects. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the DeleteObjectTaggingRequest operation. - - - - - The bucket name containing the objects from which to remove the tags. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Check to see if Bucket property is set - - - - - The key identifying the object tagging to delete. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Check to see if Key property is set - - - - - The identifier for the specific version of the object to be deleted, if required. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - Returns information about the DeleteObjectTagging response and response metadata. - - - - - Returns the version ID of the delete marker created as a result of the DELETE operation. - - - - - Check to see if VersionId property is set - - - - - Container for the parameters to the DeletePublicAccessBlock operation. - Removes the Public Access Block configuration for an Amazon S3 bucket. - - - - - Gets and sets the property BucketName. - - The Amazon S3 bucket whose Public Access Block configuration you want to delete. - - - - - - This is the response object from the DeletePublicAccessBlock operation. - - - - - EncryptionConfiguration class - - - - - The ID of the AWS KMS key for the region where the destination bucket - resides. Amazon S3 uses this key to encrypt the replica object. - - - - - The Continuation Event. - - - - - Constructs a Continuation Event. - - - - - Constructs a Continuation Event. - - - - - - The End Event. - - - - - Constructs an End Event. - - - - - Constructs an End Event. - - - - - - Common Contract for S3 Events. - - - - - The Progress event details. - - - - - Current number of object bytes scanned. - - - - - Current number of uncompressed object bytes processed. - - - - - Total number of bytes of records payload data returned. - - - - - Constructs a instance of Progress. - - - - - The Progress Event. - - - - - The Progress event details. - - - - - Constructs a ProgressEvent. - - - - - Constructs a ProgressEvent. - - - - - - The Records Event - - - - - The byte array of partial, one or more result records. - - Payload is a , which is not thread-safe. - - - - - Constructs a RecordsEvent - - - - - Creates a new End Event. - - - - - - Modeled Exception that either comes over the stream from the service model, or wraps other exceptions for the purpose of raising events. If it is - modelled, it will be a subclass. - - - - - Creates a new S3EventStreamException - - - - - Creates a new S3EventStreamException - - - - - - Creates a new S3EventStreamException - - - - - - - The contract for the SelectObjectContentEventStream. - - - - - Event that encompasses all IS3Events. - - - - - Event that encompasses S3EventStreamExceptions. - - - - - Reaised when a Records event is received. - - - - - Reaised when a Stats event is received. - - - - - Reaised when a Progress event is received. - - - - - Reaised when a Continuation event is received. - - - - - Reaised when an End event is received. - - - - - A Stream of Events returned by the SelectObjectContent operation. Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treaded as mutually exclusive. - - - - - The mapping of event message to a generator function to construct the matching Event Stream event. - - - - - The mapping of event message to a generator function to construct the matching Event Stream exception. - - - - - Whether the backround processing loop is running. - - - - - Event that encompasses all IS3Events. - - - - - Event that encompasses S3EventStreamExceptions. - - - - - Reaised when a Records event is received. - - - - - Reaised when a Stats event is received. - - - - - Reaised when a Progress event is received. - - - - - Reaised when a Continuation event is received. - - - - - Reaised when an End event is received. - - - - - Event Stream returned by SelectObjectContentStream. - - Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treated as mutually exclusive. - - The network stream which events will be parsed from. - - - - Event Stream returned by SelectObjectContentStream. - - Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treaded as mutually exclusive. - - The network stream which events will be parsed from. - The decoder responsible for parsing events. - - - - The Stats event details. - - - - - Total number of object bytes scanned. - - - - - Total number of uncompressed object bytes processed. - - - - - Total number of bytes of records payload data returned. - - - - - Constructs an instance of Stats. - - - - - The Stats Event. - - - - - The Stats event details. - - - - - Constructs a StatsEvent - - - - - Constructs a ProgressEvent. - - - - - - This Event is returned if an event is retrieved from the event stream, but a generator function - for the event is not defined. - - - - - Constructs an UnknownEventStreamEvent. - - - - - Constructs an UnknownEventStreamEvent. - - The Message recieved from the event stream before conversion. - - - - Constructs an UnknownEventStreamEvent. - - The Message recieved from the event stream before conversion. - The event type. - - - - A container that specifies information about existing object replication. You can choose whether to enable or disable the replication of existing objects. - - - - - Specifies whether existing object replication is enabled. - - - - - Defines the expiration policy for a given object. - - - - - This property is deprecated. This property exposes a DateTime of kind Unspecified. Use ExpiryDateUtc instead. - The date and time for expiry. - - - - - The date and time for expiry. - - - - - Id of the configuration rule for this expiry. - - - - - Constructs an empty instance of an Expiration object - - - - Bucket - Represents a set of filter criteria that limits the objects that can trigger event notifications - - - - - Filter criteria that limits the objects that can trigger event notifications based on their S3 Key name. - - - - - Bucket - Represents a Filter Rule for a NotificationConfiguration. - - - - - Constructs an empty FilterRule. - - - - - Constructs a FilterRule with a specific name and value. - - - - - - - The name of the filter rule. - - - - - The value of the filter rule. - - - - - Container for the parameters to the GetACL operation. - Returns the access control list (ACL) of an object. - - - - - The bucket name that contains the object for which to get the ACL information. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The key of the S3 object to be queried. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - VersionId used to reference a specific version of the object. - - - - - Returns information about the GetACL response and response metadata. - - - - - Gets and sets the AccessControlList property. - - - - - Container for the parameters to the GetBucketAccelerateConfiguration operation. - - - - - The name of the bucket. - - - - - The response class for GetBucketAccelerateConfiguration operation. - - - - - The accelerate status of the bucket. - - - - - Container for the parameters to the GetBucketAnalyticsConfiguration operation. - Gets an analytics configuration for the bucket (specified by the analytics configuration ID). - - - - - The name of the bucket from which an analytics configuration is retrieved. - - - - - The identifier used to represent an analytics configuration. - - - - - GetBucketAnalyticsConfigurationResponse Response - - - - - The configuration and any analyses for the analytics filter. - - - - - Container for the parameters to the GetBucketEncryptionRequest operation. - Returns the server-side encryption configuration of a bucket. - - - - - The name of the bucket. - - - - - GetBucketEncryptionResponse Response - - - - - Container for server-side encryption configuration rules. Currently S3 supports one rule only. - - - - - Container for the parameters to the GetInventoryConfigurationRequest operation. - Returns an inventory configuration (identified by the inventory ID) from the bucket. - - - - - The name of the bucket containing the inventory configuration to retrieve. - - - - - The ID used to identify the inventory configuration. - - - - - GetInventoryConfigurationResponse Response - - - - - Specifies the inventory configuration. - - - - - Container for the parameters to the GetBucketLocation operation. - Returns the region the bucket resides in. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetBucketLocation response and response metadata. - - - - - Gets and sets the Location property. - If the the bucket is located in us-east-1 S3Region.US will be return which has a - value of empty string. - - - - - Container for the parameters to the GetBucketLogging operation. - Returns the logging status of a bucket and the permissions users have to view and modify that status. To use GET, you must be the - bucket owner. - - - - - The name of the bucket to query. - - - - - Returns information about the GetBucketLogging response and response metadata. - - - - - Gets and sets the LoggingConfig property. - - - - - Container for the parameters to the GetBucketMetricsConfiguration operation. - Gets a metrics configuration (specified by the metrics configuration ID) from the bucket. - - - - - The name of the bucket containing the metrics configuration to retrieve. - - - - - The ID used to identify the metrics configuration. - - - - - GetBucketMetricsConfiguration Response - - - - - Specifies the metrics configuration. - - - - - Container for the parameters to the GetBucketNotification operation. - Return the notification configuration of a bucket. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetBucketNotification response and response metadata. - - - - - Gets and sets the TopicConfigurations property. TopicConfigurations are configuration - for Amazon S3 events to be sent to Amazon SNS topics. - - - - - Gets and sets the QueueConfigurations property. QueueConfigurations are configuration - for Amazon S3 events to be sent to Amazon SQS queues. - - - - - Gets and sets the LambdaFunctionConfigurations property. LambdaFunctionConfigurations are configuration - for Amazon S3 events to be sent to an Amazon Lambda cloud function. - - - - - Container for the parameters to the GetBucketPolicy operation. - Returns the policy of a specified bucket. - - - - - The name of the bucket. - - - - - Get BucketName Policy Response - - - - - The bucket policy as a JSON document. - - - - - Container for the parameters to the GetBucketPolicyStatus operation. - Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket - is public. - - - - - Gets and sets the property BucketName. - - The name of the Amazon S3 bucket whose public-policy status you want to retrieve. - - - - - - This is the response object from the GetBucketPolicyStatus operation. - - - - - The public-policy status for this bucket. - - - - - Container for the parameters to the GetBucketReplicationConfiguration operation. - Returns the replication configuration information set on the bucket. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetReplicationConfiguration response and response metadata. - - - - - The replication configuration for the buccket specified in the request. - - - - - Container for the parameters to the GetBucketRequestPayment operation. - Returns the request payment configuration of a bucket. - - - - - The name of the bucket. - - - - - Returns information about the GetBucketRequestPayment response and response metadata. - - - - - Specifies who pays for the download and request fees. - - - - - - Container for the parameters to the GetBucketTagging operation. - Returns the tag set associated with the bucket. - - - - - The name of the bucket to be queried. - - - - - Returns information about the GetBucketTagging response and response metadata. - - - - - The collection of tags. - - - - - Container for the parameters to the GetBucketVersioning operation. - Returns the versioning state of a bucket. - - - - - The name of the bucket to be queried. - - - - - Returns information about the GetBucketVersioning response and response metadata. - - - - - Gets and sets the Versioning property. - Unless Versioning has been explicitly "Enabled" on a bucket, - Versioning Status is "Off". Once Versioning has been - "Enabled", it can be "Suspended" but cannot be switched "Off". - - - - - Container for the parameters to the GetBucketWebsite operation. - Returns the website configuration for a bucket. - - - - - The name of the bucket to be queried. - - - - - Returns information about the GetBucketWebsite response and response metadata. - - - - - Gets and sets the WebsiteConfiguration property. - - This is where the index document suffix and custom error page are defined. - - - - - Container for the parameters to the GetBucketCors operation. - Returns the cors configuration for the bucket. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetBucketCors response and response metadata. - - - - - The current CORSConfiguration for the bucket. - - - - - Container for the parameters to the GetLifecycleConfiguration operation. - Returns the lifecycle configuration information set on the bucket. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetLifecycleConfiguration response and response metadata. - - - - - Gets and Sets the property that governs whether - the response includes successful deletes as well as errors - following the DeleteObjects call against S3. - - By default this property is false and successful deletes - are returned in the response. - - - - - Container for the parameters to the GetObjectLegalHold operation. - Gets an object's current Legal Hold status. - - - - - The bucket name containing the object whose Legal Hold status you want to retrieve. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property Key. - - The key name for the object whose Legal Hold status you want to retrieve. - - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property VersionId. - - The version ID of the object whose Legal Hold status you want to retrieve. - - - - - - This is the response object from the GetObjectLegalHold operation. - - - - - Gets and sets the property LegalHold. - - The current Legal Hold status for the specified object. - - - - - - Container for the parameters to the GetObjectLockConfiguration operation. - Gets the Object Lock configuration for a bucket. The rule specified in the Object - Lock configuration will be applied by default to every new object placed in the specified - bucket. - - - - - Gets and sets the property BucketName. - - The bucket whose Object Lock configuration you want to retrieve. - - - - - - This is the response object from the GetObjectLockConfiguration operation. - - - - - Gets and sets the property ObjectLockConfiguration. - - The specified bucket's Object Lock configuration. - - - - - - Container for the parameters to the HeadObject operation. - The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you''re only - interested in an object''s metadata. To use HEAD, you must have READ access to the object. - - - - - The name of the bucket that contains the object. - - - - - ETag to be matched as a pre-condition for returning the object, - otherwise a PreconditionFailed signal is returned. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or - ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Returns the object only if it has been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Returns the object only if it has been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - ETag that should not be matched as a pre-condition for returning the object, - otherwise a PreconditionFailed signal is returned. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or - UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Returns the object only if it has not been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Returns the object only if it has not been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - The key of the object. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - VersionId used to reference a specific version of the object. - - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to decrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - Part number of the object being read. This is a positive integer between 1 and 10,000. - Effectively performs a 'ranged' HEAD request for the part specified. - Useful querying about the size of the part and the number of parts in this object. - - - - - Check if PartNumber property is set. - - true if PartNumber property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the HeadObject response and response metadata. - - - - - Flag which returns true if the Expires property has been unmarshalled - from the raw value or set by user code. - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the - response. - - - - - - Gets and sets the AcceptRanges. - - - - - Gets and sets the ContentRange. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - Gets and sets the RestoreExpiration property. - RestoreExpiration will be set for objects that have been restored from Amazon Glacier. - It indiciates for those objects how long the restored object will exist. - - - - - Gets and sets the RestoreInProgress - Will be true when the object is in the process of being restored from Amazon Glacier. - - - - - Last modified date of the object - - - - - - An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL - - - - - - This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like - SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal - HTTP headers. - - - - - - Version of the object. - - - - - - The date and time at which the object is no longer cacheable. - - - - - - If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The status of the replication job associated with this source object. - - - - - Checks if ReplicationStatus property is set. - - true if ReplicationStatus property is set. - - - - The count of parts this object has. - - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - The Legal Hold status for the specified object. - - - - - - Gets and sets the property ObjectLockMode. - - The Object Lock mode currently in place for this object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - The date and time when this object's Object Lock will expire. - - - - - - The class of storage used to store the object. - - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the GetObject operation. - Retrieves objects from Amazon S3. - - - - - The bucket name containing the object. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - ETag to be matched as a pre-condition for returning the object, - otherwise a PreconditionFailed signal is returned. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or - ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Returns the object only if it has been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Returns the object only if it has been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - ETag that should not be matched as a pre-condition for returning the object, - otherwise a PreconditionFailed signal is returned. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or - UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Returns the object only if it has not been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Returns the object only if it has not been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Gets and sets the Key property. This is the user defined key that identifies the object in the bucket. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Downloads the specified range bytes of an object. - - - - - A set of response headers that should be returned with the object. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ResponseExpiresUtc instead. Setting either ResponseExpires or - ResponseExpiresUtc results in both ResponseExpires and ResponseExpiresUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ResponseExpires is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Sets the Expires header of the response. - - - - - Sets the Expires header of the response. - - - - - VersionId used to reference a specific version of the object. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to decrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - Part number of the object being read. This is a positive integer between 1 and 10,000. - Effectively performs a 'ranged' GET request for the part specified. Useful for downloading just a part of an object. - - - - - Checks if PartNumber property is set. - - true if PartNumber property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the GetObject response and response metadata. - - - - - Flag which returns true if the Expires property has been unmarshalled - from the raw value or set by user code. - - - - - Gets and sets the BucketName property. - - - - - Gets and sets the Key property. - - - - - Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the - response. - - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - Gets and sets the AcceptRanges. - - - - - Gets and sets the ContentRange. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - Gets and sets the RestoreExpiration property. - RestoreExpiration will be set for objects that have been restored from Amazon Glacier. - It indiciates for those objects how long the restored object will exist. - - - - - Gets and sets the RestoreInProgress - Will be true when the object is in the process of being restored from Amazon Glacier. - - - - - Last modified date of the object - - - - - - An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL - - - - - - This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like - SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal - HTTP headers. - - - - - - Version of the object. - - - - - - The date and time at which the object is no longer cacheable. - - - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - - - - Gets and sets the property ObjectLockMode. - - The Object Lock mode currently in place for this object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - The date and time when this object's Object Lock will expire. - - - - - - If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The class of storage used to store the object. - - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The status of the replication job associated with this source object. - - - - - Checks if ReplicationStatus property is set. - - true if ReplicationStatus property is set. - - - - The number of parts this oject has. - - - - - Checks if PartsCount is set. - - true if PartsCount property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - The number of tags, if any, on the object. - - - - - The event for Write Object progress notifications. All - subscribers will be notified when a new progress - event is raised. - - - Subscribe to this event if you want to receive - put object progress notifications. Here is how:
- 1. Define a method with a signature similar to this one: - - private void displayProgress(object sender, WriteObjectProgressArgs args) - { - Console.WriteLine(args); - } - - 2. Add this method to the Put Object Progress Event delegate's invocation list - - GetObjectResponse response = s3Client.GetObject(request); - response.WriteObjectProgressEvent += displayProgress; - - - - - - This method is called by a producer of write object progress - notifications. When called, all the subscribers in the - invocation list will be called sequentially. - - The file being written. - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - True if transfer is complete - - - - Writes the content of the ResponseStream a file indicated by the filePath argument. - - The location where to write the ResponseStream - Whether or not to append to the file if it exists - Cancellation token which can be used to cancel this operation. - - - - Encapsulates the information needed to provide - download progress for the Write Object Event. - - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The bucket name for the S3 object being written. - The object key for the S3 object being written. - The version-id of the S3 object. - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - True if finished writing - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The bucket name for the S3 object being written. - The object key for the S3 object being written. - The file for the S3 object being written. - The version-id of the S3 object. - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - True if finished writing - - - - Gets the bucket name for the S3 object being written. - - - - - Gets the object key for the S3 object being written. - - - - - Gets the version-id of the S3 object. - - - - - The file for the S3 object being written. - - - - - True if writing is complete - - - - - Container for the parameters to the GetObjectRetention operation. - Retrieves an object's retention settings. - - - - - The bucket name containing the object whose retention settings you want to retrieve. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property Key. - - The key name for the object whose retention settings you want to retrieve. - - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property VersionId. - - The version ID for the object whose retention settings you want to retrieve. - - - - - - This is the response object from the GetObjectRetention operation. - - - - - Gets and sets the property Retention. - - The container element for an object's retention settings. - - - - - - Container for the parameters to the GetObjectTaggingRequest operation. - - - - - The bucket name containing the object for which to get the tagging information. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Check to see if Bucket property is set - - - - - Gets and sets the Key property. This is the user defined key that identifies the object in the bucket. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Check to see if Key property is set - - - - - VersionId used to reference a specific version of the object. - - - - - - Returns information about the GetObjectTagging response and response metadata. - - - - - Gets or sets tag-set for a given object - - - - - Container for the parameters to the GetObjectTorrent operation. - Return torrent files from a bucket. - - - - - The name of the bucket containing the object. - - - - - The key identifying the object. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the GetObjectTorrent response and response metadata. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - The parameters to create a pre-signed URL to a bucket or object. - - - For more information, refer to: . -
Required Parameters: BucketName, Expires -
Optional Parameters: Key, VersionId, Verb: default is GET - - - - - The name of the bucket to create a pre-signed url to, or containing the object. - - - - - Checks if BucketName property is set. - - true if BucketName property is set. - - - - The key to the object for which a pre-signed url should be created. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Checks if Key property is set. - - true if Key property is set. - - - - A standard MIME type describing the format of the object data. - - - - The content type for the content being uploaded. This property defaults to "binary/octet-stream". - For more information, refer to: . - - - Note that if content type is specified, it should also be included in the HttpRequest headers - of the eventual upload request, otherwise a signature error may result. - - - - - - The expiry date and time for the pre-signed url. - - - - - Checks if Expires property is set. - - true if Expires property is set. - - - - The requested protocol (http/https) for the pre-signed url. - - - Defaults to https. - - - - - The verb for the pre-signed url. - - - Accepted verbs are GET, PUT, DELETE and HEAD. - Default is GET. - - - - - Version id for the object that the pre-signed url will reference. If not set, - the url will reference the latest version of the object. - - - This is the VersionId for the S3 Object you want to get - a PreSigned URL for. The VersionId property will be ignored - for PreSigned "PUT" requests and for requests that don't specify - the Key property. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - The upload id for the multipart upload for which a pre-signed url should be created. - - - - - Checks if UploadId property is set. - - true if UploadId property is set. - - - - The part number for the multipart upload for which a pre-signed url should be created. - - - - - Checks if PartNumber property is set. - - true if PartNumber property is set. - - - - Specifies the encryption used on the server to store the content. - - - - Default is None. - - - If specifying encryption (not None), the corresponding request must include header - "x-amz-server-side-encryption" with the value of the encryption. - - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - Confirms that the requester knows that she or he will be charged for the request. - Bucket owners need not specify this parameter in their requests. - - - - - A set of response headers that should be returned with the pre-signed url creation response. - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - Custom parameters to include in the signed request, so that they are tamper-proof. - - - - - The parameters for a pre-signed URL to a bucket or object as a string. - - - For more information, refer to: . - - - - - The PreSignedURL as a string - - - - - Constructor - - A url returned from GetPreSignedUrlRequest - - - - Container for the parameters to the GetPublicAccessBlock operation. - Retrieves the Public Access Block configuration for an Amazon S3 bucket. - - - - - Gets and sets the property BucketName. - - The name of the Amazon S3 bucket whose Public Access Block configuration you want - to retrieve. - - - - - - This is the response object from the GetPublicAccessBlock operation. - - - - - The Public Access Block configuration currently in effect for this Amazon S3 bucket. - - - - - Container for the parameters to the HeadBucket operation. - This operation is useful to determine if a bucket exists and you have permission to access it. - - - - - Returns information about the HeadBucket response metadata. - The HeadBucket operation has a void result type. - - - - - This class contains the headers for an S3 object. - - - - - Gets and sets headers to set for the object. - - The name of the header - The value for the header - - - - Gets the count of headers. - - - - - Gets the names of the headers set. - - - - - Specifies caching behavior along the request/reply chain. - - - - - - Specifies presentational information for the object. - - - - - - Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type - referenced by the Content-Type header field. - - - - - - The size of the object, in bytes. - - - - - The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. This - header can be used as a message integrity check to verify that the data is the same data that was originally sent. - - - - - A standard MIME type describing the format of the object data. - - - - - - The date and time at which the object is no longer cacheable. - - - - - - - Container for the parameters to the InitiateMultipartUpload operation. - Initiates a multipart upload and returns an upload ID. - - - - - Envelope Key to Encrypt data - - - - - Encrypted Envelope Key to Encrypt data - - - - - Initialization Vector for encryption - - - - - Storage mode for encryption information. - - - - - A canned access control list (ACL) to apply to the object. - Please refer to for information on S3 Canned ACLs. - - - - - The name of the bucketName where the new object will be created, or existing object updated. - - - - - The key of the object to create or update. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - StorageClass property for the object. - - - Default: S3StorageClass.Standard. Set this property - only if you want reduced redundancy for this object. - Please refer to - for - information on S3 Storage Classes. - - - - - If the bucketName is configured as a website, redirects requests for this object to another object in the same bucketName or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - This is a convenience property for Headers.ContentType. - - - - - - Specifies the encryption to be used on the server for the new object. - - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - Checks if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - true if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - Specifies whether you want to apply a Legal Hold to the uploaded object. - - - - - - Gets and sets the property ObjectLockMode. - - Specifies the Object Lock mode that you want to apply to the uploaded object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - Specifies the date and time when you want the Object Lock to expire. - - - - - - The tag-set for the object. The tag-set must be encoded as URL Query parameters. - - - - - Checks if Tagging property is set - - true if Tagging is set. - - - - Returns information about the InitiateMultipartUpload response and response metadata. - - - - - Name of the bucketName to which the multipart upload was initiated. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Object key for which the multipart upload was initiated. - - - - - - Gets and sets the initiated multipart upload id. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - Date when multipart upload will become eligible for abort operation by lifecycle. - - - - - Id of the lifecycle rule that makes a multipart upload eligible for abort operation. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Identifies who initiated the multipart upload. - - - - - Name of the Principal. - - - - - - If the principal is an AWS account, it provides the Canonical User ID. If the principal is an IAM User, it provides a user ARN value. - - - - - - Describes the serialization format of the object. - - - - - Describes the serialization of a CSV-encoded object. - - - - - Specifies object's compression format. Valid values: NONE, GZIP. Default Value: NONE. - - - - - Specifies JSON as object's input serialization format. - - - - - Specifies Parquet as object's input serialization format. - - - - - Class for MetricsConfiguration - - - - - Contains information about where to publish the inventory results. - - - - - Specifies whether the inventory is enabled or disabled. - - - - - Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria. - - - - - The ID used to identify the inventory configuration. - - - - - Specifies which object version(s) to included in the inventory results. - - - - - Contains the optional fields that are included in the inventory results. - - - - - Specifies the schedule for generating inventory results. - - - - - Class for InventoryDestination - - - - - Contains the bucket name, file format, bucket owner (optional), and prefix (optional) where inventory results are published. - - - - - InventoryEncryption class - - - - - Specifies the use of SSE-S3 to encrypt delievered Inventory reports. - - - - - Specifies the use of SSE-KMS to encrypt delievered Inventory reports. - - - - - Class for InventoryFilter - - - - - Filter Predicate setup for specific filter types. - - - - - Filter Predicate abstract class for specific filter types to be derived from. - - - - - Class for InventoryPrefixPredicate - The prefix that an object must have to be included in the inventory results. - - - - - The ID of the account that owns the destination bucket. - - - - - The Amazon resource name (ARN) of the bucket where inventory results will be published. - - - - - The prefix that is prepended to all inventory results. - - - - - Specifies the output format of the inventory results. - - - - - Contains the type of server-side encryption used to encrypt the inventory results. - - - - - Class for InventorySchedule - - - - - Specifies how frequently inventory results are produced. - - - - - Specifies JSON as object's input serialization format. - - - - - The type of JSON. Valid values: Document, Lines. - - - - - Specifies JSON as request's output serialization format - - - - - The value used to separate individual records in the output. - - - - - Specifies an object key and optional object version. - - - - - Key name of the object to delete. - - - - - - VersionId for the specific version of the object to delete. - - - - - - This class contains the configuration Amazon S3 uses to figure out what events you want to listen - and send the event to an Amazon Lambda cloud function. - - - - - Gets and set the Id property. The Id will be provided in the event content and can be used - to identify which configuration caused an event to fire. If the Id is not provided for the configuration, one will be generated. - - - - - Gets and sets the FunctionArn property. This is the Amazon Lambda cloud function to which Amazon S3 will invoke with the events. - - - - Lifecycle Configuration - - - - - Gets and sets the Rules property. These rules defined the lifecycle configuration. - - - - - Base class for all the different predicates that can be used - in a filter. - - - - - This method is called by the visitor when it wants to visit the predicate. - - - - - - Filter identifying one or more objects to which a applies. - - - - - The predicate used by the filter. - - - - - Base class for lifecycle operators. - - - - - The list of objects - that this operator operates on. - - - - - The logical and operator for filtering objects for a - - - - - Accept a visit from an - - - This method is used internally by the SDK. - - - - - - A predicate that filters objects for a - by matching a particular prefix. - - - - - The prefix to be matched by filtered objects. - - - - - Accept a visit from an - - - This method is used internally by the SDK. - - - - - - A predicate that filters objects for a - by matching a particular key and value. - - - - - The Tag to be matched by filtered objects. - - - - - Accept a visit from an - - - This method is used internally by the SDK. - - - - - - Rules Item - - - - - Defines the length of time, in days, before objects expire. - - - - - Unique identifier for the rule. The value cannot be longer than 255 characters. - - - - - Prefix identifying one or more objects to which the rule applies. - - - - - - Filter identifying one or more objects to which the rule applies. - - - - - If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied. - - - - - - The transition rule that describes when objects transition to a different storage class. - - Lifecycle rules can now contain multiple transitions. This property is obsolete in favor of the Transitions property. - This property will always get or set the the zeroth element in the Transitions collection. - - - - - - Defines the length of time, in days, before noncurrent versions expire. - - - - - The transition rule that describes when noncurrent versions transition to - a different storage class. - - Lifecycle rules can now contain multiple noncurrent version transitions. This property - is obsolete in favor of the NoncurrentVersionTransitions property. - This property will always get or set the the zeroth element in the NoncurrentVersionTransitions collection. - - - - - - The transition rules that describe when objects transition to a different storage class. - - - - - The transition rules that describe when noncurrent versions transition to - a different storage class. - - - - - Specifies the days since the initiation of an Incomplete Multipart Upload - that Lifecycle will wait before permanently removing all parts of the upload. - - - - - Specifies the days since the initiation of an Incomplete Multipart Upload - that Lifecycle will wait before permanently removing all parts of the upload. - - - - - Indicates the number of days that must pass since initiation for Lifecycle - to abort an Incomplete Multipart Upload. - - - - Expiration - - - - - Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format. - - - - - - Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer. - - - - - - Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set to true, the delete marker will be expired; if set to false the policy takes no action. This cannot be specified with Days or Date in a Lifecycle Expiration Policy. - - - - - - Noncurrent Version Expiration - - - - - Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated - action. For information about the noncurrent days calculations, see - How Amazon S3 Calculates When an Object Became Noncurrent - in the Amazon Simple Storage Service Developer Guide. - - - - - LifecycleTransition defines when and how objects transition. - - - - - Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated - action. For information about the noncurrent days calculations, see - How Amazon S3 Calculates When an Object Became Noncurrent - in the Amazon Simple Storage Service Developer Guide. - - - - - The class of storage used to store the object. - - - - - - LifecycleTransition defines when and how objects transition. - - - - - Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format. - - - - - - Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer. - - - - - - The class of storage used to store the object. - - - - - - Container for the parameters to the ListInventoryConfigurationsRequest operation. - Lists the analytics configurations for the bucket. - - - - - The name of the bucket containing the analytics configurations to retrieve. - - - - - The ContinuationToken that represents a placeholder from where this request should begin. - - - - - Returns information about the ListBucketAnalyticsConfigurationsResponse response and response metadata. - - - - - The ContinuationToken that represents where this request began. - - - - - The list of analytics configurations for a bucket. - - - - - Indicates whether the returned list of analytics configurations is complete. - A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request. - - - - - NextContinuationToken is sent when isTruncated is true, which indicates that there are more analytics configurations to list. - The next request must include this NextContinuationToken. The token is obfuscated and is not a usable value. - - - - - Container for the parameters to the ListInventoryConfigurationsRequest operation. - Returns a list of inventory configurations for the bucket. - - - - - The name of the bucket containing the inventory configurations to retrieve. - - - - - The marker used to continue an inventory configuration listing that has been truncated. - Use the NextContinuationToken from a previously truncated list response to continue the listing. - The continuation token is an opaque value that Amazon S3 understands. - - - - - Returns information about the ListInventoryConfigurationsResponse response and response metadata. - - - - - If sent in the request, the marker that is used as a starting point for this inventory configuration list response. - - - - - The list of inventory configurations for a bucket. - - - - - Indicates whether the returned list of inventory configurations is truncated in this response. A value of true indicates that the list is truncated. - - - - - The marker used to continue this inventory configuration listing. Use the NextContinuationToken from this response to continue the listing in a subsequent request. - The continuation token is an opaque value that Amazon S3 understands. - - - - - Container for the parameters to the ListBucketMetricsConfigurationRequest operation. - Lists the metrics configurations for the bucket. - - - - - The name of the bucket containing the metrics configurations to retrieve. - - - - - - The marker that is used to continue a metrics configuration listing that has been truncated. - Use the NextContinuationToken from a previously truncated list response to continue the listing. - The continuation token is an opaque value that Amazon S3 understands. - - - - - - Returns information about the ListBucketMetricsConfiguration response and response metadata. - - - - - - The marker that is used to continue a metrics configuration listing that has been truncated. - Use the NextContinuationToken from a previously truncated list response to continue the listing. - The continuation token is an opaque value that Amazon S3 understands. - - - - - - The list of metrics configurations for a bucket. - - - - - - Indicates whether the returned list of metrics configurations is complete. - A value of true indicates that the list is not complete and the NextContinuationToken will be provided for - a subsequent request. - - - - - - - The marker used to continue a metrics configuration listing that has been truncated. - Use the NextContinuationToken from a previously truncated list response to continue the listing. - The continuation token is an opaque value that Amazon S3 understands. - - - - - - Container for the parameters to the ListBuckets operation. - Returns a list of all buckets owned by the authenticated sender of the request. - - - - - Returns information about the ListBuckets response and response metadata. - - - - - List of buckets. - - - - - Owner of the buckets. - - - - - Container for the parameters to the ListMultipartUploads operation. - This operation lists in-progress multipart uploads. - - - - - Name of the bucket to which the multipart upload was initiated. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Character you use to group keys. - - - - - - Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin. - - - - - - Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response body. 1,000 is the maximum number of uploads that - can be returned in a response. - - - - - - Lists in-progress uploads only for those keys that begin with the specified prefix. - - - - - - Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the - upload-id-marker parameter is ignored. - - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - Returns information about the ListMultipartUploads response and response metadata. - - - - - Name of the bucketName to which the multipart upload was initiated. - - - - - - The key at or after which the listing began. - - - - - - Upload ID after which listing began. - - - - - - When a list is truncated, this element specifies the value that should be used for the key-marker request parameter in a subsequent request. - - - - - - When a list is truncated, this element specifies the value that should be used for the upload-id-marker request parameter in a subsequent - request. - - - - - - Maximum number of multipart uploads that could have been included in the response. - - - - - - Indicates whether the returned list of multipart uploads is truncated. A value of true indicates that the list was truncated. The list can - be truncated if the number of multipart uploads exceeds the limit allowed or specified by max uploads. - - - - - - Gets and sets the MultipartUploads property. - - Container for elements related to a particular multipart upload. A response - can contain zero or more Upload elements. - - - - - - Gets and sets the Prefix property. - - - - - Gets and sets the Delimiter property. - - - - - Gets the CommonPrefixes property. - A response can contain CommonPrefixes only if you specify a delimiter. - When you do, CommonPrefixes contains all (if there are any) keys between - Prefix and the next occurrence of the string specified by delimiter. In effect, - CommonPrefixes lists keys that act like subdirectories in the directory specified - by Prefix. For example, if prefix is notes/ and delimiter is a slash (/), in - notes/summer/july, the common prefix is notes/summer/. - - - - - Container for the parameters to the ListObjects operation. - Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a - subset of the objects in a bucket. - - - - - The name of the bucket containing the objects whose keys are to be listed. - - - - - A delimiter is a character you use to group keys. - - - - - Specifies the key to start with when listing objects in a bucket. - - - - - Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more. - - - - - Limits the response to keys that begin with the specified prefix. - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the ListObjects response and response metadata. - - - - - A flag that indicates whether or not Amazon S3 returned all of the results that satisfied - the search criteria. - - - - - Gets and sets the NextMarker property. - NextMarker is set by S3 only if a Delimiter was specified - in the original ListObjects request. If a delimiter was - not specified, the AWS SDK for .NET returns the last Key - of the List of Objects retrieved from S3 as the NextMarker. - - - - - Gets the S3Objects property. This is a list of - objects in the bucket that match your search criteria. - - - - - Gets and sets the Name property which is the name of the bucket. - - - - - Gets and sets the Prefix property. - - - - - Gets and sets the MaxKeys property. This is max number of object keys returned by the list operation. - - - - - Gets the CommonPrefixes property. - A response can contain CommonPrefixes only if you specify a delimiter. - When you do, CommonPrefixes contains all (if there are any) keys between - Prefix and the next occurrence of the string specified by delimiter. In effect, - CommonPrefixes lists keys that act like subdirectories in the directory specified - by Prefix. For example, if prefix is notes/ and delimiter is a slash (/), in - notes/summer/july, the common prefix is notes/summer/. - - - - - Gets and sets the Delimiter property. - Causes keys that contain the same string between the prefix and the - first occurrence of the delimiter to be rolled up into a single result - element in the CommonPrefixes collection. - - - These rolled-up keys are not returned elsewhere in the response. - - - - - Container for the parameters to the ListObjects operation. - Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a - subset of the objects in a bucket. - - - - - Bucket name to list. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - A delimiter is a character you use to group keys. - - - - - Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more. - - - - - Limits the response to keys that begin with the specified prefix. - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts - listing after this specified key. StartAfter can be any key in the bucket. - Cannot be set at the same time as ContinuationToken. - - - - - ContinuationToken indicates Amazon S3 that the list is being continued on this - bucket with a token. ContinuationToken is obfuscated and is not a real key. - - - - - The owner field is not present in ListObjectsV2 responses by default. - If you want to return owner field with each key in the result then set this field to true. - If not specified, the Owner field on S3Object will be null. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the ListObjects response and response metadata. - - - - - A flag that indicates whether or not Amazon S3 returned all of the results that satisfied - the search criteria. - - - - - Gets and sets the S3Objects property. Metadata about each object returned. - - - - - Bucket name. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the Prefix property. - - - - - Gets and sets the MaxKeys property. This is max number of object keys returned by the list operation. - - - - - Gets and sets the CommonPrefixes property. - CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence - of the string specified by delimiter - - - - - Gets and sets the Delimiter property. - Causes keys that contain the same string between the prefix and the - first occurrence of the delimiter to be rolled up into a single result - element in the CommonPrefixes collection. - - - These rolled-up keys are not returned elsewhere in the response. - - - - - Encoding type used by Amazon S3 to encode object keys in the response. - - - - - KeyCount is the number of keys returned with this request. - KeyCount will always be less than or equal to MaxKeys field. - - - - - ContinuationToken indicates Amazon S3 that the list is being continued - on this bucket with a token. - ContinuationToken is obfuscated and is not a real key - - - - - NextContinuationToken is sent when isTruncated is true which means there - are more keys in the bucket that can be listed. The next ListObjectV2 call - to Amazon S3 can be continued with this NextContinuationToken. - NextContinuationToken is obfuscated and is not a real key. - - - - - StartAfter is where you want Amazon S3 to start listing from. - Amazon S3 starts listing after this specified key. - StartAfter can be any key in the bucket. - - - - - Container for the parameters to the ListParts operation. - Lists the parts that have been uploaded for a specific multipart upload. - - - - - Name of the bucket to which the parts are being uploaded. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The object key for which the multipart upload was initiated. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Sets the maximum number of parts to return. - - - - - - Specifies the part after which listing should begin. Only parts with higher part numbers will be listed. - - - - - - Upload ID identifying the multipart upload whose parts are being listed. - - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the ListParts response and response metadata. - - - - - Name of the bucketName to which the multipart upload was initiated. - - - - - - Object key for which the multipart upload was initiated. - - - - - - Upload ID identifying the multipart upload whose parts are being listed. - - - - - - Part number after which listing begins. - - - - - - When a list is truncated, this element specifies the last part in the list, as well as the value to use for the part-number-marker request - parameter in a subsequent request. - - - - - - Maximum number of parts that were allowed in the response. - - - - - - Indicates whether the returned list of parts is truncated. - - - - - - Gets and sets the Parts property. - - PartDetails is a container for elements related to a particular part. A response can contain - zero or more Part elements. - - - - - - Identifies who initiated the multipart upload. - - - - - - Gets and sets the Owner property. - - - - - The class of storage used to store the object. - - - - - - Date when multipart upload will become eligible for abort operation by lifecycle. - - - - - Id of the lifecycle rule that makes a multipart upload eligible for abort operation. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the ListVersions operation. - Returns metadata about all of the versions of objects in a bucket. - - - - - The bucket name that contains the objects. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - A delimiter is a character you use to group keys. - - - - - Specifies the key to start with when listing objects in a bucket. - - - - - Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more. - - - - - Limits the response to keys that begin with the specified prefix. - - - - - Specifies the object version you want to start listing from. - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - Returns information about the ListVersions response and response metadata. - - - - - A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria. If your results were - truncated, you can make a follow-up paginated request using the NextKeyMarker and NextVersionIdMarker response parameters as a starting - place in another request to return the rest of the results. - - - - - - Marks the last Key returned in a truncated response. - - - - - - Gets and sets the VersionIdMarker property. - Marks the last Version-Id returned in a truncated response. - - - - - Use this value for the key marker request parameter in a subsequent request. - - - - - - Use this value for the next version id marker parameter in a subsequent request. - - - - - - Gets and sets the Versions property. This is a list of - object versions in the bucket that match your search criteria. - - - - - Gets and sets the Name property. - The bucket's name. - - - - - Gets and sets the Prefix property. - Keys that begin with the indicated prefix are listed. - - - - - Gets and sets the MaxKeys property. - This is the maximum number of keys in the S3ObjectVersions collection. - The value is derived from the MaxKeys parameter to ListVersionsRequest. - - - - - Gets the CommonPrefixes property. - A response can contain CommonPrefixes only if you specify a delimiter. - When you do, CommonPrefixes contains all (if there are any) keys between - Prefix and the next occurrence of the string specified by delimiter. - - - - - Gets and sets the Delimiter property. - Causes keys that contain the same string between the prefix and the - first occurrence of the delimiter to be rolled up into a single result - element in the CommonPrefixes collection. - - - These rolled-up keys are not returned elsewhere in the response. - - - - - This class contains the meta data for an S3 object. - - - - - Gets and sets meta data for the object. Meta data names must start with "x-amz-meta-". If the name passeed in as the indexer - doesn't start with "x-amz-meta-" then it will be prepended. - - The name of the meta data. - The value for the meta data - - - - Adds the metadata to the collection, if the name already exists it will be overwritten. - - The name of the metadata element - The value for the metadata - - - - Gets the count of headers. - - - - - Gets the names of the meta data elements. - - - - - A metadata key-value pair to store with an object. - - - - - Key of metadata key-value pair - - - - - Value of metadata key-value pair - - - - - A container specifying replication metrics-related information, including whether - emitting metrics and Amazon S3 events for replication are enabled. In addition, contains - configurations related to specific metrics or events. Must be specified together with a - ReplicationTime block. - - - - - Specifies whether the replication metrics are enabled. - - - - - A container specifying the time threshold for emitting the - s3:Replication:OperationMissedThreshold event. - - - - - Class for MetricsAndOperatorPredicate - A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. - The operator must have at least two predicates, and an object must match all of the predicates - in order for the filter to apply. - - Note: The current implementation restricts the usage to atmost one MetricsPrefixPredicate - and any number of MetricsTagPredicates. - - - - Class for MetricsConfiguration - - - - - The ID used to identify the metrics configuration. - - - - - Specifies a metrics configuration filter. - The metrics configuration will only include objects that meet the filter's criteria. - A filter must be a prefix, a tag, or a conjunction (MetricsAndOperator). - - - - - Filter class for Metrics. - - - - - Filter Predicate setup for specific filter types. - - - - - Filter Predicate abstract class for specific filter types to be derived from. - - - - - Abstract class that can be used over logical filter predicates,i.e. AND/OR. - - - - - Class for MetricsPrefixPredicate - The prefix used when evaluating a metrics filter. - - - - - Class for MetricsTagPredicate - The tag used when evaluating a metrics filter. - - - - - This class contains the mfa codes used authentication - - - - - Gets and sets the serial number of the authentication device - - - - - Gets and sets the displated value on the authentication device - - - - - The formatted string of the mfa codes to be passed to S3. - - - - - Container for elements related to a particular multipart upload. - - - - - Date and time at which the multipart upload was initiated. - - - - - - Identifies who initiated the multipart upload. - - - - - - Key of the object for which the multipart upload was initiated. - - - - - - Gets and sets the Owner property. - - - - - The class of storage used to store the object. - - - - - - Upload ID that identifies the multipart upload. - - - - - - An abstract class for all the notification configurations associated with an Amazon S3 bucket. - - - - - Gets and sets the Events property. These are the events the configuration will listen to. - - - - - Filter criteria for determining which S3 objects trigger event notifications. - - - - - - The container element for Object Lock configuration parameters. - - - - - Gets and sets the property ObjectLockEnabled. - - Indicates whether this object has an Object Lock configuration enabled. - - - - - - Gets and sets the property Rule. - - The Object Lock rule in place for the specified object. - - - - - - A Legal Hold configuration for an object. - - - - - Gets and sets the property Status. - - Indicates whether the specified object has a Legal Hold in place. - - - - - - A Retention configuration for an object. - - - - - Gets and sets the property Mode. - - Indicates the Retention mode for the specified object. - - - - - - Gets and sets the property RetainUntilDate. - - - - - The container element for an Object Lock rule. - - - - - Gets and sets the property DefaultRetention. - - The default retention period that you want to apply to new objects placed in the specified - bucket. - - - - - - Describes the location where the restore job's output is stored. - - - - - Describes an S3 location that will receive the results of the restore request. - - - - - Describes how results of the Select job are serialized. - - - - - Describes the serialization of CSV-encoded Select results. - - - - - Specifies JSON as request's output serialization format. - - - - - The owner of an S3 bucket. - - - - - The display name of the owner. - - - - - The unique identifier of the owner. - - - - - This class contains custom querystring parameters for an S3 object, which can then be signed as part of a Pre-signed URL request - - - - - Gets and sets parameters for the object. Parameter names must start with "x-". If the name passeed in as the indexer - doesn't start with "x-" then it will be prepended. - - The name of the parameter. - The value for the meta data - - - - Adds the parameter to the collection, if the name already exists it will be overwritten. - - The name of the parameter - The value for the parameter - - - - Gets the count of parameters. - - - - - Gets the names of the parameter elements. - - - - - Specifies Parquet as object's input serialization format. - - - - - A container for elements related to a particular part in a multipart operation. - A response can contain zero or more Part elements. - - - - - The date and time at which the part was uploaded. - - - - - The size of the uploaded part data. - - - - - A container holding the part number and etag used when completing a multipart upload. - - - - - Default constructor. - - - - - Constructs an instance of PartETag and sets the part number and etag. - - The part number. - the associated ETag for the part number. - - - - Compares the current object with another object of the same type. - - An object to compare with this object. - - A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has the following meanings: - Value - Meaning - Less than zero - This object is less than the parameter. - Zero - This object is equal to . - Greater than zero - This object is greater than . - - - - - The part number identifying the part. - - - - - The entity tag associated with the part. - - - - - The container element for this bucket's public-policy status. - - - - - Gets and sets the property IsPublic. - - The public-policy status for this bucket. TRUE indicates that this bucket - is public. FALSE indicates that the bucket is not public. - - - - - - The container element for all Public Access Block configuration options. You can enable - the configuration options in any combination. - - - - Amazon S3 considers a bucket policy public unless at least one of the following conditions - is true: - -
  1. - - The policy limits access to a set of CIDRs using aws:SourceIp. For more - information on CIDR, see http://www.rfc-editor.org/rfc/rfc4632.txt - - -
  2. - - The policy grants permissions, not including any "bad actions," to one of the following: - -
    • - - A fixed AWS principal, user, role, or service principal - -
    • - - A fixed aws:SourceArn - -
    • - - A fixed aws:SourceVpc - -
    • - - A fixed aws:SourceVpce - -
    • - - A fixed aws:SourceOwner - -
    • - - A fixed aws:SourceAccount - -
    • - - A fixed value of s3:x-amz-server-side-encryption-aws-kms-key-id - -
    • - - A fixed value of aws:userid outside the pattern "AROLEID:*" - -
- - "Bad actions" are those that could expose the data inside a bucket to reads or writes - by the public. These actions are s3:Get*, s3:List*, s3:AbortMultipartUpload, - s3:Delete*, s3:Put*, and s3:RestoreObject. - - - - The star notation for bad actions indicates that all matching operations are considered - bad actions. For example, because s3:Get* is a bad action, s3:GetObject, - s3:GetObjectVersion, and s3:GetObjectAcl are all bad actions. - - - - - - Gets and sets the property BlockPublicAcls. - - Specifies whether Amazon S3 should block public ACLs for this bucket. Setting this - element to TRUE causes the following behavior: - -
  • - - PUT Bucket acl and PUT Object acl calls will fail if the specified ACL allows public - access. - -
  • - - PUT Object calls will fail if the request includes an object ACL. - -
- - Note that enabling this setting doesn't affect existing policies or ACLs. - - - - - - Gets and sets the property IgnorePublicAcls. - - Specifies whether Amazon S3 should ignore public ACLs for this bucket. Setting this - element to TRUE causes Amazon S3 to ignore all public ACLs on this bucket - and any objects that it contains. - - - - Note that enabling this setting doesn't affect the persistence of any existing ACLs - and doesn't prevent new public ACLs from being set. - - - - - - Gets and sets the property BlockPublicPolicy. - - Specifies whether Amazon S3 should block public bucket policies for this bucket. Setting - this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy - if the specified bucket policy allows public access. - - - - Note that enabling this setting doesn't affect existing bucket policies. - - - - - - Gets and sets the property RestrictPublicBuckets. - - Specifies whether Amazon S3 should restrict public bucket policies for this bucket. - If this element is set to TRUE, then only the bucket owner and AWS Services - can access this bucket if it has a public policy. - - - - Note that enabling this setting doesn't affect previously stored bucket policies, - except that public and cross-account access within any public bucket policy, including - non-public delegation to specific accounts, is blocked. - - - - - - Container for the parameters to the PutAcl operation. - uses the acl subresource to set the access control list (ACL) permissions for an object that already exists in a bucket - - - - - The canned ACL to apply to the bucket. - - - - - - Custom ACLs to be applied to the bucket or object. - - - - - The bucket name that contains the object to which you want to attach the ACL. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The key of an S3 object. - If not specified, the ACLs are applied to the bucket. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - If set and an object key has been specified, the ACLs are applied - to the specific version of the object. - This property is ignored if the ACL is to be set on a Bucket. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - Returns information about the PutObjectAcl response metadata. - The PutAcl operation has a void result type. - - - - - The response for the PutBucketAccelerateConfiguration operation. - Adds an object to a bucket. - - - - - Container for the parameters to the PutBucketAccelerateConfiguration request. - - - - - The name of the bucket to contain the object. - - - - - Accelerate configuration for the bucket. - - - - - Container for the parameters to the PutBucketAnalyticsConfiguration operation. - Sets an analytics configuration for the bucket (specified by the analytics configuration ID). - - - - - The name of the bucket to which an analytics configuration is stored. - - - - - The identifier used to represent an analytics configuration. - - - - - The configuration and any analyses for the analytics filter. - - - - - Returns information about the PutBucketAnalyticsConfigurationResponse response metadata. - The PutBucketAnalyticsConfigurationResponse operation has a void result type. - - - - - Container for the parameters to the PutBucketRequestPayment operation. - Creates a new server-side encryption configuration (or replaces an existing one, if present). - - - - - The name of the bucket for which the server-side encryption configuration is set. - - - - - The base64-encoded 128-bit MD5 digest of the server-side encryption configuration. - - - This header can be used as a message integrity check to verify that the data is the same data that was originally sent. - Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. - - - - - Container for server-side encryption configuration rules. Currently S3 supports one rule only. - - - - - Container for the parameters to the PutBucketRequestPayment operation. - Adds an inventory configuration (identified by the inventory ID) from the bucket. - - - - - The name of the bucket where the inventory configuration will be stored. - - - - - Specifies the inventory Id. - - - - - Specifies the inventory configuration. - - - - - Returns information about the PutInventoryConfigurationResponse response metadata. - The PutInventoryConfigurationResponse operation has a void result type. - - - - - Container for the parameters to the PutBucketLoggingRequest operation. - Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. To set the - logging status of a bucket, you must be the bucket owner. - - - - - Gets and sets the BucketName property. - - - - - Gets and sets the LoggingConfig property. - - - - - Returns information about the PutBucketLogging response metadata. - The EnableBucketLogging operation has a void result type. - - - - - Container for the parameters to the PutBucketMetricsConfigurationRequest operation. - Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. - - - - - The name of the bucket for which the metrics configuration is set. - - - - - The ID used to identify the metrics configuration. - - - - - Specifies the metrics configuration. - - - - - Returns information about the PutBucketMetricsConfiguration response metadata. - The PutBucketMetricsConfiguration operation has a void result type. - - - - - Container for the parameters to the PutBucketNotification operation. - Enables notifications of specified events for a bucket. - - - - - Gets and sets the BucketName property. - - - - - Gets and sets the TopicConfigurations property. TopicConfigurations are configuration for Amazon S3 - events to be sent to Amazon SNS topics. - - - - - Gets and sets the QueueConfigurations property. QueueConfigurations are configuration for Amazon S3 - events to be sent to Amazon SQS queues. - - - - - Gets and sets the LambdaFunctionConfigurations property. LambdaFunctionConfigurations are configuration for - Amazon S3 events to be sent to an Amazon Lambda cloud function. - - - - - Returns information about the PutBucketNotification response metadata. - The PutBucketNotification operation has a void result type. - - - - - Container for the parameters to the PutBucketPolicy operation. - Replaces a policy on a bucket. If the bucket already has a policy, the one in this request completely replaces it. - - - - - The name of the bucket. - - - - - The base64 encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. - - - This header can be used as a message integrity check to verify that the data is the same data that was originally sent. - Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. - - - - - The bucket policy as a JSON document. - - - - - Set this parameter to true to confirm that you want to remove your - permissions to change this bucket policy in the future. - - - - - Overriden to turn off sending SHA256 header. - - - - - Returns information about the PutBucketPolicy response metadata. - The PutBucketPolicy operation has a void result type. - - - - - Container for the parameters to the PutBucketReplication operation. - Sets replication configuration for your bucket. If a replication configuration exists, this replaces it. - - - - - The name of the bucket to have the replication configuration applied. - - - - - The replication configuration to be applied. - - - - - Gets and sets the property Token. - - - - - Returns information about the PutBucketReplicationConfiguration response metadata. - The PutBucketReplicationConfiguration operation has a void result type. - - - - - Container for the parameters to the PutBucket operation. - Creates a new bucket. - - - - - The canned ACL to apply to the bucket. - - - - - - If set to true the bucket will be created in the same region - as the configuration of the AmazonS3 client. - If PutBucketRequest.BucketRegion or PutBucketRequest.BucketRegionName are set they take precedence over - this property. - Default: true. - - - - - The name of the bucket to be created. - - - - - The region locality for the bucket. - - - When set, this will determine where your data will - reside in S3. Refer - for a list of possible values. - - - - - The bucket region locality expressed using the name of the region. - When set, this will determine where your data will reside in S3. - Valid values: us-east-1, us-west-1, us-west-2, eu-west-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, sa-east-1 - - - - - Gets and sets the property ObjectLockEnabledForBucket. - - Specifies whether you want S3 Object Lock to be enabled for the new bucket. - - - - - - Container for the parameters to the PutBucketRequestPayment operation. - Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This - configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the - download. - - - - - The name of the bucket to set payment config. - - - - - Gets and sets request payment configuration - - - - - Returns information about the PutBucketRequestPayment response metadata. - The PutBucketRequestPayment operation has a void result type. - - - - - Returns information about the PutBucket response and response metadata. - - - - - Container for the parameters to the PutBucketTagging operation. - Sets the tags for a bucket. - - - - - The name of the bucket to apply the tags to. - - - - - The collection of tags. - - - - - Returns information about the PutBucketTagging response metadata. - The PutBucketTagging operation has a void result type. - - - - - Container for the parameters to the PutBucketVersioning operation. - Sets the versioning state of an existing bucket. To set the versioning state, you must be the bucket owner. - - - - - The name of the bucket to be updated. - - - - - The MfaCodes Tuple associates the Serial Number and the current Token/Code displayed on the - Multi-Factor Authentication device associated with your AWS Account. - - - This is a required property for this request if:
- 1. EnableMfaDelete was configured on the bucket - containing this object's version.
- 2. You are deleting an object's version - - - - - Checks if the MfaCodes property is set. - - true if the MfaCodes property is set. - - - - The versioning configuration to apply to the bucket. - - - Once Versioning has been "Enabled" on a bucket, it can be "Suspended" - but cannot be switched "Off". If EnableMfaDelete is set, - the MfaCodes property needs to contain the Serial of and current Token - displayed on the MFA device. - - - - - Returns information about the PutBucketVersioning response metadata. - The PutBucketVersioning operation has a void result type. - - - - - Container for the parameters to the PutBucketWebsite operation. - Set the website configuration for a bucket. - - - - - The name of the bucket to apply the configuration to. - - - - - The website configuration to apply. The configuration defines the index - document suffix and custom error page. - - - - - Returns information about the PutBucketWebsite response metadata. - The PutBucketWebsite operation has a void result type. - - - - - Container for the parameters to the PutCORSConfiguration operation. - Sets the cors configuration for a bucket. - - - - - The name of the bucket to have the CORS configuration applied. - - - - - The CORS configuration to apply. - - - - - Returns information about the PutCORSConfiguration response metadata. - The PutCORSConfiguration operation has a void result type. - - - - - Container for the parameters to the PutLifecycleConfiguration operation. - Sets lifecycle configuration for your bucket. If a lifecycle configuration exists, it replaces it. - - - - - The name of the bucket to have the lifecycle configuration applied. - - - - - The lifecycle configuration to be applied. - - - - - Returns information about the PutLifecycleConfiguration response metadata. - The PutLifecycleConfiguration operation has a void result type. - - - - - Container for the parameters to the PutObjectLegalHold operation. - Applies a Legal Hold configuration to the specified object. - - - - - The bucket name containing the object that you want to place a Legal Hold on. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property ContentMD5. - - The MD5 signature for the configuration included in your request. - - - - - - Gets and sets the property Key. - - The key name for the object that you want to place a Legal Hold on. - - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Gets and sets the property LegalHold. - - Container element for the Legal Hold configuration you want to apply to the specified - object. - - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property VersionId. - - The version ID of the object that you want to place a Legal Hold on. - - - - - - This is the response object from the PutObjectLegalHold operation. - - - - - Gets and sets the property RequestCharged. - - - - - Container for the parameters to the PutObjectLockConfiguration operation. - Places an Object Lock configuration on the specified bucket. The rule specified in - the Object Lock configuration will be applied by default to every new object placed - in the specified bucket. - - - - - Gets and sets the property BucketName. - - The bucket whose Object Lock configuration you want to create or replace. - - - - - - Gets and sets the property ContentMD5. - - The MD5 signature for the configuration included in your request. - - - - - - Gets and sets the property ObjectLockConfiguration. - - The Object Lock configuration that you want to apply to the specified bucket. - - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property Token. - - - - - This is the response object from the PutObjectLockConfiguration operation. - - - - - Gets and sets the property RequestCharged. - - - - - Container for the parameters to the PutObject operation. - Adds an object to a bucket. - - - Container for the parameters to the PutObject operation. - Adds an object to a bucket. - - - - - A canned access control list (CACL) to apply to the object. - Please refer to for - information on S3 Canned ACLs. - - - - - Input stream for the request; content for the request will be read from the stream. - - - - - - The full path and name to a file to be uploaded. - If this is set the request will upload the specified file to S3. - - - For WinRT and Windows Phone this property must be in the form of "ms-appdata:///local/file.txt". - - - - - - Text content to be uploaded. Use this property if you want to upload plaintext to S3. - The content type will be set to 'text/plain'. - - - - - If this value is set to true then the stream used with this request will be closed when all the content - is read from the stream. - Default: true. - - - - - If this value is set to true then the stream will be seeked back to the start before being read for upload. - Default: true. - - - - - If this value is set to true then a chunked encoding upload will be used for the request. - Default: true. - - - - - Bucket name to which the PUT operation was initiated. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - Gets and sets Key property. This key is used to identify the object in S3. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - Checks if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - true if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - - - The type of storage to use for the object. Defaults to 'STANDARD'. - - - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - The Legal Hold status that you want to apply to the specified object. - - - - - - Gets and sets the property ObjectLockMode. - - The Object Lock mode that you want to apply to this object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - The date and time when you want this object's Object Lock to expire. - - - - - - If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - Attach a callback that will be called as data is being sent to the AWS Service. - - - - - This is a convenience property for Headers.ContentType. - - - - - An MD5 digest for the content. - - - - The base64 encoded 128-bit MD5 digest of the message - (without the headers) according to RFC 1864. This header - can be used as a message integrity check to verify that - the data is the same data that was originally sent. - - - If supplied, after the file has been uploaded to S3, - S3 checks to ensure that the MD5 hash of the uploaded file - matches the hash supplied. - - - Although it is optional, we recommend using the - Content-MD5 mechanism as an end-to-end integrity check. - - - - - - Checks if MD5Digest property is set. - - true if MD5Digest property is set. - - - - Overriden to turn off sending SHA256 header. - - - - - Overriden to turn on expect 100 continue. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - The tag-set for the object. The tag-set must be encoded as URL Query parameters. - - - - - Checks if Tagging property is set - - true if Tagging is set. - - - - Returns information about the PutObject response and response metadata. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - Entity tag for the uploaded object. - - - - - - Version of the object. - - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the PutObjectRetention operation. - Places an Object Retention configuration on an object. - - - - - The bucket name that contains the object you want to apply this Object Retention configuration to. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property BypassGovernanceRetention. - - - - - Gets and sets the property ContentMD5. - - The MD5 signature for the configuration included in your request. - - - - - - Gets and sets the property Key. - - The key name for the object that you want to apply this Object Retention configuration - to. - - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property Retention. - - The container element for the Object Retention configuration. - - - - - - Gets and sets the property VersionId. - - The version ID for the object that you want to apply this Object Retention configuration - to. - - - - - - This is the response object from the PutObjectRetention operation. - - - - - Gets and sets the property RequestCharged. - - - - - Container for the parameters to the PutObjectTagging operation. - - - - - The bucket name containing the object. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Check to see if Bucket property is set - - - - - Gets and sets Key property. This key is used to identify the object in S3. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Check to see if Key property is set - - - - - The tag-set for the object. The tag-set must be encoded as URL Query parameters - - - - - Checks if Tagging property is set. - - - - - VersionId used to reference a specific version of the object. - - - - - - Returns information about the PutObjectTagging response and response metadata. - - - - - Version of the object. - - - - - Container for the parameters to the PutPublicAccessBlock operation. - Creates or modifies the Public Access Block configuration for an Amazon S3 bucket. - - - - - Gets and sets the property BucketName. - - The name of the Amazon S3 bucket whose Public Access Block configuration you want - to set. - - - - - - Gets and sets the property ContentMD5. - - The MD5 hash of the PutPublicBlock request body. - - - - - - Gets and sets the property PublicAccessBlockConfiguration. - - The Public Access Block configuration that you want to apply to this Amazon S3 bucket. - - - - - - This is the response object from the PutPublicAccessBlock operation. - - - - - Base class for put operations that can also put an ACL. - - - - - Gets the access control lists (ACLs) for this request. - Please refer to for information on - S3 Grants. - - - - - This class contains the configuration Amazon S3 uses to figure out what events you want to listen - and send the event to an Amazon SQS queue. - - The queue's policy must allow S3 to send messages to it. The utility method - Amazon.SQS.AmazonSQSClient.AuthorizeS3ToSendMessage(string,string) - can be used to help setup the queue policy. - - - - - - Gets and set the Id property. The Id will be provided in the event content and can be used - to identify which configuration caused an event to fire. If the Id is not provided for the configuration, one will be generated. - - - - - Gets and sets the Queue property. Amazon SQS queue to which Amazon S3 will publish a message - to report the specified events for the bucket. - - The queue's policy must allow S3 to send messages to it. The utility method - Amazon.SQS.AmazonSQSClient.AuthorizeS3ToSendMessage(string,string) - can be used to help setup the queue policy. - - - - - - This class defines the configuration for replication. - - - - - Indicates the ARN of the role to assume. - - - - - Check to see if the Role property is set. - - true if the Role property is set. - - - - Container for information about a particular replication rule. - Replication configuration must have at least one rule and can contain up to 1,000 rules. - - - - - Checks to see if the Rules property is set. - - true if the Rules property is set. - - - - Destination configuration for a replication rule. - - - - -

Amazon resource name (ARN) of the bucket where you want Amazon - S3 to store replicas of the object identified by the rule.

- If you have multiple rules in your replication configuration, all - rules must specify the same bucket as the destination. A replication - configuration can replicate objects only to one destination bucket.

- - - - - Checks to see if BucketArn property is set. - - true if BucketArn property is set. - - - - The class of storage used to store the object. - - - - - -

Account ID of the destination bucket. Currently Amazon S3 verifies this - value only if Access Control Translation is enabled.

In a cross-account - scenario, if you tell Amazon S3 to change replica ownership to the AWS account - that owns the destination bucket by adding the AccessControlTranslation - element, this is the account ID of the destination bucket owner.

- - - - -

Container for information regarding the access control for replicas.

-

Use only in a cross-account scenario, where source and destination bucket - owners are not the same, when you want to change replica ownership to the AWS - account that owns the destination bucket. If you don't add this element to the - replication configuration, the replicas are owned by same AWS account that - owns the source object.

- - - - -

Container that provides encryption-related information. You must - specify this element if the SourceSelectionCriteria is - specified.

- - - - - A container specifying the time when all objects and operations on objects are - replicated. Must be specified together with a Metrics block. - - - - - A container specifying replication metrics-related information, including whether - emitting metrics and Amazon S3 events for replication are enabled. In addition, - contains configurations related to specific metrics or events. Must be specified - together with a ReplicationTime block. - - - - - Rule that specifies the replication configuration. - - - - - Unique identifier for the rule. The value cannot be longer than 255 characters. - - - - - Checks to see if Id property is set. - - true if Id property is set. - - - -

The priority associated with the rule. If you specify multiple rules in a - replication configuration, then Amazon S3 applies rule priority in the event - there are conflicts (two or more rules identify the same object based on - filter specified). The rule with higher priority takes precedence. For - example,

  • Same object quality prefix based filter criteria - If prefixes you specified in multiple rules overlap.

  • Same - object qualify tag based filter criteria specified in multiple rules

    • -

For more information, see - - Cross-Region Replication (CRR) in the Amazon S3 Developer Guide.

- - - - - Checks to see if Priority property is set. - - true if Priority property is set. - - - - Object keyname prefix identifying one or more objects to which the - rule applies. Maximum prefix length can be up to 1,024 characters. - - - - - Checks to see if Prefix property is set. - - true if Prefix property is set. - - - - Gets and sets the property Filter. - - - - - Checks to see if Filter property is set. - - true if Filter property is set. - - - - Whether the rule is applied or ignored. - - - - - Checks to see if Status property is set. - - true if Status property is set. - - - - Container for replication destination information. - - - - - Checks to see if Destination property is set. - - true if Destination property is set. - - - -

Container that describes additional filters in identifying source objects that - you want to replicate. Currently, Amazon S3 supports only the filter that you can - specify for objects created with server-side encryption using an AWS KMS-managed - key. You can choose to enable or disable replication of these objects.

if - you want Amazon S3 to replicate objects created with server-side encryption using - AWS KMS-managed keys.

- - - - - A container that specifies information about existing object replication. - You can choose whether to enable or disable the replication of existing objects. - - - - - Checks to see if ExistingObjectReplication property is set. - - true if ExistingObjectReplication property is set. - - - - Specifies whether Amazon S3 should replicate delete makers. - - - - - Checks to see if DeleteMarkerReplication property is set. - - true if DeleteMarkerReplication property is set. - - - - - - - - Object keyname prefix that identifies subset of objects to which the rule applies. - - - - - Checks to see if Prefix property is set. - - true if Prefix property is set. - - - - All of these tags must exist in the object's tag set in order for the rule to apply. - - - - - Checks to see if Tags property is set. - - true if Tags property is set. - - - - Filter that identifies subset of objects to which the replication rule applies. - A Filter must specify exactly one Prefix, - Tag, or an And child element. - - - - - Object keyname prefix that identifies subset of objects to which the rule applies. - - - - - Checks to see if Prefix property is set. - - true if Prefix property is set. - - - -

Container for specifying a tag key and value.

-

The rule applies only to objects having the tag in its tagset.

- - - - - Checks to see if Tag property is set. - - true if Tag property is set. - - - -

Container for specifying rule filters. These filters determine the - subset of objects to which the rule applies. The element is required - only if you specify more than one filter. For example:

  • -

    You specify both a Prefix and a Tag - filters. Then you wrap these in an And tag.

    • -

  • You specify filter based on multiple tags. Then you wrap the - Tag elements in an And tag.

- - - - - Checks to see if And property is set. - - true if And property is set. - - - - A container specifying the time when all objects and operations on objects are replicated. Must be specified together with a Metrics block. - - - - - Specifies whether the replication time is enabled. - - - - - A container specifying the time by which replication should complete for all objects and operations on objects. - - - - - A container specifying the time value. - - - - - Contains an integer specifying time in minutes. - - - - - Request Payment Configuration - - - - - Specifies who pays for the download and request fees. - - - - - Container for values of the response headers that will be set on a response from a GetObject request. - These values override any headers that were set when the object was uploaded to S3. - - - - - A standard MIME type describing the format of the object data. - - - The content type for the content being uploaded. This property defaults to "binary/octet-stream". - For more information, refer to: - - - - - ContentLanguage header value. - - - - - Expiry header value. - - - - - CacheControl header value. - - - - - The ContentDisposition header value. - - - - - The ContentEncoding header value. - - - - - Container for the parameters to the RestoreObject operation. - Restores an archived copy of an object back into Amazon S3 - - - - - The bucket name or containing the object to restore. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the Key property. This key indicates the S3 object to restore. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Lifetime of the active copy in days - ** Do not use with restores that specify OutputLocation ** - - - - - VersionId used to reference a specific version of the object. - - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Glacier retrieval tier at which the restore will be processed. - ** Do not use with restores that specify OutputLocation ** - - - - - Glacier retrieval tier at which the restore will be processed. - ** Only use with restores that require OutputLocation ** - - - - - Type of restore request. - - - - - The optional description for the job. - - - - - Describes the parameters for Select job types. - - - - - Describes the location where the restore job's output is stored. - - - - - Returns information about the RestoreObject response metadata. - The RestoreObject operation has a void result type. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Indicates the path in the provided S3 output location where Select results will be restored to. - - - - Routing Rule - - - - - A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the - /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might - process the error. - - - - - - Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event of an - error, you can can specify a different error code to return. - - - - - - A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages - in the /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you - might process the error. - - - - - The HTTP error code when the redirect is applied. In the event of an error, if the error code equals this value, then the specified redirect - is applied. Required when parent element Condition is specified and sibling KeyPrefixEquals is not specified. If both are specified, then - both must be true for the redirect to be applied. - - - - - - The object key name prefix when the redirect is applied. For example, to redirect requests for ExamplePage.html, the key prefix will be - ExamplePage.html. To redirect request for all pages with the prefix docs/, the key prefix will be /docs, which identifies all objects in the - docs/ folder. Required when the parent element Condition is specified and sibling HttpErrorCodeReturnedEquals is not specified. If both - conditions are specified, both must be true for the redirect to be applied. - - - - - - Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event - of an error, you can can specify a different error code to return. - - - - - Name of the host where requests will be redirected. - - - - - - The HTTP redirect code to use on the response. Not required if one of the siblings is present. - - - - - - Protocol to use (http, https) when redirecting requests. The default is the protocol that is used in the original request. - - - - - - The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix docs/ (objects in the - docs/ folder) to documents/, you can set a condition block with KeyPrefixEquals set to docs/ and in the Redirect set ReplaceKeyPrefixWith to - /documents. Not required if one of the siblings is present. Can be present only if ReplaceKeyWith is not provided. - - - - - - The specific object key to use in the redirect request. For example, redirect request to error.html. Not required if one of the sibling is - present. Can be present only if ReplaceKeyPrefixWith is not provided. - - - - - - Represents an access control list (ACL) for S3. An AccessControlList is represented by an Owner, - and a List of Grants, where each Grant is a Grantee and a Permission. - - - - Each bucket and object in Amazon S3 has an ACL that defines its access control policy. - When a request is made, Amazon S3 authenticates the request using its standard - authentication procedure and then checks the ACL to verify the sender was granted access - to the bucket or object. If the sender is approved, the request proceeds. - Otherwise, Amazon S3 returns an error. - - - An ACL is a list of grants. A grant consists of one grantee and one permission. - ACLs only grant permissions; they do not deny them. - - - For convenience, some commonly used Access Control Lists are defined in - S3CannedACL. - - - Note: BucketName and object ACLs are completely independent; an object does not inherit the ACL - from its bucket. For example, if you create a bucket and grant write access to another user, - you will not be able to access the user's objects unless the user explicitly grants access. - This also applies if you grant anonymous write access to a bucket. Only the user "anonymous" - will be able to access objects the user created unless permission is explicitly granted to - the bucket owner. - - - Important: We highly recommend that you do not grant the anonymous group write access to your - buckets as you will have no control over the objects others can store and their associated charges. - For more information, see Grantees and Permissions - - - - - Creates a S3Grant and adds it to the list of grants. - - The grantee for the grant. - The permission for the grantee. - - - - Removes a specific permission for the given grantee. - - The grantee - The permission for the grantee to remove - - - - Removes all permissions for the given grantee. - - - - - - The owner of the bucket or object. - - - - Every bucket and object in Amazon S3 has an owner, the user that - created the bucket or object. The owner of a bucket or object cannot - be changed. However, if the object is overwritten by another user - (deleted and rewritten), the new object will have a new owner. - - - Note: Even the owner is subject to the ACL. For example, if an owner - does not have Permission.READ access to an object, the owner cannot read - that object. However, the owner of an object always has write access to the - access control policy (Permission.WriteAcp) and can change the ACL to - read the object. - - - - - - Checks if Owner property is set. - - true if Owner property is set. - - - - A collection of grants. - - - - - Checks if Grants property is set. - - true if Grants property is set. - - - Bucket - Represents an S3 bucket, contains the name of the S3 bucket and the date that the bucket was created. - - - - - Date the bucket was created. - - - - - - The name of the bucket. - - - - - Logging Enabled - - - - - Specifies the bucket where you want Amazon S3 to store server access logs. You can have your logs delivered to any bucket that you own, - including the same bucket that is being logged. You can also configure multiple buckets to deliver their logs to the same target bucket. In - this case you should choose a different TargetPrefix for each source bucket so that the delivered log files can be distinguished by key. - - - - - A collection of grants. - - - - - This element lets you specify a prefix for the keys that the log files will be stored under. - - - - - Creates a S3Grant and adds it to the list of grants. - - The grantee for the grant. - The permission for the grantee. - - - - Removes a specific permission for the given grantee. - - The grantee - The permission for the grantee to remove - - - - Removes all permissions for the given grantee. - - - - - - An S3 bucket versioning configuration. - - - Contains the bucket's versioning status (Off, Enabled, Suspended) and whether an MFADelete - has been enabled for the bucket. - - - - - Versioning status for the bucket. - Accepted values: Off, Enabled, Suspended. - - - - - Checks if Status property is set - - true if Status property is set - - - - Specifies whether MFA Delete is enabled on this S3 Bucket. - - - If this property is set, please ensure that the - PutBucketVersioningRequest's MfaCodes property is set with - the Serial of and Token on the MFA device. - - - - - Checks if EnableMfaDelete property is set. - - true if Status property is set - - - - Describes the server-side encryption that will be applied to the restore results. - - - - - The server-side encryption algorithm used when storing job results in Amazon S3 (e.g., AES256, aws:kms). - - - - - Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by - AWS KMS will fail if not made via SSL or using SigV4. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at - http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version - - - - - If the encryption type is aws:kms, this optional value can be used to specify the encryption context for the restore results. - - - - Grant - - - - - The grantee details. - - - - - Specifies the permission given to the grantee. - - - - - Grantee - - - - - Type of grantee - - - - - - Screen name of the grantee. - - - - - - Email address of the grantee. - - - - - - The canonical user ID of the grantee. - - - - - - URI of the grantee group. - - - - - - Filter criteria that allows for event notification filtering based on an S3 Object's key name. - - - - - Gets and sets the filterRules property. - These are the filter rules for this filter. - - - - - Describes an S3 location that will receive the results of the restore request. - - - - - The name of the bucket where the restore results will be placed. - - - - - The prefix that is prepended to the restore results for this request. - - - - - The canned ACL to apply to the restore results. - - - - - A list of grants that control access to the staged results. - - - - - The tag-set that is applied to the restore results. - - - - - A map of metadata to store with the restore results in S3. - - - - - The class of storage used to store the restore results. - - - - - Represents an S3 Object. Contains all attributes that an S3 Object has. - For more information about S3 Objects refer: - - - - - - Any ETag set on the object. - - - - - The name of the bucket containing this object. - - - - - The key of the object. - - - - - The date and time the object was last modified. - - The date retrieved from S3 is in ISO8601 format. A GMT formatted date is passed back to the user. - - - - - - The owner of the object. - - - - - The size of the object. - - - - - The class of storage used to store the object. - - - - - - Represents a version of an object in an S3 Bucket. An S3 object version is an S3 object - that also has a version identifier, an indication of whether this is the latest version of the object - and whether it's a DeleteMarker or not. - - - - - Specifies whether the object is (true) or is not (false) the latest version of an object. - - - - - Version ID of an object. - - - - - If true, the object is a delete marker for a deleted object. - - - - - Specifies the byte range of the object to get the records from. A record is processed when its first byte is contained by the range. - - - - - Specifies the start of the byte range. This parameter is optional. Valid values: non-negative integers. The default value is 0. - - - - - Specifies the end of the byte range. This parameter is optional. Valid values: non-negative integers. The default value is one less than the size of the object being queried. - - - - - Request to filter the contents of an Amazon S3 object based on a simple Structured Query Language (SQL) statement. - - In the request, along with the SQL expression, you must also specify a data serialization format (JSON or CSV) of the object. - Amazon S3 uses this to parse object data into records, and returns only records - that match the specified SQL expression. You must also specify the data serialization format for the response. - - - - S3Select API Documentation - - - - - The S3 Bucket. - - - - - The Object Key. - - - - - The SSE Algorithm used to encrypt the object. - - - Server-Side Encryption (Using Customer-Provided Encryption Keys. - - - - - The SSE Customer Key. - - - Server-Side Encryption (Using Customer-Provided Encryption Keys. - - - - - The SSE Customer Key MD5. - - - Server-Side Encryption (Using Customer-Provided Encryption Keys. - - - - - The expression that is used to query the object. - - - - - The type of the provided expression (e.g., SQL). - - - - - Specifies if periodic request progress information should be enabled. - - - - - Describes the format of the data in the object that is being queried. - - - - - Describes the format of the data that you want Amazon S3 to return in response. - - - - - The byte range of the object to get the records from. - - - - - Contains the response Payload for the SelectObjectContent request - - - - - The Event Stream result of SelectObjectContent - - - - - Describes the parameters for Select job types. - - - - - Describes the serialization format of the object. - - - - - The type of the provided expression (e.g., SQL). - - - - - The expression that is used to query the object. - - - - - Describes how the results of the Select job are serialized. - - - - - ServerSideEncryptionByDefault class - - - - - Server-side encryption algorithm to use for the default encryption. - - - - - KMS master key ID to use for the default encryption. - This parameter is allowed if SSEAlgorithm is aws:kms. - - - - - ServerSideEncryptionConfiguration class - - - - - Container for information about a particular server-side encryption configuration rule. - - - - - ServerSideEncryptionRule class - - - - - Describes the default server-side encryption to apply to - new objects in the bucket. If Put Object request - does not specify any server-side encryption, - this default encryption will be applied. - - - - - SourceSelectionCriteria class - - - - - Container for filter information of selection of KMS Encrypted - S3 objects. The element is required if you include - SourceSelectionCriteria in the replication - configuration. - - - - - SSEKMS class - - - - - Specifies the ID of the AWS Key Management Service (KMS) - master encryption key to use for encrypting Inventory reports. - - - - - SseKmsEncryptedObjects class - - - - - The replication for KMS encrypted S3 objects is disabled if status is not Enabled. - - - - - SSES3 class - - - - - Class for StorageClassAnalysis - - - - - A container used to describe how data related to the storage class analysis should be exported. - - - - - Class for StorageClassAnalysisDataExport - - - - - The version of the output schema to use when exporting data. Must be V_1. - - - - - The place to store the data for an analysis. - - - - - Base class for responses that return a stream. - - - - - Disposes of all managed and unmanaged resources. - - - - - An open stream read from to get the data from S3. In order to - use this stream without leaking the underlying resource, please - wrap access to the stream within a using block. - - - - - The exception that is thrown when the size of a stream does not match it's expected size. - - - - - Gets and sets ExpectedSize property. - - - - - Gets and sets ActualSize property. - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - - - Tag is a key-value pair of metadata associated with an S3Object - - - - - Name of the tag. - - - - - Value of the tag. - - - - - Structure that contains list of Tags - - - - - TagSet - - - - - This class contains the configuration Amazon S3 uses to figure out what events you want to listen - and send the event to an Amazon SNS topic. - - The topic's policy must allow S3 to publish messages to it. The utility method - Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.AuthorizeS3ToPublish(string,string) - can be used to help setup the topic policy. - - - - - - Gets and set the Id property. The Id will be provided in the event content and can be used - to identify which configuration caused an event to fire. If the Id is not provided for the configuration, one will be generated. - - - - - Bucket event for which to send notifications. - - Topic configurations can now contain multiple events. This property is obsolete in favor of the Events property. - This property will always get or set the the zeroth element in the Events collection. - - - - - - Gets and sets the Topic property. Amazon SNS topic to which Amazon S3 will publish a message to report the - specified events for the bucket. - - The topic's policy must allow S3 to publish messages to it. The utility method - Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.AuthorizeS3ToPublish(string,string) - can be used to help setup the topic policy. - - - - - - The parameters to request upload of a part in a multipart upload operation. - - - - If PartSize is not specified then the rest of the content from the file - or stream will be sent to Amazon S3. - - - You must set either the FilePath or InputStream. If FilePath is set then the FilePosition - property must be set. - - - - The parameters to request upload of a part in a multipart upload operation. - - - - If PartSize is not specified then the rest of the content from the file - or stream will be sent to Amazon S3. - - - You must set either the FilePath or InputStream. If FilePath is set then the FilePosition - property must be set. - - - - - - Caller needs to set this to true when uploading the last part. This property only needs to be set - when using the AmazonS3EncryptionClient. - - - - - Input stream for the request; content for the request will be read from the stream. - - - - - The name of the bucket containing the object to receive the part. - - - - - The key of the object. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Part number of part being uploaded. - - - - - - The size of the part to be uploaded. - - - - - Checks if PartSize property is set. - - true if PartSize property is set. - - - - Upload ID identifying the multipart upload whose part is being uploaded. - - - - - - An MD5 digest for the part. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - - Full path and name of a file from which the content for the part is retrieved. - - - For WinRT and Windows Phone this property must be in the form of "ms-appdata:///local/file.txt". - - - - - - Checks if the FilePath property is set. - - true if FilePath property is set. - - - - Position in the file specified by FilePath from which to retrieve the content of the part. - This field is required when a file path is specified. It is ignored when using the InputStream property. - - - - - If this value is set to true then a chunked encoding upload will be used for the request. - Default: true. - - - - - Checks if the FilePosition property is set. - - true if FilePosition property is set. - - - - Checks if the MD5Digest property is set. - - true if Md5Digest property is set. - - - - Attach a callback that will be called as data is being sent to the AWS Service. - - - - - Overriden to turn off sending SHA256 header. - - - - - Overriden to turn on Expect 100 continue. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the UploadPart response and response metadata. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - Entity tag for the uploaded object. - - - - - - Gets and sets the part number specified for the part upload. This is needed when - completing the multipart upload. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - Website Configuration - - - - - The ErrorDocument value, an object key name to use when a 4XX class error occurs. - - - - - - This value is a suffix that is appended to a request that is for a "directory" - on the website endpoint (e.g. if the suffix is index.html and - you make a request to samplebucket/images/ the data that - is returned will be for the object with the key name - images/index.html) - - - The suffix must not be empty and must not include a slash - character. - - - - - - Container for redirect information where all requests will be redirect - to. You can redirect requests to another host, to another page, or with - another protocol. In the event of an error, you can can specify a - different error code to return. . - - - - - The list of routing rules that can be used for configuring redirects if certain conditions are meet. - - - - - Arguments containing event details for an in-flight transfer. - - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - - - - Gets the percentage of transfer completed - - - - - Gets the number of bytes transferred since last event - - - - - Gets the number of bytes transferred - - - - - Gets the total number of bytes to be transferred - - - - - Returns a string representation of this object - - - - - - AmazonS3 exception. - Thrown when DeleteObjects returns successfully, but some of the objects - were not deleted. - - - - - Gets and sets the ErrorResponse property. - The DeleteObjectsErrorResponse associated with this exception. - - - - - Constructs an instance of DeleteObjectsException - - - - - - The file format used when exporting data to Amazon S3. - - - - - CSV file format. - - - - - Construct instance of AnalyticsS3ExportFileFormat. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to an AnalyticsS3ExportFileFormat. - - - - - - - Represents the accelerate status for a bucket. - - - - - Bucket acceleration is enabled. - - - - - Bucket acceleration is suspended. - - - - - Construct instance of BucketAccelerateStatus. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to an BucketAccelerateStatus - - - - - - - The status of the delete marker replication. - - - - - Delete marker replication is enabled. - - - - - Delete marker replication is disabled. - - - - - Construct instance of DeleteMarkerReplicationStatus. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to a DeleteMarkerReplicationStatus - - - - - - - A list of all possible CannedACLs that can be used - for S3 Buckets or S3 Objects. For more information about CannedACLs, refer to - . - - - - - Owner gets FULL_CONTROL. - No one else has access rights (default). - - - - - Owner gets FULL_CONTROL. - No one else has access rights (default). - - - - - Owner gets FULL_CONTROL and the anonymous principal is granted READ access. - If this policy is used on an object, it can be read from a browser with no authentication. - - - - - Owner gets FULL_CONTROL, the anonymous principal is granted READ and WRITE access. - This can be a useful policy to apply to a bucket, but is generally not recommended. - - - - - Owner gets FULL_CONTROL, and any principal authenticated as a registered Amazon - S3 user is granted READ access. - - - - - Owner gets FULL_CONTROL. Amazon EC2 gets READ access to GET an - Amazon Machine Image (AMI) bundle from Amazon S3. - - - - - Object Owner gets FULL_CONTROL, Bucket Owner gets READ - This ACL applies only to objects and is equivalent to private when used with PUT Bucket. - You use this ACL to let someone other than the bucket owner write content (get full control) - in the bucket but still grant the bucket owner read access to the objects. - - - - - Object Owner gets FULL_CONTROL, Bucket Owner gets FULL_CONTROL. - This ACL applies only to objects and is equivalent to private when used with PUT Bucket. - You use this ACL to let someone other than the bucket owner write content (get full control) - in the bucket but still grant the bucket owner full rights over the objects. - - - - - The LogDelivery group gets WRITE and READ_ACP permissions on the bucket. - - - - - Construct instance of S3CannedACL. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to an S3CannedACL - - - - - - - A list of all possible S3 Bucket region possibilities. For - more information, refer to - . - - - - - Specifies that the S3 Bucket should use US locality. - This is the default value. - - - - - Specifies that the S3 Bucket should use US-EAST-2 locality. - - - - - Specifies that the S3 Bucket should use EU locality which defaults to EU-WEST-1 - - - - - Specifies that the S3 Bucket should use the EU-NORTH-1 locality. - - - - - Specifies that the S3 Bucket should use the EU-WEST-1 locality. - - - - - Specifies that the S3 Bucket should use the EU-WEST-2 locality. - - - - - Specifies that the S3 Bucket should use the EU-WEST-3 locality. - - - - - Specifies that the S3 Bucket should use the EU-CENTRAL-1 locality. - - - - - Specifies that the S3 Bucket should use US-WEST-1 locality. - - - - - Specifies that the S3 Bucket should use US-WEST-2 locality. - - - - - Specifies that the S3 Bucket should use US-GOV-EAST-1 locality. - - - - - Specifies that the S3 Bucket should use US-GOV-WEST-1 locality. - - - - - Specifies that the S3 Bucket should use the AP-EAST-1 locality. - - - - - Specifies that the S3 Bucket should use the AP-SOUTHEAST-1 locality. - - - - - Specifies that the S3 Bucket should use the AP-SOUTHEAST-2 locality. - - - - - Specifies that the S3 Bucket should use the AP-NORTHEAST-1 locality. - - - - - Specifies that the S3 Bucket should use the AP-NORTHEAST-2 locality. - - - - - Specifies that the S3 Bucket should use the AP-NORTHEAST-3 locality. - - - - - Specifies that the S3 Bucket should use the AP-SOUTH-1 locality. - - - - - Specifies that the S3 Bucket should use the SA-EAST-1 locality. - - - - - Specifies that the S3 Bucket should use CN-NORTH-1 locality. - - - - - Specifies that the S3 Bucket should use CN-NORTHWEST-1 locality. - - - - - Specifies that the S3 Bucket should use CA-CENTRAL-1 locality. - - - - - Specifies that the S3 Bucket should use US-WEST-1 locality. - - - - - Specifies that the S3 Bucket should use CN-NORTH-1 locality. - - - - - Specifies that the S3 Bucket should use US-GOV-WEST-1 locality. - - - - - Construct instance of S3Region. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to the S3Region class - - - - - - - A list of all ACL permissions. For more information, refer to - . - - - - - When applied to a bucket, grants permission to list the bucket. - When applied to an object, this grants permission to read the - object data and/or metadata. - - - - - When applied to a bucket, grants permission to create, overwrite, - and delete any object in the bucket. This permission is not - supported for objects. - - - - - Grants permission to read the ACL for the applicable bucket or object. - The owner of a bucket or object always has this permission implicitly. - - - - - Gives permission to overwrite the ACP for the applicable bucket or object. - The owner of a bucket or object always has this permission implicitly. - Granting this permission is equivalent to granting FULL_CONTROL because - the grant recipient can make any changes to the ACP. - - - - - Provides READ, WRITE, READ_ACP, and WRITE_ACP permissions. - It does not convey additional rights and is provided only for convenience. - - - - - Gives permission to restore an object that is currently stored in Amazon Glacier - for archival storage. - - - - - Construct S3Permission. - - - - - - Construct instance of S3Permission. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - - Gets and sets the HeaderName property. - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to an S3Permission - - - - - - - An enumeration of all Metadata directives that - can be used for the CopyObject operation. - - - - - Specifies that the metadata is copied from the source object. - - - - - Specifies that the metadata is replaced with metadata provided in the request. - All original metadata is replaced by the metadata you specify. - - - - - An enumeration of all protocols that the pre-signed - URL can be created against. - - - - - https protocol will be used in the pre-signed URL. - - - - - http protocol will be used in the pre-signed URL. - - - - - An enumeration of supported HTTP verbs - - - - - The GET HTTP verb. - - - - - The HEAD HTTP verb. - - - - - The PUT HTTP verb. - - - - - The DELETE HTTP verb. - - - - - S3 Storage Class Definitions - - - - - The STANDARD storage class, which is the default - storage class for S3. - - Durability 99.999999999%; Availability 99.99% over a given year. - - - - - REDUCED_REDUNDANCY provides the same availability as standard, but at a lower durability. - - Durability 99.99%; Availability 99.99% over a given year. - - - - - The GLACIER storage is for object that are stored in Amazon Glacier. - This storage class is for objects that are for archival purpose and - get operations are rare. - - Durability 99.999999999% - - - - - The STANDARD_IA storage is for infrequently accessed objects. - This storage class is for objects that are long-lived and less frequently accessed, - like backups and older data. - - Durability 99.999999999%; Availability 99.9% over a given year. - - - - - The ONEZONE_IA storage is for infrequently accessed objects. It is similiar to STANDARD_IA, but - only stores object data within one Availablity Zone in a given region. - - Durability 99.999999999%; Availability 99% over a given year. - - - - - IntelligentTiering makes it easy to lower your overall cost of storage by automatically placing data in the storage - class that best matches the access patterns for the storage. With IntelligentTiering, you don’t need to define - and manage individual policies for lifecycle data management or write code to transition objects - between storage classes. Instead, you can use IntelligentTiering to manage transitions between Standard and - S-IA without writing any application code. IntelligentTiering also manages transitions automatically to - Glacier for long term archive in addition to S3 storage classes. - - - - - S3 Glacier Deep Archive provides secure, durable object storage class for long term data archival. - It is the ideal storage class to make an archival, durable copy of data that rarely, if ever, needs to be accessed. - It can be used as an offline backup for their most important data assets and to meet long-term retention needs. - - - - - Construct an instance of S3StorageClass. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to S3StorageClass. - - - - - - - The constants for the known event names used by S3 notification. S3 might add new - events before the SDK is updated. In which case the names listed in the S3 documentation - will work as well as these constants. - - - - - An event that says an object has been lost in the reduced redundancy storage. - - - - - A list of all server-side encryption methods for customer provided encryption keys. - - - - - No server side encryption to be used. - - - - - Use AES 256 server side encryption. - - - - - Constructs an instance of ServerSideEncryptionCustomerMethod. - - - - - - Finds the constant for the unique value. - - - - - - - Converts string to ServerSideEncryptionCustomerMethod. - - - - - - - A list of all server-side encryption methods. - - - - - No server side encryption to be used. - - - - - Use AES 256 server side encryption. - - - - - Use AWS Key Management Service for server side encryption. - - - - - Construct instance of ServerSideEncryptionMethod. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to ServerSideEncryptionCustomerMethod. - - - - - - - A list of all grantee types. - - - - - The predefined group. - - - - - The email address of an AWS account - - - - - The canonical user ID of an AWS account - - - - - Construct an instance of GranteeType. - - - - - - Finds the constant for the unique value. - - - - - - - Convert a string to GranteeType. - - - - - - - A list of all lifecycle statuses. - - - - - The rule is enabled. - - - - - The rule is disabled. - - - - - Constructs an instance LifecycleRuleStatus. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to LifecycleRuleStatus. - - - - - - - A list of all version statuses. - - - - - The rule is off. - - - - - The rule is suspended. - - - - - The rule is enabled. - - - - - Construct an instance of VersionStatus. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to VersionStatus. - - - - - - - A list of all encoding types. - - - - - Url encoding. - - - - - Constructs intance of EncodingType - - - - - - Finds the constant for the unique value. - - - - - - - Converts string to EncodingType - - - - - - - The bucket event for which to send notifications. - - - - - The event encapsulates all the object create events - - - - - Event for put operations - - - - - Event for post operations - - - - - Event for copy operations - - - - - Event for completing a multi part upload - - - - - This event encapsulates all the object removed events - - - - - Event for object removed, delete operation. - - - - - Event for object removed, delete marker created operation. - - - - - Event for objects stored in reduced redundancy and S3 detects the object is lost - - - - - Event for all object restore - - - - - Event for restore post operations. - - - - - Event for when object restore is completed. - - - - - Event for replication of all - - - - - Event for operation failed replication - - - - - Evemt for replication operation not tracked - - - - - Event for replication operation missed threshold - - - - - Event for operation replicated after threshold - - - - - Constructs instance of EventType. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to EventType. - - - - - - - Compares if the ConstantClass instances are equals. - - - - - - - Compares if the ConstantClass instances are equals. This is ovewritten to handle the - discrepancy with S3 events coming from Lambda that don't have the prefix "s3:". - - - - - - - A list of all Inventory Formats. - - - - - CSV inventory format - - - - - ORC inventory format - - - - - Parquet inventory format - - - - - Construct instance of InventoryFormat. - - - - - - Finds the constant for the unique value. - - The string representation of the InventoryFormat. - The InventoryFormat object for that string. - - - - Convert string to InventoryFormat. - - - - - - - A list of inventory included object versions. - - - - - All Inventory Included Object Versions - - - - - Current Inventory Included Object Versions - - - - - Construct instance of InventoryIncludedObjectVersions. - - - - - - Finds the constant for the unique value. - - The string representation of the InventoryIncludedObjectVersions. - The InventoryIncludedObjectVersions object for that string. - - - - Convert string to InventoryIncludedObjectVersions. - - - - - - - A list of inventory frequencies. - - - - - Daily Inventory Frequency - - - - - Weekly Inventory Frequency - - - - - Construct instance of InventoryFrequency. - - - - - - Finds the constant for the unique value. - - The string representation of the InventoryFrequency. - The InventoryFrequency object for that string. - - - - Convert string to InventoryFrequency. - - - - - - - A list of inventory optional fields. - - - - - InventoryOptionalField for Size - - - - - InventoryOptionalField for LastModifiedDate - - - - - InventoryOptionalField for StorageClass - - - - - InventoryOptionalField for ETag - - - - - InventoryOptionalField for IsMultipartUploaded - - - - - InventoryOptionalField for ReplicationStatus - - - - - InventoryOptionalField for EncryptionStatus - - - - - InventoryOptionalField for ObjectLockRetainUntilDate - - - - - InventoryOptionalField for ObjectLockMode - - - - - InventoryOptionalField for ObjectLockLegalHoldStatus - - - - - InventoryOptionalField for IntelligentTieringAccessTier - - - - - Construct instance of InventoryOptionalField. - - - - - - Finds the constant for the unique value. - - The string representation of the InventoryOptionalField. - The InventoryIncludedObjectVersions object for that string. - - - - Convert string to InventoryOptionalField. - - - - - - - The status of the replication job associated with this source object. - - - - - The object is pending replication. - - - - - The object has been replicated. - - - - - The object was created as a result of replication. - - - - - The object replication has failed due to a customer-attributable reason, and the replication will not be attempted again. - - - - - Construct instance of ReplicationStatus. - - - - - - Finds the constant for the unique value. - - The string representation of the ReplicationStatus. - The ReplicationStatus object for that string. - - - - Convert string to ReplicationStatus. - - - - - - - Whether a replication rule is applied or ignored. - - - - - The rule will be applied. - - - - - The rule will be ignored. - - - - - Construct instance of ReplicationRuleStatus - - - - - - Finds the constant for the unique value. - - The string representation of the ReplicationRuleStatus. - The ReplicationRuleStatus object for that string. - - - - Convert string to ReplicationRuleStatus. - - - - - - - Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request. - - - - - The object tag-set is copied from the source object. - - - - - The object tag-set is replaced with tag-set provided in the request. - - - - - Construct instance of TaggingDirective - - - - - Finds the constant for the unique value. - - The string representation of the TaggingDirective. - The TaggingDirective object for that string. - - - - Convert string to TaggingDirective. - - - - - All enumerations type for retrieval tier for Glacier restore. - - - - - Standard Tier for Glacier restore. - - - - - Bulk Tier for Glacier restore. - - - - - Expedited Tier for Glacier restore. - - - - - Construct instance of RestoreObjectRequestGlacierJobTier - - - - - - Finds the constant for the unique value. - - The string representation of the RestoreObjectRequestGlacierJobTier. - The RestoreObjectRequestGlacierJobTier object for that string. - - - - Convert string to RestoreObjectRequestGlacierJobTier. - - - - - - - The version of the output schema to use when exporting data. - - - - - The schema output version V_1. - - - - - Construct instance of StorageClassAnalysisSchemaVersion - - - - - - Finds the constant for the unique value. - - The string representation of the StorageClassAnalysisSchemaVersion. - The StorageClassAnalysisSchemaVersion object for that string. - - - - Convert string to StorageClassAnalysisSchemaVersion. - - - - - - - Acknowledges that requester pays for the operation. - - - - - Requester pays for the operation. - - - - - Finds the RequestPayer instance for the string value. - - - - - Converts string to RequestPayer instance - - - - - The response from S3 that it confirms that requester pays. - - - - - S3 acknowledges that the requester pays. - - - - - Finds the RequestCharged instance for the string value - - - - - converts the string to RequestCharged instance - - - - - The override value for the owner of the replica object. - - - - - Overrides destination bucket's owner. - - - - - Finds the OwnerOverride instance for the string value - - - - - converts the string to OwnerOverride instance - - - - - The replication for KMS encrypted S3 objects is disabled if status is not Enabled. - - - - - The replication for KMS encrypted S3 objects is enabled. - - - - - The replication for KMS encrypted S3 objects is disabled. - - - - - - - - - - Finds the SseKmsEncryptedObjectsStatus instance for the string value - - - - - Converts the string to SseKmsEncryptedObjectsStatus instance - - - - - Specify how headers will be handled. - - - - - Headers will be usable in SELECT clause. - - - - - Headers will be skipped - - - - - No header is present. - - - - - Finds the FileHeaderInfo instance for the string value - - - - - - - Converts the string to FileHeaderInfo instance - - - - - Specifies whether existing object replication is enabled. - - - - - Enable the replication of existing objects - - - - - Disable the replication of existing objects - - - - - Finds the ExistingObjectReplicationStatus instance for the string value - - - - - - - Converts the string to ExistingObjectReplicationStatus instance - - - - - Describes when fields in output should be surrounded with quotes. - - - - - Specifies that fields in output should always be surrounded in quotes. - - - - - Specifies that fields in output should be surrounded in quotes as necessary. - - - - - Finds the QuoteFields instance for the string value - - string value that maps to QuoteFields enum - QuoteFields enum - - - - Converts the string to QuoteFields instance - - - - - Type of the expression provided in the Expression member. - - - - - SQL expression - - - - - Finds the ExpressionType instance for the string value - - string value that maps to ExpressionType enum - ExpressionType enum - - - - Converts the string to ExpressionType instance - - - - - Indicates what type of job is being initiated. - - - - - Finds the RestoreRequestType instance for the string value - - - - - Converts the string to RestoreRequestType instance - - - - - The type of JSON. - - - - - Finds the JsonType instance for the string value - - - - - Converts the string to JsonType instance - - - - - Specifies object's compression format. - - - - - Finds the CompressionType instance for the string value - - - - - Converts the string to CompressionType instance - - - - - The type of ObjectLockEnabled - - - - - Finds the ObjectLockEnabled instance for the string value - - - - - Converts the string to ObjectLockEnabled instance - - - - - The type of ObjectLockLegalHoldStatus - - - - - Finds the ObjectLockLegalHoldStatus instance for the string value - - - - - Converts the string to ObjectLockLegalHoldStatus instance - - - - - The type of ObjectLockRetentionMode - - - - - Finds the ObjectLockRetentionMode instance for the string value - - - - - Converts the string to ObjectLockRetentionMode instance - - - - - The type of ObjectLockMode - - - - - Finds the ObjectLockMode instance for the string value - - - - - Converts the string to ObjectLockMode instance - - - - - Specifies whether the replication time is enabled. - - - - - Replication time is enabled. - - - - - Replication time is disabled. - - - - - Finds the ReplicationTimeStatus instance for the string value - - - - - - - Converts the string to ReplicationTimeStatus instance - - - - - - Specifies whether the replication metrics are enabled. - - - - - Replication metrics are enabled. - - - - - Replication metrics are disabled. - - - - - Finds the MetricsStatus instance for the string value - - - - - - - Converts the string to MetricsStatus instance - - - - - - Uri wrapper that can parse out information (bucket, key, region, style) from an - S3 URI. - - - - - True if the URI contains the bucket in the path, false if it contains the bucket in the authority. - - - - - The bucket name parsed from the URI (or null if no bucket specified). - - - - - The key parsed from the URI (or null if no key specified). - - - - - The region parsed from the URI (or null if no region specified). - - - - - Constructs a parser for the S3 URI specified as a string. - - The S3 URI to be parsed. - - - - Constructs a parser for the S3 URI specified as a Uri instance. - - The S3 URI to be parsed. - - - - If the given string is an AmazonS3Endpoint return true and set the AmazonS3Uri out parameter. - - - - true if the string is an AmazonS3Endpoint, and the out paramter has been filled in, false otherwise - - - - If the given Uri is an AmazonS3Endpoint return true and set the AmazonS3Uri out parameter. - - - - true if the Uri is an AmazonS3Endpoint, and the out paramter has been filled in, false otherwise - - - - Checks whether the given URI is a Amazon S3 URI. - - The S3 URI to be checked. - true if the URI is a Amazon S3 URI, false; otherwise. - - - - Checks whether the given URI is a Amazon S3 URI. - - The S3 URI to be checked. - true if the URI is a Amazon S3 URI, false; otherwise. - - - - Percent-decodes the given string, with a fast path for strings that are not - percent-encoded. - - The string to decode - The decoded string - - - - Percent-decodes the given string. - - The string to decode - The index of the first '%' in the string - The decoded string - - - - Decodes the percent-encoded character at the given index in the string - and appends the decoded value to the string under construction. - - - The string under construction to which the decoded character will be - appended. - - The string being decoded. - The index of the '%' character in the string. - - - - Converts a hex character (0-9A-Fa-f) into its corresponding quad value. - - The hex character - The quad value - - - - Provides utilities used by the Amazon S3 client implementation. - These utilities might be useful to consumers of the Amazon S3 - library. - - - Provides utilities used by the Amazon S3 client implementation. - These utilities might be useful to consumers of the Amazon S3 - library. - - - - - Determines MIME type from a file extension - - The extension of the file - The MIME type for the extension, or text/plain - - - - URL encodes a string. If the path property is specified, - the accepted path characters {/+:} are not encoded. - - The string to encode - Whether the string is a URL path or not - - - - - Converts a non-seekable stream into a System.IO.MemoryStream. - A MemoryStream's position can be moved arbitrarily - - The stream to be converted - A seekable MemoryStream - MemoryStreams use byte arrays as their backing store. - Please use this judicially as it is likely that a very large - stream will cause system resources to be used up. - - - - - Formats the current date as a GMT timestamp - - A GMT formatted string representation - of the current date and time - - - - - Generates an MD5 Digest for the string-based content - - The content for which the MD5 Digest needs - to be computed. - - Whether the returned checksum should be - base64 encoded. - - A string representation of the hash with or w/o base64 encoding - - - - - Only escape non-ascii characters in a string - - - - - - - Version2 S3 buckets adhere to RFC 1035: - - Less than 255 characters, with each label less than 63 characters. - Label must start with a letter - Label must end with a letter or digit - Label can have a string of letter, digits and hyphens in the middle. - Although names can be case-sensitive, no significance is attached to the case. - RFC 1123: Allow label to start with letter or digit (e.g. 3ware.com works) - RFC 2181: No restrictions apart from the length restrictions. - - S3 V2 will start with RFCs 1035 and 1123 and impose the following additional restrictions: - - Length between 3 and 63 characters (to allow headroom for upper-level domains, - as well as to avoid separate length restrictions for bucket-name and its labels - Only lower-case to avoid user confusion. - No dotted-decimal IPv4-like strings - - - The BucketName to validate if V2 addressing should be used - True if the BucketName should use V2 bucket addressing, false otherwise - - S3 v2 Bucket restrictions - - - - Determines whether an S3 bucket exists or not. - - The name of the bucket to check. - The Amazon S3 Client to use for S3 specific operations. - False is returned in case S3 responds with a NoSuchBucket error. - True is returned in case of success, AccessDenied error or PermanentRedirect error. - An exception is thrown in case of any other error. - This method calls GetACL for the bucket. - - - - Determines whether an S3 bucket exists or not. - This is done by: - 1. Creating a PreSigned Url for the bucket. To work with Signature V4 only regions, as - well as Signature V4-optional regions, we keep the expiry to within the maximum for V4 - (which is one week). - 2. Making a HEAD request to the Url - - The name of the bucket to check. - The Amazon S3 Client to use for S3 specific operations. - - - - - Deletes an S3 bucket which contains objects. - An S3 bucket which contains objects cannot be deleted until all the objects - in it are deleted. This method deletes all the objects in the specified - bucket and then deletes the bucket itself. - - The bucket to be deleted. - The Amazon S3 Client to use for S3 specific operations. - - - - Deletes an S3 bucket which contains objects. - An S3 bucket which contains objects cannot be deleted until all the objects - in it are deleted. This method deletes all the objects in the specified - bucket and then deletes the bucket itself. - - The bucket to be deleted. - The Amazon S3 Client to use for S3 specific operations. - Options to control the behavior of the delete operation. - - - - Initiates the asynchronous execution of the DeleteS3BucketWithObjects operation. - DeleteS3BucketWithObjects deletes an S3 bucket which contains objects. - An S3 bucket which contains objects cannot be deleted until all the objects - in it are deleted. This method deletes all the objects in the specified - bucket and then deletes the bucket itself. - - The bucket to be deleted. - The Amazon S3 Client to use for S3 specific operations. - token to check if the operation has been request to cancel. - An IAsyncCancelableResult that can be used to poll or wait for results, or both; - this value is also needed when invoking EndDeleteS3BucketWithObjects. IAsyncCancelableResult can also - be used to cancel the operation while it's in progress. - - - - Initiates the asynchronous execution of the DeleteS3BucketWithObjects operation. - DeleteS3BucketWithObjects deletes an S3 bucket which contains objects. - An S3 bucket which contains objects cannot be deleted until all the objects - in it are deleted. This method deletes all the objects in the specified - bucket and then deletes the bucket itself. - - The bucket to be deleted. - The Amazon S3 Client to use for S3 specific operations. - Options to control the behavior of the delete operation. - token to check if the operation has been request to cancel. - An IAsyncCancelableResult that can be used to poll or wait for results, or both; - this value is also needed when invoking EndDeleteS3BucketWithObjects. IAsyncCancelableResult can also - be used to cancel the operation while it's in progress. - - - - Initiates the asynchronous execution of the DeleteS3BucketWithObjects operation. - DeleteS3BucketWithObjects deletes an S3 bucket which contains objects. - An S3 bucket which contains objects cannot be deleted until all the objects - in it are deleted. This method deletes all the objects in the specified - bucket and then deletes the bucket itself. - - The bucket to be deleted. - The Amazon S3 Client to use for S3 specific operations. - >Options to control the behavior of the delete operation. - An callback that is invoked to send updates while delete operation is in progress. - token to check if the operation has been request to cancel. - An IAsyncCancelableResult that can be used to poll or wait for results, or both; - this value is also needed when invoking EndDeleteS3BucketWithObjects. IAsyncCancelableResult can also - be used to cancel the operation while it's in progress. - - - - Invokes the DeleteS3BucketWithObjectsInternal method. - - The Request object that has all the data to complete the operation. - token to request the operation to be cancelled. - - - - Deletes an S3 bucket which contains objects. - An S3 bucket which contains objects cannot be deleted until all the objects - in it are deleted. The function deletes all the objects in the specified - bucket and then deletes the bucket itself. - - The bucket to be deleted. - The Amazon S3 Client to use for S3 specific operations. - Options to control the behavior of the delete operation. - The callback which is used to send updates about the delete operation. - token to check if the operation has been request to cancel. - - - - Invokes the callback which provides updated about the delete operation. - - The callback to be invoked. - The data being passed to the callback. - 8 - - - - Class to manage and cache the correct region for buckets accessed without an explicit region. - - - Class to manage and cache the correct region for buckets accessed without an explicit region. - - - - - A cache of BucketName -> RegionEndpoint pairs. - The cache is used to make sure that bucket requests are signed for the correct region, - even when requesting them without an explicit region. - - - - - Detect a bucket region mismatch based on the x-amz-bucket-region header, and the status code provided. - - - - - - - - - Detects if the signature is malformed, and the requested bucket is in a Region - different from the Region of the request. - - - - the correct region if a mismatch was detected, null otherwise - - - - Detects if the signature is malformed, and the requested bucket is in a Region - different from the Region of the request. - - - - - the correct region if a mismatch was detected, null otherwise - - - - Use a HEAD bucket request to get the region for the given bucket. - - This method creates an AmazonS3Client from the credentials passed in. - It's critical that the AmazonS3Client is not used to make any requests that will - be routed through the pipeline. - - - - the value of the x-amz-bucket-region header from the response - - - - A helper class that represents a strongly typed S3 EventNotification item sent to SQS - - - - - Parse the JSON string into a S3EventNotification object. - - The function will try its best to parse input JSON string as best as it can. - It will not fail even if the JSON string contains unknown properties. - - For any parsing errors - - - - - Gets and sets the records for the S3 event notification - - - - - The class holds the user identity properties. - - - - - Gets and sets the PrincipalId property. - - - - - This class contains the identity information for an S3 bucket. - - - - - Gets and sets the name of the bucket. - - - - - Gets and sets the bucket owner id. - - - - - Gets and sets the S3 bucket arn. - - - - - This class contains the information for an object in S3. - - - - - Gets and sets the key for the object stored in S3. - - - - - Gets and sets the size of the object in S3. - - - - - Gets and sets the etag of the object. This can be used to determine if the object has changed. - - - - - Gets and sets the version id of the object in S3. - - - - - Gets and sets the sequencer a string representation of a hexadecimal value used to determine event sequence, only used with PUTs and DELETEs. - - - - - Gets and sets the meta information describing S3. - - - - - Gets and sets the ConfigurationId. This ID can be found in the bucket notification configuration. - - - - - Gets and sets the Bucket property. - - - - - Gets and sets the Object property. - - - - - Gets and sets the S3SchemaVersion property. - - - - - The class holds the request parameters - - - - - Gets and sets the SourceIPAddress. This is the ip address where the request came from. - - - - - This class holds the response elements. - - - - - Gets and sets the XAmzId2 Property. This is the Amazon S3 host that processed the request. - - - - - Gets and sets the XAmzRequestId. This is the Amazon S3 generated request ID. - - - - - The class holds the glacier event data elements. - - - - - Gets and sets the RestoreEventData property. - - - - - The class holds the restore event data elements. - - - - - Gets and sets the LifecycleRestorationExpiryTime the time when the object restoration will be expired. - - - - - Gets and sets the LifecycleRestoreStorageClass the source storage class for restore. - - - - - The class holds the event notification. - - - - - Gets and sets the AwsRegion property. - - - - - Gets and sets the EventName property. This identities what type of event occurred. - For example for an object just put in S3 this will be set to EventType.ObjectCreatedPut. - - - - - Gets and sets the EventSource property. - - - - - Gets and sets the EventType property. The time when S3 finished processing the request. - - - - - Gets and sets the EventVersion property. - - - - - Gets and sets the RequestParameters property. - - - - - Gets and sets the ResponseElements property. - - - - - Gets and sets the S3 property. - - - - - Gets and sets the UserIdentity property. - - - - - Get and sets the GlacierEventData property. - - - - - Options which control the behaviour of the DeleteS3BucketWithObjects operation. - - - - - Gets or sets a value which indicates whether the - operation should be aborted if an error is encountered during execution. - - - - - Gets or sets a value which indicated whether verbose results shoule be returned to the - callback. - If quiet mode is true the callback will receive only keys where the delete operation encountered an error. - If quiet mode is false the callback will receive keys for both successful and unsuccessful delete operations. - - - - - Internal class used to pass the parameters for DeleteS3BucketWithObjects operation. - - - - - Name of the bucket to be deleted. - - - - - The Amazon S3 Client to use for S3 specific operations. - - - - - Options to control the behavior of the delete operation. - - - - - The callback which is used to send updates about the delete operation. - - - - - Contains updates from DeleteS3BucketWithObjects operation. - - - - - The list of objects which were successfully deleted. - - - - - The list of objects for which the delete operation failed. - - - - - Interface for accessing S3 - - - - - - - Create a signed URL allowing access to a resource that would - usually require authentication. - - - - When using query string authentication you create a query, - specify an expiration time for the query, sign it with your - signature, place the data in an HTTP request, and distribute - the request to a user or embed the request in a web page. - - - A PreSigned URL can be generated for GET, PUT, DELETE and HEAD - operations on your bucketName, keys, and versions. - - - The GetPreSignedUrlRequest that defines the - parameters of the operation. - A string that is the signed http request. - - - - - - This operation aborts a multipart upload. After a multipart upload is aborted, no - additional parts can be uploaded using that upload ID. The storage consumed by any - previously uploaded parts will be freed. However, if any part uploads are currently - in progress, those part uploads might or might not succeed. As a result, it might - be necessary to abort a given multipart upload multiple times in order to completely - free all storage consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts operation and ensure that the parts - list is empty. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - The bucket name to which the upload was taking place. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object for which the multipart upload was initiated. - Upload ID that identifies the multipart upload. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AbortMultipartUpload service method, as returned by S3. - REST API Reference for AbortMultipartUpload Operation - - - - This operation aborts a multipart upload. After a multipart upload is aborted, no - additional parts can be uploaded using that upload ID. The storage consumed by any - previously uploaded parts will be freed. However, if any part uploads are currently - in progress, those part uploads might or might not succeed. As a result, it might - be necessary to abort a given multipart upload multiple times in order to completely - free all storage consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts operation and ensure that the parts - list is empty. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - Container for the necessary parameters to execute the AbortMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AbortMultipartUpload service method, as returned by S3. - REST API Reference for AbortMultipartUpload Operation - - - - Completes a multipart upload by assembling previously uploaded parts. - - - - You first initiate the multipart upload and then upload all parts using the UploadPart - operation. After successfully uploading all relevant parts of an upload, you call - this operation to complete the upload. Upon receiving this request, Amazon S3 concatenates - all the parts in ascending order by part number to create a new object. In the Complete - Multipart Upload request, you must provide the parts list. You must ensure that the - parts list is complete. This operation concatenates the parts that you provide in - the list. For each part in the list, you must provide the part number and the ETag - value, returned after that part was uploaded. - - - - Processing of a Complete Multipart Upload request could take several minutes to complete. - After Amazon S3 begins processing the request, it sends an HTTP response header that - specifies a 200 OK response. While processing is in progress, Amazon S3 periodically - sends white space characters to keep the connection from timing out. Because a request - could fail after the initial 200 OK response has been sent, it is important that you - check the response body to determine whether the request succeeded. - - - - Note that if CompleteMultipartUpload fails, applications should be prepared - to retry the failed requests. For more information, see Amazon - S3 Error Best Practices. - - - - For more information about multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - GetBucketLifecycle has the following special errors: - -
  • - - Error code: EntityTooSmall - -
    • - - Description: Your proposed upload is smaller than the minimum allowed object size. - Each part must be at least 5 MB in size, except the last part. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPart - -
    • - - Description: One or more of the specified parts could not be found. The part might - not have been uploaded, or the specified entity tag might not have matched the part's - entity tag. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPartOrder - -
    • - - Description: The list of parts was not in ascending order. The parts list must be - specified in order by part number. - -
    • - - 400 Bad Request - -
  • - - Error code: NoSuchUpload - -
    • - - Description: The specified multipart upload does not exist. The upload ID might be - invalid, or the multipart upload might have been aborted or completed. - -
    • - - 404 Not Found - -
- - The following operations are related to CompleteMultipartUpload: - - - - Container for the necessary parameters to execute the CompleteMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CompleteMultipartUpload service method, as returned by S3. - REST API Reference for CompleteMultipartUpload Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 Developer Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Encryption - - - - The source object that you are copying can be encrypted or unencrypted. The source - object can be encrypted with server-side encryption using AWS managed encryption keys - (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side - encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers - and decrypts the data when you access it. - - - - You can optionally use the appropriate encryption-related headers to request server-side - encryption for the target object. You have the option to provide your own encryption - key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that - was used to encrypt the source object. You can even request encryption if the source - object was not encrypted. For more information about server-side encryption, see Using - Server-Side Encryption. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject operation to change the storage class of an - object that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 Service Developer Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 Developer Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Encryption - - - - The source object that you are copying can be encrypted or unencrypted. The source - object can be encrypted with server-side encryption using AWS managed encryption keys - (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side - encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers - and decrypts the data when you access it. - - - - You can optionally use the appropriate encryption-related headers to request server-side - encryption for the target object. You have the option to provide your own encryption - key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that - was used to encrypt the source object. You can even request encryption if the source - object was not encrypted. For more information about server-side encryption, see Using - Server-Side Encryption. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject operation to change the storage class of an - object that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 Service Developer Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 Developer Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Encryption - - - - The source object that you are copying can be encrypted or unencrypted. The source - object can be encrypted with server-side encryption using AWS managed encryption keys - (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side - encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers - and decrypts the data when you access it. - - - - You can optionally use the appropriate encryption-related headers to request server-side - encryption for the target object. You have the option to provide your own encryption - key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that - was used to encrypt the source object. You can even request encryption if the source - object was not encrypted. For more information about server-side encryption, see Using - Server-Side Encryption. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject operation to change the storage class of an - object that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 Service Developer Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - Container for the necessary parameters to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - - - - - - Deletes an analytics configuration for the bucket (specified by the analytics configuration - ID). - - - - To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to DeleteBucketAnalyticsConfiguration: - -
  • - - - -
  • - - - -
  • - - - -
- - Container for the necessary parameters to execute the DeleteBucketAnalyticsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketAnalyticsConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketAnalyticsConfiguration Operation - - - - - Deletes an inventory configuration (identified by the inventory ID) from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - Operations related to DeleteBucketInventoryConfiguration include: - - - - Container for the necessary parameters to execute the DeleteBucketInventoryConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketInventoryConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketInventoryConfiguration Operation - - - - Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified - by the metrics configuration ID) from the bucket. Note that this doesn't include the - daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketMetricsConfiguration Operation - - - - This implementation of the DELETE operation uses the policy subresource to delete - the policy of a specified bucket. If you are using an identity other than the root - user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - The bucket name. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketPolicy service method, as returned by S3. - REST API Reference for DeleteBucketPolicy Operation - - - - This implementation of the DELETE operation uses the policy subresource to delete - the policy of a specified bucket. If you are using an identity other than the root - user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - Container for the necessary parameters to execute the DeleteBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketPolicy service method, as returned by S3. - REST API Reference for DeleteBucketPolicy Operation - - - - Deletes the replication configuration from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutReplicationConfiguration - action. The bucket owner has these permissions by default and can grant it to others. - For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - It can take a while for the deletion of a replication configuration to fully propagate. - - - - For information about replication configuration, see Replication - in the Amazon S3 Developer Guide. - - - - The following operations are related to DeleteBucketReplication: - - - - Container for the necessary parameters to execute the DeleteBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketReplication service method, as returned by S3. - REST API Reference for DeleteBucketReplication Operation - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - The bucket that has the tag set to be removed. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketTagging service method, as returned by S3. - REST API Reference for DeleteBucketTagging Operation - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - Container for the necessary parameters to execute the DeleteBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketTagging service method, as returned by S3. - REST API Reference for DeleteBucketTagging Operation - - - - This operation removes the website configuration for a bucket. Amazon S3 returns a - 200 OK response upon successfully deleting a website configuration on - the specified bucket. You will get a 200 OK response if the website configuration - you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE operation requires the S3:DeleteBucketWebsite permission. - By default, only the bucket owner can delete the website configuration attached to - a bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which you want to remove the website configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketWebsite service method, as returned by S3. - REST API Reference for DeleteBucketWebsite Operation - - - - This operation removes the website configuration for a bucket. Amazon S3 returns a - 200 OK response upon successfully deleting a website configuration on - the specified bucket. You will get a 200 OK response if the website configuration - you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE operation requires the S3:DeleteBucketWebsite permission. - By default, only the bucket owner can delete the website configuration attached to - a bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the DeleteBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketWebsite service method, as returned by S3. - REST API Reference for DeleteBucketWebsite Operation - - - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - The bucket name of the lifecycle to delete. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - REST API Reference for DeleteLifecycleConfiguration Operation - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - Container for the necessary parameters to execute the DeleteLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - REST API Reference for DeleteLifecycleConfiguration Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key name of the object to delete. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key name of the object to delete. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - Container for the necessary parameters to execute the DeleteObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - This operation enables you to delete multiple objects from a bucket using a single - HTTP request. If you know the object keys that you want to delete, then this operation - provides a suitable alternative to sending individual delete requests, reducing per-request - overhead. - - - - The request contains a list of up to 1000 keys that you want to delete. In the XML, - you provide the object key names, and optionally, version IDs if you want to delete - a specific version of the object from a versioning-enabled bucket. For each key, Amazon - S3 performs a delete operation and returns the result of that delete, success, or - failure, in the response. Note that if the object specified in the request is not - found, Amazon S3 returns the result as deleted. - - - - The operation supports two modes for the response: verbose and quiet. By default, - the operation uses verbose mode in which the response includes the result of deletion - of each key in your request. In quiet mode the response includes only keys where the - delete operation encountered an error. For a successful deletion, the operation does - not return any information about the delete in the response body. - - - - When performing this operation on an MFA Delete enabled bucket, that attempts to delete - any versioned objects, you must include an MFA token. If you do not provide one, the - entire request will fail, even if there are non-versioned objects you are trying to - delete. If you provide an invalid token, whether there are versioned keys in the request - or not, the entire Multi-Object Delete request will fail. For information about MFA - Delete, see - MFA Delete. - - - - Finally, the Content-MD5 header is required for all Multi-Object Delete requests. - Amazon S3 uses the header value to ensure that your request body has not been altered - in transit. - - - - The following operations are related to DeleteObjects: - - - - Container for the necessary parameters to execute the DeleteObjects service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObjects service method, as returned by S3. - REST API Reference for DeleteObjects Operation - - - - Removes the entire tag set from the specified object. For more information about managing - object tags, see - Object Tagging. - - - - To use this operation, you must have permission to perform the s3:DeleteObjectTagging - action. - - - - To delete tags of a specific object version, add the versionId query - parameter in the request. You will need permission for the s3:DeleteObjectVersionTagging - action. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteObjectTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObjectTagging service method, as returned by S3. - REST API Reference for DeleteObjectTagging Operation - - - - Removes the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:PutBucketPublicAccessBlock - permission. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to DeletePublicAccessBlock: - - - - Container for the necessary parameters to execute the DeletePublicAccessBlock service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeletePublicAccessBlock service method, as returned by S3. - REST API Reference for DeletePublicAccessBlock Operation - - - - - - - - - Returns the default encryption configuration for an Amazon S3 bucket. For information - about the Amazon S3 default encryption feature, see Amazon - S3 Default Bucket Encryption. - - - - To use this operation, you must have permission to perform the s3:GetEncryptionConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to GetBucketEncryption: - - - - Container for the necessary parameters to execute the GetBucketEncryption service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketEncryption service method, as returned by S3. - REST API Reference for GetBucketEncryption Operation - - - - Returns an inventory configuration (identified by the inventory configuration ID) - from the bucket. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - The following operations are related to GetBucketInventoryConfiguration: - - - - Container for the necessary parameters to execute the GetBucketInventoryConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketInventoryConfiguration service method, as returned by S3. - REST API Reference for GetBucketInventoryConfiguration Operation - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - The name of the bucket for which to get the location. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLocation service method, as returned by S3. - REST API Reference for GetBucketLocation Operation - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - Container for the necessary parameters to execute the GetBucketLocation service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLocation service method, as returned by S3. - REST API Reference for GetBucketLocation Operation - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - The bucket name for which to get the logging information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLogging service method, as returned by S3. - REST API Reference for GetBucketLogging Operation - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - Container for the necessary parameters to execute the GetBucketLogging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLogging service method, as returned by S3. - REST API Reference for GetBucketLogging Operation - - - - Gets a metrics configuration (specified by the metrics configuration ID) from the - bucket. Note that this doesn't include the daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to GetBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the GetBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for GetBucketMetricsConfiguration Operation - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following operation is related to GetBucketNotification: - - - - Name of the bucket for which to get the notification configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketNotification service method, as returned by S3. - REST API Reference for GetBucketNotification Operation - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following operation is related to GetBucketNotification: - - - - Container for the necessary parameters to execute the GetBucketNotification service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketNotification service method, as returned by S3. - REST API Reference for GetBucketNotification Operation - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operation is related to GetBucketPolicy: - - - - The bucket name for which to get the bucket policy. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicy service method, as returned by S3. - REST API Reference for GetBucketPolicy Operation - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operation is related to GetBucketPolicy: - - - - Container for the necessary parameters to execute the GetBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicy service method, as returned by S3. - REST API Reference for GetBucketPolicy Operation - - - - Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket - is public. In order to use this operation, you must have the s3:GetBucketPolicyStatus - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - For more information about when Amazon S3 considers a bucket public, see The - Meaning of "Public". - - - - The following operations are related to GetBucketPolicyStatus: - - - - Container for the necessary parameters to execute the GetBucketPolicyStatus service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicyStatus service method, as returned by S3. - REST API Reference for GetBucketPolicyStatus Operation - - - - Retrieves the replication configuration for the given Amazon S3 bucket. - - Container for the necessary parameters to execute the GetBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketReplication service method, as returned by S3. - REST API Reference for GetBucketReplication Operation - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - The name of the bucket for which to get the payment request configuration - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketRequestPayment service method, as returned by S3. - REST API Reference for GetBucketRequestPayment Operation - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - Container for the necessary parameters to execute the GetBucketRequestPayment service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketRequestPayment service method, as returned by S3. - REST API Reference for GetBucketRequestPayment Operation - - - - Returns the tag set associated with the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - GetBucketTagging has the following special error: - -
  • - - Error code: NoSuchTagSetError - -
    • - - Description: There is no tag set associated with the bucket. - -
- - The following operations are related to GetBucketTagging: - - - - Container for the necessary parameters to execute the GetBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketTagging service method, as returned by S3. - REST API Reference for GetBucketTagging Operation - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - The name of the bucket for which to get the versioning information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketVersioning service method, as returned by S3. - REST API Reference for GetBucketVersioning Operation - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - Container for the necessary parameters to execute the GetBucketVersioning service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketVersioning service method, as returned by S3. - REST API Reference for GetBucketVersioning Operation - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET operation requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which to get the website configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketWebsite service method, as returned by S3. - REST API Reference for GetBucketWebsite Operation - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET operation requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the GetBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketWebsite service method, as returned by S3. - REST API Reference for GetBucketWebsite Operation - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - The bucket name for which to get the cors configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetCORSConfiguration service method, as returned by S3. - REST API Reference for GetCORSConfiguration Operation - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - Container for the necessary parameters to execute the GetCORSConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetCORSConfiguration service method, as returned by S3. - REST API Reference for GetCORSConfiguration Operation - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are still using previous version of the lifecycle configuration, it works. - For the earlier API description, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to GetBucketLifecycleConfiguration: - - - - The name of the bucket for which to get the lifecycle information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetLifecycleConfiguration service method, as returned by S3. - REST API Reference for GetLifecycleConfiguration Operation - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are still using previous version of the lifecycle configuration, it works. - For the earlier API description, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to GetBucketLifecycleConfiguration: - - - - Container for the necessary parameters to execute the GetLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetLifecycleConfiguration service method, as returned by S3. - REST API Reference for GetLifecycleConfiguration Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object to get. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object to get. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - Container for the necessary parameters to execute the GetObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Gets an object's current Legal Hold status. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLegalHold service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectLegalHold service method, as returned by S3. - REST API Reference for GetObjectLegalHold Operation - - - - Gets the Object Lock configuration for a bucket. The rule specified in the Object - Lock configuration will be applied by default to every new object placed in the specified - bucket. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLockConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectLockConfiguration service method, as returned by S3. - REST API Reference for GetObjectLockConfiguration Operation - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - The name of the bucket containing the object. - The object key. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - The name of the bucket containing the object. - The object key. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - Container for the necessary parameters to execute the GetObjectMetadata service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - Retrieves an object's retention settings. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectRetention service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectRetention service method, as returned by S3. - REST API Reference for GetObjectRetention Operation - - - - Returns the tag-set of an object. You send the GET request against the tagging subresource - associated with the object. - - - - To use this operation, you must have permission to perform the s3:GetObjectTagging - action. By default, the GET operation returns information about current version of - an object. For a versioned bucket, you can have multiple versions of an object in - your bucket. To retrieve tags of any other version, use the versionId query parameter. - You also need permission for the s3:GetObjectVersionTagging action. - - - - By default, the bucket owner has this permission and can grant this permission to - others. - - - - For information about the Amazon S3 object tagging feature, see Object - Tagging. - - - - The following operation is related to GetObjectTagging: - - - - Container for the necessary parameters to execute the GetObjectTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTagging service method, as returned by S3. - REST API Reference for GetObjectTagging Operation - - - - Return torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Amazon - S3 Torrent. - - - - You can get torrent only for objects that are less than 5 GB in size and that are - not encrypted using server-side encryption with customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - The following operation is related to GetObjectTorrent: - - - - The name of the bucket containing the object for which to get the torrent files. - The object key for which to get the information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTorrent service method, as returned by S3. - REST API Reference for GetObjectTorrent Operation - - - - Return torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Amazon - S3 Torrent. - - - - You can get torrent only for objects that are less than 5 GB in size and that are - not encrypted using server-side encryption with customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - The following operation is related to GetObjectTorrent: - - - - Container for the necessary parameters to execute the GetObjectTorrent service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTorrent service method, as returned by S3. - REST API Reference for GetObjectTorrent Operation - - - - Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:GetBucketPublicAccessBlock - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket - or an object, it checks the PublicAccessBlock configuration for both - the bucket (or the bucket that contains the object) and the bucket owner's account. - If the PublicAccessBlock settings are different between the bucket and - the account, Amazon S3 uses the most restrictive combination of the bucket-level and - account-level settings. - - - - For more information about when Amazon S3 considers a bucket or an object public, - see The - Meaning of "Public". - - - - The following operations are related to GetPublicAccessBlock: - - - - Container for the necessary parameters to execute the GetPublicAccessBlock service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetPublicAccessBlock service method, as returned by S3. - REST API Reference for GetPublicAccessBlock Operation - - - - This operation initiates a multipart upload and returns an upload ID. This upload - ID is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort operation - and Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload API and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart) and UploadPartCopy) requests must match the headers you - used in the request to initiate the upload by using CreateMultipartUpload. - - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, - kms:GenerateDataKey*, and kms:DescribeKey actions on the - key. These permissions are required because Amazon S3 must decrypt and read data from - the encrypted file parts before it completes the multipart upload. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - The following operations are related to CreateMultipartUpload: - - - - The name of the bucket to which to initiate the upload - Object key for which the multipart upload is to be initiated. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the InitiateMultipartUpload service method, as returned by S3. - REST API Reference for InitiateMultipartUpload Operation - - - - This operation initiates a multipart upload and returns an upload ID. This upload - ID is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort operation - and Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload API and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart) and UploadPartCopy) requests must match the headers you - used in the request to initiate the upload by using CreateMultipartUpload. - - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, - kms:GenerateDataKey*, and kms:DescribeKey actions on the - key. These permissions are required because Amazon S3 must decrypt and read data from - the encrypted file parts before it completes the multipart upload. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - The following operations are related to CreateMultipartUpload: - - - - Container for the necessary parameters to execute the InitiateMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the InitiateMultipartUpload service method, as returned by S3. - REST API Reference for InitiateMultipartUpload Operation - - - - Lists the analytics configurations for the bucket. You can have up to 1,000 analytics - configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. You should always check the IsTruncated element in the response. - If there are no more configurations to list, IsTruncated is set to false. - If there are more configurations to list, IsTruncated is set to true, - and there will be a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to ListBucketAnalyticsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketAnalyticsConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketAnalyticsConfigurations service method, as returned by S3. - REST API Reference for ListBucketAnalyticsConfigurations Operation - - - - Returns a list of inventory configurations for the bucket. You can have up to 1,000 - analytics configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory - - - - The following operations are related to ListBucketInventoryConfigurations: - - - - Container for the necessary parameters to execute the ListBucketInventoryConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketInventoryConfigurations service method, as returned by S3. - REST API Reference for ListBucketInventoryConfigurations Operation - - - - Lists the metrics configurations for the bucket. The metrics configurations are only - for the request metrics of the bucket and do not provide information on daily storage - metrics. You can have up to 1,000 configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For more information about metrics configurations and CloudWatch request metrics, - see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to ListBucketMetricsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketMetricsConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketMetricsConfigurations service method, as returned by S3. - REST API Reference for ListBucketMetricsConfigurations Operation - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBuckets service method, as returned by S3. - REST API Reference for ListBuckets Operation - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - Container for the necessary parameters to execute the ListBuckets service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBuckets service method, as returned by S3. - REST API Reference for ListBuckets Operation - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Container for the necessary parameters to execute the ListMultipartUploads service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. - Limits the response to keys that begin with the specified prefix. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - Container for the necessary parameters to execute the ListObjects service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Make sure to design - your application to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - To use this operation in an AWS Identity and Access Management (IAM) policy, you must - have permissions to perform the s3:ListBucket action. The bucket owner - has this permission by default and can grant this permission to others. For more information - about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - This section describes the latest revision of the API. We recommend that you use this - revised API for application development. For backward compatibility, Amazon S3 continues - to support the prior version of this API, ListObjects. - - - - To get a list of your buckets, see ListBuckets. - - - - The following operations are related to ListObjectsV2: - - - - Container for the necessary parameters to execute the ListObjectsV2 service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjectsV2 service method, as returned by S3. - REST API Reference for ListObjectsV2 Operation - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). This request returns a maximum of 1,000 - uploaded parts. The default number of parts returned is 1,000 parts. You can restrict - the number of parts returned by specifying the max-parts request parameter. - If your multipart upload consists of more than 1,000 parts, the response returns an - IsTruncated field with the value of true, and a NextPartNumberMarker - element. In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListParts: - - - - Name of the bucket to which the parts are being uploaded. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Object key for which the multipart upload was initiated. - Upload ID identifying the multipart upload whose parts are being listed. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListParts service method, as returned by S3. - REST API Reference for ListParts Operation - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). This request returns a maximum of 1,000 - uploaded parts. The default number of parts returned is 1,000 parts. You can restrict - the number of parts returned by specifying the max-parts request parameter. - If your multipart upload consists of more than 1,000 parts, the response returns an - IsTruncated field with the value of true, and a NextPartNumberMarker - element. In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListParts: - - - - Container for the necessary parameters to execute the ListParts service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListParts service method, as returned by S3. - REST API Reference for ListParts Operation - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - Container for the necessary parameters to execute the ListVersions service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - - Creates a new bucket. To create a bucket, you must register with Amazon S3 and have - a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed - to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information on bucket naming restrictions, - see Working - with Amazon S3 Buckets. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) - Region. For more information, see How - to Select a Region for Your Buckets. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - Hosting of Buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - The name of the bucket to create. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucket service method, as returned by S3. - REST API Reference for PutBucket Operation - - - - Creates a new bucket. To create a bucket, you must register with Amazon S3 and have - a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed - to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information on bucket naming restrictions, - see Working - with Amazon S3 Buckets. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) - Region. For more information, see How - to Select a Region for Your Buckets. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - Hosting of Buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - Container for the necessary parameters to execute the PutBucket service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucket service method, as returned by S3. - REST API Reference for PutBucket Operation - - - - Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration - is a bucket-level feature that enables you to perform faster data transfers to Amazon - S3. - - - - To use this operation, you must have permission to perform the s3:PutAccelerateConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The Transfer Acceleration state of a bucket can be set to one of the following two - values: - -
  • - - Enabled – Enables accelerated data transfers to the bucket. - -
  • - - Suspended – Disables accelerated data transfers to the bucket. - -
- - The GetBucketAccelerateConfiguration operation returns the transfer acceleration - state of a bucket. - - - - After setting the Transfer Acceleration state of a bucket to Enabled, it might take - up to thirty minutes before the data transfer rates to the bucket increase. - - - - The name of the bucket used for Transfer Acceleration must be DNS-compliant and must - not contain periods ("."). - - - - For more information about transfer acceleration, see Transfer - Acceleration. - - - - The following operations are related to PutBucketAccelerateConfiguration: - - - - Container for the necessary parameters to execute the PutBucketAccelerateConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketAccelerateConfiguration service method, as returned by S3. - REST API Reference for PutBucketAccelerateConfiguration Operation - - - - - - - Set the logging parameters for a bucket and to specify permissions for who can view - and modify the logging parameters. All logs are saved to buckets in the same AWS Region - as the source bucket. To set the logging status of a bucket, you must be the bucket - owner. - - - - The bucket owner is automatically granted FULL_CONTROL to all logs. You use the Grantee - request element to grant access to other people. The Permissions request - element specifies the kind of access the grantee has to the logs. - - - - Grantee Values - - - - You can specify the person (grantee) to whom you're assigning access rights (using - request elements) in the following ways: - -
  • - - By the person's ID: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> - </Grantee> - - - - DisplayName is optional and ignored in the request. - -
  • - - By Email address: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee> - - - - - The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl - request, appears as the CanonicalUser. - -
  • - - By URI: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee> - - -
- - To enable logging, you use LoggingEnabled and its children request elements. To disable - logging, you use an empty BucketLoggingStatus request element: - - - - <BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01" /> - - - - - For more information about server access logging, see Server - Access Logging. - - - - For more information about creating a bucket, see CreateBucket. For more information - about returning the logging status of a bucket, see GetBucketLogging. - - - - The following operations are related to PutBucketLogging: - - - - Container for the necessary parameters to execute the PutBucketLogging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketLogging service method, as returned by S3. - REST API Reference for PutBucketLogging Operation - - - - Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. - You can have up to 1,000 metrics configurations per bucket. If you're updating an - existing metrics configuration, note that this is a full replacement of the existing - metrics configuration. If you don't include the elements you want to keep, they are - erased. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to PutBucketMetricsConfiguration: - - - - GetBucketLifecycle has the following special error: - -
  • - - Error code: TooManyConfigurations - -
    • - - Description: You are attempting to create a new configuration but have already reached - the 1,000-configuration limit. - -
    • - - HTTP Status Code: HTTP 400 Bad Request - -
- - Container for the necessary parameters to execute the PutBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for PutBucketMetricsConfiguration Operation - - - - Enables notifications of specified events for a bucket. For more information about - event notifications, see Configuring - Event Notifications. - - - - Using this API, you can replace an existing notification configuration. The configuration - is an XML file that defines the event types that you want Amazon S3 to publish and - the destination where you want Amazon S3 to publish an event notification when it - detects an event of the specified type. - - - - By default, your bucket has no event notifications configured. That is, the notification - configuration will be an empty NotificationConfiguration. - - - - <NotificationConfiguration> - - - - </NotificationConfiguration> - - - - This operation replaces the existing notification configuration with the configuration - you include in the request body. - - - - After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification - Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, - and that the bucket owner has permission to publish to it by sending a test notification. - In the case of AWS Lambda destinations, Amazon S3 verifies that the Lambda function - permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. - For more information, see Configuring - Notifications for Amazon S3 Events. - - - - You can disable notifications by adding the empty NotificationConfiguration element. - - - - By default, only the bucket owner can configure notifications on a bucket. However, - bucket owners can use a bucket policy to grant permission to other users to set this - configuration with s3:PutBucketNotification permission. - - - - The PUT notification is an atomic operation. For example, suppose your notification - configuration includes SNS topic, SQS queue, and Lambda function configurations. When - you send a PUT request with this configuration, Amazon S3 sends test messages to your - SNS topic. If the message fails, the entire PUT operation will fail, and Amazon S3 - will not add the configuration to your bucket. - - - - Responses - - - - If the configuration in the request body includes only one TopicConfiguration - specifying only the s3:ReducedRedundancyLostObject event type, the response - will also include the x-amz-sns-test-message-id header containing the - message ID of the test notification sent to the topic. - - - - The following operation is related to PutBucketNotificationConfiguration: - - - - Container for the necessary parameters to execute the PutBucketNotification service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketNotification service method, as returned by S3. - REST API Reference for PutBucketNotification Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - The MD5 hash of the request body. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - Container for the necessary parameters to execute the PutBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Creates a replication configuration or replaces an existing one. For more information, - see Replication - in the Amazon S3 Developer Guide. - - - - To perform this operation, the user or role performing the operation must have the - iam:PassRole - permission. - - - - Specify the replication configuration in the request body. In the replication configuration, - you provide the name of the destination bucket where you want Amazon S3 to replicate - objects, the IAM role that Amazon S3 can assume to replicate objects on your behalf, - and other relevant information. - - - - A replication configuration must include at least one rule, and can contain a maximum - of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects - in the source bucket. To choose additional subsets of objects to replicate, add a - rule for each subset. All rules must specify the same destination bucket. - - - - To specify a subset of the objects in the source bucket to apply a replication rule - to, add the Filter element as a child of the Rule element. You can filter objects - based on an object key prefix, one or more object tags, or both. When you add the - Filter element in the configuration, you must also add the following elements: DeleteMarkerReplication, - Status, and Priority. - - - - For information about enabling versioning on a bucket, see Using - Versioning. - - - - By default, a resource owner, in this case the AWS account that created the bucket, - can perform this operation. The resource owner can also grant others permissions to - perform the operation. For more information about permissions, see Specifying - Permissions in a Policy and Managing - Access Permissions to Your Amazon S3 Resources. - - - - Handling Replication of Encrypted Objects - - - - By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side - encryption with CMKs stored in AWS KMS. To replicate AWS KMS-encrypted objects, add - the following: SourceSelectionCriteria, SseKmsEncryptedObjects, - Status, EncryptionConfiguration, and ReplicaKmsKeyID. - For information about replication configuration, see Replicating - Objects Created with SSE Using CMKs stored in AWS KMS. - - - - For information on PutBucketReplication errors, see ReplicationErrorCodeList - - - - - The following operations are related to PutBucketReplication: - - - - Container for the necessary parameters to execute the PutBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketReplication service method, as returned by S3. - REST API Reference for PutBucketReplication Operation - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - The bucket name. - Container for Payer. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketRequestPayment service method, as returned by S3. - REST API Reference for PutBucketRequestPayment Operation - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - Container for the necessary parameters to execute the PutBucketRequestPayment service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketRequestPayment service method, as returned by S3. - REST API Reference for PutBucketRequestPayment Operation - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging. - - - - Within a bucket, if you add a tag that has the same key as an existing tag, the new - value overwrites the old value. For more information, see Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional operation is currently in progress against - this resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - The bucket name. - A property of PutBucketTaggingRequest used to execute the PutBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketTagging service method, as returned by S3. - REST API Reference for PutBucketTagging Operation - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging. - - - - Within a bucket, if you add a tag that has the same key as an existing tag, the new - value overwrites the old value. For more information, see Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional operation is currently in progress against - this resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - Container for the necessary parameters to execute the PutBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketTagging service method, as returned by S3. - REST API Reference for PutBucketTagging Operation - - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT operation requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - Amazon S3 has a limitation of 50 routing rules per website configuration. If you require - more than 50 routing rules, you can use object redirect. For more information, see - Configuring - an Object Redirect in the Amazon Simple Storage Service Developer Guide. - - - The bucket name. - Container for the request. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketWebsite service method, as returned by S3. - REST API Reference for PutBucketWebsite Operation - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT operation requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - Amazon S3 has a limitation of 50 routing rules per website configuration. If you require - more than 50 routing rules, you can use object redirect. For more information, see - Configuring - an Object Redirect in the Amazon Simple Storage Service Developer Guide. - - - Container for the necessary parameters to execute the PutBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketWebsite service method, as returned by S3. - REST API Reference for PutBucketWebsite Operation - - - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - The name of the bucket for which to set the configuration. - A property of PutLifecycleConfigurationRequest used to execute the PutLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutLifecycleConfiguration service method, as returned by S3. - REST API Reference for PutLifecycleConfiguration Operation - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - Container for the necessary parameters to execute the PutLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutLifecycleConfiguration service method, as returned by S3. - REST API Reference for PutLifecycleConfiguration Operation - - - - - - - - - - - - - - - - - The base class for requests that return Amazon S3 objects. - - - - - Gets or sets the name of the bucket. - - - The name of the bucket. - - - - - Gets whether or not the bucket name is set. - - - A value of true if the bucket name is set. - Returns false if otherwise. - - - - - Gets or sets the key under which the Amazon S3 object is stored. - - - The key under which the Amazon S3 object is stored. - - - - - Gets whether or not the key property is set. - - - A value of true if key property is set. - Returns false if otherwise. - - - - - Gets or sets the version ID of the Amazon S3 object. - - - The version ID of the Amazon S3 object. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or - ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Gets or sets the ModifiedSinceDate property. - - - The ModifiedSinceDate property. - - - - - Gets or sets the ModifiedSinceDate property. - - - The ModifiedSinceDate property. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or - UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Gets or sets the UnmodifiedSinceDate property. - - - The UnmodifiedSinceDate property. - - - - - Gets or sets the UnmodifiedSinceDate property. - - - The UnmodifiedSinceDate property. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to decrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - The base class TransferUtility request classes. - - - - - Waits for all of the tasks to complete or till any task fails or is canceled. - - - - - Waits for all of the tasks to complete or till any task fails or is canceled. - - - - - Returns the amount of bytes remaining that need to be pulled down from S3. - - The fully qualified path of the file. - - - - - The command to manage an upload using the S3 multipart API. - - - - - Initializes a new instance of the class. - - The s3 client. - The config object that has the number of threads to use. - The file transporter request. - - - - This command is for doing regular PutObject requests. - - - - - This command files all the files that meets the criteria specified in the TransferUtilityUploadDirectoryRequest request - and uploads them. - - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - - Gets the Amazon S3 client used for making calls into Amazon S3. - - - The Amazon S3 client used for making calls into Amazon S3. - - - - - Uploads the specified file. - The object key is derived from the file's name. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the specified file. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the contents of the specified stream. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The stream to read to obtain the content to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the stream to. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the file or stream specified by the request. - To track the progress of the upload, - add an event listener to the request's UploadProgressEvent. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - Contains all the parameters required to upload to Amazon S3. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Aborts the multipart uploads that were initiated before the specified date. - - - The name of the bucket containing multipart uploads. - - - The date before which the multipart uploads were initiated. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the content from Amazon S3 and writes it to the specified file. - If the key is not specified in the request parameter, - the file name will used as the key name. - - - Contains all the parameters required to download an Amazon S3 object. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Returns a stream from which the caller can read the content from the specified - Amazon S3 bucket and key. - The caller of this method is responsible for closing the stream. - - - The name of the bucket. - - - The object key. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Returns a stream to read the contents from Amazon S3 as - specified by the TransferUtilityOpenStreamRequest. - The caller of this method is responsible for closing the stream. - - - Contains all the parameters required for the OpenStream operation. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - A pattern used to identify the files from the source directory to upload. - - - A search option that specifies whether to recursively search for files to upload - in subdirectories. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The request that contains all the parameters required to upload a directory. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by s3Directory. - - - The name of the bucket containing the Amazon S3 objects to download. - - - The directory in Amazon S3 to download. - - - The local directory to download the objects to. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by the S3Directory - property of the passed in TransferUtilityDownloadDirectoryRequest object. - - - Contains all the parameters required to download objects from Amazon S3 - into a local directory. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the content from Amazon S3 and writes it to the specified file. - - - The file path where the content from Amazon S3 will be written to. - - - The name of the bucket containing the Amazon S3 object to download. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - A pattern used to identify the files from the source directory to upload. - - - A search option that specifies whether to recursively search for files to upload - in subdirectories. - - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The request that contains all the parameters required to upload a directory. - - - - - Uploads the specified file. - The object key is derived from the file's name. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - - - Uploads the specified file. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - The key under which the Amazon S3 object is stored. - - - - - Uploads the contents of the specified stream. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The stream to read to obtain the content to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the stream to. - - - The key under which the Amazon S3 object is stored. - - - - - Uploads the file or stream specified by the request. - To track the progress of the upload, - add an event listener to the request's UploadProgressEvent. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - Contains all the parameters required to upload to Amazon S3. - - - - - Returns a stream from which the caller can read the content from the specified - Amazon S3 bucket and key. - The caller of this method is responsible for closing the stream. - - - The name of the bucket. - - - The object key. - - - A stream of the contents from the specified Amazon S3 and key. - - - - - Returns a stream to read the contents from Amazon S3 as - specified by the TransferUtilityOpenStreamRequest. - The caller of this method is responsible for closing the stream. - - - Contains all the parameters required to open a stream to an S3 object. - - - A stream of the contents from Amazon S3. - - - - - Downloads the content from Amazon S3 and writes it to the specified file. - - - The file path where the content from Amazon S3 will be written to. - - - The name of the bucket containing the Amazon S3 object to download. - - - The key under which the Amazon S3 object is stored. - - - - - Downloads the content from Amazon S3 and writes it to the specified file. - If the key is not specified in the request parameter, - the file name will used as the key name. - - - Contains all the parameters required to download an Amazon S3 object. - - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by s3Directory. - - - The name of the bucket containing the Amazon S3 objects to download. - - - The directory in Amazon S3 to download. - - - The local directory to download the objects to. - - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by the S3Directory - property of the passed in TransferUtilityDownloadDirectoryRequest object. - - - Contains all the parameters required to download objects from Amazon S3 - into a local directory. - - - - - Aborts the multipart uploads that were initiated before the specified date. - - - The name of the bucket containing multipart uploads. - - - The date before which the multipart uploads were initiated. - - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - - Constructs a new class. - - - The AWS Access Key ID. - - - The AWS Secret Access Key. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new class. - - - The AWS Access Key ID. - - - The AWS Secret Access Key. - - - The region to configure the transfer utility for. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new instance of the class. - - - The AWS Access Key ID. - - - The AWS Secret Access Key. - - - Specifies advanced settings. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new instance of the class. - - - The AWS Access Key ID. - - - The AWS Secret Access Key. - - - The region to configure the transfer utility for. - - - Specifies advanced settings. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new instance of the class. - - - The Amazon S3 client. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Initializes a new instance of the class. - - - The Amazon S3 client. - - - Specifies advanced configuration settings for . - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Gets the Amazon S3 client used for making calls into Amazon S3. - - - The Amazon S3 client used for making calls into Amazon S3. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Uploads the specified file. - The object key is derived from the file's name. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the specified file. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the contents of the specified stream. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The stream to read to obtain the content to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the stream to. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the file or stream specified by the request. - To track the progress of the upload, - add an event listener to the request's UploadProgressEvent. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - Contains all the parameters required to upload to Amazon S3. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Aborts the multipart uploads that were initiated before the specified date. - - - The name of the bucket containing multipart uploads. - - - The date before which the multipart uploads were initiated. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the content from Amazon S3 and writes it to the specified file. - If the key is not specified in the request parameter, - the file name will used as the key name. - - - Contains all the parameters required to download an Amazon S3 object. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Returns a stream from which the caller can read the content from the specified - Amazon S3 bucket and key. - The caller of this method is responsible for closing the stream. - - - The name of the bucket. - - - The object key. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Returns a stream to read the contents from Amazon S3 as - specified by the TransferUtilityOpenStreamRequest. - The caller of this method is responsible for closing the stream. - - - Contains all the parameters required for the OpenStream operation. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Constructs a new class. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new class. - - - The region to configure the transfer utility for. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new class. - - - Specifies advanced configuration settings for . - - - - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - A pattern used to identify the files from the source directory to upload. - - - A search option that specifies whether to recursively search for files to upload - in subdirectories. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The request that contains all the parameters required to upload a directory. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by s3Directory. - - - The name of the bucket containing the Amazon S3 objects to download. - - - The directory in Amazon S3 to download. - - - The local directory to download the objects to. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by the S3Directory - property of the passed in TransferUtilityDownloadDirectoryRequest object. - - - Contains all the parameters required to download objects from Amazon S3 - into a local directory. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the content from Amazon S3 and writes it to the specified file. - - - The file path where the content from Amazon S3 will be written to. - - - The name of the bucket containing the Amazon S3 object to download. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - A pattern used to identify the files from the source directory to upload. - - - A search option that specifies whether to recursively search for files to upload - in subdirectories. - - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The request that contains all the parameters required to upload a directory. - - - - - Uploads the specified file. - The object key is derived from the file's name. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - - - Uploads the specified file. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - The key under which the Amazon S3 object is stored. - - - - - Uploads the contents of the specified stream. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The stream to read to obtain the content to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the stream to. - - - The key under which the Amazon S3 object is stored. - - - - - Uploads the file or stream specified by the request. - To track the progress of the upload, - add an event listener to the request's UploadProgressEvent. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - Contains all the parameters required to upload to Amazon S3. - - - - - Returns a stream from which the caller can read the content from the specified - Amazon S3 bucket and key. - The caller of this method is responsible for closing the stream. - - - The name of the bucket. - - - The object key. - - - A stream of the contents from the specified Amazon S3 and key. - - - - - Returns a stream to read the contents from Amazon S3 as - specified by the TransferUtilityOpenStreamRequest. - The caller of this method is responsible for closing the stream. - - - Contains all the parameters required to open a stream to an S3 object. - - - A stream of the contents from Amazon S3. - - - - - Downloads the content from Amazon S3 and writes it to the specified file. - - - The file path where the content from Amazon S3 will be written to. - - - The name of the bucket containing the Amazon S3 object to download. - - - The key under which the Amazon S3 object is stored. - - - - - Downloads the content from Amazon S3 and writes it to the specified file. - If the key is not specified in the request parameter, - the file name will used as the key name. - - - Contains all the parameters required to download an Amazon S3 object. - - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by s3Directory. - - - The name of the bucket containing the Amazon S3 objects to download. - - - The directory in Amazon S3 to download. - - - The local directory to download the objects to. - - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by the S3Directory - property of the passed in TransferUtilityDownloadDirectoryRequest object. - - - Contains all the parameters required to download objects from Amazon S3 - into a local directory. - - - - - Aborts the multipart uploads that were initiated before the specified date. - - - The name of the bucket containing multipart uploads. - - - The date before which the multipart uploads were initiated. - - - - - - Provides configuration options for how processes requests. - - - The best configuration settings depend on network - configuration, latency and bandwidth. - The default configuration settings are suitable - for most applications, but this class enables developers to experiment with - different configurations and tune transfer manager performance. - - - - - - Default constructor. - - - - - Gets or sets the minimum part size for upload parts in bytes. The default is 16 MB. - Decreasing the minimum part size causes - multipart uploads to be split into a larger number - of smaller parts. Setting this value too low has a negative effect - on transfer speeds, causing extra latency and network - communication for each part. - - - - - This property determines how many active threads - or the number of concurrent asynchronous web requests - will be used to upload/download the file . - The default value is 10. - - - A value less than or equal to 0 will be silently ignored. - - - - - Gets or sets the number of executing threads. - This property determines how many active threads will be used to upload - the file. The default value is 10 threads. - - - A value less than or equal to 0 will be silently ignored. - - - - - Contains all the parameters - that can be set when making a this request with the - TransferUtility method. - - - - - Get or sets the file path location of where the - downloaded Amazon S3 object will be written to. - - - The file path location of where the downloaded Amazon S3 object will be written to. - - - - - Checks if FilePath property is set. - - True if FilePath property is set. - - - - The event for WriteObjectProgressEvent notifications. All - subscribers will be notified when a new progress - event is raised. - - The WriteObjectProgressEvent is fired as data - is downloaded from S3. The delegates attached to the event - will be passed information detailing how much data - has been downloaded as well as how much will be downloaded. - - - - Subscribe to this event if you want to receive - WriteObjectProgressEvent notifications. Here is how:
- 1. Define a method with a signature similar to this one: - - private void displayProgress(object sender, WriteObjectProgressArgs args) - { - Console.WriteLine(args); - } - - 2. Add this method to the WriteObjectProgressEvent delegate's invocation list - - TransferUtilityDownloadRequest request = new TransferUtilityDownloadRequest(); - request.WriteObjectProgressEvent += displayProgress; - - - - - - Causes the WriteObjectProgressEvent event to be fired. - - Progress data for the stream being written to file. - - - - Contains all the parameters - that can be set when making a this request with the - TransferUtility method. - - - - - Contains all the parameters - that can be set when making a this request with the - TransferUtility method. - - - - - Gets or sets the name of the bucket. - - - The name of the bucket. - - - - - Checks if BucketName property is set. - - true if BucketName property is set. - - - - Gets or sets the key under which the Amazon S3 object is to be stored. - - - The key under which the Amazon S3 object is to be stored. - - - - - Checks if Key property is set. - - true if Key property is set. - - - - Gets or sets the canned access control list (ACL) - for the uploaded object. - Please refer to - for - information on Amazon S3 canned ACLs. - - - The canned access control list (ACL) - for the uploaded object. - - - - - Checks if the CannedACL property is set. - - true if there is the CannedACL property is set. - - - - Removes the cannned access control list (ACL) - for the uploaded object. - - - - - Gets or sets the content type of the uploaded Amazon S3 object. - - - The content type of the uploaded Amazon S3 object. - - - - - Checks if ContentType property is set. - - true if ContentType property is set. - - - - Gets or sets the storage class for the uploaded Amazon S3 object. - Please refer to - for - information on S3 Storage Classes. - - - The storage class for the uploaded Amazon S3 object. - - - - - Gets and sets the ServerSideEncryptionMethod property. - Specifies the encryption used on the server to - store the content. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Input stream for the request; content for the request will be read from the stream. - - - - - - Gets or sets the file path - where the Amazon S3 object will be uploaded from. - - - For WinRT and Windows Phone this property must be in the form of "ms-appdata:///local/file.txt". - - - - The file path where the Amazon S3 object will be uploaded from. - - - - - Checks if FilePath property is set. - - true if FilePath property is set. - - - - Gets or sets the part size of the upload in bytes. - The uploaded file will be divided into - parts the size specified and - uploaded to Amazon S3 individually. - - - The part size of the upload. - - - - - Checks if PartSize property is set. - - true if PartSize property is set. - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - The tag-set for the object. - - - - - The event for UploadProgressEvent notifications. All - subscribers will be notified when a new progress - event is raised. - - The UploadProgressEvent is fired as data - is uploaded to S3. The delegates attached to the event - will be passed information detailing how much data - has been uploaded as well as how much will be uploaded. - - - - Subscribe to this event if you want to receive - UploadProgressEvent notifications. Here is how:
- 1. Define a method with a signature similar to this one: - - private void displayProgress(object sender, UploadProgressArgs args) - { - Console.WriteLine(args); - } - - 2. Add this method to the UploadProgressEvent delegate's invocation list - - TransferUtilityUploadRequest request = new TransferUtilityUploadRequest(); - request.UploadProgressEvent += displayProgress; - - - - - - Causes the UploadProgressEvent event to be fired. - - Progress data for the file being uploaded. - - - - Gets the length of the content by either checking the FileInfo.Length property or the Stream.Length property. - - The length of the content. - - - - Gets or sets whether or not the stream used with this request is - automatically closed when all of the content is read from the stream. - - - A value of true if the if the stream is - automatically closed when all of the content is read from the stream. - A value of false if otherwise. - - - - - If this value is set to true then the stream's position will be reset to the start before being read for upload. - Default: true. - - - - - Sets whether or not the stream used with this request is - automatically closed when all of the content is read from the stream - and returns this object instance, - enabling additional method calls to be chained together. - - - A value of true if the if the stream is - automatically closed when all of the content is read from the stream. - A value of false if otherwise. - - - This object instance, enabling additional method calls to be chained together. - - - - - Encapsulates the information needed to provide - transfer progress to subscribers of the Put Object - Event. - - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The how many bytes were transferred since last event. - The number of bytes transferred - The total number of bytes to be transferred - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The how many bytes were transferred since last event. - The number of bytes transferred - The total number of bytes to be transferred - The file being uploaded - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The how many bytes were transferred since last event. - The number of bytes transferred - The total number of bytes to be transferred - A compensation for any upstream aggregators if this event to correct theit totalTransferred count, - in case the underlying request is retried. - The file being uploaded - - - - Gets the FilePath. - - - - - Request object for downloading a directory with the TransferUtility. - - - - - Gets or sets the name of the bucket. - - - The name of the bucket. - - - - - Gets whether or not the bucket name is set. - - - A value of true if the bucket name is set. - Otherwise, returns false. - - - - - Gets or sets the local directory where objects from Amazon S3 will be downloaded. - If the directory doesn't exist, it will be created. - - - The local directory where objects from Amazon S3 will be downloaded. - - - - - Gets whether or not the LocalDirectory property is set. - - - A value of true if LocalDirectory property is set. - Otherwise, returns false. - - - - - Gets or sets the Amazon S3 directory to download from. - This is translated to a key prefix; keys that have this prefix will be - downloaded. - - - - - Gets whether or not the S3Directory property is set. - - - A value of true if S3Directory property is set. - Otherwise, returns false. - - - - - - This property is deprecated. This property doesn't honor the DateTimeKind, please - use ModifiedSinceDateUtc instead. - - Gets or sets the ModifiedSinceDate property. - Only objects that have been modified since this date will be - downloaded. - - - The ModifiedSinceDate property. - - - - - Checks if ModifiedSinceDate property is set. - - A value of true if ModifiedSinceDate property is set. - Otherwise, returns false. - - - - Gets or sets the ModifiedSinceDateUtc property. - Only objects that have been modified since this date will be - downloaded. - - - The ModifiedSinceDateUtc property. - - - - - Checks if ModifiedSinceDateUtc property is set. - - A value of true if ModifiedSinceDateUtc property is set. - Otherwise, returns false. - - - - - This property is deprecated. This property doesn't honor the DateTimeKind, please - use UnmodifiedSinceDateUtc instead. - - Gets or sets the UnmodifiedSinceDate property. - Only objects that have not been modified since this date will be downloaded. - - - The UnmodifiedSinceDate property. - - - - - Checks if UnmodifiedSinceDate property is set. - - true if UnmodifiedSinceDate property is set. - - - - Gets or sets the UnmodifiedSinceDateUtc property. - Only objects that have not been modified since this date will be downloaded. - - - The UnmodifiedSinceDateUtc property. - - - - - Checks if UnmodifiedSinceDateUtc property is set. - - true if UnmodifiedSinceDateUtc property is set. - - - - Gets or sets the DownloadFilesConcurrently property. - Specifies if multiple files will be downloaded concurrently. - The number of concurrent web requests used is controlled - by the TransferUtilityConfig.ConcurrencyLevel property. - - - - - The event for DownloadedDirectoryProgressEvent notifications. All - subscribers will be notified when a new progress - event is raised. - - The DownloadedDirectoryProgressEvent is fired as data - is downloaded from Amazon S3. The delegates attached to the event - will be passed information detailing how much data - has been downloaded as well as how much will be downloaded. - - - - Subscribe to this event if you want to receive - DownloadedDirectoryProgressEvent notifications. Here is how:
- 1. Define a method with a signature similar to this one: - - private void displayProgress(object sender, DownloadDirectoryProgressArgs args) - { - Console.WriteLine(args); - } - - 2. Add this method to the DownloadedDirectoryProgressEvent delegate's invocation list - - TransferUtilityDownloadDirectoryRequest request = new TransferUtilityDownloadDirectoryRequest(); - request.DownloadedDirectoryProgressEvent += displayProgress; - - - - - - Encapsulates the information needed to provide - transfer progress to subscribers of the DownloadDirectory - event. - - - - - Constructs a new instance of DownloadDirectoryProgressArgs. - - - The number of files downloaded. - - - The total number of files to download. - - - The current file being downloaded - - - The number of transferred bytes for the current file. - - - The size of the current file in bytes. - - - - - Constructs a new instance of DownloadDirectoryProgressArgs. - - - The number of files downloaded. - - - The total number of files to download. - - - The bytes transferred across all files being downloaded. - - - The total number of bytes across all files being downloaded. - - - The current file being downloaded. - - - The number of transferred bytes for the current file. - - - The size of the current file in bytes. - - - - - Gets or sets the total number of files. - - The total number of files. - - - - Gets or sets the number of files downloaded so far. - - The number of files downloaded. - - - - Gets or sets the total number of bytes across all files being downloaded. - - The total number of bytes across all files being downloaded. - - - - Gets or sets the bytes transferred across all files being downloaded. - - The bytes transferred across all files being downloaded. - - - - Gets or sets the current file being downloaded. - - The current file being downloaded. - - - - Gets or sets the transferred bytes for the current file. - - The transferred bytes for the current file. - - - - Gets or sets the total number of bytes for the current file. - - The total number of bytes for the current file. - - - - The string representation of this instance of DownloadDirectoryProgressArgs. - - The string representation of this instance of DownloadDirectoryProgressArgs. - - - - Contains all the parameters - that can be set when making a this request with the - TransferUtility method. - - - - - Gets or sets the directory where files are uploaded from. - - - The directory where files are uploaded from. - - - - - Checks if Directory property is set. - - true if Directory property is set. - - - - Gets or sets the KeyPrefix property. As object keys are generated for the - files being uploaded this value will prefix the key. This is useful when a directory - needs to be uploaded into sub directory in the S3 Bucket. - - - The directory where files are uploaded from. - - - - - Checks if KeyPrefix property is set. - - true if KeyPrefix property is set. - - - - Gets and sets the search pattern used to determine which - files in the directory are uploaded. - - - The search pattern used to deterimine which - files in the directory are uploaded. - The default value is "*", specifying that all files - in the directory will be uploaded. - - - - - Checks if SearchPattern property is set. - - true if SearchPattern property is set. - - - - Gets or sets the recursive options for the directory upload. - - - The recursive options for the directory upload. - Set by default to TopDirectoryOnly, - specifying that files will be uploaded from the root directory only. - - - - - Gets or sets the name of the bucket. - - - The name of the bucket. - - - - - Checks if BucketName property is set. - - true if BucketName property is set. - - - - Gets or sets the canned access control list (ACL) - for the uploaded objects. - Please refer to - for - information on Amazon S3 canned ACLs. - - - The canned access control list (ACL) - for the uploaded objects. - - - - - Checks if the CannedACL property is set. - - true if there is the CannedACL property is set. - - - - Gets or sets the content type for the uploaded Amazon S3 objects. - The default behavior when this field is not set is to use the file - extension to set the content type. If this field is set to a value it - will be applied to all uploaded files in the directory, overriding - file extension inspection. - - - The content type for all the uploaded Amazon S3 objects. - - - - - Gets or sets the storage class for the uploaded Amazon S3 objects. - Please refer to - for - information on S3 Storage Classes. - - - The storage class for the uploaded Amazon S3 objects. - - - - - The collection of meta data for the request. - - - - - Gets or sets the ServerSideEncryptionMethod property. - Specifies the encryption used on the server to - store the content. - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Gets or sets the UploadFilesConcurrently property. - Specifies if multiple files will be uploaded concurrently. - The number of concurrent web requests used is controlled - by the TransferUtilityConfig.ConcurrencyLevel property. - - - - - The event for UploadDirectoryProgressEvent notifications. All - subscribers will be notified when a new progress - event is raised. - - The UploadDirectoryProgressEvent is fired as data - is uploaded to S3. The delegates attached to the event - will be passed information detailing how much data - has been uploaded as well as how much will be uploaded. - - - - Subscribe to this event if you want to receive - UploadDirectoryProgressEvent notifications. Here is how:
- 1. Define a method with a signature similar to this one: - - private void displayProgress(object sender, UploadDirectoryProgressArgs args) - { - Console.WriteLine(args); - } - - 2. Add this method to the UploadDirectoryProgressEvent delegate's invocation list - - TransferUtilityUploadDirectoryRequest request = new TransferUtilityUploadDirectoryRequest(); - request.UploadDirectoryProgressEvent += displayProgress; - - - - - - The event for modifying individual TransferUtilityUploadRequest for each file - being uploaded. - - - - - Causes the UploadDirectoryProgressEvent event to be fired. - - Progress data for files currently being uploaded. - - - - Tags that will be applied to all objects in the diretory. - - - - - Encapsulates the information needed to provide - transfer progress to subscribers of the UploadDirectory - event. - - - - - Constructs a new instance of UploadDirectoryProgressArgs. - - - The number of files uploaded. - - - The total number of files to upload. - - - The current file - - - The number of transferred bytes for current file. - - - The size of the current file in bytes. - - - - - Constructs a new instance of UploadDirectoryProgressArgs. - - - The number of files uploaded. - - - The total number of files to upload. - - - The bytes transferred across all files being uploaded. - - - The total number of bytes across all files being uploaded. - - - The current file being uploaded. - - - The number of transferred bytes for current file. - - - The size of the current file in bytes. - - - - - Gets or sets the total number of files. - - The total number of files. - - - - Gets or sets the number of files uploaded. - - The number of files uploaded. - - - - Gets or sets the total number of bytes across all files being uploaded. - - The total number of bytes across all files being uploaded. - - - - Gets or sets the bytes transferred across all files being uploaded. - - The bytes transferred across all files being uploaded. - - - - Gets or sets the current file. - - - This property is only valid if UploadDirectory is used without enabling concurrent file uploads (by default concurrent upload is disabled). - If concurrent file uploads are enabled by setting TransferUtilityUploadDirectoryRequest.UploadFilesConcurrently to true, this property - will return null. - - The current file. - - - - Gets or sets the transferred bytes for current file. - - - This property is only valid if UploadDirectory is used without enabling concurrent file uploads (by default concurrent upload is disabled). - If concurrent file uploads are enabled by setting TransferUtilityUploadDirectoryRequest.UploadFilesConcurrently to true, this property - will return 0. - - The transferred bytes for current file. - - - - Gets or sets the total number of bytes for current file. - - - This property is only valid if UploadDirectory is used without enabling concurrent file uploads (by default concurrent upload is disabled). - If concurrent file uploads are enabled by setting TransferUtilityUploadDirectoryRequest.UploadFilesConcurrently to true, this property - will return 0. - - The total number of bytes for current file. - - - - The string representation of this instance of UploadDirectoryProgressArgs. - - The string representation of this instance of UploadDirectoryProgressArgs. - - - - Contains a single TransferUtilityUploadRequest corresponding - to a single file about to be uploaded, allowing changes to - the request before it is executed. - - - - - Constructs a new UploadDirectoryFileRequestArgs instance. - - Request being processed. - - - - Gets and sets the UploadRequest property. - - - - - This class extends the AmazonS3Client and provides client side encryption when reading or writing S3 objects. - - - - - Constructs AmazonS3EncryptionClient with the Encryption materials and credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Constructs AmazonS3EncryptionClient with the Encryption materials and credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - - The region to connect. - - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Constructs AmazonS3EncryptionClient with the Encryption materials, - AmazonS3 CryptoConfiguration object and credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - - The AmazonS3EncryptionClient CryptoConfiguration Object - - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Constructs AmazonS3EncryptionClient with AWS Credentials and Encryption materials. - - - The encryption materials to be used to encrypt and decrypt envelope key. - - AWS Credentials - - - - Constructs AmazonS3EncryptionClient with AWS Credentials, Region and Encryption materials - - AWS Credentials - The region to connect. - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Constructs AmazonS3EncryptionClient with AWS Credentials, AmazonS3CryptoConfiguration Configuration object - and Encryption materials - - AWS Credentials - The AmazonS3EncryptionClient CryptoConfiguration Object - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Constructs AmazonS3EncryptionClient with AWS Access Key ID, - AWS Secret Key and Encryption materials - - AWS Access Key ID - AWS Secret Access Key - The encryption materials to be used to encrypt and decrypt envelope key. - - - - Constructs AmazonS3EncryptionClient with AWS Access Key ID, - AWS Secret Key, Region and Encryption materials - - AWS Access Key ID - AWS Secret Access Key - The region to connect. - The encryption materials to be used to encrypt and decrypt envelope key. - - - - Constructs AmazonS3EncryptionClient with AWS Access Key ID, Secret Key, - AmazonS3 CryptoConfiguration object and Encryption materials. - - AWS Access Key ID - AWS Secret Access Key - The AmazonS3EncryptionClient CryptoConfiguration Object - The encryption materials to be used to encrypt and decrypt envelope key. - - - - Constructs AmazonS3EncryptionClient with AWS Access Key ID, Secret Key, - SessionToken and Encryption materials. - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Constructs AmazonS3EncryptionClient with AWS Access Key ID, Secret Key, - SessionToken, Region and Encryption materials. - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - The region to connect. - The encryption materials to be used to encrypt and decrypt envelope key. - - - - Constructs AmazonS3EncryptionClient with AWS Access Key ID, Secret Key, SessionToken - AmazonS3EncryptionClient CryptoConfiguration object and Encryption materials. - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - The AmazonS3EncryptionClient CryptoConfiguration Object - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Turn off response logging because it will interfere with decrypt of the data coming back from S3. - - - - - Customize the pipeline to allow encryption. - - - - - - Dispose this instance - - - - - - AmazonS3CryptoConfiguration allows customers - to set storage mode for encryption credentials - - - - - Default Constructor. - - - - - Gets and sets the StorageMode property. This determines if the crypto metadata is stored as metadata on the object or as a separate object in S3. - The default is ObjectMetadata. - - - - - Mode for string the encryption information for an object. - - - - - Store the information in a separate S3 Object. - - - - - Store the information as metadata on the encrypted object. - - - - - Encryption Instructions store the encryption credentials - - - - - Construct an instance EncryptionInstructions. - - - - - - - - - Construct an instance EncryptionInstructions. - - - - - - - - The "key encrypting key" materials used in encrypt/decryption. - These materials may be an asymmetric key, a symmetric key, or a KMS key ID. - - - - - Constructs a new EncryptionMaterials object, storing an asymmetric key. - - - - - - Constructs a new EncryptionMaterials object, storing a symmetric key. - - - - - - Constructs a new EncryptionMaterials object, storing a KMS Key ID - - - - - - The EncryptionUtils class encrypts and decrypts data stored in S3. - It can be used to prepare requests for encryption before they are stored in S3 - and to decrypt objects that are retrieved from S3. - - - - - Decrypts an encrypted Envelope key using the provided encryption materials - and returns it in raw byte array form. - - Encrypted envelope key - Encryption materials needed to decrypt the encrypted envlelope key - - - - - Returns an updated stream where the stream contains the encrypted object contents. - The specified instruction will be used to encrypt data. - - - The stream whose contents are to be encrypted. - - - The instruction that will be used to encrypt the object data. - - - Encrypted stream, i.e input stream wrapped into encrypted stream - - - - - Returns an updated input stream where the input stream contains the encrypted object contents. - The specified instruction will be used to encrypt data. - - - The stream whose contents are to be encrypted. - - - The instruction that will be used to encrypt the object data. - - - Encrypted stream, i.e input stream wrapped into encrypted stream - - - - - Updates object where the object - input stream contains the decrypted contents. - - - The getObject response whose contents are to be decrypted. - - - The instruction that will be used to encrypt the object data. - - - - - Generates an instruction that will be used to encrypt an object - using materials with the KMSKeyID set. - - - Used to call KMS to generate a data key. - - - The encryption materials to be used to encrypt and decrypt data. - - - The instruction that will be used to encrypt an object. - - - - - Generates an instruction that will be used to encrypt an object - using materials with the KMSKeyID set. - - - Used to call KMS to generate a data key. - - - The encryption materials to be used to encrypt and decrypt data. - - - The instruction that will be used to encrypt an object. - - - - - Generates an instruction that will be used to encrypt an object - using materials with the AsymmetricProvider or SymmetricProvider set. - - - The encryption materials to be used to encrypt and decrypt data. - - - The instruction that will be used to encrypt an object. - - - - - Builds an instruction object from the object metadata. - - - A non-null object response that contains encryption information in its metadata. - - - The non-null encryption materials to be used to encrypt and decrypt Envelope key. - - - The decrypted envelope key to be use if KMS key wrapping is being used. Or null if non-KMS key wrapping is being used. - - - - - - - Builds an instruction object from the instruction file. - - Instruction file GetObject response - - The non-null encryption materials to be used to encrypt and decrypt Envelope key. - - - A non-null instruction object containing encryption information. - - - - - Update the request's ObjectMetadata with the necessary information for decrypting the object. - - - AmazonWebServiceRequest encrypted using the given instruction - - - Non-null instruction used to encrypt the data in this AmazonWebServiceRequest . - - - If true use V2 metadata format, otherwise use V1. - - - - - Adds UnEncrypted content length to object metadata - - - - - - checks if encryption credentials are in object metadata - - Response of the object - - - - - checks if encryption credentials are in the instructionfile - - Instruction file response that contains encryption information - - - - - Custom the pipeline handler to decrypt objects. - - - - - Construct instance of SetupDecryptionHandler. - - - - - - Gets the EncryptionClient property which is the AmazonS3EncryptionClient that is decrypting the object. - - - - - Calls the post invoke logic after calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Decrypt the object being downloaded. - - - - - - Calls the and post invoke logic after calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Decrypt the object being downloaded. - - - - - - Decrypt the object being downloaded. - - - - - - - Updates object where the object input stream contains the decrypted contents. - - - The getObject response of InstructionFile. - - - The getObject response whose contents are to be decrypted. - - - - - Updates object where the object input stream contains the decrypted contents. - - - The getObject response whose contents are to be decrypted. - - - The decrypted envelope key to be use if KMS key wrapping is being used. Or null if non-KMS key wrapping is being used. - - - - - Custom pipeline handler to encrypt the data as it is being uploaded to S3. - - - - - Construct an instance SetupEncryptionHandler. - - - - - - Gets the EncryptionClient property which is the AmazonS3EncryptionClient that is encrypting the object. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Encrypts the S3 object being uploaded. - - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Encrypts the S3 object being uploaded. - - - - - - Make sure that the storage mode and encryption materials are compatible. - The client only supports KMS key wrapping in metadata storage mode. - - - - - Updates the request where the metadata contains encryption information - and the input stream contains the encrypted object contents. - - - The request whose contents are to be encrypted. - - - - - Updates the request where the instruction file contains encryption information - and the input stream contains the encrypted object contents. - - - - - - Updates the request where the input stream contains the encrypted object contents. - - - - - - Adds the crypto token to the user agent - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Customize the user agent. - - - - - - Configuration for the S3 section of AWS configuration. - Changes to some settings may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws> - <s3 useSignatureVersion4="true" /> - </aws> - - - - - - Key for the S3UseSignatureVersion4Key property. - - - - - - Configures if the S3 client should use Signature Version 4 signing with requests. - By default, this setting is set to true which will use Signature Version 4 for all - requests except presigned URL requests when the region is set to us-east-1. When - UseSignatureVersion4 is explicitly set to true by directly setting this property or - directly setting this property through configuration, Signature Version 4 will be - used for all requests when able to do so. - When this setting is false, Signature Version 2 will be used. Note that when the - setting is false, Signature Version 4 may still be used by default in some cases - or with some regions. - - - - - Escape and unescape S3 metadata for S3 Put/Get object requests. - Escape only escapes non-ascii values in metadata - Any "%" values in metadata could interfere with this option. - Default value is false. - - - - - Was the value of the UseSignatureVersion4 property set explicitly? - This can be done via configuration or by directly setting the property. - - This is used to determine if the user set UseSignatureVersion4 to true, - or if it's true because the default was changed to true in the SDK. - - - - diff --git a/packages/AWSSDK.S3.3.3.111.14/lib/portable-net45+win8+wpa81+wp8/AWSSDK.S3.XML b/packages/AWSSDK.S3.3.3.111.14/lib/portable-net45+win8+wpa81+wp8/AWSSDK.S3.XML deleted file mode 100644 index 389da7c..0000000 --- a/packages/AWSSDK.S3.3.3.111.14/lib/portable-net45+win8+wpa81+wp8/AWSSDK.S3.XML +++ /dev/null @@ -1,28560 +0,0 @@ - - - - AWSSDK.S3 - - - - - Implementation for accessing S3 - - - - - - - Specialize the initialize of the client. - - - - - Create a signed URL allowing access to a resource that would - usually require authentication. - - - - When using query string authentication you create a query, - specify an expiration time for the query, sign it with your - signature, place the data in an HTTP request, and distribute - the request to a user or embed the request in a web page. - - - A PreSigned URL can be generated for GET, PUT, DELETE and HEAD - operations on your bucketName, keys, and versions. - - - The GetPreSignedUrlRequest that defines the - parameters of the operation. - determines if signing will fall back to SigV2 if the - signing region is us-east-1 - A string that is the signed http request. - - - - - - Marshalls the parameters for a presigned url for a preferred signing protocol. - - - - - - True if AWS4 signing will be used; if the expiry period in the request exceeds the - maximum allowed for AWS4 (one week), an ArgumentException is thrown. - - - - - - Create a signed URL allowing access to a resource that would - usually require authentication. - - - - When using query string authentication you create a query, - specify an expiration time for the query, sign it with your - signature, place the data in an HTTP request, and distribute - the request to a user or embed the request in a web page. - - - A PreSigned URL can be generated for GET, PUT, DELETE and HEAD - operations on your bucketName, keys, and versions. - - - The GetPreSignedUrlRequest that defines the - parameters of the operation. - A string that is the signed http request. - - - - - - Constructs AmazonS3Client with AWS Credentials - - AWS Credentials - - - - Constructs AmazonS3Client with AWS Credentials - - AWS Credentials - The region to connect. - - - - Constructs AmazonS3Client with AWS Credentials and an - AmazonS3Client Configuration object. - - AWS Credentials - The AmazonS3Client Configuration Object - - - - Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - - - - Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - The region to connect. - - - - Constructs AmazonS3Client with AWS Access Key ID, AWS Secret Key and an - AmazonS3Client Configuration object. - - AWS Access Key ID - AWS Secret Access Key - The AmazonS3Client Configuration Object - - - - Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - - - - Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - The region to connect. - - - - Constructs AmazonS3Client with AWS Access Key ID, AWS Secret Key and an - AmazonS3Client Configuration object. - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - The AmazonS3Client Configuration Object - - - - Creates the signer for the service. - - - - - Customizes the runtime pipeline. - - Runtime pipeline for the current client. - - - - Capture metadata for the service. - - - - - Disposes the service client. - - - - - This operation aborts a multipart upload. After a multipart upload is aborted, no - additional parts can be uploaded using that upload ID. The storage consumed by any - previously uploaded parts will be freed. However, if any part uploads are currently - in progress, those part uploads might or might not succeed. As a result, it might - be necessary to abort a given multipart upload multiple times in order to completely - free all storage consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts operation and ensure that the parts - list is empty. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - The bucket name to which the upload was taking place. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object for which the multipart upload was initiated. - Upload ID that identifies the multipart upload. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AbortMultipartUpload service method, as returned by S3. - REST API Reference for AbortMultipartUpload Operation - - - - This operation aborts a multipart upload. After a multipart upload is aborted, no - additional parts can be uploaded using that upload ID. The storage consumed by any - previously uploaded parts will be freed. However, if any part uploads are currently - in progress, those part uploads might or might not succeed. As a result, it might - be necessary to abort a given multipart upload multiple times in order to completely - free all storage consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts operation and ensure that the parts - list is empty. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - Container for the necessary parameters to execute the AbortMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AbortMultipartUpload service method, as returned by S3. - REST API Reference for AbortMultipartUpload Operation - - - - Completes a multipart upload by assembling previously uploaded parts. - - - - You first initiate the multipart upload and then upload all parts using the UploadPart - operation. After successfully uploading all relevant parts of an upload, you call - this operation to complete the upload. Upon receiving this request, Amazon S3 concatenates - all the parts in ascending order by part number to create a new object. In the Complete - Multipart Upload request, you must provide the parts list. You must ensure that the - parts list is complete. This operation concatenates the parts that you provide in - the list. For each part in the list, you must provide the part number and the ETag - value, returned after that part was uploaded. - - - - Processing of a Complete Multipart Upload request could take several minutes to complete. - After Amazon S3 begins processing the request, it sends an HTTP response header that - specifies a 200 OK response. While processing is in progress, Amazon S3 periodically - sends white space characters to keep the connection from timing out. Because a request - could fail after the initial 200 OK response has been sent, it is important that you - check the response body to determine whether the request succeeded. - - - - Note that if CompleteMultipartUpload fails, applications should be prepared - to retry the failed requests. For more information, see Amazon - S3 Error Best Practices. - - - - For more information about multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - GetBucketLifecycle has the following special errors: - -
  • - - Error code: EntityTooSmall - -
    • - - Description: Your proposed upload is smaller than the minimum allowed object size. - Each part must be at least 5 MB in size, except the last part. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPart - -
    • - - Description: One or more of the specified parts could not be found. The part might - not have been uploaded, or the specified entity tag might not have matched the part's - entity tag. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPartOrder - -
    • - - Description: The list of parts was not in ascending order. The parts list must be - specified in order by part number. - -
    • - - 400 Bad Request - -
  • - - Error code: NoSuchUpload - -
    • - - Description: The specified multipart upload does not exist. The upload ID might be - invalid, or the multipart upload might have been aborted or completed. - -
    • - - 404 Not Found - -
- - The following operations are related to CompleteMultipartUpload: - - - - Container for the necessary parameters to execute the CompleteMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CompleteMultipartUpload service method, as returned by S3. - REST API Reference for CompleteMultipartUpload Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 Developer Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Encryption - - - - The source object that you are copying can be encrypted or unencrypted. The source - object can be encrypted with server-side encryption using AWS managed encryption keys - (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side - encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers - and decrypts the data when you access it. - - - - You can optionally use the appropriate encryption-related headers to request server-side - encryption for the target object. You have the option to provide your own encryption - key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that - was used to encrypt the source object. You can even request encryption if the source - object was not encrypted. For more information about server-side encryption, see Using - Server-Side Encryption. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject operation to change the storage class of an - object that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 Service Developer Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 Developer Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Encryption - - - - The source object that you are copying can be encrypted or unencrypted. The source - object can be encrypted with server-side encryption using AWS managed encryption keys - (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side - encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers - and decrypts the data when you access it. - - - - You can optionally use the appropriate encryption-related headers to request server-side - encryption for the target object. You have the option to provide your own encryption - key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that - was used to encrypt the source object. You can even request encryption if the source - object was not encrypted. For more information about server-side encryption, see Using - Server-Side Encryption. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject operation to change the storage class of an - object that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 Service Developer Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 Developer Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Encryption - - - - The source object that you are copying can be encrypted or unencrypted. The source - object can be encrypted with server-side encryption using AWS managed encryption keys - (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side - encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers - and decrypts the data when you access it. - - - - You can optionally use the appropriate encryption-related headers to request server-side - encryption for the target object. You have the option to provide your own encryption - key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that - was used to encrypt the source object. You can even request encryption if the source - object was not encrypted. For more information about server-side encryption, see Using - Server-Side Encryption. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject operation to change the storage class of an - object that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 Service Developer Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - Container for the necessary parameters to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - - - - - - Deletes an analytics configuration for the bucket (specified by the analytics configuration - ID). - - - - To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to DeleteBucketAnalyticsConfiguration: - -
  • - - - -
  • - - - -
  • - - - -
- - Container for the necessary parameters to execute the DeleteBucketAnalyticsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketAnalyticsConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketAnalyticsConfiguration Operation - - - - - Deletes an inventory configuration (identified by the inventory ID) from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - Operations related to DeleteBucketInventoryConfiguration include: - - - - Container for the necessary parameters to execute the DeleteBucketInventoryConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketInventoryConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketInventoryConfiguration Operation - - - - Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified - by the metrics configuration ID) from the bucket. Note that this doesn't include the - daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketMetricsConfiguration Operation - - - - This implementation of the DELETE operation uses the policy subresource to delete - the policy of a specified bucket. If you are using an identity other than the root - user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - The bucket name. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketPolicy service method, as returned by S3. - REST API Reference for DeleteBucketPolicy Operation - - - - This implementation of the DELETE operation uses the policy subresource to delete - the policy of a specified bucket. If you are using an identity other than the root - user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - Container for the necessary parameters to execute the DeleteBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketPolicy service method, as returned by S3. - REST API Reference for DeleteBucketPolicy Operation - - - - Deletes the replication configuration from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutReplicationConfiguration - action. The bucket owner has these permissions by default and can grant it to others. - For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - It can take a while for the deletion of a replication configuration to fully propagate. - - - - For information about replication configuration, see Replication - in the Amazon S3 Developer Guide. - - - - The following operations are related to DeleteBucketReplication: - - - - Container for the necessary parameters to execute the DeleteBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketReplication service method, as returned by S3. - REST API Reference for DeleteBucketReplication Operation - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - The bucket that has the tag set to be removed. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketTagging service method, as returned by S3. - REST API Reference for DeleteBucketTagging Operation - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - Container for the necessary parameters to execute the DeleteBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketTagging service method, as returned by S3. - REST API Reference for DeleteBucketTagging Operation - - - - This operation removes the website configuration for a bucket. Amazon S3 returns a - 200 OK response upon successfully deleting a website configuration on - the specified bucket. You will get a 200 OK response if the website configuration - you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE operation requires the S3:DeleteBucketWebsite permission. - By default, only the bucket owner can delete the website configuration attached to - a bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which you want to remove the website configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketWebsite service method, as returned by S3. - REST API Reference for DeleteBucketWebsite Operation - - - - This operation removes the website configuration for a bucket. Amazon S3 returns a - 200 OK response upon successfully deleting a website configuration on - the specified bucket. You will get a 200 OK response if the website configuration - you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE operation requires the S3:DeleteBucketWebsite permission. - By default, only the bucket owner can delete the website configuration attached to - a bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the DeleteBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketWebsite service method, as returned by S3. - REST API Reference for DeleteBucketWebsite Operation - - - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - The bucket name of the lifecycle to delete. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - REST API Reference for DeleteLifecycleConfiguration Operation - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - Container for the necessary parameters to execute the DeleteLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - REST API Reference for DeleteLifecycleConfiguration Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key name of the object to delete. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key name of the object to delete. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - Container for the necessary parameters to execute the DeleteObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - This operation enables you to delete multiple objects from a bucket using a single - HTTP request. If you know the object keys that you want to delete, then this operation - provides a suitable alternative to sending individual delete requests, reducing per-request - overhead. - - - - The request contains a list of up to 1000 keys that you want to delete. In the XML, - you provide the object key names, and optionally, version IDs if you want to delete - a specific version of the object from a versioning-enabled bucket. For each key, Amazon - S3 performs a delete operation and returns the result of that delete, success, or - failure, in the response. Note that if the object specified in the request is not - found, Amazon S3 returns the result as deleted. - - - - The operation supports two modes for the response: verbose and quiet. By default, - the operation uses verbose mode in which the response includes the result of deletion - of each key in your request. In quiet mode the response includes only keys where the - delete operation encountered an error. For a successful deletion, the operation does - not return any information about the delete in the response body. - - - - When performing this operation on an MFA Delete enabled bucket, that attempts to delete - any versioned objects, you must include an MFA token. If you do not provide one, the - entire request will fail, even if there are non-versioned objects you are trying to - delete. If you provide an invalid token, whether there are versioned keys in the request - or not, the entire Multi-Object Delete request will fail. For information about MFA - Delete, see - MFA Delete. - - - - Finally, the Content-MD5 header is required for all Multi-Object Delete requests. - Amazon S3 uses the header value to ensure that your request body has not been altered - in transit. - - - - The following operations are related to DeleteObjects: - - - - Container for the necessary parameters to execute the DeleteObjects service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObjects service method, as returned by S3. - REST API Reference for DeleteObjects Operation - - - - Removes the entire tag set from the specified object. For more information about managing - object tags, see - Object Tagging. - - - - To use this operation, you must have permission to perform the s3:DeleteObjectTagging - action. - - - - To delete tags of a specific object version, add the versionId query - parameter in the request. You will need permission for the s3:DeleteObjectVersionTagging - action. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteObjectTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObjectTagging service method, as returned by S3. - REST API Reference for DeleteObjectTagging Operation - - - - Removes the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:PutBucketPublicAccessBlock - permission. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to DeletePublicAccessBlock: - - - - Container for the necessary parameters to execute the DeletePublicAccessBlock service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeletePublicAccessBlock service method, as returned by S3. - REST API Reference for DeletePublicAccessBlock Operation - - - - - - - - - Returns the default encryption configuration for an Amazon S3 bucket. For information - about the Amazon S3 default encryption feature, see Amazon - S3 Default Bucket Encryption. - - - - To use this operation, you must have permission to perform the s3:GetEncryptionConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to GetBucketEncryption: - - - - Container for the necessary parameters to execute the GetBucketEncryption service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketEncryption service method, as returned by S3. - REST API Reference for GetBucketEncryption Operation - - - - Returns an inventory configuration (identified by the inventory configuration ID) - from the bucket. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - The following operations are related to GetBucketInventoryConfiguration: - - - - Container for the necessary parameters to execute the GetBucketInventoryConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketInventoryConfiguration service method, as returned by S3. - REST API Reference for GetBucketInventoryConfiguration Operation - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - The name of the bucket for which to get the location. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLocation service method, as returned by S3. - REST API Reference for GetBucketLocation Operation - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - Container for the necessary parameters to execute the GetBucketLocation service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLocation service method, as returned by S3. - REST API Reference for GetBucketLocation Operation - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - The bucket name for which to get the logging information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLogging service method, as returned by S3. - REST API Reference for GetBucketLogging Operation - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - Container for the necessary parameters to execute the GetBucketLogging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLogging service method, as returned by S3. - REST API Reference for GetBucketLogging Operation - - - - Gets a metrics configuration (specified by the metrics configuration ID) from the - bucket. Note that this doesn't include the daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to GetBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the GetBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for GetBucketMetricsConfiguration Operation - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following operation is related to GetBucketNotification: - - - - Name of the bucket for which to get the notification configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketNotification service method, as returned by S3. - REST API Reference for GetBucketNotification Operation - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following operation is related to GetBucketNotification: - - - - Container for the necessary parameters to execute the GetBucketNotification service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketNotification service method, as returned by S3. - REST API Reference for GetBucketNotification Operation - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operation is related to GetBucketPolicy: - - - - The bucket name for which to get the bucket policy. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicy service method, as returned by S3. - REST API Reference for GetBucketPolicy Operation - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operation is related to GetBucketPolicy: - - - - Container for the necessary parameters to execute the GetBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicy service method, as returned by S3. - REST API Reference for GetBucketPolicy Operation - - - - Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket - is public. In order to use this operation, you must have the s3:GetBucketPolicyStatus - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - For more information about when Amazon S3 considers a bucket public, see The - Meaning of "Public". - - - - The following operations are related to GetBucketPolicyStatus: - - - - Container for the necessary parameters to execute the GetBucketPolicyStatus service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicyStatus service method, as returned by S3. - REST API Reference for GetBucketPolicyStatus Operation - - - - Retrieves the replication configuration for the given Amazon S3 bucket. - - Container for the necessary parameters to execute the GetBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketReplication service method, as returned by S3. - REST API Reference for GetBucketReplication Operation - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - The name of the bucket for which to get the payment request configuration - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketRequestPayment service method, as returned by S3. - REST API Reference for GetBucketRequestPayment Operation - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - Container for the necessary parameters to execute the GetBucketRequestPayment service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketRequestPayment service method, as returned by S3. - REST API Reference for GetBucketRequestPayment Operation - - - - Returns the tag set associated with the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - GetBucketTagging has the following special error: - -
  • - - Error code: NoSuchTagSetError - -
    • - - Description: There is no tag set associated with the bucket. - -
- - The following operations are related to GetBucketTagging: - - - - Container for the necessary parameters to execute the GetBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketTagging service method, as returned by S3. - REST API Reference for GetBucketTagging Operation - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - The name of the bucket for which to get the versioning information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketVersioning service method, as returned by S3. - REST API Reference for GetBucketVersioning Operation - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - Container for the necessary parameters to execute the GetBucketVersioning service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketVersioning service method, as returned by S3. - REST API Reference for GetBucketVersioning Operation - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET operation requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which to get the website configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketWebsite service method, as returned by S3. - REST API Reference for GetBucketWebsite Operation - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET operation requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the GetBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketWebsite service method, as returned by S3. - REST API Reference for GetBucketWebsite Operation - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - The bucket name for which to get the cors configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetCORSConfiguration service method, as returned by S3. - REST API Reference for GetCORSConfiguration Operation - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - Container for the necessary parameters to execute the GetCORSConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetCORSConfiguration service method, as returned by S3. - REST API Reference for GetCORSConfiguration Operation - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are still using previous version of the lifecycle configuration, it works. - For the earlier API description, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to GetBucketLifecycleConfiguration: - - - - The name of the bucket for which to get the lifecycle information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetLifecycleConfiguration service method, as returned by S3. - REST API Reference for GetLifecycleConfiguration Operation - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are still using previous version of the lifecycle configuration, it works. - For the earlier API description, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to GetBucketLifecycleConfiguration: - - - - Container for the necessary parameters to execute the GetLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetLifecycleConfiguration service method, as returned by S3. - REST API Reference for GetLifecycleConfiguration Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object to get. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object to get. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - Container for the necessary parameters to execute the GetObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Gets an object's current Legal Hold status. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLegalHold service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectLegalHold service method, as returned by S3. - REST API Reference for GetObjectLegalHold Operation - - - - Gets the Object Lock configuration for a bucket. The rule specified in the Object - Lock configuration will be applied by default to every new object placed in the specified - bucket. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLockConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectLockConfiguration service method, as returned by S3. - REST API Reference for GetObjectLockConfiguration Operation - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - The name of the bucket containing the object. - The object key. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - The name of the bucket containing the object. - The object key. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - Container for the necessary parameters to execute the GetObjectMetadata service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - Retrieves an object's retention settings. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectRetention service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectRetention service method, as returned by S3. - REST API Reference for GetObjectRetention Operation - - - - Returns the tag-set of an object. You send the GET request against the tagging subresource - associated with the object. - - - - To use this operation, you must have permission to perform the s3:GetObjectTagging - action. By default, the GET operation returns information about current version of - an object. For a versioned bucket, you can have multiple versions of an object in - your bucket. To retrieve tags of any other version, use the versionId query parameter. - You also need permission for the s3:GetObjectVersionTagging action. - - - - By default, the bucket owner has this permission and can grant this permission to - others. - - - - For information about the Amazon S3 object tagging feature, see Object - Tagging. - - - - The following operation is related to GetObjectTagging: - - - - Container for the necessary parameters to execute the GetObjectTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTagging service method, as returned by S3. - REST API Reference for GetObjectTagging Operation - - - - Return torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Amazon - S3 Torrent. - - - - You can get torrent only for objects that are less than 5 GB in size and that are - not encrypted using server-side encryption with customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - The following operation is related to GetObjectTorrent: - - - - The name of the bucket containing the object for which to get the torrent files. - The object key for which to get the information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTorrent service method, as returned by S3. - REST API Reference for GetObjectTorrent Operation - - - - Return torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Amazon - S3 Torrent. - - - - You can get torrent only for objects that are less than 5 GB in size and that are - not encrypted using server-side encryption with customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - The following operation is related to GetObjectTorrent: - - - - Container for the necessary parameters to execute the GetObjectTorrent service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTorrent service method, as returned by S3. - REST API Reference for GetObjectTorrent Operation - - - - Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:GetBucketPublicAccessBlock - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket - or an object, it checks the PublicAccessBlock configuration for both - the bucket (or the bucket that contains the object) and the bucket owner's account. - If the PublicAccessBlock settings are different between the bucket and - the account, Amazon S3 uses the most restrictive combination of the bucket-level and - account-level settings. - - - - For more information about when Amazon S3 considers a bucket or an object public, - see The - Meaning of "Public". - - - - The following operations are related to GetPublicAccessBlock: - - - - Container for the necessary parameters to execute the GetPublicAccessBlock service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetPublicAccessBlock service method, as returned by S3. - REST API Reference for GetPublicAccessBlock Operation - - - - This operation is useful to determine if a bucket exists and you have permission to - access it. The operation returns a 200 OK if the bucket exists and you - have permission to access it. Otherwise, the operation might return responses such - as 404 Not Found and 403 Forbidden. - - - - To use this operation, you must have permissions to perform the s3:ListBucket - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - Container for the necessary parameters to execute the HeadBucket service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the HeadBucket service method, as returned by S3. - REST API Reference for HeadBucket Operation - - - - This operation initiates a multipart upload and returns an upload ID. This upload - ID is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort operation - and Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload API and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart) and UploadPartCopy) requests must match the headers you - used in the request to initiate the upload by using CreateMultipartUpload. - - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, - kms:GenerateDataKey*, and kms:DescribeKey actions on the - key. These permissions are required because Amazon S3 must decrypt and read data from - the encrypted file parts before it completes the multipart upload. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - The following operations are related to CreateMultipartUpload: - - - - The name of the bucket to which to initiate the upload - Object key for which the multipart upload is to be initiated. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the InitiateMultipartUpload service method, as returned by S3. - REST API Reference for InitiateMultipartUpload Operation - - - - This operation initiates a multipart upload and returns an upload ID. This upload - ID is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort operation - and Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload API and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart) and UploadPartCopy) requests must match the headers you - used in the request to initiate the upload by using CreateMultipartUpload. - - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, - kms:GenerateDataKey*, and kms:DescribeKey actions on the - key. These permissions are required because Amazon S3 must decrypt and read data from - the encrypted file parts before it completes the multipart upload. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - The following operations are related to CreateMultipartUpload: - - - - Container for the necessary parameters to execute the InitiateMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the InitiateMultipartUpload service method, as returned by S3. - REST API Reference for InitiateMultipartUpload Operation - - - - Lists the analytics configurations for the bucket. You can have up to 1,000 analytics - configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. You should always check the IsTruncated element in the response. - If there are no more configurations to list, IsTruncated is set to false. - If there are more configurations to list, IsTruncated is set to true, - and there will be a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to ListBucketAnalyticsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketAnalyticsConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketAnalyticsConfigurations service method, as returned by S3. - REST API Reference for ListBucketAnalyticsConfigurations Operation - - - - Returns a list of inventory configurations for the bucket. You can have up to 1,000 - analytics configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory - - - - The following operations are related to ListBucketInventoryConfigurations: - - - - Container for the necessary parameters to execute the ListBucketInventoryConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketInventoryConfigurations service method, as returned by S3. - REST API Reference for ListBucketInventoryConfigurations Operation - - - - Lists the metrics configurations for the bucket. The metrics configurations are only - for the request metrics of the bucket and do not provide information on daily storage - metrics. You can have up to 1,000 configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For more information about metrics configurations and CloudWatch request metrics, - see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to ListBucketMetricsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketMetricsConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketMetricsConfigurations service method, as returned by S3. - REST API Reference for ListBucketMetricsConfigurations Operation - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBuckets service method, as returned by S3. - REST API Reference for ListBuckets Operation - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - Container for the necessary parameters to execute the ListBuckets service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBuckets service method, as returned by S3. - REST API Reference for ListBuckets Operation - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Container for the necessary parameters to execute the ListMultipartUploads service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. - Limits the response to keys that begin with the specified prefix. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - Container for the necessary parameters to execute the ListObjects service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Make sure to design - your application to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - To use this operation in an AWS Identity and Access Management (IAM) policy, you must - have permissions to perform the s3:ListBucket action. The bucket owner - has this permission by default and can grant this permission to others. For more information - about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - This section describes the latest revision of the API. We recommend that you use this - revised API for application development. For backward compatibility, Amazon S3 continues - to support the prior version of this API, ListObjects. - - - - To get a list of your buckets, see ListBuckets. - - - - The following operations are related to ListObjectsV2: - - - - Container for the necessary parameters to execute the ListObjectsV2 service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjectsV2 service method, as returned by S3. - REST API Reference for ListObjectsV2 Operation - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). This request returns a maximum of 1,000 - uploaded parts. The default number of parts returned is 1,000 parts. You can restrict - the number of parts returned by specifying the max-parts request parameter. - If your multipart upload consists of more than 1,000 parts, the response returns an - IsTruncated field with the value of true, and a NextPartNumberMarker - element. In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListParts: - - - - Name of the bucket to which the parts are being uploaded. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Object key for which the multipart upload was initiated. - Upload ID identifying the multipart upload whose parts are being listed. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListParts service method, as returned by S3. - REST API Reference for ListParts Operation - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). This request returns a maximum of 1,000 - uploaded parts. The default number of parts returned is 1,000 parts. You can restrict - the number of parts returned by specifying the max-parts request parameter. - If your multipart upload consists of more than 1,000 parts, the response returns an - IsTruncated field with the value of true, and a NextPartNumberMarker - element. In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListParts: - - - - Container for the necessary parameters to execute the ListParts service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListParts service method, as returned by S3. - REST API Reference for ListParts Operation - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - Container for the necessary parameters to execute the ListVersions service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - - Creates a new bucket. To create a bucket, you must register with Amazon S3 and have - a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed - to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information on bucket naming restrictions, - see Working - with Amazon S3 Buckets. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) - Region. For more information, see How - to Select a Region for Your Buckets. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - Hosting of Buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - The name of the bucket to create. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucket service method, as returned by S3. - REST API Reference for PutBucket Operation - - - - Creates a new bucket. To create a bucket, you must register with Amazon S3 and have - a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed - to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information on bucket naming restrictions, - see Working - with Amazon S3 Buckets. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) - Region. For more information, see How - to Select a Region for Your Buckets. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - Hosting of Buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - Container for the necessary parameters to execute the PutBucket service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucket service method, as returned by S3. - REST API Reference for PutBucket Operation - - - - Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration - is a bucket-level feature that enables you to perform faster data transfers to Amazon - S3. - - - - To use this operation, you must have permission to perform the s3:PutAccelerateConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The Transfer Acceleration state of a bucket can be set to one of the following two - values: - -
  • - - Enabled – Enables accelerated data transfers to the bucket. - -
  • - - Suspended – Disables accelerated data transfers to the bucket. - -
- - The GetBucketAccelerateConfiguration operation returns the transfer acceleration - state of a bucket. - - - - After setting the Transfer Acceleration state of a bucket to Enabled, it might take - up to thirty minutes before the data transfer rates to the bucket increase. - - - - The name of the bucket used for Transfer Acceleration must be DNS-compliant and must - not contain periods ("."). - - - - For more information about transfer acceleration, see Transfer - Acceleration. - - - - The following operations are related to PutBucketAccelerateConfiguration: - - - - Container for the necessary parameters to execute the PutBucketAccelerateConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketAccelerateConfiguration service method, as returned by S3. - REST API Reference for PutBucketAccelerateConfiguration Operation - - - - - - - Set the logging parameters for a bucket and to specify permissions for who can view - and modify the logging parameters. All logs are saved to buckets in the same AWS Region - as the source bucket. To set the logging status of a bucket, you must be the bucket - owner. - - - - The bucket owner is automatically granted FULL_CONTROL to all logs. You use the Grantee - request element to grant access to other people. The Permissions request - element specifies the kind of access the grantee has to the logs. - - - - Grantee Values - - - - You can specify the person (grantee) to whom you're assigning access rights (using - request elements) in the following ways: - -
  • - - By the person's ID: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> - </Grantee> - - - - DisplayName is optional and ignored in the request. - -
  • - - By Email address: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee> - - - - - The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl - request, appears as the CanonicalUser. - -
  • - - By URI: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee> - - -
- - To enable logging, you use LoggingEnabled and its children request elements. To disable - logging, you use an empty BucketLoggingStatus request element: - - - - <BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01" /> - - - - - For more information about server access logging, see Server - Access Logging. - - - - For more information about creating a bucket, see CreateBucket. For more information - about returning the logging status of a bucket, see GetBucketLogging. - - - - The following operations are related to PutBucketLogging: - - - - Container for the necessary parameters to execute the PutBucketLogging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketLogging service method, as returned by S3. - REST API Reference for PutBucketLogging Operation - - - - Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. - You can have up to 1,000 metrics configurations per bucket. If you're updating an - existing metrics configuration, note that this is a full replacement of the existing - metrics configuration. If you don't include the elements you want to keep, they are - erased. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to PutBucketMetricsConfiguration: - - - - GetBucketLifecycle has the following special error: - -
  • - - Error code: TooManyConfigurations - -
    • - - Description: You are attempting to create a new configuration but have already reached - the 1,000-configuration limit. - -
    • - - HTTP Status Code: HTTP 400 Bad Request - -
- - Container for the necessary parameters to execute the PutBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for PutBucketMetricsConfiguration Operation - - - - Enables notifications of specified events for a bucket. For more information about - event notifications, see Configuring - Event Notifications. - - - - Using this API, you can replace an existing notification configuration. The configuration - is an XML file that defines the event types that you want Amazon S3 to publish and - the destination where you want Amazon S3 to publish an event notification when it - detects an event of the specified type. - - - - By default, your bucket has no event notifications configured. That is, the notification - configuration will be an empty NotificationConfiguration. - - - - <NotificationConfiguration> - - - - </NotificationConfiguration> - - - - This operation replaces the existing notification configuration with the configuration - you include in the request body. - - - - After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification - Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, - and that the bucket owner has permission to publish to it by sending a test notification. - In the case of AWS Lambda destinations, Amazon S3 verifies that the Lambda function - permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. - For more information, see Configuring - Notifications for Amazon S3 Events. - - - - You can disable notifications by adding the empty NotificationConfiguration element. - - - - By default, only the bucket owner can configure notifications on a bucket. However, - bucket owners can use a bucket policy to grant permission to other users to set this - configuration with s3:PutBucketNotification permission. - - - - The PUT notification is an atomic operation. For example, suppose your notification - configuration includes SNS topic, SQS queue, and Lambda function configurations. When - you send a PUT request with this configuration, Amazon S3 sends test messages to your - SNS topic. If the message fails, the entire PUT operation will fail, and Amazon S3 - will not add the configuration to your bucket. - - - - Responses - - - - If the configuration in the request body includes only one TopicConfiguration - specifying only the s3:ReducedRedundancyLostObject event type, the response - will also include the x-amz-sns-test-message-id header containing the - message ID of the test notification sent to the topic. - - - - The following operation is related to PutBucketNotificationConfiguration: - - - - Container for the necessary parameters to execute the PutBucketNotification service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketNotification service method, as returned by S3. - REST API Reference for PutBucketNotification Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - The MD5 hash of the request body. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - Container for the necessary parameters to execute the PutBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Creates a replication configuration or replaces an existing one. For more information, - see Replication - in the Amazon S3 Developer Guide. - - - - To perform this operation, the user or role performing the operation must have the - iam:PassRole - permission. - - - - Specify the replication configuration in the request body. In the replication configuration, - you provide the name of the destination bucket where you want Amazon S3 to replicate - objects, the IAM role that Amazon S3 can assume to replicate objects on your behalf, - and other relevant information. - - - - A replication configuration must include at least one rule, and can contain a maximum - of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects - in the source bucket. To choose additional subsets of objects to replicate, add a - rule for each subset. All rules must specify the same destination bucket. - - - - To specify a subset of the objects in the source bucket to apply a replication rule - to, add the Filter element as a child of the Rule element. You can filter objects - based on an object key prefix, one or more object tags, or both. When you add the - Filter element in the configuration, you must also add the following elements: DeleteMarkerReplication, - Status, and Priority. - - - - For information about enabling versioning on a bucket, see Using - Versioning. - - - - By default, a resource owner, in this case the AWS account that created the bucket, - can perform this operation. The resource owner can also grant others permissions to - perform the operation. For more information about permissions, see Specifying - Permissions in a Policy and Managing - Access Permissions to Your Amazon S3 Resources. - - - - Handling Replication of Encrypted Objects - - - - By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side - encryption with CMKs stored in AWS KMS. To replicate AWS KMS-encrypted objects, add - the following: SourceSelectionCriteria, SseKmsEncryptedObjects, - Status, EncryptionConfiguration, and ReplicaKmsKeyID. - For information about replication configuration, see Replicating - Objects Created with SSE Using CMKs stored in AWS KMS. - - - - For information on PutBucketReplication errors, see ReplicationErrorCodeList - - - - - The following operations are related to PutBucketReplication: - - - - Container for the necessary parameters to execute the PutBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketReplication service method, as returned by S3. - REST API Reference for PutBucketReplication Operation - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - The bucket name. - Container for Payer. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketRequestPayment service method, as returned by S3. - REST API Reference for PutBucketRequestPayment Operation - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - Container for the necessary parameters to execute the PutBucketRequestPayment service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketRequestPayment service method, as returned by S3. - REST API Reference for PutBucketRequestPayment Operation - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging. - - - - Within a bucket, if you add a tag that has the same key as an existing tag, the new - value overwrites the old value. For more information, see Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional operation is currently in progress against - this resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - The bucket name. - A property of PutBucketTaggingRequest used to execute the PutBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketTagging service method, as returned by S3. - REST API Reference for PutBucketTagging Operation - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging. - - - - Within a bucket, if you add a tag that has the same key as an existing tag, the new - value overwrites the old value. For more information, see Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional operation is currently in progress against - this resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - Container for the necessary parameters to execute the PutBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketTagging service method, as returned by S3. - REST API Reference for PutBucketTagging Operation - - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT operation requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - Amazon S3 has a limitation of 50 routing rules per website configuration. If you require - more than 50 routing rules, you can use object redirect. For more information, see - Configuring - an Object Redirect in the Amazon Simple Storage Service Developer Guide. - - - The bucket name. - Container for the request. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketWebsite service method, as returned by S3. - REST API Reference for PutBucketWebsite Operation - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT operation requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - Amazon S3 has a limitation of 50 routing rules per website configuration. If you require - more than 50 routing rules, you can use object redirect. For more information, see - Configuring - an Object Redirect in the Amazon Simple Storage Service Developer Guide. - - - Container for the necessary parameters to execute the PutBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketWebsite service method, as returned by S3. - REST API Reference for PutBucketWebsite Operation - - - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - The name of the bucket for which to set the configuration. - A property of PutLifecycleConfigurationRequest used to execute the PutLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutLifecycleConfiguration service method, as returned by S3. - REST API Reference for PutLifecycleConfiguration Operation - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - Container for the necessary parameters to execute the PutLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutLifecycleConfiguration service method, as returned by S3. - REST API Reference for PutLifecycleConfiguration Operation - - - - - - - - - - - - - - - - - Configuration for accessing AmazonS3 service - - - Configuration for accessing Amazon S3 service - - - - - When true, requests will always use path style addressing. - - - - - Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. - To use this feature, the bucket name should be DNS compliant names and should not contain periods (.). - The following APIs are not supported and are sent to the regular region endpoint, even if this option is enabled: -
    -
  1. PutBucket
    2. -
  2. ListBuckets
    3. -
  3. DeleteBucket
    4. -
- - - This option cannot be used at the same time as UseDualstackEndpoint. - - - - - If set to true and the service package supports it the region identified in the arn for a resource - will be used when making the service request. - - - - - USEast1RegionalEndpointValue determines wheter or not - to send the us-east-1 s3 requests to the regional endpoint or to - the legacy global endpoint. - This flags takes precedence over the AWS_S3_US_EAST_1_REGIONAL_ENDPOINT - environment variable and the credential file. - - - - - This method contains custom initializations for the config object. - - - - - Given this client configuration, returns the service url - - The service url in the form of a string - - - - If the client is configured to hit us-east-1 with the S3UsEast1RegionalEndpointValue flag not set, - this method checks whether the environment variable is present or the credential file contains a valid value - - A Nullable of S3UsEast1RegionalEndpointValue representing the client configuration for the regional us-east-1 endpoint - - - - Validate that the config object is properly configured. - - - - - Checks the AWS_S3_US_EAST_1_REGIONAL_ENDPOINT environment variable for the presence of the s3 regional flag - - A nullable of S3UsEast1RegionalEndpointValue - - - - Checks the credential file for the presence of the s3 regional flag - - A nullable of S3UsEast1RegionalEndpointValue - - - - Default constructor - - - - - The constant used to lookup in the region hash the endpoint. - - - - - Gets the ServiceVersion property. - - - - - Gets the value of UserAgent property. - - - - - Base exception for S3 errors. - - - - - Construct an instance of AmazonS3Exception - - - - - - Construct an instance of AmazonS3Exception - - - - - - - Construct an instance of AmazonS3Exception - - - - - - Construct an instance of AmazonS3Exception - - - - - - - - - - Construct an instance of AmazonS3Exception - - - - - - - - - - - Construct an instance of AmazonS3Exception - - - - - - - - - - - - Construct an instance of AmazonS3Exception - - - - - - - - - - - - - A special token that helps AWS troubleshoot problems. - - - - - A special token that helps AWS troubleshoot S3 accelerate problems. - - - - - The entire response body for this exception, if available. - - - - - The region that the AmazonS3Exception relates to. - - - - - Gets the exception message. - - - - - Extensions methods added to Amazon.Arn type to help parse S3 specific resources from the ARN. - - - - - Attempt to parse the resource component of the ARN into access point resource name. - - An AWS ARN to parse - The access point resouce identifier found in the ARN. - True if the ARN contains an access point resource identifier. - - - - Attempt to parse the resource component of the ARN into bucket name. - - An AWS ARN to parse - The bucket name found in the ARN. - True if the ARN contains a bucket name. - - - - The file format used when exporting data to Amazon S3. - - - - - CSV file format. - - - - - Construct instance of AnalyticsS3ExportFileFormat. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to an AnalyticsS3ExportFileFormat. - - - - - - - Represents the accelerate status for a bucket. - - - - - Bucket acceleration is enabled. - - - - - Bucket acceleration is suspended. - - - - - Construct instance of BucketAccelerateStatus. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to an BucketAccelerateStatus - - - - - - - The status of the delete marker replication. - - - - - Delete marker replication is enabled. - - - - - Delete marker replication is disabled. - - - - - Construct instance of DeleteMarkerReplicationStatus. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to a DeleteMarkerReplicationStatus - - - - - - - A list of all possible CannedACLs that can be used - for S3 Buckets or S3 Objects. For more information about CannedACLs, refer to - . - - - - - Owner gets FULL_CONTROL. - No one else has access rights (default). - - - - - Owner gets FULL_CONTROL. - No one else has access rights (default). - - - - - Owner gets FULL_CONTROL and the anonymous principal is granted READ access. - If this policy is used on an object, it can be read from a browser with no authentication. - - - - - Owner gets FULL_CONTROL, the anonymous principal is granted READ and WRITE access. - This can be a useful policy to apply to a bucket, but is generally not recommended. - - - - - Owner gets FULL_CONTROL, and any principal authenticated as a registered Amazon - S3 user is granted READ access. - - - - - Owner gets FULL_CONTROL. Amazon EC2 gets READ access to GET an - Amazon Machine Image (AMI) bundle from Amazon S3. - - - - - Object Owner gets FULL_CONTROL, Bucket Owner gets READ - This ACL applies only to objects and is equivalent to private when used with PUT Bucket. - You use this ACL to let someone other than the bucket owner write content (get full control) - in the bucket but still grant the bucket owner read access to the objects. - - - - - Object Owner gets FULL_CONTROL, Bucket Owner gets FULL_CONTROL. - This ACL applies only to objects and is equivalent to private when used with PUT Bucket. - You use this ACL to let someone other than the bucket owner write content (get full control) - in the bucket but still grant the bucket owner full rights over the objects. - - - - - The LogDelivery group gets WRITE and READ_ACP permissions on the bucket. - - - - - Construct instance of S3CannedACL. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to an S3CannedACL - - - - - - - A list of all possible S3 Bucket region possibilities. For - more information, refer to - . - - - - - Specifies that the S3 Bucket should use US locality. - This is the default value. - - - - - Specifies that the S3 Bucket should use US-EAST-2 locality. - - - - - Specifies that the S3 Bucket should use EU locality which defaults to EU-WEST-1 - - - - - Specifies that the S3 Bucket should use the EU-NORTH-1 locality. - - - - - Specifies that the S3 Bucket should use the EU-WEST-1 locality. - - - - - Specifies that the S3 Bucket should use the EU-WEST-2 locality. - - - - - Specifies that the S3 Bucket should use the EU-WEST-3 locality. - - - - - Specifies that the S3 Bucket should use the EU-CENTRAL-1 locality. - - - - - Specifies that the S3 Bucket should use US-WEST-1 locality. - - - - - Specifies that the S3 Bucket should use US-WEST-2 locality. - - - - - Specifies that the S3 Bucket should use US-GOV-EAST-1 locality. - - - - - Specifies that the S3 Bucket should use US-GOV-WEST-1 locality. - - - - - Specifies that the S3 Bucket should use the AP-EAST-1 locality. - - - - - Specifies that the S3 Bucket should use the AP-SOUTHEAST-1 locality. - - - - - Specifies that the S3 Bucket should use the AP-SOUTHEAST-2 locality. - - - - - Specifies that the S3 Bucket should use the AP-NORTHEAST-1 locality. - - - - - Specifies that the S3 Bucket should use the AP-NORTHEAST-2 locality. - - - - - Specifies that the S3 Bucket should use the AP-NORTHEAST-3 locality. - - - - - Specifies that the S3 Bucket should use the AP-SOUTH-1 locality. - - - - - Specifies that the S3 Bucket should use the SA-EAST-1 locality. - - - - - Specifies that the S3 Bucket should use CN-NORTH-1 locality. - - - - - Specifies that the S3 Bucket should use CN-NORTHWEST-1 locality. - - - - - Specifies that the S3 Bucket should use CA-CENTRAL-1 locality. - - - - - Specifies that the S3 Bucket should use US-WEST-1 locality. - - - - - Specifies that the S3 Bucket should use CN-NORTH-1 locality. - - - - - Specifies that the S3 Bucket should use US-GOV-WEST-1 locality. - - - - - Construct instance of S3Region. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to the S3Region class - - - - - - - A list of all ACL permissions. For more information, refer to - . - - - - - When applied to a bucket, grants permission to list the bucket. - When applied to an object, this grants permission to read the - object data and/or metadata. - - - - - When applied to a bucket, grants permission to create, overwrite, - and delete any object in the bucket. This permission is not - supported for objects. - - - - - Grants permission to read the ACL for the applicable bucket or object. - The owner of a bucket or object always has this permission implicitly. - - - - - Gives permission to overwrite the ACP for the applicable bucket or object. - The owner of a bucket or object always has this permission implicitly. - Granting this permission is equivalent to granting FULL_CONTROL because - the grant recipient can make any changes to the ACP. - - - - - Provides READ, WRITE, READ_ACP, and WRITE_ACP permissions. - It does not convey additional rights and is provided only for convenience. - - - - - Gives permission to restore an object that is currently stored in Amazon Glacier - for archival storage. - - - - - Construct S3Permission. - - - - - - Construct instance of S3Permission. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - - Gets and sets the HeaderName property. - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to an S3Permission - - - - - - - An enumeration of all Metadata directives that - can be used for the CopyObject operation. - - - - - Specifies that the metadata is copied from the source object. - - - - - Specifies that the metadata is replaced with metadata provided in the request. - All original metadata is replaced by the metadata you specify. - - - - - An enumeration of all protocols that the pre-signed - URL can be created against. - - - - - https protocol will be used in the pre-signed URL. - - - - - http protocol will be used in the pre-signed URL. - - - - - An enumeration of supported HTTP verbs - - - - - The GET HTTP verb. - - - - - The HEAD HTTP verb. - - - - - The PUT HTTP verb. - - - - - The DELETE HTTP verb. - - - - - S3 Storage Class Definitions - - - - - The STANDARD storage class, which is the default - storage class for S3. - - Durability 99.999999999%; Availability 99.99% over a given year. - - - - - REDUCED_REDUNDANCY provides the same availability as standard, but at a lower durability. - - Durability 99.99%; Availability 99.99% over a given year. - - - - - The GLACIER storage is for object that are stored in Amazon Glacier. - This storage class is for objects that are for archival purpose and - get operations are rare. - - Durability 99.999999999% - - - - - The STANDARD_IA storage is for infrequently accessed objects. - This storage class is for objects that are long-lived and less frequently accessed, - like backups and older data. - - Durability 99.999999999%; Availability 99.9% over a given year. - - - - - The ONEZONE_IA storage is for infrequently accessed objects. It is similiar to STANDARD_IA, but - only stores object data within one Availablity Zone in a given region. - - Durability 99.999999999%; Availability 99% over a given year. - - - - - IntelligentTiering makes it easy to lower your overall cost of storage by automatically placing data in the storage - class that best matches the access patterns for the storage. With IntelligentTiering, you don’t need to define - and manage individual policies for lifecycle data management or write code to transition objects - between storage classes. Instead, you can use IntelligentTiering to manage transitions between Standard and - S-IA without writing any application code. IntelligentTiering also manages transitions automatically to - Glacier for long term archive in addition to S3 storage classes. - - - - - S3 Glacier Deep Archive provides secure, durable object storage class for long term data archival. - It is the ideal storage class to make an archival, durable copy of data that rarely, if ever, needs to be accessed. - It can be used as an offline backup for their most important data assets and to meet long-term retention needs. - - - - - Construct an instance of S3StorageClass. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to S3StorageClass. - - - - - - - The constants for the known event names used by S3 notification. S3 might add new - events before the SDK is updated. In which case the names listed in the S3 documentation - will work as well as these constants. - - - - - An event that says an object has been lost in the reduced redundancy storage. - - - - - A list of all server-side encryption methods for customer provided encryption keys. - - - - - No server side encryption to be used. - - - - - Use AES 256 server side encryption. - - - - - Constructs an instance of ServerSideEncryptionCustomerMethod. - - - - - - Finds the constant for the unique value. - - - - - - - Converts string to ServerSideEncryptionCustomerMethod. - - - - - - - A list of all server-side encryption methods. - - - - - No server side encryption to be used. - - - - - Use AES 256 server side encryption. - - - - - Use AWS Key Management Service for server side encryption. - - - - - Construct instance of ServerSideEncryptionMethod. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to ServerSideEncryptionCustomerMethod. - - - - - - - A list of all grantee types. - - - - - The predefined group. - - - - - The email address of an AWS account - - - - - The canonical user ID of an AWS account - - - - - Construct an instance of GranteeType. - - - - - - Finds the constant for the unique value. - - - - - - - Convert a string to GranteeType. - - - - - - - A list of all lifecycle statuses. - - - - - The rule is enabled. - - - - - The rule is disabled. - - - - - Constructs an instance LifecycleRuleStatus. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to LifecycleRuleStatus. - - - - - - - A list of all version statuses. - - - - - The rule is off. - - - - - The rule is suspended. - - - - - The rule is enabled. - - - - - Construct an instance of VersionStatus. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to VersionStatus. - - - - - - - A list of all encoding types. - - - - - Url encoding. - - - - - Constructs intance of EncodingType - - - - - - Finds the constant for the unique value. - - - - - - - Converts string to EncodingType - - - - - - - The bucket event for which to send notifications. - - - - - The event encapsulates all the object create events - - - - - Event for put operations - - - - - Event for post operations - - - - - Event for copy operations - - - - - Event for completing a multi part upload - - - - - This event encapsulates all the object removed events - - - - - Event for object removed, delete operation. - - - - - Event for object removed, delete marker created operation. - - - - - Event for objects stored in reduced redundancy and S3 detects the object is lost - - - - - Event for all object restore - - - - - Event for restore post operations. - - - - - Event for when object restore is completed. - - - - - Event for replication of all - - - - - Event for operation failed replication - - - - - Evemt for replication operation not tracked - - - - - Event for replication operation missed threshold - - - - - Event for operation replicated after threshold - - - - - Constructs instance of EventType. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to EventType. - - - - - - - Compares if the ConstantClass instances are equals. - - - - - - - Compares if the ConstantClass instances are equals. This is ovewritten to handle the - discrepancy with S3 events coming from Lambda that don't have the prefix "s3:". - - - - - - - A list of all Inventory Formats. - - - - - CSV inventory format - - - - - ORC inventory format - - - - - Parquet inventory format - - - - - Construct instance of InventoryFormat. - - - - - - Finds the constant for the unique value. - - The string representation of the InventoryFormat. - The InventoryFormat object for that string. - - - - Convert string to InventoryFormat. - - - - - - - A list of inventory included object versions. - - - - - All Inventory Included Object Versions - - - - - Current Inventory Included Object Versions - - - - - Construct instance of InventoryIncludedObjectVersions. - - - - - - Finds the constant for the unique value. - - The string representation of the InventoryIncludedObjectVersions. - The InventoryIncludedObjectVersions object for that string. - - - - Convert string to InventoryIncludedObjectVersions. - - - - - - - A list of inventory frequencies. - - - - - Daily Inventory Frequency - - - - - Weekly Inventory Frequency - - - - - Construct instance of InventoryFrequency. - - - - - - Finds the constant for the unique value. - - The string representation of the InventoryFrequency. - The InventoryFrequency object for that string. - - - - Convert string to InventoryFrequency. - - - - - - - A list of inventory optional fields. - - - - - InventoryOptionalField for Size - - - - - InventoryOptionalField for LastModifiedDate - - - - - InventoryOptionalField for StorageClass - - - - - InventoryOptionalField for ETag - - - - - InventoryOptionalField for IsMultipartUploaded - - - - - InventoryOptionalField for ReplicationStatus - - - - - InventoryOptionalField for EncryptionStatus - - - - - InventoryOptionalField for ObjectLockRetainUntilDate - - - - - InventoryOptionalField for ObjectLockMode - - - - - InventoryOptionalField for ObjectLockLegalHoldStatus - - - - - InventoryOptionalField for IntelligentTieringAccessTier - - - - - Construct instance of InventoryOptionalField. - - - - - - Finds the constant for the unique value. - - The string representation of the InventoryOptionalField. - The InventoryIncludedObjectVersions object for that string. - - - - Convert string to InventoryOptionalField. - - - - - - - The status of the replication job associated with this source object. - - - - - The object is pending replication. - - - - - The object has been replicated. - - - - - The object was created as a result of replication. - - - - - The object replication has failed due to a customer-attributable reason, and the replication will not be attempted again. - - - - - Construct instance of ReplicationStatus. - - - - - - Finds the constant for the unique value. - - The string representation of the ReplicationStatus. - The ReplicationStatus object for that string. - - - - Convert string to ReplicationStatus. - - - - - - - Whether a replication rule is applied or ignored. - - - - - The rule will be applied. - - - - - The rule will be ignored. - - - - - Construct instance of ReplicationRuleStatus - - - - - - Finds the constant for the unique value. - - The string representation of the ReplicationRuleStatus. - The ReplicationRuleStatus object for that string. - - - - Convert string to ReplicationRuleStatus. - - - - - - - Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request. - - - - - The object tag-set is copied from the source object. - - - - - The object tag-set is replaced with tag-set provided in the request. - - - - - Construct instance of TaggingDirective - - - - - Finds the constant for the unique value. - - The string representation of the TaggingDirective. - The TaggingDirective object for that string. - - - - Convert string to TaggingDirective. - - - - - All enumerations type for retrieval tier for Glacier restore. - - - - - Standard Tier for Glacier restore. - - - - - Bulk Tier for Glacier restore. - - - - - Expedited Tier for Glacier restore. - - - - - Construct instance of RestoreObjectRequestGlacierJobTier - - - - - - Finds the constant for the unique value. - - The string representation of the RestoreObjectRequestGlacierJobTier. - The RestoreObjectRequestGlacierJobTier object for that string. - - - - Convert string to RestoreObjectRequestGlacierJobTier. - - - - - - - The version of the output schema to use when exporting data. - - - - - The schema output version V_1. - - - - - Construct instance of StorageClassAnalysisSchemaVersion - - - - - - Finds the constant for the unique value. - - The string representation of the StorageClassAnalysisSchemaVersion. - The StorageClassAnalysisSchemaVersion object for that string. - - - - Convert string to StorageClassAnalysisSchemaVersion. - - - - - - - Acknowledges that requester pays for the operation. - - - - - Requester pays for the operation. - - - - - Finds the RequestPayer instance for the string value. - - - - - Converts string to RequestPayer instance - - - - - The response from S3 that it confirms that requester pays. - - - - - S3 acknowledges that the requester pays. - - - - - Finds the RequestCharged instance for the string value - - - - - converts the string to RequestCharged instance - - - - - The override value for the owner of the replica object. - - - - - Overrides destination bucket's owner. - - - - - Finds the OwnerOverride instance for the string value - - - - - converts the string to OwnerOverride instance - - - - - The replication for KMS encrypted S3 objects is disabled if status is not Enabled. - - - - - The replication for KMS encrypted S3 objects is enabled. - - - - - The replication for KMS encrypted S3 objects is disabled. - - - - - - - - - - Finds the SseKmsEncryptedObjectsStatus instance for the string value - - - - - Converts the string to SseKmsEncryptedObjectsStatus instance - - - - - Specify how headers will be handled. - - - - - Headers will be usable in SELECT clause. - - - - - Headers will be skipped - - - - - No header is present. - - - - - Finds the FileHeaderInfo instance for the string value - - - - - - - Converts the string to FileHeaderInfo instance - - - - - Specifies whether existing object replication is enabled. - - - - - Enable the replication of existing objects - - - - - Disable the replication of existing objects - - - - - Finds the ExistingObjectReplicationStatus instance for the string value - - - - - - - Converts the string to ExistingObjectReplicationStatus instance - - - - - Describes when fields in output should be surrounded with quotes. - - - - - Specifies that fields in output should always be surrounded in quotes. - - - - - Specifies that fields in output should be surrounded in quotes as necessary. - - - - - Finds the QuoteFields instance for the string value - - string value that maps to QuoteFields enum - QuoteFields enum - - - - Converts the string to QuoteFields instance - - - - - Type of the expression provided in the Expression member. - - - - - SQL expression - - - - - Finds the ExpressionType instance for the string value - - string value that maps to ExpressionType enum - ExpressionType enum - - - - Converts the string to ExpressionType instance - - - - - Indicates what type of job is being initiated. - - - - - Finds the RestoreRequestType instance for the string value - - - - - Converts the string to RestoreRequestType instance - - - - - The type of JSON. - - - - - Finds the JsonType instance for the string value - - - - - Converts the string to JsonType instance - - - - - Specifies object's compression format. - - - - - Finds the CompressionType instance for the string value - - - - - Converts the string to CompressionType instance - - - - - The type of ObjectLockEnabled - - - - - Finds the ObjectLockEnabled instance for the string value - - - - - Converts the string to ObjectLockEnabled instance - - - - - The type of ObjectLockLegalHoldStatus - - - - - Finds the ObjectLockLegalHoldStatus instance for the string value - - - - - Converts the string to ObjectLockLegalHoldStatus instance - - - - - The type of ObjectLockRetentionMode - - - - - Finds the ObjectLockRetentionMode instance for the string value - - - - - Converts the string to ObjectLockRetentionMode instance - - - - - The type of ObjectLockMode - - - - - Finds the ObjectLockMode instance for the string value - - - - - Converts the string to ObjectLockMode instance - - - - - Specifies whether the replication time is enabled. - - - - - Replication time is enabled. - - - - - Replication time is disabled. - - - - - Finds the ReplicationTimeStatus instance for the string value - - - - - - - Converts the string to ReplicationTimeStatus instance - - - - - - Specifies whether the replication metrics are enabled. - - - - - Replication metrics are enabled. - - - - - Replication metrics are disabled. - - - - - Finds the MetricsStatus instance for the string value - - - - - - - Converts the string to MetricsStatus instance - - - - - - Custom pipeline handler to clean up streams in case of an exception. - - - - - Catch exceptions and clean up any open streams. - - - - - - Catch exceptions and clean up any open streams. - - - - - - - Custom pipeline handler to enable sig V4 for Get requests. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Custom pipeline handler to enable sig V4 for Get requests. - - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Calls the post invoke logic after calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls the and post invoke logic after calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Constructor for AmazonS3RetryPolicy. - - The IClientConfig object - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - - - a value if it can be determined, or null if the IO-bound calculations need to be done - - - - Return true if the request should be retried. Implements additional checks - specific to S3 on top of the checks in DefaultRetryPolicy. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Constructor for AmazonS3StandardRetryPolicy. - - The IClientConfig object - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - - - a value if it can be determined, or null if the IO-bound calculations need to be done - - - - Return true if the request should be retried. Implements additional checks - specific to S3 on top of the checks in StandardRetryPolicy. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Constructor for AmazonS3AdaptiveRetryPolicy. - - The IClientConfig object - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - - - a value if it can be determined, or null if the IO-bound calculations need to be done - - - - Return true if the request should be retried. Implements additional checks - specific to S3 on top of the checks in AdaptiveRetryPolicy. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Marker interface to identify AmazonS3EncryptionClient. - - - - - Service metadata for Amazon S3 service - - - - - Gets the value of the Service Id. - - - - - Gets the dictionary that gives mapping of renamed operations - - - - - The parameters to request an abort of a multipart upload. - - - After a multipart upload is aborted, no additional parts can be uploaded using that upload ID. - The storage consumed by any previously uploaded parts will be freed. However, if any part uploads - are currently in progress, those part uploads might or might not succeed. As a result, it might be - necessary to abort a given multipart upload multiple times in order to completely free all storage - consumed by all parts. - - - - - The bucket name to which the upload was taking place. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The key of the S3 object that was being uploaded. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - The upload id for the in-progress multipart upload that should be aborted. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the AbortMultipartUpload response metadata. - The AbortMultipartUpload operation has a void result type. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Bucket accelerate configuration. - - - - - The accelerate status of the bucket. - - - - - AccessControlTranslation class - - - - - The override value for the owner of the replica object. - - - - - Class for AnalyticsAndOperator - A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. - The operator must have at least two predicates, and an object must match all of the predicates - in order for the filter to apply. - - Note: The current implementation restricts the usage to atmost one AnalyticsPrefixPredicate - and any number of AnalyticsTagPredicates. - - - - Class for AnalyticsConfiguration - - - - - The identifier used to represent an analytics configuration. - - - - - The filter used to describe a set of objects for analyses. - A filter must have exactly one prefix, one tag, or one conjunction (AnalyticsAndOperator). - If no filter is provided, all objects will be considered in any analysis. - - - - - If present, it indicates that data related to access patterns will be collected - and made available to analyze the tradeoffs between different storage classes. - - - - - Class for AnalyticsExportDestination - - - - - A destination signifying output to an S3 bucket. - - - - - Filter class for Metrics. - - - - - Filter Predicate setup for specific filter types. - - - - - Filter Predicate abstract class for specific filter types to be derived from. - - - - - Abstract class that can be used over logical filter predicates,i.e. AND/OR. - - - - - Internal implementation of Metrics Predicate visitor interface. - - - - - Interface for implementing visitor pattern in Analytics Predicate Filter. - - - - - Interface for implementing visitor pattern in Inventory Predicate Filter. - - - - - Interface for implementing visitor pattern in Metrics Predicate Filter. - - - - - Internal implementation of Inventory Predicate visitor interface. - - - - - Internal implementation of Metrics Predicate visitor interface. - - - - - Defines the interface that is used to visit all the different - implementations of - - - - - Visit a - - - - - - Visit a - - - - - - Visit a - - - - - - Implementation of to marshall . - - - - - AbortIncompleteMultipartUpload Unmarshaller - - - - - Abort Multipart Upload Request Marshaller - - - - - Response Unmarshaller for AbortMultipartUpload operation - - - - - AnalyticsConfiguration Unmarshaller - - - - - AnalyticsExportDestinationUnmarshaller - - - - - AnalyticsFilter Unmarshaller - - - - - AnalyticsS3BucketDestination Unmarshaller - - - - - Bucket Unmarshaller - - - - - CommonPrefixesItem Unmarshaller - - - - - Complete Multipart Upload Request Marshaller - - - - - Response Unmarshaller for CompleteMultipartUpload operation - - - - - ContentsItem Unmarshaller - - - - - Copy Object Request Marshaller - - - - - Response Unmarshaller for CopyObject operation - - - - - Upload Part Copy Request Marshaller - - - - - Response Unmarshaller for CopyPart operation - - - - - CORSRule Unmarshaller - - - - - Response Unmarshaller for DefaultRetention Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Delete InventoryConfiguration Request Marshaller - - - - - Response Unmarshaller for DeleteAnalyticsConfiguration operation - - - - - Response Unmarshaller for DeleteCORSConfiguration operation - - - - - Delete InventoryConfiguration Request Marshaller - - - - - Response Unmarshaller for DeleteInventoryConfiguration operation - - - - - Delete Bucket MetricsConfiguration Request Marshaller - - - - - Response Unmarshaller for DeleteBucketMetricsConfiguration operation - - - - - Delete Bucket Policy Request Marshaller - - - - - Response Unmarshaller for DeleteBucketPolicy operation - - - - - Delete Bucket Request Marshaller - - - - - Response Unmarshaller for DeleteBucket operation - - - - - Delete Bucket Tagging Request Marshaller - - - - - Response Unmarshaller for DeleteBucketTagging operation - - - - - Delete Bucket Website Request Marshaller - - - - - Response Unmarshaller for DeleteBucketWebsite operation - - - - - Delete Bucket Cors Request Marshaller - - - - - DeletedObject Unmarshaller - - - - - Delete Bucket Lifecycle Request Marshaller - - - - - Response Unmarshaller for DeleteBucketLifecycle operation - - - - - Delete Object Request Marshaller - - - - - Response Unmarshaller for DeleteObject operation - - - - - Delete Objects Request Marshaller - - - - - Response Unmarshaller for DeleteObjects operation - - - - - DeleteObjectTaggingRequest Marshaller - - - - - Marshall DeleteObjectTaggingRequest object into an http request. - - - - - Marshall DeleteObjectTaggingRequest object into an http request. - - - - - Response Unmarshaller for DeleteObjectTagging operation - - - - - DeletePublicAccessBlock Request Marshaller - - - - - Response Unmarshaller for DeletePublicAccessBlock operation - - - - - ErrorsItem Unmarshaller - - - - - Expiration Unmarshaller - - - - - FilterRule Unmarshaller - - - - - Filter Unmarshaller - - - - - Get Object Acl Request Marshaller - - - - - Response Unmarshaller for GetACL operation - - - - - Get Object Accelerate Configuration Request Marshaller - - - - - Response Unmarshaller for GetACL operation - - - - - Get BucketAnalyticsConfiguration Request Marshaller - - - - - Response Unmarshaller for GetAnalyticsConfiguration operation - - - - - Get InventoryConfiguration Request Marshaller - - - - - Response Unmarshaller for GetInventoryConfiguration operation - - - - - Get Bucket Location Request Marshaller - - - - - Response Unmarshaller for GetBucketLocation operation - - - - - Get Bucket Logging Request Marshaller - - - - - Response Unmarshaller for GetBucketLogging operation - - - - - Get Bucket MetricsConfigurationRequest Marshaller - - - - - Response Unmarshaller for GetBucketMetricsConfiguration operation - - - - - Get Bucket Notification Request Marshaller - - - - - Response Unmarshaller for GetBucketNotification operation - - - - - Get BucketName Policy Request Marshaller - - - - - Response Unmarshaller for GetBucketPolicy operation - - - - - GetBucketPolicyStatusRequestMarshaller - - - - - Response Unmarshaller for GetBucketPolicyStatus operation - - - - - Get Bucket Request Payment Request Marshaller - - - - - Response Unmarshaller for GetBucketRequestPayment operation - - - - - Get Bucket Tagging Request Marshaller - - - - - Response Unmarshaller for GetBucketTagging operation - - - - - Get Bucket Versioning Request Marshaller - - - - - Response Unmarshaller for GetBucketVersioning operation - - - - - Get Bucket Website Request Marshaller - - - - - Response Unmarshaller for GetBucketWebsite operation - - - - - Get Bucket Cors Request Marshaller - - - - - Response Unmarshaller for GetCORSConfiguration operation - - - - - Get Bucket Lifecycle Request Marshaller - - - - - Response Unmarshaller for GetLifecycleConfiguration operation - - - - - GetObjectLegalHold Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for GetObjectLegalHold operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - GetObjectLockConfiguration Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for GetObjectLockConfiguration operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - GetObjectMetadata Marshaller - - - - - Response Unmarshaller for GetObjectMetadata operation - - - - - Get Object Request Marshaller - - - - - Response Unmarshaller for GetObject operation - - - - - GetObjectRetention Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for GetObjectRetention operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - GetObjectTaggingRequest Marshaller - - - - - Marshall GetObjectTaggingRequest into an http request. - - - - - Marshall GetObjectTaggingRequest into an http request. - - - - - Response Unmarshaller for GetObjectTagging operation - - - - - Get Object Torrent Request Marshaller - - - - - Response Unmarshaller for GetObjectTorrent operation - - - - - GetPublicAccessBlockRequestMarshaller - - - - - Response Unmarshaller for GetPublicAccessBlock operation - - - - - Grantee Unmarshaller - - - - - Grant Unmarshaller - - - - - Head Bucket Request Marshaller - - - - - Response Unmarshaller for HeadBucket operation - - - - - Create Multipart Upload Request Marshaller - - - - - Response Unmarshaller for InitiateMultipartUpload operation - - - - - Initiator Unmarshaller - - - - - InventoryConfiguration Unmarshaller - - - - - InventoryDestination Unmarshaller - - - - - InventoryEncryption Unmarshaller - - - - - InventoryFilter Unmarshaller - - - - - InventoryS3BucketDestination Unmarshaller - - - - - InventorySchedule Unmarshaller - - - - - LifecycleFilterPredicate Unmarshaller - - - - - LifecycleRuleNoncurrentVersionExpiration Unmarshaller - - - - - LifecycleRuleNoncurrentVersionTransition Unmarshaller - - - - - List AnalyticsConfiguration Request Marshaller - - - - - Response Unmarshaller for ListAnalyticsConfiguration operation - - - - - List InventoryConfiguration Request Marshaller - - - - - Response Unmarshaller for ListInventoryConfiguration operation - - - - - List Bucket MetricsConfigurationRequest Marshaller - - - - - Response Unmarshaller for ListBucketMetricsConfiguration operation - - - - - List Buckets Request Marshaller - - - - - Response Unmarshaller for ListBuckets operation - - - - - List Multipart Uploads Request Marshaller - - - - - Response Unmarshaller for ListMultipartUploads operation - - - - - List Objects Request Marshaller - - - - - Response Unmarshaller for ListObjects operation - - - - - List Objects Request Marshaller - - - - - Response Unmarshaller for ListObjects operation - - - - - List Parts Request Marshaller - - - - - Response Unmarshaller for ListParts operation - - - - - List Object Versions Request Marshaller - - - - - Response Unmarshaller for ListVersions operation - - - - - LoggingEnabled Unmarshaller - - - - - MetricsConfiguration Unmarshaller - - - - - MetricsFilte Unmarshaller - - - - - UploadsItem Unmarshaller - - - - - Response Unmarshaller for ObjectLockConfiguration Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Response Unmarshaller for ObjectLockLegalHold Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Response Unmarshaller for ObjectLockRetention Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Response Unmarshaller for ObjectLockRule Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Owner Unmarshaller - - - - - PartsItem Unmarshaller - - - - - PolicyStatus Unmarshaller - - - - - PublicAccessBlockConfiguration Unmarshaller - - - - - Put Object Acl Request Marshaller - - - - - Response Unmarshaller for PutObjectAcl operation - - - - - Put Object Acl Request Marshaller - - - - - Response Unmarshaller for PutBucketAccelerate operation - - - - - Request Marshaller for PutAnalyticsConfiguration operation - - - - - Response Unmarshaller for PutBucketAnalytics operation - - - - - Request Marshaller for PutInventoryConfiguration operation - - - - - Response Unmarshaller for PutBucketWebsite operation - - - - - Enable Bucket Logging Request Marshaller - - - - - Response Unmarshaller for PutBucketLogging operation - - - - - Put Bucket MetricsConfigurationRequest Marshaller - - - - - Response Unmarshaller for PutBucketMetricsConfiguration operation - - - - - Put Bucket Notification Request Marshaller - - - - - Response Unmarshaller for PutBucketNotification operation - - - - - Put Bucket Policy Request Marshaller - - - - - Response Unmarshaller for PutBucketPolicy operation - - - - - Put Buckeyt Replication Request Marshaller - - - - - Response Unmarshaller for PutBucketReplication operation. - - - - - Put Bucket Request Marshaller - - - - - Put Bucket Request Payment Request Marshaller - - - - - Response Unmarshaller for PutBucketRequestPayment operation - - - - - Response Unmarshaller for PutBucket operation - - - - - Put Bucket Tagging Request Marshaller - - - - - Response Unmarshaller for PutBucketTagging operation - - - - - Put Bucket Versioning Request Marshaller - - - - - Response Unmarshaller for PutBucketVersioning operation - - - - - Put Bucket Website Request Marshaller - - - - - Response Unmarshaller for PutBucketWebsite operation - - - - - Put Bucket Cors Request Marshaller - - - - - Response Unmarshaller for PutCORSConfiguration operation - - - - - Put Bucket Lifecycle Request Marshaller - - - - - Response Unmarshaller for PutLifecycleConfiguration operation - - - - - PutObjectLegalHold Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for PutObjectLegalHold operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - PutObjectLockConfiguration Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for PutObjectLockConfiguration operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Put Object Request Marshaller - - - - - Response Unmarshaller for PutObject operation - - - - - PutObjectRetention Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for PutObjectRetention operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Delete Object Tagging Request Marshaller - - - - - Marshall PutObjectTaggingRequest into an http request. - - - - - Marshall PutObjectTaggingRequest into an http request. - - - - - Response Unmarshaller for DeleteObjectTagging operation - - - - - PutPublicAccessBlock Request Marshaller - - - - - Response Unmarshaller for PutPublicAccessBlock operation - - - - - Restore Object Request Marshaller - - - - - Response Unmarshaller for RestoreObject operation - - - - - Condition Unmarshaller - - - - - Redirect Unmarshaller - - - - - RoutingRule Unmarshaller - - - - - RulesItem Unmarshaller - - - - - Response Unmarshaller for all Errors - - - - - Build an S3ErrorResponse from XML - - The XML parsing context. - Usually an Amazon.Runtime.Internal.UnmarshallerContext. - An S3ErrorResponse object. - - - - Grant Unmarshaller - - - - - Class for unmarshalling S3 service responses - - - - - Specialized S3 unmarshaller context. - - - - - Wrap an XmlTextReader with state for event-based parsing of an XML stream. - - Stream with the XML from a service response. - If set to true, maintains a copy of the complete response body as the stream is being read. - Response data coming back from the request - If set to is true, configure unmarshaller with exception specifics. - - - - Reads to the next node in the XML document, and updates the context accordingly. - If node is RequestId, reads the contents and stores in RequestId property. - - - True if a node was read, false if there are no more elements to read./ - - - - - SSEKMS Unmarshaller - - - - - StorageClassAnalysisDataExportDataExportUnmarshaller - - - - - StorageClassAnalysisUnmarshaller - - - - - Tag Unmarshaller - - - - - TopicConfiguration Unmarshaller - - - - - Transition Unmarshaller - - - - - Upload Part Request Marshaller - - - - - Response Unmarshaller for UploadPart operation - - - - - VersionsItem Unmarshaller - - - - - Class for AnalyticsPrefixPredicate - The prefix used when evaluating a metrics filter. - - - - - Class for AnalyticsS3BucketDestination - - - - - The file format used when exporting data to Amazon S3. - - - - - The account ID that owns the destination bucket. If no account ID is provided, the owner will not be validated prior to exporting data. - - - - - The Amazon resource name (ARN) of the bucket to which data is exported. - - - - - The prefix to use when exporting data. The exported data begins with this prefix. - - - - - Class for MetricsTagPredicate - The tag used when evaluating a metrics filter. - - - - - This class represents the byte range for a range GET from S3. - - - - - Constructs a ByteRange and sets the start and end. - - - - - - - Constructs a ByteRange and sets the header to the value specified. - - - - - - A private string, represending the byte range. - - - - - The starting byte number of the range - - - - - The ending byte number of the range - - - - - The formatted string representing the byte range to be set for the range header. - - - - - Container for the parameters to the CompleteMultipartUpload operation. - Completes a multipart upload by assembling previously uploaded parts. - - - - - The name of the bucketName containing the S3 object that was being uploaded in parts. - - - - - The key of the S3 object that was being uploaded. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - A collection of part numbers and corresponding etags. - - - - - Adds a collection of part numbers and corresponding etags. - - PartETags that will added to this request. - - - - Adds a collection of part numbers and corresponding etags. - - PartETags that will added to this request. - - - - Adds a collection of part numbers and corresponding etags by transforming the UploadPartResponses into PartETags. - - The list of response objects return from UploadParts. - - - - Adds a collection of part numbers and corresponding etags by transforming the UploadPartResponses into PartETags. - - The list of response objects return from UploadParts. - - - - Adds a collection of part numbers and corresponding etags by transforming the CopyPartResponse into PartETags. - - The list of response objects return from CopyParts. - - - - Adds a collection of part numbers and corresponding etags by transforming the CopyPartResponse into PartETags. - - The list of response objects return from CopyParts. - - - - The upload id for the in-progress multipart upload that should be completed. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the CompleteMultipartUpload response and response metadata. - - - - - Gets and sets the URI that identifies the newly created object. - - - - - Gets and sets the name of the bucketName that contains the newly created object. - - - - - Gets and sets the object key of the newly created object. - - - - - Gets and sets Entity tag that identifies the newly created object's data. Objects with different - object data will have different entity tags. The entity tag is an opaque string. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - Gets and sets the ServerSideEncryptionMethod property. - Specifies the encryption used on the server to - store the content. - Default is None. - - - - - Gets and sets the VersionId property. - This is the version-id of the S3 object - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the CopyObject operation. - Creates a copy of an object that is already stored in Amazon S3. - - - - - The name of the bucket containing the object to copy. - - - - - Checks if SourceBucket property is set. - - true if SourceBucket property is set. - - - - The key of the object to copy. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Checks if SourceKey property is set. - - true if SourceKey property is set. - - - - Specifies a particular version of the source object to copy. By default the latest version is copied. - - - - - Checks if SourceVersionId property is set. - - true if SourceVersionId property is set. - - - - The name of the bucket to contain the copy of the source object. - - - - - Checks if DestinationBucket property is set. - - true if DestinationBucket property is set. - - - - The key to be given to the copy of the source object. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Checks if DestinationKey property is set. - - true if DestinationKey property is set. - - - - A canned access control list (CACL) to apply to the object. - Please refer to for - information on S3 Canned ACLs. - - - - - ETag to be matched as a pre-condition for copying the source object - otherwise returns a PreconditionFailed. - - - Copies the object if its entity tag (ETag) matches - the specified tag; otherwise return a 412 (precondition failed). - Constraints: This property can be used with IfUnmodifiedSince, - but cannot be used with other conditional copy properties. - - - - - Checks if ETagToMatch property is set. - - - Copies the object if its entity tag (ETag) is different - than the specified Etag; otherwise returns a 412 (failed condition). - Constraints: This header can be used with IfModifiedSince, but cannot - be used with other conditional copy properties. - - true if ETagToMatch property is set. - - - - ETag that must not be matched as a pre-condition for copying the source object, - otherwise returns a PreconditionFailed. - - - - - Checks if ETagToNotMatch property is set. - - true if ETagToNotMatch property is set. - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or - ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Copies the object if it has been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it has been modified since the - specified time; otherwise returns a 412 (failed condition). - Constraints: This property can be used with ETagToNotMatch, - but cannot be used with other conditional copy properties. - - - - - Copies the object if it has been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it has been modified since the - specified time; otherwise returns a 412 (failed condition). - Constraints: This property can be used with ETagToNotMatch, - but cannot be used with other conditional copy properties. - - - - - Checks if ModifiedSinceDateUtc property is set. - - true if ModifiedSinceDateUtc property is set. - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or - UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Copies the object if it has not been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it hasn't been modified since the - specified time; otherwise returns a 412 (precondition failed). - Constraints: This property can be used with ETagToMatch, - but cannot be used with other conditional copy properties. - - - - - Copies the object if it has not been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it hasn't been modified since the - specified time; otherwise returns a 412 (precondition failed). - Constraints: This property can be used with ETagToMatch, - but cannot be used with other conditional copy properties. - - - - - Checks if UnmodifiedSinceDateUtc property is set. - - true if UnmodifiedSinceDateUtc property is set. - - - - Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request. - - - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - Specifies whether you want to apply a Legal Hold to the copied object. - - - - - - Gets and sets the property ObjectLockMode. - - The Object Lock mode that you want to apply to the copied object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - The date and time when you want the copied object's Object Lock to expire. - - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - Checks if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - true if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - - - The type of storage to use for the object. Defaults to 'STANDARD'. - - - - - - If the bucketName is configured as a website, redirects requests for this object to another object in the same bucketName or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - This is a convenience property for Headers.ContentType. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - /// - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The customer provided encryption key for the source object of the copy. - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - true if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the CopySourceServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if CopySourceServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - The tag-set for the object destination object this value must be used in conjunction with the TaggingDirective. The tag-set must be encoded as URL Query parameters. - - - - - Checks if Tagging property is set - - true if Tagging is set. - - - - Returns information about the CopyObject response and response metadata. - - - - - Gets and sets the ETag property. - - - - - Gets and sets the LastModified property. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - Gets and sets the SourceVersionId property. - This is the Version Id of the Source Object - - - - - Version ID of the newly created copy. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the CopyPart operation. - Uploads a part by copying data from an existing object as data source. - - - - - The name of the bucket containing the object to copy. - - - - - Checks if SourceBucket property is set. - - true if SourceBucket property is set. - - - - The key of the object to copy. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Checks if SourceKey property is set. - - true if SourceKey property is set. - - - - Specifies a particular version of the source object to copy. By default the latest version is copied. - - - - - Checks if SourceVersionId property is set. - - true if SourceVersionId property is set. - - - - The name of the bucket to contain the copy of the source object. - - - - - Checks if DestinationBucket property is set. - - true if DestinationBucket property is set. - - - - The key to be given to the copy of the source object. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Checks if DestinationKey property is set. - - true if DestinationKey property is set. - - - - The ID identifying multipart upload for which we are copying a part. - - - - - Checks if UploadId property is set. - - true if UploadId property is set. - - - - Collection of ETags to be matched as a pre-condition for copying the source object - otherwise returns a PreconditionFailed. - - - Copies the object if its entity tag (ETag) matches one of - the specified tags; otherwise return a 412 (precondition failed). - Constraints: This property can be used with IfUnmodifiedSince, - but cannot be used with other conditional copy properties. - - - - - Checks if ETagsToMatch property is set. - - true if ETagToMatch property is set. - - - - Collection of ETags that must not be matched as a pre-condition for copying the source object - otherwise returns a PreconditionFailed. - - - Copies the object if its entity tag (ETag) does not match any of the specified - tags; otherwise returns a 412 (failed condition). - Constraints: This header can be used with IfModifiedSince, but cannot - be used with other conditional copy properties. - - - - - Checks if ETagToNotMatch property is set. - - true if ETagToNotMatch property is set. - - - - Copies the object if it has been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it has been modified since the - specified time; otherwise returns a 412 (failed condition). - Constraints: This property can be used with ETagToNotMatch, - but cannot be used with other conditional copy properties. - - - - - Checks if ModifiedSinceDate property is set. - - true if ModifiedSinceDate property is set. - - - - Copies the object if it has not been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it hasn't been modified since the - specified time; otherwise returns a 412 (precondition failed). - Constraints: This property can be used with ETagToMatch, - but cannot be used with other conditional copy properties. - - - - - Checks if UnmodifiedSinceDate property is set. - - true if UnmodifiedSinceDate property is set. - - - - The number of the part to be copied. - - - Valid part numbers are from 1 to 10,000 inclusive and will uniquely identify the part - and determine the relative ordering within the destination object. If a part already - exists with the PartNumber it will be overwritten. - - - - - Checks if PartNumber property is set. - - true if PartNumber property is set. - - - - The location of the first byte in the range if only a portion of the - source object is to be copied as the part. - - - The LastByte property must also be set or this value will be ignored. - - - - - Checks if FirstByte property is set. - - true if FirstByte property is set. - - - - The location of the last byte in the range if only a portion of the - source object is to be copied as the part. - - - The FirstByte property must also be set or this value will be ignored. - - - - - Checks if LastByte property is set. - - true if LastByte property is set. - - - - - This property is obsolete. Use ServerSideEncryptionMethod in InitiateMultipartUploadRequest instead. - - - Default: None - - - - - - Checks if ServerSideEncryptionMethod property is set. - - true if ServerSideEncryptionMethod property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - This property is obsolete. Use ServerSideEncryptionKeyManagementServiceKeyId in InitiateMultipartUploadRequest instead. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The customer provided encryption key for the source object of the copy. - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - true if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the CopySourceServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if CopySourceServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - - - Returns information about the CopyPart response and response metadata. - - - - - The version of the source object that was copied, if you have enabled versioning on the source bucketName. - - - - - - Entity tag of the object. - - - - - - Date and time at which the object was uploaded. - - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - Gets and sets the PartNumber property. - This is the part number in it's multi-part upload that will uniquely identify the part - and determine the relative ordering within the destination object. - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - A collection of up to 100 cross-origin resource sharing (CORS) rules. - - - - - The collection of rules in this configuration. - - - - C O R S Rule - - - - - Identifies HTTP methods that the domain/origin specified in the rule is allowed to execute. - - - - - - One or more origins you want customers to be able to access the bucket from. - - - - - - An optional unique identifier for the rule. - - - The ID value can be up to 255 characters long. The IDs help you find a rule in the configuration. - - - - - Checks if Id property is set. - - true if Id property is set. - - - - One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript - XMLHttpRequest object). - - - - - - The time in seconds that your browser is to cache the preflight response for the specified resource. - - - - - - Specifies which headers are allowed in a pre-flight OPTIONS request through the - Access-Control-Request-Headers header. - - - Each header name specified in the Access-Control-Request-Headers must have a corresponding - entry in the rule. Only the headers that were requested will be sent back. - This element can contain at most one * wildcard character. - - - - - Checks if AllowedHeaders property is set. - - true if AllowedHeaders property is set. - - - - Describes how a CSV-formatted input object is formatted. - - - - - Describes the first line of input. Valid values: None, Ignore, Use. - - - - - Single character used to indicate a row should be ignored when present at the start of a row. - - - - - Single character used for escaping the quote character inside an already escaped value. - - - - - Value used to separate individual records. - - - - - Value used to separate individual fields in a record. - - - - - Value used for escaping where the field delimiter is part of the value. - - - - - Specifies that CSV field values may contain quoted record delimiters and such records should be allowed. Default value is FALSE. Setting this value to TRUE may lower performance. - - - - - Describes how CSV-formatted results are formatted. - - - - - Indicates whether or not all output fields should be quoted. - - - - - Single character used for escaping the quote character inside an already escaped value. - - - - - Value used to separate individual records. - - - - - Value used to separate individual fields in a record. - - - - - Value used for escaping where the field delimiter is part of the value. - - - - - The container element for specifying the default Object Lock retention settings for - new objects placed in the specified bucket. - - - - - Gets and sets the property Days. - - The number of days that you want to specify for the default retention period. - - - - - - Gets and sets the property Mode. - - The default Object Lock retention mode you want to apply to new objects placed in - the specified bucket. - - - - - - Gets and sets the property Years. - - The number of years that you want to specify for the default retention period. - - - - - - Container for the parameters to the DeleteBucketAnalyticsConfiguration operation. - Deletes an analytics configuration for the bucket (specified by the analytics configuration ID). - - - - - The name of the bucket from which an analytics configuration is deleted. - - - - - The identifier used to represent an analytics configuration. - - - - - Returns information about the DeleteBucketAnalyticsConfiguration response metadata. - The DeleteBucketAnalyticsConfiguration operation has a void result type. - - - - - Request object for the DeleteBucketEncryption operation. - Request Deletes the server-side encryption configuration from the bucket. - - - - - The name of the bucket containing the server-side encryption configuration to delete. - - - - - Returns information about the DeleteBucketEncryption response metadata. - The DeleteBucketEncryption operation has a void result type. - - - - - Container for the parameters to the DeleteInventoryConfiguration operation. - Deletes an inventory configuration (identified by the inventory ID) from the bucket. - - - - - The name of the bucket containing the inventory configuration to delete. - - - - - The ID used to identify the inventory configuration. - - - - - Returns information about the DeleteInventoryConfiguration response metadata. - The DeleteInventoryConfiguration operation has a void result type. - - - - - Container for the parameters to the DeleteBucketMetricsConfiguration operation. - Deletes a metrics configuration (specified by the metrics configuration ID) from the bucket. - - - - - The name of the bucket on which Inventory configuration is to be removed. - - - - - The ID used to identify the metrics configuration. - - - - - Returns information about the DeleteBucketMetricsConfiguration response metadata. - The DeleteBucketMetricsConfiguration operation has a void result type. - - - - - Container for the parameters to the DeleteBucketPolicy operation. - Deletes the policy from the bucket. - - - - - The bucket on which the policy is to be deleted. - - - - - Returns information about the DeleteBucketPolicy response metadata. - The DeleteBucketPolicy operation has a void result type. - - - - - Request object for the DeleteBucketReplication operation. - - - - - Gets and sets the property BucketName. -

Deletes the replication subresource associated with the specified - bucket.

There is usually some time lag before - replication configuration deletion is fully propagated to all the - Amazon S3 systems.

For more information, see - - Cross-Region Replication (CRR) in the Amazon S3 Developer - Guide.

- - - - - Returns information about the DeleteBucketReplication response metadata. - The DeleteBucketReplication operation has a void result type. - - - - - Container for the parameters to the DeleteBucket operation. - Deletes the bucket. All objects (including all object versions and Delete Markers) in the bucket must be deleted before the bucket - itself can be deleted. - - - - - The name of the bucket to be created. - - - - - The region locality for the bucket. - - - When set, this will determine the region the bucket exists in. - Refer - for a list of possible values. - - - - - If set to true the bucket will be deleted in the same region as the configuration of the AmazonS3 client. - DeleteBucketRequest.BucketRegion takes precedence over this property if both are set. - Default: true. - - - - - Returns information about the DeleteBucket response metadata. - The DeleteBucket operation has a void result type. - - - - - The parameters to request deletion of a tag set from a bucket. - - - To use this operation, you must have permission to perform the s3:PutBucketTagging action. - By default, the bucket owner has this permission and can grant this permission to others. - - - - - The name of the bucket on which the tag set is to be removed. - - - - - Returns information about the DeleteBucketTagging response metadata. - The DeleteBucketTagging operation has a void result type. - - - - - Container for the parameters to the DeleteBucketWebsite operation. - This operation removes the website configuration from the bucket. - - - - - The name of the bucket on which website configuration is to be removed. - - - - - Returns information about the DeleteBucketWebsite response metadata. - The DeleteBucketWebsite operation has a void result type. - - - - - Container for the parameters to the DeleteCORSConfiguration operation. - Deletes the cors configuration information set for the bucket. - - - - - Gets and sets the BucketName property. - - - - - Returns information about the DeleteCORSConfiguration response metadata. - The DeleteCORSConfiguration operation has a void result type. - - - - - Contains information about a successful delete operation against a specific S3 object. - - - - - Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a - delete marker. In a simple DELETE, this header indicates whether (true) or not (false) a delete - marker was created. - - - - - The version ID of the delete marker created as a result of the DELETE operation. If you delete a - specific object version, the value returned by this header is the version ID of the object version - deleted. - - - - - The key of the deleted S3 object. - - - - - The version of the deleted S3 object. - - - - - Contains information about a failed delete operation against a specific S3 object. - - - - - The key of the S3 object. - - - - - The version of the S3 object. - - - - - The failure code for the delete error. - - - - - The failure message for the delete error. - - - - - The parameters to request deletion of the lifecycle configuration on a bucket. - - - - Amazon S3 removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. - Your objects never expire, and Amazon S3 no longer automatically deletes any objects on the basis of rules contained - in the deleted lifecycle configuration. - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration action. By default, the - bucket owner has this permission and the bucket owner can grant this permission to others. - - - There is usually some time lag before lifecycle configuration deletion is fully propagated to all the Amazon S3 systems. - - - - - - The name of the bucket on which the lifecycle configuration is to be deleted. - - - - - Returns information about the DeleteLifecycleConfiguration response metadata. - The DeleteLifecycleConfiguration operation has a void result type. - - - - -

Specifies whether Amazon S3 should replicate delete makers.

- - - - - Gets and sets the property Status. -

The status of the delete marker replication.

-

In the current implementation, Amazon S3 does not replicate - the delete markers. Therefore, the status must be - Disabled.

- - - - - The parameters to request deletion of an object in a bucket. - The operation removes the null version (if there is one) of an object and inserts a delete marker, which - becomes the latest version of the object. - - - - To remove a specific version, you must be the bucket owner and you must use the versionId subresource. - Using this subresource permanently deletes the version. - - - If the object you want to delete is in a bucket where the bucket versioning configuration is MFA Delete enabled, - you must include specify the MFA serial number and value in the request. - - - If there isn't a null version, Amazon S3 does not remove any objects. - - - - - - The bucket name of the bucket containing the object. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property BypassGovernanceRetention. - - - - - The key identifying the object to delete. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - The identifier for the specific version of the object to be deleted, if required. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - The MfaCodes Tuple associates the Serial Number and the current Token/Code displayed on the - Multi-Factor Authentication device associated with your AWS Account. - - - This is a required property for this request if:
- 1. EnableMfaDelete was configured on the bucket - containing this object's version.
- 2. You are deleting an object's version - - - - - Checks if the MfaCodes property is set. - - true if the MfaCodes property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the DeleteObject response and response metadata. - - - - - Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a delete marker. - - - - - - Returns the version ID of the delete marker created as a result of the DELETE operation. - - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the DeleteObjects operation. - This operation enables you to delete multiple objects from a bucket using a single HTTP request. You may specify up to 1000 - keys. - - - Container for the parameters to the DeleteObjects operation. - This operation enables you to delete multiple objects from a bucket using a single HTTP request. You may specify up to 1000 - keys. - - - - - The bucket name containing the objects to delete. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property BypassGovernanceRetention. - - Specifies whether you want to delete this object even if it has a Governance-type - Object Lock in place. You must have sufficient permissions to perform this operation. - - - - - - List of object keys to delete. - - - - - Toggles between Quiet and Verbose mode for the operation. - If set to true (Quiet mode), the response includes only those keys for objects on which - the delete operation failed. - - - By default this property is false and keys for both successful deletes - and failures are returned in the response. - - - - - The MfaCodes Tuple associates the Serial Number and the current Token/Code displayed on the - Multi-Factor Authentication device associated with your AWS Account. - - - This is a required property for this request if:
- 1. EnableMfaDelete was configured on the bucket - containing this object's version.
- 2. You are deleting an object's version - - - - - Checks if the MfaCodes property is set. - - true if the MfaCodes property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Add a key to the set of keys of objects to be deleted. - - Object key - - - - Add a key and a version to be deleted. - - Key of the object to be deleted. - Version of the object to be deleted. - - - - Add a KeyVersion object representing the S3 object to be deleted. - - KeyVersion representation of object to be deleted. - - - - Returns information about the DeleteObjects response and response metadata. - - - - - A default constructor for DeleteObjectsResponse - - - - - Gets and sets the DeletedObjects property. - A list of successful deletes. - Set only when Quiet=false on DeleteObjectsRequest. - - - - - Gets and sets the DeleteErrors property. - A list of errors encountered while deleting objects. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the DeleteObjectTaggingRequest operation. - - - - - The bucket name containing the objects from which to remove the tags. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Check to see if Bucket property is set - - - - - The key identifying the object tagging to delete. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Check to see if Key property is set - - - - - The identifier for the specific version of the object to be deleted, if required. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - Returns information about the DeleteObjectTagging response and response metadata. - - - - - Returns the version ID of the delete marker created as a result of the DELETE operation. - - - - - Check to see if VersionId property is set - - - - - Container for the parameters to the DeletePublicAccessBlock operation. - Removes the Public Access Block configuration for an Amazon S3 bucket. - - - - - Gets and sets the property BucketName. - - The Amazon S3 bucket whose Public Access Block configuration you want to delete. - - - - - - This is the response object from the DeletePublicAccessBlock operation. - - - - - EncryptionConfiguration class - - - - - The ID of the AWS KMS key for the region where the destination bucket - resides. Amazon S3 uses this key to encrypt the replica object. - - - - - A container that specifies information about existing object replication. You can choose whether to enable or disable the replication of existing objects. - - - - - Specifies whether existing object replication is enabled. - - - - - Defines the expiration policy for a given object. - - - - - This property is deprecated. This property exposes a DateTime of kind Unspecified. Use ExpiryDateUtc instead. - The date and time for expiry. - - - - - The date and time for expiry. - - - - - Id of the configuration rule for this expiry. - - - - - Constructs an empty instance of an Expiration object - - - - Bucket - Represents a set of filter criteria that limits the objects that can trigger event notifications - - - - - Filter criteria that limits the objects that can trigger event notifications based on their S3 Key name. - - - - - Bucket - Represents a Filter Rule for a NotificationConfiguration. - - - - - Constructs an empty FilterRule. - - - - - Constructs a FilterRule with a specific name and value. - - - - - - - The name of the filter rule. - - - - - The value of the filter rule. - - - - - Container for the parameters to the GetACL operation. - Returns the access control list (ACL) of an object. - - - - - The bucket name that contains the object for which to get the ACL information. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The key of the S3 object to be queried. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - VersionId used to reference a specific version of the object. - - - - - Returns information about the GetACL response and response metadata. - - - - - Gets and sets the AccessControlList property. - - - - - Container for the parameters to the GetBucketAccelerateConfiguration operation. - - - - - The name of the bucket. - - - - - The response class for GetBucketAccelerateConfiguration operation. - - - - - The accelerate status of the bucket. - - - - - Container for the parameters to the GetBucketAnalyticsConfiguration operation. - Gets an analytics configuration for the bucket (specified by the analytics configuration ID). - - - - - The name of the bucket from which an analytics configuration is retrieved. - - - - - The identifier used to represent an analytics configuration. - - - - - GetBucketAnalyticsConfigurationResponse Response - - - - - The configuration and any analyses for the analytics filter. - - - - - Container for the parameters to the GetBucketEncryptionRequest operation. - Returns the server-side encryption configuration of a bucket. - - - - - The name of the bucket. - - - - - GetBucketEncryptionResponse Response - - - - - Container for server-side encryption configuration rules. Currently S3 supports one rule only. - - - - - Container for the parameters to the GetInventoryConfigurationRequest operation. - Returns an inventory configuration (identified by the inventory ID) from the bucket. - - - - - The name of the bucket containing the inventory configuration to retrieve. - - - - - The ID used to identify the inventory configuration. - - - - - GetInventoryConfigurationResponse Response - - - - - Specifies the inventory configuration. - - - - - Container for the parameters to the GetBucketLocation operation. - Returns the region the bucket resides in. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetBucketLocation response and response metadata. - - - - - Gets and sets the Location property. - If the the bucket is located in us-east-1 S3Region.US will be return which has a - value of empty string. - - - - - Container for the parameters to the GetBucketLogging operation. - Returns the logging status of a bucket and the permissions users have to view and modify that status. To use GET, you must be the - bucket owner. - - - - - The name of the bucket to query. - - - - - Returns information about the GetBucketLogging response and response metadata. - - - - - Gets and sets the LoggingConfig property. - - - - - Container for the parameters to the GetBucketMetricsConfiguration operation. - Gets a metrics configuration (specified by the metrics configuration ID) from the bucket. - - - - - The name of the bucket containing the metrics configuration to retrieve. - - - - - The ID used to identify the metrics configuration. - - - - - GetBucketMetricsConfiguration Response - - - - - Specifies the metrics configuration. - - - - - Container for the parameters to the GetBucketNotification operation. - Return the notification configuration of a bucket. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetBucketNotification response and response metadata. - - - - - Gets and sets the TopicConfigurations property. TopicConfigurations are configuration - for Amazon S3 events to be sent to Amazon SNS topics. - - - - - Gets and sets the QueueConfigurations property. QueueConfigurations are configuration - for Amazon S3 events to be sent to Amazon SQS queues. - - - - - Gets and sets the LambdaFunctionConfigurations property. LambdaFunctionConfigurations are configuration - for Amazon S3 events to be sent to an Amazon Lambda cloud function. - - - - - Container for the parameters to the GetBucketPolicy operation. - Returns the policy of a specified bucket. - - - - - The name of the bucket. - - - - - Get BucketName Policy Response - - - - - The bucket policy as a JSON document. - - - - - Container for the parameters to the GetBucketPolicyStatus operation. - Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket - is public. - - - - - Gets and sets the property BucketName. - - The name of the Amazon S3 bucket whose public-policy status you want to retrieve. - - - - - - This is the response object from the GetBucketPolicyStatus operation. - - - - - The public-policy status for this bucket. - - - - - Container for the parameters to the GetBucketReplicationConfiguration operation. - Returns the replication configuration information set on the bucket. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetReplicationConfiguration response and response metadata. - - - - - The replication configuration for the buccket specified in the request. - - - - - Container for the parameters to the GetBucketRequestPayment operation. - Returns the request payment configuration of a bucket. - - - - - The name of the bucket. - - - - - Returns information about the GetBucketRequestPayment response and response metadata. - - - - - Specifies who pays for the download and request fees. - - - - - - Container for the parameters to the GetBucketTagging operation. - Returns the tag set associated with the bucket. - - - - - The name of the bucket to be queried. - - - - - Returns information about the GetBucketTagging response and response metadata. - - - - - The collection of tags. - - - - - Container for the parameters to the GetBucketVersioning operation. - Returns the versioning state of a bucket. - - - - - The name of the bucket to be queried. - - - - - Returns information about the GetBucketVersioning response and response metadata. - - - - - Gets and sets the Versioning property. - Unless Versioning has been explicitly "Enabled" on a bucket, - Versioning Status is "Off". Once Versioning has been - "Enabled", it can be "Suspended" but cannot be switched "Off". - - - - - Container for the parameters to the GetBucketWebsite operation. - Returns the website configuration for a bucket. - - - - - The name of the bucket to be queried. - - - - - Returns information about the GetBucketWebsite response and response metadata. - - - - - Gets and sets the WebsiteConfiguration property. - - This is where the index document suffix and custom error page are defined. - - - - - Container for the parameters to the GetBucketCors operation. - Returns the cors configuration for the bucket. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetBucketCors response and response metadata. - - - - - The current CORSConfiguration for the bucket. - - - - - Container for the parameters to the GetLifecycleConfiguration operation. - Returns the lifecycle configuration information set on the bucket. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetLifecycleConfiguration response and response metadata. - - - - - Gets and Sets the property that governs whether - the response includes successful deletes as well as errors - following the DeleteObjects call against S3. - - By default this property is false and successful deletes - are returned in the response. - - - - - Container for the parameters to the GetObjectLegalHold operation. - Gets an object's current Legal Hold status. - - - - - The bucket name containing the object whose Legal Hold status you want to retrieve. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property Key. - - The key name for the object whose Legal Hold status you want to retrieve. - - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property VersionId. - - The version ID of the object whose Legal Hold status you want to retrieve. - - - - - - This is the response object from the GetObjectLegalHold operation. - - - - - Gets and sets the property LegalHold. - - The current Legal Hold status for the specified object. - - - - - - Container for the parameters to the GetObjectLockConfiguration operation. - Gets the Object Lock configuration for a bucket. The rule specified in the Object - Lock configuration will be applied by default to every new object placed in the specified - bucket. - - - - - Gets and sets the property BucketName. - - The bucket whose Object Lock configuration you want to retrieve. - - - - - - This is the response object from the GetObjectLockConfiguration operation. - - - - - Gets and sets the property ObjectLockConfiguration. - - The specified bucket's Object Lock configuration. - - - - - - Container for the parameters to the HeadObject operation. - The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you''re only - interested in an object''s metadata. To use HEAD, you must have READ access to the object. - - - - - The name of the bucket that contains the object. - - - - - ETag to be matched as a pre-condition for returning the object, - otherwise a PreconditionFailed signal is returned. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or - ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Returns the object only if it has been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Returns the object only if it has been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - ETag that should not be matched as a pre-condition for returning the object, - otherwise a PreconditionFailed signal is returned. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or - UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Returns the object only if it has not been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Returns the object only if it has not been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - The key of the object. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - VersionId used to reference a specific version of the object. - - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to decrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - Part number of the object being read. This is a positive integer between 1 and 10,000. - Effectively performs a 'ranged' HEAD request for the part specified. - Useful querying about the size of the part and the number of parts in this object. - - - - - Check if PartNumber property is set. - - true if PartNumber property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the HeadObject response and response metadata. - - - - - Flag which returns true if the Expires property has been unmarshalled - from the raw value or set by user code. - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the - response. - - - - - - Gets and sets the AcceptRanges. - - - - - Gets and sets the ContentRange. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - Gets and sets the RestoreExpiration property. - RestoreExpiration will be set for objects that have been restored from Amazon Glacier. - It indiciates for those objects how long the restored object will exist. - - - - - Gets and sets the RestoreInProgress - Will be true when the object is in the process of being restored from Amazon Glacier. - - - - - Last modified date of the object - - - - - - An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL - - - - - - This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like - SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal - HTTP headers. - - - - - - Version of the object. - - - - - - The date and time at which the object is no longer cacheable. - - - - - - If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The status of the replication job associated with this source object. - - - - - Checks if ReplicationStatus property is set. - - true if ReplicationStatus property is set. - - - - The count of parts this object has. - - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - The Legal Hold status for the specified object. - - - - - - Gets and sets the property ObjectLockMode. - - The Object Lock mode currently in place for this object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - The date and time when this object's Object Lock will expire. - - - - - - The class of storage used to store the object. - - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the GetObject operation. - Retrieves objects from Amazon S3. - - - - - The bucket name containing the object. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - ETag to be matched as a pre-condition for returning the object, - otherwise a PreconditionFailed signal is returned. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or - ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Returns the object only if it has been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Returns the object only if it has been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - ETag that should not be matched as a pre-condition for returning the object, - otherwise a PreconditionFailed signal is returned. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or - UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Returns the object only if it has not been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Returns the object only if it has not been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Gets and sets the Key property. This is the user defined key that identifies the object in the bucket. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Downloads the specified range bytes of an object. - - - - - A set of response headers that should be returned with the object. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ResponseExpiresUtc instead. Setting either ResponseExpires or - ResponseExpiresUtc results in both ResponseExpires and ResponseExpiresUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ResponseExpires is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Sets the Expires header of the response. - - - - - Sets the Expires header of the response. - - - - - VersionId used to reference a specific version of the object. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to decrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - Part number of the object being read. This is a positive integer between 1 and 10,000. - Effectively performs a 'ranged' GET request for the part specified. Useful for downloading just a part of an object. - - - - - Checks if PartNumber property is set. - - true if PartNumber property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the GetObject response and response metadata. - - - - - Flag which returns true if the Expires property has been unmarshalled - from the raw value or set by user code. - - - - - Gets and sets the BucketName property. - - - - - Gets and sets the Key property. - - - - - Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the - response. - - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - Gets and sets the AcceptRanges. - - - - - Gets and sets the ContentRange. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - Gets and sets the RestoreExpiration property. - RestoreExpiration will be set for objects that have been restored from Amazon Glacier. - It indiciates for those objects how long the restored object will exist. - - - - - Gets and sets the RestoreInProgress - Will be true when the object is in the process of being restored from Amazon Glacier. - - - - - Last modified date of the object - - - - - - An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL - - - - - - This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like - SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal - HTTP headers. - - - - - - Version of the object. - - - - - - The date and time at which the object is no longer cacheable. - - - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - - - - Gets and sets the property ObjectLockMode. - - The Object Lock mode currently in place for this object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - The date and time when this object's Object Lock will expire. - - - - - - If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The class of storage used to store the object. - - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The status of the replication job associated with this source object. - - - - - Checks if ReplicationStatus property is set. - - true if ReplicationStatus property is set. - - - - The number of parts this oject has. - - - - - Checks if PartsCount is set. - - true if PartsCount property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - The number of tags, if any, on the object. - - - - - The event for Write Object progress notifications. All - subscribers will be notified when a new progress - event is raised. - - - Subscribe to this event if you want to receive - put object progress notifications. Here is how:
- 1. Define a method with a signature similar to this one: - - private void displayProgress(object sender, WriteObjectProgressArgs args) - { - Console.WriteLine(args); - } - - 2. Add this method to the Put Object Progress Event delegate's invocation list - - GetObjectResponse response = s3Client.GetObject(request); - response.WriteObjectProgressEvent += displayProgress; - - - - - - This method is called by a producer of write object progress - notifications. When called, all the subscribers in the - invocation list will be called sequentially. - - The file being written. - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - True if transfer is complete - - - - Writes the content of the ResponseStream a file indicated by the filePath argument. - - The location where to write the ResponseStream - Whether or not to append to the file if it exists - - - - Encapsulates the information needed to provide - download progress for the Write Object Event. - - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The bucket name for the S3 object being written. - The object key for the S3 object being written. - The version-id of the S3 object. - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - True if finished writing - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The bucket name for the S3 object being written. - The object key for the S3 object being written. - The file for the S3 object being written. - The version-id of the S3 object. - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - True if finished writing - - - - Gets the bucket name for the S3 object being written. - - - - - Gets the object key for the S3 object being written. - - - - - Gets the version-id of the S3 object. - - - - - The file for the S3 object being written. - - - - - True if writing is complete - - - - - Container for the parameters to the GetObjectRetention operation. - Retrieves an object's retention settings. - - - - - The bucket name containing the object whose retention settings you want to retrieve. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property Key. - - The key name for the object whose retention settings you want to retrieve. - - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property VersionId. - - The version ID for the object whose retention settings you want to retrieve. - - - - - - This is the response object from the GetObjectRetention operation. - - - - - Gets and sets the property Retention. - - The container element for an object's retention settings. - - - - - - Container for the parameters to the GetObjectTaggingRequest operation. - - - - - The bucket name containing the object for which to get the tagging information. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Check to see if Bucket property is set - - - - - Gets and sets the Key property. This is the user defined key that identifies the object in the bucket. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Check to see if Key property is set - - - - - VersionId used to reference a specific version of the object. - - - - - - Returns information about the GetObjectTagging response and response metadata. - - - - - Gets or sets tag-set for a given object - - - - - Container for the parameters to the GetObjectTorrent operation. - Return torrent files from a bucket. - - - - - The name of the bucket containing the object. - - - - - The key identifying the object. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the GetObjectTorrent response and response metadata. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - The parameters to create a pre-signed URL to a bucket or object. - - - For more information, refer to: . -
Required Parameters: BucketName, Expires -
Optional Parameters: Key, VersionId, Verb: default is GET - - - - - The name of the bucket to create a pre-signed url to, or containing the object. - - - - - Checks if BucketName property is set. - - true if BucketName property is set. - - - - The key to the object for which a pre-signed url should be created. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Checks if Key property is set. - - true if Key property is set. - - - - A standard MIME type describing the format of the object data. - - - - The content type for the content being uploaded. This property defaults to "binary/octet-stream". - For more information, refer to: . - - - Note that if content type is specified, it should also be included in the HttpRequest headers - of the eventual upload request, otherwise a signature error may result. - - - - - - The expiry date and time for the pre-signed url. - - - - - Checks if Expires property is set. - - true if Expires property is set. - - - - The requested protocol (http/https) for the pre-signed url. - - - Defaults to https. - - - - - The verb for the pre-signed url. - - - Accepted verbs are GET, PUT, DELETE and HEAD. - Default is GET. - - - - - Version id for the object that the pre-signed url will reference. If not set, - the url will reference the latest version of the object. - - - This is the VersionId for the S3 Object you want to get - a PreSigned URL for. The VersionId property will be ignored - for PreSigned "PUT" requests and for requests that don't specify - the Key property. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - The upload id for the multipart upload for which a pre-signed url should be created. - - - - - Checks if UploadId property is set. - - true if UploadId property is set. - - - - The part number for the multipart upload for which a pre-signed url should be created. - - - - - Checks if PartNumber property is set. - - true if PartNumber property is set. - - - - Specifies the encryption used on the server to store the content. - - - - Default is None. - - - If specifying encryption (not None), the corresponding request must include header - "x-amz-server-side-encryption" with the value of the encryption. - - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - Confirms that the requester knows that she or he will be charged for the request. - Bucket owners need not specify this parameter in their requests. - - - - - A set of response headers that should be returned with the pre-signed url creation response. - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - Custom parameters to include in the signed request, so that they are tamper-proof. - - - - - The parameters for a pre-signed URL to a bucket or object as a string. - - - For more information, refer to: . - - - - - The PreSignedURL as a string - - - - - Constructor - - A url returned from GetPreSignedUrlRequest - - - - Container for the parameters to the GetPublicAccessBlock operation. - Retrieves the Public Access Block configuration for an Amazon S3 bucket. - - - - - Gets and sets the property BucketName. - - The name of the Amazon S3 bucket whose Public Access Block configuration you want - to retrieve. - - - - - - This is the response object from the GetPublicAccessBlock operation. - - - - - The Public Access Block configuration currently in effect for this Amazon S3 bucket. - - - - - Container for the parameters to the HeadBucket operation. - This operation is useful to determine if a bucket exists and you have permission to access it. - - - - - Returns information about the HeadBucket response metadata. - The HeadBucket operation has a void result type. - - - - - This class contains the headers for an S3 object. - - - - - Gets and sets headers to set for the object. - - The name of the header - The value for the header - - - - Gets the count of headers. - - - - - Gets the names of the headers set. - - - - - Specifies caching behavior along the request/reply chain. - - - - - - Specifies presentational information for the object. - - - - - - Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type - referenced by the Content-Type header field. - - - - - - The size of the object, in bytes. - - - - - The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. This - header can be used as a message integrity check to verify that the data is the same data that was originally sent. - - - - - A standard MIME type describing the format of the object data. - - - - - - The date and time at which the object is no longer cacheable. - - - - - - - Container for the parameters to the InitiateMultipartUpload operation. - Initiates a multipart upload and returns an upload ID. - - - - - Envelope Key to Encrypt data - - - - - Encrypted Envelope Key to Encrypt data - - - - - Initialization Vector for encryption - - - - - A canned access control list (ACL) to apply to the object. - Please refer to for information on S3 Canned ACLs. - - - - - The name of the bucketName where the new object will be created, or existing object updated. - - - - - The key of the object to create or update. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - StorageClass property for the object. - - - Default: S3StorageClass.Standard. Set this property - only if you want reduced redundancy for this object. - Please refer to - for - information on S3 Storage Classes. - - - - - If the bucketName is configured as a website, redirects requests for this object to another object in the same bucketName or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - This is a convenience property for Headers.ContentType. - - - - - - Specifies the encryption to be used on the server for the new object. - - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - Checks if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - true if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - Specifies whether you want to apply a Legal Hold to the uploaded object. - - - - - - Gets and sets the property ObjectLockMode. - - Specifies the Object Lock mode that you want to apply to the uploaded object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - Specifies the date and time when you want the Object Lock to expire. - - - - - - The tag-set for the object. The tag-set must be encoded as URL Query parameters. - - - - - Checks if Tagging property is set - - true if Tagging is set. - - - - Returns information about the InitiateMultipartUpload response and response metadata. - - - - - Name of the bucketName to which the multipart upload was initiated. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Object key for which the multipart upload was initiated. - - - - - - Gets and sets the initiated multipart upload id. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - Date when multipart upload will become eligible for abort operation by lifecycle. - - - - - Id of the lifecycle rule that makes a multipart upload eligible for abort operation. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Identifies who initiated the multipart upload. - - - - - Name of the Principal. - - - - - - If the principal is an AWS account, it provides the Canonical User ID. If the principal is an IAM User, it provides a user ARN value. - - - - - - Describes the serialization format of the object. - - - - - Describes the serialization of a CSV-encoded object. - - - - - Specifies object's compression format. Valid values: NONE, GZIP. Default Value: NONE. - - - - - Specifies JSON as object's input serialization format. - - - - - Specifies Parquet as object's input serialization format. - - - - - Class for MetricsConfiguration - - - - - Contains information about where to publish the inventory results. - - - - - Specifies whether the inventory is enabled or disabled. - - - - - Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria. - - - - - The ID used to identify the inventory configuration. - - - - - Specifies which object version(s) to included in the inventory results. - - - - - Contains the optional fields that are included in the inventory results. - - - - - Specifies the schedule for generating inventory results. - - - - - Class for InventoryDestination - - - - - Contains the bucket name, file format, bucket owner (optional), and prefix (optional) where inventory results are published. - - - - - InventoryEncryption class - - - - - Specifies the use of SSE-S3 to encrypt delievered Inventory reports. - - - - - Specifies the use of SSE-KMS to encrypt delievered Inventory reports. - - - - - Class for InventoryFilter - - - - - Filter Predicate setup for specific filter types. - - - - - Filter Predicate abstract class for specific filter types to be derived from. - - - - - Class for InventoryPrefixPredicate - The prefix that an object must have to be included in the inventory results. - - - - - The ID of the account that owns the destination bucket. - - - - - The Amazon resource name (ARN) of the bucket where inventory results will be published. - - - - - The prefix that is prepended to all inventory results. - - - - - Specifies the output format of the inventory results. - - - - - Contains the type of server-side encryption used to encrypt the inventory results. - - - - - Class for InventorySchedule - - - - - Specifies how frequently inventory results are produced. - - - - - Specifies JSON as object's input serialization format. - - - - - The type of JSON. Valid values: Document, Lines. - - - - - Specifies JSON as request's output serialization format - - - - - The value used to separate individual records in the output. - - - - - Specifies an object key and optional object version. - - - - - Key name of the object to delete. - - - - - - VersionId for the specific version of the object to delete. - - - - - - This class contains the configuration Amazon S3 uses to figure out what events you want to listen - and send the event to an Amazon Lambda cloud function. - - - - - Gets and set the Id property. The Id will be provided in the event content and can be used - to identify which configuration caused an event to fire. If the Id is not provided for the configuration, one will be generated. - - - - - Gets and sets the FunctionArn property. This is the Amazon Lambda cloud function to which Amazon S3 will invoke with the events. - - - - Lifecycle Configuration - - - - - Gets and sets the Rules property. These rules defined the lifecycle configuration. - - - - - Base class for all the different predicates that can be used - in a filter. - - - - - This method is called by the visitor when it wants to visit the predicate. - - - - - - Filter identifying one or more objects to which a applies. - - - - - The predicate used by the filter. - - - - - Base class for lifecycle operators. - - - - - The list of objects - that this operator operates on. - - - - - The logical and operator for filtering objects for a - - - - - Accept a visit from an - - - This method is used internally by the SDK. - - - - - - A predicate that filters objects for a - by matching a particular prefix. - - - - - The prefix to be matched by filtered objects. - - - - - Accept a visit from an - - - This method is used internally by the SDK. - - - - - - A predicate that filters objects for a - by matching a particular key and value. - - - - - The Tag to be matched by filtered objects. - - - - - Accept a visit from an - - - This method is used internally by the SDK. - - - - - - Rules Item - - - - - Defines the length of time, in days, before objects expire. - - - - - Unique identifier for the rule. The value cannot be longer than 255 characters. - - - - - Prefix identifying one or more objects to which the rule applies. - - - - - - Filter identifying one or more objects to which the rule applies. - - - - - If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied. - - - - - - The transition rule that describes when objects transition to a different storage class. - - Lifecycle rules can now contain multiple transitions. This property is obsolete in favor of the Transitions property. - This property will always get or set the the zeroth element in the Transitions collection. - - - - - - Defines the length of time, in days, before noncurrent versions expire. - - - - - The transition rule that describes when noncurrent versions transition to - a different storage class. - - Lifecycle rules can now contain multiple noncurrent version transitions. This property - is obsolete in favor of the NoncurrentVersionTransitions property. - This property will always get or set the the zeroth element in the NoncurrentVersionTransitions collection. - - - - - - The transition rules that describe when objects transition to a different storage class. - - - - - The transition rules that describe when noncurrent versions transition to - a different storage class. - - - - - Specifies the days since the initiation of an Incomplete Multipart Upload - that Lifecycle will wait before permanently removing all parts of the upload. - - - - - Specifies the days since the initiation of an Incomplete Multipart Upload - that Lifecycle will wait before permanently removing all parts of the upload. - - - - - Indicates the number of days that must pass since initiation for Lifecycle - to abort an Incomplete Multipart Upload. - - - - Expiration - - - - - Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format. - - - - - - Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer. - - - - - - Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set to true, the delete marker will be expired; if set to false the policy takes no action. This cannot be specified with Days or Date in a Lifecycle Expiration Policy. - - - - - - Noncurrent Version Expiration - - - - - Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated - action. For information about the noncurrent days calculations, see - How Amazon S3 Calculates When an Object Became Noncurrent - in the Amazon Simple Storage Service Developer Guide. - - - - - LifecycleTransition defines when and how objects transition. - - - - - Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated - action. For information about the noncurrent days calculations, see - How Amazon S3 Calculates When an Object Became Noncurrent - in the Amazon Simple Storage Service Developer Guide. - - - - - The class of storage used to store the object. - - - - - - LifecycleTransition defines when and how objects transition. - - - - - Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format. - - - - - - Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer. - - - - - - The class of storage used to store the object. - - - - - - Container for the parameters to the ListInventoryConfigurationsRequest operation. - Lists the analytics configurations for the bucket. - - - - - The name of the bucket containing the analytics configurations to retrieve. - - - - - The ContinuationToken that represents a placeholder from where this request should begin. - - - - - Returns information about the ListBucketAnalyticsConfigurationsResponse response and response metadata. - - - - - The ContinuationToken that represents where this request began. - - - - - The list of analytics configurations for a bucket. - - - - - Indicates whether the returned list of analytics configurations is complete. - A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request. - - - - - NextContinuationToken is sent when isTruncated is true, which indicates that there are more analytics configurations to list. - The next request must include this NextContinuationToken. The token is obfuscated and is not a usable value. - - - - - Container for the parameters to the ListInventoryConfigurationsRequest operation. - Returns a list of inventory configurations for the bucket. - - - - - The name of the bucket containing the inventory configurations to retrieve. - - - - - The marker used to continue an inventory configuration listing that has been truncated. - Use the NextContinuationToken from a previously truncated list response to continue the listing. - The continuation token is an opaque value that Amazon S3 understands. - - - - - Returns information about the ListInventoryConfigurationsResponse response and response metadata. - - - - - If sent in the request, the marker that is used as a starting point for this inventory configuration list response. - - - - - The list of inventory configurations for a bucket. - - - - - Indicates whether the returned list of inventory configurations is truncated in this response. A value of true indicates that the list is truncated. - - - - - The marker used to continue this inventory configuration listing. Use the NextContinuationToken from this response to continue the listing in a subsequent request. - The continuation token is an opaque value that Amazon S3 understands. - - - - - Container for the parameters to the ListBucketMetricsConfigurationRequest operation. - Lists the metrics configurations for the bucket. - - - - - The name of the bucket containing the metrics configurations to retrieve. - - - - - - The marker that is used to continue a metrics configuration listing that has been truncated. - Use the NextContinuationToken from a previously truncated list response to continue the listing. - The continuation token is an opaque value that Amazon S3 understands. - - - - - - Returns information about the ListBucketMetricsConfiguration response and response metadata. - - - - - - The marker that is used to continue a metrics configuration listing that has been truncated. - Use the NextContinuationToken from a previously truncated list response to continue the listing. - The continuation token is an opaque value that Amazon S3 understands. - - - - - - The list of metrics configurations for a bucket. - - - - - - Indicates whether the returned list of metrics configurations is complete. - A value of true indicates that the list is not complete and the NextContinuationToken will be provided for - a subsequent request. - - - - - - - The marker used to continue a metrics configuration listing that has been truncated. - Use the NextContinuationToken from a previously truncated list response to continue the listing. - The continuation token is an opaque value that Amazon S3 understands. - - - - - - Container for the parameters to the ListBuckets operation. - Returns a list of all buckets owned by the authenticated sender of the request. - - - - - Returns information about the ListBuckets response and response metadata. - - - - - List of buckets. - - - - - Owner of the buckets. - - - - - Container for the parameters to the ListMultipartUploads operation. - This operation lists in-progress multipart uploads. - - - - - Name of the bucket to which the multipart upload was initiated. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Character you use to group keys. - - - - - - Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin. - - - - - - Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response body. 1,000 is the maximum number of uploads that - can be returned in a response. - - - - - - Lists in-progress uploads only for those keys that begin with the specified prefix. - - - - - - Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the - upload-id-marker parameter is ignored. - - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - Returns information about the ListMultipartUploads response and response metadata. - - - - - Name of the bucketName to which the multipart upload was initiated. - - - - - - The key at or after which the listing began. - - - - - - Upload ID after which listing began. - - - - - - When a list is truncated, this element specifies the value that should be used for the key-marker request parameter in a subsequent request. - - - - - - When a list is truncated, this element specifies the value that should be used for the upload-id-marker request parameter in a subsequent - request. - - - - - - Maximum number of multipart uploads that could have been included in the response. - - - - - - Indicates whether the returned list of multipart uploads is truncated. A value of true indicates that the list was truncated. The list can - be truncated if the number of multipart uploads exceeds the limit allowed or specified by max uploads. - - - - - - Gets and sets the MultipartUploads property. - - Container for elements related to a particular multipart upload. A response - can contain zero or more Upload elements. - - - - - - Gets and sets the Prefix property. - - - - - Gets and sets the Delimiter property. - - - - - Gets the CommonPrefixes property. - A response can contain CommonPrefixes only if you specify a delimiter. - When you do, CommonPrefixes contains all (if there are any) keys between - Prefix and the next occurrence of the string specified by delimiter. In effect, - CommonPrefixes lists keys that act like subdirectories in the directory specified - by Prefix. For example, if prefix is notes/ and delimiter is a slash (/), in - notes/summer/july, the common prefix is notes/summer/. - - - - - Container for the parameters to the ListObjects operation. - Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a - subset of the objects in a bucket. - - - - - The name of the bucket containing the objects whose keys are to be listed. - - - - - A delimiter is a character you use to group keys. - - - - - Specifies the key to start with when listing objects in a bucket. - - - - - Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more. - - - - - Limits the response to keys that begin with the specified prefix. - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the ListObjects response and response metadata. - - - - - A flag that indicates whether or not Amazon S3 returned all of the results that satisfied - the search criteria. - - - - - Gets and sets the NextMarker property. - NextMarker is set by S3 only if a Delimiter was specified - in the original ListObjects request. If a delimiter was - not specified, the AWS SDK for .NET returns the last Key - of the List of Objects retrieved from S3 as the NextMarker. - - - - - Gets the S3Objects property. This is a list of - objects in the bucket that match your search criteria. - - - - - Gets and sets the Name property which is the name of the bucket. - - - - - Gets and sets the Prefix property. - - - - - Gets and sets the MaxKeys property. This is max number of object keys returned by the list operation. - - - - - Gets the CommonPrefixes property. - A response can contain CommonPrefixes only if you specify a delimiter. - When you do, CommonPrefixes contains all (if there are any) keys between - Prefix and the next occurrence of the string specified by delimiter. In effect, - CommonPrefixes lists keys that act like subdirectories in the directory specified - by Prefix. For example, if prefix is notes/ and delimiter is a slash (/), in - notes/summer/july, the common prefix is notes/summer/. - - - - - Gets and sets the Delimiter property. - Causes keys that contain the same string between the prefix and the - first occurrence of the delimiter to be rolled up into a single result - element in the CommonPrefixes collection. - - - These rolled-up keys are not returned elsewhere in the response. - - - - - Container for the parameters to the ListObjects operation. - Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a - subset of the objects in a bucket. - - - - - Bucket name to list. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - A delimiter is a character you use to group keys. - - - - - Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more. - - - - - Limits the response to keys that begin with the specified prefix. - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts - listing after this specified key. StartAfter can be any key in the bucket. - Cannot be set at the same time as ContinuationToken. - - - - - ContinuationToken indicates Amazon S3 that the list is being continued on this - bucket with a token. ContinuationToken is obfuscated and is not a real key. - - - - - The owner field is not present in ListObjectsV2 responses by default. - If you want to return owner field with each key in the result then set this field to true. - If not specified, the Owner field on S3Object will be null. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the ListObjects response and response metadata. - - - - - A flag that indicates whether or not Amazon S3 returned all of the results that satisfied - the search criteria. - - - - - Gets and sets the S3Objects property. Metadata about each object returned. - - - - - Bucket name. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the Prefix property. - - - - - Gets and sets the MaxKeys property. This is max number of object keys returned by the list operation. - - - - - Gets and sets the CommonPrefixes property. - CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence - of the string specified by delimiter - - - - - Gets and sets the Delimiter property. - Causes keys that contain the same string between the prefix and the - first occurrence of the delimiter to be rolled up into a single result - element in the CommonPrefixes collection. - - - These rolled-up keys are not returned elsewhere in the response. - - - - - Encoding type used by Amazon S3 to encode object keys in the response. - - - - - KeyCount is the number of keys returned with this request. - KeyCount will always be less than or equal to MaxKeys field. - - - - - ContinuationToken indicates Amazon S3 that the list is being continued - on this bucket with a token. - ContinuationToken is obfuscated and is not a real key - - - - - NextContinuationToken is sent when isTruncated is true which means there - are more keys in the bucket that can be listed. The next ListObjectV2 call - to Amazon S3 can be continued with this NextContinuationToken. - NextContinuationToken is obfuscated and is not a real key. - - - - - StartAfter is where you want Amazon S3 to start listing from. - Amazon S3 starts listing after this specified key. - StartAfter can be any key in the bucket. - - - - - Container for the parameters to the ListParts operation. - Lists the parts that have been uploaded for a specific multipart upload. - - - - - Name of the bucket to which the parts are being uploaded. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The object key for which the multipart upload was initiated. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Sets the maximum number of parts to return. - - - - - - Specifies the part after which listing should begin. Only parts with higher part numbers will be listed. - - - - - - Upload ID identifying the multipart upload whose parts are being listed. - - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the ListParts response and response metadata. - - - - - Name of the bucketName to which the multipart upload was initiated. - - - - - - Object key for which the multipart upload was initiated. - - - - - - Upload ID identifying the multipart upload whose parts are being listed. - - - - - - Part number after which listing begins. - - - - - - When a list is truncated, this element specifies the last part in the list, as well as the value to use for the part-number-marker request - parameter in a subsequent request. - - - - - - Maximum number of parts that were allowed in the response. - - - - - - Indicates whether the returned list of parts is truncated. - - - - - - Gets and sets the Parts property. - - PartDetails is a container for elements related to a particular part. A response can contain - zero or more Part elements. - - - - - - Identifies who initiated the multipart upload. - - - - - - Gets and sets the Owner property. - - - - - The class of storage used to store the object. - - - - - - Date when multipart upload will become eligible for abort operation by lifecycle. - - - - - Id of the lifecycle rule that makes a multipart upload eligible for abort operation. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the ListVersions operation. - Returns metadata about all of the versions of objects in a bucket. - - - - - The bucket name that contains the objects. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - A delimiter is a character you use to group keys. - - - - - Specifies the key to start with when listing objects in a bucket. - - - - - Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more. - - - - - Limits the response to keys that begin with the specified prefix. - - - - - Specifies the object version you want to start listing from. - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - Returns information about the ListVersions response and response metadata. - - - - - A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria. If your results were - truncated, you can make a follow-up paginated request using the NextKeyMarker and NextVersionIdMarker response parameters as a starting - place in another request to return the rest of the results. - - - - - - Marks the last Key returned in a truncated response. - - - - - - Gets and sets the VersionIdMarker property. - Marks the last Version-Id returned in a truncated response. - - - - - Use this value for the key marker request parameter in a subsequent request. - - - - - - Use this value for the next version id marker parameter in a subsequent request. - - - - - - Gets and sets the Versions property. This is a list of - object versions in the bucket that match your search criteria. - - - - - Gets and sets the Name property. - The bucket's name. - - - - - Gets and sets the Prefix property. - Keys that begin with the indicated prefix are listed. - - - - - Gets and sets the MaxKeys property. - This is the maximum number of keys in the S3ObjectVersions collection. - The value is derived from the MaxKeys parameter to ListVersionsRequest. - - - - - Gets the CommonPrefixes property. - A response can contain CommonPrefixes only if you specify a delimiter. - When you do, CommonPrefixes contains all (if there are any) keys between - Prefix and the next occurrence of the string specified by delimiter. - - - - - Gets and sets the Delimiter property. - Causes keys that contain the same string between the prefix and the - first occurrence of the delimiter to be rolled up into a single result - element in the CommonPrefixes collection. - - - These rolled-up keys are not returned elsewhere in the response. - - - - - This class contains the meta data for an S3 object. - - - - - Gets and sets meta data for the object. Meta data names must start with "x-amz-meta-". If the name passeed in as the indexer - doesn't start with "x-amz-meta-" then it will be prepended. - - The name of the meta data. - The value for the meta data - - - - Adds the metadata to the collection, if the name already exists it will be overwritten. - - The name of the metadata element - The value for the metadata - - - - Gets the count of headers. - - - - - Gets the names of the meta data elements. - - - - - A metadata key-value pair to store with an object. - - - - - Key of metadata key-value pair - - - - - Value of metadata key-value pair - - - - - A container specifying replication metrics-related information, including whether - emitting metrics and Amazon S3 events for replication are enabled. In addition, contains - configurations related to specific metrics or events. Must be specified together with a - ReplicationTime block. - - - - - Specifies whether the replication metrics are enabled. - - - - - A container specifying the time threshold for emitting the - s3:Replication:OperationMissedThreshold event. - - - - - Class for MetricsAndOperatorPredicate - A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. - The operator must have at least two predicates, and an object must match all of the predicates - in order for the filter to apply. - - Note: The current implementation restricts the usage to atmost one MetricsPrefixPredicate - and any number of MetricsTagPredicates. - - - - Class for MetricsConfiguration - - - - - The ID used to identify the metrics configuration. - - - - - Specifies a metrics configuration filter. - The metrics configuration will only include objects that meet the filter's criteria. - A filter must be a prefix, a tag, or a conjunction (MetricsAndOperator). - - - - - Filter class for Metrics. - - - - - Filter Predicate setup for specific filter types. - - - - - Filter Predicate abstract class for specific filter types to be derived from. - - - - - Abstract class that can be used over logical filter predicates,i.e. AND/OR. - - - - - Class for MetricsPrefixPredicate - The prefix used when evaluating a metrics filter. - - - - - Class for MetricsTagPredicate - The tag used when evaluating a metrics filter. - - - - - This class contains the mfa codes used authentication - - - - - Gets and sets the serial number of the authentication device - - - - - Gets and sets the displated value on the authentication device - - - - - The formatted string of the mfa codes to be passed to S3. - - - - - Container for elements related to a particular multipart upload. - - - - - Date and time at which the multipart upload was initiated. - - - - - - Identifies who initiated the multipart upload. - - - - - - Key of the object for which the multipart upload was initiated. - - - - - - Gets and sets the Owner property. - - - - - The class of storage used to store the object. - - - - - - Upload ID that identifies the multipart upload. - - - - - - An abstract class for all the notification configurations associated with an Amazon S3 bucket. - - - - - Gets and sets the Events property. These are the events the configuration will listen to. - - - - - Filter criteria for determining which S3 objects trigger event notifications. - - - - - - The container element for Object Lock configuration parameters. - - - - - Gets and sets the property ObjectLockEnabled. - - Indicates whether this object has an Object Lock configuration enabled. - - - - - - Gets and sets the property Rule. - - The Object Lock rule in place for the specified object. - - - - - - A Legal Hold configuration for an object. - - - - - Gets and sets the property Status. - - Indicates whether the specified object has a Legal Hold in place. - - - - - - A Retention configuration for an object. - - - - - Gets and sets the property Mode. - - Indicates the Retention mode for the specified object. - - - - - - Gets and sets the property RetainUntilDate. - - - - - The container element for an Object Lock rule. - - - - - Gets and sets the property DefaultRetention. - - The default retention period that you want to apply to new objects placed in the specified - bucket. - - - - - - Describes the location where the restore job's output is stored. - - - - - Describes an S3 location that will receive the results of the restore request. - - - - - Describes how results of the Select job are serialized. - - - - - Describes the serialization of CSV-encoded Select results. - - - - - Specifies JSON as request's output serialization format. - - - - - The owner of an S3 bucket. - - - - - The display name of the owner. - - - - - The unique identifier of the owner. - - - - - This class contains custom querystring parameters for an S3 object, which can then be signed as part of a Pre-signed URL request - - - - - Gets and sets parameters for the object. Parameter names must start with "x-". If the name passeed in as the indexer - doesn't start with "x-" then it will be prepended. - - The name of the parameter. - The value for the meta data - - - - Adds the parameter to the collection, if the name already exists it will be overwritten. - - The name of the parameter - The value for the parameter - - - - Gets the count of parameters. - - - - - Gets the names of the parameter elements. - - - - - Specifies Parquet as object's input serialization format. - - - - - A container for elements related to a particular part in a multipart operation. - A response can contain zero or more Part elements. - - - - - The date and time at which the part was uploaded. - - - - - The size of the uploaded part data. - - - - - A container holding the part number and etag used when completing a multipart upload. - - - - - Default constructor. - - - - - Constructs an instance of PartETag and sets the part number and etag. - - The part number. - the associated ETag for the part number. - - - - Compares the current object with another object of the same type. - - An object to compare with this object. - - A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has the following meanings: - Value - Meaning - Less than zero - This object is less than the parameter. - Zero - This object is equal to . - Greater than zero - This object is greater than . - - - - - The part number identifying the part. - - - - - The entity tag associated with the part. - - - - - The container element for this bucket's public-policy status. - - - - - Gets and sets the property IsPublic. - - The public-policy status for this bucket. TRUE indicates that this bucket - is public. FALSE indicates that the bucket is not public. - - - - - - The container element for all Public Access Block configuration options. You can enable - the configuration options in any combination. - - - - Amazon S3 considers a bucket policy public unless at least one of the following conditions - is true: - -
  1. - - The policy limits access to a set of CIDRs using aws:SourceIp. For more - information on CIDR, see http://www.rfc-editor.org/rfc/rfc4632.txt - - -
  2. - - The policy grants permissions, not including any "bad actions," to one of the following: - -
    • - - A fixed AWS principal, user, role, or service principal - -
    • - - A fixed aws:SourceArn - -
    • - - A fixed aws:SourceVpc - -
    • - - A fixed aws:SourceVpce - -
    • - - A fixed aws:SourceOwner - -
    • - - A fixed aws:SourceAccount - -
    • - - A fixed value of s3:x-amz-server-side-encryption-aws-kms-key-id - -
    • - - A fixed value of aws:userid outside the pattern "AROLEID:*" - -
- - "Bad actions" are those that could expose the data inside a bucket to reads or writes - by the public. These actions are s3:Get*, s3:List*, s3:AbortMultipartUpload, - s3:Delete*, s3:Put*, and s3:RestoreObject. - - - - The star notation for bad actions indicates that all matching operations are considered - bad actions. For example, because s3:Get* is a bad action, s3:GetObject, - s3:GetObjectVersion, and s3:GetObjectAcl are all bad actions. - - - - - - Gets and sets the property BlockPublicAcls. - - Specifies whether Amazon S3 should block public ACLs for this bucket. Setting this - element to TRUE causes the following behavior: - -
  • - - PUT Bucket acl and PUT Object acl calls will fail if the specified ACL allows public - access. - -
  • - - PUT Object calls will fail if the request includes an object ACL. - -
- - Note that enabling this setting doesn't affect existing policies or ACLs. - - - - - - Gets and sets the property IgnorePublicAcls. - - Specifies whether Amazon S3 should ignore public ACLs for this bucket. Setting this - element to TRUE causes Amazon S3 to ignore all public ACLs on this bucket - and any objects that it contains. - - - - Note that enabling this setting doesn't affect the persistence of any existing ACLs - and doesn't prevent new public ACLs from being set. - - - - - - Gets and sets the property BlockPublicPolicy. - - Specifies whether Amazon S3 should block public bucket policies for this bucket. Setting - this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy - if the specified bucket policy allows public access. - - - - Note that enabling this setting doesn't affect existing bucket policies. - - - - - - Gets and sets the property RestrictPublicBuckets. - - Specifies whether Amazon S3 should restrict public bucket policies for this bucket. - If this element is set to TRUE, then only the bucket owner and AWS Services - can access this bucket if it has a public policy. - - - - Note that enabling this setting doesn't affect previously stored bucket policies, - except that public and cross-account access within any public bucket policy, including - non-public delegation to specific accounts, is blocked. - - - - - - Container for the parameters to the PutAcl operation. - uses the acl subresource to set the access control list (ACL) permissions for an object that already exists in a bucket - - - - - The canned ACL to apply to the bucket. - - - - - - Custom ACLs to be applied to the bucket or object. - - - - - The bucket name that contains the object to which you want to attach the ACL. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The key of an S3 object. - If not specified, the ACLs are applied to the bucket. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - If set and an object key has been specified, the ACLs are applied - to the specific version of the object. - This property is ignored if the ACL is to be set on a Bucket. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - Returns information about the PutObjectAcl response metadata. - The PutAcl operation has a void result type. - - - - - The response for the PutBucketAccelerateConfiguration operation. - Adds an object to a bucket. - - - - - Container for the parameters to the PutBucketAccelerateConfiguration request. - - - - - The name of the bucket to contain the object. - - - - - Accelerate configuration for the bucket. - - - - - Container for the parameters to the PutBucketAnalyticsConfiguration operation. - Sets an analytics configuration for the bucket (specified by the analytics configuration ID). - - - - - The name of the bucket to which an analytics configuration is stored. - - - - - The identifier used to represent an analytics configuration. - - - - - The configuration and any analyses for the analytics filter. - - - - - Returns information about the PutBucketAnalyticsConfigurationResponse response metadata. - The PutBucketAnalyticsConfigurationResponse operation has a void result type. - - - - - Container for the parameters to the PutBucketRequestPayment operation. - Creates a new server-side encryption configuration (or replaces an existing one, if present). - - - - - The name of the bucket for which the server-side encryption configuration is set. - - - - - The base64-encoded 128-bit MD5 digest of the server-side encryption configuration. - - - This header can be used as a message integrity check to verify that the data is the same data that was originally sent. - Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. - - - - - Container for server-side encryption configuration rules. Currently S3 supports one rule only. - - - - - Container for the parameters to the PutBucketRequestPayment operation. - Adds an inventory configuration (identified by the inventory ID) from the bucket. - - - - - The name of the bucket where the inventory configuration will be stored. - - - - - Specifies the inventory Id. - - - - - Specifies the inventory configuration. - - - - - Returns information about the PutInventoryConfigurationResponse response metadata. - The PutInventoryConfigurationResponse operation has a void result type. - - - - - Container for the parameters to the PutBucketLoggingRequest operation. - Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. To set the - logging status of a bucket, you must be the bucket owner. - - - - - Gets and sets the BucketName property. - - - - - Gets and sets the LoggingConfig property. - - - - - Returns information about the PutBucketLogging response metadata. - The EnableBucketLogging operation has a void result type. - - - - - Container for the parameters to the PutBucketMetricsConfigurationRequest operation. - Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. - - - - - The name of the bucket for which the metrics configuration is set. - - - - - The ID used to identify the metrics configuration. - - - - - Specifies the metrics configuration. - - - - - Returns information about the PutBucketMetricsConfiguration response metadata. - The PutBucketMetricsConfiguration operation has a void result type. - - - - - Container for the parameters to the PutBucketNotification operation. - Enables notifications of specified events for a bucket. - - - - - Gets and sets the BucketName property. - - - - - Gets and sets the TopicConfigurations property. TopicConfigurations are configuration for Amazon S3 - events to be sent to Amazon SNS topics. - - - - - Gets and sets the QueueConfigurations property. QueueConfigurations are configuration for Amazon S3 - events to be sent to Amazon SQS queues. - - - - - Gets and sets the LambdaFunctionConfigurations property. LambdaFunctionConfigurations are configuration for - Amazon S3 events to be sent to an Amazon Lambda cloud function. - - - - - Returns information about the PutBucketNotification response metadata. - The PutBucketNotification operation has a void result type. - - - - - Container for the parameters to the PutBucketPolicy operation. - Replaces a policy on a bucket. If the bucket already has a policy, the one in this request completely replaces it. - - - - - The name of the bucket. - - - - - The base64 encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. - - - This header can be used as a message integrity check to verify that the data is the same data that was originally sent. - Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. - - - - - The bucket policy as a JSON document. - - - - - Set this parameter to true to confirm that you want to remove your - permissions to change this bucket policy in the future. - - - - - Overriden to turn off sending SHA256 header. - - - - - Returns information about the PutBucketPolicy response metadata. - The PutBucketPolicy operation has a void result type. - - - - - Container for the parameters to the PutBucketReplication operation. - Sets replication configuration for your bucket. If a replication configuration exists, this replaces it. - - - - - The name of the bucket to have the replication configuration applied. - - - - - The replication configuration to be applied. - - - - - Gets and sets the property Token. - - - - - Returns information about the PutBucketReplicationConfiguration response metadata. - The PutBucketReplicationConfiguration operation has a void result type. - - - - - Container for the parameters to the PutBucket operation. - Creates a new bucket. - - - - - The canned ACL to apply to the bucket. - - - - - - If set to true the bucket will be created in the same region - as the configuration of the AmazonS3 client. - If PutBucketRequest.BucketRegion or PutBucketRequest.BucketRegionName are set they take precedence over - this property. - Default: true. - - - - - The name of the bucket to be created. - - - - - The region locality for the bucket. - - - When set, this will determine where your data will - reside in S3. Refer - for a list of possible values. - - - - - The bucket region locality expressed using the name of the region. - When set, this will determine where your data will reside in S3. - Valid values: us-east-1, us-west-1, us-west-2, eu-west-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, sa-east-1 - - - - - Gets and sets the property ObjectLockEnabledForBucket. - - Specifies whether you want S3 Object Lock to be enabled for the new bucket. - - - - - - Container for the parameters to the PutBucketRequestPayment operation. - Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This - configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the - download. - - - - - The name of the bucket to set payment config. - - - - - Gets and sets request payment configuration - - - - - Returns information about the PutBucketRequestPayment response metadata. - The PutBucketRequestPayment operation has a void result type. - - - - - Returns information about the PutBucket response and response metadata. - - - - - Container for the parameters to the PutBucketTagging operation. - Sets the tags for a bucket. - - - - - The name of the bucket to apply the tags to. - - - - - The collection of tags. - - - - - Returns information about the PutBucketTagging response metadata. - The PutBucketTagging operation has a void result type. - - - - - Container for the parameters to the PutBucketVersioning operation. - Sets the versioning state of an existing bucket. To set the versioning state, you must be the bucket owner. - - - - - The name of the bucket to be updated. - - - - - The MfaCodes Tuple associates the Serial Number and the current Token/Code displayed on the - Multi-Factor Authentication device associated with your AWS Account. - - - This is a required property for this request if:
- 1. EnableMfaDelete was configured on the bucket - containing this object's version.
- 2. You are deleting an object's version - - - - - Checks if the MfaCodes property is set. - - true if the MfaCodes property is set. - - - - The versioning configuration to apply to the bucket. - - - Once Versioning has been "Enabled" on a bucket, it can be "Suspended" - but cannot be switched "Off". If EnableMfaDelete is set, - the MfaCodes property needs to contain the Serial of and current Token - displayed on the MFA device. - - - - - Returns information about the PutBucketVersioning response metadata. - The PutBucketVersioning operation has a void result type. - - - - - Container for the parameters to the PutBucketWebsite operation. - Set the website configuration for a bucket. - - - - - The name of the bucket to apply the configuration to. - - - - - The website configuration to apply. The configuration defines the index - document suffix and custom error page. - - - - - Returns information about the PutBucketWebsite response metadata. - The PutBucketWebsite operation has a void result type. - - - - - Container for the parameters to the PutCORSConfiguration operation. - Sets the cors configuration for a bucket. - - - - - The name of the bucket to have the CORS configuration applied. - - - - - The CORS configuration to apply. - - - - - Returns information about the PutCORSConfiguration response metadata. - The PutCORSConfiguration operation has a void result type. - - - - - Container for the parameters to the PutLifecycleConfiguration operation. - Sets lifecycle configuration for your bucket. If a lifecycle configuration exists, it replaces it. - - - - - The name of the bucket to have the lifecycle configuration applied. - - - - - The lifecycle configuration to be applied. - - - - - Returns information about the PutLifecycleConfiguration response metadata. - The PutLifecycleConfiguration operation has a void result type. - - - - - Container for the parameters to the PutObjectLegalHold operation. - Applies a Legal Hold configuration to the specified object. - - - - - The bucket name containing the object that you want to place a Legal Hold on. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property ContentMD5. - - The MD5 signature for the configuration included in your request. - - - - - - Gets and sets the property Key. - - The key name for the object that you want to place a Legal Hold on. - - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Gets and sets the property LegalHold. - - Container element for the Legal Hold configuration you want to apply to the specified - object. - - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property VersionId. - - The version ID of the object that you want to place a Legal Hold on. - - - - - - This is the response object from the PutObjectLegalHold operation. - - - - - Gets and sets the property RequestCharged. - - - - - Container for the parameters to the PutObjectLockConfiguration operation. - Places an Object Lock configuration on the specified bucket. The rule specified in - the Object Lock configuration will be applied by default to every new object placed - in the specified bucket. - - - - - Gets and sets the property BucketName. - - The bucket whose Object Lock configuration you want to create or replace. - - - - - - Gets and sets the property ContentMD5. - - The MD5 signature for the configuration included in your request. - - - - - - Gets and sets the property ObjectLockConfiguration. - - The Object Lock configuration that you want to apply to the specified bucket. - - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property Token. - - - - - This is the response object from the PutObjectLockConfiguration operation. - - - - - Gets and sets the property RequestCharged. - - - - - Container for the parameters to the PutObject operation. - Adds an object to a bucket. - - - Container for the parameters to the PutObject operation. - Adds an object to a bucket. - - - - - A canned access control list (CACL) to apply to the object. - Please refer to for - information on S3 Canned ACLs. - - - - - Input stream for the request; content for the request will be read from the stream. - - - - - - The full path and name to a file to be uploaded. - If this is set the request will upload the specified file to S3. - - - For WinRT and Windows Phone this property must be in the form of "ms-appdata:///local/file.txt". - - - - - - Text content to be uploaded. Use this property if you want to upload plaintext to S3. - The content type will be set to 'text/plain'. - - - - - If this value is set to true then the stream used with this request will be closed when all the content - is read from the stream. - Default: true. - - - - - If this value is set to true then the stream will be seeked back to the start before being read for upload. - Default: true. - - - - - If this value is set to true then a chunked encoding upload will be used for the request. - Default: true. - - - - - Bucket name to which the PUT operation was initiated. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - Gets and sets Key property. This key is used to identify the object in S3. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - Checks if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - true if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - - - The type of storage to use for the object. Defaults to 'STANDARD'. - - - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - The Legal Hold status that you want to apply to the specified object. - - - - - - Gets and sets the property ObjectLockMode. - - The Object Lock mode that you want to apply to this object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - The date and time when you want this object's Object Lock to expire. - - - - - - If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - Attach a callback that will be called as data is being sent to the AWS Service. - - - - - This is a convenience property for Headers.ContentType. - - - - - An MD5 digest for the content. - - - - The base64 encoded 128-bit MD5 digest of the message - (without the headers) according to RFC 1864. This header - can be used as a message integrity check to verify that - the data is the same data that was originally sent. - - - If supplied, after the file has been uploaded to S3, - S3 checks to ensure that the MD5 hash of the uploaded file - matches the hash supplied. - - - Although it is optional, we recommend using the - Content-MD5 mechanism as an end-to-end integrity check. - - - - - - Checks if MD5Digest property is set. - - true if MD5Digest property is set. - - - - Overriden to turn off sending SHA256 header. - - - - - Overriden to turn on expect 100 continue. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - The tag-set for the object. The tag-set must be encoded as URL Query parameters. - - - - - Checks if Tagging property is set - - true if Tagging is set. - - - - Returns information about the PutObject response and response metadata. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - Entity tag for the uploaded object. - - - - - - Version of the object. - - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the PutObjectRetention operation. - Places an Object Retention configuration on an object. - - - - - The bucket name that contains the object you want to apply this Object Retention configuration to. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property BypassGovernanceRetention. - - - - - Gets and sets the property ContentMD5. - - The MD5 signature for the configuration included in your request. - - - - - - Gets and sets the property Key. - - The key name for the object that you want to apply this Object Retention configuration - to. - - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property Retention. - - The container element for the Object Retention configuration. - - - - - - Gets and sets the property VersionId. - - The version ID for the object that you want to apply this Object Retention configuration - to. - - - - - - This is the response object from the PutObjectRetention operation. - - - - - Gets and sets the property RequestCharged. - - - - - Container for the parameters to the PutObjectTagging operation. - - - - - The bucket name containing the object. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Check to see if Bucket property is set - - - - - Gets and sets Key property. This key is used to identify the object in S3. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Check to see if Key property is set - - - - - The tag-set for the object. The tag-set must be encoded as URL Query parameters - - - - - Checks if Tagging property is set. - - - - - VersionId used to reference a specific version of the object. - - - - - - Returns information about the PutObjectTagging response and response metadata. - - - - - Version of the object. - - - - - Container for the parameters to the PutPublicAccessBlock operation. - Creates or modifies the Public Access Block configuration for an Amazon S3 bucket. - - - - - Gets and sets the property BucketName. - - The name of the Amazon S3 bucket whose Public Access Block configuration you want - to set. - - - - - - Gets and sets the property ContentMD5. - - The MD5 hash of the PutPublicBlock request body. - - - - - - Gets and sets the property PublicAccessBlockConfiguration. - - The Public Access Block configuration that you want to apply to this Amazon S3 bucket. - - - - - - This is the response object from the PutPublicAccessBlock operation. - - - - - Base class for put operations that can also put an ACL. - - - - - Gets the access control lists (ACLs) for this request. - Please refer to for information on - S3 Grants. - - - - - This class contains the configuration Amazon S3 uses to figure out what events you want to listen - and send the event to an Amazon SQS queue. - - The queue's policy must allow S3 to send messages to it. The utility method - Amazon.SQS.AmazonSQSClient.AuthorizeS3ToSendMessage(string,string) - can be used to help setup the queue policy. - - - - - - Gets and set the Id property. The Id will be provided in the event content and can be used - to identify which configuration caused an event to fire. If the Id is not provided for the configuration, one will be generated. - - - - - Gets and sets the Queue property. Amazon SQS queue to which Amazon S3 will publish a message - to report the specified events for the bucket. - - The queue's policy must allow S3 to send messages to it. The utility method - Amazon.SQS.AmazonSQSClient.AuthorizeS3ToSendMessage(string,string) - can be used to help setup the queue policy. - - - - - - This class defines the configuration for replication. - - - - - Indicates the ARN of the role to assume. - - - - - Check to see if the Role property is set. - - true if the Role property is set. - - - - Container for information about a particular replication rule. - Replication configuration must have at least one rule and can contain up to 1,000 rules. - - - - - Checks to see if the Rules property is set. - - true if the Rules property is set. - - - - Destination configuration for a replication rule. - - - - -

Amazon resource name (ARN) of the bucket where you want Amazon - S3 to store replicas of the object identified by the rule.

- If you have multiple rules in your replication configuration, all - rules must specify the same bucket as the destination. A replication - configuration can replicate objects only to one destination bucket.

- - - - - Checks to see if BucketArn property is set. - - true if BucketArn property is set. - - - - The class of storage used to store the object. - - - - - -

Account ID of the destination bucket. Currently Amazon S3 verifies this - value only if Access Control Translation is enabled.

In a cross-account - scenario, if you tell Amazon S3 to change replica ownership to the AWS account - that owns the destination bucket by adding the AccessControlTranslation - element, this is the account ID of the destination bucket owner.

- - - - -

Container for information regarding the access control for replicas.

-

Use only in a cross-account scenario, where source and destination bucket - owners are not the same, when you want to change replica ownership to the AWS - account that owns the destination bucket. If you don't add this element to the - replication configuration, the replicas are owned by same AWS account that - owns the source object.

- - - - -

Container that provides encryption-related information. You must - specify this element if the SourceSelectionCriteria is - specified.

- - - - - A container specifying the time when all objects and operations on objects are - replicated. Must be specified together with a Metrics block. - - - - - A container specifying replication metrics-related information, including whether - emitting metrics and Amazon S3 events for replication are enabled. In addition, - contains configurations related to specific metrics or events. Must be specified - together with a ReplicationTime block. - - - - - Rule that specifies the replication configuration. - - - - - Unique identifier for the rule. The value cannot be longer than 255 characters. - - - - - Checks to see if Id property is set. - - true if Id property is set. - - - -

The priority associated with the rule. If you specify multiple rules in a - replication configuration, then Amazon S3 applies rule priority in the event - there are conflicts (two or more rules identify the same object based on - filter specified). The rule with higher priority takes precedence. For - example,

  • Same object quality prefix based filter criteria - If prefixes you specified in multiple rules overlap.

  • Same - object qualify tag based filter criteria specified in multiple rules

    • -

For more information, see - - Cross-Region Replication (CRR) in the Amazon S3 Developer Guide.

- - - - - Checks to see if Priority property is set. - - true if Priority property is set. - - - - Object keyname prefix identifying one or more objects to which the - rule applies. Maximum prefix length can be up to 1,024 characters. - - - - - Checks to see if Prefix property is set. - - true if Prefix property is set. - - - - Gets and sets the property Filter. - - - - - Checks to see if Filter property is set. - - true if Filter property is set. - - - - Whether the rule is applied or ignored. - - - - - Checks to see if Status property is set. - - true if Status property is set. - - - - Container for replication destination information. - - - - - Checks to see if Destination property is set. - - true if Destination property is set. - - - -

Container that describes additional filters in identifying source objects that - you want to replicate. Currently, Amazon S3 supports only the filter that you can - specify for objects created with server-side encryption using an AWS KMS-managed - key. You can choose to enable or disable replication of these objects.

if - you want Amazon S3 to replicate objects created with server-side encryption using - AWS KMS-managed keys.

- - - - - A container that specifies information about existing object replication. - You can choose whether to enable or disable the replication of existing objects. - - - - - Checks to see if ExistingObjectReplication property is set. - - true if ExistingObjectReplication property is set. - - - - Specifies whether Amazon S3 should replicate delete makers. - - - - - Checks to see if DeleteMarkerReplication property is set. - - true if DeleteMarkerReplication property is set. - - - - - - - - Object keyname prefix that identifies subset of objects to which the rule applies. - - - - - Checks to see if Prefix property is set. - - true if Prefix property is set. - - - - All of these tags must exist in the object's tag set in order for the rule to apply. - - - - - Checks to see if Tags property is set. - - true if Tags property is set. - - - - Filter that identifies subset of objects to which the replication rule applies. - A Filter must specify exactly one Prefix, - Tag, or an And child element. - - - - - Object keyname prefix that identifies subset of objects to which the rule applies. - - - - - Checks to see if Prefix property is set. - - true if Prefix property is set. - - - -

Container for specifying a tag key and value.

-

The rule applies only to objects having the tag in its tagset.

- - - - - Checks to see if Tag property is set. - - true if Tag property is set. - - - -

Container for specifying rule filters. These filters determine the - subset of objects to which the rule applies. The element is required - only if you specify more than one filter. For example:

  • -

    You specify both a Prefix and a Tag - filters. Then you wrap these in an And tag.

    • -

  • You specify filter based on multiple tags. Then you wrap the - Tag elements in an And tag.

- - - - - Checks to see if And property is set. - - true if And property is set. - - - - A container specifying the time when all objects and operations on objects are replicated. Must be specified together with a Metrics block. - - - - - Specifies whether the replication time is enabled. - - - - - A container specifying the time by which replication should complete for all objects and operations on objects. - - - - - A container specifying the time value. - - - - - Contains an integer specifying time in minutes. - - - - - Request Payment Configuration - - - - - Specifies who pays for the download and request fees. - - - - - Container for values of the response headers that will be set on a response from a GetObject request. - These values override any headers that were set when the object was uploaded to S3. - - - - - A standard MIME type describing the format of the object data. - - - The content type for the content being uploaded. This property defaults to "binary/octet-stream". - For more information, refer to: - - - - - ContentLanguage header value. - - - - - Expiry header value. - - - - - CacheControl header value. - - - - - The ContentDisposition header value. - - - - - The ContentEncoding header value. - - - - - Container for the parameters to the RestoreObject operation. - Restores an archived copy of an object back into Amazon S3 - - - - - The bucket name or containing the object to restore. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the Key property. This key indicates the S3 object to restore. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Lifetime of the active copy in days - ** Do not use with restores that specify OutputLocation ** - - - - - VersionId used to reference a specific version of the object. - - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Glacier retrieval tier at which the restore will be processed. - ** Do not use with restores that specify OutputLocation ** - - - - - Glacier retrieval tier at which the restore will be processed. - ** Only use with restores that require OutputLocation ** - - - - - Type of restore request. - - - - - The optional description for the job. - - - - - Describes the parameters for Select job types. - - - - - Describes the location where the restore job's output is stored. - - - - - Returns information about the RestoreObject response metadata. - The RestoreObject operation has a void result type. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Indicates the path in the provided S3 output location where Select results will be restored to. - - - - Routing Rule - - - - - A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the - /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might - process the error. - - - - - - Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event of an - error, you can can specify a different error code to return. - - - - - - A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages - in the /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you - might process the error. - - - - - The HTTP error code when the redirect is applied. In the event of an error, if the error code equals this value, then the specified redirect - is applied. Required when parent element Condition is specified and sibling KeyPrefixEquals is not specified. If both are specified, then - both must be true for the redirect to be applied. - - - - - - The object key name prefix when the redirect is applied. For example, to redirect requests for ExamplePage.html, the key prefix will be - ExamplePage.html. To redirect request for all pages with the prefix docs/, the key prefix will be /docs, which identifies all objects in the - docs/ folder. Required when the parent element Condition is specified and sibling HttpErrorCodeReturnedEquals is not specified. If both - conditions are specified, both must be true for the redirect to be applied. - - - - - - Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event - of an error, you can can specify a different error code to return. - - - - - Name of the host where requests will be redirected. - - - - - - The HTTP redirect code to use on the response. Not required if one of the siblings is present. - - - - - - Protocol to use (http, https) when redirecting requests. The default is the protocol that is used in the original request. - - - - - - The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix docs/ (objects in the - docs/ folder) to documents/, you can set a condition block with KeyPrefixEquals set to docs/ and in the Redirect set ReplaceKeyPrefixWith to - /documents. Not required if one of the siblings is present. Can be present only if ReplaceKeyWith is not provided. - - - - - - The specific object key to use in the redirect request. For example, redirect request to error.html. Not required if one of the sibling is - present. Can be present only if ReplaceKeyPrefixWith is not provided. - - - - - - Represents an access control list (ACL) for S3. An AccessControlList is represented by an Owner, - and a List of Grants, where each Grant is a Grantee and a Permission. - - - - Each bucket and object in Amazon S3 has an ACL that defines its access control policy. - When a request is made, Amazon S3 authenticates the request using its standard - authentication procedure and then checks the ACL to verify the sender was granted access - to the bucket or object. If the sender is approved, the request proceeds. - Otherwise, Amazon S3 returns an error. - - - An ACL is a list of grants. A grant consists of one grantee and one permission. - ACLs only grant permissions; they do not deny them. - - - For convenience, some commonly used Access Control Lists are defined in - S3CannedACL. - - - Note: BucketName and object ACLs are completely independent; an object does not inherit the ACL - from its bucket. For example, if you create a bucket and grant write access to another user, - you will not be able to access the user's objects unless the user explicitly grants access. - This also applies if you grant anonymous write access to a bucket. Only the user "anonymous" - will be able to access objects the user created unless permission is explicitly granted to - the bucket owner. - - - Important: We highly recommend that you do not grant the anonymous group write access to your - buckets as you will have no control over the objects others can store and their associated charges. - For more information, see Grantees and Permissions - - - - - Creates a S3Grant and adds it to the list of grants. - - The grantee for the grant. - The permission for the grantee. - - - - Removes a specific permission for the given grantee. - - The grantee - The permission for the grantee to remove - - - - Removes all permissions for the given grantee. - - - - - - The owner of the bucket or object. - - - - Every bucket and object in Amazon S3 has an owner, the user that - created the bucket or object. The owner of a bucket or object cannot - be changed. However, if the object is overwritten by another user - (deleted and rewritten), the new object will have a new owner. - - - Note: Even the owner is subject to the ACL. For example, if an owner - does not have Permission.READ access to an object, the owner cannot read - that object. However, the owner of an object always has write access to the - access control policy (Permission.WriteAcp) and can change the ACL to - read the object. - - - - - - Checks if Owner property is set. - - true if Owner property is set. - - - - A collection of grants. - - - - - Checks if Grants property is set. - - true if Grants property is set. - - - Bucket - Represents an S3 bucket, contains the name of the S3 bucket and the date that the bucket was created. - - - - - Date the bucket was created. - - - - - - The name of the bucket. - - - - - Logging Enabled - - - - - Specifies the bucket where you want Amazon S3 to store server access logs. You can have your logs delivered to any bucket that you own, - including the same bucket that is being logged. You can also configure multiple buckets to deliver their logs to the same target bucket. In - this case you should choose a different TargetPrefix for each source bucket so that the delivered log files can be distinguished by key. - - - - - A collection of grants. - - - - - This element lets you specify a prefix for the keys that the log files will be stored under. - - - - - Creates a S3Grant and adds it to the list of grants. - - The grantee for the grant. - The permission for the grantee. - - - - Removes a specific permission for the given grantee. - - The grantee - The permission for the grantee to remove - - - - Removes all permissions for the given grantee. - - - - - - An S3 bucket versioning configuration. - - - Contains the bucket's versioning status (Off, Enabled, Suspended) and whether an MFADelete - has been enabled for the bucket. - - - - - Versioning status for the bucket. - Accepted values: Off, Enabled, Suspended. - - - - - Checks if Status property is set - - true if Status property is set - - - - Specifies whether MFA Delete is enabled on this S3 Bucket. - - - If this property is set, please ensure that the - PutBucketVersioningRequest's MfaCodes property is set with - the Serial of and Token on the MFA device. - - - - - Checks if EnableMfaDelete property is set. - - true if Status property is set - - - - Describes the server-side encryption that will be applied to the restore results. - - - - - The server-side encryption algorithm used when storing job results in Amazon S3 (e.g., AES256, aws:kms). - - - - - Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by - AWS KMS will fail if not made via SSL or using SigV4. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at - http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version - - - - - If the encryption type is aws:kms, this optional value can be used to specify the encryption context for the restore results. - - - - Grant - - - - - The grantee details. - - - - - Specifies the permission given to the grantee. - - - - - Grantee - - - - - Type of grantee - - - - - - Screen name of the grantee. - - - - - - Email address of the grantee. - - - - - - The canonical user ID of the grantee. - - - - - - URI of the grantee group. - - - - - - Filter criteria that allows for event notification filtering based on an S3 Object's key name. - - - - - Gets and sets the filterRules property. - These are the filter rules for this filter. - - - - - Describes an S3 location that will receive the results of the restore request. - - - - - The name of the bucket where the restore results will be placed. - - - - - The prefix that is prepended to the restore results for this request. - - - - - The canned ACL to apply to the restore results. - - - - - A list of grants that control access to the staged results. - - - - - The tag-set that is applied to the restore results. - - - - - A map of metadata to store with the restore results in S3. - - - - - The class of storage used to store the restore results. - - - - - Represents an S3 Object. Contains all attributes that an S3 Object has. - For more information about S3 Objects refer: - - - - - - Any ETag set on the object. - - - - - The name of the bucket containing this object. - - - - - The key of the object. - - - - - The date and time the object was last modified. - - The date retrieved from S3 is in ISO8601 format. A GMT formatted date is passed back to the user. - - - - - - The owner of the object. - - - - - The size of the object. - - - - - The class of storage used to store the object. - - - - - - Represents a version of an object in an S3 Bucket. An S3 object version is an S3 object - that also has a version identifier, an indication of whether this is the latest version of the object - and whether it's a DeleteMarker or not. - - - - - Specifies whether the object is (true) or is not (false) the latest version of an object. - - - - - Version ID of an object. - - - - - If true, the object is a delete marker for a deleted object. - - - - - Specifies the byte range of the object to get the records from. A record is processed when its first byte is contained by the range. - - - - - Specifies the start of the byte range. This parameter is optional. Valid values: non-negative integers. The default value is 0. - - - - - Specifies the end of the byte range. This parameter is optional. Valid values: non-negative integers. The default value is one less than the size of the object being queried. - - - - - Request to filter the contents of an Amazon S3 object based on a simple Structured Query Language (SQL) statement. - - In the request, along with the SQL expression, you must also specify a data serialization format (JSON or CSV) of the object. - Amazon S3 uses this to parse object data into records, and returns only records - that match the specified SQL expression. You must also specify the data serialization format for the response. - - - - S3Select API Documentation - - - - - The S3 Bucket. - - - - - The Object Key. - - - - - The SSE Algorithm used to encrypt the object. - - - Server-Side Encryption (Using Customer-Provided Encryption Keys. - - - - - The SSE Customer Key. - - - Server-Side Encryption (Using Customer-Provided Encryption Keys. - - - - - The SSE Customer Key MD5. - - - Server-Side Encryption (Using Customer-Provided Encryption Keys. - - - - - The expression that is used to query the object. - - - - - The type of the provided expression (e.g., SQL). - - - - - Specifies if periodic request progress information should be enabled. - - - - - Describes the format of the data in the object that is being queried. - - - - - Describes the format of the data that you want Amazon S3 to return in response. - - - - - The byte range of the object to get the records from. - - - - - Contains the response Payload for the SelectObjectContent request - - - - - The Event Stream result of SelectObjectContent - - - - - Describes the parameters for Select job types. - - - - - Describes the serialization format of the object. - - - - - The type of the provided expression (e.g., SQL). - - - - - The expression that is used to query the object. - - - - - Describes how the results of the Select job are serialized. - - - - - ServerSideEncryptionByDefault class - - - - - Server-side encryption algorithm to use for the default encryption. - - - - - KMS master key ID to use for the default encryption. - This parameter is allowed if SSEAlgorithm is aws:kms. - - - - - ServerSideEncryptionConfiguration class - - - - - Container for information about a particular server-side encryption configuration rule. - - - - - ServerSideEncryptionRule class - - - - - Describes the default server-side encryption to apply to - new objects in the bucket. If Put Object request - does not specify any server-side encryption, - this default encryption will be applied. - - - - - SourceSelectionCriteria class - - - - - Container for filter information of selection of KMS Encrypted - S3 objects. The element is required if you include - SourceSelectionCriteria in the replication - configuration. - - - - - SSEKMS class - - - - - Specifies the ID of the AWS Key Management Service (KMS) - master encryption key to use for encrypting Inventory reports. - - - - - SseKmsEncryptedObjects class - - - - - The replication for KMS encrypted S3 objects is disabled if status is not Enabled. - - - - - SSES3 class - - - - - Class for StorageClassAnalysis - - - - - A container used to describe how data related to the storage class analysis should be exported. - - - - - Class for StorageClassAnalysisDataExport - - - - - The version of the output schema to use when exporting data. Must be V_1. - - - - - The place to store the data for an analysis. - - - - - Base class for responses that return a stream. - - - - - Disposes of all managed and unmanaged resources. - - - - - An open stream read from to get the data from S3. In order to - use this stream without leaking the underlying resource, please - wrap access to the stream within a using block. - - - - - The exception that is thrown when the size of a stream does not match it's expected size. - - - - - Gets and sets ExpectedSize property. - - - - - Gets and sets ActualSize property. - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - - - Tag is a key-value pair of metadata associated with an S3Object - - - - - Name of the tag. - - - - - Value of the tag. - - - - - Structure that contains list of Tags - - - - - TagSet - - - - - This class contains the configuration Amazon S3 uses to figure out what events you want to listen - and send the event to an Amazon SNS topic. - - The topic's policy must allow S3 to publish messages to it. The utility method - Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.AuthorizeS3ToPublish(string,string) - can be used to help setup the topic policy. - - - - - - Gets and set the Id property. The Id will be provided in the event content and can be used - to identify which configuration caused an event to fire. If the Id is not provided for the configuration, one will be generated. - - - - - Bucket event for which to send notifications. - - Topic configurations can now contain multiple events. This property is obsolete in favor of the Events property. - This property will always get or set the the zeroth element in the Events collection. - - - - - - Gets and sets the Topic property. Amazon SNS topic to which Amazon S3 will publish a message to report the - specified events for the bucket. - - The topic's policy must allow S3 to publish messages to it. The utility method - Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.AuthorizeS3ToPublish(string,string) - can be used to help setup the topic policy. - - - - - - The parameters to request upload of a part in a multipart upload operation. - - - - If PartSize is not specified then the rest of the content from the file - or stream will be sent to Amazon S3. - - - You must set either the FilePath or InputStream. If FilePath is set then the FilePosition - property must be set. - - - - The parameters to request upload of a part in a multipart upload operation. - - - - If PartSize is not specified then the rest of the content from the file - or stream will be sent to Amazon S3. - - - You must set either the FilePath or InputStream. If FilePath is set then the FilePosition - property must be set. - - - - - - Caller needs to set this to true when uploading the last part. This property only needs to be set - when using the AmazonS3EncryptionClient. - - - - - Input stream for the request; content for the request will be read from the stream. - - - - - The name of the bucket containing the object to receive the part. - - - - - The key of the object. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Part number of part being uploaded. - - - - - - The size of the part to be uploaded. - - - - - Checks if PartSize property is set. - - true if PartSize property is set. - - - - Upload ID identifying the multipart upload whose part is being uploaded. - - - - - - An MD5 digest for the part. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - - Full path and name of a file from which the content for the part is retrieved. - - - For WinRT and Windows Phone this property must be in the form of "ms-appdata:///local/file.txt". - - - - - - Checks if the FilePath property is set. - - true if FilePath property is set. - - - - Position in the file specified by FilePath from which to retrieve the content of the part. - This field is required when a file path is specified. It is ignored when using the InputStream property. - - - - - If this value is set to true then a chunked encoding upload will be used for the request. - Default: true. - - - - - Checks if the FilePosition property is set. - - true if FilePosition property is set. - - - - Checks if the MD5Digest property is set. - - true if Md5Digest property is set. - - - - Attach a callback that will be called as data is being sent to the AWS Service. - - - - - Overriden to turn off sending SHA256 header. - - - - - Overriden to turn on Expect 100 continue. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the UploadPart response and response metadata. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - Entity tag for the uploaded object. - - - - - - Gets and sets the part number specified for the part upload. This is needed when - completing the multipart upload. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - Website Configuration - - - - - The ErrorDocument value, an object key name to use when a 4XX class error occurs. - - - - - - This value is a suffix that is appended to a request that is for a "directory" - on the website endpoint (e.g. if the suffix is index.html and - you make a request to samplebucket/images/ the data that - is returned will be for the object with the key name - images/index.html) - - - The suffix must not be empty and must not include a slash - character. - - - - - - Container for redirect information where all requests will be redirect - to. You can redirect requests to another host, to another page, or with - another protocol. In the event of an error, you can can specify a - different error code to return. . - - - - - The list of routing rules that can be used for configuring redirects if certain conditions are meet. - - - - - The Continuation Event. - - - - - Constructs a Continuation Event. - - - - - Constructs a Continuation Event. - - - - - - The End Event. - - - - - Constructs an End Event. - - - - - Constructs an End Event. - - - - - - Common Contract for S3 Events. - - - - - The Progress event details. - - - - - Current number of object bytes scanned. - - - - - Current number of uncompressed object bytes processed. - - - - - Total number of bytes of records payload data returned. - - - - - Constructs a instance of Progress. - - - - - The Progress Event. - - - - - The Progress event details. - - - - - Constructs a ProgressEvent. - - - - - Constructs a ProgressEvent. - - - - - - The Records Event - - - - - The byte array of partial, one or more result records. - - Payload is a , which is not thread-safe. - - - - - Constructs a RecordsEvent - - - - - Creates a new End Event. - - - - - - Modeled Exception that either comes over the stream from the service model, or wraps other exceptions for the purpose of raising events. If it is - modelled, it will be a subclass. - - - - - Creates a new S3EventStreamException - - - - - Creates a new S3EventStreamException - - - - - - Creates a new S3EventStreamException - - - - - - - The contract for the SelectObjectContentEventStream. - - - - - Event that encompasses all IS3Events. - - - - - Event that encompasses S3EventStreamExceptions. - - - - - Reaised when a Records event is received. - - - - - Reaised when a Stats event is received. - - - - - Reaised when a Progress event is received. - - - - - Reaised when a Continuation event is received. - - - - - Reaised when an End event is received. - - - - - A Stream of Events returned by the SelectObjectContent operation. Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treaded as mutually exclusive. - - - - - The mapping of event message to a generator function to construct the matching Event Stream event. - - - - - The mapping of event message to a generator function to construct the matching Event Stream exception. - - - - - Whether the backround processing loop is running. - - - - - Event that encompasses all IS3Events. - - - - - Event that encompasses S3EventStreamExceptions. - - - - - Reaised when a Records event is received. - - - - - Reaised when a Stats event is received. - - - - - Reaised when a Progress event is received. - - - - - Reaised when a Continuation event is received. - - - - - Reaised when an End event is received. - - - - - Event Stream returned by SelectObjectContentStream. - - Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treated as mutually exclusive. - - The network stream which events will be parsed from. - - - - Event Stream returned by SelectObjectContentStream. - - Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treaded as mutually exclusive. - - The network stream which events will be parsed from. - The decoder responsible for parsing events. - - - - The Stats event details. - - - - - Total number of object bytes scanned. - - - - - Total number of uncompressed object bytes processed. - - - - - Total number of bytes of records payload data returned. - - - - - Constructs an instance of Stats. - - - - - The Stats Event. - - - - - The Stats event details. - - - - - Constructs a StatsEvent - - - - - Constructs a ProgressEvent. - - - - - - This Event is returned if an event is retrieved from the event stream, but a generator function - for the event is not defined. - - - - - Constructs an UnknownEventStreamEvent. - - - - - Constructs an UnknownEventStreamEvent. - - The Message recieved from the event stream before conversion. - - - - Constructs an UnknownEventStreamEvent. - - The Message recieved from the event stream before conversion. - The event type. - - - - Arguments containing event details for an in-flight transfer. - - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - - - - Gets the percentage of transfer completed - - - - - Gets the number of bytes transferred since last event - - - - - Gets the number of bytes transferred - - - - - Gets the total number of bytes to be transferred - - - - - Returns a string representation of this object - - - - - - AmazonS3 exception. - Thrown when DeleteObjects returns successfully, but some of the objects - were not deleted. - - - - - Gets and sets the ErrorResponse property. - The DeleteObjectsErrorResponse associated with this exception. - - - - - Constructs an instance of DeleteObjectsException - - - - - - Uri wrapper that can parse out information (bucket, key, region, style) from an - S3 URI. - - - - - True if the URI contains the bucket in the path, false if it contains the bucket in the authority. - - - - - The bucket name parsed from the URI (or null if no bucket specified). - - - - - The key parsed from the URI (or null if no key specified). - - - - - The region parsed from the URI (or null if no region specified). - - - - - Constructs a parser for the S3 URI specified as a string. - - The S3 URI to be parsed. - - - - Constructs a parser for the S3 URI specified as a Uri instance. - - The S3 URI to be parsed. - - - - If the given string is an AmazonS3Endpoint return true and set the AmazonS3Uri out parameter. - - - - true if the string is an AmazonS3Endpoint, and the out paramter has been filled in, false otherwise - - - - If the given Uri is an AmazonS3Endpoint return true and set the AmazonS3Uri out parameter. - - - - true if the Uri is an AmazonS3Endpoint, and the out paramter has been filled in, false otherwise - - - - Checks whether the given URI is a Amazon S3 URI. - - The S3 URI to be checked. - true if the URI is a Amazon S3 URI, false; otherwise. - - - - Checks whether the given URI is a Amazon S3 URI. - - The S3 URI to be checked. - true if the URI is a Amazon S3 URI, false; otherwise. - - - - Percent-decodes the given string, with a fast path for strings that are not - percent-encoded. - - The string to decode - The decoded string - - - - Percent-decodes the given string. - - The string to decode - The index of the first '%' in the string - The decoded string - - - - Decodes the percent-encoded character at the given index in the string - and appends the decoded value to the string under construction. - - - The string under construction to which the decoded character will be - appended. - - The string being decoded. - The index of the '%' character in the string. - - - - Converts a hex character (0-9A-Fa-f) into its corresponding quad value. - - The hex character - The quad value - - - - Provides utilities used by the Amazon S3 client implementation. - These utilities might be useful to consumers of the Amazon S3 - library. - - - - - Determines MIME type from a file extension - - The extension of the file - The MIME type for the extension, or text/plain - - - - URL encodes a string. If the path property is specified, - the accepted path characters {/+:} are not encoded. - - The string to encode - Whether the string is a URL path or not - - - - - Converts a non-seekable stream into a System.IO.MemoryStream. - A MemoryStream's position can be moved arbitrarily - - The stream to be converted - A seekable MemoryStream - MemoryStreams use byte arrays as their backing store. - Please use this judicially as it is likely that a very large - stream will cause system resources to be used up. - - - - - Formats the current date as a GMT timestamp - - A GMT formatted string representation - of the current date and time - - - - - Generates an MD5 Digest for the string-based content - - The content for which the MD5 Digest needs - to be computed. - - Whether the returned checksum should be - base64 encoded. - - A string representation of the hash with or w/o base64 encoding - - - - - Only escape non-ascii characters in a string - - - - - - - Version2 S3 buckets adhere to RFC 1035: - - Less than 255 characters, with each label less than 63 characters. - Label must start with a letter - Label must end with a letter or digit - Label can have a string of letter, digits and hyphens in the middle. - Although names can be case-sensitive, no significance is attached to the case. - RFC 1123: Allow label to start with letter or digit (e.g. 3ware.com works) - RFC 2181: No restrictions apart from the length restrictions. - - S3 V2 will start with RFCs 1035 and 1123 and impose the following additional restrictions: - - Length between 3 and 63 characters (to allow headroom for upper-level domains, - as well as to avoid separate length restrictions for bucket-name and its labels - Only lower-case to avoid user confusion. - No dotted-decimal IPv4-like strings - - - The BucketName to validate if V2 addressing should be used - True if the BucketName should use V2 bucket addressing, false otherwise - - S3 v2 Bucket restrictions - - - - Determines whether an S3 bucket exists or not. - - The name of the bucket to check. - The Amazon S3 Client to use for S3 specific operations. - False is returned in case S3 responds with a NoSuchBucket error. - True is returned in case of success, AccessDenied error or PermanentRedirect error. - An exception is thrown in case of any other error. - This method calls GetACL for the bucket. - - - - Determines whether an S3 bucket exists or not. - This is done by: - 1. Creating a PreSigned Url for the bucket. To work with Signature V4 only regions, as - well as Signature V4-optional regions, we keep the expiry to within the maximum for V4 - (which is one week). - 2. Making a HEAD request to the Url - - The name of the bucket to check. - The Amazon S3 Client to use for S3 specific operations. - - - - - Class to manage and cache the correct region for buckets accessed without an explicit region. - - - Class to manage and cache the correct region for buckets accessed without an explicit region. - - - - - A cache of BucketName -> RegionEndpoint pairs. - The cache is used to make sure that bucket requests are signed for the correct region, - even when requesting them without an explicit region. - - - - - Detect a bucket region mismatch based on the x-amz-bucket-region header, and the status code provided. - - - - - - - - - Detects if the signature is malformed, and the requested bucket is in a Region - different from the Region of the request. - - - - the correct region if a mismatch was detected, null otherwise - - - - Detects if the signature is malformed, and the requested bucket is in a Region - different from the Region of the request. - - - - - the correct region if a mismatch was detected, null otherwise - - - - Use a HEAD bucket request to get the region for the given bucket. - - This method creates an AmazonS3Client from the credentials passed in. - It's critical that the AmazonS3Client is not used to make any requests that will - be routed through the pipeline. - - - - the value of the x-amz-bucket-region header from the response - - - - A helper class that represents a strongly typed S3 EventNotification item sent to SQS - - - - - Parse the JSON string into a S3EventNotification object. - - The function will try its best to parse input JSON string as best as it can. - It will not fail even if the JSON string contains unknown properties. - - For any parsing errors - - - - - Gets and sets the records for the S3 event notification - - - - - The class holds the user identity properties. - - - - - Gets and sets the PrincipalId property. - - - - - This class contains the identity information for an S3 bucket. - - - - - Gets and sets the name of the bucket. - - - - - Gets and sets the bucket owner id. - - - - - Gets and sets the S3 bucket arn. - - - - - This class contains the information for an object in S3. - - - - - Gets and sets the key for the object stored in S3. - - - - - Gets and sets the size of the object in S3. - - - - - Gets and sets the etag of the object. This can be used to determine if the object has changed. - - - - - Gets and sets the version id of the object in S3. - - - - - Gets and sets the sequencer a string representation of a hexadecimal value used to determine event sequence, only used with PUTs and DELETEs. - - - - - Gets and sets the meta information describing S3. - - - - - Gets and sets the ConfigurationId. This ID can be found in the bucket notification configuration. - - - - - Gets and sets the Bucket property. - - - - - Gets and sets the Object property. - - - - - Gets and sets the S3SchemaVersion property. - - - - - The class holds the request parameters - - - - - Gets and sets the SourceIPAddress. This is the ip address where the request came from. - - - - - This class holds the response elements. - - - - - Gets and sets the XAmzId2 Property. This is the Amazon S3 host that processed the request. - - - - - Gets and sets the XAmzRequestId. This is the Amazon S3 generated request ID. - - - - - The class holds the glacier event data elements. - - - - - Gets and sets the RestoreEventData property. - - - - - The class holds the restore event data elements. - - - - - Gets and sets the LifecycleRestorationExpiryTime the time when the object restoration will be expired. - - - - - Gets and sets the LifecycleRestoreStorageClass the source storage class for restore. - - - - - The class holds the event notification. - - - - - Gets and sets the AwsRegion property. - - - - - Gets and sets the EventName property. This identities what type of event occurred. - For example for an object just put in S3 this will be set to EventType.ObjectCreatedPut. - - - - - Gets and sets the EventSource property. - - - - - Gets and sets the EventType property. The time when S3 finished processing the request. - - - - - Gets and sets the EventVersion property. - - - - - Gets and sets the RequestParameters property. - - - - - Gets and sets the ResponseElements property. - - - - - Gets and sets the S3 property. - - - - - Gets and sets the UserIdentity property. - - - - - Get and sets the GlacierEventData property. - - - - - Interface for accessing S3 - - - - - - - Create a signed URL allowing access to a resource that would - usually require authentication. - - - - When using query string authentication you create a query, - specify an expiration time for the query, sign it with your - signature, place the data in an HTTP request, and distribute - the request to a user or embed the request in a web page. - - - A PreSigned URL can be generated for GET, PUT, DELETE and HEAD - operations on your bucketName, keys, and versions. - - - The GetPreSignedUrlRequest that defines the - parameters of the operation. - A string that is the signed http request. - - - - - - This operation aborts a multipart upload. After a multipart upload is aborted, no - additional parts can be uploaded using that upload ID. The storage consumed by any - previously uploaded parts will be freed. However, if any part uploads are currently - in progress, those part uploads might or might not succeed. As a result, it might - be necessary to abort a given multipart upload multiple times in order to completely - free all storage consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts operation and ensure that the parts - list is empty. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - The bucket name to which the upload was taking place. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object for which the multipart upload was initiated. - Upload ID that identifies the multipart upload. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AbortMultipartUpload service method, as returned by S3. - REST API Reference for AbortMultipartUpload Operation - - - - This operation aborts a multipart upload. After a multipart upload is aborted, no - additional parts can be uploaded using that upload ID. The storage consumed by any - previously uploaded parts will be freed. However, if any part uploads are currently - in progress, those part uploads might or might not succeed. As a result, it might - be necessary to abort a given multipart upload multiple times in order to completely - free all storage consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts operation and ensure that the parts - list is empty. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - Container for the necessary parameters to execute the AbortMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AbortMultipartUpload service method, as returned by S3. - REST API Reference for AbortMultipartUpload Operation - - - - Completes a multipart upload by assembling previously uploaded parts. - - - - You first initiate the multipart upload and then upload all parts using the UploadPart - operation. After successfully uploading all relevant parts of an upload, you call - this operation to complete the upload. Upon receiving this request, Amazon S3 concatenates - all the parts in ascending order by part number to create a new object. In the Complete - Multipart Upload request, you must provide the parts list. You must ensure that the - parts list is complete. This operation concatenates the parts that you provide in - the list. For each part in the list, you must provide the part number and the ETag - value, returned after that part was uploaded. - - - - Processing of a Complete Multipart Upload request could take several minutes to complete. - After Amazon S3 begins processing the request, it sends an HTTP response header that - specifies a 200 OK response. While processing is in progress, Amazon S3 periodically - sends white space characters to keep the connection from timing out. Because a request - could fail after the initial 200 OK response has been sent, it is important that you - check the response body to determine whether the request succeeded. - - - - Note that if CompleteMultipartUpload fails, applications should be prepared - to retry the failed requests. For more information, see Amazon - S3 Error Best Practices. - - - - For more information about multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - GetBucketLifecycle has the following special errors: - -
  • - - Error code: EntityTooSmall - -
    • - - Description: Your proposed upload is smaller than the minimum allowed object size. - Each part must be at least 5 MB in size, except the last part. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPart - -
    • - - Description: One or more of the specified parts could not be found. The part might - not have been uploaded, or the specified entity tag might not have matched the part's - entity tag. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPartOrder - -
    • - - Description: The list of parts was not in ascending order. The parts list must be - specified in order by part number. - -
    • - - 400 Bad Request - -
  • - - Error code: NoSuchUpload - -
    • - - Description: The specified multipart upload does not exist. The upload ID might be - invalid, or the multipart upload might have been aborted or completed. - -
    • - - 404 Not Found - -
- - The following operations are related to CompleteMultipartUpload: - - - - Container for the necessary parameters to execute the CompleteMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CompleteMultipartUpload service method, as returned by S3. - REST API Reference for CompleteMultipartUpload Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 Developer Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Encryption - - - - The source object that you are copying can be encrypted or unencrypted. The source - object can be encrypted with server-side encryption using AWS managed encryption keys - (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side - encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers - and decrypts the data when you access it. - - - - You can optionally use the appropriate encryption-related headers to request server-side - encryption for the target object. You have the option to provide your own encryption - key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that - was used to encrypt the source object. You can even request encryption if the source - object was not encrypted. For more information about server-side encryption, see Using - Server-Side Encryption. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject operation to change the storage class of an - object that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 Service Developer Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 Developer Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Encryption - - - - The source object that you are copying can be encrypted or unencrypted. The source - object can be encrypted with server-side encryption using AWS managed encryption keys - (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side - encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers - and decrypts the data when you access it. - - - - You can optionally use the appropriate encryption-related headers to request server-side - encryption for the target object. You have the option to provide your own encryption - key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that - was used to encrypt the source object. You can even request encryption if the source - object was not encrypted. For more information about server-side encryption, see Using - Server-Side Encryption. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject operation to change the storage class of an - object that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 Service Developer Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 Developer Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Encryption - - - - The source object that you are copying can be encrypted or unencrypted. The source - object can be encrypted with server-side encryption using AWS managed encryption keys - (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side - encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers - and decrypts the data when you access it. - - - - You can optionally use the appropriate encryption-related headers to request server-side - encryption for the target object. You have the option to provide your own encryption - key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that - was used to encrypt the source object. You can even request encryption if the source - object was not encrypted. For more information about server-side encryption, see Using - Server-Side Encryption. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject operation to change the storage class of an - object that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 Service Developer Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - Container for the necessary parameters to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - - - - - - Deletes an analytics configuration for the bucket (specified by the analytics configuration - ID). - - - - To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to DeleteBucketAnalyticsConfiguration: - -
  • - - - -
  • - - - -
  • - - - -
- - Container for the necessary parameters to execute the DeleteBucketAnalyticsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketAnalyticsConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketAnalyticsConfiguration Operation - - - - - Deletes an inventory configuration (identified by the inventory ID) from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - Operations related to DeleteBucketInventoryConfiguration include: - - - - Container for the necessary parameters to execute the DeleteBucketInventoryConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketInventoryConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketInventoryConfiguration Operation - - - - Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified - by the metrics configuration ID) from the bucket. Note that this doesn't include the - daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketMetricsConfiguration Operation - - - - This implementation of the DELETE operation uses the policy subresource to delete - the policy of a specified bucket. If you are using an identity other than the root - user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - The bucket name. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketPolicy service method, as returned by S3. - REST API Reference for DeleteBucketPolicy Operation - - - - This implementation of the DELETE operation uses the policy subresource to delete - the policy of a specified bucket. If you are using an identity other than the root - user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - Container for the necessary parameters to execute the DeleteBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketPolicy service method, as returned by S3. - REST API Reference for DeleteBucketPolicy Operation - - - - Deletes the replication configuration from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutReplicationConfiguration - action. The bucket owner has these permissions by default and can grant it to others. - For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - It can take a while for the deletion of a replication configuration to fully propagate. - - - - For information about replication configuration, see Replication - in the Amazon S3 Developer Guide. - - - - The following operations are related to DeleteBucketReplication: - - - - Container for the necessary parameters to execute the DeleteBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketReplication service method, as returned by S3. - REST API Reference for DeleteBucketReplication Operation - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - The bucket that has the tag set to be removed. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketTagging service method, as returned by S3. - REST API Reference for DeleteBucketTagging Operation - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - Container for the necessary parameters to execute the DeleteBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketTagging service method, as returned by S3. - REST API Reference for DeleteBucketTagging Operation - - - - This operation removes the website configuration for a bucket. Amazon S3 returns a - 200 OK response upon successfully deleting a website configuration on - the specified bucket. You will get a 200 OK response if the website configuration - you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE operation requires the S3:DeleteBucketWebsite permission. - By default, only the bucket owner can delete the website configuration attached to - a bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which you want to remove the website configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketWebsite service method, as returned by S3. - REST API Reference for DeleteBucketWebsite Operation - - - - This operation removes the website configuration for a bucket. Amazon S3 returns a - 200 OK response upon successfully deleting a website configuration on - the specified bucket. You will get a 200 OK response if the website configuration - you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE operation requires the S3:DeleteBucketWebsite permission. - By default, only the bucket owner can delete the website configuration attached to - a bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the DeleteBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketWebsite service method, as returned by S3. - REST API Reference for DeleteBucketWebsite Operation - - - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - The bucket name of the lifecycle to delete. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - REST API Reference for DeleteLifecycleConfiguration Operation - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - Container for the necessary parameters to execute the DeleteLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - REST API Reference for DeleteLifecycleConfiguration Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key name of the object to delete. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key name of the object to delete. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - Container for the necessary parameters to execute the DeleteObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - This operation enables you to delete multiple objects from a bucket using a single - HTTP request. If you know the object keys that you want to delete, then this operation - provides a suitable alternative to sending individual delete requests, reducing per-request - overhead. - - - - The request contains a list of up to 1000 keys that you want to delete. In the XML, - you provide the object key names, and optionally, version IDs if you want to delete - a specific version of the object from a versioning-enabled bucket. For each key, Amazon - S3 performs a delete operation and returns the result of that delete, success, or - failure, in the response. Note that if the object specified in the request is not - found, Amazon S3 returns the result as deleted. - - - - The operation supports two modes for the response: verbose and quiet. By default, - the operation uses verbose mode in which the response includes the result of deletion - of each key in your request. In quiet mode the response includes only keys where the - delete operation encountered an error. For a successful deletion, the operation does - not return any information about the delete in the response body. - - - - When performing this operation on an MFA Delete enabled bucket, that attempts to delete - any versioned objects, you must include an MFA token. If you do not provide one, the - entire request will fail, even if there are non-versioned objects you are trying to - delete. If you provide an invalid token, whether there are versioned keys in the request - or not, the entire Multi-Object Delete request will fail. For information about MFA - Delete, see - MFA Delete. - - - - Finally, the Content-MD5 header is required for all Multi-Object Delete requests. - Amazon S3 uses the header value to ensure that your request body has not been altered - in transit. - - - - The following operations are related to DeleteObjects: - - - - Container for the necessary parameters to execute the DeleteObjects service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObjects service method, as returned by S3. - REST API Reference for DeleteObjects Operation - - - - Removes the entire tag set from the specified object. For more information about managing - object tags, see - Object Tagging. - - - - To use this operation, you must have permission to perform the s3:DeleteObjectTagging - action. - - - - To delete tags of a specific object version, add the versionId query - parameter in the request. You will need permission for the s3:DeleteObjectVersionTagging - action. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteObjectTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObjectTagging service method, as returned by S3. - REST API Reference for DeleteObjectTagging Operation - - - - Removes the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:PutBucketPublicAccessBlock - permission. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to DeletePublicAccessBlock: - - - - Container for the necessary parameters to execute the DeletePublicAccessBlock service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeletePublicAccessBlock service method, as returned by S3. - REST API Reference for DeletePublicAccessBlock Operation - - - - - - - - - Returns the default encryption configuration for an Amazon S3 bucket. For information - about the Amazon S3 default encryption feature, see Amazon - S3 Default Bucket Encryption. - - - - To use this operation, you must have permission to perform the s3:GetEncryptionConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to GetBucketEncryption: - - - - Container for the necessary parameters to execute the GetBucketEncryption service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketEncryption service method, as returned by S3. - REST API Reference for GetBucketEncryption Operation - - - - Returns an inventory configuration (identified by the inventory configuration ID) - from the bucket. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - The following operations are related to GetBucketInventoryConfiguration: - - - - Container for the necessary parameters to execute the GetBucketInventoryConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketInventoryConfiguration service method, as returned by S3. - REST API Reference for GetBucketInventoryConfiguration Operation - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - The name of the bucket for which to get the location. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLocation service method, as returned by S3. - REST API Reference for GetBucketLocation Operation - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - Container for the necessary parameters to execute the GetBucketLocation service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLocation service method, as returned by S3. - REST API Reference for GetBucketLocation Operation - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - The bucket name for which to get the logging information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLogging service method, as returned by S3. - REST API Reference for GetBucketLogging Operation - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - Container for the necessary parameters to execute the GetBucketLogging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLogging service method, as returned by S3. - REST API Reference for GetBucketLogging Operation - - - - Gets a metrics configuration (specified by the metrics configuration ID) from the - bucket. Note that this doesn't include the daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to GetBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the GetBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for GetBucketMetricsConfiguration Operation - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following operation is related to GetBucketNotification: - - - - Name of the bucket for which to get the notification configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketNotification service method, as returned by S3. - REST API Reference for GetBucketNotification Operation - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following operation is related to GetBucketNotification: - - - - Container for the necessary parameters to execute the GetBucketNotification service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketNotification service method, as returned by S3. - REST API Reference for GetBucketNotification Operation - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operation is related to GetBucketPolicy: - - - - The bucket name for which to get the bucket policy. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicy service method, as returned by S3. - REST API Reference for GetBucketPolicy Operation - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operation is related to GetBucketPolicy: - - - - Container for the necessary parameters to execute the GetBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicy service method, as returned by S3. - REST API Reference for GetBucketPolicy Operation - - - - Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket - is public. In order to use this operation, you must have the s3:GetBucketPolicyStatus - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - For more information about when Amazon S3 considers a bucket public, see The - Meaning of "Public". - - - - The following operations are related to GetBucketPolicyStatus: - - - - Container for the necessary parameters to execute the GetBucketPolicyStatus service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicyStatus service method, as returned by S3. - REST API Reference for GetBucketPolicyStatus Operation - - - - Retrieves the replication configuration for the given Amazon S3 bucket. - - Container for the necessary parameters to execute the GetBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketReplication service method, as returned by S3. - REST API Reference for GetBucketReplication Operation - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - The name of the bucket for which to get the payment request configuration - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketRequestPayment service method, as returned by S3. - REST API Reference for GetBucketRequestPayment Operation - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - Container for the necessary parameters to execute the GetBucketRequestPayment service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketRequestPayment service method, as returned by S3. - REST API Reference for GetBucketRequestPayment Operation - - - - Returns the tag set associated with the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - GetBucketTagging has the following special error: - -
  • - - Error code: NoSuchTagSetError - -
    • - - Description: There is no tag set associated with the bucket. - -
- - The following operations are related to GetBucketTagging: - - - - Container for the necessary parameters to execute the GetBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketTagging service method, as returned by S3. - REST API Reference for GetBucketTagging Operation - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - The name of the bucket for which to get the versioning information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketVersioning service method, as returned by S3. - REST API Reference for GetBucketVersioning Operation - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - Container for the necessary parameters to execute the GetBucketVersioning service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketVersioning service method, as returned by S3. - REST API Reference for GetBucketVersioning Operation - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET operation requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which to get the website configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketWebsite service method, as returned by S3. - REST API Reference for GetBucketWebsite Operation - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET operation requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the GetBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketWebsite service method, as returned by S3. - REST API Reference for GetBucketWebsite Operation - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - The bucket name for which to get the cors configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetCORSConfiguration service method, as returned by S3. - REST API Reference for GetCORSConfiguration Operation - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - Container for the necessary parameters to execute the GetCORSConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetCORSConfiguration service method, as returned by S3. - REST API Reference for GetCORSConfiguration Operation - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are still using previous version of the lifecycle configuration, it works. - For the earlier API description, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to GetBucketLifecycleConfiguration: - - - - The name of the bucket for which to get the lifecycle information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetLifecycleConfiguration service method, as returned by S3. - REST API Reference for GetLifecycleConfiguration Operation - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are still using previous version of the lifecycle configuration, it works. - For the earlier API description, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to GetBucketLifecycleConfiguration: - - - - Container for the necessary parameters to execute the GetLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetLifecycleConfiguration service method, as returned by S3. - REST API Reference for GetLifecycleConfiguration Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object to get. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object to get. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - Container for the necessary parameters to execute the GetObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Gets an object's current Legal Hold status. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLegalHold service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectLegalHold service method, as returned by S3. - REST API Reference for GetObjectLegalHold Operation - - - - Gets the Object Lock configuration for a bucket. The rule specified in the Object - Lock configuration will be applied by default to every new object placed in the specified - bucket. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLockConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectLockConfiguration service method, as returned by S3. - REST API Reference for GetObjectLockConfiguration Operation - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - The name of the bucket containing the object. - The object key. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - The name of the bucket containing the object. - The object key. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - Container for the necessary parameters to execute the GetObjectMetadata service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - Retrieves an object's retention settings. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectRetention service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectRetention service method, as returned by S3. - REST API Reference for GetObjectRetention Operation - - - - Returns the tag-set of an object. You send the GET request against the tagging subresource - associated with the object. - - - - To use this operation, you must have permission to perform the s3:GetObjectTagging - action. By default, the GET operation returns information about current version of - an object. For a versioned bucket, you can have multiple versions of an object in - your bucket. To retrieve tags of any other version, use the versionId query parameter. - You also need permission for the s3:GetObjectVersionTagging action. - - - - By default, the bucket owner has this permission and can grant this permission to - others. - - - - For information about the Amazon S3 object tagging feature, see Object - Tagging. - - - - The following operation is related to GetObjectTagging: - - - - Container for the necessary parameters to execute the GetObjectTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTagging service method, as returned by S3. - REST API Reference for GetObjectTagging Operation - - - - Return torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Amazon - S3 Torrent. - - - - You can get torrent only for objects that are less than 5 GB in size and that are - not encrypted using server-side encryption with customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - The following operation is related to GetObjectTorrent: - - - - The name of the bucket containing the object for which to get the torrent files. - The object key for which to get the information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTorrent service method, as returned by S3. - REST API Reference for GetObjectTorrent Operation - - - - Return torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Amazon - S3 Torrent. - - - - You can get torrent only for objects that are less than 5 GB in size and that are - not encrypted using server-side encryption with customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - The following operation is related to GetObjectTorrent: - - - - Container for the necessary parameters to execute the GetObjectTorrent service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTorrent service method, as returned by S3. - REST API Reference for GetObjectTorrent Operation - - - - Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:GetBucketPublicAccessBlock - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket - or an object, it checks the PublicAccessBlock configuration for both - the bucket (or the bucket that contains the object) and the bucket owner's account. - If the PublicAccessBlock settings are different between the bucket and - the account, Amazon S3 uses the most restrictive combination of the bucket-level and - account-level settings. - - - - For more information about when Amazon S3 considers a bucket or an object public, - see The - Meaning of "Public". - - - - The following operations are related to GetPublicAccessBlock: - - - - Container for the necessary parameters to execute the GetPublicAccessBlock service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetPublicAccessBlock service method, as returned by S3. - REST API Reference for GetPublicAccessBlock Operation - - - - This operation initiates a multipart upload and returns an upload ID. This upload - ID is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort operation - and Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload API and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart) and UploadPartCopy) requests must match the headers you - used in the request to initiate the upload by using CreateMultipartUpload. - - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, - kms:GenerateDataKey*, and kms:DescribeKey actions on the - key. These permissions are required because Amazon S3 must decrypt and read data from - the encrypted file parts before it completes the multipart upload. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - The following operations are related to CreateMultipartUpload: - - - - The name of the bucket to which to initiate the upload - Object key for which the multipart upload is to be initiated. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the InitiateMultipartUpload service method, as returned by S3. - REST API Reference for InitiateMultipartUpload Operation - - - - This operation initiates a multipart upload and returns an upload ID. This upload - ID is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort operation - and Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload API and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart) and UploadPartCopy) requests must match the headers you - used in the request to initiate the upload by using CreateMultipartUpload. - - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, - kms:GenerateDataKey*, and kms:DescribeKey actions on the - key. These permissions are required because Amazon S3 must decrypt and read data from - the encrypted file parts before it completes the multipart upload. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - The following operations are related to CreateMultipartUpload: - - - - Container for the necessary parameters to execute the InitiateMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the InitiateMultipartUpload service method, as returned by S3. - REST API Reference for InitiateMultipartUpload Operation - - - - Lists the analytics configurations for the bucket. You can have up to 1,000 analytics - configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. You should always check the IsTruncated element in the response. - If there are no more configurations to list, IsTruncated is set to false. - If there are more configurations to list, IsTruncated is set to true, - and there will be a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to ListBucketAnalyticsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketAnalyticsConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketAnalyticsConfigurations service method, as returned by S3. - REST API Reference for ListBucketAnalyticsConfigurations Operation - - - - Returns a list of inventory configurations for the bucket. You can have up to 1,000 - analytics configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory - - - - The following operations are related to ListBucketInventoryConfigurations: - - - - Container for the necessary parameters to execute the ListBucketInventoryConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketInventoryConfigurations service method, as returned by S3. - REST API Reference for ListBucketInventoryConfigurations Operation - - - - Lists the metrics configurations for the bucket. The metrics configurations are only - for the request metrics of the bucket and do not provide information on daily storage - metrics. You can have up to 1,000 configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For more information about metrics configurations and CloudWatch request metrics, - see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to ListBucketMetricsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketMetricsConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketMetricsConfigurations service method, as returned by S3. - REST API Reference for ListBucketMetricsConfigurations Operation - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBuckets service method, as returned by S3. - REST API Reference for ListBuckets Operation - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - Container for the necessary parameters to execute the ListBuckets service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBuckets service method, as returned by S3. - REST API Reference for ListBuckets Operation - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Container for the necessary parameters to execute the ListMultipartUploads service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. - Limits the response to keys that begin with the specified prefix. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - Container for the necessary parameters to execute the ListObjects service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Make sure to design - your application to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - To use this operation in an AWS Identity and Access Management (IAM) policy, you must - have permissions to perform the s3:ListBucket action. The bucket owner - has this permission by default and can grant this permission to others. For more information - about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - This section describes the latest revision of the API. We recommend that you use this - revised API for application development. For backward compatibility, Amazon S3 continues - to support the prior version of this API, ListObjects. - - - - To get a list of your buckets, see ListBuckets. - - - - The following operations are related to ListObjectsV2: - - - - Container for the necessary parameters to execute the ListObjectsV2 service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjectsV2 service method, as returned by S3. - REST API Reference for ListObjectsV2 Operation - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). This request returns a maximum of 1,000 - uploaded parts. The default number of parts returned is 1,000 parts. You can restrict - the number of parts returned by specifying the max-parts request parameter. - If your multipart upload consists of more than 1,000 parts, the response returns an - IsTruncated field with the value of true, and a NextPartNumberMarker - element. In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListParts: - - - - Name of the bucket to which the parts are being uploaded. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Object key for which the multipart upload was initiated. - Upload ID identifying the multipart upload whose parts are being listed. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListParts service method, as returned by S3. - REST API Reference for ListParts Operation - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). This request returns a maximum of 1,000 - uploaded parts. The default number of parts returned is 1,000 parts. You can restrict - the number of parts returned by specifying the max-parts request parameter. - If your multipart upload consists of more than 1,000 parts, the response returns an - IsTruncated field with the value of true, and a NextPartNumberMarker - element. In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListParts: - - - - Container for the necessary parameters to execute the ListParts service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListParts service method, as returned by S3. - REST API Reference for ListParts Operation - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - Container for the necessary parameters to execute the ListVersions service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - - Creates a new bucket. To create a bucket, you must register with Amazon S3 and have - a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed - to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information on bucket naming restrictions, - see Working - with Amazon S3 Buckets. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) - Region. For more information, see How - to Select a Region for Your Buckets. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - Hosting of Buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - The name of the bucket to create. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucket service method, as returned by S3. - REST API Reference for PutBucket Operation - - - - Creates a new bucket. To create a bucket, you must register with Amazon S3 and have - a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed - to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information on bucket naming restrictions, - see Working - with Amazon S3 Buckets. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) - Region. For more information, see How - to Select a Region for Your Buckets. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - Hosting of Buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - Container for the necessary parameters to execute the PutBucket service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucket service method, as returned by S3. - REST API Reference for PutBucket Operation - - - - Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration - is a bucket-level feature that enables you to perform faster data transfers to Amazon - S3. - - - - To use this operation, you must have permission to perform the s3:PutAccelerateConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The Transfer Acceleration state of a bucket can be set to one of the following two - values: - -
  • - - Enabled – Enables accelerated data transfers to the bucket. - -
  • - - Suspended – Disables accelerated data transfers to the bucket. - -
- - The GetBucketAccelerateConfiguration operation returns the transfer acceleration - state of a bucket. - - - - After setting the Transfer Acceleration state of a bucket to Enabled, it might take - up to thirty minutes before the data transfer rates to the bucket increase. - - - - The name of the bucket used for Transfer Acceleration must be DNS-compliant and must - not contain periods ("."). - - - - For more information about transfer acceleration, see Transfer - Acceleration. - - - - The following operations are related to PutBucketAccelerateConfiguration: - - - - Container for the necessary parameters to execute the PutBucketAccelerateConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketAccelerateConfiguration service method, as returned by S3. - REST API Reference for PutBucketAccelerateConfiguration Operation - - - - - - - Set the logging parameters for a bucket and to specify permissions for who can view - and modify the logging parameters. All logs are saved to buckets in the same AWS Region - as the source bucket. To set the logging status of a bucket, you must be the bucket - owner. - - - - The bucket owner is automatically granted FULL_CONTROL to all logs. You use the Grantee - request element to grant access to other people. The Permissions request - element specifies the kind of access the grantee has to the logs. - - - - Grantee Values - - - - You can specify the person (grantee) to whom you're assigning access rights (using - request elements) in the following ways: - -
  • - - By the person's ID: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> - </Grantee> - - - - DisplayName is optional and ignored in the request. - -
  • - - By Email address: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee> - - - - - The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl - request, appears as the CanonicalUser. - -
  • - - By URI: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee> - - -
- - To enable logging, you use LoggingEnabled and its children request elements. To disable - logging, you use an empty BucketLoggingStatus request element: - - - - <BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01" /> - - - - - For more information about server access logging, see Server - Access Logging. - - - - For more information about creating a bucket, see CreateBucket. For more information - about returning the logging status of a bucket, see GetBucketLogging. - - - - The following operations are related to PutBucketLogging: - - - - Container for the necessary parameters to execute the PutBucketLogging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketLogging service method, as returned by S3. - REST API Reference for PutBucketLogging Operation - - - - Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. - You can have up to 1,000 metrics configurations per bucket. If you're updating an - existing metrics configuration, note that this is a full replacement of the existing - metrics configuration. If you don't include the elements you want to keep, they are - erased. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to PutBucketMetricsConfiguration: - - - - GetBucketLifecycle has the following special error: - -
  • - - Error code: TooManyConfigurations - -
    • - - Description: You are attempting to create a new configuration but have already reached - the 1,000-configuration limit. - -
    • - - HTTP Status Code: HTTP 400 Bad Request - -
- - Container for the necessary parameters to execute the PutBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for PutBucketMetricsConfiguration Operation - - - - Enables notifications of specified events for a bucket. For more information about - event notifications, see Configuring - Event Notifications. - - - - Using this API, you can replace an existing notification configuration. The configuration - is an XML file that defines the event types that you want Amazon S3 to publish and - the destination where you want Amazon S3 to publish an event notification when it - detects an event of the specified type. - - - - By default, your bucket has no event notifications configured. That is, the notification - configuration will be an empty NotificationConfiguration. - - - - <NotificationConfiguration> - - - - </NotificationConfiguration> - - - - This operation replaces the existing notification configuration with the configuration - you include in the request body. - - - - After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification - Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, - and that the bucket owner has permission to publish to it by sending a test notification. - In the case of AWS Lambda destinations, Amazon S3 verifies that the Lambda function - permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. - For more information, see Configuring - Notifications for Amazon S3 Events. - - - - You can disable notifications by adding the empty NotificationConfiguration element. - - - - By default, only the bucket owner can configure notifications on a bucket. However, - bucket owners can use a bucket policy to grant permission to other users to set this - configuration with s3:PutBucketNotification permission. - - - - The PUT notification is an atomic operation. For example, suppose your notification - configuration includes SNS topic, SQS queue, and Lambda function configurations. When - you send a PUT request with this configuration, Amazon S3 sends test messages to your - SNS topic. If the message fails, the entire PUT operation will fail, and Amazon S3 - will not add the configuration to your bucket. - - - - Responses - - - - If the configuration in the request body includes only one TopicConfiguration - specifying only the s3:ReducedRedundancyLostObject event type, the response - will also include the x-amz-sns-test-message-id header containing the - message ID of the test notification sent to the topic. - - - - The following operation is related to PutBucketNotificationConfiguration: - - - - Container for the necessary parameters to execute the PutBucketNotification service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketNotification service method, as returned by S3. - REST API Reference for PutBucketNotification Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - The MD5 hash of the request body. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - Container for the necessary parameters to execute the PutBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Creates a replication configuration or replaces an existing one. For more information, - see Replication - in the Amazon S3 Developer Guide. - - - - To perform this operation, the user or role performing the operation must have the - iam:PassRole - permission. - - - - Specify the replication configuration in the request body. In the replication configuration, - you provide the name of the destination bucket where you want Amazon S3 to replicate - objects, the IAM role that Amazon S3 can assume to replicate objects on your behalf, - and other relevant information. - - - - A replication configuration must include at least one rule, and can contain a maximum - of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects - in the source bucket. To choose additional subsets of objects to replicate, add a - rule for each subset. All rules must specify the same destination bucket. - - - - To specify a subset of the objects in the source bucket to apply a replication rule - to, add the Filter element as a child of the Rule element. You can filter objects - based on an object key prefix, one or more object tags, or both. When you add the - Filter element in the configuration, you must also add the following elements: DeleteMarkerReplication, - Status, and Priority. - - - - For information about enabling versioning on a bucket, see Using - Versioning. - - - - By default, a resource owner, in this case the AWS account that created the bucket, - can perform this operation. The resource owner can also grant others permissions to - perform the operation. For more information about permissions, see Specifying - Permissions in a Policy and Managing - Access Permissions to Your Amazon S3 Resources. - - - - Handling Replication of Encrypted Objects - - - - By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side - encryption with CMKs stored in AWS KMS. To replicate AWS KMS-encrypted objects, add - the following: SourceSelectionCriteria, SseKmsEncryptedObjects, - Status, EncryptionConfiguration, and ReplicaKmsKeyID. - For information about replication configuration, see Replicating - Objects Created with SSE Using CMKs stored in AWS KMS. - - - - For information on PutBucketReplication errors, see ReplicationErrorCodeList - - - - - The following operations are related to PutBucketReplication: - - - - Container for the necessary parameters to execute the PutBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketReplication service method, as returned by S3. - REST API Reference for PutBucketReplication Operation - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - The bucket name. - Container for Payer. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketRequestPayment service method, as returned by S3. - REST API Reference for PutBucketRequestPayment Operation - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - Container for the necessary parameters to execute the PutBucketRequestPayment service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketRequestPayment service method, as returned by S3. - REST API Reference for PutBucketRequestPayment Operation - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging. - - - - Within a bucket, if you add a tag that has the same key as an existing tag, the new - value overwrites the old value. For more information, see Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional operation is currently in progress against - this resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - The bucket name. - A property of PutBucketTaggingRequest used to execute the PutBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketTagging service method, as returned by S3. - REST API Reference for PutBucketTagging Operation - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging. - - - - Within a bucket, if you add a tag that has the same key as an existing tag, the new - value overwrites the old value. For more information, see Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional operation is currently in progress against - this resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - Container for the necessary parameters to execute the PutBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketTagging service method, as returned by S3. - REST API Reference for PutBucketTagging Operation - - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT operation requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - Amazon S3 has a limitation of 50 routing rules per website configuration. If you require - more than 50 routing rules, you can use object redirect. For more information, see - Configuring - an Object Redirect in the Amazon Simple Storage Service Developer Guide. - - - The bucket name. - Container for the request. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketWebsite service method, as returned by S3. - REST API Reference for PutBucketWebsite Operation - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT operation requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - Amazon S3 has a limitation of 50 routing rules per website configuration. If you require - more than 50 routing rules, you can use object redirect. For more information, see - Configuring - an Object Redirect in the Amazon Simple Storage Service Developer Guide. - - - Container for the necessary parameters to execute the PutBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketWebsite service method, as returned by S3. - REST API Reference for PutBucketWebsite Operation - - - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - The name of the bucket for which to set the configuration. - A property of PutLifecycleConfigurationRequest used to execute the PutLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutLifecycleConfiguration service method, as returned by S3. - REST API Reference for PutLifecycleConfiguration Operation - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - Container for the necessary parameters to execute the PutLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutLifecycleConfiguration service method, as returned by S3. - REST API Reference for PutLifecycleConfiguration Operation - - - - - - - - - - - - - - - - - The base class for requests that return Amazon S3 objects. - - - - - Gets or sets the name of the bucket. - - - The name of the bucket. - - - - - Gets whether or not the bucket name is set. - - - A value of true if the bucket name is set. - Returns false if otherwise. - - - - - Gets or sets the key under which the Amazon S3 object is stored. - - - The key under which the Amazon S3 object is stored. - - - - - Gets whether or not the key property is set. - - - A value of true if key property is set. - Returns false if otherwise. - - - - - Gets or sets the version ID of the Amazon S3 object. - - - The version ID of the Amazon S3 object. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or - ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Gets or sets the ModifiedSinceDate property. - - - The ModifiedSinceDate property. - - - - - Gets or sets the ModifiedSinceDate property. - - - The ModifiedSinceDate property. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or - UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Gets or sets the UnmodifiedSinceDate property. - - - The UnmodifiedSinceDate property. - - - - - Gets or sets the UnmodifiedSinceDate property. - - - The UnmodifiedSinceDate property. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to decrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - The base class TransferUtility request classes. - - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - - Gets the Amazon S3 client used for making calls into Amazon S3. - - - The Amazon S3 client used for making calls into Amazon S3. - - - - - Uploads the specified file. - The object key is derived from the file's name. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the specified file. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the contents of the specified stream. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The stream to read to obtain the content to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the stream to. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the file or stream specified by the request. - To track the progress of the upload, - add an event listener to the request's UploadProgressEvent. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - Contains all the parameters required to upload to Amazon S3. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Aborts the multipart uploads that were initiated before the specified date. - - - The name of the bucket containing multipart uploads. - - - The date before which the multipart uploads were initiated. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the content from Amazon S3 and writes it to the specified file. - If the key is not specified in the request parameter, - the file name will used as the key name. - - - Contains all the parameters required to download an Amazon S3 object. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Returns a stream from which the caller can read the content from the specified - Amazon S3 bucket and key. - The caller of this method is responsible for closing the stream. - - - The name of the bucket. - - - The object key. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Returns a stream to read the contents from Amazon S3 as - specified by the TransferUtilityOpenStreamRequest. - The caller of this method is responsible for closing the stream. - - - Contains all the parameters required for the OpenStream operation. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - - Constructs a new class. - - - The AWS Access Key ID. - - - The AWS Secret Access Key. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new class. - - - The AWS Access Key ID. - - - The AWS Secret Access Key. - - - The region to configure the transfer utility for. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new instance of the class. - - - The AWS Access Key ID. - - - The AWS Secret Access Key. - - - Specifies advanced settings. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new instance of the class. - - - The AWS Access Key ID. - - - The AWS Secret Access Key. - - - The region to configure the transfer utility for. - - - Specifies advanced settings. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new instance of the class. - - - The Amazon S3 client. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Initializes a new instance of the class. - - - The Amazon S3 client. - - - Specifies advanced configuration settings for . - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Gets the Amazon S3 client used for making calls into Amazon S3. - - - The Amazon S3 client used for making calls into Amazon S3. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Uploads the specified file. - The object key is derived from the file's name. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the specified file. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the contents of the specified stream. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The stream to read to obtain the content to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the stream to. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the file or stream specified by the request. - To track the progress of the upload, - add an event listener to the request's UploadProgressEvent. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - Contains all the parameters required to upload to Amazon S3. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Aborts the multipart uploads that were initiated before the specified date. - - - The name of the bucket containing multipart uploads. - - - The date before which the multipart uploads were initiated. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the content from Amazon S3 and writes it to the specified file. - If the key is not specified in the request parameter, - the file name will used as the key name. - - - Contains all the parameters required to download an Amazon S3 object. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Returns a stream from which the caller can read the content from the specified - Amazon S3 bucket and key. - The caller of this method is responsible for closing the stream. - - - The name of the bucket. - - - The object key. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Returns a stream to read the contents from Amazon S3 as - specified by the TransferUtilityOpenStreamRequest. - The caller of this method is responsible for closing the stream. - - - Contains all the parameters required for the OpenStream operation. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - - Provides configuration options for how processes requests. - - - The best configuration settings depend on network - configuration, latency and bandwidth. - The default configuration settings are suitable - for most applications, but this class enables developers to experiment with - different configurations and tune transfer manager performance. - - - - - - Default constructor. - - - - - Gets or sets the minimum part size for upload parts in bytes. The default is 16 MB. - Decreasing the minimum part size causes - multipart uploads to be split into a larger number - of smaller parts. Setting this value too low has a negative effect - on transfer speeds, causing extra latency and network - communication for each part. - - - - - This property determines how many active threads - or the number of concurrent asynchronous web requests - will be used to upload/download the file . - The default value is 10. - - - A value less than or equal to 0 will be silently ignored. - - - - - Gets or sets the number of executing threads. - This property determines how many active threads will be used to upload - the file. The default value is 10 threads. - - - A value less than or equal to 0 will be silently ignored. - - - - - Contains all the parameters - that can be set when making a this request with the - TransferUtility method. - - - - - Get or sets the file path location of where the - downloaded Amazon S3 object will be written to. - - - The file path location of where the downloaded Amazon S3 object will be written to. - - - - - Checks if FilePath property is set. - - True if FilePath property is set. - - - - The event for WriteObjectProgressEvent notifications. All - subscribers will be notified when a new progress - event is raised. - - The WriteObjectProgressEvent is fired as data - is downloaded from S3. The delegates attached to the event - will be passed information detailing how much data - has been downloaded as well as how much will be downloaded. - - - - Subscribe to this event if you want to receive - WriteObjectProgressEvent notifications. Here is how:
- 1. Define a method with a signature similar to this one: - - private void displayProgress(object sender, WriteObjectProgressArgs args) - { - Console.WriteLine(args); - } - - 2. Add this method to the WriteObjectProgressEvent delegate's invocation list - - TransferUtilityDownloadRequest request = new TransferUtilityDownloadRequest(); - request.WriteObjectProgressEvent += displayProgress; - - - - - - Causes the WriteObjectProgressEvent event to be fired. - - Progress data for the stream being written to file. - - - - Contains all the parameters - that can be set when making a this request with the - TransferUtility method. - - - - - Contains all the parameters - that can be set when making a this request with the - TransferUtility method. - - - - - Gets or sets the name of the bucket. - - - The name of the bucket. - - - - - Checks if BucketName property is set. - - true if BucketName property is set. - - - - Gets or sets the key under which the Amazon S3 object is to be stored. - - - The key under which the Amazon S3 object is to be stored. - - - - - Checks if Key property is set. - - true if Key property is set. - - - - Gets or sets the canned access control list (ACL) - for the uploaded object. - Please refer to - for - information on Amazon S3 canned ACLs. - - - The canned access control list (ACL) - for the uploaded object. - - - - - Checks if the CannedACL property is set. - - true if there is the CannedACL property is set. - - - - Removes the cannned access control list (ACL) - for the uploaded object. - - - - - Gets or sets the content type of the uploaded Amazon S3 object. - - - The content type of the uploaded Amazon S3 object. - - - - - Checks if ContentType property is set. - - true if ContentType property is set. - - - - Gets or sets the storage class for the uploaded Amazon S3 object. - Please refer to - for - information on S3 Storage Classes. - - - The storage class for the uploaded Amazon S3 object. - - - - - Gets and sets the ServerSideEncryptionMethod property. - Specifies the encryption used on the server to - store the content. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Input stream for the request; content for the request will be read from the stream. - - - - - - Gets or sets the file path - where the Amazon S3 object will be uploaded from. - - - For WinRT and Windows Phone this property must be in the form of "ms-appdata:///local/file.txt". - - - - The file path where the Amazon S3 object will be uploaded from. - - - - - Checks if FilePath property is set. - - true if FilePath property is set. - - - - Gets or sets the part size of the upload in bytes. - The uploaded file will be divided into - parts the size specified and - uploaded to Amazon S3 individually. - - - The part size of the upload. - - - - - Checks if PartSize property is set. - - true if PartSize property is set. - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - The tag-set for the object. - - - - - The event for UploadProgressEvent notifications. All - subscribers will be notified when a new progress - event is raised. - - The UploadProgressEvent is fired as data - is uploaded to S3. The delegates attached to the event - will be passed information detailing how much data - has been uploaded as well as how much will be uploaded. - - - - Subscribe to this event if you want to receive - UploadProgressEvent notifications. Here is how:
- 1. Define a method with a signature similar to this one: - - private void displayProgress(object sender, UploadProgressArgs args) - { - Console.WriteLine(args); - } - - 2. Add this method to the UploadProgressEvent delegate's invocation list - - TransferUtilityUploadRequest request = new TransferUtilityUploadRequest(); - request.UploadProgressEvent += displayProgress; - - - - - - Causes the UploadProgressEvent event to be fired. - - Progress data for the file being uploaded. - - - - Gets the length of the content by either checking the FileInfo.Length property or the Stream.Length property. - - The length of the content. - - - - Gets or sets whether or not the stream used with this request is - automatically closed when all of the content is read from the stream. - - - A value of true if the if the stream is - automatically closed when all of the content is read from the stream. - A value of false if otherwise. - - - - - If this value is set to true then the stream's position will be reset to the start before being read for upload. - Default: true. - - - - - Sets whether or not the stream used with this request is - automatically closed when all of the content is read from the stream - and returns this object instance, - enabling additional method calls to be chained together. - - - A value of true if the if the stream is - automatically closed when all of the content is read from the stream. - A value of false if otherwise. - - - This object instance, enabling additional method calls to be chained together. - - - - - Encapsulates the information needed to provide - transfer progress to subscribers of the Put Object - Event. - - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The how many bytes were transferred since last event. - The number of bytes transferred - The total number of bytes to be transferred - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The how many bytes were transferred since last event. - The number of bytes transferred - The total number of bytes to be transferred - The file being uploaded - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The how many bytes were transferred since last event. - The number of bytes transferred - The total number of bytes to be transferred - A compensation for any upstream aggregators if this event to correct theit totalTransferred count, - in case the underlying request is retried. - The file being uploaded - - - - Gets the FilePath. - - - - - Waits for all of the tasks to complete or till any task fails or is canceled. - - - - - Waits for all of the tasks to complete or till any task fails or is canceled. - - - - - Returns the amount of bytes remaining that need to be pulled down from S3. - - The fully qualified path of the file. - - - - - The command to manage an upload using the S3 multipart API. - - - - - Initializes a new instance of the class. - - The s3 client. - The config object that has the number of threads to use. - The file transporter request. - - - - This command is for doing regular PutObject requests. - - - - - Configuration for the S3 section of AWS configuration. - Changes to some settings may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws> - <s3 useSignatureVersion4="true" /> - </aws> - - - - - - Key for the S3UseSignatureVersion4Key property. - - - - - - Configures if the S3 client should use Signature Version 4 signing with requests. - By default, this setting is set to true which will use Signature Version 4 for all - requests except presigned URL requests when the region is set to us-east-1. When - UseSignatureVersion4 is explicitly set to true by directly setting this property or - directly setting this property through configuration, Signature Version 4 will be - used for all requests when able to do so. - When this setting is false, Signature Version 2 will be used. Note that when the - setting is false, Signature Version 4 may still be used by default in some cases - or with some regions. - - - - - Escape and unescape S3 metadata for S3 Put/Get object requests. - Escape only escapes non-ascii values in metadata - Any "%" values in metadata could interfere with this option. - Default value is false. - - - - - Was the value of the UseSignatureVersion4 property set explicitly? - This can be done via configuration or by directly setting the property. - - This is used to determine if the user set UseSignatureVersion4 to true, - or if it's true because the default was changed to true in the SDK. - - - - diff --git a/packages/AWSSDK.S3.3.3.111.14/lib/portable-net45+win8+wpa81+wp8/AWSSDK.S3.dll b/packages/AWSSDK.S3.3.3.111.14/lib/portable-net45+win8+wpa81+wp8/AWSSDK.S3.dll deleted file mode 100644 index 0610561..0000000 Binary files a/packages/AWSSDK.S3.3.3.111.14/lib/portable-net45+win8+wpa81+wp8/AWSSDK.S3.dll and /dev/null differ diff --git a/packages/AWSSDK.S3.3.3.111.14/lib/uap/AWSSDK.S3.XML b/packages/AWSSDK.S3.3.3.111.14/lib/uap/AWSSDK.S3.XML deleted file mode 100644 index 389da7c..0000000 --- a/packages/AWSSDK.S3.3.3.111.14/lib/uap/AWSSDK.S3.XML +++ /dev/null @@ -1,28560 +0,0 @@ - - - - AWSSDK.S3 - - - - - Implementation for accessing S3 - - - - - - - Specialize the initialize of the client. - - - - - Create a signed URL allowing access to a resource that would - usually require authentication. - - - - When using query string authentication you create a query, - specify an expiration time for the query, sign it with your - signature, place the data in an HTTP request, and distribute - the request to a user or embed the request in a web page. - - - A PreSigned URL can be generated for GET, PUT, DELETE and HEAD - operations on your bucketName, keys, and versions. - - - The GetPreSignedUrlRequest that defines the - parameters of the operation. - determines if signing will fall back to SigV2 if the - signing region is us-east-1 - A string that is the signed http request. - - - - - - Marshalls the parameters for a presigned url for a preferred signing protocol. - - - - - - True if AWS4 signing will be used; if the expiry period in the request exceeds the - maximum allowed for AWS4 (one week), an ArgumentException is thrown. - - - - - - Create a signed URL allowing access to a resource that would - usually require authentication. - - - - When using query string authentication you create a query, - specify an expiration time for the query, sign it with your - signature, place the data in an HTTP request, and distribute - the request to a user or embed the request in a web page. - - - A PreSigned URL can be generated for GET, PUT, DELETE and HEAD - operations on your bucketName, keys, and versions. - - - The GetPreSignedUrlRequest that defines the - parameters of the operation. - A string that is the signed http request. - - - - - - Constructs AmazonS3Client with AWS Credentials - - AWS Credentials - - - - Constructs AmazonS3Client with AWS Credentials - - AWS Credentials - The region to connect. - - - - Constructs AmazonS3Client with AWS Credentials and an - AmazonS3Client Configuration object. - - AWS Credentials - The AmazonS3Client Configuration Object - - - - Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - - - - Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - The region to connect. - - - - Constructs AmazonS3Client with AWS Access Key ID, AWS Secret Key and an - AmazonS3Client Configuration object. - - AWS Access Key ID - AWS Secret Access Key - The AmazonS3Client Configuration Object - - - - Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - - - - Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - The region to connect. - - - - Constructs AmazonS3Client with AWS Access Key ID, AWS Secret Key and an - AmazonS3Client Configuration object. - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - The AmazonS3Client Configuration Object - - - - Creates the signer for the service. - - - - - Customizes the runtime pipeline. - - Runtime pipeline for the current client. - - - - Capture metadata for the service. - - - - - Disposes the service client. - - - - - This operation aborts a multipart upload. After a multipart upload is aborted, no - additional parts can be uploaded using that upload ID. The storage consumed by any - previously uploaded parts will be freed. However, if any part uploads are currently - in progress, those part uploads might or might not succeed. As a result, it might - be necessary to abort a given multipart upload multiple times in order to completely - free all storage consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts operation and ensure that the parts - list is empty. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - The bucket name to which the upload was taking place. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object for which the multipart upload was initiated. - Upload ID that identifies the multipart upload. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AbortMultipartUpload service method, as returned by S3. - REST API Reference for AbortMultipartUpload Operation - - - - This operation aborts a multipart upload. After a multipart upload is aborted, no - additional parts can be uploaded using that upload ID. The storage consumed by any - previously uploaded parts will be freed. However, if any part uploads are currently - in progress, those part uploads might or might not succeed. As a result, it might - be necessary to abort a given multipart upload multiple times in order to completely - free all storage consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts operation and ensure that the parts - list is empty. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - Container for the necessary parameters to execute the AbortMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AbortMultipartUpload service method, as returned by S3. - REST API Reference for AbortMultipartUpload Operation - - - - Completes a multipart upload by assembling previously uploaded parts. - - - - You first initiate the multipart upload and then upload all parts using the UploadPart - operation. After successfully uploading all relevant parts of an upload, you call - this operation to complete the upload. Upon receiving this request, Amazon S3 concatenates - all the parts in ascending order by part number to create a new object. In the Complete - Multipart Upload request, you must provide the parts list. You must ensure that the - parts list is complete. This operation concatenates the parts that you provide in - the list. For each part in the list, you must provide the part number and the ETag - value, returned after that part was uploaded. - - - - Processing of a Complete Multipart Upload request could take several minutes to complete. - After Amazon S3 begins processing the request, it sends an HTTP response header that - specifies a 200 OK response. While processing is in progress, Amazon S3 periodically - sends white space characters to keep the connection from timing out. Because a request - could fail after the initial 200 OK response has been sent, it is important that you - check the response body to determine whether the request succeeded. - - - - Note that if CompleteMultipartUpload fails, applications should be prepared - to retry the failed requests. For more information, see Amazon - S3 Error Best Practices. - - - - For more information about multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - GetBucketLifecycle has the following special errors: - -
  • - - Error code: EntityTooSmall - -
    • - - Description: Your proposed upload is smaller than the minimum allowed object size. - Each part must be at least 5 MB in size, except the last part. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPart - -
    • - - Description: One or more of the specified parts could not be found. The part might - not have been uploaded, or the specified entity tag might not have matched the part's - entity tag. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPartOrder - -
    • - - Description: The list of parts was not in ascending order. The parts list must be - specified in order by part number. - -
    • - - 400 Bad Request - -
  • - - Error code: NoSuchUpload - -
    • - - Description: The specified multipart upload does not exist. The upload ID might be - invalid, or the multipart upload might have been aborted or completed. - -
    • - - 404 Not Found - -
- - The following operations are related to CompleteMultipartUpload: - - - - Container for the necessary parameters to execute the CompleteMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CompleteMultipartUpload service method, as returned by S3. - REST API Reference for CompleteMultipartUpload Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 Developer Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Encryption - - - - The source object that you are copying can be encrypted or unencrypted. The source - object can be encrypted with server-side encryption using AWS managed encryption keys - (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side - encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers - and decrypts the data when you access it. - - - - You can optionally use the appropriate encryption-related headers to request server-side - encryption for the target object. You have the option to provide your own encryption - key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that - was used to encrypt the source object. You can even request encryption if the source - object was not encrypted. For more information about server-side encryption, see Using - Server-Side Encryption. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject operation to change the storage class of an - object that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 Service Developer Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 Developer Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Encryption - - - - The source object that you are copying can be encrypted or unencrypted. The source - object can be encrypted with server-side encryption using AWS managed encryption keys - (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side - encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers - and decrypts the data when you access it. - - - - You can optionally use the appropriate encryption-related headers to request server-side - encryption for the target object. You have the option to provide your own encryption - key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that - was used to encrypt the source object. You can even request encryption if the source - object was not encrypted. For more information about server-side encryption, see Using - Server-Side Encryption. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject operation to change the storage class of an - object that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 Service Developer Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 Developer Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Encryption - - - - The source object that you are copying can be encrypted or unencrypted. The source - object can be encrypted with server-side encryption using AWS managed encryption keys - (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side - encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers - and decrypts the data when you access it. - - - - You can optionally use the appropriate encryption-related headers to request server-side - encryption for the target object. You have the option to provide your own encryption - key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that - was used to encrypt the source object. You can even request encryption if the source - object was not encrypted. For more information about server-side encryption, see Using - Server-Side Encryption. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject operation to change the storage class of an - object that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 Service Developer Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - Container for the necessary parameters to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - - - - - - Deletes an analytics configuration for the bucket (specified by the analytics configuration - ID). - - - - To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to DeleteBucketAnalyticsConfiguration: - -
  • - - - -
  • - - - -
  • - - - -
- - Container for the necessary parameters to execute the DeleteBucketAnalyticsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketAnalyticsConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketAnalyticsConfiguration Operation - - - - - Deletes an inventory configuration (identified by the inventory ID) from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - Operations related to DeleteBucketInventoryConfiguration include: - - - - Container for the necessary parameters to execute the DeleteBucketInventoryConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketInventoryConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketInventoryConfiguration Operation - - - - Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified - by the metrics configuration ID) from the bucket. Note that this doesn't include the - daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketMetricsConfiguration Operation - - - - This implementation of the DELETE operation uses the policy subresource to delete - the policy of a specified bucket. If you are using an identity other than the root - user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - The bucket name. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketPolicy service method, as returned by S3. - REST API Reference for DeleteBucketPolicy Operation - - - - This implementation of the DELETE operation uses the policy subresource to delete - the policy of a specified bucket. If you are using an identity other than the root - user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - Container for the necessary parameters to execute the DeleteBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketPolicy service method, as returned by S3. - REST API Reference for DeleteBucketPolicy Operation - - - - Deletes the replication configuration from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutReplicationConfiguration - action. The bucket owner has these permissions by default and can grant it to others. - For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - It can take a while for the deletion of a replication configuration to fully propagate. - - - - For information about replication configuration, see Replication - in the Amazon S3 Developer Guide. - - - - The following operations are related to DeleteBucketReplication: - - - - Container for the necessary parameters to execute the DeleteBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketReplication service method, as returned by S3. - REST API Reference for DeleteBucketReplication Operation - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - The bucket that has the tag set to be removed. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketTagging service method, as returned by S3. - REST API Reference for DeleteBucketTagging Operation - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - Container for the necessary parameters to execute the DeleteBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketTagging service method, as returned by S3. - REST API Reference for DeleteBucketTagging Operation - - - - This operation removes the website configuration for a bucket. Amazon S3 returns a - 200 OK response upon successfully deleting a website configuration on - the specified bucket. You will get a 200 OK response if the website configuration - you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE operation requires the S3:DeleteBucketWebsite permission. - By default, only the bucket owner can delete the website configuration attached to - a bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which you want to remove the website configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketWebsite service method, as returned by S3. - REST API Reference for DeleteBucketWebsite Operation - - - - This operation removes the website configuration for a bucket. Amazon S3 returns a - 200 OK response upon successfully deleting a website configuration on - the specified bucket. You will get a 200 OK response if the website configuration - you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE operation requires the S3:DeleteBucketWebsite permission. - By default, only the bucket owner can delete the website configuration attached to - a bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the DeleteBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketWebsite service method, as returned by S3. - REST API Reference for DeleteBucketWebsite Operation - - - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - The bucket name of the lifecycle to delete. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - REST API Reference for DeleteLifecycleConfiguration Operation - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - Container for the necessary parameters to execute the DeleteLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - REST API Reference for DeleteLifecycleConfiguration Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key name of the object to delete. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key name of the object to delete. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - Container for the necessary parameters to execute the DeleteObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - This operation enables you to delete multiple objects from a bucket using a single - HTTP request. If you know the object keys that you want to delete, then this operation - provides a suitable alternative to sending individual delete requests, reducing per-request - overhead. - - - - The request contains a list of up to 1000 keys that you want to delete. In the XML, - you provide the object key names, and optionally, version IDs if you want to delete - a specific version of the object from a versioning-enabled bucket. For each key, Amazon - S3 performs a delete operation and returns the result of that delete, success, or - failure, in the response. Note that if the object specified in the request is not - found, Amazon S3 returns the result as deleted. - - - - The operation supports two modes for the response: verbose and quiet. By default, - the operation uses verbose mode in which the response includes the result of deletion - of each key in your request. In quiet mode the response includes only keys where the - delete operation encountered an error. For a successful deletion, the operation does - not return any information about the delete in the response body. - - - - When performing this operation on an MFA Delete enabled bucket, that attempts to delete - any versioned objects, you must include an MFA token. If you do not provide one, the - entire request will fail, even if there are non-versioned objects you are trying to - delete. If you provide an invalid token, whether there are versioned keys in the request - or not, the entire Multi-Object Delete request will fail. For information about MFA - Delete, see - MFA Delete. - - - - Finally, the Content-MD5 header is required for all Multi-Object Delete requests. - Amazon S3 uses the header value to ensure that your request body has not been altered - in transit. - - - - The following operations are related to DeleteObjects: - - - - Container for the necessary parameters to execute the DeleteObjects service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObjects service method, as returned by S3. - REST API Reference for DeleteObjects Operation - - - - Removes the entire tag set from the specified object. For more information about managing - object tags, see - Object Tagging. - - - - To use this operation, you must have permission to perform the s3:DeleteObjectTagging - action. - - - - To delete tags of a specific object version, add the versionId query - parameter in the request. You will need permission for the s3:DeleteObjectVersionTagging - action. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteObjectTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObjectTagging service method, as returned by S3. - REST API Reference for DeleteObjectTagging Operation - - - - Removes the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:PutBucketPublicAccessBlock - permission. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to DeletePublicAccessBlock: - - - - Container for the necessary parameters to execute the DeletePublicAccessBlock service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeletePublicAccessBlock service method, as returned by S3. - REST API Reference for DeletePublicAccessBlock Operation - - - - - - - - - Returns the default encryption configuration for an Amazon S3 bucket. For information - about the Amazon S3 default encryption feature, see Amazon - S3 Default Bucket Encryption. - - - - To use this operation, you must have permission to perform the s3:GetEncryptionConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to GetBucketEncryption: - - - - Container for the necessary parameters to execute the GetBucketEncryption service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketEncryption service method, as returned by S3. - REST API Reference for GetBucketEncryption Operation - - - - Returns an inventory configuration (identified by the inventory configuration ID) - from the bucket. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - The following operations are related to GetBucketInventoryConfiguration: - - - - Container for the necessary parameters to execute the GetBucketInventoryConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketInventoryConfiguration service method, as returned by S3. - REST API Reference for GetBucketInventoryConfiguration Operation - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - The name of the bucket for which to get the location. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLocation service method, as returned by S3. - REST API Reference for GetBucketLocation Operation - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - Container for the necessary parameters to execute the GetBucketLocation service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLocation service method, as returned by S3. - REST API Reference for GetBucketLocation Operation - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - The bucket name for which to get the logging information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLogging service method, as returned by S3. - REST API Reference for GetBucketLogging Operation - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - Container for the necessary parameters to execute the GetBucketLogging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLogging service method, as returned by S3. - REST API Reference for GetBucketLogging Operation - - - - Gets a metrics configuration (specified by the metrics configuration ID) from the - bucket. Note that this doesn't include the daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to GetBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the GetBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for GetBucketMetricsConfiguration Operation - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following operation is related to GetBucketNotification: - - - - Name of the bucket for which to get the notification configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketNotification service method, as returned by S3. - REST API Reference for GetBucketNotification Operation - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following operation is related to GetBucketNotification: - - - - Container for the necessary parameters to execute the GetBucketNotification service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketNotification service method, as returned by S3. - REST API Reference for GetBucketNotification Operation - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operation is related to GetBucketPolicy: - - - - The bucket name for which to get the bucket policy. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicy service method, as returned by S3. - REST API Reference for GetBucketPolicy Operation - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operation is related to GetBucketPolicy: - - - - Container for the necessary parameters to execute the GetBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicy service method, as returned by S3. - REST API Reference for GetBucketPolicy Operation - - - - Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket - is public. In order to use this operation, you must have the s3:GetBucketPolicyStatus - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - For more information about when Amazon S3 considers a bucket public, see The - Meaning of "Public". - - - - The following operations are related to GetBucketPolicyStatus: - - - - Container for the necessary parameters to execute the GetBucketPolicyStatus service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicyStatus service method, as returned by S3. - REST API Reference for GetBucketPolicyStatus Operation - - - - Retrieves the replication configuration for the given Amazon S3 bucket. - - Container for the necessary parameters to execute the GetBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketReplication service method, as returned by S3. - REST API Reference for GetBucketReplication Operation - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - The name of the bucket for which to get the payment request configuration - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketRequestPayment service method, as returned by S3. - REST API Reference for GetBucketRequestPayment Operation - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - Container for the necessary parameters to execute the GetBucketRequestPayment service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketRequestPayment service method, as returned by S3. - REST API Reference for GetBucketRequestPayment Operation - - - - Returns the tag set associated with the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - GetBucketTagging has the following special error: - -
  • - - Error code: NoSuchTagSetError - -
    • - - Description: There is no tag set associated with the bucket. - -
- - The following operations are related to GetBucketTagging: - - - - Container for the necessary parameters to execute the GetBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketTagging service method, as returned by S3. - REST API Reference for GetBucketTagging Operation - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - The name of the bucket for which to get the versioning information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketVersioning service method, as returned by S3. - REST API Reference for GetBucketVersioning Operation - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - Container for the necessary parameters to execute the GetBucketVersioning service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketVersioning service method, as returned by S3. - REST API Reference for GetBucketVersioning Operation - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET operation requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which to get the website configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketWebsite service method, as returned by S3. - REST API Reference for GetBucketWebsite Operation - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET operation requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the GetBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketWebsite service method, as returned by S3. - REST API Reference for GetBucketWebsite Operation - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - The bucket name for which to get the cors configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetCORSConfiguration service method, as returned by S3. - REST API Reference for GetCORSConfiguration Operation - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - Container for the necessary parameters to execute the GetCORSConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetCORSConfiguration service method, as returned by S3. - REST API Reference for GetCORSConfiguration Operation - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are still using previous version of the lifecycle configuration, it works. - For the earlier API description, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to GetBucketLifecycleConfiguration: - - - - The name of the bucket for which to get the lifecycle information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetLifecycleConfiguration service method, as returned by S3. - REST API Reference for GetLifecycleConfiguration Operation - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are still using previous version of the lifecycle configuration, it works. - For the earlier API description, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to GetBucketLifecycleConfiguration: - - - - Container for the necessary parameters to execute the GetLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetLifecycleConfiguration service method, as returned by S3. - REST API Reference for GetLifecycleConfiguration Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object to get. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object to get. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - Container for the necessary parameters to execute the GetObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Gets an object's current Legal Hold status. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLegalHold service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectLegalHold service method, as returned by S3. - REST API Reference for GetObjectLegalHold Operation - - - - Gets the Object Lock configuration for a bucket. The rule specified in the Object - Lock configuration will be applied by default to every new object placed in the specified - bucket. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLockConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectLockConfiguration service method, as returned by S3. - REST API Reference for GetObjectLockConfiguration Operation - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - The name of the bucket containing the object. - The object key. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - The name of the bucket containing the object. - The object key. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - Container for the necessary parameters to execute the GetObjectMetadata service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - Retrieves an object's retention settings. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectRetention service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectRetention service method, as returned by S3. - REST API Reference for GetObjectRetention Operation - - - - Returns the tag-set of an object. You send the GET request against the tagging subresource - associated with the object. - - - - To use this operation, you must have permission to perform the s3:GetObjectTagging - action. By default, the GET operation returns information about current version of - an object. For a versioned bucket, you can have multiple versions of an object in - your bucket. To retrieve tags of any other version, use the versionId query parameter. - You also need permission for the s3:GetObjectVersionTagging action. - - - - By default, the bucket owner has this permission and can grant this permission to - others. - - - - For information about the Amazon S3 object tagging feature, see Object - Tagging. - - - - The following operation is related to GetObjectTagging: - - - - Container for the necessary parameters to execute the GetObjectTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTagging service method, as returned by S3. - REST API Reference for GetObjectTagging Operation - - - - Return torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Amazon - S3 Torrent. - - - - You can get torrent only for objects that are less than 5 GB in size and that are - not encrypted using server-side encryption with customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - The following operation is related to GetObjectTorrent: - - - - The name of the bucket containing the object for which to get the torrent files. - The object key for which to get the information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTorrent service method, as returned by S3. - REST API Reference for GetObjectTorrent Operation - - - - Return torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Amazon - S3 Torrent. - - - - You can get torrent only for objects that are less than 5 GB in size and that are - not encrypted using server-side encryption with customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - The following operation is related to GetObjectTorrent: - - - - Container for the necessary parameters to execute the GetObjectTorrent service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTorrent service method, as returned by S3. - REST API Reference for GetObjectTorrent Operation - - - - Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:GetBucketPublicAccessBlock - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket - or an object, it checks the PublicAccessBlock configuration for both - the bucket (or the bucket that contains the object) and the bucket owner's account. - If the PublicAccessBlock settings are different between the bucket and - the account, Amazon S3 uses the most restrictive combination of the bucket-level and - account-level settings. - - - - For more information about when Amazon S3 considers a bucket or an object public, - see The - Meaning of "Public". - - - - The following operations are related to GetPublicAccessBlock: - - - - Container for the necessary parameters to execute the GetPublicAccessBlock service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetPublicAccessBlock service method, as returned by S3. - REST API Reference for GetPublicAccessBlock Operation - - - - This operation is useful to determine if a bucket exists and you have permission to - access it. The operation returns a 200 OK if the bucket exists and you - have permission to access it. Otherwise, the operation might return responses such - as 404 Not Found and 403 Forbidden. - - - - To use this operation, you must have permissions to perform the s3:ListBucket - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - Container for the necessary parameters to execute the HeadBucket service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the HeadBucket service method, as returned by S3. - REST API Reference for HeadBucket Operation - - - - This operation initiates a multipart upload and returns an upload ID. This upload - ID is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort operation - and Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload API and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart) and UploadPartCopy) requests must match the headers you - used in the request to initiate the upload by using CreateMultipartUpload. - - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, - kms:GenerateDataKey*, and kms:DescribeKey actions on the - key. These permissions are required because Amazon S3 must decrypt and read data from - the encrypted file parts before it completes the multipart upload. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - The following operations are related to CreateMultipartUpload: - - - - The name of the bucket to which to initiate the upload - Object key for which the multipart upload is to be initiated. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the InitiateMultipartUpload service method, as returned by S3. - REST API Reference for InitiateMultipartUpload Operation - - - - This operation initiates a multipart upload and returns an upload ID. This upload - ID is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort operation - and Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload API and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart) and UploadPartCopy) requests must match the headers you - used in the request to initiate the upload by using CreateMultipartUpload. - - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, - kms:GenerateDataKey*, and kms:DescribeKey actions on the - key. These permissions are required because Amazon S3 must decrypt and read data from - the encrypted file parts before it completes the multipart upload. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - The following operations are related to CreateMultipartUpload: - - - - Container for the necessary parameters to execute the InitiateMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the InitiateMultipartUpload service method, as returned by S3. - REST API Reference for InitiateMultipartUpload Operation - - - - Lists the analytics configurations for the bucket. You can have up to 1,000 analytics - configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. You should always check the IsTruncated element in the response. - If there are no more configurations to list, IsTruncated is set to false. - If there are more configurations to list, IsTruncated is set to true, - and there will be a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to ListBucketAnalyticsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketAnalyticsConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketAnalyticsConfigurations service method, as returned by S3. - REST API Reference for ListBucketAnalyticsConfigurations Operation - - - - Returns a list of inventory configurations for the bucket. You can have up to 1,000 - analytics configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory - - - - The following operations are related to ListBucketInventoryConfigurations: - - - - Container for the necessary parameters to execute the ListBucketInventoryConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketInventoryConfigurations service method, as returned by S3. - REST API Reference for ListBucketInventoryConfigurations Operation - - - - Lists the metrics configurations for the bucket. The metrics configurations are only - for the request metrics of the bucket and do not provide information on daily storage - metrics. You can have up to 1,000 configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For more information about metrics configurations and CloudWatch request metrics, - see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to ListBucketMetricsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketMetricsConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketMetricsConfigurations service method, as returned by S3. - REST API Reference for ListBucketMetricsConfigurations Operation - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBuckets service method, as returned by S3. - REST API Reference for ListBuckets Operation - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - Container for the necessary parameters to execute the ListBuckets service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBuckets service method, as returned by S3. - REST API Reference for ListBuckets Operation - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Container for the necessary parameters to execute the ListMultipartUploads service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. - Limits the response to keys that begin with the specified prefix. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - Container for the necessary parameters to execute the ListObjects service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Make sure to design - your application to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - To use this operation in an AWS Identity and Access Management (IAM) policy, you must - have permissions to perform the s3:ListBucket action. The bucket owner - has this permission by default and can grant this permission to others. For more information - about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - This section describes the latest revision of the API. We recommend that you use this - revised API for application development. For backward compatibility, Amazon S3 continues - to support the prior version of this API, ListObjects. - - - - To get a list of your buckets, see ListBuckets. - - - - The following operations are related to ListObjectsV2: - - - - Container for the necessary parameters to execute the ListObjectsV2 service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjectsV2 service method, as returned by S3. - REST API Reference for ListObjectsV2 Operation - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). This request returns a maximum of 1,000 - uploaded parts. The default number of parts returned is 1,000 parts. You can restrict - the number of parts returned by specifying the max-parts request parameter. - If your multipart upload consists of more than 1,000 parts, the response returns an - IsTruncated field with the value of true, and a NextPartNumberMarker - element. In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListParts: - - - - Name of the bucket to which the parts are being uploaded. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Object key for which the multipart upload was initiated. - Upload ID identifying the multipart upload whose parts are being listed. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListParts service method, as returned by S3. - REST API Reference for ListParts Operation - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). This request returns a maximum of 1,000 - uploaded parts. The default number of parts returned is 1,000 parts. You can restrict - the number of parts returned by specifying the max-parts request parameter. - If your multipart upload consists of more than 1,000 parts, the response returns an - IsTruncated field with the value of true, and a NextPartNumberMarker - element. In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListParts: - - - - Container for the necessary parameters to execute the ListParts service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListParts service method, as returned by S3. - REST API Reference for ListParts Operation - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - Container for the necessary parameters to execute the ListVersions service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - - Creates a new bucket. To create a bucket, you must register with Amazon S3 and have - a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed - to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information on bucket naming restrictions, - see Working - with Amazon S3 Buckets. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) - Region. For more information, see How - to Select a Region for Your Buckets. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - Hosting of Buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - The name of the bucket to create. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucket service method, as returned by S3. - REST API Reference for PutBucket Operation - - - - Creates a new bucket. To create a bucket, you must register with Amazon S3 and have - a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed - to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information on bucket naming restrictions, - see Working - with Amazon S3 Buckets. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) - Region. For more information, see How - to Select a Region for Your Buckets. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - Hosting of Buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - Container for the necessary parameters to execute the PutBucket service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucket service method, as returned by S3. - REST API Reference for PutBucket Operation - - - - Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration - is a bucket-level feature that enables you to perform faster data transfers to Amazon - S3. - - - - To use this operation, you must have permission to perform the s3:PutAccelerateConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The Transfer Acceleration state of a bucket can be set to one of the following two - values: - -
  • - - Enabled – Enables accelerated data transfers to the bucket. - -
  • - - Suspended – Disables accelerated data transfers to the bucket. - -
- - The GetBucketAccelerateConfiguration operation returns the transfer acceleration - state of a bucket. - - - - After setting the Transfer Acceleration state of a bucket to Enabled, it might take - up to thirty minutes before the data transfer rates to the bucket increase. - - - - The name of the bucket used for Transfer Acceleration must be DNS-compliant and must - not contain periods ("."). - - - - For more information about transfer acceleration, see Transfer - Acceleration. - - - - The following operations are related to PutBucketAccelerateConfiguration: - - - - Container for the necessary parameters to execute the PutBucketAccelerateConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketAccelerateConfiguration service method, as returned by S3. - REST API Reference for PutBucketAccelerateConfiguration Operation - - - - - - - Set the logging parameters for a bucket and to specify permissions for who can view - and modify the logging parameters. All logs are saved to buckets in the same AWS Region - as the source bucket. To set the logging status of a bucket, you must be the bucket - owner. - - - - The bucket owner is automatically granted FULL_CONTROL to all logs. You use the Grantee - request element to grant access to other people. The Permissions request - element specifies the kind of access the grantee has to the logs. - - - - Grantee Values - - - - You can specify the person (grantee) to whom you're assigning access rights (using - request elements) in the following ways: - -
  • - - By the person's ID: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> - </Grantee> - - - - DisplayName is optional and ignored in the request. - -
  • - - By Email address: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee> - - - - - The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl - request, appears as the CanonicalUser. - -
  • - - By URI: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee> - - -
- - To enable logging, you use LoggingEnabled and its children request elements. To disable - logging, you use an empty BucketLoggingStatus request element: - - - - <BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01" /> - - - - - For more information about server access logging, see Server - Access Logging. - - - - For more information about creating a bucket, see CreateBucket. For more information - about returning the logging status of a bucket, see GetBucketLogging. - - - - The following operations are related to PutBucketLogging: - - - - Container for the necessary parameters to execute the PutBucketLogging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketLogging service method, as returned by S3. - REST API Reference for PutBucketLogging Operation - - - - Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. - You can have up to 1,000 metrics configurations per bucket. If you're updating an - existing metrics configuration, note that this is a full replacement of the existing - metrics configuration. If you don't include the elements you want to keep, they are - erased. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to PutBucketMetricsConfiguration: - - - - GetBucketLifecycle has the following special error: - -
  • - - Error code: TooManyConfigurations - -
    • - - Description: You are attempting to create a new configuration but have already reached - the 1,000-configuration limit. - -
    • - - HTTP Status Code: HTTP 400 Bad Request - -
- - Container for the necessary parameters to execute the PutBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for PutBucketMetricsConfiguration Operation - - - - Enables notifications of specified events for a bucket. For more information about - event notifications, see Configuring - Event Notifications. - - - - Using this API, you can replace an existing notification configuration. The configuration - is an XML file that defines the event types that you want Amazon S3 to publish and - the destination where you want Amazon S3 to publish an event notification when it - detects an event of the specified type. - - - - By default, your bucket has no event notifications configured. That is, the notification - configuration will be an empty NotificationConfiguration. - - - - <NotificationConfiguration> - - - - </NotificationConfiguration> - - - - This operation replaces the existing notification configuration with the configuration - you include in the request body. - - - - After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification - Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, - and that the bucket owner has permission to publish to it by sending a test notification. - In the case of AWS Lambda destinations, Amazon S3 verifies that the Lambda function - permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. - For more information, see Configuring - Notifications for Amazon S3 Events. - - - - You can disable notifications by adding the empty NotificationConfiguration element. - - - - By default, only the bucket owner can configure notifications on a bucket. However, - bucket owners can use a bucket policy to grant permission to other users to set this - configuration with s3:PutBucketNotification permission. - - - - The PUT notification is an atomic operation. For example, suppose your notification - configuration includes SNS topic, SQS queue, and Lambda function configurations. When - you send a PUT request with this configuration, Amazon S3 sends test messages to your - SNS topic. If the message fails, the entire PUT operation will fail, and Amazon S3 - will not add the configuration to your bucket. - - - - Responses - - - - If the configuration in the request body includes only one TopicConfiguration - specifying only the s3:ReducedRedundancyLostObject event type, the response - will also include the x-amz-sns-test-message-id header containing the - message ID of the test notification sent to the topic. - - - - The following operation is related to PutBucketNotificationConfiguration: - - - - Container for the necessary parameters to execute the PutBucketNotification service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketNotification service method, as returned by S3. - REST API Reference for PutBucketNotification Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - The MD5 hash of the request body. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - Container for the necessary parameters to execute the PutBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Creates a replication configuration or replaces an existing one. For more information, - see Replication - in the Amazon S3 Developer Guide. - - - - To perform this operation, the user or role performing the operation must have the - iam:PassRole - permission. - - - - Specify the replication configuration in the request body. In the replication configuration, - you provide the name of the destination bucket where you want Amazon S3 to replicate - objects, the IAM role that Amazon S3 can assume to replicate objects on your behalf, - and other relevant information. - - - - A replication configuration must include at least one rule, and can contain a maximum - of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects - in the source bucket. To choose additional subsets of objects to replicate, add a - rule for each subset. All rules must specify the same destination bucket. - - - - To specify a subset of the objects in the source bucket to apply a replication rule - to, add the Filter element as a child of the Rule element. You can filter objects - based on an object key prefix, one or more object tags, or both. When you add the - Filter element in the configuration, you must also add the following elements: DeleteMarkerReplication, - Status, and Priority. - - - - For information about enabling versioning on a bucket, see Using - Versioning. - - - - By default, a resource owner, in this case the AWS account that created the bucket, - can perform this operation. The resource owner can also grant others permissions to - perform the operation. For more information about permissions, see Specifying - Permissions in a Policy and Managing - Access Permissions to Your Amazon S3 Resources. - - - - Handling Replication of Encrypted Objects - - - - By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side - encryption with CMKs stored in AWS KMS. To replicate AWS KMS-encrypted objects, add - the following: SourceSelectionCriteria, SseKmsEncryptedObjects, - Status, EncryptionConfiguration, and ReplicaKmsKeyID. - For information about replication configuration, see Replicating - Objects Created with SSE Using CMKs stored in AWS KMS. - - - - For information on PutBucketReplication errors, see ReplicationErrorCodeList - - - - - The following operations are related to PutBucketReplication: - - - - Container for the necessary parameters to execute the PutBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketReplication service method, as returned by S3. - REST API Reference for PutBucketReplication Operation - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - The bucket name. - Container for Payer. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketRequestPayment service method, as returned by S3. - REST API Reference for PutBucketRequestPayment Operation - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - Container for the necessary parameters to execute the PutBucketRequestPayment service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketRequestPayment service method, as returned by S3. - REST API Reference for PutBucketRequestPayment Operation - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging. - - - - Within a bucket, if you add a tag that has the same key as an existing tag, the new - value overwrites the old value. For more information, see Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional operation is currently in progress against - this resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - The bucket name. - A property of PutBucketTaggingRequest used to execute the PutBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketTagging service method, as returned by S3. - REST API Reference for PutBucketTagging Operation - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging. - - - - Within a bucket, if you add a tag that has the same key as an existing tag, the new - value overwrites the old value. For more information, see Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional operation is currently in progress against - this resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - Container for the necessary parameters to execute the PutBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketTagging service method, as returned by S3. - REST API Reference for PutBucketTagging Operation - - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT operation requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - Amazon S3 has a limitation of 50 routing rules per website configuration. If you require - more than 50 routing rules, you can use object redirect. For more information, see - Configuring - an Object Redirect in the Amazon Simple Storage Service Developer Guide. - - - The bucket name. - Container for the request. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketWebsite service method, as returned by S3. - REST API Reference for PutBucketWebsite Operation - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT operation requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - Amazon S3 has a limitation of 50 routing rules per website configuration. If you require - more than 50 routing rules, you can use object redirect. For more information, see - Configuring - an Object Redirect in the Amazon Simple Storage Service Developer Guide. - - - Container for the necessary parameters to execute the PutBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketWebsite service method, as returned by S3. - REST API Reference for PutBucketWebsite Operation - - - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - The name of the bucket for which to set the configuration. - A property of PutLifecycleConfigurationRequest used to execute the PutLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutLifecycleConfiguration service method, as returned by S3. - REST API Reference for PutLifecycleConfiguration Operation - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - Container for the necessary parameters to execute the PutLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutLifecycleConfiguration service method, as returned by S3. - REST API Reference for PutLifecycleConfiguration Operation - - - - - - - - - - - - - - - - - Configuration for accessing AmazonS3 service - - - Configuration for accessing Amazon S3 service - - - - - When true, requests will always use path style addressing. - - - - - Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. - To use this feature, the bucket name should be DNS compliant names and should not contain periods (.). - The following APIs are not supported and are sent to the regular region endpoint, even if this option is enabled: -
    -
  1. PutBucket
    2. -
  2. ListBuckets
    3. -
  3. DeleteBucket
    4. -
- - - This option cannot be used at the same time as UseDualstackEndpoint. - - - - - If set to true and the service package supports it the region identified in the arn for a resource - will be used when making the service request. - - - - - USEast1RegionalEndpointValue determines wheter or not - to send the us-east-1 s3 requests to the regional endpoint or to - the legacy global endpoint. - This flags takes precedence over the AWS_S3_US_EAST_1_REGIONAL_ENDPOINT - environment variable and the credential file. - - - - - This method contains custom initializations for the config object. - - - - - Given this client configuration, returns the service url - - The service url in the form of a string - - - - If the client is configured to hit us-east-1 with the S3UsEast1RegionalEndpointValue flag not set, - this method checks whether the environment variable is present or the credential file contains a valid value - - A Nullable of S3UsEast1RegionalEndpointValue representing the client configuration for the regional us-east-1 endpoint - - - - Validate that the config object is properly configured. - - - - - Checks the AWS_S3_US_EAST_1_REGIONAL_ENDPOINT environment variable for the presence of the s3 regional flag - - A nullable of S3UsEast1RegionalEndpointValue - - - - Checks the credential file for the presence of the s3 regional flag - - A nullable of S3UsEast1RegionalEndpointValue - - - - Default constructor - - - - - The constant used to lookup in the region hash the endpoint. - - - - - Gets the ServiceVersion property. - - - - - Gets the value of UserAgent property. - - - - - Base exception for S3 errors. - - - - - Construct an instance of AmazonS3Exception - - - - - - Construct an instance of AmazonS3Exception - - - - - - - Construct an instance of AmazonS3Exception - - - - - - Construct an instance of AmazonS3Exception - - - - - - - - - - Construct an instance of AmazonS3Exception - - - - - - - - - - - Construct an instance of AmazonS3Exception - - - - - - - - - - - - Construct an instance of AmazonS3Exception - - - - - - - - - - - - - A special token that helps AWS troubleshoot problems. - - - - - A special token that helps AWS troubleshoot S3 accelerate problems. - - - - - The entire response body for this exception, if available. - - - - - The region that the AmazonS3Exception relates to. - - - - - Gets the exception message. - - - - - Extensions methods added to Amazon.Arn type to help parse S3 specific resources from the ARN. - - - - - Attempt to parse the resource component of the ARN into access point resource name. - - An AWS ARN to parse - The access point resouce identifier found in the ARN. - True if the ARN contains an access point resource identifier. - - - - Attempt to parse the resource component of the ARN into bucket name. - - An AWS ARN to parse - The bucket name found in the ARN. - True if the ARN contains a bucket name. - - - - The file format used when exporting data to Amazon S3. - - - - - CSV file format. - - - - - Construct instance of AnalyticsS3ExportFileFormat. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to an AnalyticsS3ExportFileFormat. - - - - - - - Represents the accelerate status for a bucket. - - - - - Bucket acceleration is enabled. - - - - - Bucket acceleration is suspended. - - - - - Construct instance of BucketAccelerateStatus. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to an BucketAccelerateStatus - - - - - - - The status of the delete marker replication. - - - - - Delete marker replication is enabled. - - - - - Delete marker replication is disabled. - - - - - Construct instance of DeleteMarkerReplicationStatus. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to a DeleteMarkerReplicationStatus - - - - - - - A list of all possible CannedACLs that can be used - for S3 Buckets or S3 Objects. For more information about CannedACLs, refer to - . - - - - - Owner gets FULL_CONTROL. - No one else has access rights (default). - - - - - Owner gets FULL_CONTROL. - No one else has access rights (default). - - - - - Owner gets FULL_CONTROL and the anonymous principal is granted READ access. - If this policy is used on an object, it can be read from a browser with no authentication. - - - - - Owner gets FULL_CONTROL, the anonymous principal is granted READ and WRITE access. - This can be a useful policy to apply to a bucket, but is generally not recommended. - - - - - Owner gets FULL_CONTROL, and any principal authenticated as a registered Amazon - S3 user is granted READ access. - - - - - Owner gets FULL_CONTROL. Amazon EC2 gets READ access to GET an - Amazon Machine Image (AMI) bundle from Amazon S3. - - - - - Object Owner gets FULL_CONTROL, Bucket Owner gets READ - This ACL applies only to objects and is equivalent to private when used with PUT Bucket. - You use this ACL to let someone other than the bucket owner write content (get full control) - in the bucket but still grant the bucket owner read access to the objects. - - - - - Object Owner gets FULL_CONTROL, Bucket Owner gets FULL_CONTROL. - This ACL applies only to objects and is equivalent to private when used with PUT Bucket. - You use this ACL to let someone other than the bucket owner write content (get full control) - in the bucket but still grant the bucket owner full rights over the objects. - - - - - The LogDelivery group gets WRITE and READ_ACP permissions on the bucket. - - - - - Construct instance of S3CannedACL. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to an S3CannedACL - - - - - - - A list of all possible S3 Bucket region possibilities. For - more information, refer to - . - - - - - Specifies that the S3 Bucket should use US locality. - This is the default value. - - - - - Specifies that the S3 Bucket should use US-EAST-2 locality. - - - - - Specifies that the S3 Bucket should use EU locality which defaults to EU-WEST-1 - - - - - Specifies that the S3 Bucket should use the EU-NORTH-1 locality. - - - - - Specifies that the S3 Bucket should use the EU-WEST-1 locality. - - - - - Specifies that the S3 Bucket should use the EU-WEST-2 locality. - - - - - Specifies that the S3 Bucket should use the EU-WEST-3 locality. - - - - - Specifies that the S3 Bucket should use the EU-CENTRAL-1 locality. - - - - - Specifies that the S3 Bucket should use US-WEST-1 locality. - - - - - Specifies that the S3 Bucket should use US-WEST-2 locality. - - - - - Specifies that the S3 Bucket should use US-GOV-EAST-1 locality. - - - - - Specifies that the S3 Bucket should use US-GOV-WEST-1 locality. - - - - - Specifies that the S3 Bucket should use the AP-EAST-1 locality. - - - - - Specifies that the S3 Bucket should use the AP-SOUTHEAST-1 locality. - - - - - Specifies that the S3 Bucket should use the AP-SOUTHEAST-2 locality. - - - - - Specifies that the S3 Bucket should use the AP-NORTHEAST-1 locality. - - - - - Specifies that the S3 Bucket should use the AP-NORTHEAST-2 locality. - - - - - Specifies that the S3 Bucket should use the AP-NORTHEAST-3 locality. - - - - - Specifies that the S3 Bucket should use the AP-SOUTH-1 locality. - - - - - Specifies that the S3 Bucket should use the SA-EAST-1 locality. - - - - - Specifies that the S3 Bucket should use CN-NORTH-1 locality. - - - - - Specifies that the S3 Bucket should use CN-NORTHWEST-1 locality. - - - - - Specifies that the S3 Bucket should use CA-CENTRAL-1 locality. - - - - - Specifies that the S3 Bucket should use US-WEST-1 locality. - - - - - Specifies that the S3 Bucket should use CN-NORTH-1 locality. - - - - - Specifies that the S3 Bucket should use US-GOV-WEST-1 locality. - - - - - Construct instance of S3Region. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to the S3Region class - - - - - - - A list of all ACL permissions. For more information, refer to - . - - - - - When applied to a bucket, grants permission to list the bucket. - When applied to an object, this grants permission to read the - object data and/or metadata. - - - - - When applied to a bucket, grants permission to create, overwrite, - and delete any object in the bucket. This permission is not - supported for objects. - - - - - Grants permission to read the ACL for the applicable bucket or object. - The owner of a bucket or object always has this permission implicitly. - - - - - Gives permission to overwrite the ACP for the applicable bucket or object. - The owner of a bucket or object always has this permission implicitly. - Granting this permission is equivalent to granting FULL_CONTROL because - the grant recipient can make any changes to the ACP. - - - - - Provides READ, WRITE, READ_ACP, and WRITE_ACP permissions. - It does not convey additional rights and is provided only for convenience. - - - - - Gives permission to restore an object that is currently stored in Amazon Glacier - for archival storage. - - - - - Construct S3Permission. - - - - - - Construct instance of S3Permission. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - - Gets and sets the HeaderName property. - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to an S3Permission - - - - - - - An enumeration of all Metadata directives that - can be used for the CopyObject operation. - - - - - Specifies that the metadata is copied from the source object. - - - - - Specifies that the metadata is replaced with metadata provided in the request. - All original metadata is replaced by the metadata you specify. - - - - - An enumeration of all protocols that the pre-signed - URL can be created against. - - - - - https protocol will be used in the pre-signed URL. - - - - - http protocol will be used in the pre-signed URL. - - - - - An enumeration of supported HTTP verbs - - - - - The GET HTTP verb. - - - - - The HEAD HTTP verb. - - - - - The PUT HTTP verb. - - - - - The DELETE HTTP verb. - - - - - S3 Storage Class Definitions - - - - - The STANDARD storage class, which is the default - storage class for S3. - - Durability 99.999999999%; Availability 99.99% over a given year. - - - - - REDUCED_REDUNDANCY provides the same availability as standard, but at a lower durability. - - Durability 99.99%; Availability 99.99% over a given year. - - - - - The GLACIER storage is for object that are stored in Amazon Glacier. - This storage class is for objects that are for archival purpose and - get operations are rare. - - Durability 99.999999999% - - - - - The STANDARD_IA storage is for infrequently accessed objects. - This storage class is for objects that are long-lived and less frequently accessed, - like backups and older data. - - Durability 99.999999999%; Availability 99.9% over a given year. - - - - - The ONEZONE_IA storage is for infrequently accessed objects. It is similiar to STANDARD_IA, but - only stores object data within one Availablity Zone in a given region. - - Durability 99.999999999%; Availability 99% over a given year. - - - - - IntelligentTiering makes it easy to lower your overall cost of storage by automatically placing data in the storage - class that best matches the access patterns for the storage. With IntelligentTiering, you don’t need to define - and manage individual policies for lifecycle data management or write code to transition objects - between storage classes. Instead, you can use IntelligentTiering to manage transitions between Standard and - S-IA without writing any application code. IntelligentTiering also manages transitions automatically to - Glacier for long term archive in addition to S3 storage classes. - - - - - S3 Glacier Deep Archive provides secure, durable object storage class for long term data archival. - It is the ideal storage class to make an archival, durable copy of data that rarely, if ever, needs to be accessed. - It can be used as an offline backup for their most important data assets and to meet long-term retention needs. - - - - - Construct an instance of S3StorageClass. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to S3StorageClass. - - - - - - - The constants for the known event names used by S3 notification. S3 might add new - events before the SDK is updated. In which case the names listed in the S3 documentation - will work as well as these constants. - - - - - An event that says an object has been lost in the reduced redundancy storage. - - - - - A list of all server-side encryption methods for customer provided encryption keys. - - - - - No server side encryption to be used. - - - - - Use AES 256 server side encryption. - - - - - Constructs an instance of ServerSideEncryptionCustomerMethod. - - - - - - Finds the constant for the unique value. - - - - - - - Converts string to ServerSideEncryptionCustomerMethod. - - - - - - - A list of all server-side encryption methods. - - - - - No server side encryption to be used. - - - - - Use AES 256 server side encryption. - - - - - Use AWS Key Management Service for server side encryption. - - - - - Construct instance of ServerSideEncryptionMethod. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to ServerSideEncryptionCustomerMethod. - - - - - - - A list of all grantee types. - - - - - The predefined group. - - - - - The email address of an AWS account - - - - - The canonical user ID of an AWS account - - - - - Construct an instance of GranteeType. - - - - - - Finds the constant for the unique value. - - - - - - - Convert a string to GranteeType. - - - - - - - A list of all lifecycle statuses. - - - - - The rule is enabled. - - - - - The rule is disabled. - - - - - Constructs an instance LifecycleRuleStatus. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to LifecycleRuleStatus. - - - - - - - A list of all version statuses. - - - - - The rule is off. - - - - - The rule is suspended. - - - - - The rule is enabled. - - - - - Construct an instance of VersionStatus. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to VersionStatus. - - - - - - - A list of all encoding types. - - - - - Url encoding. - - - - - Constructs intance of EncodingType - - - - - - Finds the constant for the unique value. - - - - - - - Converts string to EncodingType - - - - - - - The bucket event for which to send notifications. - - - - - The event encapsulates all the object create events - - - - - Event for put operations - - - - - Event for post operations - - - - - Event for copy operations - - - - - Event for completing a multi part upload - - - - - This event encapsulates all the object removed events - - - - - Event for object removed, delete operation. - - - - - Event for object removed, delete marker created operation. - - - - - Event for objects stored in reduced redundancy and S3 detects the object is lost - - - - - Event for all object restore - - - - - Event for restore post operations. - - - - - Event for when object restore is completed. - - - - - Event for replication of all - - - - - Event for operation failed replication - - - - - Evemt for replication operation not tracked - - - - - Event for replication operation missed threshold - - - - - Event for operation replicated after threshold - - - - - Constructs instance of EventType. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to EventType. - - - - - - - Compares if the ConstantClass instances are equals. - - - - - - - Compares if the ConstantClass instances are equals. This is ovewritten to handle the - discrepancy with S3 events coming from Lambda that don't have the prefix "s3:". - - - - - - - A list of all Inventory Formats. - - - - - CSV inventory format - - - - - ORC inventory format - - - - - Parquet inventory format - - - - - Construct instance of InventoryFormat. - - - - - - Finds the constant for the unique value. - - The string representation of the InventoryFormat. - The InventoryFormat object for that string. - - - - Convert string to InventoryFormat. - - - - - - - A list of inventory included object versions. - - - - - All Inventory Included Object Versions - - - - - Current Inventory Included Object Versions - - - - - Construct instance of InventoryIncludedObjectVersions. - - - - - - Finds the constant for the unique value. - - The string representation of the InventoryIncludedObjectVersions. - The InventoryIncludedObjectVersions object for that string. - - - - Convert string to InventoryIncludedObjectVersions. - - - - - - - A list of inventory frequencies. - - - - - Daily Inventory Frequency - - - - - Weekly Inventory Frequency - - - - - Construct instance of InventoryFrequency. - - - - - - Finds the constant for the unique value. - - The string representation of the InventoryFrequency. - The InventoryFrequency object for that string. - - - - Convert string to InventoryFrequency. - - - - - - - A list of inventory optional fields. - - - - - InventoryOptionalField for Size - - - - - InventoryOptionalField for LastModifiedDate - - - - - InventoryOptionalField for StorageClass - - - - - InventoryOptionalField for ETag - - - - - InventoryOptionalField for IsMultipartUploaded - - - - - InventoryOptionalField for ReplicationStatus - - - - - InventoryOptionalField for EncryptionStatus - - - - - InventoryOptionalField for ObjectLockRetainUntilDate - - - - - InventoryOptionalField for ObjectLockMode - - - - - InventoryOptionalField for ObjectLockLegalHoldStatus - - - - - InventoryOptionalField for IntelligentTieringAccessTier - - - - - Construct instance of InventoryOptionalField. - - - - - - Finds the constant for the unique value. - - The string representation of the InventoryOptionalField. - The InventoryIncludedObjectVersions object for that string. - - - - Convert string to InventoryOptionalField. - - - - - - - The status of the replication job associated with this source object. - - - - - The object is pending replication. - - - - - The object has been replicated. - - - - - The object was created as a result of replication. - - - - - The object replication has failed due to a customer-attributable reason, and the replication will not be attempted again. - - - - - Construct instance of ReplicationStatus. - - - - - - Finds the constant for the unique value. - - The string representation of the ReplicationStatus. - The ReplicationStatus object for that string. - - - - Convert string to ReplicationStatus. - - - - - - - Whether a replication rule is applied or ignored. - - - - - The rule will be applied. - - - - - The rule will be ignored. - - - - - Construct instance of ReplicationRuleStatus - - - - - - Finds the constant for the unique value. - - The string representation of the ReplicationRuleStatus. - The ReplicationRuleStatus object for that string. - - - - Convert string to ReplicationRuleStatus. - - - - - - - Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request. - - - - - The object tag-set is copied from the source object. - - - - - The object tag-set is replaced with tag-set provided in the request. - - - - - Construct instance of TaggingDirective - - - - - Finds the constant for the unique value. - - The string representation of the TaggingDirective. - The TaggingDirective object for that string. - - - - Convert string to TaggingDirective. - - - - - All enumerations type for retrieval tier for Glacier restore. - - - - - Standard Tier for Glacier restore. - - - - - Bulk Tier for Glacier restore. - - - - - Expedited Tier for Glacier restore. - - - - - Construct instance of RestoreObjectRequestGlacierJobTier - - - - - - Finds the constant for the unique value. - - The string representation of the RestoreObjectRequestGlacierJobTier. - The RestoreObjectRequestGlacierJobTier object for that string. - - - - Convert string to RestoreObjectRequestGlacierJobTier. - - - - - - - The version of the output schema to use when exporting data. - - - - - The schema output version V_1. - - - - - Construct instance of StorageClassAnalysisSchemaVersion - - - - - - Finds the constant for the unique value. - - The string representation of the StorageClassAnalysisSchemaVersion. - The StorageClassAnalysisSchemaVersion object for that string. - - - - Convert string to StorageClassAnalysisSchemaVersion. - - - - - - - Acknowledges that requester pays for the operation. - - - - - Requester pays for the operation. - - - - - Finds the RequestPayer instance for the string value. - - - - - Converts string to RequestPayer instance - - - - - The response from S3 that it confirms that requester pays. - - - - - S3 acknowledges that the requester pays. - - - - - Finds the RequestCharged instance for the string value - - - - - converts the string to RequestCharged instance - - - - - The override value for the owner of the replica object. - - - - - Overrides destination bucket's owner. - - - - - Finds the OwnerOverride instance for the string value - - - - - converts the string to OwnerOverride instance - - - - - The replication for KMS encrypted S3 objects is disabled if status is not Enabled. - - - - - The replication for KMS encrypted S3 objects is enabled. - - - - - The replication for KMS encrypted S3 objects is disabled. - - - - - - - - - - Finds the SseKmsEncryptedObjectsStatus instance for the string value - - - - - Converts the string to SseKmsEncryptedObjectsStatus instance - - - - - Specify how headers will be handled. - - - - - Headers will be usable in SELECT clause. - - - - - Headers will be skipped - - - - - No header is present. - - - - - Finds the FileHeaderInfo instance for the string value - - - - - - - Converts the string to FileHeaderInfo instance - - - - - Specifies whether existing object replication is enabled. - - - - - Enable the replication of existing objects - - - - - Disable the replication of existing objects - - - - - Finds the ExistingObjectReplicationStatus instance for the string value - - - - - - - Converts the string to ExistingObjectReplicationStatus instance - - - - - Describes when fields in output should be surrounded with quotes. - - - - - Specifies that fields in output should always be surrounded in quotes. - - - - - Specifies that fields in output should be surrounded in quotes as necessary. - - - - - Finds the QuoteFields instance for the string value - - string value that maps to QuoteFields enum - QuoteFields enum - - - - Converts the string to QuoteFields instance - - - - - Type of the expression provided in the Expression member. - - - - - SQL expression - - - - - Finds the ExpressionType instance for the string value - - string value that maps to ExpressionType enum - ExpressionType enum - - - - Converts the string to ExpressionType instance - - - - - Indicates what type of job is being initiated. - - - - - Finds the RestoreRequestType instance for the string value - - - - - Converts the string to RestoreRequestType instance - - - - - The type of JSON. - - - - - Finds the JsonType instance for the string value - - - - - Converts the string to JsonType instance - - - - - Specifies object's compression format. - - - - - Finds the CompressionType instance for the string value - - - - - Converts the string to CompressionType instance - - - - - The type of ObjectLockEnabled - - - - - Finds the ObjectLockEnabled instance for the string value - - - - - Converts the string to ObjectLockEnabled instance - - - - - The type of ObjectLockLegalHoldStatus - - - - - Finds the ObjectLockLegalHoldStatus instance for the string value - - - - - Converts the string to ObjectLockLegalHoldStatus instance - - - - - The type of ObjectLockRetentionMode - - - - - Finds the ObjectLockRetentionMode instance for the string value - - - - - Converts the string to ObjectLockRetentionMode instance - - - - - The type of ObjectLockMode - - - - - Finds the ObjectLockMode instance for the string value - - - - - Converts the string to ObjectLockMode instance - - - - - Specifies whether the replication time is enabled. - - - - - Replication time is enabled. - - - - - Replication time is disabled. - - - - - Finds the ReplicationTimeStatus instance for the string value - - - - - - - Converts the string to ReplicationTimeStatus instance - - - - - - Specifies whether the replication metrics are enabled. - - - - - Replication metrics are enabled. - - - - - Replication metrics are disabled. - - - - - Finds the MetricsStatus instance for the string value - - - - - - - Converts the string to MetricsStatus instance - - - - - - Custom pipeline handler to clean up streams in case of an exception. - - - - - Catch exceptions and clean up any open streams. - - - - - - Catch exceptions and clean up any open streams. - - - - - - - Custom pipeline handler to enable sig V4 for Get requests. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Custom pipeline handler to enable sig V4 for Get requests. - - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Calls the post invoke logic after calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls the and post invoke logic after calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Constructor for AmazonS3RetryPolicy. - - The IClientConfig object - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - - - a value if it can be determined, or null if the IO-bound calculations need to be done - - - - Return true if the request should be retried. Implements additional checks - specific to S3 on top of the checks in DefaultRetryPolicy. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Constructor for AmazonS3StandardRetryPolicy. - - The IClientConfig object - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - - - a value if it can be determined, or null if the IO-bound calculations need to be done - - - - Return true if the request should be retried. Implements additional checks - specific to S3 on top of the checks in StandardRetryPolicy. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Constructor for AmazonS3AdaptiveRetryPolicy. - - The IClientConfig object - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - - - a value if it can be determined, or null if the IO-bound calculations need to be done - - - - Return true if the request should be retried. Implements additional checks - specific to S3 on top of the checks in AdaptiveRetryPolicy. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Marker interface to identify AmazonS3EncryptionClient. - - - - - Service metadata for Amazon S3 service - - - - - Gets the value of the Service Id. - - - - - Gets the dictionary that gives mapping of renamed operations - - - - - The parameters to request an abort of a multipart upload. - - - After a multipart upload is aborted, no additional parts can be uploaded using that upload ID. - The storage consumed by any previously uploaded parts will be freed. However, if any part uploads - are currently in progress, those part uploads might or might not succeed. As a result, it might be - necessary to abort a given multipart upload multiple times in order to completely free all storage - consumed by all parts. - - - - - The bucket name to which the upload was taking place. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The key of the S3 object that was being uploaded. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - The upload id for the in-progress multipart upload that should be aborted. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the AbortMultipartUpload response metadata. - The AbortMultipartUpload operation has a void result type. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Bucket accelerate configuration. - - - - - The accelerate status of the bucket. - - - - - AccessControlTranslation class - - - - - The override value for the owner of the replica object. - - - - - Class for AnalyticsAndOperator - A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. - The operator must have at least two predicates, and an object must match all of the predicates - in order for the filter to apply. - - Note: The current implementation restricts the usage to atmost one AnalyticsPrefixPredicate - and any number of AnalyticsTagPredicates. - - - - Class for AnalyticsConfiguration - - - - - The identifier used to represent an analytics configuration. - - - - - The filter used to describe a set of objects for analyses. - A filter must have exactly one prefix, one tag, or one conjunction (AnalyticsAndOperator). - If no filter is provided, all objects will be considered in any analysis. - - - - - If present, it indicates that data related to access patterns will be collected - and made available to analyze the tradeoffs between different storage classes. - - - - - Class for AnalyticsExportDestination - - - - - A destination signifying output to an S3 bucket. - - - - - Filter class for Metrics. - - - - - Filter Predicate setup for specific filter types. - - - - - Filter Predicate abstract class for specific filter types to be derived from. - - - - - Abstract class that can be used over logical filter predicates,i.e. AND/OR. - - - - - Internal implementation of Metrics Predicate visitor interface. - - - - - Interface for implementing visitor pattern in Analytics Predicate Filter. - - - - - Interface for implementing visitor pattern in Inventory Predicate Filter. - - - - - Interface for implementing visitor pattern in Metrics Predicate Filter. - - - - - Internal implementation of Inventory Predicate visitor interface. - - - - - Internal implementation of Metrics Predicate visitor interface. - - - - - Defines the interface that is used to visit all the different - implementations of - - - - - Visit a - - - - - - Visit a - - - - - - Visit a - - - - - - Implementation of to marshall . - - - - - AbortIncompleteMultipartUpload Unmarshaller - - - - - Abort Multipart Upload Request Marshaller - - - - - Response Unmarshaller for AbortMultipartUpload operation - - - - - AnalyticsConfiguration Unmarshaller - - - - - AnalyticsExportDestinationUnmarshaller - - - - - AnalyticsFilter Unmarshaller - - - - - AnalyticsS3BucketDestination Unmarshaller - - - - - Bucket Unmarshaller - - - - - CommonPrefixesItem Unmarshaller - - - - - Complete Multipart Upload Request Marshaller - - - - - Response Unmarshaller for CompleteMultipartUpload operation - - - - - ContentsItem Unmarshaller - - - - - Copy Object Request Marshaller - - - - - Response Unmarshaller for CopyObject operation - - - - - Upload Part Copy Request Marshaller - - - - - Response Unmarshaller for CopyPart operation - - - - - CORSRule Unmarshaller - - - - - Response Unmarshaller for DefaultRetention Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Delete InventoryConfiguration Request Marshaller - - - - - Response Unmarshaller for DeleteAnalyticsConfiguration operation - - - - - Response Unmarshaller for DeleteCORSConfiguration operation - - - - - Delete InventoryConfiguration Request Marshaller - - - - - Response Unmarshaller for DeleteInventoryConfiguration operation - - - - - Delete Bucket MetricsConfiguration Request Marshaller - - - - - Response Unmarshaller for DeleteBucketMetricsConfiguration operation - - - - - Delete Bucket Policy Request Marshaller - - - - - Response Unmarshaller for DeleteBucketPolicy operation - - - - - Delete Bucket Request Marshaller - - - - - Response Unmarshaller for DeleteBucket operation - - - - - Delete Bucket Tagging Request Marshaller - - - - - Response Unmarshaller for DeleteBucketTagging operation - - - - - Delete Bucket Website Request Marshaller - - - - - Response Unmarshaller for DeleteBucketWebsite operation - - - - - Delete Bucket Cors Request Marshaller - - - - - DeletedObject Unmarshaller - - - - - Delete Bucket Lifecycle Request Marshaller - - - - - Response Unmarshaller for DeleteBucketLifecycle operation - - - - - Delete Object Request Marshaller - - - - - Response Unmarshaller for DeleteObject operation - - - - - Delete Objects Request Marshaller - - - - - Response Unmarshaller for DeleteObjects operation - - - - - DeleteObjectTaggingRequest Marshaller - - - - - Marshall DeleteObjectTaggingRequest object into an http request. - - - - - Marshall DeleteObjectTaggingRequest object into an http request. - - - - - Response Unmarshaller for DeleteObjectTagging operation - - - - - DeletePublicAccessBlock Request Marshaller - - - - - Response Unmarshaller for DeletePublicAccessBlock operation - - - - - ErrorsItem Unmarshaller - - - - - Expiration Unmarshaller - - - - - FilterRule Unmarshaller - - - - - Filter Unmarshaller - - - - - Get Object Acl Request Marshaller - - - - - Response Unmarshaller for GetACL operation - - - - - Get Object Accelerate Configuration Request Marshaller - - - - - Response Unmarshaller for GetACL operation - - - - - Get BucketAnalyticsConfiguration Request Marshaller - - - - - Response Unmarshaller for GetAnalyticsConfiguration operation - - - - - Get InventoryConfiguration Request Marshaller - - - - - Response Unmarshaller for GetInventoryConfiguration operation - - - - - Get Bucket Location Request Marshaller - - - - - Response Unmarshaller for GetBucketLocation operation - - - - - Get Bucket Logging Request Marshaller - - - - - Response Unmarshaller for GetBucketLogging operation - - - - - Get Bucket MetricsConfigurationRequest Marshaller - - - - - Response Unmarshaller for GetBucketMetricsConfiguration operation - - - - - Get Bucket Notification Request Marshaller - - - - - Response Unmarshaller for GetBucketNotification operation - - - - - Get BucketName Policy Request Marshaller - - - - - Response Unmarshaller for GetBucketPolicy operation - - - - - GetBucketPolicyStatusRequestMarshaller - - - - - Response Unmarshaller for GetBucketPolicyStatus operation - - - - - Get Bucket Request Payment Request Marshaller - - - - - Response Unmarshaller for GetBucketRequestPayment operation - - - - - Get Bucket Tagging Request Marshaller - - - - - Response Unmarshaller for GetBucketTagging operation - - - - - Get Bucket Versioning Request Marshaller - - - - - Response Unmarshaller for GetBucketVersioning operation - - - - - Get Bucket Website Request Marshaller - - - - - Response Unmarshaller for GetBucketWebsite operation - - - - - Get Bucket Cors Request Marshaller - - - - - Response Unmarshaller for GetCORSConfiguration operation - - - - - Get Bucket Lifecycle Request Marshaller - - - - - Response Unmarshaller for GetLifecycleConfiguration operation - - - - - GetObjectLegalHold Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for GetObjectLegalHold operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - GetObjectLockConfiguration Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for GetObjectLockConfiguration operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - GetObjectMetadata Marshaller - - - - - Response Unmarshaller for GetObjectMetadata operation - - - - - Get Object Request Marshaller - - - - - Response Unmarshaller for GetObject operation - - - - - GetObjectRetention Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for GetObjectRetention operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - GetObjectTaggingRequest Marshaller - - - - - Marshall GetObjectTaggingRequest into an http request. - - - - - Marshall GetObjectTaggingRequest into an http request. - - - - - Response Unmarshaller for GetObjectTagging operation - - - - - Get Object Torrent Request Marshaller - - - - - Response Unmarshaller for GetObjectTorrent operation - - - - - GetPublicAccessBlockRequestMarshaller - - - - - Response Unmarshaller for GetPublicAccessBlock operation - - - - - Grantee Unmarshaller - - - - - Grant Unmarshaller - - - - - Head Bucket Request Marshaller - - - - - Response Unmarshaller for HeadBucket operation - - - - - Create Multipart Upload Request Marshaller - - - - - Response Unmarshaller for InitiateMultipartUpload operation - - - - - Initiator Unmarshaller - - - - - InventoryConfiguration Unmarshaller - - - - - InventoryDestination Unmarshaller - - - - - InventoryEncryption Unmarshaller - - - - - InventoryFilter Unmarshaller - - - - - InventoryS3BucketDestination Unmarshaller - - - - - InventorySchedule Unmarshaller - - - - - LifecycleFilterPredicate Unmarshaller - - - - - LifecycleRuleNoncurrentVersionExpiration Unmarshaller - - - - - LifecycleRuleNoncurrentVersionTransition Unmarshaller - - - - - List AnalyticsConfiguration Request Marshaller - - - - - Response Unmarshaller for ListAnalyticsConfiguration operation - - - - - List InventoryConfiguration Request Marshaller - - - - - Response Unmarshaller for ListInventoryConfiguration operation - - - - - List Bucket MetricsConfigurationRequest Marshaller - - - - - Response Unmarshaller for ListBucketMetricsConfiguration operation - - - - - List Buckets Request Marshaller - - - - - Response Unmarshaller for ListBuckets operation - - - - - List Multipart Uploads Request Marshaller - - - - - Response Unmarshaller for ListMultipartUploads operation - - - - - List Objects Request Marshaller - - - - - Response Unmarshaller for ListObjects operation - - - - - List Objects Request Marshaller - - - - - Response Unmarshaller for ListObjects operation - - - - - List Parts Request Marshaller - - - - - Response Unmarshaller for ListParts operation - - - - - List Object Versions Request Marshaller - - - - - Response Unmarshaller for ListVersions operation - - - - - LoggingEnabled Unmarshaller - - - - - MetricsConfiguration Unmarshaller - - - - - MetricsFilte Unmarshaller - - - - - UploadsItem Unmarshaller - - - - - Response Unmarshaller for ObjectLockConfiguration Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Response Unmarshaller for ObjectLockLegalHold Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Response Unmarshaller for ObjectLockRetention Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Response Unmarshaller for ObjectLockRule Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Owner Unmarshaller - - - - - PartsItem Unmarshaller - - - - - PolicyStatus Unmarshaller - - - - - PublicAccessBlockConfiguration Unmarshaller - - - - - Put Object Acl Request Marshaller - - - - - Response Unmarshaller for PutObjectAcl operation - - - - - Put Object Acl Request Marshaller - - - - - Response Unmarshaller for PutBucketAccelerate operation - - - - - Request Marshaller for PutAnalyticsConfiguration operation - - - - - Response Unmarshaller for PutBucketAnalytics operation - - - - - Request Marshaller for PutInventoryConfiguration operation - - - - - Response Unmarshaller for PutBucketWebsite operation - - - - - Enable Bucket Logging Request Marshaller - - - - - Response Unmarshaller for PutBucketLogging operation - - - - - Put Bucket MetricsConfigurationRequest Marshaller - - - - - Response Unmarshaller for PutBucketMetricsConfiguration operation - - - - - Put Bucket Notification Request Marshaller - - - - - Response Unmarshaller for PutBucketNotification operation - - - - - Put Bucket Policy Request Marshaller - - - - - Response Unmarshaller for PutBucketPolicy operation - - - - - Put Buckeyt Replication Request Marshaller - - - - - Response Unmarshaller for PutBucketReplication operation. - - - - - Put Bucket Request Marshaller - - - - - Put Bucket Request Payment Request Marshaller - - - - - Response Unmarshaller for PutBucketRequestPayment operation - - - - - Response Unmarshaller for PutBucket operation - - - - - Put Bucket Tagging Request Marshaller - - - - - Response Unmarshaller for PutBucketTagging operation - - - - - Put Bucket Versioning Request Marshaller - - - - - Response Unmarshaller for PutBucketVersioning operation - - - - - Put Bucket Website Request Marshaller - - - - - Response Unmarshaller for PutBucketWebsite operation - - - - - Put Bucket Cors Request Marshaller - - - - - Response Unmarshaller for PutCORSConfiguration operation - - - - - Put Bucket Lifecycle Request Marshaller - - - - - Response Unmarshaller for PutLifecycleConfiguration operation - - - - - PutObjectLegalHold Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for PutObjectLegalHold operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - PutObjectLockConfiguration Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for PutObjectLockConfiguration operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Put Object Request Marshaller - - - - - Response Unmarshaller for PutObject operation - - - - - PutObjectRetention Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for PutObjectRetention operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Delete Object Tagging Request Marshaller - - - - - Marshall PutObjectTaggingRequest into an http request. - - - - - Marshall PutObjectTaggingRequest into an http request. - - - - - Response Unmarshaller for DeleteObjectTagging operation - - - - - PutPublicAccessBlock Request Marshaller - - - - - Response Unmarshaller for PutPublicAccessBlock operation - - - - - Restore Object Request Marshaller - - - - - Response Unmarshaller for RestoreObject operation - - - - - Condition Unmarshaller - - - - - Redirect Unmarshaller - - - - - RoutingRule Unmarshaller - - - - - RulesItem Unmarshaller - - - - - Response Unmarshaller for all Errors - - - - - Build an S3ErrorResponse from XML - - The XML parsing context. - Usually an Amazon.Runtime.Internal.UnmarshallerContext. - An S3ErrorResponse object. - - - - Grant Unmarshaller - - - - - Class for unmarshalling S3 service responses - - - - - Specialized S3 unmarshaller context. - - - - - Wrap an XmlTextReader with state for event-based parsing of an XML stream. - - Stream with the XML from a service response. - If set to true, maintains a copy of the complete response body as the stream is being read. - Response data coming back from the request - If set to is true, configure unmarshaller with exception specifics. - - - - Reads to the next node in the XML document, and updates the context accordingly. - If node is RequestId, reads the contents and stores in RequestId property. - - - True if a node was read, false if there are no more elements to read./ - - - - - SSEKMS Unmarshaller - - - - - StorageClassAnalysisDataExportDataExportUnmarshaller - - - - - StorageClassAnalysisUnmarshaller - - - - - Tag Unmarshaller - - - - - TopicConfiguration Unmarshaller - - - - - Transition Unmarshaller - - - - - Upload Part Request Marshaller - - - - - Response Unmarshaller for UploadPart operation - - - - - VersionsItem Unmarshaller - - - - - Class for AnalyticsPrefixPredicate - The prefix used when evaluating a metrics filter. - - - - - Class for AnalyticsS3BucketDestination - - - - - The file format used when exporting data to Amazon S3. - - - - - The account ID that owns the destination bucket. If no account ID is provided, the owner will not be validated prior to exporting data. - - - - - The Amazon resource name (ARN) of the bucket to which data is exported. - - - - - The prefix to use when exporting data. The exported data begins with this prefix. - - - - - Class for MetricsTagPredicate - The tag used when evaluating a metrics filter. - - - - - This class represents the byte range for a range GET from S3. - - - - - Constructs a ByteRange and sets the start and end. - - - - - - - Constructs a ByteRange and sets the header to the value specified. - - - - - - A private string, represending the byte range. - - - - - The starting byte number of the range - - - - - The ending byte number of the range - - - - - The formatted string representing the byte range to be set for the range header. - - - - - Container for the parameters to the CompleteMultipartUpload operation. - Completes a multipart upload by assembling previously uploaded parts. - - - - - The name of the bucketName containing the S3 object that was being uploaded in parts. - - - - - The key of the S3 object that was being uploaded. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - A collection of part numbers and corresponding etags. - - - - - Adds a collection of part numbers and corresponding etags. - - PartETags that will added to this request. - - - - Adds a collection of part numbers and corresponding etags. - - PartETags that will added to this request. - - - - Adds a collection of part numbers and corresponding etags by transforming the UploadPartResponses into PartETags. - - The list of response objects return from UploadParts. - - - - Adds a collection of part numbers and corresponding etags by transforming the UploadPartResponses into PartETags. - - The list of response objects return from UploadParts. - - - - Adds a collection of part numbers and corresponding etags by transforming the CopyPartResponse into PartETags. - - The list of response objects return from CopyParts. - - - - Adds a collection of part numbers and corresponding etags by transforming the CopyPartResponse into PartETags. - - The list of response objects return from CopyParts. - - - - The upload id for the in-progress multipart upload that should be completed. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the CompleteMultipartUpload response and response metadata. - - - - - Gets and sets the URI that identifies the newly created object. - - - - - Gets and sets the name of the bucketName that contains the newly created object. - - - - - Gets and sets the object key of the newly created object. - - - - - Gets and sets Entity tag that identifies the newly created object's data. Objects with different - object data will have different entity tags. The entity tag is an opaque string. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - Gets and sets the ServerSideEncryptionMethod property. - Specifies the encryption used on the server to - store the content. - Default is None. - - - - - Gets and sets the VersionId property. - This is the version-id of the S3 object - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the CopyObject operation. - Creates a copy of an object that is already stored in Amazon S3. - - - - - The name of the bucket containing the object to copy. - - - - - Checks if SourceBucket property is set. - - true if SourceBucket property is set. - - - - The key of the object to copy. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Checks if SourceKey property is set. - - true if SourceKey property is set. - - - - Specifies a particular version of the source object to copy. By default the latest version is copied. - - - - - Checks if SourceVersionId property is set. - - true if SourceVersionId property is set. - - - - The name of the bucket to contain the copy of the source object. - - - - - Checks if DestinationBucket property is set. - - true if DestinationBucket property is set. - - - - The key to be given to the copy of the source object. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Checks if DestinationKey property is set. - - true if DestinationKey property is set. - - - - A canned access control list (CACL) to apply to the object. - Please refer to for - information on S3 Canned ACLs. - - - - - ETag to be matched as a pre-condition for copying the source object - otherwise returns a PreconditionFailed. - - - Copies the object if its entity tag (ETag) matches - the specified tag; otherwise return a 412 (precondition failed). - Constraints: This property can be used with IfUnmodifiedSince, - but cannot be used with other conditional copy properties. - - - - - Checks if ETagToMatch property is set. - - - Copies the object if its entity tag (ETag) is different - than the specified Etag; otherwise returns a 412 (failed condition). - Constraints: This header can be used with IfModifiedSince, but cannot - be used with other conditional copy properties. - - true if ETagToMatch property is set. - - - - ETag that must not be matched as a pre-condition for copying the source object, - otherwise returns a PreconditionFailed. - - - - - Checks if ETagToNotMatch property is set. - - true if ETagToNotMatch property is set. - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or - ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Copies the object if it has been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it has been modified since the - specified time; otherwise returns a 412 (failed condition). - Constraints: This property can be used with ETagToNotMatch, - but cannot be used with other conditional copy properties. - - - - - Copies the object if it has been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it has been modified since the - specified time; otherwise returns a 412 (failed condition). - Constraints: This property can be used with ETagToNotMatch, - but cannot be used with other conditional copy properties. - - - - - Checks if ModifiedSinceDateUtc property is set. - - true if ModifiedSinceDateUtc property is set. - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or - UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Copies the object if it has not been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it hasn't been modified since the - specified time; otherwise returns a 412 (precondition failed). - Constraints: This property can be used with ETagToMatch, - but cannot be used with other conditional copy properties. - - - - - Copies the object if it has not been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it hasn't been modified since the - specified time; otherwise returns a 412 (precondition failed). - Constraints: This property can be used with ETagToMatch, - but cannot be used with other conditional copy properties. - - - - - Checks if UnmodifiedSinceDateUtc property is set. - - true if UnmodifiedSinceDateUtc property is set. - - - - Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request. - - - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - Specifies whether you want to apply a Legal Hold to the copied object. - - - - - - Gets and sets the property ObjectLockMode. - - The Object Lock mode that you want to apply to the copied object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - The date and time when you want the copied object's Object Lock to expire. - - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - Checks if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - true if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - - - The type of storage to use for the object. Defaults to 'STANDARD'. - - - - - - If the bucketName is configured as a website, redirects requests for this object to another object in the same bucketName or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - This is a convenience property for Headers.ContentType. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - /// - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The customer provided encryption key for the source object of the copy. - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - true if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the CopySourceServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if CopySourceServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - The tag-set for the object destination object this value must be used in conjunction with the TaggingDirective. The tag-set must be encoded as URL Query parameters. - - - - - Checks if Tagging property is set - - true if Tagging is set. - - - - Returns information about the CopyObject response and response metadata. - - - - - Gets and sets the ETag property. - - - - - Gets and sets the LastModified property. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - Gets and sets the SourceVersionId property. - This is the Version Id of the Source Object - - - - - Version ID of the newly created copy. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the CopyPart operation. - Uploads a part by copying data from an existing object as data source. - - - - - The name of the bucket containing the object to copy. - - - - - Checks if SourceBucket property is set. - - true if SourceBucket property is set. - - - - The key of the object to copy. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Checks if SourceKey property is set. - - true if SourceKey property is set. - - - - Specifies a particular version of the source object to copy. By default the latest version is copied. - - - - - Checks if SourceVersionId property is set. - - true if SourceVersionId property is set. - - - - The name of the bucket to contain the copy of the source object. - - - - - Checks if DestinationBucket property is set. - - true if DestinationBucket property is set. - - - - The key to be given to the copy of the source object. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Checks if DestinationKey property is set. - - true if DestinationKey property is set. - - - - The ID identifying multipart upload for which we are copying a part. - - - - - Checks if UploadId property is set. - - true if UploadId property is set. - - - - Collection of ETags to be matched as a pre-condition for copying the source object - otherwise returns a PreconditionFailed. - - - Copies the object if its entity tag (ETag) matches one of - the specified tags; otherwise return a 412 (precondition failed). - Constraints: This property can be used with IfUnmodifiedSince, - but cannot be used with other conditional copy properties. - - - - - Checks if ETagsToMatch property is set. - - true if ETagToMatch property is set. - - - - Collection of ETags that must not be matched as a pre-condition for copying the source object - otherwise returns a PreconditionFailed. - - - Copies the object if its entity tag (ETag) does not match any of the specified - tags; otherwise returns a 412 (failed condition). - Constraints: This header can be used with IfModifiedSince, but cannot - be used with other conditional copy properties. - - - - - Checks if ETagToNotMatch property is set. - - true if ETagToNotMatch property is set. - - - - Copies the object if it has been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it has been modified since the - specified time; otherwise returns a 412 (failed condition). - Constraints: This property can be used with ETagToNotMatch, - but cannot be used with other conditional copy properties. - - - - - Checks if ModifiedSinceDate property is set. - - true if ModifiedSinceDate property is set. - - - - Copies the object if it has not been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it hasn't been modified since the - specified time; otherwise returns a 412 (precondition failed). - Constraints: This property can be used with ETagToMatch, - but cannot be used with other conditional copy properties. - - - - - Checks if UnmodifiedSinceDate property is set. - - true if UnmodifiedSinceDate property is set. - - - - The number of the part to be copied. - - - Valid part numbers are from 1 to 10,000 inclusive and will uniquely identify the part - and determine the relative ordering within the destination object. If a part already - exists with the PartNumber it will be overwritten. - - - - - Checks if PartNumber property is set. - - true if PartNumber property is set. - - - - The location of the first byte in the range if only a portion of the - source object is to be copied as the part. - - - The LastByte property must also be set or this value will be ignored. - - - - - Checks if FirstByte property is set. - - true if FirstByte property is set. - - - - The location of the last byte in the range if only a portion of the - source object is to be copied as the part. - - - The FirstByte property must also be set or this value will be ignored. - - - - - Checks if LastByte property is set. - - true if LastByte property is set. - - - - - This property is obsolete. Use ServerSideEncryptionMethod in InitiateMultipartUploadRequest instead. - - - Default: None - - - - - - Checks if ServerSideEncryptionMethod property is set. - - true if ServerSideEncryptionMethod property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - This property is obsolete. Use ServerSideEncryptionKeyManagementServiceKeyId in InitiateMultipartUploadRequest instead. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The customer provided encryption key for the source object of the copy. - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - true if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the CopySourceServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if CopySourceServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - - - Returns information about the CopyPart response and response metadata. - - - - - The version of the source object that was copied, if you have enabled versioning on the source bucketName. - - - - - - Entity tag of the object. - - - - - - Date and time at which the object was uploaded. - - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - Gets and sets the PartNumber property. - This is the part number in it's multi-part upload that will uniquely identify the part - and determine the relative ordering within the destination object. - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - A collection of up to 100 cross-origin resource sharing (CORS) rules. - - - - - The collection of rules in this configuration. - - - - C O R S Rule - - - - - Identifies HTTP methods that the domain/origin specified in the rule is allowed to execute. - - - - - - One or more origins you want customers to be able to access the bucket from. - - - - - - An optional unique identifier for the rule. - - - The ID value can be up to 255 characters long. The IDs help you find a rule in the configuration. - - - - - Checks if Id property is set. - - true if Id property is set. - - - - One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript - XMLHttpRequest object). - - - - - - The time in seconds that your browser is to cache the preflight response for the specified resource. - - - - - - Specifies which headers are allowed in a pre-flight OPTIONS request through the - Access-Control-Request-Headers header. - - - Each header name specified in the Access-Control-Request-Headers must have a corresponding - entry in the rule. Only the headers that were requested will be sent back. - This element can contain at most one * wildcard character. - - - - - Checks if AllowedHeaders property is set. - - true if AllowedHeaders property is set. - - - - Describes how a CSV-formatted input object is formatted. - - - - - Describes the first line of input. Valid values: None, Ignore, Use. - - - - - Single character used to indicate a row should be ignored when present at the start of a row. - - - - - Single character used for escaping the quote character inside an already escaped value. - - - - - Value used to separate individual records. - - - - - Value used to separate individual fields in a record. - - - - - Value used for escaping where the field delimiter is part of the value. - - - - - Specifies that CSV field values may contain quoted record delimiters and such records should be allowed. Default value is FALSE. Setting this value to TRUE may lower performance. - - - - - Describes how CSV-formatted results are formatted. - - - - - Indicates whether or not all output fields should be quoted. - - - - - Single character used for escaping the quote character inside an already escaped value. - - - - - Value used to separate individual records. - - - - - Value used to separate individual fields in a record. - - - - - Value used for escaping where the field delimiter is part of the value. - - - - - The container element for specifying the default Object Lock retention settings for - new objects placed in the specified bucket. - - - - - Gets and sets the property Days. - - The number of days that you want to specify for the default retention period. - - - - - - Gets and sets the property Mode. - - The default Object Lock retention mode you want to apply to new objects placed in - the specified bucket. - - - - - - Gets and sets the property Years. - - The number of years that you want to specify for the default retention period. - - - - - - Container for the parameters to the DeleteBucketAnalyticsConfiguration operation. - Deletes an analytics configuration for the bucket (specified by the analytics configuration ID). - - - - - The name of the bucket from which an analytics configuration is deleted. - - - - - The identifier used to represent an analytics configuration. - - - - - Returns information about the DeleteBucketAnalyticsConfiguration response metadata. - The DeleteBucketAnalyticsConfiguration operation has a void result type. - - - - - Request object for the DeleteBucketEncryption operation. - Request Deletes the server-side encryption configuration from the bucket. - - - - - The name of the bucket containing the server-side encryption configuration to delete. - - - - - Returns information about the DeleteBucketEncryption response metadata. - The DeleteBucketEncryption operation has a void result type. - - - - - Container for the parameters to the DeleteInventoryConfiguration operation. - Deletes an inventory configuration (identified by the inventory ID) from the bucket. - - - - - The name of the bucket containing the inventory configuration to delete. - - - - - The ID used to identify the inventory configuration. - - - - - Returns information about the DeleteInventoryConfiguration response metadata. - The DeleteInventoryConfiguration operation has a void result type. - - - - - Container for the parameters to the DeleteBucketMetricsConfiguration operation. - Deletes a metrics configuration (specified by the metrics configuration ID) from the bucket. - - - - - The name of the bucket on which Inventory configuration is to be removed. - - - - - The ID used to identify the metrics configuration. - - - - - Returns information about the DeleteBucketMetricsConfiguration response metadata. - The DeleteBucketMetricsConfiguration operation has a void result type. - - - - - Container for the parameters to the DeleteBucketPolicy operation. - Deletes the policy from the bucket. - - - - - The bucket on which the policy is to be deleted. - - - - - Returns information about the DeleteBucketPolicy response metadata. - The DeleteBucketPolicy operation has a void result type. - - - - - Request object for the DeleteBucketReplication operation. - - - - - Gets and sets the property BucketName. -

Deletes the replication subresource associated with the specified - bucket.

There is usually some time lag before - replication configuration deletion is fully propagated to all the - Amazon S3 systems.

For more information, see - - Cross-Region Replication (CRR) in the Amazon S3 Developer - Guide.

- - - - - Returns information about the DeleteBucketReplication response metadata. - The DeleteBucketReplication operation has a void result type. - - - - - Container for the parameters to the DeleteBucket operation. - Deletes the bucket. All objects (including all object versions and Delete Markers) in the bucket must be deleted before the bucket - itself can be deleted. - - - - - The name of the bucket to be created. - - - - - The region locality for the bucket. - - - When set, this will determine the region the bucket exists in. - Refer - for a list of possible values. - - - - - If set to true the bucket will be deleted in the same region as the configuration of the AmazonS3 client. - DeleteBucketRequest.BucketRegion takes precedence over this property if both are set. - Default: true. - - - - - Returns information about the DeleteBucket response metadata. - The DeleteBucket operation has a void result type. - - - - - The parameters to request deletion of a tag set from a bucket. - - - To use this operation, you must have permission to perform the s3:PutBucketTagging action. - By default, the bucket owner has this permission and can grant this permission to others. - - - - - The name of the bucket on which the tag set is to be removed. - - - - - Returns information about the DeleteBucketTagging response metadata. - The DeleteBucketTagging operation has a void result type. - - - - - Container for the parameters to the DeleteBucketWebsite operation. - This operation removes the website configuration from the bucket. - - - - - The name of the bucket on which website configuration is to be removed. - - - - - Returns information about the DeleteBucketWebsite response metadata. - The DeleteBucketWebsite operation has a void result type. - - - - - Container for the parameters to the DeleteCORSConfiguration operation. - Deletes the cors configuration information set for the bucket. - - - - - Gets and sets the BucketName property. - - - - - Returns information about the DeleteCORSConfiguration response metadata. - The DeleteCORSConfiguration operation has a void result type. - - - - - Contains information about a successful delete operation against a specific S3 object. - - - - - Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a - delete marker. In a simple DELETE, this header indicates whether (true) or not (false) a delete - marker was created. - - - - - The version ID of the delete marker created as a result of the DELETE operation. If you delete a - specific object version, the value returned by this header is the version ID of the object version - deleted. - - - - - The key of the deleted S3 object. - - - - - The version of the deleted S3 object. - - - - - Contains information about a failed delete operation against a specific S3 object. - - - - - The key of the S3 object. - - - - - The version of the S3 object. - - - - - The failure code for the delete error. - - - - - The failure message for the delete error. - - - - - The parameters to request deletion of the lifecycle configuration on a bucket. - - - - Amazon S3 removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. - Your objects never expire, and Amazon S3 no longer automatically deletes any objects on the basis of rules contained - in the deleted lifecycle configuration. - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration action. By default, the - bucket owner has this permission and the bucket owner can grant this permission to others. - - - There is usually some time lag before lifecycle configuration deletion is fully propagated to all the Amazon S3 systems. - - - - - - The name of the bucket on which the lifecycle configuration is to be deleted. - - - - - Returns information about the DeleteLifecycleConfiguration response metadata. - The DeleteLifecycleConfiguration operation has a void result type. - - - - -

Specifies whether Amazon S3 should replicate delete makers.

- - - - - Gets and sets the property Status. -

The status of the delete marker replication.

-

In the current implementation, Amazon S3 does not replicate - the delete markers. Therefore, the status must be - Disabled.

- - - - - The parameters to request deletion of an object in a bucket. - The operation removes the null version (if there is one) of an object and inserts a delete marker, which - becomes the latest version of the object. - - - - To remove a specific version, you must be the bucket owner and you must use the versionId subresource. - Using this subresource permanently deletes the version. - - - If the object you want to delete is in a bucket where the bucket versioning configuration is MFA Delete enabled, - you must include specify the MFA serial number and value in the request. - - - If there isn't a null version, Amazon S3 does not remove any objects. - - - - - - The bucket name of the bucket containing the object. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property BypassGovernanceRetention. - - - - - The key identifying the object to delete. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - The identifier for the specific version of the object to be deleted, if required. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - The MfaCodes Tuple associates the Serial Number and the current Token/Code displayed on the - Multi-Factor Authentication device associated with your AWS Account. - - - This is a required property for this request if:
- 1. EnableMfaDelete was configured on the bucket - containing this object's version.
- 2. You are deleting an object's version - - - - - Checks if the MfaCodes property is set. - - true if the MfaCodes property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the DeleteObject response and response metadata. - - - - - Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a delete marker. - - - - - - Returns the version ID of the delete marker created as a result of the DELETE operation. - - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the DeleteObjects operation. - This operation enables you to delete multiple objects from a bucket using a single HTTP request. You may specify up to 1000 - keys. - - - Container for the parameters to the DeleteObjects operation. - This operation enables you to delete multiple objects from a bucket using a single HTTP request. You may specify up to 1000 - keys. - - - - - The bucket name containing the objects to delete. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property BypassGovernanceRetention. - - Specifies whether you want to delete this object even if it has a Governance-type - Object Lock in place. You must have sufficient permissions to perform this operation. - - - - - - List of object keys to delete. - - - - - Toggles between Quiet and Verbose mode for the operation. - If set to true (Quiet mode), the response includes only those keys for objects on which - the delete operation failed. - - - By default this property is false and keys for both successful deletes - and failures are returned in the response. - - - - - The MfaCodes Tuple associates the Serial Number and the current Token/Code displayed on the - Multi-Factor Authentication device associated with your AWS Account. - - - This is a required property for this request if:
- 1. EnableMfaDelete was configured on the bucket - containing this object's version.
- 2. You are deleting an object's version - - - - - Checks if the MfaCodes property is set. - - true if the MfaCodes property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Add a key to the set of keys of objects to be deleted. - - Object key - - - - Add a key and a version to be deleted. - - Key of the object to be deleted. - Version of the object to be deleted. - - - - Add a KeyVersion object representing the S3 object to be deleted. - - KeyVersion representation of object to be deleted. - - - - Returns information about the DeleteObjects response and response metadata. - - - - - A default constructor for DeleteObjectsResponse - - - - - Gets and sets the DeletedObjects property. - A list of successful deletes. - Set only when Quiet=false on DeleteObjectsRequest. - - - - - Gets and sets the DeleteErrors property. - A list of errors encountered while deleting objects. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the DeleteObjectTaggingRequest operation. - - - - - The bucket name containing the objects from which to remove the tags. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Check to see if Bucket property is set - - - - - The key identifying the object tagging to delete. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Check to see if Key property is set - - - - - The identifier for the specific version of the object to be deleted, if required. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - Returns information about the DeleteObjectTagging response and response metadata. - - - - - Returns the version ID of the delete marker created as a result of the DELETE operation. - - - - - Check to see if VersionId property is set - - - - - Container for the parameters to the DeletePublicAccessBlock operation. - Removes the Public Access Block configuration for an Amazon S3 bucket. - - - - - Gets and sets the property BucketName. - - The Amazon S3 bucket whose Public Access Block configuration you want to delete. - - - - - - This is the response object from the DeletePublicAccessBlock operation. - - - - - EncryptionConfiguration class - - - - - The ID of the AWS KMS key for the region where the destination bucket - resides. Amazon S3 uses this key to encrypt the replica object. - - - - - A container that specifies information about existing object replication. You can choose whether to enable or disable the replication of existing objects. - - - - - Specifies whether existing object replication is enabled. - - - - - Defines the expiration policy for a given object. - - - - - This property is deprecated. This property exposes a DateTime of kind Unspecified. Use ExpiryDateUtc instead. - The date and time for expiry. - - - - - The date and time for expiry. - - - - - Id of the configuration rule for this expiry. - - - - - Constructs an empty instance of an Expiration object - - - - Bucket - Represents a set of filter criteria that limits the objects that can trigger event notifications - - - - - Filter criteria that limits the objects that can trigger event notifications based on their S3 Key name. - - - - - Bucket - Represents a Filter Rule for a NotificationConfiguration. - - - - - Constructs an empty FilterRule. - - - - - Constructs a FilterRule with a specific name and value. - - - - - - - The name of the filter rule. - - - - - The value of the filter rule. - - - - - Container for the parameters to the GetACL operation. - Returns the access control list (ACL) of an object. - - - - - The bucket name that contains the object for which to get the ACL information. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The key of the S3 object to be queried. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - VersionId used to reference a specific version of the object. - - - - - Returns information about the GetACL response and response metadata. - - - - - Gets and sets the AccessControlList property. - - - - - Container for the parameters to the GetBucketAccelerateConfiguration operation. - - - - - The name of the bucket. - - - - - The response class for GetBucketAccelerateConfiguration operation. - - - - - The accelerate status of the bucket. - - - - - Container for the parameters to the GetBucketAnalyticsConfiguration operation. - Gets an analytics configuration for the bucket (specified by the analytics configuration ID). - - - - - The name of the bucket from which an analytics configuration is retrieved. - - - - - The identifier used to represent an analytics configuration. - - - - - GetBucketAnalyticsConfigurationResponse Response - - - - - The configuration and any analyses for the analytics filter. - - - - - Container for the parameters to the GetBucketEncryptionRequest operation. - Returns the server-side encryption configuration of a bucket. - - - - - The name of the bucket. - - - - - GetBucketEncryptionResponse Response - - - - - Container for server-side encryption configuration rules. Currently S3 supports one rule only. - - - - - Container for the parameters to the GetInventoryConfigurationRequest operation. - Returns an inventory configuration (identified by the inventory ID) from the bucket. - - - - - The name of the bucket containing the inventory configuration to retrieve. - - - - - The ID used to identify the inventory configuration. - - - - - GetInventoryConfigurationResponse Response - - - - - Specifies the inventory configuration. - - - - - Container for the parameters to the GetBucketLocation operation. - Returns the region the bucket resides in. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetBucketLocation response and response metadata. - - - - - Gets and sets the Location property. - If the the bucket is located in us-east-1 S3Region.US will be return which has a - value of empty string. - - - - - Container for the parameters to the GetBucketLogging operation. - Returns the logging status of a bucket and the permissions users have to view and modify that status. To use GET, you must be the - bucket owner. - - - - - The name of the bucket to query. - - - - - Returns information about the GetBucketLogging response and response metadata. - - - - - Gets and sets the LoggingConfig property. - - - - - Container for the parameters to the GetBucketMetricsConfiguration operation. - Gets a metrics configuration (specified by the metrics configuration ID) from the bucket. - - - - - The name of the bucket containing the metrics configuration to retrieve. - - - - - The ID used to identify the metrics configuration. - - - - - GetBucketMetricsConfiguration Response - - - - - Specifies the metrics configuration. - - - - - Container for the parameters to the GetBucketNotification operation. - Return the notification configuration of a bucket. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetBucketNotification response and response metadata. - - - - - Gets and sets the TopicConfigurations property. TopicConfigurations are configuration - for Amazon S3 events to be sent to Amazon SNS topics. - - - - - Gets and sets the QueueConfigurations property. QueueConfigurations are configuration - for Amazon S3 events to be sent to Amazon SQS queues. - - - - - Gets and sets the LambdaFunctionConfigurations property. LambdaFunctionConfigurations are configuration - for Amazon S3 events to be sent to an Amazon Lambda cloud function. - - - - - Container for the parameters to the GetBucketPolicy operation. - Returns the policy of a specified bucket. - - - - - The name of the bucket. - - - - - Get BucketName Policy Response - - - - - The bucket policy as a JSON document. - - - - - Container for the parameters to the GetBucketPolicyStatus operation. - Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket - is public. - - - - - Gets and sets the property BucketName. - - The name of the Amazon S3 bucket whose public-policy status you want to retrieve. - - - - - - This is the response object from the GetBucketPolicyStatus operation. - - - - - The public-policy status for this bucket. - - - - - Container for the parameters to the GetBucketReplicationConfiguration operation. - Returns the replication configuration information set on the bucket. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetReplicationConfiguration response and response metadata. - - - - - The replication configuration for the buccket specified in the request. - - - - - Container for the parameters to the GetBucketRequestPayment operation. - Returns the request payment configuration of a bucket. - - - - - The name of the bucket. - - - - - Returns information about the GetBucketRequestPayment response and response metadata. - - - - - Specifies who pays for the download and request fees. - - - - - - Container for the parameters to the GetBucketTagging operation. - Returns the tag set associated with the bucket. - - - - - The name of the bucket to be queried. - - - - - Returns information about the GetBucketTagging response and response metadata. - - - - - The collection of tags. - - - - - Container for the parameters to the GetBucketVersioning operation. - Returns the versioning state of a bucket. - - - - - The name of the bucket to be queried. - - - - - Returns information about the GetBucketVersioning response and response metadata. - - - - - Gets and sets the Versioning property. - Unless Versioning has been explicitly "Enabled" on a bucket, - Versioning Status is "Off". Once Versioning has been - "Enabled", it can be "Suspended" but cannot be switched "Off". - - - - - Container for the parameters to the GetBucketWebsite operation. - Returns the website configuration for a bucket. - - - - - The name of the bucket to be queried. - - - - - Returns information about the GetBucketWebsite response and response metadata. - - - - - Gets and sets the WebsiteConfiguration property. - - This is where the index document suffix and custom error page are defined. - - - - - Container for the parameters to the GetBucketCors operation. - Returns the cors configuration for the bucket. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetBucketCors response and response metadata. - - - - - The current CORSConfiguration for the bucket. - - - - - Container for the parameters to the GetLifecycleConfiguration operation. - Returns the lifecycle configuration information set on the bucket. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetLifecycleConfiguration response and response metadata. - - - - - Gets and Sets the property that governs whether - the response includes successful deletes as well as errors - following the DeleteObjects call against S3. - - By default this property is false and successful deletes - are returned in the response. - - - - - Container for the parameters to the GetObjectLegalHold operation. - Gets an object's current Legal Hold status. - - - - - The bucket name containing the object whose Legal Hold status you want to retrieve. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property Key. - - The key name for the object whose Legal Hold status you want to retrieve. - - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property VersionId. - - The version ID of the object whose Legal Hold status you want to retrieve. - - - - - - This is the response object from the GetObjectLegalHold operation. - - - - - Gets and sets the property LegalHold. - - The current Legal Hold status for the specified object. - - - - - - Container for the parameters to the GetObjectLockConfiguration operation. - Gets the Object Lock configuration for a bucket. The rule specified in the Object - Lock configuration will be applied by default to every new object placed in the specified - bucket. - - - - - Gets and sets the property BucketName. - - The bucket whose Object Lock configuration you want to retrieve. - - - - - - This is the response object from the GetObjectLockConfiguration operation. - - - - - Gets and sets the property ObjectLockConfiguration. - - The specified bucket's Object Lock configuration. - - - - - - Container for the parameters to the HeadObject operation. - The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you''re only - interested in an object''s metadata. To use HEAD, you must have READ access to the object. - - - - - The name of the bucket that contains the object. - - - - - ETag to be matched as a pre-condition for returning the object, - otherwise a PreconditionFailed signal is returned. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or - ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Returns the object only if it has been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Returns the object only if it has been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - ETag that should not be matched as a pre-condition for returning the object, - otherwise a PreconditionFailed signal is returned. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or - UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Returns the object only if it has not been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Returns the object only if it has not been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - The key of the object. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - VersionId used to reference a specific version of the object. - - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to decrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - Part number of the object being read. This is a positive integer between 1 and 10,000. - Effectively performs a 'ranged' HEAD request for the part specified. - Useful querying about the size of the part and the number of parts in this object. - - - - - Check if PartNumber property is set. - - true if PartNumber property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the HeadObject response and response metadata. - - - - - Flag which returns true if the Expires property has been unmarshalled - from the raw value or set by user code. - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the - response. - - - - - - Gets and sets the AcceptRanges. - - - - - Gets and sets the ContentRange. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - Gets and sets the RestoreExpiration property. - RestoreExpiration will be set for objects that have been restored from Amazon Glacier. - It indiciates for those objects how long the restored object will exist. - - - - - Gets and sets the RestoreInProgress - Will be true when the object is in the process of being restored from Amazon Glacier. - - - - - Last modified date of the object - - - - - - An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL - - - - - - This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like - SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal - HTTP headers. - - - - - - Version of the object. - - - - - - The date and time at which the object is no longer cacheable. - - - - - - If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The status of the replication job associated with this source object. - - - - - Checks if ReplicationStatus property is set. - - true if ReplicationStatus property is set. - - - - The count of parts this object has. - - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - The Legal Hold status for the specified object. - - - - - - Gets and sets the property ObjectLockMode. - - The Object Lock mode currently in place for this object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - The date and time when this object's Object Lock will expire. - - - - - - The class of storage used to store the object. - - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the GetObject operation. - Retrieves objects from Amazon S3. - - - - - The bucket name containing the object. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - ETag to be matched as a pre-condition for returning the object, - otherwise a PreconditionFailed signal is returned. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or - ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Returns the object only if it has been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Returns the object only if it has been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - ETag that should not be matched as a pre-condition for returning the object, - otherwise a PreconditionFailed signal is returned. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or - UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Returns the object only if it has not been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Returns the object only if it has not been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Gets and sets the Key property. This is the user defined key that identifies the object in the bucket. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Downloads the specified range bytes of an object. - - - - - A set of response headers that should be returned with the object. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ResponseExpiresUtc instead. Setting either ResponseExpires or - ResponseExpiresUtc results in both ResponseExpires and ResponseExpiresUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ResponseExpires is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Sets the Expires header of the response. - - - - - Sets the Expires header of the response. - - - - - VersionId used to reference a specific version of the object. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to decrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - Part number of the object being read. This is a positive integer between 1 and 10,000. - Effectively performs a 'ranged' GET request for the part specified. Useful for downloading just a part of an object. - - - - - Checks if PartNumber property is set. - - true if PartNumber property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the GetObject response and response metadata. - - - - - Flag which returns true if the Expires property has been unmarshalled - from the raw value or set by user code. - - - - - Gets and sets the BucketName property. - - - - - Gets and sets the Key property. - - - - - Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the - response. - - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - Gets and sets the AcceptRanges. - - - - - Gets and sets the ContentRange. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - Gets and sets the RestoreExpiration property. - RestoreExpiration will be set for objects that have been restored from Amazon Glacier. - It indiciates for those objects how long the restored object will exist. - - - - - Gets and sets the RestoreInProgress - Will be true when the object is in the process of being restored from Amazon Glacier. - - - - - Last modified date of the object - - - - - - An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL - - - - - - This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like - SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal - HTTP headers. - - - - - - Version of the object. - - - - - - The date and time at which the object is no longer cacheable. - - - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - - - - Gets and sets the property ObjectLockMode. - - The Object Lock mode currently in place for this object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - The date and time when this object's Object Lock will expire. - - - - - - If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The class of storage used to store the object. - - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The status of the replication job associated with this source object. - - - - - Checks if ReplicationStatus property is set. - - true if ReplicationStatus property is set. - - - - The number of parts this oject has. - - - - - Checks if PartsCount is set. - - true if PartsCount property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - The number of tags, if any, on the object. - - - - - The event for Write Object progress notifications. All - subscribers will be notified when a new progress - event is raised. - - - Subscribe to this event if you want to receive - put object progress notifications. Here is how:
- 1. Define a method with a signature similar to this one: - - private void displayProgress(object sender, WriteObjectProgressArgs args) - { - Console.WriteLine(args); - } - - 2. Add this method to the Put Object Progress Event delegate's invocation list - - GetObjectResponse response = s3Client.GetObject(request); - response.WriteObjectProgressEvent += displayProgress; - - - - - - This method is called by a producer of write object progress - notifications. When called, all the subscribers in the - invocation list will be called sequentially. - - The file being written. - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - True if transfer is complete - - - - Writes the content of the ResponseStream a file indicated by the filePath argument. - - The location where to write the ResponseStream - Whether or not to append to the file if it exists - - - - Encapsulates the information needed to provide - download progress for the Write Object Event. - - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The bucket name for the S3 object being written. - The object key for the S3 object being written. - The version-id of the S3 object. - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - True if finished writing - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The bucket name for the S3 object being written. - The object key for the S3 object being written. - The file for the S3 object being written. - The version-id of the S3 object. - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - True if finished writing - - - - Gets the bucket name for the S3 object being written. - - - - - Gets the object key for the S3 object being written. - - - - - Gets the version-id of the S3 object. - - - - - The file for the S3 object being written. - - - - - True if writing is complete - - - - - Container for the parameters to the GetObjectRetention operation. - Retrieves an object's retention settings. - - - - - The bucket name containing the object whose retention settings you want to retrieve. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property Key. - - The key name for the object whose retention settings you want to retrieve. - - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property VersionId. - - The version ID for the object whose retention settings you want to retrieve. - - - - - - This is the response object from the GetObjectRetention operation. - - - - - Gets and sets the property Retention. - - The container element for an object's retention settings. - - - - - - Container for the parameters to the GetObjectTaggingRequest operation. - - - - - The bucket name containing the object for which to get the tagging information. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Check to see if Bucket property is set - - - - - Gets and sets the Key property. This is the user defined key that identifies the object in the bucket. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Check to see if Key property is set - - - - - VersionId used to reference a specific version of the object. - - - - - - Returns information about the GetObjectTagging response and response metadata. - - - - - Gets or sets tag-set for a given object - - - - - Container for the parameters to the GetObjectTorrent operation. - Return torrent files from a bucket. - - - - - The name of the bucket containing the object. - - - - - The key identifying the object. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the GetObjectTorrent response and response metadata. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - The parameters to create a pre-signed URL to a bucket or object. - - - For more information, refer to: . -
Required Parameters: BucketName, Expires -
Optional Parameters: Key, VersionId, Verb: default is GET - - - - - The name of the bucket to create a pre-signed url to, or containing the object. - - - - - Checks if BucketName property is set. - - true if BucketName property is set. - - - - The key to the object for which a pre-signed url should be created. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Checks if Key property is set. - - true if Key property is set. - - - - A standard MIME type describing the format of the object data. - - - - The content type for the content being uploaded. This property defaults to "binary/octet-stream". - For more information, refer to: . - - - Note that if content type is specified, it should also be included in the HttpRequest headers - of the eventual upload request, otherwise a signature error may result. - - - - - - The expiry date and time for the pre-signed url. - - - - - Checks if Expires property is set. - - true if Expires property is set. - - - - The requested protocol (http/https) for the pre-signed url. - - - Defaults to https. - - - - - The verb for the pre-signed url. - - - Accepted verbs are GET, PUT, DELETE and HEAD. - Default is GET. - - - - - Version id for the object that the pre-signed url will reference. If not set, - the url will reference the latest version of the object. - - - This is the VersionId for the S3 Object you want to get - a PreSigned URL for. The VersionId property will be ignored - for PreSigned "PUT" requests and for requests that don't specify - the Key property. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - The upload id for the multipart upload for which a pre-signed url should be created. - - - - - Checks if UploadId property is set. - - true if UploadId property is set. - - - - The part number for the multipart upload for which a pre-signed url should be created. - - - - - Checks if PartNumber property is set. - - true if PartNumber property is set. - - - - Specifies the encryption used on the server to store the content. - - - - Default is None. - - - If specifying encryption (not None), the corresponding request must include header - "x-amz-server-side-encryption" with the value of the encryption. - - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - Confirms that the requester knows that she or he will be charged for the request. - Bucket owners need not specify this parameter in their requests. - - - - - A set of response headers that should be returned with the pre-signed url creation response. - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - Custom parameters to include in the signed request, so that they are tamper-proof. - - - - - The parameters for a pre-signed URL to a bucket or object as a string. - - - For more information, refer to: . - - - - - The PreSignedURL as a string - - - - - Constructor - - A url returned from GetPreSignedUrlRequest - - - - Container for the parameters to the GetPublicAccessBlock operation. - Retrieves the Public Access Block configuration for an Amazon S3 bucket. - - - - - Gets and sets the property BucketName. - - The name of the Amazon S3 bucket whose Public Access Block configuration you want - to retrieve. - - - - - - This is the response object from the GetPublicAccessBlock operation. - - - - - The Public Access Block configuration currently in effect for this Amazon S3 bucket. - - - - - Container for the parameters to the HeadBucket operation. - This operation is useful to determine if a bucket exists and you have permission to access it. - - - - - Returns information about the HeadBucket response metadata. - The HeadBucket operation has a void result type. - - - - - This class contains the headers for an S3 object. - - - - - Gets and sets headers to set for the object. - - The name of the header - The value for the header - - - - Gets the count of headers. - - - - - Gets the names of the headers set. - - - - - Specifies caching behavior along the request/reply chain. - - - - - - Specifies presentational information for the object. - - - - - - Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type - referenced by the Content-Type header field. - - - - - - The size of the object, in bytes. - - - - - The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. This - header can be used as a message integrity check to verify that the data is the same data that was originally sent. - - - - - A standard MIME type describing the format of the object data. - - - - - - The date and time at which the object is no longer cacheable. - - - - - - - Container for the parameters to the InitiateMultipartUpload operation. - Initiates a multipart upload and returns an upload ID. - - - - - Envelope Key to Encrypt data - - - - - Encrypted Envelope Key to Encrypt data - - - - - Initialization Vector for encryption - - - - - A canned access control list (ACL) to apply to the object. - Please refer to for information on S3 Canned ACLs. - - - - - The name of the bucketName where the new object will be created, or existing object updated. - - - - - The key of the object to create or update. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - StorageClass property for the object. - - - Default: S3StorageClass.Standard. Set this property - only if you want reduced redundancy for this object. - Please refer to - for - information on S3 Storage Classes. - - - - - If the bucketName is configured as a website, redirects requests for this object to another object in the same bucketName or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - This is a convenience property for Headers.ContentType. - - - - - - Specifies the encryption to be used on the server for the new object. - - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - Checks if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - true if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - Specifies whether you want to apply a Legal Hold to the uploaded object. - - - - - - Gets and sets the property ObjectLockMode. - - Specifies the Object Lock mode that you want to apply to the uploaded object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - Specifies the date and time when you want the Object Lock to expire. - - - - - - The tag-set for the object. The tag-set must be encoded as URL Query parameters. - - - - - Checks if Tagging property is set - - true if Tagging is set. - - - - Returns information about the InitiateMultipartUpload response and response metadata. - - - - - Name of the bucketName to which the multipart upload was initiated. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Object key for which the multipart upload was initiated. - - - - - - Gets and sets the initiated multipart upload id. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - Date when multipart upload will become eligible for abort operation by lifecycle. - - - - - Id of the lifecycle rule that makes a multipart upload eligible for abort operation. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Identifies who initiated the multipart upload. - - - - - Name of the Principal. - - - - - - If the principal is an AWS account, it provides the Canonical User ID. If the principal is an IAM User, it provides a user ARN value. - - - - - - Describes the serialization format of the object. - - - - - Describes the serialization of a CSV-encoded object. - - - - - Specifies object's compression format. Valid values: NONE, GZIP. Default Value: NONE. - - - - - Specifies JSON as object's input serialization format. - - - - - Specifies Parquet as object's input serialization format. - - - - - Class for MetricsConfiguration - - - - - Contains information about where to publish the inventory results. - - - - - Specifies whether the inventory is enabled or disabled. - - - - - Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria. - - - - - The ID used to identify the inventory configuration. - - - - - Specifies which object version(s) to included in the inventory results. - - - - - Contains the optional fields that are included in the inventory results. - - - - - Specifies the schedule for generating inventory results. - - - - - Class for InventoryDestination - - - - - Contains the bucket name, file format, bucket owner (optional), and prefix (optional) where inventory results are published. - - - - - InventoryEncryption class - - - - - Specifies the use of SSE-S3 to encrypt delievered Inventory reports. - - - - - Specifies the use of SSE-KMS to encrypt delievered Inventory reports. - - - - - Class for InventoryFilter - - - - - Filter Predicate setup for specific filter types. - - - - - Filter Predicate abstract class for specific filter types to be derived from. - - - - - Class for InventoryPrefixPredicate - The prefix that an object must have to be included in the inventory results. - - - - - The ID of the account that owns the destination bucket. - - - - - The Amazon resource name (ARN) of the bucket where inventory results will be published. - - - - - The prefix that is prepended to all inventory results. - - - - - Specifies the output format of the inventory results. - - - - - Contains the type of server-side encryption used to encrypt the inventory results. - - - - - Class for InventorySchedule - - - - - Specifies how frequently inventory results are produced. - - - - - Specifies JSON as object's input serialization format. - - - - - The type of JSON. Valid values: Document, Lines. - - - - - Specifies JSON as request's output serialization format - - - - - The value used to separate individual records in the output. - - - - - Specifies an object key and optional object version. - - - - - Key name of the object to delete. - - - - - - VersionId for the specific version of the object to delete. - - - - - - This class contains the configuration Amazon S3 uses to figure out what events you want to listen - and send the event to an Amazon Lambda cloud function. - - - - - Gets and set the Id property. The Id will be provided in the event content and can be used - to identify which configuration caused an event to fire. If the Id is not provided for the configuration, one will be generated. - - - - - Gets and sets the FunctionArn property. This is the Amazon Lambda cloud function to which Amazon S3 will invoke with the events. - - - - Lifecycle Configuration - - - - - Gets and sets the Rules property. These rules defined the lifecycle configuration. - - - - - Base class for all the different predicates that can be used - in a filter. - - - - - This method is called by the visitor when it wants to visit the predicate. - - - - - - Filter identifying one or more objects to which a applies. - - - - - The predicate used by the filter. - - - - - Base class for lifecycle operators. - - - - - The list of objects - that this operator operates on. - - - - - The logical and operator for filtering objects for a - - - - - Accept a visit from an - - - This method is used internally by the SDK. - - - - - - A predicate that filters objects for a - by matching a particular prefix. - - - - - The prefix to be matched by filtered objects. - - - - - Accept a visit from an - - - This method is used internally by the SDK. - - - - - - A predicate that filters objects for a - by matching a particular key and value. - - - - - The Tag to be matched by filtered objects. - - - - - Accept a visit from an - - - This method is used internally by the SDK. - - - - - - Rules Item - - - - - Defines the length of time, in days, before objects expire. - - - - - Unique identifier for the rule. The value cannot be longer than 255 characters. - - - - - Prefix identifying one or more objects to which the rule applies. - - - - - - Filter identifying one or more objects to which the rule applies. - - - - - If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied. - - - - - - The transition rule that describes when objects transition to a different storage class. - - Lifecycle rules can now contain multiple transitions. This property is obsolete in favor of the Transitions property. - This property will always get or set the the zeroth element in the Transitions collection. - - - - - - Defines the length of time, in days, before noncurrent versions expire. - - - - - The transition rule that describes when noncurrent versions transition to - a different storage class. - - Lifecycle rules can now contain multiple noncurrent version transitions. This property - is obsolete in favor of the NoncurrentVersionTransitions property. - This property will always get or set the the zeroth element in the NoncurrentVersionTransitions collection. - - - - - - The transition rules that describe when objects transition to a different storage class. - - - - - The transition rules that describe when noncurrent versions transition to - a different storage class. - - - - - Specifies the days since the initiation of an Incomplete Multipart Upload - that Lifecycle will wait before permanently removing all parts of the upload. - - - - - Specifies the days since the initiation of an Incomplete Multipart Upload - that Lifecycle will wait before permanently removing all parts of the upload. - - - - - Indicates the number of days that must pass since initiation for Lifecycle - to abort an Incomplete Multipart Upload. - - - - Expiration - - - - - Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format. - - - - - - Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer. - - - - - - Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set to true, the delete marker will be expired; if set to false the policy takes no action. This cannot be specified with Days or Date in a Lifecycle Expiration Policy. - - - - - - Noncurrent Version Expiration - - - - - Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated - action. For information about the noncurrent days calculations, see - How Amazon S3 Calculates When an Object Became Noncurrent - in the Amazon Simple Storage Service Developer Guide. - - - - - LifecycleTransition defines when and how objects transition. - - - - - Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated - action. For information about the noncurrent days calculations, see - How Amazon S3 Calculates When an Object Became Noncurrent - in the Amazon Simple Storage Service Developer Guide. - - - - - The class of storage used to store the object. - - - - - - LifecycleTransition defines when and how objects transition. - - - - - Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format. - - - - - - Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer. - - - - - - The class of storage used to store the object. - - - - - - Container for the parameters to the ListInventoryConfigurationsRequest operation. - Lists the analytics configurations for the bucket. - - - - - The name of the bucket containing the analytics configurations to retrieve. - - - - - The ContinuationToken that represents a placeholder from where this request should begin. - - - - - Returns information about the ListBucketAnalyticsConfigurationsResponse response and response metadata. - - - - - The ContinuationToken that represents where this request began. - - - - - The list of analytics configurations for a bucket. - - - - - Indicates whether the returned list of analytics configurations is complete. - A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request. - - - - - NextContinuationToken is sent when isTruncated is true, which indicates that there are more analytics configurations to list. - The next request must include this NextContinuationToken. The token is obfuscated and is not a usable value. - - - - - Container for the parameters to the ListInventoryConfigurationsRequest operation. - Returns a list of inventory configurations for the bucket. - - - - - The name of the bucket containing the inventory configurations to retrieve. - - - - - The marker used to continue an inventory configuration listing that has been truncated. - Use the NextContinuationToken from a previously truncated list response to continue the listing. - The continuation token is an opaque value that Amazon S3 understands. - - - - - Returns information about the ListInventoryConfigurationsResponse response and response metadata. - - - - - If sent in the request, the marker that is used as a starting point for this inventory configuration list response. - - - - - The list of inventory configurations for a bucket. - - - - - Indicates whether the returned list of inventory configurations is truncated in this response. A value of true indicates that the list is truncated. - - - - - The marker used to continue this inventory configuration listing. Use the NextContinuationToken from this response to continue the listing in a subsequent request. - The continuation token is an opaque value that Amazon S3 understands. - - - - - Container for the parameters to the ListBucketMetricsConfigurationRequest operation. - Lists the metrics configurations for the bucket. - - - - - The name of the bucket containing the metrics configurations to retrieve. - - - - - - The marker that is used to continue a metrics configuration listing that has been truncated. - Use the NextContinuationToken from a previously truncated list response to continue the listing. - The continuation token is an opaque value that Amazon S3 understands. - - - - - - Returns information about the ListBucketMetricsConfiguration response and response metadata. - - - - - - The marker that is used to continue a metrics configuration listing that has been truncated. - Use the NextContinuationToken from a previously truncated list response to continue the listing. - The continuation token is an opaque value that Amazon S3 understands. - - - - - - The list of metrics configurations for a bucket. - - - - - - Indicates whether the returned list of metrics configurations is complete. - A value of true indicates that the list is not complete and the NextContinuationToken will be provided for - a subsequent request. - - - - - - - The marker used to continue a metrics configuration listing that has been truncated. - Use the NextContinuationToken from a previously truncated list response to continue the listing. - The continuation token is an opaque value that Amazon S3 understands. - - - - - - Container for the parameters to the ListBuckets operation. - Returns a list of all buckets owned by the authenticated sender of the request. - - - - - Returns information about the ListBuckets response and response metadata. - - - - - List of buckets. - - - - - Owner of the buckets. - - - - - Container for the parameters to the ListMultipartUploads operation. - This operation lists in-progress multipart uploads. - - - - - Name of the bucket to which the multipart upload was initiated. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Character you use to group keys. - - - - - - Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin. - - - - - - Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response body. 1,000 is the maximum number of uploads that - can be returned in a response. - - - - - - Lists in-progress uploads only for those keys that begin with the specified prefix. - - - - - - Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the - upload-id-marker parameter is ignored. - - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - Returns information about the ListMultipartUploads response and response metadata. - - - - - Name of the bucketName to which the multipart upload was initiated. - - - - - - The key at or after which the listing began. - - - - - - Upload ID after which listing began. - - - - - - When a list is truncated, this element specifies the value that should be used for the key-marker request parameter in a subsequent request. - - - - - - When a list is truncated, this element specifies the value that should be used for the upload-id-marker request parameter in a subsequent - request. - - - - - - Maximum number of multipart uploads that could have been included in the response. - - - - - - Indicates whether the returned list of multipart uploads is truncated. A value of true indicates that the list was truncated. The list can - be truncated if the number of multipart uploads exceeds the limit allowed or specified by max uploads. - - - - - - Gets and sets the MultipartUploads property. - - Container for elements related to a particular multipart upload. A response - can contain zero or more Upload elements. - - - - - - Gets and sets the Prefix property. - - - - - Gets and sets the Delimiter property. - - - - - Gets the CommonPrefixes property. - A response can contain CommonPrefixes only if you specify a delimiter. - When you do, CommonPrefixes contains all (if there are any) keys between - Prefix and the next occurrence of the string specified by delimiter. In effect, - CommonPrefixes lists keys that act like subdirectories in the directory specified - by Prefix. For example, if prefix is notes/ and delimiter is a slash (/), in - notes/summer/july, the common prefix is notes/summer/. - - - - - Container for the parameters to the ListObjects operation. - Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a - subset of the objects in a bucket. - - - - - The name of the bucket containing the objects whose keys are to be listed. - - - - - A delimiter is a character you use to group keys. - - - - - Specifies the key to start with when listing objects in a bucket. - - - - - Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more. - - - - - Limits the response to keys that begin with the specified prefix. - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the ListObjects response and response metadata. - - - - - A flag that indicates whether or not Amazon S3 returned all of the results that satisfied - the search criteria. - - - - - Gets and sets the NextMarker property. - NextMarker is set by S3 only if a Delimiter was specified - in the original ListObjects request. If a delimiter was - not specified, the AWS SDK for .NET returns the last Key - of the List of Objects retrieved from S3 as the NextMarker. - - - - - Gets the S3Objects property. This is a list of - objects in the bucket that match your search criteria. - - - - - Gets and sets the Name property which is the name of the bucket. - - - - - Gets and sets the Prefix property. - - - - - Gets and sets the MaxKeys property. This is max number of object keys returned by the list operation. - - - - - Gets the CommonPrefixes property. - A response can contain CommonPrefixes only if you specify a delimiter. - When you do, CommonPrefixes contains all (if there are any) keys between - Prefix and the next occurrence of the string specified by delimiter. In effect, - CommonPrefixes lists keys that act like subdirectories in the directory specified - by Prefix. For example, if prefix is notes/ and delimiter is a slash (/), in - notes/summer/july, the common prefix is notes/summer/. - - - - - Gets and sets the Delimiter property. - Causes keys that contain the same string between the prefix and the - first occurrence of the delimiter to be rolled up into a single result - element in the CommonPrefixes collection. - - - These rolled-up keys are not returned elsewhere in the response. - - - - - Container for the parameters to the ListObjects operation. - Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a - subset of the objects in a bucket. - - - - - Bucket name to list. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - A delimiter is a character you use to group keys. - - - - - Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more. - - - - - Limits the response to keys that begin with the specified prefix. - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts - listing after this specified key. StartAfter can be any key in the bucket. - Cannot be set at the same time as ContinuationToken. - - - - - ContinuationToken indicates Amazon S3 that the list is being continued on this - bucket with a token. ContinuationToken is obfuscated and is not a real key. - - - - - The owner field is not present in ListObjectsV2 responses by default. - If you want to return owner field with each key in the result then set this field to true. - If not specified, the Owner field on S3Object will be null. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the ListObjects response and response metadata. - - - - - A flag that indicates whether or not Amazon S3 returned all of the results that satisfied - the search criteria. - - - - - Gets and sets the S3Objects property. Metadata about each object returned. - - - - - Bucket name. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the Prefix property. - - - - - Gets and sets the MaxKeys property. This is max number of object keys returned by the list operation. - - - - - Gets and sets the CommonPrefixes property. - CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence - of the string specified by delimiter - - - - - Gets and sets the Delimiter property. - Causes keys that contain the same string between the prefix and the - first occurrence of the delimiter to be rolled up into a single result - element in the CommonPrefixes collection. - - - These rolled-up keys are not returned elsewhere in the response. - - - - - Encoding type used by Amazon S3 to encode object keys in the response. - - - - - KeyCount is the number of keys returned with this request. - KeyCount will always be less than or equal to MaxKeys field. - - - - - ContinuationToken indicates Amazon S3 that the list is being continued - on this bucket with a token. - ContinuationToken is obfuscated and is not a real key - - - - - NextContinuationToken is sent when isTruncated is true which means there - are more keys in the bucket that can be listed. The next ListObjectV2 call - to Amazon S3 can be continued with this NextContinuationToken. - NextContinuationToken is obfuscated and is not a real key. - - - - - StartAfter is where you want Amazon S3 to start listing from. - Amazon S3 starts listing after this specified key. - StartAfter can be any key in the bucket. - - - - - Container for the parameters to the ListParts operation. - Lists the parts that have been uploaded for a specific multipart upload. - - - - - Name of the bucket to which the parts are being uploaded. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The object key for which the multipart upload was initiated. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Sets the maximum number of parts to return. - - - - - - Specifies the part after which listing should begin. Only parts with higher part numbers will be listed. - - - - - - Upload ID identifying the multipart upload whose parts are being listed. - - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the ListParts response and response metadata. - - - - - Name of the bucketName to which the multipart upload was initiated. - - - - - - Object key for which the multipart upload was initiated. - - - - - - Upload ID identifying the multipart upload whose parts are being listed. - - - - - - Part number after which listing begins. - - - - - - When a list is truncated, this element specifies the last part in the list, as well as the value to use for the part-number-marker request - parameter in a subsequent request. - - - - - - Maximum number of parts that were allowed in the response. - - - - - - Indicates whether the returned list of parts is truncated. - - - - - - Gets and sets the Parts property. - - PartDetails is a container for elements related to a particular part. A response can contain - zero or more Part elements. - - - - - - Identifies who initiated the multipart upload. - - - - - - Gets and sets the Owner property. - - - - - The class of storage used to store the object. - - - - - - Date when multipart upload will become eligible for abort operation by lifecycle. - - - - - Id of the lifecycle rule that makes a multipart upload eligible for abort operation. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the ListVersions operation. - Returns metadata about all of the versions of objects in a bucket. - - - - - The bucket name that contains the objects. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - A delimiter is a character you use to group keys. - - - - - Specifies the key to start with when listing objects in a bucket. - - - - - Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more. - - - - - Limits the response to keys that begin with the specified prefix. - - - - - Specifies the object version you want to start listing from. - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - Returns information about the ListVersions response and response metadata. - - - - - A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria. If your results were - truncated, you can make a follow-up paginated request using the NextKeyMarker and NextVersionIdMarker response parameters as a starting - place in another request to return the rest of the results. - - - - - - Marks the last Key returned in a truncated response. - - - - - - Gets and sets the VersionIdMarker property. - Marks the last Version-Id returned in a truncated response. - - - - - Use this value for the key marker request parameter in a subsequent request. - - - - - - Use this value for the next version id marker parameter in a subsequent request. - - - - - - Gets and sets the Versions property. This is a list of - object versions in the bucket that match your search criteria. - - - - - Gets and sets the Name property. - The bucket's name. - - - - - Gets and sets the Prefix property. - Keys that begin with the indicated prefix are listed. - - - - - Gets and sets the MaxKeys property. - This is the maximum number of keys in the S3ObjectVersions collection. - The value is derived from the MaxKeys parameter to ListVersionsRequest. - - - - - Gets the CommonPrefixes property. - A response can contain CommonPrefixes only if you specify a delimiter. - When you do, CommonPrefixes contains all (if there are any) keys between - Prefix and the next occurrence of the string specified by delimiter. - - - - - Gets and sets the Delimiter property. - Causes keys that contain the same string between the prefix and the - first occurrence of the delimiter to be rolled up into a single result - element in the CommonPrefixes collection. - - - These rolled-up keys are not returned elsewhere in the response. - - - - - This class contains the meta data for an S3 object. - - - - - Gets and sets meta data for the object. Meta data names must start with "x-amz-meta-". If the name passeed in as the indexer - doesn't start with "x-amz-meta-" then it will be prepended. - - The name of the meta data. - The value for the meta data - - - - Adds the metadata to the collection, if the name already exists it will be overwritten. - - The name of the metadata element - The value for the metadata - - - - Gets the count of headers. - - - - - Gets the names of the meta data elements. - - - - - A metadata key-value pair to store with an object. - - - - - Key of metadata key-value pair - - - - - Value of metadata key-value pair - - - - - A container specifying replication metrics-related information, including whether - emitting metrics and Amazon S3 events for replication are enabled. In addition, contains - configurations related to specific metrics or events. Must be specified together with a - ReplicationTime block. - - - - - Specifies whether the replication metrics are enabled. - - - - - A container specifying the time threshold for emitting the - s3:Replication:OperationMissedThreshold event. - - - - - Class for MetricsAndOperatorPredicate - A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. - The operator must have at least two predicates, and an object must match all of the predicates - in order for the filter to apply. - - Note: The current implementation restricts the usage to atmost one MetricsPrefixPredicate - and any number of MetricsTagPredicates. - - - - Class for MetricsConfiguration - - - - - The ID used to identify the metrics configuration. - - - - - Specifies a metrics configuration filter. - The metrics configuration will only include objects that meet the filter's criteria. - A filter must be a prefix, a tag, or a conjunction (MetricsAndOperator). - - - - - Filter class for Metrics. - - - - - Filter Predicate setup for specific filter types. - - - - - Filter Predicate abstract class for specific filter types to be derived from. - - - - - Abstract class that can be used over logical filter predicates,i.e. AND/OR. - - - - - Class for MetricsPrefixPredicate - The prefix used when evaluating a metrics filter. - - - - - Class for MetricsTagPredicate - The tag used when evaluating a metrics filter. - - - - - This class contains the mfa codes used authentication - - - - - Gets and sets the serial number of the authentication device - - - - - Gets and sets the displated value on the authentication device - - - - - The formatted string of the mfa codes to be passed to S3. - - - - - Container for elements related to a particular multipart upload. - - - - - Date and time at which the multipart upload was initiated. - - - - - - Identifies who initiated the multipart upload. - - - - - - Key of the object for which the multipart upload was initiated. - - - - - - Gets and sets the Owner property. - - - - - The class of storage used to store the object. - - - - - - Upload ID that identifies the multipart upload. - - - - - - An abstract class for all the notification configurations associated with an Amazon S3 bucket. - - - - - Gets and sets the Events property. These are the events the configuration will listen to. - - - - - Filter criteria for determining which S3 objects trigger event notifications. - - - - - - The container element for Object Lock configuration parameters. - - - - - Gets and sets the property ObjectLockEnabled. - - Indicates whether this object has an Object Lock configuration enabled. - - - - - - Gets and sets the property Rule. - - The Object Lock rule in place for the specified object. - - - - - - A Legal Hold configuration for an object. - - - - - Gets and sets the property Status. - - Indicates whether the specified object has a Legal Hold in place. - - - - - - A Retention configuration for an object. - - - - - Gets and sets the property Mode. - - Indicates the Retention mode for the specified object. - - - - - - Gets and sets the property RetainUntilDate. - - - - - The container element for an Object Lock rule. - - - - - Gets and sets the property DefaultRetention. - - The default retention period that you want to apply to new objects placed in the specified - bucket. - - - - - - Describes the location where the restore job's output is stored. - - - - - Describes an S3 location that will receive the results of the restore request. - - - - - Describes how results of the Select job are serialized. - - - - - Describes the serialization of CSV-encoded Select results. - - - - - Specifies JSON as request's output serialization format. - - - - - The owner of an S3 bucket. - - - - - The display name of the owner. - - - - - The unique identifier of the owner. - - - - - This class contains custom querystring parameters for an S3 object, which can then be signed as part of a Pre-signed URL request - - - - - Gets and sets parameters for the object. Parameter names must start with "x-". If the name passeed in as the indexer - doesn't start with "x-" then it will be prepended. - - The name of the parameter. - The value for the meta data - - - - Adds the parameter to the collection, if the name already exists it will be overwritten. - - The name of the parameter - The value for the parameter - - - - Gets the count of parameters. - - - - - Gets the names of the parameter elements. - - - - - Specifies Parquet as object's input serialization format. - - - - - A container for elements related to a particular part in a multipart operation. - A response can contain zero or more Part elements. - - - - - The date and time at which the part was uploaded. - - - - - The size of the uploaded part data. - - - - - A container holding the part number and etag used when completing a multipart upload. - - - - - Default constructor. - - - - - Constructs an instance of PartETag and sets the part number and etag. - - The part number. - the associated ETag for the part number. - - - - Compares the current object with another object of the same type. - - An object to compare with this object. - - A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has the following meanings: - Value - Meaning - Less than zero - This object is less than the parameter. - Zero - This object is equal to . - Greater than zero - This object is greater than . - - - - - The part number identifying the part. - - - - - The entity tag associated with the part. - - - - - The container element for this bucket's public-policy status. - - - - - Gets and sets the property IsPublic. - - The public-policy status for this bucket. TRUE indicates that this bucket - is public. FALSE indicates that the bucket is not public. - - - - - - The container element for all Public Access Block configuration options. You can enable - the configuration options in any combination. - - - - Amazon S3 considers a bucket policy public unless at least one of the following conditions - is true: - -
  1. - - The policy limits access to a set of CIDRs using aws:SourceIp. For more - information on CIDR, see http://www.rfc-editor.org/rfc/rfc4632.txt - - -
  2. - - The policy grants permissions, not including any "bad actions," to one of the following: - -
    • - - A fixed AWS principal, user, role, or service principal - -
    • - - A fixed aws:SourceArn - -
    • - - A fixed aws:SourceVpc - -
    • - - A fixed aws:SourceVpce - -
    • - - A fixed aws:SourceOwner - -
    • - - A fixed aws:SourceAccount - -
    • - - A fixed value of s3:x-amz-server-side-encryption-aws-kms-key-id - -
    • - - A fixed value of aws:userid outside the pattern "AROLEID:*" - -
- - "Bad actions" are those that could expose the data inside a bucket to reads or writes - by the public. These actions are s3:Get*, s3:List*, s3:AbortMultipartUpload, - s3:Delete*, s3:Put*, and s3:RestoreObject. - - - - The star notation for bad actions indicates that all matching operations are considered - bad actions. For example, because s3:Get* is a bad action, s3:GetObject, - s3:GetObjectVersion, and s3:GetObjectAcl are all bad actions. - - - - - - Gets and sets the property BlockPublicAcls. - - Specifies whether Amazon S3 should block public ACLs for this bucket. Setting this - element to TRUE causes the following behavior: - -
  • - - PUT Bucket acl and PUT Object acl calls will fail if the specified ACL allows public - access. - -
  • - - PUT Object calls will fail if the request includes an object ACL. - -
- - Note that enabling this setting doesn't affect existing policies or ACLs. - - - - - - Gets and sets the property IgnorePublicAcls. - - Specifies whether Amazon S3 should ignore public ACLs for this bucket. Setting this - element to TRUE causes Amazon S3 to ignore all public ACLs on this bucket - and any objects that it contains. - - - - Note that enabling this setting doesn't affect the persistence of any existing ACLs - and doesn't prevent new public ACLs from being set. - - - - - - Gets and sets the property BlockPublicPolicy. - - Specifies whether Amazon S3 should block public bucket policies for this bucket. Setting - this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy - if the specified bucket policy allows public access. - - - - Note that enabling this setting doesn't affect existing bucket policies. - - - - - - Gets and sets the property RestrictPublicBuckets. - - Specifies whether Amazon S3 should restrict public bucket policies for this bucket. - If this element is set to TRUE, then only the bucket owner and AWS Services - can access this bucket if it has a public policy. - - - - Note that enabling this setting doesn't affect previously stored bucket policies, - except that public and cross-account access within any public bucket policy, including - non-public delegation to specific accounts, is blocked. - - - - - - Container for the parameters to the PutAcl operation. - uses the acl subresource to set the access control list (ACL) permissions for an object that already exists in a bucket - - - - - The canned ACL to apply to the bucket. - - - - - - Custom ACLs to be applied to the bucket or object. - - - - - The bucket name that contains the object to which you want to attach the ACL. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The key of an S3 object. - If not specified, the ACLs are applied to the bucket. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - If set and an object key has been specified, the ACLs are applied - to the specific version of the object. - This property is ignored if the ACL is to be set on a Bucket. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - Returns information about the PutObjectAcl response metadata. - The PutAcl operation has a void result type. - - - - - The response for the PutBucketAccelerateConfiguration operation. - Adds an object to a bucket. - - - - - Container for the parameters to the PutBucketAccelerateConfiguration request. - - - - - The name of the bucket to contain the object. - - - - - Accelerate configuration for the bucket. - - - - - Container for the parameters to the PutBucketAnalyticsConfiguration operation. - Sets an analytics configuration for the bucket (specified by the analytics configuration ID). - - - - - The name of the bucket to which an analytics configuration is stored. - - - - - The identifier used to represent an analytics configuration. - - - - - The configuration and any analyses for the analytics filter. - - - - - Returns information about the PutBucketAnalyticsConfigurationResponse response metadata. - The PutBucketAnalyticsConfigurationResponse operation has a void result type. - - - - - Container for the parameters to the PutBucketRequestPayment operation. - Creates a new server-side encryption configuration (or replaces an existing one, if present). - - - - - The name of the bucket for which the server-side encryption configuration is set. - - - - - The base64-encoded 128-bit MD5 digest of the server-side encryption configuration. - - - This header can be used as a message integrity check to verify that the data is the same data that was originally sent. - Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. - - - - - Container for server-side encryption configuration rules. Currently S3 supports one rule only. - - - - - Container for the parameters to the PutBucketRequestPayment operation. - Adds an inventory configuration (identified by the inventory ID) from the bucket. - - - - - The name of the bucket where the inventory configuration will be stored. - - - - - Specifies the inventory Id. - - - - - Specifies the inventory configuration. - - - - - Returns information about the PutInventoryConfigurationResponse response metadata. - The PutInventoryConfigurationResponse operation has a void result type. - - - - - Container for the parameters to the PutBucketLoggingRequest operation. - Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. To set the - logging status of a bucket, you must be the bucket owner. - - - - - Gets and sets the BucketName property. - - - - - Gets and sets the LoggingConfig property. - - - - - Returns information about the PutBucketLogging response metadata. - The EnableBucketLogging operation has a void result type. - - - - - Container for the parameters to the PutBucketMetricsConfigurationRequest operation. - Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. - - - - - The name of the bucket for which the metrics configuration is set. - - - - - The ID used to identify the metrics configuration. - - - - - Specifies the metrics configuration. - - - - - Returns information about the PutBucketMetricsConfiguration response metadata. - The PutBucketMetricsConfiguration operation has a void result type. - - - - - Container for the parameters to the PutBucketNotification operation. - Enables notifications of specified events for a bucket. - - - - - Gets and sets the BucketName property. - - - - - Gets and sets the TopicConfigurations property. TopicConfigurations are configuration for Amazon S3 - events to be sent to Amazon SNS topics. - - - - - Gets and sets the QueueConfigurations property. QueueConfigurations are configuration for Amazon S3 - events to be sent to Amazon SQS queues. - - - - - Gets and sets the LambdaFunctionConfigurations property. LambdaFunctionConfigurations are configuration for - Amazon S3 events to be sent to an Amazon Lambda cloud function. - - - - - Returns information about the PutBucketNotification response metadata. - The PutBucketNotification operation has a void result type. - - - - - Container for the parameters to the PutBucketPolicy operation. - Replaces a policy on a bucket. If the bucket already has a policy, the one in this request completely replaces it. - - - - - The name of the bucket. - - - - - The base64 encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. - - - This header can be used as a message integrity check to verify that the data is the same data that was originally sent. - Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. - - - - - The bucket policy as a JSON document. - - - - - Set this parameter to true to confirm that you want to remove your - permissions to change this bucket policy in the future. - - - - - Overriden to turn off sending SHA256 header. - - - - - Returns information about the PutBucketPolicy response metadata. - The PutBucketPolicy operation has a void result type. - - - - - Container for the parameters to the PutBucketReplication operation. - Sets replication configuration for your bucket. If a replication configuration exists, this replaces it. - - - - - The name of the bucket to have the replication configuration applied. - - - - - The replication configuration to be applied. - - - - - Gets and sets the property Token. - - - - - Returns information about the PutBucketReplicationConfiguration response metadata. - The PutBucketReplicationConfiguration operation has a void result type. - - - - - Container for the parameters to the PutBucket operation. - Creates a new bucket. - - - - - The canned ACL to apply to the bucket. - - - - - - If set to true the bucket will be created in the same region - as the configuration of the AmazonS3 client. - If PutBucketRequest.BucketRegion or PutBucketRequest.BucketRegionName are set they take precedence over - this property. - Default: true. - - - - - The name of the bucket to be created. - - - - - The region locality for the bucket. - - - When set, this will determine where your data will - reside in S3. Refer - for a list of possible values. - - - - - The bucket region locality expressed using the name of the region. - When set, this will determine where your data will reside in S3. - Valid values: us-east-1, us-west-1, us-west-2, eu-west-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, sa-east-1 - - - - - Gets and sets the property ObjectLockEnabledForBucket. - - Specifies whether you want S3 Object Lock to be enabled for the new bucket. - - - - - - Container for the parameters to the PutBucketRequestPayment operation. - Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This - configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the - download. - - - - - The name of the bucket to set payment config. - - - - - Gets and sets request payment configuration - - - - - Returns information about the PutBucketRequestPayment response metadata. - The PutBucketRequestPayment operation has a void result type. - - - - - Returns information about the PutBucket response and response metadata. - - - - - Container for the parameters to the PutBucketTagging operation. - Sets the tags for a bucket. - - - - - The name of the bucket to apply the tags to. - - - - - The collection of tags. - - - - - Returns information about the PutBucketTagging response metadata. - The PutBucketTagging operation has a void result type. - - - - - Container for the parameters to the PutBucketVersioning operation. - Sets the versioning state of an existing bucket. To set the versioning state, you must be the bucket owner. - - - - - The name of the bucket to be updated. - - - - - The MfaCodes Tuple associates the Serial Number and the current Token/Code displayed on the - Multi-Factor Authentication device associated with your AWS Account. - - - This is a required property for this request if:
- 1. EnableMfaDelete was configured on the bucket - containing this object's version.
- 2. You are deleting an object's version - - - - - Checks if the MfaCodes property is set. - - true if the MfaCodes property is set. - - - - The versioning configuration to apply to the bucket. - - - Once Versioning has been "Enabled" on a bucket, it can be "Suspended" - but cannot be switched "Off". If EnableMfaDelete is set, - the MfaCodes property needs to contain the Serial of and current Token - displayed on the MFA device. - - - - - Returns information about the PutBucketVersioning response metadata. - The PutBucketVersioning operation has a void result type. - - - - - Container for the parameters to the PutBucketWebsite operation. - Set the website configuration for a bucket. - - - - - The name of the bucket to apply the configuration to. - - - - - The website configuration to apply. The configuration defines the index - document suffix and custom error page. - - - - - Returns information about the PutBucketWebsite response metadata. - The PutBucketWebsite operation has a void result type. - - - - - Container for the parameters to the PutCORSConfiguration operation. - Sets the cors configuration for a bucket. - - - - - The name of the bucket to have the CORS configuration applied. - - - - - The CORS configuration to apply. - - - - - Returns information about the PutCORSConfiguration response metadata. - The PutCORSConfiguration operation has a void result type. - - - - - Container for the parameters to the PutLifecycleConfiguration operation. - Sets lifecycle configuration for your bucket. If a lifecycle configuration exists, it replaces it. - - - - - The name of the bucket to have the lifecycle configuration applied. - - - - - The lifecycle configuration to be applied. - - - - - Returns information about the PutLifecycleConfiguration response metadata. - The PutLifecycleConfiguration operation has a void result type. - - - - - Container for the parameters to the PutObjectLegalHold operation. - Applies a Legal Hold configuration to the specified object. - - - - - The bucket name containing the object that you want to place a Legal Hold on. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property ContentMD5. - - The MD5 signature for the configuration included in your request. - - - - - - Gets and sets the property Key. - - The key name for the object that you want to place a Legal Hold on. - - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Gets and sets the property LegalHold. - - Container element for the Legal Hold configuration you want to apply to the specified - object. - - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property VersionId. - - The version ID of the object that you want to place a Legal Hold on. - - - - - - This is the response object from the PutObjectLegalHold operation. - - - - - Gets and sets the property RequestCharged. - - - - - Container for the parameters to the PutObjectLockConfiguration operation. - Places an Object Lock configuration on the specified bucket. The rule specified in - the Object Lock configuration will be applied by default to every new object placed - in the specified bucket. - - - - - Gets and sets the property BucketName. - - The bucket whose Object Lock configuration you want to create or replace. - - - - - - Gets and sets the property ContentMD5. - - The MD5 signature for the configuration included in your request. - - - - - - Gets and sets the property ObjectLockConfiguration. - - The Object Lock configuration that you want to apply to the specified bucket. - - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property Token. - - - - - This is the response object from the PutObjectLockConfiguration operation. - - - - - Gets and sets the property RequestCharged. - - - - - Container for the parameters to the PutObject operation. - Adds an object to a bucket. - - - Container for the parameters to the PutObject operation. - Adds an object to a bucket. - - - - - A canned access control list (CACL) to apply to the object. - Please refer to for - information on S3 Canned ACLs. - - - - - Input stream for the request; content for the request will be read from the stream. - - - - - - The full path and name to a file to be uploaded. - If this is set the request will upload the specified file to S3. - - - For WinRT and Windows Phone this property must be in the form of "ms-appdata:///local/file.txt". - - - - - - Text content to be uploaded. Use this property if you want to upload plaintext to S3. - The content type will be set to 'text/plain'. - - - - - If this value is set to true then the stream used with this request will be closed when all the content - is read from the stream. - Default: true. - - - - - If this value is set to true then the stream will be seeked back to the start before being read for upload. - Default: true. - - - - - If this value is set to true then a chunked encoding upload will be used for the request. - Default: true. - - - - - Bucket name to which the PUT operation was initiated. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - Gets and sets Key property. This key is used to identify the object in S3. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - Checks if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - true if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - - - The type of storage to use for the object. Defaults to 'STANDARD'. - - - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - The Legal Hold status that you want to apply to the specified object. - - - - - - Gets and sets the property ObjectLockMode. - - The Object Lock mode that you want to apply to this object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - The date and time when you want this object's Object Lock to expire. - - - - - - If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - Attach a callback that will be called as data is being sent to the AWS Service. - - - - - This is a convenience property for Headers.ContentType. - - - - - An MD5 digest for the content. - - - - The base64 encoded 128-bit MD5 digest of the message - (without the headers) according to RFC 1864. This header - can be used as a message integrity check to verify that - the data is the same data that was originally sent. - - - If supplied, after the file has been uploaded to S3, - S3 checks to ensure that the MD5 hash of the uploaded file - matches the hash supplied. - - - Although it is optional, we recommend using the - Content-MD5 mechanism as an end-to-end integrity check. - - - - - - Checks if MD5Digest property is set. - - true if MD5Digest property is set. - - - - Overriden to turn off sending SHA256 header. - - - - - Overriden to turn on expect 100 continue. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - The tag-set for the object. The tag-set must be encoded as URL Query parameters. - - - - - Checks if Tagging property is set - - true if Tagging is set. - - - - Returns information about the PutObject response and response metadata. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - Entity tag for the uploaded object. - - - - - - Version of the object. - - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the PutObjectRetention operation. - Places an Object Retention configuration on an object. - - - - - The bucket name that contains the object you want to apply this Object Retention configuration to. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property BypassGovernanceRetention. - - - - - Gets and sets the property ContentMD5. - - The MD5 signature for the configuration included in your request. - - - - - - Gets and sets the property Key. - - The key name for the object that you want to apply this Object Retention configuration - to. - - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property Retention. - - The container element for the Object Retention configuration. - - - - - - Gets and sets the property VersionId. - - The version ID for the object that you want to apply this Object Retention configuration - to. - - - - - - This is the response object from the PutObjectRetention operation. - - - - - Gets and sets the property RequestCharged. - - - - - Container for the parameters to the PutObjectTagging operation. - - - - - The bucket name containing the object. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Check to see if Bucket property is set - - - - - Gets and sets Key property. This key is used to identify the object in S3. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Check to see if Key property is set - - - - - The tag-set for the object. The tag-set must be encoded as URL Query parameters - - - - - Checks if Tagging property is set. - - - - - VersionId used to reference a specific version of the object. - - - - - - Returns information about the PutObjectTagging response and response metadata. - - - - - Version of the object. - - - - - Container for the parameters to the PutPublicAccessBlock operation. - Creates or modifies the Public Access Block configuration for an Amazon S3 bucket. - - - - - Gets and sets the property BucketName. - - The name of the Amazon S3 bucket whose Public Access Block configuration you want - to set. - - - - - - Gets and sets the property ContentMD5. - - The MD5 hash of the PutPublicBlock request body. - - - - - - Gets and sets the property PublicAccessBlockConfiguration. - - The Public Access Block configuration that you want to apply to this Amazon S3 bucket. - - - - - - This is the response object from the PutPublicAccessBlock operation. - - - - - Base class for put operations that can also put an ACL. - - - - - Gets the access control lists (ACLs) for this request. - Please refer to for information on - S3 Grants. - - - - - This class contains the configuration Amazon S3 uses to figure out what events you want to listen - and send the event to an Amazon SQS queue. - - The queue's policy must allow S3 to send messages to it. The utility method - Amazon.SQS.AmazonSQSClient.AuthorizeS3ToSendMessage(string,string) - can be used to help setup the queue policy. - - - - - - Gets and set the Id property. The Id will be provided in the event content and can be used - to identify which configuration caused an event to fire. If the Id is not provided for the configuration, one will be generated. - - - - - Gets and sets the Queue property. Amazon SQS queue to which Amazon S3 will publish a message - to report the specified events for the bucket. - - The queue's policy must allow S3 to send messages to it. The utility method - Amazon.SQS.AmazonSQSClient.AuthorizeS3ToSendMessage(string,string) - can be used to help setup the queue policy. - - - - - - This class defines the configuration for replication. - - - - - Indicates the ARN of the role to assume. - - - - - Check to see if the Role property is set. - - true if the Role property is set. - - - - Container for information about a particular replication rule. - Replication configuration must have at least one rule and can contain up to 1,000 rules. - - - - - Checks to see if the Rules property is set. - - true if the Rules property is set. - - - - Destination configuration for a replication rule. - - - - -

Amazon resource name (ARN) of the bucket where you want Amazon - S3 to store replicas of the object identified by the rule.

- If you have multiple rules in your replication configuration, all - rules must specify the same bucket as the destination. A replication - configuration can replicate objects only to one destination bucket.

- - - - - Checks to see if BucketArn property is set. - - true if BucketArn property is set. - - - - The class of storage used to store the object. - - - - - -

Account ID of the destination bucket. Currently Amazon S3 verifies this - value only if Access Control Translation is enabled.

In a cross-account - scenario, if you tell Amazon S3 to change replica ownership to the AWS account - that owns the destination bucket by adding the AccessControlTranslation - element, this is the account ID of the destination bucket owner.

- - - - -

Container for information regarding the access control for replicas.

-

Use only in a cross-account scenario, where source and destination bucket - owners are not the same, when you want to change replica ownership to the AWS - account that owns the destination bucket. If you don't add this element to the - replication configuration, the replicas are owned by same AWS account that - owns the source object.

- - - - -

Container that provides encryption-related information. You must - specify this element if the SourceSelectionCriteria is - specified.

- - - - - A container specifying the time when all objects and operations on objects are - replicated. Must be specified together with a Metrics block. - - - - - A container specifying replication metrics-related information, including whether - emitting metrics and Amazon S3 events for replication are enabled. In addition, - contains configurations related to specific metrics or events. Must be specified - together with a ReplicationTime block. - - - - - Rule that specifies the replication configuration. - - - - - Unique identifier for the rule. The value cannot be longer than 255 characters. - - - - - Checks to see if Id property is set. - - true if Id property is set. - - - -

The priority associated with the rule. If you specify multiple rules in a - replication configuration, then Amazon S3 applies rule priority in the event - there are conflicts (two or more rules identify the same object based on - filter specified). The rule with higher priority takes precedence. For - example,

  • Same object quality prefix based filter criteria - If prefixes you specified in multiple rules overlap.

  • Same - object qualify tag based filter criteria specified in multiple rules

    • -

For more information, see - - Cross-Region Replication (CRR) in the Amazon S3 Developer Guide.

- - - - - Checks to see if Priority property is set. - - true if Priority property is set. - - - - Object keyname prefix identifying one or more objects to which the - rule applies. Maximum prefix length can be up to 1,024 characters. - - - - - Checks to see if Prefix property is set. - - true if Prefix property is set. - - - - Gets and sets the property Filter. - - - - - Checks to see if Filter property is set. - - true if Filter property is set. - - - - Whether the rule is applied or ignored. - - - - - Checks to see if Status property is set. - - true if Status property is set. - - - - Container for replication destination information. - - - - - Checks to see if Destination property is set. - - true if Destination property is set. - - - -

Container that describes additional filters in identifying source objects that - you want to replicate. Currently, Amazon S3 supports only the filter that you can - specify for objects created with server-side encryption using an AWS KMS-managed - key. You can choose to enable or disable replication of these objects.

if - you want Amazon S3 to replicate objects created with server-side encryption using - AWS KMS-managed keys.

- - - - - A container that specifies information about existing object replication. - You can choose whether to enable or disable the replication of existing objects. - - - - - Checks to see if ExistingObjectReplication property is set. - - true if ExistingObjectReplication property is set. - - - - Specifies whether Amazon S3 should replicate delete makers. - - - - - Checks to see if DeleteMarkerReplication property is set. - - true if DeleteMarkerReplication property is set. - - - - - - - - Object keyname prefix that identifies subset of objects to which the rule applies. - - - - - Checks to see if Prefix property is set. - - true if Prefix property is set. - - - - All of these tags must exist in the object's tag set in order for the rule to apply. - - - - - Checks to see if Tags property is set. - - true if Tags property is set. - - - - Filter that identifies subset of objects to which the replication rule applies. - A Filter must specify exactly one Prefix, - Tag, or an And child element. - - - - - Object keyname prefix that identifies subset of objects to which the rule applies. - - - - - Checks to see if Prefix property is set. - - true if Prefix property is set. - - - -

Container for specifying a tag key and value.

-

The rule applies only to objects having the tag in its tagset.

- - - - - Checks to see if Tag property is set. - - true if Tag property is set. - - - -

Container for specifying rule filters. These filters determine the - subset of objects to which the rule applies. The element is required - only if you specify more than one filter. For example:

  • -

    You specify both a Prefix and a Tag - filters. Then you wrap these in an And tag.

    • -

  • You specify filter based on multiple tags. Then you wrap the - Tag elements in an And tag.

- - - - - Checks to see if And property is set. - - true if And property is set. - - - - A container specifying the time when all objects and operations on objects are replicated. Must be specified together with a Metrics block. - - - - - Specifies whether the replication time is enabled. - - - - - A container specifying the time by which replication should complete for all objects and operations on objects. - - - - - A container specifying the time value. - - - - - Contains an integer specifying time in minutes. - - - - - Request Payment Configuration - - - - - Specifies who pays for the download and request fees. - - - - - Container for values of the response headers that will be set on a response from a GetObject request. - These values override any headers that were set when the object was uploaded to S3. - - - - - A standard MIME type describing the format of the object data. - - - The content type for the content being uploaded. This property defaults to "binary/octet-stream". - For more information, refer to: - - - - - ContentLanguage header value. - - - - - Expiry header value. - - - - - CacheControl header value. - - - - - The ContentDisposition header value. - - - - - The ContentEncoding header value. - - - - - Container for the parameters to the RestoreObject operation. - Restores an archived copy of an object back into Amazon S3 - - - - - The bucket name or containing the object to restore. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the Key property. This key indicates the S3 object to restore. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Lifetime of the active copy in days - ** Do not use with restores that specify OutputLocation ** - - - - - VersionId used to reference a specific version of the object. - - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Glacier retrieval tier at which the restore will be processed. - ** Do not use with restores that specify OutputLocation ** - - - - - Glacier retrieval tier at which the restore will be processed. - ** Only use with restores that require OutputLocation ** - - - - - Type of restore request. - - - - - The optional description for the job. - - - - - Describes the parameters for Select job types. - - - - - Describes the location where the restore job's output is stored. - - - - - Returns information about the RestoreObject response metadata. - The RestoreObject operation has a void result type. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Indicates the path in the provided S3 output location where Select results will be restored to. - - - - Routing Rule - - - - - A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the - /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might - process the error. - - - - - - Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event of an - error, you can can specify a different error code to return. - - - - - - A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages - in the /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you - might process the error. - - - - - The HTTP error code when the redirect is applied. In the event of an error, if the error code equals this value, then the specified redirect - is applied. Required when parent element Condition is specified and sibling KeyPrefixEquals is not specified. If both are specified, then - both must be true for the redirect to be applied. - - - - - - The object key name prefix when the redirect is applied. For example, to redirect requests for ExamplePage.html, the key prefix will be - ExamplePage.html. To redirect request for all pages with the prefix docs/, the key prefix will be /docs, which identifies all objects in the - docs/ folder. Required when the parent element Condition is specified and sibling HttpErrorCodeReturnedEquals is not specified. If both - conditions are specified, both must be true for the redirect to be applied. - - - - - - Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event - of an error, you can can specify a different error code to return. - - - - - Name of the host where requests will be redirected. - - - - - - The HTTP redirect code to use on the response. Not required if one of the siblings is present. - - - - - - Protocol to use (http, https) when redirecting requests. The default is the protocol that is used in the original request. - - - - - - The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix docs/ (objects in the - docs/ folder) to documents/, you can set a condition block with KeyPrefixEquals set to docs/ and in the Redirect set ReplaceKeyPrefixWith to - /documents. Not required if one of the siblings is present. Can be present only if ReplaceKeyWith is not provided. - - - - - - The specific object key to use in the redirect request. For example, redirect request to error.html. Not required if one of the sibling is - present. Can be present only if ReplaceKeyPrefixWith is not provided. - - - - - - Represents an access control list (ACL) for S3. An AccessControlList is represented by an Owner, - and a List of Grants, where each Grant is a Grantee and a Permission. - - - - Each bucket and object in Amazon S3 has an ACL that defines its access control policy. - When a request is made, Amazon S3 authenticates the request using its standard - authentication procedure and then checks the ACL to verify the sender was granted access - to the bucket or object. If the sender is approved, the request proceeds. - Otherwise, Amazon S3 returns an error. - - - An ACL is a list of grants. A grant consists of one grantee and one permission. - ACLs only grant permissions; they do not deny them. - - - For convenience, some commonly used Access Control Lists are defined in - S3CannedACL. - - - Note: BucketName and object ACLs are completely independent; an object does not inherit the ACL - from its bucket. For example, if you create a bucket and grant write access to another user, - you will not be able to access the user's objects unless the user explicitly grants access. - This also applies if you grant anonymous write access to a bucket. Only the user "anonymous" - will be able to access objects the user created unless permission is explicitly granted to - the bucket owner. - - - Important: We highly recommend that you do not grant the anonymous group write access to your - buckets as you will have no control over the objects others can store and their associated charges. - For more information, see Grantees and Permissions - - - - - Creates a S3Grant and adds it to the list of grants. - - The grantee for the grant. - The permission for the grantee. - - - - Removes a specific permission for the given grantee. - - The grantee - The permission for the grantee to remove - - - - Removes all permissions for the given grantee. - - - - - - The owner of the bucket or object. - - - - Every bucket and object in Amazon S3 has an owner, the user that - created the bucket or object. The owner of a bucket or object cannot - be changed. However, if the object is overwritten by another user - (deleted and rewritten), the new object will have a new owner. - - - Note: Even the owner is subject to the ACL. For example, if an owner - does not have Permission.READ access to an object, the owner cannot read - that object. However, the owner of an object always has write access to the - access control policy (Permission.WriteAcp) and can change the ACL to - read the object. - - - - - - Checks if Owner property is set. - - true if Owner property is set. - - - - A collection of grants. - - - - - Checks if Grants property is set. - - true if Grants property is set. - - - Bucket - Represents an S3 bucket, contains the name of the S3 bucket and the date that the bucket was created. - - - - - Date the bucket was created. - - - - - - The name of the bucket. - - - - - Logging Enabled - - - - - Specifies the bucket where you want Amazon S3 to store server access logs. You can have your logs delivered to any bucket that you own, - including the same bucket that is being logged. You can also configure multiple buckets to deliver their logs to the same target bucket. In - this case you should choose a different TargetPrefix for each source bucket so that the delivered log files can be distinguished by key. - - - - - A collection of grants. - - - - - This element lets you specify a prefix for the keys that the log files will be stored under. - - - - - Creates a S3Grant and adds it to the list of grants. - - The grantee for the grant. - The permission for the grantee. - - - - Removes a specific permission for the given grantee. - - The grantee - The permission for the grantee to remove - - - - Removes all permissions for the given grantee. - - - - - - An S3 bucket versioning configuration. - - - Contains the bucket's versioning status (Off, Enabled, Suspended) and whether an MFADelete - has been enabled for the bucket. - - - - - Versioning status for the bucket. - Accepted values: Off, Enabled, Suspended. - - - - - Checks if Status property is set - - true if Status property is set - - - - Specifies whether MFA Delete is enabled on this S3 Bucket. - - - If this property is set, please ensure that the - PutBucketVersioningRequest's MfaCodes property is set with - the Serial of and Token on the MFA device. - - - - - Checks if EnableMfaDelete property is set. - - true if Status property is set - - - - Describes the server-side encryption that will be applied to the restore results. - - - - - The server-side encryption algorithm used when storing job results in Amazon S3 (e.g., AES256, aws:kms). - - - - - Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by - AWS KMS will fail if not made via SSL or using SigV4. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at - http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version - - - - - If the encryption type is aws:kms, this optional value can be used to specify the encryption context for the restore results. - - - - Grant - - - - - The grantee details. - - - - - Specifies the permission given to the grantee. - - - - - Grantee - - - - - Type of grantee - - - - - - Screen name of the grantee. - - - - - - Email address of the grantee. - - - - - - The canonical user ID of the grantee. - - - - - - URI of the grantee group. - - - - - - Filter criteria that allows for event notification filtering based on an S3 Object's key name. - - - - - Gets and sets the filterRules property. - These are the filter rules for this filter. - - - - - Describes an S3 location that will receive the results of the restore request. - - - - - The name of the bucket where the restore results will be placed. - - - - - The prefix that is prepended to the restore results for this request. - - - - - The canned ACL to apply to the restore results. - - - - - A list of grants that control access to the staged results. - - - - - The tag-set that is applied to the restore results. - - - - - A map of metadata to store with the restore results in S3. - - - - - The class of storage used to store the restore results. - - - - - Represents an S3 Object. Contains all attributes that an S3 Object has. - For more information about S3 Objects refer: - - - - - - Any ETag set on the object. - - - - - The name of the bucket containing this object. - - - - - The key of the object. - - - - - The date and time the object was last modified. - - The date retrieved from S3 is in ISO8601 format. A GMT formatted date is passed back to the user. - - - - - - The owner of the object. - - - - - The size of the object. - - - - - The class of storage used to store the object. - - - - - - Represents a version of an object in an S3 Bucket. An S3 object version is an S3 object - that also has a version identifier, an indication of whether this is the latest version of the object - and whether it's a DeleteMarker or not. - - - - - Specifies whether the object is (true) or is not (false) the latest version of an object. - - - - - Version ID of an object. - - - - - If true, the object is a delete marker for a deleted object. - - - - - Specifies the byte range of the object to get the records from. A record is processed when its first byte is contained by the range. - - - - - Specifies the start of the byte range. This parameter is optional. Valid values: non-negative integers. The default value is 0. - - - - - Specifies the end of the byte range. This parameter is optional. Valid values: non-negative integers. The default value is one less than the size of the object being queried. - - - - - Request to filter the contents of an Amazon S3 object based on a simple Structured Query Language (SQL) statement. - - In the request, along with the SQL expression, you must also specify a data serialization format (JSON or CSV) of the object. - Amazon S3 uses this to parse object data into records, and returns only records - that match the specified SQL expression. You must also specify the data serialization format for the response. - - - - S3Select API Documentation - - - - - The S3 Bucket. - - - - - The Object Key. - - - - - The SSE Algorithm used to encrypt the object. - - - Server-Side Encryption (Using Customer-Provided Encryption Keys. - - - - - The SSE Customer Key. - - - Server-Side Encryption (Using Customer-Provided Encryption Keys. - - - - - The SSE Customer Key MD5. - - - Server-Side Encryption (Using Customer-Provided Encryption Keys. - - - - - The expression that is used to query the object. - - - - - The type of the provided expression (e.g., SQL). - - - - - Specifies if periodic request progress information should be enabled. - - - - - Describes the format of the data in the object that is being queried. - - - - - Describes the format of the data that you want Amazon S3 to return in response. - - - - - The byte range of the object to get the records from. - - - - - Contains the response Payload for the SelectObjectContent request - - - - - The Event Stream result of SelectObjectContent - - - - - Describes the parameters for Select job types. - - - - - Describes the serialization format of the object. - - - - - The type of the provided expression (e.g., SQL). - - - - - The expression that is used to query the object. - - - - - Describes how the results of the Select job are serialized. - - - - - ServerSideEncryptionByDefault class - - - - - Server-side encryption algorithm to use for the default encryption. - - - - - KMS master key ID to use for the default encryption. - This parameter is allowed if SSEAlgorithm is aws:kms. - - - - - ServerSideEncryptionConfiguration class - - - - - Container for information about a particular server-side encryption configuration rule. - - - - - ServerSideEncryptionRule class - - - - - Describes the default server-side encryption to apply to - new objects in the bucket. If Put Object request - does not specify any server-side encryption, - this default encryption will be applied. - - - - - SourceSelectionCriteria class - - - - - Container for filter information of selection of KMS Encrypted - S3 objects. The element is required if you include - SourceSelectionCriteria in the replication - configuration. - - - - - SSEKMS class - - - - - Specifies the ID of the AWS Key Management Service (KMS) - master encryption key to use for encrypting Inventory reports. - - - - - SseKmsEncryptedObjects class - - - - - The replication for KMS encrypted S3 objects is disabled if status is not Enabled. - - - - - SSES3 class - - - - - Class for StorageClassAnalysis - - - - - A container used to describe how data related to the storage class analysis should be exported. - - - - - Class for StorageClassAnalysisDataExport - - - - - The version of the output schema to use when exporting data. Must be V_1. - - - - - The place to store the data for an analysis. - - - - - Base class for responses that return a stream. - - - - - Disposes of all managed and unmanaged resources. - - - - - An open stream read from to get the data from S3. In order to - use this stream without leaking the underlying resource, please - wrap access to the stream within a using block. - - - - - The exception that is thrown when the size of a stream does not match it's expected size. - - - - - Gets and sets ExpectedSize property. - - - - - Gets and sets ActualSize property. - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - - - Tag is a key-value pair of metadata associated with an S3Object - - - - - Name of the tag. - - - - - Value of the tag. - - - - - Structure that contains list of Tags - - - - - TagSet - - - - - This class contains the configuration Amazon S3 uses to figure out what events you want to listen - and send the event to an Amazon SNS topic. - - The topic's policy must allow S3 to publish messages to it. The utility method - Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.AuthorizeS3ToPublish(string,string) - can be used to help setup the topic policy. - - - - - - Gets and set the Id property. The Id will be provided in the event content and can be used - to identify which configuration caused an event to fire. If the Id is not provided for the configuration, one will be generated. - - - - - Bucket event for which to send notifications. - - Topic configurations can now contain multiple events. This property is obsolete in favor of the Events property. - This property will always get or set the the zeroth element in the Events collection. - - - - - - Gets and sets the Topic property. Amazon SNS topic to which Amazon S3 will publish a message to report the - specified events for the bucket. - - The topic's policy must allow S3 to publish messages to it. The utility method - Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.AuthorizeS3ToPublish(string,string) - can be used to help setup the topic policy. - - - - - - The parameters to request upload of a part in a multipart upload operation. - - - - If PartSize is not specified then the rest of the content from the file - or stream will be sent to Amazon S3. - - - You must set either the FilePath or InputStream. If FilePath is set then the FilePosition - property must be set. - - - - The parameters to request upload of a part in a multipart upload operation. - - - - If PartSize is not specified then the rest of the content from the file - or stream will be sent to Amazon S3. - - - You must set either the FilePath or InputStream. If FilePath is set then the FilePosition - property must be set. - - - - - - Caller needs to set this to true when uploading the last part. This property only needs to be set - when using the AmazonS3EncryptionClient. - - - - - Input stream for the request; content for the request will be read from the stream. - - - - - The name of the bucket containing the object to receive the part. - - - - - The key of the object. - - - This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class - is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." - is interpreted as use parent directory. For further information view the documentation for - the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri - - - - - Part number of part being uploaded. - - - - - - The size of the part to be uploaded. - - - - - Checks if PartSize property is set. - - true if PartSize property is set. - - - - Upload ID identifying the multipart upload whose part is being uploaded. - - - - - - An MD5 digest for the part. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - - Full path and name of a file from which the content for the part is retrieved. - - - For WinRT and Windows Phone this property must be in the form of "ms-appdata:///local/file.txt". - - - - - - Checks if the FilePath property is set. - - true if FilePath property is set. - - - - Position in the file specified by FilePath from which to retrieve the content of the part. - This field is required when a file path is specified. It is ignored when using the InputStream property. - - - - - If this value is set to true then a chunked encoding upload will be used for the request. - Default: true. - - - - - Checks if the FilePosition property is set. - - true if FilePosition property is set. - - - - Checks if the MD5Digest property is set. - - true if Md5Digest property is set. - - - - Attach a callback that will be called as data is being sent to the AWS Service. - - - - - Overriden to turn off sending SHA256 header. - - - - - Overriden to turn on Expect 100 continue. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the UploadPart response and response metadata. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - Entity tag for the uploaded object. - - - - - - Gets and sets the part number specified for the part upload. This is needed when - completing the multipart upload. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - Website Configuration - - - - - The ErrorDocument value, an object key name to use when a 4XX class error occurs. - - - - - - This value is a suffix that is appended to a request that is for a "directory" - on the website endpoint (e.g. if the suffix is index.html and - you make a request to samplebucket/images/ the data that - is returned will be for the object with the key name - images/index.html) - - - The suffix must not be empty and must not include a slash - character. - - - - - - Container for redirect information where all requests will be redirect - to. You can redirect requests to another host, to another page, or with - another protocol. In the event of an error, you can can specify a - different error code to return. . - - - - - The list of routing rules that can be used for configuring redirects if certain conditions are meet. - - - - - The Continuation Event. - - - - - Constructs a Continuation Event. - - - - - Constructs a Continuation Event. - - - - - - The End Event. - - - - - Constructs an End Event. - - - - - Constructs an End Event. - - - - - - Common Contract for S3 Events. - - - - - The Progress event details. - - - - - Current number of object bytes scanned. - - - - - Current number of uncompressed object bytes processed. - - - - - Total number of bytes of records payload data returned. - - - - - Constructs a instance of Progress. - - - - - The Progress Event. - - - - - The Progress event details. - - - - - Constructs a ProgressEvent. - - - - - Constructs a ProgressEvent. - - - - - - The Records Event - - - - - The byte array of partial, one or more result records. - - Payload is a , which is not thread-safe. - - - - - Constructs a RecordsEvent - - - - - Creates a new End Event. - - - - - - Modeled Exception that either comes over the stream from the service model, or wraps other exceptions for the purpose of raising events. If it is - modelled, it will be a subclass. - - - - - Creates a new S3EventStreamException - - - - - Creates a new S3EventStreamException - - - - - - Creates a new S3EventStreamException - - - - - - - The contract for the SelectObjectContentEventStream. - - - - - Event that encompasses all IS3Events. - - - - - Event that encompasses S3EventStreamExceptions. - - - - - Reaised when a Records event is received. - - - - - Reaised when a Stats event is received. - - - - - Reaised when a Progress event is received. - - - - - Reaised when a Continuation event is received. - - - - - Reaised when an End event is received. - - - - - A Stream of Events returned by the SelectObjectContent operation. Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treaded as mutually exclusive. - - - - - The mapping of event message to a generator function to construct the matching Event Stream event. - - - - - The mapping of event message to a generator function to construct the matching Event Stream exception. - - - - - Whether the backround processing loop is running. - - - - - Event that encompasses all IS3Events. - - - - - Event that encompasses S3EventStreamExceptions. - - - - - Reaised when a Records event is received. - - - - - Reaised when a Stats event is received. - - - - - Reaised when a Progress event is received. - - - - - Reaised when a Continuation event is received. - - - - - Reaised when an End event is received. - - - - - Event Stream returned by SelectObjectContentStream. - - Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treated as mutually exclusive. - - The network stream which events will be parsed from. - - - - Event Stream returned by SelectObjectContentStream. - - Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treaded as mutually exclusive. - - The network stream which events will be parsed from. - The decoder responsible for parsing events. - - - - The Stats event details. - - - - - Total number of object bytes scanned. - - - - - Total number of uncompressed object bytes processed. - - - - - Total number of bytes of records payload data returned. - - - - - Constructs an instance of Stats. - - - - - The Stats Event. - - - - - The Stats event details. - - - - - Constructs a StatsEvent - - - - - Constructs a ProgressEvent. - - - - - - This Event is returned if an event is retrieved from the event stream, but a generator function - for the event is not defined. - - - - - Constructs an UnknownEventStreamEvent. - - - - - Constructs an UnknownEventStreamEvent. - - The Message recieved from the event stream before conversion. - - - - Constructs an UnknownEventStreamEvent. - - The Message recieved from the event stream before conversion. - The event type. - - - - Arguments containing event details for an in-flight transfer. - - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - - - - Gets the percentage of transfer completed - - - - - Gets the number of bytes transferred since last event - - - - - Gets the number of bytes transferred - - - - - Gets the total number of bytes to be transferred - - - - - Returns a string representation of this object - - - - - - AmazonS3 exception. - Thrown when DeleteObjects returns successfully, but some of the objects - were not deleted. - - - - - Gets and sets the ErrorResponse property. - The DeleteObjectsErrorResponse associated with this exception. - - - - - Constructs an instance of DeleteObjectsException - - - - - - Uri wrapper that can parse out information (bucket, key, region, style) from an - S3 URI. - - - - - True if the URI contains the bucket in the path, false if it contains the bucket in the authority. - - - - - The bucket name parsed from the URI (or null if no bucket specified). - - - - - The key parsed from the URI (or null if no key specified). - - - - - The region parsed from the URI (or null if no region specified). - - - - - Constructs a parser for the S3 URI specified as a string. - - The S3 URI to be parsed. - - - - Constructs a parser for the S3 URI specified as a Uri instance. - - The S3 URI to be parsed. - - - - If the given string is an AmazonS3Endpoint return true and set the AmazonS3Uri out parameter. - - - - true if the string is an AmazonS3Endpoint, and the out paramter has been filled in, false otherwise - - - - If the given Uri is an AmazonS3Endpoint return true and set the AmazonS3Uri out parameter. - - - - true if the Uri is an AmazonS3Endpoint, and the out paramter has been filled in, false otherwise - - - - Checks whether the given URI is a Amazon S3 URI. - - The S3 URI to be checked. - true if the URI is a Amazon S3 URI, false; otherwise. - - - - Checks whether the given URI is a Amazon S3 URI. - - The S3 URI to be checked. - true if the URI is a Amazon S3 URI, false; otherwise. - - - - Percent-decodes the given string, with a fast path for strings that are not - percent-encoded. - - The string to decode - The decoded string - - - - Percent-decodes the given string. - - The string to decode - The index of the first '%' in the string - The decoded string - - - - Decodes the percent-encoded character at the given index in the string - and appends the decoded value to the string under construction. - - - The string under construction to which the decoded character will be - appended. - - The string being decoded. - The index of the '%' character in the string. - - - - Converts a hex character (0-9A-Fa-f) into its corresponding quad value. - - The hex character - The quad value - - - - Provides utilities used by the Amazon S3 client implementation. - These utilities might be useful to consumers of the Amazon S3 - library. - - - - - Determines MIME type from a file extension - - The extension of the file - The MIME type for the extension, or text/plain - - - - URL encodes a string. If the path property is specified, - the accepted path characters {/+:} are not encoded. - - The string to encode - Whether the string is a URL path or not - - - - - Converts a non-seekable stream into a System.IO.MemoryStream. - A MemoryStream's position can be moved arbitrarily - - The stream to be converted - A seekable MemoryStream - MemoryStreams use byte arrays as their backing store. - Please use this judicially as it is likely that a very large - stream will cause system resources to be used up. - - - - - Formats the current date as a GMT timestamp - - A GMT formatted string representation - of the current date and time - - - - - Generates an MD5 Digest for the string-based content - - The content for which the MD5 Digest needs - to be computed. - - Whether the returned checksum should be - base64 encoded. - - A string representation of the hash with or w/o base64 encoding - - - - - Only escape non-ascii characters in a string - - - - - - - Version2 S3 buckets adhere to RFC 1035: - - Less than 255 characters, with each label less than 63 characters. - Label must start with a letter - Label must end with a letter or digit - Label can have a string of letter, digits and hyphens in the middle. - Although names can be case-sensitive, no significance is attached to the case. - RFC 1123: Allow label to start with letter or digit (e.g. 3ware.com works) - RFC 2181: No restrictions apart from the length restrictions. - - S3 V2 will start with RFCs 1035 and 1123 and impose the following additional restrictions: - - Length between 3 and 63 characters (to allow headroom for upper-level domains, - as well as to avoid separate length restrictions for bucket-name and its labels - Only lower-case to avoid user confusion. - No dotted-decimal IPv4-like strings - - - The BucketName to validate if V2 addressing should be used - True if the BucketName should use V2 bucket addressing, false otherwise - - S3 v2 Bucket restrictions - - - - Determines whether an S3 bucket exists or not. - - The name of the bucket to check. - The Amazon S3 Client to use for S3 specific operations. - False is returned in case S3 responds with a NoSuchBucket error. - True is returned in case of success, AccessDenied error or PermanentRedirect error. - An exception is thrown in case of any other error. - This method calls GetACL for the bucket. - - - - Determines whether an S3 bucket exists or not. - This is done by: - 1. Creating a PreSigned Url for the bucket. To work with Signature V4 only regions, as - well as Signature V4-optional regions, we keep the expiry to within the maximum for V4 - (which is one week). - 2. Making a HEAD request to the Url - - The name of the bucket to check. - The Amazon S3 Client to use for S3 specific operations. - - - - - Class to manage and cache the correct region for buckets accessed without an explicit region. - - - Class to manage and cache the correct region for buckets accessed without an explicit region. - - - - - A cache of BucketName -> RegionEndpoint pairs. - The cache is used to make sure that bucket requests are signed for the correct region, - even when requesting them without an explicit region. - - - - - Detect a bucket region mismatch based on the x-amz-bucket-region header, and the status code provided. - - - - - - - - - Detects if the signature is malformed, and the requested bucket is in a Region - different from the Region of the request. - - - - the correct region if a mismatch was detected, null otherwise - - - - Detects if the signature is malformed, and the requested bucket is in a Region - different from the Region of the request. - - - - - the correct region if a mismatch was detected, null otherwise - - - - Use a HEAD bucket request to get the region for the given bucket. - - This method creates an AmazonS3Client from the credentials passed in. - It's critical that the AmazonS3Client is not used to make any requests that will - be routed through the pipeline. - - - - the value of the x-amz-bucket-region header from the response - - - - A helper class that represents a strongly typed S3 EventNotification item sent to SQS - - - - - Parse the JSON string into a S3EventNotification object. - - The function will try its best to parse input JSON string as best as it can. - It will not fail even if the JSON string contains unknown properties. - - For any parsing errors - - - - - Gets and sets the records for the S3 event notification - - - - - The class holds the user identity properties. - - - - - Gets and sets the PrincipalId property. - - - - - This class contains the identity information for an S3 bucket. - - - - - Gets and sets the name of the bucket. - - - - - Gets and sets the bucket owner id. - - - - - Gets and sets the S3 bucket arn. - - - - - This class contains the information for an object in S3. - - - - - Gets and sets the key for the object stored in S3. - - - - - Gets and sets the size of the object in S3. - - - - - Gets and sets the etag of the object. This can be used to determine if the object has changed. - - - - - Gets and sets the version id of the object in S3. - - - - - Gets and sets the sequencer a string representation of a hexadecimal value used to determine event sequence, only used with PUTs and DELETEs. - - - - - Gets and sets the meta information describing S3. - - - - - Gets and sets the ConfigurationId. This ID can be found in the bucket notification configuration. - - - - - Gets and sets the Bucket property. - - - - - Gets and sets the Object property. - - - - - Gets and sets the S3SchemaVersion property. - - - - - The class holds the request parameters - - - - - Gets and sets the SourceIPAddress. This is the ip address where the request came from. - - - - - This class holds the response elements. - - - - - Gets and sets the XAmzId2 Property. This is the Amazon S3 host that processed the request. - - - - - Gets and sets the XAmzRequestId. This is the Amazon S3 generated request ID. - - - - - The class holds the glacier event data elements. - - - - - Gets and sets the RestoreEventData property. - - - - - The class holds the restore event data elements. - - - - - Gets and sets the LifecycleRestorationExpiryTime the time when the object restoration will be expired. - - - - - Gets and sets the LifecycleRestoreStorageClass the source storage class for restore. - - - - - The class holds the event notification. - - - - - Gets and sets the AwsRegion property. - - - - - Gets and sets the EventName property. This identities what type of event occurred. - For example for an object just put in S3 this will be set to EventType.ObjectCreatedPut. - - - - - Gets and sets the EventSource property. - - - - - Gets and sets the EventType property. The time when S3 finished processing the request. - - - - - Gets and sets the EventVersion property. - - - - - Gets and sets the RequestParameters property. - - - - - Gets and sets the ResponseElements property. - - - - - Gets and sets the S3 property. - - - - - Gets and sets the UserIdentity property. - - - - - Get and sets the GlacierEventData property. - - - - - Interface for accessing S3 - - - - - - - Create a signed URL allowing access to a resource that would - usually require authentication. - - - - When using query string authentication you create a query, - specify an expiration time for the query, sign it with your - signature, place the data in an HTTP request, and distribute - the request to a user or embed the request in a web page. - - - A PreSigned URL can be generated for GET, PUT, DELETE and HEAD - operations on your bucketName, keys, and versions. - - - The GetPreSignedUrlRequest that defines the - parameters of the operation. - A string that is the signed http request. - - - - - - This operation aborts a multipart upload. After a multipart upload is aborted, no - additional parts can be uploaded using that upload ID. The storage consumed by any - previously uploaded parts will be freed. However, if any part uploads are currently - in progress, those part uploads might or might not succeed. As a result, it might - be necessary to abort a given multipart upload multiple times in order to completely - free all storage consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts operation and ensure that the parts - list is empty. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - The bucket name to which the upload was taking place. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object for which the multipart upload was initiated. - Upload ID that identifies the multipart upload. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AbortMultipartUpload service method, as returned by S3. - REST API Reference for AbortMultipartUpload Operation - - - - This operation aborts a multipart upload. After a multipart upload is aborted, no - additional parts can be uploaded using that upload ID. The storage consumed by any - previously uploaded parts will be freed. However, if any part uploads are currently - in progress, those part uploads might or might not succeed. As a result, it might - be necessary to abort a given multipart upload multiple times in order to completely - free all storage consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts operation and ensure that the parts - list is empty. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - Container for the necessary parameters to execute the AbortMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AbortMultipartUpload service method, as returned by S3. - REST API Reference for AbortMultipartUpload Operation - - - - Completes a multipart upload by assembling previously uploaded parts. - - - - You first initiate the multipart upload and then upload all parts using the UploadPart - operation. After successfully uploading all relevant parts of an upload, you call - this operation to complete the upload. Upon receiving this request, Amazon S3 concatenates - all the parts in ascending order by part number to create a new object. In the Complete - Multipart Upload request, you must provide the parts list. You must ensure that the - parts list is complete. This operation concatenates the parts that you provide in - the list. For each part in the list, you must provide the part number and the ETag - value, returned after that part was uploaded. - - - - Processing of a Complete Multipart Upload request could take several minutes to complete. - After Amazon S3 begins processing the request, it sends an HTTP response header that - specifies a 200 OK response. While processing is in progress, Amazon S3 periodically - sends white space characters to keep the connection from timing out. Because a request - could fail after the initial 200 OK response has been sent, it is important that you - check the response body to determine whether the request succeeded. - - - - Note that if CompleteMultipartUpload fails, applications should be prepared - to retry the failed requests. For more information, see Amazon - S3 Error Best Practices. - - - - For more information about multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - GetBucketLifecycle has the following special errors: - -
  • - - Error code: EntityTooSmall - -
    • - - Description: Your proposed upload is smaller than the minimum allowed object size. - Each part must be at least 5 MB in size, except the last part. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPart - -
    • - - Description: One or more of the specified parts could not be found. The part might - not have been uploaded, or the specified entity tag might not have matched the part's - entity tag. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPartOrder - -
    • - - Description: The list of parts was not in ascending order. The parts list must be - specified in order by part number. - -
    • - - 400 Bad Request - -
  • - - Error code: NoSuchUpload - -
    • - - Description: The specified multipart upload does not exist. The upload ID might be - invalid, or the multipart upload might have been aborted or completed. - -
    • - - 404 Not Found - -
- - The following operations are related to CompleteMultipartUpload: - - - - Container for the necessary parameters to execute the CompleteMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CompleteMultipartUpload service method, as returned by S3. - REST API Reference for CompleteMultipartUpload Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 Developer Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Encryption - - - - The source object that you are copying can be encrypted or unencrypted. The source - object can be encrypted with server-side encryption using AWS managed encryption keys - (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side - encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers - and decrypts the data when you access it. - - - - You can optionally use the appropriate encryption-related headers to request server-side - encryption for the target object. You have the option to provide your own encryption - key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that - was used to encrypt the source object. You can even request encryption if the source - object was not encrypted. For more information about server-side encryption, see Using - Server-Side Encryption. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject operation to change the storage class of an - object that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 Service Developer Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 Developer Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Encryption - - - - The source object that you are copying can be encrypted or unencrypted. The source - object can be encrypted with server-side encryption using AWS managed encryption keys - (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side - encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers - and decrypts the data when you access it. - - - - You can optionally use the appropriate encryption-related headers to request server-side - encryption for the target object. You have the option to provide your own encryption - key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that - was used to encrypt the source object. You can even request encryption if the source - object was not encrypted. For more information about server-side encryption, see Using - Server-Side Encryption. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject operation to change the storage class of an - object that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 Service Developer Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - to copy an object greater than 5 GB, you must use the multipart upload Upload Part - - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - The copy request charge is based on the storage class and Region that you specify - for the destination object. For pricing information, see Amazon - S3 pricing. - - - - Amazon S3 transfer acceleration does not support cross-Region copies. If you request - a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information, see Transfer - Acceleration. - - - - Metadata - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - To specify whether you want the object metadata copied from the source object or replaced - with metadata provided in the request, you can optionally add the x-amz-metadata-directive - header. When you grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. For - more information, see Specifying - Conditions in a Policy in the Amazon S3 Developer Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3. - - - - x-amz-copy-source-if Headers - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - following request parameters: - -
  • - - x-amz-copy-source-if-match - -
  • - - x-amz-copy-source-if-none-match - -
  • - - x-amz-copy-source-if-unmodified-since - -
  • - - x-amz-copy-source-if-modified-since - -
- - If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
  • - - x-amz-copy-source-if-match condition evaluates to true - -
  • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
- - If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request and evaluate as follows, Amazon S3 returns the - 412 Precondition Failed response code: - -
  • - - x-amz-copy-source-if-none-match condition evaluates to false - -
  • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - Encryption - - - - The source object that you are copying can be encrypted or unencrypted. The source - object can be encrypted with server-side encryption using AWS managed encryption keys - (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side - encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers - and decrypts the data when you access it. - - - - You can optionally use the appropriate encryption-related headers to request server-side - encryption for the target object. You have the option to provide your own encryption - key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that - was used to encrypt the source object. You can even request encryption if the source - object was not encrypted. For more information about server-side encryption, see Using - Server-Side Encryption. - - - - Access Control List (ACL)-Specific Request Headers - - - - When copying an object, you can optionally use headers to grant ACL-based permissions. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the ACL on the object. - For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API. - - - - Storage Class Options - - - - You can use the CopyObject operation to change the storage class of an - object that is already stored in Amazon S3 using the StorageClass parameter. - For more information, see Storage - Classes in the Amazon S3 Service Developer Guide. - - - - Versioning - - - - By default, x-amz-copy-source identifies the current version of an object - to copy. If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted. To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - - - - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - Container for the necessary parameters to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - REST API Reference for CopyObject Operation - - - - - - - - - Deletes an analytics configuration for the bucket (specified by the analytics configuration - ID). - - - - To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to DeleteBucketAnalyticsConfiguration: - -
  • - - - -
  • - - - -
  • - - - -
- - Container for the necessary parameters to execute the DeleteBucketAnalyticsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketAnalyticsConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketAnalyticsConfiguration Operation - - - - - Deletes an inventory configuration (identified by the inventory ID) from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - Operations related to DeleteBucketInventoryConfiguration include: - - - - Container for the necessary parameters to execute the DeleteBucketInventoryConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketInventoryConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketInventoryConfiguration Operation - - - - Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified - by the metrics configuration ID) from the bucket. Note that this doesn't include the - daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for DeleteBucketMetricsConfiguration Operation - - - - This implementation of the DELETE operation uses the policy subresource to delete - the policy of a specified bucket. If you are using an identity other than the root - user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - The bucket name. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketPolicy service method, as returned by S3. - REST API Reference for DeleteBucketPolicy Operation - - - - This implementation of the DELETE operation uses the policy subresource to delete - the policy of a specified bucket. If you are using an identity other than the root - user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - Container for the necessary parameters to execute the DeleteBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketPolicy service method, as returned by S3. - REST API Reference for DeleteBucketPolicy Operation - - - - Deletes the replication configuration from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutReplicationConfiguration - action. The bucket owner has these permissions by default and can grant it to others. - For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - It can take a while for the deletion of a replication configuration to fully propagate. - - - - For information about replication configuration, see Replication - in the Amazon S3 Developer Guide. - - - - The following operations are related to DeleteBucketReplication: - - - - Container for the necessary parameters to execute the DeleteBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketReplication service method, as returned by S3. - REST API Reference for DeleteBucketReplication Operation - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - The bucket that has the tag set to be removed. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketTagging service method, as returned by S3. - REST API Reference for DeleteBucketTagging Operation - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - Container for the necessary parameters to execute the DeleteBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketTagging service method, as returned by S3. - REST API Reference for DeleteBucketTagging Operation - - - - This operation removes the website configuration for a bucket. Amazon S3 returns a - 200 OK response upon successfully deleting a website configuration on - the specified bucket. You will get a 200 OK response if the website configuration - you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE operation requires the S3:DeleteBucketWebsite permission. - By default, only the bucket owner can delete the website configuration attached to - a bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which you want to remove the website configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketWebsite service method, as returned by S3. - REST API Reference for DeleteBucketWebsite Operation - - - - This operation removes the website configuration for a bucket. Amazon S3 returns a - 200 OK response upon successfully deleting a website configuration on - the specified bucket. You will get a 200 OK response if the website configuration - you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE operation requires the S3:DeleteBucketWebsite permission. - By default, only the bucket owner can delete the website configuration attached to - a bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the DeleteBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketWebsite service method, as returned by S3. - REST API Reference for DeleteBucketWebsite Operation - - - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - The bucket name of the lifecycle to delete. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - REST API Reference for DeleteLifecycleConfiguration Operation - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - Container for the necessary parameters to execute the DeleteLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - REST API Reference for DeleteLifecycleConfiguration Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key name of the object to delete. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key name of the object to delete. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - Container for the necessary parameters to execute the DeleteObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - REST API Reference for DeleteObject Operation - - - - This operation enables you to delete multiple objects from a bucket using a single - HTTP request. If you know the object keys that you want to delete, then this operation - provides a suitable alternative to sending individual delete requests, reducing per-request - overhead. - - - - The request contains a list of up to 1000 keys that you want to delete. In the XML, - you provide the object key names, and optionally, version IDs if you want to delete - a specific version of the object from a versioning-enabled bucket. For each key, Amazon - S3 performs a delete operation and returns the result of that delete, success, or - failure, in the response. Note that if the object specified in the request is not - found, Amazon S3 returns the result as deleted. - - - - The operation supports two modes for the response: verbose and quiet. By default, - the operation uses verbose mode in which the response includes the result of deletion - of each key in your request. In quiet mode the response includes only keys where the - delete operation encountered an error. For a successful deletion, the operation does - not return any information about the delete in the response body. - - - - When performing this operation on an MFA Delete enabled bucket, that attempts to delete - any versioned objects, you must include an MFA token. If you do not provide one, the - entire request will fail, even if there are non-versioned objects you are trying to - delete. If you provide an invalid token, whether there are versioned keys in the request - or not, the entire Multi-Object Delete request will fail. For information about MFA - Delete, see - MFA Delete. - - - - Finally, the Content-MD5 header is required for all Multi-Object Delete requests. - Amazon S3 uses the header value to ensure that your request body has not been altered - in transit. - - - - The following operations are related to DeleteObjects: - - - - Container for the necessary parameters to execute the DeleteObjects service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObjects service method, as returned by S3. - REST API Reference for DeleteObjects Operation - - - - Removes the entire tag set from the specified object. For more information about managing - object tags, see - Object Tagging. - - - - To use this operation, you must have permission to perform the s3:DeleteObjectTagging - action. - - - - To delete tags of a specific object version, add the versionId query - parameter in the request. You will need permission for the s3:DeleteObjectVersionTagging - action. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteObjectTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObjectTagging service method, as returned by S3. - REST API Reference for DeleteObjectTagging Operation - - - - Removes the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:PutBucketPublicAccessBlock - permission. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to DeletePublicAccessBlock: - - - - Container for the necessary parameters to execute the DeletePublicAccessBlock service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeletePublicAccessBlock service method, as returned by S3. - REST API Reference for DeletePublicAccessBlock Operation - - - - - - - - - Returns the default encryption configuration for an Amazon S3 bucket. For information - about the Amazon S3 default encryption feature, see Amazon - S3 Default Bucket Encryption. - - - - To use this operation, you must have permission to perform the s3:GetEncryptionConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to GetBucketEncryption: - - - - Container for the necessary parameters to execute the GetBucketEncryption service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketEncryption service method, as returned by S3. - REST API Reference for GetBucketEncryption Operation - - - - Returns an inventory configuration (identified by the inventory configuration ID) - from the bucket. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - The following operations are related to GetBucketInventoryConfiguration: - - - - Container for the necessary parameters to execute the GetBucketInventoryConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketInventoryConfiguration service method, as returned by S3. - REST API Reference for GetBucketInventoryConfiguration Operation - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - The name of the bucket for which to get the location. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLocation service method, as returned by S3. - REST API Reference for GetBucketLocation Operation - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - Container for the necessary parameters to execute the GetBucketLocation service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLocation service method, as returned by S3. - REST API Reference for GetBucketLocation Operation - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - The bucket name for which to get the logging information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLogging service method, as returned by S3. - REST API Reference for GetBucketLogging Operation - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - Container for the necessary parameters to execute the GetBucketLogging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLogging service method, as returned by S3. - REST API Reference for GetBucketLogging Operation - - - - Gets a metrics configuration (specified by the metrics configuration ID) from the - bucket. Note that this doesn't include the daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to GetBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the GetBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for GetBucketMetricsConfiguration Operation - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following operation is related to GetBucketNotification: - - - - Name of the bucket for which to get the notification configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketNotification service method, as returned by S3. - REST API Reference for GetBucketNotification Operation - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following operation is related to GetBucketNotification: - - - - Container for the necessary parameters to execute the GetBucketNotification service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketNotification service method, as returned by S3. - REST API Reference for GetBucketNotification Operation - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operation is related to GetBucketPolicy: - - - - The bucket name for which to get the bucket policy. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicy service method, as returned by S3. - REST API Reference for GetBucketPolicy Operation - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operation is related to GetBucketPolicy: - - - - Container for the necessary parameters to execute the GetBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicy service method, as returned by S3. - REST API Reference for GetBucketPolicy Operation - - - - Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket - is public. In order to use this operation, you must have the s3:GetBucketPolicyStatus - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - For more information about when Amazon S3 considers a bucket public, see The - Meaning of "Public". - - - - The following operations are related to GetBucketPolicyStatus: - - - - Container for the necessary parameters to execute the GetBucketPolicyStatus service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicyStatus service method, as returned by S3. - REST API Reference for GetBucketPolicyStatus Operation - - - - Retrieves the replication configuration for the given Amazon S3 bucket. - - Container for the necessary parameters to execute the GetBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketReplication service method, as returned by S3. - REST API Reference for GetBucketReplication Operation - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - The name of the bucket for which to get the payment request configuration - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketRequestPayment service method, as returned by S3. - REST API Reference for GetBucketRequestPayment Operation - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - Container for the necessary parameters to execute the GetBucketRequestPayment service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketRequestPayment service method, as returned by S3. - REST API Reference for GetBucketRequestPayment Operation - - - - Returns the tag set associated with the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - GetBucketTagging has the following special error: - -
  • - - Error code: NoSuchTagSetError - -
    • - - Description: There is no tag set associated with the bucket. - -
- - The following operations are related to GetBucketTagging: - - - - Container for the necessary parameters to execute the GetBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketTagging service method, as returned by S3. - REST API Reference for GetBucketTagging Operation - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - The name of the bucket for which to get the versioning information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketVersioning service method, as returned by S3. - REST API Reference for GetBucketVersioning Operation - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - Container for the necessary parameters to execute the GetBucketVersioning service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketVersioning service method, as returned by S3. - REST API Reference for GetBucketVersioning Operation - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET operation requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which to get the website configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketWebsite service method, as returned by S3. - REST API Reference for GetBucketWebsite Operation - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET operation requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the GetBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketWebsite service method, as returned by S3. - REST API Reference for GetBucketWebsite Operation - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - The bucket name for which to get the cors configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetCORSConfiguration service method, as returned by S3. - REST API Reference for GetCORSConfiguration Operation - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - Container for the necessary parameters to execute the GetCORSConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetCORSConfiguration service method, as returned by S3. - REST API Reference for GetCORSConfiguration Operation - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are still using previous version of the lifecycle configuration, it works. - For the earlier API description, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to GetBucketLifecycleConfiguration: - - - - The name of the bucket for which to get the lifecycle information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetLifecycleConfiguration service method, as returned by S3. - REST API Reference for GetLifecycleConfiguration Operation - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are still using previous version of the lifecycle configuration, it works. - For the earlier API description, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to GetBucketLifecycleConfiguration: - - - - Container for the necessary parameters to execute the GetLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetLifecycleConfiguration service method, as returned by S3. - REST API Reference for GetLifecycleConfiguration Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object to get. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object to get. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - Container for the necessary parameters to execute the GetObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - REST API Reference for GetObject Operation - - - - Gets an object's current Legal Hold status. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLegalHold service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectLegalHold service method, as returned by S3. - REST API Reference for GetObjectLegalHold Operation - - - - Gets the Object Lock configuration for a bucket. The rule specified in the Object - Lock configuration will be applied by default to every new object placed in the specified - bucket. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLockConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectLockConfiguration service method, as returned by S3. - REST API Reference for GetObjectLockConfiguration Operation - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - The name of the bucket containing the object. - The object key. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - The name of the bucket containing the object. - The object key. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - Container for the necessary parameters to execute the GetObjectMetadata service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - REST API Reference for GetObjectMetadata Operation - - - - Retrieves an object's retention settings. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectRetention service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectRetention service method, as returned by S3. - REST API Reference for GetObjectRetention Operation - - - - Returns the tag-set of an object. You send the GET request against the tagging subresource - associated with the object. - - - - To use this operation, you must have permission to perform the s3:GetObjectTagging - action. By default, the GET operation returns information about current version of - an object. For a versioned bucket, you can have multiple versions of an object in - your bucket. To retrieve tags of any other version, use the versionId query parameter. - You also need permission for the s3:GetObjectVersionTagging action. - - - - By default, the bucket owner has this permission and can grant this permission to - others. - - - - For information about the Amazon S3 object tagging feature, see Object - Tagging. - - - - The following operation is related to GetObjectTagging: - - - - Container for the necessary parameters to execute the GetObjectTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTagging service method, as returned by S3. - REST API Reference for GetObjectTagging Operation - - - - Return torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Amazon - S3 Torrent. - - - - You can get torrent only for objects that are less than 5 GB in size and that are - not encrypted using server-side encryption with customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - The following operation is related to GetObjectTorrent: - - - - The name of the bucket containing the object for which to get the torrent files. - The object key for which to get the information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTorrent service method, as returned by S3. - REST API Reference for GetObjectTorrent Operation - - - - Return torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Amazon - S3 Torrent. - - - - You can get torrent only for objects that are less than 5 GB in size and that are - not encrypted using server-side encryption with customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - The following operation is related to GetObjectTorrent: - - - - Container for the necessary parameters to execute the GetObjectTorrent service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTorrent service method, as returned by S3. - REST API Reference for GetObjectTorrent Operation - - - - Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:GetBucketPublicAccessBlock - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket - or an object, it checks the PublicAccessBlock configuration for both - the bucket (or the bucket that contains the object) and the bucket owner's account. - If the PublicAccessBlock settings are different between the bucket and - the account, Amazon S3 uses the most restrictive combination of the bucket-level and - account-level settings. - - - - For more information about when Amazon S3 considers a bucket or an object public, - see The - Meaning of "Public". - - - - The following operations are related to GetPublicAccessBlock: - - - - Container for the necessary parameters to execute the GetPublicAccessBlock service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetPublicAccessBlock service method, as returned by S3. - REST API Reference for GetPublicAccessBlock Operation - - - - This operation initiates a multipart upload and returns an upload ID. This upload - ID is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort operation - and Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload API and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart) and UploadPartCopy) requests must match the headers you - used in the request to initiate the upload by using CreateMultipartUpload. - - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, - kms:GenerateDataKey*, and kms:DescribeKey actions on the - key. These permissions are required because Amazon S3 must decrypt and read data from - the encrypted file parts before it completes the multipart upload. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - The following operations are related to CreateMultipartUpload: - - - - The name of the bucket to which to initiate the upload - Object key for which the multipart upload is to be initiated. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the InitiateMultipartUpload service method, as returned by S3. - REST API Reference for InitiateMultipartUpload Operation - - - - This operation initiates a multipart upload and returns an upload ID. This upload - ID is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort operation - and Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload API and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart) and UploadPartCopy) requests must match the headers you - used in the request to initiate the upload by using CreateMultipartUpload. - - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, - kms:GenerateDataKey*, and kms:DescribeKey actions on the - key. These permissions are required because Amazon S3 must decrypt and read data from - the encrypted file parts before it completes the multipart upload. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - The following operations are related to CreateMultipartUpload: - - - - Container for the necessary parameters to execute the InitiateMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the InitiateMultipartUpload service method, as returned by S3. - REST API Reference for InitiateMultipartUpload Operation - - - - Lists the analytics configurations for the bucket. You can have up to 1,000 analytics - configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. You should always check the IsTruncated element in the response. - If there are no more configurations to list, IsTruncated is set to false. - If there are more configurations to list, IsTruncated is set to true, - and there will be a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to ListBucketAnalyticsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketAnalyticsConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketAnalyticsConfigurations service method, as returned by S3. - REST API Reference for ListBucketAnalyticsConfigurations Operation - - - - Returns a list of inventory configurations for the bucket. You can have up to 1,000 - analytics configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory - - - - The following operations are related to ListBucketInventoryConfigurations: - - - - Container for the necessary parameters to execute the ListBucketInventoryConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketInventoryConfigurations service method, as returned by S3. - REST API Reference for ListBucketInventoryConfigurations Operation - - - - Lists the metrics configurations for the bucket. The metrics configurations are only - for the request metrics of the bucket and do not provide information on daily storage - metrics. You can have up to 1,000 configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For more information about metrics configurations and CloudWatch request metrics, - see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to ListBucketMetricsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketMetricsConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketMetricsConfigurations service method, as returned by S3. - REST API Reference for ListBucketMetricsConfigurations Operation - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBuckets service method, as returned by S3. - REST API Reference for ListBuckets Operation - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - Container for the necessary parameters to execute the ListBuckets service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBuckets service method, as returned by S3. - REST API Reference for ListBuckets Operation - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Container for the necessary parameters to execute the ListMultipartUploads service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - REST API Reference for ListMultipartUploads Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. - Limits the response to keys that begin with the specified prefix. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - Container for the necessary parameters to execute the ListObjects service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - REST API Reference for ListObjects Operation - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Make sure to design - your application to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - To use this operation in an AWS Identity and Access Management (IAM) policy, you must - have permissions to perform the s3:ListBucket action. The bucket owner - has this permission by default and can grant this permission to others. For more information - about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - This section describes the latest revision of the API. We recommend that you use this - revised API for application development. For backward compatibility, Amazon S3 continues - to support the prior version of this API, ListObjects. - - - - To get a list of your buckets, see ListBuckets. - - - - The following operations are related to ListObjectsV2: - - - - Container for the necessary parameters to execute the ListObjectsV2 service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjectsV2 service method, as returned by S3. - REST API Reference for ListObjectsV2 Operation - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). This request returns a maximum of 1,000 - uploaded parts. The default number of parts returned is 1,000 parts. You can restrict - the number of parts returned by specifying the max-parts request parameter. - If your multipart upload consists of more than 1,000 parts, the response returns an - IsTruncated field with the value of true, and a NextPartNumberMarker - element. In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListParts: - - - - Name of the bucket to which the parts are being uploaded. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Object key for which the multipart upload was initiated. - Upload ID identifying the multipart upload whose parts are being listed. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListParts service method, as returned by S3. - REST API Reference for ListParts Operation - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). This request returns a maximum of 1,000 - uploaded parts. The default number of parts returned is 1,000 parts. You can restrict - the number of parts returned by specifying the max-parts request parameter. - If your multipart upload consists of more than 1,000 parts, the response returns an - IsTruncated field with the value of true, and a NextPartNumberMarker - element. In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListParts: - - - - Container for the necessary parameters to execute the ListParts service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListParts service method, as returned by S3. - REST API Reference for ListParts Operation - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - Container for the necessary parameters to execute the ListVersions service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - REST API Reference for ListVersions Operation - - - - - Creates a new bucket. To create a bucket, you must register with Amazon S3 and have - a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed - to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information on bucket naming restrictions, - see Working - with Amazon S3 Buckets. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) - Region. For more information, see How - to Select a Region for Your Buckets. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - Hosting of Buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - The name of the bucket to create. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucket service method, as returned by S3. - REST API Reference for PutBucket Operation - - - - Creates a new bucket. To create a bucket, you must register with Amazon S3 and have - a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed - to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information on bucket naming restrictions, - see Working - with Amazon S3 Buckets. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) - Region. For more information, see How - to Select a Region for Your Buckets. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - Hosting of Buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - - - - Using email addresses to specify a grantee is only supported in the following AWS - Regions: - -
      • - - US East (N. Virginia) - -
      • - - US West (N. California) - -
      • - - US West (Oregon) - -
      • - - Asia Pacific (Singapore) - -
      • - - Asia Pacific (Sydney) - -
      • - - Asia Pacific (Tokyo) - -
      • - - Europe (Ireland) - -
      • - - South America (São Paulo) - -
      - - For a list of all the Amazon S3 supported Regions and endpoints, see Regions - and Endpoints in the AWS General Reference. - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by account IDs permissions to read object data and its metadata: - - - - x-amz-grant-read: id="11112222333", id="444455556666" - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - Container for the necessary parameters to execute the PutBucket service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucket service method, as returned by S3. - REST API Reference for PutBucket Operation - - - - Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration - is a bucket-level feature that enables you to perform faster data transfers to Amazon - S3. - - - - To use this operation, you must have permission to perform the s3:PutAccelerateConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The Transfer Acceleration state of a bucket can be set to one of the following two - values: - -
  • - - Enabled – Enables accelerated data transfers to the bucket. - -
  • - - Suspended – Disables accelerated data transfers to the bucket. - -
- - The GetBucketAccelerateConfiguration operation returns the transfer acceleration - state of a bucket. - - - - After setting the Transfer Acceleration state of a bucket to Enabled, it might take - up to thirty minutes before the data transfer rates to the bucket increase. - - - - The name of the bucket used for Transfer Acceleration must be DNS-compliant and must - not contain periods ("."). - - - - For more information about transfer acceleration, see Transfer - Acceleration. - - - - The following operations are related to PutBucketAccelerateConfiguration: - - - - Container for the necessary parameters to execute the PutBucketAccelerateConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketAccelerateConfiguration service method, as returned by S3. - REST API Reference for PutBucketAccelerateConfiguration Operation - - - - - - - Set the logging parameters for a bucket and to specify permissions for who can view - and modify the logging parameters. All logs are saved to buckets in the same AWS Region - as the source bucket. To set the logging status of a bucket, you must be the bucket - owner. - - - - The bucket owner is automatically granted FULL_CONTROL to all logs. You use the Grantee - request element to grant access to other people. The Permissions request - element specifies the kind of access the grantee has to the logs. - - - - Grantee Values - - - - You can specify the person (grantee) to whom you're assigning access rights (using - request elements) in the following ways: - -
  • - - By the person's ID: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> - </Grantee> - - - - DisplayName is optional and ignored in the request. - -
  • - - By Email address: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee> - - - - - The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl - request, appears as the CanonicalUser. - -
  • - - By URI: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee> - - -
- - To enable logging, you use LoggingEnabled and its children request elements. To disable - logging, you use an empty BucketLoggingStatus request element: - - - - <BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01" /> - - - - - For more information about server access logging, see Server - Access Logging. - - - - For more information about creating a bucket, see CreateBucket. For more information - about returning the logging status of a bucket, see GetBucketLogging. - - - - The following operations are related to PutBucketLogging: - - - - Container for the necessary parameters to execute the PutBucketLogging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketLogging service method, as returned by S3. - REST API Reference for PutBucketLogging Operation - - - - Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. - You can have up to 1,000 metrics configurations per bucket. If you're updating an - existing metrics configuration, note that this is a full replacement of the existing - metrics configuration. If you don't include the elements you want to keep, they are - erased. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to PutBucketMetricsConfiguration: - - - - GetBucketLifecycle has the following special error: - -
  • - - Error code: TooManyConfigurations - -
    • - - Description: You are attempting to create a new configuration but have already reached - the 1,000-configuration limit. - -
    • - - HTTP Status Code: HTTP 400 Bad Request - -
- - Container for the necessary parameters to execute the PutBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketMetricsConfiguration service method, as returned by S3. - REST API Reference for PutBucketMetricsConfiguration Operation - - - - Enables notifications of specified events for a bucket. For more information about - event notifications, see Configuring - Event Notifications. - - - - Using this API, you can replace an existing notification configuration. The configuration - is an XML file that defines the event types that you want Amazon S3 to publish and - the destination where you want Amazon S3 to publish an event notification when it - detects an event of the specified type. - - - - By default, your bucket has no event notifications configured. That is, the notification - configuration will be an empty NotificationConfiguration. - - - - <NotificationConfiguration> - - - - </NotificationConfiguration> - - - - This operation replaces the existing notification configuration with the configuration - you include in the request body. - - - - After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification - Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, - and that the bucket owner has permission to publish to it by sending a test notification. - In the case of AWS Lambda destinations, Amazon S3 verifies that the Lambda function - permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. - For more information, see Configuring - Notifications for Amazon S3 Events. - - - - You can disable notifications by adding the empty NotificationConfiguration element. - - - - By default, only the bucket owner can configure notifications on a bucket. However, - bucket owners can use a bucket policy to grant permission to other users to set this - configuration with s3:PutBucketNotification permission. - - - - The PUT notification is an atomic operation. For example, suppose your notification - configuration includes SNS topic, SQS queue, and Lambda function configurations. When - you send a PUT request with this configuration, Amazon S3 sends test messages to your - SNS topic. If the message fails, the entire PUT operation will fail, and Amazon S3 - will not add the configuration to your bucket. - - - - Responses - - - - If the configuration in the request body includes only one TopicConfiguration - specifying only the s3:ReducedRedundancyLostObject event type, the response - will also include the x-amz-sns-test-message-id header containing the - message ID of the test notification sent to the topic. - - - - The following operation is related to PutBucketNotificationConfiguration: - - - - Container for the necessary parameters to execute the PutBucketNotification service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketNotification service method, as returned by S3. - REST API Reference for PutBucketNotification Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - The MD5 hash of the request body. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - Container for the necessary parameters to execute the PutBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - REST API Reference for PutBucketPolicy Operation - - - - Creates a replication configuration or replaces an existing one. For more information, - see Replication - in the Amazon S3 Developer Guide. - - - - To perform this operation, the user or role performing the operation must have the - iam:PassRole - permission. - - - - Specify the replication configuration in the request body. In the replication configuration, - you provide the name of the destination bucket where you want Amazon S3 to replicate - objects, the IAM role that Amazon S3 can assume to replicate objects on your behalf, - and other relevant information. - - - - A replication configuration must include at least one rule, and can contain a maximum - of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects - in the source bucket. To choose additional subsets of objects to replicate, add a - rule for each subset. All rules must specify the same destination bucket. - - - - To specify a subset of the objects in the source bucket to apply a replication rule - to, add the Filter element as a child of the Rule element. You can filter objects - based on an object key prefix, one or more object tags, or both. When you add the - Filter element in the configuration, you must also add the following elements: DeleteMarkerReplication, - Status, and Priority. - - - - For information about enabling versioning on a bucket, see Using - Versioning. - - - - By default, a resource owner, in this case the AWS account that created the bucket, - can perform this operation. The resource owner can also grant others permissions to - perform the operation. For more information about permissions, see Specifying - Permissions in a Policy and Managing - Access Permissions to Your Amazon S3 Resources. - - - - Handling Replication of Encrypted Objects - - - - By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side - encryption with CMKs stored in AWS KMS. To replicate AWS KMS-encrypted objects, add - the following: SourceSelectionCriteria, SseKmsEncryptedObjects, - Status, EncryptionConfiguration, and ReplicaKmsKeyID. - For information about replication configuration, see Replicating - Objects Created with SSE Using CMKs stored in AWS KMS. - - - - For information on PutBucketReplication errors, see ReplicationErrorCodeList - - - - - The following operations are related to PutBucketReplication: - - - - Container for the necessary parameters to execute the PutBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketReplication service method, as returned by S3. - REST API Reference for PutBucketReplication Operation - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - The bucket name. - Container for Payer. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketRequestPayment service method, as returned by S3. - REST API Reference for PutBucketRequestPayment Operation - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - Container for the necessary parameters to execute the PutBucketRequestPayment service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketRequestPayment service method, as returned by S3. - REST API Reference for PutBucketRequestPayment Operation - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging. - - - - Within a bucket, if you add a tag that has the same key as an existing tag, the new - value overwrites the old value. For more information, see Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional operation is currently in progress against - this resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - The bucket name. - A property of PutBucketTaggingRequest used to execute the PutBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketTagging service method, as returned by S3. - REST API Reference for PutBucketTagging Operation - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging. - - - - Within a bucket, if you add a tag that has the same key as an existing tag, the new - value overwrites the old value. For more information, see Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional operation is currently in progress against - this resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - Container for the necessary parameters to execute the PutBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketTagging service method, as returned by S3. - REST API Reference for PutBucketTagging Operation - - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT operation requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - Amazon S3 has a limitation of 50 routing rules per website configuration. If you require - more than 50 routing rules, you can use object redirect. For more information, see - Configuring - an Object Redirect in the Amazon Simple Storage Service Developer Guide. - - - The bucket name. - Container for the request. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketWebsite service method, as returned by S3. - REST API Reference for PutBucketWebsite Operation - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT operation requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - Amazon S3 has a limitation of 50 routing rules per website configuration. If you require - more than 50 routing rules, you can use object redirect. For more information, see - Configuring - an Object Redirect in the Amazon Simple Storage Service Developer Guide. - - - Container for the necessary parameters to execute the PutBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketWebsite service method, as returned by S3. - REST API Reference for PutBucketWebsite Operation - - - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - The name of the bucket for which to set the configuration. - A property of PutLifecycleConfigurationRequest used to execute the PutLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutLifecycleConfiguration service method, as returned by S3. - REST API Reference for PutLifecycleConfiguration Operation - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - Container for the necessary parameters to execute the PutLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutLifecycleConfiguration service method, as returned by S3. - REST API Reference for PutLifecycleConfiguration Operation - - - - - - - - - - - - - - - - - The base class for requests that return Amazon S3 objects. - - - - - Gets or sets the name of the bucket. - - - The name of the bucket. - - - - - Gets whether or not the bucket name is set. - - - A value of true if the bucket name is set. - Returns false if otherwise. - - - - - Gets or sets the key under which the Amazon S3 object is stored. - - - The key under which the Amazon S3 object is stored. - - - - - Gets whether or not the key property is set. - - - A value of true if key property is set. - Returns false if otherwise. - - - - - Gets or sets the version ID of the Amazon S3 object. - - - The version ID of the Amazon S3 object. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or - ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Gets or sets the ModifiedSinceDate property. - - - The ModifiedSinceDate property. - - - - - Gets or sets the ModifiedSinceDate property. - - - The ModifiedSinceDate property. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or - UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Gets or sets the UnmodifiedSinceDate property. - - - The UnmodifiedSinceDate property. - - - - - Gets or sets the UnmodifiedSinceDate property. - - - The UnmodifiedSinceDate property. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to decrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - The base class TransferUtility request classes. - - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - - Gets the Amazon S3 client used for making calls into Amazon S3. - - - The Amazon S3 client used for making calls into Amazon S3. - - - - - Uploads the specified file. - The object key is derived from the file's name. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the specified file. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the contents of the specified stream. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The stream to read to obtain the content to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the stream to. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the file or stream specified by the request. - To track the progress of the upload, - add an event listener to the request's UploadProgressEvent. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - Contains all the parameters required to upload to Amazon S3. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Aborts the multipart uploads that were initiated before the specified date. - - - The name of the bucket containing multipart uploads. - - - The date before which the multipart uploads were initiated. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the content from Amazon S3 and writes it to the specified file. - If the key is not specified in the request parameter, - the file name will used as the key name. - - - Contains all the parameters required to download an Amazon S3 object. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Returns a stream from which the caller can read the content from the specified - Amazon S3 bucket and key. - The caller of this method is responsible for closing the stream. - - - The name of the bucket. - - - The object key. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Returns a stream to read the contents from Amazon S3 as - specified by the TransferUtilityOpenStreamRequest. - The caller of this method is responsible for closing the stream. - - - Contains all the parameters required for the OpenStream operation. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - - Constructs a new class. - - - The AWS Access Key ID. - - - The AWS Secret Access Key. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new class. - - - The AWS Access Key ID. - - - The AWS Secret Access Key. - - - The region to configure the transfer utility for. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new instance of the class. - - - The AWS Access Key ID. - - - The AWS Secret Access Key. - - - Specifies advanced settings. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new instance of the class. - - - The AWS Access Key ID. - - - The AWS Secret Access Key. - - - The region to configure the transfer utility for. - - - Specifies advanced settings. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new instance of the class. - - - The Amazon S3 client. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Initializes a new instance of the class. - - - The Amazon S3 client. - - - Specifies advanced configuration settings for . - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Gets the Amazon S3 client used for making calls into Amazon S3. - - - The Amazon S3 client used for making calls into Amazon S3. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Uploads the specified file. - The object key is derived from the file's name. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the specified file. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the contents of the specified stream. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The stream to read to obtain the content to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the stream to. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the file or stream specified by the request. - To track the progress of the upload, - add an event listener to the request's UploadProgressEvent. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - Contains all the parameters required to upload to Amazon S3. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Aborts the multipart uploads that were initiated before the specified date. - - - The name of the bucket containing multipart uploads. - - - The date before which the multipart uploads were initiated. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the content from Amazon S3 and writes it to the specified file. - If the key is not specified in the request parameter, - the file name will used as the key name. - - - Contains all the parameters required to download an Amazon S3 object. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Returns a stream from which the caller can read the content from the specified - Amazon S3 bucket and key. - The caller of this method is responsible for closing the stream. - - - The name of the bucket. - - - The object key. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Returns a stream to read the contents from Amazon S3 as - specified by the TransferUtilityOpenStreamRequest. - The caller of this method is responsible for closing the stream. - - - Contains all the parameters required for the OpenStream operation. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - - Provides configuration options for how processes requests. - - - The best configuration settings depend on network - configuration, latency and bandwidth. - The default configuration settings are suitable - for most applications, but this class enables developers to experiment with - different configurations and tune transfer manager performance. - - - - - - Default constructor. - - - - - Gets or sets the minimum part size for upload parts in bytes. The default is 16 MB. - Decreasing the minimum part size causes - multipart uploads to be split into a larger number - of smaller parts. Setting this value too low has a negative effect - on transfer speeds, causing extra latency and network - communication for each part. - - - - - This property determines how many active threads - or the number of concurrent asynchronous web requests - will be used to upload/download the file . - The default value is 10. - - - A value less than or equal to 0 will be silently ignored. - - - - - Gets or sets the number of executing threads. - This property determines how many active threads will be used to upload - the file. The default value is 10 threads. - - - A value less than or equal to 0 will be silently ignored. - - - - - Contains all the parameters - that can be set when making a this request with the - TransferUtility method. - - - - - Get or sets the file path location of where the - downloaded Amazon S3 object will be written to. - - - The file path location of where the downloaded Amazon S3 object will be written to. - - - - - Checks if FilePath property is set. - - True if FilePath property is set. - - - - The event for WriteObjectProgressEvent notifications. All - subscribers will be notified when a new progress - event is raised. - - The WriteObjectProgressEvent is fired as data - is downloaded from S3. The delegates attached to the event - will be passed information detailing how much data - has been downloaded as well as how much will be downloaded. - - - - Subscribe to this event if you want to receive - WriteObjectProgressEvent notifications. Here is how:
- 1. Define a method with a signature similar to this one: - - private void displayProgress(object sender, WriteObjectProgressArgs args) - { - Console.WriteLine(args); - } - - 2. Add this method to the WriteObjectProgressEvent delegate's invocation list - - TransferUtilityDownloadRequest request = new TransferUtilityDownloadRequest(); - request.WriteObjectProgressEvent += displayProgress; - - - - - - Causes the WriteObjectProgressEvent event to be fired. - - Progress data for the stream being written to file. - - - - Contains all the parameters - that can be set when making a this request with the - TransferUtility method. - - - - - Contains all the parameters - that can be set when making a this request with the - TransferUtility method. - - - - - Gets or sets the name of the bucket. - - - The name of the bucket. - - - - - Checks if BucketName property is set. - - true if BucketName property is set. - - - - Gets or sets the key under which the Amazon S3 object is to be stored. - - - The key under which the Amazon S3 object is to be stored. - - - - - Checks if Key property is set. - - true if Key property is set. - - - - Gets or sets the canned access control list (ACL) - for the uploaded object. - Please refer to - for - information on Amazon S3 canned ACLs. - - - The canned access control list (ACL) - for the uploaded object. - - - - - Checks if the CannedACL property is set. - - true if there is the CannedACL property is set. - - - - Removes the cannned access control list (ACL) - for the uploaded object. - - - - - Gets or sets the content type of the uploaded Amazon S3 object. - - - The content type of the uploaded Amazon S3 object. - - - - - Checks if ContentType property is set. - - true if ContentType property is set. - - - - Gets or sets the storage class for the uploaded Amazon S3 object. - Please refer to - for - information on S3 Storage Classes. - - - The storage class for the uploaded Amazon S3 object. - - - - - Gets and sets the ServerSideEncryptionMethod property. - Specifies the encryption used on the server to - store the content. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Input stream for the request; content for the request will be read from the stream. - - - - - - Gets or sets the file path - where the Amazon S3 object will be uploaded from. - - - For WinRT and Windows Phone this property must be in the form of "ms-appdata:///local/file.txt". - - - - The file path where the Amazon S3 object will be uploaded from. - - - - - Checks if FilePath property is set. - - true if FilePath property is set. - - - - Gets or sets the part size of the upload in bytes. - The uploaded file will be divided into - parts the size specified and - uploaded to Amazon S3 individually. - - - The part size of the upload. - - - - - Checks if PartSize property is set. - - true if PartSize property is set. - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - The tag-set for the object. - - - - - The event for UploadProgressEvent notifications. All - subscribers will be notified when a new progress - event is raised. - - The UploadProgressEvent is fired as data - is uploaded to S3. The delegates attached to the event - will be passed information detailing how much data - has been uploaded as well as how much will be uploaded. - - - - Subscribe to this event if you want to receive - UploadProgressEvent notifications. Here is how:
- 1. Define a method with a signature similar to this one: - - private void displayProgress(object sender, UploadProgressArgs args) - { - Console.WriteLine(args); - } - - 2. Add this method to the UploadProgressEvent delegate's invocation list - - TransferUtilityUploadRequest request = new TransferUtilityUploadRequest(); - request.UploadProgressEvent += displayProgress; - - - - - - Causes the UploadProgressEvent event to be fired. - - Progress data for the file being uploaded. - - - - Gets the length of the content by either checking the FileInfo.Length property or the Stream.Length property. - - The length of the content. - - - - Gets or sets whether or not the stream used with this request is - automatically closed when all of the content is read from the stream. - - - A value of true if the if the stream is - automatically closed when all of the content is read from the stream. - A value of false if otherwise. - - - - - If this value is set to true then the stream's position will be reset to the start before being read for upload. - Default: true. - - - - - Sets whether or not the stream used with this request is - automatically closed when all of the content is read from the stream - and returns this object instance, - enabling additional method calls to be chained together. - - - A value of true if the if the stream is - automatically closed when all of the content is read from the stream. - A value of false if otherwise. - - - This object instance, enabling additional method calls to be chained together. - - - - - Encapsulates the information needed to provide - transfer progress to subscribers of the Put Object - Event. - - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The how many bytes were transferred since last event. - The number of bytes transferred - The total number of bytes to be transferred - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The how many bytes were transferred since last event. - The number of bytes transferred - The total number of bytes to be transferred - The file being uploaded - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The how many bytes were transferred since last event. - The number of bytes transferred - The total number of bytes to be transferred - A compensation for any upstream aggregators if this event to correct theit totalTransferred count, - in case the underlying request is retried. - The file being uploaded - - - - Gets the FilePath. - - - - - Waits for all of the tasks to complete or till any task fails or is canceled. - - - - - Waits for all of the tasks to complete or till any task fails or is canceled. - - - - - Returns the amount of bytes remaining that need to be pulled down from S3. - - The fully qualified path of the file. - - - - - The command to manage an upload using the S3 multipart API. - - - - - Initializes a new instance of the class. - - The s3 client. - The config object that has the number of threads to use. - The file transporter request. - - - - This command is for doing regular PutObject requests. - - - - - Configuration for the S3 section of AWS configuration. - Changes to some settings may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws> - <s3 useSignatureVersion4="true" /> - </aws> - - - - - - Key for the S3UseSignatureVersion4Key property. - - - - - - Configures if the S3 client should use Signature Version 4 signing with requests. - By default, this setting is set to true which will use Signature Version 4 for all - requests except presigned URL requests when the region is set to us-east-1. When - UseSignatureVersion4 is explicitly set to true by directly setting this property or - directly setting this property through configuration, Signature Version 4 will be - used for all requests when able to do so. - When this setting is false, Signature Version 2 will be used. Note that when the - setting is false, Signature Version 4 may still be used by default in some cases - or with some regions. - - - - - Escape and unescape S3 metadata for S3 Put/Get object requests. - Escape only escapes non-ascii values in metadata - Any "%" values in metadata could interfere with this option. - Default value is false. - - - - - Was the value of the UseSignatureVersion4 property set explicitly? - This can be done via configuration or by directly setting the property. - - This is used to determine if the user set UseSignatureVersion4 to true, - or if it's true because the default was changed to true in the SDK. - - - - diff --git a/packages/AWSSDK.S3.3.3.111.14/lib/uap/AWSSDK.S3.dll b/packages/AWSSDK.S3.3.3.111.14/lib/uap/AWSSDK.S3.dll deleted file mode 100644 index 0610561..0000000 Binary files a/packages/AWSSDK.S3.3.3.111.14/lib/uap/AWSSDK.S3.dll and /dev/null differ diff --git a/packages/AWSSDK.S3.3.3.111.14/tools/install.ps1 b/packages/AWSSDK.S3.3.3.111.14/tools/install.ps1 deleted file mode 100644 index 8178834..0000000 --- a/packages/AWSSDK.S3.3.3.111.14/tools/install.ps1 +++ /dev/null @@ -1,49 +0,0 @@ -param($installPath, $toolsPath, $package, $project) - -$analyzersPaths = Join-Path (Join-Path (Split-Path -Path $toolsPath -Parent) "analyzers" ) * -Resolve - -foreach($analyzersPath in $analyzersPaths) -{ - # Install the language agnostic analyzers. - if (Test-Path $analyzersPath) - { - foreach ($analyzerFilePath in Get-ChildItem $analyzersPath -Filter *.dll) - { - if($project.Object.AnalyzerReferences) - { - $project.Object.AnalyzerReferences.Add($analyzerFilePath.FullName) - } - } - } -} - -# $project.Type gives the language name like (C# or VB.NET) -$languageFolder = "" -if($project.Type -eq "C#") -{ - $languageFolder = "cs" -} -if($project.Type -eq "VB.NET") -{ - $languageFolder = "vb" -} -if($languageFolder -eq "") -{ - return -} - -foreach($analyzersPath in $analyzersPaths) -{ - # Install language specific analyzers. - $languageAnalyzersPath = join-path $analyzersPath $languageFolder - if (Test-Path $languageAnalyzersPath) - { - foreach ($analyzerFilePath in Get-ChildItem $languageAnalyzersPath -Filter *.dll) - { - if($project.Object.AnalyzerReferences) - { - $project.Object.AnalyzerReferences.Add($analyzerFilePath.FullName) - } - } - } -} \ No newline at end of file diff --git a/packages/AWSSDK.S3.3.3.111.14/tools/uninstall.ps1 b/packages/AWSSDK.S3.3.3.111.14/tools/uninstall.ps1 deleted file mode 100644 index 9130bcb..0000000 --- a/packages/AWSSDK.S3.3.3.111.14/tools/uninstall.ps1 +++ /dev/null @@ -1,56 +0,0 @@ -param($installPath, $toolsPath, $package, $project) - -$analyzersPaths = Join-Path (Join-Path (Split-Path -Path $toolsPath -Parent) "analyzers" ) * -Resolve - -foreach($analyzersPath in $analyzersPaths) -{ - # Uninstall the language agnostic analyzers. - if (Test-Path $analyzersPath) - { - foreach ($analyzerFilePath in Get-ChildItem $analyzersPath -Filter *.dll) - { - if($project.Object.AnalyzerReferences) - { - $project.Object.AnalyzerReferences.Remove($analyzerFilePath.FullName) - } - } - } -} - -# $project.Type gives the language name like (C# or VB.NET) -$languageFolder = "" -if($project.Type -eq "C#") -{ - $languageFolder = "cs" -} -if($project.Type -eq "VB.NET") -{ - $languageFolder = "vb" -} -if($languageFolder -eq "") -{ - return -} - -foreach($analyzersPath in $analyzersPaths) -{ - # Uninstall language specific analyzers. - $languageAnalyzersPath = join-path $analyzersPath $languageFolder - if (Test-Path $languageAnalyzersPath) - { - foreach ($analyzerFilePath in Get-ChildItem $languageAnalyzersPath -Filter *.dll) - { - if($project.Object.AnalyzerReferences) - { - try - { - $project.Object.AnalyzerReferences.Remove($analyzerFilePath.FullName) - } - catch - { - - } - } - } - } -} \ No newline at end of file diff --git a/packages/AWSSDK.S3.3.5.0-beta/.signature.p7s b/packages/AWSSDK.S3.3.5.0-beta/.signature.p7s deleted file mode 100644 index 4f5cd49..0000000 Binary files a/packages/AWSSDK.S3.3.5.0-beta/.signature.p7s and /dev/null differ diff --git a/packages/AWSSDK.S3.3.5.0-beta/AWSSDK.S3.3.5.0-beta.nupkg b/packages/AWSSDK.S3.3.5.0-beta/AWSSDK.S3.3.5.0-beta.nupkg deleted file mode 100644 index f61743f..0000000 Binary files a/packages/AWSSDK.S3.3.5.0-beta/AWSSDK.S3.3.5.0-beta.nupkg and /dev/null differ diff --git a/packages/AWSSDK.S3.3.5.0-beta/analyzers/dotnet/cs/AWSSDK.S3.CodeAnalysis.dll b/packages/AWSSDK.S3.3.5.0-beta/analyzers/dotnet/cs/AWSSDK.S3.CodeAnalysis.dll deleted file mode 100644 index fd26763..0000000 Binary files a/packages/AWSSDK.S3.3.5.0-beta/analyzers/dotnet/cs/AWSSDK.S3.CodeAnalysis.dll and /dev/null differ diff --git a/packages/AWSSDK.S3.3.5.0-beta/lib/net35/AWSSDK.S3.dll b/packages/AWSSDK.S3.3.5.0-beta/lib/net35/AWSSDK.S3.dll deleted file mode 100644 index 754d51d..0000000 Binary files a/packages/AWSSDK.S3.3.5.0-beta/lib/net35/AWSSDK.S3.dll and /dev/null differ diff --git a/packages/AWSSDK.S3.3.5.0-beta/lib/net35/AWSSDK.S3.xml b/packages/AWSSDK.S3.3.5.0-beta/lib/net35/AWSSDK.S3.xml deleted file mode 100644 index 52be9d2..0000000 --- a/packages/AWSSDK.S3.3.5.0-beta/lib/net35/AWSSDK.S3.xml +++ /dev/null @@ -1,35669 +0,0 @@ - - - - AWSSDK.S3 - - - - - Implementation for accessing S3 - - - - - - - Specialize the initialize of the client. - - - - - Create a signed URL allowing access to a resource that would - usually require authentication. - - - - When using query string authentication you create a query, - specify an expiration time for the query, sign it with your - signature, place the data in an HTTP request, and distribute - the request to a user or embed the request in a web page. - - - A PreSigned URL can be generated for GET, PUT, DELETE and HEAD - operations on your bucketName, keys, and versions. - - - The GetPreSignedUrlRequest that defines the - parameters of the operation. - determines if signing will fall back to SigV2 if the - signing region is us-east-1 - A string that is the signed http request. - - - - - - Marshalls the parameters for a presigned url for a preferred signing protocol. - - - - - - True if AWS4 signing will be used; if the expiry period in the request exceeds the - maximum allowed for AWS4 (one week), an ArgumentException is thrown. - - - - - - Create a signed URL allowing access to a resource that would - usually require authentication. - - - - When using query string authentication you create a query, - specify an expiration time for the query, sign it with your - signature, place the data in an HTTP request, and distribute - the request to a user or embed the request in a web page. - - - A PreSigned URL can be generated for GET, PUT, DELETE and HEAD - operations on your bucketName, keys, and versions. - - - The GetPreSignedUrlRequest that defines the - parameters of the operation. - A string that is the signed http request. - - - - - - Constructs AmazonS3Client with the credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - - - - Constructs AmazonS3Client with the credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - The region to connect. - - - - Constructs AmazonS3Client with the credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - The AmazonS3Client Configuration Object - - - - Constructs AmazonS3Client with AWS Credentials - - AWS Credentials - - - - Constructs AmazonS3Client with AWS Credentials - - AWS Credentials - The region to connect. - - - - Constructs AmazonS3Client with AWS Credentials and an - AmazonS3Client Configuration object. - - AWS Credentials - The AmazonS3Client Configuration Object - - - - Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - - - - Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - The region to connect. - - - - Constructs AmazonS3Client with AWS Access Key ID, AWS Secret Key and an - AmazonS3Client Configuration object. - - AWS Access Key ID - AWS Secret Access Key - The AmazonS3Client Configuration Object - - - - Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - - - - Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - The region to connect. - - - - Constructs AmazonS3Client with AWS Access Key ID, AWS Secret Key and an - AmazonS3Client Configuration object. - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - The AmazonS3Client Configuration Object - - - - Creates the signer for the service. - - - - - Customize the pipeline - - - - - - Capture metadata for the service. - - - - - Disposes the service client. - - - - - This operation aborts a multipart upload. After a multipart upload is aborted, no - additional parts can be uploaded using that upload ID. The storage consumed by any - previously uploaded parts will be freed. However, if any part uploads are currently - in progress, those part uploads might or might not succeed. As a result, it might - be necessary to abort a given multipart upload multiple times in order to completely - free all storage consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts operation and ensure that the parts - list is empty. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - The bucket name to which the upload was taking place. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object for which the multipart upload was initiated. - Upload ID that identifies the multipart upload. - - The response from the AbortMultipartUpload service method, as returned by S3. - - - - This operation aborts a multipart upload. After a multipart upload is aborted, no - additional parts can be uploaded using that upload ID. The storage consumed by any - previously uploaded parts will be freed. However, if any part uploads are currently - in progress, those part uploads might or might not succeed. As a result, it might - be necessary to abort a given multipart upload multiple times in order to completely - free all storage consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts operation and ensure that the parts - list is empty. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - Container for the necessary parameters to execute the AbortMultipartUpload service method. - - The response from the AbortMultipartUpload service method, as returned by S3. - - - - Initiates the asynchronous execution of the AbortMultipartUpload operation. - - - Container for the necessary parameters to execute the AbortMultipartUpload operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAbortMultipartUpload - operation. - - - - Finishes the asynchronous execution of the AbortMultipartUpload operation. - - - The IAsyncResult returned by the call to BeginAbortMultipartUpload. - - Returns a AbortMultipartUploadResult from S3. - - - - Completes a multipart upload by assembling previously uploaded parts. - - - - You first initiate the multipart upload and then upload all parts using the UploadPart - operation. After successfully uploading all relevant parts of an upload, you call - this operation to complete the upload. Upon receiving this request, Amazon S3 concatenates - all the parts in ascending order by part number to create a new object. In the Complete - Multipart Upload request, you must provide the parts list. You must ensure that the - parts list is complete. This operation concatenates the parts that you provide in - the list. For each part in the list, you must provide the part number and the ETag - value, returned after that part was uploaded. - - - - Processing of a Complete Multipart Upload request could take several minutes to complete. - After Amazon S3 begins processing the request, it sends an HTTP response header that - specifies a 200 OK response. While processing is in progress, Amazon S3 periodically - sends white space characters to keep the connection from timing out. Because a request - could fail after the initial 200 OK response has been sent, it is important that you - check the response body to determine whether the request succeeded. - - - - Note that if CompleteMultipartUpload fails, applications should be prepared - to retry the failed requests. For more information, see Amazon - S3 Error Best Practices. - - - - For more information about multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - GetBucketLifecycle has the following special errors: - -
  • - - Error code: EntityTooSmall - -
    • - - Description: Your proposed upload is smaller than the minimum allowed object size. - Each part must be at least 5 MB in size, except the last part. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPart - -
    • - - Description: One or more of the specified parts could not be found. The part might - not have been uploaded, or the specified entity tag might not have matched the part's - entity tag. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPartOrder - -
    • - - Description: The list of parts was not in ascending order. The parts list must be - specified in order by part number. - -
    • - - 400 Bad Request - -
  • - - Error code: NoSuchUpload - -
    • - - Description: The specified multipart upload does not exist. The upload ID might be - invalid, or the multipart upload might have been aborted or completed. - -
    • - - 404 Not Found - -
- - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the CompleteMultipartUpload service method. - - The response from the CompleteMultipartUpload service method, as returned by S3. - - - - Initiates the asynchronous execution of the CompleteMultipartUpload operation. - - - Container for the necessary parameters to execute the CompleteMultipartUpload operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCompleteMultipartUpload - operation. - - - - Finishes the asynchronous execution of the CompleteMultipartUpload operation. - - - The IAsyncResult returned by the call to BeginCompleteMultipartUpload. - - Returns a CompleteMultipartUploadResult from S3. - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - for copying an object greater than 5 GB, you must use the multipart upload Upload - Part - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - Amazon S3 transfer acceleration does not support cross-region copies. If you request - a cross-region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information about transfer acceleration, see Transfer - Acceleration. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - request parameters x-amz-copy-source-if-match, x-amz-copy-source-if-none-match, - x-amz-copy-source-if-unmodified-since, or x-amz-copy-source-if-modified-since. - - - - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - You can use this operation to change the storage class of an object that is already - stored in Amazon S3 using the StorageClass parameter. For more information, - see Storage - Classes. - - - - The source object that you are copying can be encrypted or unencrypted. If the source - object is encrypted, it can be encrypted by server-side encryption using AWS managed - encryption keys or by using a customer-provided encryption key. When copying an object, - you can request that Amazon S3 encrypt the target object by using either the AWS managed - encryption keys or by using your own encryption key. You can do this regardless of - the form of server-side encryption that was used to encrypt the source, or even if - the source object was not encrypted. For more information about server-side encryption, - see Using - Server-Side Encryption. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
    • - - x-amz-copy-source-if-match condition evaluates to true - -
    • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
  • - - Consideration 2 – If both of the x-amz-copy-source-if-none-match and - x-amz-copy-source-if-modified-since headers are present in the request - and evaluate as follows, Amazon S3 returns the 412 Precondition Failed - response code: - -
    • - - x-amz-copy-source-if-none-match condition evaluates to false - -
    • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - The copy request charge is based on the storage class and Region you specify for the - destination object. For pricing information, see Amazon - S3 Pricing. - - - - Following are other considerations when using CopyObject: - -
Versioning
- - By default, x-amz-copy-source identifies the current version of an object - to copy. (If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted.) To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - To encrypt the target object, you must provide the appropriate encryption-related - request headers. The one you use depends on whether you want to use AWS managed encryption - keys or provide your own encryption key. - -
  • - - To encrypt the target object using server-side encryption with an AWS managed encryption - key, provide the following request headers, as appropriate. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. If you want to use a customer managed AWS KMS - CMK, you must provide the x-amz-server-side-encryption-aws-kms-key-id - of the symmetric customer managed CMK. Amazon S3 only supports symmetric CMKs and - not asymmetric CMKs. For more information, see Using - Symmetric and Asymmetric Keys in the AWS Key Management Service Developer Guide. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in KMS. - -
  • - - To encrypt the target object using server-side encryption with an encryption key that - you provide, use the following headers. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
  • - - If the source object is encrypted using server-side encryption with customer-provided - encryption keys, you must use the following headers. - -
    • - - x-amz-copy-source​-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-copy-source​-server-side​-encryption​-customer-key - -
    • - - x-amz-copy-source-​server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in Amazon KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - The response from the CopyObject service method, as returned by S3. - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - for copying an object greater than 5 GB, you must use the multipart upload Upload - Part - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - Amazon S3 transfer acceleration does not support cross-region copies. If you request - a cross-region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information about transfer acceleration, see Transfer - Acceleration. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - request parameters x-amz-copy-source-if-match, x-amz-copy-source-if-none-match, - x-amz-copy-source-if-unmodified-since, or x-amz-copy-source-if-modified-since. - - - - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - You can use this operation to change the storage class of an object that is already - stored in Amazon S3 using the StorageClass parameter. For more information, - see Storage - Classes. - - - - The source object that you are copying can be encrypted or unencrypted. If the source - object is encrypted, it can be encrypted by server-side encryption using AWS managed - encryption keys or by using a customer-provided encryption key. When copying an object, - you can request that Amazon S3 encrypt the target object by using either the AWS managed - encryption keys or by using your own encryption key. You can do this regardless of - the form of server-side encryption that was used to encrypt the source, or even if - the source object was not encrypted. For more information about server-side encryption, - see Using - Server-Side Encryption. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
    • - - x-amz-copy-source-if-match condition evaluates to true - -
    • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
  • - - Consideration 2 – If both of the x-amz-copy-source-if-none-match and - x-amz-copy-source-if-modified-since headers are present in the request - and evaluate as follows, Amazon S3 returns the 412 Precondition Failed - response code: - -
    • - - x-amz-copy-source-if-none-match condition evaluates to false - -
    • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - The copy request charge is based on the storage class and Region you specify for the - destination object. For pricing information, see Amazon - S3 Pricing. - - - - Following are other considerations when using CopyObject: - -
Versioning
- - By default, x-amz-copy-source identifies the current version of an object - to copy. (If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted.) To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - To encrypt the target object, you must provide the appropriate encryption-related - request headers. The one you use depends on whether you want to use AWS managed encryption - keys or provide your own encryption key. - -
  • - - To encrypt the target object using server-side encryption with an AWS managed encryption - key, provide the following request headers, as appropriate. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. If you want to use a customer managed AWS KMS - CMK, you must provide the x-amz-server-side-encryption-aws-kms-key-id - of the symmetric customer managed CMK. Amazon S3 only supports symmetric CMKs and - not asymmetric CMKs. For more information, see Using - Symmetric and Asymmetric Keys in the AWS Key Management Service Developer Guide. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in KMS. - -
  • - - To encrypt the target object using server-side encryption with an encryption key that - you provide, use the following headers. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
  • - - If the source object is encrypted using server-side encryption with customer-provided - encryption keys, you must use the following headers. - -
    • - - x-amz-copy-source​-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-copy-source​-server-side​-encryption​-customer-key - -
    • - - x-amz-copy-source-​server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in Amazon KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - The response from the CopyObject service method, as returned by S3. - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - for copying an object greater than 5 GB, you must use the multipart upload Upload - Part - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - Amazon S3 transfer acceleration does not support cross-region copies. If you request - a cross-region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information about transfer acceleration, see Transfer - Acceleration. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - request parameters x-amz-copy-source-if-match, x-amz-copy-source-if-none-match, - x-amz-copy-source-if-unmodified-since, or x-amz-copy-source-if-modified-since. - - - - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - You can use this operation to change the storage class of an object that is already - stored in Amazon S3 using the StorageClass parameter. For more information, - see Storage - Classes. - - - - The source object that you are copying can be encrypted or unencrypted. If the source - object is encrypted, it can be encrypted by server-side encryption using AWS managed - encryption keys or by using a customer-provided encryption key. When copying an object, - you can request that Amazon S3 encrypt the target object by using either the AWS managed - encryption keys or by using your own encryption key. You can do this regardless of - the form of server-side encryption that was used to encrypt the source, or even if - the source object was not encrypted. For more information about server-side encryption, - see Using - Server-Side Encryption. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
    • - - x-amz-copy-source-if-match condition evaluates to true - -
    • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
  • - - Consideration 2 – If both of the x-amz-copy-source-if-none-match and - x-amz-copy-source-if-modified-since headers are present in the request - and evaluate as follows, Amazon S3 returns the 412 Precondition Failed - response code: - -
    • - - x-amz-copy-source-if-none-match condition evaluates to false - -
    • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - The copy request charge is based on the storage class and Region you specify for the - destination object. For pricing information, see Amazon - S3 Pricing. - - - - Following are other considerations when using CopyObject: - -
Versioning
- - By default, x-amz-copy-source identifies the current version of an object - to copy. (If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted.) To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - To encrypt the target object, you must provide the appropriate encryption-related - request headers. The one you use depends on whether you want to use AWS managed encryption - keys or provide your own encryption key. - -
  • - - To encrypt the target object using server-side encryption with an AWS managed encryption - key, provide the following request headers, as appropriate. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. If you want to use a customer managed AWS KMS - CMK, you must provide the x-amz-server-side-encryption-aws-kms-key-id - of the symmetric customer managed CMK. Amazon S3 only supports symmetric CMKs and - not asymmetric CMKs. For more information, see Using - Symmetric and Asymmetric Keys in the AWS Key Management Service Developer Guide. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in KMS. - -
  • - - To encrypt the target object using server-side encryption with an encryption key that - you provide, use the following headers. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
  • - - If the source object is encrypted using server-side encryption with customer-provided - encryption keys, you must use the following headers. - -
    • - - x-amz-copy-source​-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-copy-source​-server-side​-encryption​-customer-key - -
    • - - x-amz-copy-source-​server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in Amazon KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - Container for the necessary parameters to execute the CopyObject service method. - - The response from the CopyObject service method, as returned by S3. - - - - Initiates the asynchronous execution of the CopyObject operation. - - - Container for the necessary parameters to execute the CopyObject operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCopyObject - operation. - - - - Finishes the asynchronous execution of the CopyObject operation. - - - The IAsyncResult returned by the call to BeginCopyObject. - - Returns a CopyObjectResult from S3. - - - - - - - Initiates the asynchronous execution of the CopyPart operation. - - - Container for the necessary parameters to execute the CopyPart operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCopyPart - operation. - - - - Finishes the asynchronous execution of the CopyPart operation. - - - The IAsyncResult returned by the call to BeginCopyPart. - - Returns a CopyPartResult from S3. - - - - - - Initiates the asynchronous execution of the DeleteBucket operation. - - - Container for the necessary parameters to execute the DeleteBucket operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteBucket - operation. - - - - Finishes the asynchronous execution of the DeleteBucket operation. - - - The IAsyncResult returned by the call to BeginDeleteBucket. - - Returns a DeleteBucketResult from S3. - - - - Deletes an analytics configuration for the bucket (specified by the analytics configuration - ID). - - - - To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to DeleteBucketAnalyticsConfiguration: - -
  • - - - -
  • - - - -
  • - - - -
- - Container for the necessary parameters to execute the DeleteBucketAnalyticsConfiguration service method. - - The response from the DeleteBucketAnalyticsConfiguration service method, as returned by S3. - - - - Initiates the asynchronous execution of the DeleteBucketAnalyticsConfiguration operation. - - - Container for the necessary parameters to execute the DeleteBucketAnalyticsConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteBucketAnalyticsConfiguration - operation. - - - - Finishes the asynchronous execution of the DeleteBucketAnalyticsConfiguration operation. - - - The IAsyncResult returned by the call to BeginDeleteBucketAnalyticsConfiguration. - - Returns a DeleteBucketAnalyticsConfigurationResult from S3. - - - - - Initiates the asynchronous execution of the DeleteBucketEncryption operation. - - - Container for the necessary parameters to execute the DeleteBucketEncryption operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteBucketEncryption - operation. - - - - Finishes the asynchronous execution of the DeleteBucketEncryption operation. - - - The IAsyncResult returned by the call to BeginDeleteBucketEncryption. - - Returns a DeleteBucketEncryptionResult from S3. - - - - Deletes an inventory configuration (identified by the inventory ID) from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - Operations related to DeleteBucketInventoryConfiguration include: - - - - Container for the necessary parameters to execute the DeleteBucketInventoryConfiguration service method. - - The response from the DeleteBucketInventoryConfiguration service method, as returned by S3. - - - - Initiates the asynchronous execution of the DeleteBucketInventoryConfiguration operation. - - - Container for the necessary parameters to execute the DeleteBucketInventoryConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteBucketInventoryConfiguration - operation. - - - - Finishes the asynchronous execution of the DeleteBucketInventoryConfiguration operation. - - - The IAsyncResult returned by the call to BeginDeleteBucketInventoryConfiguration. - - Returns a DeleteBucketInventoryConfigurationResult from S3. - - - - Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified - by the metrics configuration ID) from the bucket. Note that this doesn't include the - daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteBucketMetricsConfiguration service method. - - The response from the DeleteBucketMetricsConfiguration service method, as returned by S3. - - - - Initiates the asynchronous execution of the DeleteBucketMetricsConfiguration operation. - - - Container for the necessary parameters to execute the DeleteBucketMetricsConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteBucketMetricsConfiguration - operation. - - - - Finishes the asynchronous execution of the DeleteBucketMetricsConfiguration operation. - - - The IAsyncResult returned by the call to BeginDeleteBucketMetricsConfiguration. - - Returns a DeleteBucketMetricsConfigurationResult from S3. - - - - This implementation of the DELETE operation uses the policy subresource to delete - the policy of a specified bucket. If you are using an identity other than the root - user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - The bucket name. - - The response from the DeleteBucketPolicy service method, as returned by S3. - - - - This implementation of the DELETE operation uses the policy subresource to delete - the policy of a specified bucket. If you are using an identity other than the root - user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - Container for the necessary parameters to execute the DeleteBucketPolicy service method. - - The response from the DeleteBucketPolicy service method, as returned by S3. - - - - Initiates the asynchronous execution of the DeleteBucketPolicy operation. - - - Container for the necessary parameters to execute the DeleteBucketPolicy operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteBucketPolicy - operation. - - - - Finishes the asynchronous execution of the DeleteBucketPolicy operation. - - - The IAsyncResult returned by the call to BeginDeleteBucketPolicy. - - Returns a DeleteBucketPolicyResult from S3. - - - - Deletes the replication configuration from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutReplicationConfiguration - action. The bucket owner has these permissions by default and can grant it to others. - For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - It can take a while for the deletion of a replication configuration to fully propagate. - - - - For information about replication configuration, see Replication - in the Amazon S3 Developer Guide. - - - - The following operations are related to DeleteBucketReplication: - - - - Container for the necessary parameters to execute the DeleteBucketReplication service method. - - The response from the DeleteBucketReplication service method, as returned by S3. - - - - Initiates the asynchronous execution of the DeleteBucketReplication operation. - - - Container for the necessary parameters to execute the DeleteBucketReplication operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteBucketReplication - operation. - - - - Finishes the asynchronous execution of the DeleteBucketReplication operation. - - - The IAsyncResult returned by the call to BeginDeleteBucketReplication. - - Returns a DeleteBucketReplicationResult from S3. - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - The bucket that has the tag set to be removed. - - The response from the DeleteBucketTagging service method, as returned by S3. - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - Container for the necessary parameters to execute the DeleteBucketTagging service method. - - The response from the DeleteBucketTagging service method, as returned by S3. - - - - Initiates the asynchronous execution of the DeleteBucketTagging operation. - - - Container for the necessary parameters to execute the DeleteBucketTagging operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteBucketTagging - operation. - - - - Finishes the asynchronous execution of the DeleteBucketTagging operation. - - - The IAsyncResult returned by the call to BeginDeleteBucketTagging. - - Returns a DeleteBucketTaggingResult from S3. - - - - This operation removes the website configuration for a bucket. Amazon S3 returns a - 200 OK response upon successfully deleting a website configuration on - the specified bucket. You will get a 200 OK response if the website configuration - you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE operation requires the S3:DeleteBucketWebsite permission. - By default, only the bucket owner can delete the website configuration attached to - a bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which you want to remove the website configuration. - - The response from the DeleteBucketWebsite service method, as returned by S3. - - - - This operation removes the website configuration for a bucket. Amazon S3 returns a - 200 OK response upon successfully deleting a website configuration on - the specified bucket. You will get a 200 OK response if the website configuration - you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE operation requires the S3:DeleteBucketWebsite permission. - By default, only the bucket owner can delete the website configuration attached to - a bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the DeleteBucketWebsite service method. - - The response from the DeleteBucketWebsite service method, as returned by S3. - - - - Initiates the asynchronous execution of the DeleteBucketWebsite operation. - - - Container for the necessary parameters to execute the DeleteBucketWebsite operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteBucketWebsite - operation. - - - - Finishes the asynchronous execution of the DeleteBucketWebsite operation. - - - The IAsyncResult returned by the call to BeginDeleteBucketWebsite. - - Returns a DeleteBucketWebsiteResult from S3. - - - - - - Initiates the asynchronous execution of the DeleteCORSConfiguration operation. - - - Container for the necessary parameters to execute the DeleteCORSConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteCORSConfiguration - operation. - - - - Finishes the asynchronous execution of the DeleteCORSConfiguration operation. - - - The IAsyncResult returned by the call to BeginDeleteCORSConfiguration. - - Returns a DeleteCORSConfigurationResult from S3. - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - The bucket name of the lifecycle to delete. - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - Container for the necessary parameters to execute the DeleteLifecycleConfiguration service method. - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - - - - Initiates the asynchronous execution of the DeleteLifecycleConfiguration operation. - - - Container for the necessary parameters to execute the DeleteLifecycleConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteLifecycleConfiguration - operation. - - - - Finishes the asynchronous execution of the DeleteLifecycleConfiguration operation. - - - The IAsyncResult returned by the call to BeginDeleteLifecycleConfiguration. - - Returns a DeleteLifecycleConfigurationResult from S3. - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key name of the object to delete. - - The response from the DeleteObject service method, as returned by S3. - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key name of the object to delete. - VersionId used to reference a specific version of the object. - - The response from the DeleteObject service method, as returned by S3. - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - Container for the necessary parameters to execute the DeleteObject service method. - - The response from the DeleteObject service method, as returned by S3. - - - - Initiates the asynchronous execution of the DeleteObject operation. - - - Container for the necessary parameters to execute the DeleteObject operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteObject - operation. - - - - Finishes the asynchronous execution of the DeleteObject operation. - - - The IAsyncResult returned by the call to BeginDeleteObject. - - Returns a DeleteObjectResult from S3. - - - - This operation enables you to delete multiple objects from a bucket using a single - HTTP request. If you know the object keys that you want to delete, then this operation - provides a suitable alternative to sending individual delete requests, reducing per-request - overhead. - - - - The request contains a list of up to 1000 keys that you want to delete. In the XML, - you provide the object key names, and optionally, version IDs if you want to delete - a specific version of the object from a versioning-enabled bucket. For each key, Amazon - S3 performs a delete operation and returns the result of that delete, success, or - failure, in the response. Note that if the object specified in the request is not - found, Amazon S3 returns the result as deleted. - - - - The operation supports two modes for the response: verbose and quiet. By default, - the operation uses verbose mode in which the response includes the result of deletion - of each key in your request. In quiet mode the response includes only keys where the - delete operation encountered an error. For a successful deletion, the operation does - not return any information about the delete in the response body. - - - - When performing this operation on an MFA Delete enabled bucket, that attempts to delete - any versioned objects, you must include an MFA token. If you do not provide one, the - entire request will fail, even if there are non-versioned objects you are trying to - delete. If you provide an invalid token, whether there are versioned keys in the request - or not, the entire Multi-Object Delete request will fail. For information about MFA - Delete, see - MFA Delete. - - - - Finally, the Content-MD5 header is required for all Multi-Object Delete requests. - Amazon S3 uses the header value to ensure that your request body has not been altered - in transit. - - - - The following operations are related to DeleteObjects: - - - - Container for the necessary parameters to execute the DeleteObjects service method. - - The response from the DeleteObjects service method, as returned by S3. - - - - Initiates the asynchronous execution of the DeleteObjects operation. - - - Container for the necessary parameters to execute the DeleteObjects operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteObjects - operation. - - - - Finishes the asynchronous execution of the DeleteObjects operation. - - - The IAsyncResult returned by the call to BeginDeleteObjects. - - Returns a DeleteObjectsResult from S3. - - - - Removes the entire tag set from the specified object. For more information about managing - object tags, see - Object Tagging. - - - - To use this operation, you must have permission to perform the s3:DeleteObjectTagging - action. - - - - To delete tags of a specific object version, add the versionId query - parameter in the request. You will need permission for the s3:DeleteObjectVersionTagging - action. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteObjectTagging service method. - - The response from the DeleteObjectTagging service method, as returned by S3. - - - - Initiates the asynchronous execution of the DeleteObjectTagging operation. - - - Container for the necessary parameters to execute the DeleteObjectTagging operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteObjectTagging - operation. - - - - Finishes the asynchronous execution of the DeleteObjectTagging operation. - - - The IAsyncResult returned by the call to BeginDeleteObjectTagging. - - Returns a DeleteObjectTaggingResult from S3. - - - - Removes the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:PutBucketPublicAccessBlock - permission. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeletePublicAccessBlock service method. - - The response from the DeletePublicAccessBlock service method, as returned by S3. - - - - Initiates the asynchronous execution of the DeletePublicAccessBlock operation. - - - Container for the necessary parameters to execute the DeletePublicAccessBlock operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeletePublicAccessBlock - operation. - - - - Finishes the asynchronous execution of the DeletePublicAccessBlock operation. - - - The IAsyncResult returned by the call to BeginDeletePublicAccessBlock. - - Returns a DeletePublicAccessBlockResult from S3. - - - - - - Initiates the asynchronous execution of the GetACL operation. - - - Container for the necessary parameters to execute the GetACL operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetACL - operation. - - - - Finishes the asynchronous execution of the GetACL operation. - - - The IAsyncResult returned by the call to BeginGetACL. - - Returns a GetACLResult from S3. - - - - - - Initiates the asynchronous execution of the GetBucketAccelerateConfiguration operation. - - - Container for the necessary parameters to execute the GetBucketAccelerateConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketAccelerateConfiguration - operation. - - - - Finishes the asynchronous execution of the GetBucketAccelerateConfiguration operation. - - - The IAsyncResult returned by the call to BeginGetBucketAccelerateConfiguration. - - Returns a GetBucketAccelerateConfigurationResult from S3. - - - - - Initiates the asynchronous execution of the GetBucketAnalyticsConfiguration operation. - - - Container for the necessary parameters to execute the GetBucketAnalyticsConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketAnalyticsConfiguration - operation. - - - - Finishes the asynchronous execution of the GetBucketAnalyticsConfiguration operation. - - - The IAsyncResult returned by the call to BeginGetBucketAnalyticsConfiguration. - - Returns a GetBucketAnalyticsConfigurationResult from S3. - - - - Returns the default encryption configuration for an Amazon S3 bucket. For information - about the Amazon S3 default encryption feature, see Amazon - S3 Default Bucket Encryption. - - - - To use this operation, you must have permission to perform the s3:GetEncryptionConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to GetBucketEncryption: - - - - Container for the necessary parameters to execute the GetBucketEncryption service method. - - The response from the GetBucketEncryption service method, as returned by S3. - - - - Initiates the asynchronous execution of the GetBucketEncryption operation. - - - Container for the necessary parameters to execute the GetBucketEncryption operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketEncryption - operation. - - - - Finishes the asynchronous execution of the GetBucketEncryption operation. - - - The IAsyncResult returned by the call to BeginGetBucketEncryption. - - Returns a GetBucketEncryptionResult from S3. - - - - Returns an inventory configuration (identified by the inventory configuration ID) - from the bucket. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - The following operations are related to GetBucketInventoryConfiguration: - - - - Container for the necessary parameters to execute the GetBucketInventoryConfiguration service method. - - The response from the GetBucketInventoryConfiguration service method, as returned by S3. - - - - Initiates the asynchronous execution of the GetBucketInventoryConfiguration operation. - - - Container for the necessary parameters to execute the GetBucketInventoryConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketInventoryConfiguration - operation. - - - - Finishes the asynchronous execution of the GetBucketInventoryConfiguration operation. - - - The IAsyncResult returned by the call to BeginGetBucketInventoryConfiguration. - - Returns a GetBucketInventoryConfigurationResult from S3. - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - The name of the bucket for which to get the location. - - The response from the GetBucketLocation service method, as returned by S3. - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - Container for the necessary parameters to execute the GetBucketLocation service method. - - The response from the GetBucketLocation service method, as returned by S3. - - - - Initiates the asynchronous execution of the GetBucketLocation operation. - - - Container for the necessary parameters to execute the GetBucketLocation operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketLocation - operation. - - - - Finishes the asynchronous execution of the GetBucketLocation operation. - - - The IAsyncResult returned by the call to BeginGetBucketLocation. - - Returns a GetBucketLocationResult from S3. - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - The bucket name for which to get the logging information. - - The response from the GetBucketLogging service method, as returned by S3. - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - Container for the necessary parameters to execute the GetBucketLogging service method. - - The response from the GetBucketLogging service method, as returned by S3. - - - - Initiates the asynchronous execution of the GetBucketLogging operation. - - - Container for the necessary parameters to execute the GetBucketLogging operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketLogging - operation. - - - - Finishes the asynchronous execution of the GetBucketLogging operation. - - - The IAsyncResult returned by the call to BeginGetBucketLogging. - - Returns a GetBucketLoggingResult from S3. - - - - Gets a metrics configuration (specified by the metrics configuration ID) from the - bucket. Note that this doesn't include the daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to GetBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the GetBucketMetricsConfiguration service method. - - The response from the GetBucketMetricsConfiguration service method, as returned by S3. - - - - Initiates the asynchronous execution of the GetBucketMetricsConfiguration operation. - - - Container for the necessary parameters to execute the GetBucketMetricsConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketMetricsConfiguration - operation. - - - - Finishes the asynchronous execution of the GetBucketMetricsConfiguration operation. - - - The IAsyncResult returned by the call to BeginGetBucketMetricsConfiguration. - - Returns a GetBucketMetricsConfigurationResult from S3. - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following operation is related to GetBucketNotification: - - - - Name of the bucket for which to get the notification configuration - - The response from the GetBucketNotification service method, as returned by S3. - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following operation is related to GetBucketNotification: - - - - Container for the necessary parameters to execute the GetBucketNotification service method. - - The response from the GetBucketNotification service method, as returned by S3. - - - - Initiates the asynchronous execution of the GetBucketNotification operation. - - - Container for the necessary parameters to execute the GetBucketNotification operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketNotification - operation. - - - - Finishes the asynchronous execution of the GetBucketNotification operation. - - - The IAsyncResult returned by the call to BeginGetBucketNotification. - - Returns a GetBucketNotificationResult from S3. - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operation is related to GetBucketPolicy: - - - - The bucket name for which to get the bucket policy. - - The response from the GetBucketPolicy service method, as returned by S3. - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operation is related to GetBucketPolicy: - - - - Container for the necessary parameters to execute the GetBucketPolicy service method. - - The response from the GetBucketPolicy service method, as returned by S3. - - - - Initiates the asynchronous execution of the GetBucketPolicy operation. - - - Container for the necessary parameters to execute the GetBucketPolicy operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketPolicy - operation. - - - - Finishes the asynchronous execution of the GetBucketPolicy operation. - - - The IAsyncResult returned by the call to BeginGetBucketPolicy. - - Returns a GetBucketPolicyResult from S3. - - - - Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket - is public. In order to use this operation, you must have the s3:GetBucketPolicyStatus - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - For more information about when Amazon S3 considers a bucket public, see The - Meaning of "Public". - - - - The following operations are related to GetBucketPolicyStatus: - - - - Container for the necessary parameters to execute the GetBucketPolicyStatus service method. - - The response from the GetBucketPolicyStatus service method, as returned by S3. - - - - Initiates the asynchronous execution of the GetBucketPolicyStatus operation. - - - Container for the necessary parameters to execute the GetBucketPolicyStatus operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketPolicyStatus - operation. - - - - Finishes the asynchronous execution of the GetBucketPolicyStatus operation. - - - The IAsyncResult returned by the call to BeginGetBucketPolicyStatus. - - Returns a GetBucketPolicyStatusResult from S3. - - - - Retrieves the replication configuration for the given Amazon S3 bucket. - - Container for the necessary parameters to execute the GetBucketReplication service method. - - The response from the GetBucketReplication service method, as returned by S3. - - - - Initiates the asynchronous execution of the GetBucketReplication operation. - - - Container for the necessary parameters to execute the GetBucketReplication operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketReplication - operation. - - - - Finishes the asynchronous execution of the GetBucketReplication operation. - - - The IAsyncResult returned by the call to BeginGetBucketReplication. - - Returns a GetBucketReplicationResult from S3. - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - The name of the bucket for which to get the payment request configuration - - The response from the GetBucketRequestPayment service method, as returned by S3. - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - Container for the necessary parameters to execute the GetBucketRequestPayment service method. - - The response from the GetBucketRequestPayment service method, as returned by S3. - - - - Initiates the asynchronous execution of the GetBucketRequestPayment operation. - - - Container for the necessary parameters to execute the GetBucketRequestPayment operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketRequestPayment - operation. - - - - Finishes the asynchronous execution of the GetBucketRequestPayment operation. - - - The IAsyncResult returned by the call to BeginGetBucketRequestPayment. - - Returns a GetBucketRequestPaymentResult from S3. - - - - Returns the tag set associated with the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - GetBucketTagging has the following special error: - -
  • - - Error code: NoSuchTagSetError - -
    • - - Description: There is no tag set associated with the bucket. - -
- - The following operations are related to GetBucketTagging: - - - - Container for the necessary parameters to execute the GetBucketTagging service method. - - The response from the GetBucketTagging service method, as returned by S3. - - - - Initiates the asynchronous execution of the GetBucketTagging operation. - - - Container for the necessary parameters to execute the GetBucketTagging operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketTagging - operation. - - - - Finishes the asynchronous execution of the GetBucketTagging operation. - - - The IAsyncResult returned by the call to BeginGetBucketTagging. - - Returns a GetBucketTaggingResult from S3. - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - The name of the bucket for which to get the versioning information. - - The response from the GetBucketVersioning service method, as returned by S3. - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - Container for the necessary parameters to execute the GetBucketVersioning service method. - - The response from the GetBucketVersioning service method, as returned by S3. - - - - Initiates the asynchronous execution of the GetBucketVersioning operation. - - - Container for the necessary parameters to execute the GetBucketVersioning operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketVersioning - operation. - - - - Finishes the asynchronous execution of the GetBucketVersioning operation. - - - The IAsyncResult returned by the call to BeginGetBucketVersioning. - - Returns a GetBucketVersioningResult from S3. - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET operation requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which to get the website configuration. - - The response from the GetBucketWebsite service method, as returned by S3. - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET operation requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the GetBucketWebsite service method. - - The response from the GetBucketWebsite service method, as returned by S3. - - - - Initiates the asynchronous execution of the GetBucketWebsite operation. - - - Container for the necessary parameters to execute the GetBucketWebsite operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketWebsite - operation. - - - - Finishes the asynchronous execution of the GetBucketWebsite operation. - - - The IAsyncResult returned by the call to BeginGetBucketWebsite. - - Returns a GetBucketWebsiteResult from S3. - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - The bucket name for which to get the cors configuration. - - The response from the GetCORSConfiguration service method, as returned by S3. - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - Container for the necessary parameters to execute the GetCORSConfiguration service method. - - The response from the GetCORSConfiguration service method, as returned by S3. - - - - Initiates the asynchronous execution of the GetCORSConfiguration operation. - - - Container for the necessary parameters to execute the GetCORSConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetCORSConfiguration - operation. - - - - Finishes the asynchronous execution of the GetCORSConfiguration operation. - - - The IAsyncResult returned by the call to BeginGetCORSConfiguration. - - Returns a GetCORSConfigurationResult from S3. - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are still using previous version of the lifecycle configuration, it works. - For the earlier API description, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to DeleteBucketMetricsConfiguration: - - - - The name of the bucket for which to get the lifecycle information. - - The response from the GetLifecycleConfiguration service method, as returned by S3. - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are still using previous version of the lifecycle configuration, it works. - For the earlier API description, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the GetLifecycleConfiguration service method. - - The response from the GetLifecycleConfiguration service method, as returned by S3. - - - - Initiates the asynchronous execution of the GetLifecycleConfiguration operation. - - - Container for the necessary parameters to execute the GetLifecycleConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetLifecycleConfiguration - operation. - - - - Finishes the asynchronous execution of the GetLifecycleConfiguration operation. - - - The IAsyncResult returned by the call to BeginGetLifecycleConfiguration. - - Returns a GetLifecycleConfigurationResult from S3. - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object to get. - - The response from the GetObject service method, as returned by S3. - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object to get. - VersionId used to reference a specific version of the object. - - The response from the GetObject service method, as returned by S3. - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - Container for the necessary parameters to execute the GetObject service method. - - The response from the GetObject service method, as returned by S3. - - - - Initiates the asynchronous execution of the GetObject operation. - - - Container for the necessary parameters to execute the GetObject operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetObject - operation. - - - - Finishes the asynchronous execution of the GetObject operation. - - - The IAsyncResult returned by the call to BeginGetObject. - - Returns a GetObjectResult from S3. - - - - Gets an object's current Legal Hold status. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLegalHold service method. - - The response from the GetObjectLegalHold service method, as returned by S3. - - - - Initiates the asynchronous execution of the GetObjectLegalHold operation. - - - Container for the necessary parameters to execute the GetObjectLegalHold operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetObjectLegalHold - operation. - - - - Finishes the asynchronous execution of the GetObjectLegalHold operation. - - - The IAsyncResult returned by the call to BeginGetObjectLegalHold. - - Returns a GetObjectLegalHoldResult from S3. - - - - Gets the Object Lock configuration for a bucket. The rule specified in the Object - Lock configuration will be applied by default to every new object placed in the specified - bucket. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLockConfiguration service method. - - The response from the GetObjectLockConfiguration service method, as returned by S3. - - - - Initiates the asynchronous execution of the GetObjectLockConfiguration operation. - - - Container for the necessary parameters to execute the GetObjectLockConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetObjectLockConfiguration - operation. - - - - Finishes the asynchronous execution of the GetObjectLockConfiguration operation. - - - The IAsyncResult returned by the call to BeginGetObjectLockConfiguration. - - Returns a GetObjectLockConfigurationResult from S3. - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - The name of the bucket containing the object. - The object key. - - The response from the GetObjectMetadata service method, as returned by S3. - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - The name of the bucket containing the object. - The object key. - VersionId used to reference a specific version of the object. - - The response from the GetObjectMetadata service method, as returned by S3. - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - Container for the necessary parameters to execute the GetObjectMetadata service method. - - The response from the GetObjectMetadata service method, as returned by S3. - - - - Initiates the asynchronous execution of the GetObjectMetadata operation. - - - Container for the necessary parameters to execute the GetObjectMetadata operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetObjectMetadata - operation. - - - - Finishes the asynchronous execution of the GetObjectMetadata operation. - - - The IAsyncResult returned by the call to BeginGetObjectMetadata. - - Returns a GetObjectMetadataResult from S3. - - - - Retrieves an object's retention settings. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectRetention service method. - - The response from the GetObjectRetention service method, as returned by S3. - - - - Initiates the asynchronous execution of the GetObjectRetention operation. - - - Container for the necessary parameters to execute the GetObjectRetention operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetObjectRetention - operation. - - - - Finishes the asynchronous execution of the GetObjectRetention operation. - - - The IAsyncResult returned by the call to BeginGetObjectRetention. - - Returns a GetObjectRetentionResult from S3. - - - - Returns the tag-set of an object. You send the GET request against the tagging subresource - associated with the object. - - - - To use this operation, you must have permission to perform the s3:GetObjectTagging - action. By default, the GET operation returns information about current version of - an object. For a versioned bucket, you can have multiple versions of an object in - your bucket. To retrieve tags of any other version, use the versionId query parameter. - You also need permission for the s3:GetObjectVersionTagging action. - - - - By default, the bucket owner has this permission and can grant this permission to - others. - - - - For information about the Amazon S3 object tagging feature, see Object - Tagging. - - - - The following operation is related to GetObjectTagging: - - - - Container for the necessary parameters to execute the GetObjectTagging service method. - - The response from the GetObjectTagging service method, as returned by S3. - - - - Initiates the asynchronous execution of the GetObjectTagging operation. - - - Container for the necessary parameters to execute the GetObjectTagging operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetObjectTagging - operation. - - - - Finishes the asynchronous execution of the GetObjectTagging operation. - - - The IAsyncResult returned by the call to BeginGetObjectTagging. - - Returns a GetObjectTaggingResult from S3. - - - - Return torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Amazon - S3 Torrent. - - - - You can get torrent only for objects that are less than 5 GB in size and that are - not encrypted using server-side encryption with customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - The following operation is related to GetObjectTorrent: - - - - The name of the bucket containing the object for which to get the torrent files. - The object key for which to get the information. - - The response from the GetObjectTorrent service method, as returned by S3. - - - - Return torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Amazon - S3 Torrent. - - - - You can get torrent only for objects that are less than 5 GB in size and that are - not encrypted using server-side encryption with customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - The following operation is related to GetObjectTorrent: - - - - Container for the necessary parameters to execute the GetObjectTorrent service method. - - The response from the GetObjectTorrent service method, as returned by S3. - - - - Initiates the asynchronous execution of the GetObjectTorrent operation. - - - Container for the necessary parameters to execute the GetObjectTorrent operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetObjectTorrent - operation. - - - - Finishes the asynchronous execution of the GetObjectTorrent operation. - - - The IAsyncResult returned by the call to BeginGetObjectTorrent. - - Returns a GetObjectTorrentResult from S3. - - - - Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:GetBucketPublicAccessBlock - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket - or an object, it checks the PublicAccessBlock configuration for both - the bucket (or the bucket that contains the object) and the bucket owner's account. - If the PublicAccessBlock settings are different between the bucket and - the account, Amazon S3 uses the most restrictive combination of the bucket-level and - account-level settings. - - - - For more information about when Amazon S3 considers a bucket or an object public, - see The - Meaning of "Public". - - - - The following operations are related to GetPublicAccessBlock: - - - - Container for the necessary parameters to execute the GetPublicAccessBlock service method. - - The response from the GetPublicAccessBlock service method, as returned by S3. - - - - Initiates the asynchronous execution of the GetPublicAccessBlock operation. - - - Container for the necessary parameters to execute the GetPublicAccessBlock operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetPublicAccessBlock - operation. - - - - Finishes the asynchronous execution of the GetPublicAccessBlock operation. - - - The IAsyncResult returned by the call to BeginGetPublicAccessBlock. - - Returns a GetPublicAccessBlockResult from S3. - - - - This operation is useful to determine if a bucket exists and you have permission to - access it. The operation returns a 200 OK if the bucket exists and you - have permission to access it. Otherwise, the operation might return responses such - as 404 Not Found and 403 Forbidden. - - - - To use this operation, you must have permissions to perform the s3:ListBucket - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - Container for the necessary parameters to execute the HeadBucket service method. - - The response from the HeadBucket service method, as returned by S3. - - - - Initiates the asynchronous execution of the HeadBucket operation. - - - Container for the necessary parameters to execute the HeadBucket operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndHeadBucket - operation. - - - - Finishes the asynchronous execution of the HeadBucket operation. - - - The IAsyncResult returned by the call to BeginHeadBucket. - - Returns a HeadBucketResult from S3. - - - - This operation initiates a multipart upload and returns an upload ID. This upload - ID is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort operation - and Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload API and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart) and UploadPartCopy) requests must match the headers you - used in the request to initiate the upload by using CreateMultipartUpload. - - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, - kms:GenerateDataKey*, and kms:DescribeKey actions on the - key. These permissions are required because Amazon S3 must decrypt and read data from - the encrypted file parts before it completes the multipart upload. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - The following operations are related to CreateMultipartUpload: - - - - The name of the bucket to which to initiate the upload - Object key for which the multipart upload is to be initiated. - - The response from the InitiateMultipartUpload service method, as returned by S3. - - - - This operation initiates a multipart upload and returns an upload ID. This upload - ID is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort operation - and Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload API and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart) and UploadPartCopy) requests must match the headers you - used in the request to initiate the upload by using CreateMultipartUpload. - - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, - kms:GenerateDataKey*, and kms:DescribeKey actions on the - key. These permissions are required because Amazon S3 must decrypt and read data from - the encrypted file parts before it completes the multipart upload. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - The following operations are related to CreateMultipartUpload: - - - - Container for the necessary parameters to execute the InitiateMultipartUpload service method. - - The response from the InitiateMultipartUpload service method, as returned by S3. - - - - Initiates the asynchronous execution of the InitiateMultipartUpload operation. - - - Container for the necessary parameters to execute the InitiateMultipartUpload operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndInitiateMultipartUpload - operation. - - - - Finishes the asynchronous execution of the InitiateMultipartUpload operation. - - - The IAsyncResult returned by the call to BeginInitiateMultipartUpload. - - Returns a InitiateMultipartUploadResult from S3. - - - - Lists the analytics configurations for the bucket. You can have up to 1,000 analytics - configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. You should always check the IsTruncated element in the response. - If there are no more configurations to list, IsTruncated is set to false. - If there are more configurations to list, IsTruncated is set to true, - and there will be a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to ListBucketAnalyticsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketAnalyticsConfigurations service method. - - The response from the ListBucketAnalyticsConfigurations service method, as returned by S3. - - - - Initiates the asynchronous execution of the ListBucketAnalyticsConfigurations operation. - - - Container for the necessary parameters to execute the ListBucketAnalyticsConfigurations operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListBucketAnalyticsConfigurations - operation. - - - - Finishes the asynchronous execution of the ListBucketAnalyticsConfigurations operation. - - - The IAsyncResult returned by the call to BeginListBucketAnalyticsConfigurations. - - Returns a ListBucketAnalyticsConfigurationsResult from S3. - - - - Returns a list of inventory configurations for the bucket. You can have up to 1,000 - analytics configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory - - - - The following operations are related to ListBucketInventoryConfigurations: - - - - Container for the necessary parameters to execute the ListBucketInventoryConfigurations service method. - - The response from the ListBucketInventoryConfigurations service method, as returned by S3. - - - - Initiates the asynchronous execution of the ListBucketInventoryConfigurations operation. - - - Container for the necessary parameters to execute the ListBucketInventoryConfigurations operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListBucketInventoryConfigurations - operation. - - - - Finishes the asynchronous execution of the ListBucketInventoryConfigurations operation. - - - The IAsyncResult returned by the call to BeginListBucketInventoryConfigurations. - - Returns a ListBucketInventoryConfigurationsResult from S3. - - - - Lists the metrics configurations for the bucket. The metrics configurations are only - for the request metrics of the bucket and do not provide information on daily storage - metrics. You can have up to 1,000 configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For more information about metrics configurations and CloudWatch request metrics, - see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to ListBucketMetricsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketMetricsConfigurations service method. - - The response from the ListBucketMetricsConfigurations service method, as returned by S3. - - - - Initiates the asynchronous execution of the ListBucketMetricsConfigurations operation. - - - Container for the necessary parameters to execute the ListBucketMetricsConfigurations operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListBucketMetricsConfigurations - operation. - - - - Finishes the asynchronous execution of the ListBucketMetricsConfigurations operation. - - - The IAsyncResult returned by the call to BeginListBucketMetricsConfigurations. - - Returns a ListBucketMetricsConfigurationsResult from S3. - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - - The response from the ListBuckets service method, as returned by S3. - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - Container for the necessary parameters to execute the ListBuckets service method. - - The response from the ListBuckets service method, as returned by S3. - - - - Initiates the asynchronous execution of the ListBuckets operation. - - - Container for the necessary parameters to execute the ListBuckets operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListBuckets - operation. - - - - Finishes the asynchronous execution of the ListBuckets operation. - - - The IAsyncResult returned by the call to BeginListBuckets. - - Returns a ListBucketsResult from S3. - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - - The response from the ListMultipartUploads service method, as returned by S3. - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) - - The response from the ListMultipartUploads service method, as returned by S3. - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Container for the necessary parameters to execute the ListMultipartUploads service method. - - The response from the ListMultipartUploads service method, as returned by S3. - - - - Initiates the asynchronous execution of the ListMultipartUploads operation. - - - Container for the necessary parameters to execute the ListMultipartUploads operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListMultipartUploads - operation. - - - - Finishes the asynchronous execution of the ListMultipartUploads operation. - - - The IAsyncResult returned by the call to BeginListMultipartUploads. - - Returns a ListMultipartUploadsResult from S3. - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. - - The response from the ListObjects service method, as returned by S3. - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. - Limits the response to keys that begin with the specified prefix. - - The response from the ListObjects service method, as returned by S3. - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - Container for the necessary parameters to execute the ListObjects service method. - - The response from the ListObjects service method, as returned by S3. - - - - Initiates the asynchronous execution of the ListObjects operation. - - - Container for the necessary parameters to execute the ListObjects operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListObjects - operation. - - - - Finishes the asynchronous execution of the ListObjects operation. - - - The IAsyncResult returned by the call to BeginListObjects. - - Returns a ListObjectsResult from S3. - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Make sure to design - your application to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - To use this operation in an AWS Identity and Access Management (IAM) policy, you must - have permissions to perform the s3:ListBucket action. The bucket owner - has this permission by default and can grant this permission to others. For more information - about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - This section describes the latest revision of the API. We recommend that you use this - revised API for application development. For backward compatibility, Amazon S3 continues - to support the prior version of this API, ListObjects. - - - - To get a list of your buckets, see ListBuckets. - - - - The following operations are related to ListObjectsV2: - - - - Container for the necessary parameters to execute the ListObjectsV2 service method. - - The response from the ListObjectsV2 service method, as returned by S3. - - - - Initiates the asynchronous execution of the ListObjectsV2 operation. - - - Container for the necessary parameters to execute the ListObjectsV2 operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListObjectsV2 - operation. - - - - Finishes the asynchronous execution of the ListObjectsV2 operation. - - - The IAsyncResult returned by the call to BeginListObjectsV2. - - Returns a ListObjectsV2Result from S3. - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). This request returns a maximum of 1,000 - uploaded parts. The default number of parts returned is 1,000 parts. You can restrict - the number of parts returned by specifying the max-parts request parameter. - If your multipart upload consists of more than 1,000 parts, the response returns an - IsTruncated field with the value of true, and a NextPartNumberMarker - element. In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListParts: - - - - Name of the bucket to which the parts are being uploaded. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Object key for which the multipart upload was initiated. - Upload ID identifying the multipart upload whose parts are being listed. - - The response from the ListParts service method, as returned by S3. - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). This request returns a maximum of 1,000 - uploaded parts. The default number of parts returned is 1,000 parts. You can restrict - the number of parts returned by specifying the max-parts request parameter. - If your multipart upload consists of more than 1,000 parts, the response returns an - IsTruncated field with the value of true, and a NextPartNumberMarker - element. In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListParts: - - - - Container for the necessary parameters to execute the ListParts service method. - - The response from the ListParts service method, as returned by S3. - - - - Initiates the asynchronous execution of the ListParts operation. - - - Container for the necessary parameters to execute the ListParts operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListParts - operation. - - - - Finishes the asynchronous execution of the ListParts operation. - - - The IAsyncResult returned by the call to BeginListParts. - - Returns a ListPartsResult from S3. - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - - The response from the ListVersions service method, as returned by S3. - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes. - - The response from the ListVersions service method, as returned by S3. - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - Container for the necessary parameters to execute the ListVersions service method. - - The response from the ListVersions service method, as returned by S3. - - - - Initiates the asynchronous execution of the ListVersions operation. - - - Container for the necessary parameters to execute the ListVersions operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListVersions - operation. - - - - Finishes the asynchronous execution of the ListVersions operation. - - - The IAsyncResult returned by the call to BeginListVersions. - - Returns a ListVersionsResult from S3. - - - - - Initiates the asynchronous execution of the PutACL operation. - - - Container for the necessary parameters to execute the PutACL operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutACL - operation. - - - - Finishes the asynchronous execution of the PutACL operation. - - - The IAsyncResult returned by the call to BeginPutACL. - - Returns a PutACLResult from S3. - - - - Creates a new bucket. To create a bucket, you must register with Amazon S3 and have - a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed - to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information on bucket naming restrictions, - see Working - with Amazon S3 Buckets. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the EU (Ireland) - Region. For more information, see How - to Select a Region for Your Buckets. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - Hosting of Buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - The name of the bucket to create. - - The response from the PutBucket service method, as returned by S3. - - - - Creates a new bucket. To create a bucket, you must register with Amazon S3 and have - a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed - to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information on bucket naming restrictions, - see Working - with Amazon S3 Buckets. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the EU (Ireland) - Region. For more information, see How - to Select a Region for Your Buckets. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - Hosting of Buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - Container for the necessary parameters to execute the PutBucket service method. - - The response from the PutBucket service method, as returned by S3. - - - - Initiates the asynchronous execution of the PutBucket operation. - - - Container for the necessary parameters to execute the PutBucket operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucket - operation. - - - - Finishes the asynchronous execution of the PutBucket operation. - - - The IAsyncResult returned by the call to BeginPutBucket. - - Returns a PutBucketResult from S3. - - - - Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration - is a bucket-level feature that enables you to perform faster data transfers to Amazon - S3. - - - - To use this operation, you must have permission to perform the s3:PutAccelerateConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The Transfer Acceleration state of a bucket can be set to one of the following two - values: - -
  • - - Enabled – Enables accelerated data transfers to the bucket. - -
  • - - Suspended – Disables accelerated data transfers to the bucket. - -
- - The GetBucketAccelerateConfiguration operation returns the transfer acceleration - state of a bucket. - - - - After setting the Transfer Acceleration state of a bucket to Enabled, it might take - up to thirty minutes before the data transfer rates to the bucket increase. - - - - The name of the bucket used for Transfer Acceleration must be DNS-compliant and must - not contain periods ("."). - - - - For more information about transfer acceleration, see Transfer - Acceleration. - - - - The following operations are related to PutBucketAccelerateConfiguration: - - - - Container for the necessary parameters to execute the PutBucketAccelerateConfiguration service method. - - The response from the PutBucketAccelerateConfiguration service method, as returned by S3. - - - - Initiates the asynchronous execution of the PutBucketAccelerateConfiguration operation. - - - Container for the necessary parameters to execute the PutBucketAccelerateConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketAccelerateConfiguration - operation. - - - - Finishes the asynchronous execution of the PutBucketAccelerateConfiguration operation. - - - The IAsyncResult returned by the call to BeginPutBucketAccelerateConfiguration. - - Returns a PutBucketAccelerateConfigurationResult from S3. - - - - - Initiates the asynchronous execution of the PutBucketAnalyticsConfiguration operation. - - - Container for the necessary parameters to execute the PutBucketAnalyticsConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketAnalyticsConfiguration - operation. - - - - Finishes the asynchronous execution of the PutBucketAnalyticsConfiguration operation. - - - The IAsyncResult returned by the call to BeginPutBucketAnalyticsConfiguration. - - Returns a PutBucketAnalyticsConfigurationResult from S3. - - - - - Initiates the asynchronous execution of the PutBucketEncryption operation. - - - Container for the necessary parameters to execute the PutBucketEncryption operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketEncryption - operation. - - - - Finishes the asynchronous execution of the PutBucketEncryption operation. - - - The IAsyncResult returned by the call to BeginPutBucketEncryption. - - Returns a PutBucketEncryptionResult from S3. - - - - - Initiates the asynchronous execution of the PutBucketInventoryConfiguration operation. - - - Container for the necessary parameters to execute the PutBucketInventoryConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketInventoryConfiguration - operation. - - - - Finishes the asynchronous execution of the PutBucketInventoryConfiguration operation. - - - The IAsyncResult returned by the call to BeginPutBucketInventoryConfiguration. - - Returns a PutBucketInventoryConfigurationResult from S3. - - - - Set the logging parameters for a bucket and to specify permissions for who can view - and modify the logging parameters. All logs are saved to buckets in the same AWS Region - as the source bucket. To set the logging status of a bucket, you must be the bucket - owner. - - - - The bucket owner is automatically granted FULL_CONTROL to all logs. You use the Grantee - request element to grant access to other people. The Permissions request - element specifies the kind of access the grantee has to the logs. - - - - Grantee Values - - - - You can specify the person (grantee) to whom you're assigning access rights (using - request elements) in the following ways: - -
  • - - By the person's ID: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> - </Grantee> - - - - DisplayName is optional and ignored in the request. - -
  • - - By Email address: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee> - - - - - The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl - request, appears as the CanonicalUser. - -
  • - - By URI: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee> - - -
- - To enable logging, you use LoggingEnabled and its children request elements. To disable - logging, you use an empty BucketLoggingStatus request element: - - - - <BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01" /> - - - - - For more information about server access logging, see Server - Access Logging. - - - - For more information about creating a bucket, see CreateBucket. For more information - about returning the logging status of a bucket, see GetBucketLogging. - - - - The following operations are related to PutBucketLogging: - - - - Container for the necessary parameters to execute the PutBucketLogging service method. - - The response from the PutBucketLogging service method, as returned by S3. - - - - Initiates the asynchronous execution of the PutBucketLogging operation. - - - Container for the necessary parameters to execute the PutBucketLogging operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketLogging - operation. - - - - Finishes the asynchronous execution of the PutBucketLogging operation. - - - The IAsyncResult returned by the call to BeginPutBucketLogging. - - Returns a PutBucketLoggingResult from S3. - - - - Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. - You can have up to 1,000 metrics configurations per bucket. If you're updating an - existing metrics configuration, note that this is a full replacement of the existing - metrics configuration. If you don't include the elements you want to keep, they are - erased. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to PutBucketMetricsConfiguration: - - - - GetBucketLifecycle has the following special error: - -
  • - - Error code: TooManyConfigurations - -
    • - - Description: You are attempting to create a new configuration but have already reached - the 1,000-configuration limit. - -
    • - - HTTP Status Code: HTTP 400 Bad Request - -
- - Container for the necessary parameters to execute the PutBucketMetricsConfiguration service method. - - The response from the PutBucketMetricsConfiguration service method, as returned by S3. - - - - Initiates the asynchronous execution of the PutBucketMetricsConfiguration operation. - - - Container for the necessary parameters to execute the PutBucketMetricsConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketMetricsConfiguration - operation. - - - - Finishes the asynchronous execution of the PutBucketMetricsConfiguration operation. - - - The IAsyncResult returned by the call to BeginPutBucketMetricsConfiguration. - - Returns a PutBucketMetricsConfigurationResult from S3. - - - - Enables notifications of specified events for a bucket. For more information about - event notifications, see Configuring - Event Notifications. - - - - Using this API, you can replace an existing notification configuration. The configuration - is an XML file that defines the event types that you want Amazon S3 to publish and - the destination where you want Amazon S3 to publish an event notification when it - detects an event of the specified type. - - - - By default, your bucket has no event notifications configured. That is, the notification - configuration will be an empty NotificationConfiguration. - - - - <NotificationConfiguration> - - - - </NotificationConfiguration> - - - - This operation replaces the existing notification configuration with the configuration - you include in the request body. - - - - After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification - Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, - and that the bucket owner has permission to publish to it by sending a test notification. - In the case of AWS Lambda destinations, Amazon S3 verifies that the Lambda function - permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. - For more information, see Configuring - Notifications for Amazon S3 Events. - - - - You can disable notifications by adding the empty NotificationConfiguration element. - - - - By default, only the bucket owner can configure notifications on a bucket. However, - bucket owners can use a bucket policy to grant permission to other users to set this - configuration with s3:PutBucketNotification permission. - - - - The PUT notification is an atomic operation. For example, suppose your notification - configuration includes SNS topic, SQS queue, and Lambda function configurations. When - you send a PUT request with this configuration, Amazon S3 sends test messages to your - SNS topic. If the message fails, the entire PUT operation will fail, and Amazon S3 - will not add the configuration to your bucket. - - - - Responses - - - - If the configuration in the request body includes only one TopicConfiguration - specifying only the s3:ReducedRedundancyLostObject event type, the response - will also include the x-amz-sns-test-message-id header containing the - message ID of the test notification sent to the topic. - - - - The following operation is related to PutBucketNotificationConfiguration: - - - - Container for the necessary parameters to execute the PutBucketNotification service method. - - The response from the PutBucketNotification service method, as returned by S3. - - - - Initiates the asynchronous execution of the PutBucketNotification operation. - - - Container for the necessary parameters to execute the PutBucketNotification operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketNotification - operation. - - - - Finishes the asynchronous execution of the PutBucketNotification operation. - - - The IAsyncResult returned by the call to BeginPutBucketNotification. - - Returns a PutBucketNotificationResult from S3. - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - - The response from the PutBucketPolicy service method, as returned by S3. - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - The MD5 hash of the request body. - - The response from the PutBucketPolicy service method, as returned by S3. - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - Container for the necessary parameters to execute the PutBucketPolicy service method. - - The response from the PutBucketPolicy service method, as returned by S3. - - - - Initiates the asynchronous execution of the PutBucketPolicy operation. - - - Container for the necessary parameters to execute the PutBucketPolicy operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketPolicy - operation. - - - - Finishes the asynchronous execution of the PutBucketPolicy operation. - - - The IAsyncResult returned by the call to BeginPutBucketPolicy. - - Returns a PutBucketPolicyResult from S3. - - - - Creates a replication configuration or replaces an existing one. For more information, - see Replication - in the Amazon S3 Developer Guide. - - - - To perform this operation, the user or role performing the operation must have the - iam:PassRole - permission. - - - - Specify the replication configuration in the request body. In the replication configuration, - you provide the name of the destination bucket where you want Amazon S3 to replicate - objects, the IAM role that Amazon S3 can assume to replicate objects on your behalf, - and other relevant information. - - - - A replication configuration must include at least one rule, and can contain a maximum - of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects - in the source bucket. To choose additional subsets of objects to replicate, add a - rule for each subset. All rules must specify the same destination bucket. - - - - To specify a subset of the objects in the source bucket to apply a replication rule - to, add the Filter element as a child of the Rule element. You can filter objects - based on an object key prefix, one or more object tags, or both. When you add the - Filter element in the configuration, you must also add the following elements: DeleteMarkerReplication, - Status, and Priority. - - - - For information about enabling versioning on a bucket, see Using - Versioning. - - - - By default, a resource owner, in this case the AWS account that created the bucket, - can perform this operation. The resource owner can also grant others permissions to - perform the operation. For more information about permissions, see Specifying - Permissions in a Policy and Managing - Access Permissions to Your Amazon S3 Resources. - - - - Handling Replication of Encrypted Objects - - - - By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side - encryption with CMKs stored in AWS KMS. To replicate AWS KMS-encrypted objects, add - the following: SourceSelectionCriteria, SseKmsEncryptedObjects, - Status, EncryptionConfiguration, and ReplicaKmsKeyID. - For information about replication configuration, see Replicating - Objects Created with SSE Using CMKs stored in AWS KMS. - - - - For information on PutBucketReplication errors, see ReplicationErrorCodeList - - - - - The following operations are related to PutBucketReplication: - - - - Container for the necessary parameters to execute the PutBucketReplication service method. - - The response from the PutBucketReplication service method, as returned by S3. - - - - Initiates the asynchronous execution of the PutBucketReplication operation. - - - Container for the necessary parameters to execute the PutBucketReplication operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketReplication - operation. - - - - Finishes the asynchronous execution of the PutBucketReplication operation. - - - The IAsyncResult returned by the call to BeginPutBucketReplication. - - Returns a PutBucketReplicationResult from S3. - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - The bucket name. - Container for Payer. - - The response from the PutBucketRequestPayment service method, as returned by S3. - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - Container for the necessary parameters to execute the PutBucketRequestPayment service method. - - The response from the PutBucketRequestPayment service method, as returned by S3. - - - - Initiates the asynchronous execution of the PutBucketRequestPayment operation. - - - Container for the necessary parameters to execute the PutBucketRequestPayment operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketRequestPayment - operation. - - - - Finishes the asynchronous execution of the PutBucketRequestPayment operation. - - - The IAsyncResult returned by the call to BeginPutBucketRequestPayment. - - Returns a PutBucketRequestPaymentResult from S3. - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging. - - - - Within a bucket, if you add a tag that has the same key as an existing tag, the new - value overwrites the old value. For more information, see Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional operation is currently in progress against - this resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - The bucket name. - A property of PutBucketTaggingRequest used to execute the PutBucketTagging service method. - - The response from the PutBucketTagging service method, as returned by S3. - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging. - - - - Within a bucket, if you add a tag that has the same key as an existing tag, the new - value overwrites the old value. For more information, see Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional operation is currently in progress against - this resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - Container for the necessary parameters to execute the PutBucketTagging service method. - - The response from the PutBucketTagging service method, as returned by S3. - - - - Initiates the asynchronous execution of the PutBucketTagging operation. - - - Container for the necessary parameters to execute the PutBucketTagging operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketTagging - operation. - - - - Finishes the asynchronous execution of the PutBucketTagging operation. - - - The IAsyncResult returned by the call to BeginPutBucketTagging. - - Returns a PutBucketTaggingResult from S3. - - - - - Initiates the asynchronous execution of the PutBucketVersioning operation. - - - Container for the necessary parameters to execute the PutBucketVersioning operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketVersioning - operation. - - - - Finishes the asynchronous execution of the PutBucketVersioning operation. - - - The IAsyncResult returned by the call to BeginPutBucketVersioning. - - Returns a PutBucketVersioningResult from S3. - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT operation requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - The bucket name. - Container for the request. - - The response from the PutBucketWebsite service method, as returned by S3. - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT operation requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - Container for the necessary parameters to execute the PutBucketWebsite service method. - - The response from the PutBucketWebsite service method, as returned by S3. - - - - Initiates the asynchronous execution of the PutBucketWebsite operation. - - - Container for the necessary parameters to execute the PutBucketWebsite operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketWebsite - operation. - - - - Finishes the asynchronous execution of the PutBucketWebsite operation. - - - The IAsyncResult returned by the call to BeginPutBucketWebsite. - - Returns a PutBucketWebsiteResult from S3. - - - - - - Initiates the asynchronous execution of the PutCORSConfiguration operation. - - - Container for the necessary parameters to execute the PutCORSConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutCORSConfiguration - operation. - - - - Finishes the asynchronous execution of the PutCORSConfiguration operation. - - - The IAsyncResult returned by the call to BeginPutCORSConfiguration. - - Returns a PutCORSConfigurationResult from S3. - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - The name of the bucket for which to set the configuration. - A property of PutLifecycleConfigurationRequest used to execute the PutLifecycleConfiguration service method. - - The response from the PutLifecycleConfiguration service method, as returned by S3. - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - Container for the necessary parameters to execute the PutLifecycleConfiguration service method. - - The response from the PutLifecycleConfiguration service method, as returned by S3. - - - - Initiates the asynchronous execution of the PutLifecycleConfiguration operation. - - - Container for the necessary parameters to execute the PutLifecycleConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutLifecycleConfiguration - operation. - - - - Finishes the asynchronous execution of the PutLifecycleConfiguration operation. - - - The IAsyncResult returned by the call to BeginPutLifecycleConfiguration. - - Returns a PutLifecycleConfigurationResult from S3. - - - - - Initiates the asynchronous execution of the PutObject operation. - - - Container for the necessary parameters to execute the PutObject operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutObject - operation. - - - - Finishes the asynchronous execution of the PutObject operation. - - - The IAsyncResult returned by the call to BeginPutObject. - - Returns a PutObjectResult from S3. - - - - - Initiates the asynchronous execution of the PutObjectLegalHold operation. - - - Container for the necessary parameters to execute the PutObjectLegalHold operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutObjectLegalHold - operation. - - - - Finishes the asynchronous execution of the PutObjectLegalHold operation. - - - The IAsyncResult returned by the call to BeginPutObjectLegalHold. - - Returns a PutObjectLegalHoldResult from S3. - - - - - Initiates the asynchronous execution of the PutObjectLockConfiguration operation. - - - Container for the necessary parameters to execute the PutObjectLockConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutObjectLockConfiguration - operation. - - - - Finishes the asynchronous execution of the PutObjectLockConfiguration operation. - - - The IAsyncResult returned by the call to BeginPutObjectLockConfiguration. - - Returns a PutObjectLockConfigurationResult from S3. - - - - - Initiates the asynchronous execution of the PutObjectRetention operation. - - - Container for the necessary parameters to execute the PutObjectRetention operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutObjectRetention - operation. - - - - Finishes the asynchronous execution of the PutObjectRetention operation. - - - The IAsyncResult returned by the call to BeginPutObjectRetention. - - Returns a PutObjectRetentionResult from S3. - - - - - Initiates the asynchronous execution of the PutObjectTagging operation. - - - Container for the necessary parameters to execute the PutObjectTagging operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutObjectTagging - operation. - - - - Finishes the asynchronous execution of the PutObjectTagging operation. - - - The IAsyncResult returned by the call to BeginPutObjectTagging. - - Returns a PutObjectTaggingResult from S3. - - - - - Initiates the asynchronous execution of the PutPublicAccessBlock operation. - - - Container for the necessary parameters to execute the PutPublicAccessBlock operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutPublicAccessBlock - operation. - - - - Finishes the asynchronous execution of the PutPublicAccessBlock operation. - - - The IAsyncResult returned by the call to BeginPutPublicAccessBlock. - - Returns a PutPublicAccessBlockResult from S3. - - - - - - - - - Initiates the asynchronous execution of the RestoreObject operation. - - - Container for the necessary parameters to execute the RestoreObject operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRestoreObject - operation. - - - - Finishes the asynchronous execution of the RestoreObject operation. - - - The IAsyncResult returned by the call to BeginRestoreObject. - - Returns a RestoreObjectResult from S3. - - - - - Initiates the asynchronous execution of the SelectObjectContent operation. - - - Container for the necessary parameters to execute the SelectObjectContent operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSelectObjectContent - operation. - - - - Finishes the asynchronous execution of the SelectObjectContent operation. - - - The IAsyncResult returned by the call to BeginSelectObjectContent. - - Returns a SelectObjectContentResult from S3. - - - - - Initiates the asynchronous execution of the UploadPart operation. - - - Container for the necessary parameters to execute the UploadPart operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUploadPart - operation. - - - - Finishes the asynchronous execution of the UploadPart operation. - - - The IAsyncResult returned by the call to BeginUploadPart. - - Returns a UploadPartResult from S3. - - - - Configuration for accessing AmazonS3 service - - - Configuration for accessing Amazon S3 service - - - - - When true, requests will always use path style addressing. - - - - - Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. - To use this feature, the bucket name should be DNS compliant names and should not contain periods (.). - The following APIs are not supported and are sent to the regular region endpoint, even if this option is enabled: -
    -
  1. PutBucket
    2. -
  2. ListBuckets
    3. -
  3. DeleteBucket
    4. -
- - - This option cannot be used at the same time as UseDualstackEndpoint. - - - - - If set to true and the service package supports it the region identified in the arn for a resource - will be used when making the service request. - - - - - USEast1RegionalEndpointValue determines wheter or not - to send the us-east-1 s3 requests to the regional endpoint or to - the legacy global endpoint. - This flags takes precedence over the AWS_S3_US_EAST_1_REGIONAL_ENDPOINT - environment variable and the credential file. - - - - - This method contains custom initializations for the config object. - - - - - Given this client configuration, returns the service url - - The service url in the form of a string - - - - If the client is configured to hit us-east-1 with the S3UsEast1RegionalEndpointValue flag not set, - this method checks whether the environment variable is present or the credential file contains a valid value - - A Nullable of S3UsEast1RegionalEndpointValue representing the client configuration for the regional us-east-1 endpoint - - - - Validate that the config object is properly configured. - - - - - Checks the AWS_S3_US_EAST_1_REGIONAL_ENDPOINT environment variable for the presence of the s3 regional flag - - A nullable of S3UsEast1RegionalEndpointValue - - - - Checks the credential file for the presence of the s3 regional flag - - A nullable of S3UsEast1RegionalEndpointValue - - - - Default constructor - - - - - The constant used to lookup in the region hash the endpoint. - - - - - Gets the ServiceVersion property. - - - - - Gets the value of UserAgent property. - - - - - Base exception for S3 errors. - - - - - Construct an instance of AmazonS3Exception - - - - - - Construct an instance of AmazonS3Exception - - - - - - - Construct an instance of AmazonS3Exception - - - - - - Construct an instance of AmazonS3Exception - - - - - - - - - - Construct an instance of AmazonS3Exception - - - - - - - - - - - Construct an instance of AmazonS3Exception - - - - - - - - - - - - Construct an instance of AmazonS3Exception - - - - - - - - - - - - - A special token that helps AWS troubleshoot problems. - - - - - A special token that helps AWS troubleshoot S3 accelerate problems. - - - - - The entire response body for this exception, if available. - - - - - The region that the AmazonS3Exception relates to. - - - - - Gets the exception message. - - - - - Constructs a new instance of the AmazonS3Exception class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - Extensions methods added to Amazon.Arn type to help parse S3 specific resources from the ARN. - - - - - Attempt to parse the resource component of the ARN into access point resource name. - - An AWS ARN to parse - The access point resouce identifier found in the ARN. - True if the ARN contains an access point resource identifier. - - - - Attempt to parse the resource component of the ARN into bucket name. - - An AWS ARN to parse - The bucket name found in the ARN. - True if the ARN contains a bucket name. - - - - This class extends the AmazonS3Client and provides client side encryption when reading or writing S3 objects. - - - - - Constructs AmazonS3EncryptionClient with the Encryption materials and credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Constructs AmazonS3EncryptionClient with the Encryption materials and credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - - The region to connect. - - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Constructs AmazonS3EncryptionClient with the Encryption materials, - AmazonS3 CryptoConfiguration object and credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - - The AmazonS3EncryptionClient CryptoConfiguration Object - - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Constructs AmazonS3EncryptionClient with AWS Credentials and Encryption materials. - - - The encryption materials to be used to encrypt and decrypt envelope key. - - AWS Credentials - - - - Constructs AmazonS3EncryptionClient with AWS Credentials, Region and Encryption materials - - AWS Credentials - The region to connect. - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Constructs AmazonS3EncryptionClient with AWS Credentials, AmazonS3CryptoConfiguration Configuration object - and Encryption materials - - AWS Credentials - The AmazonS3EncryptionClient CryptoConfiguration Object - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Constructs AmazonS3EncryptionClient with AWS Access Key ID, - AWS Secret Key and Encryption materials - - AWS Access Key ID - AWS Secret Access Key - The encryption materials to be used to encrypt and decrypt envelope key. - - - - Constructs AmazonS3EncryptionClient with AWS Access Key ID, - AWS Secret Key, Region and Encryption materials - - AWS Access Key ID - AWS Secret Access Key - The region to connect. - The encryption materials to be used to encrypt and decrypt envelope key. - - - - Constructs AmazonS3EncryptionClient with AWS Access Key ID, Secret Key, - AmazonS3 CryptoConfiguration object and Encryption materials. - - AWS Access Key ID - AWS Secret Access Key - The AmazonS3EncryptionClient CryptoConfiguration Object - The encryption materials to be used to encrypt and decrypt envelope key. - - - - Constructs AmazonS3EncryptionClient with AWS Access Key ID, Secret Key, - SessionToken and Encryption materials. - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Constructs AmazonS3EncryptionClient with AWS Access Key ID, Secret Key, - SessionToken, Region and Encryption materials. - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - The region to connect. - The encryption materials to be used to encrypt and decrypt envelope key. - - - - Constructs AmazonS3EncryptionClient with AWS Access Key ID, Secret Key, SessionToken - AmazonS3EncryptionClient CryptoConfiguration object and Encryption materials. - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - The AmazonS3EncryptionClient CryptoConfiguration Object - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Turn off response logging because it will interfere with decrypt of the data coming back from S3. - - - - - Customize the pipeline to allow encryption. - - - - - - Dispose this instance - - - - - - AmazonS3CryptoConfiguration allows customers - to set storage mode for encryption credentials - - - - - Default Constructor. - - - - - Gets and sets the StorageMode property. This determines if the crypto metadata is stored as metadata on the object or as a separate object in S3. - The default is ObjectMetadata. - - - - - Mode for string the encryption information for an object. - - - - - Store the information in a separate S3 Object. - - - - - Store the information as metadata on the encrypted object. - - - - - Encryption Instructions store the encryption credentials - - - - - Construct an instance EncryptionInstructions. - - - - - - - - - Construct an instance EncryptionInstructions. - - - - - - - - The "key encrypting key" materials used in encrypt/decryption. - These materials may be an asymmetric key, a symmetric key, or a KMS key ID. - - - - - Constructs a new EncryptionMaterials object, storing an asymmetric key. - - - - - - Constructs a new EncryptionMaterials object, storing a symmetric key. - - - - - - Constructs a new EncryptionMaterials object, storing a KMS Key ID - - - - - - The EncryptionUtils class encrypts and decrypts data stored in S3. - It can be used to prepare requests for encryption before they are stored in S3 - and to decrypt objects that are retrieved from S3. - - - - - Decrypts an encrypted Envelope key using the provided encryption materials - and returns it in raw byte array form. - - Encrypted envelope key - Encryption materials needed to decrypt the encrypted envlelope key - - - - - Returns an updated stream where the stream contains the encrypted object contents. - The specified instruction will be used to encrypt data. - - - The stream whose contents are to be encrypted. - - - The instruction that will be used to encrypt the object data. - - - Encrypted stream, i.e input stream wrapped into encrypted stream - - - - - Returns an updated input stream where the input stream contains the encrypted object contents. - The specified instruction will be used to encrypt data. - - - The stream whose contents are to be encrypted. - - - The instruction that will be used to encrypt the object data. - - - Encrypted stream, i.e input stream wrapped into encrypted stream - - - - - Updates object where the object - input stream contains the decrypted contents. - - - The getObject response whose contents are to be decrypted. - - - The instruction that will be used to encrypt the object data. - - - - - Generates an instruction that will be used to encrypt an object - using materials with the KMSKeyID set. - - - Used to call KMS to generate a data key. - - - The encryption materials to be used to encrypt and decrypt data. - - - The instruction that will be used to encrypt an object. - - - - - Generates an instruction that will be used to encrypt an object - using materials with the AsymmetricProvider or SymmetricProvider set. - - - The encryption materials to be used to encrypt and decrypt data. - - - The instruction that will be used to encrypt an object. - - - - - Builds an instruction object from the object metadata. - - - A non-null object response that contains encryption information in its metadata. - - - The non-null encryption materials to be used to encrypt and decrypt Envelope key. - - - The decrypted envelope key to be use if KMS key wrapping is being used. Or null if non-KMS key wrapping is being used. - - - - - - - Builds an instruction object from the instruction file. - - Instruction file GetObject response - - The non-null encryption materials to be used to encrypt and decrypt Envelope key. - - - A non-null instruction object containing encryption information. - - - - - Update the request's ObjectMetadata with the necessary information for decrypting the object. - - - AmazonWebServiceRequest encrypted using the given instruction - - - Non-null instruction used to encrypt the data in this AmazonWebServiceRequest . - - - If true use V2 metadata format, otherwise use V1. - - - - - Adds UnEncrypted content length to object metadata - - - - - - checks if encryption credentials are in object metadata - - Response of the object - - - - - checks if encryption credentials are in the instructionfile - - Instruction file response that contains encryption information - - - - - Custom the pipeline handler to decrypt objects. - - - - - Construct instance of SetupDecryptionHandler. - - - - - - Gets the EncryptionClient property which is the AmazonS3EncryptionClient that is decrypting the object. - - - - - Calls the post invoke logic after calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Decrypt the object being downloaded. - - - - - - Calls the PostInvoke methods after calling the next handler - in the pipeline. - - The execution context, it contains the - request and response context. - - - - Decrypt the object being downloaded. - - - - - - - Updates object where the object input stream contains the decrypted contents. - - - The getObject response of InstructionFile. - - - The getObject response whose contents are to be decrypted. - - - - - Updates object where the object input stream contains the decrypted contents. - - - The getObject response whose contents are to be decrypted. - - - The decrypted envelope key to be use if KMS key wrapping is being used. Or null if non-KMS key wrapping is being used. - - - - - Custom pipeline handler to encrypt the data as it is being uploaded to S3. - - - - - Construct an instance SetupEncryptionHandler. - - - - - - Gets the EncryptionClient property which is the AmazonS3EncryptionClient that is encrypting the object. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Encrypts the S3 object being uploaded. - - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - IAsyncResult which represent an async operation. - - - - Make sure that the storage mode and encryption materials are compatible. - The client only supports KMS key wrapping in metadata storage mode. - - - - - Updates the request where the metadata contains encryption information - and the input stream contains the encrypted object contents. - - - The request whose contents are to be encrypted. - - - - - Updates the request where the instruction file contains encryption information - and the input stream contains the encrypted object contents. - - - - - - Updates the request where the input stream contains the encrypted object contents. - - - - - - Adds the crypto token to the user agent - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - IAsyncResult which represent an async operation. - - - - Customize the user agent. - - - - - - Interface for accessing S3 - - - - - - - Create a signed URL allowing access to a resource that would - usually require authentication. - - - - When using query string authentication you create a query, - specify an expiration time for the query, sign it with your - signature, place the data in an HTTP request, and distribute - the request to a user or embed the request in a web page. - - - A PreSigned URL can be generated for GET, PUT, DELETE and HEAD - operations on your bucketName, keys, and versions. - - - The GetPreSignedUrlRequest that defines the - parameters of the operation. - A string that is the signed http request. - - - - - - This operation aborts a multipart upload. After a multipart upload is aborted, no - additional parts can be uploaded using that upload ID. The storage consumed by any - previously uploaded parts will be freed. However, if any part uploads are currently - in progress, those part uploads might or might not succeed. As a result, it might - be necessary to abort a given multipart upload multiple times in order to completely - free all storage consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts operation and ensure that the parts - list is empty. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - The bucket name to which the upload was taking place. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object for which the multipart upload was initiated. - Upload ID that identifies the multipart upload. - - The response from the AbortMultipartUpload service method, as returned by S3. - - - - This operation aborts a multipart upload. After a multipart upload is aborted, no - additional parts can be uploaded using that upload ID. The storage consumed by any - previously uploaded parts will be freed. However, if any part uploads are currently - in progress, those part uploads might or might not succeed. As a result, it might - be necessary to abort a given multipart upload multiple times in order to completely - free all storage consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts operation and ensure that the parts - list is empty. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - Container for the necessary parameters to execute the AbortMultipartUpload service method. - - The response from the AbortMultipartUpload service method, as returned by S3. - - - - Initiates the asynchronous execution of the AbortMultipartUpload operation. - - - Container for the necessary parameters to execute the AbortMultipartUpload operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAbortMultipartUpload - operation. - - - - Finishes the asynchronous execution of the AbortMultipartUpload operation. - - - The IAsyncResult returned by the call to BeginAbortMultipartUpload. - - Returns a AbortMultipartUploadResult from S3. - - - - Completes a multipart upload by assembling previously uploaded parts. - - - - You first initiate the multipart upload and then upload all parts using the UploadPart - operation. After successfully uploading all relevant parts of an upload, you call - this operation to complete the upload. Upon receiving this request, Amazon S3 concatenates - all the parts in ascending order by part number to create a new object. In the Complete - Multipart Upload request, you must provide the parts list. You must ensure that the - parts list is complete. This operation concatenates the parts that you provide in - the list. For each part in the list, you must provide the part number and the ETag - value, returned after that part was uploaded. - - - - Processing of a Complete Multipart Upload request could take several minutes to complete. - After Amazon S3 begins processing the request, it sends an HTTP response header that - specifies a 200 OK response. While processing is in progress, Amazon S3 periodically - sends white space characters to keep the connection from timing out. Because a request - could fail after the initial 200 OK response has been sent, it is important that you - check the response body to determine whether the request succeeded. - - - - Note that if CompleteMultipartUpload fails, applications should be prepared - to retry the failed requests. For more information, see Amazon - S3 Error Best Practices. - - - - For more information about multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - GetBucketLifecycle has the following special errors: - -
  • - - Error code: EntityTooSmall - -
    • - - Description: Your proposed upload is smaller than the minimum allowed object size. - Each part must be at least 5 MB in size, except the last part. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPart - -
    • - - Description: One or more of the specified parts could not be found. The part might - not have been uploaded, or the specified entity tag might not have matched the part's - entity tag. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPartOrder - -
    • - - Description: The list of parts was not in ascending order. The parts list must be - specified in order by part number. - -
    • - - 400 Bad Request - -
  • - - Error code: NoSuchUpload - -
    • - - Description: The specified multipart upload does not exist. The upload ID might be - invalid, or the multipart upload might have been aborted or completed. - -
    • - - 404 Not Found - -
- - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the CompleteMultipartUpload service method. - - The response from the CompleteMultipartUpload service method, as returned by S3. - - - - Initiates the asynchronous execution of the CompleteMultipartUpload operation. - - - Container for the necessary parameters to execute the CompleteMultipartUpload operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCompleteMultipartUpload - operation. - - - - Finishes the asynchronous execution of the CompleteMultipartUpload operation. - - - The IAsyncResult returned by the call to BeginCompleteMultipartUpload. - - Returns a CompleteMultipartUploadResult from S3. - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - for copying an object greater than 5 GB, you must use the multipart upload Upload - Part - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - Amazon S3 transfer acceleration does not support cross-region copies. If you request - a cross-region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information about transfer acceleration, see Transfer - Acceleration. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - request parameters x-amz-copy-source-if-match, x-amz-copy-source-if-none-match, - x-amz-copy-source-if-unmodified-since, or x-amz-copy-source-if-modified-since. - - - - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - You can use this operation to change the storage class of an object that is already - stored in Amazon S3 using the StorageClass parameter. For more information, - see Storage - Classes. - - - - The source object that you are copying can be encrypted or unencrypted. If the source - object is encrypted, it can be encrypted by server-side encryption using AWS managed - encryption keys or by using a customer-provided encryption key. When copying an object, - you can request that Amazon S3 encrypt the target object by using either the AWS managed - encryption keys or by using your own encryption key. You can do this regardless of - the form of server-side encryption that was used to encrypt the source, or even if - the source object was not encrypted. For more information about server-side encryption, - see Using - Server-Side Encryption. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
    • - - x-amz-copy-source-if-match condition evaluates to true - -
    • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
  • - - Consideration 2 – If both of the x-amz-copy-source-if-none-match and - x-amz-copy-source-if-modified-since headers are present in the request - and evaluate as follows, Amazon S3 returns the 412 Precondition Failed - response code: - -
    • - - x-amz-copy-source-if-none-match condition evaluates to false - -
    • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - The copy request charge is based on the storage class and Region you specify for the - destination object. For pricing information, see Amazon - S3 Pricing. - - - - Following are other considerations when using CopyObject: - -
Versioning
- - By default, x-amz-copy-source identifies the current version of an object - to copy. (If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted.) To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - To encrypt the target object, you must provide the appropriate encryption-related - request headers. The one you use depends on whether you want to use AWS managed encryption - keys or provide your own encryption key. - -
  • - - To encrypt the target object using server-side encryption with an AWS managed encryption - key, provide the following request headers, as appropriate. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. If you want to use a customer managed AWS KMS - CMK, you must provide the x-amz-server-side-encryption-aws-kms-key-id - of the symmetric customer managed CMK. Amazon S3 only supports symmetric CMKs and - not asymmetric CMKs. For more information, see Using - Symmetric and Asymmetric Keys in the AWS Key Management Service Developer Guide. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in KMS. - -
  • - - To encrypt the target object using server-side encryption with an encryption key that - you provide, use the following headers. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
  • - - If the source object is encrypted using server-side encryption with customer-provided - encryption keys, you must use the following headers. - -
    • - - x-amz-copy-source​-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-copy-source​-server-side​-encryption​-customer-key - -
    • - - x-amz-copy-source-​server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in Amazon KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - The response from the CopyObject service method, as returned by S3. - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - for copying an object greater than 5 GB, you must use the multipart upload Upload - Part - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - Amazon S3 transfer acceleration does not support cross-region copies. If you request - a cross-region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information about transfer acceleration, see Transfer - Acceleration. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - request parameters x-amz-copy-source-if-match, x-amz-copy-source-if-none-match, - x-amz-copy-source-if-unmodified-since, or x-amz-copy-source-if-modified-since. - - - - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - You can use this operation to change the storage class of an object that is already - stored in Amazon S3 using the StorageClass parameter. For more information, - see Storage - Classes. - - - - The source object that you are copying can be encrypted or unencrypted. If the source - object is encrypted, it can be encrypted by server-side encryption using AWS managed - encryption keys or by using a customer-provided encryption key. When copying an object, - you can request that Amazon S3 encrypt the target object by using either the AWS managed - encryption keys or by using your own encryption key. You can do this regardless of - the form of server-side encryption that was used to encrypt the source, or even if - the source object was not encrypted. For more information about server-side encryption, - see Using - Server-Side Encryption. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
    • - - x-amz-copy-source-if-match condition evaluates to true - -
    • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
  • - - Consideration 2 – If both of the x-amz-copy-source-if-none-match and - x-amz-copy-source-if-modified-since headers are present in the request - and evaluate as follows, Amazon S3 returns the 412 Precondition Failed - response code: - -
    • - - x-amz-copy-source-if-none-match condition evaluates to false - -
    • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - The copy request charge is based on the storage class and Region you specify for the - destination object. For pricing information, see Amazon - S3 Pricing. - - - - Following are other considerations when using CopyObject: - -
Versioning
- - By default, x-amz-copy-source identifies the current version of an object - to copy. (If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted.) To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - To encrypt the target object, you must provide the appropriate encryption-related - request headers. The one you use depends on whether you want to use AWS managed encryption - keys or provide your own encryption key. - -
  • - - To encrypt the target object using server-side encryption with an AWS managed encryption - key, provide the following request headers, as appropriate. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. If you want to use a customer managed AWS KMS - CMK, you must provide the x-amz-server-side-encryption-aws-kms-key-id - of the symmetric customer managed CMK. Amazon S3 only supports symmetric CMKs and - not asymmetric CMKs. For more information, see Using - Symmetric and Asymmetric Keys in the AWS Key Management Service Developer Guide. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in KMS. - -
  • - - To encrypt the target object using server-side encryption with an encryption key that - you provide, use the following headers. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
  • - - If the source object is encrypted using server-side encryption with customer-provided - encryption keys, you must use the following headers. - -
    • - - x-amz-copy-source​-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-copy-source​-server-side​-encryption​-customer-key - -
    • - - x-amz-copy-source-​server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in Amazon KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - The response from the CopyObject service method, as returned by S3. - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - for copying an object greater than 5 GB, you must use the multipart upload Upload - Part - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - Amazon S3 transfer acceleration does not support cross-region copies. If you request - a cross-region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information about transfer acceleration, see Transfer - Acceleration. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - request parameters x-amz-copy-source-if-match, x-amz-copy-source-if-none-match, - x-amz-copy-source-if-unmodified-since, or x-amz-copy-source-if-modified-since. - - - - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - You can use this operation to change the storage class of an object that is already - stored in Amazon S3 using the StorageClass parameter. For more information, - see Storage - Classes. - - - - The source object that you are copying can be encrypted or unencrypted. If the source - object is encrypted, it can be encrypted by server-side encryption using AWS managed - encryption keys or by using a customer-provided encryption key. When copying an object, - you can request that Amazon S3 encrypt the target object by using either the AWS managed - encryption keys or by using your own encryption key. You can do this regardless of - the form of server-side encryption that was used to encrypt the source, or even if - the source object was not encrypted. For more information about server-side encryption, - see Using - Server-Side Encryption. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
    • - - x-amz-copy-source-if-match condition evaluates to true - -
    • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
  • - - Consideration 2 – If both of the x-amz-copy-source-if-none-match and - x-amz-copy-source-if-modified-since headers are present in the request - and evaluate as follows, Amazon S3 returns the 412 Precondition Failed - response code: - -
    • - - x-amz-copy-source-if-none-match condition evaluates to false - -
    • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - The copy request charge is based on the storage class and Region you specify for the - destination object. For pricing information, see Amazon - S3 Pricing. - - - - Following are other considerations when using CopyObject: - -
Versioning
- - By default, x-amz-copy-source identifies the current version of an object - to copy. (If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted.) To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - To encrypt the target object, you must provide the appropriate encryption-related - request headers. The one you use depends on whether you want to use AWS managed encryption - keys or provide your own encryption key. - -
  • - - To encrypt the target object using server-side encryption with an AWS managed encryption - key, provide the following request headers, as appropriate. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. If you want to use a customer managed AWS KMS - CMK, you must provide the x-amz-server-side-encryption-aws-kms-key-id - of the symmetric customer managed CMK. Amazon S3 only supports symmetric CMKs and - not asymmetric CMKs. For more information, see Using - Symmetric and Asymmetric Keys in the AWS Key Management Service Developer Guide. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in KMS. - -
  • - - To encrypt the target object using server-side encryption with an encryption key that - you provide, use the following headers. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
  • - - If the source object is encrypted using server-side encryption with customer-provided - encryption keys, you must use the following headers. - -
    • - - x-amz-copy-source​-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-copy-source​-server-side​-encryption​-customer-key - -
    • - - x-amz-copy-source-​server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in Amazon KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - Container for the necessary parameters to execute the CopyObject service method. - - The response from the CopyObject service method, as returned by S3. - - - - Initiates the asynchronous execution of the CopyObject operation. - - - Container for the necessary parameters to execute the CopyObject operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCopyObject - operation. - - - - Finishes the asynchronous execution of the CopyObject operation. - - - The IAsyncResult returned by the call to BeginCopyObject. - - Returns a CopyObjectResult from S3. - - - - - - - Initiates the asynchronous execution of the CopyPart operation. - - - Container for the necessary parameters to execute the CopyPart operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCopyPart - operation. - - - - Finishes the asynchronous execution of the CopyPart operation. - - - The IAsyncResult returned by the call to BeginCopyPart. - - Returns a CopyPartResult from S3. - - - - - - Initiates the asynchronous execution of the DeleteBucket operation. - - - Container for the necessary parameters to execute the DeleteBucket operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteBucket - operation. - - - - Finishes the asynchronous execution of the DeleteBucket operation. - - - The IAsyncResult returned by the call to BeginDeleteBucket. - - Returns a DeleteBucketResult from S3. - - - - Deletes an analytics configuration for the bucket (specified by the analytics configuration - ID). - - - - To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to DeleteBucketAnalyticsConfiguration: - -
  • - - - -
  • - - - -
  • - - - -
- - Container for the necessary parameters to execute the DeleteBucketAnalyticsConfiguration service method. - - The response from the DeleteBucketAnalyticsConfiguration service method, as returned by S3. - - - - Initiates the asynchronous execution of the DeleteBucketAnalyticsConfiguration operation. - - - Container for the necessary parameters to execute the DeleteBucketAnalyticsConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteBucketAnalyticsConfiguration - operation. - - - - Finishes the asynchronous execution of the DeleteBucketAnalyticsConfiguration operation. - - - The IAsyncResult returned by the call to BeginDeleteBucketAnalyticsConfiguration. - - Returns a DeleteBucketAnalyticsConfigurationResult from S3. - - - - - Initiates the asynchronous execution of the DeleteBucketEncryption operation. - - - Container for the necessary parameters to execute the DeleteBucketEncryption operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteBucketEncryption - operation. - - - - Finishes the asynchronous execution of the DeleteBucketEncryption operation. - - - The IAsyncResult returned by the call to BeginDeleteBucketEncryption. - - Returns a DeleteBucketEncryptionResult from S3. - - - - Deletes an inventory configuration (identified by the inventory ID) from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - Operations related to DeleteBucketInventoryConfiguration include: - - - - Container for the necessary parameters to execute the DeleteBucketInventoryConfiguration service method. - - The response from the DeleteBucketInventoryConfiguration service method, as returned by S3. - - - - Initiates the asynchronous execution of the DeleteBucketInventoryConfiguration operation. - - - Container for the necessary parameters to execute the DeleteBucketInventoryConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteBucketInventoryConfiguration - operation. - - - - Finishes the asynchronous execution of the DeleteBucketInventoryConfiguration operation. - - - The IAsyncResult returned by the call to BeginDeleteBucketInventoryConfiguration. - - Returns a DeleteBucketInventoryConfigurationResult from S3. - - - - Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified - by the metrics configuration ID) from the bucket. Note that this doesn't include the - daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteBucketMetricsConfiguration service method. - - The response from the DeleteBucketMetricsConfiguration service method, as returned by S3. - - - - Initiates the asynchronous execution of the DeleteBucketMetricsConfiguration operation. - - - Container for the necessary parameters to execute the DeleteBucketMetricsConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteBucketMetricsConfiguration - operation. - - - - Finishes the asynchronous execution of the DeleteBucketMetricsConfiguration operation. - - - The IAsyncResult returned by the call to BeginDeleteBucketMetricsConfiguration. - - Returns a DeleteBucketMetricsConfigurationResult from S3. - - - - This implementation of the DELETE operation uses the policy subresource to delete - the policy of a specified bucket. If you are using an identity other than the root - user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - The bucket name. - - The response from the DeleteBucketPolicy service method, as returned by S3. - - - - This implementation of the DELETE operation uses the policy subresource to delete - the policy of a specified bucket. If you are using an identity other than the root - user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - Container for the necessary parameters to execute the DeleteBucketPolicy service method. - - The response from the DeleteBucketPolicy service method, as returned by S3. - - - - Initiates the asynchronous execution of the DeleteBucketPolicy operation. - - - Container for the necessary parameters to execute the DeleteBucketPolicy operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteBucketPolicy - operation. - - - - Finishes the asynchronous execution of the DeleteBucketPolicy operation. - - - The IAsyncResult returned by the call to BeginDeleteBucketPolicy. - - Returns a DeleteBucketPolicyResult from S3. - - - - Deletes the replication configuration from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutReplicationConfiguration - action. The bucket owner has these permissions by default and can grant it to others. - For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - It can take a while for the deletion of a replication configuration to fully propagate. - - - - For information about replication configuration, see Replication - in the Amazon S3 Developer Guide. - - - - The following operations are related to DeleteBucketReplication: - - - - Container for the necessary parameters to execute the DeleteBucketReplication service method. - - The response from the DeleteBucketReplication service method, as returned by S3. - - - - Initiates the asynchronous execution of the DeleteBucketReplication operation. - - - Container for the necessary parameters to execute the DeleteBucketReplication operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteBucketReplication - operation. - - - - Finishes the asynchronous execution of the DeleteBucketReplication operation. - - - The IAsyncResult returned by the call to BeginDeleteBucketReplication. - - Returns a DeleteBucketReplicationResult from S3. - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - The bucket that has the tag set to be removed. - - The response from the DeleteBucketTagging service method, as returned by S3. - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - Container for the necessary parameters to execute the DeleteBucketTagging service method. - - The response from the DeleteBucketTagging service method, as returned by S3. - - - - Initiates the asynchronous execution of the DeleteBucketTagging operation. - - - Container for the necessary parameters to execute the DeleteBucketTagging operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteBucketTagging - operation. - - - - Finishes the asynchronous execution of the DeleteBucketTagging operation. - - - The IAsyncResult returned by the call to BeginDeleteBucketTagging. - - Returns a DeleteBucketTaggingResult from S3. - - - - This operation removes the website configuration for a bucket. Amazon S3 returns a - 200 OK response upon successfully deleting a website configuration on - the specified bucket. You will get a 200 OK response if the website configuration - you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE operation requires the S3:DeleteBucketWebsite permission. - By default, only the bucket owner can delete the website configuration attached to - a bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which you want to remove the website configuration. - - The response from the DeleteBucketWebsite service method, as returned by S3. - - - - This operation removes the website configuration for a bucket. Amazon S3 returns a - 200 OK response upon successfully deleting a website configuration on - the specified bucket. You will get a 200 OK response if the website configuration - you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE operation requires the S3:DeleteBucketWebsite permission. - By default, only the bucket owner can delete the website configuration attached to - a bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the DeleteBucketWebsite service method. - - The response from the DeleteBucketWebsite service method, as returned by S3. - - - - Initiates the asynchronous execution of the DeleteBucketWebsite operation. - - - Container for the necessary parameters to execute the DeleteBucketWebsite operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteBucketWebsite - operation. - - - - Finishes the asynchronous execution of the DeleteBucketWebsite operation. - - - The IAsyncResult returned by the call to BeginDeleteBucketWebsite. - - Returns a DeleteBucketWebsiteResult from S3. - - - - - - Initiates the asynchronous execution of the DeleteCORSConfiguration operation. - - - Container for the necessary parameters to execute the DeleteCORSConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteCORSConfiguration - operation. - - - - Finishes the asynchronous execution of the DeleteCORSConfiguration operation. - - - The IAsyncResult returned by the call to BeginDeleteCORSConfiguration. - - Returns a DeleteCORSConfigurationResult from S3. - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - The bucket name of the lifecycle to delete. - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - Container for the necessary parameters to execute the DeleteLifecycleConfiguration service method. - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - - - - Initiates the asynchronous execution of the DeleteLifecycleConfiguration operation. - - - Container for the necessary parameters to execute the DeleteLifecycleConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteLifecycleConfiguration - operation. - - - - Finishes the asynchronous execution of the DeleteLifecycleConfiguration operation. - - - The IAsyncResult returned by the call to BeginDeleteLifecycleConfiguration. - - Returns a DeleteLifecycleConfigurationResult from S3. - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key name of the object to delete. - - The response from the DeleteObject service method, as returned by S3. - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key name of the object to delete. - VersionId used to reference a specific version of the object. - - The response from the DeleteObject service method, as returned by S3. - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - Container for the necessary parameters to execute the DeleteObject service method. - - The response from the DeleteObject service method, as returned by S3. - - - - Initiates the asynchronous execution of the DeleteObject operation. - - - Container for the necessary parameters to execute the DeleteObject operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteObject - operation. - - - - Finishes the asynchronous execution of the DeleteObject operation. - - - The IAsyncResult returned by the call to BeginDeleteObject. - - Returns a DeleteObjectResult from S3. - - - - This operation enables you to delete multiple objects from a bucket using a single - HTTP request. If you know the object keys that you want to delete, then this operation - provides a suitable alternative to sending individual delete requests, reducing per-request - overhead. - - - - The request contains a list of up to 1000 keys that you want to delete. In the XML, - you provide the object key names, and optionally, version IDs if you want to delete - a specific version of the object from a versioning-enabled bucket. For each key, Amazon - S3 performs a delete operation and returns the result of that delete, success, or - failure, in the response. Note that if the object specified in the request is not - found, Amazon S3 returns the result as deleted. - - - - The operation supports two modes for the response: verbose and quiet. By default, - the operation uses verbose mode in which the response includes the result of deletion - of each key in your request. In quiet mode the response includes only keys where the - delete operation encountered an error. For a successful deletion, the operation does - not return any information about the delete in the response body. - - - - When performing this operation on an MFA Delete enabled bucket, that attempts to delete - any versioned objects, you must include an MFA token. If you do not provide one, the - entire request will fail, even if there are non-versioned objects you are trying to - delete. If you provide an invalid token, whether there are versioned keys in the request - or not, the entire Multi-Object Delete request will fail. For information about MFA - Delete, see - MFA Delete. - - - - Finally, the Content-MD5 header is required for all Multi-Object Delete requests. - Amazon S3 uses the header value to ensure that your request body has not been altered - in transit. - - - - The following operations are related to DeleteObjects: - - - - Container for the necessary parameters to execute the DeleteObjects service method. - - The response from the DeleteObjects service method, as returned by S3. - - - - Initiates the asynchronous execution of the DeleteObjects operation. - - - Container for the necessary parameters to execute the DeleteObjects operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteObjects - operation. - - - - Finishes the asynchronous execution of the DeleteObjects operation. - - - The IAsyncResult returned by the call to BeginDeleteObjects. - - Returns a DeleteObjectsResult from S3. - - - - Removes the entire tag set from the specified object. For more information about managing - object tags, see - Object Tagging. - - - - To use this operation, you must have permission to perform the s3:DeleteObjectTagging - action. - - - - To delete tags of a specific object version, add the versionId query - parameter in the request. You will need permission for the s3:DeleteObjectVersionTagging - action. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteObjectTagging service method. - - The response from the DeleteObjectTagging service method, as returned by S3. - - - - Initiates the asynchronous execution of the DeleteObjectTagging operation. - - - Container for the necessary parameters to execute the DeleteObjectTagging operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteObjectTagging - operation. - - - - Finishes the asynchronous execution of the DeleteObjectTagging operation. - - - The IAsyncResult returned by the call to BeginDeleteObjectTagging. - - Returns a DeleteObjectTaggingResult from S3. - - - - Removes the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:PutBucketPublicAccessBlock - permission. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeletePublicAccessBlock service method. - - The response from the DeletePublicAccessBlock service method, as returned by S3. - - - - Initiates the asynchronous execution of the DeletePublicAccessBlock operation. - - - Container for the necessary parameters to execute the DeletePublicAccessBlock operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeletePublicAccessBlock - operation. - - - - Finishes the asynchronous execution of the DeletePublicAccessBlock operation. - - - The IAsyncResult returned by the call to BeginDeletePublicAccessBlock. - - Returns a DeletePublicAccessBlockResult from S3. - - - - - - Initiates the asynchronous execution of the GetACL operation. - - - Container for the necessary parameters to execute the GetACL operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetACL - operation. - - - - Finishes the asynchronous execution of the GetACL operation. - - - The IAsyncResult returned by the call to BeginGetACL. - - Returns a GetACLResult from S3. - - - - - - Initiates the asynchronous execution of the GetBucketAccelerateConfiguration operation. - - - Container for the necessary parameters to execute the GetBucketAccelerateConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketAccelerateConfiguration - operation. - - - - Finishes the asynchronous execution of the GetBucketAccelerateConfiguration operation. - - - The IAsyncResult returned by the call to BeginGetBucketAccelerateConfiguration. - - Returns a GetBucketAccelerateConfigurationResult from S3. - - - - - Initiates the asynchronous execution of the GetBucketAnalyticsConfiguration operation. - - - Container for the necessary parameters to execute the GetBucketAnalyticsConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketAnalyticsConfiguration - operation. - - - - Finishes the asynchronous execution of the GetBucketAnalyticsConfiguration operation. - - - The IAsyncResult returned by the call to BeginGetBucketAnalyticsConfiguration. - - Returns a GetBucketAnalyticsConfigurationResult from S3. - - - - Returns the default encryption configuration for an Amazon S3 bucket. For information - about the Amazon S3 default encryption feature, see Amazon - S3 Default Bucket Encryption. - - - - To use this operation, you must have permission to perform the s3:GetEncryptionConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to GetBucketEncryption: - - - - Container for the necessary parameters to execute the GetBucketEncryption service method. - - The response from the GetBucketEncryption service method, as returned by S3. - - - - Initiates the asynchronous execution of the GetBucketEncryption operation. - - - Container for the necessary parameters to execute the GetBucketEncryption operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketEncryption - operation. - - - - Finishes the asynchronous execution of the GetBucketEncryption operation. - - - The IAsyncResult returned by the call to BeginGetBucketEncryption. - - Returns a GetBucketEncryptionResult from S3. - - - - Returns an inventory configuration (identified by the inventory configuration ID) - from the bucket. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - The following operations are related to GetBucketInventoryConfiguration: - - - - Container for the necessary parameters to execute the GetBucketInventoryConfiguration service method. - - The response from the GetBucketInventoryConfiguration service method, as returned by S3. - - - - Initiates the asynchronous execution of the GetBucketInventoryConfiguration operation. - - - Container for the necessary parameters to execute the GetBucketInventoryConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketInventoryConfiguration - operation. - - - - Finishes the asynchronous execution of the GetBucketInventoryConfiguration operation. - - - The IAsyncResult returned by the call to BeginGetBucketInventoryConfiguration. - - Returns a GetBucketInventoryConfigurationResult from S3. - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - The name of the bucket for which to get the location. - - The response from the GetBucketLocation service method, as returned by S3. - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - Container for the necessary parameters to execute the GetBucketLocation service method. - - The response from the GetBucketLocation service method, as returned by S3. - - - - Initiates the asynchronous execution of the GetBucketLocation operation. - - - Container for the necessary parameters to execute the GetBucketLocation operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketLocation - operation. - - - - Finishes the asynchronous execution of the GetBucketLocation operation. - - - The IAsyncResult returned by the call to BeginGetBucketLocation. - - Returns a GetBucketLocationResult from S3. - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - The bucket name for which to get the logging information. - - The response from the GetBucketLogging service method, as returned by S3. - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - Container for the necessary parameters to execute the GetBucketLogging service method. - - The response from the GetBucketLogging service method, as returned by S3. - - - - Initiates the asynchronous execution of the GetBucketLogging operation. - - - Container for the necessary parameters to execute the GetBucketLogging operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketLogging - operation. - - - - Finishes the asynchronous execution of the GetBucketLogging operation. - - - The IAsyncResult returned by the call to BeginGetBucketLogging. - - Returns a GetBucketLoggingResult from S3. - - - - Gets a metrics configuration (specified by the metrics configuration ID) from the - bucket. Note that this doesn't include the daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to GetBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the GetBucketMetricsConfiguration service method. - - The response from the GetBucketMetricsConfiguration service method, as returned by S3. - - - - Initiates the asynchronous execution of the GetBucketMetricsConfiguration operation. - - - Container for the necessary parameters to execute the GetBucketMetricsConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketMetricsConfiguration - operation. - - - - Finishes the asynchronous execution of the GetBucketMetricsConfiguration operation. - - - The IAsyncResult returned by the call to BeginGetBucketMetricsConfiguration. - - Returns a GetBucketMetricsConfigurationResult from S3. - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following operation is related to GetBucketNotification: - - - - Name of the bucket for which to get the notification configuration - - The response from the GetBucketNotification service method, as returned by S3. - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following operation is related to GetBucketNotification: - - - - Container for the necessary parameters to execute the GetBucketNotification service method. - - The response from the GetBucketNotification service method, as returned by S3. - - - - Initiates the asynchronous execution of the GetBucketNotification operation. - - - Container for the necessary parameters to execute the GetBucketNotification operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketNotification - operation. - - - - Finishes the asynchronous execution of the GetBucketNotification operation. - - - The IAsyncResult returned by the call to BeginGetBucketNotification. - - Returns a GetBucketNotificationResult from S3. - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operation is related to GetBucketPolicy: - - - - The bucket name for which to get the bucket policy. - - The response from the GetBucketPolicy service method, as returned by S3. - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operation is related to GetBucketPolicy: - - - - Container for the necessary parameters to execute the GetBucketPolicy service method. - - The response from the GetBucketPolicy service method, as returned by S3. - - - - Initiates the asynchronous execution of the GetBucketPolicy operation. - - - Container for the necessary parameters to execute the GetBucketPolicy operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketPolicy - operation. - - - - Finishes the asynchronous execution of the GetBucketPolicy operation. - - - The IAsyncResult returned by the call to BeginGetBucketPolicy. - - Returns a GetBucketPolicyResult from S3. - - - - Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket - is public. In order to use this operation, you must have the s3:GetBucketPolicyStatus - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - For more information about when Amazon S3 considers a bucket public, see The - Meaning of "Public". - - - - The following operations are related to GetBucketPolicyStatus: - - - - Container for the necessary parameters to execute the GetBucketPolicyStatus service method. - - The response from the GetBucketPolicyStatus service method, as returned by S3. - - - - Initiates the asynchronous execution of the GetBucketPolicyStatus operation. - - - Container for the necessary parameters to execute the GetBucketPolicyStatus operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketPolicyStatus - operation. - - - - Finishes the asynchronous execution of the GetBucketPolicyStatus operation. - - - The IAsyncResult returned by the call to BeginGetBucketPolicyStatus. - - Returns a GetBucketPolicyStatusResult from S3. - - - - Retrieves the replication configuration for the given Amazon S3 bucket. - - Container for the necessary parameters to execute the GetBucketReplication service method. - - The response from the GetBucketReplication service method, as returned by S3. - - - - Initiates the asynchronous execution of the GetBucketReplication operation. - - - Container for the necessary parameters to execute the GetBucketReplication operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketReplication - operation. - - - - Finishes the asynchronous execution of the GetBucketReplication operation. - - - The IAsyncResult returned by the call to BeginGetBucketReplication. - - Returns a GetBucketReplicationResult from S3. - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - The name of the bucket for which to get the payment request configuration - - The response from the GetBucketRequestPayment service method, as returned by S3. - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - Container for the necessary parameters to execute the GetBucketRequestPayment service method. - - The response from the GetBucketRequestPayment service method, as returned by S3. - - - - Initiates the asynchronous execution of the GetBucketRequestPayment operation. - - - Container for the necessary parameters to execute the GetBucketRequestPayment operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketRequestPayment - operation. - - - - Finishes the asynchronous execution of the GetBucketRequestPayment operation. - - - The IAsyncResult returned by the call to BeginGetBucketRequestPayment. - - Returns a GetBucketRequestPaymentResult from S3. - - - - Returns the tag set associated with the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - GetBucketTagging has the following special error: - -
  • - - Error code: NoSuchTagSetError - -
    • - - Description: There is no tag set associated with the bucket. - -
- - The following operations are related to GetBucketTagging: - - - - Container for the necessary parameters to execute the GetBucketTagging service method. - - The response from the GetBucketTagging service method, as returned by S3. - - - - Initiates the asynchronous execution of the GetBucketTagging operation. - - - Container for the necessary parameters to execute the GetBucketTagging operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketTagging - operation. - - - - Finishes the asynchronous execution of the GetBucketTagging operation. - - - The IAsyncResult returned by the call to BeginGetBucketTagging. - - Returns a GetBucketTaggingResult from S3. - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - The name of the bucket for which to get the versioning information. - - The response from the GetBucketVersioning service method, as returned by S3. - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - Container for the necessary parameters to execute the GetBucketVersioning service method. - - The response from the GetBucketVersioning service method, as returned by S3. - - - - Initiates the asynchronous execution of the GetBucketVersioning operation. - - - Container for the necessary parameters to execute the GetBucketVersioning operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketVersioning - operation. - - - - Finishes the asynchronous execution of the GetBucketVersioning operation. - - - The IAsyncResult returned by the call to BeginGetBucketVersioning. - - Returns a GetBucketVersioningResult from S3. - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET operation requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which to get the website configuration. - - The response from the GetBucketWebsite service method, as returned by S3. - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET operation requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the GetBucketWebsite service method. - - The response from the GetBucketWebsite service method, as returned by S3. - - - - Initiates the asynchronous execution of the GetBucketWebsite operation. - - - Container for the necessary parameters to execute the GetBucketWebsite operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketWebsite - operation. - - - - Finishes the asynchronous execution of the GetBucketWebsite operation. - - - The IAsyncResult returned by the call to BeginGetBucketWebsite. - - Returns a GetBucketWebsiteResult from S3. - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - The bucket name for which to get the cors configuration. - - The response from the GetCORSConfiguration service method, as returned by S3. - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - Container for the necessary parameters to execute the GetCORSConfiguration service method. - - The response from the GetCORSConfiguration service method, as returned by S3. - - - - Initiates the asynchronous execution of the GetCORSConfiguration operation. - - - Container for the necessary parameters to execute the GetCORSConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetCORSConfiguration - operation. - - - - Finishes the asynchronous execution of the GetCORSConfiguration operation. - - - The IAsyncResult returned by the call to BeginGetCORSConfiguration. - - Returns a GetCORSConfigurationResult from S3. - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are still using previous version of the lifecycle configuration, it works. - For the earlier API description, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to DeleteBucketMetricsConfiguration: - - - - The name of the bucket for which to get the lifecycle information. - - The response from the GetLifecycleConfiguration service method, as returned by S3. - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are still using previous version of the lifecycle configuration, it works. - For the earlier API description, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the GetLifecycleConfiguration service method. - - The response from the GetLifecycleConfiguration service method, as returned by S3. - - - - Initiates the asynchronous execution of the GetLifecycleConfiguration operation. - - - Container for the necessary parameters to execute the GetLifecycleConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetLifecycleConfiguration - operation. - - - - Finishes the asynchronous execution of the GetLifecycleConfiguration operation. - - - The IAsyncResult returned by the call to BeginGetLifecycleConfiguration. - - Returns a GetLifecycleConfigurationResult from S3. - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object to get. - - The response from the GetObject service method, as returned by S3. - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object to get. - VersionId used to reference a specific version of the object. - - The response from the GetObject service method, as returned by S3. - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - Container for the necessary parameters to execute the GetObject service method. - - The response from the GetObject service method, as returned by S3. - - - - Initiates the asynchronous execution of the GetObject operation. - - - Container for the necessary parameters to execute the GetObject operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetObject - operation. - - - - Finishes the asynchronous execution of the GetObject operation. - - - The IAsyncResult returned by the call to BeginGetObject. - - Returns a GetObjectResult from S3. - - - - Gets an object's current Legal Hold status. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLegalHold service method. - - The response from the GetObjectLegalHold service method, as returned by S3. - - - - Initiates the asynchronous execution of the GetObjectLegalHold operation. - - - Container for the necessary parameters to execute the GetObjectLegalHold operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetObjectLegalHold - operation. - - - - Finishes the asynchronous execution of the GetObjectLegalHold operation. - - - The IAsyncResult returned by the call to BeginGetObjectLegalHold. - - Returns a GetObjectLegalHoldResult from S3. - - - - Gets the Object Lock configuration for a bucket. The rule specified in the Object - Lock configuration will be applied by default to every new object placed in the specified - bucket. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLockConfiguration service method. - - The response from the GetObjectLockConfiguration service method, as returned by S3. - - - - Initiates the asynchronous execution of the GetObjectLockConfiguration operation. - - - Container for the necessary parameters to execute the GetObjectLockConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetObjectLockConfiguration - operation. - - - - Finishes the asynchronous execution of the GetObjectLockConfiguration operation. - - - The IAsyncResult returned by the call to BeginGetObjectLockConfiguration. - - Returns a GetObjectLockConfigurationResult from S3. - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - The name of the bucket containing the object. - The object key. - - The response from the GetObjectMetadata service method, as returned by S3. - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - The name of the bucket containing the object. - The object key. - VersionId used to reference a specific version of the object. - - The response from the GetObjectMetadata service method, as returned by S3. - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - Container for the necessary parameters to execute the GetObjectMetadata service method. - - The response from the GetObjectMetadata service method, as returned by S3. - - - - Initiates the asynchronous execution of the GetObjectMetadata operation. - - - Container for the necessary parameters to execute the GetObjectMetadata operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetObjectMetadata - operation. - - - - Finishes the asynchronous execution of the GetObjectMetadata operation. - - - The IAsyncResult returned by the call to BeginGetObjectMetadata. - - Returns a GetObjectMetadataResult from S3. - - - - Retrieves an object's retention settings. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectRetention service method. - - The response from the GetObjectRetention service method, as returned by S3. - - - - Initiates the asynchronous execution of the GetObjectRetention operation. - - - Container for the necessary parameters to execute the GetObjectRetention operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetObjectRetention - operation. - - - - Finishes the asynchronous execution of the GetObjectRetention operation. - - - The IAsyncResult returned by the call to BeginGetObjectRetention. - - Returns a GetObjectRetentionResult from S3. - - - - Returns the tag-set of an object. You send the GET request against the tagging subresource - associated with the object. - - - - To use this operation, you must have permission to perform the s3:GetObjectTagging - action. By default, the GET operation returns information about current version of - an object. For a versioned bucket, you can have multiple versions of an object in - your bucket. To retrieve tags of any other version, use the versionId query parameter. - You also need permission for the s3:GetObjectVersionTagging action. - - - - By default, the bucket owner has this permission and can grant this permission to - others. - - - - For information about the Amazon S3 object tagging feature, see Object - Tagging. - - - - The following operation is related to GetObjectTagging: - - - - Container for the necessary parameters to execute the GetObjectTagging service method. - - The response from the GetObjectTagging service method, as returned by S3. - - - - Initiates the asynchronous execution of the GetObjectTagging operation. - - - Container for the necessary parameters to execute the GetObjectTagging operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetObjectTagging - operation. - - - - Finishes the asynchronous execution of the GetObjectTagging operation. - - - The IAsyncResult returned by the call to BeginGetObjectTagging. - - Returns a GetObjectTaggingResult from S3. - - - - Return torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Amazon - S3 Torrent. - - - - You can get torrent only for objects that are less than 5 GB in size and that are - not encrypted using server-side encryption with customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - The following operation is related to GetObjectTorrent: - - - - The name of the bucket containing the object for which to get the torrent files. - The object key for which to get the information. - - The response from the GetObjectTorrent service method, as returned by S3. - - - - Return torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Amazon - S3 Torrent. - - - - You can get torrent only for objects that are less than 5 GB in size and that are - not encrypted using server-side encryption with customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - The following operation is related to GetObjectTorrent: - - - - Container for the necessary parameters to execute the GetObjectTorrent service method. - - The response from the GetObjectTorrent service method, as returned by S3. - - - - Initiates the asynchronous execution of the GetObjectTorrent operation. - - - Container for the necessary parameters to execute the GetObjectTorrent operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetObjectTorrent - operation. - - - - Finishes the asynchronous execution of the GetObjectTorrent operation. - - - The IAsyncResult returned by the call to BeginGetObjectTorrent. - - Returns a GetObjectTorrentResult from S3. - - - - Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:GetBucketPublicAccessBlock - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket - or an object, it checks the PublicAccessBlock configuration for both - the bucket (or the bucket that contains the object) and the bucket owner's account. - If the PublicAccessBlock settings are different between the bucket and - the account, Amazon S3 uses the most restrictive combination of the bucket-level and - account-level settings. - - - - For more information about when Amazon S3 considers a bucket or an object public, - see The - Meaning of "Public". - - - - The following operations are related to GetPublicAccessBlock: - - - - Container for the necessary parameters to execute the GetPublicAccessBlock service method. - - The response from the GetPublicAccessBlock service method, as returned by S3. - - - - Initiates the asynchronous execution of the GetPublicAccessBlock operation. - - - Container for the necessary parameters to execute the GetPublicAccessBlock operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetPublicAccessBlock - operation. - - - - Finishes the asynchronous execution of the GetPublicAccessBlock operation. - - - The IAsyncResult returned by the call to BeginGetPublicAccessBlock. - - Returns a GetPublicAccessBlockResult from S3. - - - - This operation initiates a multipart upload and returns an upload ID. This upload - ID is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort operation - and Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload API and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart) and UploadPartCopy) requests must match the headers you - used in the request to initiate the upload by using CreateMultipartUpload. - - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, - kms:GenerateDataKey*, and kms:DescribeKey actions on the - key. These permissions are required because Amazon S3 must decrypt and read data from - the encrypted file parts before it completes the multipart upload. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - The following operations are related to CreateMultipartUpload: - - - - The name of the bucket to which to initiate the upload - Object key for which the multipart upload is to be initiated. - - The response from the InitiateMultipartUpload service method, as returned by S3. - - - - This operation initiates a multipart upload and returns an upload ID. This upload - ID is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort operation - and Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload API and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart) and UploadPartCopy) requests must match the headers you - used in the request to initiate the upload by using CreateMultipartUpload. - - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, - kms:GenerateDataKey*, and kms:DescribeKey actions on the - key. These permissions are required because Amazon S3 must decrypt and read data from - the encrypted file parts before it completes the multipart upload. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - The following operations are related to CreateMultipartUpload: - - - - Container for the necessary parameters to execute the InitiateMultipartUpload service method. - - The response from the InitiateMultipartUpload service method, as returned by S3. - - - - Initiates the asynchronous execution of the InitiateMultipartUpload operation. - - - Container for the necessary parameters to execute the InitiateMultipartUpload operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndInitiateMultipartUpload - operation. - - - - Finishes the asynchronous execution of the InitiateMultipartUpload operation. - - - The IAsyncResult returned by the call to BeginInitiateMultipartUpload. - - Returns a InitiateMultipartUploadResult from S3. - - - - Lists the analytics configurations for the bucket. You can have up to 1,000 analytics - configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. You should always check the IsTruncated element in the response. - If there are no more configurations to list, IsTruncated is set to false. - If there are more configurations to list, IsTruncated is set to true, - and there will be a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to ListBucketAnalyticsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketAnalyticsConfigurations service method. - - The response from the ListBucketAnalyticsConfigurations service method, as returned by S3. - - - - Initiates the asynchronous execution of the ListBucketAnalyticsConfigurations operation. - - - Container for the necessary parameters to execute the ListBucketAnalyticsConfigurations operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListBucketAnalyticsConfigurations - operation. - - - - Finishes the asynchronous execution of the ListBucketAnalyticsConfigurations operation. - - - The IAsyncResult returned by the call to BeginListBucketAnalyticsConfigurations. - - Returns a ListBucketAnalyticsConfigurationsResult from S3. - - - - Returns a list of inventory configurations for the bucket. You can have up to 1,000 - analytics configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory - - - - The following operations are related to ListBucketInventoryConfigurations: - - - - Container for the necessary parameters to execute the ListBucketInventoryConfigurations service method. - - The response from the ListBucketInventoryConfigurations service method, as returned by S3. - - - - Initiates the asynchronous execution of the ListBucketInventoryConfigurations operation. - - - Container for the necessary parameters to execute the ListBucketInventoryConfigurations operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListBucketInventoryConfigurations - operation. - - - - Finishes the asynchronous execution of the ListBucketInventoryConfigurations operation. - - - The IAsyncResult returned by the call to BeginListBucketInventoryConfigurations. - - Returns a ListBucketInventoryConfigurationsResult from S3. - - - - Lists the metrics configurations for the bucket. The metrics configurations are only - for the request metrics of the bucket and do not provide information on daily storage - metrics. You can have up to 1,000 configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For more information about metrics configurations and CloudWatch request metrics, - see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to ListBucketMetricsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketMetricsConfigurations service method. - - The response from the ListBucketMetricsConfigurations service method, as returned by S3. - - - - Initiates the asynchronous execution of the ListBucketMetricsConfigurations operation. - - - Container for the necessary parameters to execute the ListBucketMetricsConfigurations operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListBucketMetricsConfigurations - operation. - - - - Finishes the asynchronous execution of the ListBucketMetricsConfigurations operation. - - - The IAsyncResult returned by the call to BeginListBucketMetricsConfigurations. - - Returns a ListBucketMetricsConfigurationsResult from S3. - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - - The response from the ListBuckets service method, as returned by S3. - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - Container for the necessary parameters to execute the ListBuckets service method. - - The response from the ListBuckets service method, as returned by S3. - - - - Initiates the asynchronous execution of the ListBuckets operation. - - - Container for the necessary parameters to execute the ListBuckets operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListBuckets - operation. - - - - Finishes the asynchronous execution of the ListBuckets operation. - - - The IAsyncResult returned by the call to BeginListBuckets. - - Returns a ListBucketsResult from S3. - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - - The response from the ListMultipartUploads service method, as returned by S3. - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) - - The response from the ListMultipartUploads service method, as returned by S3. - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Container for the necessary parameters to execute the ListMultipartUploads service method. - - The response from the ListMultipartUploads service method, as returned by S3. - - - - Initiates the asynchronous execution of the ListMultipartUploads operation. - - - Container for the necessary parameters to execute the ListMultipartUploads operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListMultipartUploads - operation. - - - - Finishes the asynchronous execution of the ListMultipartUploads operation. - - - The IAsyncResult returned by the call to BeginListMultipartUploads. - - Returns a ListMultipartUploadsResult from S3. - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. - - The response from the ListObjects service method, as returned by S3. - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. - Limits the response to keys that begin with the specified prefix. - - The response from the ListObjects service method, as returned by S3. - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - Container for the necessary parameters to execute the ListObjects service method. - - The response from the ListObjects service method, as returned by S3. - - - - Initiates the asynchronous execution of the ListObjects operation. - - - Container for the necessary parameters to execute the ListObjects operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListObjects - operation. - - - - Finishes the asynchronous execution of the ListObjects operation. - - - The IAsyncResult returned by the call to BeginListObjects. - - Returns a ListObjectsResult from S3. - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Make sure to design - your application to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - To use this operation in an AWS Identity and Access Management (IAM) policy, you must - have permissions to perform the s3:ListBucket action. The bucket owner - has this permission by default and can grant this permission to others. For more information - about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - This section describes the latest revision of the API. We recommend that you use this - revised API for application development. For backward compatibility, Amazon S3 continues - to support the prior version of this API, ListObjects. - - - - To get a list of your buckets, see ListBuckets. - - - - The following operations are related to ListObjectsV2: - - - - Container for the necessary parameters to execute the ListObjectsV2 service method. - - The response from the ListObjectsV2 service method, as returned by S3. - - - - Initiates the asynchronous execution of the ListObjectsV2 operation. - - - Container for the necessary parameters to execute the ListObjectsV2 operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListObjectsV2 - operation. - - - - Finishes the asynchronous execution of the ListObjectsV2 operation. - - - The IAsyncResult returned by the call to BeginListObjectsV2. - - Returns a ListObjectsV2Result from S3. - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). This request returns a maximum of 1,000 - uploaded parts. The default number of parts returned is 1,000 parts. You can restrict - the number of parts returned by specifying the max-parts request parameter. - If your multipart upload consists of more than 1,000 parts, the response returns an - IsTruncated field with the value of true, and a NextPartNumberMarker - element. In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListParts: - - - - Name of the bucket to which the parts are being uploaded. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Object key for which the multipart upload was initiated. - Upload ID identifying the multipart upload whose parts are being listed. - - The response from the ListParts service method, as returned by S3. - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). This request returns a maximum of 1,000 - uploaded parts. The default number of parts returned is 1,000 parts. You can restrict - the number of parts returned by specifying the max-parts request parameter. - If your multipart upload consists of more than 1,000 parts, the response returns an - IsTruncated field with the value of true, and a NextPartNumberMarker - element. In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListParts: - - - - Container for the necessary parameters to execute the ListParts service method. - - The response from the ListParts service method, as returned by S3. - - - - Initiates the asynchronous execution of the ListParts operation. - - - Container for the necessary parameters to execute the ListParts operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListParts - operation. - - - - Finishes the asynchronous execution of the ListParts operation. - - - The IAsyncResult returned by the call to BeginListParts. - - Returns a ListPartsResult from S3. - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - - The response from the ListVersions service method, as returned by S3. - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes. - - The response from the ListVersions service method, as returned by S3. - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - Container for the necessary parameters to execute the ListVersions service method. - - The response from the ListVersions service method, as returned by S3. - - - - Initiates the asynchronous execution of the ListVersions operation. - - - Container for the necessary parameters to execute the ListVersions operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListVersions - operation. - - - - Finishes the asynchronous execution of the ListVersions operation. - - - The IAsyncResult returned by the call to BeginListVersions. - - Returns a ListVersionsResult from S3. - - - - - Initiates the asynchronous execution of the PutACL operation. - - - Container for the necessary parameters to execute the PutACL operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutACL - operation. - - - - Finishes the asynchronous execution of the PutACL operation. - - - The IAsyncResult returned by the call to BeginPutACL. - - Returns a PutACLResult from S3. - - - - Creates a new bucket. To create a bucket, you must register with Amazon S3 and have - a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed - to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information on bucket naming restrictions, - see Working - with Amazon S3 Buckets. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the EU (Ireland) - Region. For more information, see How - to Select a Region for Your Buckets. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - Hosting of Buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - The name of the bucket to create. - - The response from the PutBucket service method, as returned by S3. - - - - Creates a new bucket. To create a bucket, you must register with Amazon S3 and have - a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed - to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information on bucket naming restrictions, - see Working - with Amazon S3 Buckets. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the EU (Ireland) - Region. For more information, see How - to Select a Region for Your Buckets. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - Hosting of Buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - Container for the necessary parameters to execute the PutBucket service method. - - The response from the PutBucket service method, as returned by S3. - - - - Initiates the asynchronous execution of the PutBucket operation. - - - Container for the necessary parameters to execute the PutBucket operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucket - operation. - - - - Finishes the asynchronous execution of the PutBucket operation. - - - The IAsyncResult returned by the call to BeginPutBucket. - - Returns a PutBucketResult from S3. - - - - Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration - is a bucket-level feature that enables you to perform faster data transfers to Amazon - S3. - - - - To use this operation, you must have permission to perform the s3:PutAccelerateConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The Transfer Acceleration state of a bucket can be set to one of the following two - values: - -
  • - - Enabled – Enables accelerated data transfers to the bucket. - -
  • - - Suspended – Disables accelerated data transfers to the bucket. - -
- - The GetBucketAccelerateConfiguration operation returns the transfer acceleration - state of a bucket. - - - - After setting the Transfer Acceleration state of a bucket to Enabled, it might take - up to thirty minutes before the data transfer rates to the bucket increase. - - - - The name of the bucket used for Transfer Acceleration must be DNS-compliant and must - not contain periods ("."). - - - - For more information about transfer acceleration, see Transfer - Acceleration. - - - - The following operations are related to PutBucketAccelerateConfiguration: - - - - Container for the necessary parameters to execute the PutBucketAccelerateConfiguration service method. - - The response from the PutBucketAccelerateConfiguration service method, as returned by S3. - - - - Initiates the asynchronous execution of the PutBucketAccelerateConfiguration operation. - - - Container for the necessary parameters to execute the PutBucketAccelerateConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketAccelerateConfiguration - operation. - - - - Finishes the asynchronous execution of the PutBucketAccelerateConfiguration operation. - - - The IAsyncResult returned by the call to BeginPutBucketAccelerateConfiguration. - - Returns a PutBucketAccelerateConfigurationResult from S3. - - - - - Initiates the asynchronous execution of the PutBucketAnalyticsConfiguration operation. - - - Container for the necessary parameters to execute the PutBucketAnalyticsConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketAnalyticsConfiguration - operation. - - - - Finishes the asynchronous execution of the PutBucketAnalyticsConfiguration operation. - - - The IAsyncResult returned by the call to BeginPutBucketAnalyticsConfiguration. - - Returns a PutBucketAnalyticsConfigurationResult from S3. - - - - - Initiates the asynchronous execution of the PutBucketEncryption operation. - - - Container for the necessary parameters to execute the PutBucketEncryption operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketEncryption - operation. - - - - Finishes the asynchronous execution of the PutBucketEncryption operation. - - - The IAsyncResult returned by the call to BeginPutBucketEncryption. - - Returns a PutBucketEncryptionResult from S3. - - - - - Initiates the asynchronous execution of the PutBucketInventoryConfiguration operation. - - - Container for the necessary parameters to execute the PutBucketInventoryConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketInventoryConfiguration - operation. - - - - Finishes the asynchronous execution of the PutBucketInventoryConfiguration operation. - - - The IAsyncResult returned by the call to BeginPutBucketInventoryConfiguration. - - Returns a PutBucketInventoryConfigurationResult from S3. - - - - Set the logging parameters for a bucket and to specify permissions for who can view - and modify the logging parameters. All logs are saved to buckets in the same AWS Region - as the source bucket. To set the logging status of a bucket, you must be the bucket - owner. - - - - The bucket owner is automatically granted FULL_CONTROL to all logs. You use the Grantee - request element to grant access to other people. The Permissions request - element specifies the kind of access the grantee has to the logs. - - - - Grantee Values - - - - You can specify the person (grantee) to whom you're assigning access rights (using - request elements) in the following ways: - -
  • - - By the person's ID: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> - </Grantee> - - - - DisplayName is optional and ignored in the request. - -
  • - - By Email address: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee> - - - - - The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl - request, appears as the CanonicalUser. - -
  • - - By URI: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee> - - -
- - To enable logging, you use LoggingEnabled and its children request elements. To disable - logging, you use an empty BucketLoggingStatus request element: - - - - <BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01" /> - - - - - For more information about server access logging, see Server - Access Logging. - - - - For more information about creating a bucket, see CreateBucket. For more information - about returning the logging status of a bucket, see GetBucketLogging. - - - - The following operations are related to PutBucketLogging: - - - - Container for the necessary parameters to execute the PutBucketLogging service method. - - The response from the PutBucketLogging service method, as returned by S3. - - - - Initiates the asynchronous execution of the PutBucketLogging operation. - - - Container for the necessary parameters to execute the PutBucketLogging operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketLogging - operation. - - - - Finishes the asynchronous execution of the PutBucketLogging operation. - - - The IAsyncResult returned by the call to BeginPutBucketLogging. - - Returns a PutBucketLoggingResult from S3. - - - - Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. - You can have up to 1,000 metrics configurations per bucket. If you're updating an - existing metrics configuration, note that this is a full replacement of the existing - metrics configuration. If you don't include the elements you want to keep, they are - erased. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to PutBucketMetricsConfiguration: - - - - GetBucketLifecycle has the following special error: - -
  • - - Error code: TooManyConfigurations - -
    • - - Description: You are attempting to create a new configuration but have already reached - the 1,000-configuration limit. - -
    • - - HTTP Status Code: HTTP 400 Bad Request - -
- - Container for the necessary parameters to execute the PutBucketMetricsConfiguration service method. - - The response from the PutBucketMetricsConfiguration service method, as returned by S3. - - - - Initiates the asynchronous execution of the PutBucketMetricsConfiguration operation. - - - Container for the necessary parameters to execute the PutBucketMetricsConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketMetricsConfiguration - operation. - - - - Finishes the asynchronous execution of the PutBucketMetricsConfiguration operation. - - - The IAsyncResult returned by the call to BeginPutBucketMetricsConfiguration. - - Returns a PutBucketMetricsConfigurationResult from S3. - - - - Enables notifications of specified events for a bucket. For more information about - event notifications, see Configuring - Event Notifications. - - - - Using this API, you can replace an existing notification configuration. The configuration - is an XML file that defines the event types that you want Amazon S3 to publish and - the destination where you want Amazon S3 to publish an event notification when it - detects an event of the specified type. - - - - By default, your bucket has no event notifications configured. That is, the notification - configuration will be an empty NotificationConfiguration. - - - - <NotificationConfiguration> - - - - </NotificationConfiguration> - - - - This operation replaces the existing notification configuration with the configuration - you include in the request body. - - - - After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification - Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, - and that the bucket owner has permission to publish to it by sending a test notification. - In the case of AWS Lambda destinations, Amazon S3 verifies that the Lambda function - permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. - For more information, see Configuring - Notifications for Amazon S3 Events. - - - - You can disable notifications by adding the empty NotificationConfiguration element. - - - - By default, only the bucket owner can configure notifications on a bucket. However, - bucket owners can use a bucket policy to grant permission to other users to set this - configuration with s3:PutBucketNotification permission. - - - - The PUT notification is an atomic operation. For example, suppose your notification - configuration includes SNS topic, SQS queue, and Lambda function configurations. When - you send a PUT request with this configuration, Amazon S3 sends test messages to your - SNS topic. If the message fails, the entire PUT operation will fail, and Amazon S3 - will not add the configuration to your bucket. - - - - Responses - - - - If the configuration in the request body includes only one TopicConfiguration - specifying only the s3:ReducedRedundancyLostObject event type, the response - will also include the x-amz-sns-test-message-id header containing the - message ID of the test notification sent to the topic. - - - - The following operation is related to PutBucketNotificationConfiguration: - - - - Container for the necessary parameters to execute the PutBucketNotification service method. - - The response from the PutBucketNotification service method, as returned by S3. - - - - Initiates the asynchronous execution of the PutBucketNotification operation. - - - Container for the necessary parameters to execute the PutBucketNotification operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketNotification - operation. - - - - Finishes the asynchronous execution of the PutBucketNotification operation. - - - The IAsyncResult returned by the call to BeginPutBucketNotification. - - Returns a PutBucketNotificationResult from S3. - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - - The response from the PutBucketPolicy service method, as returned by S3. - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - The MD5 hash of the request body. - - The response from the PutBucketPolicy service method, as returned by S3. - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - Container for the necessary parameters to execute the PutBucketPolicy service method. - - The response from the PutBucketPolicy service method, as returned by S3. - - - - Initiates the asynchronous execution of the PutBucketPolicy operation. - - - Container for the necessary parameters to execute the PutBucketPolicy operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketPolicy - operation. - - - - Finishes the asynchronous execution of the PutBucketPolicy operation. - - - The IAsyncResult returned by the call to BeginPutBucketPolicy. - - Returns a PutBucketPolicyResult from S3. - - - - Creates a replication configuration or replaces an existing one. For more information, - see Replication - in the Amazon S3 Developer Guide. - - - - To perform this operation, the user or role performing the operation must have the - iam:PassRole - permission. - - - - Specify the replication configuration in the request body. In the replication configuration, - you provide the name of the destination bucket where you want Amazon S3 to replicate - objects, the IAM role that Amazon S3 can assume to replicate objects on your behalf, - and other relevant information. - - - - A replication configuration must include at least one rule, and can contain a maximum - of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects - in the source bucket. To choose additional subsets of objects to replicate, add a - rule for each subset. All rules must specify the same destination bucket. - - - - To specify a subset of the objects in the source bucket to apply a replication rule - to, add the Filter element as a child of the Rule element. You can filter objects - based on an object key prefix, one or more object tags, or both. When you add the - Filter element in the configuration, you must also add the following elements: DeleteMarkerReplication, - Status, and Priority. - - - - For information about enabling versioning on a bucket, see Using - Versioning. - - - - By default, a resource owner, in this case the AWS account that created the bucket, - can perform this operation. The resource owner can also grant others permissions to - perform the operation. For more information about permissions, see Specifying - Permissions in a Policy and Managing - Access Permissions to Your Amazon S3 Resources. - - - - Handling Replication of Encrypted Objects - - - - By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side - encryption with CMKs stored in AWS KMS. To replicate AWS KMS-encrypted objects, add - the following: SourceSelectionCriteria, SseKmsEncryptedObjects, - Status, EncryptionConfiguration, and ReplicaKmsKeyID. - For information about replication configuration, see Replicating - Objects Created with SSE Using CMKs stored in AWS KMS. - - - - For information on PutBucketReplication errors, see ReplicationErrorCodeList - - - - - The following operations are related to PutBucketReplication: - - - - Container for the necessary parameters to execute the PutBucketReplication service method. - - The response from the PutBucketReplication service method, as returned by S3. - - - - Initiates the asynchronous execution of the PutBucketReplication operation. - - - Container for the necessary parameters to execute the PutBucketReplication operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketReplication - operation. - - - - Finishes the asynchronous execution of the PutBucketReplication operation. - - - The IAsyncResult returned by the call to BeginPutBucketReplication. - - Returns a PutBucketReplicationResult from S3. - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - The bucket name. - Container for Payer. - - The response from the PutBucketRequestPayment service method, as returned by S3. - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - Container for the necessary parameters to execute the PutBucketRequestPayment service method. - - The response from the PutBucketRequestPayment service method, as returned by S3. - - - - Initiates the asynchronous execution of the PutBucketRequestPayment operation. - - - Container for the necessary parameters to execute the PutBucketRequestPayment operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketRequestPayment - operation. - - - - Finishes the asynchronous execution of the PutBucketRequestPayment operation. - - - The IAsyncResult returned by the call to BeginPutBucketRequestPayment. - - Returns a PutBucketRequestPaymentResult from S3. - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging. - - - - Within a bucket, if you add a tag that has the same key as an existing tag, the new - value overwrites the old value. For more information, see Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional operation is currently in progress against - this resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - The bucket name. - A property of PutBucketTaggingRequest used to execute the PutBucketTagging service method. - - The response from the PutBucketTagging service method, as returned by S3. - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging. - - - - Within a bucket, if you add a tag that has the same key as an existing tag, the new - value overwrites the old value. For more information, see Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional operation is currently in progress against - this resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - Container for the necessary parameters to execute the PutBucketTagging service method. - - The response from the PutBucketTagging service method, as returned by S3. - - - - Initiates the asynchronous execution of the PutBucketTagging operation. - - - Container for the necessary parameters to execute the PutBucketTagging operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketTagging - operation. - - - - Finishes the asynchronous execution of the PutBucketTagging operation. - - - The IAsyncResult returned by the call to BeginPutBucketTagging. - - Returns a PutBucketTaggingResult from S3. - - - - - Initiates the asynchronous execution of the PutBucketVersioning operation. - - - Container for the necessary parameters to execute the PutBucketVersioning operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketVersioning - operation. - - - - Finishes the asynchronous execution of the PutBucketVersioning operation. - - - The IAsyncResult returned by the call to BeginPutBucketVersioning. - - Returns a PutBucketVersioningResult from S3. - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT operation requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - The bucket name. - Container for the request. - - The response from the PutBucketWebsite service method, as returned by S3. - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT operation requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - Container for the necessary parameters to execute the PutBucketWebsite service method. - - The response from the PutBucketWebsite service method, as returned by S3. - - - - Initiates the asynchronous execution of the PutBucketWebsite operation. - - - Container for the necessary parameters to execute the PutBucketWebsite operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketWebsite - operation. - - - - Finishes the asynchronous execution of the PutBucketWebsite operation. - - - The IAsyncResult returned by the call to BeginPutBucketWebsite. - - Returns a PutBucketWebsiteResult from S3. - - - - - - Initiates the asynchronous execution of the PutCORSConfiguration operation. - - - Container for the necessary parameters to execute the PutCORSConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutCORSConfiguration - operation. - - - - Finishes the asynchronous execution of the PutCORSConfiguration operation. - - - The IAsyncResult returned by the call to BeginPutCORSConfiguration. - - Returns a PutCORSConfigurationResult from S3. - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - The name of the bucket for which to set the configuration. - A property of PutLifecycleConfigurationRequest used to execute the PutLifecycleConfiguration service method. - - The response from the PutLifecycleConfiguration service method, as returned by S3. - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - Container for the necessary parameters to execute the PutLifecycleConfiguration service method. - - The response from the PutLifecycleConfiguration service method, as returned by S3. - - - - Initiates the asynchronous execution of the PutLifecycleConfiguration operation. - - - Container for the necessary parameters to execute the PutLifecycleConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutLifecycleConfiguration - operation. - - - - Finishes the asynchronous execution of the PutLifecycleConfiguration operation. - - - The IAsyncResult returned by the call to BeginPutLifecycleConfiguration. - - Returns a PutLifecycleConfigurationResult from S3. - - - - - Initiates the asynchronous execution of the PutObject operation. - - - Container for the necessary parameters to execute the PutObject operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutObject - operation. - - - - Finishes the asynchronous execution of the PutObject operation. - - - The IAsyncResult returned by the call to BeginPutObject. - - Returns a PutObjectResult from S3. - - - - - Initiates the asynchronous execution of the PutObjectLegalHold operation. - - - Container for the necessary parameters to execute the PutObjectLegalHold operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutObjectLegalHold - operation. - - - - Finishes the asynchronous execution of the PutObjectLegalHold operation. - - - The IAsyncResult returned by the call to BeginPutObjectLegalHold. - - Returns a PutObjectLegalHoldResult from S3. - - - - - Initiates the asynchronous execution of the PutObjectLockConfiguration operation. - - - Container for the necessary parameters to execute the PutObjectLockConfiguration operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutObjectLockConfiguration - operation. - - - - Finishes the asynchronous execution of the PutObjectLockConfiguration operation. - - - The IAsyncResult returned by the call to BeginPutObjectLockConfiguration. - - Returns a PutObjectLockConfigurationResult from S3. - - - - - Initiates the asynchronous execution of the PutObjectRetention operation. - - - Container for the necessary parameters to execute the PutObjectRetention operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutObjectRetention - operation. - - - - Finishes the asynchronous execution of the PutObjectRetention operation. - - - The IAsyncResult returned by the call to BeginPutObjectRetention. - - Returns a PutObjectRetentionResult from S3. - - - - - Initiates the asynchronous execution of the PutObjectTagging operation. - - - Container for the necessary parameters to execute the PutObjectTagging operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutObjectTagging - operation. - - - - Finishes the asynchronous execution of the PutObjectTagging operation. - - - The IAsyncResult returned by the call to BeginPutObjectTagging. - - Returns a PutObjectTaggingResult from S3. - - - - - Initiates the asynchronous execution of the PutPublicAccessBlock operation. - - - Container for the necessary parameters to execute the PutPublicAccessBlock operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutPublicAccessBlock - operation. - - - - Finishes the asynchronous execution of the PutPublicAccessBlock operation. - - - The IAsyncResult returned by the call to BeginPutPublicAccessBlock. - - Returns a PutPublicAccessBlockResult from S3. - - - - - - - - - Initiates the asynchronous execution of the RestoreObject operation. - - - Container for the necessary parameters to execute the RestoreObject operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRestoreObject - operation. - - - - Finishes the asynchronous execution of the RestoreObject operation. - - - The IAsyncResult returned by the call to BeginRestoreObject. - - Returns a RestoreObjectResult from S3. - - - - - Initiates the asynchronous execution of the SelectObjectContent operation. - - - Container for the necessary parameters to execute the SelectObjectContent operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSelectObjectContent - operation. - - - - Finishes the asynchronous execution of the SelectObjectContent operation. - - - The IAsyncResult returned by the call to BeginSelectObjectContent. - - Returns a SelectObjectContentResult from S3. - - - - - Initiates the asynchronous execution of the UploadPart operation. - - - Container for the necessary parameters to execute the UploadPart operation on AmazonS3Client. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback - procedure using the AsyncState property. - - An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUploadPart - operation. - - - - Finishes the asynchronous execution of the UploadPart operation. - - - The IAsyncResult returned by the call to BeginUploadPart. - - Returns a UploadPartResult from S3. - - - - Custom pipeline handler to clean up streams in case of an exception. - - - - - Catch exceptions and clean up any open streams. - - - - - - Catch exceptions and clean up any open streams. - - - - - - Catch exceptions and clean up any open streams. - - - - - - - Custom pipeline handler to enable sig V4 for Get requests. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - IAsyncResult which represent an async operation. - - - - Custom pipeline handler to enable sig V4 for Get requests. - - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - IAsyncResult which represent an async operation. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - IAsyncResult which represent an async operation. - - - - Calls the post invoke logic after calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls the PostInvoke methods after calling the next handler - in the pipeline. - - The execution context, it contains the - request and response context. - - - - Constructor for AmazonS3RetryPolicy. - - The IClientConfig object - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - - - a value if it can be determined, or null if the IO-bound calculations need to be done - - - - Return true if the request should be retried. Implements additional checks - specific to S3 on top of the checks in DefaultRetryPolicy. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Marker interface to identify AmazonS3EncryptionClient. - - - - - Service metadata for Amazon S3 service - - - - - Gets the value of the Service Id. - - - - - Gets the dictionary that gives mapping of renamed operations - - - - - The parameters to request an abort of a multipart upload. - - - After a multipart upload is aborted, no additional parts can be uploaded using that upload ID. - The storage consumed by any previously uploaded parts will be freed. However, if any part uploads - are currently in progress, those part uploads might or might not succeed. As a result, it might be - necessary to abort a given multipart upload multiple times in order to completely free all storage - consumed by all parts. - - - - - The bucket name to which the upload was taking place. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The key of the S3 object that was being uploaded. - - - - - The upload id for the in-progress multipart upload that should be aborted. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the AbortMultipartUpload response metadata. - The AbortMultipartUpload operation has a void result type. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Bucket accelerate configuration. - - - - - The accelerate status of the bucket. - - - - - AccessControlTranslation class - - - - - The override value for the owner of the replica object. - - - - - Class for AnalyticsAndOperator - A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. - The operator must have at least two predicates, and an object must match all of the predicates - in order for the filter to apply. - - Note: The current implementation restricts the usage to atmost one AnalyticsPrefixPredicate - and any number of AnalyticsTagPredicates. - - - - Class for AnalyticsConfiguration - - - - - The identifier used to represent an analytics configuration. - - - - - The filter used to describe a set of objects for analyses. - A filter must have exactly one prefix, one tag, or one conjunction (AnalyticsAndOperator). - If no filter is provided, all objects will be considered in any analysis. - - - - - If present, it indicates that data related to access patterns will be collected - and made available to analyze the tradeoffs between different storage classes. - - - - - Class for AnalyticsExportDestination - - - - - A destination signifying output to an S3 bucket. - - - - - Filter class for Metrics. - - - - - Filter Predicate setup for specific filter types. - - - - - Filter Predicate abstract class for specific filter types to be derived from. - - - - - Abstract class that can be used over logical filter predicates,i.e. AND/OR. - - - - - Internal implementation of Metrics Predicate visitor interface. - - - - - Interface for implementing visitor pattern in Analytics Predicate Filter. - - - - - Interface for implementing visitor pattern in Inventory Predicate Filter. - - - - - Interface for implementing visitor pattern in Metrics Predicate Filter. - - - - - Defines the interface that is used to visit all the different - implementations of - - - - - Visit a - - - - - - Visit a - - - - - - Visit a - - - - - - Implementation of to marshall . - - - - - AbortIncompleteMultipartUpload Unmarshaller - - - - - Abort Multipart Upload Request Marshaller - - - - - Response Unmarshaller for AbortMultipartUpload operation - - - - - AnalyticsConfiguration Unmarshaller - - - - - AnalyticsExportDestinationUnmarshaller - - - - - AnalyticsFilter Unmarshaller - - - - - AnalyticsS3BucketDestination Unmarshaller - - - - - Bucket Unmarshaller - - - - - CommonPrefixesItem Unmarshaller - - - - - Complete Multipart Upload Request Marshaller - - - - - Response Unmarshaller for CompleteMultipartUpload operation - - - - - ContentsItem Unmarshaller - - - - - Copy Object Request Marshaller - - - - - Response Unmarshaller for CopyObject operation - - - - - Upload Part Copy Request Marshaller - - - - - Response Unmarshaller for CopyPart operation - - - - - CORSRule Unmarshaller - - - - - Response Unmarshaller for DefaultRetention Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Delete InventoryConfiguration Request Marshaller - - - - - Response Unmarshaller for DeleteAnalyticsConfiguration operation - - - - - Response Unmarshaller for DeleteCORSConfiguration operation - - - - - Delete InventoryConfiguration Request Marshaller - - - - - Response Unmarshaller for DeleteInventoryConfiguration operation - - - - - Delete Bucket MetricsConfiguration Request Marshaller - - - - - Response Unmarshaller for DeleteBucketMetricsConfiguration operation - - - - - Delete Bucket Policy Request Marshaller - - - - - Response Unmarshaller for DeleteBucketPolicy operation - - - - - Delete Bucket Request Marshaller - - - - - Response Unmarshaller for DeleteBucket operation - - - - - Delete Bucket Tagging Request Marshaller - - - - - Response Unmarshaller for DeleteBucketTagging operation - - - - - Delete Bucket Website Request Marshaller - - - - - Response Unmarshaller for DeleteBucketWebsite operation - - - - - Delete Bucket Cors Request Marshaller - - - - - DeletedObject Unmarshaller - - - - - Delete Bucket Lifecycle Request Marshaller - - - - - Response Unmarshaller for DeleteBucketLifecycle operation - - - - - Delete Object Request Marshaller - - - - - Response Unmarshaller for DeleteObject operation - - - - - Delete Objects Request Marshaller - - - - - Response Unmarshaller for DeleteObjects operation - - - - - DeleteObjectTaggingRequest Marshaller - - - - - Marshall DeleteObjectTaggingRequest object into an http request. - - - - - Marshall DeleteObjectTaggingRequest object into an http request. - - - - - Response Unmarshaller for DeleteObjectTagging operation - - - - - DeletePublicAccessBlock Request Marshaller - - - - - Response Unmarshaller for DeletePublicAccessBlock operation - - - - - ErrorsItem Unmarshaller - - - - - Expiration Unmarshaller - - - - - FilterRule Unmarshaller - - - - - Filter Unmarshaller - - - - - Get Object Acl Request Marshaller - - - - - Response Unmarshaller for GetACL operation - - - - - Get Object Accelerate Configuration Request Marshaller - - - - - Response Unmarshaller for GetACL operation - - - - - Get BucketAnalyticsConfiguration Request Marshaller - - - - - Response Unmarshaller for GetAnalyticsConfiguration operation - - - - - Get InventoryConfiguration Request Marshaller - - - - - Response Unmarshaller for GetInventoryConfiguration operation - - - - - Get Bucket Location Request Marshaller - - - - - Response Unmarshaller for GetBucketLocation operation - - - - - Get Bucket Logging Request Marshaller - - - - - Response Unmarshaller for GetBucketLogging operation - - - - - Get Bucket MetricsConfigurationRequest Marshaller - - - - - Response Unmarshaller for GetBucketMetricsConfiguration operation - - - - - Get Bucket Notification Request Marshaller - - - - - Response Unmarshaller for GetBucketNotification operation - - - - - Get BucketName Policy Request Marshaller - - - - - Response Unmarshaller for GetBucketPolicy operation - - - - - GetBucketPolicyStatusRequestMarshaller - - - - - Response Unmarshaller for GetBucketPolicyStatus operation - - - - - Get Bucket Request Payment Request Marshaller - - - - - Response Unmarshaller for GetBucketRequestPayment operation - - - - - Get Bucket Tagging Request Marshaller - - - - - Response Unmarshaller for GetBucketTagging operation - - - - - Get Bucket Versioning Request Marshaller - - - - - Response Unmarshaller for GetBucketVersioning operation - - - - - Get Bucket Website Request Marshaller - - - - - Response Unmarshaller for GetBucketWebsite operation - - - - - Get Bucket Cors Request Marshaller - - - - - Response Unmarshaller for GetCORSConfiguration operation - - - - - Get Bucket Lifecycle Request Marshaller - - - - - Response Unmarshaller for GetLifecycleConfiguration operation - - - - - GetObjectLegalHold Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for GetObjectLegalHold operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - GetObjectLockConfiguration Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for GetObjectLockConfiguration operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - GetObjectMetadata Marshaller - - - - - Response Unmarshaller for GetObjectMetadata operation - - - - - Get Object Request Marshaller - - - - - Response Unmarshaller for GetObject operation - - - - - GetObjectRetention Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for GetObjectRetention operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - GetObjectTaggingRequest Marshaller - - - - - Marshall GetObjectTaggingRequest into an http request. - - - - - Marshall GetObjectTaggingRequest into an http request. - - - - - Response Unmarshaller for GetObjectTagging operation - - - - - Get Object Torrent Request Marshaller - - - - - Response Unmarshaller for GetObjectTorrent operation - - - - - GetPublicAccessBlockRequestMarshaller - - - - - Response Unmarshaller for GetPublicAccessBlock operation - - - - - Grantee Unmarshaller - - - - - Grant Unmarshaller - - - - - Head Bucket Request Marshaller - - - - - Response Unmarshaller for HeadBucket operation - - - - - Create Multipart Upload Request Marshaller - - - - - Response Unmarshaller for InitiateMultipartUpload operation - - - - - Initiator Unmarshaller - - - - - InventoryConfiguration Unmarshaller - - - - - InventoryDestination Unmarshaller - - - - - InventoryEncryption Unmarshaller - - - - - InventoryFilter Unmarshaller - - - - - InventoryS3BucketDestination Unmarshaller - - - - - InventorySchedule Unmarshaller - - - - - LifecycleFilterPredicate Unmarshaller - - - - - LifecycleRuleNoncurrentVersionExpiration Unmarshaller - - - - - LifecycleRuleNoncurrentVersionTransition Unmarshaller - - - - - List AnalyticsConfiguration Request Marshaller - - - - - Response Unmarshaller for ListAnalyticsConfiguration operation - - - - - List InventoryConfiguration Request Marshaller - - - - - Response Unmarshaller for ListInventoryConfiguration operation - - - - - List Bucket MetricsConfigurationRequest Marshaller - - - - - Response Unmarshaller for ListBucketMetricsConfiguration operation - - - - - List Buckets Request Marshaller - - - - - Response Unmarshaller for ListBuckets operation - - - - - List Multipart Uploads Request Marshaller - - - - - Response Unmarshaller for ListMultipartUploads operation - - - - - List Objects Request Marshaller - - - - - Response Unmarshaller for ListObjects operation - - - - - List Objects Request Marshaller - - - - - Response Unmarshaller for ListObjects operation - - - - - List Parts Request Marshaller - - - - - Response Unmarshaller for ListParts operation - - - - - List Object Versions Request Marshaller - - - - - Response Unmarshaller for ListVersions operation - - - - - LoggingEnabled Unmarshaller - - - - - MetricsConfiguration Unmarshaller - - - - - MetricsFilte Unmarshaller - - - - - UploadsItem Unmarshaller - - - - - Response Unmarshaller for ObjectLockConfiguration Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Response Unmarshaller for ObjectLockLegalHold Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Response Unmarshaller for ObjectLockRetention Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Response Unmarshaller for ObjectLockRule Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Owner Unmarshaller - - - - - PartsItem Unmarshaller - - - - - PolicyStatus Unmarshaller - - - - - PublicAccessBlockConfiguration Unmarshaller - - - - - Put Object Acl Request Marshaller - - - - - Response Unmarshaller for PutObjectAcl operation - - - - - Put Object Acl Request Marshaller - - - - - Response Unmarshaller for PutBucketAccelerate operation - - - - - Request Marshaller for PutAnalyticsConfiguration operation - - - - - Response Unmarshaller for PutBucketAnalytics operation - - - - - Request Marshaller for PutInventoryConfiguration operation - - - - - Response Unmarshaller for PutBucketWebsite operation - - - - - Enable Bucket Logging Request Marshaller - - - - - Response Unmarshaller for PutBucketLogging operation - - - - - Put Bucket MetricsConfigurationRequest Marshaller - - - - - Response Unmarshaller for PutBucketMetricsConfiguration operation - - - - - Put Bucket Notification Request Marshaller - - - - - Response Unmarshaller for PutBucketNotification operation - - - - - Put Bucket Policy Request Marshaller - - - - - Response Unmarshaller for PutBucketPolicy operation - - - - - Put Buckeyt Replication Request Marshaller - - - - - Response Unmarshaller for PutBucketReplication operation. - - - - - Put Bucket Request Marshaller - - - - - Put Bucket Request Payment Request Marshaller - - - - - Response Unmarshaller for PutBucketRequestPayment operation - - - - - Response Unmarshaller for PutBucket operation - - - - - Put Bucket Tagging Request Marshaller - - - - - Response Unmarshaller for PutBucketTagging operation - - - - - Put Bucket Versioning Request Marshaller - - - - - Response Unmarshaller for PutBucketVersioning operation - - - - - Put Bucket Website Request Marshaller - - - - - Response Unmarshaller for PutBucketWebsite operation - - - - - Put Bucket Cors Request Marshaller - - - - - Response Unmarshaller for PutCORSConfiguration operation - - - - - Put Bucket Lifecycle Request Marshaller - - - - - Response Unmarshaller for PutLifecycleConfiguration operation - - - - - PutObjectLegalHold Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for PutObjectLegalHold operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - PutObjectLockConfiguration Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for PutObjectLockConfiguration operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Put Object Request Marshaller - - - - - Response Unmarshaller for PutObject operation - - - - - PutObjectRetention Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for PutObjectRetention operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Delete Object Tagging Request Marshaller - - - - - Marshall PutObjectTaggingRequest into an http request. - - - - - Marshall PutObjectTaggingRequest into an http request. - - - - - Response Unmarshaller for DeleteObjectTagging operation - - - - - PutPublicAccessBlock Request Marshaller - - - - - Response Unmarshaller for PutPublicAccessBlock operation - - - - - Restore Object Request Marshaller - - - - - Response Unmarshaller for RestoreObject operation - - - - - Condition Unmarshaller - - - - - Redirect Unmarshaller - - - - - RoutingRule Unmarshaller - - - - - RulesItem Unmarshaller - - - - - Response Unmarshaller for all Errors - - - - - Build an S3ErrorResponse from XML - - The XML parsing context. - Usually an Amazon.Runtime.Internal.UnmarshallerContext. - An S3ErrorResponse object. - - - - Grant Unmarshaller - - - - - Class for unmarshalling S3 service responses - - - - - Specialized S3 unmarshaller context. - - - - - Wrap an XmlTextReader with state for event-based parsing of an XML stream. - - Stream with the XML from a service response. - If set to true, maintains a copy of the complete response body as the stream is being read. - Response data coming back from the request - - - - Reads to the next node in the XML document, and updates the context accordingly. - If node is RequestId, reads the contents and stores in RequestId property. - - - True if a node was read, false if there are no more elements to read./ - - - - - SSEKMS Unmarshaller - - - - - StorageClassAnalysisDataExportDataExportUnmarshaller - - - - - StorageClassAnalysisUnmarshaller - - - - - Tag Unmarshaller - - - - - TopicConfiguration Unmarshaller - - - - - Transition Unmarshaller - - - - - Upload Part Request Marshaller - - - - - Response Unmarshaller for UploadPart operation - - - - - VersionsItem Unmarshaller - - - - - Internal implementation of Inventory Predicate visitor interface. - - - - - Internal implementation of Metrics Predicate visitor interface. - - - - - Class for AnalyticsPrefixPredicate - The prefix used when evaluating a metrics filter. - - - - - Class for AnalyticsS3BucketDestination - - - - - The file format used when exporting data to Amazon S3. - - - - - The account ID that owns the destination bucket. If no account ID is provided, the owner will not be validated prior to exporting data. - - - - - The Amazon resource name (ARN) of the bucket to which data is exported. - - - - - The prefix to use when exporting data. The exported data begins with this prefix. - - - - - Class for MetricsTagPredicate - The tag used when evaluating a metrics filter. - - - - - This class represents the byte range for a range GET from S3. - - - - - Constructs a ByteRange and sets the start and end. - - - - - - - Constructs a ByteRange and sets the header to the value specified. - - - - - - A private string, represending the byte range. - - - - - The starting byte number of the range - - - - - The ending byte number of the range - - - - - The formatted string representing the byte range to be set for the range header. - - - - - Container for the parameters to the CompleteMultipartUpload operation. - Completes a multipart upload by assembling previously uploaded parts. - - - - - The name of the bucketName containing the S3 object that was being uploaded in parts. - - - - - The key of the S3 object that was being uploaded. - - - - - A collection of part numbers and corresponding etags. - - - - - Adds a collection of part numbers and corresponding etags. - - PartETags that will added to this request. - - - - Adds a collection of part numbers and corresponding etags. - - PartETags that will added to this request. - - - - Adds a collection of part numbers and corresponding etags by transforming the UploadPartResponses into PartETags. - - The list of response objects return from UploadParts. - - - - Adds a collection of part numbers and corresponding etags by transforming the UploadPartResponses into PartETags. - - The list of response objects return from UploadParts. - - - - Adds a collection of part numbers and corresponding etags by transforming the CopyPartResponse into PartETags. - - The list of response objects return from CopyParts. - - - - Adds a collection of part numbers and corresponding etags by transforming the CopyPartResponse into PartETags. - - The list of response objects return from CopyParts. - - - - The upload id for the in-progress multipart upload that should be completed. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the CompleteMultipartUpload response and response metadata. - - - - - Gets and sets the URI that identifies the newly created object. - - - - - Gets and sets the name of the bucketName that contains the newly created object. - - - - - Gets and sets the object key of the newly created object. - - - - - Gets and sets Entity tag that identifies the newly created object's data. Objects with different - object data will have different entity tags. The entity tag is an opaque string. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - Gets and sets the ServerSideEncryptionMethod property. - Specifies the encryption used on the server to - store the content. - Default is None. - - - - - Gets and sets the VersionId property. - This is the version-id of the S3 object - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the CopyObject operation. - Creates a copy of an object that is already stored in Amazon S3. - - - Container for the parameters to the CopyObject operation. - Creates a copy of an object that is already stored in Amazon S3. - - - - - The name of the bucket containing the object to copy. - - - - - Checks if SourceBucket property is set. - - true if SourceBucket property is set. - - - - The key of the object to copy. - - - - - Checks if SourceKey property is set. - - true if SourceKey property is set. - - - - Specifies a particular version of the source object to copy. By default the latest version is copied. - - - - - Checks if SourceVersionId property is set. - - true if SourceVersionId property is set. - - - - The name of the bucket to contain the copy of the source object. - - - - - Checks if DestinationBucket property is set. - - true if DestinationBucket property is set. - - - - The key to be given to the copy of the source object. - - - - - Checks if DestinationKey property is set. - - true if DestinationKey property is set. - - - - A canned access control list (CACL) to apply to the object. - Please refer to for - information on S3 Canned ACLs. - - - - - ETag to be matched as a pre-condition for copying the source object - otherwise returns a PreconditionFailed. - - - Copies the object if its entity tag (ETag) matches - the specified tag; otherwise return a 412 (precondition failed). - Constraints: This property can be used with IfUnmodifiedSince, - but cannot be used with other conditional copy properties. - - - - - Checks if ETagToMatch property is set. - - - Copies the object if its entity tag (ETag) is different - than the specified Etag; otherwise returns a 412 (failed condition). - Constraints: This header can be used with IfModifiedSince, but cannot - be used with other conditional copy properties. - - true if ETagToMatch property is set. - - - - ETag that must not be matched as a pre-condition for copying the source object, - otherwise returns a PreconditionFailed. - - - - - Checks if ETagToNotMatch property is set. - - true if ETagToNotMatch property is set. - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or - ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Copies the object if it has been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it has been modified since the - specified time; otherwise returns a 412 (failed condition). - Constraints: This property can be used with ETagToNotMatch, - but cannot be used with other conditional copy properties. - - - - - Copies the object if it has been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it has been modified since the - specified time; otherwise returns a 412 (failed condition). - Constraints: This property can be used with ETagToNotMatch, - but cannot be used with other conditional copy properties. - - - - - Checks if ModifiedSinceDateUtc property is set. - - true if ModifiedSinceDateUtc property is set. - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or - UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Copies the object if it has not been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it hasn't been modified since the - specified time; otherwise returns a 412 (precondition failed). - Constraints: This property can be used with ETagToMatch, - but cannot be used with other conditional copy properties. - - - - - Copies the object if it has not been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it hasn't been modified since the - specified time; otherwise returns a 412 (precondition failed). - Constraints: This property can be used with ETagToMatch, - but cannot be used with other conditional copy properties. - - - - - Checks if UnmodifiedSinceDateUtc property is set. - - true if UnmodifiedSinceDateUtc property is set. - - - - Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request. - - - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - Specifies whether you want to apply a Legal Hold to the copied object. - - - - - - Gets and sets the property ObjectLockMode. - - The Object Lock mode that you want to apply to the copied object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - The date and time when you want the copied object's Object Lock to expire. - - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - Checks if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - true if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - - - The type of storage to use for the object. Defaults to 'STANDARD'. - - - - - - If the bucketName is configured as a website, redirects requests for this object to another object in the same bucketName or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - This is a convenience property for Headers.ContentType. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - /// - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The customer provided encryption key for the source object of the copy. - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - true if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the CopySourceServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if CopySourceServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - The tag-set for the object destination object this value must be used in conjunction with the TaggingDirective. The tag-set must be encoded as URL Query parameters. - - - - - Checks if Tagging property is set - - true if Tagging is set. - - - - Overrides the default request timeout value. - - - - If the value is set, the value is assigned to the Timeout property of the HTTPWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Overrides the default ReadWriteTimeout value. - - - - If the value is set, the value is assigned to the ReadWriteTimeout property of the HTTPWebRequest/WebRequestHandler object used - to send requests. - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - - Returns information about the CopyObject response and response metadata. - - - - - Gets and sets the ETag property. - - - - - Gets and sets the LastModified property. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - Gets and sets the SourceVersionId property. - This is the Version Id of the Source Object - - - - - Version ID of the newly created copy. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the CopyPart operation. - Uploads a part by copying data from an existing object as data source. - - - Container for the parameters to the CopyPart operation. - Uploads a part by copying data from an existing object as data source. - - - - - The name of the bucket containing the object to copy. - - - - - Checks if SourceBucket property is set. - - true if SourceBucket property is set. - - - - The key of the object to copy. - - - - - Checks if SourceKey property is set. - - true if SourceKey property is set. - - - - Specifies a particular version of the source object to copy. By default the latest version is copied. - - - - - Checks if SourceVersionId property is set. - - true if SourceVersionId property is set. - - - - The name of the bucket to contain the copy of the source object. - - - - - Checks if DestinationBucket property is set. - - true if DestinationBucket property is set. - - - - The key to be given to the copy of the source object. - - - - - Checks if DestinationKey property is set. - - true if DestinationKey property is set. - - - - The ID identifying multipart upload for which we are copying a part. - - - - - Checks if UploadId property is set. - - true if UploadId property is set. - - - - Collection of ETags to be matched as a pre-condition for copying the source object - otherwise returns a PreconditionFailed. - - - Copies the object if its entity tag (ETag) matches one of - the specified tags; otherwise return a 412 (precondition failed). - Constraints: This property can be used with IfUnmodifiedSince, - but cannot be used with other conditional copy properties. - - - - - Checks if ETagsToMatch property is set. - - true if ETagToMatch property is set. - - - - Collection of ETags that must not be matched as a pre-condition for copying the source object - otherwise returns a PreconditionFailed. - - - Copies the object if its entity tag (ETag) does not match any of the specified - tags; otherwise returns a 412 (failed condition). - Constraints: This header can be used with IfModifiedSince, but cannot - be used with other conditional copy properties. - - - - - Checks if ETagToNotMatch property is set. - - true if ETagToNotMatch property is set. - - - - Copies the object if it has been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it has been modified since the - specified time; otherwise returns a 412 (failed condition). - Constraints: This property can be used with ETagToNotMatch, - but cannot be used with other conditional copy properties. - - - - - Checks if ModifiedSinceDate property is set. - - true if ModifiedSinceDate property is set. - - - - Copies the object if it has not been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it hasn't been modified since the - specified time; otherwise returns a 412 (precondition failed). - Constraints: This property can be used with ETagToMatch, - but cannot be used with other conditional copy properties. - - - - - Checks if UnmodifiedSinceDate property is set. - - true if UnmodifiedSinceDate property is set. - - - - The number of the part to be copied. - - - Valid part numbers are from 1 to 10,000 inclusive and will uniquely identify the part - and determine the relative ordering within the destination object. If a part already - exists with the PartNumber it will be overwritten. - - - - - Checks if PartNumber property is set. - - true if PartNumber property is set. - - - - The location of the first byte in the range if only a portion of the - source object is to be copied as the part. - - - The LastByte property must also be set or this value will be ignored. - - - - - Checks if FirstByte property is set. - - true if FirstByte property is set. - - - - The location of the last byte in the range if only a portion of the - source object is to be copied as the part. - - - The FirstByte property must also be set or this value will be ignored. - - - - - Checks if LastByte property is set. - - true if LastByte property is set. - - - - - This property is obsolete. Use ServerSideEncryptionMethod in InitiateMultipartUploadRequest instead. - - - Default: None - - - - - - Checks if ServerSideEncryptionMethod property is set. - - true if ServerSideEncryptionMethod property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - This property is obsolete. Use ServerSideEncryptionKeyManagementServiceKeyId in InitiateMultipartUploadRequest instead. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The customer provided encryption key for the source object of the copy. - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - true if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the CopySourceServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if CopySourceServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - - - Overrides the default request timeout value. - - - - If the value is set, the value is assigned to the Timeout property of the HTTPWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Overrides the default ReadWriteTimeout value. - - - - If the value is set, the value is assigned to the ReadWriteTimeout property of the HTTPWebRequest/WebRequestHandler object used - to send requests. - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - - Returns information about the CopyPart response and response metadata. - - - - - The version of the source object that was copied, if you have enabled versioning on the source bucketName. - - - - - - Entity tag of the object. - - - - - - Date and time at which the object was uploaded. - - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - Gets and sets the PartNumber property. - This is the part number in it's multi-part upload that will uniquely identify the part - and determine the relative ordering within the destination object. - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - A collection of up to 100 cross-origin resource sharing (CORS) rules. - - - - - The collection of rules in this configuration. - - - - C O R S Rule - - - - - Identifies HTTP methods that the domain/origin specified in the rule is allowed to execute. - - - - - - One or more origins you want customers to be able to access the bucket from. - - - - - - An optional unique identifier for the rule. - - - The ID value can be up to 255 characters long. The IDs help you find a rule in the configuration. - - - - - Checks if Id property is set. - - true if Id property is set. - - - - One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript - XMLHttpRequest object). - - - - - - The time in seconds that your browser is to cache the preflight response for the specified resource. - - - - - - Specifies which headers are allowed in a pre-flight OPTIONS request through the - Access-Control-Request-Headers header. - - - Each header name specified in the Access-Control-Request-Headers must have a corresponding - entry in the rule. Only the headers that were requested will be sent back. - This element can contain at most one * wildcard character. - - - - - Checks if AllowedHeaders property is set. - - true if AllowedHeaders property is set. - - - - Describes how a CSV-formatted input object is formatted. - - - - - Describes the first line of input. Valid values: None, Ignore, Use. - - - - - Single character used to indicate a row should be ignored when present at the start of a row. - - - - - Single character used for escaping the quote character inside an already escaped value. - - - - - Value used to separate individual records. - - - - - Value used to separate individual fields in a record. - - - - - Value used for escaping where the field delimiter is part of the value. - - - - - Specifies that CSV field values may contain quoted record delimiters and such records should be allowed. Default value is FALSE. Setting this value to TRUE may lower performance. - - - - - Describes how CSV-formatted results are formatted. - - - - - Indicates whether or not all output fields should be quoted. - - - - - Single character used for escaping the quote character inside an already escaped value. - - - - - Value used to separate individual records. - - - - - Value used to separate individual fields in a record. - - - - - Value used for escaping where the field delimiter is part of the value. - - - - - The container element for specifying the default Object Lock retention settings for - new objects placed in the specified bucket. - - - - - Gets and sets the property Days. - - The number of days that you want to specify for the default retention period. - - - - - - Gets and sets the property Mode. - - The default Object Lock retention mode you want to apply to new objects placed in - the specified bucket. - - - - - - Gets and sets the property Years. - - The number of years that you want to specify for the default retention period. - - - - - - Container for the parameters to the DeleteBucketAnalyticsConfiguration operation. - Deletes an analytics configuration for the bucket (specified by the analytics configuration ID). - - - - - The name of the bucket from which an analytics configuration is deleted. - - - - - The identifier used to represent an analytics configuration. - - - - - Returns information about the DeleteBucketAnalyticsConfiguration response metadata. - The DeleteBucketAnalyticsConfiguration operation has a void result type. - - - - - Request object for the DeleteBucketEncryption operation. - Request Deletes the server-side encryption configuration from the bucket. - - - - - The name of the bucket containing the server-side encryption configuration to delete. - - - - - Returns information about the DeleteBucketEncryption response metadata. - The DeleteBucketEncryption operation has a void result type. - - - - - Container for the parameters to the DeleteInventoryConfiguration operation. - Deletes an inventory configuration (identified by the inventory ID) from the bucket. - - - - - The name of the bucket containing the inventory configuration to delete. - - - - - The ID used to identify the inventory configuration. - - - - - Returns information about the DeleteInventoryConfiguration response metadata. - The DeleteInventoryConfiguration operation has a void result type. - - - - - Container for the parameters to the DeleteBucketMetricsConfiguration operation. - Deletes a metrics configuration (specified by the metrics configuration ID) from the bucket. - - - - - The name of the bucket on which Inventory configuration is to be removed. - - - - - The ID used to identify the metrics configuration. - - - - - Returns information about the DeleteBucketMetricsConfiguration response metadata. - The DeleteBucketMetricsConfiguration operation has a void result type. - - - - - Container for the parameters to the DeleteBucketPolicy operation. - Deletes the policy from the bucket. - - - - - The bucket on which the policy is to be deleted. - - - - - Returns information about the DeleteBucketPolicy response metadata. - The DeleteBucketPolicy operation has a void result type. - - - - - Request object for the DeleteBucketReplication operation. - - - - - Gets and sets the property BucketName. -

Deletes the replication subresource associated with the specified - bucket.

There is usually some time lag before - replication configuration deletion is fully propagated to all the - Amazon S3 systems.

For more information, see - - Cross-Region Replication (CRR) in the Amazon S3 Developer - Guide.

- - - - - Returns information about the DeleteBucketReplication response metadata. - The DeleteBucketReplication operation has a void result type. - - - - - Container for the parameters to the DeleteBucket operation. - Deletes the bucket. All objects (including all object versions and Delete Markers) in the bucket must be deleted before the bucket - itself can be deleted. - - - - - The name of the bucket to be created. - - - - - The region locality for the bucket. - - - When set, this will determine the region the bucket exists in. - Refer - for a list of possible values. - - - - - If set to true the bucket will be deleted in the same region as the configuration of the AmazonS3 client. - DeleteBucketRequest.BucketRegion takes precedence over this property if both are set. - Default: true. - - - - - Returns information about the DeleteBucket response metadata. - The DeleteBucket operation has a void result type. - - - - - The parameters to request deletion of a tag set from a bucket. - - - To use this operation, you must have permission to perform the s3:PutBucketTagging action. - By default, the bucket owner has this permission and can grant this permission to others. - - - - - The name of the bucket on which the tag set is to be removed. - - - - - Returns information about the DeleteBucketTagging response metadata. - The DeleteBucketTagging operation has a void result type. - - - - - Container for the parameters to the DeleteBucketWebsite operation. - This operation removes the website configuration from the bucket. - - - - - The name of the bucket on which website configuration is to be removed. - - - - - Returns information about the DeleteBucketWebsite response metadata. - The DeleteBucketWebsite operation has a void result type. - - - - - Container for the parameters to the DeleteCORSConfiguration operation. - Deletes the cors configuration information set for the bucket. - - - - - Gets and sets the BucketName property. - - - - - Returns information about the DeleteCORSConfiguration response metadata. - The DeleteCORSConfiguration operation has a void result type. - - - - - Contains information about a successful delete operation against a specific S3 object. - - - - - Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a - delete marker. In a simple DELETE, this header indicates whether (true) or not (false) a delete - marker was created. - - - - - The version ID of the delete marker created as a result of the DELETE operation. If you delete a - specific object version, the value returned by this header is the version ID of the object version - deleted. - - - - - The key of the deleted S3 object. - - - - - The version of the deleted S3 object. - - - - - Contains information about a failed delete operation against a specific S3 object. - - - - - The key of the S3 object. - - - - - The version of the S3 object. - - - - - The failure code for the delete error. - - - - - The failure message for the delete error. - - - - - The parameters to request deletion of the lifecycle configuration on a bucket. - - - - Amazon S3 removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. - Your objects never expire, and Amazon S3 no longer automatically deletes any objects on the basis of rules contained - in the deleted lifecycle configuration. - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration action. By default, the - bucket owner has this permission and the bucket owner can grant this permission to others. - - - There is usually some time lag before lifecycle configuration deletion is fully propagated to all the Amazon S3 systems. - - - - - - The name of the bucket on which the lifecycle configuration is to be deleted. - - - - - Returns information about the DeleteLifecycleConfiguration response metadata. - The DeleteLifecycleConfiguration operation has a void result type. - - - - -

Specifies whether Amazon S3 should replicate delete makers.

- - - - - Gets and sets the property Status. -

The status of the delete marker replication.

-

In the current implementation, Amazon S3 does not replicate - the delete markers. Therefore, the status must be - Disabled.

- - - - - The parameters to request deletion of an object in a bucket. - The operation removes the null version (if there is one) of an object and inserts a delete marker, which - becomes the latest version of the object. - - - - To remove a specific version, you must be the bucket owner and you must use the versionId subresource. - Using this subresource permanently deletes the version. - - - If the object you want to delete is in a bucket where the bucket versioning configuration is MFA Delete enabled, - you must include specify the MFA serial number and value in the request. - - - If there isn't a null version, Amazon S3 does not remove any objects. - - - - - - The bucket name of the bucket containing the object. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property BypassGovernanceRetention. - - - - - The key identifying the object to delete. - - - - - The identifier for the specific version of the object to be deleted, if required. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - The MfaCodes Tuple associates the Serial Number and the current Token/Code displayed on the - Multi-Factor Authentication device associated with your AWS Account. - - - This is a required property for this request if:
- 1. EnableMfaDelete was configured on the bucket - containing this object's version.
- 2. You are deleting an object's version - - - - - Checks if the MfaCodes property is set. - - true if the MfaCodes property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the DeleteObject response and response metadata. - - - - - Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a delete marker. - - - - - - Returns the version ID of the delete marker created as a result of the DELETE operation. - - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the DeleteObjects operation. - This operation enables you to delete multiple objects from a bucket using a single HTTP request. You may specify up to 1000 - keys. - - - Container for the parameters to the DeleteObjects operation. - This operation enables you to delete multiple objects from a bucket using a single HTTP request. You may specify up to 1000 - keys. - - - - - The bucket name containing the objects to delete. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property BypassGovernanceRetention. - - Specifies whether you want to delete this object even if it has a Governance-type - Object Lock in place. You must have sufficient permissions to perform this operation. - - - - - - List of object keys to delete. - - - - - Toggles between Quiet and Verbose mode for the operation. - If set to true (Quiet mode), the response includes only those keys for objects on which - the delete operation failed. - - - By default this property is false and keys for both successful deletes - and failures are returned in the response. - - - - - The MfaCodes Tuple associates the Serial Number and the current Token/Code displayed on the - Multi-Factor Authentication device associated with your AWS Account. - - - This is a required property for this request if:
- 1. EnableMfaDelete was configured on the bucket - containing this object's version.
- 2. You are deleting an object's version - - - - - Checks if the MfaCodes property is set. - - true if the MfaCodes property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Add a key to the set of keys of objects to be deleted. - - Object key - - - - Add a key and a version to be deleted. - - Key of the object to be deleted. - Version of the object to be deleted. - - - - Add a KeyVersion object representing the S3 object to be deleted. - - KeyVersion representation of object to be deleted. - - - - Returns information about the DeleteObjects response and response metadata. - - - - - A default constructor for DeleteObjectsResponse - - - - - Gets and sets the DeletedObjects property. - A list of successful deletes. - Set only when Quiet=false on DeleteObjectsRequest. - - - - - Gets and sets the DeleteErrors property. - A list of errors encountered while deleting objects. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Sets the with information about DeleteObjectsResponse - - The that holds the serialized object data. - The that contains contextual information about the source or destination. - - - - Sets the with information about the DeleteObjectsResponse. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - - - - Container for the parameters to the DeleteObjectTaggingRequest operation. - - - - - The bucket name containing the objects from which to remove the tags. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Check to see if Bucket property is set - - - - - The key identifying the object tagging to delete. - - - - - Check to see if Key property is set - - - - - The identifier for the specific version of the object to be deleted, if required. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - Returns information about the DeleteObjectTagging response and response metadata. - - - - - Returns the version ID of the delete marker created as a result of the DELETE operation. - - - - - Check to see if VersionId property is set - - - - - Container for the parameters to the DeletePublicAccessBlock operation. - Removes the Public Access Block configuration for an Amazon S3 bucket. - - - - - Gets and sets the property BucketName. - - The Amazon S3 bucket whose Public Access Block configuration you want to delete. - - - - - - This is the response object from the DeletePublicAccessBlock operation. - - - - - EncryptionConfiguration class - - - - - The ID of the AWS KMS key for the region where the destination bucket - resides. Amazon S3 uses this key to encrypt the replica object. - - - - - The Continuation Event. - - - - - Constructs a Continuation Event. - - - - - Constructs a Continuation Event. - - - - - - The End Event. - - - - - Constructs an End Event. - - - - - Constructs an End Event. - - - - - - Common Contract for S3 Events. - - - - - The Progress event details. - - - - - Current number of object bytes scanned. - - - - - Current number of uncompressed object bytes processed. - - - - - Total number of bytes of records payload data returned. - - - - - Constructs a instance of Progress. - - - - - The Progress Event. - - - - - The Progress event details. - - - - - Constructs a ProgressEvent. - - - - - Constructs a ProgressEvent. - - - - - - The Records Event - - - - - The byte array of partial, one or more result records. - - Payload is a , which is not thread-safe. - - - - - Constructs a RecordsEvent - - - - - Creates a new End Event. - - - - - - Modeled Exception that either comes over the stream from the service model, or wraps other exceptions for the purpose of raising events. If it is - modelled, it will be a subclass. - - - - - Creates a new S3EventStreamException - - - - - Creates a new S3EventStreamException - - - - - - Creates a new S3EventStreamException - - - - - - - Constructs a new instance of the S3EventStreamException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - The contract for the SelectObjectContentEventStream. - - - - - Event that encompasses all IS3Events. - - - - - Event that encompasses S3EventStreamExceptions. - - - - - Reaised when a Records event is received. - - - - - Reaised when a Stats event is received. - - - - - Reaised when a Progress event is received. - - - - - Reaised when a Continuation event is received. - - - - - Reaised when an End event is received. - - - - - A Stream of Events returned by the SelectObjectContent operation. Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treaded as mutually exclusive. - - - - - The mapping of event message to a generator function to construct the matching Event Stream event. - - - - - The mapping of event message to a generator function to construct the matching Event Stream exception. - - - - - Whether the backround processing loop is running. - - - - - Event that encompasses all IS3Events. - - - - - Event that encompasses S3EventStreamExceptions. - - - - - Reaised when a Records event is received. - - - - - Reaised when a Stats event is received. - - - - - Reaised when a Progress event is received. - - - - - Reaised when a Continuation event is received. - - - - - Reaised when an End event is received. - - - - - Event Stream returned by SelectObjectContentStream. - - Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treated as mutually exclusive. - - The network stream which events will be parsed from. - - - - Event Stream returned by SelectObjectContentStream. - - Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treaded as mutually exclusive. - - The network stream which events will be parsed from. - The decoder responsible for parsing events. - - - - The Stats event details. - - - - - Total number of object bytes scanned. - - - - - Total number of uncompressed object bytes processed. - - - - - Total number of bytes of records payload data returned. - - - - - Constructs an instance of Stats. - - - - - The Stats Event. - - - - - The Stats event details. - - - - - Constructs a StatsEvent - - - - - Constructs a ProgressEvent. - - - - - - This Event is returned if an event is retrieved from the event stream, but a generator function - for the event is not defined. - - - - - Constructs an UnknownEventStreamEvent. - - - - - Constructs an UnknownEventStreamEvent. - - The Message recieved from the event stream before conversion. - - - - Constructs an UnknownEventStreamEvent. - - The Message recieved from the event stream before conversion. - The event type. - - - - A container that specifies information about existing object replication. You can choose whether to enable or disable the replication of existing objects. - - - - - Specifies whether existing object replication is enabled. - - - - - Defines the expiration policy for a given object. - - - - - This property is deprecated. This property exposes a DateTime of kind Unspecified. Use ExpiryDateUtc instead. - The date and time for expiry. - - - - - The date and time for expiry. - - - - - Id of the configuration rule for this expiry. - - - - - Constructs an empty instance of an Expiration object - - - - Bucket - Represents a set of filter criteria that limits the objects that can trigger event notifications - - - - - Filter criteria that limits the objects that can trigger event notifications based on their S3 Key name. - - - - - Bucket - Represents a Filter Rule for a NotificationConfiguration. - - - - - Constructs an empty FilterRule. - - - - - Constructs a FilterRule with a specific name and value. - - - - - - - The name of the filter rule. - - - - - The value of the filter rule. - - - - - Container for the parameters to the GetACL operation. - Returns the access control list (ACL) of an object. - - - - - The bucket name that contains the object for which to get the ACL information. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The key of the S3 object to be queried. - - - - - VersionId used to reference a specific version of the object. - - - - - Returns information about the GetACL response and response metadata. - - - - - Gets and sets the AccessControlList property. - - - - - Container for the parameters to the GetBucketAccelerateConfiguration operation. - - - - - The name of the bucket. - - - - - The response class for GetBucketAccelerateConfiguration operation. - - - - - The accelerate status of the bucket. - - - - - Container for the parameters to the GetBucketAnalyticsConfiguration operation. - Gets an analytics configuration for the bucket (specified by the analytics configuration ID). - - - - - The name of the bucket from which an analytics configuration is retrieved. - - - - - The identifier used to represent an analytics configuration. - - - - - GetBucketAnalyticsConfigurationResponse Response - - - - - The configuration and any analyses for the analytics filter. - - - - - Container for the parameters to the GetBucketEncryptionRequest operation. - Returns the server-side encryption configuration of a bucket. - - - - - The name of the bucket. - - - - - GetBucketEncryptionResponse Response - - - - - Container for server-side encryption configuration rules. Currently S3 supports one rule only. - - - - - Container for the parameters to the GetInventoryConfigurationRequest operation. - Returns an inventory configuration (identified by the inventory ID) from the bucket. - - - - - The name of the bucket containing the inventory configuration to retrieve. - - - - - The ID used to identify the inventory configuration. - - - - - GetInventoryConfigurationResponse Response - - - - - Specifies the inventory configuration. - - - - - Container for the parameters to the GetBucketLocation operation. - Returns the region the bucket resides in. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetBucketLocation response and response metadata. - - - - - Gets and sets the Location property. - If the the bucket is located in us-east-1 S3Region.US will be return which has a - value of empty string. - - - - - Container for the parameters to the GetBucketLogging operation. - Returns the logging status of a bucket and the permissions users have to view and modify that status. To use GET, you must be the - bucket owner. - - - - - The name of the bucket to query. - - - - - Returns information about the GetBucketLogging response and response metadata. - - - - - Gets and sets the LoggingConfig property. - - - - - Container for the parameters to the GetBucketMetricsConfiguration operation. - Gets a metrics configuration (specified by the metrics configuration ID) from the bucket. - - - - - The name of the bucket containing the metrics configuration to retrieve. - - - - - The ID used to identify the metrics configuration. - - - - - GetBucketMetricsConfiguration Response - - - - - Specifies the metrics configuration. - - - - - Container for the parameters to the GetBucketNotification operation. - Return the notification configuration of a bucket. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetBucketNotification response and response metadata. - - - - - Gets and sets the TopicConfigurations property. TopicConfigurations are configuration - for Amazon S3 events to be sent to Amazon SNS topics. - - - - - Gets and sets the QueueConfigurations property. QueueConfigurations are configuration - for Amazon S3 events to be sent to Amazon SQS queues. - - - - - Gets and sets the LambdaFunctionConfigurations property. LambdaFunctionConfigurations are configuration - for Amazon S3 events to be sent to an Amazon Lambda cloud function. - - - - - Container for the parameters to the GetBucketPolicy operation. - Returns the policy of a specified bucket. - - - - - The name of the bucket. - - - - - Get BucketName Policy Response - - - - - The bucket policy as a JSON document. - - - - - Container for the parameters to the GetBucketPolicyStatus operation. - Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket - is public. - - - - - Gets and sets the property BucketName. - - The name of the Amazon S3 bucket whose public-policy status you want to retrieve. - - - - - - This is the response object from the GetBucketPolicyStatus operation. - - - - - The public-policy status for this bucket. - - - - - Container for the parameters to the GetBucketReplicationConfiguration operation. - Returns the replication configuration information set on the bucket. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetReplicationConfiguration response and response metadata. - - - - - The replication configuration for the buccket specified in the request. - - - - - Container for the parameters to the GetBucketRequestPayment operation. - Returns the request payment configuration of a bucket. - - - - - The name of the bucket. - - - - - Returns information about the GetBucketRequestPayment response and response metadata. - - - - - Specifies who pays for the download and request fees. - - - - - - Container for the parameters to the GetBucketTagging operation. - Returns the tag set associated with the bucket. - - - - - The name of the bucket to be queried. - - - - - Returns information about the GetBucketTagging response and response metadata. - - - - - The collection of tags. - - - - - Container for the parameters to the GetBucketVersioning operation. - Returns the versioning state of a bucket. - - - - - The name of the bucket to be queried. - - - - - Returns information about the GetBucketVersioning response and response metadata. - - - - - Gets and sets the Versioning property. - Unless Versioning has been explicitly "Enabled" on a bucket, - Versioning Status is "Off". Once Versioning has been - "Enabled", it can be "Suspended" but cannot be switched "Off". - - - - - Container for the parameters to the GetBucketWebsite operation. - Returns the website configuration for a bucket. - - - - - The name of the bucket to be queried. - - - - - Returns information about the GetBucketWebsite response and response metadata. - - - - - Gets and sets the WebsiteConfiguration property. - - This is where the index document suffix and custom error page are defined. - - - - - Container for the parameters to the GetBucketCors operation. - Returns the cors configuration for the bucket. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetBucketCors response and response metadata. - - - - - The current CORSConfiguration for the bucket. - - - - - Container for the parameters to the GetLifecycleConfiguration operation. - Returns the lifecycle configuration information set on the bucket. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetLifecycleConfiguration response and response metadata. - - - - - Gets and Sets the property that governs whether - the response includes successful deletes as well as errors - following the DeleteObjects call against S3. - - By default this property is false and successful deletes - are returned in the response. - - - - - Container for the parameters to the GetObjectLegalHold operation. - Gets an object's current Legal Hold status. - - - - - The bucket name containing the object whose Legal Hold status you want to retrieve. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property Key. - - The key name for the object whose Legal Hold status you want to retrieve. - - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property VersionId. - - The version ID of the object whose Legal Hold status you want to retrieve. - - - - - - This is the response object from the GetObjectLegalHold operation. - - - - - Gets and sets the property LegalHold. - - The current Legal Hold status for the specified object. - - - - - - Container for the parameters to the GetObjectLockConfiguration operation. - Gets the Object Lock configuration for a bucket. The rule specified in the Object - Lock configuration will be applied by default to every new object placed in the specified - bucket. - - - - - Gets and sets the property BucketName. - - The bucket whose Object Lock configuration you want to retrieve. - - - - - - This is the response object from the GetObjectLockConfiguration operation. - - - - - Gets and sets the property ObjectLockConfiguration. - - The specified bucket's Object Lock configuration. - - - - - - Container for the parameters to the HeadObject operation. - The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you''re only - interested in an object''s metadata. To use HEAD, you must have READ access to the object. - - - - - The name of the bucket that contains the object. - - - - - ETag to be matched as a pre-condition for returning the object, - otherwise a PreconditionFailed signal is returned. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or - ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Returns the object only if it has been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Returns the object only if it has been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - ETag that should not be matched as a pre-condition for returning the object, - otherwise a PreconditionFailed signal is returned. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or - UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Returns the object only if it has not been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Returns the object only if it has not been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - The key of the object. - - - - - VersionId used to reference a specific version of the object. - - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to decrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - Part number of the object being read. This is a positive integer between 1 and 10,000. - Effectively performs a 'ranged' HEAD request for the part specified. - Useful querying about the size of the part and the number of parts in this object. - - - - - Check if PartNumber property is set. - - true if PartNumber property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the HeadObject response and response metadata. - - - - - Flag which returns true if the Expires property has been unmarshalled - from the raw value or set by user code. - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the - response. - - - - - - Gets and sets the AcceptRanges. - - - - - Gets and sets the ContentRange. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - Gets and sets the RestoreExpiration property. - RestoreExpiration will be set for objects that have been restored from Amazon Glacier. - It indiciates for those objects how long the restored object will exist. - - - - - Gets and sets the RestoreInProgress - Will be true when the object is in the process of being restored from Amazon Glacier. - - - - - Last modified date of the object - - - - - - An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL - - - - - - This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like - SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal - HTTP headers. - - - - - - Version of the object. - - - - - - The date and time at which the object is no longer cacheable. - - - - - - If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The status of the replication job associated with this source object. - - - - - Checks if ReplicationStatus property is set. - - true if ReplicationStatus property is set. - - - - The count of parts this object has. - - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - The Legal Hold status for the specified object. - - - - - - Gets and sets the property ObjectLockMode. - - The Object Lock mode currently in place for this object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - The date and time when this object's Object Lock will expire. - - - - - - The class of storage used to store the object. - - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the GetObject operation. - Retrieves objects from Amazon S3. - - - - - The bucket name containing the object. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - ETag to be matched as a pre-condition for returning the object, - otherwise a PreconditionFailed signal is returned. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or - ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Returns the object only if it has been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Returns the object only if it has been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - ETag that should not be matched as a pre-condition for returning the object, - otherwise a PreconditionFailed signal is returned. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or - UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Returns the object only if it has not been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Returns the object only if it has not been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Gets and sets the Key property. This is the user defined key that identifies the object in the bucket. - - - - - Downloads the specified range bytes of an object. - - - - - A set of response headers that should be returned with the object. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ResponseExpiresUtc instead. Setting either ResponseExpires or - ResponseExpiresUtc results in both ResponseExpires and ResponseExpiresUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ResponseExpires is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Sets the Expires header of the response. - - - - - Sets the Expires header of the response. - - - - - VersionId used to reference a specific version of the object. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to decrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - Part number of the object being read. This is a positive integer between 1 and 10,000. - Effectively performs a 'ranged' GET request for the part specified. Useful for downloading just a part of an object. - - - - - Checks if PartNumber property is set. - - true if PartNumber property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the GetObject response and response metadata. - - - - - Flag which returns true if the Expires property has been unmarshalled - from the raw value or set by user code. - - - - - Gets and sets the BucketName property. - - - - - Gets and sets the Key property. - - - - - Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the - response. - - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - Gets and sets the AcceptRanges. - - - - - Gets and sets the ContentRange. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - Gets and sets the RestoreExpiration property. - RestoreExpiration will be set for objects that have been restored from Amazon Glacier. - It indiciates for those objects how long the restored object will exist. - - - - - Gets and sets the RestoreInProgress - Will be true when the object is in the process of being restored from Amazon Glacier. - - - - - Last modified date of the object - - - - - - An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL - - - - - - This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like - SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal - HTTP headers. - - - - - - Version of the object. - - - - - - The date and time at which the object is no longer cacheable. - - - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - - - - Gets and sets the property ObjectLockMode. - - The Object Lock mode currently in place for this object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - The date and time when this object's Object Lock will expire. - - - - - - If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The class of storage used to store the object. - - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The status of the replication job associated with this source object. - - - - - Checks if ReplicationStatus property is set. - - true if ReplicationStatus property is set. - - - - The number of parts this oject has. - - - - - Checks if PartsCount is set. - - true if PartsCount property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - The number of tags, if any, on the object. - - - - - Writes the content of the ResponseStream a file indicated by the filePath argument. - - The location where to write the ResponseStream - - - - Writes the content of the ResponseStream a file indicated by the filePath argument. - - The location where to write the ResponseStream - Whether or not to append to the file if it exists - - - - The event for Write Object progress notifications. All - subscribers will be notified when a new progress - event is raised. - - - Subscribe to this event if you want to receive - put object progress notifications. Here is how:
- 1. Define a method with a signature similar to this one: - - private void displayProgress(object sender, WriteObjectProgressArgs args) - { - Console.WriteLine(args); - } - - 2. Add this method to the Put Object Progress Event delegate's invocation list - - GetObjectResponse response = s3Client.GetObject(request); - response.WriteObjectProgressEvent += displayProgress; - - - - - - This method is called by a producer of write object progress - notifications. When called, all the subscribers in the - invocation list will be called sequentially. - - The file being written. - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - True if transfer is complete - - - - Encapsulates the information needed to provide - download progress for the Write Object Event. - - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The bucket name for the S3 object being written. - The object key for the S3 object being written. - The version-id of the S3 object. - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - True if finished writing - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The bucket name for the S3 object being written. - The object key for the S3 object being written. - The file for the S3 object being written. - The version-id of the S3 object. - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - True if finished writing - - - - Gets the bucket name for the S3 object being written. - - - - - Gets the object key for the S3 object being written. - - - - - Gets the version-id of the S3 object. - - - - - The file for the S3 object being written. - - - - - True if writing is complete - - - - - Container for the parameters to the GetObjectRetention operation. - Retrieves an object's retention settings. - - - - - The bucket name containing the object whose retention settings you want to retrieve. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property Key. - - The key name for the object whose retention settings you want to retrieve. - - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property VersionId. - - The version ID for the object whose retention settings you want to retrieve. - - - - - - This is the response object from the GetObjectRetention operation. - - - - - Gets and sets the property Retention. - - The container element for an object's retention settings. - - - - - - Container for the parameters to the GetObjectTaggingRequest operation. - - - - - The bucket name containing the object for which to get the tagging information. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Check to see if Bucket property is set - - - - - Gets and sets the Key property. This is the user defined key that identifies the object in the bucket. - - - - - Check to see if Key property is set - - - - - VersionId used to reference a specific version of the object. - - - - - - Returns information about the GetObjectTagging response and response metadata. - - - - - Gets or sets tag-set for a given object - - - - - Container for the parameters to the GetObjectTorrent operation. - Return torrent files from a bucket. - - - - - The name of the bucket containing the object. - - - - - The key identifying the object. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the GetObjectTorrent response and response metadata. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - The parameters to create a pre-signed URL to a bucket or object. - - - For more information, refer to: . -
Required Parameters: BucketName, Expires -
Optional Parameters: Key, VersionId, Verb: default is GET - - - - - The name of the bucket to create a pre-signed url to, or containing the object. - - - - - Checks if BucketName property is set. - - true if BucketName property is set. - - - - The key to the object for which a pre-signed url should be created. - - - - - Checks if Key property is set. - - true if Key property is set. - - - - A standard MIME type describing the format of the object data. - - - - The content type for the content being uploaded. This property defaults to "binary/octet-stream". - For more information, refer to: . - - - Note that if content type is specified, it should also be included in the HttpRequest headers - of the eventual upload request, otherwise a signature error may result. - - - - - - The expiry date and time for the pre-signed url. - - - - - Checks if Expires property is set. - - true if Expires property is set. - - - - The requested protocol (http/https) for the pre-signed url. - - - Defaults to https. - - - - - The verb for the pre-signed url. - - - Accepted verbs are GET, PUT, DELETE and HEAD. - Default is GET. - - - - - Version id for the object that the pre-signed url will reference. If not set, - the url will reference the latest version of the object. - - - This is the VersionId for the S3 Object you want to get - a PreSigned URL for. The VersionId property will be ignored - for PreSigned "PUT" requests and for requests that don't specify - the Key property. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - Specifies the encryption used on the server to store the content. - - - - Default is None. - - - If specifying encryption (not None), the corresponding request must include header - "x-amz-server-side-encryption" with the value of the encryption. - - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - Confirms that the requester knows that she or he will be charged for the request. - Bucket owners need not specify this parameter in their requests. - - - - - A set of response headers that should be returned with the pre-signed url creation response. - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - Custom parameters to include in the signed request, so that they are tamper-proof. - - - - - The parameters for a pre-signed URL to a bucket or object as a string. - - - For more information, refer to: . - - - - - The PreSignedURL as a string - - - - - Constructor - - A url returned from GetPreSignedUrlRequest - - - - Container for the parameters to the GetPublicAccessBlock operation. - Retrieves the Public Access Block configuration for an Amazon S3 bucket. - - - - - Gets and sets the property BucketName. - - The name of the Amazon S3 bucket whose Public Access Block configuration you want - to retrieve. - - - - - - This is the response object from the GetPublicAccessBlock operation. - - - - - The Public Access Block configuration currently in effect for this Amazon S3 bucket. - - - - - Container for the parameters to the HeadBucket operation. - This operation is useful to determine if a bucket exists and you have permission to access it. - - - - - Returns information about the HeadBucket response metadata. - The HeadBucket operation has a void result type. - - - - - This class contains the headers for an S3 object. - - - - - Gets and sets headers to set for the object. - - The name of the header - The value for the header - - - - Gets the count of headers. - - - - - Gets the names of the headers set. - - - - - Specifies caching behavior along the request/reply chain. - - - - - - Specifies presentational information for the object. - - - - - - Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type - referenced by the Content-Type header field. - - - - - - The size of the object, in bytes. - - - - - The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. This - header can be used as a message integrity check to verify that the data is the same data that was originally sent. - - - - - A standard MIME type describing the format of the object data. - - - - - - The date and time at which the object is no longer cacheable. - - - - - - - Container for the parameters to the InitiateMultipartUpload operation. - Initiates a multipart upload and returns an upload ID. - - - - - Envelope Key to Encrypt data - - - - - Encrypted Envelope Key to Encrypt data - - - - - Initialization Vector for encryption - - - - - Storage mode for encryption information. - - - - - A canned access control list (ACL) to apply to the object. - Please refer to for information on S3 Canned ACLs. - - - - - The name of the bucketName where the new object will be created, or existing object updated. - - - - - The key of the object to create or update. - - - - - StorageClass property for the object. - - - Default: S3StorageClass.Standard. Set this property - only if you want reduced redundancy for this object. - Please refer to - for - information on S3 Storage Classes. - - - - - If the bucketName is configured as a website, redirects requests for this object to another object in the same bucketName or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - This is a convenience property for Headers.ContentType. - - - - - - Specifies the encryption to be used on the server for the new object. - - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - Checks if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - true if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - Specifies whether you want to apply a Legal Hold to the uploaded object. - - - - - - Gets and sets the property ObjectLockMode. - - Specifies the Object Lock mode that you want to apply to the uploaded object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - Specifies the date and time when you want the Object Lock to expire. - - - - - - The tag-set for the object. The tag-set must be encoded as URL Query parameters. - - - - - Checks if Tagging property is set - - true if Tagging is set. - - - - Returns information about the InitiateMultipartUpload response and response metadata. - - - - - Name of the bucketName to which the multipart upload was initiated. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Object key for which the multipart upload was initiated. - - - - - - Gets and sets the initiated multipart upload id. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - Date when multipart upload will become eligible for abort operation by lifecycle. - - - - - Id of the lifecycle rule that makes a multipart upload eligible for abort operation. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Identifies who initiated the multipart upload. - - - - - Name of the Principal. - - - - - - If the principal is an AWS account, it provides the Canonical User ID. If the principal is an IAM User, it provides a user ARN value. - - - - - - Describes the serialization format of the object. - - - - - Describes the serialization of a CSV-encoded object. - - - - - Specifies object's compression format. Valid values: NONE, GZIP. Default Value: NONE. - - - - - Specifies JSON as object's input serialization format. - - - - - Specifies Parquet as object's input serialization format. - - - - - Class for MetricsConfiguration - - - - - Contains information about where to publish the inventory results. - - - - - Specifies whether the inventory is enabled or disabled. - - - - - Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria. - - - - - The ID used to identify the inventory configuration. - - - - - Specifies which object version(s) to included in the inventory results. - - - - - Contains the optional fields that are included in the inventory results. - - - - - Specifies the schedule for generating inventory results. - - - - - Class for InventoryDestination - - - - - Contains the bucket name, file format, bucket owner (optional), and prefix (optional) where inventory results are published. - - - - - InventoryEncryption class - - - - - Specifies the use of SSE-S3 to encrypt delievered Inventory reports. - - - - - Specifies the use of SSE-KMS to encrypt delievered Inventory reports. - - - - - Class for InventoryFilter - - - - - Filter Predicate setup for specific filter types. - - - - - Filter Predicate abstract class for specific filter types to be derived from. - - - - - Class for InventoryPrefixPredicate - The prefix that an object must have to be included in the inventory results. - - - - - The ID of the account that owns the destination bucket. - - - - - The Amazon resource name (ARN) of the bucket where inventory results will be published. - - - - - The prefix that is prepended to all inventory results. - - - - - Specifies the output format of the inventory results. - - - - - Contains the type of server-side encryption used to encrypt the inventory results. - - - - - Class for InventorySchedule - - - - - Specifies how frequently inventory results are produced. - - - - - Specifies JSON as object's input serialization format. - - - - - The type of JSON. Valid values: Document, Lines. - - - - - Specifies JSON as request's output serialization format - - - - - The value used to separate individual records in the output. - - - - - Specifies an object key and optional object version. - - - - - Key name of the object to delete. - - - - - - VersionId for the specific version of the object to delete. - - - - - - This class contains the configuration Amazon S3 uses to figure out what events you want to listen - and send the event to an Amazon Lambda cloud function. - - - - - Gets and set the Id property. The Id will be provided in the event content and can be used - to identify which configuration caused an event to fire. If the Id is not provided for the configuration, one will be generated. - - - - - Gets and sets the FunctionArn property. This is the Amazon Lambda cloud function to which Amazon S3 will invoke with the events. - - - - Lifecycle Configuration - - - - - Gets and sets the Rules property. These rules defined the lifecycle configuration. - - - - - Base class for all the different predicates that can be used - in a filter. - - - - - This method is called by the visitor when it wants to visit the predicate. - - - - - - Filter identifying one or more objects to which a applies. - - - - - The predicate used by the filter. - - - - - Base class for lifecycle operators. - - - - - The list of objects - that this operator operates on. - - - - - The logical and operator for filtering objects for a - - - - - Accept a visit from an - - - This method is used internally by the SDK. - - - - - - A predicate that filters objects for a - by matching a particular prefix. - - - - - The prefix to be matched by filtered objects. - - - - - Accept a visit from an - - - This method is used internally by the SDK. - - - - - - A predicate that filters objects for a - by matching a particular key and value. - - - - - The Tag to be matched by filtered objects. - - - - - Accept a visit from an - - - This method is used internally by the SDK. - - - - - - Rules Item - - - - - Defines the length of time, in days, before objects expire. - - - - - Unique identifier for the rule. The value cannot be longer than 255 characters. - - - - - Prefix identifying one or more objects to which the rule applies. - - - - - - Filter identifying one or more objects to which the rule applies. - - - - - If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied. - - - - - - The transition rule that describes when objects transition to a different storage class. - - Lifecycle rules can now contain multiple transitions. This property is obsolete in favor of the Transitions property. - This property will always get or set the the zeroth element in the Transitions collection. - - - - - - Defines the length of time, in days, before noncurrent versions expire. - - - - - The transition rule that describes when noncurrent versions transition to - a different storage class. - - Lifecycle rules can now contain multiple noncurrent version transitions. This property - is obsolete in favor of the NoncurrentVersionTransitions property. - This property will always get or set the the zeroth element in the NoncurrentVersionTransitions collection. - - - - - - The transition rules that describe when objects transition to a different storage class. - - - - - The transition rules that describe when noncurrent versions transition to - a different storage class. - - - - - Specifies the days since the initiation of an Incomplete Multipart Upload - that Lifecycle will wait before permanently removing all parts of the upload. - - - - - Specifies the days since the initiation of an Incomplete Multipart Upload - that Lifecycle will wait before permanently removing all parts of the upload. - - - - - Indicates the number of days that must pass since initiation for Lifecycle - to abort an Incomplete Multipart Upload. - - - - Expiration - - - - - Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format. - - - - - - Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer. - - - - - - Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set to true, the delete marker will be expired; if set to false the policy takes no action. This cannot be specified with Days or Date in a Lifecycle Expiration Policy. - - - - - - Noncurrent Version Expiration - - - - - Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated - action. For information about the noncurrent days calculations, see - How Amazon S3 Calculates When an Object Became Noncurrent - in the Amazon Simple Storage Service Developer Guide. - - - - - LifecycleTransition defines when and how objects transition. - - - - - Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated - action. For information about the noncurrent days calculations, see - How Amazon S3 Calculates When an Object Became Noncurrent - in the Amazon Simple Storage Service Developer Guide. - - - - - The class of storage used to store the object. - - - - - - LifecycleTransition defines when and how objects transition. - - - - - Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format. - - - - - - Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer. - - - - - - The class of storage used to store the object. - - - - - - Container for the parameters to the ListInventoryConfigurationsRequest operation. - Lists the analytics configurations for the bucket. - - - - - The name of the bucket containing the analytics configurations to retrieve. - - - - - The ContinuationToken that represents a placeholder from where this request should begin. - - - - - Returns information about the ListBucketAnalyticsConfigurationsResponse response and response metadata. - - - - - The ContinuationToken that represents where this request began. - - - - - The list of analytics configurations for a bucket. - - - - - Indicates whether the returned list of analytics configurations is complete. - A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request. - - - - - NextContinuationToken is sent when isTruncated is true, which indicates that there are more analytics configurations to list. - The next request must include this NextContinuationToken. The token is obfuscated and is not a usable value. - - - - - Container for the parameters to the ListInventoryConfigurationsRequest operation. - Returns a list of inventory configurations for the bucket. - - - - - The name of the bucket containing the inventory configurations to retrieve. - - - - - The marker used to continue an inventory configuration listing that has been truncated. - Use the NextContinuationToken from a previously truncated list response to continue the listing. - The continuation token is an opaque value that Amazon S3 understands. - - - - - Returns information about the ListInventoryConfigurationsResponse response and response metadata. - - - - - If sent in the request, the marker that is used as a starting point for this inventory configuration list response. - - - - - The list of inventory configurations for a bucket. - - - - - Indicates whether the returned list of inventory configurations is truncated in this response. A value of true indicates that the list is truncated. - - - - - The marker used to continue this inventory configuration listing. Use the NextContinuationToken from this response to continue the listing in a subsequent request. - The continuation token is an opaque value that Amazon S3 understands. - - - - - Container for the parameters to the ListBucketMetricsConfigurationRequest operation. - Lists the metrics configurations for the bucket. - - - - - The name of the bucket containing the metrics configurations to retrieve. - - - - - - The marker that is used to continue a metrics configuration listing that has been truncated. - Use the NextContinuationToken from a previously truncated list response to continue the listing. - The continuation token is an opaque value that Amazon S3 understands. - - - - - - Returns information about the ListBucketMetricsConfiguration response and response metadata. - - - - - - The marker that is used to continue a metrics configuration listing that has been truncated. - Use the NextContinuationToken from a previously truncated list response to continue the listing. - The continuation token is an opaque value that Amazon S3 understands. - - - - - - The list of metrics configurations for a bucket. - - - - - - Indicates whether the returned list of metrics configurations is complete. - A value of true indicates that the list is not complete and the NextContinuationToken will be provided for - a subsequent request. - - - - - - - The marker used to continue a metrics configuration listing that has been truncated. - Use the NextContinuationToken from a previously truncated list response to continue the listing. - The continuation token is an opaque value that Amazon S3 understands. - - - - - - Container for the parameters to the ListBuckets operation. - Returns a list of all buckets owned by the authenticated sender of the request. - - - - - Returns information about the ListBuckets response and response metadata. - - - - - List of buckets. - - - - - Owner of the buckets. - - - - - Container for the parameters to the ListMultipartUploads operation. - This operation lists in-progress multipart uploads. - - - - - Name of the bucket to which the multipart upload was initiated. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Character you use to group keys. - - - - - - Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin. - - - - - - Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response body. 1,000 is the maximum number of uploads that - can be returned in a response. - - - - - - Lists in-progress uploads only for those keys that begin with the specified prefix. - - - - - - Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the - upload-id-marker parameter is ignored. - - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - Returns information about the ListMultipartUploads response and response metadata. - - - - - Name of the bucketName to which the multipart upload was initiated. - - - - - - The key at or after which the listing began. - - - - - - Upload ID after which listing began. - - - - - - When a list is truncated, this element specifies the value that should be used for the key-marker request parameter in a subsequent request. - - - - - - When a list is truncated, this element specifies the value that should be used for the upload-id-marker request parameter in a subsequent - request. - - - - - - Maximum number of multipart uploads that could have been included in the response. - - - - - - Indicates whether the returned list of multipart uploads is truncated. A value of true indicates that the list was truncated. The list can - be truncated if the number of multipart uploads exceeds the limit allowed or specified by max uploads. - - - - - - Gets and sets the MultipartUploads property. - - Container for elements related to a particular multipart upload. A response - can contain zero or more Upload elements. - - - - - - Gets and sets the Prefix property. - - - - - Gets and sets the Delimiter property. - - - - - Gets the CommonPrefixes property. - A response can contain CommonPrefixes only if you specify a delimiter. - When you do, CommonPrefixes contains all (if there are any) keys between - Prefix and the next occurrence of the string specified by delimiter. In effect, - CommonPrefixes lists keys that act like subdirectories in the directory specified - by Prefix. For example, if prefix is notes/ and delimiter is a slash (/), in - notes/summer/july, the common prefix is notes/summer/. - - - - - Container for the parameters to the ListObjects operation. - Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a - subset of the objects in a bucket. - - - - - The name of the bucket containing the objects whose keys are to be listed. - - - - - A delimiter is a character you use to group keys. - - - - - Specifies the key to start with when listing objects in a bucket. - - - - - Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more. - - - - - Limits the response to keys that begin with the specified prefix. - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the ListObjects response and response metadata. - - - - - A flag that indicates whether or not Amazon S3 returned all of the results that satisfied - the search criteria. - - - - - Gets and sets the NextMarker property. - NextMarker is set by S3 only if a Delimiter was specified - in the original ListObjects request. If a delimiter was - not specified, the AWS SDK for .NET returns the last Key - of the List of Objects retrieved from S3 as the NextMarker. - - - - - Gets the S3Objects property. This is a list of - objects in the bucket that match your search criteria. - - - - - Gets and sets the Name property which is the name of the bucket. - - - - - Gets and sets the Prefix property. - - - - - Gets and sets the MaxKeys property. This is max number of object keys returned by the list operation. - - - - - Gets the CommonPrefixes property. - A response can contain CommonPrefixes only if you specify a delimiter. - When you do, CommonPrefixes contains all (if there are any) keys between - Prefix and the next occurrence of the string specified by delimiter. In effect, - CommonPrefixes lists keys that act like subdirectories in the directory specified - by Prefix. For example, if prefix is notes/ and delimiter is a slash (/), in - notes/summer/july, the common prefix is notes/summer/. - - - - - Gets and sets the Delimiter property. - Causes keys that contain the same string between the prefix and the - first occurrence of the delimiter to be rolled up into a single result - element in the CommonPrefixes collection. - - - These rolled-up keys are not returned elsewhere in the response. - - - - - Container for the parameters to the ListObjects operation. - Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a - subset of the objects in a bucket. - - - - - Bucket name to list. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - A delimiter is a character you use to group keys. - - - - - Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more. - - - - - Limits the response to keys that begin with the specified prefix. - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts - listing after this specified key. StartAfter can be any key in the bucket. - Cannot be set at the same time as ContinuationToken. - - - - - ContinuationToken indicates Amazon S3 that the list is being continued on this - bucket with a token. ContinuationToken is obfuscated and is not a real key. - - - - - The owner field is not present in ListObjectsV2 responses by default. - If you want to return owner field with each key in the result then set this field to true. - If not specified, the Owner field on S3Object will be null. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the ListObjects response and response metadata. - - - - - A flag that indicates whether or not Amazon S3 returned all of the results that satisfied - the search criteria. - - - - - Gets and sets the S3Objects property. Metadata about each object returned. - - - - - Bucket name. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the Prefix property. - - - - - Gets and sets the MaxKeys property. This is max number of object keys returned by the list operation. - - - - - Gets and sets the CommonPrefixes property. - CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence - of the string specified by delimiter - - - - - Gets and sets the Delimiter property. - Causes keys that contain the same string between the prefix and the - first occurrence of the delimiter to be rolled up into a single result - element in the CommonPrefixes collection. - - - These rolled-up keys are not returned elsewhere in the response. - - - - - Encoding type used by Amazon S3 to encode object keys in the response. - - - - - KeyCount is the number of keys returned with this request. - KeyCount will always be less than or equal to MaxKeys field. - - - - - ContinuationToken indicates Amazon S3 that the list is being continued - on this bucket with a token. - ContinuationToken is obfuscated and is not a real key - - - - - NextContinuationToken is sent when isTruncated is true which means there - are more keys in the bucket that can be listed. The next ListObjectV2 call - to Amazon S3 can be continued with this NextContinuationToken. - NextContinuationToken is obfuscated and is not a real key. - - - - - StartAfter is where you want Amazon S3 to start listing from. - Amazon S3 starts listing after this specified key. - StartAfter can be any key in the bucket. - - - - - Container for the parameters to the ListParts operation. - Lists the parts that have been uploaded for a specific multipart upload. - - - - - Name of the bucket to which the parts are being uploaded. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The object key for which the multipart upload was initiated. - - - - - Sets the maximum number of parts to return. - - - - - - Specifies the part after which listing should begin. Only parts with higher part numbers will be listed. - - - - - - Upload ID identifying the multipart upload whose parts are being listed. - - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the ListParts response and response metadata. - - - - - Name of the bucketName to which the multipart upload was initiated. - - - - - - Object key for which the multipart upload was initiated. - - - - - - Upload ID identifying the multipart upload whose parts are being listed. - - - - - - Part number after which listing begins. - - - - - - When a list is truncated, this element specifies the last part in the list, as well as the value to use for the part-number-marker request - parameter in a subsequent request. - - - - - - Maximum number of parts that were allowed in the response. - - - - - - Indicates whether the returned list of parts is truncated. - - - - - - Gets and sets the Parts property. - - PartDetails is a container for elements related to a particular part. A response can contain - zero or more Part elements. - - - - - - Identifies who initiated the multipart upload. - - - - - - Gets and sets the Owner property. - - - - - The class of storage used to store the object. - - - - - - Date when multipart upload will become eligible for abort operation by lifecycle. - - - - - Id of the lifecycle rule that makes a multipart upload eligible for abort operation. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the ListVersions operation. - Returns metadata about all of the versions of objects in a bucket. - - - - - The bucket name that contains the objects. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - A delimiter is a character you use to group keys. - - - - - Specifies the key to start with when listing objects in a bucket. - - - - - Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more. - - - - - Limits the response to keys that begin with the specified prefix. - - - - - Specifies the object version you want to start listing from. - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - Returns information about the ListVersions response and response metadata. - - - - - A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria. If your results were - truncated, you can make a follow-up paginated request using the NextKeyMarker and NextVersionIdMarker response parameters as a starting - place in another request to return the rest of the results. - - - - - - Marks the last Key returned in a truncated response. - - - - - - Gets and sets the VersionIdMarker property. - Marks the last Version-Id returned in a truncated response. - - - - - Use this value for the key marker request parameter in a subsequent request. - - - - - - Use this value for the next version id marker parameter in a subsequent request. - - - - - - Gets and sets the Versions property. This is a list of - object versions in the bucket that match your search criteria. - - - - - Gets and sets the Name property. - The bucket's name. - - - - - Gets and sets the Prefix property. - Keys that begin with the indicated prefix are listed. - - - - - Gets and sets the MaxKeys property. - This is the maximum number of keys in the S3ObjectVersions collection. - The value is derived from the MaxKeys parameter to ListVersionsRequest. - - - - - Gets the CommonPrefixes property. - A response can contain CommonPrefixes only if you specify a delimiter. - When you do, CommonPrefixes contains all (if there are any) keys between - Prefix and the next occurrence of the string specified by delimiter. - - - - - Gets and sets the Delimiter property. - Causes keys that contain the same string between the prefix and the - first occurrence of the delimiter to be rolled up into a single result - element in the CommonPrefixes collection. - - - These rolled-up keys are not returned elsewhere in the response. - - - - - This class contains the meta data for an S3 object. - - - - - Gets and sets meta data for the object. Meta data names must start with "x-amz-meta-". If the name passeed in as the indexer - doesn't start with "x-amz-meta-" then it will be prepended. - - The name of the meta data. - The value for the meta data - - - - Adds the metadata to the collection, if the name already exists it will be overwritten. - - The name of the metadata element - The value for the metadata - - - - Gets the count of headers. - - - - - Gets the names of the meta data elements. - - - - - A metadata key-value pair to store with an object. - - - - - Key of metadata key-value pair - - - - - Value of metadata key-value pair - - - - - A container specifying replication metrics-related information, including whether - emitting metrics and Amazon S3 events for replication are enabled. In addition, contains - configurations related to specific metrics or events. Must be specified together with a - ReplicationTime block. - - - - - Specifies whether the replication metrics are enabled. - - - - - A container specifying the time threshold for emitting the - s3:Replication:OperationMissedThreshold event. - - - - - Class for MetricsAndOperatorPredicate - A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. - The operator must have at least two predicates, and an object must match all of the predicates - in order for the filter to apply. - - Note: The current implementation restricts the usage to atmost one MetricsPrefixPredicate - and any number of MetricsTagPredicates. - - - - Class for MetricsConfiguration - - - - - The ID used to identify the metrics configuration. - - - - - Specifies a metrics configuration filter. - The metrics configuration will only include objects that meet the filter's criteria. - A filter must be a prefix, a tag, or a conjunction (MetricsAndOperator). - - - - - Filter class for Metrics. - - - - - Filter Predicate setup for specific filter types. - - - - - Filter Predicate abstract class for specific filter types to be derived from. - - - - - Abstract class that can be used over logical filter predicates,i.e. AND/OR. - - - - - Class for MetricsPrefixPredicate - The prefix used when evaluating a metrics filter. - - - - - Class for MetricsTagPredicate - The tag used when evaluating a metrics filter. - - - - - This class contains the mfa codes used authentication - - - - - Gets and sets the serial number of the authentication device - - - - - Gets and sets the displated value on the authentication device - - - - - The formatted string of the mfa codes to be passed to S3. - - - - - Container for elements related to a particular multipart upload. - - - - - Date and time at which the multipart upload was initiated. - - - - - - Identifies who initiated the multipart upload. - - - - - - Key of the object for which the multipart upload was initiated. - - - - - - Gets and sets the Owner property. - - - - - The class of storage used to store the object. - - - - - - Upload ID that identifies the multipart upload. - - - - - - An abstract class for all the notification configurations associated with an Amazon S3 bucket. - - - - - Gets and sets the Events property. These are the events the configuration will listen to. - - - - - Filter criteria for determining which S3 objects trigger event notifications. - - - - - - The container element for Object Lock configuration parameters. - - - - - Gets and sets the property ObjectLockEnabled. - - Indicates whether this object has an Object Lock configuration enabled. - - - - - - Gets and sets the property Rule. - - The Object Lock rule in place for the specified object. - - - - - - A Legal Hold configuration for an object. - - - - - Gets and sets the property Status. - - Indicates whether the specified object has a Legal Hold in place. - - - - - - A Retention configuration for an object. - - - - - Gets and sets the property Mode. - - Indicates the Retention mode for the specified object. - - - - - - Gets and sets the property RetainUntilDate. - - - - - The container element for an Object Lock rule. - - - - - Gets and sets the property DefaultRetention. - - The default retention period that you want to apply to new objects placed in the specified - bucket. - - - - - - Describes the location where the restore job's output is stored. - - - - - Describes an S3 location that will receive the results of the restore request. - - - - - Describes how results of the Select job are serialized. - - - - - Describes the serialization of CSV-encoded Select results. - - - - - Specifies JSON as request's output serialization format. - - - - - The owner of an S3 bucket. - - - - - The display name of the owner. - - - - - The unique identifier of the owner. - - - - - This class contains custom querystring parameters for an S3 object, which can then be signed as part of a Pre-signed URL request - - - - - Gets and sets parameters for the object. Parameter names must start with "x-". If the name passeed in as the indexer - doesn't start with "x-" then it will be prepended. - - The name of the parameter. - The value for the meta data - - - - Adds the parameter to the collection, if the name already exists it will be overwritten. - - The name of the parameter - The value for the parameter - - - - Gets the count of parameters. - - - - - Gets the names of the parameter elements. - - - - - Specifies Parquet as object's input serialization format. - - - - - A container for elements related to a particular part in a multipart operation. - A response can contain zero or more Part elements. - - - - - The date and time at which the part was uploaded. - - - - - The size of the uploaded part data. - - - - - A container holding the part number and etag used when completing a multipart upload. - - - - - Default constructor. - - - - - Constructs an instance of PartETag and sets the part number and etag. - - The part number. - the associated ETag for the part number. - - - - Compares the current object with another object of the same type. - - An object to compare with this object. - - A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has the following meanings: - Value - Meaning - Less than zero - This object is less than the parameter. - Zero - This object is equal to . - Greater than zero - This object is greater than . - - - - - The part number identifying the part. - - - - - The entity tag associated with the part. - - - - - The container element for this bucket's public-policy status. - - - - - Gets and sets the property IsPublic. - - The public-policy status for this bucket. TRUE indicates that this bucket - is public. FALSE indicates that the bucket is not public. - - - - - - The container element for all Public Access Block configuration options. You can enable - the configuration options in any combination. - - - - Amazon S3 considers a bucket policy public unless at least one of the following conditions - is true: - -
  1. - - The policy limits access to a set of CIDRs using aws:SourceIp. For more - information on CIDR, see http://www.rfc-editor.org/rfc/rfc4632.txt - - -
  2. - - The policy grants permissions, not including any "bad actions," to one of the following: - -
    • - - A fixed AWS principal, user, role, or service principal - -
    • - - A fixed aws:SourceArn - -
    • - - A fixed aws:SourceVpc - -
    • - - A fixed aws:SourceVpce - -
    • - - A fixed aws:SourceOwner - -
    • - - A fixed aws:SourceAccount - -
    • - - A fixed value of s3:x-amz-server-side-encryption-aws-kms-key-id - -
    • - - A fixed value of aws:userid outside the pattern "AROLEID:*" - -
- - "Bad actions" are those that could expose the data inside a bucket to reads or writes - by the public. These actions are s3:Get*, s3:List*, s3:AbortMultipartUpload, - s3:Delete*, s3:Put*, and s3:RestoreObject. - - - - The star notation for bad actions indicates that all matching operations are considered - bad actions. For example, because s3:Get* is a bad action, s3:GetObject, - s3:GetObjectVersion, and s3:GetObjectAcl are all bad actions. - - - - - - Gets and sets the property BlockPublicAcls. - - Specifies whether Amazon S3 should block public ACLs for this bucket. Setting this - element to TRUE causes the following behavior: - -
  • - - PUT Bucket acl and PUT Object acl calls will fail if the specified ACL allows public - access. - -
  • - - PUT Object calls will fail if the request includes an object ACL. - -
- - Note that enabling this setting doesn't affect existing policies or ACLs. - - - - - - Gets and sets the property IgnorePublicAcls. - - Specifies whether Amazon S3 should ignore public ACLs for this bucket. Setting this - element to TRUE causes Amazon S3 to ignore all public ACLs on this bucket - and any objects that it contains. - - - - Note that enabling this setting doesn't affect the persistence of any existing ACLs - and doesn't prevent new public ACLs from being set. - - - - - - Gets and sets the property BlockPublicPolicy. - - Specifies whether Amazon S3 should block public bucket policies for this bucket. Setting - this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy - if the specified bucket policy allows public access. - - - - Note that enabling this setting doesn't affect existing bucket policies. - - - - - - Gets and sets the property RestrictPublicBuckets. - - Specifies whether Amazon S3 should restrict public bucket policies for this bucket. - If this element is set to TRUE, then only the bucket owner and AWS Services - can access this bucket if it has a public policy. - - - - Note that enabling this setting doesn't affect previously stored bucket policies, - except that public and cross-account access within any public bucket policy, including - non-public delegation to specific accounts, is blocked. - - - - - - Container for the parameters to the PutAcl operation. - uses the acl subresource to set the access control list (ACL) permissions for an object that already exists in a bucket - - - - - The canned ACL to apply to the bucket. - - - - - - Custom ACLs to be applied to the bucket or object. - - - - - The bucket name that contains the object to which you want to attach the ACL. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The key of an S3 object. - If not specified, the ACLs are applied to the bucket. - - - - - If set and an object key has been specified, the ACLs are applied - to the specific version of the object. - This property is ignored if the ACL is to be set on a Bucket. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - Returns information about the PutObjectAcl response metadata. - The PutAcl operation has a void result type. - - - - - The response for the PutBucketAccelerateConfiguration operation. - Adds an object to a bucket. - - - - - Container for the parameters to the PutBucketAccelerateConfiguration request. - - - - - The name of the bucket to contain the object. - - - - - Accelerate configuration for the bucket. - - - - - Container for the parameters to the PutBucketAnalyticsConfiguration operation. - Sets an analytics configuration for the bucket (specified by the analytics configuration ID). - - - - - The name of the bucket to which an analytics configuration is stored. - - - - - The identifier used to represent an analytics configuration. - - - - - The configuration and any analyses for the analytics filter. - - - - - Returns information about the PutBucketAnalyticsConfigurationResponse response metadata. - The PutBucketAnalyticsConfigurationResponse operation has a void result type. - - - - - Container for the parameters to the PutBucketRequestPayment operation. - Creates a new server-side encryption configuration (or replaces an existing one, if present). - - - - - The name of the bucket for which the server-side encryption configuration is set. - - - - - The base64-encoded 128-bit MD5 digest of the server-side encryption configuration. - - - This header can be used as a message integrity check to verify that the data is the same data that was originally sent. - Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. - - - - - Container for server-side encryption configuration rules. Currently S3 supports one rule only. - - - - - Container for the parameters to the PutBucketRequestPayment operation. - Adds an inventory configuration (identified by the inventory ID) from the bucket. - - - - - The name of the bucket where the inventory configuration will be stored. - - - - - Specifies the inventory Id. - - - - - Specifies the inventory configuration. - - - - - Returns information about the PutInventoryConfigurationResponse response metadata. - The PutInventoryConfigurationResponse operation has a void result type. - - - - - Container for the parameters to the PutBucketLoggingRequest operation. - Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. To set the - logging status of a bucket, you must be the bucket owner. - - - - - Gets and sets the BucketName property. - - - - - Gets and sets the LoggingConfig property. - - - - - Returns information about the PutBucketLogging response metadata. - The EnableBucketLogging operation has a void result type. - - - - - Container for the parameters to the PutBucketMetricsConfigurationRequest operation. - Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. - - - - - The name of the bucket for which the metrics configuration is set. - - - - - The ID used to identify the metrics configuration. - - - - - Specifies the metrics configuration. - - - - - Returns information about the PutBucketMetricsConfiguration response metadata. - The PutBucketMetricsConfiguration operation has a void result type. - - - - - Container for the parameters to the PutBucketNotification operation. - Enables notifications of specified events for a bucket. - - - - - Gets and sets the BucketName property. - - - - - Gets and sets the TopicConfigurations property. TopicConfigurations are configuration for Amazon S3 - events to be sent to Amazon SNS topics. - - - - - Gets and sets the QueueConfigurations property. QueueConfigurations are configuration for Amazon S3 - events to be sent to Amazon SQS queues. - - - - - Gets and sets the LambdaFunctionConfigurations property. LambdaFunctionConfigurations are configuration for - Amazon S3 events to be sent to an Amazon Lambda cloud function. - - - - - Returns information about the PutBucketNotification response metadata. - The PutBucketNotification operation has a void result type. - - - - - Container for the parameters to the PutBucketPolicy operation. - Replaces a policy on a bucket. If the bucket already has a policy, the one in this request completely replaces it. - - - - - The name of the bucket. - - - - - The base64 encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. - - - This header can be used as a message integrity check to verify that the data is the same data that was originally sent. - Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. - - - - - The bucket policy as a JSON document. - - - - - Set this parameter to true to confirm that you want to remove your - permissions to change this bucket policy in the future. - - - - - Overriden to turn off sending SHA256 header. - - - - - Returns information about the PutBucketPolicy response metadata. - The PutBucketPolicy operation has a void result type. - - - - - Container for the parameters to the PutBucketReplication operation. - Sets replication configuration for your bucket. If a replication configuration exists, this replaces it. - - - - - The name of the bucket to have the replication configuration applied. - - - - - The replication configuration to be applied. - - - - - Gets and sets the property Token. - - - - - Returns information about the PutBucketReplicationConfiguration response metadata. - The PutBucketReplicationConfiguration operation has a void result type. - - - - - Container for the parameters to the PutBucket operation. - Creates a new bucket. - - - - - The canned ACL to apply to the bucket. - - - - - - If set to true the bucket will be created in the same region - as the configuration of the AmazonS3 client. - If PutBucketRequest.BucketRegion or PutBucketRequest.BucketRegionName are set they take precedence over - this property. - Default: true. - - - - - The name of the bucket to be created. - - - - - The region locality for the bucket. - - - When set, this will determine where your data will - reside in S3. Refer - for a list of possible values. - - - - - The bucket region locality expressed using the name of the region. - When set, this will determine where your data will reside in S3. - Valid values: us-east-1, us-west-1, us-west-2, eu-west-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, sa-east-1 - - - - - Gets and sets the property ObjectLockEnabledForBucket. - - Specifies whether you want S3 Object Lock to be enabled for the new bucket. - - - - - - Container for the parameters to the PutBucketRequestPayment operation. - Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This - configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the - download. - - - - - The name of the bucket to set payment config. - - - - - Gets and sets request payment configuration - - - - - Returns information about the PutBucketRequestPayment response metadata. - The PutBucketRequestPayment operation has a void result type. - - - - - Returns information about the PutBucket response and response metadata. - - - - - Container for the parameters to the PutBucketTagging operation. - Sets the tags for a bucket. - - - - - The name of the bucket to apply the tags to. - - - - - The collection of tags. - - - - - Returns information about the PutBucketTagging response metadata. - The PutBucketTagging operation has a void result type. - - - - - Container for the parameters to the PutBucketVersioning operation. - Sets the versioning state of an existing bucket. To set the versioning state, you must be the bucket owner. - - - - - The name of the bucket to be updated. - - - - - The MfaCodes Tuple associates the Serial Number and the current Token/Code displayed on the - Multi-Factor Authentication device associated with your AWS Account. - - - This is a required property for this request if:
- 1. EnableMfaDelete was configured on the bucket - containing this object's version.
- 2. You are deleting an object's version - - - - - Checks if the MfaCodes property is set. - - true if the MfaCodes property is set. - - - - The versioning configuration to apply to the bucket. - - - Once Versioning has been "Enabled" on a bucket, it can be "Suspended" - but cannot be switched "Off". If EnableMfaDelete is set, - the MfaCodes property needs to contain the Serial of and current Token - displayed on the MFA device. - - - - - Returns information about the PutBucketVersioning response metadata. - The PutBucketVersioning operation has a void result type. - - - - - Container for the parameters to the PutBucketWebsite operation. - Set the website configuration for a bucket. - - - - - The name of the bucket to apply the configuration to. - - - - - The website configuration to apply. The configuration defines the index - document suffix and custom error page. - - - - - Returns information about the PutBucketWebsite response metadata. - The PutBucketWebsite operation has a void result type. - - - - - Container for the parameters to the PutCORSConfiguration operation. - Sets the cors configuration for a bucket. - - - - - The name of the bucket to have the CORS configuration applied. - - - - - The CORS configuration to apply. - - - - - Returns information about the PutCORSConfiguration response metadata. - The PutCORSConfiguration operation has a void result type. - - - - - Container for the parameters to the PutLifecycleConfiguration operation. - Sets lifecycle configuration for your bucket. If a lifecycle configuration exists, it replaces it. - - - - - The name of the bucket to have the lifecycle configuration applied. - - - - - The lifecycle configuration to be applied. - - - - - Returns information about the PutLifecycleConfiguration response metadata. - The PutLifecycleConfiguration operation has a void result type. - - - - - Container for the parameters to the PutObjectLegalHold operation. - Applies a Legal Hold configuration to the specified object. - - - - - The bucket name containing the object that you want to place a Legal Hold on. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property ContentMD5. - - The MD5 signature for the configuration included in your request. - - - - - - Gets and sets the property Key. - - The key name for the object that you want to place a Legal Hold on. - - - - - - Gets and sets the property LegalHold. - - Container element for the Legal Hold configuration you want to apply to the specified - object. - - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property VersionId. - - The version ID of the object that you want to place a Legal Hold on. - - - - - - This is the response object from the PutObjectLegalHold operation. - - - - - Gets and sets the property RequestCharged. - - - - - Container for the parameters to the PutObjectLockConfiguration operation. - Places an Object Lock configuration on the specified bucket. The rule specified in - the Object Lock configuration will be applied by default to every new object placed - in the specified bucket. - - - - - Gets and sets the property BucketName. - - The bucket whose Object Lock configuration you want to create or replace. - - - - - - Gets and sets the property ContentMD5. - - The MD5 signature for the configuration included in your request. - - - - - - Gets and sets the property ObjectLockConfiguration. - - The Object Lock configuration that you want to apply to the specified bucket. - - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property Token. - - - - - This is the response object from the PutObjectLockConfiguration operation. - - - - - Gets and sets the property RequestCharged. - - - - - Container for the parameters to the PutObject operation. - Adds an object to a bucket. - - - Container for the parameters to the PutObject operation. - Adds an object to a bucket. - - - - - A canned access control list (CACL) to apply to the object. - Please refer to for - information on S3 Canned ACLs. - - - - - Input stream for the request; content for the request will be read from the stream. - - - - - - The full path and name to a file to be uploaded. - If this is set the request will upload the specified file to S3. - - - For WinRT and Windows Phone this property must be in the form of "ms-appdata:///local/file.txt". - - - - - - Text content to be uploaded. Use this property if you want to upload plaintext to S3. - The content type will be set to 'text/plain'. - - - - - If this value is set to true then the stream used with this request will be closed when all the content - is read from the stream. - Default: true. - - - - - If this value is set to true then the stream will be seeked back to the start before being read for upload. - Default: true. - - - - - If this value is set to true then a chunked encoding upload will be used for the request. - Default: true. - - - - - Bucket name to which the PUT operation was initiated. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - Gets and sets Key property. This key is used to identify the object in S3. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - Checks if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - true if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - - - The type of storage to use for the object. Defaults to 'STANDARD'. - - - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - The Legal Hold status that you want to apply to the specified object. - - - - - - Gets and sets the property ObjectLockMode. - - The Object Lock mode that you want to apply to this object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - The date and time when you want this object's Object Lock to expire. - - - - - - If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - Attach a callback that will be called as data is being sent to the AWS Service. - - - - - This is a convenience property for Headers.ContentType. - - - - - An MD5 digest for the content. - - - - The base64 encoded 128-bit MD5 digest of the message - (without the headers) according to RFC 1864. This header - can be used as a message integrity check to verify that - the data is the same data that was originally sent. - - - If supplied, after the file has been uploaded to S3, - S3 checks to ensure that the MD5 hash of the uploaded file - matches the hash supplied. - - - Although it is optional, we recommend using the - Content-MD5 mechanism as an end-to-end integrity check. - - - - - - Checks if MD5Digest property is set. - - true if MD5Digest property is set. - - - - Overriden to turn off sending SHA256 header. - - - - - Overriden to turn on expect 100 continue. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - The tag-set for the object. The tag-set must be encoded as URL Query parameters. - - - - - Checks if Tagging property is set - - true if Tagging is set. - - - - Overrides the default request timeout value. - - - - If the value is set, the value is assigned to the Timeout property of the HTTPWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Overrides the default ReadWriteTimeout value. - - - - If the value is set, the value is assigned to the ReadWriteTimeout property of the HTTPWebRequest/WebRequestHandler object used - to send requests. - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - - Returns information about the PutObject response and response metadata. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - Entity tag for the uploaded object. - - - - - - Version of the object. - - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the PutObjectRetention operation. - Places an Object Retention configuration on an object. - - - - - The bucket name that contains the object you want to apply this Object Retention configuration to. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property BypassGovernanceRetention. - - - - - Gets and sets the property ContentMD5. - - The MD5 signature for the configuration included in your request. - - - - - - Gets and sets the property Key. - - The key name for the object that you want to apply this Object Retention configuration - to. - - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property Retention. - - The container element for the Object Retention configuration. - - - - - - Gets and sets the property VersionId. - - The version ID for the object that you want to apply this Object Retention configuration - to. - - - - - - This is the response object from the PutObjectRetention operation. - - - - - Gets and sets the property RequestCharged. - - - - - Container for the parameters to the PutObjectTagging operation. - - - - - The bucket name containing the object. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Check to see if Bucket property is set - - - - - Gets and sets Key property. This key is used to identify the object in S3. - - - - - Check to see if Key property is set - - - - - The tag-set for the object. The tag-set must be encoded as URL Query parameters - - - - - Checks if Tagging property is set. - - - - - VersionId used to reference a specific version of the object. - - - - - - Returns information about the PutObjectTagging response and response metadata. - - - - - Version of the object. - - - - - Container for the parameters to the PutPublicAccessBlock operation. - Creates or modifies the Public Access Block configuration for an Amazon S3 bucket. - - - - - Gets and sets the property BucketName. - - The name of the Amazon S3 bucket whose Public Access Block configuration you want - to set. - - - - - - Gets and sets the property ContentMD5. - - The MD5 hash of the PutPublicBlock request body. - - - - - - Gets and sets the property PublicAccessBlockConfiguration. - - The Public Access Block configuration that you want to apply to this Amazon S3 bucket. - - - - - - This is the response object from the PutPublicAccessBlock operation. - - - - - Base class for put operations that can also put an ACL. - - - - - Gets the access control lists (ACLs) for this request. - Please refer to for information on - S3 Grants. - - - - - This class contains the configuration Amazon S3 uses to figure out what events you want to listen - and send the event to an Amazon SQS queue. - - The queue's policy must allow S3 to send messages to it. The utility method - Amazon.SQS.AmazonSQSClient.AuthorizeS3ToSendMessage(string,string) - can be used to help setup the queue policy. - - - - - - Gets and set the Id property. The Id will be provided in the event content and can be used - to identify which configuration caused an event to fire. If the Id is not provided for the configuration, one will be generated. - - - - - Gets and sets the Queue property. Amazon SQS queue to which Amazon S3 will publish a message - to report the specified events for the bucket. - - The queue's policy must allow S3 to send messages to it. The utility method - Amazon.SQS.AmazonSQSClient.AuthorizeS3ToSendMessage(string,string) - can be used to help setup the queue policy. - - - - - - This class defines the configuration for replication. - - - - - Indicates the ARN of the role to assume. - - - - - Check to see if the Role property is set. - - true if the Role property is set. - - - - Container for information about a particular replication rule. - Replication configuration must have at least one rule and can contain up to 1,000 rules. - - - - - Checks to see if the Rules property is set. - - true if the Rules property is set. - - - - Destination configuration for a replication rule. - - - - -

Amazon resource name (ARN) of the bucket where you want Amazon - S3 to store replicas of the object identified by the rule.

- If you have multiple rules in your replication configuration, all - rules must specify the same bucket as the destination. A replication - configuration can replicate objects only to one destination bucket.

- - - - - Checks to see if BucketArn property is set. - - true if BucketArn property is set. - - - - The class of storage used to store the object. - - - - - -

Account ID of the destination bucket. Currently Amazon S3 verifies this - value only if Access Control Translation is enabled.

In a cross-account - scenario, if you tell Amazon S3 to change replica ownership to the AWS account - that owns the destination bucket by adding the AccessControlTranslation - element, this is the account ID of the destination bucket owner.

- - - - -

Container for information regarding the access control for replicas.

-

Use only in a cross-account scenario, where source and destination bucket - owners are not the same, when you want to change replica ownership to the AWS - account that owns the destination bucket. If you don't add this element to the - replication configuration, the replicas are owned by same AWS account that - owns the source object.

- - - - -

Container that provides encryption-related information. You must - specify this element if the SourceSelectionCriteria is - specified.

- - - - - A container specifying the time when all objects and operations on objects are - replicated. Must be specified together with a Metrics block. - - - - - A container specifying replication metrics-related information, including whether - emitting metrics and Amazon S3 events for replication are enabled. In addition, - contains configurations related to specific metrics or events. Must be specified - together with a ReplicationTime block. - - - - - Rule that specifies the replication configuration. - - - - - Unique identifier for the rule. The value cannot be longer than 255 characters. - - - - - Checks to see if Id property is set. - - true if Id property is set. - - - -

The priority associated with the rule. If you specify multiple rules in a - replication configuration, then Amazon S3 applies rule priority in the event - there are conflicts (two or more rules identify the same object based on - filter specified). The rule with higher priority takes precedence. For - example,

  • Same object quality prefix based filter criteria - If prefixes you specified in multiple rules overlap.

  • Same - object qualify tag based filter criteria specified in multiple rules

    • -

For more information, see - - Cross-Region Replication (CRR) in the Amazon S3 Developer Guide.

- - - - - Checks to see if Priority property is set. - - true if Priority property is set. - - - - Object keyname prefix identifying one or more objects to which the - rule applies. Maximum prefix length can be up to 1,024 characters. - - - - - Checks to see if Prefix property is set. - - true if Prefix property is set. - - - - Gets and sets the property Filter. - - - - - Checks to see if Filter property is set. - - true if Filter property is set. - - - - Whether the rule is applied or ignored. - - - - - Checks to see if Status property is set. - - true if Status property is set. - - - - Container for replication destination information. - - - - - Checks to see if Destination property is set. - - true if Destination property is set. - - - -

Container that describes additional filters in identifying source objects that - you want to replicate. Currently, Amazon S3 supports only the filter that you can - specify for objects created with server-side encryption using an AWS KMS-managed - key. You can choose to enable or disable replication of these objects.

if - you want Amazon S3 to replicate objects created with server-side encryption using - AWS KMS-managed keys.

- - - - - A container that specifies information about existing object replication. - You can choose whether to enable or disable the replication of existing objects. - - - - - Checks to see if ExistingObjectReplication property is set. - - true if ExistingObjectReplication property is set. - - - - Specifies whether Amazon S3 should replicate delete makers. - - - - - Checks to see if DeleteMarkerReplication property is set. - - true if DeleteMarkerReplication property is set. - - - - - - - - Object keyname prefix that identifies subset of objects to which the rule applies. - - - - - Checks to see if Prefix property is set. - - true if Prefix property is set. - - - - All of these tags must exist in the object's tag set in order for the rule to apply. - - - - - Checks to see if Tags property is set. - - true if Tags property is set. - - - - Filter that identifies subset of objects to which the replication rule applies. - A Filter must specify exactly one Prefix, - Tag, or an And child element. - - - - - Object keyname prefix that identifies subset of objects to which the rule applies. - - - - - Checks to see if Prefix property is set. - - true if Prefix property is set. - - - -

Container for specifying a tag key and value.

-

The rule applies only to objects having the tag in its tagset.

- - - - - Checks to see if Tag property is set. - - true if Tag property is set. - - - -

Container for specifying rule filters. These filters determine the - subset of objects to which the rule applies. The element is required - only if you specify more than one filter. For example:

  • -

    You specify both a Prefix and a Tag - filters. Then you wrap these in an And tag.

    • -

  • You specify filter based on multiple tags. Then you wrap the - Tag elements in an And tag.

- - - - - Checks to see if And property is set. - - true if And property is set. - - - - A container specifying the time when all objects and operations on objects are replicated. Must be specified together with a Metrics block. - - - - - Specifies whether the replication time is enabled. - - - - - A container specifying the time by which replication should complete for all objects and operations on objects. - - - - - A container specifying the time value. - - - - - Contains an integer specifying time in minutes. - - - - - Request Payment Configuration - - - - - Specifies who pays for the download and request fees. - - - - - Container for values of the response headers that will be set on a response from a GetObject request. - These values override any headers that were set when the object was uploaded to S3. - - - - - A standard MIME type describing the format of the object data. - - - The content type for the content being uploaded. This property defaults to "binary/octet-stream". - For more information, refer to: - - - - - ContentLanguage header value. - - - - - Expiry header value. - - - - - CacheControl header value. - - - - - The ContentDisposition header value. - - - - - The ContentEncoding header value. - - - - - Container for the parameters to the RestoreObject operation. - Restores an archived copy of an object back into Amazon S3 - - - - - The bucket name or containing the object to restore. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the Key property. This key indicates the S3 object to restore. - - - - - Lifetime of the active copy in days - ** Do not use with restores that specify OutputLocation ** - - - - - VersionId used to reference a specific version of the object. - - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Glacier retrieval tier at which the restore will be processed. - ** Do not use with restores that specify OutputLocation ** - - - - - Glacier retrieval tier at which the restore will be processed. - ** Only use with restores that require OutputLocation ** - - - - - Type of restore request. - - - - - The optional description for the job. - - - - - Describes the parameters for Select job types. - - - - - Describes the location where the restore job's output is stored. - - - - - Returns information about the RestoreObject response metadata. - The RestoreObject operation has a void result type. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Indicates the path in the provided S3 output location where Select results will be restored to. - - - - Routing Rule - - - - - A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the - /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might - process the error. - - - - - - Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event of an - error, you can can specify a different error code to return. - - - - - - A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages - in the /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you - might process the error. - - - - - The HTTP error code when the redirect is applied. In the event of an error, if the error code equals this value, then the specified redirect - is applied. Required when parent element Condition is specified and sibling KeyPrefixEquals is not specified. If both are specified, then - both must be true for the redirect to be applied. - - - - - - The object key name prefix when the redirect is applied. For example, to redirect requests for ExamplePage.html, the key prefix will be - ExamplePage.html. To redirect request for all pages with the prefix docs/, the key prefix will be /docs, which identifies all objects in the - docs/ folder. Required when the parent element Condition is specified and sibling HttpErrorCodeReturnedEquals is not specified. If both - conditions are specified, both must be true for the redirect to be applied. - - - - - - Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event - of an error, you can can specify a different error code to return. - - - - - Name of the host where requests will be redirected. - - - - - - The HTTP redirect code to use on the response. Not required if one of the siblings is present. - - - - - - Protocol to use (http, https) when redirecting requests. The default is the protocol that is used in the original request. - - - - - - The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix docs/ (objects in the - docs/ folder) to documents/, you can set a condition block with KeyPrefixEquals set to docs/ and in the Redirect set ReplaceKeyPrefixWith to - /documents. Not required if one of the siblings is present. Can be present only if ReplaceKeyWith is not provided. - - - - - - The specific object key to use in the redirect request. For example, redirect request to error.html. Not required if one of the sibling is - present. Can be present only if ReplaceKeyPrefixWith is not provided. - - - - - - Represents an access control list (ACL) for S3. An AccessControlList is represented by an Owner, - and a List of Grants, where each Grant is a Grantee and a Permission. - - - - Each bucket and object in Amazon S3 has an ACL that defines its access control policy. - When a request is made, Amazon S3 authenticates the request using its standard - authentication procedure and then checks the ACL to verify the sender was granted access - to the bucket or object. If the sender is approved, the request proceeds. - Otherwise, Amazon S3 returns an error. - - - An ACL is a list of grants. A grant consists of one grantee and one permission. - ACLs only grant permissions; they do not deny them. - - - For convenience, some commonly used Access Control Lists are defined in - S3CannedACL. - - - Note: BucketName and object ACLs are completely independent; an object does not inherit the ACL - from its bucket. For example, if you create a bucket and grant write access to another user, - you will not be able to access the user's objects unless the user explicitly grants access. - This also applies if you grant anonymous write access to a bucket. Only the user "anonymous" - will be able to access objects the user created unless permission is explicitly granted to - the bucket owner. - - - Important: We highly recommend that you do not grant the anonymous group write access to your - buckets as you will have no control over the objects others can store and their associated charges. - For more information, see Grantees and Permissions - - - - - Creates a S3Grant and adds it to the list of grants. - - The grantee for the grant. - The permission for the grantee. - - - - Removes a specific permission for the given grantee. - - The grantee - The permission for the grantee to remove - - - - Removes all permissions for the given grantee. - - - - - - The owner of the bucket or object. - - - - Every bucket and object in Amazon S3 has an owner, the user that - created the bucket or object. The owner of a bucket or object cannot - be changed. However, if the object is overwritten by another user - (deleted and rewritten), the new object will have a new owner. - - - Note: Even the owner is subject to the ACL. For example, if an owner - does not have Permission.READ access to an object, the owner cannot read - that object. However, the owner of an object always has write access to the - access control policy (Permission.WriteAcp) and can change the ACL to - read the object. - - - - - - Checks if Owner property is set. - - true if Owner property is set. - - - - A collection of grants. - - - - - Checks if Grants property is set. - - true if Grants property is set. - - - Bucket - Represents an S3 bucket, contains the name of the S3 bucket and the date that the bucket was created. - - - - - Date the bucket was created. - - - - - - The name of the bucket. - - - - - Logging Enabled - - - - - Specifies the bucket where you want Amazon S3 to store server access logs. You can have your logs delivered to any bucket that you own, - including the same bucket that is being logged. You can also configure multiple buckets to deliver their logs to the same target bucket. In - this case you should choose a different TargetPrefix for each source bucket so that the delivered log files can be distinguished by key. - - - - - A collection of grants. - - - - - This element lets you specify a prefix for the keys that the log files will be stored under. - - - - - Creates a S3Grant and adds it to the list of grants. - - The grantee for the grant. - The permission for the grantee. - - - - Removes a specific permission for the given grantee. - - The grantee - The permission for the grantee to remove - - - - Removes all permissions for the given grantee. - - - - - - An S3 bucket versioning configuration. - - - Contains the bucket's versioning status (Off, Enabled, Suspended) and whether an MFADelete - has been enabled for the bucket. - - - - - Versioning status for the bucket. - Accepted values: Off, Enabled, Suspended. - - - - - Checks if Status property is set - - true if Status property is set - - - - Specifies whether MFA Delete is enabled on this S3 Bucket. - - - If this property is set, please ensure that the - PutBucketVersioningRequest's MfaCodes property is set with - the Serial of and Token on the MFA device. - - - - - Checks if EnableMfaDelete property is set. - - true if Status property is set - - - - Describes the server-side encryption that will be applied to the restore results. - - - - - The server-side encryption algorithm used when storing job results in Amazon S3 (e.g., AES256, aws:kms). - - - - - Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by - AWS KMS will fail if not made via SSL or using SigV4. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at - http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version - - - - - If the encryption type is aws:kms, this optional value can be used to specify the encryption context for the restore results. - - - - Grant - - - - - The grantee details. - - - - - Specifies the permission given to the grantee. - - - - - Grantee - - - - - Type of grantee - - - - - - Screen name of the grantee. - - - - - - Email address of the grantee. - - - - - - The canonical user ID of the grantee. - - - - - - URI of the grantee group. - - - - - - Filter criteria that allows for event notification filtering based on an S3 Object's key name. - - - - - Gets and sets the filterRules property. - These are the filter rules for this filter. - - - - - Describes an S3 location that will receive the results of the restore request. - - - - - The name of the bucket where the restore results will be placed. - - - - - The prefix that is prepended to the restore results for this request. - - - - - The canned ACL to apply to the restore results. - - - - - A list of grants that control access to the staged results. - - - - - The tag-set that is applied to the restore results. - - - - - A map of metadata to store with the restore results in S3. - - - - - The class of storage used to store the restore results. - - - - - Represents an S3 Object. Contains all attributes that an S3 Object has. - For more information about S3 Objects refer: - - - - - - Any ETag set on the object. - - - - - The name of the bucket containing this object. - - - - - The key of the object. - - - - - The date and time the object was last modified. - - The date retrieved from S3 is in ISO8601 format. A GMT formatted date is passed back to the user. - - - - - - The owner of the object. - - - - - The size of the object. - - - - - The class of storage used to store the object. - - - - - - Represents a version of an object in an S3 Bucket. An S3 object version is an S3 object - that also has a version identifier, an indication of whether this is the latest version of the object - and whether it's a DeleteMarker or not. - - - - - Specifies whether the object is (true) or is not (false) the latest version of an object. - - - - - Version ID of an object. - - - - - If true, the object is a delete marker for a deleted object. - - - - - Specifies the byte range of the object to get the records from. A record is processed when its first byte is contained by the range. - - - - - Specifies the start of the byte range. This parameter is optional. Valid values: non-negative integers. The default value is 0. - - - - - Specifies the end of the byte range. This parameter is optional. Valid values: non-negative integers. The default value is one less than the size of the object being queried. - - - - - Request to filter the contents of an Amazon S3 object based on a simple Structured Query Language (SQL) statement. - - In the request, along with the SQL expression, you must also specify a data serialization format (JSON or CSV) of the object. - Amazon S3 uses this to parse object data into records, and returns only records - that match the specified SQL expression. You must also specify the data serialization format for the response. - - - - S3Select API Documentation - - - - - The S3 Bucket. - - - - - The Object Key. - - - - - The SSE Algorithm used to encrypt the object. - - - Server-Side Encryption (Using Customer-Provided Encryption Keys. - - - - - The SSE Customer Key. - - - Server-Side Encryption (Using Customer-Provided Encryption Keys. - - - - - The SSE Customer Key MD5. - - - Server-Side Encryption (Using Customer-Provided Encryption Keys. - - - - - The expression that is used to query the object. - - - - - The type of the provided expression (e.g., SQL). - - - - - Specifies if periodic request progress information should be enabled. - - - - - Describes the format of the data in the object that is being queried. - - - - - Describes the format of the data that you want Amazon S3 to return in response. - - - - - The byte range of the object to get the records from. - - - - - Contains the response Payload for the SelectObjectContent request - - - - - The Event Stream result of SelectObjectContent - - - - - Describes the parameters for Select job types. - - - - - Describes the serialization format of the object. - - - - - The type of the provided expression (e.g., SQL). - - - - - The expression that is used to query the object. - - - - - Describes how the results of the Select job are serialized. - - - - - ServerSideEncryptionByDefault class - - - - - Server-side encryption algorithm to use for the default encryption. - - - - - KMS master key ID to use for the default encryption. - This parameter is allowed if SSEAlgorithm is aws:kms. - - - - - ServerSideEncryptionConfiguration class - - - - - Container for information about a particular server-side encryption configuration rule. - - - - - ServerSideEncryptionRule class - - - - - Describes the default server-side encryption to apply to - new objects in the bucket. If Put Object request - does not specify any server-side encryption, - this default encryption will be applied. - - - - - SourceSelectionCriteria class - - - - - Container for filter information of selection of KMS Encrypted - S3 objects. The element is required if you include - SourceSelectionCriteria in the replication - configuration. - - - - - SSEKMS class - - - - - Specifies the ID of the AWS Key Management Service (KMS) - master encryption key to use for encrypting Inventory reports. - - - - - SseKmsEncryptedObjects class - - - - - The replication for KMS encrypted S3 objects is disabled if status is not Enabled. - - - - - SSES3 class - - - - - Class for StorageClassAnalysis - - - - - A container used to describe how data related to the storage class analysis should be exported. - - - - - Class for StorageClassAnalysisDataExport - - - - - The version of the output schema to use when exporting data. Must be V_1. - - - - - The place to store the data for an analysis. - - - - - Base class for responses that return a stream. - - - - - Disposes of all managed and unmanaged resources. - - - - - An open stream read from to get the data from S3. In order to - use this stream without leaking the underlying resource, please - wrap access to the stream within a using block. - - - - - The exception that is thrown when the size of a stream does not match it's expected size. - - - - - Gets and sets ExpectedSize property. - - - - - Gets and sets ActualSize property. - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - - - Constructs a new instance of the AmazonServiceException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - Tag is a key-value pair of metadata associated with an S3Object - - - - - Name of the tag. - - - - - Value of the tag. - - - - - Structure that contains list of Tags - - - - - TagSet - - - - - This class contains the configuration Amazon S3 uses to figure out what events you want to listen - and send the event to an Amazon SNS topic. - - The topic's policy must allow S3 to publish messages to it. The utility method - Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.AuthorizeS3ToPublish(string,string) - can be used to help setup the topic policy. - - - - - - Gets and set the Id property. The Id will be provided in the event content and can be used - to identify which configuration caused an event to fire. If the Id is not provided for the configuration, one will be generated. - - - - - Bucket event for which to send notifications. - - Topic configurations can now contain multiple events. This property is obsolete in favor of the Events property. - This property will always get or set the the zeroth element in the Events collection. - - - - - - Gets and sets the Topic property. Amazon SNS topic to which Amazon S3 will publish a message to report the - specified events for the bucket. - - The topic's policy must allow S3 to publish messages to it. The utility method - Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.AuthorizeS3ToPublish(string,string) - can be used to help setup the topic policy. - - - - - - The parameters to request upload of a part in a multipart upload operation. - - - - If PartSize is not specified then the rest of the content from the file - or stream will be sent to Amazon S3. - - - You must set either the FilePath or InputStream. If FilePath is set then the FilePosition - property must be set. - - - - The parameters to request upload of a part in a multipart upload operation. - - - - If PartSize is not specified then the rest of the content from the file - or stream will be sent to Amazon S3. - - - You must set either the FilePath or InputStream. If FilePath is set then the FilePosition - property must be set. - - - - - - Caller needs to set this to true when uploading the last part. This property only needs to be set - when using the AmazonS3EncryptionClient. - - - - - Input stream for the request; content for the request will be read from the stream. - - - - - The name of the bucket containing the object to receive the part. - - - - - The key of the object. - - - - - Part number of part being uploaded. - - - - - - The size of the part to be uploaded. - - - - - Checks if PartSize property is set. - - true if PartSize property is set. - - - - Upload ID identifying the multipart upload whose part is being uploaded. - - - - - - An MD5 digest for the part. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - - Full path and name of a file from which the content for the part is retrieved. - - - For WinRT and Windows Phone this property must be in the form of "ms-appdata:///local/file.txt". - - - - - - Checks if the FilePath property is set. - - true if FilePath property is set. - - - - Position in the file specified by FilePath from which to retrieve the content of the part. - This field is required when a file path is specified. It is ignored when using the InputStream property. - - - - - If this value is set to true then a chunked encoding upload will be used for the request. - Default: true. - - - - - Checks if the FilePosition property is set. - - true if FilePosition property is set. - - - - Checks if the MD5Digest property is set. - - true if Md5Digest property is set. - - - - Attach a callback that will be called as data is being sent to the AWS Service. - - - - - Overriden to turn off sending SHA256 header. - - - - - Overriden to turn on Expect 100 continue. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Overrides the default request timeout value. - - - - If the value is set, the value is assigned to the Timeout property of the HTTPWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Overrides the default ReadWriteTimeout value. - - - - If the value is set, the value is assigned to the ReadWriteTimeout property of the HTTPWebRequest/WebRequestHandler object used - to send requests. - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - - Returns information about the UploadPart response and response metadata. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - Entity tag for the uploaded object. - - - - - - Gets and sets the part number specified for the part upload. This is needed when - completing the multipart upload. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - Website Configuration - - - - - The ErrorDocument value, an object key name to use when a 4XX class error occurs. - - - - - - This value is a suffix that is appended to a request that is for a "directory" - on the website endpoint (e.g. if the suffix is index.html and - you make a request to samplebucket/images/ the data that - is returned will be for the object with the key name - images/index.html) - - - The suffix must not be empty and must not include a slash - character. - - - - - - Container for redirect information where all requests will be redirect - to. You can redirect requests to another host, to another page, or with - another protocol. In the event of an error, you can can specify a - different error code to return. . - - - - - The list of routing rules that can be used for configuring redirects if certain conditions are meet. - - - - - Arguments containing event details for an in-flight transfer. - - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - - - - Gets the percentage of transfer completed - - - - - Gets the number of bytes transferred since last event - - - - - Gets the number of bytes transferred - - - - - Gets the total number of bytes to be transferred - - - - - Returns a string representation of this object - - - - - - AmazonS3 exception. - Thrown when DeleteObjects returns successfully, but some of the objects - were not deleted. - - - - - Gets and sets the ErrorResponse property. - The DeleteObjectsErrorResponse associated with this exception. - - - - - Constructs an instance of DeleteObjectsException - - - - - - Constructs a new instance of the DeleteObjectsException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - The file format used when exporting data to Amazon S3. - - - - - CSV file format. - - - - - Construct instance of AnalyticsS3ExportFileFormat. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to an AnalyticsS3ExportFileFormat. - - - - - - - Represents the accelerate status for a bucket. - - - - - Bucket acceleration is enabled. - - - - - Bucket acceleration is suspended. - - - - - Construct instance of BucketAccelerateStatus. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to an BucketAccelerateStatus - - - - - - - The status of the delete marker replication. - - - - - Delete marker replication is enabled. - - - - - Delete marker replication is disabled. - - - - - Construct instance of DeleteMarkerReplicationStatus. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to a DeleteMarkerReplicationStatus - - - - - - - A list of all possible CannedACLs that can be used - for S3 Buckets or S3 Objects. For more information about CannedACLs, refer to - . - - - - - Owner gets FULL_CONTROL. - No one else has access rights (default). - - - - - Owner gets FULL_CONTROL. - No one else has access rights (default). - - - - - Owner gets FULL_CONTROL and the anonymous principal is granted READ access. - If this policy is used on an object, it can be read from a browser with no authentication. - - - - - Owner gets FULL_CONTROL, the anonymous principal is granted READ and WRITE access. - This can be a useful policy to apply to a bucket, but is generally not recommended. - - - - - Owner gets FULL_CONTROL, and any principal authenticated as a registered Amazon - S3 user is granted READ access. - - - - - Owner gets FULL_CONTROL. Amazon EC2 gets READ access to GET an - Amazon Machine Image (AMI) bundle from Amazon S3. - - - - - Object Owner gets FULL_CONTROL, Bucket Owner gets READ - This ACL applies only to objects and is equivalent to private when used with PUT Bucket. - You use this ACL to let someone other than the bucket owner write content (get full control) - in the bucket but still grant the bucket owner read access to the objects. - - - - - Object Owner gets FULL_CONTROL, Bucket Owner gets FULL_CONTROL. - This ACL applies only to objects and is equivalent to private when used with PUT Bucket. - You use this ACL to let someone other than the bucket owner write content (get full control) - in the bucket but still grant the bucket owner full rights over the objects. - - - - - The LogDelivery group gets WRITE and READ_ACP permissions on the bucket. - - - - - Construct instance of S3CannedACL. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to an S3CannedACL - - - - - - - A list of all possible S3 Bucket region possibilities. For - more information, refer to - . - - - - - Specifies that the S3 Bucket should use US locality. - This is the default value. - - - - - Specifies that the S3 Bucket should use US-EAST-2 locality. - - - - - Specifies that the S3 Bucket should use EU locality which defaults to EU-WEST-1 - - - - - Specifies that the S3 Bucket should use the EU-NORTH-1 locality. - - - - - Specifies that the S3 Bucket should use the EU-WEST-1 locality. - - - - - Specifies that the S3 Bucket should use the EU-WEST-2 locality. - - - - - Specifies that the S3 Bucket should use the EU-WEST-3 locality. - - - - - Specifies that the S3 Bucket should use the EU-CENTRAL-1 locality. - - - - - Specifies that the S3 Bucket should use US-WEST-1 locality. - - - - - Specifies that the S3 Bucket should use US-WEST-2 locality. - - - - - Specifies that the S3 Bucket should use US-GOV-EAST-1 locality. - - - - - Specifies that the S3 Bucket should use US-GOV-WEST-1 locality. - - - - - Specifies that the S3 Bucket should use the AP-EAST-1 locality. - - - - - Specifies that the S3 Bucket should use the AP-SOUTHEAST-1 locality. - - - - - Specifies that the S3 Bucket should use the AP-SOUTHEAST-2 locality. - - - - - Specifies that the S3 Bucket should use the AP-NORTHEAST-1 locality. - - - - - Specifies that the S3 Bucket should use the AP-NORTHEAST-2 locality. - - - - - Specifies that the S3 Bucket should use the AP-NORTHEAST-3 locality. - - - - - Specifies that the S3 Bucket should use the AP-SOUTH-1 locality. - - - - - Specifies that the S3 Bucket should use the SA-EAST-1 locality. - - - - - Specifies that the S3 Bucket should use CN-NORTH-1 locality. - - - - - Specifies that the S3 Bucket should use CN-NORTHWEST-1 locality. - - - - - Specifies that the S3 Bucket should use CA-CENTRAL-1 locality. - - - - - Specifies that the S3 Bucket should use US-WEST-1 locality. - - - - - Specifies that the S3 Bucket should use CN-NORTH-1 locality. - - - - - Specifies that the S3 Bucket should use US-GOV-WEST-1 locality. - - - - - Construct instance of S3Region. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to the S3Region class - - - - - - - A list of all ACL permissions. For more information, refer to - . - - - - - When applied to a bucket, grants permission to list the bucket. - When applied to an object, this grants permission to read the - object data and/or metadata. - - - - - When applied to a bucket, grants permission to create, overwrite, - and delete any object in the bucket. This permission is not - supported for objects. - - - - - Grants permission to read the ACL for the applicable bucket or object. - The owner of a bucket or object always has this permission implicitly. - - - - - Gives permission to overwrite the ACP for the applicable bucket or object. - The owner of a bucket or object always has this permission implicitly. - Granting this permission is equivalent to granting FULL_CONTROL because - the grant recipient can make any changes to the ACP. - - - - - Provides READ, WRITE, READ_ACP, and WRITE_ACP permissions. - It does not convey additional rights and is provided only for convenience. - - - - - Gives permission to restore an object that is currently stored in Amazon Glacier - for archival storage. - - - - - Construct S3Permission. - - - - - - Construct instance of S3Permission. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - - Gets and sets the HeaderName property. - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to an S3Permission - - - - - - - An enumeration of all Metadata directives that - can be used for the CopyObject operation. - - - - - Specifies that the metadata is copied from the source object. - - - - - Specifies that the metadata is replaced with metadata provided in the request. - All original metadata is replaced by the metadata you specify. - - - - - An enumeration of all protocols that the pre-signed - URL can be created against. - - - - - https protocol will be used in the pre-signed URL. - - - - - http protocol will be used in the pre-signed URL. - - - - - An enumeration of supported HTTP verbs - - - - - The GET HTTP verb. - - - - - The HEAD HTTP verb. - - - - - The PUT HTTP verb. - - - - - The DELETE HTTP verb. - - - - - S3 Storage Class Definitions - - - - - The STANDARD storage class, which is the default - storage class for S3. - - Durability 99.999999999%; Availability 99.99% over a given year. - - - - - REDUCED_REDUNDANCY provides the same availability as standard, but at a lower durability. - - Durability 99.99%; Availability 99.99% over a given year. - - - - - The GLACIER storage is for object that are stored in Amazon Glacier. - This storage class is for objects that are for archival purpose and - get operations are rare. - - Durability 99.999999999% - - - - - The STANDARD_IA storage is for infrequently accessed objects. - This storage class is for objects that are long-lived and less frequently accessed, - like backups and older data. - - Durability 99.999999999%; Availability 99.9% over a given year. - - - - - The ONEZONE_IA storage is for infrequently accessed objects. It is similiar to STANDARD_IA, but - only stores object data within one Availablity Zone in a given region. - - Durability 99.999999999%; Availability 99% over a given year. - - - - - IntelligentTiering makes it easy to lower your overall cost of storage by automatically placing data in the storage - class that best matches the access patterns for the storage. With IntelligentTiering, you don’t need to define - and manage individual policies for lifecycle data management or write code to transition objects - between storage classes. Instead, you can use IntelligentTiering to manage transitions between Standard and - S-IA without writing any application code. IntelligentTiering also manages transitions automatically to - Glacier for long term archive in addition to S3 storage classes. - - - - - S3 Glacier Deep Archive provides secure, durable object storage class for long term data archival. - It is the ideal storage class to make an archival, durable copy of data that rarely, if ever, needs to be accessed. - It can be used as an offline backup for their most important data assets and to meet long-term retention needs. - - - - - Construct an instance of S3StorageClass. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to S3StorageClass. - - - - - - - The constants for the known event names used by S3 notification. S3 might add new - events before the SDK is updated. In which case the names listed in the S3 documentation - will work as well as these constants. - - - - - An event that says an object has been lost in the reduced redundancy storage. - - - - - A list of all server-side encryption methods for customer provided encryption keys. - - - - - No server side encryption to be used. - - - - - Use AES 256 server side encryption. - - - - - Constructs an instance of ServerSideEncryptionCustomerMethod. - - - - - - Finds the constant for the unique value. - - - - - - - Converts string to ServerSideEncryptionCustomerMethod. - - - - - - - A list of all server-side encryption methods. - - - - - No server side encryption to be used. - - - - - Use AES 256 server side encryption. - - - - - Use AWS Key Management Service for server side encryption. - - - - - Construct instance of ServerSideEncryptionMethod. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to ServerSideEncryptionCustomerMethod. - - - - - - - A list of all grantee types. - - - - - The predefined group. - - - - - The email address of an AWS account - - - - - The canonical user ID of an AWS account - - - - - Construct an instance of GranteeType. - - - - - - Finds the constant for the unique value. - - - - - - - Convert a string to GranteeType. - - - - - - - A list of all lifecycle statuses. - - - - - The rule is enabled. - - - - - The rule is disabled. - - - - - Constructs an instance LifecycleRuleStatus. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to LifecycleRuleStatus. - - - - - - - A list of all version statuses. - - - - - The rule is off. - - - - - The rule is suspended. - - - - - The rule is enabled. - - - - - Construct an instance of VersionStatus. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to VersionStatus. - - - - - - - A list of all encoding types. - - - - - Url encoding. - - - - - Constructs intance of EncodingType - - - - - - Finds the constant for the unique value. - - - - - - - Converts string to EncodingType - - - - - - - The bucket event for which to send notifications. - - - - - The event encapsulates all the object create events - - - - - Event for put operations - - - - - Event for post operations - - - - - Event for copy operations - - - - - Event for completing a multi part upload - - - - - This event encapsulates all the object removed events - - - - - Event for object removed, delete operation. - - - - - Event for object removed, delete marker created operation. - - - - - Event for objects stored in reduced redundancy and S3 detects the object is lost - - - - - Event for all object restore - - - - - Event for restore post operations. - - - - - Event for when object restore is completed. - - - - - Event for replication of all - - - - - Event for operation failed replication - - - - - Evemt for replication operation not tracked - - - - - Event for replication operation missed threshold - - - - - Event for operation replicated after threshold - - - - - Constructs instance of EventType. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to EventType. - - - - - - - Compares if the ConstantClass instances are equals. - - - - - - - Compares if the ConstantClass instances are equals. This is ovewritten to handle the - discrepancy with S3 events coming from Lambda that don't have the prefix "s3:". - - - - - - - A list of all Inventory Formats. - - - - - CSV inventory format - - - - - ORC inventory format - - - - - Parquet inventory format - - - - - Construct instance of InventoryFormat. - - - - - - Finds the constant for the unique value. - - The string representation of the InventoryFormat. - The InventoryFormat object for that string. - - - - Convert string to InventoryFormat. - - - - - - - A list of inventory included object versions. - - - - - All Inventory Included Object Versions - - - - - Current Inventory Included Object Versions - - - - - Construct instance of InventoryIncludedObjectVersions. - - - - - - Finds the constant for the unique value. - - The string representation of the InventoryIncludedObjectVersions. - The InventoryIncludedObjectVersions object for that string. - - - - Convert string to InventoryIncludedObjectVersions. - - - - - - - A list of inventory frequencies. - - - - - Daily Inventory Frequency - - - - - Weekly Inventory Frequency - - - - - Construct instance of InventoryFrequency. - - - - - - Finds the constant for the unique value. - - The string representation of the InventoryFrequency. - The InventoryFrequency object for that string. - - - - Convert string to InventoryFrequency. - - - - - - - A list of inventory optional fields. - - - - - InventoryOptionalField for Size - - - - - InventoryOptionalField for LastModifiedDate - - - - - InventoryOptionalField for StorageClass - - - - - InventoryOptionalField for ETag - - - - - InventoryOptionalField for IsMultipartUploaded - - - - - InventoryOptionalField for ReplicationStatus - - - - - InventoryOptionalField for EncryptionStatus - - - - - InventoryOptionalField for ObjectLockRetainUntilDate - - - - - InventoryOptionalField for ObjectLockMode - - - - - InventoryOptionalField for ObjectLockLegalHoldStatus - - - - - InventoryOptionalField for IntelligentTieringAccessTier - - - - - Construct instance of InventoryOptionalField. - - - - - - Finds the constant for the unique value. - - The string representation of the InventoryOptionalField. - The InventoryIncludedObjectVersions object for that string. - - - - Convert string to InventoryOptionalField. - - - - - - - The status of the replication job associated with this source object. - - - - - The object is pending replication. - - - - - The object has been replicated. - - - - - The object was created as a result of replication. - - - - - The object replication has failed due to a customer-attributable reason, and the replication will not be attempted again. - - - - - Construct instance of ReplicationStatus. - - - - - - Finds the constant for the unique value. - - The string representation of the ReplicationStatus. - The ReplicationStatus object for that string. - - - - Convert string to ReplicationStatus. - - - - - - - Whether a replication rule is applied or ignored. - - - - - The rule will be applied. - - - - - The rule will be ignored. - - - - - Construct instance of ReplicationRuleStatus - - - - - - Finds the constant for the unique value. - - The string representation of the ReplicationRuleStatus. - The ReplicationRuleStatus object for that string. - - - - Convert string to ReplicationRuleStatus. - - - - - - - Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request. - - - - - The object tag-set is copied from the source object. - - - - - The object tag-set is replaced with tag-set provided in the request. - - - - - Construct instance of TaggingDirective - - - - - Finds the constant for the unique value. - - The string representation of the TaggingDirective. - The TaggingDirective object for that string. - - - - Convert string to TaggingDirective. - - - - - All enumerations type for retrieval tier for Glacier restore. - - - - - Standard Tier for Glacier restore. - - - - - Bulk Tier for Glacier restore. - - - - - Expedited Tier for Glacier restore. - - - - - Construct instance of RestoreObjectRequestGlacierJobTier - - - - - - Finds the constant for the unique value. - - The string representation of the RestoreObjectRequestGlacierJobTier. - The RestoreObjectRequestGlacierJobTier object for that string. - - - - Convert string to RestoreObjectRequestGlacierJobTier. - - - - - - - The version of the output schema to use when exporting data. - - - - - The schema output version V_1. - - - - - Construct instance of StorageClassAnalysisSchemaVersion - - - - - - Finds the constant for the unique value. - - The string representation of the StorageClassAnalysisSchemaVersion. - The StorageClassAnalysisSchemaVersion object for that string. - - - - Convert string to StorageClassAnalysisSchemaVersion. - - - - - - - Acknowledges that requester pays for the operation. - - - - - Requester pays for the operation. - - - - - Finds the RequestPayer instance for the string value. - - - - - Converts string to RequestPayer instance - - - - - The response from S3 that it confirms that requester pays. - - - - - S3 acknowledges that the requester pays. - - - - - Finds the RequestCharged instance for the string value - - - - - converts the string to RequestCharged instance - - - - - The override value for the owner of the replica object. - - - - - Overrides destination bucket's owner. - - - - - Finds the OwnerOverride instance for the string value - - - - - converts the string to OwnerOverride instance - - - - - The replication for KMS encrypted S3 objects is disabled if status is not Enabled. - - - - - The replication for KMS encrypted S3 objects is enabled. - - - - - The replication for KMS encrypted S3 objects is disabled. - - - - - - - - - - Finds the SseKmsEncryptedObjectsStatus instance for the string value - - - - - Converts the string to SseKmsEncryptedObjectsStatus instance - - - - - Specify how headers will be handled. - - - - - Headers will be usable in SELECT clause. - - - - - Headers will be skipped - - - - - No header is present. - - - - - Finds the FileHeaderInfo instance for the string value - - - - - - - Converts the string to FileHeaderInfo instance - - - - - Specifies whether existing object replication is enabled. - - - - - Enable the replication of existing objects - - - - - Disable the replication of existing objects - - - - - Finds the ExistingObjectReplicationStatus instance for the string value - - - - - - - Converts the string to ExistingObjectReplicationStatus instance - - - - - Describes when fields in output should be surrounded with quotes. - - - - - Specifies that fields in output should always be surrounded in quotes. - - - - - Specifies that fields in output should be surrounded in quotes as necessary. - - - - - Finds the QuoteFields instance for the string value - - string value that maps to QuoteFields enum - QuoteFields enum - - - - Converts the string to QuoteFields instance - - - - - Type of the expression provided in the Expression member. - - - - - SQL expression - - - - - Finds the ExpressionType instance for the string value - - string value that maps to ExpressionType enum - ExpressionType enum - - - - Converts the string to ExpressionType instance - - - - - Indicates what type of job is being initiated. - - - - - Finds the RestoreRequestType instance for the string value - - - - - Converts the string to RestoreRequestType instance - - - - - The type of JSON. - - - - - Finds the JsonType instance for the string value - - - - - Converts the string to JsonType instance - - - - - Specifies object's compression format. - - - - - Finds the CompressionType instance for the string value - - - - - Converts the string to CompressionType instance - - - - - The type of ObjectLockEnabled - - - - - Finds the ObjectLockEnabled instance for the string value - - - - - Converts the string to ObjectLockEnabled instance - - - - - The type of ObjectLockLegalHoldStatus - - - - - Finds the ObjectLockLegalHoldStatus instance for the string value - - - - - Converts the string to ObjectLockLegalHoldStatus instance - - - - - The type of ObjectLockRetentionMode - - - - - Finds the ObjectLockRetentionMode instance for the string value - - - - - Converts the string to ObjectLockRetentionMode instance - - - - - The type of ObjectLockMode - - - - - Finds the ObjectLockMode instance for the string value - - - - - Converts the string to ObjectLockMode instance - - - - - Specifies whether the replication time is enabled. - - - - - Replication time is enabled. - - - - - Replication time is disabled. - - - - - Finds the ReplicationTimeStatus instance for the string value - - - - - - - Converts the string to ReplicationTimeStatus instance - - - - - - Specifies whether the replication metrics are enabled. - - - - - Replication metrics are enabled. - - - - - Replication metrics are disabled. - - - - - Finds the MetricsStatus instance for the string value - - - - - - - Converts the string to MetricsStatus instance - - - - - - The base class for requests that return Amazon S3 objects. - - - - - Gets or sets the name of the bucket. - - - The name of the bucket. - - - - - Gets whether or not the bucket name is set. - - - A value of true if the bucket name is set. - Returns false if otherwise. - - - - - Gets or sets the key under which the Amazon S3 object is stored. - - - The key under which the Amazon S3 object is stored. - - - - - Gets whether or not the key property is set. - - - A value of true if key property is set. - Returns false if otherwise. - - - - - Gets or sets the version ID of the Amazon S3 object. - - - The version ID of the Amazon S3 object. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or - ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Gets or sets the ModifiedSinceDate property. - - - The ModifiedSinceDate property. - - - - - Gets or sets the ModifiedSinceDate property. - - - The ModifiedSinceDate property. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or - UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Gets or sets the UnmodifiedSinceDate property. - - - The UnmodifiedSinceDate property. - - - - - Gets or sets the UnmodifiedSinceDate property. - - - The UnmodifiedSinceDate property. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to decrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - The base class TransferUtility request classes. - - - - - Overrides the default request timeout value. - - - - The value of this property is assigned to the Timeout property of the HTTPWebRequest/HttpClient object used - to send requests. Each TransferUtility's Download method may perform multiple server requests to complete the operation. - This timeout does not apply to the overall operation. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Returns the amount of bytes remaining that need to be pulled down from S3. - - The fully qualified path of the file. - - - - - The command to manage an upload using the S3 multipart API. - - - The command to manage an upload using the S3 multipart API. - - - - - Initializes a new instance of the class. - - The s3 client. - The config object that has the number of threads to use. - The file transporter request. - - - - Runs the multipart upload. - - - - - Used as the ThreadStart for the threads doing the upload. - - - - - This command is for doing regular PutObject requests. - - - This command is for doing regular PutObject requests. - - - - - This command files all the files that meets the criteria specified in the TransferUtilityUploadDirectoryRequest request - and uploads them. - - - This command files all the files that meets the criteria specified in the TransferUtilityUploadDirectoryRequest request - and uploads them. - - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - - Gets the Amazon S3 client used for making calls into Amazon S3. - - - The Amazon S3 client used for making calls into Amazon S3. - - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - A pattern used to identify the files from the source directory to upload. - - - A search option that specifies whether to recursively search for files to upload - in subdirectories. - - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The request that contains all the parameters required to upload a directory. - - - - - Initiates the asynchronous execution of the UploadDirectory operation. - - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. - Retrieve this object from within the callback procedure using the AsyncState property. - - - - - An IAsyncResult that can be used to poll, or wait for results, or both. - This value is also needed when invoking EndUploadDirectory. - - - - Initiates the asynchronous execution of the UploadDirectory operation. - - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - A pattern used to identify the files from the source directory to upload. - - - A search option that specifies whether to recursively search for files to upload - in subdirectories. - - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property. - - - - An IAsyncResult that can be used to poll, or wait for results, or both. - This value is also needed when invoking EndUploadDirectory. - - - - Initiates the asynchronous execution of the UploadDirectory operation. - - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The request that contains all the parameters required to upload a directory. - - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property. - - - - An IAsyncResult that can be used to poll, or wait for results, or both. - This value is also needed when invoking EndUploadDirectory. - - - - Finishes the asynchronous execution of the UploadDirectory operation. - - - The IAsyncResult returned by the call to BeginUploadDirectory. - - - - - - - Uploads the specified file. - The object key is derived from the file's name. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - - - Uploads the specified file. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - The key under which the Amazon S3 object is stored. - - - - - Uploads the contents of the specified stream. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The stream to read to obtain the content to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the stream to. - - - The key under which the Amazon S3 object is stored. - - - - - Uploads the file or stream specified by the request. - To track the progress of the upload, - add an event listener to the request's UploadProgressEvent. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - Contains all the parameters required to upload to Amazon S3. - - - - - Initiates the asynchronous execution of the Upload operation. - - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property. - - - - An IAsyncResult that can be used to poll, or wait for results, or both. - This values is also needed when invoking EndUpload. - - - - Initiates the asynchronous execution of the Upload operation. - - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - The key under which the Amazon S3 object is stored. - - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property. - - - - An IAsyncResult that can be used to poll, or wait for results, or both. - This values is also needed when invoking EndUpload. - - - - Initiates the asynchronous execution of the Upload operation. - - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The stream to read to obtain the content to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the stream to. - - - The key under which the Amazon S3 object is stored. - - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property. - - - - An IAsyncResult that can be used to poll, or wait for results, or both. - This values is also needed when invoking EndUpload. - - - - Initiates the asynchronous execution of the Upload operation. - - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - Contains all the parameters required to upload to Amazon S3. - - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property. - - - - An IAsyncResult that can be used to poll, or wait for results, or both. - This values is also needed when invoking EndUpload. - - - - Finishes the asynchronous execution of the Upload operation. - - - The IAsyncResult returned by the call to BeginUpload. - - - - - - - Returns a stream from which the caller can read the content from the specified - Amazon S3 bucket and key. - The caller of this method is responsible for closing the stream. - - - The name of the bucket. - - - The object key. - - - A stream of the contents from the specified Amazon S3 and key. - - - - - Returns a stream to read the contents from Amazon S3 as - specified by the TransferUtilityOpenStreamRequest. - The caller of this method is responsible for closing the stream. - - - Contains all the parameters required to open a stream to an S3 object. - - - A stream of the contents from Amazon S3. - - - - - Initiates the asynchronous execution of the OpenStream operation. - - - - The name of the bucket. - - - The object key. - - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property. - - - - An IAsyncResult that can be used to poll, or wait for results, or both. - This values is also needed when invoking EndOpenStream. - - - - Initiates the asynchronous execution of the OpenStream operation. - - - - Contains all the parameters required to open a stream to an Amazon S3 object. - - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property. - - - - An IAsyncResult that can be used to poll, or wait for results, or both. - This values is also needed when invoking EndOpenStream. - - - - Finishes the asynchronous execution of the OpenStream operation. - - - The IAsyncResult returned by the call to BeginOpenStream. - - - - - - - Downloads the content from Amazon S3 and writes it to the specified file. - - - The file path where the content from Amazon S3 will be written to. - - - The name of the bucket containing the Amazon S3 object to download. - - - The key under which the Amazon S3 object is stored. - - - - - Downloads the content from Amazon S3 and writes it to the specified file. - If the key is not specified in the request parameter, - the file name will used as the key name. - - - Contains all the parameters required to download an Amazon S3 object. - - - - - Initiates the asynchronous execution of the Download operation. - - - - The file path where the content from Amazon S3 will be written to. - - - The name of the bucket containing the Amazon S3 object to download. - - - The key under which the Amazon S3 object is stored. - - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property. - - - - An IAsyncResult that can be used to poll, or wait for results, or both. - This values is also needed when invoking EndDownload. - - - - Initiates the asynchronous execution of the Download operation. - - - - Contains all the parameters required to download an Amazon S3 object. - - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property. - - - - An IAsyncResult that can be used to poll, or wait for results, or both. - This values is also needed when invoking EndDownload. - - - - Finishes the asynchronous execution of the Download operation. - - - The IAsyncResult returned by the call to BeginDownload. - - - - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by s3Directory. - - - The name of the bucket containing the Amazon S3 objects to download. - - - The directory in Amazon S3 to download. - - - The local directory to download the objects to. - - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by the S3Directory - property of the passed in TransferUtilityDownloadDirectoryRequest object. - - - Contains all the parameters required to download objects from Amazon S3 - into a local directory. - - - - - Initiates the asynchronous execution of the DownloadDirectory operation. - - - - The name of the bucket containing the Amazon S3 objects to download. - - - The directory in Amazon S3 to download. - - - The local directory to download the objects to. - - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property. - - - - An IAsyncResult that can be used to poll, or wait for results, or both. - This values is also needed when invoking EndDownloadDirectory. - - - - Initiates the asynchronous execution of the DownloadDirectory operation. - - - - Contains all the parameters required to download objects from a directory in Amazon S3 - to a local directory. - - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property. - - - - An IAsyncResult that can be used to poll, or wait for results, or both. - This values is also needed when invoking EndDownload. - - - - Finishes the asynchronous execution of the DownloadDirectory operation. - - - The IAsyncResult returned by the call to BeginDownloadDirectory. - - - - - - - Aborts the multipart uploads that were initiated before the specified date. - - - The name of the bucket containing multipart uploads. - - - The date before which the multipart uploads were initiated. - - - - - Initiates the asynchronous execution of the AbortMultipartUploads operation. - - - - The name of the bucket containing multipart uploads. - - - The date before which the multipart uploads were initiated. - - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property. - - - - An IAsyncResult that can be used to poll, or wait for results, or both. - This values is also needed when invoking EndAbortMultipartUploads. - - - - Finishes the asynchronous execution of the AbortMultipartUploads operation. - - - The IAsyncResult returned by the call to BeginAbortMultipartUploads. - - - - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - - Constructs a new class. - - - The AWS Access Key ID. - - - The AWS Secret Access Key. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new class. - - - The AWS Access Key ID. - - - The AWS Secret Access Key. - - - The region to configure the transfer utility for. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new instance of the class. - - - The AWS Access Key ID. - - - The AWS Secret Access Key. - - - Specifies advanced settings. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new instance of the class. - - - The AWS Access Key ID. - - - The AWS Secret Access Key. - - - The region to configure the transfer utility for. - - - Specifies advanced settings. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new instance of the class. - - - The Amazon S3 client. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Initializes a new instance of the class. - - - The Amazon S3 client. - - - Specifies advanced configuration settings for . - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new class. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new class. - - - The region to configure the transfer utility for. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new class. - - - Specifies advanced configuration settings for . - - - - - - - Gets the Amazon S3 client used for making calls into Amazon S3. - - - The Amazon S3 client used for making calls into Amazon S3. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - A pattern used to identify the files from the source directory to upload. - - - A search option that specifies whether to recursively search for files to upload - in subdirectories. - - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The request that contains all the parameters required to upload a directory. - - - - - Initiates the asynchronous execution of the UploadDirectory operation. - - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. - Retrieve this object from within the callback procedure using the AsyncState property. - - - - - An IAsyncResult that can be used to poll, or wait for results, or both. - This value is also needed when invoking EndUploadDirectory. - - - - Initiates the asynchronous execution of the UploadDirectory operation. - - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - A pattern used to identify the files from the source directory to upload. - - - A search option that specifies whether to recursively search for files to upload - in subdirectories. - - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property. - - - - An IAsyncResult that can be used to poll, or wait for results, or both. - This value is also needed when invoking EndUploadDirectory. - - - - Initiates the asynchronous execution of the UploadDirectory operation. - - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The request that contains all the parameters required to upload a directory. - - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property. - - - - An IAsyncResult that can be used to poll, or wait for results, or both. - This value is also needed when invoking EndUploadDirectory. - - - - Finishes the asynchronous execution of the UploadDirectory operation. - - - The IAsyncResult returned by the call to BeginUploadDirectory. - - - - - - - Uploads the specified file. - The object key is derived from the file's name. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - - - Uploads the specified file. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - The key under which the Amazon S3 object is stored. - - - - - Uploads the contents of the specified stream. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The stream to read to obtain the content to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the stream to. - - - The key under which the Amazon S3 object is stored. - - - - - Uploads the file or stream specified by the request. - To track the progress of the upload, - add an event listener to the request's UploadProgressEvent. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - Contains all the parameters required to upload to Amazon S3. - - - - - Initiates the asynchronous execution of the Upload operation. - - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property. - - - - An IAsyncResult that can be used to poll, or wait for results, or both. - This values is also needed when invoking EndUpload. - - - - Initiates the asynchronous execution of the Upload operation. - - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - The key under which the Amazon S3 object is stored. - - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property. - - - - An IAsyncResult that can be used to poll, or wait for results, or both. - This values is also needed when invoking EndUpload. - - - - Initiates the asynchronous execution of the Upload operation. - - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The stream to read to obtain the content to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the stream to. - - - The key under which the Amazon S3 object is stored. - - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property. - - - - An IAsyncResult that can be used to poll, or wait for results, or both. - This values is also needed when invoking EndUpload. - - - - Initiates the asynchronous execution of the Upload operation. - - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - Contains all the parameters required to upload to Amazon S3. - - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property. - - - - An IAsyncResult that can be used to poll, or wait for results, or both. - This values is also needed when invoking EndUpload. - - - - Finishes the asynchronous execution of the Upload operation. - - - The IAsyncResult returned by the call to BeginUpload. - - - - - - - Returns a stream from which the caller can read the content from the specified - Amazon S3 bucket and key. - The caller of this method is responsible for closing the stream. - - - The name of the bucket. - - - The object key. - - - A stream of the contents from the specified Amazon S3 and key. - - - - - Returns a stream to read the contents from Amazon S3 as - specified by the TransferUtilityOpenStreamRequest. - The caller of this method is responsible for closing the stream. - - - Contains all the parameters required to open a stream to an S3 object. - - - A stream of the contents from Amazon S3. - - - - - Initiates the asynchronous execution of the OpenStream operation. - - - - The name of the bucket. - - - The object key. - - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property. - - - - An IAsyncResult that can be used to poll, or wait for results, or both. - This values is also needed when invoking EndOpenStream. - - - - Initiates the asynchronous execution of the OpenStream operation. - - - - Contains all the parameters required to open a stream to an Amazon S3 object. - - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property. - - - - An IAsyncResult that can be used to poll, or wait for results, or both. - This values is also needed when invoking EndOpenStream. - - - - Finishes the asynchronous execution of the OpenStream operation. - - - The IAsyncResult returned by the call to BeginOpenStream. - - - - - - - Downloads the content from Amazon S3 and writes it to the specified file. - - - The file path where the content from Amazon S3 will be written to. - - - The name of the bucket containing the Amazon S3 object to download. - - - The key under which the Amazon S3 object is stored. - - - - - Downloads the content from Amazon S3 and writes it to the specified file. - If the key is not specified in the request parameter, - the file name will used as the key name. - - - Contains all the parameters required to download an Amazon S3 object. - - - - - Initiates the asynchronous execution of the Download operation. - - - - The file path where the content from Amazon S3 will be written to. - - - The name of the bucket containing the Amazon S3 object to download. - - - The key under which the Amazon S3 object is stored. - - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property. - - - - An IAsyncResult that can be used to poll, or wait for results, or both. - This values is also needed when invoking EndDownload. - - - - Initiates the asynchronous execution of the Download operation. - - - - Contains all the parameters required to download an Amazon S3 object. - - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property. - - - - An IAsyncResult that can be used to poll, or wait for results, or both. - This values is also needed when invoking EndDownload. - - - - Finishes the asynchronous execution of the Download operation. - - - The IAsyncResult returned by the call to BeginDownload. - - - - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by s3Directory. - - - The name of the bucket containing the Amazon S3 objects to download. - - - The directory in Amazon S3 to download. - - - The local directory to download the objects to. - - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by the S3Directory - property of the passed in TransferUtilityDownloadDirectoryRequest object. - - - Contains all the parameters required to download objects from Amazon S3 - into a local directory. - - - - - Initiates the asynchronous execution of the DownloadDirectory operation. - - - - The name of the bucket containing the Amazon S3 objects to download. - - - The directory in Amazon S3 to download. - - - The local directory to download the objects to. - - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property. - - - - An IAsyncResult that can be used to poll, or wait for results, or both. - This values is also needed when invoking EndDownloadDirectory. - - - - Initiates the asynchronous execution of the DownloadDirectory operation. - - - - Contains all the parameters required to download objects from a directory in Amazon S3 - to a local directory. - - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property. - - - - An IAsyncResult that can be used to poll, or wait for results, or both. - This values is also needed when invoking EndDownload. - - - - Finishes the asynchronous execution of the DownloadDirectory operation. - - - The IAsyncResult returned by the call to BeginDownloadDirectory. - - - - - - - Aborts the multipart uploads that were initiated before the specified date. - - - The name of the bucket containing multipart uploads. - - - The date before which the multipart uploads were initiated. - - - - - Initiates the asynchronous execution of the AbortMultipartUploads operation. - - - - The name of the bucket containing multipart uploads. - - - The date before which the multipart uploads were initiated. - - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property. - - - - An IAsyncResult that can be used to poll, or wait for results, or both. - This values is also needed when invoking EndAbortMultipartUploads. - - - - Finishes the asynchronous execution of the AbortMultipartUploads operation. - - - The IAsyncResult returned by the call to BeginAbortMultipartUploads. - - - - - - - Uploads the specified file. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - The key under which the Amazon S3 object is stored. - - - - - Uploads the contents of the specified stream. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - The stream to read to obtain the content to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the stream to. - - - The key under which the Amazon S3 object is stored. - - - - - Uploads the file or stream specified by the request. - To track the progress of the upload, - add an event listener to the request's UploadProgressEvent. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - Contains all the parameters required to upload to Amazon S3. - - - - - - Provides configuration options for how processes requests. - - - The best configuration settings depend on network - configuration, latency and bandwidth. - The default configuration settings are suitable - for most applications, but this class enables developers to experiment with - different configurations and tune transfer manager performance. - - - - - Provides configuration options for how processes requests. - - - The best configuration settings depend on network - configuration, latency and bandwidth. - The default configuration settings are suitable - for most applications, but this class enables developers to experiment with - different configurations and tune transfer manager performance. - - - - - - Default constructor. - - - - - Gets or sets the minimum part size for upload parts in bytes. The default is 16 MB. - Decreasing the minimum part size causes - multipart uploads to be split into a larger number - of smaller parts. Setting this value too low has a negative effect - on transfer speeds, causing extra latency and network - communication for each part. - - - - - This property determines how many active threads - or the number of concurrent asynchronous web requests - will be used to upload/download the file . - The default value is 10. - - - A value less than or equal to 0 will be silently ignored. - - - - - Gets or sets the number of executing threads. - This property determines how many active threads will be used to upload - the file. The default value is 10 threads. - - - A value less than or equal to 0 will be silently ignored. - - - - - Gets or sets the default timeout in milliseconds used for writing objects to S3. - - - - - Request object for downloading a directory with the TransferUtility. - - - - - Gets or sets the name of the bucket. - - - The name of the bucket. - - - - - Gets whether or not the bucket name is set. - - - A value of true if the bucket name is set. - Otherwise, returns false. - - - - - Gets or sets the local directory where objects from Amazon S3 will be downloaded. - If the directory doesn't exist, it will be created. - - - The local directory where objects from Amazon S3 will be downloaded. - - - - - Gets whether or not the LocalDirectory property is set. - - - A value of true if LocalDirectory property is set. - Otherwise, returns false. - - - - - Gets or sets the Amazon S3 directory to download from. - This is translated to a key prefix; keys that have this prefix will be - downloaded. - - - - - Gets whether or not the S3Directory property is set. - - - A value of true if S3Directory property is set. - Otherwise, returns false. - - - - - - This property is deprecated. This property doesn't honor the DateTimeKind, please - use ModifiedSinceDateUtc instead. - - Gets or sets the ModifiedSinceDate property. - Only objects that have been modified since this date will be - downloaded. - - - The ModifiedSinceDate property. - - - - - Checks if ModifiedSinceDate property is set. - - A value of true if ModifiedSinceDate property is set. - Otherwise, returns false. - - - - Gets or sets the ModifiedSinceDateUtc property. - Only objects that have been modified since this date will be - downloaded. - - - The ModifiedSinceDateUtc property. - - - - - Checks if ModifiedSinceDateUtc property is set. - - A value of true if ModifiedSinceDateUtc property is set. - Otherwise, returns false. - - - - - This property is deprecated. This property doesn't honor the DateTimeKind, please - use UnmodifiedSinceDateUtc instead. - - Gets or sets the UnmodifiedSinceDate property. - Only objects that have not been modified since this date will be downloaded. - - - The UnmodifiedSinceDate property. - - - - - Checks if UnmodifiedSinceDate property is set. - - true if UnmodifiedSinceDate property is set. - - - - Gets or sets the UnmodifiedSinceDateUtc property. - Only objects that have not been modified since this date will be downloaded. - - - The UnmodifiedSinceDateUtc property. - - - - - Checks if UnmodifiedSinceDateUtc property is set. - - true if UnmodifiedSinceDateUtc property is set. - - - - Gets or sets the DownloadFilesConcurrently property. - Specifies if multiple files will be downloaded concurrently. - The number of concurrent web requests used is controlled - by the TransferUtilityConfig.ConcurrencyLevel property. - - - - - The event for DownloadedDirectoryProgressEvent notifications. All - subscribers will be notified when a new progress - event is raised. - - The DownloadedDirectoryProgressEvent is fired as data - is downloaded from Amazon S3. The delegates attached to the event - will be passed information detailing how much data - has been downloaded as well as how much will be downloaded. - - - - Subscribe to this event if you want to receive - DownloadedDirectoryProgressEvent notifications. Here is how:
- 1. Define a method with a signature similar to this one: - - private void displayProgress(object sender, DownloadDirectoryProgressArgs args) - { - Console.WriteLine(args); - } - - 2. Add this method to the DownloadedDirectoryProgressEvent delegate's invocation list - - TransferUtilityDownloadDirectoryRequest request = new TransferUtilityDownloadDirectoryRequest(); - request.DownloadedDirectoryProgressEvent += displayProgress; - - - - - - Encapsulates the information needed to provide - transfer progress to subscribers of the DownloadDirectory - event. - - - - - Constructs a new instance of DownloadDirectoryProgressArgs. - - - The number of files downloaded. - - - The total number of files to download. - - - The current file being downloaded - - - The number of transferred bytes for the current file. - - - The size of the current file in bytes. - - - - - Constructs a new instance of DownloadDirectoryProgressArgs. - - - The number of files downloaded. - - - The total number of files to download. - - - The bytes transferred across all files being downloaded. - - - The total number of bytes across all files being downloaded. - - - The current file being downloaded. - - - The number of transferred bytes for the current file. - - - The size of the current file in bytes. - - - - - Gets or sets the total number of files. - - The total number of files. - - - - Gets or sets the number of files downloaded so far. - - The number of files downloaded. - - - - Gets or sets the total number of bytes across all files being downloaded. - - The total number of bytes across all files being downloaded. - - - - Gets or sets the bytes transferred across all files being downloaded. - - The bytes transferred across all files being downloaded. - - - - Gets or sets the current file being downloaded. - - The current file being downloaded. - - - - Gets or sets the transferred bytes for the current file. - - The transferred bytes for the current file. - - - - Gets or sets the total number of bytes for the current file. - - The total number of bytes for the current file. - - - - The string representation of this instance of DownloadDirectoryProgressArgs. - - The string representation of this instance of DownloadDirectoryProgressArgs. - - - - Contains all the parameters - that can be set when making a this request with the - TransferUtility method. - - - - - Get or sets the file path location of where the - downloaded Amazon S3 object will be written to. - - - The file path location of where the downloaded Amazon S3 object will be written to. - - - - - Checks if FilePath property is set. - - True if FilePath property is set. - - - - The event for WriteObjectProgressEvent notifications. All - subscribers will be notified when a new progress - event is raised. - - The WriteObjectProgressEvent is fired as data - is downloaded from S3. The delegates attached to the event - will be passed information detailing how much data - has been downloaded as well as how much will be downloaded. - - - - Subscribe to this event if you want to receive - WriteObjectProgressEvent notifications. Here is how:
- 1. Define a method with a signature similar to this one: - - private void displayProgress(object sender, WriteObjectProgressArgs args) - { - Console.WriteLine(args); - } - - 2. Add this method to the WriteObjectProgressEvent delegate's invocation list - - TransferUtilityDownloadRequest request = new TransferUtilityDownloadRequest(); - request.WriteObjectProgressEvent += displayProgress; - - - - - - Causes the WriteObjectProgressEvent event to be fired. - - Progress data for the stream being written to file. - - - - Contains all the parameters - that can be set when making a this request with the - TransferUtility method. - - - - - Contains all the parameters - that can be set when making a this request with the - TransferUtility method. - - - - - Gets or sets the directory where files are uploaded from. - - - The directory where files are uploaded from. - - - - - Checks if Directory property is set. - - true if Directory property is set. - - - - Gets or sets the KeyPrefix property. As object keys are generated for the - files being uploaded this value will prefix the key. This is useful when a directory - needs to be uploaded into sub directory in the S3 Bucket. - - - The directory where files are uploaded from. - - - - - Checks if KeyPrefix property is set. - - true if KeyPrefix property is set. - - - - Gets and sets the search pattern used to determine which - files in the directory are uploaded. - - - The search pattern used to deterimine which - files in the directory are uploaded. - The default value is "*", specifying that all files - in the directory will be uploaded. - - - - - Checks if SearchPattern property is set. - - true if SearchPattern property is set. - - - - Gets or sets the recursive options for the directory upload. - - - The recursive options for the directory upload. - Set by default to TopDirectoryOnly, - specifying that files will be uploaded from the root directory only. - - - - - Gets or sets the name of the bucket. - - - The name of the bucket. - - - - - Checks if BucketName property is set. - - true if BucketName property is set. - - - - Gets or sets the canned access control list (ACL) - for the uploaded objects. - Please refer to - for - information on Amazon S3 canned ACLs. - - - The canned access control list (ACL) - for the uploaded objects. - - - - - Checks if the CannedACL property is set. - - true if there is the CannedACL property is set. - - - - Gets or sets the content type for the uploaded Amazon S3 objects. - The default behavior when this field is not set is to use the file - extension to set the content type. If this field is set to a value it - will be applied to all uploaded files in the directory, overriding - file extension inspection. - - - The content type for all the uploaded Amazon S3 objects. - - - - - Gets or sets the storage class for the uploaded Amazon S3 objects. - Please refer to - for - information on S3 Storage Classes. - - - The storage class for the uploaded Amazon S3 objects. - - - - - The collection of meta data for the request. - - - - - Gets or sets the ServerSideEncryptionMethod property. - Specifies the encryption used on the server to - store the content. - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Gets or sets the UploadFilesConcurrently property. - Specifies if multiple files will be uploaded concurrently. - The number of concurrent web requests used is controlled - by the TransferUtilityConfig.ConcurrencyLevel property. - - - - - The event for UploadDirectoryProgressEvent notifications. All - subscribers will be notified when a new progress - event is raised. - - The UploadDirectoryProgressEvent is fired as data - is uploaded to S3. The delegates attached to the event - will be passed information detailing how much data - has been uploaded as well as how much will be uploaded. - - - - Subscribe to this event if you want to receive - UploadDirectoryProgressEvent notifications. Here is how:
- 1. Define a method with a signature similar to this one: - - private void displayProgress(object sender, UploadDirectoryProgressArgs args) - { - Console.WriteLine(args); - } - - 2. Add this method to the UploadDirectoryProgressEvent delegate's invocation list - - TransferUtilityUploadDirectoryRequest request = new TransferUtilityUploadDirectoryRequest(); - request.UploadDirectoryProgressEvent += displayProgress; - - - - - - The event for modifying individual TransferUtilityUploadRequest for each file - being uploaded. - - - - - Causes the UploadDirectoryProgressEvent event to be fired. - - Progress data for files currently being uploaded. - - - - Tags that will be applied to all objects in the diretory. - - - - - Encapsulates the information needed to provide - transfer progress to subscribers of the UploadDirectory - event. - - - - - Constructs a new instance of UploadDirectoryProgressArgs. - - - The number of files uploaded. - - - The total number of files to upload. - - - The current file - - - The number of transferred bytes for current file. - - - The size of the current file in bytes. - - - - - Constructs a new instance of UploadDirectoryProgressArgs. - - - The number of files uploaded. - - - The total number of files to upload. - - - The bytes transferred across all files being uploaded. - - - The total number of bytes across all files being uploaded. - - - The current file being uploaded. - - - The number of transferred bytes for current file. - - - The size of the current file in bytes. - - - - - Gets or sets the total number of files. - - The total number of files. - - - - Gets or sets the number of files uploaded. - - The number of files uploaded. - - - - Gets or sets the total number of bytes across all files being uploaded. - - The total number of bytes across all files being uploaded. - - - - Gets or sets the bytes transferred across all files being uploaded. - - The bytes transferred across all files being uploaded. - - - - Gets or sets the current file. - - The current file. - - - - Gets or sets the transferred bytes for current file. - - The transferred bytes for current file. - - - - Gets or sets the total number of bytes for current file. - - The total number of bytes for current file. - - - - The string representation of this instance of UploadDirectoryProgressArgs. - - The string representation of this instance of UploadDirectoryProgressArgs. - - - - Contains a single TransferUtilityUploadRequest corresponding - to a single file about to be uploaded, allowing changes to - the request before it is executed. - - - - - Constructs a new UploadDirectoryFileRequestArgs instance. - - Request being processed. - - - - Gets and sets the UploadRequest property. - - - - - Contains all the parameters - that can be set when making a this request with the - TransferUtility method. - - - - - Gets or sets the name of the bucket. - - - The name of the bucket. - - - - - Checks if BucketName property is set. - - true if BucketName property is set. - - - - Gets or sets the key under which the Amazon S3 object is to be stored. - - - The key under which the Amazon S3 object is to be stored. - - - - - Checks if Key property is set. - - true if Key property is set. - - - - Gets or sets the canned access control list (ACL) - for the uploaded object. - Please refer to - for - information on Amazon S3 canned ACLs. - - - The canned access control list (ACL) - for the uploaded object. - - - - - Checks if the CannedACL property is set. - - true if there is the CannedACL property is set. - - - - Removes the cannned access control list (ACL) - for the uploaded object. - - - - - Gets or sets the content type of the uploaded Amazon S3 object. - - - The content type of the uploaded Amazon S3 object. - - - - - Checks if ContentType property is set. - - true if ContentType property is set. - - - - Gets or sets the storage class for the uploaded Amazon S3 object. - Please refer to - for - information on S3 Storage Classes. - - - The storage class for the uploaded Amazon S3 object. - - - - - Gets and sets the ServerSideEncryptionMethod property. - Specifies the encryption used on the server to - store the content. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Input stream for the request; content for the request will be read from the stream. - - - - - - Gets or sets the file path - where the Amazon S3 object will be uploaded from. - - - For WinRT and Windows Phone this property must be in the form of "ms-appdata:///local/file.txt". - - - - The file path where the Amazon S3 object will be uploaded from. - - - - - Checks if FilePath property is set. - - true if FilePath property is set. - - - - Gets or sets the part size of the upload in bytes. - The uploaded file will be divided into - parts the size specified and - uploaded to Amazon S3 individually. - - - The part size of the upload. - - - - - Checks if PartSize property is set. - - true if PartSize property is set. - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - The tag-set for the object. - - - - - The event for UploadProgressEvent notifications. All - subscribers will be notified when a new progress - event is raised. - - The UploadProgressEvent is fired as data - is uploaded to S3. The delegates attached to the event - will be passed information detailing how much data - has been uploaded as well as how much will be uploaded. - - - - Subscribe to this event if you want to receive - UploadProgressEvent notifications. Here is how:
- 1. Define a method with a signature similar to this one: - - private void displayProgress(object sender, UploadProgressArgs args) - { - Console.WriteLine(args); - } - - 2. Add this method to the UploadProgressEvent delegate's invocation list - - TransferUtilityUploadRequest request = new TransferUtilityUploadRequest(); - request.UploadProgressEvent += displayProgress; - - - - - - Causes the UploadProgressEvent event to be fired. - - Progress data for the file being uploaded. - - - - Gets the length of the content by either checking the FileInfo.Length property or the Stream.Length property. - - The length of the content. - - - - Gets or sets whether or not the stream used with this request is - automatically closed when all of the content is read from the stream. - - - A value of true if the if the stream is - automatically closed when all of the content is read from the stream. - A value of false if otherwise. - - - - - If this value is set to true then the stream's position will be reset to the start before being read for upload. - Default: true. - - - - - Sets whether or not the stream used with this request is - automatically closed when all of the content is read from the stream - and returns this object instance, - enabling additional method calls to be chained together. - - - A value of true if the if the stream is - automatically closed when all of the content is read from the stream. - A value of false if otherwise. - - - This object instance, enabling additional method calls to be chained together. - - - - - Encapsulates the information needed to provide - transfer progress to subscribers of the Put Object - Event. - - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The how many bytes were transferred since last event. - The number of bytes transferred - The total number of bytes to be transferred - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The how many bytes were transferred since last event. - The number of bytes transferred - The total number of bytes to be transferred - The file being uploaded - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The how many bytes were transferred since last event. - The number of bytes transferred - The total number of bytes to be transferred - A compensation for any upstream aggregators if this event to correct theit totalTransferred count, - in case the underlying request is retried. - The file being uploaded - - - - Gets the FilePath. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Uri wrapper that can parse out information (bucket, key, region, style) from an - S3 URI. - - - - - True if the URI contains the bucket in the path, false if it contains the bucket in the authority. - - - - - The bucket name parsed from the URI (or null if no bucket specified). - - - - - The key parsed from the URI (or null if no key specified). - - - - - The region parsed from the URI (or null if no region specified). - - - - - Constructs a parser for the S3 URI specified as a string. - - The S3 URI to be parsed. - - - - Constructs a parser for the S3 URI specified as a Uri instance. - - The S3 URI to be parsed. - - - - If the given string is an AmazonS3Endpoint return true and set the AmazonS3Uri out parameter. - - - - true if the string is an AmazonS3Endpoint, and the out paramter has been filled in, false otherwise - - - - If the given Uri is an AmazonS3Endpoint return true and set the AmazonS3Uri out parameter. - - - - true if the Uri is an AmazonS3Endpoint, and the out paramter has been filled in, false otherwise - - - - Checks whether the given URI is a Amazon S3 URI. - - The S3 URI to be checked. - true if the URI is a Amazon S3 URI, false; otherwise. - - - - Checks whether the given URI is a Amazon S3 URI. - - The S3 URI to be checked. - true if the URI is a Amazon S3 URI, false; otherwise. - - - - Percent-decodes the given string, with a fast path for strings that are not - percent-encoded. - - The string to decode - The decoded string - - - - Percent-decodes the given string. - - The string to decode - The index of the first '%' in the string - The decoded string - - - - Decodes the percent-encoded character at the given index in the string - and appends the decoded value to the string under construction. - - - The string under construction to which the decoded character will be - appended. - - The string being decoded. - The index of the '%' character in the string. - - - - Converts a hex character (0-9A-Fa-f) into its corresponding quad value. - - The hex character - The quad value - - - - Provides utilities used by the Amazon S3 client implementation. - These utilities might be useful to consumers of the Amazon S3 - library. - - - Provides utilities used by the Amazon S3 client implementation. - These utilities might be useful to consumers of the Amazon S3 - library. - - - - - Determines MIME type from a file extension - - The extension of the file - The MIME type for the extension, or text/plain - - - - URL encodes a string. If the path property is specified, - the accepted path characters {/+:} are not encoded. - - The string to encode - Whether the string is a URL path or not - - - - - Converts a non-seekable stream into a System.IO.MemoryStream. - A MemoryStream's position can be moved arbitrarily - - The stream to be converted - A seekable MemoryStream - MemoryStreams use byte arrays as their backing store. - Please use this judicially as it is likely that a very large - stream will cause system resources to be used up. - - - - - Formats the current date as a GMT timestamp - - A GMT formatted string representation - of the current date and time - - - - - Generates an MD5 Digest for the string-based content - - The content for which the MD5 Digest needs - to be computed. - - Whether the returned checksum should be - base64 encoded. - - A string representation of the hash with or w/o base64 encoding - - - - - Version2 S3 buckets adhere to RFC 1035: - - Less than 255 characters, with each label less than 63 characters. - Label must start with a letter - Label must end with a letter or digit - Label can have a string of letter, digits and hyphens in the middle. - Although names can be case-sensitive, no significance is attached to the case. - RFC 1123: Allow label to start with letter or digit (e.g. 3ware.com works) - RFC 2181: No restrictions apart from the length restrictions. - - S3 V2 will start with RFCs 1035 and 1123 and impose the following additional restrictions: - - Length between 3 and 63 characters (to allow headroom for upper-level domains, - as well as to avoid separate length restrictions for bucket-name and its labels - Only lower-case to avoid user confusion. - No dotted-decimal IPv4-like strings - - - The BucketName to validate if V2 addressing should be used - True if the BucketName should use V2 bucket addressing, false otherwise - - S3 v2 Bucket restrictions - - - - Determines whether an S3 bucket exists or not. - - The name of the bucket to check. - The Amazon S3 Client to use for S3 specific operations. - False is returned in case S3 responds with a NoSuchBucket error. - True is returned in case of success, AccessDenied error or PermanentRedirect error. - An exception is thrown in case of any other error. - This method calls GetACL for the bucket. - - - - Determines whether an S3 bucket exists or not. - This is done by: - 1. Creating a PreSigned Url for the bucket. To work with Signature V4 only regions, as - well as Signature V4-optional regions, we keep the expiry to within the maximum for V4 - (which is one week). - 2. Making a HEAD request to the Url - - The name of the bucket to check. - The Amazon S3 Client to use for S3 specific operations. - - - - - Sets the storage class for the S3 Object to the value - specified. - - The name of the bucket in which the key is stored - The key of the S3 Object whose storage class needs changing - The new Storage Class for the object - The Amazon S3 Client to use for S3 specific operations. - - - - - Sets the storage class for the S3 Object's Version to the value - specified. - - The name of the bucket in which the key is stored - The key of the S3 Object whose storage class needs changing - The version of the S3 Object whose storage class needs changing - The new Storage Class for the object - The Amazon S3 Client to use for S3 specific operations. - - - - - Sets the server side encryption method for the S3 Object to the value - specified. - - The name of the bucket in which the key is stored - The key of the S3 Object - The server side encryption method - The Amazon S3 Client to use for S3 specific operations. - - - - Sets the server side encryption method for the S3 Object's Version to the value - specified. - - The name of the bucket in which the key is stored - The key of the S3 Object - The version of the S3 Object - The server side encryption method - The Amazon S3 Client to use for S3 specific operations. - - - - Sets the redirect location for the S3 Object's when being accessed through the S3 website endpoint. - - The name of the bucket in which the key is stored - The key of the S3 Object - The redirect location - The Amazon S3 Client to use for S3 specific operations. - - - - Sets up the request needed to make an exact copy of the object leaving the parent method - the ability to change just the attribute being requested to change. - - - - - - - - - - - Converts the string representing a storage class that would come back from a ListObjects request - to the S3StorageClass enumeration. - - Amazon S3 string values for storage class - The converted S3StorageClass enumeration - - - - Upload data to Amazon S3 using HTTP POST. - - - For more information, - - Request object which describes the data to POST - Thrown if the service returns an error - - - - Deletes an S3 bucket which contains objects. - An S3 bucket which contains objects cannot be deleted until all the objects - in it are deleted. This method deletes all the objects in the specified - bucket and then deletes the bucket itself. - - The bucket to be deleted. - The Amazon S3 Client to use for S3 specific operations. - - - - Deletes an S3 bucket which contains objects. - An S3 bucket which contains objects cannot be deleted until all the objects - in it are deleted. This method deletes all the objects in the specified - bucket and then deletes the bucket itself. - - The bucket to be deleted. - The Amazon S3 Client to use for S3 specific operations. - Options to control the behavior of the delete operation. - - - - Initiates the asynchronous execution of the DeleteS3BucketWithObjects operation. - DeleteS3BucketWithObjects deletes an S3 bucket which contains objects. - An S3 bucket which contains objects cannot be deleted until all the objects - in it are deleted. This method deletes all the objects in the specified - bucket and then deletes the bucket itself. - - The bucket to be deleted. - The Amazon S3 Client to use for S3 specific operations. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property. - An IAsyncCancelableResult that can be used to poll or wait for results, or both; - this value is also needed when invoking EndDeleteS3BucketWithObjects. IAsyncCancelableResult can also - be used to cancel the operation while it's in progress. - - - - Initiates the asynchronous execution of the DeleteS3BucketWithObjects operation. - DeleteS3BucketWithObjects deletes an S3 bucket which contains objects. - An S3 bucket which contains objects cannot be deleted until all the objects - in it are deleted. This method deletes all the objects in the specified - bucket and then deletes the bucket itself. - - The bucket to be deleted. - The Amazon S3 Client to use for S3 specific operations. - Options to control the behavior of the delete operation. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property. - An IAsyncCancelableResult that can be used to poll or wait for results, or both; - this value is also needed when invoking EndDeleteS3BucketWithObjects. IAsyncCancelableResult can also - be used to cancel the operation while it's in progress. - - - - Initiates the asynchronous execution of the DeleteS3BucketWithObjects operation. - DeleteS3BucketWithObjects deletes an S3 bucket which contains objects. - An S3 bucket which contains objects cannot be deleted until all the objects - in it are deleted. This method deletes all the objects in the specified - bucket and then deletes the bucket itself. - - The bucket to be deleted. - The Amazon S3 Client to use for S3 specific operations. - >Options to control the behavior of the delete operation. - An callback that is invoked to send updates while delete operation is in progress. - An AsyncCallback delegate that is invoked when the operation completes. - A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property. - An IAsyncCancelableResult that can be used to poll or wait for results, or both; - this value is also needed when invoking EndDeleteS3BucketWithObjects. IAsyncCancelableResult can also - be used to cancel the operation while it's in progress. - - - - Finishes the asynchronous execution of the DeleteS3BucketWithObjects operation. - - The IAsyncCancelableResult returned by the call to BeginDeleteS3BucketWithObjects. - - - - Invokes the DeleteS3BucketWithObjectsInternal method. - - The Request object that has all the data to complete the operation. - - - - Deletes an S3 bucket which contains objects. - An S3 bucket which contains objects cannot be deleted until all the objects - in it are deleted. The function deletes all the objects in the specified - bucket and then deletes the bucket itself. - - The bucket to be deleted. - The Amazon S3 Client to use for S3 specific operations. - Options to control the behavior of the delete operation. - The callback which is used to send updates about the delete operation. - An IAsyncCancelableResult that can be used to poll or wait for results, or both; - this value is also needed when invoking EndDeleteS3BucketWithObjects. IAsyncCancelableResult can also - be used to cancel the operation while it's in progress. - - - - Invokes the callback which provides updated about the delete operation. - - The callback to be invoked. - The data being passed to the callback. - - - - Class to manage and cache the correct region for buckets accessed without an explicit region. - - - Class to manage and cache the correct region for buckets accessed without an explicit region. - - - - - A cache of BucketName -> RegionEndpoint pairs. - The cache is used to make sure that bucket requests are signed for the correct region, - even when requesting them without an explicit region. - - - - - Detect a bucket region mismatch based on the x-amz-bucket-region header, and the status code provided. - - - - - - - - - Detects if the signature is malformed, and the requested bucket is in a Region - different from the Region of the request. - - - - the correct region if a mismatch was detected, null otherwise - - - - Detects if the signature is malformed, and the requested bucket is in a Region - different from the Region of the request. - - - - - the correct region if a mismatch was detected, null otherwise - - - - Use a HEAD bucket request to get the region for the given bucket. - - This method creates an AmazonS3Client from the credentials passed in. - It's critical that the AmazonS3Client is not used to make any requests that will - be routed through the pipeline. - - - - the value of the x-amz-bucket-region header from the response - - - - Options which control the behaviour of the DeleteS3BucketWithObjects operation. - - - - - Gets or sets a value which indicates whether the - operation should be aborted if an error is encountered during execution. - - - - - Gets or sets a value which indicated whether verbose results shoule be returned to the - callback. - If quiet mode is true the callback will receive only keys where the delete operation encountered an error. - If quiet mode is false the callback will receive keys for both successful and unsuccessful delete operations. - - - - - Internal class used to pass the parameters for DeleteS3BucketWithObjects operation. - - - Internal class used to pass the parameters for DeleteS3BucketWithObjects operation. - - - - - Name of the bucket to be deleted. - - - - - The Amazon S3 Client to use for S3 specific operations. - - - - - Options to control the behavior of the delete operation. - - - - - The callback which is used to send updates about the delete operation. - - - - - Contains updates from DeleteS3BucketWithObjects operation. - - - - - The list of objects which were successfully deleted. - - - - - The list of objects for which the delete operation failed. - - - - - A helper class that represents a strongly typed S3 EventNotification item sent to SQS - - - - - Parse the JSON string into a S3EventNotification object. - - The function will try its best to parse input JSON string as best as it can. - It will not fail even if the JSON string contains unknown properties. - - For any parsing errors - - - - - Gets and sets the records for the S3 event notification - - - - - The class holds the user identity properties. - - - - - Gets and sets the PrincipalId property. - - - - - This class contains the identity information for an S3 bucket. - - - - - Gets and sets the name of the bucket. - - - - - Gets and sets the bucket owner id. - - - - - Gets and sets the S3 bucket arn. - - - - - This class contains the information for an object in S3. - - - - - Gets and sets the key for the object stored in S3. - - - - - Gets and sets the size of the object in S3. - - - - - Gets and sets the etag of the object. This can be used to determine if the object has changed. - - - - - Gets and sets the version id of the object in S3. - - - - - Gets and sets the sequencer a string representation of a hexadecimal value used to determine event sequence, only used with PUTs and DELETEs. - - - - - Gets and sets the meta information describing S3. - - - - - Gets and sets the ConfigurationId. This ID can be found in the bucket notification configuration. - - - - - Gets and sets the Bucket property. - - - - - Gets and sets the Object property. - - - - - Gets and sets the S3SchemaVersion property. - - - - - The class holds the request parameters - - - - - Gets and sets the SourceIPAddress. This is the ip address where the request came from. - - - - - This class holds the response elements. - - - - - Gets and sets the XAmzId2 Property. This is the Amazon S3 host that processed the request. - - - - - Gets and sets the XAmzRequestId. This is the Amazon S3 generated request ID. - - - - - The class holds the glacier event data elements. - - - - - Gets and sets the RestoreEventData property. - - - - - The class holds the restore event data elements. - - - - - Gets and sets the LifecycleRestorationExpiryTime the time when the object restoration will be expired. - - - - - Gets and sets the LifecycleRestoreStorageClass the source storage class for restore. - - - - - The class holds the event notification. - - - - - Gets and sets the AwsRegion property. - - - - - Gets and sets the EventName property. This identities what type of event occurred. - For example for an object just put in S3 this will be set to EventType.ObjectCreatedPut. - - - - - Gets and sets the EventSource property. - - - - - Gets and sets the EventType property. The time when S3 finished processing the request. - - - - - Gets and sets the EventVersion property. - - - - - Gets and sets the RequestParameters property. - - - - - Gets and sets the ResponseElements property. - - - - - Gets and sets the S3 property. - - - - - Gets and sets the UserIdentity property. - - - - - Get and sets the GlacierEventData property. - - - - - Represents the status of an asynchronous operation. - It adds support for Cancelation of the asynchronous operation. - - - - - Gets a value that indicated whether the asynchronous operation has been canceled. - - - - - Gets a user-defined object that qualifies or contains information about an - asynchronous operation. - - - - - Gets a System.Threading.WaitHandle that is used to wait for an asynchronous - operation to complete. - - - - - Gets a value that indicates whether the asynchronous operation completed - synchronously. - - - - - Gets a value that indicates whether the asynchronous operation has completed. - - - - - Gets a value that indicates whether a cancel is requested. - - - - - The last exception that when the asynchronous operation was executed. - This is used to capture the exception and re-throw it when EndOperation is called. - - - - - The callback to be invoked when the asynchronous operation is completed. - - - - - Constructor for AsyncCancelableResult. - - The callback to be invoked when the asynchronous operation is completed. - Gets a user-defined object that qualifies or contains information about an - asynchronous operation. - - - - - Cancels the asynchronous operation if it's in progress. - - - - - Signals that the operaton is canceled and invokes the callback. - - - - - Signals that the operation is completed and invoked the callback. - - - - - Performs application-defined tasks associated with freeing, releasing, or - resetting unmanaged resources. - - - - - Disposes any managed and unmanaged resources. - - Should pass true if called by Dispose(), pass false if - called during finalization. - - - - Represents the status of an asynchronous operation. This interface extends - IAsyncResult and adds support for Cancelation of the asynchronous operation. - - - - - Cancels the asynchronous operation if it's in progress. - - - - - Gets a value that indicated whether the asynchronous operation has been canceled. - - - - - An exception detailing a failed HTTP POST upload atempt to Amazon S3. - - - - - Initializes a new instance of S3PostUploadException with a specified error message - - The error message - - - - Initializes a new instance of S3PostUploadException with a specified error code and error message - - The error code - The error message - - - - The error code returned by S3 - - - - - The S3 request id - - - - - The S3 host id - - - - - The HTTP error status code returned by S3 - - - - - Additional information about the error - - - Some errors are accompanied by more specific information, which vary from error to error - - - - - Parse an S3 Error response and create an S3PostUploadException - - The response from S3 - An S3PostUploadException with the information from the response - - - - Constructs a new instance of the S3PostUploadException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - Class for unmarshalling response XML - - - - - Gets and sets the ErrorCode property. - - - - - Gets and sets the ErrorMessage property. - - - - - Gets and sets the RequestId property. - - - - - Gets and sets the HostId property. - - - - - Gets and sets the elements property. - - - - - Parameters for uploading to Amazon S3 a file using HTTP POS - - - - If a S3PostUploadSignedPolicy is assigned, then values set (other than InputStream or Path) on this object must adhere to the policy. - This includes metadata. If metadata is specified in the policy, then it must be included in the request. Adding metadata not in the - policy will cause the POST to fail. - - For more information, - - - - - - Default constructor. - - - - - S3 Bucket to upload the object to - - - - - The name of the uploaded key. - - - - - Stream to read the upload data for - - - If you use InputStream, then you also need to set ContentLength - - - - - File path to read the upload data from - - - - - Content type for the uploaded data - - - If this is not set, an attempt will be made to infer it from the extension on Key or Path (in that order), - otherwise 'application/octet-stream' will be assumed. - - - - - Specifies an Amazon S3 access control list - - - - - Signed policy from bucket owner. - - - - - Where to redirect browsers on a successful upload - - - - - The status code returned to the client upon successful upload if success_action_redirect is not specified - - - - Accepts the values OK (200) , Created (201), or NoContent (204, default). - - If the value is set to OK or NoContent, Amazon S3 returns an empty document with a 200 or 204 status code. - - If the value is set to Created, Amazon S3 returns an XML document with a 201 status code. - - If the value is not set or if it is set to an invalid value, Amazon S3 returns an empty document with a 204 status code. - - - - - - Storage class to use for storing the object - - - Default: STANDARD - - - - - The AWS region where the bucket is located. - - - Depending upon the bucket name, POST uploads will be - successfully redirected, but for buckets with non-DNS-compliant - characters, redirects will fail. Setting this to the appropriate - region will avoid the redirect. - - - - - Metadata to set on the uploaded object - - - If keys do not begin with 'x-amz-meta-' it will be added at POST time. - - - - - Write the multipart/form-data for this request for all fields except the file data to a stream - - - - - Class holds Response data for a post upload. - - - - - Gets and sets the StatusCode property. - - - - - Gets and sets the RequestId property. - - - - - Gets and sets the HostId property. - - - - - Gets and sets the CloudFront request ID. - - - - - Utility class for managing and exchanging HTTP POST uploads of objects to Amazon S3. - - - - This object supports creating, marshalling, and unmarshalling of the information needed to build - an authenticated HTTP POST request to S3 for uploading objects according to a policy. - - For more information, - - - - - Given a policy and AWS credentials, produce a S3PostUploadSignedPolicy. - - JSON string representing the policy to sign - Credentials to sign the policy with - A signed policy object for use with an S3PostUploadRequest. - - - - Given a policy and AWS credentials, produce a S3PostUploadSignedPolicy. - - JSON string representing the policy to sign - Credentials to sign the policy with - Service region endpoint. - A signed policy object for use with an S3PostUploadRequest. - - - - The policy document which governs what uploads can be done. - - - - - The signature for the policy. - - - - - The AWS Access Key Id for the credential pair that produced the signature. - - - - - The security token from session or instance credentials. - - - - - The signature version usedd. Either "2" or "4". - - - - - The signing algorithm used. Required as a field in the post Amazon - S3 can re-calculate the signature. - - - - - The date value in ISO8601 format. It is the same date used in - creating the signing key. - - - - - In addition to the access key ID, this provides scope information - used in calculating the signing key for signature calculation. - - - - - Get the policy document as a human readable string. - - Human readable policy document. - - - - JSON representation of this object - - JSON string - - - - XML Representation of this object - - XML String - - - - Create an instance of this class from a JSON string. - - JSON string - Instance of S3PostUploadSignedPolicy - - - - Create an instance of this class from an XML string. - - XML string generated by ToXml() - Instance of S3PostUploadSignedPolicy - - - - Mimics the System.IO.DirectoryInfo for a virtual directory in S3. It exposes properties and methods for enumerating directories and files as well as - methods manipulate directories. - - - It is important to keep in mind that S3 is not a filesystem. It is possible for S3 object keys to contain - characters which are not not legal file path characters, and so some pre-existing objects in a bucket that were created with - other software may not be compatible with this class. - - - - - Initialize a new instance of the S3DirectoryInfo class for the specified S3 bucket. - - S3 client which is used to access the S3 resources. - Name of the S3 bucket. - - - - - Initialize a new instance of the S3DirectoryInfo class for the specified S3 bucket and S3 object key. - - S3 client which is used to access the S3 resources. - Name of the S3 bucket. - The S3 object key. - - - - - The S3DirectoryInfo for the root of the S3 bucket. - - - - - Checks with S3 to see if the directory exists and if so returns true. - - Due to Amazon S3's eventual consistency model this property can return false for newly created buckets. - - - - - - - Returns empty string for directories. - - - - - The full path of the directory including bucket name. - - - - - Returns the last write time of the the latest file written to the directory. - - - - - - - UTC converted version of LastWriteTime. - - - - - - - Returns the name of the folder. - - - - - Return the S3DirectoryInfo of the parent directory. - - - - - Returns the S3DirectroyInfo for the S3 account. - - - - - Returns the type of file system element. - - - - - Creates the directory in S3. If no object key was specified when creating the S3DirectoryInfo then the bucket will be created. - - - - - - - Creates a sub directory inside the instance of S3DirectoryInfo. - - - - - - - - - Deletes all the files in this directory as well as this directory. - - - - - - - - Deletes all the files in this directory as well as this directory. If recursive is set to true then all sub directories will be - deleted as well. - - - - - If true then sub directories will be deleted as well. - - - - Enumerate the sub directories of this directory. - - - - An enumerable collection of directories. - - - - Enumerate the sub directories of this directory. - - The search string. The default pattern is "*", which returns all directories. - - - An enumerable collection of directories that matches searchPattern. - - - - Enumerate the sub directories of this directory. - - The search string. The default pattern is "*", which returns all directories. - One of the enumeration values that specifies whether the search operation should include only the current directory or all subdirectories. The default value is TopDirectoryOnly. - - - An enumerable collection of directories that matches searchPattern and searchOption. - - - - Enumerate the files of this directory. - - - - An enumerable collection of files. - - - - Enumerate the sub directories of this directory. - - The search string. The default pattern is "*", which returns all files. - - - An enumerable collection of files that matches searchPattern. - - - - Enumerate the files of this directory. - - The search string. The default pattern is "*", which returns all files. - One of the enumeration values that specifies whether the search operation should include only the current directory or all subdirectories. The default value is TopDirectoryOnly. - - - An enumerable collection of files that matches searchPattern and searchOption. - - - - Enumerate the files of this directory. - - - - An enumerable collection of files. - - - - Enumerate the files of this directory. - - The search string. The default pattern is "*", which returns all files. - - - An enumerable collection of files that matches searchPattern. - - - - Enumerate the files of this directory. - - The search string. The default pattern is "*", which returns all files. - One of the enumeration values that specifies whether the search operation should include only the current directory or all subdirectories. The default value is TopDirectoryOnly. - - - An enumerable collection of files that matches searchPattern and searchOption. - - - - Returns the S3DirectoryInfo for the specified sub directory. - - Directory to get the S3DirectroyInfo for. - The S3DirectoryInfo for the specified sub directory. - - - - Returns an array of S3DirectoryInfos for the directories in this directory. - - - - An array of directories. - - - - Returns an array of S3DirectoryInfos for the directories in this directory. - - The search string. The default pattern is "*", which returns all files. - An array of files that matches searchPattern. - - - - Returns an array of S3DirectoryInfos for the directories in this directory. - - The search string. The default pattern is "*", which returns all directories. - One of the enumeration values that specifies whether the search operation should include only the current directory or all subdirectories. The default value is TopDirectoryOnly. - - - An array of directories that matches searchPattern and searchOption. - - - - Returns the S3FileInfo for the specified file. - - File to get the S3FileInfo for. - The S3FileInfo for the specified file. - - - - Returns an array of S3FileInfos for the files in this directory. - - - - An array of files. - - - - Returns an array of S3FileInfos for the files in this directory. - - The search string. The default pattern is "*", which returns all files. - - - An array of files that matches searchPattern. - - - - Returns an array of S3FileInfos for the files in this directory. - - The search string. The default pattern is "*", which returns all files. - One of the enumeration values that specifies whether the search operation should include only the current directory or all subdirectories. The default value is TopDirectoryOnly. - - - An array of files that matches searchPattern and searchOption. - - - - Returns an array of IS3FileSystemInfos for the files in this directory. - - - - An array of files. - - - - Returns an array of IS3FileSystemInfos for the files in this directory. - - The search string. The default pattern is "*", which returns all files. - - - An array of files that matches searchPattern. - - - - Returns an array of IS3FileSystemInfos for the files in this directory. - - The search string. The default pattern is "*", which returns all files. - One of the enumeration values that specifies whether the search operation should include only the current directory or all subdirectories. The default value is TopDirectoryOnly. - - - An array of files that matches searchPattern and searchOption. - - - - Copies the files from this directory to the target directory specified by the bucket and object key. - - The target bucket to copy to. - The target object key which represents a directory in S3. - - - - S3DirectoryInfo for the target location. - - - - Copies the files from this directory to the target directory specified by the bucket and object key. Only - files that have changed since the changeSince date will be copied. - - The target bucket to copy to. - The target object key which represents a directory in S3. - Date which files must have changed since in ordered to be copied. - - - - S3DirectoryInfo for the target location. - - - - Copies the files from this directory to the target directory. - - The target directory to copy to. - - - - S3DirectoryInfo for the target location. - - - - Copies the files from this directory to the target directory. Only - files that have changed since the changeSince date will be copied. - - The target directory to copy to. - Date which files must have changed since in ordered to be copied. - - - - S3DirectoryInfo for the target location. - - - - Copies the files from the S3 directory to the local file system in the location indicated by the path parameter. - - The location on the local file system to copy the files to. - - - DirectoryInfo for the local directory where files are copied to. - - - - Copies the files from the S3 directory to the local file system in the location indicated by the path parameter. - Only files that have been modified since the changesSince property will be copied. - - The location on the local file system to copy the files to. - Date which files must have changed since in ordered to be copied. - - - - DirectoryInfo for the local directory where files are copied to. - - - - Copies files from the local file system to S3 in this directory. Sub directories are copied as well. - - The local file system path where the files are to be copied. - - - - S3DirectoryInfo where the files are copied to. - - - - Copies files from the local file system to S3 in this directory. Sub directories are copied as well. - Only files that have been modified since the changesSince property will be copied. - - The local file system path where the files are to copy. - Date which files must have changed since in ordered to be copied. - - - - S3DirectoryInfo where the files are copied to. - - - - Moves the directory to the target directory specified by the bucket and object key. - - The target bucket to move to. - The target object key which represents a directory in S3. - - - - S3DirectoryInfo for the target location. - - - - Moves the directory to the target S3 directory. - - The target directory to copy to. - - - - S3DirectoryInfo for the target location. - - - - Moves the files from the S3 directory to the local file system in the location indicated by the path parameter. - - The location on the local file system to move the files to. - - - - DirectoryInfo for the local directory where files are moved to. - - - - Moves files from the local file system to S3 in this directory. Sub directories are moved as well. - - The local file system path where the files are to be moved. - - - - S3DirectoryInfo where the files are moved to. - - - - Implement the ToString method. - - - - - - Creating and deleting buckets can sometimes take a little bit of time. To make sure - users of this API do not experience the side effects of the eventual consistency - we block until the state change has happened. - - - - - - Mimics the System.IO.FileInfo for a file in S3. It exposes properties and methods manipulating files in S3. - - - - - Initialize a new instance of the S3FileInfo class for the specified S3 bucket and S3 object key. - - S3 client which is used to access the S3 resources. - Name of the S3 bucket. - The S3 object key. - - - - - Returns the parent S3DirectoryInfo. - - - - - The full name of parent directory. - - - - - Checks S3 if the file exists in S3 and return true if it does. - - - - - - - Gets the file's extension. - - - - - Returns the full path including the bucket. - - - - - Returns the last time the file was modified. - - - - - - - Returns the last time the file was modified in UTC. - - - - - - - Returns the content length of the file. - - - - - - - Returns the file name without its directory name. - - - - - Returns the type of file system element. - - - - - Copies this file's content to the file indicated by the S3 bucket and object key. - If the file already exists in S3 than an ArgumentException is thrown. - - S3 bucket to copy the file to. - S3 object key to copy the file to. - - - - S3FileInfo of the newly copied file. - - - - Copies this file's content to the file indicated by the S3 bucket and object key. - If the file already exists in S3 and overwrite is set to false than an ArgumentException is thrown. - - S3 bucket to copy the file to. - S3 object key to copy the file to. - Determines whether the file can be overwritten. - If the file already exists in S3 and overwrite is set to false. - - - - S3FileInfo of the newly copied file. - - - - Copies this file to the target directory. - If the file already exists in S3 than an ArgumentException is thrown. - - Target directory where to copy the file to. - If the directory does not exist. - If the file already exists in S3. - - - S3FileInfo of the newly copied file. - - - - Copies this file to the target directory. - If the file already exists in S3 and overwrite is set to false than an ArgumentException is thrown. - - Target directory where to copy the file to. - Determines whether the file can be overwritten. - If the directory does not exist. - If the file already exists in S3 and overwrite is set to false. - - - S3FileInfo of the newly copied file. - - - - Copies this file to the location indicated by the passed in S3FileInfo. - If the file already exists in S3 than an ArgumentException is thrown. - - The target location to copy this file to. - If the file already exists in S3. - - - S3FileInfo of the newly copied file. - - - - Copies this file to the location indicated by the passed in S3FileInfo. - If the file already exists in S3 and overwrite is set to false than an ArgumentException is thrown. - - The target location to copy this file to. - Determines whether the file can be overwritten. - If the file already exists in S3 and overwrite is set to false. - - - S3FileInfo of the newly copied file. - - - - Copies from S3 to the local file system. - If the file already exists on the local file system than an ArgumentException is thrown. - - The path where to copy the file to. - If the file already exists locally. - - - FileInfo for the local file where file is copied to. - - - - Copies from S3 to the local file system. - If the file already exists on the local file system and overwrite is set to false than an ArgumentException is thrown. - - The path where to copy the file to. - Determines whether the file can be overwritten. - If the file already exists locally and overwrite is set to false. - - - FileInfo for the local file where file is copied to. - - - - Copies the file from the local file system to S3. - If the file already exists in S3 than an ArgumentException is thrown. - - Location of the file on the local file system to copy. - If the file already exists in S3. - - - S3FileInfo where the file is copied to. - - - - Copies the file from the local file system to S3. - If the file already exists in S3 and overwrite is set to false than an ArgumentException is thrown. - - Location of the file on the local file system to copy. - Determines whether the file can be overwritten. - If the file already exists in S3 and overwrite is set to false. - - - S3FileInfo where the file is copied to. - - - - Returns a Stream that can be used to write data to S3. - - - The content will not be written to S3 until the Stream is closed. - - - - Stream to write content to. - - - - Returns a StreamWriter that can be used to write data to S3. - - - The content will not be written to S3 until the Stream is closed. - - - - Stream to write content to. - - - - Deletes the from S3. - - - - - - - Moves the file to a a new location in S3. - - Bucket to move the file to. - Object key to move the file to. - If the file already exists in S3. - - - - S3FileInfo for the target location. - - - - Moves the file to a a new location in S3. - - The target directory to copy to. - If the file already exists in S3. - - - - S3FileInfo for the target location. - - - - Moves the file to a a new location in S3. - - The target file to copy to. - If the file already exists in S3. - - - - S3FileInfo for the target location. - - - - Moves the file from S3 to the local file system in the location indicated by the path parameter. - - The location on the local file system to move the file to. - If the file already exists locally. - - - - FileInfo for the local file where file is moved to. - - - - Moves the file from the local file system to S3 in this directory. - If the file already exists in S3 than an ArgumentException is thrown. - - The local file system path where the files are to be moved. - If the file already exists locally. - - - - S3FileInfo where the file is moved to. - - - - Moves the file from the local file system to S3 in this directory. - If the file already exists in S3 and overwrite is set to false than an ArgumentException is thrown. - - The local file system path where the files are to be moved. - Determines whether the file can be overwritten. - If the file already exists in S3 and overwrite is set to false. - - - - S3FileInfo where the file is moved to. - - - - Returns a Stream for reading the contents of the file. - - The file is already open. - - - Stream to read from. - - - - Returns a StreamReader for reading the contents of the file. - - The file is already open. - - - StreamReader to read from. - - - - Returns a Stream for writing to S3. If the file already exists it will be overwritten. - - - The content will not be written to S3 until the Stream is closed. - - The file is already open. - - - Stream to write from. - - - - Replaces the destination file with the content of this file and then deletes the orignial file. If a backup location is specifed then the content of destination file is - backup to it. - - Destination bucket of this file will be copy to. - Destination object key of this file will be copy to. - Backup bucket to store the contents of the destination file. - Backup object key to store the contents of the destination file. - - - - - S3FileInfo of the destination file. - - - - Replaces the destination file with the content of this file and then deletes the orignial file. If a backupDir is specifed then the content of destination file is - backup to it. - - Where the contents of this file will be copy to. - If specified the destFile is backup to it. - - - - - S3FileInfo of the destination file. - - - - Replaces the destination file with the content of this file and then deletes the orignial file. If a backupFile is specifed then the content of destination file is - backup to it. - - Where the contents of this file will be copy to. - If specified the destFile is backup to it. - - - - - S3FileInfo of the destination file. - - - - Replaces the content of the destination file on the local file system with the content from this file from S3. - If a backup file is specified then the content of the destination file is backup to it. - - - - - - - - - - - - Implement the ToString method. - - - - - - Enumeration indicated whether a file system element is a file or directory. - - - - - Type is a directory. - - - - - Type is a file. - - - - - Common interface for both S3FileInfo and S3DirectoryInfo. - - - - - Returns true if the item exists in S3. - - - - - Returns the extension of the item. - - - - - Returns the fully qualified path to the item. - - - - - Returns the last modified time for this item from S3 in local timezone. - - - - - Returns the last modified time for this item from S3 in UTC timezone. - - - - - Returns the name of the item without parent information. - - - - - Indicates what type of item this object represents. - - - - - Deletes this item from S3. - - - - - Configuration for the S3 section of AWS configuration. - Changes to some settings may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws> - <s3 useSignatureVersion4="true" /> - </aws> - - - - - - Key for the S3UseSignatureVersion4Key property. - - - - - - Configures if the S3 client should use Signature Version 4 signing with requests. - By default, this setting is set to true which will use Signature Version 4 for all - requests except presigned URL requests when the region is set to us-east-1. When - UseSignatureVersion4 is explicitly set to true by directly setting this property or - directly setting this property through configuration, Signature Version 4 will be - used for all requests when able to do so. - When this setting is false, Signature Version 2 will be used. Note that when the - setting is false, Signature Version 4 may still be used by default in some cases - or with some regions. - - - - - Was the value of the UseSignatureVersion4 property set explicitly? - This can be done via configuration or by directly setting the property. - - This is used to determine if the user set UseSignatureVersion4 to true, - or if it's true because the default was changed to true in the SDK. - - - - - V4-enabling section - - - - diff --git a/packages/AWSSDK.S3.3.5.0-beta/lib/net45/AWSSDK.S3.dll b/packages/AWSSDK.S3.3.5.0-beta/lib/net45/AWSSDK.S3.dll deleted file mode 100644 index aca3cfd..0000000 Binary files a/packages/AWSSDK.S3.3.5.0-beta/lib/net45/AWSSDK.S3.dll and /dev/null differ diff --git a/packages/AWSSDK.S3.3.5.0-beta/lib/net45/AWSSDK.S3.xml b/packages/AWSSDK.S3.3.5.0-beta/lib/net45/AWSSDK.S3.xml deleted file mode 100644 index a08cafb..0000000 --- a/packages/AWSSDK.S3.3.5.0-beta/lib/net45/AWSSDK.S3.xml +++ /dev/null @@ -1,46244 +0,0 @@ - - - - AWSSDK.S3 - - - - - Implementation for accessing S3 - - - - - - - Specialize the initialize of the client. - - - - - Create a signed URL allowing access to a resource that would - usually require authentication. - - - - When using query string authentication you create a query, - specify an expiration time for the query, sign it with your - signature, place the data in an HTTP request, and distribute - the request to a user or embed the request in a web page. - - - A PreSigned URL can be generated for GET, PUT, DELETE and HEAD - operations on your bucketName, keys, and versions. - - - The GetPreSignedUrlRequest that defines the - parameters of the operation. - determines if signing will fall back to SigV2 if the - signing region is us-east-1 - A string that is the signed http request. - - - - - - Marshalls the parameters for a presigned url for a preferred signing protocol. - - - - - - True if AWS4 signing will be used; if the expiry period in the request exceeds the - maximum allowed for AWS4 (one week), an ArgumentException is thrown. - - - - - - Create a signed URL allowing access to a resource that would - usually require authentication. - - - - When using query string authentication you create a query, - specify an expiration time for the query, sign it with your - signature, place the data in an HTTP request, and distribute - the request to a user or embed the request in a web page. - - - A PreSigned URL can be generated for GET, PUT, DELETE and HEAD - operations on your bucketName, keys, and versions. - - - The GetPreSignedUrlRequest that defines the - parameters of the operation. - A string that is the signed http request. - - - - - - Constructs AmazonS3Client with the credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - - - - Constructs AmazonS3Client with the credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - The region to connect. - - - - Constructs AmazonS3Client with the credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - The AmazonS3Client Configuration Object - - - - Constructs AmazonS3Client with AWS Credentials - - AWS Credentials - - - - Constructs AmazonS3Client with AWS Credentials - - AWS Credentials - The region to connect. - - - - Constructs AmazonS3Client with AWS Credentials and an - AmazonS3Client Configuration object. - - AWS Credentials - The AmazonS3Client Configuration Object - - - - Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - - - - Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - The region to connect. - - - - Constructs AmazonS3Client with AWS Access Key ID, AWS Secret Key and an - AmazonS3Client Configuration object. - - AWS Access Key ID - AWS Secret Access Key - The AmazonS3Client Configuration Object - - - - Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - - - - Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - The region to connect. - - - - Constructs AmazonS3Client with AWS Access Key ID, AWS Secret Key and an - AmazonS3Client Configuration object. - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - The AmazonS3Client Configuration Object - - - - Creates the signer for the service. - - - - - Customize the pipeline - - - - - - Capture metadata for the service. - - - - - Disposes the service client. - - - - - This operation aborts a multipart upload. After a multipart upload is aborted, no - additional parts can be uploaded using that upload ID. The storage consumed by any - previously uploaded parts will be freed. However, if any part uploads are currently - in progress, those part uploads might or might not succeed. As a result, it might - be necessary to abort a given multipart upload multiple times in order to completely - free all storage consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts operation and ensure that the parts - list is empty. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - The bucket name to which the upload was taking place. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object for which the multipart upload was initiated. - Upload ID that identifies the multipart upload. - - The response from the AbortMultipartUpload service method, as returned by S3. - - - - This operation aborts a multipart upload. After a multipart upload is aborted, no - additional parts can be uploaded using that upload ID. The storage consumed by any - previously uploaded parts will be freed. However, if any part uploads are currently - in progress, those part uploads might or might not succeed. As a result, it might - be necessary to abort a given multipart upload multiple times in order to completely - free all storage consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts operation and ensure that the parts - list is empty. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - Container for the necessary parameters to execute the AbortMultipartUpload service method. - - The response from the AbortMultipartUpload service method, as returned by S3. - - - - This operation aborts a multipart upload. After a multipart upload is aborted, no - additional parts can be uploaded using that upload ID. The storage consumed by any - previously uploaded parts will be freed. However, if any part uploads are currently - in progress, those part uploads might or might not succeed. As a result, it might - be necessary to abort a given multipart upload multiple times in order to completely - free all storage consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts operation and ensure that the parts - list is empty. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - The bucket name to which the upload was taking place. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object for which the multipart upload was initiated. - Upload ID that identifies the multipart upload. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AbortMultipartUpload service method, as returned by S3. - - - - This operation aborts a multipart upload. After a multipart upload is aborted, no - additional parts can be uploaded using that upload ID. The storage consumed by any - previously uploaded parts will be freed. However, if any part uploads are currently - in progress, those part uploads might or might not succeed. As a result, it might - be necessary to abort a given multipart upload multiple times in order to completely - free all storage consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts operation and ensure that the parts - list is empty. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - Container for the necessary parameters to execute the AbortMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AbortMultipartUpload service method, as returned by S3. - - - - Completes a multipart upload by assembling previously uploaded parts. - - - - You first initiate the multipart upload and then upload all parts using the UploadPart - operation. After successfully uploading all relevant parts of an upload, you call - this operation to complete the upload. Upon receiving this request, Amazon S3 concatenates - all the parts in ascending order by part number to create a new object. In the Complete - Multipart Upload request, you must provide the parts list. You must ensure that the - parts list is complete. This operation concatenates the parts that you provide in - the list. For each part in the list, you must provide the part number and the ETag - value, returned after that part was uploaded. - - - - Processing of a Complete Multipart Upload request could take several minutes to complete. - After Amazon S3 begins processing the request, it sends an HTTP response header that - specifies a 200 OK response. While processing is in progress, Amazon S3 periodically - sends white space characters to keep the connection from timing out. Because a request - could fail after the initial 200 OK response has been sent, it is important that you - check the response body to determine whether the request succeeded. - - - - Note that if CompleteMultipartUpload fails, applications should be prepared - to retry the failed requests. For more information, see Amazon - S3 Error Best Practices. - - - - For more information about multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - GetBucketLifecycle has the following special errors: - -
  • - - Error code: EntityTooSmall - -
    • - - Description: Your proposed upload is smaller than the minimum allowed object size. - Each part must be at least 5 MB in size, except the last part. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPart - -
    • - - Description: One or more of the specified parts could not be found. The part might - not have been uploaded, or the specified entity tag might not have matched the part's - entity tag. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPartOrder - -
    • - - Description: The list of parts was not in ascending order. The parts list must be - specified in order by part number. - -
    • - - 400 Bad Request - -
  • - - Error code: NoSuchUpload - -
    • - - Description: The specified multipart upload does not exist. The upload ID might be - invalid, or the multipart upload might have been aborted or completed. - -
    • - - 404 Not Found - -
- - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the CompleteMultipartUpload service method. - - The response from the CompleteMultipartUpload service method, as returned by S3. - - - - Completes a multipart upload by assembling previously uploaded parts. - - - - You first initiate the multipart upload and then upload all parts using the UploadPart - operation. After successfully uploading all relevant parts of an upload, you call - this operation to complete the upload. Upon receiving this request, Amazon S3 concatenates - all the parts in ascending order by part number to create a new object. In the Complete - Multipart Upload request, you must provide the parts list. You must ensure that the - parts list is complete. This operation concatenates the parts that you provide in - the list. For each part in the list, you must provide the part number and the ETag - value, returned after that part was uploaded. - - - - Processing of a Complete Multipart Upload request could take several minutes to complete. - After Amazon S3 begins processing the request, it sends an HTTP response header that - specifies a 200 OK response. While processing is in progress, Amazon S3 periodically - sends white space characters to keep the connection from timing out. Because a request - could fail after the initial 200 OK response has been sent, it is important that you - check the response body to determine whether the request succeeded. - - - - Note that if CompleteMultipartUpload fails, applications should be prepared - to retry the failed requests. For more information, see Amazon - S3 Error Best Practices. - - - - For more information about multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - GetBucketLifecycle has the following special errors: - -
  • - - Error code: EntityTooSmall - -
    • - - Description: Your proposed upload is smaller than the minimum allowed object size. - Each part must be at least 5 MB in size, except the last part. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPart - -
    • - - Description: One or more of the specified parts could not be found. The part might - not have been uploaded, or the specified entity tag might not have matched the part's - entity tag. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPartOrder - -
    • - - Description: The list of parts was not in ascending order. The parts list must be - specified in order by part number. - -
    • - - 400 Bad Request - -
  • - - Error code: NoSuchUpload - -
    • - - Description: The specified multipart upload does not exist. The upload ID might be - invalid, or the multipart upload might have been aborted or completed. - -
    • - - 404 Not Found - -
- - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the CompleteMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CompleteMultipartUpload service method, as returned by S3. - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - for copying an object greater than 5 GB, you must use the multipart upload Upload - Part - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - Amazon S3 transfer acceleration does not support cross-region copies. If you request - a cross-region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information about transfer acceleration, see Transfer - Acceleration. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - request parameters x-amz-copy-source-if-match, x-amz-copy-source-if-none-match, - x-amz-copy-source-if-unmodified-since, or x-amz-copy-source-if-modified-since. - - - - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - You can use this operation to change the storage class of an object that is already - stored in Amazon S3 using the StorageClass parameter. For more information, - see Storage - Classes. - - - - The source object that you are copying can be encrypted or unencrypted. If the source - object is encrypted, it can be encrypted by server-side encryption using AWS managed - encryption keys or by using a customer-provided encryption key. When copying an object, - you can request that Amazon S3 encrypt the target object by using either the AWS managed - encryption keys or by using your own encryption key. You can do this regardless of - the form of server-side encryption that was used to encrypt the source, or even if - the source object was not encrypted. For more information about server-side encryption, - see Using - Server-Side Encryption. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
    • - - x-amz-copy-source-if-match condition evaluates to true - -
    • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
  • - - Consideration 2 – If both of the x-amz-copy-source-if-none-match and - x-amz-copy-source-if-modified-since headers are present in the request - and evaluate as follows, Amazon S3 returns the 412 Precondition Failed - response code: - -
    • - - x-amz-copy-source-if-none-match condition evaluates to false - -
    • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - The copy request charge is based on the storage class and Region you specify for the - destination object. For pricing information, see Amazon - S3 Pricing. - - - - Following are other considerations when using CopyObject: - -
Versioning
- - By default, x-amz-copy-source identifies the current version of an object - to copy. (If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted.) To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - To encrypt the target object, you must provide the appropriate encryption-related - request headers. The one you use depends on whether you want to use AWS managed encryption - keys or provide your own encryption key. - -
  • - - To encrypt the target object using server-side encryption with an AWS managed encryption - key, provide the following request headers, as appropriate. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. If you want to use a customer managed AWS KMS - CMK, you must provide the x-amz-server-side-encryption-aws-kms-key-id - of the symmetric customer managed CMK. Amazon S3 only supports symmetric CMKs and - not asymmetric CMKs. For more information, see Using - Symmetric and Asymmetric Keys in the AWS Key Management Service Developer Guide. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in KMS. - -
  • - - To encrypt the target object using server-side encryption with an encryption key that - you provide, use the following headers. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
  • - - If the source object is encrypted using server-side encryption with customer-provided - encryption keys, you must use the following headers. - -
    • - - x-amz-copy-source​-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-copy-source​-server-side​-encryption​-customer-key - -
    • - - x-amz-copy-source-​server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in Amazon KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - The response from the CopyObject service method, as returned by S3. - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - for copying an object greater than 5 GB, you must use the multipart upload Upload - Part - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - Amazon S3 transfer acceleration does not support cross-region copies. If you request - a cross-region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information about transfer acceleration, see Transfer - Acceleration. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - request parameters x-amz-copy-source-if-match, x-amz-copy-source-if-none-match, - x-amz-copy-source-if-unmodified-since, or x-amz-copy-source-if-modified-since. - - - - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - You can use this operation to change the storage class of an object that is already - stored in Amazon S3 using the StorageClass parameter. For more information, - see Storage - Classes. - - - - The source object that you are copying can be encrypted or unencrypted. If the source - object is encrypted, it can be encrypted by server-side encryption using AWS managed - encryption keys or by using a customer-provided encryption key. When copying an object, - you can request that Amazon S3 encrypt the target object by using either the AWS managed - encryption keys or by using your own encryption key. You can do this regardless of - the form of server-side encryption that was used to encrypt the source, or even if - the source object was not encrypted. For more information about server-side encryption, - see Using - Server-Side Encryption. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
    • - - x-amz-copy-source-if-match condition evaluates to true - -
    • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
  • - - Consideration 2 – If both of the x-amz-copy-source-if-none-match and - x-amz-copy-source-if-modified-since headers are present in the request - and evaluate as follows, Amazon S3 returns the 412 Precondition Failed - response code: - -
    • - - x-amz-copy-source-if-none-match condition evaluates to false - -
    • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - The copy request charge is based on the storage class and Region you specify for the - destination object. For pricing information, see Amazon - S3 Pricing. - - - - Following are other considerations when using CopyObject: - -
Versioning
- - By default, x-amz-copy-source identifies the current version of an object - to copy. (If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted.) To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - To encrypt the target object, you must provide the appropriate encryption-related - request headers. The one you use depends on whether you want to use AWS managed encryption - keys or provide your own encryption key. - -
  • - - To encrypt the target object using server-side encryption with an AWS managed encryption - key, provide the following request headers, as appropriate. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. If you want to use a customer managed AWS KMS - CMK, you must provide the x-amz-server-side-encryption-aws-kms-key-id - of the symmetric customer managed CMK. Amazon S3 only supports symmetric CMKs and - not asymmetric CMKs. For more information, see Using - Symmetric and Asymmetric Keys in the AWS Key Management Service Developer Guide. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in KMS. - -
  • - - To encrypt the target object using server-side encryption with an encryption key that - you provide, use the following headers. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
  • - - If the source object is encrypted using server-side encryption with customer-provided - encryption keys, you must use the following headers. - -
    • - - x-amz-copy-source​-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-copy-source​-server-side​-encryption​-customer-key - -
    • - - x-amz-copy-source-​server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in Amazon KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - The response from the CopyObject service method, as returned by S3. - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - for copying an object greater than 5 GB, you must use the multipart upload Upload - Part - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - Amazon S3 transfer acceleration does not support cross-region copies. If you request - a cross-region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information about transfer acceleration, see Transfer - Acceleration. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - request parameters x-amz-copy-source-if-match, x-amz-copy-source-if-none-match, - x-amz-copy-source-if-unmodified-since, or x-amz-copy-source-if-modified-since. - - - - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - You can use this operation to change the storage class of an object that is already - stored in Amazon S3 using the StorageClass parameter. For more information, - see Storage - Classes. - - - - The source object that you are copying can be encrypted or unencrypted. If the source - object is encrypted, it can be encrypted by server-side encryption using AWS managed - encryption keys or by using a customer-provided encryption key. When copying an object, - you can request that Amazon S3 encrypt the target object by using either the AWS managed - encryption keys or by using your own encryption key. You can do this regardless of - the form of server-side encryption that was used to encrypt the source, or even if - the source object was not encrypted. For more information about server-side encryption, - see Using - Server-Side Encryption. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
    • - - x-amz-copy-source-if-match condition evaluates to true - -
    • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
  • - - Consideration 2 – If both of the x-amz-copy-source-if-none-match and - x-amz-copy-source-if-modified-since headers are present in the request - and evaluate as follows, Amazon S3 returns the 412 Precondition Failed - response code: - -
    • - - x-amz-copy-source-if-none-match condition evaluates to false - -
    • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - The copy request charge is based on the storage class and Region you specify for the - destination object. For pricing information, see Amazon - S3 Pricing. - - - - Following are other considerations when using CopyObject: - -
Versioning
- - By default, x-amz-copy-source identifies the current version of an object - to copy. (If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted.) To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - To encrypt the target object, you must provide the appropriate encryption-related - request headers. The one you use depends on whether you want to use AWS managed encryption - keys or provide your own encryption key. - -
  • - - To encrypt the target object using server-side encryption with an AWS managed encryption - key, provide the following request headers, as appropriate. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. If you want to use a customer managed AWS KMS - CMK, you must provide the x-amz-server-side-encryption-aws-kms-key-id - of the symmetric customer managed CMK. Amazon S3 only supports symmetric CMKs and - not asymmetric CMKs. For more information, see Using - Symmetric and Asymmetric Keys in the AWS Key Management Service Developer Guide. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in KMS. - -
  • - - To encrypt the target object using server-side encryption with an encryption key that - you provide, use the following headers. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
  • - - If the source object is encrypted using server-side encryption with customer-provided - encryption keys, you must use the following headers. - -
    • - - x-amz-copy-source​-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-copy-source​-server-side​-encryption​-customer-key - -
    • - - x-amz-copy-source-​server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in Amazon KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - Container for the necessary parameters to execute the CopyObject service method. - - The response from the CopyObject service method, as returned by S3. - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - for copying an object greater than 5 GB, you must use the multipart upload Upload - Part - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - Amazon S3 transfer acceleration does not support cross-region copies. If you request - a cross-region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information about transfer acceleration, see Transfer - Acceleration. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - request parameters x-amz-copy-source-if-match, x-amz-copy-source-if-none-match, - x-amz-copy-source-if-unmodified-since, or x-amz-copy-source-if-modified-since. - - - - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - You can use this operation to change the storage class of an object that is already - stored in Amazon S3 using the StorageClass parameter. For more information, - see Storage - Classes. - - - - The source object that you are copying can be encrypted or unencrypted. If the source - object is encrypted, it can be encrypted by server-side encryption using AWS managed - encryption keys or by using a customer-provided encryption key. When copying an object, - you can request that Amazon S3 encrypt the target object by using either the AWS managed - encryption keys or by using your own encryption key. You can do this regardless of - the form of server-side encryption that was used to encrypt the source, or even if - the source object was not encrypted. For more information about server-side encryption, - see Using - Server-Side Encryption. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
    • - - x-amz-copy-source-if-match condition evaluates to true - -
    • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
  • - - Consideration 2 – If both of the x-amz-copy-source-if-none-match and - x-amz-copy-source-if-modified-since headers are present in the request - and evaluate as follows, Amazon S3 returns the 412 Precondition Failed - response code: - -
    • - - x-amz-copy-source-if-none-match condition evaluates to false - -
    • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - The copy request charge is based on the storage class and Region you specify for the - destination object. For pricing information, see Amazon - S3 Pricing. - - - - Following are other considerations when using CopyObject: - -
Versioning
- - By default, x-amz-copy-source identifies the current version of an object - to copy. (If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted.) To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - To encrypt the target object, you must provide the appropriate encryption-related - request headers. The one you use depends on whether you want to use AWS managed encryption - keys or provide your own encryption key. - -
  • - - To encrypt the target object using server-side encryption with an AWS managed encryption - key, provide the following request headers, as appropriate. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. If you want to use a customer managed AWS KMS - CMK, you must provide the x-amz-server-side-encryption-aws-kms-key-id - of the symmetric customer managed CMK. Amazon S3 only supports symmetric CMKs and - not asymmetric CMKs. For more information, see Using - Symmetric and Asymmetric Keys in the AWS Key Management Service Developer Guide. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in KMS. - -
  • - - To encrypt the target object using server-side encryption with an encryption key that - you provide, use the following headers. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
  • - - If the source object is encrypted using server-side encryption with customer-provided - encryption keys, you must use the following headers. - -
    • - - x-amz-copy-source​-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-copy-source​-server-side​-encryption​-customer-key - -
    • - - x-amz-copy-source-​server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in Amazon KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - for copying an object greater than 5 GB, you must use the multipart upload Upload - Part - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - Amazon S3 transfer acceleration does not support cross-region copies. If you request - a cross-region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information about transfer acceleration, see Transfer - Acceleration. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - request parameters x-amz-copy-source-if-match, x-amz-copy-source-if-none-match, - x-amz-copy-source-if-unmodified-since, or x-amz-copy-source-if-modified-since. - - - - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - You can use this operation to change the storage class of an object that is already - stored in Amazon S3 using the StorageClass parameter. For more information, - see Storage - Classes. - - - - The source object that you are copying can be encrypted or unencrypted. If the source - object is encrypted, it can be encrypted by server-side encryption using AWS managed - encryption keys or by using a customer-provided encryption key. When copying an object, - you can request that Amazon S3 encrypt the target object by using either the AWS managed - encryption keys or by using your own encryption key. You can do this regardless of - the form of server-side encryption that was used to encrypt the source, or even if - the source object was not encrypted. For more information about server-side encryption, - see Using - Server-Side Encryption. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
    • - - x-amz-copy-source-if-match condition evaluates to true - -
    • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
  • - - Consideration 2 – If both of the x-amz-copy-source-if-none-match and - x-amz-copy-source-if-modified-since headers are present in the request - and evaluate as follows, Amazon S3 returns the 412 Precondition Failed - response code: - -
    • - - x-amz-copy-source-if-none-match condition evaluates to false - -
    • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - The copy request charge is based on the storage class and Region you specify for the - destination object. For pricing information, see Amazon - S3 Pricing. - - - - Following are other considerations when using CopyObject: - -
Versioning
- - By default, x-amz-copy-source identifies the current version of an object - to copy. (If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted.) To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - To encrypt the target object, you must provide the appropriate encryption-related - request headers. The one you use depends on whether you want to use AWS managed encryption - keys or provide your own encryption key. - -
  • - - To encrypt the target object using server-side encryption with an AWS managed encryption - key, provide the following request headers, as appropriate. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. If you want to use a customer managed AWS KMS - CMK, you must provide the x-amz-server-side-encryption-aws-kms-key-id - of the symmetric customer managed CMK. Amazon S3 only supports symmetric CMKs and - not asymmetric CMKs. For more information, see Using - Symmetric and Asymmetric Keys in the AWS Key Management Service Developer Guide. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in KMS. - -
  • - - To encrypt the target object using server-side encryption with an encryption key that - you provide, use the following headers. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
  • - - If the source object is encrypted using server-side encryption with customer-provided - encryption keys, you must use the following headers. - -
    • - - x-amz-copy-source​-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-copy-source​-server-side​-encryption​-customer-key - -
    • - - x-amz-copy-source-​server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in Amazon KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - for copying an object greater than 5 GB, you must use the multipart upload Upload - Part - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - Amazon S3 transfer acceleration does not support cross-region copies. If you request - a cross-region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information about transfer acceleration, see Transfer - Acceleration. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - request parameters x-amz-copy-source-if-match, x-amz-copy-source-if-none-match, - x-amz-copy-source-if-unmodified-since, or x-amz-copy-source-if-modified-since. - - - - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - You can use this operation to change the storage class of an object that is already - stored in Amazon S3 using the StorageClass parameter. For more information, - see Storage - Classes. - - - - The source object that you are copying can be encrypted or unencrypted. If the source - object is encrypted, it can be encrypted by server-side encryption using AWS managed - encryption keys or by using a customer-provided encryption key. When copying an object, - you can request that Amazon S3 encrypt the target object by using either the AWS managed - encryption keys or by using your own encryption key. You can do this regardless of - the form of server-side encryption that was used to encrypt the source, or even if - the source object was not encrypted. For more information about server-side encryption, - see Using - Server-Side Encryption. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
    • - - x-amz-copy-source-if-match condition evaluates to true - -
    • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
  • - - Consideration 2 – If both of the x-amz-copy-source-if-none-match and - x-amz-copy-source-if-modified-since headers are present in the request - and evaluate as follows, Amazon S3 returns the 412 Precondition Failed - response code: - -
    • - - x-amz-copy-source-if-none-match condition evaluates to false - -
    • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - The copy request charge is based on the storage class and Region you specify for the - destination object. For pricing information, see Amazon - S3 Pricing. - - - - Following are other considerations when using CopyObject: - -
Versioning
- - By default, x-amz-copy-source identifies the current version of an object - to copy. (If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted.) To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - To encrypt the target object, you must provide the appropriate encryption-related - request headers. The one you use depends on whether you want to use AWS managed encryption - keys or provide your own encryption key. - -
  • - - To encrypt the target object using server-side encryption with an AWS managed encryption - key, provide the following request headers, as appropriate. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. If you want to use a customer managed AWS KMS - CMK, you must provide the x-amz-server-side-encryption-aws-kms-key-id - of the symmetric customer managed CMK. Amazon S3 only supports symmetric CMKs and - not asymmetric CMKs. For more information, see Using - Symmetric and Asymmetric Keys in the AWS Key Management Service Developer Guide. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in KMS. - -
  • - - To encrypt the target object using server-side encryption with an encryption key that - you provide, use the following headers. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
  • - - If the source object is encrypted using server-side encryption with customer-provided - encryption keys, you must use the following headers. - -
    • - - x-amz-copy-source​-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-copy-source​-server-side​-encryption​-customer-key - -
    • - - x-amz-copy-source-​server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in Amazon KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - Container for the necessary parameters to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - - - - - - - - - - - - - - Deletes an analytics configuration for the bucket (specified by the analytics configuration - ID). - - - - To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to DeleteBucketAnalyticsConfiguration: - -
  • - - - -
  • - - - -
  • - - - -
- - Container for the necessary parameters to execute the DeleteBucketAnalyticsConfiguration service method. - - The response from the DeleteBucketAnalyticsConfiguration service method, as returned by S3. - - - - Deletes an analytics configuration for the bucket (specified by the analytics configuration - ID). - - - - To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to DeleteBucketAnalyticsConfiguration: - -
  • - - - -
  • - - - -
  • - - - -
- - Container for the necessary parameters to execute the DeleteBucketAnalyticsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketAnalyticsConfiguration service method, as returned by S3. - - - - - - Deletes an inventory configuration (identified by the inventory ID) from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - Operations related to DeleteBucketInventoryConfiguration include: - - - - Container for the necessary parameters to execute the DeleteBucketInventoryConfiguration service method. - - The response from the DeleteBucketInventoryConfiguration service method, as returned by S3. - - - - Deletes an inventory configuration (identified by the inventory ID) from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - Operations related to DeleteBucketInventoryConfiguration include: - - - - Container for the necessary parameters to execute the DeleteBucketInventoryConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketInventoryConfiguration service method, as returned by S3. - - - - Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified - by the metrics configuration ID) from the bucket. Note that this doesn't include the - daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteBucketMetricsConfiguration service method. - - The response from the DeleteBucketMetricsConfiguration service method, as returned by S3. - - - - Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified - by the metrics configuration ID) from the bucket. Note that this doesn't include the - daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketMetricsConfiguration service method, as returned by S3. - - - - This implementation of the DELETE operation uses the policy subresource to delete - the policy of a specified bucket. If you are using an identity other than the root - user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - The bucket name. - - The response from the DeleteBucketPolicy service method, as returned by S3. - - - - This implementation of the DELETE operation uses the policy subresource to delete - the policy of a specified bucket. If you are using an identity other than the root - user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - Container for the necessary parameters to execute the DeleteBucketPolicy service method. - - The response from the DeleteBucketPolicy service method, as returned by S3. - - - - This implementation of the DELETE operation uses the policy subresource to delete - the policy of a specified bucket. If you are using an identity other than the root - user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - The bucket name. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketPolicy service method, as returned by S3. - - - - This implementation of the DELETE operation uses the policy subresource to delete - the policy of a specified bucket. If you are using an identity other than the root - user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - Container for the necessary parameters to execute the DeleteBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketPolicy service method, as returned by S3. - - - - Deletes the replication configuration from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutReplicationConfiguration - action. The bucket owner has these permissions by default and can grant it to others. - For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - It can take a while for the deletion of a replication configuration to fully propagate. - - - - For information about replication configuration, see Replication - in the Amazon S3 Developer Guide. - - - - The following operations are related to DeleteBucketReplication: - - - - Container for the necessary parameters to execute the DeleteBucketReplication service method. - - The response from the DeleteBucketReplication service method, as returned by S3. - - - - Deletes the replication configuration from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutReplicationConfiguration - action. The bucket owner has these permissions by default and can grant it to others. - For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - It can take a while for the deletion of a replication configuration to fully propagate. - - - - For information about replication configuration, see Replication - in the Amazon S3 Developer Guide. - - - - The following operations are related to DeleteBucketReplication: - - - - Container for the necessary parameters to execute the DeleteBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketReplication service method, as returned by S3. - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - The bucket that has the tag set to be removed. - - The response from the DeleteBucketTagging service method, as returned by S3. - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - Container for the necessary parameters to execute the DeleteBucketTagging service method. - - The response from the DeleteBucketTagging service method, as returned by S3. - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - The bucket that has the tag set to be removed. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketTagging service method, as returned by S3. - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - Container for the necessary parameters to execute the DeleteBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketTagging service method, as returned by S3. - - - - This operation removes the website configuration for a bucket. Amazon S3 returns a - 200 OK response upon successfully deleting a website configuration on - the specified bucket. You will get a 200 OK response if the website configuration - you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE operation requires the S3:DeleteBucketWebsite permission. - By default, only the bucket owner can delete the website configuration attached to - a bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which you want to remove the website configuration. - - The response from the DeleteBucketWebsite service method, as returned by S3. - - - - This operation removes the website configuration for a bucket. Amazon S3 returns a - 200 OK response upon successfully deleting a website configuration on - the specified bucket. You will get a 200 OK response if the website configuration - you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE operation requires the S3:DeleteBucketWebsite permission. - By default, only the bucket owner can delete the website configuration attached to - a bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the DeleteBucketWebsite service method. - - The response from the DeleteBucketWebsite service method, as returned by S3. - - - - This operation removes the website configuration for a bucket. Amazon S3 returns a - 200 OK response upon successfully deleting a website configuration on - the specified bucket. You will get a 200 OK response if the website configuration - you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE operation requires the S3:DeleteBucketWebsite permission. - By default, only the bucket owner can delete the website configuration attached to - a bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which you want to remove the website configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketWebsite service method, as returned by S3. - - - - This operation removes the website configuration for a bucket. Amazon S3 returns a - 200 OK response upon successfully deleting a website configuration on - the specified bucket. You will get a 200 OK response if the website configuration - you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE operation requires the S3:DeleteBucketWebsite permission. - By default, only the bucket owner can delete the website configuration attached to - a bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the DeleteBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketWebsite service method, as returned by S3. - - - - - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - The bucket name of the lifecycle to delete. - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - Container for the necessary parameters to execute the DeleteLifecycleConfiguration service method. - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - The bucket name of the lifecycle to delete. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - Container for the necessary parameters to execute the DeleteLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key name of the object to delete. - - The response from the DeleteObject service method, as returned by S3. - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key name of the object to delete. - VersionId used to reference a specific version of the object. - - The response from the DeleteObject service method, as returned by S3. - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - Container for the necessary parameters to execute the DeleteObject service method. - - The response from the DeleteObject service method, as returned by S3. - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key name of the object to delete. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key name of the object to delete. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - Container for the necessary parameters to execute the DeleteObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - - - - This operation enables you to delete multiple objects from a bucket using a single - HTTP request. If you know the object keys that you want to delete, then this operation - provides a suitable alternative to sending individual delete requests, reducing per-request - overhead. - - - - The request contains a list of up to 1000 keys that you want to delete. In the XML, - you provide the object key names, and optionally, version IDs if you want to delete - a specific version of the object from a versioning-enabled bucket. For each key, Amazon - S3 performs a delete operation and returns the result of that delete, success, or - failure, in the response. Note that if the object specified in the request is not - found, Amazon S3 returns the result as deleted. - - - - The operation supports two modes for the response: verbose and quiet. By default, - the operation uses verbose mode in which the response includes the result of deletion - of each key in your request. In quiet mode the response includes only keys where the - delete operation encountered an error. For a successful deletion, the operation does - not return any information about the delete in the response body. - - - - When performing this operation on an MFA Delete enabled bucket, that attempts to delete - any versioned objects, you must include an MFA token. If you do not provide one, the - entire request will fail, even if there are non-versioned objects you are trying to - delete. If you provide an invalid token, whether there are versioned keys in the request - or not, the entire Multi-Object Delete request will fail. For information about MFA - Delete, see - MFA Delete. - - - - Finally, the Content-MD5 header is required for all Multi-Object Delete requests. - Amazon S3 uses the header value to ensure that your request body has not been altered - in transit. - - - - The following operations are related to DeleteObjects: - - - - Container for the necessary parameters to execute the DeleteObjects service method. - - The response from the DeleteObjects service method, as returned by S3. - - - - This operation enables you to delete multiple objects from a bucket using a single - HTTP request. If you know the object keys that you want to delete, then this operation - provides a suitable alternative to sending individual delete requests, reducing per-request - overhead. - - - - The request contains a list of up to 1000 keys that you want to delete. In the XML, - you provide the object key names, and optionally, version IDs if you want to delete - a specific version of the object from a versioning-enabled bucket. For each key, Amazon - S3 performs a delete operation and returns the result of that delete, success, or - failure, in the response. Note that if the object specified in the request is not - found, Amazon S3 returns the result as deleted. - - - - The operation supports two modes for the response: verbose and quiet. By default, - the operation uses verbose mode in which the response includes the result of deletion - of each key in your request. In quiet mode the response includes only keys where the - delete operation encountered an error. For a successful deletion, the operation does - not return any information about the delete in the response body. - - - - When performing this operation on an MFA Delete enabled bucket, that attempts to delete - any versioned objects, you must include an MFA token. If you do not provide one, the - entire request will fail, even if there are non-versioned objects you are trying to - delete. If you provide an invalid token, whether there are versioned keys in the request - or not, the entire Multi-Object Delete request will fail. For information about MFA - Delete, see - MFA Delete. - - - - Finally, the Content-MD5 header is required for all Multi-Object Delete requests. - Amazon S3 uses the header value to ensure that your request body has not been altered - in transit. - - - - The following operations are related to DeleteObjects: - - - - Container for the necessary parameters to execute the DeleteObjects service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObjects service method, as returned by S3. - - - - Removes the entire tag set from the specified object. For more information about managing - object tags, see - Object Tagging. - - - - To use this operation, you must have permission to perform the s3:DeleteObjectTagging - action. - - - - To delete tags of a specific object version, add the versionId query - parameter in the request. You will need permission for the s3:DeleteObjectVersionTagging - action. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteObjectTagging service method. - - The response from the DeleteObjectTagging service method, as returned by S3. - - - - Removes the entire tag set from the specified object. For more information about managing - object tags, see - Object Tagging. - - - - To use this operation, you must have permission to perform the s3:DeleteObjectTagging - action. - - - - To delete tags of a specific object version, add the versionId query - parameter in the request. You will need permission for the s3:DeleteObjectVersionTagging - action. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteObjectTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObjectTagging service method, as returned by S3. - - - - Removes the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:PutBucketPublicAccessBlock - permission. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeletePublicAccessBlock service method. - - The response from the DeletePublicAccessBlock service method, as returned by S3. - - - - Removes the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:PutBucketPublicAccessBlock - permission. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeletePublicAccessBlock service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeletePublicAccessBlock service method, as returned by S3. - - - - - - - - - - - - - - Returns the default encryption configuration for an Amazon S3 bucket. For information - about the Amazon S3 default encryption feature, see Amazon - S3 Default Bucket Encryption. - - - - To use this operation, you must have permission to perform the s3:GetEncryptionConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to GetBucketEncryption: - - - - Container for the necessary parameters to execute the GetBucketEncryption service method. - - The response from the GetBucketEncryption service method, as returned by S3. - - - - Returns the default encryption configuration for an Amazon S3 bucket. For information - about the Amazon S3 default encryption feature, see Amazon - S3 Default Bucket Encryption. - - - - To use this operation, you must have permission to perform the s3:GetEncryptionConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to GetBucketEncryption: - - - - Container for the necessary parameters to execute the GetBucketEncryption service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketEncryption service method, as returned by S3. - - - - Returns an inventory configuration (identified by the inventory configuration ID) - from the bucket. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - The following operations are related to GetBucketInventoryConfiguration: - - - - Container for the necessary parameters to execute the GetBucketInventoryConfiguration service method. - - The response from the GetBucketInventoryConfiguration service method, as returned by S3. - - - - Returns an inventory configuration (identified by the inventory configuration ID) - from the bucket. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - The following operations are related to GetBucketInventoryConfiguration: - - - - Container for the necessary parameters to execute the GetBucketInventoryConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketInventoryConfiguration service method, as returned by S3. - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - The name of the bucket for which to get the location. - - The response from the GetBucketLocation service method, as returned by S3. - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - Container for the necessary parameters to execute the GetBucketLocation service method. - - The response from the GetBucketLocation service method, as returned by S3. - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - The name of the bucket for which to get the location. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLocation service method, as returned by S3. - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - Container for the necessary parameters to execute the GetBucketLocation service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLocation service method, as returned by S3. - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - The bucket name for which to get the logging information. - - The response from the GetBucketLogging service method, as returned by S3. - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - Container for the necessary parameters to execute the GetBucketLogging service method. - - The response from the GetBucketLogging service method, as returned by S3. - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - The bucket name for which to get the logging information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLogging service method, as returned by S3. - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - Container for the necessary parameters to execute the GetBucketLogging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLogging service method, as returned by S3. - - - - Gets a metrics configuration (specified by the metrics configuration ID) from the - bucket. Note that this doesn't include the daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to GetBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the GetBucketMetricsConfiguration service method. - - The response from the GetBucketMetricsConfiguration service method, as returned by S3. - - - - Gets a metrics configuration (specified by the metrics configuration ID) from the - bucket. Note that this doesn't include the daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to GetBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the GetBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketMetricsConfiguration service method, as returned by S3. - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following operation is related to GetBucketNotification: - - - - Name of the bucket for which to get the notification configuration - - The response from the GetBucketNotification service method, as returned by S3. - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following operation is related to GetBucketNotification: - - - - Container for the necessary parameters to execute the GetBucketNotification service method. - - The response from the GetBucketNotification service method, as returned by S3. - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following operation is related to GetBucketNotification: - - - - Name of the bucket for which to get the notification configuration - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketNotification service method, as returned by S3. - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following operation is related to GetBucketNotification: - - - - Container for the necessary parameters to execute the GetBucketNotification service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketNotification service method, as returned by S3. - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operation is related to GetBucketPolicy: - - - - The bucket name for which to get the bucket policy. - - The response from the GetBucketPolicy service method, as returned by S3. - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operation is related to GetBucketPolicy: - - - - Container for the necessary parameters to execute the GetBucketPolicy service method. - - The response from the GetBucketPolicy service method, as returned by S3. - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operation is related to GetBucketPolicy: - - - - The bucket name for which to get the bucket policy. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicy service method, as returned by S3. - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operation is related to GetBucketPolicy: - - - - Container for the necessary parameters to execute the GetBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicy service method, as returned by S3. - - - - Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket - is public. In order to use this operation, you must have the s3:GetBucketPolicyStatus - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - For more information about when Amazon S3 considers a bucket public, see The - Meaning of "Public". - - - - The following operations are related to GetBucketPolicyStatus: - - - - Container for the necessary parameters to execute the GetBucketPolicyStatus service method. - - The response from the GetBucketPolicyStatus service method, as returned by S3. - - - - Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket - is public. In order to use this operation, you must have the s3:GetBucketPolicyStatus - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - For more information about when Amazon S3 considers a bucket public, see The - Meaning of "Public". - - - - The following operations are related to GetBucketPolicyStatus: - - - - Container for the necessary parameters to execute the GetBucketPolicyStatus service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicyStatus service method, as returned by S3. - - - - Retrieves the replication configuration for the given Amazon S3 bucket. - - Container for the necessary parameters to execute the GetBucketReplication service method. - - The response from the GetBucketReplication service method, as returned by S3. - - - - Retrieves the replication configuration for the given Amazon S3 bucket. - - Container for the necessary parameters to execute the GetBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketReplication service method, as returned by S3. - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - The name of the bucket for which to get the payment request configuration - - The response from the GetBucketRequestPayment service method, as returned by S3. - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - Container for the necessary parameters to execute the GetBucketRequestPayment service method. - - The response from the GetBucketRequestPayment service method, as returned by S3. - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - The name of the bucket for which to get the payment request configuration - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketRequestPayment service method, as returned by S3. - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - Container for the necessary parameters to execute the GetBucketRequestPayment service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketRequestPayment service method, as returned by S3. - - - - Returns the tag set associated with the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - GetBucketTagging has the following special error: - -
  • - - Error code: NoSuchTagSetError - -
    • - - Description: There is no tag set associated with the bucket. - -
- - The following operations are related to GetBucketTagging: - - - - Container for the necessary parameters to execute the GetBucketTagging service method. - - The response from the GetBucketTagging service method, as returned by S3. - - - - Returns the tag set associated with the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - GetBucketTagging has the following special error: - -
  • - - Error code: NoSuchTagSetError - -
    • - - Description: There is no tag set associated with the bucket. - -
- - The following operations are related to GetBucketTagging: - - - - Container for the necessary parameters to execute the GetBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketTagging service method, as returned by S3. - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - The name of the bucket for which to get the versioning information. - - The response from the GetBucketVersioning service method, as returned by S3. - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - Container for the necessary parameters to execute the GetBucketVersioning service method. - - The response from the GetBucketVersioning service method, as returned by S3. - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - The name of the bucket for which to get the versioning information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketVersioning service method, as returned by S3. - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - Container for the necessary parameters to execute the GetBucketVersioning service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketVersioning service method, as returned by S3. - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET operation requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which to get the website configuration. - - The response from the GetBucketWebsite service method, as returned by S3. - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET operation requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the GetBucketWebsite service method. - - The response from the GetBucketWebsite service method, as returned by S3. - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET operation requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which to get the website configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketWebsite service method, as returned by S3. - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET operation requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the GetBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketWebsite service method, as returned by S3. - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - The bucket name for which to get the cors configuration. - - The response from the GetCORSConfiguration service method, as returned by S3. - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - Container for the necessary parameters to execute the GetCORSConfiguration service method. - - The response from the GetCORSConfiguration service method, as returned by S3. - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - The bucket name for which to get the cors configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetCORSConfiguration service method, as returned by S3. - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - Container for the necessary parameters to execute the GetCORSConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetCORSConfiguration service method, as returned by S3. - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are still using previous version of the lifecycle configuration, it works. - For the earlier API description, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to DeleteBucketMetricsConfiguration: - - - - The name of the bucket for which to get the lifecycle information. - - The response from the GetLifecycleConfiguration service method, as returned by S3. - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are still using previous version of the lifecycle configuration, it works. - For the earlier API description, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the GetLifecycleConfiguration service method. - - The response from the GetLifecycleConfiguration service method, as returned by S3. - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are still using previous version of the lifecycle configuration, it works. - For the earlier API description, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to DeleteBucketMetricsConfiguration: - - - - The name of the bucket for which to get the lifecycle information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetLifecycleConfiguration service method, as returned by S3. - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are still using previous version of the lifecycle configuration, it works. - For the earlier API description, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the GetLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetLifecycleConfiguration service method, as returned by S3. - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object to get. - - The response from the GetObject service method, as returned by S3. - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object to get. - VersionId used to reference a specific version of the object. - - The response from the GetObject service method, as returned by S3. - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - Container for the necessary parameters to execute the GetObject service method. - - The response from the GetObject service method, as returned by S3. - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object to get. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object to get. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - Container for the necessary parameters to execute the GetObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - - - - Gets an object's current Legal Hold status. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLegalHold service method. - - The response from the GetObjectLegalHold service method, as returned by S3. - - - - Gets an object's current Legal Hold status. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLegalHold service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectLegalHold service method, as returned by S3. - - - - Gets the Object Lock configuration for a bucket. The rule specified in the Object - Lock configuration will be applied by default to every new object placed in the specified - bucket. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLockConfiguration service method. - - The response from the GetObjectLockConfiguration service method, as returned by S3. - - - - Gets the Object Lock configuration for a bucket. The rule specified in the Object - Lock configuration will be applied by default to every new object placed in the specified - bucket. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLockConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectLockConfiguration service method, as returned by S3. - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - The name of the bucket containing the object. - The object key. - - The response from the GetObjectMetadata service method, as returned by S3. - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - The name of the bucket containing the object. - The object key. - VersionId used to reference a specific version of the object. - - The response from the GetObjectMetadata service method, as returned by S3. - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - Container for the necessary parameters to execute the GetObjectMetadata service method. - - The response from the GetObjectMetadata service method, as returned by S3. - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - The name of the bucket containing the object. - The object key. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - The name of the bucket containing the object. - The object key. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - Container for the necessary parameters to execute the GetObjectMetadata service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - - - - Retrieves an object's retention settings. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectRetention service method. - - The response from the GetObjectRetention service method, as returned by S3. - - - - Retrieves an object's retention settings. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectRetention service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectRetention service method, as returned by S3. - - - - Returns the tag-set of an object. You send the GET request against the tagging subresource - associated with the object. - - - - To use this operation, you must have permission to perform the s3:GetObjectTagging - action. By default, the GET operation returns information about current version of - an object. For a versioned bucket, you can have multiple versions of an object in - your bucket. To retrieve tags of any other version, use the versionId query parameter. - You also need permission for the s3:GetObjectVersionTagging action. - - - - By default, the bucket owner has this permission and can grant this permission to - others. - - - - For information about the Amazon S3 object tagging feature, see Object - Tagging. - - - - The following operation is related to GetObjectTagging: - - - - Container for the necessary parameters to execute the GetObjectTagging service method. - - The response from the GetObjectTagging service method, as returned by S3. - - - - Returns the tag-set of an object. You send the GET request against the tagging subresource - associated with the object. - - - - To use this operation, you must have permission to perform the s3:GetObjectTagging - action. By default, the GET operation returns information about current version of - an object. For a versioned bucket, you can have multiple versions of an object in - your bucket. To retrieve tags of any other version, use the versionId query parameter. - You also need permission for the s3:GetObjectVersionTagging action. - - - - By default, the bucket owner has this permission and can grant this permission to - others. - - - - For information about the Amazon S3 object tagging feature, see Object - Tagging. - - - - The following operation is related to GetObjectTagging: - - - - Container for the necessary parameters to execute the GetObjectTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTagging service method, as returned by S3. - - - - Return torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Amazon - S3 Torrent. - - - - You can get torrent only for objects that are less than 5 GB in size and that are - not encrypted using server-side encryption with customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - The following operation is related to GetObjectTorrent: - - - - The name of the bucket containing the object for which to get the torrent files. - The object key for which to get the information. - - The response from the GetObjectTorrent service method, as returned by S3. - - - - Return torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Amazon - S3 Torrent. - - - - You can get torrent only for objects that are less than 5 GB in size and that are - not encrypted using server-side encryption with customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - The following operation is related to GetObjectTorrent: - - - - Container for the necessary parameters to execute the GetObjectTorrent service method. - - The response from the GetObjectTorrent service method, as returned by S3. - - - - Return torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Amazon - S3 Torrent. - - - - You can get torrent only for objects that are less than 5 GB in size and that are - not encrypted using server-side encryption with customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - The following operation is related to GetObjectTorrent: - - - - The name of the bucket containing the object for which to get the torrent files. - The object key for which to get the information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTorrent service method, as returned by S3. - - - - Return torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Amazon - S3 Torrent. - - - - You can get torrent only for objects that are less than 5 GB in size and that are - not encrypted using server-side encryption with customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - The following operation is related to GetObjectTorrent: - - - - Container for the necessary parameters to execute the GetObjectTorrent service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTorrent service method, as returned by S3. - - - - Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:GetBucketPublicAccessBlock - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket - or an object, it checks the PublicAccessBlock configuration for both - the bucket (or the bucket that contains the object) and the bucket owner's account. - If the PublicAccessBlock settings are different between the bucket and - the account, Amazon S3 uses the most restrictive combination of the bucket-level and - account-level settings. - - - - For more information about when Amazon S3 considers a bucket or an object public, - see The - Meaning of "Public". - - - - The following operations are related to GetPublicAccessBlock: - - - - Container for the necessary parameters to execute the GetPublicAccessBlock service method. - - The response from the GetPublicAccessBlock service method, as returned by S3. - - - - Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:GetBucketPublicAccessBlock - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket - or an object, it checks the PublicAccessBlock configuration for both - the bucket (or the bucket that contains the object) and the bucket owner's account. - If the PublicAccessBlock settings are different between the bucket and - the account, Amazon S3 uses the most restrictive combination of the bucket-level and - account-level settings. - - - - For more information about when Amazon S3 considers a bucket or an object public, - see The - Meaning of "Public". - - - - The following operations are related to GetPublicAccessBlock: - - - - Container for the necessary parameters to execute the GetPublicAccessBlock service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetPublicAccessBlock service method, as returned by S3. - - - - This operation is useful to determine if a bucket exists and you have permission to - access it. The operation returns a 200 OK if the bucket exists and you - have permission to access it. Otherwise, the operation might return responses such - as 404 Not Found and 403 Forbidden. - - - - To use this operation, you must have permissions to perform the s3:ListBucket - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - Container for the necessary parameters to execute the HeadBucket service method. - - The response from the HeadBucket service method, as returned by S3. - - - - This operation is useful to determine if a bucket exists and you have permission to - access it. The operation returns a 200 OK if the bucket exists and you - have permission to access it. Otherwise, the operation might return responses such - as 404 Not Found and 403 Forbidden. - - - - To use this operation, you must have permissions to perform the s3:ListBucket - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - Container for the necessary parameters to execute the HeadBucket service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the HeadBucket service method, as returned by S3. - - - - This operation initiates a multipart upload and returns an upload ID. This upload - ID is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort operation - and Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload API and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart) and UploadPartCopy) requests must match the headers you - used in the request to initiate the upload by using CreateMultipartUpload. - - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, - kms:GenerateDataKey*, and kms:DescribeKey actions on the - key. These permissions are required because Amazon S3 must decrypt and read data from - the encrypted file parts before it completes the multipart upload. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - The following operations are related to CreateMultipartUpload: - - - - The name of the bucket to which to initiate the upload - Object key for which the multipart upload is to be initiated. - - The response from the InitiateMultipartUpload service method, as returned by S3. - - - - This operation initiates a multipart upload and returns an upload ID. This upload - ID is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort operation - and Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload API and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart) and UploadPartCopy) requests must match the headers you - used in the request to initiate the upload by using CreateMultipartUpload. - - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, - kms:GenerateDataKey*, and kms:DescribeKey actions on the - key. These permissions are required because Amazon S3 must decrypt and read data from - the encrypted file parts before it completes the multipart upload. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - The following operations are related to CreateMultipartUpload: - - - - Container for the necessary parameters to execute the InitiateMultipartUpload service method. - - The response from the InitiateMultipartUpload service method, as returned by S3. - - - - This operation initiates a multipart upload and returns an upload ID. This upload - ID is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort operation - and Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload API and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart) and UploadPartCopy) requests must match the headers you - used in the request to initiate the upload by using CreateMultipartUpload. - - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, - kms:GenerateDataKey*, and kms:DescribeKey actions on the - key. These permissions are required because Amazon S3 must decrypt and read data from - the encrypted file parts before it completes the multipart upload. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - The following operations are related to CreateMultipartUpload: - - - - The name of the bucket to which to initiate the upload - Object key for which the multipart upload is to be initiated. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the InitiateMultipartUpload service method, as returned by S3. - - - - This operation initiates a multipart upload and returns an upload ID. This upload - ID is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort operation - and Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload API and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart) and UploadPartCopy) requests must match the headers you - used in the request to initiate the upload by using CreateMultipartUpload. - - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, - kms:GenerateDataKey*, and kms:DescribeKey actions on the - key. These permissions are required because Amazon S3 must decrypt and read data from - the encrypted file parts before it completes the multipart upload. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - The following operations are related to CreateMultipartUpload: - - - - Container for the necessary parameters to execute the InitiateMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the InitiateMultipartUpload service method, as returned by S3. - - - - Lists the analytics configurations for the bucket. You can have up to 1,000 analytics - configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. You should always check the IsTruncated element in the response. - If there are no more configurations to list, IsTruncated is set to false. - If there are more configurations to list, IsTruncated is set to true, - and there will be a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to ListBucketAnalyticsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketAnalyticsConfigurations service method. - - The response from the ListBucketAnalyticsConfigurations service method, as returned by S3. - - - - Lists the analytics configurations for the bucket. You can have up to 1,000 analytics - configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. You should always check the IsTruncated element in the response. - If there are no more configurations to list, IsTruncated is set to false. - If there are more configurations to list, IsTruncated is set to true, - and there will be a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to ListBucketAnalyticsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketAnalyticsConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketAnalyticsConfigurations service method, as returned by S3. - - - - Returns a list of inventory configurations for the bucket. You can have up to 1,000 - analytics configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory - - - - The following operations are related to ListBucketInventoryConfigurations: - - - - Container for the necessary parameters to execute the ListBucketInventoryConfigurations service method. - - The response from the ListBucketInventoryConfigurations service method, as returned by S3. - - - - Returns a list of inventory configurations for the bucket. You can have up to 1,000 - analytics configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory - - - - The following operations are related to ListBucketInventoryConfigurations: - - - - Container for the necessary parameters to execute the ListBucketInventoryConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketInventoryConfigurations service method, as returned by S3. - - - - Lists the metrics configurations for the bucket. The metrics configurations are only - for the request metrics of the bucket and do not provide information on daily storage - metrics. You can have up to 1,000 configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For more information about metrics configurations and CloudWatch request metrics, - see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to ListBucketMetricsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketMetricsConfigurations service method. - - The response from the ListBucketMetricsConfigurations service method, as returned by S3. - - - - Lists the metrics configurations for the bucket. The metrics configurations are only - for the request metrics of the bucket and do not provide information on daily storage - metrics. You can have up to 1,000 configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For more information about metrics configurations and CloudWatch request metrics, - see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to ListBucketMetricsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketMetricsConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketMetricsConfigurations service method, as returned by S3. - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - - The response from the ListBuckets service method, as returned by S3. - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - Container for the necessary parameters to execute the ListBuckets service method. - - The response from the ListBuckets service method, as returned by S3. - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBuckets service method, as returned by S3. - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - Container for the necessary parameters to execute the ListBuckets service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBuckets service method, as returned by S3. - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - - The response from the ListMultipartUploads service method, as returned by S3. - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) - - The response from the ListMultipartUploads service method, as returned by S3. - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Container for the necessary parameters to execute the ListMultipartUploads service method. - - The response from the ListMultipartUploads service method, as returned by S3. - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Container for the necessary parameters to execute the ListMultipartUploads service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. - - The response from the ListObjects service method, as returned by S3. - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. - Limits the response to keys that begin with the specified prefix. - - The response from the ListObjects service method, as returned by S3. - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - Container for the necessary parameters to execute the ListObjects service method. - - The response from the ListObjects service method, as returned by S3. - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. - Limits the response to keys that begin with the specified prefix. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - Container for the necessary parameters to execute the ListObjects service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Make sure to design - your application to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - To use this operation in an AWS Identity and Access Management (IAM) policy, you must - have permissions to perform the s3:ListBucket action. The bucket owner - has this permission by default and can grant this permission to others. For more information - about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - This section describes the latest revision of the API. We recommend that you use this - revised API for application development. For backward compatibility, Amazon S3 continues - to support the prior version of this API, ListObjects. - - - - To get a list of your buckets, see ListBuckets. - - - - The following operations are related to ListObjectsV2: - - - - Container for the necessary parameters to execute the ListObjectsV2 service method. - - The response from the ListObjectsV2 service method, as returned by S3. - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Make sure to design - your application to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - To use this operation in an AWS Identity and Access Management (IAM) policy, you must - have permissions to perform the s3:ListBucket action. The bucket owner - has this permission by default and can grant this permission to others. For more information - about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - This section describes the latest revision of the API. We recommend that you use this - revised API for application development. For backward compatibility, Amazon S3 continues - to support the prior version of this API, ListObjects. - - - - To get a list of your buckets, see ListBuckets. - - - - The following operations are related to ListObjectsV2: - - - - Container for the necessary parameters to execute the ListObjectsV2 service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjectsV2 service method, as returned by S3. - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). This request returns a maximum of 1,000 - uploaded parts. The default number of parts returned is 1,000 parts. You can restrict - the number of parts returned by specifying the max-parts request parameter. - If your multipart upload consists of more than 1,000 parts, the response returns an - IsTruncated field with the value of true, and a NextPartNumberMarker - element. In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListParts: - - - - Name of the bucket to which the parts are being uploaded. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Object key for which the multipart upload was initiated. - Upload ID identifying the multipart upload whose parts are being listed. - - The response from the ListParts service method, as returned by S3. - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). This request returns a maximum of 1,000 - uploaded parts. The default number of parts returned is 1,000 parts. You can restrict - the number of parts returned by specifying the max-parts request parameter. - If your multipart upload consists of more than 1,000 parts, the response returns an - IsTruncated field with the value of true, and a NextPartNumberMarker - element. In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListParts: - - - - Container for the necessary parameters to execute the ListParts service method. - - The response from the ListParts service method, as returned by S3. - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). This request returns a maximum of 1,000 - uploaded parts. The default number of parts returned is 1,000 parts. You can restrict - the number of parts returned by specifying the max-parts request parameter. - If your multipart upload consists of more than 1,000 parts, the response returns an - IsTruncated field with the value of true, and a NextPartNumberMarker - element. In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListParts: - - - - Name of the bucket to which the parts are being uploaded. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Object key for which the multipart upload was initiated. - Upload ID identifying the multipart upload whose parts are being listed. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListParts service method, as returned by S3. - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). This request returns a maximum of 1,000 - uploaded parts. The default number of parts returned is 1,000 parts. You can restrict - the number of parts returned by specifying the max-parts request parameter. - If your multipart upload consists of more than 1,000 parts, the response returns an - IsTruncated field with the value of true, and a NextPartNumberMarker - element. In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListParts: - - - - Container for the necessary parameters to execute the ListParts service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListParts service method, as returned by S3. - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - - The response from the ListVersions service method, as returned by S3. - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes. - - The response from the ListVersions service method, as returned by S3. - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - Container for the necessary parameters to execute the ListVersions service method. - - The response from the ListVersions service method, as returned by S3. - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - Container for the necessary parameters to execute the ListVersions service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - - - - - - Creates a new bucket. To create a bucket, you must register with Amazon S3 and have - a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed - to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information on bucket naming restrictions, - see Working - with Amazon S3 Buckets. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the EU (Ireland) - Region. For more information, see How - to Select a Region for Your Buckets. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - Hosting of Buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - The name of the bucket to create. - - The response from the PutBucket service method, as returned by S3. - - - - Creates a new bucket. To create a bucket, you must register with Amazon S3 and have - a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed - to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information on bucket naming restrictions, - see Working - with Amazon S3 Buckets. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the EU (Ireland) - Region. For more information, see How - to Select a Region for Your Buckets. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - Hosting of Buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - Container for the necessary parameters to execute the PutBucket service method. - - The response from the PutBucket service method, as returned by S3. - - - - Creates a new bucket. To create a bucket, you must register with Amazon S3 and have - a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed - to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information on bucket naming restrictions, - see Working - with Amazon S3 Buckets. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the EU (Ireland) - Region. For more information, see How - to Select a Region for Your Buckets. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - Hosting of Buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - The name of the bucket to create. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucket service method, as returned by S3. - - - - Creates a new bucket. To create a bucket, you must register with Amazon S3 and have - a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed - to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information on bucket naming restrictions, - see Working - with Amazon S3 Buckets. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the EU (Ireland) - Region. For more information, see How - to Select a Region for Your Buckets. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - Hosting of Buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - Container for the necessary parameters to execute the PutBucket service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucket service method, as returned by S3. - - - - Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration - is a bucket-level feature that enables you to perform faster data transfers to Amazon - S3. - - - - To use this operation, you must have permission to perform the s3:PutAccelerateConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The Transfer Acceleration state of a bucket can be set to one of the following two - values: - -
  • - - Enabled – Enables accelerated data transfers to the bucket. - -
  • - - Suspended – Disables accelerated data transfers to the bucket. - -
- - The GetBucketAccelerateConfiguration operation returns the transfer acceleration - state of a bucket. - - - - After setting the Transfer Acceleration state of a bucket to Enabled, it might take - up to thirty minutes before the data transfer rates to the bucket increase. - - - - The name of the bucket used for Transfer Acceleration must be DNS-compliant and must - not contain periods ("."). - - - - For more information about transfer acceleration, see Transfer - Acceleration. - - - - The following operations are related to PutBucketAccelerateConfiguration: - - - - Container for the necessary parameters to execute the PutBucketAccelerateConfiguration service method. - - The response from the PutBucketAccelerateConfiguration service method, as returned by S3. - - - - Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration - is a bucket-level feature that enables you to perform faster data transfers to Amazon - S3. - - - - To use this operation, you must have permission to perform the s3:PutAccelerateConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The Transfer Acceleration state of a bucket can be set to one of the following two - values: - -
  • - - Enabled – Enables accelerated data transfers to the bucket. - -
  • - - Suspended – Disables accelerated data transfers to the bucket. - -
- - The GetBucketAccelerateConfiguration operation returns the transfer acceleration - state of a bucket. - - - - After setting the Transfer Acceleration state of a bucket to Enabled, it might take - up to thirty minutes before the data transfer rates to the bucket increase. - - - - The name of the bucket used for Transfer Acceleration must be DNS-compliant and must - not contain periods ("."). - - - - For more information about transfer acceleration, see Transfer - Acceleration. - - - - The following operations are related to PutBucketAccelerateConfiguration: - - - - Container for the necessary parameters to execute the PutBucketAccelerateConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketAccelerateConfiguration service method, as returned by S3. - - - - - - - - - - Set the logging parameters for a bucket and to specify permissions for who can view - and modify the logging parameters. All logs are saved to buckets in the same AWS Region - as the source bucket. To set the logging status of a bucket, you must be the bucket - owner. - - - - The bucket owner is automatically granted FULL_CONTROL to all logs. You use the Grantee - request element to grant access to other people. The Permissions request - element specifies the kind of access the grantee has to the logs. - - - - Grantee Values - - - - You can specify the person (grantee) to whom you're assigning access rights (using - request elements) in the following ways: - -
  • - - By the person's ID: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> - </Grantee> - - - - DisplayName is optional and ignored in the request. - -
  • - - By Email address: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee> - - - - - The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl - request, appears as the CanonicalUser. - -
  • - - By URI: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee> - - -
- - To enable logging, you use LoggingEnabled and its children request elements. To disable - logging, you use an empty BucketLoggingStatus request element: - - - - <BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01" /> - - - - - For more information about server access logging, see Server - Access Logging. - - - - For more information about creating a bucket, see CreateBucket. For more information - about returning the logging status of a bucket, see GetBucketLogging. - - - - The following operations are related to PutBucketLogging: - - - - Container for the necessary parameters to execute the PutBucketLogging service method. - - The response from the PutBucketLogging service method, as returned by S3. - - - - Set the logging parameters for a bucket and to specify permissions for who can view - and modify the logging parameters. All logs are saved to buckets in the same AWS Region - as the source bucket. To set the logging status of a bucket, you must be the bucket - owner. - - - - The bucket owner is automatically granted FULL_CONTROL to all logs. You use the Grantee - request element to grant access to other people. The Permissions request - element specifies the kind of access the grantee has to the logs. - - - - Grantee Values - - - - You can specify the person (grantee) to whom you're assigning access rights (using - request elements) in the following ways: - -
  • - - By the person's ID: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> - </Grantee> - - - - DisplayName is optional and ignored in the request. - -
  • - - By Email address: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee> - - - - - The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl - request, appears as the CanonicalUser. - -
  • - - By URI: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee> - - -
- - To enable logging, you use LoggingEnabled and its children request elements. To disable - logging, you use an empty BucketLoggingStatus request element: - - - - <BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01" /> - - - - - For more information about server access logging, see Server - Access Logging. - - - - For more information about creating a bucket, see CreateBucket. For more information - about returning the logging status of a bucket, see GetBucketLogging. - - - - The following operations are related to PutBucketLogging: - - - - Container for the necessary parameters to execute the PutBucketLogging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketLogging service method, as returned by S3. - - - - Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. - You can have up to 1,000 metrics configurations per bucket. If you're updating an - existing metrics configuration, note that this is a full replacement of the existing - metrics configuration. If you don't include the elements you want to keep, they are - erased. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to PutBucketMetricsConfiguration: - - - - GetBucketLifecycle has the following special error: - -
  • - - Error code: TooManyConfigurations - -
    • - - Description: You are attempting to create a new configuration but have already reached - the 1,000-configuration limit. - -
    • - - HTTP Status Code: HTTP 400 Bad Request - -
- - Container for the necessary parameters to execute the PutBucketMetricsConfiguration service method. - - The response from the PutBucketMetricsConfiguration service method, as returned by S3. - - - - Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. - You can have up to 1,000 metrics configurations per bucket. If you're updating an - existing metrics configuration, note that this is a full replacement of the existing - metrics configuration. If you don't include the elements you want to keep, they are - erased. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to PutBucketMetricsConfiguration: - - - - GetBucketLifecycle has the following special error: - -
  • - - Error code: TooManyConfigurations - -
    • - - Description: You are attempting to create a new configuration but have already reached - the 1,000-configuration limit. - -
    • - - HTTP Status Code: HTTP 400 Bad Request - -
- - Container for the necessary parameters to execute the PutBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketMetricsConfiguration service method, as returned by S3. - - - - Enables notifications of specified events for a bucket. For more information about - event notifications, see Configuring - Event Notifications. - - - - Using this API, you can replace an existing notification configuration. The configuration - is an XML file that defines the event types that you want Amazon S3 to publish and - the destination where you want Amazon S3 to publish an event notification when it - detects an event of the specified type. - - - - By default, your bucket has no event notifications configured. That is, the notification - configuration will be an empty NotificationConfiguration. - - - - <NotificationConfiguration> - - - - </NotificationConfiguration> - - - - This operation replaces the existing notification configuration with the configuration - you include in the request body. - - - - After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification - Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, - and that the bucket owner has permission to publish to it by sending a test notification. - In the case of AWS Lambda destinations, Amazon S3 verifies that the Lambda function - permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. - For more information, see Configuring - Notifications for Amazon S3 Events. - - - - You can disable notifications by adding the empty NotificationConfiguration element. - - - - By default, only the bucket owner can configure notifications on a bucket. However, - bucket owners can use a bucket policy to grant permission to other users to set this - configuration with s3:PutBucketNotification permission. - - - - The PUT notification is an atomic operation. For example, suppose your notification - configuration includes SNS topic, SQS queue, and Lambda function configurations. When - you send a PUT request with this configuration, Amazon S3 sends test messages to your - SNS topic. If the message fails, the entire PUT operation will fail, and Amazon S3 - will not add the configuration to your bucket. - - - - Responses - - - - If the configuration in the request body includes only one TopicConfiguration - specifying only the s3:ReducedRedundancyLostObject event type, the response - will also include the x-amz-sns-test-message-id header containing the - message ID of the test notification sent to the topic. - - - - The following operation is related to PutBucketNotificationConfiguration: - - - - Container for the necessary parameters to execute the PutBucketNotification service method. - - The response from the PutBucketNotification service method, as returned by S3. - - - - Enables notifications of specified events for a bucket. For more information about - event notifications, see Configuring - Event Notifications. - - - - Using this API, you can replace an existing notification configuration. The configuration - is an XML file that defines the event types that you want Amazon S3 to publish and - the destination where you want Amazon S3 to publish an event notification when it - detects an event of the specified type. - - - - By default, your bucket has no event notifications configured. That is, the notification - configuration will be an empty NotificationConfiguration. - - - - <NotificationConfiguration> - - - - </NotificationConfiguration> - - - - This operation replaces the existing notification configuration with the configuration - you include in the request body. - - - - After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification - Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, - and that the bucket owner has permission to publish to it by sending a test notification. - In the case of AWS Lambda destinations, Amazon S3 verifies that the Lambda function - permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. - For more information, see Configuring - Notifications for Amazon S3 Events. - - - - You can disable notifications by adding the empty NotificationConfiguration element. - - - - By default, only the bucket owner can configure notifications on a bucket. However, - bucket owners can use a bucket policy to grant permission to other users to set this - configuration with s3:PutBucketNotification permission. - - - - The PUT notification is an atomic operation. For example, suppose your notification - configuration includes SNS topic, SQS queue, and Lambda function configurations. When - you send a PUT request with this configuration, Amazon S3 sends test messages to your - SNS topic. If the message fails, the entire PUT operation will fail, and Amazon S3 - will not add the configuration to your bucket. - - - - Responses - - - - If the configuration in the request body includes only one TopicConfiguration - specifying only the s3:ReducedRedundancyLostObject event type, the response - will also include the x-amz-sns-test-message-id header containing the - message ID of the test notification sent to the topic. - - - - The following operation is related to PutBucketNotificationConfiguration: - - - - Container for the necessary parameters to execute the PutBucketNotification service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketNotification service method, as returned by S3. - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - - The response from the PutBucketPolicy service method, as returned by S3. - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - The MD5 hash of the request body. - - The response from the PutBucketPolicy service method, as returned by S3. - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - Container for the necessary parameters to execute the PutBucketPolicy service method. - - The response from the PutBucketPolicy service method, as returned by S3. - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - The MD5 hash of the request body. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - Container for the necessary parameters to execute the PutBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - - - - Creates a replication configuration or replaces an existing one. For more information, - see Replication - in the Amazon S3 Developer Guide. - - - - To perform this operation, the user or role performing the operation must have the - iam:PassRole - permission. - - - - Specify the replication configuration in the request body. In the replication configuration, - you provide the name of the destination bucket where you want Amazon S3 to replicate - objects, the IAM role that Amazon S3 can assume to replicate objects on your behalf, - and other relevant information. - - - - A replication configuration must include at least one rule, and can contain a maximum - of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects - in the source bucket. To choose additional subsets of objects to replicate, add a - rule for each subset. All rules must specify the same destination bucket. - - - - To specify a subset of the objects in the source bucket to apply a replication rule - to, add the Filter element as a child of the Rule element. You can filter objects - based on an object key prefix, one or more object tags, or both. When you add the - Filter element in the configuration, you must also add the following elements: DeleteMarkerReplication, - Status, and Priority. - - - - For information about enabling versioning on a bucket, see Using - Versioning. - - - - By default, a resource owner, in this case the AWS account that created the bucket, - can perform this operation. The resource owner can also grant others permissions to - perform the operation. For more information about permissions, see Specifying - Permissions in a Policy and Managing - Access Permissions to Your Amazon S3 Resources. - - - - Handling Replication of Encrypted Objects - - - - By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side - encryption with CMKs stored in AWS KMS. To replicate AWS KMS-encrypted objects, add - the following: SourceSelectionCriteria, SseKmsEncryptedObjects, - Status, EncryptionConfiguration, and ReplicaKmsKeyID. - For information about replication configuration, see Replicating - Objects Created with SSE Using CMKs stored in AWS KMS. - - - - For information on PutBucketReplication errors, see ReplicationErrorCodeList - - - - - The following operations are related to PutBucketReplication: - - - - Container for the necessary parameters to execute the PutBucketReplication service method. - - The response from the PutBucketReplication service method, as returned by S3. - - - - Creates a replication configuration or replaces an existing one. For more information, - see Replication - in the Amazon S3 Developer Guide. - - - - To perform this operation, the user or role performing the operation must have the - iam:PassRole - permission. - - - - Specify the replication configuration in the request body. In the replication configuration, - you provide the name of the destination bucket where you want Amazon S3 to replicate - objects, the IAM role that Amazon S3 can assume to replicate objects on your behalf, - and other relevant information. - - - - A replication configuration must include at least one rule, and can contain a maximum - of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects - in the source bucket. To choose additional subsets of objects to replicate, add a - rule for each subset. All rules must specify the same destination bucket. - - - - To specify a subset of the objects in the source bucket to apply a replication rule - to, add the Filter element as a child of the Rule element. You can filter objects - based on an object key prefix, one or more object tags, or both. When you add the - Filter element in the configuration, you must also add the following elements: DeleteMarkerReplication, - Status, and Priority. - - - - For information about enabling versioning on a bucket, see Using - Versioning. - - - - By default, a resource owner, in this case the AWS account that created the bucket, - can perform this operation. The resource owner can also grant others permissions to - perform the operation. For more information about permissions, see Specifying - Permissions in a Policy and Managing - Access Permissions to Your Amazon S3 Resources. - - - - Handling Replication of Encrypted Objects - - - - By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side - encryption with CMKs stored in AWS KMS. To replicate AWS KMS-encrypted objects, add - the following: SourceSelectionCriteria, SseKmsEncryptedObjects, - Status, EncryptionConfiguration, and ReplicaKmsKeyID. - For information about replication configuration, see Replicating - Objects Created with SSE Using CMKs stored in AWS KMS. - - - - For information on PutBucketReplication errors, see ReplicationErrorCodeList - - - - - The following operations are related to PutBucketReplication: - - - - Container for the necessary parameters to execute the PutBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketReplication service method, as returned by S3. - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - The bucket name. - Container for Payer. - - The response from the PutBucketRequestPayment service method, as returned by S3. - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - Container for the necessary parameters to execute the PutBucketRequestPayment service method. - - The response from the PutBucketRequestPayment service method, as returned by S3. - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - The bucket name. - Container for Payer. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketRequestPayment service method, as returned by S3. - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - Container for the necessary parameters to execute the PutBucketRequestPayment service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketRequestPayment service method, as returned by S3. - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging. - - - - Within a bucket, if you add a tag that has the same key as an existing tag, the new - value overwrites the old value. For more information, see Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional operation is currently in progress against - this resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - The bucket name. - A property of PutBucketTaggingRequest used to execute the PutBucketTagging service method. - - The response from the PutBucketTagging service method, as returned by S3. - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging. - - - - Within a bucket, if you add a tag that has the same key as an existing tag, the new - value overwrites the old value. For more information, see Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional operation is currently in progress against - this resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - Container for the necessary parameters to execute the PutBucketTagging service method. - - The response from the PutBucketTagging service method, as returned by S3. - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging. - - - - Within a bucket, if you add a tag that has the same key as an existing tag, the new - value overwrites the old value. For more information, see Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional operation is currently in progress against - this resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - The bucket name. - A property of PutBucketTaggingRequest used to execute the PutBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketTagging service method, as returned by S3. - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging. - - - - Within a bucket, if you add a tag that has the same key as an existing tag, the new - value overwrites the old value. For more information, see Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional operation is currently in progress against - this resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - Container for the necessary parameters to execute the PutBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketTagging service method, as returned by S3. - - - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT operation requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - The bucket name. - Container for the request. - - The response from the PutBucketWebsite service method, as returned by S3. - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT operation requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - Container for the necessary parameters to execute the PutBucketWebsite service method. - - The response from the PutBucketWebsite service method, as returned by S3. - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT operation requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - The bucket name. - Container for the request. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketWebsite service method, as returned by S3. - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT operation requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - Container for the necessary parameters to execute the PutBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketWebsite service method, as returned by S3. - - - - - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - The name of the bucket for which to set the configuration. - A property of PutLifecycleConfigurationRequest used to execute the PutLifecycleConfiguration service method. - - The response from the PutLifecycleConfiguration service method, as returned by S3. - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - Container for the necessary parameters to execute the PutLifecycleConfiguration service method. - - The response from the PutLifecycleConfiguration service method, as returned by S3. - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - The name of the bucket for which to set the configuration. - A property of PutLifecycleConfigurationRequest used to execute the PutLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutLifecycleConfiguration service method, as returned by S3. - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - Container for the necessary parameters to execute the PutLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutLifecycleConfiguration service method, as returned by S3. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Configuration for accessing AmazonS3 service - - - Configuration for accessing Amazon S3 service - - - - - When true, requests will always use path style addressing. - - - - - Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. - To use this feature, the bucket name should be DNS compliant names and should not contain periods (.). - The following APIs are not supported and are sent to the regular region endpoint, even if this option is enabled: -
    -
  1. PutBucket
    2. -
  2. ListBuckets
    3. -
  3. DeleteBucket
    4. -
- - - This option cannot be used at the same time as UseDualstackEndpoint. - - - - - If set to true and the service package supports it the region identified in the arn for a resource - will be used when making the service request. - - - - - USEast1RegionalEndpointValue determines wheter or not - to send the us-east-1 s3 requests to the regional endpoint or to - the legacy global endpoint. - This flags takes precedence over the AWS_S3_US_EAST_1_REGIONAL_ENDPOINT - environment variable and the credential file. - - - - - This method contains custom initializations for the config object. - - - - - Given this client configuration, returns the service url - - The service url in the form of a string - - - - If the client is configured to hit us-east-1 with the S3UsEast1RegionalEndpointValue flag not set, - this method checks whether the environment variable is present or the credential file contains a valid value - - A Nullable of S3UsEast1RegionalEndpointValue representing the client configuration for the regional us-east-1 endpoint - - - - Validate that the config object is properly configured. - - - - - Checks the AWS_S3_US_EAST_1_REGIONAL_ENDPOINT environment variable for the presence of the s3 regional flag - - A nullable of S3UsEast1RegionalEndpointValue - - - - Checks the credential file for the presence of the s3 regional flag - - A nullable of S3UsEast1RegionalEndpointValue - - - - Default constructor - - - - - The constant used to lookup in the region hash the endpoint. - - - - - Gets the ServiceVersion property. - - - - - Gets the value of UserAgent property. - - - - - Base exception for S3 errors. - - - - - Construct an instance of AmazonS3Exception - - - - - - Construct an instance of AmazonS3Exception - - - - - - - Construct an instance of AmazonS3Exception - - - - - - Construct an instance of AmazonS3Exception - - - - - - - - - - Construct an instance of AmazonS3Exception - - - - - - - - - - - Construct an instance of AmazonS3Exception - - - - - - - - - - - - Construct an instance of AmazonS3Exception - - - - - - - - - - - - - A special token that helps AWS troubleshoot problems. - - - - - A special token that helps AWS troubleshoot S3 accelerate problems. - - - - - The entire response body for this exception, if available. - - - - - The region that the AmazonS3Exception relates to. - - - - - Gets the exception message. - - - - - Constructs a new instance of the AmazonS3Exception class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - Extensions methods added to Amazon.Arn type to help parse S3 specific resources from the ARN. - - - - - Attempt to parse the resource component of the ARN into access point resource name. - - An AWS ARN to parse - The access point resouce identifier found in the ARN. - True if the ARN contains an access point resource identifier. - - - - Attempt to parse the resource component of the ARN into bucket name. - - An AWS ARN to parse - The bucket name found in the ARN. - True if the ARN contains a bucket name. - - - - This class extends the AmazonS3Client and provides client side encryption when reading or writing S3 objects. - - - - - Constructs AmazonS3EncryptionClient with the Encryption materials and credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Constructs AmazonS3EncryptionClient with the Encryption materials and credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - - The region to connect. - - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Constructs AmazonS3EncryptionClient with the Encryption materials, - AmazonS3 CryptoConfiguration object and credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - - The AmazonS3EncryptionClient CryptoConfiguration Object - - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Constructs AmazonS3EncryptionClient with AWS Credentials and Encryption materials. - - - The encryption materials to be used to encrypt and decrypt envelope key. - - AWS Credentials - - - - Constructs AmazonS3EncryptionClient with AWS Credentials, Region and Encryption materials - - AWS Credentials - The region to connect. - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Constructs AmazonS3EncryptionClient with AWS Credentials, AmazonS3CryptoConfiguration Configuration object - and Encryption materials - - AWS Credentials - The AmazonS3EncryptionClient CryptoConfiguration Object - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Constructs AmazonS3EncryptionClient with AWS Access Key ID, - AWS Secret Key and Encryption materials - - AWS Access Key ID - AWS Secret Access Key - The encryption materials to be used to encrypt and decrypt envelope key. - - - - Constructs AmazonS3EncryptionClient with AWS Access Key ID, - AWS Secret Key, Region and Encryption materials - - AWS Access Key ID - AWS Secret Access Key - The region to connect. - The encryption materials to be used to encrypt and decrypt envelope key. - - - - Constructs AmazonS3EncryptionClient with AWS Access Key ID, Secret Key, - AmazonS3 CryptoConfiguration object and Encryption materials. - - AWS Access Key ID - AWS Secret Access Key - The AmazonS3EncryptionClient CryptoConfiguration Object - The encryption materials to be used to encrypt and decrypt envelope key. - - - - Constructs AmazonS3EncryptionClient with AWS Access Key ID, Secret Key, - SessionToken and Encryption materials. - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Constructs AmazonS3EncryptionClient with AWS Access Key ID, Secret Key, - SessionToken, Region and Encryption materials. - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - The region to connect. - The encryption materials to be used to encrypt and decrypt envelope key. - - - - Constructs AmazonS3EncryptionClient with AWS Access Key ID, Secret Key, SessionToken - AmazonS3EncryptionClient CryptoConfiguration object and Encryption materials. - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - The AmazonS3EncryptionClient CryptoConfiguration Object - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Turn off response logging because it will interfere with decrypt of the data coming back from S3. - - - - - Customize the pipeline to allow encryption. - - - - - - Dispose this instance - - - - - - AmazonS3CryptoConfiguration allows customers - to set storage mode for encryption credentials - - - - - Default Constructor. - - - - - Gets and sets the StorageMode property. This determines if the crypto metadata is stored as metadata on the object or as a separate object in S3. - The default is ObjectMetadata. - - - - - Mode for string the encryption information for an object. - - - - - Store the information in a separate S3 Object. - - - - - Store the information as metadata on the encrypted object. - - - - - Encryption Instructions store the encryption credentials - - - - - Construct an instance EncryptionInstructions. - - - - - - - - - Construct an instance EncryptionInstructions. - - - - - - - - The "key encrypting key" materials used in encrypt/decryption. - These materials may be an asymmetric key, a symmetric key, or a KMS key ID. - - - - - Constructs a new EncryptionMaterials object, storing an asymmetric key. - - - - - - Constructs a new EncryptionMaterials object, storing a symmetric key. - - - - - - Constructs a new EncryptionMaterials object, storing a KMS Key ID - - - - - - The EncryptionUtils class encrypts and decrypts data stored in S3. - It can be used to prepare requests for encryption before they are stored in S3 - and to decrypt objects that are retrieved from S3. - - - - - Decrypts an encrypted Envelope key using the provided encryption materials - and returns it in raw byte array form. - - Encrypted envelope key - Encryption materials needed to decrypt the encrypted envlelope key - - - - - Returns an updated stream where the stream contains the encrypted object contents. - The specified instruction will be used to encrypt data. - - - The stream whose contents are to be encrypted. - - - The instruction that will be used to encrypt the object data. - - - Encrypted stream, i.e input stream wrapped into encrypted stream - - - - - Returns an updated input stream where the input stream contains the encrypted object contents. - The specified instruction will be used to encrypt data. - - - The stream whose contents are to be encrypted. - - - The instruction that will be used to encrypt the object data. - - - Encrypted stream, i.e input stream wrapped into encrypted stream - - - - - Updates object where the object - input stream contains the decrypted contents. - - - The getObject response whose contents are to be decrypted. - - - The instruction that will be used to encrypt the object data. - - - - - Generates an instruction that will be used to encrypt an object - using materials with the KMSKeyID set. - - - Used to call KMS to generate a data key. - - - The encryption materials to be used to encrypt and decrypt data. - - - The instruction that will be used to encrypt an object. - - - - - Generates an instruction that will be used to encrypt an object - using materials with the KMSKeyID set. - - - Used to call KMS to generate a data key. - - - The encryption materials to be used to encrypt and decrypt data. - - - The instruction that will be used to encrypt an object. - - - - - Generates an instruction that will be used to encrypt an object - using materials with the AsymmetricProvider or SymmetricProvider set. - - - The encryption materials to be used to encrypt and decrypt data. - - - The instruction that will be used to encrypt an object. - - - - - Builds an instruction object from the object metadata. - - - A non-null object response that contains encryption information in its metadata. - - - The non-null encryption materials to be used to encrypt and decrypt Envelope key. - - - The decrypted envelope key to be use if KMS key wrapping is being used. Or null if non-KMS key wrapping is being used. - - - - - - - Builds an instruction object from the instruction file. - - Instruction file GetObject response - - The non-null encryption materials to be used to encrypt and decrypt Envelope key. - - - A non-null instruction object containing encryption information. - - - - - Update the request's ObjectMetadata with the necessary information for decrypting the object. - - - AmazonWebServiceRequest encrypted using the given instruction - - - Non-null instruction used to encrypt the data in this AmazonWebServiceRequest . - - - If true use V2 metadata format, otherwise use V1. - - - - - Adds UnEncrypted content length to object metadata - - - - - - checks if encryption credentials are in object metadata - - Response of the object - - - - - checks if encryption credentials are in the instructionfile - - Instruction file response that contains encryption information - - - - - Custom the pipeline handler to decrypt objects. - - - - - Construct instance of SetupDecryptionHandler. - - - - - - Gets the EncryptionClient property which is the AmazonS3EncryptionClient that is decrypting the object. - - - - - Calls the post invoke logic after calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Decrypt the object being downloaded. - - - - - - Calls the and post invoke logic after calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Decrypt the object being downloaded. - - - - - - Decrypt the object being downloaded. - - - - - - - Updates object where the object input stream contains the decrypted contents. - - - The getObject response of InstructionFile. - - - The getObject response whose contents are to be decrypted. - - - - - Updates object where the object input stream contains the decrypted contents. - - - The getObject response whose contents are to be decrypted. - - - The decrypted envelope key to be use if KMS key wrapping is being used. Or null if non-KMS key wrapping is being used. - - - - - Custom pipeline handler to encrypt the data as it is being uploaded to S3. - - - - - Construct an instance SetupEncryptionHandler. - - - - - - Gets the EncryptionClient property which is the AmazonS3EncryptionClient that is encrypting the object. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Encrypts the S3 object being uploaded. - - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Encrypts the S3 object being uploaded. - - - - - - Make sure that the storage mode and encryption materials are compatible. - The client only supports KMS key wrapping in metadata storage mode. - - - - - Updates the request where the metadata contains encryption information - and the input stream contains the encrypted object contents. - - - The request whose contents are to be encrypted. - - - - - Updates the request where the instruction file contains encryption information - and the input stream contains the encrypted object contents. - - - - - - Updates the request where the input stream contains the encrypted object contents. - - - - - - Adds the crypto token to the user agent - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Customize the user agent. - - - - - - Interface for accessing S3 - - - - - - - Create a signed URL allowing access to a resource that would - usually require authentication. - - - - When using query string authentication you create a query, - specify an expiration time for the query, sign it with your - signature, place the data in an HTTP request, and distribute - the request to a user or embed the request in a web page. - - - A PreSigned URL can be generated for GET, PUT, DELETE and HEAD - operations on your bucketName, keys, and versions. - - - The GetPreSignedUrlRequest that defines the - parameters of the operation. - A string that is the signed http request. - - - - - - This operation aborts a multipart upload. After a multipart upload is aborted, no - additional parts can be uploaded using that upload ID. The storage consumed by any - previously uploaded parts will be freed. However, if any part uploads are currently - in progress, those part uploads might or might not succeed. As a result, it might - be necessary to abort a given multipart upload multiple times in order to completely - free all storage consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts operation and ensure that the parts - list is empty. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - The bucket name to which the upload was taking place. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object for which the multipart upload was initiated. - Upload ID that identifies the multipart upload. - - The response from the AbortMultipartUpload service method, as returned by S3. - - - - This operation aborts a multipart upload. After a multipart upload is aborted, no - additional parts can be uploaded using that upload ID. The storage consumed by any - previously uploaded parts will be freed. However, if any part uploads are currently - in progress, those part uploads might or might not succeed. As a result, it might - be necessary to abort a given multipart upload multiple times in order to completely - free all storage consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts operation and ensure that the parts - list is empty. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - Container for the necessary parameters to execute the AbortMultipartUpload service method. - - The response from the AbortMultipartUpload service method, as returned by S3. - - - - This operation aborts a multipart upload. After a multipart upload is aborted, no - additional parts can be uploaded using that upload ID. The storage consumed by any - previously uploaded parts will be freed. However, if any part uploads are currently - in progress, those part uploads might or might not succeed. As a result, it might - be necessary to abort a given multipart upload multiple times in order to completely - free all storage consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts operation and ensure that the parts - list is empty. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - The bucket name to which the upload was taking place. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object for which the multipart upload was initiated. - Upload ID that identifies the multipart upload. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AbortMultipartUpload service method, as returned by S3. - - - - This operation aborts a multipart upload. After a multipart upload is aborted, no - additional parts can be uploaded using that upload ID. The storage consumed by any - previously uploaded parts will be freed. However, if any part uploads are currently - in progress, those part uploads might or might not succeed. As a result, it might - be necessary to abort a given multipart upload multiple times in order to completely - free all storage consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts operation and ensure that the parts - list is empty. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - Container for the necessary parameters to execute the AbortMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AbortMultipartUpload service method, as returned by S3. - - - - Completes a multipart upload by assembling previously uploaded parts. - - - - You first initiate the multipart upload and then upload all parts using the UploadPart - operation. After successfully uploading all relevant parts of an upload, you call - this operation to complete the upload. Upon receiving this request, Amazon S3 concatenates - all the parts in ascending order by part number to create a new object. In the Complete - Multipart Upload request, you must provide the parts list. You must ensure that the - parts list is complete. This operation concatenates the parts that you provide in - the list. For each part in the list, you must provide the part number and the ETag - value, returned after that part was uploaded. - - - - Processing of a Complete Multipart Upload request could take several minutes to complete. - After Amazon S3 begins processing the request, it sends an HTTP response header that - specifies a 200 OK response. While processing is in progress, Amazon S3 periodically - sends white space characters to keep the connection from timing out. Because a request - could fail after the initial 200 OK response has been sent, it is important that you - check the response body to determine whether the request succeeded. - - - - Note that if CompleteMultipartUpload fails, applications should be prepared - to retry the failed requests. For more information, see Amazon - S3 Error Best Practices. - - - - For more information about multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - GetBucketLifecycle has the following special errors: - -
  • - - Error code: EntityTooSmall - -
    • - - Description: Your proposed upload is smaller than the minimum allowed object size. - Each part must be at least 5 MB in size, except the last part. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPart - -
    • - - Description: One or more of the specified parts could not be found. The part might - not have been uploaded, or the specified entity tag might not have matched the part's - entity tag. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPartOrder - -
    • - - Description: The list of parts was not in ascending order. The parts list must be - specified in order by part number. - -
    • - - 400 Bad Request - -
  • - - Error code: NoSuchUpload - -
    • - - Description: The specified multipart upload does not exist. The upload ID might be - invalid, or the multipart upload might have been aborted or completed. - -
    • - - 404 Not Found - -
- - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the CompleteMultipartUpload service method. - - The response from the CompleteMultipartUpload service method, as returned by S3. - - - - Completes a multipart upload by assembling previously uploaded parts. - - - - You first initiate the multipart upload and then upload all parts using the UploadPart - operation. After successfully uploading all relevant parts of an upload, you call - this operation to complete the upload. Upon receiving this request, Amazon S3 concatenates - all the parts in ascending order by part number to create a new object. In the Complete - Multipart Upload request, you must provide the parts list. You must ensure that the - parts list is complete. This operation concatenates the parts that you provide in - the list. For each part in the list, you must provide the part number and the ETag - value, returned after that part was uploaded. - - - - Processing of a Complete Multipart Upload request could take several minutes to complete. - After Amazon S3 begins processing the request, it sends an HTTP response header that - specifies a 200 OK response. While processing is in progress, Amazon S3 periodically - sends white space characters to keep the connection from timing out. Because a request - could fail after the initial 200 OK response has been sent, it is important that you - check the response body to determine whether the request succeeded. - - - - Note that if CompleteMultipartUpload fails, applications should be prepared - to retry the failed requests. For more information, see Amazon - S3 Error Best Practices. - - - - For more information about multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - GetBucketLifecycle has the following special errors: - -
  • - - Error code: EntityTooSmall - -
    • - - Description: Your proposed upload is smaller than the minimum allowed object size. - Each part must be at least 5 MB in size, except the last part. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPart - -
    • - - Description: One or more of the specified parts could not be found. The part might - not have been uploaded, or the specified entity tag might not have matched the part's - entity tag. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPartOrder - -
    • - - Description: The list of parts was not in ascending order. The parts list must be - specified in order by part number. - -
    • - - 400 Bad Request - -
  • - - Error code: NoSuchUpload - -
    • - - Description: The specified multipart upload does not exist. The upload ID might be - invalid, or the multipart upload might have been aborted or completed. - -
    • - - 404 Not Found - -
- - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the CompleteMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CompleteMultipartUpload service method, as returned by S3. - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - for copying an object greater than 5 GB, you must use the multipart upload Upload - Part - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - Amazon S3 transfer acceleration does not support cross-region copies. If you request - a cross-region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information about transfer acceleration, see Transfer - Acceleration. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - request parameters x-amz-copy-source-if-match, x-amz-copy-source-if-none-match, - x-amz-copy-source-if-unmodified-since, or x-amz-copy-source-if-modified-since. - - - - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - You can use this operation to change the storage class of an object that is already - stored in Amazon S3 using the StorageClass parameter. For more information, - see Storage - Classes. - - - - The source object that you are copying can be encrypted or unencrypted. If the source - object is encrypted, it can be encrypted by server-side encryption using AWS managed - encryption keys or by using a customer-provided encryption key. When copying an object, - you can request that Amazon S3 encrypt the target object by using either the AWS managed - encryption keys or by using your own encryption key. You can do this regardless of - the form of server-side encryption that was used to encrypt the source, or even if - the source object was not encrypted. For more information about server-side encryption, - see Using - Server-Side Encryption. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
    • - - x-amz-copy-source-if-match condition evaluates to true - -
    • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
  • - - Consideration 2 – If both of the x-amz-copy-source-if-none-match and - x-amz-copy-source-if-modified-since headers are present in the request - and evaluate as follows, Amazon S3 returns the 412 Precondition Failed - response code: - -
    • - - x-amz-copy-source-if-none-match condition evaluates to false - -
    • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - The copy request charge is based on the storage class and Region you specify for the - destination object. For pricing information, see Amazon - S3 Pricing. - - - - Following are other considerations when using CopyObject: - -
Versioning
- - By default, x-amz-copy-source identifies the current version of an object - to copy. (If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted.) To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - To encrypt the target object, you must provide the appropriate encryption-related - request headers. The one you use depends on whether you want to use AWS managed encryption - keys or provide your own encryption key. - -
  • - - To encrypt the target object using server-side encryption with an AWS managed encryption - key, provide the following request headers, as appropriate. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. If you want to use a customer managed AWS KMS - CMK, you must provide the x-amz-server-side-encryption-aws-kms-key-id - of the symmetric customer managed CMK. Amazon S3 only supports symmetric CMKs and - not asymmetric CMKs. For more information, see Using - Symmetric and Asymmetric Keys in the AWS Key Management Service Developer Guide. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in KMS. - -
  • - - To encrypt the target object using server-side encryption with an encryption key that - you provide, use the following headers. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
  • - - If the source object is encrypted using server-side encryption with customer-provided - encryption keys, you must use the following headers. - -
    • - - x-amz-copy-source​-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-copy-source​-server-side​-encryption​-customer-key - -
    • - - x-amz-copy-source-​server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in Amazon KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - The response from the CopyObject service method, as returned by S3. - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - for copying an object greater than 5 GB, you must use the multipart upload Upload - Part - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - Amazon S3 transfer acceleration does not support cross-region copies. If you request - a cross-region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information about transfer acceleration, see Transfer - Acceleration. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - request parameters x-amz-copy-source-if-match, x-amz-copy-source-if-none-match, - x-amz-copy-source-if-unmodified-since, or x-amz-copy-source-if-modified-since. - - - - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - You can use this operation to change the storage class of an object that is already - stored in Amazon S3 using the StorageClass parameter. For more information, - see Storage - Classes. - - - - The source object that you are copying can be encrypted or unencrypted. If the source - object is encrypted, it can be encrypted by server-side encryption using AWS managed - encryption keys or by using a customer-provided encryption key. When copying an object, - you can request that Amazon S3 encrypt the target object by using either the AWS managed - encryption keys or by using your own encryption key. You can do this regardless of - the form of server-side encryption that was used to encrypt the source, or even if - the source object was not encrypted. For more information about server-side encryption, - see Using - Server-Side Encryption. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
    • - - x-amz-copy-source-if-match condition evaluates to true - -
    • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
  • - - Consideration 2 – If both of the x-amz-copy-source-if-none-match and - x-amz-copy-source-if-modified-since headers are present in the request - and evaluate as follows, Amazon S3 returns the 412 Precondition Failed - response code: - -
    • - - x-amz-copy-source-if-none-match condition evaluates to false - -
    • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - The copy request charge is based on the storage class and Region you specify for the - destination object. For pricing information, see Amazon - S3 Pricing. - - - - Following are other considerations when using CopyObject: - -
Versioning
- - By default, x-amz-copy-source identifies the current version of an object - to copy. (If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted.) To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - To encrypt the target object, you must provide the appropriate encryption-related - request headers. The one you use depends on whether you want to use AWS managed encryption - keys or provide your own encryption key. - -
  • - - To encrypt the target object using server-side encryption with an AWS managed encryption - key, provide the following request headers, as appropriate. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. If you want to use a customer managed AWS KMS - CMK, you must provide the x-amz-server-side-encryption-aws-kms-key-id - of the symmetric customer managed CMK. Amazon S3 only supports symmetric CMKs and - not asymmetric CMKs. For more information, see Using - Symmetric and Asymmetric Keys in the AWS Key Management Service Developer Guide. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in KMS. - -
  • - - To encrypt the target object using server-side encryption with an encryption key that - you provide, use the following headers. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
  • - - If the source object is encrypted using server-side encryption with customer-provided - encryption keys, you must use the following headers. - -
    • - - x-amz-copy-source​-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-copy-source​-server-side​-encryption​-customer-key - -
    • - - x-amz-copy-source-​server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in Amazon KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - The response from the CopyObject service method, as returned by S3. - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - for copying an object greater than 5 GB, you must use the multipart upload Upload - Part - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - Amazon S3 transfer acceleration does not support cross-region copies. If you request - a cross-region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information about transfer acceleration, see Transfer - Acceleration. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - request parameters x-amz-copy-source-if-match, x-amz-copy-source-if-none-match, - x-amz-copy-source-if-unmodified-since, or x-amz-copy-source-if-modified-since. - - - - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - You can use this operation to change the storage class of an object that is already - stored in Amazon S3 using the StorageClass parameter. For more information, - see Storage - Classes. - - - - The source object that you are copying can be encrypted or unencrypted. If the source - object is encrypted, it can be encrypted by server-side encryption using AWS managed - encryption keys or by using a customer-provided encryption key. When copying an object, - you can request that Amazon S3 encrypt the target object by using either the AWS managed - encryption keys or by using your own encryption key. You can do this regardless of - the form of server-side encryption that was used to encrypt the source, or even if - the source object was not encrypted. For more information about server-side encryption, - see Using - Server-Side Encryption. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
    • - - x-amz-copy-source-if-match condition evaluates to true - -
    • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
  • - - Consideration 2 – If both of the x-amz-copy-source-if-none-match and - x-amz-copy-source-if-modified-since headers are present in the request - and evaluate as follows, Amazon S3 returns the 412 Precondition Failed - response code: - -
    • - - x-amz-copy-source-if-none-match condition evaluates to false - -
    • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - The copy request charge is based on the storage class and Region you specify for the - destination object. For pricing information, see Amazon - S3 Pricing. - - - - Following are other considerations when using CopyObject: - -
Versioning
- - By default, x-amz-copy-source identifies the current version of an object - to copy. (If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted.) To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - To encrypt the target object, you must provide the appropriate encryption-related - request headers. The one you use depends on whether you want to use AWS managed encryption - keys or provide your own encryption key. - -
  • - - To encrypt the target object using server-side encryption with an AWS managed encryption - key, provide the following request headers, as appropriate. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. If you want to use a customer managed AWS KMS - CMK, you must provide the x-amz-server-side-encryption-aws-kms-key-id - of the symmetric customer managed CMK. Amazon S3 only supports symmetric CMKs and - not asymmetric CMKs. For more information, see Using - Symmetric and Asymmetric Keys in the AWS Key Management Service Developer Guide. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in KMS. - -
  • - - To encrypt the target object using server-side encryption with an encryption key that - you provide, use the following headers. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
  • - - If the source object is encrypted using server-side encryption with customer-provided - encryption keys, you must use the following headers. - -
    • - - x-amz-copy-source​-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-copy-source​-server-side​-encryption​-customer-key - -
    • - - x-amz-copy-source-​server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in Amazon KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - Container for the necessary parameters to execute the CopyObject service method. - - The response from the CopyObject service method, as returned by S3. - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - for copying an object greater than 5 GB, you must use the multipart upload Upload - Part - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - Amazon S3 transfer acceleration does not support cross-region copies. If you request - a cross-region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information about transfer acceleration, see Transfer - Acceleration. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - request parameters x-amz-copy-source-if-match, x-amz-copy-source-if-none-match, - x-amz-copy-source-if-unmodified-since, or x-amz-copy-source-if-modified-since. - - - - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - You can use this operation to change the storage class of an object that is already - stored in Amazon S3 using the StorageClass parameter. For more information, - see Storage - Classes. - - - - The source object that you are copying can be encrypted or unencrypted. If the source - object is encrypted, it can be encrypted by server-side encryption using AWS managed - encryption keys or by using a customer-provided encryption key. When copying an object, - you can request that Amazon S3 encrypt the target object by using either the AWS managed - encryption keys or by using your own encryption key. You can do this regardless of - the form of server-side encryption that was used to encrypt the source, or even if - the source object was not encrypted. For more information about server-side encryption, - see Using - Server-Side Encryption. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
    • - - x-amz-copy-source-if-match condition evaluates to true - -
    • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
  • - - Consideration 2 – If both of the x-amz-copy-source-if-none-match and - x-amz-copy-source-if-modified-since headers are present in the request - and evaluate as follows, Amazon S3 returns the 412 Precondition Failed - response code: - -
    • - - x-amz-copy-source-if-none-match condition evaluates to false - -
    • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - The copy request charge is based on the storage class and Region you specify for the - destination object. For pricing information, see Amazon - S3 Pricing. - - - - Following are other considerations when using CopyObject: - -
Versioning
- - By default, x-amz-copy-source identifies the current version of an object - to copy. (If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted.) To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - To encrypt the target object, you must provide the appropriate encryption-related - request headers. The one you use depends on whether you want to use AWS managed encryption - keys or provide your own encryption key. - -
  • - - To encrypt the target object using server-side encryption with an AWS managed encryption - key, provide the following request headers, as appropriate. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. If you want to use a customer managed AWS KMS - CMK, you must provide the x-amz-server-side-encryption-aws-kms-key-id - of the symmetric customer managed CMK. Amazon S3 only supports symmetric CMKs and - not asymmetric CMKs. For more information, see Using - Symmetric and Asymmetric Keys in the AWS Key Management Service Developer Guide. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in KMS. - -
  • - - To encrypt the target object using server-side encryption with an encryption key that - you provide, use the following headers. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
  • - - If the source object is encrypted using server-side encryption with customer-provided - encryption keys, you must use the following headers. - -
    • - - x-amz-copy-source​-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-copy-source​-server-side​-encryption​-customer-key - -
    • - - x-amz-copy-source-​server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in Amazon KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - for copying an object greater than 5 GB, you must use the multipart upload Upload - Part - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - Amazon S3 transfer acceleration does not support cross-region copies. If you request - a cross-region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information about transfer acceleration, see Transfer - Acceleration. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - request parameters x-amz-copy-source-if-match, x-amz-copy-source-if-none-match, - x-amz-copy-source-if-unmodified-since, or x-amz-copy-source-if-modified-since. - - - - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - You can use this operation to change the storage class of an object that is already - stored in Amazon S3 using the StorageClass parameter. For more information, - see Storage - Classes. - - - - The source object that you are copying can be encrypted or unencrypted. If the source - object is encrypted, it can be encrypted by server-side encryption using AWS managed - encryption keys or by using a customer-provided encryption key. When copying an object, - you can request that Amazon S3 encrypt the target object by using either the AWS managed - encryption keys or by using your own encryption key. You can do this regardless of - the form of server-side encryption that was used to encrypt the source, or even if - the source object was not encrypted. For more information about server-side encryption, - see Using - Server-Side Encryption. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
    • - - x-amz-copy-source-if-match condition evaluates to true - -
    • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
  • - - Consideration 2 – If both of the x-amz-copy-source-if-none-match and - x-amz-copy-source-if-modified-since headers are present in the request - and evaluate as follows, Amazon S3 returns the 412 Precondition Failed - response code: - -
    • - - x-amz-copy-source-if-none-match condition evaluates to false - -
    • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - The copy request charge is based on the storage class and Region you specify for the - destination object. For pricing information, see Amazon - S3 Pricing. - - - - Following are other considerations when using CopyObject: - -
Versioning
- - By default, x-amz-copy-source identifies the current version of an object - to copy. (If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted.) To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - To encrypt the target object, you must provide the appropriate encryption-related - request headers. The one you use depends on whether you want to use AWS managed encryption - keys or provide your own encryption key. - -
  • - - To encrypt the target object using server-side encryption with an AWS managed encryption - key, provide the following request headers, as appropriate. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. If you want to use a customer managed AWS KMS - CMK, you must provide the x-amz-server-side-encryption-aws-kms-key-id - of the symmetric customer managed CMK. Amazon S3 only supports symmetric CMKs and - not asymmetric CMKs. For more information, see Using - Symmetric and Asymmetric Keys in the AWS Key Management Service Developer Guide. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in KMS. - -
  • - - To encrypt the target object using server-side encryption with an encryption key that - you provide, use the following headers. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
  • - - If the source object is encrypted using server-side encryption with customer-provided - encryption keys, you must use the following headers. - -
    • - - x-amz-copy-source​-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-copy-source​-server-side​-encryption​-customer-key - -
    • - - x-amz-copy-source-​server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in Amazon KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - for copying an object greater than 5 GB, you must use the multipart upload Upload - Part - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - Amazon S3 transfer acceleration does not support cross-region copies. If you request - a cross-region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information about transfer acceleration, see Transfer - Acceleration. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - request parameters x-amz-copy-source-if-match, x-amz-copy-source-if-none-match, - x-amz-copy-source-if-unmodified-since, or x-amz-copy-source-if-modified-since. - - - - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - You can use this operation to change the storage class of an object that is already - stored in Amazon S3 using the StorageClass parameter. For more information, - see Storage - Classes. - - - - The source object that you are copying can be encrypted or unencrypted. If the source - object is encrypted, it can be encrypted by server-side encryption using AWS managed - encryption keys or by using a customer-provided encryption key. When copying an object, - you can request that Amazon S3 encrypt the target object by using either the AWS managed - encryption keys or by using your own encryption key. You can do this regardless of - the form of server-side encryption that was used to encrypt the source, or even if - the source object was not encrypted. For more information about server-side encryption, - see Using - Server-Side Encryption. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
    • - - x-amz-copy-source-if-match condition evaluates to true - -
    • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
  • - - Consideration 2 – If both of the x-amz-copy-source-if-none-match and - x-amz-copy-source-if-modified-since headers are present in the request - and evaluate as follows, Amazon S3 returns the 412 Precondition Failed - response code: - -
    • - - x-amz-copy-source-if-none-match condition evaluates to false - -
    • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - The copy request charge is based on the storage class and Region you specify for the - destination object. For pricing information, see Amazon - S3 Pricing. - - - - Following are other considerations when using CopyObject: - -
Versioning
- - By default, x-amz-copy-source identifies the current version of an object - to copy. (If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted.) To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - To encrypt the target object, you must provide the appropriate encryption-related - request headers. The one you use depends on whether you want to use AWS managed encryption - keys or provide your own encryption key. - -
  • - - To encrypt the target object using server-side encryption with an AWS managed encryption - key, provide the following request headers, as appropriate. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. If you want to use a customer managed AWS KMS - CMK, you must provide the x-amz-server-side-encryption-aws-kms-key-id - of the symmetric customer managed CMK. Amazon S3 only supports symmetric CMKs and - not asymmetric CMKs. For more information, see Using - Symmetric and Asymmetric Keys in the AWS Key Management Service Developer Guide. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in KMS. - -
  • - - To encrypt the target object using server-side encryption with an encryption key that - you provide, use the following headers. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
  • - - If the source object is encrypted using server-side encryption with customer-provided - encryption keys, you must use the following headers. - -
    • - - x-amz-copy-source​-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-copy-source​-server-side​-encryption​-customer-key - -
    • - - x-amz-copy-source-​server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in Amazon KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - Container for the necessary parameters to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - - - - - - - - - - - - - - Deletes an analytics configuration for the bucket (specified by the analytics configuration - ID). - - - - To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to DeleteBucketAnalyticsConfiguration: - -
  • - - - -
  • - - - -
  • - - - -
- - Container for the necessary parameters to execute the DeleteBucketAnalyticsConfiguration service method. - - The response from the DeleteBucketAnalyticsConfiguration service method, as returned by S3. - - - - Deletes an analytics configuration for the bucket (specified by the analytics configuration - ID). - - - - To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to DeleteBucketAnalyticsConfiguration: - -
  • - - - -
  • - - - -
  • - - - -
- - Container for the necessary parameters to execute the DeleteBucketAnalyticsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketAnalyticsConfiguration service method, as returned by S3. - - - - - - Deletes an inventory configuration (identified by the inventory ID) from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - Operations related to DeleteBucketInventoryConfiguration include: - - - - Container for the necessary parameters to execute the DeleteBucketInventoryConfiguration service method. - - The response from the DeleteBucketInventoryConfiguration service method, as returned by S3. - - - - Deletes an inventory configuration (identified by the inventory ID) from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - Operations related to DeleteBucketInventoryConfiguration include: - - - - Container for the necessary parameters to execute the DeleteBucketInventoryConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketInventoryConfiguration service method, as returned by S3. - - - - Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified - by the metrics configuration ID) from the bucket. Note that this doesn't include the - daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteBucketMetricsConfiguration service method. - - The response from the DeleteBucketMetricsConfiguration service method, as returned by S3. - - - - Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified - by the metrics configuration ID) from the bucket. Note that this doesn't include the - daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketMetricsConfiguration service method, as returned by S3. - - - - This implementation of the DELETE operation uses the policy subresource to delete - the policy of a specified bucket. If you are using an identity other than the root - user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - The bucket name. - - The response from the DeleteBucketPolicy service method, as returned by S3. - - - - This implementation of the DELETE operation uses the policy subresource to delete - the policy of a specified bucket. If you are using an identity other than the root - user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - Container for the necessary parameters to execute the DeleteBucketPolicy service method. - - The response from the DeleteBucketPolicy service method, as returned by S3. - - - - This implementation of the DELETE operation uses the policy subresource to delete - the policy of a specified bucket. If you are using an identity other than the root - user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - The bucket name. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketPolicy service method, as returned by S3. - - - - This implementation of the DELETE operation uses the policy subresource to delete - the policy of a specified bucket. If you are using an identity other than the root - user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - Container for the necessary parameters to execute the DeleteBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketPolicy service method, as returned by S3. - - - - Deletes the replication configuration from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutReplicationConfiguration - action. The bucket owner has these permissions by default and can grant it to others. - For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - It can take a while for the deletion of a replication configuration to fully propagate. - - - - For information about replication configuration, see Replication - in the Amazon S3 Developer Guide. - - - - The following operations are related to DeleteBucketReplication: - - - - Container for the necessary parameters to execute the DeleteBucketReplication service method. - - The response from the DeleteBucketReplication service method, as returned by S3. - - - - Deletes the replication configuration from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutReplicationConfiguration - action. The bucket owner has these permissions by default and can grant it to others. - For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - It can take a while for the deletion of a replication configuration to fully propagate. - - - - For information about replication configuration, see Replication - in the Amazon S3 Developer Guide. - - - - The following operations are related to DeleteBucketReplication: - - - - Container for the necessary parameters to execute the DeleteBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketReplication service method, as returned by S3. - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - The bucket that has the tag set to be removed. - - The response from the DeleteBucketTagging service method, as returned by S3. - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - Container for the necessary parameters to execute the DeleteBucketTagging service method. - - The response from the DeleteBucketTagging service method, as returned by S3. - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - The bucket that has the tag set to be removed. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketTagging service method, as returned by S3. - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - Container for the necessary parameters to execute the DeleteBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketTagging service method, as returned by S3. - - - - This operation removes the website configuration for a bucket. Amazon S3 returns a - 200 OK response upon successfully deleting a website configuration on - the specified bucket. You will get a 200 OK response if the website configuration - you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE operation requires the S3:DeleteBucketWebsite permission. - By default, only the bucket owner can delete the website configuration attached to - a bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which you want to remove the website configuration. - - The response from the DeleteBucketWebsite service method, as returned by S3. - - - - This operation removes the website configuration for a bucket. Amazon S3 returns a - 200 OK response upon successfully deleting a website configuration on - the specified bucket. You will get a 200 OK response if the website configuration - you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE operation requires the S3:DeleteBucketWebsite permission. - By default, only the bucket owner can delete the website configuration attached to - a bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the DeleteBucketWebsite service method. - - The response from the DeleteBucketWebsite service method, as returned by S3. - - - - This operation removes the website configuration for a bucket. Amazon S3 returns a - 200 OK response upon successfully deleting a website configuration on - the specified bucket. You will get a 200 OK response if the website configuration - you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE operation requires the S3:DeleteBucketWebsite permission. - By default, only the bucket owner can delete the website configuration attached to - a bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which you want to remove the website configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketWebsite service method, as returned by S3. - - - - This operation removes the website configuration for a bucket. Amazon S3 returns a - 200 OK response upon successfully deleting a website configuration on - the specified bucket. You will get a 200 OK response if the website configuration - you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE operation requires the S3:DeleteBucketWebsite permission. - By default, only the bucket owner can delete the website configuration attached to - a bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the DeleteBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketWebsite service method, as returned by S3. - - - - - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - The bucket name of the lifecycle to delete. - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - Container for the necessary parameters to execute the DeleteLifecycleConfiguration service method. - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - The bucket name of the lifecycle to delete. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - Container for the necessary parameters to execute the DeleteLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key name of the object to delete. - - The response from the DeleteObject service method, as returned by S3. - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key name of the object to delete. - VersionId used to reference a specific version of the object. - - The response from the DeleteObject service method, as returned by S3. - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - Container for the necessary parameters to execute the DeleteObject service method. - - The response from the DeleteObject service method, as returned by S3. - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key name of the object to delete. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key name of the object to delete. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - Container for the necessary parameters to execute the DeleteObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - - - - This operation enables you to delete multiple objects from a bucket using a single - HTTP request. If you know the object keys that you want to delete, then this operation - provides a suitable alternative to sending individual delete requests, reducing per-request - overhead. - - - - The request contains a list of up to 1000 keys that you want to delete. In the XML, - you provide the object key names, and optionally, version IDs if you want to delete - a specific version of the object from a versioning-enabled bucket. For each key, Amazon - S3 performs a delete operation and returns the result of that delete, success, or - failure, in the response. Note that if the object specified in the request is not - found, Amazon S3 returns the result as deleted. - - - - The operation supports two modes for the response: verbose and quiet. By default, - the operation uses verbose mode in which the response includes the result of deletion - of each key in your request. In quiet mode the response includes only keys where the - delete operation encountered an error. For a successful deletion, the operation does - not return any information about the delete in the response body. - - - - When performing this operation on an MFA Delete enabled bucket, that attempts to delete - any versioned objects, you must include an MFA token. If you do not provide one, the - entire request will fail, even if there are non-versioned objects you are trying to - delete. If you provide an invalid token, whether there are versioned keys in the request - or not, the entire Multi-Object Delete request will fail. For information about MFA - Delete, see - MFA Delete. - - - - Finally, the Content-MD5 header is required for all Multi-Object Delete requests. - Amazon S3 uses the header value to ensure that your request body has not been altered - in transit. - - - - The following operations are related to DeleteObjects: - - - - Container for the necessary parameters to execute the DeleteObjects service method. - - The response from the DeleteObjects service method, as returned by S3. - - - - This operation enables you to delete multiple objects from a bucket using a single - HTTP request. If you know the object keys that you want to delete, then this operation - provides a suitable alternative to sending individual delete requests, reducing per-request - overhead. - - - - The request contains a list of up to 1000 keys that you want to delete. In the XML, - you provide the object key names, and optionally, version IDs if you want to delete - a specific version of the object from a versioning-enabled bucket. For each key, Amazon - S3 performs a delete operation and returns the result of that delete, success, or - failure, in the response. Note that if the object specified in the request is not - found, Amazon S3 returns the result as deleted. - - - - The operation supports two modes for the response: verbose and quiet. By default, - the operation uses verbose mode in which the response includes the result of deletion - of each key in your request. In quiet mode the response includes only keys where the - delete operation encountered an error. For a successful deletion, the operation does - not return any information about the delete in the response body. - - - - When performing this operation on an MFA Delete enabled bucket, that attempts to delete - any versioned objects, you must include an MFA token. If you do not provide one, the - entire request will fail, even if there are non-versioned objects you are trying to - delete. If you provide an invalid token, whether there are versioned keys in the request - or not, the entire Multi-Object Delete request will fail. For information about MFA - Delete, see - MFA Delete. - - - - Finally, the Content-MD5 header is required for all Multi-Object Delete requests. - Amazon S3 uses the header value to ensure that your request body has not been altered - in transit. - - - - The following operations are related to DeleteObjects: - - - - Container for the necessary parameters to execute the DeleteObjects service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObjects service method, as returned by S3. - - - - Removes the entire tag set from the specified object. For more information about managing - object tags, see - Object Tagging. - - - - To use this operation, you must have permission to perform the s3:DeleteObjectTagging - action. - - - - To delete tags of a specific object version, add the versionId query - parameter in the request. You will need permission for the s3:DeleteObjectVersionTagging - action. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteObjectTagging service method. - - The response from the DeleteObjectTagging service method, as returned by S3. - - - - Removes the entire tag set from the specified object. For more information about managing - object tags, see - Object Tagging. - - - - To use this operation, you must have permission to perform the s3:DeleteObjectTagging - action. - - - - To delete tags of a specific object version, add the versionId query - parameter in the request. You will need permission for the s3:DeleteObjectVersionTagging - action. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteObjectTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObjectTagging service method, as returned by S3. - - - - Removes the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:PutBucketPublicAccessBlock - permission. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeletePublicAccessBlock service method. - - The response from the DeletePublicAccessBlock service method, as returned by S3. - - - - Removes the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:PutBucketPublicAccessBlock - permission. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeletePublicAccessBlock service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeletePublicAccessBlock service method, as returned by S3. - - - - - - - - - - - - - - Returns the default encryption configuration for an Amazon S3 bucket. For information - about the Amazon S3 default encryption feature, see Amazon - S3 Default Bucket Encryption. - - - - To use this operation, you must have permission to perform the s3:GetEncryptionConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to GetBucketEncryption: - - - - Container for the necessary parameters to execute the GetBucketEncryption service method. - - The response from the GetBucketEncryption service method, as returned by S3. - - - - Returns the default encryption configuration for an Amazon S3 bucket. For information - about the Amazon S3 default encryption feature, see Amazon - S3 Default Bucket Encryption. - - - - To use this operation, you must have permission to perform the s3:GetEncryptionConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to GetBucketEncryption: - - - - Container for the necessary parameters to execute the GetBucketEncryption service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketEncryption service method, as returned by S3. - - - - Returns an inventory configuration (identified by the inventory configuration ID) - from the bucket. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - The following operations are related to GetBucketInventoryConfiguration: - - - - Container for the necessary parameters to execute the GetBucketInventoryConfiguration service method. - - The response from the GetBucketInventoryConfiguration service method, as returned by S3. - - - - Returns an inventory configuration (identified by the inventory configuration ID) - from the bucket. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - The following operations are related to GetBucketInventoryConfiguration: - - - - Container for the necessary parameters to execute the GetBucketInventoryConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketInventoryConfiguration service method, as returned by S3. - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - The name of the bucket for which to get the location. - - The response from the GetBucketLocation service method, as returned by S3. - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - Container for the necessary parameters to execute the GetBucketLocation service method. - - The response from the GetBucketLocation service method, as returned by S3. - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - The name of the bucket for which to get the location. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLocation service method, as returned by S3. - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - Container for the necessary parameters to execute the GetBucketLocation service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLocation service method, as returned by S3. - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - The bucket name for which to get the logging information. - - The response from the GetBucketLogging service method, as returned by S3. - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - Container for the necessary parameters to execute the GetBucketLogging service method. - - The response from the GetBucketLogging service method, as returned by S3. - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - The bucket name for which to get the logging information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLogging service method, as returned by S3. - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - Container for the necessary parameters to execute the GetBucketLogging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLogging service method, as returned by S3. - - - - Gets a metrics configuration (specified by the metrics configuration ID) from the - bucket. Note that this doesn't include the daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to GetBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the GetBucketMetricsConfiguration service method. - - The response from the GetBucketMetricsConfiguration service method, as returned by S3. - - - - Gets a metrics configuration (specified by the metrics configuration ID) from the - bucket. Note that this doesn't include the daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to GetBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the GetBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketMetricsConfiguration service method, as returned by S3. - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following operation is related to GetBucketNotification: - - - - Name of the bucket for which to get the notification configuration - - The response from the GetBucketNotification service method, as returned by S3. - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following operation is related to GetBucketNotification: - - - - Container for the necessary parameters to execute the GetBucketNotification service method. - - The response from the GetBucketNotification service method, as returned by S3. - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following operation is related to GetBucketNotification: - - - - Name of the bucket for which to get the notification configuration - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketNotification service method, as returned by S3. - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following operation is related to GetBucketNotification: - - - - Container for the necessary parameters to execute the GetBucketNotification service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketNotification service method, as returned by S3. - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operation is related to GetBucketPolicy: - - - - The bucket name for which to get the bucket policy. - - The response from the GetBucketPolicy service method, as returned by S3. - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operation is related to GetBucketPolicy: - - - - Container for the necessary parameters to execute the GetBucketPolicy service method. - - The response from the GetBucketPolicy service method, as returned by S3. - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operation is related to GetBucketPolicy: - - - - The bucket name for which to get the bucket policy. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicy service method, as returned by S3. - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operation is related to GetBucketPolicy: - - - - Container for the necessary parameters to execute the GetBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicy service method, as returned by S3. - - - - Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket - is public. In order to use this operation, you must have the s3:GetBucketPolicyStatus - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - For more information about when Amazon S3 considers a bucket public, see The - Meaning of "Public". - - - - The following operations are related to GetBucketPolicyStatus: - - - - Container for the necessary parameters to execute the GetBucketPolicyStatus service method. - - The response from the GetBucketPolicyStatus service method, as returned by S3. - - - - Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket - is public. In order to use this operation, you must have the s3:GetBucketPolicyStatus - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - For more information about when Amazon S3 considers a bucket public, see The - Meaning of "Public". - - - - The following operations are related to GetBucketPolicyStatus: - - - - Container for the necessary parameters to execute the GetBucketPolicyStatus service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicyStatus service method, as returned by S3. - - - - Retrieves the replication configuration for the given Amazon S3 bucket. - - Container for the necessary parameters to execute the GetBucketReplication service method. - - The response from the GetBucketReplication service method, as returned by S3. - - - - Retrieves the replication configuration for the given Amazon S3 bucket. - - Container for the necessary parameters to execute the GetBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketReplication service method, as returned by S3. - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - The name of the bucket for which to get the payment request configuration - - The response from the GetBucketRequestPayment service method, as returned by S3. - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - Container for the necessary parameters to execute the GetBucketRequestPayment service method. - - The response from the GetBucketRequestPayment service method, as returned by S3. - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - The name of the bucket for which to get the payment request configuration - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketRequestPayment service method, as returned by S3. - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - Container for the necessary parameters to execute the GetBucketRequestPayment service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketRequestPayment service method, as returned by S3. - - - - Returns the tag set associated with the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - GetBucketTagging has the following special error: - -
  • - - Error code: NoSuchTagSetError - -
    • - - Description: There is no tag set associated with the bucket. - -
- - The following operations are related to GetBucketTagging: - - - - Container for the necessary parameters to execute the GetBucketTagging service method. - - The response from the GetBucketTagging service method, as returned by S3. - - - - Returns the tag set associated with the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - GetBucketTagging has the following special error: - -
  • - - Error code: NoSuchTagSetError - -
    • - - Description: There is no tag set associated with the bucket. - -
- - The following operations are related to GetBucketTagging: - - - - Container for the necessary parameters to execute the GetBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketTagging service method, as returned by S3. - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - The name of the bucket for which to get the versioning information. - - The response from the GetBucketVersioning service method, as returned by S3. - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - Container for the necessary parameters to execute the GetBucketVersioning service method. - - The response from the GetBucketVersioning service method, as returned by S3. - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - The name of the bucket for which to get the versioning information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketVersioning service method, as returned by S3. - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - Container for the necessary parameters to execute the GetBucketVersioning service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketVersioning service method, as returned by S3. - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET operation requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which to get the website configuration. - - The response from the GetBucketWebsite service method, as returned by S3. - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET operation requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the GetBucketWebsite service method. - - The response from the GetBucketWebsite service method, as returned by S3. - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET operation requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which to get the website configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketWebsite service method, as returned by S3. - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET operation requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the GetBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketWebsite service method, as returned by S3. - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - The bucket name for which to get the cors configuration. - - The response from the GetCORSConfiguration service method, as returned by S3. - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - Container for the necessary parameters to execute the GetCORSConfiguration service method. - - The response from the GetCORSConfiguration service method, as returned by S3. - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - The bucket name for which to get the cors configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetCORSConfiguration service method, as returned by S3. - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - Container for the necessary parameters to execute the GetCORSConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetCORSConfiguration service method, as returned by S3. - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are still using previous version of the lifecycle configuration, it works. - For the earlier API description, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to DeleteBucketMetricsConfiguration: - - - - The name of the bucket for which to get the lifecycle information. - - The response from the GetLifecycleConfiguration service method, as returned by S3. - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are still using previous version of the lifecycle configuration, it works. - For the earlier API description, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the GetLifecycleConfiguration service method. - - The response from the GetLifecycleConfiguration service method, as returned by S3. - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are still using previous version of the lifecycle configuration, it works. - For the earlier API description, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to DeleteBucketMetricsConfiguration: - - - - The name of the bucket for which to get the lifecycle information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetLifecycleConfiguration service method, as returned by S3. - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are still using previous version of the lifecycle configuration, it works. - For the earlier API description, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the GetLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetLifecycleConfiguration service method, as returned by S3. - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object to get. - - The response from the GetObject service method, as returned by S3. - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object to get. - VersionId used to reference a specific version of the object. - - The response from the GetObject service method, as returned by S3. - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - Container for the necessary parameters to execute the GetObject service method. - - The response from the GetObject service method, as returned by S3. - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object to get. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object to get. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - Container for the necessary parameters to execute the GetObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - - - - Gets an object's current Legal Hold status. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLegalHold service method. - - The response from the GetObjectLegalHold service method, as returned by S3. - - - - Gets an object's current Legal Hold status. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLegalHold service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectLegalHold service method, as returned by S3. - - - - Gets the Object Lock configuration for a bucket. The rule specified in the Object - Lock configuration will be applied by default to every new object placed in the specified - bucket. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLockConfiguration service method. - - The response from the GetObjectLockConfiguration service method, as returned by S3. - - - - Gets the Object Lock configuration for a bucket. The rule specified in the Object - Lock configuration will be applied by default to every new object placed in the specified - bucket. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLockConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectLockConfiguration service method, as returned by S3. - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - The name of the bucket containing the object. - The object key. - - The response from the GetObjectMetadata service method, as returned by S3. - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - The name of the bucket containing the object. - The object key. - VersionId used to reference a specific version of the object. - - The response from the GetObjectMetadata service method, as returned by S3. - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - Container for the necessary parameters to execute the GetObjectMetadata service method. - - The response from the GetObjectMetadata service method, as returned by S3. - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - The name of the bucket containing the object. - The object key. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - The name of the bucket containing the object. - The object key. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - Container for the necessary parameters to execute the GetObjectMetadata service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - - - - Retrieves an object's retention settings. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectRetention service method. - - The response from the GetObjectRetention service method, as returned by S3. - - - - Retrieves an object's retention settings. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectRetention service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectRetention service method, as returned by S3. - - - - Returns the tag-set of an object. You send the GET request against the tagging subresource - associated with the object. - - - - To use this operation, you must have permission to perform the s3:GetObjectTagging - action. By default, the GET operation returns information about current version of - an object. For a versioned bucket, you can have multiple versions of an object in - your bucket. To retrieve tags of any other version, use the versionId query parameter. - You also need permission for the s3:GetObjectVersionTagging action. - - - - By default, the bucket owner has this permission and can grant this permission to - others. - - - - For information about the Amazon S3 object tagging feature, see Object - Tagging. - - - - The following operation is related to GetObjectTagging: - - - - Container for the necessary parameters to execute the GetObjectTagging service method. - - The response from the GetObjectTagging service method, as returned by S3. - - - - Returns the tag-set of an object. You send the GET request against the tagging subresource - associated with the object. - - - - To use this operation, you must have permission to perform the s3:GetObjectTagging - action. By default, the GET operation returns information about current version of - an object. For a versioned bucket, you can have multiple versions of an object in - your bucket. To retrieve tags of any other version, use the versionId query parameter. - You also need permission for the s3:GetObjectVersionTagging action. - - - - By default, the bucket owner has this permission and can grant this permission to - others. - - - - For information about the Amazon S3 object tagging feature, see Object - Tagging. - - - - The following operation is related to GetObjectTagging: - - - - Container for the necessary parameters to execute the GetObjectTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTagging service method, as returned by S3. - - - - Return torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Amazon - S3 Torrent. - - - - You can get torrent only for objects that are less than 5 GB in size and that are - not encrypted using server-side encryption with customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - The following operation is related to GetObjectTorrent: - - - - The name of the bucket containing the object for which to get the torrent files. - The object key for which to get the information. - - The response from the GetObjectTorrent service method, as returned by S3. - - - - Return torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Amazon - S3 Torrent. - - - - You can get torrent only for objects that are less than 5 GB in size and that are - not encrypted using server-side encryption with customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - The following operation is related to GetObjectTorrent: - - - - Container for the necessary parameters to execute the GetObjectTorrent service method. - - The response from the GetObjectTorrent service method, as returned by S3. - - - - Return torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Amazon - S3 Torrent. - - - - You can get torrent only for objects that are less than 5 GB in size and that are - not encrypted using server-side encryption with customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - The following operation is related to GetObjectTorrent: - - - - The name of the bucket containing the object for which to get the torrent files. - The object key for which to get the information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTorrent service method, as returned by S3. - - - - Return torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Amazon - S3 Torrent. - - - - You can get torrent only for objects that are less than 5 GB in size and that are - not encrypted using server-side encryption with customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - The following operation is related to GetObjectTorrent: - - - - Container for the necessary parameters to execute the GetObjectTorrent service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTorrent service method, as returned by S3. - - - - Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:GetBucketPublicAccessBlock - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket - or an object, it checks the PublicAccessBlock configuration for both - the bucket (or the bucket that contains the object) and the bucket owner's account. - If the PublicAccessBlock settings are different between the bucket and - the account, Amazon S3 uses the most restrictive combination of the bucket-level and - account-level settings. - - - - For more information about when Amazon S3 considers a bucket or an object public, - see The - Meaning of "Public". - - - - The following operations are related to GetPublicAccessBlock: - - - - Container for the necessary parameters to execute the GetPublicAccessBlock service method. - - The response from the GetPublicAccessBlock service method, as returned by S3. - - - - Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:GetBucketPublicAccessBlock - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket - or an object, it checks the PublicAccessBlock configuration for both - the bucket (or the bucket that contains the object) and the bucket owner's account. - If the PublicAccessBlock settings are different between the bucket and - the account, Amazon S3 uses the most restrictive combination of the bucket-level and - account-level settings. - - - - For more information about when Amazon S3 considers a bucket or an object public, - see The - Meaning of "Public". - - - - The following operations are related to GetPublicAccessBlock: - - - - Container for the necessary parameters to execute the GetPublicAccessBlock service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetPublicAccessBlock service method, as returned by S3. - - - - This operation initiates a multipart upload and returns an upload ID. This upload - ID is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort operation - and Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload API and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart) and UploadPartCopy) requests must match the headers you - used in the request to initiate the upload by using CreateMultipartUpload. - - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, - kms:GenerateDataKey*, and kms:DescribeKey actions on the - key. These permissions are required because Amazon S3 must decrypt and read data from - the encrypted file parts before it completes the multipart upload. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - The following operations are related to CreateMultipartUpload: - - - - The name of the bucket to which to initiate the upload - Object key for which the multipart upload is to be initiated. - - The response from the InitiateMultipartUpload service method, as returned by S3. - - - - This operation initiates a multipart upload and returns an upload ID. This upload - ID is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort operation - and Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload API and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart) and UploadPartCopy) requests must match the headers you - used in the request to initiate the upload by using CreateMultipartUpload. - - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, - kms:GenerateDataKey*, and kms:DescribeKey actions on the - key. These permissions are required because Amazon S3 must decrypt and read data from - the encrypted file parts before it completes the multipart upload. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - The following operations are related to CreateMultipartUpload: - - - - Container for the necessary parameters to execute the InitiateMultipartUpload service method. - - The response from the InitiateMultipartUpload service method, as returned by S3. - - - - This operation initiates a multipart upload and returns an upload ID. This upload - ID is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort operation - and Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload API and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart) and UploadPartCopy) requests must match the headers you - used in the request to initiate the upload by using CreateMultipartUpload. - - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, - kms:GenerateDataKey*, and kms:DescribeKey actions on the - key. These permissions are required because Amazon S3 must decrypt and read data from - the encrypted file parts before it completes the multipart upload. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - The following operations are related to CreateMultipartUpload: - - - - The name of the bucket to which to initiate the upload - Object key for which the multipart upload is to be initiated. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the InitiateMultipartUpload service method, as returned by S3. - - - - This operation initiates a multipart upload and returns an upload ID. This upload - ID is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort operation - and Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload API and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart) and UploadPartCopy) requests must match the headers you - used in the request to initiate the upload by using CreateMultipartUpload. - - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, - kms:GenerateDataKey*, and kms:DescribeKey actions on the - key. These permissions are required because Amazon S3 must decrypt and read data from - the encrypted file parts before it completes the multipart upload. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - The following operations are related to CreateMultipartUpload: - - - - Container for the necessary parameters to execute the InitiateMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the InitiateMultipartUpload service method, as returned by S3. - - - - Lists the analytics configurations for the bucket. You can have up to 1,000 analytics - configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. You should always check the IsTruncated element in the response. - If there are no more configurations to list, IsTruncated is set to false. - If there are more configurations to list, IsTruncated is set to true, - and there will be a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to ListBucketAnalyticsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketAnalyticsConfigurations service method. - - The response from the ListBucketAnalyticsConfigurations service method, as returned by S3. - - - - Lists the analytics configurations for the bucket. You can have up to 1,000 analytics - configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. You should always check the IsTruncated element in the response. - If there are no more configurations to list, IsTruncated is set to false. - If there are more configurations to list, IsTruncated is set to true, - and there will be a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to ListBucketAnalyticsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketAnalyticsConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketAnalyticsConfigurations service method, as returned by S3. - - - - Returns a list of inventory configurations for the bucket. You can have up to 1,000 - analytics configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory - - - - The following operations are related to ListBucketInventoryConfigurations: - - - - Container for the necessary parameters to execute the ListBucketInventoryConfigurations service method. - - The response from the ListBucketInventoryConfigurations service method, as returned by S3. - - - - Returns a list of inventory configurations for the bucket. You can have up to 1,000 - analytics configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory - - - - The following operations are related to ListBucketInventoryConfigurations: - - - - Container for the necessary parameters to execute the ListBucketInventoryConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketInventoryConfigurations service method, as returned by S3. - - - - Lists the metrics configurations for the bucket. The metrics configurations are only - for the request metrics of the bucket and do not provide information on daily storage - metrics. You can have up to 1,000 configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For more information about metrics configurations and CloudWatch request metrics, - see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to ListBucketMetricsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketMetricsConfigurations service method. - - The response from the ListBucketMetricsConfigurations service method, as returned by S3. - - - - Lists the metrics configurations for the bucket. The metrics configurations are only - for the request metrics of the bucket and do not provide information on daily storage - metrics. You can have up to 1,000 configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For more information about metrics configurations and CloudWatch request metrics, - see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to ListBucketMetricsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketMetricsConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketMetricsConfigurations service method, as returned by S3. - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - - The response from the ListBuckets service method, as returned by S3. - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - Container for the necessary parameters to execute the ListBuckets service method. - - The response from the ListBuckets service method, as returned by S3. - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBuckets service method, as returned by S3. - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - Container for the necessary parameters to execute the ListBuckets service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBuckets service method, as returned by S3. - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - - The response from the ListMultipartUploads service method, as returned by S3. - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) - - The response from the ListMultipartUploads service method, as returned by S3. - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Container for the necessary parameters to execute the ListMultipartUploads service method. - - The response from the ListMultipartUploads service method, as returned by S3. - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Container for the necessary parameters to execute the ListMultipartUploads service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. - - The response from the ListObjects service method, as returned by S3. - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. - Limits the response to keys that begin with the specified prefix. - - The response from the ListObjects service method, as returned by S3. - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - Container for the necessary parameters to execute the ListObjects service method. - - The response from the ListObjects service method, as returned by S3. - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. - Limits the response to keys that begin with the specified prefix. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - Container for the necessary parameters to execute the ListObjects service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Make sure to design - your application to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - To use this operation in an AWS Identity and Access Management (IAM) policy, you must - have permissions to perform the s3:ListBucket action. The bucket owner - has this permission by default and can grant this permission to others. For more information - about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - This section describes the latest revision of the API. We recommend that you use this - revised API for application development. For backward compatibility, Amazon S3 continues - to support the prior version of this API, ListObjects. - - - - To get a list of your buckets, see ListBuckets. - - - - The following operations are related to ListObjectsV2: - - - - Container for the necessary parameters to execute the ListObjectsV2 service method. - - The response from the ListObjectsV2 service method, as returned by S3. - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Make sure to design - your application to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - To use this operation in an AWS Identity and Access Management (IAM) policy, you must - have permissions to perform the s3:ListBucket action. The bucket owner - has this permission by default and can grant this permission to others. For more information - about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - This section describes the latest revision of the API. We recommend that you use this - revised API for application development. For backward compatibility, Amazon S3 continues - to support the prior version of this API, ListObjects. - - - - To get a list of your buckets, see ListBuckets. - - - - The following operations are related to ListObjectsV2: - - - - Container for the necessary parameters to execute the ListObjectsV2 service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjectsV2 service method, as returned by S3. - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). This request returns a maximum of 1,000 - uploaded parts. The default number of parts returned is 1,000 parts. You can restrict - the number of parts returned by specifying the max-parts request parameter. - If your multipart upload consists of more than 1,000 parts, the response returns an - IsTruncated field with the value of true, and a NextPartNumberMarker - element. In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListParts: - - - - Name of the bucket to which the parts are being uploaded. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Object key for which the multipart upload was initiated. - Upload ID identifying the multipart upload whose parts are being listed. - - The response from the ListParts service method, as returned by S3. - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). This request returns a maximum of 1,000 - uploaded parts. The default number of parts returned is 1,000 parts. You can restrict - the number of parts returned by specifying the max-parts request parameter. - If your multipart upload consists of more than 1,000 parts, the response returns an - IsTruncated field with the value of true, and a NextPartNumberMarker - element. In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListParts: - - - - Container for the necessary parameters to execute the ListParts service method. - - The response from the ListParts service method, as returned by S3. - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). This request returns a maximum of 1,000 - uploaded parts. The default number of parts returned is 1,000 parts. You can restrict - the number of parts returned by specifying the max-parts request parameter. - If your multipart upload consists of more than 1,000 parts, the response returns an - IsTruncated field with the value of true, and a NextPartNumberMarker - element. In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListParts: - - - - Name of the bucket to which the parts are being uploaded. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Object key for which the multipart upload was initiated. - Upload ID identifying the multipart upload whose parts are being listed. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListParts service method, as returned by S3. - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). This request returns a maximum of 1,000 - uploaded parts. The default number of parts returned is 1,000 parts. You can restrict - the number of parts returned by specifying the max-parts request parameter. - If your multipart upload consists of more than 1,000 parts, the response returns an - IsTruncated field with the value of true, and a NextPartNumberMarker - element. In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListParts: - - - - Container for the necessary parameters to execute the ListParts service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListParts service method, as returned by S3. - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - - The response from the ListVersions service method, as returned by S3. - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes. - - The response from the ListVersions service method, as returned by S3. - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - Container for the necessary parameters to execute the ListVersions service method. - - The response from the ListVersions service method, as returned by S3. - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - Container for the necessary parameters to execute the ListVersions service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - - - - - - Creates a new bucket. To create a bucket, you must register with Amazon S3 and have - a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed - to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information on bucket naming restrictions, - see Working - with Amazon S3 Buckets. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the EU (Ireland) - Region. For more information, see How - to Select a Region for Your Buckets. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - Hosting of Buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - The name of the bucket to create. - - The response from the PutBucket service method, as returned by S3. - - - - Creates a new bucket. To create a bucket, you must register with Amazon S3 and have - a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed - to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information on bucket naming restrictions, - see Working - with Amazon S3 Buckets. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the EU (Ireland) - Region. For more information, see How - to Select a Region for Your Buckets. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - Hosting of Buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - Container for the necessary parameters to execute the PutBucket service method. - - The response from the PutBucket service method, as returned by S3. - - - - Creates a new bucket. To create a bucket, you must register with Amazon S3 and have - a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed - to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information on bucket naming restrictions, - see Working - with Amazon S3 Buckets. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the EU (Ireland) - Region. For more information, see How - to Select a Region for Your Buckets. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - Hosting of Buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - The name of the bucket to create. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucket service method, as returned by S3. - - - - Creates a new bucket. To create a bucket, you must register with Amazon S3 and have - a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed - to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information on bucket naming restrictions, - see Working - with Amazon S3 Buckets. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the EU (Ireland) - Region. For more information, see How - to Select a Region for Your Buckets. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - Hosting of Buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - Container for the necessary parameters to execute the PutBucket service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucket service method, as returned by S3. - - - - Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration - is a bucket-level feature that enables you to perform faster data transfers to Amazon - S3. - - - - To use this operation, you must have permission to perform the s3:PutAccelerateConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The Transfer Acceleration state of a bucket can be set to one of the following two - values: - -
  • - - Enabled – Enables accelerated data transfers to the bucket. - -
  • - - Suspended – Disables accelerated data transfers to the bucket. - -
- - The GetBucketAccelerateConfiguration operation returns the transfer acceleration - state of a bucket. - - - - After setting the Transfer Acceleration state of a bucket to Enabled, it might take - up to thirty minutes before the data transfer rates to the bucket increase. - - - - The name of the bucket used for Transfer Acceleration must be DNS-compliant and must - not contain periods ("."). - - - - For more information about transfer acceleration, see Transfer - Acceleration. - - - - The following operations are related to PutBucketAccelerateConfiguration: - - - - Container for the necessary parameters to execute the PutBucketAccelerateConfiguration service method. - - The response from the PutBucketAccelerateConfiguration service method, as returned by S3. - - - - Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration - is a bucket-level feature that enables you to perform faster data transfers to Amazon - S3. - - - - To use this operation, you must have permission to perform the s3:PutAccelerateConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The Transfer Acceleration state of a bucket can be set to one of the following two - values: - -
  • - - Enabled – Enables accelerated data transfers to the bucket. - -
  • - - Suspended – Disables accelerated data transfers to the bucket. - -
- - The GetBucketAccelerateConfiguration operation returns the transfer acceleration - state of a bucket. - - - - After setting the Transfer Acceleration state of a bucket to Enabled, it might take - up to thirty minutes before the data transfer rates to the bucket increase. - - - - The name of the bucket used for Transfer Acceleration must be DNS-compliant and must - not contain periods ("."). - - - - For more information about transfer acceleration, see Transfer - Acceleration. - - - - The following operations are related to PutBucketAccelerateConfiguration: - - - - Container for the necessary parameters to execute the PutBucketAccelerateConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketAccelerateConfiguration service method, as returned by S3. - - - - - - - - - - Set the logging parameters for a bucket and to specify permissions for who can view - and modify the logging parameters. All logs are saved to buckets in the same AWS Region - as the source bucket. To set the logging status of a bucket, you must be the bucket - owner. - - - - The bucket owner is automatically granted FULL_CONTROL to all logs. You use the Grantee - request element to grant access to other people. The Permissions request - element specifies the kind of access the grantee has to the logs. - - - - Grantee Values - - - - You can specify the person (grantee) to whom you're assigning access rights (using - request elements) in the following ways: - -
  • - - By the person's ID: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> - </Grantee> - - - - DisplayName is optional and ignored in the request. - -
  • - - By Email address: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee> - - - - - The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl - request, appears as the CanonicalUser. - -
  • - - By URI: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee> - - -
- - To enable logging, you use LoggingEnabled and its children request elements. To disable - logging, you use an empty BucketLoggingStatus request element: - - - - <BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01" /> - - - - - For more information about server access logging, see Server - Access Logging. - - - - For more information about creating a bucket, see CreateBucket. For more information - about returning the logging status of a bucket, see GetBucketLogging. - - - - The following operations are related to PutBucketLogging: - - - - Container for the necessary parameters to execute the PutBucketLogging service method. - - The response from the PutBucketLogging service method, as returned by S3. - - - - Set the logging parameters for a bucket and to specify permissions for who can view - and modify the logging parameters. All logs are saved to buckets in the same AWS Region - as the source bucket. To set the logging status of a bucket, you must be the bucket - owner. - - - - The bucket owner is automatically granted FULL_CONTROL to all logs. You use the Grantee - request element to grant access to other people. The Permissions request - element specifies the kind of access the grantee has to the logs. - - - - Grantee Values - - - - You can specify the person (grantee) to whom you're assigning access rights (using - request elements) in the following ways: - -
  • - - By the person's ID: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> - </Grantee> - - - - DisplayName is optional and ignored in the request. - -
  • - - By Email address: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee> - - - - - The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl - request, appears as the CanonicalUser. - -
  • - - By URI: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee> - - -
- - To enable logging, you use LoggingEnabled and its children request elements. To disable - logging, you use an empty BucketLoggingStatus request element: - - - - <BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01" /> - - - - - For more information about server access logging, see Server - Access Logging. - - - - For more information about creating a bucket, see CreateBucket. For more information - about returning the logging status of a bucket, see GetBucketLogging. - - - - The following operations are related to PutBucketLogging: - - - - Container for the necessary parameters to execute the PutBucketLogging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketLogging service method, as returned by S3. - - - - Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. - You can have up to 1,000 metrics configurations per bucket. If you're updating an - existing metrics configuration, note that this is a full replacement of the existing - metrics configuration. If you don't include the elements you want to keep, they are - erased. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to PutBucketMetricsConfiguration: - - - - GetBucketLifecycle has the following special error: - -
  • - - Error code: TooManyConfigurations - -
    • - - Description: You are attempting to create a new configuration but have already reached - the 1,000-configuration limit. - -
    • - - HTTP Status Code: HTTP 400 Bad Request - -
- - Container for the necessary parameters to execute the PutBucketMetricsConfiguration service method. - - The response from the PutBucketMetricsConfiguration service method, as returned by S3. - - - - Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. - You can have up to 1,000 metrics configurations per bucket. If you're updating an - existing metrics configuration, note that this is a full replacement of the existing - metrics configuration. If you don't include the elements you want to keep, they are - erased. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to PutBucketMetricsConfiguration: - - - - GetBucketLifecycle has the following special error: - -
  • - - Error code: TooManyConfigurations - -
    • - - Description: You are attempting to create a new configuration but have already reached - the 1,000-configuration limit. - -
    • - - HTTP Status Code: HTTP 400 Bad Request - -
- - Container for the necessary parameters to execute the PutBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketMetricsConfiguration service method, as returned by S3. - - - - Enables notifications of specified events for a bucket. For more information about - event notifications, see Configuring - Event Notifications. - - - - Using this API, you can replace an existing notification configuration. The configuration - is an XML file that defines the event types that you want Amazon S3 to publish and - the destination where you want Amazon S3 to publish an event notification when it - detects an event of the specified type. - - - - By default, your bucket has no event notifications configured. That is, the notification - configuration will be an empty NotificationConfiguration. - - - - <NotificationConfiguration> - - - - </NotificationConfiguration> - - - - This operation replaces the existing notification configuration with the configuration - you include in the request body. - - - - After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification - Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, - and that the bucket owner has permission to publish to it by sending a test notification. - In the case of AWS Lambda destinations, Amazon S3 verifies that the Lambda function - permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. - For more information, see Configuring - Notifications for Amazon S3 Events. - - - - You can disable notifications by adding the empty NotificationConfiguration element. - - - - By default, only the bucket owner can configure notifications on a bucket. However, - bucket owners can use a bucket policy to grant permission to other users to set this - configuration with s3:PutBucketNotification permission. - - - - The PUT notification is an atomic operation. For example, suppose your notification - configuration includes SNS topic, SQS queue, and Lambda function configurations. When - you send a PUT request with this configuration, Amazon S3 sends test messages to your - SNS topic. If the message fails, the entire PUT operation will fail, and Amazon S3 - will not add the configuration to your bucket. - - - - Responses - - - - If the configuration in the request body includes only one TopicConfiguration - specifying only the s3:ReducedRedundancyLostObject event type, the response - will also include the x-amz-sns-test-message-id header containing the - message ID of the test notification sent to the topic. - - - - The following operation is related to PutBucketNotificationConfiguration: - - - - Container for the necessary parameters to execute the PutBucketNotification service method. - - The response from the PutBucketNotification service method, as returned by S3. - - - - Enables notifications of specified events for a bucket. For more information about - event notifications, see Configuring - Event Notifications. - - - - Using this API, you can replace an existing notification configuration. The configuration - is an XML file that defines the event types that you want Amazon S3 to publish and - the destination where you want Amazon S3 to publish an event notification when it - detects an event of the specified type. - - - - By default, your bucket has no event notifications configured. That is, the notification - configuration will be an empty NotificationConfiguration. - - - - <NotificationConfiguration> - - - - </NotificationConfiguration> - - - - This operation replaces the existing notification configuration with the configuration - you include in the request body. - - - - After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification - Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, - and that the bucket owner has permission to publish to it by sending a test notification. - In the case of AWS Lambda destinations, Amazon S3 verifies that the Lambda function - permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. - For more information, see Configuring - Notifications for Amazon S3 Events. - - - - You can disable notifications by adding the empty NotificationConfiguration element. - - - - By default, only the bucket owner can configure notifications on a bucket. However, - bucket owners can use a bucket policy to grant permission to other users to set this - configuration with s3:PutBucketNotification permission. - - - - The PUT notification is an atomic operation. For example, suppose your notification - configuration includes SNS topic, SQS queue, and Lambda function configurations. When - you send a PUT request with this configuration, Amazon S3 sends test messages to your - SNS topic. If the message fails, the entire PUT operation will fail, and Amazon S3 - will not add the configuration to your bucket. - - - - Responses - - - - If the configuration in the request body includes only one TopicConfiguration - specifying only the s3:ReducedRedundancyLostObject event type, the response - will also include the x-amz-sns-test-message-id header containing the - message ID of the test notification sent to the topic. - - - - The following operation is related to PutBucketNotificationConfiguration: - - - - Container for the necessary parameters to execute the PutBucketNotification service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketNotification service method, as returned by S3. - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - - The response from the PutBucketPolicy service method, as returned by S3. - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - The MD5 hash of the request body. - - The response from the PutBucketPolicy service method, as returned by S3. - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - Container for the necessary parameters to execute the PutBucketPolicy service method. - - The response from the PutBucketPolicy service method, as returned by S3. - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - The MD5 hash of the request body. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - Container for the necessary parameters to execute the PutBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - - - - Creates a replication configuration or replaces an existing one. For more information, - see Replication - in the Amazon S3 Developer Guide. - - - - To perform this operation, the user or role performing the operation must have the - iam:PassRole - permission. - - - - Specify the replication configuration in the request body. In the replication configuration, - you provide the name of the destination bucket where you want Amazon S3 to replicate - objects, the IAM role that Amazon S3 can assume to replicate objects on your behalf, - and other relevant information. - - - - A replication configuration must include at least one rule, and can contain a maximum - of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects - in the source bucket. To choose additional subsets of objects to replicate, add a - rule for each subset. All rules must specify the same destination bucket. - - - - To specify a subset of the objects in the source bucket to apply a replication rule - to, add the Filter element as a child of the Rule element. You can filter objects - based on an object key prefix, one or more object tags, or both. When you add the - Filter element in the configuration, you must also add the following elements: DeleteMarkerReplication, - Status, and Priority. - - - - For information about enabling versioning on a bucket, see Using - Versioning. - - - - By default, a resource owner, in this case the AWS account that created the bucket, - can perform this operation. The resource owner can also grant others permissions to - perform the operation. For more information about permissions, see Specifying - Permissions in a Policy and Managing - Access Permissions to Your Amazon S3 Resources. - - - - Handling Replication of Encrypted Objects - - - - By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side - encryption with CMKs stored in AWS KMS. To replicate AWS KMS-encrypted objects, add - the following: SourceSelectionCriteria, SseKmsEncryptedObjects, - Status, EncryptionConfiguration, and ReplicaKmsKeyID. - For information about replication configuration, see Replicating - Objects Created with SSE Using CMKs stored in AWS KMS. - - - - For information on PutBucketReplication errors, see ReplicationErrorCodeList - - - - - The following operations are related to PutBucketReplication: - - - - Container for the necessary parameters to execute the PutBucketReplication service method. - - The response from the PutBucketReplication service method, as returned by S3. - - - - Creates a replication configuration or replaces an existing one. For more information, - see Replication - in the Amazon S3 Developer Guide. - - - - To perform this operation, the user or role performing the operation must have the - iam:PassRole - permission. - - - - Specify the replication configuration in the request body. In the replication configuration, - you provide the name of the destination bucket where you want Amazon S3 to replicate - objects, the IAM role that Amazon S3 can assume to replicate objects on your behalf, - and other relevant information. - - - - A replication configuration must include at least one rule, and can contain a maximum - of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects - in the source bucket. To choose additional subsets of objects to replicate, add a - rule for each subset. All rules must specify the same destination bucket. - - - - To specify a subset of the objects in the source bucket to apply a replication rule - to, add the Filter element as a child of the Rule element. You can filter objects - based on an object key prefix, one or more object tags, or both. When you add the - Filter element in the configuration, you must also add the following elements: DeleteMarkerReplication, - Status, and Priority. - - - - For information about enabling versioning on a bucket, see Using - Versioning. - - - - By default, a resource owner, in this case the AWS account that created the bucket, - can perform this operation. The resource owner can also grant others permissions to - perform the operation. For more information about permissions, see Specifying - Permissions in a Policy and Managing - Access Permissions to Your Amazon S3 Resources. - - - - Handling Replication of Encrypted Objects - - - - By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side - encryption with CMKs stored in AWS KMS. To replicate AWS KMS-encrypted objects, add - the following: SourceSelectionCriteria, SseKmsEncryptedObjects, - Status, EncryptionConfiguration, and ReplicaKmsKeyID. - For information about replication configuration, see Replicating - Objects Created with SSE Using CMKs stored in AWS KMS. - - - - For information on PutBucketReplication errors, see ReplicationErrorCodeList - - - - - The following operations are related to PutBucketReplication: - - - - Container for the necessary parameters to execute the PutBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketReplication service method, as returned by S3. - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - The bucket name. - Container for Payer. - - The response from the PutBucketRequestPayment service method, as returned by S3. - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - Container for the necessary parameters to execute the PutBucketRequestPayment service method. - - The response from the PutBucketRequestPayment service method, as returned by S3. - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - The bucket name. - Container for Payer. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketRequestPayment service method, as returned by S3. - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - Container for the necessary parameters to execute the PutBucketRequestPayment service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketRequestPayment service method, as returned by S3. - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging. - - - - Within a bucket, if you add a tag that has the same key as an existing tag, the new - value overwrites the old value. For more information, see Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional operation is currently in progress against - this resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - The bucket name. - A property of PutBucketTaggingRequest used to execute the PutBucketTagging service method. - - The response from the PutBucketTagging service method, as returned by S3. - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging. - - - - Within a bucket, if you add a tag that has the same key as an existing tag, the new - value overwrites the old value. For more information, see Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional operation is currently in progress against - this resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - Container for the necessary parameters to execute the PutBucketTagging service method. - - The response from the PutBucketTagging service method, as returned by S3. - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging. - - - - Within a bucket, if you add a tag that has the same key as an existing tag, the new - value overwrites the old value. For more information, see Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional operation is currently in progress against - this resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - The bucket name. - A property of PutBucketTaggingRequest used to execute the PutBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketTagging service method, as returned by S3. - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging. - - - - Within a bucket, if you add a tag that has the same key as an existing tag, the new - value overwrites the old value. For more information, see Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional operation is currently in progress against - this resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - Container for the necessary parameters to execute the PutBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketTagging service method, as returned by S3. - - - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT operation requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - The bucket name. - Container for the request. - - The response from the PutBucketWebsite service method, as returned by S3. - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT operation requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - Container for the necessary parameters to execute the PutBucketWebsite service method. - - The response from the PutBucketWebsite service method, as returned by S3. - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT operation requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - The bucket name. - Container for the request. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketWebsite service method, as returned by S3. - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT operation requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - Container for the necessary parameters to execute the PutBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketWebsite service method, as returned by S3. - - - - - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - The name of the bucket for which to set the configuration. - A property of PutLifecycleConfigurationRequest used to execute the PutLifecycleConfiguration service method. - - The response from the PutLifecycleConfiguration service method, as returned by S3. - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - Container for the necessary parameters to execute the PutLifecycleConfiguration service method. - - The response from the PutLifecycleConfiguration service method, as returned by S3. - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - The name of the bucket for which to set the configuration. - A property of PutLifecycleConfigurationRequest used to execute the PutLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutLifecycleConfiguration service method, as returned by S3. - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - Container for the necessary parameters to execute the PutLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutLifecycleConfiguration service method, as returned by S3. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Custom pipeline handler to clean up streams in case of an exception. - - - - - Catch exceptions and clean up any open streams. - - - - - - Catch exceptions and clean up any open streams. - - - - - - - Custom pipeline handler to enable sig V4 for Get requests. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Custom pipeline handler to enable sig V4 for Get requests. - - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Calls the post invoke logic after calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls the and post invoke logic after calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Constructor for AmazonS3RetryPolicy. - - The IClientConfig object - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - - - a value if it can be determined, or null if the IO-bound calculations need to be done - - - - Return true if the request should be retried. Implements additional checks - specific to S3 on top of the checks in DefaultRetryPolicy. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Return true if the request should be retried. Implements additional checks - specific to S3 on top of the checks in DefaultRetryPolicy. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Marker interface to identify AmazonS3EncryptionClient. - - - - - Service metadata for Amazon S3 service - - - - - Gets the value of the Service Id. - - - - - Gets the dictionary that gives mapping of renamed operations - - - - - The parameters to request an abort of a multipart upload. - - - After a multipart upload is aborted, no additional parts can be uploaded using that upload ID. - The storage consumed by any previously uploaded parts will be freed. However, if any part uploads - are currently in progress, those part uploads might or might not succeed. As a result, it might be - necessary to abort a given multipart upload multiple times in order to completely free all storage - consumed by all parts. - - - - - The bucket name to which the upload was taking place. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The key of the S3 object that was being uploaded. - - - - - The upload id for the in-progress multipart upload that should be aborted. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the AbortMultipartUpload response metadata. - The AbortMultipartUpload operation has a void result type. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Bucket accelerate configuration. - - - - - The accelerate status of the bucket. - - - - - AccessControlTranslation class - - - - - The override value for the owner of the replica object. - - - - - Class for AnalyticsAndOperator - A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. - The operator must have at least two predicates, and an object must match all of the predicates - in order for the filter to apply. - - Note: The current implementation restricts the usage to atmost one AnalyticsPrefixPredicate - and any number of AnalyticsTagPredicates. - - - - Class for AnalyticsConfiguration - - - - - The identifier used to represent an analytics configuration. - - - - - The filter used to describe a set of objects for analyses. - A filter must have exactly one prefix, one tag, or one conjunction (AnalyticsAndOperator). - If no filter is provided, all objects will be considered in any analysis. - - - - - If present, it indicates that data related to access patterns will be collected - and made available to analyze the tradeoffs between different storage classes. - - - - - Class for AnalyticsExportDestination - - - - - A destination signifying output to an S3 bucket. - - - - - Filter class for Metrics. - - - - - Filter Predicate setup for specific filter types. - - - - - Filter Predicate abstract class for specific filter types to be derived from. - - - - - Abstract class that can be used over logical filter predicates,i.e. AND/OR. - - - - - Internal implementation of Metrics Predicate visitor interface. - - - - - Interface for implementing visitor pattern in Analytics Predicate Filter. - - - - - Interface for implementing visitor pattern in Inventory Predicate Filter. - - - - - Interface for implementing visitor pattern in Metrics Predicate Filter. - - - - - Defines the interface that is used to visit all the different - implementations of - - - - - Visit a - - - - - - Visit a - - - - - - Visit a - - - - - - Implementation of to marshall . - - - - - AbortIncompleteMultipartUpload Unmarshaller - - - - - Abort Multipart Upload Request Marshaller - - - - - Response Unmarshaller for AbortMultipartUpload operation - - - - - AnalyticsConfiguration Unmarshaller - - - - - AnalyticsExportDestinationUnmarshaller - - - - - AnalyticsFilter Unmarshaller - - - - - AnalyticsS3BucketDestination Unmarshaller - - - - - Bucket Unmarshaller - - - - - CommonPrefixesItem Unmarshaller - - - - - Complete Multipart Upload Request Marshaller - - - - - Response Unmarshaller for CompleteMultipartUpload operation - - - - - ContentsItem Unmarshaller - - - - - Copy Object Request Marshaller - - - - - Response Unmarshaller for CopyObject operation - - - - - Upload Part Copy Request Marshaller - - - - - Response Unmarshaller for CopyPart operation - - - - - CORSRule Unmarshaller - - - - - Response Unmarshaller for DefaultRetention Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Delete InventoryConfiguration Request Marshaller - - - - - Response Unmarshaller for DeleteAnalyticsConfiguration operation - - - - - Response Unmarshaller for DeleteCORSConfiguration operation - - - - - Delete InventoryConfiguration Request Marshaller - - - - - Response Unmarshaller for DeleteInventoryConfiguration operation - - - - - Delete Bucket MetricsConfiguration Request Marshaller - - - - - Response Unmarshaller for DeleteBucketMetricsConfiguration operation - - - - - Delete Bucket Policy Request Marshaller - - - - - Response Unmarshaller for DeleteBucketPolicy operation - - - - - Delete Bucket Request Marshaller - - - - - Response Unmarshaller for DeleteBucket operation - - - - - Delete Bucket Tagging Request Marshaller - - - - - Response Unmarshaller for DeleteBucketTagging operation - - - - - Delete Bucket Website Request Marshaller - - - - - Response Unmarshaller for DeleteBucketWebsite operation - - - - - Delete Bucket Cors Request Marshaller - - - - - DeletedObject Unmarshaller - - - - - Delete Bucket Lifecycle Request Marshaller - - - - - Response Unmarshaller for DeleteBucketLifecycle operation - - - - - Delete Object Request Marshaller - - - - - Response Unmarshaller for DeleteObject operation - - - - - Delete Objects Request Marshaller - - - - - Response Unmarshaller for DeleteObjects operation - - - - - DeleteObjectTaggingRequest Marshaller - - - - - Marshall DeleteObjectTaggingRequest object into an http request. - - - - - Marshall DeleteObjectTaggingRequest object into an http request. - - - - - Response Unmarshaller for DeleteObjectTagging operation - - - - - DeletePublicAccessBlock Request Marshaller - - - - - Response Unmarshaller for DeletePublicAccessBlock operation - - - - - ErrorsItem Unmarshaller - - - - - Expiration Unmarshaller - - - - - FilterRule Unmarshaller - - - - - Filter Unmarshaller - - - - - Get Object Acl Request Marshaller - - - - - Response Unmarshaller for GetACL operation - - - - - Get Object Accelerate Configuration Request Marshaller - - - - - Response Unmarshaller for GetACL operation - - - - - Get BucketAnalyticsConfiguration Request Marshaller - - - - - Response Unmarshaller for GetAnalyticsConfiguration operation - - - - - Get InventoryConfiguration Request Marshaller - - - - - Response Unmarshaller for GetInventoryConfiguration operation - - - - - Get Bucket Location Request Marshaller - - - - - Response Unmarshaller for GetBucketLocation operation - - - - - Get Bucket Logging Request Marshaller - - - - - Response Unmarshaller for GetBucketLogging operation - - - - - Get Bucket MetricsConfigurationRequest Marshaller - - - - - Response Unmarshaller for GetBucketMetricsConfiguration operation - - - - - Get Bucket Notification Request Marshaller - - - - - Response Unmarshaller for GetBucketNotification operation - - - - - Get BucketName Policy Request Marshaller - - - - - Response Unmarshaller for GetBucketPolicy operation - - - - - GetBucketPolicyStatusRequestMarshaller - - - - - Response Unmarshaller for GetBucketPolicyStatus operation - - - - - Get Bucket Request Payment Request Marshaller - - - - - Response Unmarshaller for GetBucketRequestPayment operation - - - - - Get Bucket Tagging Request Marshaller - - - - - Response Unmarshaller for GetBucketTagging operation - - - - - Get Bucket Versioning Request Marshaller - - - - - Response Unmarshaller for GetBucketVersioning operation - - - - - Get Bucket Website Request Marshaller - - - - - Response Unmarshaller for GetBucketWebsite operation - - - - - Get Bucket Cors Request Marshaller - - - - - Response Unmarshaller for GetCORSConfiguration operation - - - - - Get Bucket Lifecycle Request Marshaller - - - - - Response Unmarshaller for GetLifecycleConfiguration operation - - - - - GetObjectLegalHold Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for GetObjectLegalHold operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - GetObjectLockConfiguration Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for GetObjectLockConfiguration operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - GetObjectMetadata Marshaller - - - - - Response Unmarshaller for GetObjectMetadata operation - - - - - Get Object Request Marshaller - - - - - Response Unmarshaller for GetObject operation - - - - - GetObjectRetention Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for GetObjectRetention operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - GetObjectTaggingRequest Marshaller - - - - - Marshall GetObjectTaggingRequest into an http request. - - - - - Marshall GetObjectTaggingRequest into an http request. - - - - - Response Unmarshaller for GetObjectTagging operation - - - - - Get Object Torrent Request Marshaller - - - - - Response Unmarshaller for GetObjectTorrent operation - - - - - GetPublicAccessBlockRequestMarshaller - - - - - Response Unmarshaller for GetPublicAccessBlock operation - - - - - Grantee Unmarshaller - - - - - Grant Unmarshaller - - - - - Head Bucket Request Marshaller - - - - - Response Unmarshaller for HeadBucket operation - - - - - Create Multipart Upload Request Marshaller - - - - - Response Unmarshaller for InitiateMultipartUpload operation - - - - - Initiator Unmarshaller - - - - - InventoryConfiguration Unmarshaller - - - - - InventoryDestination Unmarshaller - - - - - InventoryEncryption Unmarshaller - - - - - InventoryFilter Unmarshaller - - - - - InventoryS3BucketDestination Unmarshaller - - - - - InventorySchedule Unmarshaller - - - - - LifecycleFilterPredicate Unmarshaller - - - - - LifecycleRuleNoncurrentVersionExpiration Unmarshaller - - - - - LifecycleRuleNoncurrentVersionTransition Unmarshaller - - - - - List AnalyticsConfiguration Request Marshaller - - - - - Response Unmarshaller for ListAnalyticsConfiguration operation - - - - - List InventoryConfiguration Request Marshaller - - - - - Response Unmarshaller for ListInventoryConfiguration operation - - - - - List Bucket MetricsConfigurationRequest Marshaller - - - - - Response Unmarshaller for ListBucketMetricsConfiguration operation - - - - - List Buckets Request Marshaller - - - - - Response Unmarshaller for ListBuckets operation - - - - - List Multipart Uploads Request Marshaller - - - - - Response Unmarshaller for ListMultipartUploads operation - - - - - List Objects Request Marshaller - - - - - Response Unmarshaller for ListObjects operation - - - - - List Objects Request Marshaller - - - - - Response Unmarshaller for ListObjects operation - - - - - List Parts Request Marshaller - - - - - Response Unmarshaller for ListParts operation - - - - - List Object Versions Request Marshaller - - - - - Response Unmarshaller for ListVersions operation - - - - - LoggingEnabled Unmarshaller - - - - - MetricsConfiguration Unmarshaller - - - - - MetricsFilte Unmarshaller - - - - - UploadsItem Unmarshaller - - - - - Response Unmarshaller for ObjectLockConfiguration Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Response Unmarshaller for ObjectLockLegalHold Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Response Unmarshaller for ObjectLockRetention Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Response Unmarshaller for ObjectLockRule Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Owner Unmarshaller - - - - - PartsItem Unmarshaller - - - - - PolicyStatus Unmarshaller - - - - - PublicAccessBlockConfiguration Unmarshaller - - - - - Put Object Acl Request Marshaller - - - - - Response Unmarshaller for PutObjectAcl operation - - - - - Put Object Acl Request Marshaller - - - - - Response Unmarshaller for PutBucketAccelerate operation - - - - - Request Marshaller for PutAnalyticsConfiguration operation - - - - - Response Unmarshaller for PutBucketAnalytics operation - - - - - Request Marshaller for PutInventoryConfiguration operation - - - - - Response Unmarshaller for PutBucketWebsite operation - - - - - Enable Bucket Logging Request Marshaller - - - - - Response Unmarshaller for PutBucketLogging operation - - - - - Put Bucket MetricsConfigurationRequest Marshaller - - - - - Response Unmarshaller for PutBucketMetricsConfiguration operation - - - - - Put Bucket Notification Request Marshaller - - - - - Response Unmarshaller for PutBucketNotification operation - - - - - Put Bucket Policy Request Marshaller - - - - - Response Unmarshaller for PutBucketPolicy operation - - - - - Put Buckeyt Replication Request Marshaller - - - - - Response Unmarshaller for PutBucketReplication operation. - - - - - Put Bucket Request Marshaller - - - - - Put Bucket Request Payment Request Marshaller - - - - - Response Unmarshaller for PutBucketRequestPayment operation - - - - - Response Unmarshaller for PutBucket operation - - - - - Put Bucket Tagging Request Marshaller - - - - - Response Unmarshaller for PutBucketTagging operation - - - - - Put Bucket Versioning Request Marshaller - - - - - Response Unmarshaller for PutBucketVersioning operation - - - - - Put Bucket Website Request Marshaller - - - - - Response Unmarshaller for PutBucketWebsite operation - - - - - Put Bucket Cors Request Marshaller - - - - - Response Unmarshaller for PutCORSConfiguration operation - - - - - Put Bucket Lifecycle Request Marshaller - - - - - Response Unmarshaller for PutLifecycleConfiguration operation - - - - - PutObjectLegalHold Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for PutObjectLegalHold operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - PutObjectLockConfiguration Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for PutObjectLockConfiguration operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Put Object Request Marshaller - - - - - Response Unmarshaller for PutObject operation - - - - - PutObjectRetention Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for PutObjectRetention operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Delete Object Tagging Request Marshaller - - - - - Marshall PutObjectTaggingRequest into an http request. - - - - - Marshall PutObjectTaggingRequest into an http request. - - - - - Response Unmarshaller for DeleteObjectTagging operation - - - - - PutPublicAccessBlock Request Marshaller - - - - - Response Unmarshaller for PutPublicAccessBlock operation - - - - - Restore Object Request Marshaller - - - - - Response Unmarshaller for RestoreObject operation - - - - - Condition Unmarshaller - - - - - Redirect Unmarshaller - - - - - RoutingRule Unmarshaller - - - - - RulesItem Unmarshaller - - - - - Response Unmarshaller for all Errors - - - - - Build an S3ErrorResponse from XML - - The XML parsing context. - Usually an Amazon.Runtime.Internal.UnmarshallerContext. - An S3ErrorResponse object. - - - - Grant Unmarshaller - - - - - Class for unmarshalling S3 service responses - - - - - Specialized S3 unmarshaller context. - - - - - Wrap an XmlTextReader with state for event-based parsing of an XML stream. - - Stream with the XML from a service response. - If set to true, maintains a copy of the complete response body as the stream is being read. - Response data coming back from the request - - - - Reads to the next node in the XML document, and updates the context accordingly. - If node is RequestId, reads the contents and stores in RequestId property. - - - True if a node was read, false if there are no more elements to read./ - - - - - SSEKMS Unmarshaller - - - - - StorageClassAnalysisDataExportDataExportUnmarshaller - - - - - StorageClassAnalysisUnmarshaller - - - - - Tag Unmarshaller - - - - - TopicConfiguration Unmarshaller - - - - - Transition Unmarshaller - - - - - Upload Part Request Marshaller - - - - - Response Unmarshaller for UploadPart operation - - - - - VersionsItem Unmarshaller - - - - - Internal implementation of Inventory Predicate visitor interface. - - - - - Internal implementation of Metrics Predicate visitor interface. - - - - - Class for AnalyticsPrefixPredicate - The prefix used when evaluating a metrics filter. - - - - - Class for AnalyticsS3BucketDestination - - - - - The file format used when exporting data to Amazon S3. - - - - - The account ID that owns the destination bucket. If no account ID is provided, the owner will not be validated prior to exporting data. - - - - - The Amazon resource name (ARN) of the bucket to which data is exported. - - - - - The prefix to use when exporting data. The exported data begins with this prefix. - - - - - Class for MetricsTagPredicate - The tag used when evaluating a metrics filter. - - - - - This class represents the byte range for a range GET from S3. - - - - - Constructs a ByteRange and sets the start and end. - - - - - - - Constructs a ByteRange and sets the header to the value specified. - - - - - - A private string, represending the byte range. - - - - - The starting byte number of the range - - - - - The ending byte number of the range - - - - - The formatted string representing the byte range to be set for the range header. - - - - - Container for the parameters to the CompleteMultipartUpload operation. - Completes a multipart upload by assembling previously uploaded parts. - - - - - The name of the bucketName containing the S3 object that was being uploaded in parts. - - - - - The key of the S3 object that was being uploaded. - - - - - A collection of part numbers and corresponding etags. - - - - - Adds a collection of part numbers and corresponding etags. - - PartETags that will added to this request. - - - - Adds a collection of part numbers and corresponding etags. - - PartETags that will added to this request. - - - - Adds a collection of part numbers and corresponding etags by transforming the UploadPartResponses into PartETags. - - The list of response objects return from UploadParts. - - - - Adds a collection of part numbers and corresponding etags by transforming the UploadPartResponses into PartETags. - - The list of response objects return from UploadParts. - - - - Adds a collection of part numbers and corresponding etags by transforming the CopyPartResponse into PartETags. - - The list of response objects return from CopyParts. - - - - Adds a collection of part numbers and corresponding etags by transforming the CopyPartResponse into PartETags. - - The list of response objects return from CopyParts. - - - - The upload id for the in-progress multipart upload that should be completed. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the CompleteMultipartUpload response and response metadata. - - - - - Gets and sets the URI that identifies the newly created object. - - - - - Gets and sets the name of the bucketName that contains the newly created object. - - - - - Gets and sets the object key of the newly created object. - - - - - Gets and sets Entity tag that identifies the newly created object's data. Objects with different - object data will have different entity tags. The entity tag is an opaque string. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - Gets and sets the ServerSideEncryptionMethod property. - Specifies the encryption used on the server to - store the content. - Default is None. - - - - - Gets and sets the VersionId property. - This is the version-id of the S3 object - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the CopyObject operation. - Creates a copy of an object that is already stored in Amazon S3. - - - Container for the parameters to the CopyObject operation. - Creates a copy of an object that is already stored in Amazon S3. - - - - - The name of the bucket containing the object to copy. - - - - - Checks if SourceBucket property is set. - - true if SourceBucket property is set. - - - - The key of the object to copy. - - - - - Checks if SourceKey property is set. - - true if SourceKey property is set. - - - - Specifies a particular version of the source object to copy. By default the latest version is copied. - - - - - Checks if SourceVersionId property is set. - - true if SourceVersionId property is set. - - - - The name of the bucket to contain the copy of the source object. - - - - - Checks if DestinationBucket property is set. - - true if DestinationBucket property is set. - - - - The key to be given to the copy of the source object. - - - - - Checks if DestinationKey property is set. - - true if DestinationKey property is set. - - - - A canned access control list (CACL) to apply to the object. - Please refer to for - information on S3 Canned ACLs. - - - - - ETag to be matched as a pre-condition for copying the source object - otherwise returns a PreconditionFailed. - - - Copies the object if its entity tag (ETag) matches - the specified tag; otherwise return a 412 (precondition failed). - Constraints: This property can be used with IfUnmodifiedSince, - but cannot be used with other conditional copy properties. - - - - - Checks if ETagToMatch property is set. - - - Copies the object if its entity tag (ETag) is different - than the specified Etag; otherwise returns a 412 (failed condition). - Constraints: This header can be used with IfModifiedSince, but cannot - be used with other conditional copy properties. - - true if ETagToMatch property is set. - - - - ETag that must not be matched as a pre-condition for copying the source object, - otherwise returns a PreconditionFailed. - - - - - Checks if ETagToNotMatch property is set. - - true if ETagToNotMatch property is set. - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or - ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Copies the object if it has been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it has been modified since the - specified time; otherwise returns a 412 (failed condition). - Constraints: This property can be used with ETagToNotMatch, - but cannot be used with other conditional copy properties. - - - - - Copies the object if it has been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it has been modified since the - specified time; otherwise returns a 412 (failed condition). - Constraints: This property can be used with ETagToNotMatch, - but cannot be used with other conditional copy properties. - - - - - Checks if ModifiedSinceDateUtc property is set. - - true if ModifiedSinceDateUtc property is set. - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or - UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Copies the object if it has not been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it hasn't been modified since the - specified time; otherwise returns a 412 (precondition failed). - Constraints: This property can be used with ETagToMatch, - but cannot be used with other conditional copy properties. - - - - - Copies the object if it has not been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it hasn't been modified since the - specified time; otherwise returns a 412 (precondition failed). - Constraints: This property can be used with ETagToMatch, - but cannot be used with other conditional copy properties. - - - - - Checks if UnmodifiedSinceDateUtc property is set. - - true if UnmodifiedSinceDateUtc property is set. - - - - Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request. - - - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - Specifies whether you want to apply a Legal Hold to the copied object. - - - - - - Gets and sets the property ObjectLockMode. - - The Object Lock mode that you want to apply to the copied object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - The date and time when you want the copied object's Object Lock to expire. - - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - Checks if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - true if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - - - The type of storage to use for the object. Defaults to 'STANDARD'. - - - - - - If the bucketName is configured as a website, redirects requests for this object to another object in the same bucketName or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - This is a convenience property for Headers.ContentType. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - /// - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The customer provided encryption key for the source object of the copy. - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - true if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the CopySourceServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if CopySourceServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - The tag-set for the object destination object this value must be used in conjunction with the TaggingDirective. The tag-set must be encoded as URL Query parameters. - - - - - Checks if Tagging property is set - - true if Tagging is set. - - - - Overrides the default request timeout value. - - - - If the value is set, the value is assigned to the Timeout property of the HTTPWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Overrides the default ReadWriteTimeout value. - - - - If the value is set, the value is assigned to the ReadWriteTimeout property of the HTTPWebRequest/WebRequestHandler object used - to send requests. - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - - Returns information about the CopyObject response and response metadata. - - - - - Gets and sets the ETag property. - - - - - Gets and sets the LastModified property. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - Gets and sets the SourceVersionId property. - This is the Version Id of the Source Object - - - - - Version ID of the newly created copy. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the CopyPart operation. - Uploads a part by copying data from an existing object as data source. - - - Container for the parameters to the CopyPart operation. - Uploads a part by copying data from an existing object as data source. - - - - - The name of the bucket containing the object to copy. - - - - - Checks if SourceBucket property is set. - - true if SourceBucket property is set. - - - - The key of the object to copy. - - - - - Checks if SourceKey property is set. - - true if SourceKey property is set. - - - - Specifies a particular version of the source object to copy. By default the latest version is copied. - - - - - Checks if SourceVersionId property is set. - - true if SourceVersionId property is set. - - - - The name of the bucket to contain the copy of the source object. - - - - - Checks if DestinationBucket property is set. - - true if DestinationBucket property is set. - - - - The key to be given to the copy of the source object. - - - - - Checks if DestinationKey property is set. - - true if DestinationKey property is set. - - - - The ID identifying multipart upload for which we are copying a part. - - - - - Checks if UploadId property is set. - - true if UploadId property is set. - - - - Collection of ETags to be matched as a pre-condition for copying the source object - otherwise returns a PreconditionFailed. - - - Copies the object if its entity tag (ETag) matches one of - the specified tags; otherwise return a 412 (precondition failed). - Constraints: This property can be used with IfUnmodifiedSince, - but cannot be used with other conditional copy properties. - - - - - Checks if ETagsToMatch property is set. - - true if ETagToMatch property is set. - - - - Collection of ETags that must not be matched as a pre-condition for copying the source object - otherwise returns a PreconditionFailed. - - - Copies the object if its entity tag (ETag) does not match any of the specified - tags; otherwise returns a 412 (failed condition). - Constraints: This header can be used with IfModifiedSince, but cannot - be used with other conditional copy properties. - - - - - Checks if ETagToNotMatch property is set. - - true if ETagToNotMatch property is set. - - - - Copies the object if it has been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it has been modified since the - specified time; otherwise returns a 412 (failed condition). - Constraints: This property can be used with ETagToNotMatch, - but cannot be used with other conditional copy properties. - - - - - Checks if ModifiedSinceDate property is set. - - true if ModifiedSinceDate property is set. - - - - Copies the object if it has not been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it hasn't been modified since the - specified time; otherwise returns a 412 (precondition failed). - Constraints: This property can be used with ETagToMatch, - but cannot be used with other conditional copy properties. - - - - - Checks if UnmodifiedSinceDate property is set. - - true if UnmodifiedSinceDate property is set. - - - - The number of the part to be copied. - - - Valid part numbers are from 1 to 10,000 inclusive and will uniquely identify the part - and determine the relative ordering within the destination object. If a part already - exists with the PartNumber it will be overwritten. - - - - - Checks if PartNumber property is set. - - true if PartNumber property is set. - - - - The location of the first byte in the range if only a portion of the - source object is to be copied as the part. - - - The LastByte property must also be set or this value will be ignored. - - - - - Checks if FirstByte property is set. - - true if FirstByte property is set. - - - - The location of the last byte in the range if only a portion of the - source object is to be copied as the part. - - - The FirstByte property must also be set or this value will be ignored. - - - - - Checks if LastByte property is set. - - true if LastByte property is set. - - - - - This property is obsolete. Use ServerSideEncryptionMethod in InitiateMultipartUploadRequest instead. - - - Default: None - - - - - - Checks if ServerSideEncryptionMethod property is set. - - true if ServerSideEncryptionMethod property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - This property is obsolete. Use ServerSideEncryptionKeyManagementServiceKeyId in InitiateMultipartUploadRequest instead. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The customer provided encryption key for the source object of the copy. - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - true if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the CopySourceServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if CopySourceServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - - - Overrides the default request timeout value. - - - - If the value is set, the value is assigned to the Timeout property of the HTTPWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Overrides the default ReadWriteTimeout value. - - - - If the value is set, the value is assigned to the ReadWriteTimeout property of the HTTPWebRequest/WebRequestHandler object used - to send requests. - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - - Returns information about the CopyPart response and response metadata. - - - - - The version of the source object that was copied, if you have enabled versioning on the source bucketName. - - - - - - Entity tag of the object. - - - - - - Date and time at which the object was uploaded. - - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - Gets and sets the PartNumber property. - This is the part number in it's multi-part upload that will uniquely identify the part - and determine the relative ordering within the destination object. - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - A collection of up to 100 cross-origin resource sharing (CORS) rules. - - - - - The collection of rules in this configuration. - - - - C O R S Rule - - - - - Identifies HTTP methods that the domain/origin specified in the rule is allowed to execute. - - - - - - One or more origins you want customers to be able to access the bucket from. - - - - - - An optional unique identifier for the rule. - - - The ID value can be up to 255 characters long. The IDs help you find a rule in the configuration. - - - - - Checks if Id property is set. - - true if Id property is set. - - - - One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript - XMLHttpRequest object). - - - - - - The time in seconds that your browser is to cache the preflight response for the specified resource. - - - - - - Specifies which headers are allowed in a pre-flight OPTIONS request through the - Access-Control-Request-Headers header. - - - Each header name specified in the Access-Control-Request-Headers must have a corresponding - entry in the rule. Only the headers that were requested will be sent back. - This element can contain at most one * wildcard character. - - - - - Checks if AllowedHeaders property is set. - - true if AllowedHeaders property is set. - - - - Describes how a CSV-formatted input object is formatted. - - - - - Describes the first line of input. Valid values: None, Ignore, Use. - - - - - Single character used to indicate a row should be ignored when present at the start of a row. - - - - - Single character used for escaping the quote character inside an already escaped value. - - - - - Value used to separate individual records. - - - - - Value used to separate individual fields in a record. - - - - - Value used for escaping where the field delimiter is part of the value. - - - - - Specifies that CSV field values may contain quoted record delimiters and such records should be allowed. Default value is FALSE. Setting this value to TRUE may lower performance. - - - - - Describes how CSV-formatted results are formatted. - - - - - Indicates whether or not all output fields should be quoted. - - - - - Single character used for escaping the quote character inside an already escaped value. - - - - - Value used to separate individual records. - - - - - Value used to separate individual fields in a record. - - - - - Value used for escaping where the field delimiter is part of the value. - - - - - The container element for specifying the default Object Lock retention settings for - new objects placed in the specified bucket. - - - - - Gets and sets the property Days. - - The number of days that you want to specify for the default retention period. - - - - - - Gets and sets the property Mode. - - The default Object Lock retention mode you want to apply to new objects placed in - the specified bucket. - - - - - - Gets and sets the property Years. - - The number of years that you want to specify for the default retention period. - - - - - - Container for the parameters to the DeleteBucketAnalyticsConfiguration operation. - Deletes an analytics configuration for the bucket (specified by the analytics configuration ID). - - - - - The name of the bucket from which an analytics configuration is deleted. - - - - - The identifier used to represent an analytics configuration. - - - - - Returns information about the DeleteBucketAnalyticsConfiguration response metadata. - The DeleteBucketAnalyticsConfiguration operation has a void result type. - - - - - Request object for the DeleteBucketEncryption operation. - Request Deletes the server-side encryption configuration from the bucket. - - - - - The name of the bucket containing the server-side encryption configuration to delete. - - - - - Returns information about the DeleteBucketEncryption response metadata. - The DeleteBucketEncryption operation has a void result type. - - - - - Container for the parameters to the DeleteInventoryConfiguration operation. - Deletes an inventory configuration (identified by the inventory ID) from the bucket. - - - - - The name of the bucket containing the inventory configuration to delete. - - - - - The ID used to identify the inventory configuration. - - - - - Returns information about the DeleteInventoryConfiguration response metadata. - The DeleteInventoryConfiguration operation has a void result type. - - - - - Container for the parameters to the DeleteBucketMetricsConfiguration operation. - Deletes a metrics configuration (specified by the metrics configuration ID) from the bucket. - - - - - The name of the bucket on which Inventory configuration is to be removed. - - - - - The ID used to identify the metrics configuration. - - - - - Returns information about the DeleteBucketMetricsConfiguration response metadata. - The DeleteBucketMetricsConfiguration operation has a void result type. - - - - - Container for the parameters to the DeleteBucketPolicy operation. - Deletes the policy from the bucket. - - - - - The bucket on which the policy is to be deleted. - - - - - Returns information about the DeleteBucketPolicy response metadata. - The DeleteBucketPolicy operation has a void result type. - - - - - Request object for the DeleteBucketReplication operation. - - - - - Gets and sets the property BucketName. -

Deletes the replication subresource associated with the specified - bucket.

There is usually some time lag before - replication configuration deletion is fully propagated to all the - Amazon S3 systems.

For more information, see - - Cross-Region Replication (CRR) in the Amazon S3 Developer - Guide.

- - - - - Returns information about the DeleteBucketReplication response metadata. - The DeleteBucketReplication operation has a void result type. - - - - - Container for the parameters to the DeleteBucket operation. - Deletes the bucket. All objects (including all object versions and Delete Markers) in the bucket must be deleted before the bucket - itself can be deleted. - - - - - The name of the bucket to be created. - - - - - The region locality for the bucket. - - - When set, this will determine the region the bucket exists in. - Refer - for a list of possible values. - - - - - If set to true the bucket will be deleted in the same region as the configuration of the AmazonS3 client. - DeleteBucketRequest.BucketRegion takes precedence over this property if both are set. - Default: true. - - - - - Returns information about the DeleteBucket response metadata. - The DeleteBucket operation has a void result type. - - - - - The parameters to request deletion of a tag set from a bucket. - - - To use this operation, you must have permission to perform the s3:PutBucketTagging action. - By default, the bucket owner has this permission and can grant this permission to others. - - - - - The name of the bucket on which the tag set is to be removed. - - - - - Returns information about the DeleteBucketTagging response metadata. - The DeleteBucketTagging operation has a void result type. - - - - - Container for the parameters to the DeleteBucketWebsite operation. - This operation removes the website configuration from the bucket. - - - - - The name of the bucket on which website configuration is to be removed. - - - - - Returns information about the DeleteBucketWebsite response metadata. - The DeleteBucketWebsite operation has a void result type. - - - - - Container for the parameters to the DeleteCORSConfiguration operation. - Deletes the cors configuration information set for the bucket. - - - - - Gets and sets the BucketName property. - - - - - Returns information about the DeleteCORSConfiguration response metadata. - The DeleteCORSConfiguration operation has a void result type. - - - - - Contains information about a successful delete operation against a specific S3 object. - - - - - Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a - delete marker. In a simple DELETE, this header indicates whether (true) or not (false) a delete - marker was created. - - - - - The version ID of the delete marker created as a result of the DELETE operation. If you delete a - specific object version, the value returned by this header is the version ID of the object version - deleted. - - - - - The key of the deleted S3 object. - - - - - The version of the deleted S3 object. - - - - - Contains information about a failed delete operation against a specific S3 object. - - - - - The key of the S3 object. - - - - - The version of the S3 object. - - - - - The failure code for the delete error. - - - - - The failure message for the delete error. - - - - - The parameters to request deletion of the lifecycle configuration on a bucket. - - - - Amazon S3 removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. - Your objects never expire, and Amazon S3 no longer automatically deletes any objects on the basis of rules contained - in the deleted lifecycle configuration. - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration action. By default, the - bucket owner has this permission and the bucket owner can grant this permission to others. - - - There is usually some time lag before lifecycle configuration deletion is fully propagated to all the Amazon S3 systems. - - - - - - The name of the bucket on which the lifecycle configuration is to be deleted. - - - - - Returns information about the DeleteLifecycleConfiguration response metadata. - The DeleteLifecycleConfiguration operation has a void result type. - - - - -

Specifies whether Amazon S3 should replicate delete makers.

- - - - - Gets and sets the property Status. -

The status of the delete marker replication.

-

In the current implementation, Amazon S3 does not replicate - the delete markers. Therefore, the status must be - Disabled.

- - - - - The parameters to request deletion of an object in a bucket. - The operation removes the null version (if there is one) of an object and inserts a delete marker, which - becomes the latest version of the object. - - - - To remove a specific version, you must be the bucket owner and you must use the versionId subresource. - Using this subresource permanently deletes the version. - - - If the object you want to delete is in a bucket where the bucket versioning configuration is MFA Delete enabled, - you must include specify the MFA serial number and value in the request. - - - If there isn't a null version, Amazon S3 does not remove any objects. - - - - - - The bucket name of the bucket containing the object. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property BypassGovernanceRetention. - - - - - The key identifying the object to delete. - - - - - The identifier for the specific version of the object to be deleted, if required. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - The MfaCodes Tuple associates the Serial Number and the current Token/Code displayed on the - Multi-Factor Authentication device associated with your AWS Account. - - - This is a required property for this request if:
- 1. EnableMfaDelete was configured on the bucket - containing this object's version.
- 2. You are deleting an object's version - - - - - Checks if the MfaCodes property is set. - - true if the MfaCodes property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the DeleteObject response and response metadata. - - - - - Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a delete marker. - - - - - - Returns the version ID of the delete marker created as a result of the DELETE operation. - - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the DeleteObjects operation. - This operation enables you to delete multiple objects from a bucket using a single HTTP request. You may specify up to 1000 - keys. - - - Container for the parameters to the DeleteObjects operation. - This operation enables you to delete multiple objects from a bucket using a single HTTP request. You may specify up to 1000 - keys. - - - - - The bucket name containing the objects to delete. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property BypassGovernanceRetention. - - Specifies whether you want to delete this object even if it has a Governance-type - Object Lock in place. You must have sufficient permissions to perform this operation. - - - - - - List of object keys to delete. - - - - - Toggles between Quiet and Verbose mode for the operation. - If set to true (Quiet mode), the response includes only those keys for objects on which - the delete operation failed. - - - By default this property is false and keys for both successful deletes - and failures are returned in the response. - - - - - The MfaCodes Tuple associates the Serial Number and the current Token/Code displayed on the - Multi-Factor Authentication device associated with your AWS Account. - - - This is a required property for this request if:
- 1. EnableMfaDelete was configured on the bucket - containing this object's version.
- 2. You are deleting an object's version - - - - - Checks if the MfaCodes property is set. - - true if the MfaCodes property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Add a key to the set of keys of objects to be deleted. - - Object key - - - - Add a key and a version to be deleted. - - Key of the object to be deleted. - Version of the object to be deleted. - - - - Add a KeyVersion object representing the S3 object to be deleted. - - KeyVersion representation of object to be deleted. - - - - Returns information about the DeleteObjects response and response metadata. - - - - - A default constructor for DeleteObjectsResponse - - - - - Gets and sets the DeletedObjects property. - A list of successful deletes. - Set only when Quiet=false on DeleteObjectsRequest. - - - - - Gets and sets the DeleteErrors property. - A list of errors encountered while deleting objects. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Sets the with information about DeleteObjectsResponse - - The that holds the serialized object data. - The that contains contextual information about the source or destination. - - - - Sets the with information about the DeleteObjectsResponse. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - - - - Container for the parameters to the DeleteObjectTaggingRequest operation. - - - - - The bucket name containing the objects from which to remove the tags. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Check to see if Bucket property is set - - - - - The key identifying the object tagging to delete. - - - - - Check to see if Key property is set - - - - - The identifier for the specific version of the object to be deleted, if required. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - Returns information about the DeleteObjectTagging response and response metadata. - - - - - Returns the version ID of the delete marker created as a result of the DELETE operation. - - - - - Check to see if VersionId property is set - - - - - Container for the parameters to the DeletePublicAccessBlock operation. - Removes the Public Access Block configuration for an Amazon S3 bucket. - - - - - Gets and sets the property BucketName. - - The Amazon S3 bucket whose Public Access Block configuration you want to delete. - - - - - - This is the response object from the DeletePublicAccessBlock operation. - - - - - EncryptionConfiguration class - - - - - The ID of the AWS KMS key for the region where the destination bucket - resides. Amazon S3 uses this key to encrypt the replica object. - - - - - The Continuation Event. - - - - - Constructs a Continuation Event. - - - - - Constructs a Continuation Event. - - - - - - The End Event. - - - - - Constructs an End Event. - - - - - Constructs an End Event. - - - - - - Common Contract for S3 Events. - - - - - The Progress event details. - - - - - Current number of object bytes scanned. - - - - - Current number of uncompressed object bytes processed. - - - - - Total number of bytes of records payload data returned. - - - - - Constructs a instance of Progress. - - - - - The Progress Event. - - - - - The Progress event details. - - - - - Constructs a ProgressEvent. - - - - - Constructs a ProgressEvent. - - - - - - The Records Event - - - - - The byte array of partial, one or more result records. - - Payload is a , which is not thread-safe. - - - - - Constructs a RecordsEvent - - - - - Creates a new End Event. - - - - - - Modeled Exception that either comes over the stream from the service model, or wraps other exceptions for the purpose of raising events. If it is - modelled, it will be a subclass. - - - - - Creates a new S3EventStreamException - - - - - Creates a new S3EventStreamException - - - - - - Creates a new S3EventStreamException - - - - - - - Constructs a new instance of the S3EventStreamException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - The contract for the SelectObjectContentEventStream. - - - - - Event that encompasses all IS3Events. - - - - - Event that encompasses S3EventStreamExceptions. - - - - - Reaised when a Records event is received. - - - - - Reaised when a Stats event is received. - - - - - Reaised when a Progress event is received. - - - - - Reaised when a Continuation event is received. - - - - - Reaised when an End event is received. - - - - - A Stream of Events returned by the SelectObjectContent operation. Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treaded as mutually exclusive. - - - - - The mapping of event message to a generator function to construct the matching Event Stream event. - - - - - The mapping of event message to a generator function to construct the matching Event Stream exception. - - - - - Whether the backround processing loop is running. - - - - - Event that encompasses all IS3Events. - - - - - Event that encompasses S3EventStreamExceptions. - - - - - Reaised when a Records event is received. - - - - - Reaised when a Stats event is received. - - - - - Reaised when a Progress event is received. - - - - - Reaised when a Continuation event is received. - - - - - Reaised when an End event is received. - - - - - Event Stream returned by SelectObjectContentStream. - - Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treated as mutually exclusive. - - The network stream which events will be parsed from. - - - - Event Stream returned by SelectObjectContentStream. - - Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treaded as mutually exclusive. - - The network stream which events will be parsed from. - The decoder responsible for parsing events. - - - - The Stats event details. - - - - - Total number of object bytes scanned. - - - - - Total number of uncompressed object bytes processed. - - - - - Total number of bytes of records payload data returned. - - - - - Constructs an instance of Stats. - - - - - The Stats Event. - - - - - The Stats event details. - - - - - Constructs a StatsEvent - - - - - Constructs a ProgressEvent. - - - - - - This Event is returned if an event is retrieved from the event stream, but a generator function - for the event is not defined. - - - - - Constructs an UnknownEventStreamEvent. - - - - - Constructs an UnknownEventStreamEvent. - - The Message recieved from the event stream before conversion. - - - - Constructs an UnknownEventStreamEvent. - - The Message recieved from the event stream before conversion. - The event type. - - - - A container that specifies information about existing object replication. You can choose whether to enable or disable the replication of existing objects. - - - - - Specifies whether existing object replication is enabled. - - - - - Defines the expiration policy for a given object. - - - - - This property is deprecated. This property exposes a DateTime of kind Unspecified. Use ExpiryDateUtc instead. - The date and time for expiry. - - - - - The date and time for expiry. - - - - - Id of the configuration rule for this expiry. - - - - - Constructs an empty instance of an Expiration object - - - - Bucket - Represents a set of filter criteria that limits the objects that can trigger event notifications - - - - - Filter criteria that limits the objects that can trigger event notifications based on their S3 Key name. - - - - - Bucket - Represents a Filter Rule for a NotificationConfiguration. - - - - - Constructs an empty FilterRule. - - - - - Constructs a FilterRule with a specific name and value. - - - - - - - The name of the filter rule. - - - - - The value of the filter rule. - - - - - Container for the parameters to the GetACL operation. - Returns the access control list (ACL) of an object. - - - - - The bucket name that contains the object for which to get the ACL information. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The key of the S3 object to be queried. - - - - - VersionId used to reference a specific version of the object. - - - - - Returns information about the GetACL response and response metadata. - - - - - Gets and sets the AccessControlList property. - - - - - Container for the parameters to the GetBucketAccelerateConfiguration operation. - - - - - The name of the bucket. - - - - - The response class for GetBucketAccelerateConfiguration operation. - - - - - The accelerate status of the bucket. - - - - - Container for the parameters to the GetBucketAnalyticsConfiguration operation. - Gets an analytics configuration for the bucket (specified by the analytics configuration ID). - - - - - The name of the bucket from which an analytics configuration is retrieved. - - - - - The identifier used to represent an analytics configuration. - - - - - GetBucketAnalyticsConfigurationResponse Response - - - - - The configuration and any analyses for the analytics filter. - - - - - Container for the parameters to the GetBucketEncryptionRequest operation. - Returns the server-side encryption configuration of a bucket. - - - - - The name of the bucket. - - - - - GetBucketEncryptionResponse Response - - - - - Container for server-side encryption configuration rules. Currently S3 supports one rule only. - - - - - Container for the parameters to the GetInventoryConfigurationRequest operation. - Returns an inventory configuration (identified by the inventory ID) from the bucket. - - - - - The name of the bucket containing the inventory configuration to retrieve. - - - - - The ID used to identify the inventory configuration. - - - - - GetInventoryConfigurationResponse Response - - - - - Specifies the inventory configuration. - - - - - Container for the parameters to the GetBucketLocation operation. - Returns the region the bucket resides in. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetBucketLocation response and response metadata. - - - - - Gets and sets the Location property. - If the the bucket is located in us-east-1 S3Region.US will be return which has a - value of empty string. - - - - - Container for the parameters to the GetBucketLogging operation. - Returns the logging status of a bucket and the permissions users have to view and modify that status. To use GET, you must be the - bucket owner. - - - - - The name of the bucket to query. - - - - - Returns information about the GetBucketLogging response and response metadata. - - - - - Gets and sets the LoggingConfig property. - - - - - Container for the parameters to the GetBucketMetricsConfiguration operation. - Gets a metrics configuration (specified by the metrics configuration ID) from the bucket. - - - - - The name of the bucket containing the metrics configuration to retrieve. - - - - - The ID used to identify the metrics configuration. - - - - - GetBucketMetricsConfiguration Response - - - - - Specifies the metrics configuration. - - - - - Container for the parameters to the GetBucketNotification operation. - Return the notification configuration of a bucket. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetBucketNotification response and response metadata. - - - - - Gets and sets the TopicConfigurations property. TopicConfigurations are configuration - for Amazon S3 events to be sent to Amazon SNS topics. - - - - - Gets and sets the QueueConfigurations property. QueueConfigurations are configuration - for Amazon S3 events to be sent to Amazon SQS queues. - - - - - Gets and sets the LambdaFunctionConfigurations property. LambdaFunctionConfigurations are configuration - for Amazon S3 events to be sent to an Amazon Lambda cloud function. - - - - - Container for the parameters to the GetBucketPolicy operation. - Returns the policy of a specified bucket. - - - - - The name of the bucket. - - - - - Get BucketName Policy Response - - - - - The bucket policy as a JSON document. - - - - - Container for the parameters to the GetBucketPolicyStatus operation. - Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket - is public. - - - - - Gets and sets the property BucketName. - - The name of the Amazon S3 bucket whose public-policy status you want to retrieve. - - - - - - This is the response object from the GetBucketPolicyStatus operation. - - - - - The public-policy status for this bucket. - - - - - Container for the parameters to the GetBucketReplicationConfiguration operation. - Returns the replication configuration information set on the bucket. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetReplicationConfiguration response and response metadata. - - - - - The replication configuration for the buccket specified in the request. - - - - - Container for the parameters to the GetBucketRequestPayment operation. - Returns the request payment configuration of a bucket. - - - - - The name of the bucket. - - - - - Returns information about the GetBucketRequestPayment response and response metadata. - - - - - Specifies who pays for the download and request fees. - - - - - - Container for the parameters to the GetBucketTagging operation. - Returns the tag set associated with the bucket. - - - - - The name of the bucket to be queried. - - - - - Returns information about the GetBucketTagging response and response metadata. - - - - - The collection of tags. - - - - - Container for the parameters to the GetBucketVersioning operation. - Returns the versioning state of a bucket. - - - - - The name of the bucket to be queried. - - - - - Returns information about the GetBucketVersioning response and response metadata. - - - - - Gets and sets the Versioning property. - Unless Versioning has been explicitly "Enabled" on a bucket, - Versioning Status is "Off". Once Versioning has been - "Enabled", it can be "Suspended" but cannot be switched "Off". - - - - - Container for the parameters to the GetBucketWebsite operation. - Returns the website configuration for a bucket. - - - - - The name of the bucket to be queried. - - - - - Returns information about the GetBucketWebsite response and response metadata. - - - - - Gets and sets the WebsiteConfiguration property. - - This is where the index document suffix and custom error page are defined. - - - - - Container for the parameters to the GetBucketCors operation. - Returns the cors configuration for the bucket. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetBucketCors response and response metadata. - - - - - The current CORSConfiguration for the bucket. - - - - - Container for the parameters to the GetLifecycleConfiguration operation. - Returns the lifecycle configuration information set on the bucket. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetLifecycleConfiguration response and response metadata. - - - - - Gets and Sets the property that governs whether - the response includes successful deletes as well as errors - following the DeleteObjects call against S3. - - By default this property is false and successful deletes - are returned in the response. - - - - - Container for the parameters to the GetObjectLegalHold operation. - Gets an object's current Legal Hold status. - - - - - The bucket name containing the object whose Legal Hold status you want to retrieve. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property Key. - - The key name for the object whose Legal Hold status you want to retrieve. - - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property VersionId. - - The version ID of the object whose Legal Hold status you want to retrieve. - - - - - - This is the response object from the GetObjectLegalHold operation. - - - - - Gets and sets the property LegalHold. - - The current Legal Hold status for the specified object. - - - - - - Container for the parameters to the GetObjectLockConfiguration operation. - Gets the Object Lock configuration for a bucket. The rule specified in the Object - Lock configuration will be applied by default to every new object placed in the specified - bucket. - - - - - Gets and sets the property BucketName. - - The bucket whose Object Lock configuration you want to retrieve. - - - - - - This is the response object from the GetObjectLockConfiguration operation. - - - - - Gets and sets the property ObjectLockConfiguration. - - The specified bucket's Object Lock configuration. - - - - - - Container for the parameters to the HeadObject operation. - The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you''re only - interested in an object''s metadata. To use HEAD, you must have READ access to the object. - - - - - The name of the bucket that contains the object. - - - - - ETag to be matched as a pre-condition for returning the object, - otherwise a PreconditionFailed signal is returned. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or - ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Returns the object only if it has been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Returns the object only if it has been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - ETag that should not be matched as a pre-condition for returning the object, - otherwise a PreconditionFailed signal is returned. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or - UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Returns the object only if it has not been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Returns the object only if it has not been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - The key of the object. - - - - - VersionId used to reference a specific version of the object. - - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to decrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - Part number of the object being read. This is a positive integer between 1 and 10,000. - Effectively performs a 'ranged' HEAD request for the part specified. - Useful querying about the size of the part and the number of parts in this object. - - - - - Check if PartNumber property is set. - - true if PartNumber property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the HeadObject response and response metadata. - - - - - Flag which returns true if the Expires property has been unmarshalled - from the raw value or set by user code. - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the - response. - - - - - - Gets and sets the AcceptRanges. - - - - - Gets and sets the ContentRange. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - Gets and sets the RestoreExpiration property. - RestoreExpiration will be set for objects that have been restored from Amazon Glacier. - It indiciates for those objects how long the restored object will exist. - - - - - Gets and sets the RestoreInProgress - Will be true when the object is in the process of being restored from Amazon Glacier. - - - - - Last modified date of the object - - - - - - An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL - - - - - - This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like - SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal - HTTP headers. - - - - - - Version of the object. - - - - - - The date and time at which the object is no longer cacheable. - - - - - - If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The status of the replication job associated with this source object. - - - - - Checks if ReplicationStatus property is set. - - true if ReplicationStatus property is set. - - - - The count of parts this object has. - - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - The Legal Hold status for the specified object. - - - - - - Gets and sets the property ObjectLockMode. - - The Object Lock mode currently in place for this object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - The date and time when this object's Object Lock will expire. - - - - - - The class of storage used to store the object. - - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the GetObject operation. - Retrieves objects from Amazon S3. - - - - - The bucket name containing the object. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - ETag to be matched as a pre-condition for returning the object, - otherwise a PreconditionFailed signal is returned. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or - ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Returns the object only if it has been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Returns the object only if it has been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - ETag that should not be matched as a pre-condition for returning the object, - otherwise a PreconditionFailed signal is returned. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or - UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Returns the object only if it has not been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Returns the object only if it has not been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Gets and sets the Key property. This is the user defined key that identifies the object in the bucket. - - - - - Downloads the specified range bytes of an object. - - - - - A set of response headers that should be returned with the object. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ResponseExpiresUtc instead. Setting either ResponseExpires or - ResponseExpiresUtc results in both ResponseExpires and ResponseExpiresUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ResponseExpires is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Sets the Expires header of the response. - - - - - Sets the Expires header of the response. - - - - - VersionId used to reference a specific version of the object. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to decrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - Part number of the object being read. This is a positive integer between 1 and 10,000. - Effectively performs a 'ranged' GET request for the part specified. Useful for downloading just a part of an object. - - - - - Checks if PartNumber property is set. - - true if PartNumber property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the GetObject response and response metadata. - - - - - Flag which returns true if the Expires property has been unmarshalled - from the raw value or set by user code. - - - - - Gets and sets the BucketName property. - - - - - Gets and sets the Key property. - - - - - Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the - response. - - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - Gets and sets the AcceptRanges. - - - - - Gets and sets the ContentRange. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - Gets and sets the RestoreExpiration property. - RestoreExpiration will be set for objects that have been restored from Amazon Glacier. - It indiciates for those objects how long the restored object will exist. - - - - - Gets and sets the RestoreInProgress - Will be true when the object is in the process of being restored from Amazon Glacier. - - - - - Last modified date of the object - - - - - - An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL - - - - - - This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like - SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal - HTTP headers. - - - - - - Version of the object. - - - - - - The date and time at which the object is no longer cacheable. - - - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - - - - Gets and sets the property ObjectLockMode. - - The Object Lock mode currently in place for this object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - The date and time when this object's Object Lock will expire. - - - - - - If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The class of storage used to store the object. - - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The status of the replication job associated with this source object. - - - - - Checks if ReplicationStatus property is set. - - true if ReplicationStatus property is set. - - - - The number of parts this oject has. - - - - - Checks if PartsCount is set. - - true if PartsCount property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - The number of tags, if any, on the object. - - - - - Writes the content of the ResponseStream a file indicated by the filePath argument. - - The location where to write the ResponseStream - - - - Writes the content of the ResponseStream a file indicated by the filePath argument. - - The location where to write the ResponseStream - Whether or not to append to the file if it exists - - - - The event for Write Object progress notifications. All - subscribers will be notified when a new progress - event is raised. - - - Subscribe to this event if you want to receive - put object progress notifications. Here is how:
- 1. Define a method with a signature similar to this one: - - private void displayProgress(object sender, WriteObjectProgressArgs args) - { - Console.WriteLine(args); - } - - 2. Add this method to the Put Object Progress Event delegate's invocation list - - GetObjectResponse response = s3Client.GetObject(request); - response.WriteObjectProgressEvent += displayProgress; - - - - - - This method is called by a producer of write object progress - notifications. When called, all the subscribers in the - invocation list will be called sequentially. - - The file being written. - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - True if transfer is complete - - - - Writes the content of the ResponseStream a file indicated by the filePath argument. - - The location where to write the ResponseStream - Whether or not to append to the file if it exists - Cancellation token which can be used to cancel this operation. - - - - Encapsulates the information needed to provide - download progress for the Write Object Event. - - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The bucket name for the S3 object being written. - The object key for the S3 object being written. - The version-id of the S3 object. - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - True if finished writing - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The bucket name for the S3 object being written. - The object key for the S3 object being written. - The file for the S3 object being written. - The version-id of the S3 object. - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - True if finished writing - - - - Gets the bucket name for the S3 object being written. - - - - - Gets the object key for the S3 object being written. - - - - - Gets the version-id of the S3 object. - - - - - The file for the S3 object being written. - - - - - True if writing is complete - - - - - Container for the parameters to the GetObjectRetention operation. - Retrieves an object's retention settings. - - - - - The bucket name containing the object whose retention settings you want to retrieve. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property Key. - - The key name for the object whose retention settings you want to retrieve. - - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property VersionId. - - The version ID for the object whose retention settings you want to retrieve. - - - - - - This is the response object from the GetObjectRetention operation. - - - - - Gets and sets the property Retention. - - The container element for an object's retention settings. - - - - - - Container for the parameters to the GetObjectTaggingRequest operation. - - - - - The bucket name containing the object for which to get the tagging information. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Check to see if Bucket property is set - - - - - Gets and sets the Key property. This is the user defined key that identifies the object in the bucket. - - - - - Check to see if Key property is set - - - - - VersionId used to reference a specific version of the object. - - - - - - Returns information about the GetObjectTagging response and response metadata. - - - - - Gets or sets tag-set for a given object - - - - - Container for the parameters to the GetObjectTorrent operation. - Return torrent files from a bucket. - - - - - The name of the bucket containing the object. - - - - - The key identifying the object. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the GetObjectTorrent response and response metadata. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - The parameters to create a pre-signed URL to a bucket or object. - - - For more information, refer to: . -
Required Parameters: BucketName, Expires -
Optional Parameters: Key, VersionId, Verb: default is GET - - - - - The name of the bucket to create a pre-signed url to, or containing the object. - - - - - Checks if BucketName property is set. - - true if BucketName property is set. - - - - The key to the object for which a pre-signed url should be created. - - - - - Checks if Key property is set. - - true if Key property is set. - - - - A standard MIME type describing the format of the object data. - - - - The content type for the content being uploaded. This property defaults to "binary/octet-stream". - For more information, refer to: . - - - Note that if content type is specified, it should also be included in the HttpRequest headers - of the eventual upload request, otherwise a signature error may result. - - - - - - The expiry date and time for the pre-signed url. - - - - - Checks if Expires property is set. - - true if Expires property is set. - - - - The requested protocol (http/https) for the pre-signed url. - - - Defaults to https. - - - - - The verb for the pre-signed url. - - - Accepted verbs are GET, PUT, DELETE and HEAD. - Default is GET. - - - - - Version id for the object that the pre-signed url will reference. If not set, - the url will reference the latest version of the object. - - - This is the VersionId for the S3 Object you want to get - a PreSigned URL for. The VersionId property will be ignored - for PreSigned "PUT" requests and for requests that don't specify - the Key property. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - Specifies the encryption used on the server to store the content. - - - - Default is None. - - - If specifying encryption (not None), the corresponding request must include header - "x-amz-server-side-encryption" with the value of the encryption. - - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - Confirms that the requester knows that she or he will be charged for the request. - Bucket owners need not specify this parameter in their requests. - - - - - A set of response headers that should be returned with the pre-signed url creation response. - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - Custom parameters to include in the signed request, so that they are tamper-proof. - - - - - The parameters for a pre-signed URL to a bucket or object as a string. - - - For more information, refer to: . - - - - - The PreSignedURL as a string - - - - - Constructor - - A url returned from GetPreSignedUrlRequest - - - - Container for the parameters to the GetPublicAccessBlock operation. - Retrieves the Public Access Block configuration for an Amazon S3 bucket. - - - - - Gets and sets the property BucketName. - - The name of the Amazon S3 bucket whose Public Access Block configuration you want - to retrieve. - - - - - - This is the response object from the GetPublicAccessBlock operation. - - - - - The Public Access Block configuration currently in effect for this Amazon S3 bucket. - - - - - Container for the parameters to the HeadBucket operation. - This operation is useful to determine if a bucket exists and you have permission to access it. - - - - - Returns information about the HeadBucket response metadata. - The HeadBucket operation has a void result type. - - - - - This class contains the headers for an S3 object. - - - - - Gets and sets headers to set for the object. - - The name of the header - The value for the header - - - - Gets the count of headers. - - - - - Gets the names of the headers set. - - - - - Specifies caching behavior along the request/reply chain. - - - - - - Specifies presentational information for the object. - - - - - - Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type - referenced by the Content-Type header field. - - - - - - The size of the object, in bytes. - - - - - The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. This - header can be used as a message integrity check to verify that the data is the same data that was originally sent. - - - - - A standard MIME type describing the format of the object data. - - - - - - The date and time at which the object is no longer cacheable. - - - - - - - Container for the parameters to the InitiateMultipartUpload operation. - Initiates a multipart upload and returns an upload ID. - - - - - Envelope Key to Encrypt data - - - - - Encrypted Envelope Key to Encrypt data - - - - - Initialization Vector for encryption - - - - - Storage mode for encryption information. - - - - - A canned access control list (ACL) to apply to the object. - Please refer to for information on S3 Canned ACLs. - - - - - The name of the bucketName where the new object will be created, or existing object updated. - - - - - The key of the object to create or update. - - - - - StorageClass property for the object. - - - Default: S3StorageClass.Standard. Set this property - only if you want reduced redundancy for this object. - Please refer to - for - information on S3 Storage Classes. - - - - - If the bucketName is configured as a website, redirects requests for this object to another object in the same bucketName or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - This is a convenience property for Headers.ContentType. - - - - - - Specifies the encryption to be used on the server for the new object. - - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - Checks if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - true if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - Specifies whether you want to apply a Legal Hold to the uploaded object. - - - - - - Gets and sets the property ObjectLockMode. - - Specifies the Object Lock mode that you want to apply to the uploaded object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - Specifies the date and time when you want the Object Lock to expire. - - - - - - The tag-set for the object. The tag-set must be encoded as URL Query parameters. - - - - - Checks if Tagging property is set - - true if Tagging is set. - - - - Returns information about the InitiateMultipartUpload response and response metadata. - - - - - Name of the bucketName to which the multipart upload was initiated. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Object key for which the multipart upload was initiated. - - - - - - Gets and sets the initiated multipart upload id. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - Date when multipart upload will become eligible for abort operation by lifecycle. - - - - - Id of the lifecycle rule that makes a multipart upload eligible for abort operation. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Identifies who initiated the multipart upload. - - - - - Name of the Principal. - - - - - - If the principal is an AWS account, it provides the Canonical User ID. If the principal is an IAM User, it provides a user ARN value. - - - - - - Describes the serialization format of the object. - - - - - Describes the serialization of a CSV-encoded object. - - - - - Specifies object's compression format. Valid values: NONE, GZIP. Default Value: NONE. - - - - - Specifies JSON as object's input serialization format. - - - - - Specifies Parquet as object's input serialization format. - - - - - Class for MetricsConfiguration - - - - - Contains information about where to publish the inventory results. - - - - - Specifies whether the inventory is enabled or disabled. - - - - - Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria. - - - - - The ID used to identify the inventory configuration. - - - - - Specifies which object version(s) to included in the inventory results. - - - - - Contains the optional fields that are included in the inventory results. - - - - - Specifies the schedule for generating inventory results. - - - - - Class for InventoryDestination - - - - - Contains the bucket name, file format, bucket owner (optional), and prefix (optional) where inventory results are published. - - - - - InventoryEncryption class - - - - - Specifies the use of SSE-S3 to encrypt delievered Inventory reports. - - - - - Specifies the use of SSE-KMS to encrypt delievered Inventory reports. - - - - - Class for InventoryFilter - - - - - Filter Predicate setup for specific filter types. - - - - - Filter Predicate abstract class for specific filter types to be derived from. - - - - - Class for InventoryPrefixPredicate - The prefix that an object must have to be included in the inventory results. - - - - - The ID of the account that owns the destination bucket. - - - - - The Amazon resource name (ARN) of the bucket where inventory results will be published. - - - - - The prefix that is prepended to all inventory results. - - - - - Specifies the output format of the inventory results. - - - - - Contains the type of server-side encryption used to encrypt the inventory results. - - - - - Class for InventorySchedule - - - - - Specifies how frequently inventory results are produced. - - - - - Specifies JSON as object's input serialization format. - - - - - The type of JSON. Valid values: Document, Lines. - - - - - Specifies JSON as request's output serialization format - - - - - The value used to separate individual records in the output. - - - - - Specifies an object key and optional object version. - - - - - Key name of the object to delete. - - - - - - VersionId for the specific version of the object to delete. - - - - - - This class contains the configuration Amazon S3 uses to figure out what events you want to listen - and send the event to an Amazon Lambda cloud function. - - - - - Gets and set the Id property. The Id will be provided in the event content and can be used - to identify which configuration caused an event to fire. If the Id is not provided for the configuration, one will be generated. - - - - - Gets and sets the FunctionArn property. This is the Amazon Lambda cloud function to which Amazon S3 will invoke with the events. - - - - Lifecycle Configuration - - - - - Gets and sets the Rules property. These rules defined the lifecycle configuration. - - - - - Base class for all the different predicates that can be used - in a filter. - - - - - This method is called by the visitor when it wants to visit the predicate. - - - - - - Filter identifying one or more objects to which a applies. - - - - - The predicate used by the filter. - - - - - Base class for lifecycle operators. - - - - - The list of objects - that this operator operates on. - - - - - The logical and operator for filtering objects for a - - - - - Accept a visit from an - - - This method is used internally by the SDK. - - - - - - A predicate that filters objects for a - by matching a particular prefix. - - - - - The prefix to be matched by filtered objects. - - - - - Accept a visit from an - - - This method is used internally by the SDK. - - - - - - A predicate that filters objects for a - by matching a particular key and value. - - - - - The Tag to be matched by filtered objects. - - - - - Accept a visit from an - - - This method is used internally by the SDK. - - - - - - Rules Item - - - - - Defines the length of time, in days, before objects expire. - - - - - Unique identifier for the rule. The value cannot be longer than 255 characters. - - - - - Prefix identifying one or more objects to which the rule applies. - - - - - - Filter identifying one or more objects to which the rule applies. - - - - - If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied. - - - - - - The transition rule that describes when objects transition to a different storage class. - - Lifecycle rules can now contain multiple transitions. This property is obsolete in favor of the Transitions property. - This property will always get or set the the zeroth element in the Transitions collection. - - - - - - Defines the length of time, in days, before noncurrent versions expire. - - - - - The transition rule that describes when noncurrent versions transition to - a different storage class. - - Lifecycle rules can now contain multiple noncurrent version transitions. This property - is obsolete in favor of the NoncurrentVersionTransitions property. - This property will always get or set the the zeroth element in the NoncurrentVersionTransitions collection. - - - - - - The transition rules that describe when objects transition to a different storage class. - - - - - The transition rules that describe when noncurrent versions transition to - a different storage class. - - - - - Specifies the days since the initiation of an Incomplete Multipart Upload - that Lifecycle will wait before permanently removing all parts of the upload. - - - - - Specifies the days since the initiation of an Incomplete Multipart Upload - that Lifecycle will wait before permanently removing all parts of the upload. - - - - - Indicates the number of days that must pass since initiation for Lifecycle - to abort an Incomplete Multipart Upload. - - - - Expiration - - - - - Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format. - - - - - - Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer. - - - - - - Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set to true, the delete marker will be expired; if set to false the policy takes no action. This cannot be specified with Days or Date in a Lifecycle Expiration Policy. - - - - - - Noncurrent Version Expiration - - - - - Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated - action. For information about the noncurrent days calculations, see - How Amazon S3 Calculates When an Object Became Noncurrent - in the Amazon Simple Storage Service Developer Guide. - - - - - LifecycleTransition defines when and how objects transition. - - - - - Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated - action. For information about the noncurrent days calculations, see - How Amazon S3 Calculates When an Object Became Noncurrent - in the Amazon Simple Storage Service Developer Guide. - - - - - The class of storage used to store the object. - - - - - - LifecycleTransition defines when and how objects transition. - - - - - Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format. - - - - - - Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer. - - - - - - The class of storage used to store the object. - - - - - - Container for the parameters to the ListInventoryConfigurationsRequest operation. - Lists the analytics configurations for the bucket. - - - - - The name of the bucket containing the analytics configurations to retrieve. - - - - - The ContinuationToken that represents a placeholder from where this request should begin. - - - - - Returns information about the ListBucketAnalyticsConfigurationsResponse response and response metadata. - - - - - The ContinuationToken that represents where this request began. - - - - - The list of analytics configurations for a bucket. - - - - - Indicates whether the returned list of analytics configurations is complete. - A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request. - - - - - NextContinuationToken is sent when isTruncated is true, which indicates that there are more analytics configurations to list. - The next request must include this NextContinuationToken. The token is obfuscated and is not a usable value. - - - - - Container for the parameters to the ListInventoryConfigurationsRequest operation. - Returns a list of inventory configurations for the bucket. - - - - - The name of the bucket containing the inventory configurations to retrieve. - - - - - The marker used to continue an inventory configuration listing that has been truncated. - Use the NextContinuationToken from a previously truncated list response to continue the listing. - The continuation token is an opaque value that Amazon S3 understands. - - - - - Returns information about the ListInventoryConfigurationsResponse response and response metadata. - - - - - If sent in the request, the marker that is used as a starting point for this inventory configuration list response. - - - - - The list of inventory configurations for a bucket. - - - - - Indicates whether the returned list of inventory configurations is truncated in this response. A value of true indicates that the list is truncated. - - - - - The marker used to continue this inventory configuration listing. Use the NextContinuationToken from this response to continue the listing in a subsequent request. - The continuation token is an opaque value that Amazon S3 understands. - - - - - Container for the parameters to the ListBucketMetricsConfigurationRequest operation. - Lists the metrics configurations for the bucket. - - - - - The name of the bucket containing the metrics configurations to retrieve. - - - - - - The marker that is used to continue a metrics configuration listing that has been truncated. - Use the NextContinuationToken from a previously truncated list response to continue the listing. - The continuation token is an opaque value that Amazon S3 understands. - - - - - - Returns information about the ListBucketMetricsConfiguration response and response metadata. - - - - - - The marker that is used to continue a metrics configuration listing that has been truncated. - Use the NextContinuationToken from a previously truncated list response to continue the listing. - The continuation token is an opaque value that Amazon S3 understands. - - - - - - The list of metrics configurations for a bucket. - - - - - - Indicates whether the returned list of metrics configurations is complete. - A value of true indicates that the list is not complete and the NextContinuationToken will be provided for - a subsequent request. - - - - - - - The marker used to continue a metrics configuration listing that has been truncated. - Use the NextContinuationToken from a previously truncated list response to continue the listing. - The continuation token is an opaque value that Amazon S3 understands. - - - - - - Container for the parameters to the ListBuckets operation. - Returns a list of all buckets owned by the authenticated sender of the request. - - - - - Returns information about the ListBuckets response and response metadata. - - - - - List of buckets. - - - - - Owner of the buckets. - - - - - Container for the parameters to the ListMultipartUploads operation. - This operation lists in-progress multipart uploads. - - - - - Name of the bucket to which the multipart upload was initiated. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Character you use to group keys. - - - - - - Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin. - - - - - - Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response body. 1,000 is the maximum number of uploads that - can be returned in a response. - - - - - - Lists in-progress uploads only for those keys that begin with the specified prefix. - - - - - - Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the - upload-id-marker parameter is ignored. - - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - Returns information about the ListMultipartUploads response and response metadata. - - - - - Name of the bucketName to which the multipart upload was initiated. - - - - - - The key at or after which the listing began. - - - - - - Upload ID after which listing began. - - - - - - When a list is truncated, this element specifies the value that should be used for the key-marker request parameter in a subsequent request. - - - - - - When a list is truncated, this element specifies the value that should be used for the upload-id-marker request parameter in a subsequent - request. - - - - - - Maximum number of multipart uploads that could have been included in the response. - - - - - - Indicates whether the returned list of multipart uploads is truncated. A value of true indicates that the list was truncated. The list can - be truncated if the number of multipart uploads exceeds the limit allowed or specified by max uploads. - - - - - - Gets and sets the MultipartUploads property. - - Container for elements related to a particular multipart upload. A response - can contain zero or more Upload elements. - - - - - - Gets and sets the Prefix property. - - - - - Gets and sets the Delimiter property. - - - - - Gets the CommonPrefixes property. - A response can contain CommonPrefixes only if you specify a delimiter. - When you do, CommonPrefixes contains all (if there are any) keys between - Prefix and the next occurrence of the string specified by delimiter. In effect, - CommonPrefixes lists keys that act like subdirectories in the directory specified - by Prefix. For example, if prefix is notes/ and delimiter is a slash (/), in - notes/summer/july, the common prefix is notes/summer/. - - - - - Container for the parameters to the ListObjects operation. - Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a - subset of the objects in a bucket. - - - - - The name of the bucket containing the objects whose keys are to be listed. - - - - - A delimiter is a character you use to group keys. - - - - - Specifies the key to start with when listing objects in a bucket. - - - - - Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more. - - - - - Limits the response to keys that begin with the specified prefix. - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the ListObjects response and response metadata. - - - - - A flag that indicates whether or not Amazon S3 returned all of the results that satisfied - the search criteria. - - - - - Gets and sets the NextMarker property. - NextMarker is set by S3 only if a Delimiter was specified - in the original ListObjects request. If a delimiter was - not specified, the AWS SDK for .NET returns the last Key - of the List of Objects retrieved from S3 as the NextMarker. - - - - - Gets the S3Objects property. This is a list of - objects in the bucket that match your search criteria. - - - - - Gets and sets the Name property which is the name of the bucket. - - - - - Gets and sets the Prefix property. - - - - - Gets and sets the MaxKeys property. This is max number of object keys returned by the list operation. - - - - - Gets the CommonPrefixes property. - A response can contain CommonPrefixes only if you specify a delimiter. - When you do, CommonPrefixes contains all (if there are any) keys between - Prefix and the next occurrence of the string specified by delimiter. In effect, - CommonPrefixes lists keys that act like subdirectories in the directory specified - by Prefix. For example, if prefix is notes/ and delimiter is a slash (/), in - notes/summer/july, the common prefix is notes/summer/. - - - - - Gets and sets the Delimiter property. - Causes keys that contain the same string between the prefix and the - first occurrence of the delimiter to be rolled up into a single result - element in the CommonPrefixes collection. - - - These rolled-up keys are not returned elsewhere in the response. - - - - - Container for the parameters to the ListObjects operation. - Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a - subset of the objects in a bucket. - - - - - Bucket name to list. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - A delimiter is a character you use to group keys. - - - - - Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more. - - - - - Limits the response to keys that begin with the specified prefix. - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts - listing after this specified key. StartAfter can be any key in the bucket. - Cannot be set at the same time as ContinuationToken. - - - - - ContinuationToken indicates Amazon S3 that the list is being continued on this - bucket with a token. ContinuationToken is obfuscated and is not a real key. - - - - - The owner field is not present in ListObjectsV2 responses by default. - If you want to return owner field with each key in the result then set this field to true. - If not specified, the Owner field on S3Object will be null. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the ListObjects response and response metadata. - - - - - A flag that indicates whether or not Amazon S3 returned all of the results that satisfied - the search criteria. - - - - - Gets and sets the S3Objects property. Metadata about each object returned. - - - - - Bucket name. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the Prefix property. - - - - - Gets and sets the MaxKeys property. This is max number of object keys returned by the list operation. - - - - - Gets and sets the CommonPrefixes property. - CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence - of the string specified by delimiter - - - - - Gets and sets the Delimiter property. - Causes keys that contain the same string between the prefix and the - first occurrence of the delimiter to be rolled up into a single result - element in the CommonPrefixes collection. - - - These rolled-up keys are not returned elsewhere in the response. - - - - - Encoding type used by Amazon S3 to encode object keys in the response. - - - - - KeyCount is the number of keys returned with this request. - KeyCount will always be less than or equal to MaxKeys field. - - - - - ContinuationToken indicates Amazon S3 that the list is being continued - on this bucket with a token. - ContinuationToken is obfuscated and is not a real key - - - - - NextContinuationToken is sent when isTruncated is true which means there - are more keys in the bucket that can be listed. The next ListObjectV2 call - to Amazon S3 can be continued with this NextContinuationToken. - NextContinuationToken is obfuscated and is not a real key. - - - - - StartAfter is where you want Amazon S3 to start listing from. - Amazon S3 starts listing after this specified key. - StartAfter can be any key in the bucket. - - - - - Container for the parameters to the ListParts operation. - Lists the parts that have been uploaded for a specific multipart upload. - - - - - Name of the bucket to which the parts are being uploaded. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The object key for which the multipart upload was initiated. - - - - - Sets the maximum number of parts to return. - - - - - - Specifies the part after which listing should begin. Only parts with higher part numbers will be listed. - - - - - - Upload ID identifying the multipart upload whose parts are being listed. - - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the ListParts response and response metadata. - - - - - Name of the bucketName to which the multipart upload was initiated. - - - - - - Object key for which the multipart upload was initiated. - - - - - - Upload ID identifying the multipart upload whose parts are being listed. - - - - - - Part number after which listing begins. - - - - - - When a list is truncated, this element specifies the last part in the list, as well as the value to use for the part-number-marker request - parameter in a subsequent request. - - - - - - Maximum number of parts that were allowed in the response. - - - - - - Indicates whether the returned list of parts is truncated. - - - - - - Gets and sets the Parts property. - - PartDetails is a container for elements related to a particular part. A response can contain - zero or more Part elements. - - - - - - Identifies who initiated the multipart upload. - - - - - - Gets and sets the Owner property. - - - - - The class of storage used to store the object. - - - - - - Date when multipart upload will become eligible for abort operation by lifecycle. - - - - - Id of the lifecycle rule that makes a multipart upload eligible for abort operation. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the ListVersions operation. - Returns metadata about all of the versions of objects in a bucket. - - - - - The bucket name that contains the objects. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - A delimiter is a character you use to group keys. - - - - - Specifies the key to start with when listing objects in a bucket. - - - - - Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more. - - - - - Limits the response to keys that begin with the specified prefix. - - - - - Specifies the object version you want to start listing from. - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - Returns information about the ListVersions response and response metadata. - - - - - A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria. If your results were - truncated, you can make a follow-up paginated request using the NextKeyMarker and NextVersionIdMarker response parameters as a starting - place in another request to return the rest of the results. - - - - - - Marks the last Key returned in a truncated response. - - - - - - Gets and sets the VersionIdMarker property. - Marks the last Version-Id returned in a truncated response. - - - - - Use this value for the key marker request parameter in a subsequent request. - - - - - - Use this value for the next version id marker parameter in a subsequent request. - - - - - - Gets and sets the Versions property. This is a list of - object versions in the bucket that match your search criteria. - - - - - Gets and sets the Name property. - The bucket's name. - - - - - Gets and sets the Prefix property. - Keys that begin with the indicated prefix are listed. - - - - - Gets and sets the MaxKeys property. - This is the maximum number of keys in the S3ObjectVersions collection. - The value is derived from the MaxKeys parameter to ListVersionsRequest. - - - - - Gets the CommonPrefixes property. - A response can contain CommonPrefixes only if you specify a delimiter. - When you do, CommonPrefixes contains all (if there are any) keys between - Prefix and the next occurrence of the string specified by delimiter. - - - - - Gets and sets the Delimiter property. - Causes keys that contain the same string between the prefix and the - first occurrence of the delimiter to be rolled up into a single result - element in the CommonPrefixes collection. - - - These rolled-up keys are not returned elsewhere in the response. - - - - - This class contains the meta data for an S3 object. - - - - - Gets and sets meta data for the object. Meta data names must start with "x-amz-meta-". If the name passeed in as the indexer - doesn't start with "x-amz-meta-" then it will be prepended. - - The name of the meta data. - The value for the meta data - - - - Adds the metadata to the collection, if the name already exists it will be overwritten. - - The name of the metadata element - The value for the metadata - - - - Gets the count of headers. - - - - - Gets the names of the meta data elements. - - - - - A metadata key-value pair to store with an object. - - - - - Key of metadata key-value pair - - - - - Value of metadata key-value pair - - - - - A container specifying replication metrics-related information, including whether - emitting metrics and Amazon S3 events for replication are enabled. In addition, contains - configurations related to specific metrics or events. Must be specified together with a - ReplicationTime block. - - - - - Specifies whether the replication metrics are enabled. - - - - - A container specifying the time threshold for emitting the - s3:Replication:OperationMissedThreshold event. - - - - - Class for MetricsAndOperatorPredicate - A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. - The operator must have at least two predicates, and an object must match all of the predicates - in order for the filter to apply. - - Note: The current implementation restricts the usage to atmost one MetricsPrefixPredicate - and any number of MetricsTagPredicates. - - - - Class for MetricsConfiguration - - - - - The ID used to identify the metrics configuration. - - - - - Specifies a metrics configuration filter. - The metrics configuration will only include objects that meet the filter's criteria. - A filter must be a prefix, a tag, or a conjunction (MetricsAndOperator). - - - - - Filter class for Metrics. - - - - - Filter Predicate setup for specific filter types. - - - - - Filter Predicate abstract class for specific filter types to be derived from. - - - - - Abstract class that can be used over logical filter predicates,i.e. AND/OR. - - - - - Class for MetricsPrefixPredicate - The prefix used when evaluating a metrics filter. - - - - - Class for MetricsTagPredicate - The tag used when evaluating a metrics filter. - - - - - This class contains the mfa codes used authentication - - - - - Gets and sets the serial number of the authentication device - - - - - Gets and sets the displated value on the authentication device - - - - - The formatted string of the mfa codes to be passed to S3. - - - - - Container for elements related to a particular multipart upload. - - - - - Date and time at which the multipart upload was initiated. - - - - - - Identifies who initiated the multipart upload. - - - - - - Key of the object for which the multipart upload was initiated. - - - - - - Gets and sets the Owner property. - - - - - The class of storage used to store the object. - - - - - - Upload ID that identifies the multipart upload. - - - - - - An abstract class for all the notification configurations associated with an Amazon S3 bucket. - - - - - Gets and sets the Events property. These are the events the configuration will listen to. - - - - - Filter criteria for determining which S3 objects trigger event notifications. - - - - - - The container element for Object Lock configuration parameters. - - - - - Gets and sets the property ObjectLockEnabled. - - Indicates whether this object has an Object Lock configuration enabled. - - - - - - Gets and sets the property Rule. - - The Object Lock rule in place for the specified object. - - - - - - A Legal Hold configuration for an object. - - - - - Gets and sets the property Status. - - Indicates whether the specified object has a Legal Hold in place. - - - - - - A Retention configuration for an object. - - - - - Gets and sets the property Mode. - - Indicates the Retention mode for the specified object. - - - - - - Gets and sets the property RetainUntilDate. - - - - - The container element for an Object Lock rule. - - - - - Gets and sets the property DefaultRetention. - - The default retention period that you want to apply to new objects placed in the specified - bucket. - - - - - - Describes the location where the restore job's output is stored. - - - - - Describes an S3 location that will receive the results of the restore request. - - - - - Describes how results of the Select job are serialized. - - - - - Describes the serialization of CSV-encoded Select results. - - - - - Specifies JSON as request's output serialization format. - - - - - The owner of an S3 bucket. - - - - - The display name of the owner. - - - - - The unique identifier of the owner. - - - - - This class contains custom querystring parameters for an S3 object, which can then be signed as part of a Pre-signed URL request - - - - - Gets and sets parameters for the object. Parameter names must start with "x-". If the name passeed in as the indexer - doesn't start with "x-" then it will be prepended. - - The name of the parameter. - The value for the meta data - - - - Adds the parameter to the collection, if the name already exists it will be overwritten. - - The name of the parameter - The value for the parameter - - - - Gets the count of parameters. - - - - - Gets the names of the parameter elements. - - - - - Specifies Parquet as object's input serialization format. - - - - - A container for elements related to a particular part in a multipart operation. - A response can contain zero or more Part elements. - - - - - The date and time at which the part was uploaded. - - - - - The size of the uploaded part data. - - - - - A container holding the part number and etag used when completing a multipart upload. - - - - - Default constructor. - - - - - Constructs an instance of PartETag and sets the part number and etag. - - The part number. - the associated ETag for the part number. - - - - Compares the current object with another object of the same type. - - An object to compare with this object. - - A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has the following meanings: - Value - Meaning - Less than zero - This object is less than the parameter. - Zero - This object is equal to . - Greater than zero - This object is greater than . - - - - - The part number identifying the part. - - - - - The entity tag associated with the part. - - - - - The container element for this bucket's public-policy status. - - - - - Gets and sets the property IsPublic. - - The public-policy status for this bucket. TRUE indicates that this bucket - is public. FALSE indicates that the bucket is not public. - - - - - - The container element for all Public Access Block configuration options. You can enable - the configuration options in any combination. - - - - Amazon S3 considers a bucket policy public unless at least one of the following conditions - is true: - -
  1. - - The policy limits access to a set of CIDRs using aws:SourceIp. For more - information on CIDR, see http://www.rfc-editor.org/rfc/rfc4632.txt - - -
  2. - - The policy grants permissions, not including any "bad actions," to one of the following: - -
    • - - A fixed AWS principal, user, role, or service principal - -
    • - - A fixed aws:SourceArn - -
    • - - A fixed aws:SourceVpc - -
    • - - A fixed aws:SourceVpce - -
    • - - A fixed aws:SourceOwner - -
    • - - A fixed aws:SourceAccount - -
    • - - A fixed value of s3:x-amz-server-side-encryption-aws-kms-key-id - -
    • - - A fixed value of aws:userid outside the pattern "AROLEID:*" - -
- - "Bad actions" are those that could expose the data inside a bucket to reads or writes - by the public. These actions are s3:Get*, s3:List*, s3:AbortMultipartUpload, - s3:Delete*, s3:Put*, and s3:RestoreObject. - - - - The star notation for bad actions indicates that all matching operations are considered - bad actions. For example, because s3:Get* is a bad action, s3:GetObject, - s3:GetObjectVersion, and s3:GetObjectAcl are all bad actions. - - - - - - Gets and sets the property BlockPublicAcls. - - Specifies whether Amazon S3 should block public ACLs for this bucket. Setting this - element to TRUE causes the following behavior: - -
  • - - PUT Bucket acl and PUT Object acl calls will fail if the specified ACL allows public - access. - -
  • - - PUT Object calls will fail if the request includes an object ACL. - -
- - Note that enabling this setting doesn't affect existing policies or ACLs. - - - - - - Gets and sets the property IgnorePublicAcls. - - Specifies whether Amazon S3 should ignore public ACLs for this bucket. Setting this - element to TRUE causes Amazon S3 to ignore all public ACLs on this bucket - and any objects that it contains. - - - - Note that enabling this setting doesn't affect the persistence of any existing ACLs - and doesn't prevent new public ACLs from being set. - - - - - - Gets and sets the property BlockPublicPolicy. - - Specifies whether Amazon S3 should block public bucket policies for this bucket. Setting - this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy - if the specified bucket policy allows public access. - - - - Note that enabling this setting doesn't affect existing bucket policies. - - - - - - Gets and sets the property RestrictPublicBuckets. - - Specifies whether Amazon S3 should restrict public bucket policies for this bucket. - If this element is set to TRUE, then only the bucket owner and AWS Services - can access this bucket if it has a public policy. - - - - Note that enabling this setting doesn't affect previously stored bucket policies, - except that public and cross-account access within any public bucket policy, including - non-public delegation to specific accounts, is blocked. - - - - - - Container for the parameters to the PutAcl operation. - uses the acl subresource to set the access control list (ACL) permissions for an object that already exists in a bucket - - - - - The canned ACL to apply to the bucket. - - - - - - Custom ACLs to be applied to the bucket or object. - - - - - The bucket name that contains the object to which you want to attach the ACL. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The key of an S3 object. - If not specified, the ACLs are applied to the bucket. - - - - - If set and an object key has been specified, the ACLs are applied - to the specific version of the object. - This property is ignored if the ACL is to be set on a Bucket. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - Returns information about the PutObjectAcl response metadata. - The PutAcl operation has a void result type. - - - - - The response for the PutBucketAccelerateConfiguration operation. - Adds an object to a bucket. - - - - - Container for the parameters to the PutBucketAccelerateConfiguration request. - - - - - The name of the bucket to contain the object. - - - - - Accelerate configuration for the bucket. - - - - - Container for the parameters to the PutBucketAnalyticsConfiguration operation. - Sets an analytics configuration for the bucket (specified by the analytics configuration ID). - - - - - The name of the bucket to which an analytics configuration is stored. - - - - - The identifier used to represent an analytics configuration. - - - - - The configuration and any analyses for the analytics filter. - - - - - Returns information about the PutBucketAnalyticsConfigurationResponse response metadata. - The PutBucketAnalyticsConfigurationResponse operation has a void result type. - - - - - Container for the parameters to the PutBucketRequestPayment operation. - Creates a new server-side encryption configuration (or replaces an existing one, if present). - - - - - The name of the bucket for which the server-side encryption configuration is set. - - - - - The base64-encoded 128-bit MD5 digest of the server-side encryption configuration. - - - This header can be used as a message integrity check to verify that the data is the same data that was originally sent. - Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. - - - - - Container for server-side encryption configuration rules. Currently S3 supports one rule only. - - - - - Container for the parameters to the PutBucketRequestPayment operation. - Adds an inventory configuration (identified by the inventory ID) from the bucket. - - - - - The name of the bucket where the inventory configuration will be stored. - - - - - Specifies the inventory Id. - - - - - Specifies the inventory configuration. - - - - - Returns information about the PutInventoryConfigurationResponse response metadata. - The PutInventoryConfigurationResponse operation has a void result type. - - - - - Container for the parameters to the PutBucketLoggingRequest operation. - Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. To set the - logging status of a bucket, you must be the bucket owner. - - - - - Gets and sets the BucketName property. - - - - - Gets and sets the LoggingConfig property. - - - - - Returns information about the PutBucketLogging response metadata. - The EnableBucketLogging operation has a void result type. - - - - - Container for the parameters to the PutBucketMetricsConfigurationRequest operation. - Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. - - - - - The name of the bucket for which the metrics configuration is set. - - - - - The ID used to identify the metrics configuration. - - - - - Specifies the metrics configuration. - - - - - Returns information about the PutBucketMetricsConfiguration response metadata. - The PutBucketMetricsConfiguration operation has a void result type. - - - - - Container for the parameters to the PutBucketNotification operation. - Enables notifications of specified events for a bucket. - - - - - Gets and sets the BucketName property. - - - - - Gets and sets the TopicConfigurations property. TopicConfigurations are configuration for Amazon S3 - events to be sent to Amazon SNS topics. - - - - - Gets and sets the QueueConfigurations property. QueueConfigurations are configuration for Amazon S3 - events to be sent to Amazon SQS queues. - - - - - Gets and sets the LambdaFunctionConfigurations property. LambdaFunctionConfigurations are configuration for - Amazon S3 events to be sent to an Amazon Lambda cloud function. - - - - - Returns information about the PutBucketNotification response metadata. - The PutBucketNotification operation has a void result type. - - - - - Container for the parameters to the PutBucketPolicy operation. - Replaces a policy on a bucket. If the bucket already has a policy, the one in this request completely replaces it. - - - - - The name of the bucket. - - - - - The base64 encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. - - - This header can be used as a message integrity check to verify that the data is the same data that was originally sent. - Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. - - - - - The bucket policy as a JSON document. - - - - - Set this parameter to true to confirm that you want to remove your - permissions to change this bucket policy in the future. - - - - - Overriden to turn off sending SHA256 header. - - - - - Returns information about the PutBucketPolicy response metadata. - The PutBucketPolicy operation has a void result type. - - - - - Container for the parameters to the PutBucketReplication operation. - Sets replication configuration for your bucket. If a replication configuration exists, this replaces it. - - - - - The name of the bucket to have the replication configuration applied. - - - - - The replication configuration to be applied. - - - - - Gets and sets the property Token. - - - - - Returns information about the PutBucketReplicationConfiguration response metadata. - The PutBucketReplicationConfiguration operation has a void result type. - - - - - Container for the parameters to the PutBucket operation. - Creates a new bucket. - - - - - The canned ACL to apply to the bucket. - - - - - - If set to true the bucket will be created in the same region - as the configuration of the AmazonS3 client. - If PutBucketRequest.BucketRegion or PutBucketRequest.BucketRegionName are set they take precedence over - this property. - Default: true. - - - - - The name of the bucket to be created. - - - - - The region locality for the bucket. - - - When set, this will determine where your data will - reside in S3. Refer - for a list of possible values. - - - - - The bucket region locality expressed using the name of the region. - When set, this will determine where your data will reside in S3. - Valid values: us-east-1, us-west-1, us-west-2, eu-west-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, sa-east-1 - - - - - Gets and sets the property ObjectLockEnabledForBucket. - - Specifies whether you want S3 Object Lock to be enabled for the new bucket. - - - - - - Container for the parameters to the PutBucketRequestPayment operation. - Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This - configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the - download. - - - - - The name of the bucket to set payment config. - - - - - Gets and sets request payment configuration - - - - - Returns information about the PutBucketRequestPayment response metadata. - The PutBucketRequestPayment operation has a void result type. - - - - - Returns information about the PutBucket response and response metadata. - - - - - Container for the parameters to the PutBucketTagging operation. - Sets the tags for a bucket. - - - - - The name of the bucket to apply the tags to. - - - - - The collection of tags. - - - - - Returns information about the PutBucketTagging response metadata. - The PutBucketTagging operation has a void result type. - - - - - Container for the parameters to the PutBucketVersioning operation. - Sets the versioning state of an existing bucket. To set the versioning state, you must be the bucket owner. - - - - - The name of the bucket to be updated. - - - - - The MfaCodes Tuple associates the Serial Number and the current Token/Code displayed on the - Multi-Factor Authentication device associated with your AWS Account. - - - This is a required property for this request if:
- 1. EnableMfaDelete was configured on the bucket - containing this object's version.
- 2. You are deleting an object's version - - - - - Checks if the MfaCodes property is set. - - true if the MfaCodes property is set. - - - - The versioning configuration to apply to the bucket. - - - Once Versioning has been "Enabled" on a bucket, it can be "Suspended" - but cannot be switched "Off". If EnableMfaDelete is set, - the MfaCodes property needs to contain the Serial of and current Token - displayed on the MFA device. - - - - - Returns information about the PutBucketVersioning response metadata. - The PutBucketVersioning operation has a void result type. - - - - - Container for the parameters to the PutBucketWebsite operation. - Set the website configuration for a bucket. - - - - - The name of the bucket to apply the configuration to. - - - - - The website configuration to apply. The configuration defines the index - document suffix and custom error page. - - - - - Returns information about the PutBucketWebsite response metadata. - The PutBucketWebsite operation has a void result type. - - - - - Container for the parameters to the PutCORSConfiguration operation. - Sets the cors configuration for a bucket. - - - - - The name of the bucket to have the CORS configuration applied. - - - - - The CORS configuration to apply. - - - - - Returns information about the PutCORSConfiguration response metadata. - The PutCORSConfiguration operation has a void result type. - - - - - Container for the parameters to the PutLifecycleConfiguration operation. - Sets lifecycle configuration for your bucket. If a lifecycle configuration exists, it replaces it. - - - - - The name of the bucket to have the lifecycle configuration applied. - - - - - The lifecycle configuration to be applied. - - - - - Returns information about the PutLifecycleConfiguration response metadata. - The PutLifecycleConfiguration operation has a void result type. - - - - - Container for the parameters to the PutObjectLegalHold operation. - Applies a Legal Hold configuration to the specified object. - - - - - The bucket name containing the object that you want to place a Legal Hold on. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property ContentMD5. - - The MD5 signature for the configuration included in your request. - - - - - - Gets and sets the property Key. - - The key name for the object that you want to place a Legal Hold on. - - - - - - Gets and sets the property LegalHold. - - Container element for the Legal Hold configuration you want to apply to the specified - object. - - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property VersionId. - - The version ID of the object that you want to place a Legal Hold on. - - - - - - This is the response object from the PutObjectLegalHold operation. - - - - - Gets and sets the property RequestCharged. - - - - - Container for the parameters to the PutObjectLockConfiguration operation. - Places an Object Lock configuration on the specified bucket. The rule specified in - the Object Lock configuration will be applied by default to every new object placed - in the specified bucket. - - - - - Gets and sets the property BucketName. - - The bucket whose Object Lock configuration you want to create or replace. - - - - - - Gets and sets the property ContentMD5. - - The MD5 signature for the configuration included in your request. - - - - - - Gets and sets the property ObjectLockConfiguration. - - The Object Lock configuration that you want to apply to the specified bucket. - - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property Token. - - - - - This is the response object from the PutObjectLockConfiguration operation. - - - - - Gets and sets the property RequestCharged. - - - - - Container for the parameters to the PutObject operation. - Adds an object to a bucket. - - - Container for the parameters to the PutObject operation. - Adds an object to a bucket. - - - - - A canned access control list (CACL) to apply to the object. - Please refer to for - information on S3 Canned ACLs. - - - - - Input stream for the request; content for the request will be read from the stream. - - - - - - The full path and name to a file to be uploaded. - If this is set the request will upload the specified file to S3. - - - For WinRT and Windows Phone this property must be in the form of "ms-appdata:///local/file.txt". - - - - - - Text content to be uploaded. Use this property if you want to upload plaintext to S3. - The content type will be set to 'text/plain'. - - - - - If this value is set to true then the stream used with this request will be closed when all the content - is read from the stream. - Default: true. - - - - - If this value is set to true then the stream will be seeked back to the start before being read for upload. - Default: true. - - - - - If this value is set to true then a chunked encoding upload will be used for the request. - Default: true. - - - - - Bucket name to which the PUT operation was initiated. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - Gets and sets Key property. This key is used to identify the object in S3. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - Checks if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - true if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - - - The type of storage to use for the object. Defaults to 'STANDARD'. - - - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - The Legal Hold status that you want to apply to the specified object. - - - - - - Gets and sets the property ObjectLockMode. - - The Object Lock mode that you want to apply to this object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - The date and time when you want this object's Object Lock to expire. - - - - - - If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - Attach a callback that will be called as data is being sent to the AWS Service. - - - - - This is a convenience property for Headers.ContentType. - - - - - An MD5 digest for the content. - - - - The base64 encoded 128-bit MD5 digest of the message - (without the headers) according to RFC 1864. This header - can be used as a message integrity check to verify that - the data is the same data that was originally sent. - - - If supplied, after the file has been uploaded to S3, - S3 checks to ensure that the MD5 hash of the uploaded file - matches the hash supplied. - - - Although it is optional, we recommend using the - Content-MD5 mechanism as an end-to-end integrity check. - - - - - - Checks if MD5Digest property is set. - - true if MD5Digest property is set. - - - - Overriden to turn off sending SHA256 header. - - - - - Overriden to turn on expect 100 continue. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - The tag-set for the object. The tag-set must be encoded as URL Query parameters. - - - - - Checks if Tagging property is set - - true if Tagging is set. - - - - Overrides the default request timeout value. - - - - If the value is set, the value is assigned to the Timeout property of the HTTPWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Overrides the default ReadWriteTimeout value. - - - - If the value is set, the value is assigned to the ReadWriteTimeout property of the HTTPWebRequest/WebRequestHandler object used - to send requests. - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - - Returns information about the PutObject response and response metadata. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - Entity tag for the uploaded object. - - - - - - Version of the object. - - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the PutObjectRetention operation. - Places an Object Retention configuration on an object. - - - - - The bucket name that contains the object you want to apply this Object Retention configuration to. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property BypassGovernanceRetention. - - - - - Gets and sets the property ContentMD5. - - The MD5 signature for the configuration included in your request. - - - - - - Gets and sets the property Key. - - The key name for the object that you want to apply this Object Retention configuration - to. - - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property Retention. - - The container element for the Object Retention configuration. - - - - - - Gets and sets the property VersionId. - - The version ID for the object that you want to apply this Object Retention configuration - to. - - - - - - This is the response object from the PutObjectRetention operation. - - - - - Gets and sets the property RequestCharged. - - - - - Container for the parameters to the PutObjectTagging operation. - - - - - The bucket name containing the object. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Check to see if Bucket property is set - - - - - Gets and sets Key property. This key is used to identify the object in S3. - - - - - Check to see if Key property is set - - - - - The tag-set for the object. The tag-set must be encoded as URL Query parameters - - - - - Checks if Tagging property is set. - - - - - VersionId used to reference a specific version of the object. - - - - - - Returns information about the PutObjectTagging response and response metadata. - - - - - Version of the object. - - - - - Container for the parameters to the PutPublicAccessBlock operation. - Creates or modifies the Public Access Block configuration for an Amazon S3 bucket. - - - - - Gets and sets the property BucketName. - - The name of the Amazon S3 bucket whose Public Access Block configuration you want - to set. - - - - - - Gets and sets the property ContentMD5. - - The MD5 hash of the PutPublicBlock request body. - - - - - - Gets and sets the property PublicAccessBlockConfiguration. - - The Public Access Block configuration that you want to apply to this Amazon S3 bucket. - - - - - - This is the response object from the PutPublicAccessBlock operation. - - - - - Base class for put operations that can also put an ACL. - - - - - Gets the access control lists (ACLs) for this request. - Please refer to for information on - S3 Grants. - - - - - This class contains the configuration Amazon S3 uses to figure out what events you want to listen - and send the event to an Amazon SQS queue. - - The queue's policy must allow S3 to send messages to it. The utility method - Amazon.SQS.AmazonSQSClient.AuthorizeS3ToSendMessage(string,string) - can be used to help setup the queue policy. - - - - - - Gets and set the Id property. The Id will be provided in the event content and can be used - to identify which configuration caused an event to fire. If the Id is not provided for the configuration, one will be generated. - - - - - Gets and sets the Queue property. Amazon SQS queue to which Amazon S3 will publish a message - to report the specified events for the bucket. - - The queue's policy must allow S3 to send messages to it. The utility method - Amazon.SQS.AmazonSQSClient.AuthorizeS3ToSendMessage(string,string) - can be used to help setup the queue policy. - - - - - - This class defines the configuration for replication. - - - - - Indicates the ARN of the role to assume. - - - - - Check to see if the Role property is set. - - true if the Role property is set. - - - - Container for information about a particular replication rule. - Replication configuration must have at least one rule and can contain up to 1,000 rules. - - - - - Checks to see if the Rules property is set. - - true if the Rules property is set. - - - - Destination configuration for a replication rule. - - - - -

Amazon resource name (ARN) of the bucket where you want Amazon - S3 to store replicas of the object identified by the rule.

- If you have multiple rules in your replication configuration, all - rules must specify the same bucket as the destination. A replication - configuration can replicate objects only to one destination bucket.

- - - - - Checks to see if BucketArn property is set. - - true if BucketArn property is set. - - - - The class of storage used to store the object. - - - - - -

Account ID of the destination bucket. Currently Amazon S3 verifies this - value only if Access Control Translation is enabled.

In a cross-account - scenario, if you tell Amazon S3 to change replica ownership to the AWS account - that owns the destination bucket by adding the AccessControlTranslation - element, this is the account ID of the destination bucket owner.

- - - - -

Container for information regarding the access control for replicas.

-

Use only in a cross-account scenario, where source and destination bucket - owners are not the same, when you want to change replica ownership to the AWS - account that owns the destination bucket. If you don't add this element to the - replication configuration, the replicas are owned by same AWS account that - owns the source object.

- - - - -

Container that provides encryption-related information. You must - specify this element if the SourceSelectionCriteria is - specified.

- - - - - A container specifying the time when all objects and operations on objects are - replicated. Must be specified together with a Metrics block. - - - - - A container specifying replication metrics-related information, including whether - emitting metrics and Amazon S3 events for replication are enabled. In addition, - contains configurations related to specific metrics or events. Must be specified - together with a ReplicationTime block. - - - - - Rule that specifies the replication configuration. - - - - - Unique identifier for the rule. The value cannot be longer than 255 characters. - - - - - Checks to see if Id property is set. - - true if Id property is set. - - - -

The priority associated with the rule. If you specify multiple rules in a - replication configuration, then Amazon S3 applies rule priority in the event - there are conflicts (two or more rules identify the same object based on - filter specified). The rule with higher priority takes precedence. For - example,

  • Same object quality prefix based filter criteria - If prefixes you specified in multiple rules overlap.

  • Same - object qualify tag based filter criteria specified in multiple rules

    • -

For more information, see - - Cross-Region Replication (CRR) in the Amazon S3 Developer Guide.

- - - - - Checks to see if Priority property is set. - - true if Priority property is set. - - - - Object keyname prefix identifying one or more objects to which the - rule applies. Maximum prefix length can be up to 1,024 characters. - - - - - Checks to see if Prefix property is set. - - true if Prefix property is set. - - - - Gets and sets the property Filter. - - - - - Checks to see if Filter property is set. - - true if Filter property is set. - - - - Whether the rule is applied or ignored. - - - - - Checks to see if Status property is set. - - true if Status property is set. - - - - Container for replication destination information. - - - - - Checks to see if Destination property is set. - - true if Destination property is set. - - - -

Container that describes additional filters in identifying source objects that - you want to replicate. Currently, Amazon S3 supports only the filter that you can - specify for objects created with server-side encryption using an AWS KMS-managed - key. You can choose to enable or disable replication of these objects.

if - you want Amazon S3 to replicate objects created with server-side encryption using - AWS KMS-managed keys.

- - - - - A container that specifies information about existing object replication. - You can choose whether to enable or disable the replication of existing objects. - - - - - Checks to see if ExistingObjectReplication property is set. - - true if ExistingObjectReplication property is set. - - - - Specifies whether Amazon S3 should replicate delete makers. - - - - - Checks to see if DeleteMarkerReplication property is set. - - true if DeleteMarkerReplication property is set. - - - - - - - - Object keyname prefix that identifies subset of objects to which the rule applies. - - - - - Checks to see if Prefix property is set. - - true if Prefix property is set. - - - - All of these tags must exist in the object's tag set in order for the rule to apply. - - - - - Checks to see if Tags property is set. - - true if Tags property is set. - - - - Filter that identifies subset of objects to which the replication rule applies. - A Filter must specify exactly one Prefix, - Tag, or an And child element. - - - - - Object keyname prefix that identifies subset of objects to which the rule applies. - - - - - Checks to see if Prefix property is set. - - true if Prefix property is set. - - - -

Container for specifying a tag key and value.

-

The rule applies only to objects having the tag in its tagset.

- - - - - Checks to see if Tag property is set. - - true if Tag property is set. - - - -

Container for specifying rule filters. These filters determine the - subset of objects to which the rule applies. The element is required - only if you specify more than one filter. For example:

  • -

    You specify both a Prefix and a Tag - filters. Then you wrap these in an And tag.

    • -

  • You specify filter based on multiple tags. Then you wrap the - Tag elements in an And tag.

- - - - - Checks to see if And property is set. - - true if And property is set. - - - - A container specifying the time when all objects and operations on objects are replicated. Must be specified together with a Metrics block. - - - - - Specifies whether the replication time is enabled. - - - - - A container specifying the time by which replication should complete for all objects and operations on objects. - - - - - A container specifying the time value. - - - - - Contains an integer specifying time in minutes. - - - - - Request Payment Configuration - - - - - Specifies who pays for the download and request fees. - - - - - Container for values of the response headers that will be set on a response from a GetObject request. - These values override any headers that were set when the object was uploaded to S3. - - - - - A standard MIME type describing the format of the object data. - - - The content type for the content being uploaded. This property defaults to "binary/octet-stream". - For more information, refer to: - - - - - ContentLanguage header value. - - - - - Expiry header value. - - - - - CacheControl header value. - - - - - The ContentDisposition header value. - - - - - The ContentEncoding header value. - - - - - Container for the parameters to the RestoreObject operation. - Restores an archived copy of an object back into Amazon S3 - - - - - The bucket name or containing the object to restore. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the Key property. This key indicates the S3 object to restore. - - - - - Lifetime of the active copy in days - ** Do not use with restores that specify OutputLocation ** - - - - - VersionId used to reference a specific version of the object. - - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Glacier retrieval tier at which the restore will be processed. - ** Do not use with restores that specify OutputLocation ** - - - - - Glacier retrieval tier at which the restore will be processed. - ** Only use with restores that require OutputLocation ** - - - - - Type of restore request. - - - - - The optional description for the job. - - - - - Describes the parameters for Select job types. - - - - - Describes the location where the restore job's output is stored. - - - - - Returns information about the RestoreObject response metadata. - The RestoreObject operation has a void result type. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Indicates the path in the provided S3 output location where Select results will be restored to. - - - - Routing Rule - - - - - A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the - /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might - process the error. - - - - - - Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event of an - error, you can can specify a different error code to return. - - - - - - A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages - in the /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you - might process the error. - - - - - The HTTP error code when the redirect is applied. In the event of an error, if the error code equals this value, then the specified redirect - is applied. Required when parent element Condition is specified and sibling KeyPrefixEquals is not specified. If both are specified, then - both must be true for the redirect to be applied. - - - - - - The object key name prefix when the redirect is applied. For example, to redirect requests for ExamplePage.html, the key prefix will be - ExamplePage.html. To redirect request for all pages with the prefix docs/, the key prefix will be /docs, which identifies all objects in the - docs/ folder. Required when the parent element Condition is specified and sibling HttpErrorCodeReturnedEquals is not specified. If both - conditions are specified, both must be true for the redirect to be applied. - - - - - - Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event - of an error, you can can specify a different error code to return. - - - - - Name of the host where requests will be redirected. - - - - - - The HTTP redirect code to use on the response. Not required if one of the siblings is present. - - - - - - Protocol to use (http, https) when redirecting requests. The default is the protocol that is used in the original request. - - - - - - The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix docs/ (objects in the - docs/ folder) to documents/, you can set a condition block with KeyPrefixEquals set to docs/ and in the Redirect set ReplaceKeyPrefixWith to - /documents. Not required if one of the siblings is present. Can be present only if ReplaceKeyWith is not provided. - - - - - - The specific object key to use in the redirect request. For example, redirect request to error.html. Not required if one of the sibling is - present. Can be present only if ReplaceKeyPrefixWith is not provided. - - - - - - Represents an access control list (ACL) for S3. An AccessControlList is represented by an Owner, - and a List of Grants, where each Grant is a Grantee and a Permission. - - - - Each bucket and object in Amazon S3 has an ACL that defines its access control policy. - When a request is made, Amazon S3 authenticates the request using its standard - authentication procedure and then checks the ACL to verify the sender was granted access - to the bucket or object. If the sender is approved, the request proceeds. - Otherwise, Amazon S3 returns an error. - - - An ACL is a list of grants. A grant consists of one grantee and one permission. - ACLs only grant permissions; they do not deny them. - - - For convenience, some commonly used Access Control Lists are defined in - S3CannedACL. - - - Note: BucketName and object ACLs are completely independent; an object does not inherit the ACL - from its bucket. For example, if you create a bucket and grant write access to another user, - you will not be able to access the user's objects unless the user explicitly grants access. - This also applies if you grant anonymous write access to a bucket. Only the user "anonymous" - will be able to access objects the user created unless permission is explicitly granted to - the bucket owner. - - - Important: We highly recommend that you do not grant the anonymous group write access to your - buckets as you will have no control over the objects others can store and their associated charges. - For more information, see Grantees and Permissions - - - - - Creates a S3Grant and adds it to the list of grants. - - The grantee for the grant. - The permission for the grantee. - - - - Removes a specific permission for the given grantee. - - The grantee - The permission for the grantee to remove - - - - Removes all permissions for the given grantee. - - - - - - The owner of the bucket or object. - - - - Every bucket and object in Amazon S3 has an owner, the user that - created the bucket or object. The owner of a bucket or object cannot - be changed. However, if the object is overwritten by another user - (deleted and rewritten), the new object will have a new owner. - - - Note: Even the owner is subject to the ACL. For example, if an owner - does not have Permission.READ access to an object, the owner cannot read - that object. However, the owner of an object always has write access to the - access control policy (Permission.WriteAcp) and can change the ACL to - read the object. - - - - - - Checks if Owner property is set. - - true if Owner property is set. - - - - A collection of grants. - - - - - Checks if Grants property is set. - - true if Grants property is set. - - - Bucket - Represents an S3 bucket, contains the name of the S3 bucket and the date that the bucket was created. - - - - - Date the bucket was created. - - - - - - The name of the bucket. - - - - - Logging Enabled - - - - - Specifies the bucket where you want Amazon S3 to store server access logs. You can have your logs delivered to any bucket that you own, - including the same bucket that is being logged. You can also configure multiple buckets to deliver their logs to the same target bucket. In - this case you should choose a different TargetPrefix for each source bucket so that the delivered log files can be distinguished by key. - - - - - A collection of grants. - - - - - This element lets you specify a prefix for the keys that the log files will be stored under. - - - - - Creates a S3Grant and adds it to the list of grants. - - The grantee for the grant. - The permission for the grantee. - - - - Removes a specific permission for the given grantee. - - The grantee - The permission for the grantee to remove - - - - Removes all permissions for the given grantee. - - - - - - An S3 bucket versioning configuration. - - - Contains the bucket's versioning status (Off, Enabled, Suspended) and whether an MFADelete - has been enabled for the bucket. - - - - - Versioning status for the bucket. - Accepted values: Off, Enabled, Suspended. - - - - - Checks if Status property is set - - true if Status property is set - - - - Specifies whether MFA Delete is enabled on this S3 Bucket. - - - If this property is set, please ensure that the - PutBucketVersioningRequest's MfaCodes property is set with - the Serial of and Token on the MFA device. - - - - - Checks if EnableMfaDelete property is set. - - true if Status property is set - - - - Describes the server-side encryption that will be applied to the restore results. - - - - - The server-side encryption algorithm used when storing job results in Amazon S3 (e.g., AES256, aws:kms). - - - - - Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by - AWS KMS will fail if not made via SSL or using SigV4. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at - http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version - - - - - If the encryption type is aws:kms, this optional value can be used to specify the encryption context for the restore results. - - - - Grant - - - - - The grantee details. - - - - - Specifies the permission given to the grantee. - - - - - Grantee - - - - - Type of grantee - - - - - - Screen name of the grantee. - - - - - - Email address of the grantee. - - - - - - The canonical user ID of the grantee. - - - - - - URI of the grantee group. - - - - - - Filter criteria that allows for event notification filtering based on an S3 Object's key name. - - - - - Gets and sets the filterRules property. - These are the filter rules for this filter. - - - - - Describes an S3 location that will receive the results of the restore request. - - - - - The name of the bucket where the restore results will be placed. - - - - - The prefix that is prepended to the restore results for this request. - - - - - The canned ACL to apply to the restore results. - - - - - A list of grants that control access to the staged results. - - - - - The tag-set that is applied to the restore results. - - - - - A map of metadata to store with the restore results in S3. - - - - - The class of storage used to store the restore results. - - - - - Represents an S3 Object. Contains all attributes that an S3 Object has. - For more information about S3 Objects refer: - - - - - - Any ETag set on the object. - - - - - The name of the bucket containing this object. - - - - - The key of the object. - - - - - The date and time the object was last modified. - - The date retrieved from S3 is in ISO8601 format. A GMT formatted date is passed back to the user. - - - - - - The owner of the object. - - - - - The size of the object. - - - - - The class of storage used to store the object. - - - - - - Represents a version of an object in an S3 Bucket. An S3 object version is an S3 object - that also has a version identifier, an indication of whether this is the latest version of the object - and whether it's a DeleteMarker or not. - - - - - Specifies whether the object is (true) or is not (false) the latest version of an object. - - - - - Version ID of an object. - - - - - If true, the object is a delete marker for a deleted object. - - - - - Specifies the byte range of the object to get the records from. A record is processed when its first byte is contained by the range. - - - - - Specifies the start of the byte range. This parameter is optional. Valid values: non-negative integers. The default value is 0. - - - - - Specifies the end of the byte range. This parameter is optional. Valid values: non-negative integers. The default value is one less than the size of the object being queried. - - - - - Request to filter the contents of an Amazon S3 object based on a simple Structured Query Language (SQL) statement. - - In the request, along with the SQL expression, you must also specify a data serialization format (JSON or CSV) of the object. - Amazon S3 uses this to parse object data into records, and returns only records - that match the specified SQL expression. You must also specify the data serialization format for the response. - - - - S3Select API Documentation - - - - - The S3 Bucket. - - - - - The Object Key. - - - - - The SSE Algorithm used to encrypt the object. - - - Server-Side Encryption (Using Customer-Provided Encryption Keys. - - - - - The SSE Customer Key. - - - Server-Side Encryption (Using Customer-Provided Encryption Keys. - - - - - The SSE Customer Key MD5. - - - Server-Side Encryption (Using Customer-Provided Encryption Keys. - - - - - The expression that is used to query the object. - - - - - The type of the provided expression (e.g., SQL). - - - - - Specifies if periodic request progress information should be enabled. - - - - - Describes the format of the data in the object that is being queried. - - - - - Describes the format of the data that you want Amazon S3 to return in response. - - - - - The byte range of the object to get the records from. - - - - - Contains the response Payload for the SelectObjectContent request - - - - - The Event Stream result of SelectObjectContent - - - - - Describes the parameters for Select job types. - - - - - Describes the serialization format of the object. - - - - - The type of the provided expression (e.g., SQL). - - - - - The expression that is used to query the object. - - - - - Describes how the results of the Select job are serialized. - - - - - ServerSideEncryptionByDefault class - - - - - Server-side encryption algorithm to use for the default encryption. - - - - - KMS master key ID to use for the default encryption. - This parameter is allowed if SSEAlgorithm is aws:kms. - - - - - ServerSideEncryptionConfiguration class - - - - - Container for information about a particular server-side encryption configuration rule. - - - - - ServerSideEncryptionRule class - - - - - Describes the default server-side encryption to apply to - new objects in the bucket. If Put Object request - does not specify any server-side encryption, - this default encryption will be applied. - - - - - SourceSelectionCriteria class - - - - - Container for filter information of selection of KMS Encrypted - S3 objects. The element is required if you include - SourceSelectionCriteria in the replication - configuration. - - - - - SSEKMS class - - - - - Specifies the ID of the AWS Key Management Service (KMS) - master encryption key to use for encrypting Inventory reports. - - - - - SseKmsEncryptedObjects class - - - - - The replication for KMS encrypted S3 objects is disabled if status is not Enabled. - - - - - SSES3 class - - - - - Class for StorageClassAnalysis - - - - - A container used to describe how data related to the storage class analysis should be exported. - - - - - Class for StorageClassAnalysisDataExport - - - - - The version of the output schema to use when exporting data. Must be V_1. - - - - - The place to store the data for an analysis. - - - - - Base class for responses that return a stream. - - - - - Disposes of all managed and unmanaged resources. - - - - - An open stream read from to get the data from S3. In order to - use this stream without leaking the underlying resource, please - wrap access to the stream within a using block. - - - - - The exception that is thrown when the size of a stream does not match it's expected size. - - - - - Gets and sets ExpectedSize property. - - - - - Gets and sets ActualSize property. - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - - - Constructs a new instance of the AmazonServiceException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - Tag is a key-value pair of metadata associated with an S3Object - - - - - Name of the tag. - - - - - Value of the tag. - - - - - Structure that contains list of Tags - - - - - TagSet - - - - - This class contains the configuration Amazon S3 uses to figure out what events you want to listen - and send the event to an Amazon SNS topic. - - The topic's policy must allow S3 to publish messages to it. The utility method - Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.AuthorizeS3ToPublish(string,string) - can be used to help setup the topic policy. - - - - - - Gets and set the Id property. The Id will be provided in the event content and can be used - to identify which configuration caused an event to fire. If the Id is not provided for the configuration, one will be generated. - - - - - Bucket event for which to send notifications. - - Topic configurations can now contain multiple events. This property is obsolete in favor of the Events property. - This property will always get or set the the zeroth element in the Events collection. - - - - - - Gets and sets the Topic property. Amazon SNS topic to which Amazon S3 will publish a message to report the - specified events for the bucket. - - The topic's policy must allow S3 to publish messages to it. The utility method - Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.AuthorizeS3ToPublish(string,string) - can be used to help setup the topic policy. - - - - - - The parameters to request upload of a part in a multipart upload operation. - - - - If PartSize is not specified then the rest of the content from the file - or stream will be sent to Amazon S3. - - - You must set either the FilePath or InputStream. If FilePath is set then the FilePosition - property must be set. - - - - The parameters to request upload of a part in a multipart upload operation. - - - - If PartSize is not specified then the rest of the content from the file - or stream will be sent to Amazon S3. - - - You must set either the FilePath or InputStream. If FilePath is set then the FilePosition - property must be set. - - - - - - Caller needs to set this to true when uploading the last part. This property only needs to be set - when using the AmazonS3EncryptionClient. - - - - - Input stream for the request; content for the request will be read from the stream. - - - - - The name of the bucket containing the object to receive the part. - - - - - The key of the object. - - - - - Part number of part being uploaded. - - - - - - The size of the part to be uploaded. - - - - - Checks if PartSize property is set. - - true if PartSize property is set. - - - - Upload ID identifying the multipart upload whose part is being uploaded. - - - - - - An MD5 digest for the part. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - - Full path and name of a file from which the content for the part is retrieved. - - - For WinRT and Windows Phone this property must be in the form of "ms-appdata:///local/file.txt". - - - - - - Checks if the FilePath property is set. - - true if FilePath property is set. - - - - Position in the file specified by FilePath from which to retrieve the content of the part. - This field is required when a file path is specified. It is ignored when using the InputStream property. - - - - - If this value is set to true then a chunked encoding upload will be used for the request. - Default: true. - - - - - Checks if the FilePosition property is set. - - true if FilePosition property is set. - - - - Checks if the MD5Digest property is set. - - true if Md5Digest property is set. - - - - Attach a callback that will be called as data is being sent to the AWS Service. - - - - - Overriden to turn off sending SHA256 header. - - - - - Overriden to turn on Expect 100 continue. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Overrides the default request timeout value. - - - - If the value is set, the value is assigned to the Timeout property of the HTTPWebRequest/HttpClient object used - to send requests. - - - Please specify a timeout value only if the operation will not complete within the default intervals - specified for an HttpWebRequest/HttpClient. - - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - Overrides the default ReadWriteTimeout value. - - - - If the value is set, the value is assigned to the ReadWriteTimeout property of the HTTPWebRequest/WebRequestHandler object used - to send requests. - - The timeout specified is null. - The timeout specified is less than or equal to zero and is not Infinite. - - - - - - - Returns information about the UploadPart response and response metadata. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - Entity tag for the uploaded object. - - - - - - Gets and sets the part number specified for the part upload. This is needed when - completing the multipart upload. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - Website Configuration - - - - - The ErrorDocument value, an object key name to use when a 4XX class error occurs. - - - - - - This value is a suffix that is appended to a request that is for a "directory" - on the website endpoint (e.g. if the suffix is index.html and - you make a request to samplebucket/images/ the data that - is returned will be for the object with the key name - images/index.html) - - - The suffix must not be empty and must not include a slash - character. - - - - - - Container for redirect information where all requests will be redirect - to. You can redirect requests to another host, to another page, or with - another protocol. In the event of an error, you can can specify a - different error code to return. . - - - - - The list of routing rules that can be used for configuring redirects if certain conditions are meet. - - - - - Arguments containing event details for an in-flight transfer. - - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - - - - Gets the percentage of transfer completed - - - - - Gets the number of bytes transferred since last event - - - - - Gets the number of bytes transferred - - - - - Gets the total number of bytes to be transferred - - - - - Returns a string representation of this object - - - - - - AmazonS3 exception. - Thrown when DeleteObjects returns successfully, but some of the objects - were not deleted. - - - - - Gets and sets the ErrorResponse property. - The DeleteObjectsErrorResponse associated with this exception. - - - - - Constructs an instance of DeleteObjectsException - - - - - - Constructs a new instance of the DeleteObjectsException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - The file format used when exporting data to Amazon S3. - - - - - CSV file format. - - - - - Construct instance of AnalyticsS3ExportFileFormat. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to an AnalyticsS3ExportFileFormat. - - - - - - - Represents the accelerate status for a bucket. - - - - - Bucket acceleration is enabled. - - - - - Bucket acceleration is suspended. - - - - - Construct instance of BucketAccelerateStatus. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to an BucketAccelerateStatus - - - - - - - The status of the delete marker replication. - - - - - Delete marker replication is enabled. - - - - - Delete marker replication is disabled. - - - - - Construct instance of DeleteMarkerReplicationStatus. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to a DeleteMarkerReplicationStatus - - - - - - - A list of all possible CannedACLs that can be used - for S3 Buckets or S3 Objects. For more information about CannedACLs, refer to - . - - - - - Owner gets FULL_CONTROL. - No one else has access rights (default). - - - - - Owner gets FULL_CONTROL. - No one else has access rights (default). - - - - - Owner gets FULL_CONTROL and the anonymous principal is granted READ access. - If this policy is used on an object, it can be read from a browser with no authentication. - - - - - Owner gets FULL_CONTROL, the anonymous principal is granted READ and WRITE access. - This can be a useful policy to apply to a bucket, but is generally not recommended. - - - - - Owner gets FULL_CONTROL, and any principal authenticated as a registered Amazon - S3 user is granted READ access. - - - - - Owner gets FULL_CONTROL. Amazon EC2 gets READ access to GET an - Amazon Machine Image (AMI) bundle from Amazon S3. - - - - - Object Owner gets FULL_CONTROL, Bucket Owner gets READ - This ACL applies only to objects and is equivalent to private when used with PUT Bucket. - You use this ACL to let someone other than the bucket owner write content (get full control) - in the bucket but still grant the bucket owner read access to the objects. - - - - - Object Owner gets FULL_CONTROL, Bucket Owner gets FULL_CONTROL. - This ACL applies only to objects and is equivalent to private when used with PUT Bucket. - You use this ACL to let someone other than the bucket owner write content (get full control) - in the bucket but still grant the bucket owner full rights over the objects. - - - - - The LogDelivery group gets WRITE and READ_ACP permissions on the bucket. - - - - - Construct instance of S3CannedACL. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to an S3CannedACL - - - - - - - A list of all possible S3 Bucket region possibilities. For - more information, refer to - . - - - - - Specifies that the S3 Bucket should use US locality. - This is the default value. - - - - - Specifies that the S3 Bucket should use US-EAST-2 locality. - - - - - Specifies that the S3 Bucket should use EU locality which defaults to EU-WEST-1 - - - - - Specifies that the S3 Bucket should use the EU-NORTH-1 locality. - - - - - Specifies that the S3 Bucket should use the EU-WEST-1 locality. - - - - - Specifies that the S3 Bucket should use the EU-WEST-2 locality. - - - - - Specifies that the S3 Bucket should use the EU-WEST-3 locality. - - - - - Specifies that the S3 Bucket should use the EU-CENTRAL-1 locality. - - - - - Specifies that the S3 Bucket should use US-WEST-1 locality. - - - - - Specifies that the S3 Bucket should use US-WEST-2 locality. - - - - - Specifies that the S3 Bucket should use US-GOV-EAST-1 locality. - - - - - Specifies that the S3 Bucket should use US-GOV-WEST-1 locality. - - - - - Specifies that the S3 Bucket should use the AP-EAST-1 locality. - - - - - Specifies that the S3 Bucket should use the AP-SOUTHEAST-1 locality. - - - - - Specifies that the S3 Bucket should use the AP-SOUTHEAST-2 locality. - - - - - Specifies that the S3 Bucket should use the AP-NORTHEAST-1 locality. - - - - - Specifies that the S3 Bucket should use the AP-NORTHEAST-2 locality. - - - - - Specifies that the S3 Bucket should use the AP-NORTHEAST-3 locality. - - - - - Specifies that the S3 Bucket should use the AP-SOUTH-1 locality. - - - - - Specifies that the S3 Bucket should use the SA-EAST-1 locality. - - - - - Specifies that the S3 Bucket should use CN-NORTH-1 locality. - - - - - Specifies that the S3 Bucket should use CN-NORTHWEST-1 locality. - - - - - Specifies that the S3 Bucket should use CA-CENTRAL-1 locality. - - - - - Specifies that the S3 Bucket should use US-WEST-1 locality. - - - - - Specifies that the S3 Bucket should use CN-NORTH-1 locality. - - - - - Specifies that the S3 Bucket should use US-GOV-WEST-1 locality. - - - - - Construct instance of S3Region. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to the S3Region class - - - - - - - A list of all ACL permissions. For more information, refer to - . - - - - - When applied to a bucket, grants permission to list the bucket. - When applied to an object, this grants permission to read the - object data and/or metadata. - - - - - When applied to a bucket, grants permission to create, overwrite, - and delete any object in the bucket. This permission is not - supported for objects. - - - - - Grants permission to read the ACL for the applicable bucket or object. - The owner of a bucket or object always has this permission implicitly. - - - - - Gives permission to overwrite the ACP for the applicable bucket or object. - The owner of a bucket or object always has this permission implicitly. - Granting this permission is equivalent to granting FULL_CONTROL because - the grant recipient can make any changes to the ACP. - - - - - Provides READ, WRITE, READ_ACP, and WRITE_ACP permissions. - It does not convey additional rights and is provided only for convenience. - - - - - Gives permission to restore an object that is currently stored in Amazon Glacier - for archival storage. - - - - - Construct S3Permission. - - - - - - Construct instance of S3Permission. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - - Gets and sets the HeaderName property. - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to an S3Permission - - - - - - - An enumeration of all Metadata directives that - can be used for the CopyObject operation. - - - - - Specifies that the metadata is copied from the source object. - - - - - Specifies that the metadata is replaced with metadata provided in the request. - All original metadata is replaced by the metadata you specify. - - - - - An enumeration of all protocols that the pre-signed - URL can be created against. - - - - - https protocol will be used in the pre-signed URL. - - - - - http protocol will be used in the pre-signed URL. - - - - - An enumeration of supported HTTP verbs - - - - - The GET HTTP verb. - - - - - The HEAD HTTP verb. - - - - - The PUT HTTP verb. - - - - - The DELETE HTTP verb. - - - - - S3 Storage Class Definitions - - - - - The STANDARD storage class, which is the default - storage class for S3. - - Durability 99.999999999%; Availability 99.99% over a given year. - - - - - REDUCED_REDUNDANCY provides the same availability as standard, but at a lower durability. - - Durability 99.99%; Availability 99.99% over a given year. - - - - - The GLACIER storage is for object that are stored in Amazon Glacier. - This storage class is for objects that are for archival purpose and - get operations are rare. - - Durability 99.999999999% - - - - - The STANDARD_IA storage is for infrequently accessed objects. - This storage class is for objects that are long-lived and less frequently accessed, - like backups and older data. - - Durability 99.999999999%; Availability 99.9% over a given year. - - - - - The ONEZONE_IA storage is for infrequently accessed objects. It is similiar to STANDARD_IA, but - only stores object data within one Availablity Zone in a given region. - - Durability 99.999999999%; Availability 99% over a given year. - - - - - IntelligentTiering makes it easy to lower your overall cost of storage by automatically placing data in the storage - class that best matches the access patterns for the storage. With IntelligentTiering, you don’t need to define - and manage individual policies for lifecycle data management or write code to transition objects - between storage classes. Instead, you can use IntelligentTiering to manage transitions between Standard and - S-IA without writing any application code. IntelligentTiering also manages transitions automatically to - Glacier for long term archive in addition to S3 storage classes. - - - - - S3 Glacier Deep Archive provides secure, durable object storage class for long term data archival. - It is the ideal storage class to make an archival, durable copy of data that rarely, if ever, needs to be accessed. - It can be used as an offline backup for their most important data assets and to meet long-term retention needs. - - - - - Construct an instance of S3StorageClass. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to S3StorageClass. - - - - - - - The constants for the known event names used by S3 notification. S3 might add new - events before the SDK is updated. In which case the names listed in the S3 documentation - will work as well as these constants. - - - - - An event that says an object has been lost in the reduced redundancy storage. - - - - - A list of all server-side encryption methods for customer provided encryption keys. - - - - - No server side encryption to be used. - - - - - Use AES 256 server side encryption. - - - - - Constructs an instance of ServerSideEncryptionCustomerMethod. - - - - - - Finds the constant for the unique value. - - - - - - - Converts string to ServerSideEncryptionCustomerMethod. - - - - - - - A list of all server-side encryption methods. - - - - - No server side encryption to be used. - - - - - Use AES 256 server side encryption. - - - - - Use AWS Key Management Service for server side encryption. - - - - - Construct instance of ServerSideEncryptionMethod. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to ServerSideEncryptionCustomerMethod. - - - - - - - A list of all grantee types. - - - - - The predefined group. - - - - - The email address of an AWS account - - - - - The canonical user ID of an AWS account - - - - - Construct an instance of GranteeType. - - - - - - Finds the constant for the unique value. - - - - - - - Convert a string to GranteeType. - - - - - - - A list of all lifecycle statuses. - - - - - The rule is enabled. - - - - - The rule is disabled. - - - - - Constructs an instance LifecycleRuleStatus. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to LifecycleRuleStatus. - - - - - - - A list of all version statuses. - - - - - The rule is off. - - - - - The rule is suspended. - - - - - The rule is enabled. - - - - - Construct an instance of VersionStatus. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to VersionStatus. - - - - - - - A list of all encoding types. - - - - - Url encoding. - - - - - Constructs intance of EncodingType - - - - - - Finds the constant for the unique value. - - - - - - - Converts string to EncodingType - - - - - - - The bucket event for which to send notifications. - - - - - The event encapsulates all the object create events - - - - - Event for put operations - - - - - Event for post operations - - - - - Event for copy operations - - - - - Event for completing a multi part upload - - - - - This event encapsulates all the object removed events - - - - - Event for object removed, delete operation. - - - - - Event for object removed, delete marker created operation. - - - - - Event for objects stored in reduced redundancy and S3 detects the object is lost - - - - - Event for all object restore - - - - - Event for restore post operations. - - - - - Event for when object restore is completed. - - - - - Event for replication of all - - - - - Event for operation failed replication - - - - - Evemt for replication operation not tracked - - - - - Event for replication operation missed threshold - - - - - Event for operation replicated after threshold - - - - - Constructs instance of EventType. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to EventType. - - - - - - - Compares if the ConstantClass instances are equals. - - - - - - - Compares if the ConstantClass instances are equals. This is ovewritten to handle the - discrepancy with S3 events coming from Lambda that don't have the prefix "s3:". - - - - - - - A list of all Inventory Formats. - - - - - CSV inventory format - - - - - ORC inventory format - - - - - Parquet inventory format - - - - - Construct instance of InventoryFormat. - - - - - - Finds the constant for the unique value. - - The string representation of the InventoryFormat. - The InventoryFormat object for that string. - - - - Convert string to InventoryFormat. - - - - - - - A list of inventory included object versions. - - - - - All Inventory Included Object Versions - - - - - Current Inventory Included Object Versions - - - - - Construct instance of InventoryIncludedObjectVersions. - - - - - - Finds the constant for the unique value. - - The string representation of the InventoryIncludedObjectVersions. - The InventoryIncludedObjectVersions object for that string. - - - - Convert string to InventoryIncludedObjectVersions. - - - - - - - A list of inventory frequencies. - - - - - Daily Inventory Frequency - - - - - Weekly Inventory Frequency - - - - - Construct instance of InventoryFrequency. - - - - - - Finds the constant for the unique value. - - The string representation of the InventoryFrequency. - The InventoryFrequency object for that string. - - - - Convert string to InventoryFrequency. - - - - - - - A list of inventory optional fields. - - - - - InventoryOptionalField for Size - - - - - InventoryOptionalField for LastModifiedDate - - - - - InventoryOptionalField for StorageClass - - - - - InventoryOptionalField for ETag - - - - - InventoryOptionalField for IsMultipartUploaded - - - - - InventoryOptionalField for ReplicationStatus - - - - - InventoryOptionalField for EncryptionStatus - - - - - InventoryOptionalField for ObjectLockRetainUntilDate - - - - - InventoryOptionalField for ObjectLockMode - - - - - InventoryOptionalField for ObjectLockLegalHoldStatus - - - - - InventoryOptionalField for IntelligentTieringAccessTier - - - - - Construct instance of InventoryOptionalField. - - - - - - Finds the constant for the unique value. - - The string representation of the InventoryOptionalField. - The InventoryIncludedObjectVersions object for that string. - - - - Convert string to InventoryOptionalField. - - - - - - - The status of the replication job associated with this source object. - - - - - The object is pending replication. - - - - - The object has been replicated. - - - - - The object was created as a result of replication. - - - - - The object replication has failed due to a customer-attributable reason, and the replication will not be attempted again. - - - - - Construct instance of ReplicationStatus. - - - - - - Finds the constant for the unique value. - - The string representation of the ReplicationStatus. - The ReplicationStatus object for that string. - - - - Convert string to ReplicationStatus. - - - - - - - Whether a replication rule is applied or ignored. - - - - - The rule will be applied. - - - - - The rule will be ignored. - - - - - Construct instance of ReplicationRuleStatus - - - - - - Finds the constant for the unique value. - - The string representation of the ReplicationRuleStatus. - The ReplicationRuleStatus object for that string. - - - - Convert string to ReplicationRuleStatus. - - - - - - - Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request. - - - - - The object tag-set is copied from the source object. - - - - - The object tag-set is replaced with tag-set provided in the request. - - - - - Construct instance of TaggingDirective - - - - - Finds the constant for the unique value. - - The string representation of the TaggingDirective. - The TaggingDirective object for that string. - - - - Convert string to TaggingDirective. - - - - - All enumerations type for retrieval tier for Glacier restore. - - - - - Standard Tier for Glacier restore. - - - - - Bulk Tier for Glacier restore. - - - - - Expedited Tier for Glacier restore. - - - - - Construct instance of RestoreObjectRequestGlacierJobTier - - - - - - Finds the constant for the unique value. - - The string representation of the RestoreObjectRequestGlacierJobTier. - The RestoreObjectRequestGlacierJobTier object for that string. - - - - Convert string to RestoreObjectRequestGlacierJobTier. - - - - - - - The version of the output schema to use when exporting data. - - - - - The schema output version V_1. - - - - - Construct instance of StorageClassAnalysisSchemaVersion - - - - - - Finds the constant for the unique value. - - The string representation of the StorageClassAnalysisSchemaVersion. - The StorageClassAnalysisSchemaVersion object for that string. - - - - Convert string to StorageClassAnalysisSchemaVersion. - - - - - - - Acknowledges that requester pays for the operation. - - - - - Requester pays for the operation. - - - - - Finds the RequestPayer instance for the string value. - - - - - Converts string to RequestPayer instance - - - - - The response from S3 that it confirms that requester pays. - - - - - S3 acknowledges that the requester pays. - - - - - Finds the RequestCharged instance for the string value - - - - - converts the string to RequestCharged instance - - - - - The override value for the owner of the replica object. - - - - - Overrides destination bucket's owner. - - - - - Finds the OwnerOverride instance for the string value - - - - - converts the string to OwnerOverride instance - - - - - The replication for KMS encrypted S3 objects is disabled if status is not Enabled. - - - - - The replication for KMS encrypted S3 objects is enabled. - - - - - The replication for KMS encrypted S3 objects is disabled. - - - - - - - - - - Finds the SseKmsEncryptedObjectsStatus instance for the string value - - - - - Converts the string to SseKmsEncryptedObjectsStatus instance - - - - - Specify how headers will be handled. - - - - - Headers will be usable in SELECT clause. - - - - - Headers will be skipped - - - - - No header is present. - - - - - Finds the FileHeaderInfo instance for the string value - - - - - - - Converts the string to FileHeaderInfo instance - - - - - Specifies whether existing object replication is enabled. - - - - - Enable the replication of existing objects - - - - - Disable the replication of existing objects - - - - - Finds the ExistingObjectReplicationStatus instance for the string value - - - - - - - Converts the string to ExistingObjectReplicationStatus instance - - - - - Describes when fields in output should be surrounded with quotes. - - - - - Specifies that fields in output should always be surrounded in quotes. - - - - - Specifies that fields in output should be surrounded in quotes as necessary. - - - - - Finds the QuoteFields instance for the string value - - string value that maps to QuoteFields enum - QuoteFields enum - - - - Converts the string to QuoteFields instance - - - - - Type of the expression provided in the Expression member. - - - - - SQL expression - - - - - Finds the ExpressionType instance for the string value - - string value that maps to ExpressionType enum - ExpressionType enum - - - - Converts the string to ExpressionType instance - - - - - Indicates what type of job is being initiated. - - - - - Finds the RestoreRequestType instance for the string value - - - - - Converts the string to RestoreRequestType instance - - - - - The type of JSON. - - - - - Finds the JsonType instance for the string value - - - - - Converts the string to JsonType instance - - - - - Specifies object's compression format. - - - - - Finds the CompressionType instance for the string value - - - - - Converts the string to CompressionType instance - - - - - The type of ObjectLockEnabled - - - - - Finds the ObjectLockEnabled instance for the string value - - - - - Converts the string to ObjectLockEnabled instance - - - - - The type of ObjectLockLegalHoldStatus - - - - - Finds the ObjectLockLegalHoldStatus instance for the string value - - - - - Converts the string to ObjectLockLegalHoldStatus instance - - - - - The type of ObjectLockRetentionMode - - - - - Finds the ObjectLockRetentionMode instance for the string value - - - - - Converts the string to ObjectLockRetentionMode instance - - - - - The type of ObjectLockMode - - - - - Finds the ObjectLockMode instance for the string value - - - - - Converts the string to ObjectLockMode instance - - - - - Specifies whether the replication time is enabled. - - - - - Replication time is enabled. - - - - - Replication time is disabled. - - - - - Finds the ReplicationTimeStatus instance for the string value - - - - - - - Converts the string to ReplicationTimeStatus instance - - - - - - Specifies whether the replication metrics are enabled. - - - - - Replication metrics are enabled. - - - - - Replication metrics are disabled. - - - - - Finds the MetricsStatus instance for the string value - - - - - - - Converts the string to MetricsStatus instance - - - - - - The base class for requests that return Amazon S3 objects. - - - - - Gets or sets the name of the bucket. - - - The name of the bucket. - - - - - Gets whether or not the bucket name is set. - - - A value of true if the bucket name is set. - Returns false if otherwise. - - - - - Gets or sets the key under which the Amazon S3 object is stored. - - - The key under which the Amazon S3 object is stored. - - - - - Gets whether or not the key property is set. - - - A value of true if key property is set. - Returns false if otherwise. - - - - - Gets or sets the version ID of the Amazon S3 object. - - - The version ID of the Amazon S3 object. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or - ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Gets or sets the ModifiedSinceDate property. - - - The ModifiedSinceDate property. - - - - - Gets or sets the ModifiedSinceDate property. - - - The ModifiedSinceDate property. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or - UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Gets or sets the UnmodifiedSinceDate property. - - - The UnmodifiedSinceDate property. - - - - - Gets or sets the UnmodifiedSinceDate property. - - - The UnmodifiedSinceDate property. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to decrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - The base class TransferUtility request classes. - - - - - Waits for all of the tasks to complete or till any task fails or is canceled. - - - - - Waits for all of the tasks to complete or till any task fails or is canceled. - - - - - Returns the amount of bytes remaining that need to be pulled down from S3. - - The fully qualified path of the file. - - - - - The command to manage an upload using the S3 multipart API. - - - - - Initializes a new instance of the class. - - The s3 client. - The config object that has the number of threads to use. - The file transporter request. - - - - This command is for doing regular PutObject requests. - - - - - This command files all the files that meets the criteria specified in the TransferUtilityUploadDirectoryRequest request - and uploads them. - - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - - Gets the Amazon S3 client used for making calls into Amazon S3. - - - The Amazon S3 client used for making calls into Amazon S3. - - - - - Uploads the specified file. - The object key is derived from the file's name. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the specified file. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the contents of the specified stream. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The stream to read to obtain the content to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the stream to. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the file or stream specified by the request. - To track the progress of the upload, - add an event listener to the request's UploadProgressEvent. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - Contains all the parameters required to upload to Amazon S3. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Aborts the multipart uploads that were initiated before the specified date. - - - The name of the bucket containing multipart uploads. - - - The date before which the multipart uploads were initiated. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the content from Amazon S3 and writes it to the specified file. - If the key is not specified in the request parameter, - the file name will used as the key name. - - - Contains all the parameters required to download an Amazon S3 object. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Returns a stream from which the caller can read the content from the specified - Amazon S3 bucket and key. - The caller of this method is responsible for closing the stream. - - - The name of the bucket. - - - The object key. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Returns a stream to read the contents from Amazon S3 as - specified by the TransferUtilityOpenStreamRequest. - The caller of this method is responsible for closing the stream. - - - Contains all the parameters required for the OpenStream operation. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - A pattern used to identify the files from the source directory to upload. - - - A search option that specifies whether to recursively search for files to upload - in subdirectories. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The request that contains all the parameters required to upload a directory. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by s3Directory. - - - The name of the bucket containing the Amazon S3 objects to download. - - - The directory in Amazon S3 to download. - - - The local directory to download the objects to. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by the S3Directory - property of the passed in TransferUtilityDownloadDirectoryRequest object. - - - Contains all the parameters required to download objects from Amazon S3 - into a local directory. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the content from Amazon S3 and writes it to the specified file. - - - The file path where the content from Amazon S3 will be written to. - - - The name of the bucket containing the Amazon S3 object to download. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - A pattern used to identify the files from the source directory to upload. - - - A search option that specifies whether to recursively search for files to upload - in subdirectories. - - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The request that contains all the parameters required to upload a directory. - - - - - Uploads the specified file. - The object key is derived from the file's name. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - - - Uploads the specified file. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - The key under which the Amazon S3 object is stored. - - - - - Uploads the contents of the specified stream. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The stream to read to obtain the content to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the stream to. - - - The key under which the Amazon S3 object is stored. - - - - - Uploads the file or stream specified by the request. - To track the progress of the upload, - add an event listener to the request's UploadProgressEvent. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - Contains all the parameters required to upload to Amazon S3. - - - - - Returns a stream from which the caller can read the content from the specified - Amazon S3 bucket and key. - The caller of this method is responsible for closing the stream. - - - The name of the bucket. - - - The object key. - - - A stream of the contents from the specified Amazon S3 and key. - - - - - Returns a stream to read the contents from Amazon S3 as - specified by the TransferUtilityOpenStreamRequest. - The caller of this method is responsible for closing the stream. - - - Contains all the parameters required to open a stream to an S3 object. - - - A stream of the contents from Amazon S3. - - - - - Downloads the content from Amazon S3 and writes it to the specified file. - - - The file path where the content from Amazon S3 will be written to. - - - The name of the bucket containing the Amazon S3 object to download. - - - The key under which the Amazon S3 object is stored. - - - - - Downloads the content from Amazon S3 and writes it to the specified file. - If the key is not specified in the request parameter, - the file name will used as the key name. - - - Contains all the parameters required to download an Amazon S3 object. - - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by s3Directory. - - - The name of the bucket containing the Amazon S3 objects to download. - - - The directory in Amazon S3 to download. - - - The local directory to download the objects to. - - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by the S3Directory - property of the passed in TransferUtilityDownloadDirectoryRequest object. - - - Contains all the parameters required to download objects from Amazon S3 - into a local directory. - - - - - Aborts the multipart uploads that were initiated before the specified date. - - - The name of the bucket containing multipart uploads. - - - The date before which the multipart uploads were initiated. - - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - - Constructs a new class. - - - The AWS Access Key ID. - - - The AWS Secret Access Key. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new class. - - - The AWS Access Key ID. - - - The AWS Secret Access Key. - - - The region to configure the transfer utility for. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new instance of the class. - - - The AWS Access Key ID. - - - The AWS Secret Access Key. - - - Specifies advanced settings. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new instance of the class. - - - The AWS Access Key ID. - - - The AWS Secret Access Key. - - - The region to configure the transfer utility for. - - - Specifies advanced settings. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new instance of the class. - - - The Amazon S3 client. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Initializes a new instance of the class. - - - The Amazon S3 client. - - - Specifies advanced configuration settings for . - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new class. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new class. - - - The region to configure the transfer utility for. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new class. - - - Specifies advanced configuration settings for . - - - - - - - Gets the Amazon S3 client used for making calls into Amazon S3. - - - The Amazon S3 client used for making calls into Amazon S3. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Uploads the specified file. - The object key is derived from the file's name. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the specified file. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the contents of the specified stream. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The stream to read to obtain the content to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the stream to. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the file or stream specified by the request. - To track the progress of the upload, - add an event listener to the request's UploadProgressEvent. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - Contains all the parameters required to upload to Amazon S3. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Aborts the multipart uploads that were initiated before the specified date. - - - The name of the bucket containing multipart uploads. - - - The date before which the multipart uploads were initiated. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the content from Amazon S3 and writes it to the specified file. - If the key is not specified in the request parameter, - the file name will used as the key name. - - - Contains all the parameters required to download an Amazon S3 object. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Returns a stream from which the caller can read the content from the specified - Amazon S3 bucket and key. - The caller of this method is responsible for closing the stream. - - - The name of the bucket. - - - The object key. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Returns a stream to read the contents from Amazon S3 as - specified by the TransferUtilityOpenStreamRequest. - The caller of this method is responsible for closing the stream. - - - Contains all the parameters required for the OpenStream operation. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - A pattern used to identify the files from the source directory to upload. - - - A search option that specifies whether to recursively search for files to upload - in subdirectories. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The request that contains all the parameters required to upload a directory. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by s3Directory. - - - The name of the bucket containing the Amazon S3 objects to download. - - - The directory in Amazon S3 to download. - - - The local directory to download the objects to. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by the S3Directory - property of the passed in TransferUtilityDownloadDirectoryRequest object. - - - Contains all the parameters required to download objects from Amazon S3 - into a local directory. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the content from Amazon S3 and writes it to the specified file. - - - The file path where the content from Amazon S3 will be written to. - - - The name of the bucket containing the Amazon S3 object to download. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - A pattern used to identify the files from the source directory to upload. - - - A search option that specifies whether to recursively search for files to upload - in subdirectories. - - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The request that contains all the parameters required to upload a directory. - - - - - Uploads the specified file. - The object key is derived from the file's name. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - - - Uploads the specified file. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - The key under which the Amazon S3 object is stored. - - - - - Uploads the contents of the specified stream. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The stream to read to obtain the content to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the stream to. - - - The key under which the Amazon S3 object is stored. - - - - - Uploads the file or stream specified by the request. - To track the progress of the upload, - add an event listener to the request's UploadProgressEvent. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - Contains all the parameters required to upload to Amazon S3. - - - - - Returns a stream from which the caller can read the content from the specified - Amazon S3 bucket and key. - The caller of this method is responsible for closing the stream. - - - The name of the bucket. - - - The object key. - - - A stream of the contents from the specified Amazon S3 and key. - - - - - Returns a stream to read the contents from Amazon S3 as - specified by the TransferUtilityOpenStreamRequest. - The caller of this method is responsible for closing the stream. - - - Contains all the parameters required to open a stream to an S3 object. - - - A stream of the contents from Amazon S3. - - - - - Downloads the content from Amazon S3 and writes it to the specified file. - - - The file path where the content from Amazon S3 will be written to. - - - The name of the bucket containing the Amazon S3 object to download. - - - The key under which the Amazon S3 object is stored. - - - - - Downloads the content from Amazon S3 and writes it to the specified file. - If the key is not specified in the request parameter, - the file name will used as the key name. - - - Contains all the parameters required to download an Amazon S3 object. - - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by s3Directory. - - - The name of the bucket containing the Amazon S3 objects to download. - - - The directory in Amazon S3 to download. - - - The local directory to download the objects to. - - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by the S3Directory - property of the passed in TransferUtilityDownloadDirectoryRequest object. - - - Contains all the parameters required to download objects from Amazon S3 - into a local directory. - - - - - Aborts the multipart uploads that were initiated before the specified date. - - - The name of the bucket containing multipart uploads. - - - The date before which the multipart uploads were initiated. - - - - - - Provides configuration options for how processes requests. - - - The best configuration settings depend on network - configuration, latency and bandwidth. - The default configuration settings are suitable - for most applications, but this class enables developers to experiment with - different configurations and tune transfer manager performance. - - - - - - Default constructor. - - - - - Gets or sets the minimum part size for upload parts in bytes. The default is 16 MB. - Decreasing the minimum part size causes - multipart uploads to be split into a larger number - of smaller parts. Setting this value too low has a negative effect - on transfer speeds, causing extra latency and network - communication for each part. - - - - - This property determines how many active threads - or the number of concurrent asynchronous web requests - will be used to upload/download the file . - The default value is 10. - - - A value less than or equal to 0 will be silently ignored. - - - - - Gets or sets the number of executing threads. - This property determines how many active threads will be used to upload - the file. The default value is 10 threads. - - - A value less than or equal to 0 will be silently ignored. - - - - - Request object for downloading a directory with the TransferUtility. - - - - - Gets or sets the name of the bucket. - - - The name of the bucket. - - - - - Gets whether or not the bucket name is set. - - - A value of true if the bucket name is set. - Otherwise, returns false. - - - - - Gets or sets the local directory where objects from Amazon S3 will be downloaded. - If the directory doesn't exist, it will be created. - - - The local directory where objects from Amazon S3 will be downloaded. - - - - - Gets whether or not the LocalDirectory property is set. - - - A value of true if LocalDirectory property is set. - Otherwise, returns false. - - - - - Gets or sets the Amazon S3 directory to download from. - This is translated to a key prefix; keys that have this prefix will be - downloaded. - - - - - Gets whether or not the S3Directory property is set. - - - A value of true if S3Directory property is set. - Otherwise, returns false. - - - - - - This property is deprecated. This property doesn't honor the DateTimeKind, please - use ModifiedSinceDateUtc instead. - - Gets or sets the ModifiedSinceDate property. - Only objects that have been modified since this date will be - downloaded. - - - The ModifiedSinceDate property. - - - - - Checks if ModifiedSinceDate property is set. - - A value of true if ModifiedSinceDate property is set. - Otherwise, returns false. - - - - Gets or sets the ModifiedSinceDateUtc property. - Only objects that have been modified since this date will be - downloaded. - - - The ModifiedSinceDateUtc property. - - - - - Checks if ModifiedSinceDateUtc property is set. - - A value of true if ModifiedSinceDateUtc property is set. - Otherwise, returns false. - - - - - This property is deprecated. This property doesn't honor the DateTimeKind, please - use UnmodifiedSinceDateUtc instead. - - Gets or sets the UnmodifiedSinceDate property. - Only objects that have not been modified since this date will be downloaded. - - - The UnmodifiedSinceDate property. - - - - - Checks if UnmodifiedSinceDate property is set. - - true if UnmodifiedSinceDate property is set. - - - - Gets or sets the UnmodifiedSinceDateUtc property. - Only objects that have not been modified since this date will be downloaded. - - - The UnmodifiedSinceDateUtc property. - - - - - Checks if UnmodifiedSinceDateUtc property is set. - - true if UnmodifiedSinceDateUtc property is set. - - - - Gets or sets the DownloadFilesConcurrently property. - Specifies if multiple files will be downloaded concurrently. - The number of concurrent web requests used is controlled - by the TransferUtilityConfig.ConcurrencyLevel property. - - - - - The event for DownloadedDirectoryProgressEvent notifications. All - subscribers will be notified when a new progress - event is raised. - - The DownloadedDirectoryProgressEvent is fired as data - is downloaded from Amazon S3. The delegates attached to the event - will be passed information detailing how much data - has been downloaded as well as how much will be downloaded. - - - - Subscribe to this event if you want to receive - DownloadedDirectoryProgressEvent notifications. Here is how:
- 1. Define a method with a signature similar to this one: - - private void displayProgress(object sender, DownloadDirectoryProgressArgs args) - { - Console.WriteLine(args); - } - - 2. Add this method to the DownloadedDirectoryProgressEvent delegate's invocation list - - TransferUtilityDownloadDirectoryRequest request = new TransferUtilityDownloadDirectoryRequest(); - request.DownloadedDirectoryProgressEvent += displayProgress; - - - - - - Encapsulates the information needed to provide - transfer progress to subscribers of the DownloadDirectory - event. - - - - - Constructs a new instance of DownloadDirectoryProgressArgs. - - - The number of files downloaded. - - - The total number of files to download. - - - The current file being downloaded - - - The number of transferred bytes for the current file. - - - The size of the current file in bytes. - - - - - Constructs a new instance of DownloadDirectoryProgressArgs. - - - The number of files downloaded. - - - The total number of files to download. - - - The bytes transferred across all files being downloaded. - - - The total number of bytes across all files being downloaded. - - - The current file being downloaded. - - - The number of transferred bytes for the current file. - - - The size of the current file in bytes. - - - - - Gets or sets the total number of files. - - The total number of files. - - - - Gets or sets the number of files downloaded so far. - - The number of files downloaded. - - - - Gets or sets the total number of bytes across all files being downloaded. - - The total number of bytes across all files being downloaded. - - - - Gets or sets the bytes transferred across all files being downloaded. - - The bytes transferred across all files being downloaded. - - - - Gets or sets the current file being downloaded. - - - This property is only valid if DownloadDirectory is used without enabling concurrent file downloads (by default concurrent download is disabled). - If concurrent file downloads are enabled by setting TransferUtilityDownloadDirectoryRequest.DownloadFilesConcurrently to true, this property - will return null. - - The current file being downloaded. - - - - Gets or sets the transferred bytes for the current file. - - - This property is only valid if DownloadDirectory is used without enabling concurrent file downloads (by default concurrent download is disabled). - If concurrent file downloads are enabled by setting TransferUtilityDownloadDirectoryRequest.DownloadFilesConcurrently to true, this property - will return 0. - - The transferred bytes for the current file. - - - - Gets or sets the total number of bytes for the current file. - - - This property is only valid if DownloadDirectory is used without enabling concurrent file downloads (by default concurrent download is disabled). - If concurrent file downloads are enabled by setting TransferUtilityDownloadDirectoryRequest.DownloadFilesConcurrently to true, this property - will return 0. - - The total number of bytes for the current file. - - - - The string representation of this instance of DownloadDirectoryProgressArgs. - - The string representation of this instance of DownloadDirectoryProgressArgs. - - - - Contains all the parameters - that can be set when making a this request with the - TransferUtility method. - - - - - Get or sets the file path location of where the - downloaded Amazon S3 object will be written to. - - - The file path location of where the downloaded Amazon S3 object will be written to. - - - - - Checks if FilePath property is set. - - True if FilePath property is set. - - - - The event for WriteObjectProgressEvent notifications. All - subscribers will be notified when a new progress - event is raised. - - The WriteObjectProgressEvent is fired as data - is downloaded from S3. The delegates attached to the event - will be passed information detailing how much data - has been downloaded as well as how much will be downloaded. - - - - Subscribe to this event if you want to receive - WriteObjectProgressEvent notifications. Here is how:
- 1. Define a method with a signature similar to this one: - - private void displayProgress(object sender, WriteObjectProgressArgs args) - { - Console.WriteLine(args); - } - - 2. Add this method to the WriteObjectProgressEvent delegate's invocation list - - TransferUtilityDownloadRequest request = new TransferUtilityDownloadRequest(); - request.WriteObjectProgressEvent += displayProgress; - - - - - - Causes the WriteObjectProgressEvent event to be fired. - - Progress data for the stream being written to file. - - - - Contains all the parameters - that can be set when making a this request with the - TransferUtility method. - - - - - Contains all the parameters - that can be set when making a this request with the - TransferUtility method. - - - - - Gets or sets the directory where files are uploaded from. - - - The directory where files are uploaded from. - - - - - Checks if Directory property is set. - - true if Directory property is set. - - - - Gets or sets the KeyPrefix property. As object keys are generated for the - files being uploaded this value will prefix the key. This is useful when a directory - needs to be uploaded into sub directory in the S3 Bucket. - - - The directory where files are uploaded from. - - - - - Checks if KeyPrefix property is set. - - true if KeyPrefix property is set. - - - - Gets and sets the search pattern used to determine which - files in the directory are uploaded. - - - The search pattern used to deterimine which - files in the directory are uploaded. - The default value is "*", specifying that all files - in the directory will be uploaded. - - - - - Checks if SearchPattern property is set. - - true if SearchPattern property is set. - - - - Gets or sets the recursive options for the directory upload. - - - The recursive options for the directory upload. - Set by default to TopDirectoryOnly, - specifying that files will be uploaded from the root directory only. - - - - - Gets or sets the name of the bucket. - - - The name of the bucket. - - - - - Checks if BucketName property is set. - - true if BucketName property is set. - - - - Gets or sets the canned access control list (ACL) - for the uploaded objects. - Please refer to - for - information on Amazon S3 canned ACLs. - - - The canned access control list (ACL) - for the uploaded objects. - - - - - Checks if the CannedACL property is set. - - true if there is the CannedACL property is set. - - - - Gets or sets the content type for the uploaded Amazon S3 objects. - The default behavior when this field is not set is to use the file - extension to set the content type. If this field is set to a value it - will be applied to all uploaded files in the directory, overriding - file extension inspection. - - - The content type for all the uploaded Amazon S3 objects. - - - - - Gets or sets the storage class for the uploaded Amazon S3 objects. - Please refer to - for - information on S3 Storage Classes. - - - The storage class for the uploaded Amazon S3 objects. - - - - - The collection of meta data for the request. - - - - - Gets or sets the ServerSideEncryptionMethod property. - Specifies the encryption used on the server to - store the content. - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Gets or sets the UploadFilesConcurrently property. - Specifies if multiple files will be uploaded concurrently. - The number of concurrent web requests used is controlled - by the TransferUtilityConfig.ConcurrencyLevel property. - - - - - The event for UploadDirectoryProgressEvent notifications. All - subscribers will be notified when a new progress - event is raised. - - The UploadDirectoryProgressEvent is fired as data - is uploaded to S3. The delegates attached to the event - will be passed information detailing how much data - has been uploaded as well as how much will be uploaded. - - - - Subscribe to this event if you want to receive - UploadDirectoryProgressEvent notifications. Here is how:
- 1. Define a method with a signature similar to this one: - - private void displayProgress(object sender, UploadDirectoryProgressArgs args) - { - Console.WriteLine(args); - } - - 2. Add this method to the UploadDirectoryProgressEvent delegate's invocation list - - TransferUtilityUploadDirectoryRequest request = new TransferUtilityUploadDirectoryRequest(); - request.UploadDirectoryProgressEvent += displayProgress; - - - - - - The event for modifying individual TransferUtilityUploadRequest for each file - being uploaded. - - - - - Causes the UploadDirectoryProgressEvent event to be fired. - - Progress data for files currently being uploaded. - - - - Tags that will be applied to all objects in the diretory. - - - - - Encapsulates the information needed to provide - transfer progress to subscribers of the UploadDirectory - event. - - - - - Constructs a new instance of UploadDirectoryProgressArgs. - - - The number of files uploaded. - - - The total number of files to upload. - - - The current file - - - The number of transferred bytes for current file. - - - The size of the current file in bytes. - - - - - Constructs a new instance of UploadDirectoryProgressArgs. - - - The number of files uploaded. - - - The total number of files to upload. - - - The bytes transferred across all files being uploaded. - - - The total number of bytes across all files being uploaded. - - - The current file being uploaded. - - - The number of transferred bytes for current file. - - - The size of the current file in bytes. - - - - - Gets or sets the total number of files. - - The total number of files. - - - - Gets or sets the number of files uploaded. - - The number of files uploaded. - - - - Gets or sets the total number of bytes across all files being uploaded. - - The total number of bytes across all files being uploaded. - - - - Gets or sets the bytes transferred across all files being uploaded. - - The bytes transferred across all files being uploaded. - - - - Gets or sets the current file. - - - This property is only valid if UploadDirectory is used without enabling concurrent file uploads (by default concurrent upload is disabled). - If concurrent file uploads are enabled by setting TransferUtilityUploadDirectoryRequest.UploadFilesConcurrently to true, this property - will return null. - - The current file. - - - - Gets or sets the transferred bytes for current file. - - - This property is only valid if UploadDirectory is used without enabling concurrent file uploads (by default concurrent upload is disabled). - If concurrent file uploads are enabled by setting TransferUtilityUploadDirectoryRequest.UploadFilesConcurrently to true, this property - will return 0. - - The transferred bytes for current file. - - - - Gets or sets the total number of bytes for current file. - - - This property is only valid if UploadDirectory is used without enabling concurrent file uploads (by default concurrent upload is disabled). - If concurrent file uploads are enabled by setting TransferUtilityUploadDirectoryRequest.UploadFilesConcurrently to true, this property - will return 0. - - The total number of bytes for current file. - - - - The string representation of this instance of UploadDirectoryProgressArgs. - - The string representation of this instance of UploadDirectoryProgressArgs. - - - - Contains a single TransferUtilityUploadRequest corresponding - to a single file about to be uploaded, allowing changes to - the request before it is executed. - - - - - Constructs a new UploadDirectoryFileRequestArgs instance. - - Request being processed. - - - - Gets and sets the UploadRequest property. - - - - - Contains all the parameters - that can be set when making a this request with the - TransferUtility method. - - - - - Gets or sets the name of the bucket. - - - The name of the bucket. - - - - - Checks if BucketName property is set. - - true if BucketName property is set. - - - - Gets or sets the key under which the Amazon S3 object is to be stored. - - - The key under which the Amazon S3 object is to be stored. - - - - - Checks if Key property is set. - - true if Key property is set. - - - - Gets or sets the canned access control list (ACL) - for the uploaded object. - Please refer to - for - information on Amazon S3 canned ACLs. - - - The canned access control list (ACL) - for the uploaded object. - - - - - Checks if the CannedACL property is set. - - true if there is the CannedACL property is set. - - - - Removes the cannned access control list (ACL) - for the uploaded object. - - - - - Gets or sets the content type of the uploaded Amazon S3 object. - - - The content type of the uploaded Amazon S3 object. - - - - - Checks if ContentType property is set. - - true if ContentType property is set. - - - - Gets or sets the storage class for the uploaded Amazon S3 object. - Please refer to - for - information on S3 Storage Classes. - - - The storage class for the uploaded Amazon S3 object. - - - - - Gets and sets the ServerSideEncryptionMethod property. - Specifies the encryption used on the server to - store the content. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Input stream for the request; content for the request will be read from the stream. - - - - - - Gets or sets the file path - where the Amazon S3 object will be uploaded from. - - - For WinRT and Windows Phone this property must be in the form of "ms-appdata:///local/file.txt". - - - - The file path where the Amazon S3 object will be uploaded from. - - - - - Checks if FilePath property is set. - - true if FilePath property is set. - - - - Gets or sets the part size of the upload in bytes. - The uploaded file will be divided into - parts the size specified and - uploaded to Amazon S3 individually. - - - The part size of the upload. - - - - - Checks if PartSize property is set. - - true if PartSize property is set. - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - The tag-set for the object. - - - - - The event for UploadProgressEvent notifications. All - subscribers will be notified when a new progress - event is raised. - - The UploadProgressEvent is fired as data - is uploaded to S3. The delegates attached to the event - will be passed information detailing how much data - has been uploaded as well as how much will be uploaded. - - - - Subscribe to this event if you want to receive - UploadProgressEvent notifications. Here is how:
- 1. Define a method with a signature similar to this one: - - private void displayProgress(object sender, UploadProgressArgs args) - { - Console.WriteLine(args); - } - - 2. Add this method to the UploadProgressEvent delegate's invocation list - - TransferUtilityUploadRequest request = new TransferUtilityUploadRequest(); - request.UploadProgressEvent += displayProgress; - - - - - - Causes the UploadProgressEvent event to be fired. - - Progress data for the file being uploaded. - - - - Gets the length of the content by either checking the FileInfo.Length property or the Stream.Length property. - - The length of the content. - - - - Gets or sets whether or not the stream used with this request is - automatically closed when all of the content is read from the stream. - - - A value of true if the if the stream is - automatically closed when all of the content is read from the stream. - A value of false if otherwise. - - - - - If this value is set to true then the stream's position will be reset to the start before being read for upload. - Default: true. - - - - - Sets whether or not the stream used with this request is - automatically closed when all of the content is read from the stream - and returns this object instance, - enabling additional method calls to be chained together. - - - A value of true if the if the stream is - automatically closed when all of the content is read from the stream. - A value of false if otherwise. - - - This object instance, enabling additional method calls to be chained together. - - - - - Encapsulates the information needed to provide - transfer progress to subscribers of the Put Object - Event. - - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The how many bytes were transferred since last event. - The number of bytes transferred - The total number of bytes to be transferred - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The how many bytes were transferred since last event. - The number of bytes transferred - The total number of bytes to be transferred - The file being uploaded - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The how many bytes were transferred since last event. - The number of bytes transferred - The total number of bytes to be transferred - A compensation for any upstream aggregators if this event to correct theit totalTransferred count, - in case the underlying request is retried. - The file being uploaded - - - - Gets the FilePath. - - - - - Uri wrapper that can parse out information (bucket, key, region, style) from an - S3 URI. - - - - - True if the URI contains the bucket in the path, false if it contains the bucket in the authority. - - - - - The bucket name parsed from the URI (or null if no bucket specified). - - - - - The key parsed from the URI (or null if no key specified). - - - - - The region parsed from the URI (or null if no region specified). - - - - - Constructs a parser for the S3 URI specified as a string. - - The S3 URI to be parsed. - - - - Constructs a parser for the S3 URI specified as a Uri instance. - - The S3 URI to be parsed. - - - - If the given string is an AmazonS3Endpoint return true and set the AmazonS3Uri out parameter. - - - - true if the string is an AmazonS3Endpoint, and the out paramter has been filled in, false otherwise - - - - If the given Uri is an AmazonS3Endpoint return true and set the AmazonS3Uri out parameter. - - - - true if the Uri is an AmazonS3Endpoint, and the out paramter has been filled in, false otherwise - - - - Checks whether the given URI is a Amazon S3 URI. - - The S3 URI to be checked. - true if the URI is a Amazon S3 URI, false; otherwise. - - - - Checks whether the given URI is a Amazon S3 URI. - - The S3 URI to be checked. - true if the URI is a Amazon S3 URI, false; otherwise. - - - - Percent-decodes the given string, with a fast path for strings that are not - percent-encoded. - - The string to decode - The decoded string - - - - Percent-decodes the given string. - - The string to decode - The index of the first '%' in the string - The decoded string - - - - Decodes the percent-encoded character at the given index in the string - and appends the decoded value to the string under construction. - - - The string under construction to which the decoded character will be - appended. - - The string being decoded. - The index of the '%' character in the string. - - - - Converts a hex character (0-9A-Fa-f) into its corresponding quad value. - - The hex character - The quad value - - - - Provides utilities used by the Amazon S3 client implementation. - These utilities might be useful to consumers of the Amazon S3 - library. - - - Provides utilities used by the Amazon S3 client implementation. - These utilities might be useful to consumers of the Amazon S3 - library. - - - Provides utilities used by the Amazon S3 client implementation. - These utilities might be useful to consumers of the Amazon S3 - library. - - - - - Determines MIME type from a file extension - - The extension of the file - The MIME type for the extension, or text/plain - - - - URL encodes a string. If the path property is specified, - the accepted path characters {/+:} are not encoded. - - The string to encode - Whether the string is a URL path or not - - - - - Converts a non-seekable stream into a System.IO.MemoryStream. - A MemoryStream's position can be moved arbitrarily - - The stream to be converted - A seekable MemoryStream - MemoryStreams use byte arrays as their backing store. - Please use this judicially as it is likely that a very large - stream will cause system resources to be used up. - - - - - Formats the current date as a GMT timestamp - - A GMT formatted string representation - of the current date and time - - - - - Generates an MD5 Digest for the string-based content - - The content for which the MD5 Digest needs - to be computed. - - Whether the returned checksum should be - base64 encoded. - - A string representation of the hash with or w/o base64 encoding - - - - - Version2 S3 buckets adhere to RFC 1035: - - Less than 255 characters, with each label less than 63 characters. - Label must start with a letter - Label must end with a letter or digit - Label can have a string of letter, digits and hyphens in the middle. - Although names can be case-sensitive, no significance is attached to the case. - RFC 1123: Allow label to start with letter or digit (e.g. 3ware.com works) - RFC 2181: No restrictions apart from the length restrictions. - - S3 V2 will start with RFCs 1035 and 1123 and impose the following additional restrictions: - - Length between 3 and 63 characters (to allow headroom for upper-level domains, - as well as to avoid separate length restrictions for bucket-name and its labels - Only lower-case to avoid user confusion. - No dotted-decimal IPv4-like strings - - - The BucketName to validate if V2 addressing should be used - True if the BucketName should use V2 bucket addressing, false otherwise - - S3 v2 Bucket restrictions - - - - Determines whether an S3 bucket exists or not. - - The name of the bucket to check. - The Amazon S3 Client to use for S3 specific operations. - False is returned in case S3 responds with a NoSuchBucket error. - True is returned in case of success, AccessDenied error or PermanentRedirect error. - An exception is thrown in case of any other error. - This method calls GetACL for the bucket. - - - - Determines whether an S3 bucket exists or not. - This is done by: - 1. Creating a PreSigned Url for the bucket. To work with Signature V4 only regions, as - well as Signature V4-optional regions, we keep the expiry to within the maximum for V4 - (which is one week). - 2. Making a HEAD request to the Url - - The name of the bucket to check. - The Amazon S3 Client to use for S3 specific operations. - - - - - Deletes an S3 bucket which contains objects. - An S3 bucket which contains objects cannot be deleted until all the objects - in it are deleted. This method deletes all the objects in the specified - bucket and then deletes the bucket itself. - - The bucket to be deleted. - The Amazon S3 Client to use for S3 specific operations. - - - - Deletes an S3 bucket which contains objects. - An S3 bucket which contains objects cannot be deleted until all the objects - in it are deleted. This method deletes all the objects in the specified - bucket and then deletes the bucket itself. - - The bucket to be deleted. - The Amazon S3 Client to use for S3 specific operations. - Options to control the behavior of the delete operation. - - - - Initiates the asynchronous execution of the DeleteS3BucketWithObjects operation. - DeleteS3BucketWithObjects deletes an S3 bucket which contains objects. - An S3 bucket which contains objects cannot be deleted until all the objects - in it are deleted. This method deletes all the objects in the specified - bucket and then deletes the bucket itself. - - The bucket to be deleted. - The Amazon S3 Client to use for S3 specific operations. - token to check if the operation has been request to cancel. - An IAsyncCancelableResult that can be used to poll or wait for results, or both; - this value is also needed when invoking EndDeleteS3BucketWithObjects. IAsyncCancelableResult can also - be used to cancel the operation while it's in progress. - - - - Initiates the asynchronous execution of the DeleteS3BucketWithObjects operation. - DeleteS3BucketWithObjects deletes an S3 bucket which contains objects. - An S3 bucket which contains objects cannot be deleted until all the objects - in it are deleted. This method deletes all the objects in the specified - bucket and then deletes the bucket itself. - - The bucket to be deleted. - The Amazon S3 Client to use for S3 specific operations. - Options to control the behavior of the delete operation. - token to check if the operation has been request to cancel. - An IAsyncCancelableResult that can be used to poll or wait for results, or both; - this value is also needed when invoking EndDeleteS3BucketWithObjects. IAsyncCancelableResult can also - be used to cancel the operation while it's in progress. - - - - Initiates the asynchronous execution of the DeleteS3BucketWithObjects operation. - DeleteS3BucketWithObjects deletes an S3 bucket which contains objects. - An S3 bucket which contains objects cannot be deleted until all the objects - in it are deleted. This method deletes all the objects in the specified - bucket and then deletes the bucket itself. - - The bucket to be deleted. - The Amazon S3 Client to use for S3 specific operations. - >Options to control the behavior of the delete operation. - An callback that is invoked to send updates while delete operation is in progress. - token to check if the operation has been request to cancel. - An IAsyncCancelableResult that can be used to poll or wait for results, or both; - this value is also needed when invoking EndDeleteS3BucketWithObjects. IAsyncCancelableResult can also - be used to cancel the operation while it's in progress. - - - - Invokes the DeleteS3BucketWithObjectsInternal method. - - The Request object that has all the data to complete the operation. - token to request the operation to be cancelled. - - - - Deletes an S3 bucket which contains objects. - An S3 bucket which contains objects cannot be deleted until all the objects - in it are deleted. The function deletes all the objects in the specified - bucket and then deletes the bucket itself. - - The bucket to be deleted. - The Amazon S3 Client to use for S3 specific operations. - Options to control the behavior of the delete operation. - The callback which is used to send updates about the delete operation. - token to check if the operation has been request to cancel. - - - - Invokes the callback which provides updated about the delete operation. - - The callback to be invoked. - The data being passed to the callback. - 8 - - - - Determines whether an S3 bucket exists or not. - - The name of the bucket to check. - The Amazon S3 Client to use for S3 specific operations. - False is returned in case S3 responds with a NoSuchBucket error. - True is returned in case of success, AccessDenied error or PermanentRedirect error. - An exception is thrown in case of any other error. - This method calls GetACL for the bucket. - - - - Determines whether an S3 bucket exists or not. - This is done by: - 1. Creating a PreSigned Url for the bucket. To work with Signature V4 only regions, as - well as Signature V4-optional regions, we keep the expiry to within the maximum for V4 - (which is one week). - 2. Making a HEAD request to the Url - - The name of the bucket to check. - The Amazon S3 Client to use for S3 specific operations. - - - - - Sets the storage class for the S3 Object to the value - specified. - - The name of the bucket in which the key is stored - The key of the S3 Object whose storage class needs changing - The new Storage Class for the object - The Amazon S3 Client to use for S3 specific operations. - - - - - Sets the storage class for the S3 Object's Version to the value - specified. - - The name of the bucket in which the key is stored - The key of the S3 Object whose storage class needs changing - The version of the S3 Object whose storage class needs changing - The new Storage Class for the object - The Amazon S3 Client to use for S3 specific operations. - - - - - Sets the server side encryption method for the S3 Object to the value - specified. - - The name of the bucket in which the key is stored - The key of the S3 Object - The server side encryption method - The Amazon S3 Client to use for S3 specific operations. - - - - Sets the server side encryption method for the S3 Object's Version to the value - specified. - - The name of the bucket in which the key is stored - The key of the S3 Object - The version of the S3 Object - The server side encryption method - The Amazon S3 Client to use for S3 specific operations. - - - - Sets the redirect location for the S3 Object's when being accessed through the S3 website endpoint. - - The name of the bucket in which the key is stored - The key of the S3 Object - The redirect location - The Amazon S3 Client to use for S3 specific operations. - - - - Sets up the request needed to make an exact copy of the object leaving the parent method - the ability to change just the attribute being requested to change. - - - - - - - - - - - Converts the string representing a storage class that would come back from a ListObjects request - to the S3StorageClass enumeration. - - Amazon S3 string values for storage class - The converted S3StorageClass enumeration - - - - Upload data to Amazon S3 using HTTP POST. - - - For more information, - - Request object which describes the data to POST - Thrown if the service returns an error - - - - Deletes an S3 bucket which contains objects. - An S3 bucket which contains objects cannot be deleted until all the objects - in it are deleted. This method deletes all the objects in the specified - bucket and then deletes the bucket itself. - - The bucket to be deleted. - The Amazon S3 Client to use for S3 specific operations. - - - - Deletes an S3 bucket which contains objects. - An S3 bucket which contains objects cannot be deleted until all the objects - in it are deleted. This method deletes all the objects in the specified - bucket and then deletes the bucket itself. - - The bucket to be deleted. - The Amazon S3 Client to use for S3 specific operations. - Options to control the behavior of the delete operation. - - - - Class to manage and cache the correct region for buckets accessed without an explicit region. - - - Class to manage and cache the correct region for buckets accessed without an explicit region. - - - Class to manage and cache the correct region for buckets accessed without an explicit region. - - - - - A cache of BucketName -> RegionEndpoint pairs. - The cache is used to make sure that bucket requests are signed for the correct region, - even when requesting them without an explicit region. - - - - - Detect a bucket region mismatch based on the x-amz-bucket-region header, and the status code provided. - - - - - - - - - Detects if the signature is malformed, and the requested bucket is in a Region - different from the Region of the request. - - - - the correct region if a mismatch was detected, null otherwise - - - - Detects if the signature is malformed, and the requested bucket is in a Region - different from the Region of the request. - - - - - the correct region if a mismatch was detected, null otherwise - - - - Use a HEAD bucket request to get the region for the given bucket. - - This method creates an AmazonS3Client from the credentials passed in. - It's critical that the AmazonS3Client is not used to make any requests that will - be routed through the pipeline. - - - - the value of the x-amz-bucket-region header from the response - - - - Detects if the signature is malformed, and the requested bucket is in a Region - different from the Region of the request. - - - - - the correct region if a mismatch was detected, null otherwise - - - - Use a HEAD bucket request to get the region for the given bucket. - - This method creates an AmazonS3Client from the credentials passed in. - It's critical that the AmazonS3Client is not used to make any requests that will - be routed through the pipeline. - - - - the value of the x-amz-bucket-region header from the response - - - - Options which control the behaviour of the DeleteS3BucketWithObjects operation. - - - - - Gets or sets a value which indicates whether the - operation should be aborted if an error is encountered during execution. - - - - - Gets or sets a value which indicated whether verbose results shoule be returned to the - callback. - If quiet mode is true the callback will receive only keys where the delete operation encountered an error. - If quiet mode is false the callback will receive keys for both successful and unsuccessful delete operations. - - - - - Internal class used to pass the parameters for DeleteS3BucketWithObjects operation. - - - - - Name of the bucket to be deleted. - - - - - The Amazon S3 Client to use for S3 specific operations. - - - - - Options to control the behavior of the delete operation. - - - - - The callback which is used to send updates about the delete operation. - - - - - Contains updates from DeleteS3BucketWithObjects operation. - - - - - The list of objects which were successfully deleted. - - - - - The list of objects for which the delete operation failed. - - - - - A helper class that represents a strongly typed S3 EventNotification item sent to SQS - - - - - Parse the JSON string into a S3EventNotification object. - - The function will try its best to parse input JSON string as best as it can. - It will not fail even if the JSON string contains unknown properties. - - For any parsing errors - - - - - Gets and sets the records for the S3 event notification - - - - - The class holds the user identity properties. - - - - - Gets and sets the PrincipalId property. - - - - - This class contains the identity information for an S3 bucket. - - - - - Gets and sets the name of the bucket. - - - - - Gets and sets the bucket owner id. - - - - - Gets and sets the S3 bucket arn. - - - - - This class contains the information for an object in S3. - - - - - Gets and sets the key for the object stored in S3. - - - - - Gets and sets the size of the object in S3. - - - - - Gets and sets the etag of the object. This can be used to determine if the object has changed. - - - - - Gets and sets the version id of the object in S3. - - - - - Gets and sets the sequencer a string representation of a hexadecimal value used to determine event sequence, only used with PUTs and DELETEs. - - - - - Gets and sets the meta information describing S3. - - - - - Gets and sets the ConfigurationId. This ID can be found in the bucket notification configuration. - - - - - Gets and sets the Bucket property. - - - - - Gets and sets the Object property. - - - - - Gets and sets the S3SchemaVersion property. - - - - - The class holds the request parameters - - - - - Gets and sets the SourceIPAddress. This is the ip address where the request came from. - - - - - This class holds the response elements. - - - - - Gets and sets the XAmzId2 Property. This is the Amazon S3 host that processed the request. - - - - - Gets and sets the XAmzRequestId. This is the Amazon S3 generated request ID. - - - - - The class holds the glacier event data elements. - - - - - Gets and sets the RestoreEventData property. - - - - - The class holds the restore event data elements. - - - - - Gets and sets the LifecycleRestorationExpiryTime the time when the object restoration will be expired. - - - - - Gets and sets the LifecycleRestoreStorageClass the source storage class for restore. - - - - - The class holds the event notification. - - - - - Gets and sets the AwsRegion property. - - - - - Gets and sets the EventName property. This identities what type of event occurred. - For example for an object just put in S3 this will be set to EventType.ObjectCreatedPut. - - - - - Gets and sets the EventSource property. - - - - - Gets and sets the EventType property. The time when S3 finished processing the request. - - - - - Gets and sets the EventVersion property. - - - - - Gets and sets the RequestParameters property. - - - - - Gets and sets the ResponseElements property. - - - - - Gets and sets the S3 property. - - - - - Gets and sets the UserIdentity property. - - - - - Get and sets the GlacierEventData property. - - - - - Represents the status of an asynchronous operation. - It adds support for Cancelation of the asynchronous operation. - - - - - Gets a value that indicated whether the asynchronous operation has been canceled. - - - - - Gets a user-defined object that qualifies or contains information about an - asynchronous operation. - - - - - Gets a System.Threading.WaitHandle that is used to wait for an asynchronous - operation to complete. - - - - - Gets a value that indicates whether the asynchronous operation completed - synchronously. - - - - - Gets a value that indicates whether the asynchronous operation has completed. - - - - - Gets a value that indicates whether a cancel is requested. - - - - - The last exception that when the asynchronous operation was executed. - This is used to capture the exception and re-throw it when EndOperation is called. - - - - - The callback to be invoked when the asynchronous operation is completed. - - - - - Constructor for AsyncCancelableResult. - - The callback to be invoked when the asynchronous operation is completed. - Gets a user-defined object that qualifies or contains information about an - asynchronous operation. - - - - - Cancels the asynchronous operation if it's in progress. - - - - - Signals that the operaton is canceled and invokes the callback. - - - - - Signals that the operation is completed and invoked the callback. - - - - - Performs application-defined tasks associated with freeing, releasing, or - resetting unmanaged resources. - - - - - Disposes any managed and unmanaged resources. - - Should pass true if called by Dispose(), pass false if - called during finalization. - - - - Represents the status of an asynchronous operation. This interface extends - IAsyncResult and adds support for Cancelation of the asynchronous operation. - - - - - Cancels the asynchronous operation if it's in progress. - - - - - Gets a value that indicated whether the asynchronous operation has been canceled. - - - - - An exception detailing a failed HTTP POST upload atempt to Amazon S3. - - - - - Initializes a new instance of S3PostUploadException with a specified error message - - The error message - - - - Initializes a new instance of S3PostUploadException with a specified error code and error message - - The error code - The error message - - - - The error code returned by S3 - - - - - The S3 request id - - - - - The S3 host id - - - - - The HTTP error status code returned by S3 - - - - - Additional information about the error - - - Some errors are accompanied by more specific information, which vary from error to error - - - - - Parse an S3 Error response and create an S3PostUploadException - - The response from S3 - An S3PostUploadException with the information from the response - - - - Constructs a new instance of the S3PostUploadException class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - Class for unmarshalling response XML - - - - - Gets and sets the ErrorCode property. - - - - - Gets and sets the ErrorMessage property. - - - - - Gets and sets the RequestId property. - - - - - Gets and sets the HostId property. - - - - - Gets and sets the elements property. - - - - - Parameters for uploading to Amazon S3 a file using HTTP POS - - - - If a S3PostUploadSignedPolicy is assigned, then values set (other than InputStream or Path) on this object must adhere to the policy. - This includes metadata. If metadata is specified in the policy, then it must be included in the request. Adding metadata not in the - policy will cause the POST to fail. - - For more information, - - - - - - Default constructor. - - - - - S3 Bucket to upload the object to - - - - - The name of the uploaded key. - - - - - Stream to read the upload data for - - - If you use InputStream, then you also need to set ContentLength - - - - - File path to read the upload data from - - - - - Content type for the uploaded data - - - If this is not set, an attempt will be made to infer it from the extension on Key or Path (in that order), - otherwise 'application/octet-stream' will be assumed. - - - - - Specifies an Amazon S3 access control list - - - - - Signed policy from bucket owner. - - - - - Where to redirect browsers on a successful upload - - - - - The status code returned to the client upon successful upload if success_action_redirect is not specified - - - - Accepts the values OK (200) , Created (201), or NoContent (204, default). - - If the value is set to OK or NoContent, Amazon S3 returns an empty document with a 200 or 204 status code. - - If the value is set to Created, Amazon S3 returns an XML document with a 201 status code. - - If the value is not set or if it is set to an invalid value, Amazon S3 returns an empty document with a 204 status code. - - - - - - Storage class to use for storing the object - - - Default: STANDARD - - - - - The AWS region where the bucket is located. - - - Depending upon the bucket name, POST uploads will be - successfully redirected, but for buckets with non-DNS-compliant - characters, redirects will fail. Setting this to the appropriate - region will avoid the redirect. - - - - - Metadata to set on the uploaded object - - - If keys do not begin with 'x-amz-meta-' it will be added at POST time. - - - - - Write the multipart/form-data for this request for all fields except the file data to a stream - - - - - Class holds Response data for a post upload. - - - - - Gets and sets the StatusCode property. - - - - - Gets and sets the RequestId property. - - - - - Gets and sets the HostId property. - - - - - Gets and sets the CloudFront request ID. - - - - - Utility class for managing and exchanging HTTP POST uploads of objects to Amazon S3. - - - - This object supports creating, marshalling, and unmarshalling of the information needed to build - an authenticated HTTP POST request to S3 for uploading objects according to a policy. - - For more information, - - - - - Given a policy and AWS credentials, produce a S3PostUploadSignedPolicy. - - JSON string representing the policy to sign - Credentials to sign the policy with - A signed policy object for use with an S3PostUploadRequest. - - - - Given a policy and AWS credentials, produce a S3PostUploadSignedPolicy. - - JSON string representing the policy to sign - Credentials to sign the policy with - Service region endpoint. - A signed policy object for use with an S3PostUploadRequest. - - - - The policy document which governs what uploads can be done. - - - - - The signature for the policy. - - - - - The AWS Access Key Id for the credential pair that produced the signature. - - - - - The security token from session or instance credentials. - - - - - The signature version usedd. Either "2" or "4". - - - - - The signing algorithm used. Required as a field in the post Amazon - S3 can re-calculate the signature. - - - - - The date value in ISO8601 format. It is the same date used in - creating the signing key. - - - - - In addition to the access key ID, this provides scope information - used in calculating the signing key for signature calculation. - - - - - Get the policy document as a human readable string. - - Human readable policy document. - - - - JSON representation of this object - - JSON string - - - - XML Representation of this object - - XML String - - - - Create an instance of this class from a JSON string. - - JSON string - Instance of S3PostUploadSignedPolicy - - - - Create an instance of this class from an XML string. - - XML string generated by ToXml() - Instance of S3PostUploadSignedPolicy - - - - Mimics the System.IO.DirectoryInfo for a virtual directory in S3. It exposes properties and methods for enumerating directories and files as well as - methods manipulate directories. - - - It is important to keep in mind that S3 is not a filesystem. It is possible for S3 object keys to contain - characters which are not not legal file path characters, and so some pre-existing objects in a bucket that were created with - other software may not be compatible with this class. - - - - - Initialize a new instance of the S3DirectoryInfo class for the specified S3 bucket. - - S3 client which is used to access the S3 resources. - Name of the S3 bucket. - - - - - Initialize a new instance of the S3DirectoryInfo class for the specified S3 bucket and S3 object key. - - S3 client which is used to access the S3 resources. - Name of the S3 bucket. - The S3 object key. - - - - - The S3DirectoryInfo for the root of the S3 bucket. - - - - - Checks with S3 to see if the directory exists and if so returns true. - - Due to Amazon S3's eventual consistency model this property can return false for newly created buckets. - - - - - - - Returns empty string for directories. - - - - - The full path of the directory including bucket name. - - - - - Returns the last write time of the the latest file written to the directory. - - - - - - - UTC converted version of LastWriteTime. - - - - - - - Returns the name of the folder. - - - - - Return the S3DirectoryInfo of the parent directory. - - - - - Returns the S3DirectroyInfo for the S3 account. - - - - - Returns the type of file system element. - - - - - Creates the directory in S3. If no object key was specified when creating the S3DirectoryInfo then the bucket will be created. - - - - - - - Creates a sub directory inside the instance of S3DirectoryInfo. - - - - - - - - - Deletes all the files in this directory as well as this directory. - - - - - - - - Deletes all the files in this directory as well as this directory. If recursive is set to true then all sub directories will be - deleted as well. - - - - - If true then sub directories will be deleted as well. - - - - Enumerate the sub directories of this directory. - - - - An enumerable collection of directories. - - - - Enumerate the sub directories of this directory. - - The search string. The default pattern is "*", which returns all directories. - - - An enumerable collection of directories that matches searchPattern. - - - - Enumerate the sub directories of this directory. - - The search string. The default pattern is "*", which returns all directories. - One of the enumeration values that specifies whether the search operation should include only the current directory or all subdirectories. The default value is TopDirectoryOnly. - - - An enumerable collection of directories that matches searchPattern and searchOption. - - - - Enumerate the files of this directory. - - - - An enumerable collection of files. - - - - Enumerate the sub directories of this directory. - - The search string. The default pattern is "*", which returns all files. - - - An enumerable collection of files that matches searchPattern. - - - - Enumerate the files of this directory. - - The search string. The default pattern is "*", which returns all files. - One of the enumeration values that specifies whether the search operation should include only the current directory or all subdirectories. The default value is TopDirectoryOnly. - - - An enumerable collection of files that matches searchPattern and searchOption. - - - - Enumerate the files of this directory. - - - - An enumerable collection of files. - - - - Enumerate the files of this directory. - - The search string. The default pattern is "*", which returns all files. - - - An enumerable collection of files that matches searchPattern. - - - - Enumerate the files of this directory. - - The search string. The default pattern is "*", which returns all files. - One of the enumeration values that specifies whether the search operation should include only the current directory or all subdirectories. The default value is TopDirectoryOnly. - - - An enumerable collection of files that matches searchPattern and searchOption. - - - - Returns the S3DirectoryInfo for the specified sub directory. - - Directory to get the S3DirectroyInfo for. - The S3DirectoryInfo for the specified sub directory. - - - - Returns an array of S3DirectoryInfos for the directories in this directory. - - - - An array of directories. - - - - Returns an array of S3DirectoryInfos for the directories in this directory. - - The search string. The default pattern is "*", which returns all files. - An array of files that matches searchPattern. - - - - Returns an array of S3DirectoryInfos for the directories in this directory. - - The search string. The default pattern is "*", which returns all directories. - One of the enumeration values that specifies whether the search operation should include only the current directory or all subdirectories. The default value is TopDirectoryOnly. - - - An array of directories that matches searchPattern and searchOption. - - - - Returns the S3FileInfo for the specified file. - - File to get the S3FileInfo for. - The S3FileInfo for the specified file. - - - - Returns an array of S3FileInfos for the files in this directory. - - - - An array of files. - - - - Returns an array of S3FileInfos for the files in this directory. - - The search string. The default pattern is "*", which returns all files. - - - An array of files that matches searchPattern. - - - - Returns an array of S3FileInfos for the files in this directory. - - The search string. The default pattern is "*", which returns all files. - One of the enumeration values that specifies whether the search operation should include only the current directory or all subdirectories. The default value is TopDirectoryOnly. - - - An array of files that matches searchPattern and searchOption. - - - - Returns an array of IS3FileSystemInfos for the files in this directory. - - - - An array of files. - - - - Returns an array of IS3FileSystemInfos for the files in this directory. - - The search string. The default pattern is "*", which returns all files. - - - An array of files that matches searchPattern. - - - - Returns an array of IS3FileSystemInfos for the files in this directory. - - The search string. The default pattern is "*", which returns all files. - One of the enumeration values that specifies whether the search operation should include only the current directory or all subdirectories. The default value is TopDirectoryOnly. - - - An array of files that matches searchPattern and searchOption. - - - - Copies the files from this directory to the target directory specified by the bucket and object key. - - The target bucket to copy to. - The target object key which represents a directory in S3. - - - - S3DirectoryInfo for the target location. - - - - Copies the files from this directory to the target directory specified by the bucket and object key. Only - files that have changed since the changeSince date will be copied. - - The target bucket to copy to. - The target object key which represents a directory in S3. - Date which files must have changed since in ordered to be copied. - - - - S3DirectoryInfo for the target location. - - - - Copies the files from this directory to the target directory. - - The target directory to copy to. - - - - S3DirectoryInfo for the target location. - - - - Copies the files from this directory to the target directory. Only - files that have changed since the changeSince date will be copied. - - The target directory to copy to. - Date which files must have changed since in ordered to be copied. - - - - S3DirectoryInfo for the target location. - - - - Copies the files from the S3 directory to the local file system in the location indicated by the path parameter. - - The location on the local file system to copy the files to. - - - DirectoryInfo for the local directory where files are copied to. - - - - Copies the files from the S3 directory to the local file system in the location indicated by the path parameter. - Only files that have been modified since the changesSince property will be copied. - - The location on the local file system to copy the files to. - Date which files must have changed since in ordered to be copied. - - - - DirectoryInfo for the local directory where files are copied to. - - - - Copies files from the local file system to S3 in this directory. Sub directories are copied as well. - - The local file system path where the files are to be copied. - - - - S3DirectoryInfo where the files are copied to. - - - - Copies files from the local file system to S3 in this directory. Sub directories are copied as well. - Only files that have been modified since the changesSince property will be copied. - - The local file system path where the files are to copy. - Date which files must have changed since in ordered to be copied. - - - - S3DirectoryInfo where the files are copied to. - - - - Moves the directory to the target directory specified by the bucket and object key. - - The target bucket to move to. - The target object key which represents a directory in S3. - - - - S3DirectoryInfo for the target location. - - - - Moves the directory to the target S3 directory. - - The target directory to copy to. - - - - S3DirectoryInfo for the target location. - - - - Moves the files from the S3 directory to the local file system in the location indicated by the path parameter. - - The location on the local file system to move the files to. - - - - DirectoryInfo for the local directory where files are moved to. - - - - Moves files from the local file system to S3 in this directory. Sub directories are moved as well. - - The local file system path where the files are to be moved. - - - - S3DirectoryInfo where the files are moved to. - - - - Implement the ToString method. - - - - - - Creating and deleting buckets can sometimes take a little bit of time. To make sure - users of this API do not experience the side effects of the eventual consistency - we block until the state change has happened. - - - - - - Mimics the System.IO.FileInfo for a file in S3. It exposes properties and methods manipulating files in S3. - - - - - Initialize a new instance of the S3FileInfo class for the specified S3 bucket and S3 object key. - - S3 client which is used to access the S3 resources. - Name of the S3 bucket. - The S3 object key. - - - - - Returns the parent S3DirectoryInfo. - - - - - The full name of parent directory. - - - - - Checks S3 if the file exists in S3 and return true if it does. - - - - - - - Gets the file's extension. - - - - - Returns the full path including the bucket. - - - - - Returns the last time the file was modified. - - - - - - - Returns the last time the file was modified in UTC. - - - - - - - Returns the content length of the file. - - - - - - - Returns the file name without its directory name. - - - - - Returns the type of file system element. - - - - - Copies this file's content to the file indicated by the S3 bucket and object key. - If the file already exists in S3 than an ArgumentException is thrown. - - S3 bucket to copy the file to. - S3 object key to copy the file to. - - - - S3FileInfo of the newly copied file. - - - - Copies this file's content to the file indicated by the S3 bucket and object key. - If the file already exists in S3 and overwrite is set to false than an ArgumentException is thrown. - - S3 bucket to copy the file to. - S3 object key to copy the file to. - Determines whether the file can be overwritten. - If the file already exists in S3 and overwrite is set to false. - - - - S3FileInfo of the newly copied file. - - - - Copies this file to the target directory. - If the file already exists in S3 than an ArgumentException is thrown. - - Target directory where to copy the file to. - If the directory does not exist. - If the file already exists in S3. - - - S3FileInfo of the newly copied file. - - - - Copies this file to the target directory. - If the file already exists in S3 and overwrite is set to false than an ArgumentException is thrown. - - Target directory where to copy the file to. - Determines whether the file can be overwritten. - If the directory does not exist. - If the file already exists in S3 and overwrite is set to false. - - - S3FileInfo of the newly copied file. - - - - Copies this file to the location indicated by the passed in S3FileInfo. - If the file already exists in S3 than an ArgumentException is thrown. - - The target location to copy this file to. - If the file already exists in S3. - - - S3FileInfo of the newly copied file. - - - - Copies this file to the location indicated by the passed in S3FileInfo. - If the file already exists in S3 and overwrite is set to false than an ArgumentException is thrown. - - The target location to copy this file to. - Determines whether the file can be overwritten. - If the file already exists in S3 and overwrite is set to false. - - - S3FileInfo of the newly copied file. - - - - Copies from S3 to the local file system. - If the file already exists on the local file system than an ArgumentException is thrown. - - The path where to copy the file to. - If the file already exists locally. - - - FileInfo for the local file where file is copied to. - - - - Copies from S3 to the local file system. - If the file already exists on the local file system and overwrite is set to false than an ArgumentException is thrown. - - The path where to copy the file to. - Determines whether the file can be overwritten. - If the file already exists locally and overwrite is set to false. - - - FileInfo for the local file where file is copied to. - - - - Copies the file from the local file system to S3. - If the file already exists in S3 than an ArgumentException is thrown. - - Location of the file on the local file system to copy. - If the file already exists in S3. - - - S3FileInfo where the file is copied to. - - - - Copies the file from the local file system to S3. - If the file already exists in S3 and overwrite is set to false than an ArgumentException is thrown. - - Location of the file on the local file system to copy. - Determines whether the file can be overwritten. - If the file already exists in S3 and overwrite is set to false. - - - S3FileInfo where the file is copied to. - - - - Returns a Stream that can be used to write data to S3. - - - The content will not be written to S3 until the Stream is closed. - - - - Stream to write content to. - - - - Returns a StreamWriter that can be used to write data to S3. - - - The content will not be written to S3 until the Stream is closed. - - - - Stream to write content to. - - - - Deletes the from S3. - - - - - - - Moves the file to a a new location in S3. - - Bucket to move the file to. - Object key to move the file to. - If the file already exists in S3. - - - - S3FileInfo for the target location. - - - - Moves the file to a a new location in S3. - - The target directory to copy to. - If the file already exists in S3. - - - - S3FileInfo for the target location. - - - - Moves the file to a a new location in S3. - - The target file to copy to. - If the file already exists in S3. - - - - S3FileInfo for the target location. - - - - Moves the file from S3 to the local file system in the location indicated by the path parameter. - - The location on the local file system to move the file to. - If the file already exists locally. - - - - FileInfo for the local file where file is moved to. - - - - Moves the file from the local file system to S3 in this directory. - If the file already exists in S3 than an ArgumentException is thrown. - - The local file system path where the files are to be moved. - If the file already exists locally. - - - - S3FileInfo where the file is moved to. - - - - Moves the file from the local file system to S3 in this directory. - If the file already exists in S3 and overwrite is set to false than an ArgumentException is thrown. - - The local file system path where the files are to be moved. - Determines whether the file can be overwritten. - If the file already exists in S3 and overwrite is set to false. - - - - S3FileInfo where the file is moved to. - - - - Returns a Stream for reading the contents of the file. - - The file is already open. - - - Stream to read from. - - - - Returns a StreamReader for reading the contents of the file. - - The file is already open. - - - StreamReader to read from. - - - - Returns a Stream for writing to S3. If the file already exists it will be overwritten. - - - The content will not be written to S3 until the Stream is closed. - - The file is already open. - - - Stream to write from. - - - - Replaces the destination file with the content of this file and then deletes the orignial file. If a backup location is specifed then the content of destination file is - backup to it. - - Destination bucket of this file will be copy to. - Destination object key of this file will be copy to. - Backup bucket to store the contents of the destination file. - Backup object key to store the contents of the destination file. - - - - - S3FileInfo of the destination file. - - - - Replaces the destination file with the content of this file and then deletes the orignial file. If a backupDir is specifed then the content of destination file is - backup to it. - - Where the contents of this file will be copy to. - If specified the destFile is backup to it. - - - - - S3FileInfo of the destination file. - - - - Replaces the destination file with the content of this file and then deletes the orignial file. If a backupFile is specifed then the content of destination file is - backup to it. - - Where the contents of this file will be copy to. - If specified the destFile is backup to it. - - - - - S3FileInfo of the destination file. - - - - Replaces the content of the destination file on the local file system with the content from this file from S3. - If a backup file is specified then the content of the destination file is backup to it. - - - - - - - - - - - - Implement the ToString method. - - - - - - Enumeration indicated whether a file system element is a file or directory. - - - - - Type is a directory. - - - - - Type is a file. - - - - - Common interface for both S3FileInfo and S3DirectoryInfo. - - - - - Returns true if the item exists in S3. - - - - - Returns the extension of the item. - - - - - Returns the fully qualified path to the item. - - - - - Returns the last modified time for this item from S3 in local timezone. - - - - - Returns the last modified time for this item from S3 in UTC timezone. - - - - - Returns the name of the item without parent information. - - - - - Indicates what type of item this object represents. - - - - - Deletes this item from S3. - - - - - Configuration for the S3 section of AWS configuration. - Changes to some settings may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws> - <s3 useSignatureVersion4="true" /> - </aws> - - - - - - Key for the S3UseSignatureVersion4Key property. - - - - - - Configures if the S3 client should use Signature Version 4 signing with requests. - By default, this setting is set to true which will use Signature Version 4 for all - requests except presigned URL requests when the region is set to us-east-1. When - UseSignatureVersion4 is explicitly set to true by directly setting this property or - directly setting this property through configuration, Signature Version 4 will be - used for all requests when able to do so. - When this setting is false, Signature Version 2 will be used. Note that when the - setting is false, Signature Version 4 may still be used by default in some cases - or with some regions. - - - - - Was the value of the UseSignatureVersion4 property set explicitly? - This can be done via configuration or by directly setting the property. - - This is used to determine if the user set UseSignatureVersion4 to true, - or if it's true because the default was changed to true in the SDK. - - - - - V4-enabling section - - - - diff --git a/packages/AWSSDK.S3.3.5.0-beta/lib/netstandard1.3/AWSSDK.S3.dll b/packages/AWSSDK.S3.3.5.0-beta/lib/netstandard1.3/AWSSDK.S3.dll deleted file mode 100644 index fe16801..0000000 Binary files a/packages/AWSSDK.S3.3.5.0-beta/lib/netstandard1.3/AWSSDK.S3.dll and /dev/null differ diff --git a/packages/AWSSDK.S3.3.5.0-beta/lib/netstandard1.3/AWSSDK.S3.xml b/packages/AWSSDK.S3.3.5.0-beta/lib/netstandard1.3/AWSSDK.S3.xml deleted file mode 100644 index cc42c16..0000000 --- a/packages/AWSSDK.S3.3.5.0-beta/lib/netstandard1.3/AWSSDK.S3.xml +++ /dev/null @@ -1,30859 +0,0 @@ - - - - AWSSDK.S3 - - - - - Implementation for accessing S3 - - - - - - - Specialize the initialize of the client. - - - - - Create a signed URL allowing access to a resource that would - usually require authentication. - - - - When using query string authentication you create a query, - specify an expiration time for the query, sign it with your - signature, place the data in an HTTP request, and distribute - the request to a user or embed the request in a web page. - - - A PreSigned URL can be generated for GET, PUT, DELETE and HEAD - operations on your bucketName, keys, and versions. - - - The GetPreSignedUrlRequest that defines the - parameters of the operation. - determines if signing will fall back to SigV2 if the - signing region is us-east-1 - A string that is the signed http request. - - - - - - Marshalls the parameters for a presigned url for a preferred signing protocol. - - - - - - True if AWS4 signing will be used; if the expiry period in the request exceeds the - maximum allowed for AWS4 (one week), an ArgumentException is thrown. - - - - - - Create a signed URL allowing access to a resource that would - usually require authentication. - - - - When using query string authentication you create a query, - specify an expiration time for the query, sign it with your - signature, place the data in an HTTP request, and distribute - the request to a user or embed the request in a web page. - - - A PreSigned URL can be generated for GET, PUT, DELETE and HEAD - operations on your bucketName, keys, and versions. - - - The GetPreSignedUrlRequest that defines the - parameters of the operation. - A string that is the signed http request. - - - - - - Constructs AmazonS3Client with the credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - - - - Constructs AmazonS3Client with the credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - The region to connect. - - - - Constructs AmazonS3Client with the credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - The AmazonS3Client Configuration Object - - - - Constructs AmazonS3Client with AWS Credentials - - AWS Credentials - - - - Constructs AmazonS3Client with AWS Credentials - - AWS Credentials - The region to connect. - - - - Constructs AmazonS3Client with AWS Credentials and an - AmazonS3Client Configuration object. - - AWS Credentials - The AmazonS3Client Configuration Object - - - - Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - - - - Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - The region to connect. - - - - Constructs AmazonS3Client with AWS Access Key ID, AWS Secret Key and an - AmazonS3Client Configuration object. - - AWS Access Key ID - AWS Secret Access Key - The AmazonS3Client Configuration Object - - - - Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - - - - Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - The region to connect. - - - - Constructs AmazonS3Client with AWS Access Key ID, AWS Secret Key and an - AmazonS3Client Configuration object. - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - The AmazonS3Client Configuration Object - - - - Creates the signer for the service. - - - - - Customizes the runtime pipeline. - - Runtime pipeline for the current client. - - - - Capture metadata for the service. - - - - - Disposes the service client. - - - - - This operation aborts a multipart upload. After a multipart upload is aborted, no - additional parts can be uploaded using that upload ID. The storage consumed by any - previously uploaded parts will be freed. However, if any part uploads are currently - in progress, those part uploads might or might not succeed. As a result, it might - be necessary to abort a given multipart upload multiple times in order to completely - free all storage consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts operation and ensure that the parts - list is empty. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - The bucket name to which the upload was taking place. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object for which the multipart upload was initiated. - Upload ID that identifies the multipart upload. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AbortMultipartUpload service method, as returned by S3. - - - - This operation aborts a multipart upload. After a multipart upload is aborted, no - additional parts can be uploaded using that upload ID. The storage consumed by any - previously uploaded parts will be freed. However, if any part uploads are currently - in progress, those part uploads might or might not succeed. As a result, it might - be necessary to abort a given multipart upload multiple times in order to completely - free all storage consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts operation and ensure that the parts - list is empty. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - Container for the necessary parameters to execute the AbortMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AbortMultipartUpload service method, as returned by S3. - - - - Completes a multipart upload by assembling previously uploaded parts. - - - - You first initiate the multipart upload and then upload all parts using the UploadPart - operation. After successfully uploading all relevant parts of an upload, you call - this operation to complete the upload. Upon receiving this request, Amazon S3 concatenates - all the parts in ascending order by part number to create a new object. In the Complete - Multipart Upload request, you must provide the parts list. You must ensure that the - parts list is complete. This operation concatenates the parts that you provide in - the list. For each part in the list, you must provide the part number and the ETag - value, returned after that part was uploaded. - - - - Processing of a Complete Multipart Upload request could take several minutes to complete. - After Amazon S3 begins processing the request, it sends an HTTP response header that - specifies a 200 OK response. While processing is in progress, Amazon S3 periodically - sends white space characters to keep the connection from timing out. Because a request - could fail after the initial 200 OK response has been sent, it is important that you - check the response body to determine whether the request succeeded. - - - - Note that if CompleteMultipartUpload fails, applications should be prepared - to retry the failed requests. For more information, see Amazon - S3 Error Best Practices. - - - - For more information about multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - GetBucketLifecycle has the following special errors: - -
  • - - Error code: EntityTooSmall - -
    • - - Description: Your proposed upload is smaller than the minimum allowed object size. - Each part must be at least 5 MB in size, except the last part. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPart - -
    • - - Description: One or more of the specified parts could not be found. The part might - not have been uploaded, or the specified entity tag might not have matched the part's - entity tag. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPartOrder - -
    • - - Description: The list of parts was not in ascending order. The parts list must be - specified in order by part number. - -
    • - - 400 Bad Request - -
  • - - Error code: NoSuchUpload - -
    • - - Description: The specified multipart upload does not exist. The upload ID might be - invalid, or the multipart upload might have been aborted or completed. - -
    • - - 404 Not Found - -
- - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the CompleteMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CompleteMultipartUpload service method, as returned by S3. - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - for copying an object greater than 5 GB, you must use the multipart upload Upload - Part - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - Amazon S3 transfer acceleration does not support cross-region copies. If you request - a cross-region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information about transfer acceleration, see Transfer - Acceleration. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - request parameters x-amz-copy-source-if-match, x-amz-copy-source-if-none-match, - x-amz-copy-source-if-unmodified-since, or x-amz-copy-source-if-modified-since. - - - - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - You can use this operation to change the storage class of an object that is already - stored in Amazon S3 using the StorageClass parameter. For more information, - see Storage - Classes. - - - - The source object that you are copying can be encrypted or unencrypted. If the source - object is encrypted, it can be encrypted by server-side encryption using AWS managed - encryption keys or by using a customer-provided encryption key. When copying an object, - you can request that Amazon S3 encrypt the target object by using either the AWS managed - encryption keys or by using your own encryption key. You can do this regardless of - the form of server-side encryption that was used to encrypt the source, or even if - the source object was not encrypted. For more information about server-side encryption, - see Using - Server-Side Encryption. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
    • - - x-amz-copy-source-if-match condition evaluates to true - -
    • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
  • - - Consideration 2 – If both of the x-amz-copy-source-if-none-match and - x-amz-copy-source-if-modified-since headers are present in the request - and evaluate as follows, Amazon S3 returns the 412 Precondition Failed - response code: - -
    • - - x-amz-copy-source-if-none-match condition evaluates to false - -
    • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - The copy request charge is based on the storage class and Region you specify for the - destination object. For pricing information, see Amazon - S3 Pricing. - - - - Following are other considerations when using CopyObject: - -
Versioning
- - By default, x-amz-copy-source identifies the current version of an object - to copy. (If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted.) To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - To encrypt the target object, you must provide the appropriate encryption-related - request headers. The one you use depends on whether you want to use AWS managed encryption - keys or provide your own encryption key. - -
  • - - To encrypt the target object using server-side encryption with an AWS managed encryption - key, provide the following request headers, as appropriate. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. If you want to use a customer managed AWS KMS - CMK, you must provide the x-amz-server-side-encryption-aws-kms-key-id - of the symmetric customer managed CMK. Amazon S3 only supports symmetric CMKs and - not asymmetric CMKs. For more information, see Using - Symmetric and Asymmetric Keys in the AWS Key Management Service Developer Guide. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in KMS. - -
  • - - To encrypt the target object using server-side encryption with an encryption key that - you provide, use the following headers. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
  • - - If the source object is encrypted using server-side encryption with customer-provided - encryption keys, you must use the following headers. - -
    • - - x-amz-copy-source​-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-copy-source​-server-side​-encryption​-customer-key - -
    • - - x-amz-copy-source-​server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in Amazon KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - for copying an object greater than 5 GB, you must use the multipart upload Upload - Part - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - Amazon S3 transfer acceleration does not support cross-region copies. If you request - a cross-region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information about transfer acceleration, see Transfer - Acceleration. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - request parameters x-amz-copy-source-if-match, x-amz-copy-source-if-none-match, - x-amz-copy-source-if-unmodified-since, or x-amz-copy-source-if-modified-since. - - - - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - You can use this operation to change the storage class of an object that is already - stored in Amazon S3 using the StorageClass parameter. For more information, - see Storage - Classes. - - - - The source object that you are copying can be encrypted or unencrypted. If the source - object is encrypted, it can be encrypted by server-side encryption using AWS managed - encryption keys or by using a customer-provided encryption key. When copying an object, - you can request that Amazon S3 encrypt the target object by using either the AWS managed - encryption keys or by using your own encryption key. You can do this regardless of - the form of server-side encryption that was used to encrypt the source, or even if - the source object was not encrypted. For more information about server-side encryption, - see Using - Server-Side Encryption. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
    • - - x-amz-copy-source-if-match condition evaluates to true - -
    • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
  • - - Consideration 2 – If both of the x-amz-copy-source-if-none-match and - x-amz-copy-source-if-modified-since headers are present in the request - and evaluate as follows, Amazon S3 returns the 412 Precondition Failed - response code: - -
    • - - x-amz-copy-source-if-none-match condition evaluates to false - -
    • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - The copy request charge is based on the storage class and Region you specify for the - destination object. For pricing information, see Amazon - S3 Pricing. - - - - Following are other considerations when using CopyObject: - -
Versioning
- - By default, x-amz-copy-source identifies the current version of an object - to copy. (If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted.) To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - To encrypt the target object, you must provide the appropriate encryption-related - request headers. The one you use depends on whether you want to use AWS managed encryption - keys or provide your own encryption key. - -
  • - - To encrypt the target object using server-side encryption with an AWS managed encryption - key, provide the following request headers, as appropriate. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. If you want to use a customer managed AWS KMS - CMK, you must provide the x-amz-server-side-encryption-aws-kms-key-id - of the symmetric customer managed CMK. Amazon S3 only supports symmetric CMKs and - not asymmetric CMKs. For more information, see Using - Symmetric and Asymmetric Keys in the AWS Key Management Service Developer Guide. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in KMS. - -
  • - - To encrypt the target object using server-side encryption with an encryption key that - you provide, use the following headers. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
  • - - If the source object is encrypted using server-side encryption with customer-provided - encryption keys, you must use the following headers. - -
    • - - x-amz-copy-source​-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-copy-source​-server-side​-encryption​-customer-key - -
    • - - x-amz-copy-source-​server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in Amazon KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - for copying an object greater than 5 GB, you must use the multipart upload Upload - Part - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - Amazon S3 transfer acceleration does not support cross-region copies. If you request - a cross-region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information about transfer acceleration, see Transfer - Acceleration. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - request parameters x-amz-copy-source-if-match, x-amz-copy-source-if-none-match, - x-amz-copy-source-if-unmodified-since, or x-amz-copy-source-if-modified-since. - - - - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - You can use this operation to change the storage class of an object that is already - stored in Amazon S3 using the StorageClass parameter. For more information, - see Storage - Classes. - - - - The source object that you are copying can be encrypted or unencrypted. If the source - object is encrypted, it can be encrypted by server-side encryption using AWS managed - encryption keys or by using a customer-provided encryption key. When copying an object, - you can request that Amazon S3 encrypt the target object by using either the AWS managed - encryption keys or by using your own encryption key. You can do this regardless of - the form of server-side encryption that was used to encrypt the source, or even if - the source object was not encrypted. For more information about server-side encryption, - see Using - Server-Side Encryption. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
    • - - x-amz-copy-source-if-match condition evaluates to true - -
    • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
  • - - Consideration 2 – If both of the x-amz-copy-source-if-none-match and - x-amz-copy-source-if-modified-since headers are present in the request - and evaluate as follows, Amazon S3 returns the 412 Precondition Failed - response code: - -
    • - - x-amz-copy-source-if-none-match condition evaluates to false - -
    • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - The copy request charge is based on the storage class and Region you specify for the - destination object. For pricing information, see Amazon - S3 Pricing. - - - - Following are other considerations when using CopyObject: - -
Versioning
- - By default, x-amz-copy-source identifies the current version of an object - to copy. (If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted.) To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - To encrypt the target object, you must provide the appropriate encryption-related - request headers. The one you use depends on whether you want to use AWS managed encryption - keys or provide your own encryption key. - -
  • - - To encrypt the target object using server-side encryption with an AWS managed encryption - key, provide the following request headers, as appropriate. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. If you want to use a customer managed AWS KMS - CMK, you must provide the x-amz-server-side-encryption-aws-kms-key-id - of the symmetric customer managed CMK. Amazon S3 only supports symmetric CMKs and - not asymmetric CMKs. For more information, see Using - Symmetric and Asymmetric Keys in the AWS Key Management Service Developer Guide. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in KMS. - -
  • - - To encrypt the target object using server-side encryption with an encryption key that - you provide, use the following headers. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
  • - - If the source object is encrypted using server-side encryption with customer-provided - encryption keys, you must use the following headers. - -
    • - - x-amz-copy-source​-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-copy-source​-server-side​-encryption​-customer-key - -
    • - - x-amz-copy-source-​server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in Amazon KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - Container for the necessary parameters to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - - - - - - - - - Deletes an analytics configuration for the bucket (specified by the analytics configuration - ID). - - - - To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to DeleteBucketAnalyticsConfiguration: - -
  • - - - -
  • - - - -
  • - - - -
- - Container for the necessary parameters to execute the DeleteBucketAnalyticsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketAnalyticsConfiguration service method, as returned by S3. - - - - - Deletes an inventory configuration (identified by the inventory ID) from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - Operations related to DeleteBucketInventoryConfiguration include: - - - - Container for the necessary parameters to execute the DeleteBucketInventoryConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketInventoryConfiguration service method, as returned by S3. - - - - Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified - by the metrics configuration ID) from the bucket. Note that this doesn't include the - daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketMetricsConfiguration service method, as returned by S3. - - - - This implementation of the DELETE operation uses the policy subresource to delete - the policy of a specified bucket. If you are using an identity other than the root - user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - The bucket name. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketPolicy service method, as returned by S3. - - - - This implementation of the DELETE operation uses the policy subresource to delete - the policy of a specified bucket. If you are using an identity other than the root - user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - Container for the necessary parameters to execute the DeleteBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketPolicy service method, as returned by S3. - - - - Deletes the replication configuration from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutReplicationConfiguration - action. The bucket owner has these permissions by default and can grant it to others. - For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - It can take a while for the deletion of a replication configuration to fully propagate. - - - - For information about replication configuration, see Replication - in the Amazon S3 Developer Guide. - - - - The following operations are related to DeleteBucketReplication: - - - - Container for the necessary parameters to execute the DeleteBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketReplication service method, as returned by S3. - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - The bucket that has the tag set to be removed. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketTagging service method, as returned by S3. - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - Container for the necessary parameters to execute the DeleteBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketTagging service method, as returned by S3. - - - - This operation removes the website configuration for a bucket. Amazon S3 returns a - 200 OK response upon successfully deleting a website configuration on - the specified bucket. You will get a 200 OK response if the website configuration - you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE operation requires the S3:DeleteBucketWebsite permission. - By default, only the bucket owner can delete the website configuration attached to - a bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which you want to remove the website configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketWebsite service method, as returned by S3. - - - - This operation removes the website configuration for a bucket. Amazon S3 returns a - 200 OK response upon successfully deleting a website configuration on - the specified bucket. You will get a 200 OK response if the website configuration - you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE operation requires the S3:DeleteBucketWebsite permission. - By default, only the bucket owner can delete the website configuration attached to - a bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the DeleteBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketWebsite service method, as returned by S3. - - - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - The bucket name of the lifecycle to delete. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - Container for the necessary parameters to execute the DeleteLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key name of the object to delete. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key name of the object to delete. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - Container for the necessary parameters to execute the DeleteObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - - - - This operation enables you to delete multiple objects from a bucket using a single - HTTP request. If you know the object keys that you want to delete, then this operation - provides a suitable alternative to sending individual delete requests, reducing per-request - overhead. - - - - The request contains a list of up to 1000 keys that you want to delete. In the XML, - you provide the object key names, and optionally, version IDs if you want to delete - a specific version of the object from a versioning-enabled bucket. For each key, Amazon - S3 performs a delete operation and returns the result of that delete, success, or - failure, in the response. Note that if the object specified in the request is not - found, Amazon S3 returns the result as deleted. - - - - The operation supports two modes for the response: verbose and quiet. By default, - the operation uses verbose mode in which the response includes the result of deletion - of each key in your request. In quiet mode the response includes only keys where the - delete operation encountered an error. For a successful deletion, the operation does - not return any information about the delete in the response body. - - - - When performing this operation on an MFA Delete enabled bucket, that attempts to delete - any versioned objects, you must include an MFA token. If you do not provide one, the - entire request will fail, even if there are non-versioned objects you are trying to - delete. If you provide an invalid token, whether there are versioned keys in the request - or not, the entire Multi-Object Delete request will fail. For information about MFA - Delete, see - MFA Delete. - - - - Finally, the Content-MD5 header is required for all Multi-Object Delete requests. - Amazon S3 uses the header value to ensure that your request body has not been altered - in transit. - - - - The following operations are related to DeleteObjects: - - - - Container for the necessary parameters to execute the DeleteObjects service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObjects service method, as returned by S3. - - - - Removes the entire tag set from the specified object. For more information about managing - object tags, see - Object Tagging. - - - - To use this operation, you must have permission to perform the s3:DeleteObjectTagging - action. - - - - To delete tags of a specific object version, add the versionId query - parameter in the request. You will need permission for the s3:DeleteObjectVersionTagging - action. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteObjectTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObjectTagging service method, as returned by S3. - - - - Removes the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:PutBucketPublicAccessBlock - permission. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeletePublicAccessBlock service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeletePublicAccessBlock service method, as returned by S3. - - - - - - - - - Returns the default encryption configuration for an Amazon S3 bucket. For information - about the Amazon S3 default encryption feature, see Amazon - S3 Default Bucket Encryption. - - - - To use this operation, you must have permission to perform the s3:GetEncryptionConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to GetBucketEncryption: - - - - Container for the necessary parameters to execute the GetBucketEncryption service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketEncryption service method, as returned by S3. - - - - Returns an inventory configuration (identified by the inventory configuration ID) - from the bucket. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - The following operations are related to GetBucketInventoryConfiguration: - - - - Container for the necessary parameters to execute the GetBucketInventoryConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketInventoryConfiguration service method, as returned by S3. - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - The name of the bucket for which to get the location. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLocation service method, as returned by S3. - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - Container for the necessary parameters to execute the GetBucketLocation service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLocation service method, as returned by S3. - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - The bucket name for which to get the logging information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLogging service method, as returned by S3. - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - Container for the necessary parameters to execute the GetBucketLogging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLogging service method, as returned by S3. - - - - Gets a metrics configuration (specified by the metrics configuration ID) from the - bucket. Note that this doesn't include the daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to GetBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the GetBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketMetricsConfiguration service method, as returned by S3. - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following operation is related to GetBucketNotification: - - - - Name of the bucket for which to get the notification configuration - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketNotification service method, as returned by S3. - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following operation is related to GetBucketNotification: - - - - Container for the necessary parameters to execute the GetBucketNotification service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketNotification service method, as returned by S3. - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operation is related to GetBucketPolicy: - - - - The bucket name for which to get the bucket policy. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicy service method, as returned by S3. - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operation is related to GetBucketPolicy: - - - - Container for the necessary parameters to execute the GetBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicy service method, as returned by S3. - - - - Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket - is public. In order to use this operation, you must have the s3:GetBucketPolicyStatus - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - For more information about when Amazon S3 considers a bucket public, see The - Meaning of "Public". - - - - The following operations are related to GetBucketPolicyStatus: - - - - Container for the necessary parameters to execute the GetBucketPolicyStatus service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicyStatus service method, as returned by S3. - - - - Retrieves the replication configuration for the given Amazon S3 bucket. - - Container for the necessary parameters to execute the GetBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketReplication service method, as returned by S3. - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - The name of the bucket for which to get the payment request configuration - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketRequestPayment service method, as returned by S3. - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - Container for the necessary parameters to execute the GetBucketRequestPayment service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketRequestPayment service method, as returned by S3. - - - - Returns the tag set associated with the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - GetBucketTagging has the following special error: - -
  • - - Error code: NoSuchTagSetError - -
    • - - Description: There is no tag set associated with the bucket. - -
- - The following operations are related to GetBucketTagging: - - - - Container for the necessary parameters to execute the GetBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketTagging service method, as returned by S3. - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - The name of the bucket for which to get the versioning information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketVersioning service method, as returned by S3. - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - Container for the necessary parameters to execute the GetBucketVersioning service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketVersioning service method, as returned by S3. - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET operation requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which to get the website configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketWebsite service method, as returned by S3. - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET operation requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the GetBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketWebsite service method, as returned by S3. - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - The bucket name for which to get the cors configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetCORSConfiguration service method, as returned by S3. - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - Container for the necessary parameters to execute the GetCORSConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetCORSConfiguration service method, as returned by S3. - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are still using previous version of the lifecycle configuration, it works. - For the earlier API description, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to DeleteBucketMetricsConfiguration: - - - - The name of the bucket for which to get the lifecycle information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetLifecycleConfiguration service method, as returned by S3. - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are still using previous version of the lifecycle configuration, it works. - For the earlier API description, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the GetLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetLifecycleConfiguration service method, as returned by S3. - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object to get. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object to get. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - Container for the necessary parameters to execute the GetObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - - - - Gets an object's current Legal Hold status. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLegalHold service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectLegalHold service method, as returned by S3. - - - - Gets the Object Lock configuration for a bucket. The rule specified in the Object - Lock configuration will be applied by default to every new object placed in the specified - bucket. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLockConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectLockConfiguration service method, as returned by S3. - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - The name of the bucket containing the object. - The object key. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - The name of the bucket containing the object. - The object key. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - Container for the necessary parameters to execute the GetObjectMetadata service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - - - - Retrieves an object's retention settings. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectRetention service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectRetention service method, as returned by S3. - - - - Returns the tag-set of an object. You send the GET request against the tagging subresource - associated with the object. - - - - To use this operation, you must have permission to perform the s3:GetObjectTagging - action. By default, the GET operation returns information about current version of - an object. For a versioned bucket, you can have multiple versions of an object in - your bucket. To retrieve tags of any other version, use the versionId query parameter. - You also need permission for the s3:GetObjectVersionTagging action. - - - - By default, the bucket owner has this permission and can grant this permission to - others. - - - - For information about the Amazon S3 object tagging feature, see Object - Tagging. - - - - The following operation is related to GetObjectTagging: - - - - Container for the necessary parameters to execute the GetObjectTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTagging service method, as returned by S3. - - - - Return torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Amazon - S3 Torrent. - - - - You can get torrent only for objects that are less than 5 GB in size and that are - not encrypted using server-side encryption with customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - The following operation is related to GetObjectTorrent: - - - - The name of the bucket containing the object for which to get the torrent files. - The object key for which to get the information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTorrent service method, as returned by S3. - - - - Return torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Amazon - S3 Torrent. - - - - You can get torrent only for objects that are less than 5 GB in size and that are - not encrypted using server-side encryption with customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - The following operation is related to GetObjectTorrent: - - - - Container for the necessary parameters to execute the GetObjectTorrent service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTorrent service method, as returned by S3. - - - - Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:GetBucketPublicAccessBlock - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket - or an object, it checks the PublicAccessBlock configuration for both - the bucket (or the bucket that contains the object) and the bucket owner's account. - If the PublicAccessBlock settings are different between the bucket and - the account, Amazon S3 uses the most restrictive combination of the bucket-level and - account-level settings. - - - - For more information about when Amazon S3 considers a bucket or an object public, - see The - Meaning of "Public". - - - - The following operations are related to GetPublicAccessBlock: - - - - Container for the necessary parameters to execute the GetPublicAccessBlock service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetPublicAccessBlock service method, as returned by S3. - - - - This operation is useful to determine if a bucket exists and you have permission to - access it. The operation returns a 200 OK if the bucket exists and you - have permission to access it. Otherwise, the operation might return responses such - as 404 Not Found and 403 Forbidden. - - - - To use this operation, you must have permissions to perform the s3:ListBucket - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - Container for the necessary parameters to execute the HeadBucket service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the HeadBucket service method, as returned by S3. - - - - This operation initiates a multipart upload and returns an upload ID. This upload - ID is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort operation - and Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload API and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart) and UploadPartCopy) requests must match the headers you - used in the request to initiate the upload by using CreateMultipartUpload. - - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, - kms:GenerateDataKey*, and kms:DescribeKey actions on the - key. These permissions are required because Amazon S3 must decrypt and read data from - the encrypted file parts before it completes the multipart upload. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - The following operations are related to CreateMultipartUpload: - - - - The name of the bucket to which to initiate the upload - Object key for which the multipart upload is to be initiated. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the InitiateMultipartUpload service method, as returned by S3. - - - - This operation initiates a multipart upload and returns an upload ID. This upload - ID is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort operation - and Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload API and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart) and UploadPartCopy) requests must match the headers you - used in the request to initiate the upload by using CreateMultipartUpload. - - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, - kms:GenerateDataKey*, and kms:DescribeKey actions on the - key. These permissions are required because Amazon S3 must decrypt and read data from - the encrypted file parts before it completes the multipart upload. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - The following operations are related to CreateMultipartUpload: - - - - Container for the necessary parameters to execute the InitiateMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the InitiateMultipartUpload service method, as returned by S3. - - - - Lists the analytics configurations for the bucket. You can have up to 1,000 analytics - configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. You should always check the IsTruncated element in the response. - If there are no more configurations to list, IsTruncated is set to false. - If there are more configurations to list, IsTruncated is set to true, - and there will be a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to ListBucketAnalyticsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketAnalyticsConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketAnalyticsConfigurations service method, as returned by S3. - - - - Returns a list of inventory configurations for the bucket. You can have up to 1,000 - analytics configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory - - - - The following operations are related to ListBucketInventoryConfigurations: - - - - Container for the necessary parameters to execute the ListBucketInventoryConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketInventoryConfigurations service method, as returned by S3. - - - - Lists the metrics configurations for the bucket. The metrics configurations are only - for the request metrics of the bucket and do not provide information on daily storage - metrics. You can have up to 1,000 configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For more information about metrics configurations and CloudWatch request metrics, - see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to ListBucketMetricsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketMetricsConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketMetricsConfigurations service method, as returned by S3. - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBuckets service method, as returned by S3. - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - Container for the necessary parameters to execute the ListBuckets service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBuckets service method, as returned by S3. - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Container for the necessary parameters to execute the ListMultipartUploads service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. - Limits the response to keys that begin with the specified prefix. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - Container for the necessary parameters to execute the ListObjects service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Make sure to design - your application to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - To use this operation in an AWS Identity and Access Management (IAM) policy, you must - have permissions to perform the s3:ListBucket action. The bucket owner - has this permission by default and can grant this permission to others. For more information - about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - This section describes the latest revision of the API. We recommend that you use this - revised API for application development. For backward compatibility, Amazon S3 continues - to support the prior version of this API, ListObjects. - - - - To get a list of your buckets, see ListBuckets. - - - - The following operations are related to ListObjectsV2: - - - - Container for the necessary parameters to execute the ListObjectsV2 service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjectsV2 service method, as returned by S3. - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). This request returns a maximum of 1,000 - uploaded parts. The default number of parts returned is 1,000 parts. You can restrict - the number of parts returned by specifying the max-parts request parameter. - If your multipart upload consists of more than 1,000 parts, the response returns an - IsTruncated field with the value of true, and a NextPartNumberMarker - element. In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListParts: - - - - Name of the bucket to which the parts are being uploaded. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Object key for which the multipart upload was initiated. - Upload ID identifying the multipart upload whose parts are being listed. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListParts service method, as returned by S3. - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). This request returns a maximum of 1,000 - uploaded parts. The default number of parts returned is 1,000 parts. You can restrict - the number of parts returned by specifying the max-parts request parameter. - If your multipart upload consists of more than 1,000 parts, the response returns an - IsTruncated field with the value of true, and a NextPartNumberMarker - element. In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListParts: - - - - Container for the necessary parameters to execute the ListParts service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListParts service method, as returned by S3. - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - Container for the necessary parameters to execute the ListVersions service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - - - - - Creates a new bucket. To create a bucket, you must register with Amazon S3 and have - a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed - to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information on bucket naming restrictions, - see Working - with Amazon S3 Buckets. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the EU (Ireland) - Region. For more information, see How - to Select a Region for Your Buckets. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - Hosting of Buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - The name of the bucket to create. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucket service method, as returned by S3. - - - - Creates a new bucket. To create a bucket, you must register with Amazon S3 and have - a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed - to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information on bucket naming restrictions, - see Working - with Amazon S3 Buckets. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the EU (Ireland) - Region. For more information, see How - to Select a Region for Your Buckets. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - Hosting of Buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - Container for the necessary parameters to execute the PutBucket service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucket service method, as returned by S3. - - - - Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration - is a bucket-level feature that enables you to perform faster data transfers to Amazon - S3. - - - - To use this operation, you must have permission to perform the s3:PutAccelerateConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The Transfer Acceleration state of a bucket can be set to one of the following two - values: - -
  • - - Enabled – Enables accelerated data transfers to the bucket. - -
  • - - Suspended – Disables accelerated data transfers to the bucket. - -
- - The GetBucketAccelerateConfiguration operation returns the transfer acceleration - state of a bucket. - - - - After setting the Transfer Acceleration state of a bucket to Enabled, it might take - up to thirty minutes before the data transfer rates to the bucket increase. - - - - The name of the bucket used for Transfer Acceleration must be DNS-compliant and must - not contain periods ("."). - - - - For more information about transfer acceleration, see Transfer - Acceleration. - - - - The following operations are related to PutBucketAccelerateConfiguration: - - - - Container for the necessary parameters to execute the PutBucketAccelerateConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketAccelerateConfiguration service method, as returned by S3. - - - - - - - Set the logging parameters for a bucket and to specify permissions for who can view - and modify the logging parameters. All logs are saved to buckets in the same AWS Region - as the source bucket. To set the logging status of a bucket, you must be the bucket - owner. - - - - The bucket owner is automatically granted FULL_CONTROL to all logs. You use the Grantee - request element to grant access to other people. The Permissions request - element specifies the kind of access the grantee has to the logs. - - - - Grantee Values - - - - You can specify the person (grantee) to whom you're assigning access rights (using - request elements) in the following ways: - -
  • - - By the person's ID: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> - </Grantee> - - - - DisplayName is optional and ignored in the request. - -
  • - - By Email address: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee> - - - - - The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl - request, appears as the CanonicalUser. - -
  • - - By URI: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee> - - -
- - To enable logging, you use LoggingEnabled and its children request elements. To disable - logging, you use an empty BucketLoggingStatus request element: - - - - <BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01" /> - - - - - For more information about server access logging, see Server - Access Logging. - - - - For more information about creating a bucket, see CreateBucket. For more information - about returning the logging status of a bucket, see GetBucketLogging. - - - - The following operations are related to PutBucketLogging: - - - - Container for the necessary parameters to execute the PutBucketLogging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketLogging service method, as returned by S3. - - - - Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. - You can have up to 1,000 metrics configurations per bucket. If you're updating an - existing metrics configuration, note that this is a full replacement of the existing - metrics configuration. If you don't include the elements you want to keep, they are - erased. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to PutBucketMetricsConfiguration: - - - - GetBucketLifecycle has the following special error: - -
  • - - Error code: TooManyConfigurations - -
    • - - Description: You are attempting to create a new configuration but have already reached - the 1,000-configuration limit. - -
    • - - HTTP Status Code: HTTP 400 Bad Request - -
- - Container for the necessary parameters to execute the PutBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketMetricsConfiguration service method, as returned by S3. - - - - Enables notifications of specified events for a bucket. For more information about - event notifications, see Configuring - Event Notifications. - - - - Using this API, you can replace an existing notification configuration. The configuration - is an XML file that defines the event types that you want Amazon S3 to publish and - the destination where you want Amazon S3 to publish an event notification when it - detects an event of the specified type. - - - - By default, your bucket has no event notifications configured. That is, the notification - configuration will be an empty NotificationConfiguration. - - - - <NotificationConfiguration> - - - - </NotificationConfiguration> - - - - This operation replaces the existing notification configuration with the configuration - you include in the request body. - - - - After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification - Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, - and that the bucket owner has permission to publish to it by sending a test notification. - In the case of AWS Lambda destinations, Amazon S3 verifies that the Lambda function - permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. - For more information, see Configuring - Notifications for Amazon S3 Events. - - - - You can disable notifications by adding the empty NotificationConfiguration element. - - - - By default, only the bucket owner can configure notifications on a bucket. However, - bucket owners can use a bucket policy to grant permission to other users to set this - configuration with s3:PutBucketNotification permission. - - - - The PUT notification is an atomic operation. For example, suppose your notification - configuration includes SNS topic, SQS queue, and Lambda function configurations. When - you send a PUT request with this configuration, Amazon S3 sends test messages to your - SNS topic. If the message fails, the entire PUT operation will fail, and Amazon S3 - will not add the configuration to your bucket. - - - - Responses - - - - If the configuration in the request body includes only one TopicConfiguration - specifying only the s3:ReducedRedundancyLostObject event type, the response - will also include the x-amz-sns-test-message-id header containing the - message ID of the test notification sent to the topic. - - - - The following operation is related to PutBucketNotificationConfiguration: - - - - Container for the necessary parameters to execute the PutBucketNotification service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketNotification service method, as returned by S3. - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - The MD5 hash of the request body. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - Container for the necessary parameters to execute the PutBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - - - - Creates a replication configuration or replaces an existing one. For more information, - see Replication - in the Amazon S3 Developer Guide. - - - - To perform this operation, the user or role performing the operation must have the - iam:PassRole - permission. - - - - Specify the replication configuration in the request body. In the replication configuration, - you provide the name of the destination bucket where you want Amazon S3 to replicate - objects, the IAM role that Amazon S3 can assume to replicate objects on your behalf, - and other relevant information. - - - - A replication configuration must include at least one rule, and can contain a maximum - of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects - in the source bucket. To choose additional subsets of objects to replicate, add a - rule for each subset. All rules must specify the same destination bucket. - - - - To specify a subset of the objects in the source bucket to apply a replication rule - to, add the Filter element as a child of the Rule element. You can filter objects - based on an object key prefix, one or more object tags, or both. When you add the - Filter element in the configuration, you must also add the following elements: DeleteMarkerReplication, - Status, and Priority. - - - - For information about enabling versioning on a bucket, see Using - Versioning. - - - - By default, a resource owner, in this case the AWS account that created the bucket, - can perform this operation. The resource owner can also grant others permissions to - perform the operation. For more information about permissions, see Specifying - Permissions in a Policy and Managing - Access Permissions to Your Amazon S3 Resources. - - - - Handling Replication of Encrypted Objects - - - - By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side - encryption with CMKs stored in AWS KMS. To replicate AWS KMS-encrypted objects, add - the following: SourceSelectionCriteria, SseKmsEncryptedObjects, - Status, EncryptionConfiguration, and ReplicaKmsKeyID. - For information about replication configuration, see Replicating - Objects Created with SSE Using CMKs stored in AWS KMS. - - - - For information on PutBucketReplication errors, see ReplicationErrorCodeList - - - - - The following operations are related to PutBucketReplication: - - - - Container for the necessary parameters to execute the PutBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketReplication service method, as returned by S3. - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - The bucket name. - Container for Payer. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketRequestPayment service method, as returned by S3. - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - Container for the necessary parameters to execute the PutBucketRequestPayment service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketRequestPayment service method, as returned by S3. - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging. - - - - Within a bucket, if you add a tag that has the same key as an existing tag, the new - value overwrites the old value. For more information, see Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional operation is currently in progress against - this resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - The bucket name. - A property of PutBucketTaggingRequest used to execute the PutBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketTagging service method, as returned by S3. - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging. - - - - Within a bucket, if you add a tag that has the same key as an existing tag, the new - value overwrites the old value. For more information, see Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional operation is currently in progress against - this resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - Container for the necessary parameters to execute the PutBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketTagging service method, as returned by S3. - - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT operation requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - The bucket name. - Container for the request. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketWebsite service method, as returned by S3. - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT operation requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - Container for the necessary parameters to execute the PutBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketWebsite service method, as returned by S3. - - - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - The name of the bucket for which to set the configuration. - A property of PutLifecycleConfigurationRequest used to execute the PutLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutLifecycleConfiguration service method, as returned by S3. - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - Container for the necessary parameters to execute the PutLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutLifecycleConfiguration service method, as returned by S3. - - - - - - - - - - - - - - - - - Configuration for accessing AmazonS3 service - - - Configuration for accessing Amazon S3 service - - - - - When true, requests will always use path style addressing. - - - - - Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. - To use this feature, the bucket name should be DNS compliant names and should not contain periods (.). - The following APIs are not supported and are sent to the regular region endpoint, even if this option is enabled: -
    -
  1. PutBucket
    2. -
  2. ListBuckets
    3. -
  3. DeleteBucket
    4. -
- - - This option cannot be used at the same time as UseDualstackEndpoint. - - - - - If set to true and the service package supports it the region identified in the arn for a resource - will be used when making the service request. - - - - - USEast1RegionalEndpointValue determines wheter or not - to send the us-east-1 s3 requests to the regional endpoint or to - the legacy global endpoint. - This flags takes precedence over the AWS_S3_US_EAST_1_REGIONAL_ENDPOINT - environment variable and the credential file. - - - - - This method contains custom initializations for the config object. - - - - - Given this client configuration, returns the service url - - The service url in the form of a string - - - - If the client is configured to hit us-east-1 with the S3UsEast1RegionalEndpointValue flag not set, - this method checks whether the environment variable is present or the credential file contains a valid value - - A Nullable of S3UsEast1RegionalEndpointValue representing the client configuration for the regional us-east-1 endpoint - - - - Validate that the config object is properly configured. - - - - - Checks the AWS_S3_US_EAST_1_REGIONAL_ENDPOINT environment variable for the presence of the s3 regional flag - - A nullable of S3UsEast1RegionalEndpointValue - - - - Checks the credential file for the presence of the s3 regional flag - - A nullable of S3UsEast1RegionalEndpointValue - - - - Default constructor - - - - - The constant used to lookup in the region hash the endpoint. - - - - - Gets the ServiceVersion property. - - - - - Gets the value of UserAgent property. - - - - - Base exception for S3 errors. - - - - - Construct an instance of AmazonS3Exception - - - - - - Construct an instance of AmazonS3Exception - - - - - - - Construct an instance of AmazonS3Exception - - - - - - Construct an instance of AmazonS3Exception - - - - - - - - - - Construct an instance of AmazonS3Exception - - - - - - - - - - - Construct an instance of AmazonS3Exception - - - - - - - - - - - - Construct an instance of AmazonS3Exception - - - - - - - - - - - - - A special token that helps AWS troubleshoot problems. - - - - - A special token that helps AWS troubleshoot S3 accelerate problems. - - - - - The entire response body for this exception, if available. - - - - - The region that the AmazonS3Exception relates to. - - - - - Gets the exception message. - - - - - Extensions methods added to Amazon.Arn type to help parse S3 specific resources from the ARN. - - - - - Attempt to parse the resource component of the ARN into access point resource name. - - An AWS ARN to parse - The access point resouce identifier found in the ARN. - True if the ARN contains an access point resource identifier. - - - - Attempt to parse the resource component of the ARN into bucket name. - - An AWS ARN to parse - The bucket name found in the ARN. - True if the ARN contains a bucket name. - - - - This class extends the AmazonS3Client and provides client side encryption when reading or writing S3 objects. - - - - - Constructs AmazonS3EncryptionClient with the Encryption materials and credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Constructs AmazonS3EncryptionClient with the Encryption materials and credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - - The region to connect. - - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Constructs AmazonS3EncryptionClient with the Encryption materials, - AmazonS3 CryptoConfiguration object and credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - - The AmazonS3EncryptionClient CryptoConfiguration Object - - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Constructs AmazonS3EncryptionClient with AWS Credentials and Encryption materials. - - - The encryption materials to be used to encrypt and decrypt envelope key. - - AWS Credentials - - - - Constructs AmazonS3EncryptionClient with AWS Credentials, Region and Encryption materials - - AWS Credentials - The region to connect. - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Constructs AmazonS3EncryptionClient with AWS Credentials, AmazonS3CryptoConfiguration Configuration object - and Encryption materials - - AWS Credentials - The AmazonS3EncryptionClient CryptoConfiguration Object - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Constructs AmazonS3EncryptionClient with AWS Access Key ID, - AWS Secret Key and Encryption materials - - AWS Access Key ID - AWS Secret Access Key - The encryption materials to be used to encrypt and decrypt envelope key. - - - - Constructs AmazonS3EncryptionClient with AWS Access Key ID, - AWS Secret Key, Region and Encryption materials - - AWS Access Key ID - AWS Secret Access Key - The region to connect. - The encryption materials to be used to encrypt and decrypt envelope key. - - - - Constructs AmazonS3EncryptionClient with AWS Access Key ID, Secret Key, - AmazonS3 CryptoConfiguration object and Encryption materials. - - AWS Access Key ID - AWS Secret Access Key - The AmazonS3EncryptionClient CryptoConfiguration Object - The encryption materials to be used to encrypt and decrypt envelope key. - - - - Constructs AmazonS3EncryptionClient with AWS Access Key ID, Secret Key, - SessionToken and Encryption materials. - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Constructs AmazonS3EncryptionClient with AWS Access Key ID, Secret Key, - SessionToken, Region and Encryption materials. - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - The region to connect. - The encryption materials to be used to encrypt and decrypt envelope key. - - - - Constructs AmazonS3EncryptionClient with AWS Access Key ID, Secret Key, SessionToken - AmazonS3EncryptionClient CryptoConfiguration object and Encryption materials. - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - The AmazonS3EncryptionClient CryptoConfiguration Object - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Turn off response logging because it will interfere with decrypt of the data coming back from S3. - - - - - Customize the pipeline to allow encryption. - - - - - - Dispose this instance - - - - - - AmazonS3CryptoConfiguration allows customers - to set storage mode for encryption credentials - - - - - Default Constructor. - - - - - Gets and sets the StorageMode property. This determines if the crypto metadata is stored as metadata on the object or as a separate object in S3. - The default is ObjectMetadata. - - - - - Mode for string the encryption information for an object. - - - - - Store the information in a separate S3 Object. - - - - - Store the information as metadata on the encrypted object. - - - - - Encryption Instructions store the encryption credentials - - - - - Construct an instance EncryptionInstructions. - - - - - - - - - Construct an instance EncryptionInstructions. - - - - - - - - The "key encrypting key" materials used in encrypt/decryption. - These materials may be an asymmetric key, a symmetric key, or a KMS key ID. - - - - - Constructs a new EncryptionMaterials object, storing an asymmetric key. - - - - - - Constructs a new EncryptionMaterials object, storing a symmetric key. - - - - - - Constructs a new EncryptionMaterials object, storing a KMS Key ID - - - - - - The EncryptionUtils class encrypts and decrypts data stored in S3. - It can be used to prepare requests for encryption before they are stored in S3 - and to decrypt objects that are retrieved from S3. - - - - - Decrypts an encrypted Envelope key using the provided encryption materials - and returns it in raw byte array form. - - Encrypted envelope key - Encryption materials needed to decrypt the encrypted envlelope key - - - - - Returns an updated stream where the stream contains the encrypted object contents. - The specified instruction will be used to encrypt data. - - - The stream whose contents are to be encrypted. - - - The instruction that will be used to encrypt the object data. - - - Encrypted stream, i.e input stream wrapped into encrypted stream - - - - - Returns an updated input stream where the input stream contains the encrypted object contents. - The specified instruction will be used to encrypt data. - - - The stream whose contents are to be encrypted. - - - The instruction that will be used to encrypt the object data. - - - Encrypted stream, i.e input stream wrapped into encrypted stream - - - - - Updates object where the object - input stream contains the decrypted contents. - - - The getObject response whose contents are to be decrypted. - - - The instruction that will be used to encrypt the object data. - - - - - Generates an instruction that will be used to encrypt an object - using materials with the KMSKeyID set. - - - Used to call KMS to generate a data key. - - - The encryption materials to be used to encrypt and decrypt data. - - - The instruction that will be used to encrypt an object. - - - - - Generates an instruction that will be used to encrypt an object - using materials with the KMSKeyID set. - - - Used to call KMS to generate a data key. - - - The encryption materials to be used to encrypt and decrypt data. - - - The instruction that will be used to encrypt an object. - - - - - Generates an instruction that will be used to encrypt an object - using materials with the AsymmetricProvider or SymmetricProvider set. - - - The encryption materials to be used to encrypt and decrypt data. - - - The instruction that will be used to encrypt an object. - - - - - Builds an instruction object from the object metadata. - - - A non-null object response that contains encryption information in its metadata. - - - The non-null encryption materials to be used to encrypt and decrypt Envelope key. - - - The decrypted envelope key to be use if KMS key wrapping is being used. Or null if non-KMS key wrapping is being used. - - - - - - - Builds an instruction object from the instruction file. - - Instruction file GetObject response - - The non-null encryption materials to be used to encrypt and decrypt Envelope key. - - - A non-null instruction object containing encryption information. - - - - - Update the request's ObjectMetadata with the necessary information for decrypting the object. - - - AmazonWebServiceRequest encrypted using the given instruction - - - Non-null instruction used to encrypt the data in this AmazonWebServiceRequest . - - - If true use V2 metadata format, otherwise use V1. - - - - - Adds UnEncrypted content length to object metadata - - - - - - checks if encryption credentials are in object metadata - - Response of the object - - - - - checks if encryption credentials are in the instructionfile - - Instruction file response that contains encryption information - - - - - Custom the pipeline handler to decrypt objects. - - - - - Construct instance of SetupDecryptionHandler. - - - - - - Gets the EncryptionClient property which is the AmazonS3EncryptionClient that is decrypting the object. - - - - - Calls the post invoke logic after calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Decrypt the object being downloaded. - - - - - - Calls the and post invoke logic after calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Decrypt the object being downloaded. - - - - - - Decrypt the object being downloaded. - - - - - - - Updates object where the object input stream contains the decrypted contents. - - - The getObject response of InstructionFile. - - - The getObject response whose contents are to be decrypted. - - - - - Updates object where the object input stream contains the decrypted contents. - - - The getObject response whose contents are to be decrypted. - - - The decrypted envelope key to be use if KMS key wrapping is being used. Or null if non-KMS key wrapping is being used. - - - - - Custom pipeline handler to encrypt the data as it is being uploaded to S3. - - - - - Construct an instance SetupEncryptionHandler. - - - - - - Gets the EncryptionClient property which is the AmazonS3EncryptionClient that is encrypting the object. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Encrypts the S3 object being uploaded. - - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Encrypts the S3 object being uploaded. - - - - - - Make sure that the storage mode and encryption materials are compatible. - The client only supports KMS key wrapping in metadata storage mode. - - - - - Updates the request where the metadata contains encryption information - and the input stream contains the encrypted object contents. - - - The request whose contents are to be encrypted. - - - - - Updates the request where the instruction file contains encryption information - and the input stream contains the encrypted object contents. - - - - - - Updates the request where the input stream contains the encrypted object contents. - - - - - - Adds the crypto token to the user agent - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Customize the user agent. - - - - - - Interface for accessing S3 - - - - - - - Create a signed URL allowing access to a resource that would - usually require authentication. - - - - When using query string authentication you create a query, - specify an expiration time for the query, sign it with your - signature, place the data in an HTTP request, and distribute - the request to a user or embed the request in a web page. - - - A PreSigned URL can be generated for GET, PUT, DELETE and HEAD - operations on your bucketName, keys, and versions. - - - The GetPreSignedUrlRequest that defines the - parameters of the operation. - A string that is the signed http request. - - - - - - This operation aborts a multipart upload. After a multipart upload is aborted, no - additional parts can be uploaded using that upload ID. The storage consumed by any - previously uploaded parts will be freed. However, if any part uploads are currently - in progress, those part uploads might or might not succeed. As a result, it might - be necessary to abort a given multipart upload multiple times in order to completely - free all storage consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts operation and ensure that the parts - list is empty. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - The bucket name to which the upload was taking place. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object for which the multipart upload was initiated. - Upload ID that identifies the multipart upload. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AbortMultipartUpload service method, as returned by S3. - - - - This operation aborts a multipart upload. After a multipart upload is aborted, no - additional parts can be uploaded using that upload ID. The storage consumed by any - previously uploaded parts will be freed. However, if any part uploads are currently - in progress, those part uploads might or might not succeed. As a result, it might - be necessary to abort a given multipart upload multiple times in order to completely - free all storage consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts operation and ensure that the parts - list is empty. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - Container for the necessary parameters to execute the AbortMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AbortMultipartUpload service method, as returned by S3. - - - - Completes a multipart upload by assembling previously uploaded parts. - - - - You first initiate the multipart upload and then upload all parts using the UploadPart - operation. After successfully uploading all relevant parts of an upload, you call - this operation to complete the upload. Upon receiving this request, Amazon S3 concatenates - all the parts in ascending order by part number to create a new object. In the Complete - Multipart Upload request, you must provide the parts list. You must ensure that the - parts list is complete. This operation concatenates the parts that you provide in - the list. For each part in the list, you must provide the part number and the ETag - value, returned after that part was uploaded. - - - - Processing of a Complete Multipart Upload request could take several minutes to complete. - After Amazon S3 begins processing the request, it sends an HTTP response header that - specifies a 200 OK response. While processing is in progress, Amazon S3 periodically - sends white space characters to keep the connection from timing out. Because a request - could fail after the initial 200 OK response has been sent, it is important that you - check the response body to determine whether the request succeeded. - - - - Note that if CompleteMultipartUpload fails, applications should be prepared - to retry the failed requests. For more information, see Amazon - S3 Error Best Practices. - - - - For more information about multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - GetBucketLifecycle has the following special errors: - -
  • - - Error code: EntityTooSmall - -
    • - - Description: Your proposed upload is smaller than the minimum allowed object size. - Each part must be at least 5 MB in size, except the last part. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPart - -
    • - - Description: One or more of the specified parts could not be found. The part might - not have been uploaded, or the specified entity tag might not have matched the part's - entity tag. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPartOrder - -
    • - - Description: The list of parts was not in ascending order. The parts list must be - specified in order by part number. - -
    • - - 400 Bad Request - -
  • - - Error code: NoSuchUpload - -
    • - - Description: The specified multipart upload does not exist. The upload ID might be - invalid, or the multipart upload might have been aborted or completed. - -
    • - - 404 Not Found - -
- - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the CompleteMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CompleteMultipartUpload service method, as returned by S3. - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - for copying an object greater than 5 GB, you must use the multipart upload Upload - Part - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - Amazon S3 transfer acceleration does not support cross-region copies. If you request - a cross-region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information about transfer acceleration, see Transfer - Acceleration. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - request parameters x-amz-copy-source-if-match, x-amz-copy-source-if-none-match, - x-amz-copy-source-if-unmodified-since, or x-amz-copy-source-if-modified-since. - - - - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - You can use this operation to change the storage class of an object that is already - stored in Amazon S3 using the StorageClass parameter. For more information, - see Storage - Classes. - - - - The source object that you are copying can be encrypted or unencrypted. If the source - object is encrypted, it can be encrypted by server-side encryption using AWS managed - encryption keys or by using a customer-provided encryption key. When copying an object, - you can request that Amazon S3 encrypt the target object by using either the AWS managed - encryption keys or by using your own encryption key. You can do this regardless of - the form of server-side encryption that was used to encrypt the source, or even if - the source object was not encrypted. For more information about server-side encryption, - see Using - Server-Side Encryption. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
    • - - x-amz-copy-source-if-match condition evaluates to true - -
    • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
  • - - Consideration 2 – If both of the x-amz-copy-source-if-none-match and - x-amz-copy-source-if-modified-since headers are present in the request - and evaluate as follows, Amazon S3 returns the 412 Precondition Failed - response code: - -
    • - - x-amz-copy-source-if-none-match condition evaluates to false - -
    • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - The copy request charge is based on the storage class and Region you specify for the - destination object. For pricing information, see Amazon - S3 Pricing. - - - - Following are other considerations when using CopyObject: - -
Versioning
- - By default, x-amz-copy-source identifies the current version of an object - to copy. (If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted.) To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - To encrypt the target object, you must provide the appropriate encryption-related - request headers. The one you use depends on whether you want to use AWS managed encryption - keys or provide your own encryption key. - -
  • - - To encrypt the target object using server-side encryption with an AWS managed encryption - key, provide the following request headers, as appropriate. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. If you want to use a customer managed AWS KMS - CMK, you must provide the x-amz-server-side-encryption-aws-kms-key-id - of the symmetric customer managed CMK. Amazon S3 only supports symmetric CMKs and - not asymmetric CMKs. For more information, see Using - Symmetric and Asymmetric Keys in the AWS Key Management Service Developer Guide. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in KMS. - -
  • - - To encrypt the target object using server-side encryption with an encryption key that - you provide, use the following headers. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
  • - - If the source object is encrypted using server-side encryption with customer-provided - encryption keys, you must use the following headers. - -
    • - - x-amz-copy-source​-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-copy-source​-server-side​-encryption​-customer-key - -
    • - - x-amz-copy-source-​server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in Amazon KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - for copying an object greater than 5 GB, you must use the multipart upload Upload - Part - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - Amazon S3 transfer acceleration does not support cross-region copies. If you request - a cross-region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information about transfer acceleration, see Transfer - Acceleration. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - request parameters x-amz-copy-source-if-match, x-amz-copy-source-if-none-match, - x-amz-copy-source-if-unmodified-since, or x-amz-copy-source-if-modified-since. - - - - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - You can use this operation to change the storage class of an object that is already - stored in Amazon S3 using the StorageClass parameter. For more information, - see Storage - Classes. - - - - The source object that you are copying can be encrypted or unencrypted. If the source - object is encrypted, it can be encrypted by server-side encryption using AWS managed - encryption keys or by using a customer-provided encryption key. When copying an object, - you can request that Amazon S3 encrypt the target object by using either the AWS managed - encryption keys or by using your own encryption key. You can do this regardless of - the form of server-side encryption that was used to encrypt the source, or even if - the source object was not encrypted. For more information about server-side encryption, - see Using - Server-Side Encryption. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
    • - - x-amz-copy-source-if-match condition evaluates to true - -
    • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
  • - - Consideration 2 – If both of the x-amz-copy-source-if-none-match and - x-amz-copy-source-if-modified-since headers are present in the request - and evaluate as follows, Amazon S3 returns the 412 Precondition Failed - response code: - -
    • - - x-amz-copy-source-if-none-match condition evaluates to false - -
    • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - The copy request charge is based on the storage class and Region you specify for the - destination object. For pricing information, see Amazon - S3 Pricing. - - - - Following are other considerations when using CopyObject: - -
Versioning
- - By default, x-amz-copy-source identifies the current version of an object - to copy. (If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted.) To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - To encrypt the target object, you must provide the appropriate encryption-related - request headers. The one you use depends on whether you want to use AWS managed encryption - keys or provide your own encryption key. - -
  • - - To encrypt the target object using server-side encryption with an AWS managed encryption - key, provide the following request headers, as appropriate. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. If you want to use a customer managed AWS KMS - CMK, you must provide the x-amz-server-side-encryption-aws-kms-key-id - of the symmetric customer managed CMK. Amazon S3 only supports symmetric CMKs and - not asymmetric CMKs. For more information, see Using - Symmetric and Asymmetric Keys in the AWS Key Management Service Developer Guide. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in KMS. - -
  • - - To encrypt the target object using server-side encryption with an encryption key that - you provide, use the following headers. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
  • - - If the source object is encrypted using server-side encryption with customer-provided - encryption keys, you must use the following headers. - -
    • - - x-amz-copy-source​-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-copy-source​-server-side​-encryption​-customer-key - -
    • - - x-amz-copy-source-​server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in Amazon KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - for copying an object greater than 5 GB, you must use the multipart upload Upload - Part - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - Amazon S3 transfer acceleration does not support cross-region copies. If you request - a cross-region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information about transfer acceleration, see Transfer - Acceleration. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - request parameters x-amz-copy-source-if-match, x-amz-copy-source-if-none-match, - x-amz-copy-source-if-unmodified-since, or x-amz-copy-source-if-modified-since. - - - - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - You can use this operation to change the storage class of an object that is already - stored in Amazon S3 using the StorageClass parameter. For more information, - see Storage - Classes. - - - - The source object that you are copying can be encrypted or unencrypted. If the source - object is encrypted, it can be encrypted by server-side encryption using AWS managed - encryption keys or by using a customer-provided encryption key. When copying an object, - you can request that Amazon S3 encrypt the target object by using either the AWS managed - encryption keys or by using your own encryption key. You can do this regardless of - the form of server-side encryption that was used to encrypt the source, or even if - the source object was not encrypted. For more information about server-side encryption, - see Using - Server-Side Encryption. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
    • - - x-amz-copy-source-if-match condition evaluates to true - -
    • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
  • - - Consideration 2 – If both of the x-amz-copy-source-if-none-match and - x-amz-copy-source-if-modified-since headers are present in the request - and evaluate as follows, Amazon S3 returns the 412 Precondition Failed - response code: - -
    • - - x-amz-copy-source-if-none-match condition evaluates to false - -
    • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - The copy request charge is based on the storage class and Region you specify for the - destination object. For pricing information, see Amazon - S3 Pricing. - - - - Following are other considerations when using CopyObject: - -
Versioning
- - By default, x-amz-copy-source identifies the current version of an object - to copy. (If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted.) To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - To encrypt the target object, you must provide the appropriate encryption-related - request headers. The one you use depends on whether you want to use AWS managed encryption - keys or provide your own encryption key. - -
  • - - To encrypt the target object using server-side encryption with an AWS managed encryption - key, provide the following request headers, as appropriate. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. If you want to use a customer managed AWS KMS - CMK, you must provide the x-amz-server-side-encryption-aws-kms-key-id - of the symmetric customer managed CMK. Amazon S3 only supports symmetric CMKs and - not asymmetric CMKs. For more information, see Using - Symmetric and Asymmetric Keys in the AWS Key Management Service Developer Guide. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in KMS. - -
  • - - To encrypt the target object using server-side encryption with an encryption key that - you provide, use the following headers. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
  • - - If the source object is encrypted using server-side encryption with customer-provided - encryption keys, you must use the following headers. - -
    • - - x-amz-copy-source​-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-copy-source​-server-side​-encryption​-customer-key - -
    • - - x-amz-copy-source-​server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in Amazon KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - Container for the necessary parameters to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - - - - - - - - - Deletes an analytics configuration for the bucket (specified by the analytics configuration - ID). - - - - To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to DeleteBucketAnalyticsConfiguration: - -
  • - - - -
  • - - - -
  • - - - -
- - Container for the necessary parameters to execute the DeleteBucketAnalyticsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketAnalyticsConfiguration service method, as returned by S3. - - - - - Deletes an inventory configuration (identified by the inventory ID) from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - Operations related to DeleteBucketInventoryConfiguration include: - - - - Container for the necessary parameters to execute the DeleteBucketInventoryConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketInventoryConfiguration service method, as returned by S3. - - - - Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified - by the metrics configuration ID) from the bucket. Note that this doesn't include the - daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketMetricsConfiguration service method, as returned by S3. - - - - This implementation of the DELETE operation uses the policy subresource to delete - the policy of a specified bucket. If you are using an identity other than the root - user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - The bucket name. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketPolicy service method, as returned by S3. - - - - This implementation of the DELETE operation uses the policy subresource to delete - the policy of a specified bucket. If you are using an identity other than the root - user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - Container for the necessary parameters to execute the DeleteBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketPolicy service method, as returned by S3. - - - - Deletes the replication configuration from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutReplicationConfiguration - action. The bucket owner has these permissions by default and can grant it to others. - For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - It can take a while for the deletion of a replication configuration to fully propagate. - - - - For information about replication configuration, see Replication - in the Amazon S3 Developer Guide. - - - - The following operations are related to DeleteBucketReplication: - - - - Container for the necessary parameters to execute the DeleteBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketReplication service method, as returned by S3. - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - The bucket that has the tag set to be removed. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketTagging service method, as returned by S3. - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - Container for the necessary parameters to execute the DeleteBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketTagging service method, as returned by S3. - - - - This operation removes the website configuration for a bucket. Amazon S3 returns a - 200 OK response upon successfully deleting a website configuration on - the specified bucket. You will get a 200 OK response if the website configuration - you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE operation requires the S3:DeleteBucketWebsite permission. - By default, only the bucket owner can delete the website configuration attached to - a bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which you want to remove the website configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketWebsite service method, as returned by S3. - - - - This operation removes the website configuration for a bucket. Amazon S3 returns a - 200 OK response upon successfully deleting a website configuration on - the specified bucket. You will get a 200 OK response if the website configuration - you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE operation requires the S3:DeleteBucketWebsite permission. - By default, only the bucket owner can delete the website configuration attached to - a bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the DeleteBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketWebsite service method, as returned by S3. - - - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - The bucket name of the lifecycle to delete. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - Container for the necessary parameters to execute the DeleteLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key name of the object to delete. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key name of the object to delete. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - Container for the necessary parameters to execute the DeleteObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - - - - This operation enables you to delete multiple objects from a bucket using a single - HTTP request. If you know the object keys that you want to delete, then this operation - provides a suitable alternative to sending individual delete requests, reducing per-request - overhead. - - - - The request contains a list of up to 1000 keys that you want to delete. In the XML, - you provide the object key names, and optionally, version IDs if you want to delete - a specific version of the object from a versioning-enabled bucket. For each key, Amazon - S3 performs a delete operation and returns the result of that delete, success, or - failure, in the response. Note that if the object specified in the request is not - found, Amazon S3 returns the result as deleted. - - - - The operation supports two modes for the response: verbose and quiet. By default, - the operation uses verbose mode in which the response includes the result of deletion - of each key in your request. In quiet mode the response includes only keys where the - delete operation encountered an error. For a successful deletion, the operation does - not return any information about the delete in the response body. - - - - When performing this operation on an MFA Delete enabled bucket, that attempts to delete - any versioned objects, you must include an MFA token. If you do not provide one, the - entire request will fail, even if there are non-versioned objects you are trying to - delete. If you provide an invalid token, whether there are versioned keys in the request - or not, the entire Multi-Object Delete request will fail. For information about MFA - Delete, see - MFA Delete. - - - - Finally, the Content-MD5 header is required for all Multi-Object Delete requests. - Amazon S3 uses the header value to ensure that your request body has not been altered - in transit. - - - - The following operations are related to DeleteObjects: - - - - Container for the necessary parameters to execute the DeleteObjects service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObjects service method, as returned by S3. - - - - Removes the entire tag set from the specified object. For more information about managing - object tags, see - Object Tagging. - - - - To use this operation, you must have permission to perform the s3:DeleteObjectTagging - action. - - - - To delete tags of a specific object version, add the versionId query - parameter in the request. You will need permission for the s3:DeleteObjectVersionTagging - action. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteObjectTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObjectTagging service method, as returned by S3. - - - - Removes the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:PutBucketPublicAccessBlock - permission. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeletePublicAccessBlock service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeletePublicAccessBlock service method, as returned by S3. - - - - - - - - - Returns the default encryption configuration for an Amazon S3 bucket. For information - about the Amazon S3 default encryption feature, see Amazon - S3 Default Bucket Encryption. - - - - To use this operation, you must have permission to perform the s3:GetEncryptionConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to GetBucketEncryption: - - - - Container for the necessary parameters to execute the GetBucketEncryption service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketEncryption service method, as returned by S3. - - - - Returns an inventory configuration (identified by the inventory configuration ID) - from the bucket. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - The following operations are related to GetBucketInventoryConfiguration: - - - - Container for the necessary parameters to execute the GetBucketInventoryConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketInventoryConfiguration service method, as returned by S3. - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - The name of the bucket for which to get the location. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLocation service method, as returned by S3. - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - Container for the necessary parameters to execute the GetBucketLocation service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLocation service method, as returned by S3. - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - The bucket name for which to get the logging information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLogging service method, as returned by S3. - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - Container for the necessary parameters to execute the GetBucketLogging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLogging service method, as returned by S3. - - - - Gets a metrics configuration (specified by the metrics configuration ID) from the - bucket. Note that this doesn't include the daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to GetBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the GetBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketMetricsConfiguration service method, as returned by S3. - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following operation is related to GetBucketNotification: - - - - Name of the bucket for which to get the notification configuration - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketNotification service method, as returned by S3. - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following operation is related to GetBucketNotification: - - - - Container for the necessary parameters to execute the GetBucketNotification service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketNotification service method, as returned by S3. - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operation is related to GetBucketPolicy: - - - - The bucket name for which to get the bucket policy. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicy service method, as returned by S3. - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operation is related to GetBucketPolicy: - - - - Container for the necessary parameters to execute the GetBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicy service method, as returned by S3. - - - - Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket - is public. In order to use this operation, you must have the s3:GetBucketPolicyStatus - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - For more information about when Amazon S3 considers a bucket public, see The - Meaning of "Public". - - - - The following operations are related to GetBucketPolicyStatus: - - - - Container for the necessary parameters to execute the GetBucketPolicyStatus service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicyStatus service method, as returned by S3. - - - - Retrieves the replication configuration for the given Amazon S3 bucket. - - Container for the necessary parameters to execute the GetBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketReplication service method, as returned by S3. - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - The name of the bucket for which to get the payment request configuration - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketRequestPayment service method, as returned by S3. - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - Container for the necessary parameters to execute the GetBucketRequestPayment service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketRequestPayment service method, as returned by S3. - - - - Returns the tag set associated with the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - GetBucketTagging has the following special error: - -
  • - - Error code: NoSuchTagSetError - -
    • - - Description: There is no tag set associated with the bucket. - -
- - The following operations are related to GetBucketTagging: - - - - Container for the necessary parameters to execute the GetBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketTagging service method, as returned by S3. - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - The name of the bucket for which to get the versioning information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketVersioning service method, as returned by S3. - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - Container for the necessary parameters to execute the GetBucketVersioning service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketVersioning service method, as returned by S3. - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET operation requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which to get the website configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketWebsite service method, as returned by S3. - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET operation requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the GetBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketWebsite service method, as returned by S3. - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - The bucket name for which to get the cors configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetCORSConfiguration service method, as returned by S3. - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - Container for the necessary parameters to execute the GetCORSConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetCORSConfiguration service method, as returned by S3. - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are still using previous version of the lifecycle configuration, it works. - For the earlier API description, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to DeleteBucketMetricsConfiguration: - - - - The name of the bucket for which to get the lifecycle information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetLifecycleConfiguration service method, as returned by S3. - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are still using previous version of the lifecycle configuration, it works. - For the earlier API description, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the GetLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetLifecycleConfiguration service method, as returned by S3. - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object to get. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object to get. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - Container for the necessary parameters to execute the GetObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - - - - Gets an object's current Legal Hold status. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLegalHold service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectLegalHold service method, as returned by S3. - - - - Gets the Object Lock configuration for a bucket. The rule specified in the Object - Lock configuration will be applied by default to every new object placed in the specified - bucket. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLockConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectLockConfiguration service method, as returned by S3. - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - The name of the bucket containing the object. - The object key. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - The name of the bucket containing the object. - The object key. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - Container for the necessary parameters to execute the GetObjectMetadata service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - - - - Retrieves an object's retention settings. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectRetention service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectRetention service method, as returned by S3. - - - - Returns the tag-set of an object. You send the GET request against the tagging subresource - associated with the object. - - - - To use this operation, you must have permission to perform the s3:GetObjectTagging - action. By default, the GET operation returns information about current version of - an object. For a versioned bucket, you can have multiple versions of an object in - your bucket. To retrieve tags of any other version, use the versionId query parameter. - You also need permission for the s3:GetObjectVersionTagging action. - - - - By default, the bucket owner has this permission and can grant this permission to - others. - - - - For information about the Amazon S3 object tagging feature, see Object - Tagging. - - - - The following operation is related to GetObjectTagging: - - - - Container for the necessary parameters to execute the GetObjectTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTagging service method, as returned by S3. - - - - Return torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Amazon - S3 Torrent. - - - - You can get torrent only for objects that are less than 5 GB in size and that are - not encrypted using server-side encryption with customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - The following operation is related to GetObjectTorrent: - - - - The name of the bucket containing the object for which to get the torrent files. - The object key for which to get the information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTorrent service method, as returned by S3. - - - - Return torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Amazon - S3 Torrent. - - - - You can get torrent only for objects that are less than 5 GB in size and that are - not encrypted using server-side encryption with customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - The following operation is related to GetObjectTorrent: - - - - Container for the necessary parameters to execute the GetObjectTorrent service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTorrent service method, as returned by S3. - - - - Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:GetBucketPublicAccessBlock - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket - or an object, it checks the PublicAccessBlock configuration for both - the bucket (or the bucket that contains the object) and the bucket owner's account. - If the PublicAccessBlock settings are different between the bucket and - the account, Amazon S3 uses the most restrictive combination of the bucket-level and - account-level settings. - - - - For more information about when Amazon S3 considers a bucket or an object public, - see The - Meaning of "Public". - - - - The following operations are related to GetPublicAccessBlock: - - - - Container for the necessary parameters to execute the GetPublicAccessBlock service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetPublicAccessBlock service method, as returned by S3. - - - - This operation initiates a multipart upload and returns an upload ID. This upload - ID is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort operation - and Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload API and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart) and UploadPartCopy) requests must match the headers you - used in the request to initiate the upload by using CreateMultipartUpload. - - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, - kms:GenerateDataKey*, and kms:DescribeKey actions on the - key. These permissions are required because Amazon S3 must decrypt and read data from - the encrypted file parts before it completes the multipart upload. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - The following operations are related to CreateMultipartUpload: - - - - The name of the bucket to which to initiate the upload - Object key for which the multipart upload is to be initiated. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the InitiateMultipartUpload service method, as returned by S3. - - - - This operation initiates a multipart upload and returns an upload ID. This upload - ID is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort operation - and Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload API and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart) and UploadPartCopy) requests must match the headers you - used in the request to initiate the upload by using CreateMultipartUpload. - - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, - kms:GenerateDataKey*, and kms:DescribeKey actions on the - key. These permissions are required because Amazon S3 must decrypt and read data from - the encrypted file parts before it completes the multipart upload. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - The following operations are related to CreateMultipartUpload: - - - - Container for the necessary parameters to execute the InitiateMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the InitiateMultipartUpload service method, as returned by S3. - - - - Lists the analytics configurations for the bucket. You can have up to 1,000 analytics - configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. You should always check the IsTruncated element in the response. - If there are no more configurations to list, IsTruncated is set to false. - If there are more configurations to list, IsTruncated is set to true, - and there will be a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to ListBucketAnalyticsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketAnalyticsConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketAnalyticsConfigurations service method, as returned by S3. - - - - Returns a list of inventory configurations for the bucket. You can have up to 1,000 - analytics configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory - - - - The following operations are related to ListBucketInventoryConfigurations: - - - - Container for the necessary parameters to execute the ListBucketInventoryConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketInventoryConfigurations service method, as returned by S3. - - - - Lists the metrics configurations for the bucket. The metrics configurations are only - for the request metrics of the bucket and do not provide information on daily storage - metrics. You can have up to 1,000 configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For more information about metrics configurations and CloudWatch request metrics, - see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to ListBucketMetricsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketMetricsConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketMetricsConfigurations service method, as returned by S3. - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBuckets service method, as returned by S3. - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - Container for the necessary parameters to execute the ListBuckets service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBuckets service method, as returned by S3. - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Container for the necessary parameters to execute the ListMultipartUploads service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. - Limits the response to keys that begin with the specified prefix. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - Container for the necessary parameters to execute the ListObjects service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Make sure to design - your application to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - To use this operation in an AWS Identity and Access Management (IAM) policy, you must - have permissions to perform the s3:ListBucket action. The bucket owner - has this permission by default and can grant this permission to others. For more information - about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - This section describes the latest revision of the API. We recommend that you use this - revised API for application development. For backward compatibility, Amazon S3 continues - to support the prior version of this API, ListObjects. - - - - To get a list of your buckets, see ListBuckets. - - - - The following operations are related to ListObjectsV2: - - - - Container for the necessary parameters to execute the ListObjectsV2 service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjectsV2 service method, as returned by S3. - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). This request returns a maximum of 1,000 - uploaded parts. The default number of parts returned is 1,000 parts. You can restrict - the number of parts returned by specifying the max-parts request parameter. - If your multipart upload consists of more than 1,000 parts, the response returns an - IsTruncated field with the value of true, and a NextPartNumberMarker - element. In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListParts: - - - - Name of the bucket to which the parts are being uploaded. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Object key for which the multipart upload was initiated. - Upload ID identifying the multipart upload whose parts are being listed. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListParts service method, as returned by S3. - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). This request returns a maximum of 1,000 - uploaded parts. The default number of parts returned is 1,000 parts. You can restrict - the number of parts returned by specifying the max-parts request parameter. - If your multipart upload consists of more than 1,000 parts, the response returns an - IsTruncated field with the value of true, and a NextPartNumberMarker - element. In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListParts: - - - - Container for the necessary parameters to execute the ListParts service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListParts service method, as returned by S3. - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - Container for the necessary parameters to execute the ListVersions service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - - - - - Creates a new bucket. To create a bucket, you must register with Amazon S3 and have - a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed - to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information on bucket naming restrictions, - see Working - with Amazon S3 Buckets. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the EU (Ireland) - Region. For more information, see How - to Select a Region for Your Buckets. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - Hosting of Buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - The name of the bucket to create. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucket service method, as returned by S3. - - - - Creates a new bucket. To create a bucket, you must register with Amazon S3 and have - a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed - to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information on bucket naming restrictions, - see Working - with Amazon S3 Buckets. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the EU (Ireland) - Region. For more information, see How - to Select a Region for Your Buckets. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - Hosting of Buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - Container for the necessary parameters to execute the PutBucket service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucket service method, as returned by S3. - - - - Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration - is a bucket-level feature that enables you to perform faster data transfers to Amazon - S3. - - - - To use this operation, you must have permission to perform the s3:PutAccelerateConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The Transfer Acceleration state of a bucket can be set to one of the following two - values: - -
  • - - Enabled – Enables accelerated data transfers to the bucket. - -
  • - - Suspended – Disables accelerated data transfers to the bucket. - -
- - The GetBucketAccelerateConfiguration operation returns the transfer acceleration - state of a bucket. - - - - After setting the Transfer Acceleration state of a bucket to Enabled, it might take - up to thirty minutes before the data transfer rates to the bucket increase. - - - - The name of the bucket used for Transfer Acceleration must be DNS-compliant and must - not contain periods ("."). - - - - For more information about transfer acceleration, see Transfer - Acceleration. - - - - The following operations are related to PutBucketAccelerateConfiguration: - - - - Container for the necessary parameters to execute the PutBucketAccelerateConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketAccelerateConfiguration service method, as returned by S3. - - - - - - - Set the logging parameters for a bucket and to specify permissions for who can view - and modify the logging parameters. All logs are saved to buckets in the same AWS Region - as the source bucket. To set the logging status of a bucket, you must be the bucket - owner. - - - - The bucket owner is automatically granted FULL_CONTROL to all logs. You use the Grantee - request element to grant access to other people. The Permissions request - element specifies the kind of access the grantee has to the logs. - - - - Grantee Values - - - - You can specify the person (grantee) to whom you're assigning access rights (using - request elements) in the following ways: - -
  • - - By the person's ID: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> - </Grantee> - - - - DisplayName is optional and ignored in the request. - -
  • - - By Email address: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee> - - - - - The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl - request, appears as the CanonicalUser. - -
  • - - By URI: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee> - - -
- - To enable logging, you use LoggingEnabled and its children request elements. To disable - logging, you use an empty BucketLoggingStatus request element: - - - - <BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01" /> - - - - - For more information about server access logging, see Server - Access Logging. - - - - For more information about creating a bucket, see CreateBucket. For more information - about returning the logging status of a bucket, see GetBucketLogging. - - - - The following operations are related to PutBucketLogging: - - - - Container for the necessary parameters to execute the PutBucketLogging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketLogging service method, as returned by S3. - - - - Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. - You can have up to 1,000 metrics configurations per bucket. If you're updating an - existing metrics configuration, note that this is a full replacement of the existing - metrics configuration. If you don't include the elements you want to keep, they are - erased. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to PutBucketMetricsConfiguration: - - - - GetBucketLifecycle has the following special error: - -
  • - - Error code: TooManyConfigurations - -
    • - - Description: You are attempting to create a new configuration but have already reached - the 1,000-configuration limit. - -
    • - - HTTP Status Code: HTTP 400 Bad Request - -
- - Container for the necessary parameters to execute the PutBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketMetricsConfiguration service method, as returned by S3. - - - - Enables notifications of specified events for a bucket. For more information about - event notifications, see Configuring - Event Notifications. - - - - Using this API, you can replace an existing notification configuration. The configuration - is an XML file that defines the event types that you want Amazon S3 to publish and - the destination where you want Amazon S3 to publish an event notification when it - detects an event of the specified type. - - - - By default, your bucket has no event notifications configured. That is, the notification - configuration will be an empty NotificationConfiguration. - - - - <NotificationConfiguration> - - - - </NotificationConfiguration> - - - - This operation replaces the existing notification configuration with the configuration - you include in the request body. - - - - After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification - Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, - and that the bucket owner has permission to publish to it by sending a test notification. - In the case of AWS Lambda destinations, Amazon S3 verifies that the Lambda function - permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. - For more information, see Configuring - Notifications for Amazon S3 Events. - - - - You can disable notifications by adding the empty NotificationConfiguration element. - - - - By default, only the bucket owner can configure notifications on a bucket. However, - bucket owners can use a bucket policy to grant permission to other users to set this - configuration with s3:PutBucketNotification permission. - - - - The PUT notification is an atomic operation. For example, suppose your notification - configuration includes SNS topic, SQS queue, and Lambda function configurations. When - you send a PUT request with this configuration, Amazon S3 sends test messages to your - SNS topic. If the message fails, the entire PUT operation will fail, and Amazon S3 - will not add the configuration to your bucket. - - - - Responses - - - - If the configuration in the request body includes only one TopicConfiguration - specifying only the s3:ReducedRedundancyLostObject event type, the response - will also include the x-amz-sns-test-message-id header containing the - message ID of the test notification sent to the topic. - - - - The following operation is related to PutBucketNotificationConfiguration: - - - - Container for the necessary parameters to execute the PutBucketNotification service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketNotification service method, as returned by S3. - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - The MD5 hash of the request body. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - Container for the necessary parameters to execute the PutBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - - - - Creates a replication configuration or replaces an existing one. For more information, - see Replication - in the Amazon S3 Developer Guide. - - - - To perform this operation, the user or role performing the operation must have the - iam:PassRole - permission. - - - - Specify the replication configuration in the request body. In the replication configuration, - you provide the name of the destination bucket where you want Amazon S3 to replicate - objects, the IAM role that Amazon S3 can assume to replicate objects on your behalf, - and other relevant information. - - - - A replication configuration must include at least one rule, and can contain a maximum - of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects - in the source bucket. To choose additional subsets of objects to replicate, add a - rule for each subset. All rules must specify the same destination bucket. - - - - To specify a subset of the objects in the source bucket to apply a replication rule - to, add the Filter element as a child of the Rule element. You can filter objects - based on an object key prefix, one or more object tags, or both. When you add the - Filter element in the configuration, you must also add the following elements: DeleteMarkerReplication, - Status, and Priority. - - - - For information about enabling versioning on a bucket, see Using - Versioning. - - - - By default, a resource owner, in this case the AWS account that created the bucket, - can perform this operation. The resource owner can also grant others permissions to - perform the operation. For more information about permissions, see Specifying - Permissions in a Policy and Managing - Access Permissions to Your Amazon S3 Resources. - - - - Handling Replication of Encrypted Objects - - - - By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side - encryption with CMKs stored in AWS KMS. To replicate AWS KMS-encrypted objects, add - the following: SourceSelectionCriteria, SseKmsEncryptedObjects, - Status, EncryptionConfiguration, and ReplicaKmsKeyID. - For information about replication configuration, see Replicating - Objects Created with SSE Using CMKs stored in AWS KMS. - - - - For information on PutBucketReplication errors, see ReplicationErrorCodeList - - - - - The following operations are related to PutBucketReplication: - - - - Container for the necessary parameters to execute the PutBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketReplication service method, as returned by S3. - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - The bucket name. - Container for Payer. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketRequestPayment service method, as returned by S3. - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - Container for the necessary parameters to execute the PutBucketRequestPayment service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketRequestPayment service method, as returned by S3. - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging. - - - - Within a bucket, if you add a tag that has the same key as an existing tag, the new - value overwrites the old value. For more information, see Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional operation is currently in progress against - this resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - The bucket name. - A property of PutBucketTaggingRequest used to execute the PutBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketTagging service method, as returned by S3. - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging. - - - - Within a bucket, if you add a tag that has the same key as an existing tag, the new - value overwrites the old value. For more information, see Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional operation is currently in progress against - this resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - Container for the necessary parameters to execute the PutBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketTagging service method, as returned by S3. - - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT operation requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - The bucket name. - Container for the request. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketWebsite service method, as returned by S3. - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT operation requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - Container for the necessary parameters to execute the PutBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketWebsite service method, as returned by S3. - - - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - The name of the bucket for which to set the configuration. - A property of PutLifecycleConfigurationRequest used to execute the PutLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutLifecycleConfiguration service method, as returned by S3. - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - Container for the necessary parameters to execute the PutLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutLifecycleConfiguration service method, as returned by S3. - - - - - - - - - - - - - - - - - Custom pipeline handler to clean up streams in case of an exception. - - - - - Catch exceptions and clean up any open streams. - - - - - - Catch exceptions and clean up any open streams. - - - - - - - Custom pipeline handler to enable sig V4 for Get requests. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Custom pipeline handler to enable sig V4 for Get requests. - - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Calls the post invoke logic after calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls the and post invoke logic after calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Constructor for AmazonS3RetryPolicy. - - The IClientConfig object - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - - - a value if it can be determined, or null if the IO-bound calculations need to be done - - - - Return true if the request should be retried. Implements additional checks - specific to S3 on top of the checks in DefaultRetryPolicy. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Marker interface to identify AmazonS3EncryptionClient. - - - - - Service metadata for Amazon S3 service - - - - - Gets the value of the Service Id. - - - - - Gets the dictionary that gives mapping of renamed operations - - - - - The parameters to request an abort of a multipart upload. - - - After a multipart upload is aborted, no additional parts can be uploaded using that upload ID. - The storage consumed by any previously uploaded parts will be freed. However, if any part uploads - are currently in progress, those part uploads might or might not succeed. As a result, it might be - necessary to abort a given multipart upload multiple times in order to completely free all storage - consumed by all parts. - - - - - The bucket name to which the upload was taking place. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The key of the S3 object that was being uploaded. - - - - - The upload id for the in-progress multipart upload that should be aborted. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the AbortMultipartUpload response metadata. - The AbortMultipartUpload operation has a void result type. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Bucket accelerate configuration. - - - - - The accelerate status of the bucket. - - - - - AccessControlTranslation class - - - - - The override value for the owner of the replica object. - - - - - Class for AnalyticsAndOperator - A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. - The operator must have at least two predicates, and an object must match all of the predicates - in order for the filter to apply. - - Note: The current implementation restricts the usage to atmost one AnalyticsPrefixPredicate - and any number of AnalyticsTagPredicates. - - - - Class for AnalyticsConfiguration - - - - - The identifier used to represent an analytics configuration. - - - - - The filter used to describe a set of objects for analyses. - A filter must have exactly one prefix, one tag, or one conjunction (AnalyticsAndOperator). - If no filter is provided, all objects will be considered in any analysis. - - - - - If present, it indicates that data related to access patterns will be collected - and made available to analyze the tradeoffs between different storage classes. - - - - - Class for AnalyticsExportDestination - - - - - A destination signifying output to an S3 bucket. - - - - - Filter class for Metrics. - - - - - Filter Predicate setup for specific filter types. - - - - - Filter Predicate abstract class for specific filter types to be derived from. - - - - - Abstract class that can be used over logical filter predicates,i.e. AND/OR. - - - - - Internal implementation of Metrics Predicate visitor interface. - - - - - Interface for implementing visitor pattern in Analytics Predicate Filter. - - - - - Interface for implementing visitor pattern in Inventory Predicate Filter. - - - - - Interface for implementing visitor pattern in Metrics Predicate Filter. - - - - - Defines the interface that is used to visit all the different - implementations of - - - - - Visit a - - - - - - Visit a - - - - - - Visit a - - - - - - Implementation of to marshall . - - - - - AbortIncompleteMultipartUpload Unmarshaller - - - - - Abort Multipart Upload Request Marshaller - - - - - Response Unmarshaller for AbortMultipartUpload operation - - - - - AnalyticsConfiguration Unmarshaller - - - - - AnalyticsExportDestinationUnmarshaller - - - - - AnalyticsFilter Unmarshaller - - - - - AnalyticsS3BucketDestination Unmarshaller - - - - - Bucket Unmarshaller - - - - - CommonPrefixesItem Unmarshaller - - - - - Complete Multipart Upload Request Marshaller - - - - - Response Unmarshaller for CompleteMultipartUpload operation - - - - - ContentsItem Unmarshaller - - - - - Copy Object Request Marshaller - - - - - Response Unmarshaller for CopyObject operation - - - - - Upload Part Copy Request Marshaller - - - - - Response Unmarshaller for CopyPart operation - - - - - CORSRule Unmarshaller - - - - - Response Unmarshaller for DefaultRetention Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Delete InventoryConfiguration Request Marshaller - - - - - Response Unmarshaller for DeleteAnalyticsConfiguration operation - - - - - Response Unmarshaller for DeleteCORSConfiguration operation - - - - - Delete InventoryConfiguration Request Marshaller - - - - - Response Unmarshaller for DeleteInventoryConfiguration operation - - - - - Delete Bucket MetricsConfiguration Request Marshaller - - - - - Response Unmarshaller for DeleteBucketMetricsConfiguration operation - - - - - Delete Bucket Policy Request Marshaller - - - - - Response Unmarshaller for DeleteBucketPolicy operation - - - - - Delete Bucket Request Marshaller - - - - - Response Unmarshaller for DeleteBucket operation - - - - - Delete Bucket Tagging Request Marshaller - - - - - Response Unmarshaller for DeleteBucketTagging operation - - - - - Delete Bucket Website Request Marshaller - - - - - Response Unmarshaller for DeleteBucketWebsite operation - - - - - Delete Bucket Cors Request Marshaller - - - - - DeletedObject Unmarshaller - - - - - Delete Bucket Lifecycle Request Marshaller - - - - - Response Unmarshaller for DeleteBucketLifecycle operation - - - - - Delete Object Request Marshaller - - - - - Response Unmarshaller for DeleteObject operation - - - - - Delete Objects Request Marshaller - - - - - Response Unmarshaller for DeleteObjects operation - - - - - DeleteObjectTaggingRequest Marshaller - - - - - Marshall DeleteObjectTaggingRequest object into an http request. - - - - - Marshall DeleteObjectTaggingRequest object into an http request. - - - - - Response Unmarshaller for DeleteObjectTagging operation - - - - - DeletePublicAccessBlock Request Marshaller - - - - - Response Unmarshaller for DeletePublicAccessBlock operation - - - - - ErrorsItem Unmarshaller - - - - - Expiration Unmarshaller - - - - - FilterRule Unmarshaller - - - - - Filter Unmarshaller - - - - - Get Object Acl Request Marshaller - - - - - Response Unmarshaller for GetACL operation - - - - - Get Object Accelerate Configuration Request Marshaller - - - - - Response Unmarshaller for GetACL operation - - - - - Get BucketAnalyticsConfiguration Request Marshaller - - - - - Response Unmarshaller for GetAnalyticsConfiguration operation - - - - - Get InventoryConfiguration Request Marshaller - - - - - Response Unmarshaller for GetInventoryConfiguration operation - - - - - Get Bucket Location Request Marshaller - - - - - Response Unmarshaller for GetBucketLocation operation - - - - - Get Bucket Logging Request Marshaller - - - - - Response Unmarshaller for GetBucketLogging operation - - - - - Get Bucket MetricsConfigurationRequest Marshaller - - - - - Response Unmarshaller for GetBucketMetricsConfiguration operation - - - - - Get Bucket Notification Request Marshaller - - - - - Response Unmarshaller for GetBucketNotification operation - - - - - Get BucketName Policy Request Marshaller - - - - - Response Unmarshaller for GetBucketPolicy operation - - - - - GetBucketPolicyStatusRequestMarshaller - - - - - Response Unmarshaller for GetBucketPolicyStatus operation - - - - - Get Bucket Request Payment Request Marshaller - - - - - Response Unmarshaller for GetBucketRequestPayment operation - - - - - Get Bucket Tagging Request Marshaller - - - - - Response Unmarshaller for GetBucketTagging operation - - - - - Get Bucket Versioning Request Marshaller - - - - - Response Unmarshaller for GetBucketVersioning operation - - - - - Get Bucket Website Request Marshaller - - - - - Response Unmarshaller for GetBucketWebsite operation - - - - - Get Bucket Cors Request Marshaller - - - - - Response Unmarshaller for GetCORSConfiguration operation - - - - - Get Bucket Lifecycle Request Marshaller - - - - - Response Unmarshaller for GetLifecycleConfiguration operation - - - - - GetObjectLegalHold Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for GetObjectLegalHold operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - GetObjectLockConfiguration Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for GetObjectLockConfiguration operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - GetObjectMetadata Marshaller - - - - - Response Unmarshaller for GetObjectMetadata operation - - - - - Get Object Request Marshaller - - - - - Response Unmarshaller for GetObject operation - - - - - GetObjectRetention Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for GetObjectRetention operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - GetObjectTaggingRequest Marshaller - - - - - Marshall GetObjectTaggingRequest into an http request. - - - - - Marshall GetObjectTaggingRequest into an http request. - - - - - Response Unmarshaller for GetObjectTagging operation - - - - - Get Object Torrent Request Marshaller - - - - - Response Unmarshaller for GetObjectTorrent operation - - - - - GetPublicAccessBlockRequestMarshaller - - - - - Response Unmarshaller for GetPublicAccessBlock operation - - - - - Grantee Unmarshaller - - - - - Grant Unmarshaller - - - - - Head Bucket Request Marshaller - - - - - Response Unmarshaller for HeadBucket operation - - - - - Create Multipart Upload Request Marshaller - - - - - Response Unmarshaller for InitiateMultipartUpload operation - - - - - Initiator Unmarshaller - - - - - InventoryConfiguration Unmarshaller - - - - - InventoryDestination Unmarshaller - - - - - InventoryEncryption Unmarshaller - - - - - InventoryFilter Unmarshaller - - - - - InventoryS3BucketDestination Unmarshaller - - - - - InventorySchedule Unmarshaller - - - - - LifecycleFilterPredicate Unmarshaller - - - - - LifecycleRuleNoncurrentVersionExpiration Unmarshaller - - - - - LifecycleRuleNoncurrentVersionTransition Unmarshaller - - - - - List AnalyticsConfiguration Request Marshaller - - - - - Response Unmarshaller for ListAnalyticsConfiguration operation - - - - - List InventoryConfiguration Request Marshaller - - - - - Response Unmarshaller for ListInventoryConfiguration operation - - - - - List Bucket MetricsConfigurationRequest Marshaller - - - - - Response Unmarshaller for ListBucketMetricsConfiguration operation - - - - - List Buckets Request Marshaller - - - - - Response Unmarshaller for ListBuckets operation - - - - - List Multipart Uploads Request Marshaller - - - - - Response Unmarshaller for ListMultipartUploads operation - - - - - List Objects Request Marshaller - - - - - Response Unmarshaller for ListObjects operation - - - - - List Objects Request Marshaller - - - - - Response Unmarshaller for ListObjects operation - - - - - List Parts Request Marshaller - - - - - Response Unmarshaller for ListParts operation - - - - - List Object Versions Request Marshaller - - - - - Response Unmarshaller for ListVersions operation - - - - - LoggingEnabled Unmarshaller - - - - - MetricsConfiguration Unmarshaller - - - - - MetricsFilte Unmarshaller - - - - - UploadsItem Unmarshaller - - - - - Response Unmarshaller for ObjectLockConfiguration Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Response Unmarshaller for ObjectLockLegalHold Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Response Unmarshaller for ObjectLockRetention Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Response Unmarshaller for ObjectLockRule Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Owner Unmarshaller - - - - - PartsItem Unmarshaller - - - - - PolicyStatus Unmarshaller - - - - - PublicAccessBlockConfiguration Unmarshaller - - - - - Put Object Acl Request Marshaller - - - - - Response Unmarshaller for PutObjectAcl operation - - - - - Put Object Acl Request Marshaller - - - - - Response Unmarshaller for PutBucketAccelerate operation - - - - - Request Marshaller for PutAnalyticsConfiguration operation - - - - - Response Unmarshaller for PutBucketAnalytics operation - - - - - Request Marshaller for PutInventoryConfiguration operation - - - - - Response Unmarshaller for PutBucketWebsite operation - - - - - Enable Bucket Logging Request Marshaller - - - - - Response Unmarshaller for PutBucketLogging operation - - - - - Put Bucket MetricsConfigurationRequest Marshaller - - - - - Response Unmarshaller for PutBucketMetricsConfiguration operation - - - - - Put Bucket Notification Request Marshaller - - - - - Response Unmarshaller for PutBucketNotification operation - - - - - Put Bucket Policy Request Marshaller - - - - - Response Unmarshaller for PutBucketPolicy operation - - - - - Put Buckeyt Replication Request Marshaller - - - - - Response Unmarshaller for PutBucketReplication operation. - - - - - Put Bucket Request Marshaller - - - - - Put Bucket Request Payment Request Marshaller - - - - - Response Unmarshaller for PutBucketRequestPayment operation - - - - - Response Unmarshaller for PutBucket operation - - - - - Put Bucket Tagging Request Marshaller - - - - - Response Unmarshaller for PutBucketTagging operation - - - - - Put Bucket Versioning Request Marshaller - - - - - Response Unmarshaller for PutBucketVersioning operation - - - - - Put Bucket Website Request Marshaller - - - - - Response Unmarshaller for PutBucketWebsite operation - - - - - Put Bucket Cors Request Marshaller - - - - - Response Unmarshaller for PutCORSConfiguration operation - - - - - Put Bucket Lifecycle Request Marshaller - - - - - Response Unmarshaller for PutLifecycleConfiguration operation - - - - - PutObjectLegalHold Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for PutObjectLegalHold operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - PutObjectLockConfiguration Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for PutObjectLockConfiguration operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Put Object Request Marshaller - - - - - Response Unmarshaller for PutObject operation - - - - - PutObjectRetention Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for PutObjectRetention operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Delete Object Tagging Request Marshaller - - - - - Marshall PutObjectTaggingRequest into an http request. - - - - - Marshall PutObjectTaggingRequest into an http request. - - - - - Response Unmarshaller for DeleteObjectTagging operation - - - - - PutPublicAccessBlock Request Marshaller - - - - - Response Unmarshaller for PutPublicAccessBlock operation - - - - - Restore Object Request Marshaller - - - - - Response Unmarshaller for RestoreObject operation - - - - - Condition Unmarshaller - - - - - Redirect Unmarshaller - - - - - RoutingRule Unmarshaller - - - - - RulesItem Unmarshaller - - - - - Response Unmarshaller for all Errors - - - - - Build an S3ErrorResponse from XML - - The XML parsing context. - Usually an Amazon.Runtime.Internal.UnmarshallerContext. - An S3ErrorResponse object. - - - - Grant Unmarshaller - - - - - Class for unmarshalling S3 service responses - - - - - Specialized S3 unmarshaller context. - - - - - Wrap an XmlTextReader with state for event-based parsing of an XML stream. - - Stream with the XML from a service response. - If set to true, maintains a copy of the complete response body as the stream is being read. - Response data coming back from the request - - - - Reads to the next node in the XML document, and updates the context accordingly. - If node is RequestId, reads the contents and stores in RequestId property. - - - True if a node was read, false if there are no more elements to read./ - - - - - SSEKMS Unmarshaller - - - - - StorageClassAnalysisDataExportDataExportUnmarshaller - - - - - StorageClassAnalysisUnmarshaller - - - - - Tag Unmarshaller - - - - - TopicConfiguration Unmarshaller - - - - - Transition Unmarshaller - - - - - Upload Part Request Marshaller - - - - - Response Unmarshaller for UploadPart operation - - - - - VersionsItem Unmarshaller - - - - - Internal implementation of Inventory Predicate visitor interface. - - - - - Internal implementation of Metrics Predicate visitor interface. - - - - - Class for AnalyticsPrefixPredicate - The prefix used when evaluating a metrics filter. - - - - - Class for AnalyticsS3BucketDestination - - - - - The file format used when exporting data to Amazon S3. - - - - - The account ID that owns the destination bucket. If no account ID is provided, the owner will not be validated prior to exporting data. - - - - - The Amazon resource name (ARN) of the bucket to which data is exported. - - - - - The prefix to use when exporting data. The exported data begins with this prefix. - - - - - Class for MetricsTagPredicate - The tag used when evaluating a metrics filter. - - - - - This class represents the byte range for a range GET from S3. - - - - - Constructs a ByteRange and sets the start and end. - - - - - - - Constructs a ByteRange and sets the header to the value specified. - - - - - - A private string, represending the byte range. - - - - - The starting byte number of the range - - - - - The ending byte number of the range - - - - - The formatted string representing the byte range to be set for the range header. - - - - - Container for the parameters to the CompleteMultipartUpload operation. - Completes a multipart upload by assembling previously uploaded parts. - - - - - The name of the bucketName containing the S3 object that was being uploaded in parts. - - - - - The key of the S3 object that was being uploaded. - - - - - A collection of part numbers and corresponding etags. - - - - - Adds a collection of part numbers and corresponding etags. - - PartETags that will added to this request. - - - - Adds a collection of part numbers and corresponding etags. - - PartETags that will added to this request. - - - - Adds a collection of part numbers and corresponding etags by transforming the UploadPartResponses into PartETags. - - The list of response objects return from UploadParts. - - - - Adds a collection of part numbers and corresponding etags by transforming the UploadPartResponses into PartETags. - - The list of response objects return from UploadParts. - - - - Adds a collection of part numbers and corresponding etags by transforming the CopyPartResponse into PartETags. - - The list of response objects return from CopyParts. - - - - Adds a collection of part numbers and corresponding etags by transforming the CopyPartResponse into PartETags. - - The list of response objects return from CopyParts. - - - - The upload id for the in-progress multipart upload that should be completed. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the CompleteMultipartUpload response and response metadata. - - - - - Gets and sets the URI that identifies the newly created object. - - - - - Gets and sets the name of the bucketName that contains the newly created object. - - - - - Gets and sets the object key of the newly created object. - - - - - Gets and sets Entity tag that identifies the newly created object's data. Objects with different - object data will have different entity tags. The entity tag is an opaque string. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - Gets and sets the ServerSideEncryptionMethod property. - Specifies the encryption used on the server to - store the content. - Default is None. - - - - - Gets and sets the VersionId property. - This is the version-id of the S3 object - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the CopyObject operation. - Creates a copy of an object that is already stored in Amazon S3. - - - - - The name of the bucket containing the object to copy. - - - - - Checks if SourceBucket property is set. - - true if SourceBucket property is set. - - - - The key of the object to copy. - - - - - Checks if SourceKey property is set. - - true if SourceKey property is set. - - - - Specifies a particular version of the source object to copy. By default the latest version is copied. - - - - - Checks if SourceVersionId property is set. - - true if SourceVersionId property is set. - - - - The name of the bucket to contain the copy of the source object. - - - - - Checks if DestinationBucket property is set. - - true if DestinationBucket property is set. - - - - The key to be given to the copy of the source object. - - - - - Checks if DestinationKey property is set. - - true if DestinationKey property is set. - - - - A canned access control list (CACL) to apply to the object. - Please refer to for - information on S3 Canned ACLs. - - - - - ETag to be matched as a pre-condition for copying the source object - otherwise returns a PreconditionFailed. - - - Copies the object if its entity tag (ETag) matches - the specified tag; otherwise return a 412 (precondition failed). - Constraints: This property can be used with IfUnmodifiedSince, - but cannot be used with other conditional copy properties. - - - - - Checks if ETagToMatch property is set. - - - Copies the object if its entity tag (ETag) is different - than the specified Etag; otherwise returns a 412 (failed condition). - Constraints: This header can be used with IfModifiedSince, but cannot - be used with other conditional copy properties. - - true if ETagToMatch property is set. - - - - ETag that must not be matched as a pre-condition for copying the source object, - otherwise returns a PreconditionFailed. - - - - - Checks if ETagToNotMatch property is set. - - true if ETagToNotMatch property is set. - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or - ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Copies the object if it has been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it has been modified since the - specified time; otherwise returns a 412 (failed condition). - Constraints: This property can be used with ETagToNotMatch, - but cannot be used with other conditional copy properties. - - - - - Copies the object if it has been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it has been modified since the - specified time; otherwise returns a 412 (failed condition). - Constraints: This property can be used with ETagToNotMatch, - but cannot be used with other conditional copy properties. - - - - - Checks if ModifiedSinceDateUtc property is set. - - true if ModifiedSinceDateUtc property is set. - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or - UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Copies the object if it has not been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it hasn't been modified since the - specified time; otherwise returns a 412 (precondition failed). - Constraints: This property can be used with ETagToMatch, - but cannot be used with other conditional copy properties. - - - - - Copies the object if it has not been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it hasn't been modified since the - specified time; otherwise returns a 412 (precondition failed). - Constraints: This property can be used with ETagToMatch, - but cannot be used with other conditional copy properties. - - - - - Checks if UnmodifiedSinceDateUtc property is set. - - true if UnmodifiedSinceDateUtc property is set. - - - - Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request. - - - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - Specifies whether you want to apply a Legal Hold to the copied object. - - - - - - Gets and sets the property ObjectLockMode. - - The Object Lock mode that you want to apply to the copied object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - The date and time when you want the copied object's Object Lock to expire. - - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - Checks if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - true if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - - - The type of storage to use for the object. Defaults to 'STANDARD'. - - - - - - If the bucketName is configured as a website, redirects requests for this object to another object in the same bucketName or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - This is a convenience property for Headers.ContentType. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - /// - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The customer provided encryption key for the source object of the copy. - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - true if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the CopySourceServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if CopySourceServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - The tag-set for the object destination object this value must be used in conjunction with the TaggingDirective. The tag-set must be encoded as URL Query parameters. - - - - - Checks if Tagging property is set - - true if Tagging is set. - - - - Returns information about the CopyObject response and response metadata. - - - - - Gets and sets the ETag property. - - - - - Gets and sets the LastModified property. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - Gets and sets the SourceVersionId property. - This is the Version Id of the Source Object - - - - - Version ID of the newly created copy. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the CopyPart operation. - Uploads a part by copying data from an existing object as data source. - - - - - The name of the bucket containing the object to copy. - - - - - Checks if SourceBucket property is set. - - true if SourceBucket property is set. - - - - The key of the object to copy. - - - - - Checks if SourceKey property is set. - - true if SourceKey property is set. - - - - Specifies a particular version of the source object to copy. By default the latest version is copied. - - - - - Checks if SourceVersionId property is set. - - true if SourceVersionId property is set. - - - - The name of the bucket to contain the copy of the source object. - - - - - Checks if DestinationBucket property is set. - - true if DestinationBucket property is set. - - - - The key to be given to the copy of the source object. - - - - - Checks if DestinationKey property is set. - - true if DestinationKey property is set. - - - - The ID identifying multipart upload for which we are copying a part. - - - - - Checks if UploadId property is set. - - true if UploadId property is set. - - - - Collection of ETags to be matched as a pre-condition for copying the source object - otherwise returns a PreconditionFailed. - - - Copies the object if its entity tag (ETag) matches one of - the specified tags; otherwise return a 412 (precondition failed). - Constraints: This property can be used with IfUnmodifiedSince, - but cannot be used with other conditional copy properties. - - - - - Checks if ETagsToMatch property is set. - - true if ETagToMatch property is set. - - - - Collection of ETags that must not be matched as a pre-condition for copying the source object - otherwise returns a PreconditionFailed. - - - Copies the object if its entity tag (ETag) does not match any of the specified - tags; otherwise returns a 412 (failed condition). - Constraints: This header can be used with IfModifiedSince, but cannot - be used with other conditional copy properties. - - - - - Checks if ETagToNotMatch property is set. - - true if ETagToNotMatch property is set. - - - - Copies the object if it has been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it has been modified since the - specified time; otherwise returns a 412 (failed condition). - Constraints: This property can be used with ETagToNotMatch, - but cannot be used with other conditional copy properties. - - - - - Checks if ModifiedSinceDate property is set. - - true if ModifiedSinceDate property is set. - - - - Copies the object if it has not been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it hasn't been modified since the - specified time; otherwise returns a 412 (precondition failed). - Constraints: This property can be used with ETagToMatch, - but cannot be used with other conditional copy properties. - - - - - Checks if UnmodifiedSinceDate property is set. - - true if UnmodifiedSinceDate property is set. - - - - The number of the part to be copied. - - - Valid part numbers are from 1 to 10,000 inclusive and will uniquely identify the part - and determine the relative ordering within the destination object. If a part already - exists with the PartNumber it will be overwritten. - - - - - Checks if PartNumber property is set. - - true if PartNumber property is set. - - - - The location of the first byte in the range if only a portion of the - source object is to be copied as the part. - - - The LastByte property must also be set or this value will be ignored. - - - - - Checks if FirstByte property is set. - - true if FirstByte property is set. - - - - The location of the last byte in the range if only a portion of the - source object is to be copied as the part. - - - The FirstByte property must also be set or this value will be ignored. - - - - - Checks if LastByte property is set. - - true if LastByte property is set. - - - - - This property is obsolete. Use ServerSideEncryptionMethod in InitiateMultipartUploadRequest instead. - - - Default: None - - - - - - Checks if ServerSideEncryptionMethod property is set. - - true if ServerSideEncryptionMethod property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - This property is obsolete. Use ServerSideEncryptionKeyManagementServiceKeyId in InitiateMultipartUploadRequest instead. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The customer provided encryption key for the source object of the copy. - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - true if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the CopySourceServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if CopySourceServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - - - Returns information about the CopyPart response and response metadata. - - - - - The version of the source object that was copied, if you have enabled versioning on the source bucketName. - - - - - - Entity tag of the object. - - - - - - Date and time at which the object was uploaded. - - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - Gets and sets the PartNumber property. - This is the part number in it's multi-part upload that will uniquely identify the part - and determine the relative ordering within the destination object. - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - A collection of up to 100 cross-origin resource sharing (CORS) rules. - - - - - The collection of rules in this configuration. - - - - C O R S Rule - - - - - Identifies HTTP methods that the domain/origin specified in the rule is allowed to execute. - - - - - - One or more origins you want customers to be able to access the bucket from. - - - - - - An optional unique identifier for the rule. - - - The ID value can be up to 255 characters long. The IDs help you find a rule in the configuration. - - - - - Checks if Id property is set. - - true if Id property is set. - - - - One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript - XMLHttpRequest object). - - - - - - The time in seconds that your browser is to cache the preflight response for the specified resource. - - - - - - Specifies which headers are allowed in a pre-flight OPTIONS request through the - Access-Control-Request-Headers header. - - - Each header name specified in the Access-Control-Request-Headers must have a corresponding - entry in the rule. Only the headers that were requested will be sent back. - This element can contain at most one * wildcard character. - - - - - Checks if AllowedHeaders property is set. - - true if AllowedHeaders property is set. - - - - Describes how a CSV-formatted input object is formatted. - - - - - Describes the first line of input. Valid values: None, Ignore, Use. - - - - - Single character used to indicate a row should be ignored when present at the start of a row. - - - - - Single character used for escaping the quote character inside an already escaped value. - - - - - Value used to separate individual records. - - - - - Value used to separate individual fields in a record. - - - - - Value used for escaping where the field delimiter is part of the value. - - - - - Specifies that CSV field values may contain quoted record delimiters and such records should be allowed. Default value is FALSE. Setting this value to TRUE may lower performance. - - - - - Describes how CSV-formatted results are formatted. - - - - - Indicates whether or not all output fields should be quoted. - - - - - Single character used for escaping the quote character inside an already escaped value. - - - - - Value used to separate individual records. - - - - - Value used to separate individual fields in a record. - - - - - Value used for escaping where the field delimiter is part of the value. - - - - - The container element for specifying the default Object Lock retention settings for - new objects placed in the specified bucket. - - - - - Gets and sets the property Days. - - The number of days that you want to specify for the default retention period. - - - - - - Gets and sets the property Mode. - - The default Object Lock retention mode you want to apply to new objects placed in - the specified bucket. - - - - - - Gets and sets the property Years. - - The number of years that you want to specify for the default retention period. - - - - - - Container for the parameters to the DeleteBucketAnalyticsConfiguration operation. - Deletes an analytics configuration for the bucket (specified by the analytics configuration ID). - - - - - The name of the bucket from which an analytics configuration is deleted. - - - - - The identifier used to represent an analytics configuration. - - - - - Returns information about the DeleteBucketAnalyticsConfiguration response metadata. - The DeleteBucketAnalyticsConfiguration operation has a void result type. - - - - - Request object for the DeleteBucketEncryption operation. - Request Deletes the server-side encryption configuration from the bucket. - - - - - The name of the bucket containing the server-side encryption configuration to delete. - - - - - Returns information about the DeleteBucketEncryption response metadata. - The DeleteBucketEncryption operation has a void result type. - - - - - Container for the parameters to the DeleteInventoryConfiguration operation. - Deletes an inventory configuration (identified by the inventory ID) from the bucket. - - - - - The name of the bucket containing the inventory configuration to delete. - - - - - The ID used to identify the inventory configuration. - - - - - Returns information about the DeleteInventoryConfiguration response metadata. - The DeleteInventoryConfiguration operation has a void result type. - - - - - Container for the parameters to the DeleteBucketMetricsConfiguration operation. - Deletes a metrics configuration (specified by the metrics configuration ID) from the bucket. - - - - - The name of the bucket on which Inventory configuration is to be removed. - - - - - The ID used to identify the metrics configuration. - - - - - Returns information about the DeleteBucketMetricsConfiguration response metadata. - The DeleteBucketMetricsConfiguration operation has a void result type. - - - - - Container for the parameters to the DeleteBucketPolicy operation. - Deletes the policy from the bucket. - - - - - The bucket on which the policy is to be deleted. - - - - - Returns information about the DeleteBucketPolicy response metadata. - The DeleteBucketPolicy operation has a void result type. - - - - - Request object for the DeleteBucketReplication operation. - - - - - Gets and sets the property BucketName. -

Deletes the replication subresource associated with the specified - bucket.

There is usually some time lag before - replication configuration deletion is fully propagated to all the - Amazon S3 systems.

For more information, see - - Cross-Region Replication (CRR) in the Amazon S3 Developer - Guide.

- - - - - Returns information about the DeleteBucketReplication response metadata. - The DeleteBucketReplication operation has a void result type. - - - - - Container for the parameters to the DeleteBucket operation. - Deletes the bucket. All objects (including all object versions and Delete Markers) in the bucket must be deleted before the bucket - itself can be deleted. - - - - - The name of the bucket to be created. - - - - - The region locality for the bucket. - - - When set, this will determine the region the bucket exists in. - Refer - for a list of possible values. - - - - - If set to true the bucket will be deleted in the same region as the configuration of the AmazonS3 client. - DeleteBucketRequest.BucketRegion takes precedence over this property if both are set. - Default: true. - - - - - Returns information about the DeleteBucket response metadata. - The DeleteBucket operation has a void result type. - - - - - The parameters to request deletion of a tag set from a bucket. - - - To use this operation, you must have permission to perform the s3:PutBucketTagging action. - By default, the bucket owner has this permission and can grant this permission to others. - - - - - The name of the bucket on which the tag set is to be removed. - - - - - Returns information about the DeleteBucketTagging response metadata. - The DeleteBucketTagging operation has a void result type. - - - - - Container for the parameters to the DeleteBucketWebsite operation. - This operation removes the website configuration from the bucket. - - - - - The name of the bucket on which website configuration is to be removed. - - - - - Returns information about the DeleteBucketWebsite response metadata. - The DeleteBucketWebsite operation has a void result type. - - - - - Container for the parameters to the DeleteCORSConfiguration operation. - Deletes the cors configuration information set for the bucket. - - - - - Gets and sets the BucketName property. - - - - - Returns information about the DeleteCORSConfiguration response metadata. - The DeleteCORSConfiguration operation has a void result type. - - - - - Contains information about a successful delete operation against a specific S3 object. - - - - - Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a - delete marker. In a simple DELETE, this header indicates whether (true) or not (false) a delete - marker was created. - - - - - The version ID of the delete marker created as a result of the DELETE operation. If you delete a - specific object version, the value returned by this header is the version ID of the object version - deleted. - - - - - The key of the deleted S3 object. - - - - - The version of the deleted S3 object. - - - - - Contains information about a failed delete operation against a specific S3 object. - - - - - The key of the S3 object. - - - - - The version of the S3 object. - - - - - The failure code for the delete error. - - - - - The failure message for the delete error. - - - - - The parameters to request deletion of the lifecycle configuration on a bucket. - - - - Amazon S3 removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. - Your objects never expire, and Amazon S3 no longer automatically deletes any objects on the basis of rules contained - in the deleted lifecycle configuration. - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration action. By default, the - bucket owner has this permission and the bucket owner can grant this permission to others. - - - There is usually some time lag before lifecycle configuration deletion is fully propagated to all the Amazon S3 systems. - - - - - - The name of the bucket on which the lifecycle configuration is to be deleted. - - - - - Returns information about the DeleteLifecycleConfiguration response metadata. - The DeleteLifecycleConfiguration operation has a void result type. - - - - -

Specifies whether Amazon S3 should replicate delete makers.

- - - - - Gets and sets the property Status. -

The status of the delete marker replication.

-

In the current implementation, Amazon S3 does not replicate - the delete markers. Therefore, the status must be - Disabled.

- - - - - The parameters to request deletion of an object in a bucket. - The operation removes the null version (if there is one) of an object and inserts a delete marker, which - becomes the latest version of the object. - - - - To remove a specific version, you must be the bucket owner and you must use the versionId subresource. - Using this subresource permanently deletes the version. - - - If the object you want to delete is in a bucket where the bucket versioning configuration is MFA Delete enabled, - you must include specify the MFA serial number and value in the request. - - - If there isn't a null version, Amazon S3 does not remove any objects. - - - - - - The bucket name of the bucket containing the object. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property BypassGovernanceRetention. - - - - - The key identifying the object to delete. - - - - - The identifier for the specific version of the object to be deleted, if required. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - The MfaCodes Tuple associates the Serial Number and the current Token/Code displayed on the - Multi-Factor Authentication device associated with your AWS Account. - - - This is a required property for this request if:
- 1. EnableMfaDelete was configured on the bucket - containing this object's version.
- 2. You are deleting an object's version - - - - - Checks if the MfaCodes property is set. - - true if the MfaCodes property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the DeleteObject response and response metadata. - - - - - Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a delete marker. - - - - - - Returns the version ID of the delete marker created as a result of the DELETE operation. - - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the DeleteObjects operation. - This operation enables you to delete multiple objects from a bucket using a single HTTP request. You may specify up to 1000 - keys. - - - Container for the parameters to the DeleteObjects operation. - This operation enables you to delete multiple objects from a bucket using a single HTTP request. You may specify up to 1000 - keys. - - - - - The bucket name containing the objects to delete. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property BypassGovernanceRetention. - - Specifies whether you want to delete this object even if it has a Governance-type - Object Lock in place. You must have sufficient permissions to perform this operation. - - - - - - List of object keys to delete. - - - - - Toggles between Quiet and Verbose mode for the operation. - If set to true (Quiet mode), the response includes only those keys for objects on which - the delete operation failed. - - - By default this property is false and keys for both successful deletes - and failures are returned in the response. - - - - - The MfaCodes Tuple associates the Serial Number and the current Token/Code displayed on the - Multi-Factor Authentication device associated with your AWS Account. - - - This is a required property for this request if:
- 1. EnableMfaDelete was configured on the bucket - containing this object's version.
- 2. You are deleting an object's version - - - - - Checks if the MfaCodes property is set. - - true if the MfaCodes property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Add a key to the set of keys of objects to be deleted. - - Object key - - - - Add a key and a version to be deleted. - - Key of the object to be deleted. - Version of the object to be deleted. - - - - Add a KeyVersion object representing the S3 object to be deleted. - - KeyVersion representation of object to be deleted. - - - - Returns information about the DeleteObjects response and response metadata. - - - - - A default constructor for DeleteObjectsResponse - - - - - Gets and sets the DeletedObjects property. - A list of successful deletes. - Set only when Quiet=false on DeleteObjectsRequest. - - - - - Gets and sets the DeleteErrors property. - A list of errors encountered while deleting objects. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the DeleteObjectTaggingRequest operation. - - - - - The bucket name containing the objects from which to remove the tags. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Check to see if Bucket property is set - - - - - The key identifying the object tagging to delete. - - - - - Check to see if Key property is set - - - - - The identifier for the specific version of the object to be deleted, if required. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - Returns information about the DeleteObjectTagging response and response metadata. - - - - - Returns the version ID of the delete marker created as a result of the DELETE operation. - - - - - Check to see if VersionId property is set - - - - - Container for the parameters to the DeletePublicAccessBlock operation. - Removes the Public Access Block configuration for an Amazon S3 bucket. - - - - - Gets and sets the property BucketName. - - The Amazon S3 bucket whose Public Access Block configuration you want to delete. - - - - - - This is the response object from the DeletePublicAccessBlock operation. - - - - - EncryptionConfiguration class - - - - - The ID of the AWS KMS key for the region where the destination bucket - resides. Amazon S3 uses this key to encrypt the replica object. - - - - - The Continuation Event. - - - - - Constructs a Continuation Event. - - - - - Constructs a Continuation Event. - - - - - - The End Event. - - - - - Constructs an End Event. - - - - - Constructs an End Event. - - - - - - Common Contract for S3 Events. - - - - - The Progress event details. - - - - - Current number of object bytes scanned. - - - - - Current number of uncompressed object bytes processed. - - - - - Total number of bytes of records payload data returned. - - - - - Constructs a instance of Progress. - - - - - The Progress Event. - - - - - The Progress event details. - - - - - Constructs a ProgressEvent. - - - - - Constructs a ProgressEvent. - - - - - - The Records Event - - - - - The byte array of partial, one or more result records. - - Payload is a , which is not thread-safe. - - - - - Constructs a RecordsEvent - - - - - Creates a new End Event. - - - - - - Modeled Exception that either comes over the stream from the service model, or wraps other exceptions for the purpose of raising events. If it is - modelled, it will be a subclass. - - - - - Creates a new S3EventStreamException - - - - - Creates a new S3EventStreamException - - - - - - Creates a new S3EventStreamException - - - - - - - The contract for the SelectObjectContentEventStream. - - - - - Event that encompasses all IS3Events. - - - - - Event that encompasses S3EventStreamExceptions. - - - - - Reaised when a Records event is received. - - - - - Reaised when a Stats event is received. - - - - - Reaised when a Progress event is received. - - - - - Reaised when a Continuation event is received. - - - - - Reaised when an End event is received. - - - - - A Stream of Events returned by the SelectObjectContent operation. Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treaded as mutually exclusive. - - - - - The mapping of event message to a generator function to construct the matching Event Stream event. - - - - - The mapping of event message to a generator function to construct the matching Event Stream exception. - - - - - Whether the backround processing loop is running. - - - - - Event that encompasses all IS3Events. - - - - - Event that encompasses S3EventStreamExceptions. - - - - - Reaised when a Records event is received. - - - - - Reaised when a Stats event is received. - - - - - Reaised when a Progress event is received. - - - - - Reaised when a Continuation event is received. - - - - - Reaised when an End event is received. - - - - - Event Stream returned by SelectObjectContentStream. - - Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treated as mutually exclusive. - - The network stream which events will be parsed from. - - - - Event Stream returned by SelectObjectContentStream. - - Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treaded as mutually exclusive. - - The network stream which events will be parsed from. - The decoder responsible for parsing events. - - - - The Stats event details. - - - - - Total number of object bytes scanned. - - - - - Total number of uncompressed object bytes processed. - - - - - Total number of bytes of records payload data returned. - - - - - Constructs an instance of Stats. - - - - - The Stats Event. - - - - - The Stats event details. - - - - - Constructs a StatsEvent - - - - - Constructs a ProgressEvent. - - - - - - This Event is returned if an event is retrieved from the event stream, but a generator function - for the event is not defined. - - - - - Constructs an UnknownEventStreamEvent. - - - - - Constructs an UnknownEventStreamEvent. - - The Message recieved from the event stream before conversion. - - - - Constructs an UnknownEventStreamEvent. - - The Message recieved from the event stream before conversion. - The event type. - - - - A container that specifies information about existing object replication. You can choose whether to enable or disable the replication of existing objects. - - - - - Specifies whether existing object replication is enabled. - - - - - Defines the expiration policy for a given object. - - - - - This property is deprecated. This property exposes a DateTime of kind Unspecified. Use ExpiryDateUtc instead. - The date and time for expiry. - - - - - The date and time for expiry. - - - - - Id of the configuration rule for this expiry. - - - - - Constructs an empty instance of an Expiration object - - - - Bucket - Represents a set of filter criteria that limits the objects that can trigger event notifications - - - - - Filter criteria that limits the objects that can trigger event notifications based on their S3 Key name. - - - - - Bucket - Represents a Filter Rule for a NotificationConfiguration. - - - - - Constructs an empty FilterRule. - - - - - Constructs a FilterRule with a specific name and value. - - - - - - - The name of the filter rule. - - - - - The value of the filter rule. - - - - - Container for the parameters to the GetACL operation. - Returns the access control list (ACL) of an object. - - - - - The bucket name that contains the object for which to get the ACL information. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The key of the S3 object to be queried. - - - - - VersionId used to reference a specific version of the object. - - - - - Returns information about the GetACL response and response metadata. - - - - - Gets and sets the AccessControlList property. - - - - - Container for the parameters to the GetBucketAccelerateConfiguration operation. - - - - - The name of the bucket. - - - - - The response class for GetBucketAccelerateConfiguration operation. - - - - - The accelerate status of the bucket. - - - - - Container for the parameters to the GetBucketAnalyticsConfiguration operation. - Gets an analytics configuration for the bucket (specified by the analytics configuration ID). - - - - - The name of the bucket from which an analytics configuration is retrieved. - - - - - The identifier used to represent an analytics configuration. - - - - - GetBucketAnalyticsConfigurationResponse Response - - - - - The configuration and any analyses for the analytics filter. - - - - - Container for the parameters to the GetBucketEncryptionRequest operation. - Returns the server-side encryption configuration of a bucket. - - - - - The name of the bucket. - - - - - GetBucketEncryptionResponse Response - - - - - Container for server-side encryption configuration rules. Currently S3 supports one rule only. - - - - - Container for the parameters to the GetInventoryConfigurationRequest operation. - Returns an inventory configuration (identified by the inventory ID) from the bucket. - - - - - The name of the bucket containing the inventory configuration to retrieve. - - - - - The ID used to identify the inventory configuration. - - - - - GetInventoryConfigurationResponse Response - - - - - Specifies the inventory configuration. - - - - - Container for the parameters to the GetBucketLocation operation. - Returns the region the bucket resides in. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetBucketLocation response and response metadata. - - - - - Gets and sets the Location property. - If the the bucket is located in us-east-1 S3Region.US will be return which has a - value of empty string. - - - - - Container for the parameters to the GetBucketLogging operation. - Returns the logging status of a bucket and the permissions users have to view and modify that status. To use GET, you must be the - bucket owner. - - - - - The name of the bucket to query. - - - - - Returns information about the GetBucketLogging response and response metadata. - - - - - Gets and sets the LoggingConfig property. - - - - - Container for the parameters to the GetBucketMetricsConfiguration operation. - Gets a metrics configuration (specified by the metrics configuration ID) from the bucket. - - - - - The name of the bucket containing the metrics configuration to retrieve. - - - - - The ID used to identify the metrics configuration. - - - - - GetBucketMetricsConfiguration Response - - - - - Specifies the metrics configuration. - - - - - Container for the parameters to the GetBucketNotification operation. - Return the notification configuration of a bucket. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetBucketNotification response and response metadata. - - - - - Gets and sets the TopicConfigurations property. TopicConfigurations are configuration - for Amazon S3 events to be sent to Amazon SNS topics. - - - - - Gets and sets the QueueConfigurations property. QueueConfigurations are configuration - for Amazon S3 events to be sent to Amazon SQS queues. - - - - - Gets and sets the LambdaFunctionConfigurations property. LambdaFunctionConfigurations are configuration - for Amazon S3 events to be sent to an Amazon Lambda cloud function. - - - - - Container for the parameters to the GetBucketPolicy operation. - Returns the policy of a specified bucket. - - - - - The name of the bucket. - - - - - Get BucketName Policy Response - - - - - The bucket policy as a JSON document. - - - - - Container for the parameters to the GetBucketPolicyStatus operation. - Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket - is public. - - - - - Gets and sets the property BucketName. - - The name of the Amazon S3 bucket whose public-policy status you want to retrieve. - - - - - - This is the response object from the GetBucketPolicyStatus operation. - - - - - The public-policy status for this bucket. - - - - - Container for the parameters to the GetBucketReplicationConfiguration operation. - Returns the replication configuration information set on the bucket. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetReplicationConfiguration response and response metadata. - - - - - The replication configuration for the buccket specified in the request. - - - - - Container for the parameters to the GetBucketRequestPayment operation. - Returns the request payment configuration of a bucket. - - - - - The name of the bucket. - - - - - Returns information about the GetBucketRequestPayment response and response metadata. - - - - - Specifies who pays for the download and request fees. - - - - - - Container for the parameters to the GetBucketTagging operation. - Returns the tag set associated with the bucket. - - - - - The name of the bucket to be queried. - - - - - Returns information about the GetBucketTagging response and response metadata. - - - - - The collection of tags. - - - - - Container for the parameters to the GetBucketVersioning operation. - Returns the versioning state of a bucket. - - - - - The name of the bucket to be queried. - - - - - Returns information about the GetBucketVersioning response and response metadata. - - - - - Gets and sets the Versioning property. - Unless Versioning has been explicitly "Enabled" on a bucket, - Versioning Status is "Off". Once Versioning has been - "Enabled", it can be "Suspended" but cannot be switched "Off". - - - - - Container for the parameters to the GetBucketWebsite operation. - Returns the website configuration for a bucket. - - - - - The name of the bucket to be queried. - - - - - Returns information about the GetBucketWebsite response and response metadata. - - - - - Gets and sets the WebsiteConfiguration property. - - This is where the index document suffix and custom error page are defined. - - - - - Container for the parameters to the GetBucketCors operation. - Returns the cors configuration for the bucket. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetBucketCors response and response metadata. - - - - - The current CORSConfiguration for the bucket. - - - - - Container for the parameters to the GetLifecycleConfiguration operation. - Returns the lifecycle configuration information set on the bucket. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetLifecycleConfiguration response and response metadata. - - - - - Gets and Sets the property that governs whether - the response includes successful deletes as well as errors - following the DeleteObjects call against S3. - - By default this property is false and successful deletes - are returned in the response. - - - - - Container for the parameters to the GetObjectLegalHold operation. - Gets an object's current Legal Hold status. - - - - - The bucket name containing the object whose Legal Hold status you want to retrieve. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property Key. - - The key name for the object whose Legal Hold status you want to retrieve. - - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property VersionId. - - The version ID of the object whose Legal Hold status you want to retrieve. - - - - - - This is the response object from the GetObjectLegalHold operation. - - - - - Gets and sets the property LegalHold. - - The current Legal Hold status for the specified object. - - - - - - Container for the parameters to the GetObjectLockConfiguration operation. - Gets the Object Lock configuration for a bucket. The rule specified in the Object - Lock configuration will be applied by default to every new object placed in the specified - bucket. - - - - - Gets and sets the property BucketName. - - The bucket whose Object Lock configuration you want to retrieve. - - - - - - This is the response object from the GetObjectLockConfiguration operation. - - - - - Gets and sets the property ObjectLockConfiguration. - - The specified bucket's Object Lock configuration. - - - - - - Container for the parameters to the HeadObject operation. - The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you''re only - interested in an object''s metadata. To use HEAD, you must have READ access to the object. - - - - - The name of the bucket that contains the object. - - - - - ETag to be matched as a pre-condition for returning the object, - otherwise a PreconditionFailed signal is returned. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or - ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Returns the object only if it has been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Returns the object only if it has been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - ETag that should not be matched as a pre-condition for returning the object, - otherwise a PreconditionFailed signal is returned. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or - UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Returns the object only if it has not been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Returns the object only if it has not been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - The key of the object. - - - - - VersionId used to reference a specific version of the object. - - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to decrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - Part number of the object being read. This is a positive integer between 1 and 10,000. - Effectively performs a 'ranged' HEAD request for the part specified. - Useful querying about the size of the part and the number of parts in this object. - - - - - Check if PartNumber property is set. - - true if PartNumber property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the HeadObject response and response metadata. - - - - - Flag which returns true if the Expires property has been unmarshalled - from the raw value or set by user code. - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the - response. - - - - - - Gets and sets the AcceptRanges. - - - - - Gets and sets the ContentRange. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - Gets and sets the RestoreExpiration property. - RestoreExpiration will be set for objects that have been restored from Amazon Glacier. - It indiciates for those objects how long the restored object will exist. - - - - - Gets and sets the RestoreInProgress - Will be true when the object is in the process of being restored from Amazon Glacier. - - - - - Last modified date of the object - - - - - - An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL - - - - - - This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like - SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal - HTTP headers. - - - - - - Version of the object. - - - - - - The date and time at which the object is no longer cacheable. - - - - - - If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The status of the replication job associated with this source object. - - - - - Checks if ReplicationStatus property is set. - - true if ReplicationStatus property is set. - - - - The count of parts this object has. - - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - The Legal Hold status for the specified object. - - - - - - Gets and sets the property ObjectLockMode. - - The Object Lock mode currently in place for this object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - The date and time when this object's Object Lock will expire. - - - - - - The class of storage used to store the object. - - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the GetObject operation. - Retrieves objects from Amazon S3. - - - - - The bucket name containing the object. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - ETag to be matched as a pre-condition for returning the object, - otherwise a PreconditionFailed signal is returned. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or - ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Returns the object only if it has been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Returns the object only if it has been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - ETag that should not be matched as a pre-condition for returning the object, - otherwise a PreconditionFailed signal is returned. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or - UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Returns the object only if it has not been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Returns the object only if it has not been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Gets and sets the Key property. This is the user defined key that identifies the object in the bucket. - - - - - Downloads the specified range bytes of an object. - - - - - A set of response headers that should be returned with the object. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ResponseExpiresUtc instead. Setting either ResponseExpires or - ResponseExpiresUtc results in both ResponseExpires and ResponseExpiresUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ResponseExpires is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Sets the Expires header of the response. - - - - - Sets the Expires header of the response. - - - - - VersionId used to reference a specific version of the object. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to decrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - Part number of the object being read. This is a positive integer between 1 and 10,000. - Effectively performs a 'ranged' GET request for the part specified. Useful for downloading just a part of an object. - - - - - Checks if PartNumber property is set. - - true if PartNumber property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the GetObject response and response metadata. - - - - - Flag which returns true if the Expires property has been unmarshalled - from the raw value or set by user code. - - - - - Gets and sets the BucketName property. - - - - - Gets and sets the Key property. - - - - - Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the - response. - - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - Gets and sets the AcceptRanges. - - - - - Gets and sets the ContentRange. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - Gets and sets the RestoreExpiration property. - RestoreExpiration will be set for objects that have been restored from Amazon Glacier. - It indiciates for those objects how long the restored object will exist. - - - - - Gets and sets the RestoreInProgress - Will be true when the object is in the process of being restored from Amazon Glacier. - - - - - Last modified date of the object - - - - - - An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL - - - - - - This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like - SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal - HTTP headers. - - - - - - Version of the object. - - - - - - The date and time at which the object is no longer cacheable. - - - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - - - - Gets and sets the property ObjectLockMode. - - The Object Lock mode currently in place for this object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - The date and time when this object's Object Lock will expire. - - - - - - If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The class of storage used to store the object. - - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The status of the replication job associated with this source object. - - - - - Checks if ReplicationStatus property is set. - - true if ReplicationStatus property is set. - - - - The number of parts this oject has. - - - - - Checks if PartsCount is set. - - true if PartsCount property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - The number of tags, if any, on the object. - - - - - The event for Write Object progress notifications. All - subscribers will be notified when a new progress - event is raised. - - - Subscribe to this event if you want to receive - put object progress notifications. Here is how:
- 1. Define a method with a signature similar to this one: - - private void displayProgress(object sender, WriteObjectProgressArgs args) - { - Console.WriteLine(args); - } - - 2. Add this method to the Put Object Progress Event delegate's invocation list - - GetObjectResponse response = s3Client.GetObject(request); - response.WriteObjectProgressEvent += displayProgress; - - - - - - This method is called by a producer of write object progress - notifications. When called, all the subscribers in the - invocation list will be called sequentially. - - The file being written. - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - True if transfer is complete - - - - Writes the content of the ResponseStream a file indicated by the filePath argument. - - The location where to write the ResponseStream - Whether or not to append to the file if it exists - Cancellation token which can be used to cancel this operation. - - - - Encapsulates the information needed to provide - download progress for the Write Object Event. - - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The bucket name for the S3 object being written. - The object key for the S3 object being written. - The version-id of the S3 object. - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - True if finished writing - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The bucket name for the S3 object being written. - The object key for the S3 object being written. - The file for the S3 object being written. - The version-id of the S3 object. - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - True if finished writing - - - - Gets the bucket name for the S3 object being written. - - - - - Gets the object key for the S3 object being written. - - - - - Gets the version-id of the S3 object. - - - - - The file for the S3 object being written. - - - - - True if writing is complete - - - - - Container for the parameters to the GetObjectRetention operation. - Retrieves an object's retention settings. - - - - - The bucket name containing the object whose retention settings you want to retrieve. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property Key. - - The key name for the object whose retention settings you want to retrieve. - - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property VersionId. - - The version ID for the object whose retention settings you want to retrieve. - - - - - - This is the response object from the GetObjectRetention operation. - - - - - Gets and sets the property Retention. - - The container element for an object's retention settings. - - - - - - Container for the parameters to the GetObjectTaggingRequest operation. - - - - - The bucket name containing the object for which to get the tagging information. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Check to see if Bucket property is set - - - - - Gets and sets the Key property. This is the user defined key that identifies the object in the bucket. - - - - - Check to see if Key property is set - - - - - VersionId used to reference a specific version of the object. - - - - - - Returns information about the GetObjectTagging response and response metadata. - - - - - Gets or sets tag-set for a given object - - - - - Container for the parameters to the GetObjectTorrent operation. - Return torrent files from a bucket. - - - - - The name of the bucket containing the object. - - - - - The key identifying the object. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the GetObjectTorrent response and response metadata. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - The parameters to create a pre-signed URL to a bucket or object. - - - For more information, refer to: . -
Required Parameters: BucketName, Expires -
Optional Parameters: Key, VersionId, Verb: default is GET - - - - - The name of the bucket to create a pre-signed url to, or containing the object. - - - - - Checks if BucketName property is set. - - true if BucketName property is set. - - - - The key to the object for which a pre-signed url should be created. - - - - - Checks if Key property is set. - - true if Key property is set. - - - - A standard MIME type describing the format of the object data. - - - - The content type for the content being uploaded. This property defaults to "binary/octet-stream". - For more information, refer to: . - - - Note that if content type is specified, it should also be included in the HttpRequest headers - of the eventual upload request, otherwise a signature error may result. - - - - - - The expiry date and time for the pre-signed url. - - - - - Checks if Expires property is set. - - true if Expires property is set. - - - - The requested protocol (http/https) for the pre-signed url. - - - Defaults to https. - - - - - The verb for the pre-signed url. - - - Accepted verbs are GET, PUT, DELETE and HEAD. - Default is GET. - - - - - Version id for the object that the pre-signed url will reference. If not set, - the url will reference the latest version of the object. - - - This is the VersionId for the S3 Object you want to get - a PreSigned URL for. The VersionId property will be ignored - for PreSigned "PUT" requests and for requests that don't specify - the Key property. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - Specifies the encryption used on the server to store the content. - - - - Default is None. - - - If specifying encryption (not None), the corresponding request must include header - "x-amz-server-side-encryption" with the value of the encryption. - - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - Confirms that the requester knows that she or he will be charged for the request. - Bucket owners need not specify this parameter in their requests. - - - - - A set of response headers that should be returned with the pre-signed url creation response. - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - Custom parameters to include in the signed request, so that they are tamper-proof. - - - - - The parameters for a pre-signed URL to a bucket or object as a string. - - - For more information, refer to: . - - - - - The PreSignedURL as a string - - - - - Constructor - - A url returned from GetPreSignedUrlRequest - - - - Container for the parameters to the GetPublicAccessBlock operation. - Retrieves the Public Access Block configuration for an Amazon S3 bucket. - - - - - Gets and sets the property BucketName. - - The name of the Amazon S3 bucket whose Public Access Block configuration you want - to retrieve. - - - - - - This is the response object from the GetPublicAccessBlock operation. - - - - - The Public Access Block configuration currently in effect for this Amazon S3 bucket. - - - - - Container for the parameters to the HeadBucket operation. - This operation is useful to determine if a bucket exists and you have permission to access it. - - - - - Returns information about the HeadBucket response metadata. - The HeadBucket operation has a void result type. - - - - - This class contains the headers for an S3 object. - - - - - Gets and sets headers to set for the object. - - The name of the header - The value for the header - - - - Gets the count of headers. - - - - - Gets the names of the headers set. - - - - - Specifies caching behavior along the request/reply chain. - - - - - - Specifies presentational information for the object. - - - - - - Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type - referenced by the Content-Type header field. - - - - - - The size of the object, in bytes. - - - - - The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. This - header can be used as a message integrity check to verify that the data is the same data that was originally sent. - - - - - A standard MIME type describing the format of the object data. - - - - - - The date and time at which the object is no longer cacheable. - - - - - - - Container for the parameters to the InitiateMultipartUpload operation. - Initiates a multipart upload and returns an upload ID. - - - - - Envelope Key to Encrypt data - - - - - Encrypted Envelope Key to Encrypt data - - - - - Initialization Vector for encryption - - - - - Storage mode for encryption information. - - - - - A canned access control list (ACL) to apply to the object. - Please refer to for information on S3 Canned ACLs. - - - - - The name of the bucketName where the new object will be created, or existing object updated. - - - - - The key of the object to create or update. - - - - - StorageClass property for the object. - - - Default: S3StorageClass.Standard. Set this property - only if you want reduced redundancy for this object. - Please refer to - for - information on S3 Storage Classes. - - - - - If the bucketName is configured as a website, redirects requests for this object to another object in the same bucketName or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - This is a convenience property for Headers.ContentType. - - - - - - Specifies the encryption to be used on the server for the new object. - - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - Checks if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - true if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - Specifies whether you want to apply a Legal Hold to the uploaded object. - - - - - - Gets and sets the property ObjectLockMode. - - Specifies the Object Lock mode that you want to apply to the uploaded object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - Specifies the date and time when you want the Object Lock to expire. - - - - - - The tag-set for the object. The tag-set must be encoded as URL Query parameters. - - - - - Checks if Tagging property is set - - true if Tagging is set. - - - - Returns information about the InitiateMultipartUpload response and response metadata. - - - - - Name of the bucketName to which the multipart upload was initiated. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Object key for which the multipart upload was initiated. - - - - - - Gets and sets the initiated multipart upload id. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - Date when multipart upload will become eligible for abort operation by lifecycle. - - - - - Id of the lifecycle rule that makes a multipart upload eligible for abort operation. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Identifies who initiated the multipart upload. - - - - - Name of the Principal. - - - - - - If the principal is an AWS account, it provides the Canonical User ID. If the principal is an IAM User, it provides a user ARN value. - - - - - - Describes the serialization format of the object. - - - - - Describes the serialization of a CSV-encoded object. - - - - - Specifies object's compression format. Valid values: NONE, GZIP. Default Value: NONE. - - - - - Specifies JSON as object's input serialization format. - - - - - Specifies Parquet as object's input serialization format. - - - - - Class for MetricsConfiguration - - - - - Contains information about where to publish the inventory results. - - - - - Specifies whether the inventory is enabled or disabled. - - - - - Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria. - - - - - The ID used to identify the inventory configuration. - - - - - Specifies which object version(s) to included in the inventory results. - - - - - Contains the optional fields that are included in the inventory results. - - - - - Specifies the schedule for generating inventory results. - - - - - Class for InventoryDestination - - - - - Contains the bucket name, file format, bucket owner (optional), and prefix (optional) where inventory results are published. - - - - - InventoryEncryption class - - - - - Specifies the use of SSE-S3 to encrypt delievered Inventory reports. - - - - - Specifies the use of SSE-KMS to encrypt delievered Inventory reports. - - - - - Class for InventoryFilter - - - - - Filter Predicate setup for specific filter types. - - - - - Filter Predicate abstract class for specific filter types to be derived from. - - - - - Class for InventoryPrefixPredicate - The prefix that an object must have to be included in the inventory results. - - - - - The ID of the account that owns the destination bucket. - - - - - The Amazon resource name (ARN) of the bucket where inventory results will be published. - - - - - The prefix that is prepended to all inventory results. - - - - - Specifies the output format of the inventory results. - - - - - Contains the type of server-side encryption used to encrypt the inventory results. - - - - - Class for InventorySchedule - - - - - Specifies how frequently inventory results are produced. - - - - - Specifies JSON as object's input serialization format. - - - - - The type of JSON. Valid values: Document, Lines. - - - - - Specifies JSON as request's output serialization format - - - - - The value used to separate individual records in the output. - - - - - Specifies an object key and optional object version. - - - - - Key name of the object to delete. - - - - - - VersionId for the specific version of the object to delete. - - - - - - This class contains the configuration Amazon S3 uses to figure out what events you want to listen - and send the event to an Amazon Lambda cloud function. - - - - - Gets and set the Id property. The Id will be provided in the event content and can be used - to identify which configuration caused an event to fire. If the Id is not provided for the configuration, one will be generated. - - - - - Gets and sets the FunctionArn property. This is the Amazon Lambda cloud function to which Amazon S3 will invoke with the events. - - - - Lifecycle Configuration - - - - - Gets and sets the Rules property. These rules defined the lifecycle configuration. - - - - - Base class for all the different predicates that can be used - in a filter. - - - - - This method is called by the visitor when it wants to visit the predicate. - - - - - - Filter identifying one or more objects to which a applies. - - - - - The predicate used by the filter. - - - - - Base class for lifecycle operators. - - - - - The list of objects - that this operator operates on. - - - - - The logical and operator for filtering objects for a - - - - - Accept a visit from an - - - This method is used internally by the SDK. - - - - - - A predicate that filters objects for a - by matching a particular prefix. - - - - - The prefix to be matched by filtered objects. - - - - - Accept a visit from an - - - This method is used internally by the SDK. - - - - - - A predicate that filters objects for a - by matching a particular key and value. - - - - - The Tag to be matched by filtered objects. - - - - - Accept a visit from an - - - This method is used internally by the SDK. - - - - - - Rules Item - - - - - Defines the length of time, in days, before objects expire. - - - - - Unique identifier for the rule. The value cannot be longer than 255 characters. - - - - - Prefix identifying one or more objects to which the rule applies. - - - - - - Filter identifying one or more objects to which the rule applies. - - - - - If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied. - - - - - - The transition rule that describes when objects transition to a different storage class. - - Lifecycle rules can now contain multiple transitions. This property is obsolete in favor of the Transitions property. - This property will always get or set the the zeroth element in the Transitions collection. - - - - - - Defines the length of time, in days, before noncurrent versions expire. - - - - - The transition rule that describes when noncurrent versions transition to - a different storage class. - - Lifecycle rules can now contain multiple noncurrent version transitions. This property - is obsolete in favor of the NoncurrentVersionTransitions property. - This property will always get or set the the zeroth element in the NoncurrentVersionTransitions collection. - - - - - - The transition rules that describe when objects transition to a different storage class. - - - - - The transition rules that describe when noncurrent versions transition to - a different storage class. - - - - - Specifies the days since the initiation of an Incomplete Multipart Upload - that Lifecycle will wait before permanently removing all parts of the upload. - - - - - Specifies the days since the initiation of an Incomplete Multipart Upload - that Lifecycle will wait before permanently removing all parts of the upload. - - - - - Indicates the number of days that must pass since initiation for Lifecycle - to abort an Incomplete Multipart Upload. - - - - Expiration - - - - - Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format. - - - - - - Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer. - - - - - - Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set to true, the delete marker will be expired; if set to false the policy takes no action. This cannot be specified with Days or Date in a Lifecycle Expiration Policy. - - - - - - Noncurrent Version Expiration - - - - - Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated - action. For information about the noncurrent days calculations, see - How Amazon S3 Calculates When an Object Became Noncurrent - in the Amazon Simple Storage Service Developer Guide. - - - - - LifecycleTransition defines when and how objects transition. - - - - - Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated - action. For information about the noncurrent days calculations, see - How Amazon S3 Calculates When an Object Became Noncurrent - in the Amazon Simple Storage Service Developer Guide. - - - - - The class of storage used to store the object. - - - - - - LifecycleTransition defines when and how objects transition. - - - - - Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format. - - - - - - Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer. - - - - - - The class of storage used to store the object. - - - - - - Container for the parameters to the ListInventoryConfigurationsRequest operation. - Lists the analytics configurations for the bucket. - - - - - The name of the bucket containing the analytics configurations to retrieve. - - - - - The ContinuationToken that represents a placeholder from where this request should begin. - - - - - Returns information about the ListBucketAnalyticsConfigurationsResponse response and response metadata. - - - - - The ContinuationToken that represents where this request began. - - - - - The list of analytics configurations for a bucket. - - - - - Indicates whether the returned list of analytics configurations is complete. - A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request. - - - - - NextContinuationToken is sent when isTruncated is true, which indicates that there are more analytics configurations to list. - The next request must include this NextContinuationToken. The token is obfuscated and is not a usable value. - - - - - Container for the parameters to the ListInventoryConfigurationsRequest operation. - Returns a list of inventory configurations for the bucket. - - - - - The name of the bucket containing the inventory configurations to retrieve. - - - - - The marker used to continue an inventory configuration listing that has been truncated. - Use the NextContinuationToken from a previously truncated list response to continue the listing. - The continuation token is an opaque value that Amazon S3 understands. - - - - - Returns information about the ListInventoryConfigurationsResponse response and response metadata. - - - - - If sent in the request, the marker that is used as a starting point for this inventory configuration list response. - - - - - The list of inventory configurations for a bucket. - - - - - Indicates whether the returned list of inventory configurations is truncated in this response. A value of true indicates that the list is truncated. - - - - - The marker used to continue this inventory configuration listing. Use the NextContinuationToken from this response to continue the listing in a subsequent request. - The continuation token is an opaque value that Amazon S3 understands. - - - - - Container for the parameters to the ListBucketMetricsConfigurationRequest operation. - Lists the metrics configurations for the bucket. - - - - - The name of the bucket containing the metrics configurations to retrieve. - - - - - - The marker that is used to continue a metrics configuration listing that has been truncated. - Use the NextContinuationToken from a previously truncated list response to continue the listing. - The continuation token is an opaque value that Amazon S3 understands. - - - - - - Returns information about the ListBucketMetricsConfiguration response and response metadata. - - - - - - The marker that is used to continue a metrics configuration listing that has been truncated. - Use the NextContinuationToken from a previously truncated list response to continue the listing. - The continuation token is an opaque value that Amazon S3 understands. - - - - - - The list of metrics configurations for a bucket. - - - - - - Indicates whether the returned list of metrics configurations is complete. - A value of true indicates that the list is not complete and the NextContinuationToken will be provided for - a subsequent request. - - - - - - - The marker used to continue a metrics configuration listing that has been truncated. - Use the NextContinuationToken from a previously truncated list response to continue the listing. - The continuation token is an opaque value that Amazon S3 understands. - - - - - - Container for the parameters to the ListBuckets operation. - Returns a list of all buckets owned by the authenticated sender of the request. - - - - - Returns information about the ListBuckets response and response metadata. - - - - - List of buckets. - - - - - Owner of the buckets. - - - - - Container for the parameters to the ListMultipartUploads operation. - This operation lists in-progress multipart uploads. - - - - - Name of the bucket to which the multipart upload was initiated. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Character you use to group keys. - - - - - - Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin. - - - - - - Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response body. 1,000 is the maximum number of uploads that - can be returned in a response. - - - - - - Lists in-progress uploads only for those keys that begin with the specified prefix. - - - - - - Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the - upload-id-marker parameter is ignored. - - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - Returns information about the ListMultipartUploads response and response metadata. - - - - - Name of the bucketName to which the multipart upload was initiated. - - - - - - The key at or after which the listing began. - - - - - - Upload ID after which listing began. - - - - - - When a list is truncated, this element specifies the value that should be used for the key-marker request parameter in a subsequent request. - - - - - - When a list is truncated, this element specifies the value that should be used for the upload-id-marker request parameter in a subsequent - request. - - - - - - Maximum number of multipart uploads that could have been included in the response. - - - - - - Indicates whether the returned list of multipart uploads is truncated. A value of true indicates that the list was truncated. The list can - be truncated if the number of multipart uploads exceeds the limit allowed or specified by max uploads. - - - - - - Gets and sets the MultipartUploads property. - - Container for elements related to a particular multipart upload. A response - can contain zero or more Upload elements. - - - - - - Gets and sets the Prefix property. - - - - - Gets and sets the Delimiter property. - - - - - Gets the CommonPrefixes property. - A response can contain CommonPrefixes only if you specify a delimiter. - When you do, CommonPrefixes contains all (if there are any) keys between - Prefix and the next occurrence of the string specified by delimiter. In effect, - CommonPrefixes lists keys that act like subdirectories in the directory specified - by Prefix. For example, if prefix is notes/ and delimiter is a slash (/), in - notes/summer/july, the common prefix is notes/summer/. - - - - - Container for the parameters to the ListObjects operation. - Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a - subset of the objects in a bucket. - - - - - The name of the bucket containing the objects whose keys are to be listed. - - - - - A delimiter is a character you use to group keys. - - - - - Specifies the key to start with when listing objects in a bucket. - - - - - Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more. - - - - - Limits the response to keys that begin with the specified prefix. - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the ListObjects response and response metadata. - - - - - A flag that indicates whether or not Amazon S3 returned all of the results that satisfied - the search criteria. - - - - - Gets and sets the NextMarker property. - NextMarker is set by S3 only if a Delimiter was specified - in the original ListObjects request. If a delimiter was - not specified, the AWS SDK for .NET returns the last Key - of the List of Objects retrieved from S3 as the NextMarker. - - - - - Gets the S3Objects property. This is a list of - objects in the bucket that match your search criteria. - - - - - Gets and sets the Name property which is the name of the bucket. - - - - - Gets and sets the Prefix property. - - - - - Gets and sets the MaxKeys property. This is max number of object keys returned by the list operation. - - - - - Gets the CommonPrefixes property. - A response can contain CommonPrefixes only if you specify a delimiter. - When you do, CommonPrefixes contains all (if there are any) keys between - Prefix and the next occurrence of the string specified by delimiter. In effect, - CommonPrefixes lists keys that act like subdirectories in the directory specified - by Prefix. For example, if prefix is notes/ and delimiter is a slash (/), in - notes/summer/july, the common prefix is notes/summer/. - - - - - Gets and sets the Delimiter property. - Causes keys that contain the same string between the prefix and the - first occurrence of the delimiter to be rolled up into a single result - element in the CommonPrefixes collection. - - - These rolled-up keys are not returned elsewhere in the response. - - - - - Container for the parameters to the ListObjects operation. - Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a - subset of the objects in a bucket. - - - - - Bucket name to list. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - A delimiter is a character you use to group keys. - - - - - Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more. - - - - - Limits the response to keys that begin with the specified prefix. - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts - listing after this specified key. StartAfter can be any key in the bucket. - Cannot be set at the same time as ContinuationToken. - - - - - ContinuationToken indicates Amazon S3 that the list is being continued on this - bucket with a token. ContinuationToken is obfuscated and is not a real key. - - - - - The owner field is not present in ListObjectsV2 responses by default. - If you want to return owner field with each key in the result then set this field to true. - If not specified, the Owner field on S3Object will be null. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the ListObjects response and response metadata. - - - - - A flag that indicates whether or not Amazon S3 returned all of the results that satisfied - the search criteria. - - - - - Gets and sets the S3Objects property. Metadata about each object returned. - - - - - Bucket name. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the Prefix property. - - - - - Gets and sets the MaxKeys property. This is max number of object keys returned by the list operation. - - - - - Gets and sets the CommonPrefixes property. - CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence - of the string specified by delimiter - - - - - Gets and sets the Delimiter property. - Causes keys that contain the same string between the prefix and the - first occurrence of the delimiter to be rolled up into a single result - element in the CommonPrefixes collection. - - - These rolled-up keys are not returned elsewhere in the response. - - - - - Encoding type used by Amazon S3 to encode object keys in the response. - - - - - KeyCount is the number of keys returned with this request. - KeyCount will always be less than or equal to MaxKeys field. - - - - - ContinuationToken indicates Amazon S3 that the list is being continued - on this bucket with a token. - ContinuationToken is obfuscated and is not a real key - - - - - NextContinuationToken is sent when isTruncated is true which means there - are more keys in the bucket that can be listed. The next ListObjectV2 call - to Amazon S3 can be continued with this NextContinuationToken. - NextContinuationToken is obfuscated and is not a real key. - - - - - StartAfter is where you want Amazon S3 to start listing from. - Amazon S3 starts listing after this specified key. - StartAfter can be any key in the bucket. - - - - - Container for the parameters to the ListParts operation. - Lists the parts that have been uploaded for a specific multipart upload. - - - - - Name of the bucket to which the parts are being uploaded. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The object key for which the multipart upload was initiated. - - - - - Sets the maximum number of parts to return. - - - - - - Specifies the part after which listing should begin. Only parts with higher part numbers will be listed. - - - - - - Upload ID identifying the multipart upload whose parts are being listed. - - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the ListParts response and response metadata. - - - - - Name of the bucketName to which the multipart upload was initiated. - - - - - - Object key for which the multipart upload was initiated. - - - - - - Upload ID identifying the multipart upload whose parts are being listed. - - - - - - Part number after which listing begins. - - - - - - When a list is truncated, this element specifies the last part in the list, as well as the value to use for the part-number-marker request - parameter in a subsequent request. - - - - - - Maximum number of parts that were allowed in the response. - - - - - - Indicates whether the returned list of parts is truncated. - - - - - - Gets and sets the Parts property. - - PartDetails is a container for elements related to a particular part. A response can contain - zero or more Part elements. - - - - - - Identifies who initiated the multipart upload. - - - - - - Gets and sets the Owner property. - - - - - The class of storage used to store the object. - - - - - - Date when multipart upload will become eligible for abort operation by lifecycle. - - - - - Id of the lifecycle rule that makes a multipart upload eligible for abort operation. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the ListVersions operation. - Returns metadata about all of the versions of objects in a bucket. - - - - - The bucket name that contains the objects. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - A delimiter is a character you use to group keys. - - - - - Specifies the key to start with when listing objects in a bucket. - - - - - Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more. - - - - - Limits the response to keys that begin with the specified prefix. - - - - - Specifies the object version you want to start listing from. - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - Returns information about the ListVersions response and response metadata. - - - - - A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria. If your results were - truncated, you can make a follow-up paginated request using the NextKeyMarker and NextVersionIdMarker response parameters as a starting - place in another request to return the rest of the results. - - - - - - Marks the last Key returned in a truncated response. - - - - - - Gets and sets the VersionIdMarker property. - Marks the last Version-Id returned in a truncated response. - - - - - Use this value for the key marker request parameter in a subsequent request. - - - - - - Use this value for the next version id marker parameter in a subsequent request. - - - - - - Gets and sets the Versions property. This is a list of - object versions in the bucket that match your search criteria. - - - - - Gets and sets the Name property. - The bucket's name. - - - - - Gets and sets the Prefix property. - Keys that begin with the indicated prefix are listed. - - - - - Gets and sets the MaxKeys property. - This is the maximum number of keys in the S3ObjectVersions collection. - The value is derived from the MaxKeys parameter to ListVersionsRequest. - - - - - Gets the CommonPrefixes property. - A response can contain CommonPrefixes only if you specify a delimiter. - When you do, CommonPrefixes contains all (if there are any) keys between - Prefix and the next occurrence of the string specified by delimiter. - - - - - Gets and sets the Delimiter property. - Causes keys that contain the same string between the prefix and the - first occurrence of the delimiter to be rolled up into a single result - element in the CommonPrefixes collection. - - - These rolled-up keys are not returned elsewhere in the response. - - - - - This class contains the meta data for an S3 object. - - - - - Gets and sets meta data for the object. Meta data names must start with "x-amz-meta-". If the name passeed in as the indexer - doesn't start with "x-amz-meta-" then it will be prepended. - - The name of the meta data. - The value for the meta data - - - - Adds the metadata to the collection, if the name already exists it will be overwritten. - - The name of the metadata element - The value for the metadata - - - - Gets the count of headers. - - - - - Gets the names of the meta data elements. - - - - - A metadata key-value pair to store with an object. - - - - - Key of metadata key-value pair - - - - - Value of metadata key-value pair - - - - - A container specifying replication metrics-related information, including whether - emitting metrics and Amazon S3 events for replication are enabled. In addition, contains - configurations related to specific metrics or events. Must be specified together with a - ReplicationTime block. - - - - - Specifies whether the replication metrics are enabled. - - - - - A container specifying the time threshold for emitting the - s3:Replication:OperationMissedThreshold event. - - - - - Class for MetricsAndOperatorPredicate - A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. - The operator must have at least two predicates, and an object must match all of the predicates - in order for the filter to apply. - - Note: The current implementation restricts the usage to atmost one MetricsPrefixPredicate - and any number of MetricsTagPredicates. - - - - Class for MetricsConfiguration - - - - - The ID used to identify the metrics configuration. - - - - - Specifies a metrics configuration filter. - The metrics configuration will only include objects that meet the filter's criteria. - A filter must be a prefix, a tag, or a conjunction (MetricsAndOperator). - - - - - Filter class for Metrics. - - - - - Filter Predicate setup for specific filter types. - - - - - Filter Predicate abstract class for specific filter types to be derived from. - - - - - Abstract class that can be used over logical filter predicates,i.e. AND/OR. - - - - - Class for MetricsPrefixPredicate - The prefix used when evaluating a metrics filter. - - - - - Class for MetricsTagPredicate - The tag used when evaluating a metrics filter. - - - - - This class contains the mfa codes used authentication - - - - - Gets and sets the serial number of the authentication device - - - - - Gets and sets the displated value on the authentication device - - - - - The formatted string of the mfa codes to be passed to S3. - - - - - Container for elements related to a particular multipart upload. - - - - - Date and time at which the multipart upload was initiated. - - - - - - Identifies who initiated the multipart upload. - - - - - - Key of the object for which the multipart upload was initiated. - - - - - - Gets and sets the Owner property. - - - - - The class of storage used to store the object. - - - - - - Upload ID that identifies the multipart upload. - - - - - - An abstract class for all the notification configurations associated with an Amazon S3 bucket. - - - - - Gets and sets the Events property. These are the events the configuration will listen to. - - - - - Filter criteria for determining which S3 objects trigger event notifications. - - - - - - The container element for Object Lock configuration parameters. - - - - - Gets and sets the property ObjectLockEnabled. - - Indicates whether this object has an Object Lock configuration enabled. - - - - - - Gets and sets the property Rule. - - The Object Lock rule in place for the specified object. - - - - - - A Legal Hold configuration for an object. - - - - - Gets and sets the property Status. - - Indicates whether the specified object has a Legal Hold in place. - - - - - - A Retention configuration for an object. - - - - - Gets and sets the property Mode. - - Indicates the Retention mode for the specified object. - - - - - - Gets and sets the property RetainUntilDate. - - - - - The container element for an Object Lock rule. - - - - - Gets and sets the property DefaultRetention. - - The default retention period that you want to apply to new objects placed in the specified - bucket. - - - - - - Describes the location where the restore job's output is stored. - - - - - Describes an S3 location that will receive the results of the restore request. - - - - - Describes how results of the Select job are serialized. - - - - - Describes the serialization of CSV-encoded Select results. - - - - - Specifies JSON as request's output serialization format. - - - - - The owner of an S3 bucket. - - - - - The display name of the owner. - - - - - The unique identifier of the owner. - - - - - This class contains custom querystring parameters for an S3 object, which can then be signed as part of a Pre-signed URL request - - - - - Gets and sets parameters for the object. Parameter names must start with "x-". If the name passeed in as the indexer - doesn't start with "x-" then it will be prepended. - - The name of the parameter. - The value for the meta data - - - - Adds the parameter to the collection, if the name already exists it will be overwritten. - - The name of the parameter - The value for the parameter - - - - Gets the count of parameters. - - - - - Gets the names of the parameter elements. - - - - - Specifies Parquet as object's input serialization format. - - - - - A container for elements related to a particular part in a multipart operation. - A response can contain zero or more Part elements. - - - - - The date and time at which the part was uploaded. - - - - - The size of the uploaded part data. - - - - - A container holding the part number and etag used when completing a multipart upload. - - - - - Default constructor. - - - - - Constructs an instance of PartETag and sets the part number and etag. - - The part number. - the associated ETag for the part number. - - - - Compares the current object with another object of the same type. - - An object to compare with this object. - - A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has the following meanings: - Value - Meaning - Less than zero - This object is less than the parameter. - Zero - This object is equal to . - Greater than zero - This object is greater than . - - - - - The part number identifying the part. - - - - - The entity tag associated with the part. - - - - - The container element for this bucket's public-policy status. - - - - - Gets and sets the property IsPublic. - - The public-policy status for this bucket. TRUE indicates that this bucket - is public. FALSE indicates that the bucket is not public. - - - - - - The container element for all Public Access Block configuration options. You can enable - the configuration options in any combination. - - - - Amazon S3 considers a bucket policy public unless at least one of the following conditions - is true: - -
  1. - - The policy limits access to a set of CIDRs using aws:SourceIp. For more - information on CIDR, see http://www.rfc-editor.org/rfc/rfc4632.txt - - -
  2. - - The policy grants permissions, not including any "bad actions," to one of the following: - -
    • - - A fixed AWS principal, user, role, or service principal - -
    • - - A fixed aws:SourceArn - -
    • - - A fixed aws:SourceVpc - -
    • - - A fixed aws:SourceVpce - -
    • - - A fixed aws:SourceOwner - -
    • - - A fixed aws:SourceAccount - -
    • - - A fixed value of s3:x-amz-server-side-encryption-aws-kms-key-id - -
    • - - A fixed value of aws:userid outside the pattern "AROLEID:*" - -
- - "Bad actions" are those that could expose the data inside a bucket to reads or writes - by the public. These actions are s3:Get*, s3:List*, s3:AbortMultipartUpload, - s3:Delete*, s3:Put*, and s3:RestoreObject. - - - - The star notation for bad actions indicates that all matching operations are considered - bad actions. For example, because s3:Get* is a bad action, s3:GetObject, - s3:GetObjectVersion, and s3:GetObjectAcl are all bad actions. - - - - - - Gets and sets the property BlockPublicAcls. - - Specifies whether Amazon S3 should block public ACLs for this bucket. Setting this - element to TRUE causes the following behavior: - -
  • - - PUT Bucket acl and PUT Object acl calls will fail if the specified ACL allows public - access. - -
  • - - PUT Object calls will fail if the request includes an object ACL. - -
- - Note that enabling this setting doesn't affect existing policies or ACLs. - - - - - - Gets and sets the property IgnorePublicAcls. - - Specifies whether Amazon S3 should ignore public ACLs for this bucket. Setting this - element to TRUE causes Amazon S3 to ignore all public ACLs on this bucket - and any objects that it contains. - - - - Note that enabling this setting doesn't affect the persistence of any existing ACLs - and doesn't prevent new public ACLs from being set. - - - - - - Gets and sets the property BlockPublicPolicy. - - Specifies whether Amazon S3 should block public bucket policies for this bucket. Setting - this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy - if the specified bucket policy allows public access. - - - - Note that enabling this setting doesn't affect existing bucket policies. - - - - - - Gets and sets the property RestrictPublicBuckets. - - Specifies whether Amazon S3 should restrict public bucket policies for this bucket. - If this element is set to TRUE, then only the bucket owner and AWS Services - can access this bucket if it has a public policy. - - - - Note that enabling this setting doesn't affect previously stored bucket policies, - except that public and cross-account access within any public bucket policy, including - non-public delegation to specific accounts, is blocked. - - - - - - Container for the parameters to the PutAcl operation. - uses the acl subresource to set the access control list (ACL) permissions for an object that already exists in a bucket - - - - - The canned ACL to apply to the bucket. - - - - - - Custom ACLs to be applied to the bucket or object. - - - - - The bucket name that contains the object to which you want to attach the ACL. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The key of an S3 object. - If not specified, the ACLs are applied to the bucket. - - - - - If set and an object key has been specified, the ACLs are applied - to the specific version of the object. - This property is ignored if the ACL is to be set on a Bucket. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - Returns information about the PutObjectAcl response metadata. - The PutAcl operation has a void result type. - - - - - The response for the PutBucketAccelerateConfiguration operation. - Adds an object to a bucket. - - - - - Container for the parameters to the PutBucketAccelerateConfiguration request. - - - - - The name of the bucket to contain the object. - - - - - Accelerate configuration for the bucket. - - - - - Container for the parameters to the PutBucketAnalyticsConfiguration operation. - Sets an analytics configuration for the bucket (specified by the analytics configuration ID). - - - - - The name of the bucket to which an analytics configuration is stored. - - - - - The identifier used to represent an analytics configuration. - - - - - The configuration and any analyses for the analytics filter. - - - - - Returns information about the PutBucketAnalyticsConfigurationResponse response metadata. - The PutBucketAnalyticsConfigurationResponse operation has a void result type. - - - - - Container for the parameters to the PutBucketRequestPayment operation. - Creates a new server-side encryption configuration (or replaces an existing one, if present). - - - - - The name of the bucket for which the server-side encryption configuration is set. - - - - - The base64-encoded 128-bit MD5 digest of the server-side encryption configuration. - - - This header can be used as a message integrity check to verify that the data is the same data that was originally sent. - Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. - - - - - Container for server-side encryption configuration rules. Currently S3 supports one rule only. - - - - - Container for the parameters to the PutBucketRequestPayment operation. - Adds an inventory configuration (identified by the inventory ID) from the bucket. - - - - - The name of the bucket where the inventory configuration will be stored. - - - - - Specifies the inventory Id. - - - - - Specifies the inventory configuration. - - - - - Returns information about the PutInventoryConfigurationResponse response metadata. - The PutInventoryConfigurationResponse operation has a void result type. - - - - - Container for the parameters to the PutBucketLoggingRequest operation. - Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. To set the - logging status of a bucket, you must be the bucket owner. - - - - - Gets and sets the BucketName property. - - - - - Gets and sets the LoggingConfig property. - - - - - Returns information about the PutBucketLogging response metadata. - The EnableBucketLogging operation has a void result type. - - - - - Container for the parameters to the PutBucketMetricsConfigurationRequest operation. - Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. - - - - - The name of the bucket for which the metrics configuration is set. - - - - - The ID used to identify the metrics configuration. - - - - - Specifies the metrics configuration. - - - - - Returns information about the PutBucketMetricsConfiguration response metadata. - The PutBucketMetricsConfiguration operation has a void result type. - - - - - Container for the parameters to the PutBucketNotification operation. - Enables notifications of specified events for a bucket. - - - - - Gets and sets the BucketName property. - - - - - Gets and sets the TopicConfigurations property. TopicConfigurations are configuration for Amazon S3 - events to be sent to Amazon SNS topics. - - - - - Gets and sets the QueueConfigurations property. QueueConfigurations are configuration for Amazon S3 - events to be sent to Amazon SQS queues. - - - - - Gets and sets the LambdaFunctionConfigurations property. LambdaFunctionConfigurations are configuration for - Amazon S3 events to be sent to an Amazon Lambda cloud function. - - - - - Returns information about the PutBucketNotification response metadata. - The PutBucketNotification operation has a void result type. - - - - - Container for the parameters to the PutBucketPolicy operation. - Replaces a policy on a bucket. If the bucket already has a policy, the one in this request completely replaces it. - - - - - The name of the bucket. - - - - - The base64 encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. - - - This header can be used as a message integrity check to verify that the data is the same data that was originally sent. - Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. - - - - - The bucket policy as a JSON document. - - - - - Set this parameter to true to confirm that you want to remove your - permissions to change this bucket policy in the future. - - - - - Overriden to turn off sending SHA256 header. - - - - - Returns information about the PutBucketPolicy response metadata. - The PutBucketPolicy operation has a void result type. - - - - - Container for the parameters to the PutBucketReplication operation. - Sets replication configuration for your bucket. If a replication configuration exists, this replaces it. - - - - - The name of the bucket to have the replication configuration applied. - - - - - The replication configuration to be applied. - - - - - Gets and sets the property Token. - - - - - Returns information about the PutBucketReplicationConfiguration response metadata. - The PutBucketReplicationConfiguration operation has a void result type. - - - - - Container for the parameters to the PutBucket operation. - Creates a new bucket. - - - - - The canned ACL to apply to the bucket. - - - - - - If set to true the bucket will be created in the same region - as the configuration of the AmazonS3 client. - If PutBucketRequest.BucketRegion or PutBucketRequest.BucketRegionName are set they take precedence over - this property. - Default: true. - - - - - The name of the bucket to be created. - - - - - The region locality for the bucket. - - - When set, this will determine where your data will - reside in S3. Refer - for a list of possible values. - - - - - The bucket region locality expressed using the name of the region. - When set, this will determine where your data will reside in S3. - Valid values: us-east-1, us-west-1, us-west-2, eu-west-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, sa-east-1 - - - - - Gets and sets the property ObjectLockEnabledForBucket. - - Specifies whether you want S3 Object Lock to be enabled for the new bucket. - - - - - - Container for the parameters to the PutBucketRequestPayment operation. - Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This - configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the - download. - - - - - The name of the bucket to set payment config. - - - - - Gets and sets request payment configuration - - - - - Returns information about the PutBucketRequestPayment response metadata. - The PutBucketRequestPayment operation has a void result type. - - - - - Returns information about the PutBucket response and response metadata. - - - - - Container for the parameters to the PutBucketTagging operation. - Sets the tags for a bucket. - - - - - The name of the bucket to apply the tags to. - - - - - The collection of tags. - - - - - Returns information about the PutBucketTagging response metadata. - The PutBucketTagging operation has a void result type. - - - - - Container for the parameters to the PutBucketVersioning operation. - Sets the versioning state of an existing bucket. To set the versioning state, you must be the bucket owner. - - - - - The name of the bucket to be updated. - - - - - The MfaCodes Tuple associates the Serial Number and the current Token/Code displayed on the - Multi-Factor Authentication device associated with your AWS Account. - - - This is a required property for this request if:
- 1. EnableMfaDelete was configured on the bucket - containing this object's version.
- 2. You are deleting an object's version - - - - - Checks if the MfaCodes property is set. - - true if the MfaCodes property is set. - - - - The versioning configuration to apply to the bucket. - - - Once Versioning has been "Enabled" on a bucket, it can be "Suspended" - but cannot be switched "Off". If EnableMfaDelete is set, - the MfaCodes property needs to contain the Serial of and current Token - displayed on the MFA device. - - - - - Returns information about the PutBucketVersioning response metadata. - The PutBucketVersioning operation has a void result type. - - - - - Container for the parameters to the PutBucketWebsite operation. - Set the website configuration for a bucket. - - - - - The name of the bucket to apply the configuration to. - - - - - The website configuration to apply. The configuration defines the index - document suffix and custom error page. - - - - - Returns information about the PutBucketWebsite response metadata. - The PutBucketWebsite operation has a void result type. - - - - - Container for the parameters to the PutCORSConfiguration operation. - Sets the cors configuration for a bucket. - - - - - The name of the bucket to have the CORS configuration applied. - - - - - The CORS configuration to apply. - - - - - Returns information about the PutCORSConfiguration response metadata. - The PutCORSConfiguration operation has a void result type. - - - - - Container for the parameters to the PutLifecycleConfiguration operation. - Sets lifecycle configuration for your bucket. If a lifecycle configuration exists, it replaces it. - - - - - The name of the bucket to have the lifecycle configuration applied. - - - - - The lifecycle configuration to be applied. - - - - - Returns information about the PutLifecycleConfiguration response metadata. - The PutLifecycleConfiguration operation has a void result type. - - - - - Container for the parameters to the PutObjectLegalHold operation. - Applies a Legal Hold configuration to the specified object. - - - - - The bucket name containing the object that you want to place a Legal Hold on. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property ContentMD5. - - The MD5 signature for the configuration included in your request. - - - - - - Gets and sets the property Key. - - The key name for the object that you want to place a Legal Hold on. - - - - - - Gets and sets the property LegalHold. - - Container element for the Legal Hold configuration you want to apply to the specified - object. - - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property VersionId. - - The version ID of the object that you want to place a Legal Hold on. - - - - - - This is the response object from the PutObjectLegalHold operation. - - - - - Gets and sets the property RequestCharged. - - - - - Container for the parameters to the PutObjectLockConfiguration operation. - Places an Object Lock configuration on the specified bucket. The rule specified in - the Object Lock configuration will be applied by default to every new object placed - in the specified bucket. - - - - - Gets and sets the property BucketName. - - The bucket whose Object Lock configuration you want to create or replace. - - - - - - Gets and sets the property ContentMD5. - - The MD5 signature for the configuration included in your request. - - - - - - Gets and sets the property ObjectLockConfiguration. - - The Object Lock configuration that you want to apply to the specified bucket. - - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property Token. - - - - - This is the response object from the PutObjectLockConfiguration operation. - - - - - Gets and sets the property RequestCharged. - - - - - Container for the parameters to the PutObject operation. - Adds an object to a bucket. - - - Container for the parameters to the PutObject operation. - Adds an object to a bucket. - - - - - A canned access control list (CACL) to apply to the object. - Please refer to for - information on S3 Canned ACLs. - - - - - Input stream for the request; content for the request will be read from the stream. - - - - - - The full path and name to a file to be uploaded. - If this is set the request will upload the specified file to S3. - - - For WinRT and Windows Phone this property must be in the form of "ms-appdata:///local/file.txt". - - - - - - Text content to be uploaded. Use this property if you want to upload plaintext to S3. - The content type will be set to 'text/plain'. - - - - - If this value is set to true then the stream used with this request will be closed when all the content - is read from the stream. - Default: true. - - - - - If this value is set to true then the stream will be seeked back to the start before being read for upload. - Default: true. - - - - - If this value is set to true then a chunked encoding upload will be used for the request. - Default: true. - - - - - Bucket name to which the PUT operation was initiated. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - Gets and sets Key property. This key is used to identify the object in S3. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - Checks if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - true if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - - - The type of storage to use for the object. Defaults to 'STANDARD'. - - - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - The Legal Hold status that you want to apply to the specified object. - - - - - - Gets and sets the property ObjectLockMode. - - The Object Lock mode that you want to apply to this object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - The date and time when you want this object's Object Lock to expire. - - - - - - If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - Attach a callback that will be called as data is being sent to the AWS Service. - - - - - This is a convenience property for Headers.ContentType. - - - - - An MD5 digest for the content. - - - - The base64 encoded 128-bit MD5 digest of the message - (without the headers) according to RFC 1864. This header - can be used as a message integrity check to verify that - the data is the same data that was originally sent. - - - If supplied, after the file has been uploaded to S3, - S3 checks to ensure that the MD5 hash of the uploaded file - matches the hash supplied. - - - Although it is optional, we recommend using the - Content-MD5 mechanism as an end-to-end integrity check. - - - - - - Checks if MD5Digest property is set. - - true if MD5Digest property is set. - - - - Overriden to turn off sending SHA256 header. - - - - - Overriden to turn on expect 100 continue. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - The tag-set for the object. The tag-set must be encoded as URL Query parameters. - - - - - Checks if Tagging property is set - - true if Tagging is set. - - - - Returns information about the PutObject response and response metadata. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - Entity tag for the uploaded object. - - - - - - Version of the object. - - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the PutObjectRetention operation. - Places an Object Retention configuration on an object. - - - - - The bucket name that contains the object you want to apply this Object Retention configuration to. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property BypassGovernanceRetention. - - - - - Gets and sets the property ContentMD5. - - The MD5 signature for the configuration included in your request. - - - - - - Gets and sets the property Key. - - The key name for the object that you want to apply this Object Retention configuration - to. - - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property Retention. - - The container element for the Object Retention configuration. - - - - - - Gets and sets the property VersionId. - - The version ID for the object that you want to apply this Object Retention configuration - to. - - - - - - This is the response object from the PutObjectRetention operation. - - - - - Gets and sets the property RequestCharged. - - - - - Container for the parameters to the PutObjectTagging operation. - - - - - The bucket name containing the object. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Check to see if Bucket property is set - - - - - Gets and sets Key property. This key is used to identify the object in S3. - - - - - Check to see if Key property is set - - - - - The tag-set for the object. The tag-set must be encoded as URL Query parameters - - - - - Checks if Tagging property is set. - - - - - VersionId used to reference a specific version of the object. - - - - - - Returns information about the PutObjectTagging response and response metadata. - - - - - Version of the object. - - - - - Container for the parameters to the PutPublicAccessBlock operation. - Creates or modifies the Public Access Block configuration for an Amazon S3 bucket. - - - - - Gets and sets the property BucketName. - - The name of the Amazon S3 bucket whose Public Access Block configuration you want - to set. - - - - - - Gets and sets the property ContentMD5. - - The MD5 hash of the PutPublicBlock request body. - - - - - - Gets and sets the property PublicAccessBlockConfiguration. - - The Public Access Block configuration that you want to apply to this Amazon S3 bucket. - - - - - - This is the response object from the PutPublicAccessBlock operation. - - - - - Base class for put operations that can also put an ACL. - - - - - Gets the access control lists (ACLs) for this request. - Please refer to for information on - S3 Grants. - - - - - This class contains the configuration Amazon S3 uses to figure out what events you want to listen - and send the event to an Amazon SQS queue. - - The queue's policy must allow S3 to send messages to it. The utility method - Amazon.SQS.AmazonSQSClient.AuthorizeS3ToSendMessage(string,string) - can be used to help setup the queue policy. - - - - - - Gets and set the Id property. The Id will be provided in the event content and can be used - to identify which configuration caused an event to fire. If the Id is not provided for the configuration, one will be generated. - - - - - Gets and sets the Queue property. Amazon SQS queue to which Amazon S3 will publish a message - to report the specified events for the bucket. - - The queue's policy must allow S3 to send messages to it. The utility method - Amazon.SQS.AmazonSQSClient.AuthorizeS3ToSendMessage(string,string) - can be used to help setup the queue policy. - - - - - - This class defines the configuration for replication. - - - - - Indicates the ARN of the role to assume. - - - - - Check to see if the Role property is set. - - true if the Role property is set. - - - - Container for information about a particular replication rule. - Replication configuration must have at least one rule and can contain up to 1,000 rules. - - - - - Checks to see if the Rules property is set. - - true if the Rules property is set. - - - - Destination configuration for a replication rule. - - - - -

Amazon resource name (ARN) of the bucket where you want Amazon - S3 to store replicas of the object identified by the rule.

- If you have multiple rules in your replication configuration, all - rules must specify the same bucket as the destination. A replication - configuration can replicate objects only to one destination bucket.

- - - - - Checks to see if BucketArn property is set. - - true if BucketArn property is set. - - - - The class of storage used to store the object. - - - - - -

Account ID of the destination bucket. Currently Amazon S3 verifies this - value only if Access Control Translation is enabled.

In a cross-account - scenario, if you tell Amazon S3 to change replica ownership to the AWS account - that owns the destination bucket by adding the AccessControlTranslation - element, this is the account ID of the destination bucket owner.

- - - - -

Container for information regarding the access control for replicas.

-

Use only in a cross-account scenario, where source and destination bucket - owners are not the same, when you want to change replica ownership to the AWS - account that owns the destination bucket. If you don't add this element to the - replication configuration, the replicas are owned by same AWS account that - owns the source object.

- - - - -

Container that provides encryption-related information. You must - specify this element if the SourceSelectionCriteria is - specified.

- - - - - A container specifying the time when all objects and operations on objects are - replicated. Must be specified together with a Metrics block. - - - - - A container specifying replication metrics-related information, including whether - emitting metrics and Amazon S3 events for replication are enabled. In addition, - contains configurations related to specific metrics or events. Must be specified - together with a ReplicationTime block. - - - - - Rule that specifies the replication configuration. - - - - - Unique identifier for the rule. The value cannot be longer than 255 characters. - - - - - Checks to see if Id property is set. - - true if Id property is set. - - - -

The priority associated with the rule. If you specify multiple rules in a - replication configuration, then Amazon S3 applies rule priority in the event - there are conflicts (two or more rules identify the same object based on - filter specified). The rule with higher priority takes precedence. For - example,

  • Same object quality prefix based filter criteria - If prefixes you specified in multiple rules overlap.

  • Same - object qualify tag based filter criteria specified in multiple rules

    • -

For more information, see - - Cross-Region Replication (CRR) in the Amazon S3 Developer Guide.

- - - - - Checks to see if Priority property is set. - - true if Priority property is set. - - - - Object keyname prefix identifying one or more objects to which the - rule applies. Maximum prefix length can be up to 1,024 characters. - - - - - Checks to see if Prefix property is set. - - true if Prefix property is set. - - - - Gets and sets the property Filter. - - - - - Checks to see if Filter property is set. - - true if Filter property is set. - - - - Whether the rule is applied or ignored. - - - - - Checks to see if Status property is set. - - true if Status property is set. - - - - Container for replication destination information. - - - - - Checks to see if Destination property is set. - - true if Destination property is set. - - - -

Container that describes additional filters in identifying source objects that - you want to replicate. Currently, Amazon S3 supports only the filter that you can - specify for objects created with server-side encryption using an AWS KMS-managed - key. You can choose to enable or disable replication of these objects.

if - you want Amazon S3 to replicate objects created with server-side encryption using - AWS KMS-managed keys.

- - - - - A container that specifies information about existing object replication. - You can choose whether to enable or disable the replication of existing objects. - - - - - Checks to see if ExistingObjectReplication property is set. - - true if ExistingObjectReplication property is set. - - - - Specifies whether Amazon S3 should replicate delete makers. - - - - - Checks to see if DeleteMarkerReplication property is set. - - true if DeleteMarkerReplication property is set. - - - - - - - - Object keyname prefix that identifies subset of objects to which the rule applies. - - - - - Checks to see if Prefix property is set. - - true if Prefix property is set. - - - - All of these tags must exist in the object's tag set in order for the rule to apply. - - - - - Checks to see if Tags property is set. - - true if Tags property is set. - - - - Filter that identifies subset of objects to which the replication rule applies. - A Filter must specify exactly one Prefix, - Tag, or an And child element. - - - - - Object keyname prefix that identifies subset of objects to which the rule applies. - - - - - Checks to see if Prefix property is set. - - true if Prefix property is set. - - - -

Container for specifying a tag key and value.

-

The rule applies only to objects having the tag in its tagset.

- - - - - Checks to see if Tag property is set. - - true if Tag property is set. - - - -

Container for specifying rule filters. These filters determine the - subset of objects to which the rule applies. The element is required - only if you specify more than one filter. For example:

  • -

    You specify both a Prefix and a Tag - filters. Then you wrap these in an And tag.

    • -

  • You specify filter based on multiple tags. Then you wrap the - Tag elements in an And tag.

- - - - - Checks to see if And property is set. - - true if And property is set. - - - - A container specifying the time when all objects and operations on objects are replicated. Must be specified together with a Metrics block. - - - - - Specifies whether the replication time is enabled. - - - - - A container specifying the time by which replication should complete for all objects and operations on objects. - - - - - A container specifying the time value. - - - - - Contains an integer specifying time in minutes. - - - - - Request Payment Configuration - - - - - Specifies who pays for the download and request fees. - - - - - Container for values of the response headers that will be set on a response from a GetObject request. - These values override any headers that were set when the object was uploaded to S3. - - - - - A standard MIME type describing the format of the object data. - - - The content type for the content being uploaded. This property defaults to "binary/octet-stream". - For more information, refer to: - - - - - ContentLanguage header value. - - - - - Expiry header value. - - - - - CacheControl header value. - - - - - The ContentDisposition header value. - - - - - The ContentEncoding header value. - - - - - Container for the parameters to the RestoreObject operation. - Restores an archived copy of an object back into Amazon S3 - - - - - The bucket name or containing the object to restore. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the Key property. This key indicates the S3 object to restore. - - - - - Lifetime of the active copy in days - ** Do not use with restores that specify OutputLocation ** - - - - - VersionId used to reference a specific version of the object. - - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Glacier retrieval tier at which the restore will be processed. - ** Do not use with restores that specify OutputLocation ** - - - - - Glacier retrieval tier at which the restore will be processed. - ** Only use with restores that require OutputLocation ** - - - - - Type of restore request. - - - - - The optional description for the job. - - - - - Describes the parameters for Select job types. - - - - - Describes the location where the restore job's output is stored. - - - - - Returns information about the RestoreObject response metadata. - The RestoreObject operation has a void result type. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Indicates the path in the provided S3 output location where Select results will be restored to. - - - - Routing Rule - - - - - A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the - /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might - process the error. - - - - - - Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event of an - error, you can can specify a different error code to return. - - - - - - A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages - in the /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you - might process the error. - - - - - The HTTP error code when the redirect is applied. In the event of an error, if the error code equals this value, then the specified redirect - is applied. Required when parent element Condition is specified and sibling KeyPrefixEquals is not specified. If both are specified, then - both must be true for the redirect to be applied. - - - - - - The object key name prefix when the redirect is applied. For example, to redirect requests for ExamplePage.html, the key prefix will be - ExamplePage.html. To redirect request for all pages with the prefix docs/, the key prefix will be /docs, which identifies all objects in the - docs/ folder. Required when the parent element Condition is specified and sibling HttpErrorCodeReturnedEquals is not specified. If both - conditions are specified, both must be true for the redirect to be applied. - - - - - - Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event - of an error, you can can specify a different error code to return. - - - - - Name of the host where requests will be redirected. - - - - - - The HTTP redirect code to use on the response. Not required if one of the siblings is present. - - - - - - Protocol to use (http, https) when redirecting requests. The default is the protocol that is used in the original request. - - - - - - The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix docs/ (objects in the - docs/ folder) to documents/, you can set a condition block with KeyPrefixEquals set to docs/ and in the Redirect set ReplaceKeyPrefixWith to - /documents. Not required if one of the siblings is present. Can be present only if ReplaceKeyWith is not provided. - - - - - - The specific object key to use in the redirect request. For example, redirect request to error.html. Not required if one of the sibling is - present. Can be present only if ReplaceKeyPrefixWith is not provided. - - - - - - Represents an access control list (ACL) for S3. An AccessControlList is represented by an Owner, - and a List of Grants, where each Grant is a Grantee and a Permission. - - - - Each bucket and object in Amazon S3 has an ACL that defines its access control policy. - When a request is made, Amazon S3 authenticates the request using its standard - authentication procedure and then checks the ACL to verify the sender was granted access - to the bucket or object. If the sender is approved, the request proceeds. - Otherwise, Amazon S3 returns an error. - - - An ACL is a list of grants. A grant consists of one grantee and one permission. - ACLs only grant permissions; they do not deny them. - - - For convenience, some commonly used Access Control Lists are defined in - S3CannedACL. - - - Note: BucketName and object ACLs are completely independent; an object does not inherit the ACL - from its bucket. For example, if you create a bucket and grant write access to another user, - you will not be able to access the user's objects unless the user explicitly grants access. - This also applies if you grant anonymous write access to a bucket. Only the user "anonymous" - will be able to access objects the user created unless permission is explicitly granted to - the bucket owner. - - - Important: We highly recommend that you do not grant the anonymous group write access to your - buckets as you will have no control over the objects others can store and their associated charges. - For more information, see Grantees and Permissions - - - - - Creates a S3Grant and adds it to the list of grants. - - The grantee for the grant. - The permission for the grantee. - - - - Removes a specific permission for the given grantee. - - The grantee - The permission for the grantee to remove - - - - Removes all permissions for the given grantee. - - - - - - The owner of the bucket or object. - - - - Every bucket and object in Amazon S3 has an owner, the user that - created the bucket or object. The owner of a bucket or object cannot - be changed. However, if the object is overwritten by another user - (deleted and rewritten), the new object will have a new owner. - - - Note: Even the owner is subject to the ACL. For example, if an owner - does not have Permission.READ access to an object, the owner cannot read - that object. However, the owner of an object always has write access to the - access control policy (Permission.WriteAcp) and can change the ACL to - read the object. - - - - - - Checks if Owner property is set. - - true if Owner property is set. - - - - A collection of grants. - - - - - Checks if Grants property is set. - - true if Grants property is set. - - - Bucket - Represents an S3 bucket, contains the name of the S3 bucket and the date that the bucket was created. - - - - - Date the bucket was created. - - - - - - The name of the bucket. - - - - - Logging Enabled - - - - - Specifies the bucket where you want Amazon S3 to store server access logs. You can have your logs delivered to any bucket that you own, - including the same bucket that is being logged. You can also configure multiple buckets to deliver their logs to the same target bucket. In - this case you should choose a different TargetPrefix for each source bucket so that the delivered log files can be distinguished by key. - - - - - A collection of grants. - - - - - This element lets you specify a prefix for the keys that the log files will be stored under. - - - - - Creates a S3Grant and adds it to the list of grants. - - The grantee for the grant. - The permission for the grantee. - - - - Removes a specific permission for the given grantee. - - The grantee - The permission for the grantee to remove - - - - Removes all permissions for the given grantee. - - - - - - An S3 bucket versioning configuration. - - - Contains the bucket's versioning status (Off, Enabled, Suspended) and whether an MFADelete - has been enabled for the bucket. - - - - - Versioning status for the bucket. - Accepted values: Off, Enabled, Suspended. - - - - - Checks if Status property is set - - true if Status property is set - - - - Specifies whether MFA Delete is enabled on this S3 Bucket. - - - If this property is set, please ensure that the - PutBucketVersioningRequest's MfaCodes property is set with - the Serial of and Token on the MFA device. - - - - - Checks if EnableMfaDelete property is set. - - true if Status property is set - - - - Describes the server-side encryption that will be applied to the restore results. - - - - - The server-side encryption algorithm used when storing job results in Amazon S3 (e.g., AES256, aws:kms). - - - - - Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by - AWS KMS will fail if not made via SSL or using SigV4. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at - http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version - - - - - If the encryption type is aws:kms, this optional value can be used to specify the encryption context for the restore results. - - - - Grant - - - - - The grantee details. - - - - - Specifies the permission given to the grantee. - - - - - Grantee - - - - - Type of grantee - - - - - - Screen name of the grantee. - - - - - - Email address of the grantee. - - - - - - The canonical user ID of the grantee. - - - - - - URI of the grantee group. - - - - - - Filter criteria that allows for event notification filtering based on an S3 Object's key name. - - - - - Gets and sets the filterRules property. - These are the filter rules for this filter. - - - - - Describes an S3 location that will receive the results of the restore request. - - - - - The name of the bucket where the restore results will be placed. - - - - - The prefix that is prepended to the restore results for this request. - - - - - The canned ACL to apply to the restore results. - - - - - A list of grants that control access to the staged results. - - - - - The tag-set that is applied to the restore results. - - - - - A map of metadata to store with the restore results in S3. - - - - - The class of storage used to store the restore results. - - - - - Represents an S3 Object. Contains all attributes that an S3 Object has. - For more information about S3 Objects refer: - - - - - - Any ETag set on the object. - - - - - The name of the bucket containing this object. - - - - - The key of the object. - - - - - The date and time the object was last modified. - - The date retrieved from S3 is in ISO8601 format. A GMT formatted date is passed back to the user. - - - - - - The owner of the object. - - - - - The size of the object. - - - - - The class of storage used to store the object. - - - - - - Represents a version of an object in an S3 Bucket. An S3 object version is an S3 object - that also has a version identifier, an indication of whether this is the latest version of the object - and whether it's a DeleteMarker or not. - - - - - Specifies whether the object is (true) or is not (false) the latest version of an object. - - - - - Version ID of an object. - - - - - If true, the object is a delete marker for a deleted object. - - - - - Specifies the byte range of the object to get the records from. A record is processed when its first byte is contained by the range. - - - - - Specifies the start of the byte range. This parameter is optional. Valid values: non-negative integers. The default value is 0. - - - - - Specifies the end of the byte range. This parameter is optional. Valid values: non-negative integers. The default value is one less than the size of the object being queried. - - - - - Request to filter the contents of an Amazon S3 object based on a simple Structured Query Language (SQL) statement. - - In the request, along with the SQL expression, you must also specify a data serialization format (JSON or CSV) of the object. - Amazon S3 uses this to parse object data into records, and returns only records - that match the specified SQL expression. You must also specify the data serialization format for the response. - - - - S3Select API Documentation - - - - - The S3 Bucket. - - - - - The Object Key. - - - - - The SSE Algorithm used to encrypt the object. - - - Server-Side Encryption (Using Customer-Provided Encryption Keys. - - - - - The SSE Customer Key. - - - Server-Side Encryption (Using Customer-Provided Encryption Keys. - - - - - The SSE Customer Key MD5. - - - Server-Side Encryption (Using Customer-Provided Encryption Keys. - - - - - The expression that is used to query the object. - - - - - The type of the provided expression (e.g., SQL). - - - - - Specifies if periodic request progress information should be enabled. - - - - - Describes the format of the data in the object that is being queried. - - - - - Describes the format of the data that you want Amazon S3 to return in response. - - - - - The byte range of the object to get the records from. - - - - - Contains the response Payload for the SelectObjectContent request - - - - - The Event Stream result of SelectObjectContent - - - - - Describes the parameters for Select job types. - - - - - Describes the serialization format of the object. - - - - - The type of the provided expression (e.g., SQL). - - - - - The expression that is used to query the object. - - - - - Describes how the results of the Select job are serialized. - - - - - ServerSideEncryptionByDefault class - - - - - Server-side encryption algorithm to use for the default encryption. - - - - - KMS master key ID to use for the default encryption. - This parameter is allowed if SSEAlgorithm is aws:kms. - - - - - ServerSideEncryptionConfiguration class - - - - - Container for information about a particular server-side encryption configuration rule. - - - - - ServerSideEncryptionRule class - - - - - Describes the default server-side encryption to apply to - new objects in the bucket. If Put Object request - does not specify any server-side encryption, - this default encryption will be applied. - - - - - SourceSelectionCriteria class - - - - - Container for filter information of selection of KMS Encrypted - S3 objects. The element is required if you include - SourceSelectionCriteria in the replication - configuration. - - - - - SSEKMS class - - - - - Specifies the ID of the AWS Key Management Service (KMS) - master encryption key to use for encrypting Inventory reports. - - - - - SseKmsEncryptedObjects class - - - - - The replication for KMS encrypted S3 objects is disabled if status is not Enabled. - - - - - SSES3 class - - - - - Class for StorageClassAnalysis - - - - - A container used to describe how data related to the storage class analysis should be exported. - - - - - Class for StorageClassAnalysisDataExport - - - - - The version of the output schema to use when exporting data. Must be V_1. - - - - - The place to store the data for an analysis. - - - - - Base class for responses that return a stream. - - - - - Disposes of all managed and unmanaged resources. - - - - - An open stream read from to get the data from S3. In order to - use this stream without leaking the underlying resource, please - wrap access to the stream within a using block. - - - - - The exception that is thrown when the size of a stream does not match it's expected size. - - - - - Gets and sets ExpectedSize property. - - - - - Gets and sets ActualSize property. - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - - - Tag is a key-value pair of metadata associated with an S3Object - - - - - Name of the tag. - - - - - Value of the tag. - - - - - Structure that contains list of Tags - - - - - TagSet - - - - - This class contains the configuration Amazon S3 uses to figure out what events you want to listen - and send the event to an Amazon SNS topic. - - The topic's policy must allow S3 to publish messages to it. The utility method - Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.AuthorizeS3ToPublish(string,string) - can be used to help setup the topic policy. - - - - - - Gets and set the Id property. The Id will be provided in the event content and can be used - to identify which configuration caused an event to fire. If the Id is not provided for the configuration, one will be generated. - - - - - Bucket event for which to send notifications. - - Topic configurations can now contain multiple events. This property is obsolete in favor of the Events property. - This property will always get or set the the zeroth element in the Events collection. - - - - - - Gets and sets the Topic property. Amazon SNS topic to which Amazon S3 will publish a message to report the - specified events for the bucket. - - The topic's policy must allow S3 to publish messages to it. The utility method - Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.AuthorizeS3ToPublish(string,string) - can be used to help setup the topic policy. - - - - - - The parameters to request upload of a part in a multipart upload operation. - - - - If PartSize is not specified then the rest of the content from the file - or stream will be sent to Amazon S3. - - - You must set either the FilePath or InputStream. If FilePath is set then the FilePosition - property must be set. - - - - The parameters to request upload of a part in a multipart upload operation. - - - - If PartSize is not specified then the rest of the content from the file - or stream will be sent to Amazon S3. - - - You must set either the FilePath or InputStream. If FilePath is set then the FilePosition - property must be set. - - - - - - Caller needs to set this to true when uploading the last part. This property only needs to be set - when using the AmazonS3EncryptionClient. - - - - - Input stream for the request; content for the request will be read from the stream. - - - - - The name of the bucket containing the object to receive the part. - - - - - The key of the object. - - - - - Part number of part being uploaded. - - - - - - The size of the part to be uploaded. - - - - - Checks if PartSize property is set. - - true if PartSize property is set. - - - - Upload ID identifying the multipart upload whose part is being uploaded. - - - - - - An MD5 digest for the part. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - - Full path and name of a file from which the content for the part is retrieved. - - - For WinRT and Windows Phone this property must be in the form of "ms-appdata:///local/file.txt". - - - - - - Checks if the FilePath property is set. - - true if FilePath property is set. - - - - Position in the file specified by FilePath from which to retrieve the content of the part. - This field is required when a file path is specified. It is ignored when using the InputStream property. - - - - - If this value is set to true then a chunked encoding upload will be used for the request. - Default: true. - - - - - Checks if the FilePosition property is set. - - true if FilePosition property is set. - - - - Checks if the MD5Digest property is set. - - true if Md5Digest property is set. - - - - Attach a callback that will be called as data is being sent to the AWS Service. - - - - - Overriden to turn off sending SHA256 header. - - - - - Overriden to turn on Expect 100 continue. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the UploadPart response and response metadata. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - Entity tag for the uploaded object. - - - - - - Gets and sets the part number specified for the part upload. This is needed when - completing the multipart upload. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - Website Configuration - - - - - The ErrorDocument value, an object key name to use when a 4XX class error occurs. - - - - - - This value is a suffix that is appended to a request that is for a "directory" - on the website endpoint (e.g. if the suffix is index.html and - you make a request to samplebucket/images/ the data that - is returned will be for the object with the key name - images/index.html) - - - The suffix must not be empty and must not include a slash - character. - - - - - - Container for redirect information where all requests will be redirect - to. You can redirect requests to another host, to another page, or with - another protocol. In the event of an error, you can can specify a - different error code to return. . - - - - - The list of routing rules that can be used for configuring redirects if certain conditions are meet. - - - - - Arguments containing event details for an in-flight transfer. - - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - - - - Gets the percentage of transfer completed - - - - - Gets the number of bytes transferred since last event - - - - - Gets the number of bytes transferred - - - - - Gets the total number of bytes to be transferred - - - - - Returns a string representation of this object - - - - - - AmazonS3 exception. - Thrown when DeleteObjects returns successfully, but some of the objects - were not deleted. - - - - - Gets and sets the ErrorResponse property. - The DeleteObjectsErrorResponse associated with this exception. - - - - - Constructs an instance of DeleteObjectsException - - - - - - The file format used when exporting data to Amazon S3. - - - - - CSV file format. - - - - - Construct instance of AnalyticsS3ExportFileFormat. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to an AnalyticsS3ExportFileFormat. - - - - - - - Represents the accelerate status for a bucket. - - - - - Bucket acceleration is enabled. - - - - - Bucket acceleration is suspended. - - - - - Construct instance of BucketAccelerateStatus. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to an BucketAccelerateStatus - - - - - - - The status of the delete marker replication. - - - - - Delete marker replication is enabled. - - - - - Delete marker replication is disabled. - - - - - Construct instance of DeleteMarkerReplicationStatus. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to a DeleteMarkerReplicationStatus - - - - - - - A list of all possible CannedACLs that can be used - for S3 Buckets or S3 Objects. For more information about CannedACLs, refer to - . - - - - - Owner gets FULL_CONTROL. - No one else has access rights (default). - - - - - Owner gets FULL_CONTROL. - No one else has access rights (default). - - - - - Owner gets FULL_CONTROL and the anonymous principal is granted READ access. - If this policy is used on an object, it can be read from a browser with no authentication. - - - - - Owner gets FULL_CONTROL, the anonymous principal is granted READ and WRITE access. - This can be a useful policy to apply to a bucket, but is generally not recommended. - - - - - Owner gets FULL_CONTROL, and any principal authenticated as a registered Amazon - S3 user is granted READ access. - - - - - Owner gets FULL_CONTROL. Amazon EC2 gets READ access to GET an - Amazon Machine Image (AMI) bundle from Amazon S3. - - - - - Object Owner gets FULL_CONTROL, Bucket Owner gets READ - This ACL applies only to objects and is equivalent to private when used with PUT Bucket. - You use this ACL to let someone other than the bucket owner write content (get full control) - in the bucket but still grant the bucket owner read access to the objects. - - - - - Object Owner gets FULL_CONTROL, Bucket Owner gets FULL_CONTROL. - This ACL applies only to objects and is equivalent to private when used with PUT Bucket. - You use this ACL to let someone other than the bucket owner write content (get full control) - in the bucket but still grant the bucket owner full rights over the objects. - - - - - The LogDelivery group gets WRITE and READ_ACP permissions on the bucket. - - - - - Construct instance of S3CannedACL. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to an S3CannedACL - - - - - - - A list of all possible S3 Bucket region possibilities. For - more information, refer to - . - - - - - Specifies that the S3 Bucket should use US locality. - This is the default value. - - - - - Specifies that the S3 Bucket should use US-EAST-2 locality. - - - - - Specifies that the S3 Bucket should use EU locality which defaults to EU-WEST-1 - - - - - Specifies that the S3 Bucket should use the EU-NORTH-1 locality. - - - - - Specifies that the S3 Bucket should use the EU-WEST-1 locality. - - - - - Specifies that the S3 Bucket should use the EU-WEST-2 locality. - - - - - Specifies that the S3 Bucket should use the EU-WEST-3 locality. - - - - - Specifies that the S3 Bucket should use the EU-CENTRAL-1 locality. - - - - - Specifies that the S3 Bucket should use US-WEST-1 locality. - - - - - Specifies that the S3 Bucket should use US-WEST-2 locality. - - - - - Specifies that the S3 Bucket should use US-GOV-EAST-1 locality. - - - - - Specifies that the S3 Bucket should use US-GOV-WEST-1 locality. - - - - - Specifies that the S3 Bucket should use the AP-EAST-1 locality. - - - - - Specifies that the S3 Bucket should use the AP-SOUTHEAST-1 locality. - - - - - Specifies that the S3 Bucket should use the AP-SOUTHEAST-2 locality. - - - - - Specifies that the S3 Bucket should use the AP-NORTHEAST-1 locality. - - - - - Specifies that the S3 Bucket should use the AP-NORTHEAST-2 locality. - - - - - Specifies that the S3 Bucket should use the AP-NORTHEAST-3 locality. - - - - - Specifies that the S3 Bucket should use the AP-SOUTH-1 locality. - - - - - Specifies that the S3 Bucket should use the SA-EAST-1 locality. - - - - - Specifies that the S3 Bucket should use CN-NORTH-1 locality. - - - - - Specifies that the S3 Bucket should use CN-NORTHWEST-1 locality. - - - - - Specifies that the S3 Bucket should use CA-CENTRAL-1 locality. - - - - - Specifies that the S3 Bucket should use US-WEST-1 locality. - - - - - Specifies that the S3 Bucket should use CN-NORTH-1 locality. - - - - - Specifies that the S3 Bucket should use US-GOV-WEST-1 locality. - - - - - Construct instance of S3Region. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to the S3Region class - - - - - - - A list of all ACL permissions. For more information, refer to - . - - - - - When applied to a bucket, grants permission to list the bucket. - When applied to an object, this grants permission to read the - object data and/or metadata. - - - - - When applied to a bucket, grants permission to create, overwrite, - and delete any object in the bucket. This permission is not - supported for objects. - - - - - Grants permission to read the ACL for the applicable bucket or object. - The owner of a bucket or object always has this permission implicitly. - - - - - Gives permission to overwrite the ACP for the applicable bucket or object. - The owner of a bucket or object always has this permission implicitly. - Granting this permission is equivalent to granting FULL_CONTROL because - the grant recipient can make any changes to the ACP. - - - - - Provides READ, WRITE, READ_ACP, and WRITE_ACP permissions. - It does not convey additional rights and is provided only for convenience. - - - - - Gives permission to restore an object that is currently stored in Amazon Glacier - for archival storage. - - - - - Construct S3Permission. - - - - - - Construct instance of S3Permission. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - - Gets and sets the HeaderName property. - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to an S3Permission - - - - - - - An enumeration of all Metadata directives that - can be used for the CopyObject operation. - - - - - Specifies that the metadata is copied from the source object. - - - - - Specifies that the metadata is replaced with metadata provided in the request. - All original metadata is replaced by the metadata you specify. - - - - - An enumeration of all protocols that the pre-signed - URL can be created against. - - - - - https protocol will be used in the pre-signed URL. - - - - - http protocol will be used in the pre-signed URL. - - - - - An enumeration of supported HTTP verbs - - - - - The GET HTTP verb. - - - - - The HEAD HTTP verb. - - - - - The PUT HTTP verb. - - - - - The DELETE HTTP verb. - - - - - S3 Storage Class Definitions - - - - - The STANDARD storage class, which is the default - storage class for S3. - - Durability 99.999999999%; Availability 99.99% over a given year. - - - - - REDUCED_REDUNDANCY provides the same availability as standard, but at a lower durability. - - Durability 99.99%; Availability 99.99% over a given year. - - - - - The GLACIER storage is for object that are stored in Amazon Glacier. - This storage class is for objects that are for archival purpose and - get operations are rare. - - Durability 99.999999999% - - - - - The STANDARD_IA storage is for infrequently accessed objects. - This storage class is for objects that are long-lived and less frequently accessed, - like backups and older data. - - Durability 99.999999999%; Availability 99.9% over a given year. - - - - - The ONEZONE_IA storage is for infrequently accessed objects. It is similiar to STANDARD_IA, but - only stores object data within one Availablity Zone in a given region. - - Durability 99.999999999%; Availability 99% over a given year. - - - - - IntelligentTiering makes it easy to lower your overall cost of storage by automatically placing data in the storage - class that best matches the access patterns for the storage. With IntelligentTiering, you don’t need to define - and manage individual policies for lifecycle data management or write code to transition objects - between storage classes. Instead, you can use IntelligentTiering to manage transitions between Standard and - S-IA without writing any application code. IntelligentTiering also manages transitions automatically to - Glacier for long term archive in addition to S3 storage classes. - - - - - S3 Glacier Deep Archive provides secure, durable object storage class for long term data archival. - It is the ideal storage class to make an archival, durable copy of data that rarely, if ever, needs to be accessed. - It can be used as an offline backup for their most important data assets and to meet long-term retention needs. - - - - - Construct an instance of S3StorageClass. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to S3StorageClass. - - - - - - - The constants for the known event names used by S3 notification. S3 might add new - events before the SDK is updated. In which case the names listed in the S3 documentation - will work as well as these constants. - - - - - An event that says an object has been lost in the reduced redundancy storage. - - - - - A list of all server-side encryption methods for customer provided encryption keys. - - - - - No server side encryption to be used. - - - - - Use AES 256 server side encryption. - - - - - Constructs an instance of ServerSideEncryptionCustomerMethod. - - - - - - Finds the constant for the unique value. - - - - - - - Converts string to ServerSideEncryptionCustomerMethod. - - - - - - - A list of all server-side encryption methods. - - - - - No server side encryption to be used. - - - - - Use AES 256 server side encryption. - - - - - Use AWS Key Management Service for server side encryption. - - - - - Construct instance of ServerSideEncryptionMethod. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to ServerSideEncryptionCustomerMethod. - - - - - - - A list of all grantee types. - - - - - The predefined group. - - - - - The email address of an AWS account - - - - - The canonical user ID of an AWS account - - - - - Construct an instance of GranteeType. - - - - - - Finds the constant for the unique value. - - - - - - - Convert a string to GranteeType. - - - - - - - A list of all lifecycle statuses. - - - - - The rule is enabled. - - - - - The rule is disabled. - - - - - Constructs an instance LifecycleRuleStatus. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to LifecycleRuleStatus. - - - - - - - A list of all version statuses. - - - - - The rule is off. - - - - - The rule is suspended. - - - - - The rule is enabled. - - - - - Construct an instance of VersionStatus. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to VersionStatus. - - - - - - - A list of all encoding types. - - - - - Url encoding. - - - - - Constructs intance of EncodingType - - - - - - Finds the constant for the unique value. - - - - - - - Converts string to EncodingType - - - - - - - The bucket event for which to send notifications. - - - - - The event encapsulates all the object create events - - - - - Event for put operations - - - - - Event for post operations - - - - - Event for copy operations - - - - - Event for completing a multi part upload - - - - - This event encapsulates all the object removed events - - - - - Event for object removed, delete operation. - - - - - Event for object removed, delete marker created operation. - - - - - Event for objects stored in reduced redundancy and S3 detects the object is lost - - - - - Event for all object restore - - - - - Event for restore post operations. - - - - - Event for when object restore is completed. - - - - - Event for replication of all - - - - - Event for operation failed replication - - - - - Evemt for replication operation not tracked - - - - - Event for replication operation missed threshold - - - - - Event for operation replicated after threshold - - - - - Constructs instance of EventType. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to EventType. - - - - - - - Compares if the ConstantClass instances are equals. - - - - - - - Compares if the ConstantClass instances are equals. This is ovewritten to handle the - discrepancy with S3 events coming from Lambda that don't have the prefix "s3:". - - - - - - - A list of all Inventory Formats. - - - - - CSV inventory format - - - - - ORC inventory format - - - - - Parquet inventory format - - - - - Construct instance of InventoryFormat. - - - - - - Finds the constant for the unique value. - - The string representation of the InventoryFormat. - The InventoryFormat object for that string. - - - - Convert string to InventoryFormat. - - - - - - - A list of inventory included object versions. - - - - - All Inventory Included Object Versions - - - - - Current Inventory Included Object Versions - - - - - Construct instance of InventoryIncludedObjectVersions. - - - - - - Finds the constant for the unique value. - - The string representation of the InventoryIncludedObjectVersions. - The InventoryIncludedObjectVersions object for that string. - - - - Convert string to InventoryIncludedObjectVersions. - - - - - - - A list of inventory frequencies. - - - - - Daily Inventory Frequency - - - - - Weekly Inventory Frequency - - - - - Construct instance of InventoryFrequency. - - - - - - Finds the constant for the unique value. - - The string representation of the InventoryFrequency. - The InventoryFrequency object for that string. - - - - Convert string to InventoryFrequency. - - - - - - - A list of inventory optional fields. - - - - - InventoryOptionalField for Size - - - - - InventoryOptionalField for LastModifiedDate - - - - - InventoryOptionalField for StorageClass - - - - - InventoryOptionalField for ETag - - - - - InventoryOptionalField for IsMultipartUploaded - - - - - InventoryOptionalField for ReplicationStatus - - - - - InventoryOptionalField for EncryptionStatus - - - - - InventoryOptionalField for ObjectLockRetainUntilDate - - - - - InventoryOptionalField for ObjectLockMode - - - - - InventoryOptionalField for ObjectLockLegalHoldStatus - - - - - InventoryOptionalField for IntelligentTieringAccessTier - - - - - Construct instance of InventoryOptionalField. - - - - - - Finds the constant for the unique value. - - The string representation of the InventoryOptionalField. - The InventoryIncludedObjectVersions object for that string. - - - - Convert string to InventoryOptionalField. - - - - - - - The status of the replication job associated with this source object. - - - - - The object is pending replication. - - - - - The object has been replicated. - - - - - The object was created as a result of replication. - - - - - The object replication has failed due to a customer-attributable reason, and the replication will not be attempted again. - - - - - Construct instance of ReplicationStatus. - - - - - - Finds the constant for the unique value. - - The string representation of the ReplicationStatus. - The ReplicationStatus object for that string. - - - - Convert string to ReplicationStatus. - - - - - - - Whether a replication rule is applied or ignored. - - - - - The rule will be applied. - - - - - The rule will be ignored. - - - - - Construct instance of ReplicationRuleStatus - - - - - - Finds the constant for the unique value. - - The string representation of the ReplicationRuleStatus. - The ReplicationRuleStatus object for that string. - - - - Convert string to ReplicationRuleStatus. - - - - - - - Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request. - - - - - The object tag-set is copied from the source object. - - - - - The object tag-set is replaced with tag-set provided in the request. - - - - - Construct instance of TaggingDirective - - - - - Finds the constant for the unique value. - - The string representation of the TaggingDirective. - The TaggingDirective object for that string. - - - - Convert string to TaggingDirective. - - - - - All enumerations type for retrieval tier for Glacier restore. - - - - - Standard Tier for Glacier restore. - - - - - Bulk Tier for Glacier restore. - - - - - Expedited Tier for Glacier restore. - - - - - Construct instance of RestoreObjectRequestGlacierJobTier - - - - - - Finds the constant for the unique value. - - The string representation of the RestoreObjectRequestGlacierJobTier. - The RestoreObjectRequestGlacierJobTier object for that string. - - - - Convert string to RestoreObjectRequestGlacierJobTier. - - - - - - - The version of the output schema to use when exporting data. - - - - - The schema output version V_1. - - - - - Construct instance of StorageClassAnalysisSchemaVersion - - - - - - Finds the constant for the unique value. - - The string representation of the StorageClassAnalysisSchemaVersion. - The StorageClassAnalysisSchemaVersion object for that string. - - - - Convert string to StorageClassAnalysisSchemaVersion. - - - - - - - Acknowledges that requester pays for the operation. - - - - - Requester pays for the operation. - - - - - Finds the RequestPayer instance for the string value. - - - - - Converts string to RequestPayer instance - - - - - The response from S3 that it confirms that requester pays. - - - - - S3 acknowledges that the requester pays. - - - - - Finds the RequestCharged instance for the string value - - - - - converts the string to RequestCharged instance - - - - - The override value for the owner of the replica object. - - - - - Overrides destination bucket's owner. - - - - - Finds the OwnerOverride instance for the string value - - - - - converts the string to OwnerOverride instance - - - - - The replication for KMS encrypted S3 objects is disabled if status is not Enabled. - - - - - The replication for KMS encrypted S3 objects is enabled. - - - - - The replication for KMS encrypted S3 objects is disabled. - - - - - - - - - - Finds the SseKmsEncryptedObjectsStatus instance for the string value - - - - - Converts the string to SseKmsEncryptedObjectsStatus instance - - - - - Specify how headers will be handled. - - - - - Headers will be usable in SELECT clause. - - - - - Headers will be skipped - - - - - No header is present. - - - - - Finds the FileHeaderInfo instance for the string value - - - - - - - Converts the string to FileHeaderInfo instance - - - - - Specifies whether existing object replication is enabled. - - - - - Enable the replication of existing objects - - - - - Disable the replication of existing objects - - - - - Finds the ExistingObjectReplicationStatus instance for the string value - - - - - - - Converts the string to ExistingObjectReplicationStatus instance - - - - - Describes when fields in output should be surrounded with quotes. - - - - - Specifies that fields in output should always be surrounded in quotes. - - - - - Specifies that fields in output should be surrounded in quotes as necessary. - - - - - Finds the QuoteFields instance for the string value - - string value that maps to QuoteFields enum - QuoteFields enum - - - - Converts the string to QuoteFields instance - - - - - Type of the expression provided in the Expression member. - - - - - SQL expression - - - - - Finds the ExpressionType instance for the string value - - string value that maps to ExpressionType enum - ExpressionType enum - - - - Converts the string to ExpressionType instance - - - - - Indicates what type of job is being initiated. - - - - - Finds the RestoreRequestType instance for the string value - - - - - Converts the string to RestoreRequestType instance - - - - - The type of JSON. - - - - - Finds the JsonType instance for the string value - - - - - Converts the string to JsonType instance - - - - - Specifies object's compression format. - - - - - Finds the CompressionType instance for the string value - - - - - Converts the string to CompressionType instance - - - - - The type of ObjectLockEnabled - - - - - Finds the ObjectLockEnabled instance for the string value - - - - - Converts the string to ObjectLockEnabled instance - - - - - The type of ObjectLockLegalHoldStatus - - - - - Finds the ObjectLockLegalHoldStatus instance for the string value - - - - - Converts the string to ObjectLockLegalHoldStatus instance - - - - - The type of ObjectLockRetentionMode - - - - - Finds the ObjectLockRetentionMode instance for the string value - - - - - Converts the string to ObjectLockRetentionMode instance - - - - - The type of ObjectLockMode - - - - - Finds the ObjectLockMode instance for the string value - - - - - Converts the string to ObjectLockMode instance - - - - - Specifies whether the replication time is enabled. - - - - - Replication time is enabled. - - - - - Replication time is disabled. - - - - - Finds the ReplicationTimeStatus instance for the string value - - - - - - - Converts the string to ReplicationTimeStatus instance - - - - - - Specifies whether the replication metrics are enabled. - - - - - Replication metrics are enabled. - - - - - Replication metrics are disabled. - - - - - Finds the MetricsStatus instance for the string value - - - - - - - Converts the string to MetricsStatus instance - - - - - - The base class for requests that return Amazon S3 objects. - - - - - Gets or sets the name of the bucket. - - - The name of the bucket. - - - - - Gets whether or not the bucket name is set. - - - A value of true if the bucket name is set. - Returns false if otherwise. - - - - - Gets or sets the key under which the Amazon S3 object is stored. - - - The key under which the Amazon S3 object is stored. - - - - - Gets whether or not the key property is set. - - - A value of true if key property is set. - Returns false if otherwise. - - - - - Gets or sets the version ID of the Amazon S3 object. - - - The version ID of the Amazon S3 object. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or - ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Gets or sets the ModifiedSinceDate property. - - - The ModifiedSinceDate property. - - - - - Gets or sets the ModifiedSinceDate property. - - - The ModifiedSinceDate property. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or - UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Gets or sets the UnmodifiedSinceDate property. - - - The UnmodifiedSinceDate property. - - - - - Gets or sets the UnmodifiedSinceDate property. - - - The UnmodifiedSinceDate property. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to decrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - The base class TransferUtility request classes. - - - - - Waits for all of the tasks to complete or till any task fails or is canceled. - - - - - Waits for all of the tasks to complete or till any task fails or is canceled. - - - - - Returns the amount of bytes remaining that need to be pulled down from S3. - - The fully qualified path of the file. - - - - - The command to manage an upload using the S3 multipart API. - - - - - Initializes a new instance of the class. - - The s3 client. - The config object that has the number of threads to use. - The file transporter request. - - - - This command is for doing regular PutObject requests. - - - - - This command files all the files that meets the criteria specified in the TransferUtilityUploadDirectoryRequest request - and uploads them. - - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - - Gets the Amazon S3 client used for making calls into Amazon S3. - - - The Amazon S3 client used for making calls into Amazon S3. - - - - - Uploads the specified file. - The object key is derived from the file's name. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the specified file. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the contents of the specified stream. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The stream to read to obtain the content to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the stream to. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the file or stream specified by the request. - To track the progress of the upload, - add an event listener to the request's UploadProgressEvent. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - Contains all the parameters required to upload to Amazon S3. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Aborts the multipart uploads that were initiated before the specified date. - - - The name of the bucket containing multipart uploads. - - - The date before which the multipart uploads were initiated. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the content from Amazon S3 and writes it to the specified file. - If the key is not specified in the request parameter, - the file name will used as the key name. - - - Contains all the parameters required to download an Amazon S3 object. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Returns a stream from which the caller can read the content from the specified - Amazon S3 bucket and key. - The caller of this method is responsible for closing the stream. - - - The name of the bucket. - - - The object key. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Returns a stream to read the contents from Amazon S3 as - specified by the TransferUtilityOpenStreamRequest. - The caller of this method is responsible for closing the stream. - - - Contains all the parameters required for the OpenStream operation. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - A pattern used to identify the files from the source directory to upload. - - - A search option that specifies whether to recursively search for files to upload - in subdirectories. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The request that contains all the parameters required to upload a directory. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by s3Directory. - - - The name of the bucket containing the Amazon S3 objects to download. - - - The directory in Amazon S3 to download. - - - The local directory to download the objects to. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by the S3Directory - property of the passed in TransferUtilityDownloadDirectoryRequest object. - - - Contains all the parameters required to download objects from Amazon S3 - into a local directory. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the content from Amazon S3 and writes it to the specified file. - - - The file path where the content from Amazon S3 will be written to. - - - The name of the bucket containing the Amazon S3 object to download. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - A pattern used to identify the files from the source directory to upload. - - - A search option that specifies whether to recursively search for files to upload - in subdirectories. - - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The request that contains all the parameters required to upload a directory. - - - - - Uploads the specified file. - The object key is derived from the file's name. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - - - Uploads the specified file. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - The key under which the Amazon S3 object is stored. - - - - - Uploads the contents of the specified stream. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The stream to read to obtain the content to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the stream to. - - - The key under which the Amazon S3 object is stored. - - - - - Uploads the file or stream specified by the request. - To track the progress of the upload, - add an event listener to the request's UploadProgressEvent. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - Contains all the parameters required to upload to Amazon S3. - - - - - Returns a stream from which the caller can read the content from the specified - Amazon S3 bucket and key. - The caller of this method is responsible for closing the stream. - - - The name of the bucket. - - - The object key. - - - A stream of the contents from the specified Amazon S3 and key. - - - - - Returns a stream to read the contents from Amazon S3 as - specified by the TransferUtilityOpenStreamRequest. - The caller of this method is responsible for closing the stream. - - - Contains all the parameters required to open a stream to an S3 object. - - - A stream of the contents from Amazon S3. - - - - - Downloads the content from Amazon S3 and writes it to the specified file. - - - The file path where the content from Amazon S3 will be written to. - - - The name of the bucket containing the Amazon S3 object to download. - - - The key under which the Amazon S3 object is stored. - - - - - Downloads the content from Amazon S3 and writes it to the specified file. - If the key is not specified in the request parameter, - the file name will used as the key name. - - - Contains all the parameters required to download an Amazon S3 object. - - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by s3Directory. - - - The name of the bucket containing the Amazon S3 objects to download. - - - The directory in Amazon S3 to download. - - - The local directory to download the objects to. - - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by the S3Directory - property of the passed in TransferUtilityDownloadDirectoryRequest object. - - - Contains all the parameters required to download objects from Amazon S3 - into a local directory. - - - - - Aborts the multipart uploads that were initiated before the specified date. - - - The name of the bucket containing multipart uploads. - - - The date before which the multipart uploads were initiated. - - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - - Constructs a new class. - - - The AWS Access Key ID. - - - The AWS Secret Access Key. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new class. - - - The AWS Access Key ID. - - - The AWS Secret Access Key. - - - The region to configure the transfer utility for. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new instance of the class. - - - The AWS Access Key ID. - - - The AWS Secret Access Key. - - - Specifies advanced settings. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new instance of the class. - - - The AWS Access Key ID. - - - The AWS Secret Access Key. - - - The region to configure the transfer utility for. - - - Specifies advanced settings. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new instance of the class. - - - The Amazon S3 client. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Initializes a new instance of the class. - - - The Amazon S3 client. - - - Specifies advanced configuration settings for . - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new class. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new class. - - - The region to configure the transfer utility for. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new class. - - - Specifies advanced configuration settings for . - - - - - - - Gets the Amazon S3 client used for making calls into Amazon S3. - - - The Amazon S3 client used for making calls into Amazon S3. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Uploads the specified file. - The object key is derived from the file's name. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the specified file. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the contents of the specified stream. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The stream to read to obtain the content to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the stream to. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the file or stream specified by the request. - To track the progress of the upload, - add an event listener to the request's UploadProgressEvent. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - Contains all the parameters required to upload to Amazon S3. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Aborts the multipart uploads that were initiated before the specified date. - - - The name of the bucket containing multipart uploads. - - - The date before which the multipart uploads were initiated. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the content from Amazon S3 and writes it to the specified file. - If the key is not specified in the request parameter, - the file name will used as the key name. - - - Contains all the parameters required to download an Amazon S3 object. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Returns a stream from which the caller can read the content from the specified - Amazon S3 bucket and key. - The caller of this method is responsible for closing the stream. - - - The name of the bucket. - - - The object key. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Returns a stream to read the contents from Amazon S3 as - specified by the TransferUtilityOpenStreamRequest. - The caller of this method is responsible for closing the stream. - - - Contains all the parameters required for the OpenStream operation. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - A pattern used to identify the files from the source directory to upload. - - - A search option that specifies whether to recursively search for files to upload - in subdirectories. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The request that contains all the parameters required to upload a directory. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by s3Directory. - - - The name of the bucket containing the Amazon S3 objects to download. - - - The directory in Amazon S3 to download. - - - The local directory to download the objects to. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by the S3Directory - property of the passed in TransferUtilityDownloadDirectoryRequest object. - - - Contains all the parameters required to download objects from Amazon S3 - into a local directory. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the content from Amazon S3 and writes it to the specified file. - - - The file path where the content from Amazon S3 will be written to. - - - The name of the bucket containing the Amazon S3 object to download. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - A pattern used to identify the files from the source directory to upload. - - - A search option that specifies whether to recursively search for files to upload - in subdirectories. - - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The request that contains all the parameters required to upload a directory. - - - - - Uploads the specified file. - The object key is derived from the file's name. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - - - Uploads the specified file. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - The key under which the Amazon S3 object is stored. - - - - - Uploads the contents of the specified stream. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The stream to read to obtain the content to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the stream to. - - - The key under which the Amazon S3 object is stored. - - - - - Uploads the file or stream specified by the request. - To track the progress of the upload, - add an event listener to the request's UploadProgressEvent. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - Contains all the parameters required to upload to Amazon S3. - - - - - Returns a stream from which the caller can read the content from the specified - Amazon S3 bucket and key. - The caller of this method is responsible for closing the stream. - - - The name of the bucket. - - - The object key. - - - A stream of the contents from the specified Amazon S3 and key. - - - - - Returns a stream to read the contents from Amazon S3 as - specified by the TransferUtilityOpenStreamRequest. - The caller of this method is responsible for closing the stream. - - - Contains all the parameters required to open a stream to an S3 object. - - - A stream of the contents from Amazon S3. - - - - - Downloads the content from Amazon S3 and writes it to the specified file. - - - The file path where the content from Amazon S3 will be written to. - - - The name of the bucket containing the Amazon S3 object to download. - - - The key under which the Amazon S3 object is stored. - - - - - Downloads the content from Amazon S3 and writes it to the specified file. - If the key is not specified in the request parameter, - the file name will used as the key name. - - - Contains all the parameters required to download an Amazon S3 object. - - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by s3Directory. - - - The name of the bucket containing the Amazon S3 objects to download. - - - The directory in Amazon S3 to download. - - - The local directory to download the objects to. - - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by the S3Directory - property of the passed in TransferUtilityDownloadDirectoryRequest object. - - - Contains all the parameters required to download objects from Amazon S3 - into a local directory. - - - - - Aborts the multipart uploads that were initiated before the specified date. - - - The name of the bucket containing multipart uploads. - - - The date before which the multipart uploads were initiated. - - - - - - Provides configuration options for how processes requests. - - - The best configuration settings depend on network - configuration, latency and bandwidth. - The default configuration settings are suitable - for most applications, but this class enables developers to experiment with - different configurations and tune transfer manager performance. - - - - - - Default constructor. - - - - - Gets or sets the minimum part size for upload parts in bytes. The default is 16 MB. - Decreasing the minimum part size causes - multipart uploads to be split into a larger number - of smaller parts. Setting this value too low has a negative effect - on transfer speeds, causing extra latency and network - communication for each part. - - - - - This property determines how many active threads - or the number of concurrent asynchronous web requests - will be used to upload/download the file . - The default value is 10. - - - A value less than or equal to 0 will be silently ignored. - - - - - Gets or sets the number of executing threads. - This property determines how many active threads will be used to upload - the file. The default value is 10 threads. - - - A value less than or equal to 0 will be silently ignored. - - - - - Request object for downloading a directory with the TransferUtility. - - - - - Gets or sets the name of the bucket. - - - The name of the bucket. - - - - - Gets whether or not the bucket name is set. - - - A value of true if the bucket name is set. - Otherwise, returns false. - - - - - Gets or sets the local directory where objects from Amazon S3 will be downloaded. - If the directory doesn't exist, it will be created. - - - The local directory where objects from Amazon S3 will be downloaded. - - - - - Gets whether or not the LocalDirectory property is set. - - - A value of true if LocalDirectory property is set. - Otherwise, returns false. - - - - - Gets or sets the Amazon S3 directory to download from. - This is translated to a key prefix; keys that have this prefix will be - downloaded. - - - - - Gets whether or not the S3Directory property is set. - - - A value of true if S3Directory property is set. - Otherwise, returns false. - - - - - - This property is deprecated. This property doesn't honor the DateTimeKind, please - use ModifiedSinceDateUtc instead. - - Gets or sets the ModifiedSinceDate property. - Only objects that have been modified since this date will be - downloaded. - - - The ModifiedSinceDate property. - - - - - Checks if ModifiedSinceDate property is set. - - A value of true if ModifiedSinceDate property is set. - Otherwise, returns false. - - - - Gets or sets the ModifiedSinceDateUtc property. - Only objects that have been modified since this date will be - downloaded. - - - The ModifiedSinceDateUtc property. - - - - - Checks if ModifiedSinceDateUtc property is set. - - A value of true if ModifiedSinceDateUtc property is set. - Otherwise, returns false. - - - - - This property is deprecated. This property doesn't honor the DateTimeKind, please - use UnmodifiedSinceDateUtc instead. - - Gets or sets the UnmodifiedSinceDate property. - Only objects that have not been modified since this date will be downloaded. - - - The UnmodifiedSinceDate property. - - - - - Checks if UnmodifiedSinceDate property is set. - - true if UnmodifiedSinceDate property is set. - - - - Gets or sets the UnmodifiedSinceDateUtc property. - Only objects that have not been modified since this date will be downloaded. - - - The UnmodifiedSinceDateUtc property. - - - - - Checks if UnmodifiedSinceDateUtc property is set. - - true if UnmodifiedSinceDateUtc property is set. - - - - Gets or sets the DownloadFilesConcurrently property. - Specifies if multiple files will be downloaded concurrently. - The number of concurrent web requests used is controlled - by the TransferUtilityConfig.ConcurrencyLevel property. - - - - - The event for DownloadedDirectoryProgressEvent notifications. All - subscribers will be notified when a new progress - event is raised. - - The DownloadedDirectoryProgressEvent is fired as data - is downloaded from Amazon S3. The delegates attached to the event - will be passed information detailing how much data - has been downloaded as well as how much will be downloaded. - - - - Subscribe to this event if you want to receive - DownloadedDirectoryProgressEvent notifications. Here is how:
- 1. Define a method with a signature similar to this one: - - private void displayProgress(object sender, DownloadDirectoryProgressArgs args) - { - Console.WriteLine(args); - } - - 2. Add this method to the DownloadedDirectoryProgressEvent delegate's invocation list - - TransferUtilityDownloadDirectoryRequest request = new TransferUtilityDownloadDirectoryRequest(); - request.DownloadedDirectoryProgressEvent += displayProgress; - - - - - - Encapsulates the information needed to provide - transfer progress to subscribers of the DownloadDirectory - event. - - - - - Constructs a new instance of DownloadDirectoryProgressArgs. - - - The number of files downloaded. - - - The total number of files to download. - - - The current file being downloaded - - - The number of transferred bytes for the current file. - - - The size of the current file in bytes. - - - - - Constructs a new instance of DownloadDirectoryProgressArgs. - - - The number of files downloaded. - - - The total number of files to download. - - - The bytes transferred across all files being downloaded. - - - The total number of bytes across all files being downloaded. - - - The current file being downloaded. - - - The number of transferred bytes for the current file. - - - The size of the current file in bytes. - - - - - Gets or sets the total number of files. - - The total number of files. - - - - Gets or sets the number of files downloaded so far. - - The number of files downloaded. - - - - Gets or sets the total number of bytes across all files being downloaded. - - The total number of bytes across all files being downloaded. - - - - Gets or sets the bytes transferred across all files being downloaded. - - The bytes transferred across all files being downloaded. - - - - Gets or sets the current file being downloaded. - - The current file being downloaded. - - - - Gets or sets the transferred bytes for the current file. - - The transferred bytes for the current file. - - - - Gets or sets the total number of bytes for the current file. - - The total number of bytes for the current file. - - - - The string representation of this instance of DownloadDirectoryProgressArgs. - - The string representation of this instance of DownloadDirectoryProgressArgs. - - - - Contains all the parameters - that can be set when making a this request with the - TransferUtility method. - - - - - Get or sets the file path location of where the - downloaded Amazon S3 object will be written to. - - - The file path location of where the downloaded Amazon S3 object will be written to. - - - - - Checks if FilePath property is set. - - True if FilePath property is set. - - - - The event for WriteObjectProgressEvent notifications. All - subscribers will be notified when a new progress - event is raised. - - The WriteObjectProgressEvent is fired as data - is downloaded from S3. The delegates attached to the event - will be passed information detailing how much data - has been downloaded as well as how much will be downloaded. - - - - Subscribe to this event if you want to receive - WriteObjectProgressEvent notifications. Here is how:
- 1. Define a method with a signature similar to this one: - - private void displayProgress(object sender, WriteObjectProgressArgs args) - { - Console.WriteLine(args); - } - - 2. Add this method to the WriteObjectProgressEvent delegate's invocation list - - TransferUtilityDownloadRequest request = new TransferUtilityDownloadRequest(); - request.WriteObjectProgressEvent += displayProgress; - - - - - - Causes the WriteObjectProgressEvent event to be fired. - - Progress data for the stream being written to file. - - - - Contains all the parameters - that can be set when making a this request with the - TransferUtility method. - - - - - Contains all the parameters - that can be set when making a this request with the - TransferUtility method. - - - - - Gets or sets the directory where files are uploaded from. - - - The directory where files are uploaded from. - - - - - Checks if Directory property is set. - - true if Directory property is set. - - - - Gets or sets the KeyPrefix property. As object keys are generated for the - files being uploaded this value will prefix the key. This is useful when a directory - needs to be uploaded into sub directory in the S3 Bucket. - - - The directory where files are uploaded from. - - - - - Checks if KeyPrefix property is set. - - true if KeyPrefix property is set. - - - - Gets and sets the search pattern used to determine which - files in the directory are uploaded. - - - The search pattern used to deterimine which - files in the directory are uploaded. - The default value is "*", specifying that all files - in the directory will be uploaded. - - - - - Checks if SearchPattern property is set. - - true if SearchPattern property is set. - - - - Gets or sets the recursive options for the directory upload. - - - The recursive options for the directory upload. - Set by default to TopDirectoryOnly, - specifying that files will be uploaded from the root directory only. - - - - - Gets or sets the name of the bucket. - - - The name of the bucket. - - - - - Checks if BucketName property is set. - - true if BucketName property is set. - - - - Gets or sets the canned access control list (ACL) - for the uploaded objects. - Please refer to - for - information on Amazon S3 canned ACLs. - - - The canned access control list (ACL) - for the uploaded objects. - - - - - Checks if the CannedACL property is set. - - true if there is the CannedACL property is set. - - - - Gets or sets the content type for the uploaded Amazon S3 objects. - The default behavior when this field is not set is to use the file - extension to set the content type. If this field is set to a value it - will be applied to all uploaded files in the directory, overriding - file extension inspection. - - - The content type for all the uploaded Amazon S3 objects. - - - - - Gets or sets the storage class for the uploaded Amazon S3 objects. - Please refer to - for - information on S3 Storage Classes. - - - The storage class for the uploaded Amazon S3 objects. - - - - - The collection of meta data for the request. - - - - - Gets or sets the ServerSideEncryptionMethod property. - Specifies the encryption used on the server to - store the content. - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Gets or sets the UploadFilesConcurrently property. - Specifies if multiple files will be uploaded concurrently. - The number of concurrent web requests used is controlled - by the TransferUtilityConfig.ConcurrencyLevel property. - - - - - The event for UploadDirectoryProgressEvent notifications. All - subscribers will be notified when a new progress - event is raised. - - The UploadDirectoryProgressEvent is fired as data - is uploaded to S3. The delegates attached to the event - will be passed information detailing how much data - has been uploaded as well as how much will be uploaded. - - - - Subscribe to this event if you want to receive - UploadDirectoryProgressEvent notifications. Here is how:
- 1. Define a method with a signature similar to this one: - - private void displayProgress(object sender, UploadDirectoryProgressArgs args) - { - Console.WriteLine(args); - } - - 2. Add this method to the UploadDirectoryProgressEvent delegate's invocation list - - TransferUtilityUploadDirectoryRequest request = new TransferUtilityUploadDirectoryRequest(); - request.UploadDirectoryProgressEvent += displayProgress; - - - - - - The event for modifying individual TransferUtilityUploadRequest for each file - being uploaded. - - - - - Causes the UploadDirectoryProgressEvent event to be fired. - - Progress data for files currently being uploaded. - - - - Tags that will be applied to all objects in the diretory. - - - - - Encapsulates the information needed to provide - transfer progress to subscribers of the UploadDirectory - event. - - - - - Constructs a new instance of UploadDirectoryProgressArgs. - - - The number of files uploaded. - - - The total number of files to upload. - - - The current file - - - The number of transferred bytes for current file. - - - The size of the current file in bytes. - - - - - Constructs a new instance of UploadDirectoryProgressArgs. - - - The number of files uploaded. - - - The total number of files to upload. - - - The bytes transferred across all files being uploaded. - - - The total number of bytes across all files being uploaded. - - - The current file being uploaded. - - - The number of transferred bytes for current file. - - - The size of the current file in bytes. - - - - - Gets or sets the total number of files. - - The total number of files. - - - - Gets or sets the number of files uploaded. - - The number of files uploaded. - - - - Gets or sets the total number of bytes across all files being uploaded. - - The total number of bytes across all files being uploaded. - - - - Gets or sets the bytes transferred across all files being uploaded. - - The bytes transferred across all files being uploaded. - - - - Gets or sets the current file. - - - This property is only valid if UploadDirectory is used without enabling concurrent file uploads (by default concurrent upload is disabled). - If concurrent file uploads are enabled by setting TransferUtilityUploadDirectoryRequest.UploadFilesConcurrently to true, this property - will return null. - - The current file. - - - - Gets or sets the transferred bytes for current file. - - - This property is only valid if UploadDirectory is used without enabling concurrent file uploads (by default concurrent upload is disabled). - If concurrent file uploads are enabled by setting TransferUtilityUploadDirectoryRequest.UploadFilesConcurrently to true, this property - will return 0. - - The transferred bytes for current file. - - - - Gets or sets the total number of bytes for current file. - - - This property is only valid if UploadDirectory is used without enabling concurrent file uploads (by default concurrent upload is disabled). - If concurrent file uploads are enabled by setting TransferUtilityUploadDirectoryRequest.UploadFilesConcurrently to true, this property - will return 0. - - The total number of bytes for current file. - - - - The string representation of this instance of UploadDirectoryProgressArgs. - - The string representation of this instance of UploadDirectoryProgressArgs. - - - - Contains a single TransferUtilityUploadRequest corresponding - to a single file about to be uploaded, allowing changes to - the request before it is executed. - - - - - Constructs a new UploadDirectoryFileRequestArgs instance. - - Request being processed. - - - - Gets and sets the UploadRequest property. - - - - - Contains all the parameters - that can be set when making a this request with the - TransferUtility method. - - - - - Gets or sets the name of the bucket. - - - The name of the bucket. - - - - - Checks if BucketName property is set. - - true if BucketName property is set. - - - - Gets or sets the key under which the Amazon S3 object is to be stored. - - - The key under which the Amazon S3 object is to be stored. - - - - - Checks if Key property is set. - - true if Key property is set. - - - - Gets or sets the canned access control list (ACL) - for the uploaded object. - Please refer to - for - information on Amazon S3 canned ACLs. - - - The canned access control list (ACL) - for the uploaded object. - - - - - Checks if the CannedACL property is set. - - true if there is the CannedACL property is set. - - - - Removes the cannned access control list (ACL) - for the uploaded object. - - - - - Gets or sets the content type of the uploaded Amazon S3 object. - - - The content type of the uploaded Amazon S3 object. - - - - - Checks if ContentType property is set. - - true if ContentType property is set. - - - - Gets or sets the storage class for the uploaded Amazon S3 object. - Please refer to - for - information on S3 Storage Classes. - - - The storage class for the uploaded Amazon S3 object. - - - - - Gets and sets the ServerSideEncryptionMethod property. - Specifies the encryption used on the server to - store the content. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Input stream for the request; content for the request will be read from the stream. - - - - - - Gets or sets the file path - where the Amazon S3 object will be uploaded from. - - - For WinRT and Windows Phone this property must be in the form of "ms-appdata:///local/file.txt". - - - - The file path where the Amazon S3 object will be uploaded from. - - - - - Checks if FilePath property is set. - - true if FilePath property is set. - - - - Gets or sets the part size of the upload in bytes. - The uploaded file will be divided into - parts the size specified and - uploaded to Amazon S3 individually. - - - The part size of the upload. - - - - - Checks if PartSize property is set. - - true if PartSize property is set. - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - The tag-set for the object. - - - - - The event for UploadProgressEvent notifications. All - subscribers will be notified when a new progress - event is raised. - - The UploadProgressEvent is fired as data - is uploaded to S3. The delegates attached to the event - will be passed information detailing how much data - has been uploaded as well as how much will be uploaded. - - - - Subscribe to this event if you want to receive - UploadProgressEvent notifications. Here is how:
- 1. Define a method with a signature similar to this one: - - private void displayProgress(object sender, UploadProgressArgs args) - { - Console.WriteLine(args); - } - - 2. Add this method to the UploadProgressEvent delegate's invocation list - - TransferUtilityUploadRequest request = new TransferUtilityUploadRequest(); - request.UploadProgressEvent += displayProgress; - - - - - - Causes the UploadProgressEvent event to be fired. - - Progress data for the file being uploaded. - - - - Gets the length of the content by either checking the FileInfo.Length property or the Stream.Length property. - - The length of the content. - - - - Gets or sets whether or not the stream used with this request is - automatically closed when all of the content is read from the stream. - - - A value of true if the if the stream is - automatically closed when all of the content is read from the stream. - A value of false if otherwise. - - - - - If this value is set to true then the stream's position will be reset to the start before being read for upload. - Default: true. - - - - - Sets whether or not the stream used with this request is - automatically closed when all of the content is read from the stream - and returns this object instance, - enabling additional method calls to be chained together. - - - A value of true if the if the stream is - automatically closed when all of the content is read from the stream. - A value of false if otherwise. - - - This object instance, enabling additional method calls to be chained together. - - - - - Encapsulates the information needed to provide - transfer progress to subscribers of the Put Object - Event. - - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The how many bytes were transferred since last event. - The number of bytes transferred - The total number of bytes to be transferred - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The how many bytes were transferred since last event. - The number of bytes transferred - The total number of bytes to be transferred - The file being uploaded - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The how many bytes were transferred since last event. - The number of bytes transferred - The total number of bytes to be transferred - A compensation for any upstream aggregators if this event to correct theit totalTransferred count, - in case the underlying request is retried. - The file being uploaded - - - - Gets the FilePath. - - - - - Uri wrapper that can parse out information (bucket, key, region, style) from an - S3 URI. - - - - - True if the URI contains the bucket in the path, false if it contains the bucket in the authority. - - - - - The bucket name parsed from the URI (or null if no bucket specified). - - - - - The key parsed from the URI (or null if no key specified). - - - - - The region parsed from the URI (or null if no region specified). - - - - - Constructs a parser for the S3 URI specified as a string. - - The S3 URI to be parsed. - - - - Constructs a parser for the S3 URI specified as a Uri instance. - - The S3 URI to be parsed. - - - - If the given string is an AmazonS3Endpoint return true and set the AmazonS3Uri out parameter. - - - - true if the string is an AmazonS3Endpoint, and the out paramter has been filled in, false otherwise - - - - If the given Uri is an AmazonS3Endpoint return true and set the AmazonS3Uri out parameter. - - - - true if the Uri is an AmazonS3Endpoint, and the out paramter has been filled in, false otherwise - - - - Checks whether the given URI is a Amazon S3 URI. - - The S3 URI to be checked. - true if the URI is a Amazon S3 URI, false; otherwise. - - - - Checks whether the given URI is a Amazon S3 URI. - - The S3 URI to be checked. - true if the URI is a Amazon S3 URI, false; otherwise. - - - - Percent-decodes the given string, with a fast path for strings that are not - percent-encoded. - - The string to decode - The decoded string - - - - Percent-decodes the given string. - - The string to decode - The index of the first '%' in the string - The decoded string - - - - Decodes the percent-encoded character at the given index in the string - and appends the decoded value to the string under construction. - - - The string under construction to which the decoded character will be - appended. - - The string being decoded. - The index of the '%' character in the string. - - - - Converts a hex character (0-9A-Fa-f) into its corresponding quad value. - - The hex character - The quad value - - - - Provides utilities used by the Amazon S3 client implementation. - These utilities might be useful to consumers of the Amazon S3 - library. - - - Provides utilities used by the Amazon S3 client implementation. - These utilities might be useful to consumers of the Amazon S3 - library. - - - - - Determines MIME type from a file extension - - The extension of the file - The MIME type for the extension, or text/plain - - - - URL encodes a string. If the path property is specified, - the accepted path characters {/+:} are not encoded. - - The string to encode - Whether the string is a URL path or not - - - - - Converts a non-seekable stream into a System.IO.MemoryStream. - A MemoryStream's position can be moved arbitrarily - - The stream to be converted - A seekable MemoryStream - MemoryStreams use byte arrays as their backing store. - Please use this judicially as it is likely that a very large - stream will cause system resources to be used up. - - - - - Formats the current date as a GMT timestamp - - A GMT formatted string representation - of the current date and time - - - - - Generates an MD5 Digest for the string-based content - - The content for which the MD5 Digest needs - to be computed. - - Whether the returned checksum should be - base64 encoded. - - A string representation of the hash with or w/o base64 encoding - - - - - Version2 S3 buckets adhere to RFC 1035: - - Less than 255 characters, with each label less than 63 characters. - Label must start with a letter - Label must end with a letter or digit - Label can have a string of letter, digits and hyphens in the middle. - Although names can be case-sensitive, no significance is attached to the case. - RFC 1123: Allow label to start with letter or digit (e.g. 3ware.com works) - RFC 2181: No restrictions apart from the length restrictions. - - S3 V2 will start with RFCs 1035 and 1123 and impose the following additional restrictions: - - Length between 3 and 63 characters (to allow headroom for upper-level domains, - as well as to avoid separate length restrictions for bucket-name and its labels - Only lower-case to avoid user confusion. - No dotted-decimal IPv4-like strings - - - The BucketName to validate if V2 addressing should be used - True if the BucketName should use V2 bucket addressing, false otherwise - - S3 v2 Bucket restrictions - - - - Determines whether an S3 bucket exists or not. - - The name of the bucket to check. - The Amazon S3 Client to use for S3 specific operations. - False is returned in case S3 responds with a NoSuchBucket error. - True is returned in case of success, AccessDenied error or PermanentRedirect error. - An exception is thrown in case of any other error. - This method calls GetACL for the bucket. - - - - Determines whether an S3 bucket exists or not. - This is done by: - 1. Creating a PreSigned Url for the bucket. To work with Signature V4 only regions, as - well as Signature V4-optional regions, we keep the expiry to within the maximum for V4 - (which is one week). - 2. Making a HEAD request to the Url - - The name of the bucket to check. - The Amazon S3 Client to use for S3 specific operations. - - - - - Deletes an S3 bucket which contains objects. - An S3 bucket which contains objects cannot be deleted until all the objects - in it are deleted. This method deletes all the objects in the specified - bucket and then deletes the bucket itself. - - The bucket to be deleted. - The Amazon S3 Client to use for S3 specific operations. - - - - Deletes an S3 bucket which contains objects. - An S3 bucket which contains objects cannot be deleted until all the objects - in it are deleted. This method deletes all the objects in the specified - bucket and then deletes the bucket itself. - - The bucket to be deleted. - The Amazon S3 Client to use for S3 specific operations. - Options to control the behavior of the delete operation. - - - - Initiates the asynchronous execution of the DeleteS3BucketWithObjects operation. - DeleteS3BucketWithObjects deletes an S3 bucket which contains objects. - An S3 bucket which contains objects cannot be deleted until all the objects - in it are deleted. This method deletes all the objects in the specified - bucket and then deletes the bucket itself. - - The bucket to be deleted. - The Amazon S3 Client to use for S3 specific operations. - token to check if the operation has been request to cancel. - An IAsyncCancelableResult that can be used to poll or wait for results, or both; - this value is also needed when invoking EndDeleteS3BucketWithObjects. IAsyncCancelableResult can also - be used to cancel the operation while it's in progress. - - - - Initiates the asynchronous execution of the DeleteS3BucketWithObjects operation. - DeleteS3BucketWithObjects deletes an S3 bucket which contains objects. - An S3 bucket which contains objects cannot be deleted until all the objects - in it are deleted. This method deletes all the objects in the specified - bucket and then deletes the bucket itself. - - The bucket to be deleted. - The Amazon S3 Client to use for S3 specific operations. - Options to control the behavior of the delete operation. - token to check if the operation has been request to cancel. - An IAsyncCancelableResult that can be used to poll or wait for results, or both; - this value is also needed when invoking EndDeleteS3BucketWithObjects. IAsyncCancelableResult can also - be used to cancel the operation while it's in progress. - - - - Initiates the asynchronous execution of the DeleteS3BucketWithObjects operation. - DeleteS3BucketWithObjects deletes an S3 bucket which contains objects. - An S3 bucket which contains objects cannot be deleted until all the objects - in it are deleted. This method deletes all the objects in the specified - bucket and then deletes the bucket itself. - - The bucket to be deleted. - The Amazon S3 Client to use for S3 specific operations. - >Options to control the behavior of the delete operation. - An callback that is invoked to send updates while delete operation is in progress. - token to check if the operation has been request to cancel. - An IAsyncCancelableResult that can be used to poll or wait for results, or both; - this value is also needed when invoking EndDeleteS3BucketWithObjects. IAsyncCancelableResult can also - be used to cancel the operation while it's in progress. - - - - Invokes the DeleteS3BucketWithObjectsInternal method. - - The Request object that has all the data to complete the operation. - token to request the operation to be cancelled. - - - - Deletes an S3 bucket which contains objects. - An S3 bucket which contains objects cannot be deleted until all the objects - in it are deleted. The function deletes all the objects in the specified - bucket and then deletes the bucket itself. - - The bucket to be deleted. - The Amazon S3 Client to use for S3 specific operations. - Options to control the behavior of the delete operation. - The callback which is used to send updates about the delete operation. - token to check if the operation has been request to cancel. - - - - Invokes the callback which provides updated about the delete operation. - - The callback to be invoked. - The data being passed to the callback. - 8 - - - - Class to manage and cache the correct region for buckets accessed without an explicit region. - - - Class to manage and cache the correct region for buckets accessed without an explicit region. - - - - - A cache of BucketName -> RegionEndpoint pairs. - The cache is used to make sure that bucket requests are signed for the correct region, - even when requesting them without an explicit region. - - - - - Detect a bucket region mismatch based on the x-amz-bucket-region header, and the status code provided. - - - - - - - - - Detects if the signature is malformed, and the requested bucket is in a Region - different from the Region of the request. - - - - the correct region if a mismatch was detected, null otherwise - - - - Detects if the signature is malformed, and the requested bucket is in a Region - different from the Region of the request. - - - - - the correct region if a mismatch was detected, null otherwise - - - - Use a HEAD bucket request to get the region for the given bucket. - - This method creates an AmazonS3Client from the credentials passed in. - It's critical that the AmazonS3Client is not used to make any requests that will - be routed through the pipeline. - - - - the value of the x-amz-bucket-region header from the response - - - - Options which control the behaviour of the DeleteS3BucketWithObjects operation. - - - - - Gets or sets a value which indicates whether the - operation should be aborted if an error is encountered during execution. - - - - - Gets or sets a value which indicated whether verbose results shoule be returned to the - callback. - If quiet mode is true the callback will receive only keys where the delete operation encountered an error. - If quiet mode is false the callback will receive keys for both successful and unsuccessful delete operations. - - - - - Internal class used to pass the parameters for DeleteS3BucketWithObjects operation. - - - - - Name of the bucket to be deleted. - - - - - The Amazon S3 Client to use for S3 specific operations. - - - - - Options to control the behavior of the delete operation. - - - - - The callback which is used to send updates about the delete operation. - - - - - Contains updates from DeleteS3BucketWithObjects operation. - - - - - The list of objects which were successfully deleted. - - - - - The list of objects for which the delete operation failed. - - - - - A helper class that represents a strongly typed S3 EventNotification item sent to SQS - - - - - Parse the JSON string into a S3EventNotification object. - - The function will try its best to parse input JSON string as best as it can. - It will not fail even if the JSON string contains unknown properties. - - For any parsing errors - - - - - Gets and sets the records for the S3 event notification - - - - - The class holds the user identity properties. - - - - - Gets and sets the PrincipalId property. - - - - - This class contains the identity information for an S3 bucket. - - - - - Gets and sets the name of the bucket. - - - - - Gets and sets the bucket owner id. - - - - - Gets and sets the S3 bucket arn. - - - - - This class contains the information for an object in S3. - - - - - Gets and sets the key for the object stored in S3. - - - - - Gets and sets the size of the object in S3. - - - - - Gets and sets the etag of the object. This can be used to determine if the object has changed. - - - - - Gets and sets the version id of the object in S3. - - - - - Gets and sets the sequencer a string representation of a hexadecimal value used to determine event sequence, only used with PUTs and DELETEs. - - - - - Gets and sets the meta information describing S3. - - - - - Gets and sets the ConfigurationId. This ID can be found in the bucket notification configuration. - - - - - Gets and sets the Bucket property. - - - - - Gets and sets the Object property. - - - - - Gets and sets the S3SchemaVersion property. - - - - - The class holds the request parameters - - - - - Gets and sets the SourceIPAddress. This is the ip address where the request came from. - - - - - This class holds the response elements. - - - - - Gets and sets the XAmzId2 Property. This is the Amazon S3 host that processed the request. - - - - - Gets and sets the XAmzRequestId. This is the Amazon S3 generated request ID. - - - - - The class holds the glacier event data elements. - - - - - Gets and sets the RestoreEventData property. - - - - - The class holds the restore event data elements. - - - - - Gets and sets the LifecycleRestorationExpiryTime the time when the object restoration will be expired. - - - - - Gets and sets the LifecycleRestoreStorageClass the source storage class for restore. - - - - - The class holds the event notification. - - - - - Gets and sets the AwsRegion property. - - - - - Gets and sets the EventName property. This identities what type of event occurred. - For example for an object just put in S3 this will be set to EventType.ObjectCreatedPut. - - - - - Gets and sets the EventSource property. - - - - - Gets and sets the EventType property. The time when S3 finished processing the request. - - - - - Gets and sets the EventVersion property. - - - - - Gets and sets the RequestParameters property. - - - - - Gets and sets the ResponseElements property. - - - - - Gets and sets the S3 property. - - - - - Gets and sets the UserIdentity property. - - - - - Get and sets the GlacierEventData property. - - - - - Configuration for the S3 section of AWS configuration. - Changes to some settings may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws> - <s3 useSignatureVersion4="true" /> - </aws> - - - - - - Key for the S3UseSignatureVersion4Key property. - - - - - - Configures if the S3 client should use Signature Version 4 signing with requests. - By default, this setting is set to true which will use Signature Version 4 for all - requests except presigned URL requests when the region is set to us-east-1. When - UseSignatureVersion4 is explicitly set to true by directly setting this property or - directly setting this property through configuration, Signature Version 4 will be - used for all requests when able to do so. - When this setting is false, Signature Version 2 will be used. Note that when the - setting is false, Signature Version 4 may still be used by default in some cases - or with some regions. - - - - - Was the value of the UseSignatureVersion4 property set explicitly? - This can be done via configuration or by directly setting the property. - - This is used to determine if the user set UseSignatureVersion4 to true, - or if it's true because the default was changed to true in the SDK. - - - - diff --git a/packages/AWSSDK.S3.3.5.0-beta/lib/netstandard2.0/AWSSDK.S3.dll b/packages/AWSSDK.S3.3.5.0-beta/lib/netstandard2.0/AWSSDK.S3.dll deleted file mode 100644 index 6199421..0000000 Binary files a/packages/AWSSDK.S3.3.5.0-beta/lib/netstandard2.0/AWSSDK.S3.dll and /dev/null differ diff --git a/packages/AWSSDK.S3.3.5.0-beta/lib/netstandard2.0/AWSSDK.S3.xml b/packages/AWSSDK.S3.3.5.0-beta/lib/netstandard2.0/AWSSDK.S3.xml deleted file mode 100644 index cc42c16..0000000 --- a/packages/AWSSDK.S3.3.5.0-beta/lib/netstandard2.0/AWSSDK.S3.xml +++ /dev/null @@ -1,30859 +0,0 @@ - - - - AWSSDK.S3 - - - - - Implementation for accessing S3 - - - - - - - Specialize the initialize of the client. - - - - - Create a signed URL allowing access to a resource that would - usually require authentication. - - - - When using query string authentication you create a query, - specify an expiration time for the query, sign it with your - signature, place the data in an HTTP request, and distribute - the request to a user or embed the request in a web page. - - - A PreSigned URL can be generated for GET, PUT, DELETE and HEAD - operations on your bucketName, keys, and versions. - - - The GetPreSignedUrlRequest that defines the - parameters of the operation. - determines if signing will fall back to SigV2 if the - signing region is us-east-1 - A string that is the signed http request. - - - - - - Marshalls the parameters for a presigned url for a preferred signing protocol. - - - - - - True if AWS4 signing will be used; if the expiry period in the request exceeds the - maximum allowed for AWS4 (one week), an ArgumentException is thrown. - - - - - - Create a signed URL allowing access to a resource that would - usually require authentication. - - - - When using query string authentication you create a query, - specify an expiration time for the query, sign it with your - signature, place the data in an HTTP request, and distribute - the request to a user or embed the request in a web page. - - - A PreSigned URL can be generated for GET, PUT, DELETE and HEAD - operations on your bucketName, keys, and versions. - - - The GetPreSignedUrlRequest that defines the - parameters of the operation. - A string that is the signed http request. - - - - - - Constructs AmazonS3Client with the credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - - - - Constructs AmazonS3Client with the credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - The region to connect. - - - - Constructs AmazonS3Client with the credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - The AmazonS3Client Configuration Object - - - - Constructs AmazonS3Client with AWS Credentials - - AWS Credentials - - - - Constructs AmazonS3Client with AWS Credentials - - AWS Credentials - The region to connect. - - - - Constructs AmazonS3Client with AWS Credentials and an - AmazonS3Client Configuration object. - - AWS Credentials - The AmazonS3Client Configuration Object - - - - Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - - - - Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - The region to connect. - - - - Constructs AmazonS3Client with AWS Access Key ID, AWS Secret Key and an - AmazonS3Client Configuration object. - - AWS Access Key ID - AWS Secret Access Key - The AmazonS3Client Configuration Object - - - - Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - - - - Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - The region to connect. - - - - Constructs AmazonS3Client with AWS Access Key ID, AWS Secret Key and an - AmazonS3Client Configuration object. - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - The AmazonS3Client Configuration Object - - - - Creates the signer for the service. - - - - - Customizes the runtime pipeline. - - Runtime pipeline for the current client. - - - - Capture metadata for the service. - - - - - Disposes the service client. - - - - - This operation aborts a multipart upload. After a multipart upload is aborted, no - additional parts can be uploaded using that upload ID. The storage consumed by any - previously uploaded parts will be freed. However, if any part uploads are currently - in progress, those part uploads might or might not succeed. As a result, it might - be necessary to abort a given multipart upload multiple times in order to completely - free all storage consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts operation and ensure that the parts - list is empty. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - The bucket name to which the upload was taking place. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object for which the multipart upload was initiated. - Upload ID that identifies the multipart upload. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AbortMultipartUpload service method, as returned by S3. - - - - This operation aborts a multipart upload. After a multipart upload is aborted, no - additional parts can be uploaded using that upload ID. The storage consumed by any - previously uploaded parts will be freed. However, if any part uploads are currently - in progress, those part uploads might or might not succeed. As a result, it might - be necessary to abort a given multipart upload multiple times in order to completely - free all storage consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts operation and ensure that the parts - list is empty. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - Container for the necessary parameters to execute the AbortMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AbortMultipartUpload service method, as returned by S3. - - - - Completes a multipart upload by assembling previously uploaded parts. - - - - You first initiate the multipart upload and then upload all parts using the UploadPart - operation. After successfully uploading all relevant parts of an upload, you call - this operation to complete the upload. Upon receiving this request, Amazon S3 concatenates - all the parts in ascending order by part number to create a new object. In the Complete - Multipart Upload request, you must provide the parts list. You must ensure that the - parts list is complete. This operation concatenates the parts that you provide in - the list. For each part in the list, you must provide the part number and the ETag - value, returned after that part was uploaded. - - - - Processing of a Complete Multipart Upload request could take several minutes to complete. - After Amazon S3 begins processing the request, it sends an HTTP response header that - specifies a 200 OK response. While processing is in progress, Amazon S3 periodically - sends white space characters to keep the connection from timing out. Because a request - could fail after the initial 200 OK response has been sent, it is important that you - check the response body to determine whether the request succeeded. - - - - Note that if CompleteMultipartUpload fails, applications should be prepared - to retry the failed requests. For more information, see Amazon - S3 Error Best Practices. - - - - For more information about multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - GetBucketLifecycle has the following special errors: - -
  • - - Error code: EntityTooSmall - -
    • - - Description: Your proposed upload is smaller than the minimum allowed object size. - Each part must be at least 5 MB in size, except the last part. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPart - -
    • - - Description: One or more of the specified parts could not be found. The part might - not have been uploaded, or the specified entity tag might not have matched the part's - entity tag. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPartOrder - -
    • - - Description: The list of parts was not in ascending order. The parts list must be - specified in order by part number. - -
    • - - 400 Bad Request - -
  • - - Error code: NoSuchUpload - -
    • - - Description: The specified multipart upload does not exist. The upload ID might be - invalid, or the multipart upload might have been aborted or completed. - -
    • - - 404 Not Found - -
- - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the CompleteMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CompleteMultipartUpload service method, as returned by S3. - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - for copying an object greater than 5 GB, you must use the multipart upload Upload - Part - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - Amazon S3 transfer acceleration does not support cross-region copies. If you request - a cross-region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information about transfer acceleration, see Transfer - Acceleration. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - request parameters x-amz-copy-source-if-match, x-amz-copy-source-if-none-match, - x-amz-copy-source-if-unmodified-since, or x-amz-copy-source-if-modified-since. - - - - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - You can use this operation to change the storage class of an object that is already - stored in Amazon S3 using the StorageClass parameter. For more information, - see Storage - Classes. - - - - The source object that you are copying can be encrypted or unencrypted. If the source - object is encrypted, it can be encrypted by server-side encryption using AWS managed - encryption keys or by using a customer-provided encryption key. When copying an object, - you can request that Amazon S3 encrypt the target object by using either the AWS managed - encryption keys or by using your own encryption key. You can do this regardless of - the form of server-side encryption that was used to encrypt the source, or even if - the source object was not encrypted. For more information about server-side encryption, - see Using - Server-Side Encryption. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
    • - - x-amz-copy-source-if-match condition evaluates to true - -
    • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
  • - - Consideration 2 – If both of the x-amz-copy-source-if-none-match and - x-amz-copy-source-if-modified-since headers are present in the request - and evaluate as follows, Amazon S3 returns the 412 Precondition Failed - response code: - -
    • - - x-amz-copy-source-if-none-match condition evaluates to false - -
    • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - The copy request charge is based on the storage class and Region you specify for the - destination object. For pricing information, see Amazon - S3 Pricing. - - - - Following are other considerations when using CopyObject: - -
Versioning
- - By default, x-amz-copy-source identifies the current version of an object - to copy. (If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted.) To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - To encrypt the target object, you must provide the appropriate encryption-related - request headers. The one you use depends on whether you want to use AWS managed encryption - keys or provide your own encryption key. - -
  • - - To encrypt the target object using server-side encryption with an AWS managed encryption - key, provide the following request headers, as appropriate. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. If you want to use a customer managed AWS KMS - CMK, you must provide the x-amz-server-side-encryption-aws-kms-key-id - of the symmetric customer managed CMK. Amazon S3 only supports symmetric CMKs and - not asymmetric CMKs. For more information, see Using - Symmetric and Asymmetric Keys in the AWS Key Management Service Developer Guide. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in KMS. - -
  • - - To encrypt the target object using server-side encryption with an encryption key that - you provide, use the following headers. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
  • - - If the source object is encrypted using server-side encryption with customer-provided - encryption keys, you must use the following headers. - -
    • - - x-amz-copy-source​-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-copy-source​-server-side​-encryption​-customer-key - -
    • - - x-amz-copy-source-​server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in Amazon KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - for copying an object greater than 5 GB, you must use the multipart upload Upload - Part - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - Amazon S3 transfer acceleration does not support cross-region copies. If you request - a cross-region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information about transfer acceleration, see Transfer - Acceleration. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - request parameters x-amz-copy-source-if-match, x-amz-copy-source-if-none-match, - x-amz-copy-source-if-unmodified-since, or x-amz-copy-source-if-modified-since. - - - - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - You can use this operation to change the storage class of an object that is already - stored in Amazon S3 using the StorageClass parameter. For more information, - see Storage - Classes. - - - - The source object that you are copying can be encrypted or unencrypted. If the source - object is encrypted, it can be encrypted by server-side encryption using AWS managed - encryption keys or by using a customer-provided encryption key. When copying an object, - you can request that Amazon S3 encrypt the target object by using either the AWS managed - encryption keys or by using your own encryption key. You can do this regardless of - the form of server-side encryption that was used to encrypt the source, or even if - the source object was not encrypted. For more information about server-side encryption, - see Using - Server-Side Encryption. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
    • - - x-amz-copy-source-if-match condition evaluates to true - -
    • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
  • - - Consideration 2 – If both of the x-amz-copy-source-if-none-match and - x-amz-copy-source-if-modified-since headers are present in the request - and evaluate as follows, Amazon S3 returns the 412 Precondition Failed - response code: - -
    • - - x-amz-copy-source-if-none-match condition evaluates to false - -
    • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - The copy request charge is based on the storage class and Region you specify for the - destination object. For pricing information, see Amazon - S3 Pricing. - - - - Following are other considerations when using CopyObject: - -
Versioning
- - By default, x-amz-copy-source identifies the current version of an object - to copy. (If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted.) To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - To encrypt the target object, you must provide the appropriate encryption-related - request headers. The one you use depends on whether you want to use AWS managed encryption - keys or provide your own encryption key. - -
  • - - To encrypt the target object using server-side encryption with an AWS managed encryption - key, provide the following request headers, as appropriate. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. If you want to use a customer managed AWS KMS - CMK, you must provide the x-amz-server-side-encryption-aws-kms-key-id - of the symmetric customer managed CMK. Amazon S3 only supports symmetric CMKs and - not asymmetric CMKs. For more information, see Using - Symmetric and Asymmetric Keys in the AWS Key Management Service Developer Guide. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in KMS. - -
  • - - To encrypt the target object using server-side encryption with an encryption key that - you provide, use the following headers. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
  • - - If the source object is encrypted using server-side encryption with customer-provided - encryption keys, you must use the following headers. - -
    • - - x-amz-copy-source​-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-copy-source​-server-side​-encryption​-customer-key - -
    • - - x-amz-copy-source-​server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in Amazon KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - for copying an object greater than 5 GB, you must use the multipart upload Upload - Part - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - Amazon S3 transfer acceleration does not support cross-region copies. If you request - a cross-region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information about transfer acceleration, see Transfer - Acceleration. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - request parameters x-amz-copy-source-if-match, x-amz-copy-source-if-none-match, - x-amz-copy-source-if-unmodified-since, or x-amz-copy-source-if-modified-since. - - - - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - You can use this operation to change the storage class of an object that is already - stored in Amazon S3 using the StorageClass parameter. For more information, - see Storage - Classes. - - - - The source object that you are copying can be encrypted or unencrypted. If the source - object is encrypted, it can be encrypted by server-side encryption using AWS managed - encryption keys or by using a customer-provided encryption key. When copying an object, - you can request that Amazon S3 encrypt the target object by using either the AWS managed - encryption keys or by using your own encryption key. You can do this regardless of - the form of server-side encryption that was used to encrypt the source, or even if - the source object was not encrypted. For more information about server-side encryption, - see Using - Server-Side Encryption. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
    • - - x-amz-copy-source-if-match condition evaluates to true - -
    • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
  • - - Consideration 2 – If both of the x-amz-copy-source-if-none-match and - x-amz-copy-source-if-modified-since headers are present in the request - and evaluate as follows, Amazon S3 returns the 412 Precondition Failed - response code: - -
    • - - x-amz-copy-source-if-none-match condition evaluates to false - -
    • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - The copy request charge is based on the storage class and Region you specify for the - destination object. For pricing information, see Amazon - S3 Pricing. - - - - Following are other considerations when using CopyObject: - -
Versioning
- - By default, x-amz-copy-source identifies the current version of an object - to copy. (If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted.) To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - To encrypt the target object, you must provide the appropriate encryption-related - request headers. The one you use depends on whether you want to use AWS managed encryption - keys or provide your own encryption key. - -
  • - - To encrypt the target object using server-side encryption with an AWS managed encryption - key, provide the following request headers, as appropriate. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. If you want to use a customer managed AWS KMS - CMK, you must provide the x-amz-server-side-encryption-aws-kms-key-id - of the symmetric customer managed CMK. Amazon S3 only supports symmetric CMKs and - not asymmetric CMKs. For more information, see Using - Symmetric and Asymmetric Keys in the AWS Key Management Service Developer Guide. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in KMS. - -
  • - - To encrypt the target object using server-side encryption with an encryption key that - you provide, use the following headers. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
  • - - If the source object is encrypted using server-side encryption with customer-provided - encryption keys, you must use the following headers. - -
    • - - x-amz-copy-source​-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-copy-source​-server-side​-encryption​-customer-key - -
    • - - x-amz-copy-source-​server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in Amazon KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - Container for the necessary parameters to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - - - - - - - - - Deletes an analytics configuration for the bucket (specified by the analytics configuration - ID). - - - - To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to DeleteBucketAnalyticsConfiguration: - -
  • - - - -
  • - - - -
  • - - - -
- - Container for the necessary parameters to execute the DeleteBucketAnalyticsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketAnalyticsConfiguration service method, as returned by S3. - - - - - Deletes an inventory configuration (identified by the inventory ID) from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - Operations related to DeleteBucketInventoryConfiguration include: - - - - Container for the necessary parameters to execute the DeleteBucketInventoryConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketInventoryConfiguration service method, as returned by S3. - - - - Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified - by the metrics configuration ID) from the bucket. Note that this doesn't include the - daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketMetricsConfiguration service method, as returned by S3. - - - - This implementation of the DELETE operation uses the policy subresource to delete - the policy of a specified bucket. If you are using an identity other than the root - user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - The bucket name. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketPolicy service method, as returned by S3. - - - - This implementation of the DELETE operation uses the policy subresource to delete - the policy of a specified bucket. If you are using an identity other than the root - user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - Container for the necessary parameters to execute the DeleteBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketPolicy service method, as returned by S3. - - - - Deletes the replication configuration from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutReplicationConfiguration - action. The bucket owner has these permissions by default and can grant it to others. - For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - It can take a while for the deletion of a replication configuration to fully propagate. - - - - For information about replication configuration, see Replication - in the Amazon S3 Developer Guide. - - - - The following operations are related to DeleteBucketReplication: - - - - Container for the necessary parameters to execute the DeleteBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketReplication service method, as returned by S3. - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - The bucket that has the tag set to be removed. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketTagging service method, as returned by S3. - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - Container for the necessary parameters to execute the DeleteBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketTagging service method, as returned by S3. - - - - This operation removes the website configuration for a bucket. Amazon S3 returns a - 200 OK response upon successfully deleting a website configuration on - the specified bucket. You will get a 200 OK response if the website configuration - you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE operation requires the S3:DeleteBucketWebsite permission. - By default, only the bucket owner can delete the website configuration attached to - a bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which you want to remove the website configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketWebsite service method, as returned by S3. - - - - This operation removes the website configuration for a bucket. Amazon S3 returns a - 200 OK response upon successfully deleting a website configuration on - the specified bucket. You will get a 200 OK response if the website configuration - you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE operation requires the S3:DeleteBucketWebsite permission. - By default, only the bucket owner can delete the website configuration attached to - a bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the DeleteBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketWebsite service method, as returned by S3. - - - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - The bucket name of the lifecycle to delete. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - Container for the necessary parameters to execute the DeleteLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key name of the object to delete. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key name of the object to delete. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - Container for the necessary parameters to execute the DeleteObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - - - - This operation enables you to delete multiple objects from a bucket using a single - HTTP request. If you know the object keys that you want to delete, then this operation - provides a suitable alternative to sending individual delete requests, reducing per-request - overhead. - - - - The request contains a list of up to 1000 keys that you want to delete. In the XML, - you provide the object key names, and optionally, version IDs if you want to delete - a specific version of the object from a versioning-enabled bucket. For each key, Amazon - S3 performs a delete operation and returns the result of that delete, success, or - failure, in the response. Note that if the object specified in the request is not - found, Amazon S3 returns the result as deleted. - - - - The operation supports two modes for the response: verbose and quiet. By default, - the operation uses verbose mode in which the response includes the result of deletion - of each key in your request. In quiet mode the response includes only keys where the - delete operation encountered an error. For a successful deletion, the operation does - not return any information about the delete in the response body. - - - - When performing this operation on an MFA Delete enabled bucket, that attempts to delete - any versioned objects, you must include an MFA token. If you do not provide one, the - entire request will fail, even if there are non-versioned objects you are trying to - delete. If you provide an invalid token, whether there are versioned keys in the request - or not, the entire Multi-Object Delete request will fail. For information about MFA - Delete, see - MFA Delete. - - - - Finally, the Content-MD5 header is required for all Multi-Object Delete requests. - Amazon S3 uses the header value to ensure that your request body has not been altered - in transit. - - - - The following operations are related to DeleteObjects: - - - - Container for the necessary parameters to execute the DeleteObjects service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObjects service method, as returned by S3. - - - - Removes the entire tag set from the specified object. For more information about managing - object tags, see - Object Tagging. - - - - To use this operation, you must have permission to perform the s3:DeleteObjectTagging - action. - - - - To delete tags of a specific object version, add the versionId query - parameter in the request. You will need permission for the s3:DeleteObjectVersionTagging - action. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteObjectTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObjectTagging service method, as returned by S3. - - - - Removes the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:PutBucketPublicAccessBlock - permission. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeletePublicAccessBlock service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeletePublicAccessBlock service method, as returned by S3. - - - - - - - - - Returns the default encryption configuration for an Amazon S3 bucket. For information - about the Amazon S3 default encryption feature, see Amazon - S3 Default Bucket Encryption. - - - - To use this operation, you must have permission to perform the s3:GetEncryptionConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to GetBucketEncryption: - - - - Container for the necessary parameters to execute the GetBucketEncryption service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketEncryption service method, as returned by S3. - - - - Returns an inventory configuration (identified by the inventory configuration ID) - from the bucket. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - The following operations are related to GetBucketInventoryConfiguration: - - - - Container for the necessary parameters to execute the GetBucketInventoryConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketInventoryConfiguration service method, as returned by S3. - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - The name of the bucket for which to get the location. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLocation service method, as returned by S3. - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - Container for the necessary parameters to execute the GetBucketLocation service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLocation service method, as returned by S3. - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - The bucket name for which to get the logging information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLogging service method, as returned by S3. - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - Container for the necessary parameters to execute the GetBucketLogging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLogging service method, as returned by S3. - - - - Gets a metrics configuration (specified by the metrics configuration ID) from the - bucket. Note that this doesn't include the daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to GetBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the GetBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketMetricsConfiguration service method, as returned by S3. - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following operation is related to GetBucketNotification: - - - - Name of the bucket for which to get the notification configuration - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketNotification service method, as returned by S3. - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following operation is related to GetBucketNotification: - - - - Container for the necessary parameters to execute the GetBucketNotification service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketNotification service method, as returned by S3. - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operation is related to GetBucketPolicy: - - - - The bucket name for which to get the bucket policy. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicy service method, as returned by S3. - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operation is related to GetBucketPolicy: - - - - Container for the necessary parameters to execute the GetBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicy service method, as returned by S3. - - - - Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket - is public. In order to use this operation, you must have the s3:GetBucketPolicyStatus - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - For more information about when Amazon S3 considers a bucket public, see The - Meaning of "Public". - - - - The following operations are related to GetBucketPolicyStatus: - - - - Container for the necessary parameters to execute the GetBucketPolicyStatus service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicyStatus service method, as returned by S3. - - - - Retrieves the replication configuration for the given Amazon S3 bucket. - - Container for the necessary parameters to execute the GetBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketReplication service method, as returned by S3. - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - The name of the bucket for which to get the payment request configuration - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketRequestPayment service method, as returned by S3. - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - Container for the necessary parameters to execute the GetBucketRequestPayment service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketRequestPayment service method, as returned by S3. - - - - Returns the tag set associated with the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - GetBucketTagging has the following special error: - -
  • - - Error code: NoSuchTagSetError - -
    • - - Description: There is no tag set associated with the bucket. - -
- - The following operations are related to GetBucketTagging: - - - - Container for the necessary parameters to execute the GetBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketTagging service method, as returned by S3. - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - The name of the bucket for which to get the versioning information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketVersioning service method, as returned by S3. - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - Container for the necessary parameters to execute the GetBucketVersioning service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketVersioning service method, as returned by S3. - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET operation requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which to get the website configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketWebsite service method, as returned by S3. - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET operation requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the GetBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketWebsite service method, as returned by S3. - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - The bucket name for which to get the cors configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetCORSConfiguration service method, as returned by S3. - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - Container for the necessary parameters to execute the GetCORSConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetCORSConfiguration service method, as returned by S3. - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are still using previous version of the lifecycle configuration, it works. - For the earlier API description, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to DeleteBucketMetricsConfiguration: - - - - The name of the bucket for which to get the lifecycle information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetLifecycleConfiguration service method, as returned by S3. - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are still using previous version of the lifecycle configuration, it works. - For the earlier API description, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the GetLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetLifecycleConfiguration service method, as returned by S3. - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object to get. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object to get. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - Container for the necessary parameters to execute the GetObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - - - - Gets an object's current Legal Hold status. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLegalHold service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectLegalHold service method, as returned by S3. - - - - Gets the Object Lock configuration for a bucket. The rule specified in the Object - Lock configuration will be applied by default to every new object placed in the specified - bucket. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLockConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectLockConfiguration service method, as returned by S3. - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - The name of the bucket containing the object. - The object key. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - The name of the bucket containing the object. - The object key. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - Container for the necessary parameters to execute the GetObjectMetadata service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - - - - Retrieves an object's retention settings. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectRetention service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectRetention service method, as returned by S3. - - - - Returns the tag-set of an object. You send the GET request against the tagging subresource - associated with the object. - - - - To use this operation, you must have permission to perform the s3:GetObjectTagging - action. By default, the GET operation returns information about current version of - an object. For a versioned bucket, you can have multiple versions of an object in - your bucket. To retrieve tags of any other version, use the versionId query parameter. - You also need permission for the s3:GetObjectVersionTagging action. - - - - By default, the bucket owner has this permission and can grant this permission to - others. - - - - For information about the Amazon S3 object tagging feature, see Object - Tagging. - - - - The following operation is related to GetObjectTagging: - - - - Container for the necessary parameters to execute the GetObjectTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTagging service method, as returned by S3. - - - - Return torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Amazon - S3 Torrent. - - - - You can get torrent only for objects that are less than 5 GB in size and that are - not encrypted using server-side encryption with customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - The following operation is related to GetObjectTorrent: - - - - The name of the bucket containing the object for which to get the torrent files. - The object key for which to get the information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTorrent service method, as returned by S3. - - - - Return torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Amazon - S3 Torrent. - - - - You can get torrent only for objects that are less than 5 GB in size and that are - not encrypted using server-side encryption with customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - The following operation is related to GetObjectTorrent: - - - - Container for the necessary parameters to execute the GetObjectTorrent service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTorrent service method, as returned by S3. - - - - Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:GetBucketPublicAccessBlock - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket - or an object, it checks the PublicAccessBlock configuration for both - the bucket (or the bucket that contains the object) and the bucket owner's account. - If the PublicAccessBlock settings are different between the bucket and - the account, Amazon S3 uses the most restrictive combination of the bucket-level and - account-level settings. - - - - For more information about when Amazon S3 considers a bucket or an object public, - see The - Meaning of "Public". - - - - The following operations are related to GetPublicAccessBlock: - - - - Container for the necessary parameters to execute the GetPublicAccessBlock service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetPublicAccessBlock service method, as returned by S3. - - - - This operation is useful to determine if a bucket exists and you have permission to - access it. The operation returns a 200 OK if the bucket exists and you - have permission to access it. Otherwise, the operation might return responses such - as 404 Not Found and 403 Forbidden. - - - - To use this operation, you must have permissions to perform the s3:ListBucket - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - Container for the necessary parameters to execute the HeadBucket service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the HeadBucket service method, as returned by S3. - - - - This operation initiates a multipart upload and returns an upload ID. This upload - ID is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort operation - and Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload API and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart) and UploadPartCopy) requests must match the headers you - used in the request to initiate the upload by using CreateMultipartUpload. - - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, - kms:GenerateDataKey*, and kms:DescribeKey actions on the - key. These permissions are required because Amazon S3 must decrypt and read data from - the encrypted file parts before it completes the multipart upload. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - The following operations are related to CreateMultipartUpload: - - - - The name of the bucket to which to initiate the upload - Object key for which the multipart upload is to be initiated. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the InitiateMultipartUpload service method, as returned by S3. - - - - This operation initiates a multipart upload and returns an upload ID. This upload - ID is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort operation - and Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload API and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart) and UploadPartCopy) requests must match the headers you - used in the request to initiate the upload by using CreateMultipartUpload. - - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, - kms:GenerateDataKey*, and kms:DescribeKey actions on the - key. These permissions are required because Amazon S3 must decrypt and read data from - the encrypted file parts before it completes the multipart upload. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - The following operations are related to CreateMultipartUpload: - - - - Container for the necessary parameters to execute the InitiateMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the InitiateMultipartUpload service method, as returned by S3. - - - - Lists the analytics configurations for the bucket. You can have up to 1,000 analytics - configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. You should always check the IsTruncated element in the response. - If there are no more configurations to list, IsTruncated is set to false. - If there are more configurations to list, IsTruncated is set to true, - and there will be a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to ListBucketAnalyticsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketAnalyticsConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketAnalyticsConfigurations service method, as returned by S3. - - - - Returns a list of inventory configurations for the bucket. You can have up to 1,000 - analytics configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory - - - - The following operations are related to ListBucketInventoryConfigurations: - - - - Container for the necessary parameters to execute the ListBucketInventoryConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketInventoryConfigurations service method, as returned by S3. - - - - Lists the metrics configurations for the bucket. The metrics configurations are only - for the request metrics of the bucket and do not provide information on daily storage - metrics. You can have up to 1,000 configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For more information about metrics configurations and CloudWatch request metrics, - see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to ListBucketMetricsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketMetricsConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketMetricsConfigurations service method, as returned by S3. - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBuckets service method, as returned by S3. - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - Container for the necessary parameters to execute the ListBuckets service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBuckets service method, as returned by S3. - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Container for the necessary parameters to execute the ListMultipartUploads service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. - Limits the response to keys that begin with the specified prefix. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - Container for the necessary parameters to execute the ListObjects service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Make sure to design - your application to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - To use this operation in an AWS Identity and Access Management (IAM) policy, you must - have permissions to perform the s3:ListBucket action. The bucket owner - has this permission by default and can grant this permission to others. For more information - about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - This section describes the latest revision of the API. We recommend that you use this - revised API for application development. For backward compatibility, Amazon S3 continues - to support the prior version of this API, ListObjects. - - - - To get a list of your buckets, see ListBuckets. - - - - The following operations are related to ListObjectsV2: - - - - Container for the necessary parameters to execute the ListObjectsV2 service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjectsV2 service method, as returned by S3. - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). This request returns a maximum of 1,000 - uploaded parts. The default number of parts returned is 1,000 parts. You can restrict - the number of parts returned by specifying the max-parts request parameter. - If your multipart upload consists of more than 1,000 parts, the response returns an - IsTruncated field with the value of true, and a NextPartNumberMarker - element. In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListParts: - - - - Name of the bucket to which the parts are being uploaded. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Object key for which the multipart upload was initiated. - Upload ID identifying the multipart upload whose parts are being listed. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListParts service method, as returned by S3. - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). This request returns a maximum of 1,000 - uploaded parts. The default number of parts returned is 1,000 parts. You can restrict - the number of parts returned by specifying the max-parts request parameter. - If your multipart upload consists of more than 1,000 parts, the response returns an - IsTruncated field with the value of true, and a NextPartNumberMarker - element. In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListParts: - - - - Container for the necessary parameters to execute the ListParts service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListParts service method, as returned by S3. - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - Container for the necessary parameters to execute the ListVersions service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - - - - - Creates a new bucket. To create a bucket, you must register with Amazon S3 and have - a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed - to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information on bucket naming restrictions, - see Working - with Amazon S3 Buckets. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the EU (Ireland) - Region. For more information, see How - to Select a Region for Your Buckets. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - Hosting of Buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - The name of the bucket to create. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucket service method, as returned by S3. - - - - Creates a new bucket. To create a bucket, you must register with Amazon S3 and have - a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed - to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information on bucket naming restrictions, - see Working - with Amazon S3 Buckets. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the EU (Ireland) - Region. For more information, see How - to Select a Region for Your Buckets. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - Hosting of Buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - Container for the necessary parameters to execute the PutBucket service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucket service method, as returned by S3. - - - - Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration - is a bucket-level feature that enables you to perform faster data transfers to Amazon - S3. - - - - To use this operation, you must have permission to perform the s3:PutAccelerateConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The Transfer Acceleration state of a bucket can be set to one of the following two - values: - -
  • - - Enabled – Enables accelerated data transfers to the bucket. - -
  • - - Suspended – Disables accelerated data transfers to the bucket. - -
- - The GetBucketAccelerateConfiguration operation returns the transfer acceleration - state of a bucket. - - - - After setting the Transfer Acceleration state of a bucket to Enabled, it might take - up to thirty minutes before the data transfer rates to the bucket increase. - - - - The name of the bucket used for Transfer Acceleration must be DNS-compliant and must - not contain periods ("."). - - - - For more information about transfer acceleration, see Transfer - Acceleration. - - - - The following operations are related to PutBucketAccelerateConfiguration: - - - - Container for the necessary parameters to execute the PutBucketAccelerateConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketAccelerateConfiguration service method, as returned by S3. - - - - - - - Set the logging parameters for a bucket and to specify permissions for who can view - and modify the logging parameters. All logs are saved to buckets in the same AWS Region - as the source bucket. To set the logging status of a bucket, you must be the bucket - owner. - - - - The bucket owner is automatically granted FULL_CONTROL to all logs. You use the Grantee - request element to grant access to other people. The Permissions request - element specifies the kind of access the grantee has to the logs. - - - - Grantee Values - - - - You can specify the person (grantee) to whom you're assigning access rights (using - request elements) in the following ways: - -
  • - - By the person's ID: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> - </Grantee> - - - - DisplayName is optional and ignored in the request. - -
  • - - By Email address: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee> - - - - - The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl - request, appears as the CanonicalUser. - -
  • - - By URI: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee> - - -
- - To enable logging, you use LoggingEnabled and its children request elements. To disable - logging, you use an empty BucketLoggingStatus request element: - - - - <BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01" /> - - - - - For more information about server access logging, see Server - Access Logging. - - - - For more information about creating a bucket, see CreateBucket. For more information - about returning the logging status of a bucket, see GetBucketLogging. - - - - The following operations are related to PutBucketLogging: - - - - Container for the necessary parameters to execute the PutBucketLogging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketLogging service method, as returned by S3. - - - - Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. - You can have up to 1,000 metrics configurations per bucket. If you're updating an - existing metrics configuration, note that this is a full replacement of the existing - metrics configuration. If you don't include the elements you want to keep, they are - erased. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to PutBucketMetricsConfiguration: - - - - GetBucketLifecycle has the following special error: - -
  • - - Error code: TooManyConfigurations - -
    • - - Description: You are attempting to create a new configuration but have already reached - the 1,000-configuration limit. - -
    • - - HTTP Status Code: HTTP 400 Bad Request - -
- - Container for the necessary parameters to execute the PutBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketMetricsConfiguration service method, as returned by S3. - - - - Enables notifications of specified events for a bucket. For more information about - event notifications, see Configuring - Event Notifications. - - - - Using this API, you can replace an existing notification configuration. The configuration - is an XML file that defines the event types that you want Amazon S3 to publish and - the destination where you want Amazon S3 to publish an event notification when it - detects an event of the specified type. - - - - By default, your bucket has no event notifications configured. That is, the notification - configuration will be an empty NotificationConfiguration. - - - - <NotificationConfiguration> - - - - </NotificationConfiguration> - - - - This operation replaces the existing notification configuration with the configuration - you include in the request body. - - - - After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification - Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, - and that the bucket owner has permission to publish to it by sending a test notification. - In the case of AWS Lambda destinations, Amazon S3 verifies that the Lambda function - permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. - For more information, see Configuring - Notifications for Amazon S3 Events. - - - - You can disable notifications by adding the empty NotificationConfiguration element. - - - - By default, only the bucket owner can configure notifications on a bucket. However, - bucket owners can use a bucket policy to grant permission to other users to set this - configuration with s3:PutBucketNotification permission. - - - - The PUT notification is an atomic operation. For example, suppose your notification - configuration includes SNS topic, SQS queue, and Lambda function configurations. When - you send a PUT request with this configuration, Amazon S3 sends test messages to your - SNS topic. If the message fails, the entire PUT operation will fail, and Amazon S3 - will not add the configuration to your bucket. - - - - Responses - - - - If the configuration in the request body includes only one TopicConfiguration - specifying only the s3:ReducedRedundancyLostObject event type, the response - will also include the x-amz-sns-test-message-id header containing the - message ID of the test notification sent to the topic. - - - - The following operation is related to PutBucketNotificationConfiguration: - - - - Container for the necessary parameters to execute the PutBucketNotification service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketNotification service method, as returned by S3. - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - The MD5 hash of the request body. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - Container for the necessary parameters to execute the PutBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - - - - Creates a replication configuration or replaces an existing one. For more information, - see Replication - in the Amazon S3 Developer Guide. - - - - To perform this operation, the user or role performing the operation must have the - iam:PassRole - permission. - - - - Specify the replication configuration in the request body. In the replication configuration, - you provide the name of the destination bucket where you want Amazon S3 to replicate - objects, the IAM role that Amazon S3 can assume to replicate objects on your behalf, - and other relevant information. - - - - A replication configuration must include at least one rule, and can contain a maximum - of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects - in the source bucket. To choose additional subsets of objects to replicate, add a - rule for each subset. All rules must specify the same destination bucket. - - - - To specify a subset of the objects in the source bucket to apply a replication rule - to, add the Filter element as a child of the Rule element. You can filter objects - based on an object key prefix, one or more object tags, or both. When you add the - Filter element in the configuration, you must also add the following elements: DeleteMarkerReplication, - Status, and Priority. - - - - For information about enabling versioning on a bucket, see Using - Versioning. - - - - By default, a resource owner, in this case the AWS account that created the bucket, - can perform this operation. The resource owner can also grant others permissions to - perform the operation. For more information about permissions, see Specifying - Permissions in a Policy and Managing - Access Permissions to Your Amazon S3 Resources. - - - - Handling Replication of Encrypted Objects - - - - By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side - encryption with CMKs stored in AWS KMS. To replicate AWS KMS-encrypted objects, add - the following: SourceSelectionCriteria, SseKmsEncryptedObjects, - Status, EncryptionConfiguration, and ReplicaKmsKeyID. - For information about replication configuration, see Replicating - Objects Created with SSE Using CMKs stored in AWS KMS. - - - - For information on PutBucketReplication errors, see ReplicationErrorCodeList - - - - - The following operations are related to PutBucketReplication: - - - - Container for the necessary parameters to execute the PutBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketReplication service method, as returned by S3. - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - The bucket name. - Container for Payer. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketRequestPayment service method, as returned by S3. - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - Container for the necessary parameters to execute the PutBucketRequestPayment service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketRequestPayment service method, as returned by S3. - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging. - - - - Within a bucket, if you add a tag that has the same key as an existing tag, the new - value overwrites the old value. For more information, see Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional operation is currently in progress against - this resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - The bucket name. - A property of PutBucketTaggingRequest used to execute the PutBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketTagging service method, as returned by S3. - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging. - - - - Within a bucket, if you add a tag that has the same key as an existing tag, the new - value overwrites the old value. For more information, see Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional operation is currently in progress against - this resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - Container for the necessary parameters to execute the PutBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketTagging service method, as returned by S3. - - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT operation requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - The bucket name. - Container for the request. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketWebsite service method, as returned by S3. - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT operation requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - Container for the necessary parameters to execute the PutBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketWebsite service method, as returned by S3. - - - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - The name of the bucket for which to set the configuration. - A property of PutLifecycleConfigurationRequest used to execute the PutLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutLifecycleConfiguration service method, as returned by S3. - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - Container for the necessary parameters to execute the PutLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutLifecycleConfiguration service method, as returned by S3. - - - - - - - - - - - - - - - - - Configuration for accessing AmazonS3 service - - - Configuration for accessing Amazon S3 service - - - - - When true, requests will always use path style addressing. - - - - - Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. - To use this feature, the bucket name should be DNS compliant names and should not contain periods (.). - The following APIs are not supported and are sent to the regular region endpoint, even if this option is enabled: -
    -
  1. PutBucket
    2. -
  2. ListBuckets
    3. -
  3. DeleteBucket
    4. -
- - - This option cannot be used at the same time as UseDualstackEndpoint. - - - - - If set to true and the service package supports it the region identified in the arn for a resource - will be used when making the service request. - - - - - USEast1RegionalEndpointValue determines wheter or not - to send the us-east-1 s3 requests to the regional endpoint or to - the legacy global endpoint. - This flags takes precedence over the AWS_S3_US_EAST_1_REGIONAL_ENDPOINT - environment variable and the credential file. - - - - - This method contains custom initializations for the config object. - - - - - Given this client configuration, returns the service url - - The service url in the form of a string - - - - If the client is configured to hit us-east-1 with the S3UsEast1RegionalEndpointValue flag not set, - this method checks whether the environment variable is present or the credential file contains a valid value - - A Nullable of S3UsEast1RegionalEndpointValue representing the client configuration for the regional us-east-1 endpoint - - - - Validate that the config object is properly configured. - - - - - Checks the AWS_S3_US_EAST_1_REGIONAL_ENDPOINT environment variable for the presence of the s3 regional flag - - A nullable of S3UsEast1RegionalEndpointValue - - - - Checks the credential file for the presence of the s3 regional flag - - A nullable of S3UsEast1RegionalEndpointValue - - - - Default constructor - - - - - The constant used to lookup in the region hash the endpoint. - - - - - Gets the ServiceVersion property. - - - - - Gets the value of UserAgent property. - - - - - Base exception for S3 errors. - - - - - Construct an instance of AmazonS3Exception - - - - - - Construct an instance of AmazonS3Exception - - - - - - - Construct an instance of AmazonS3Exception - - - - - - Construct an instance of AmazonS3Exception - - - - - - - - - - Construct an instance of AmazonS3Exception - - - - - - - - - - - Construct an instance of AmazonS3Exception - - - - - - - - - - - - Construct an instance of AmazonS3Exception - - - - - - - - - - - - - A special token that helps AWS troubleshoot problems. - - - - - A special token that helps AWS troubleshoot S3 accelerate problems. - - - - - The entire response body for this exception, if available. - - - - - The region that the AmazonS3Exception relates to. - - - - - Gets the exception message. - - - - - Extensions methods added to Amazon.Arn type to help parse S3 specific resources from the ARN. - - - - - Attempt to parse the resource component of the ARN into access point resource name. - - An AWS ARN to parse - The access point resouce identifier found in the ARN. - True if the ARN contains an access point resource identifier. - - - - Attempt to parse the resource component of the ARN into bucket name. - - An AWS ARN to parse - The bucket name found in the ARN. - True if the ARN contains a bucket name. - - - - This class extends the AmazonS3Client and provides client side encryption when reading or writing S3 objects. - - - - - Constructs AmazonS3EncryptionClient with the Encryption materials and credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Constructs AmazonS3EncryptionClient with the Encryption materials and credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - - The region to connect. - - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Constructs AmazonS3EncryptionClient with the Encryption materials, - AmazonS3 CryptoConfiguration object and credentials loaded from the application's - default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. - - Example App.config with credentials set. - - <?xml version="1.0" encoding="utf-8" ?> - <configuration> - <appSettings> - <add key="AWSProfileName" value="AWS Default"/> - </appSettings> - </configuration> - - - - - The AmazonS3EncryptionClient CryptoConfiguration Object - - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Constructs AmazonS3EncryptionClient with AWS Credentials and Encryption materials. - - - The encryption materials to be used to encrypt and decrypt envelope key. - - AWS Credentials - - - - Constructs AmazonS3EncryptionClient with AWS Credentials, Region and Encryption materials - - AWS Credentials - The region to connect. - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Constructs AmazonS3EncryptionClient with AWS Credentials, AmazonS3CryptoConfiguration Configuration object - and Encryption materials - - AWS Credentials - The AmazonS3EncryptionClient CryptoConfiguration Object - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Constructs AmazonS3EncryptionClient with AWS Access Key ID, - AWS Secret Key and Encryption materials - - AWS Access Key ID - AWS Secret Access Key - The encryption materials to be used to encrypt and decrypt envelope key. - - - - Constructs AmazonS3EncryptionClient with AWS Access Key ID, - AWS Secret Key, Region and Encryption materials - - AWS Access Key ID - AWS Secret Access Key - The region to connect. - The encryption materials to be used to encrypt and decrypt envelope key. - - - - Constructs AmazonS3EncryptionClient with AWS Access Key ID, Secret Key, - AmazonS3 CryptoConfiguration object and Encryption materials. - - AWS Access Key ID - AWS Secret Access Key - The AmazonS3EncryptionClient CryptoConfiguration Object - The encryption materials to be used to encrypt and decrypt envelope key. - - - - Constructs AmazonS3EncryptionClient with AWS Access Key ID, Secret Key, - SessionToken and Encryption materials. - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Constructs AmazonS3EncryptionClient with AWS Access Key ID, Secret Key, - SessionToken, Region and Encryption materials. - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - The region to connect. - The encryption materials to be used to encrypt and decrypt envelope key. - - - - Constructs AmazonS3EncryptionClient with AWS Access Key ID, Secret Key, SessionToken - AmazonS3EncryptionClient CryptoConfiguration object and Encryption materials. - - AWS Access Key ID - AWS Secret Access Key - AWS Session Token - The AmazonS3EncryptionClient CryptoConfiguration Object - - The encryption materials to be used to encrypt and decrypt envelope key. - - - - - Turn off response logging because it will interfere with decrypt of the data coming back from S3. - - - - - Customize the pipeline to allow encryption. - - - - - - Dispose this instance - - - - - - AmazonS3CryptoConfiguration allows customers - to set storage mode for encryption credentials - - - - - Default Constructor. - - - - - Gets and sets the StorageMode property. This determines if the crypto metadata is stored as metadata on the object or as a separate object in S3. - The default is ObjectMetadata. - - - - - Mode for string the encryption information for an object. - - - - - Store the information in a separate S3 Object. - - - - - Store the information as metadata on the encrypted object. - - - - - Encryption Instructions store the encryption credentials - - - - - Construct an instance EncryptionInstructions. - - - - - - - - - Construct an instance EncryptionInstructions. - - - - - - - - The "key encrypting key" materials used in encrypt/decryption. - These materials may be an asymmetric key, a symmetric key, or a KMS key ID. - - - - - Constructs a new EncryptionMaterials object, storing an asymmetric key. - - - - - - Constructs a new EncryptionMaterials object, storing a symmetric key. - - - - - - Constructs a new EncryptionMaterials object, storing a KMS Key ID - - - - - - The EncryptionUtils class encrypts and decrypts data stored in S3. - It can be used to prepare requests for encryption before they are stored in S3 - and to decrypt objects that are retrieved from S3. - - - - - Decrypts an encrypted Envelope key using the provided encryption materials - and returns it in raw byte array form. - - Encrypted envelope key - Encryption materials needed to decrypt the encrypted envlelope key - - - - - Returns an updated stream where the stream contains the encrypted object contents. - The specified instruction will be used to encrypt data. - - - The stream whose contents are to be encrypted. - - - The instruction that will be used to encrypt the object data. - - - Encrypted stream, i.e input stream wrapped into encrypted stream - - - - - Returns an updated input stream where the input stream contains the encrypted object contents. - The specified instruction will be used to encrypt data. - - - The stream whose contents are to be encrypted. - - - The instruction that will be used to encrypt the object data. - - - Encrypted stream, i.e input stream wrapped into encrypted stream - - - - - Updates object where the object - input stream contains the decrypted contents. - - - The getObject response whose contents are to be decrypted. - - - The instruction that will be used to encrypt the object data. - - - - - Generates an instruction that will be used to encrypt an object - using materials with the KMSKeyID set. - - - Used to call KMS to generate a data key. - - - The encryption materials to be used to encrypt and decrypt data. - - - The instruction that will be used to encrypt an object. - - - - - Generates an instruction that will be used to encrypt an object - using materials with the KMSKeyID set. - - - Used to call KMS to generate a data key. - - - The encryption materials to be used to encrypt and decrypt data. - - - The instruction that will be used to encrypt an object. - - - - - Generates an instruction that will be used to encrypt an object - using materials with the AsymmetricProvider or SymmetricProvider set. - - - The encryption materials to be used to encrypt and decrypt data. - - - The instruction that will be used to encrypt an object. - - - - - Builds an instruction object from the object metadata. - - - A non-null object response that contains encryption information in its metadata. - - - The non-null encryption materials to be used to encrypt and decrypt Envelope key. - - - The decrypted envelope key to be use if KMS key wrapping is being used. Or null if non-KMS key wrapping is being used. - - - - - - - Builds an instruction object from the instruction file. - - Instruction file GetObject response - - The non-null encryption materials to be used to encrypt and decrypt Envelope key. - - - A non-null instruction object containing encryption information. - - - - - Update the request's ObjectMetadata with the necessary information for decrypting the object. - - - AmazonWebServiceRequest encrypted using the given instruction - - - Non-null instruction used to encrypt the data in this AmazonWebServiceRequest . - - - If true use V2 metadata format, otherwise use V1. - - - - - Adds UnEncrypted content length to object metadata - - - - - - checks if encryption credentials are in object metadata - - Response of the object - - - - - checks if encryption credentials are in the instructionfile - - Instruction file response that contains encryption information - - - - - Custom the pipeline handler to decrypt objects. - - - - - Construct instance of SetupDecryptionHandler. - - - - - - Gets the EncryptionClient property which is the AmazonS3EncryptionClient that is decrypting the object. - - - - - Calls the post invoke logic after calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Decrypt the object being downloaded. - - - - - - Calls the and post invoke logic after calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Decrypt the object being downloaded. - - - - - - Decrypt the object being downloaded. - - - - - - - Updates object where the object input stream contains the decrypted contents. - - - The getObject response of InstructionFile. - - - The getObject response whose contents are to be decrypted. - - - - - Updates object where the object input stream contains the decrypted contents. - - - The getObject response whose contents are to be decrypted. - - - The decrypted envelope key to be use if KMS key wrapping is being used. Or null if non-KMS key wrapping is being used. - - - - - Custom pipeline handler to encrypt the data as it is being uploaded to S3. - - - - - Construct an instance SetupEncryptionHandler. - - - - - - Gets the EncryptionClient property which is the AmazonS3EncryptionClient that is encrypting the object. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Encrypts the S3 object being uploaded. - - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Encrypts the S3 object being uploaded. - - - - - - Make sure that the storage mode and encryption materials are compatible. - The client only supports KMS key wrapping in metadata storage mode. - - - - - Updates the request where the metadata contains encryption information - and the input stream contains the encrypted object contents. - - - The request whose contents are to be encrypted. - - - - - Updates the request where the instruction file contains encryption information - and the input stream contains the encrypted object contents. - - - - - - Updates the request where the input stream contains the encrypted object contents. - - - - - - Adds the crypto token to the user agent - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Customize the user agent. - - - - - - Interface for accessing S3 - - - - - - - Create a signed URL allowing access to a resource that would - usually require authentication. - - - - When using query string authentication you create a query, - specify an expiration time for the query, sign it with your - signature, place the data in an HTTP request, and distribute - the request to a user or embed the request in a web page. - - - A PreSigned URL can be generated for GET, PUT, DELETE and HEAD - operations on your bucketName, keys, and versions. - - - The GetPreSignedUrlRequest that defines the - parameters of the operation. - A string that is the signed http request. - - - - - - This operation aborts a multipart upload. After a multipart upload is aborted, no - additional parts can be uploaded using that upload ID. The storage consumed by any - previously uploaded parts will be freed. However, if any part uploads are currently - in progress, those part uploads might or might not succeed. As a result, it might - be necessary to abort a given multipart upload multiple times in order to completely - free all storage consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts operation and ensure that the parts - list is empty. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - The bucket name to which the upload was taking place. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object for which the multipart upload was initiated. - Upload ID that identifies the multipart upload. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AbortMultipartUpload service method, as returned by S3. - - - - This operation aborts a multipart upload. After a multipart upload is aborted, no - additional parts can be uploaded using that upload ID. The storage consumed by any - previously uploaded parts will be freed. However, if any part uploads are currently - in progress, those part uploads might or might not succeed. As a result, it might - be necessary to abort a given multipart upload multiple times in order to completely - free all storage consumed by all parts. - - - - To verify that all parts have been removed, so you don't get charged for the part - storage, you should call the ListParts operation and ensure that the parts - list is empty. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to AbortMultipartUpload: - - - - Container for the necessary parameters to execute the AbortMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the AbortMultipartUpload service method, as returned by S3. - - - - Completes a multipart upload by assembling previously uploaded parts. - - - - You first initiate the multipart upload and then upload all parts using the UploadPart - operation. After successfully uploading all relevant parts of an upload, you call - this operation to complete the upload. Upon receiving this request, Amazon S3 concatenates - all the parts in ascending order by part number to create a new object. In the Complete - Multipart Upload request, you must provide the parts list. You must ensure that the - parts list is complete. This operation concatenates the parts that you provide in - the list. For each part in the list, you must provide the part number and the ETag - value, returned after that part was uploaded. - - - - Processing of a Complete Multipart Upload request could take several minutes to complete. - After Amazon S3 begins processing the request, it sends an HTTP response header that - specifies a 200 OK response. While processing is in progress, Amazon S3 periodically - sends white space characters to keep the connection from timing out. Because a request - could fail after the initial 200 OK response has been sent, it is important that you - check the response body to determine whether the request succeeded. - - - - Note that if CompleteMultipartUpload fails, applications should be prepared - to retry the failed requests. For more information, see Amazon - S3 Error Best Practices. - - - - For more information about multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information about permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - GetBucketLifecycle has the following special errors: - -
  • - - Error code: EntityTooSmall - -
    • - - Description: Your proposed upload is smaller than the minimum allowed object size. - Each part must be at least 5 MB in size, except the last part. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPart - -
    • - - Description: One or more of the specified parts could not be found. The part might - not have been uploaded, or the specified entity tag might not have matched the part's - entity tag. - -
    • - - 400 Bad Request - -
  • - - Error code: InvalidPartOrder - -
    • - - Description: The list of parts was not in ascending order. The parts list must be - specified in order by part number. - -
    • - - 400 Bad Request - -
  • - - Error code: NoSuchUpload - -
    • - - Description: The specified multipart upload does not exist. The upload ID might be - invalid, or the multipart upload might have been aborted or completed. - -
    • - - 404 Not Found - -
- - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the CompleteMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CompleteMultipartUpload service method, as returned by S3. - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - for copying an object greater than 5 GB, you must use the multipart upload Upload - Part - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - Amazon S3 transfer acceleration does not support cross-region copies. If you request - a cross-region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information about transfer acceleration, see Transfer - Acceleration. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - request parameters x-amz-copy-source-if-match, x-amz-copy-source-if-none-match, - x-amz-copy-source-if-unmodified-since, or x-amz-copy-source-if-modified-since. - - - - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - You can use this operation to change the storage class of an object that is already - stored in Amazon S3 using the StorageClass parameter. For more information, - see Storage - Classes. - - - - The source object that you are copying can be encrypted or unencrypted. If the source - object is encrypted, it can be encrypted by server-side encryption using AWS managed - encryption keys or by using a customer-provided encryption key. When copying an object, - you can request that Amazon S3 encrypt the target object by using either the AWS managed - encryption keys or by using your own encryption key. You can do this regardless of - the form of server-side encryption that was used to encrypt the source, or even if - the source object was not encrypted. For more information about server-side encryption, - see Using - Server-Side Encryption. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
    • - - x-amz-copy-source-if-match condition evaluates to true - -
    • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
  • - - Consideration 2 – If both of the x-amz-copy-source-if-none-match and - x-amz-copy-source-if-modified-since headers are present in the request - and evaluate as follows, Amazon S3 returns the 412 Precondition Failed - response code: - -
    • - - x-amz-copy-source-if-none-match condition evaluates to false - -
    • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - The copy request charge is based on the storage class and Region you specify for the - destination object. For pricing information, see Amazon - S3 Pricing. - - - - Following are other considerations when using CopyObject: - -
Versioning
- - By default, x-amz-copy-source identifies the current version of an object - to copy. (If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted.) To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - To encrypt the target object, you must provide the appropriate encryption-related - request headers. The one you use depends on whether you want to use AWS managed encryption - keys or provide your own encryption key. - -
  • - - To encrypt the target object using server-side encryption with an AWS managed encryption - key, provide the following request headers, as appropriate. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. If you want to use a customer managed AWS KMS - CMK, you must provide the x-amz-server-side-encryption-aws-kms-key-id - of the symmetric customer managed CMK. Amazon S3 only supports symmetric CMKs and - not asymmetric CMKs. For more information, see Using - Symmetric and Asymmetric Keys in the AWS Key Management Service Developer Guide. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in KMS. - -
  • - - To encrypt the target object using server-side encryption with an encryption key that - you provide, use the following headers. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
  • - - If the source object is encrypted using server-side encryption with customer-provided - encryption keys, you must use the following headers. - -
    • - - x-amz-copy-source​-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-copy-source​-server-side​-encryption​-customer-key - -
    • - - x-amz-copy-source-​server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in Amazon KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - for copying an object greater than 5 GB, you must use the multipart upload Upload - Part - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - Amazon S3 transfer acceleration does not support cross-region copies. If you request - a cross-region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information about transfer acceleration, see Transfer - Acceleration. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - request parameters x-amz-copy-source-if-match, x-amz-copy-source-if-none-match, - x-amz-copy-source-if-unmodified-since, or x-amz-copy-source-if-modified-since. - - - - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - You can use this operation to change the storage class of an object that is already - stored in Amazon S3 using the StorageClass parameter. For more information, - see Storage - Classes. - - - - The source object that you are copying can be encrypted or unencrypted. If the source - object is encrypted, it can be encrypted by server-side encryption using AWS managed - encryption keys or by using a customer-provided encryption key. When copying an object, - you can request that Amazon S3 encrypt the target object by using either the AWS managed - encryption keys or by using your own encryption key. You can do this regardless of - the form of server-side encryption that was used to encrypt the source, or even if - the source object was not encrypted. For more information about server-side encryption, - see Using - Server-Side Encryption. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
    • - - x-amz-copy-source-if-match condition evaluates to true - -
    • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
  • - - Consideration 2 – If both of the x-amz-copy-source-if-none-match and - x-amz-copy-source-if-modified-since headers are present in the request - and evaluate as follows, Amazon S3 returns the 412 Precondition Failed - response code: - -
    • - - x-amz-copy-source-if-none-match condition evaluates to false - -
    • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - The copy request charge is based on the storage class and Region you specify for the - destination object. For pricing information, see Amazon - S3 Pricing. - - - - Following are other considerations when using CopyObject: - -
Versioning
- - By default, x-amz-copy-source identifies the current version of an object - to copy. (If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted.) To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - To encrypt the target object, you must provide the appropriate encryption-related - request headers. The one you use depends on whether you want to use AWS managed encryption - keys or provide your own encryption key. - -
  • - - To encrypt the target object using server-side encryption with an AWS managed encryption - key, provide the following request headers, as appropriate. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. If you want to use a customer managed AWS KMS - CMK, you must provide the x-amz-server-side-encryption-aws-kms-key-id - of the symmetric customer managed CMK. Amazon S3 only supports symmetric CMKs and - not asymmetric CMKs. For more information, see Using - Symmetric and Asymmetric Keys in the AWS Key Management Service Developer Guide. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in KMS. - -
  • - - To encrypt the target object using server-side encryption with an encryption key that - you provide, use the following headers. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
  • - - If the source object is encrypted using server-side encryption with customer-provided - encryption keys, you must use the following headers. - -
    • - - x-amz-copy-source​-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-copy-source​-server-side​-encryption​-customer-key - -
    • - - x-amz-copy-source-​server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in Amazon KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - A property of CopyObjectRequest used to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - - - - Creates a copy of an object that is already stored in Amazon S3. - - - - You can store individual objects of up to 5 TB in Amazon S3. You create a copy of - your object up to 5 GB in size in a single atomic operation using this API. However, - for copying an object greater than 5 GB, you must use the multipart upload Upload - Part - Copy API. For more information, see Copy - Object Using the REST Multipart Upload API. - - - - When copying an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making the request. - To override the default ACL setting, specify a new ACL when generating a copy request. - For more information, see Using - ACLs. - - - - Amazon S3 transfer acceleration does not support cross-region copies. If you request - a cross-region copy using a transfer acceleration endpoint, you get a 400 Bad - Request error. For more information about transfer acceleration, see Transfer - Acceleration. - - - - All copy requests must be authenticated. Additionally, you must have read access - to the source object and write access to the destination bucket. For more information, - see REST - Authentication. Both the Region that you want to copy the object from and the - Region that you want to copy the object to must be enabled for your account. - - - - To only copy an object under certain conditions, such as whether the Etag - matches or whether the object was modified before or after a specified date, use the - request parameters x-amz-copy-source-if-match, x-amz-copy-source-if-none-match, - x-amz-copy-source-if-unmodified-since, or x-amz-copy-source-if-modified-since. - - - - All headers with the x-amz- prefix, including x-amz-copy-source, - must be signed. - - - - You can use this operation to change the storage class of an object that is already - stored in Amazon S3 using the StorageClass parameter. For more information, - see Storage - Classes. - - - - The source object that you are copying can be encrypted or unencrypted. If the source - object is encrypted, it can be encrypted by server-side encryption using AWS managed - encryption keys or by using a customer-provided encryption key. When copying an object, - you can request that Amazon S3 encrypt the target object by using either the AWS managed - encryption keys or by using your own encryption key. You can do this regardless of - the form of server-side encryption that was used to encrypt the source, or even if - the source object was not encrypted. For more information about server-side encryption, - see Using - Server-Side Encryption. - - - - A copy request might return an error when Amazon S3 receives the copy request or while - Amazon S3 is copying the files. If the error occurs before the copy operation starts, - you receive a standard Amazon S3 error. If the error occurs during the copy operation, - the error response is embedded in the 200 OK response. This means that - a 200 OK response can contain either a success or an error. Design your - application to parse the contents of the response and handle it appropriately. - - - - If the copy is successful, you receive a response with information about the copied - object. - - - - If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - it would not contain the content-length, and you would need to read the entire body. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns 200 - OK and copies the data: - -
    • - - x-amz-copy-source-if-match condition evaluates to true - -
    • - - x-amz-copy-source-if-unmodified-since condition evaluates to false - -
  • - - Consideration 2 – If both of the x-amz-copy-source-if-none-match and - x-amz-copy-source-if-modified-since headers are present in the request - and evaluate as follows, Amazon S3 returns the 412 Precondition Failed - response code: - -
    • - - x-amz-copy-source-if-none-match condition evaluates to false - -
    • - - x-amz-copy-source-if-modified-since condition evaluates to true - -
- - The copy request charge is based on the storage class and Region you specify for the - destination object. For pricing information, see Amazon - S3 Pricing. - - - - Following are other considerations when using CopyObject: - -
Versioning
- - By default, x-amz-copy-source identifies the current version of an object - to copy. (If the current version is a delete marker, Amazon S3 behaves as if the object - was deleted.) To copy a different version, use the versionId subresource. - - - - If you enable versioning on the target bucket, Amazon S3 generates a unique version - ID for the object being copied. This version ID is different from the version ID of - the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response. - - - - If you do not enable versioning or suspend it on the target bucket, the version ID - that Amazon S3 generates is always null. - - - - If the source object's storage class is GLACIER, you must restore a copy of this object - before you can use it as a source object for the copy operation. For more information, - see . - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - To encrypt the target object, you must provide the appropriate encryption-related - request headers. The one you use depends on whether you want to use AWS managed encryption - keys or provide your own encryption key. - -
  • - - To encrypt the target object using server-side encryption with an AWS managed encryption - key, provide the following request headers, as appropriate. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. If you want to use a customer managed AWS KMS - CMK, you must provide the x-amz-server-side-encryption-aws-kms-key-id - of the symmetric customer managed CMK. Amazon S3 only supports symmetric CMKs and - not asymmetric CMKs. For more information, see Using - Symmetric and Asymmetric Keys in the AWS Key Management Service Developer Guide. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in KMS. - -
  • - - To encrypt the target object using server-side encryption with an encryption key that - you provide, use the following headers. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
  • - - If the source object is encrypted using server-side encryption with customer-provided - encryption keys, you must use the following headers. - -
    • - - x-amz-copy-source​-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-copy-source​-server-side​-encryption​-customer-key - -
    • - - x-amz-copy-source-​server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in Amazon KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - The following operations are related to CopyObject: - - - - For more information, see Copying - Objects. - - - Container for the necessary parameters to execute the CopyObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the CopyObject service method, as returned by S3. - - - - - - - - - Deletes an analytics configuration for the bucket (specified by the analytics configuration - ID). - - - - To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to DeleteBucketAnalyticsConfiguration: - -
  • - - - -
  • - - - -
  • - - - -
- - Container for the necessary parameters to execute the DeleteBucketAnalyticsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketAnalyticsConfiguration service method, as returned by S3. - - - - - Deletes an inventory configuration (identified by the inventory ID) from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - Operations related to DeleteBucketInventoryConfiguration include: - - - - Container for the necessary parameters to execute the DeleteBucketInventoryConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketInventoryConfiguration service method, as returned by S3. - - - - Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified - by the metrics configuration ID) from the bucket. Note that this doesn't include the - daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketMetricsConfiguration service method, as returned by S3. - - - - This implementation of the DELETE operation uses the policy subresource to delete - the policy of a specified bucket. If you are using an identity other than the root - user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - The bucket name. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketPolicy service method, as returned by S3. - - - - This implementation of the DELETE operation uses the policy subresource to delete - the policy of a specified bucket. If you are using an identity other than the root - user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account to use - this operation. - - - - If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a - 403 Access Denied error. If you have the correct permissions, but you're - not using an identity that belongs to the bucket owner's account, Amazon S3 returns - a 405 Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and UserPolicies. - - - - The following operations are related to DeleteBucketPolicy - - - - Container for the necessary parameters to execute the DeleteBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketPolicy service method, as returned by S3. - - - - Deletes the replication configuration from the bucket. - - - - To use this operation, you must have permissions to perform the s3:PutReplicationConfiguration - action. The bucket owner has these permissions by default and can grant it to others. - For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - It can take a while for the deletion of a replication configuration to fully propagate. - - - - For information about replication configuration, see Replication - in the Amazon S3 Developer Guide. - - - - The following operations are related to DeleteBucketReplication: - - - - Container for the necessary parameters to execute the DeleteBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketReplication service method, as returned by S3. - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - The bucket that has the tag set to be removed. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketTagging service method, as returned by S3. - - - - Deletes the tags from the bucket. - - - - To use this operation, you must have permission to perform the s3:PutBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - The following operations are related to DeleteBucketTagging: - - - - Container for the necessary parameters to execute the DeleteBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketTagging service method, as returned by S3. - - - - This operation removes the website configuration for a bucket. Amazon S3 returns a - 200 OK response upon successfully deleting a website configuration on - the specified bucket. You will get a 200 OK response if the website configuration - you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE operation requires the S3:DeleteBucketWebsite permission. - By default, only the bucket owner can delete the website configuration attached to - a bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which you want to remove the website configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketWebsite service method, as returned by S3. - - - - This operation removes the website configuration for a bucket. Amazon S3 returns a - 200 OK response upon successfully deleting a website configuration on - the specified bucket. You will get a 200 OK response if the website configuration - you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 - response if the bucket specified in the request does not exist. - - - - This DELETE operation requires the S3:DeleteBucketWebsite permission. - By default, only the bucket owner can delete the website configuration attached to - a bucket. However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission. - - - - For more information about hosting websites, see Hosting - Websites on Amazon S3. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the DeleteBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteBucketWebsite service method, as returned by S3. - - - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - The bucket name of the lifecycle to delete. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - - - - Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all - the lifecycle configuration rules in the lifecycle subresource associated with the - bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any - objects on the basis of rules contained in the deleted lifecycle configuration. - - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration - action. By default, the bucket owner has this permission and the bucket owner can - grant this permission to others. - - - - There is usually some time lag before lifecycle configuration deletion is fully propagated - to all the Amazon S3 systems. - - - - For more information about the object expiration, see Elements - to Describe Lifecycle Actions. - - - - Related actions include: - - - - Container for the necessary parameters to execute the DeleteLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteLifecycleConfiguration service method, as returned by S3. - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key name of the object to delete. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - The bucket name of the bucket containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key name of the object to delete. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - - - - Removes the null version (if there is one) of an object and inserts a delete marker, - which becomes the latest version of the object. If there isn't a null version, Amazon - S3 does not remove any objects. - - - - To remove a specific version, you must be the bucket owner and you must use the version - Id subresource. Using this subresource permanently deletes the version. If the object - deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true. - - - - If the object you want to delete is in a bucket where the bucket versioning configuration - is MFA Delete enabled, you must include the x-amz-mfa request header - in the DELETE versionId request. Requests that include x-amz-mfa - must use HTTPS. - - - - For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request. - - - - You can delete objects by explicitly calling the DELETE Object API or configure its - lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. - If you want to block users or accounts from removing or deleting objects from your - bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions. - - - - The following operation is related to DeleteObject: - - - - Container for the necessary parameters to execute the DeleteObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObject service method, as returned by S3. - - - - This operation enables you to delete multiple objects from a bucket using a single - HTTP request. If you know the object keys that you want to delete, then this operation - provides a suitable alternative to sending individual delete requests, reducing per-request - overhead. - - - - The request contains a list of up to 1000 keys that you want to delete. In the XML, - you provide the object key names, and optionally, version IDs if you want to delete - a specific version of the object from a versioning-enabled bucket. For each key, Amazon - S3 performs a delete operation and returns the result of that delete, success, or - failure, in the response. Note that if the object specified in the request is not - found, Amazon S3 returns the result as deleted. - - - - The operation supports two modes for the response: verbose and quiet. By default, - the operation uses verbose mode in which the response includes the result of deletion - of each key in your request. In quiet mode the response includes only keys where the - delete operation encountered an error. For a successful deletion, the operation does - not return any information about the delete in the response body. - - - - When performing this operation on an MFA Delete enabled bucket, that attempts to delete - any versioned objects, you must include an MFA token. If you do not provide one, the - entire request will fail, even if there are non-versioned objects you are trying to - delete. If you provide an invalid token, whether there are versioned keys in the request - or not, the entire Multi-Object Delete request will fail. For information about MFA - Delete, see - MFA Delete. - - - - Finally, the Content-MD5 header is required for all Multi-Object Delete requests. - Amazon S3 uses the header value to ensure that your request body has not been altered - in transit. - - - - The following operations are related to DeleteObjects: - - - - Container for the necessary parameters to execute the DeleteObjects service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObjects service method, as returned by S3. - - - - Removes the entire tag set from the specified object. For more information about managing - object tags, see - Object Tagging. - - - - To use this operation, you must have permission to perform the s3:DeleteObjectTagging - action. - - - - To delete tags of a specific object version, add the versionId query - parameter in the request. You will need permission for the s3:DeleteObjectVersionTagging - action. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeleteObjectTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeleteObjectTagging service method, as returned by S3. - - - - Removes the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:PutBucketPublicAccessBlock - permission. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the DeletePublicAccessBlock service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the DeletePublicAccessBlock service method, as returned by S3. - - - - - - - - - Returns the default encryption configuration for an Amazon S3 bucket. For information - about the Amazon S3 default encryption feature, see Amazon - S3 Default Bucket Encryption. - - - - To use this operation, you must have permission to perform the s3:GetEncryptionConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following operations are related to GetBucketEncryption: - - - - Container for the necessary parameters to execute the GetBucketEncryption service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketEncryption service method, as returned by S3. - - - - Returns an inventory configuration (identified by the inventory configuration ID) - from the bucket. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory. - - - - The following operations are related to GetBucketInventoryConfiguration: - - - - Container for the necessary parameters to execute the GetBucketInventoryConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketInventoryConfiguration service method, as returned by S3. - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - The name of the bucket for which to get the location. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLocation service method, as returned by S3. - - - - Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint - request parameter in a CreateBucket request. For more information, see - CreateBucket. - - - - To use this implementation of the operation, you must be the bucket owner. - - - - The following operations are related to GetBucketLocation: - - - - Container for the necessary parameters to execute the GetBucketLocation service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLocation service method, as returned by S3. - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - The bucket name for which to get the logging information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLogging service method, as returned by S3. - - - - Returns the logging status of a bucket and the permissions users have to view and - modify that status. To use GET, you must be the bucket owner. - - - - The following operations are related to GetBucketLogging: - - - - Container for the necessary parameters to execute the GetBucketLogging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketLogging service method, as returned by S3. - - - - Gets a metrics configuration (specified by the metrics configuration ID) from the - bucket. Note that this doesn't include the daily storage metrics. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to GetBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the GetBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketMetricsConfiguration service method, as returned by S3. - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following operation is related to GetBucketNotification: - - - - Name of the bucket for which to get the notification configuration - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketNotification service method, as returned by S3. - - - - Returns the notification configuration of a bucket. - - - - If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration - element. - - - - By default, you must be the bucket owner to read the notification configuration of - a bucket. However, the bucket owner can use a bucket policy to grant permission to - other users to read this configuration with the s3:GetBucketNotification - permission. - - - - For more information about setting and reading the notification configuration on a - bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies. - - - - The following operation is related to GetBucketNotification: - - - - Container for the necessary parameters to execute the GetBucketNotification service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketNotification service method, as returned by S3. - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operation is related to GetBucketPolicy: - - - - The bucket name for which to get the bucket policy. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicy service method, as returned by S3. - - - - Returns the policy of a specified bucket. If you are using an identity other than - the root user of the AWS account that owns the bucket, the calling identity must have - the GetBucketPolicy permissions on the specified bucket and belong to - the bucket owner's account in order to use this operation. - - - - If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operation is related to GetBucketPolicy: - - - - Container for the necessary parameters to execute the GetBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicy service method, as returned by S3. - - - - Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket - is public. In order to use this operation, you must have the s3:GetBucketPolicyStatus - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - For more information about when Amazon S3 considers a bucket public, see The - Meaning of "Public". - - - - The following operations are related to GetBucketPolicyStatus: - - - - Container for the necessary parameters to execute the GetBucketPolicyStatus service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketPolicyStatus service method, as returned by S3. - - - - Retrieves the replication configuration for the given Amazon S3 bucket. - - Container for the necessary parameters to execute the GetBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketReplication service method, as returned by S3. - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - The name of the bucket for which to get the payment request configuration - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketRequestPayment service method, as returned by S3. - - - - Returns the request payment configuration of a bucket. To use this version of the - operation, you must be the bucket owner. For more information, see Requester - Pays Buckets. - - - - The following operations are related to GetBucketRequestPayment: - - - - Container for the necessary parameters to execute the GetBucketRequestPayment service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketRequestPayment service method, as returned by S3. - - - - Returns the tag set associated with the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketTagging - action. By default, the bucket owner has this permission and can grant this permission - to others. - - - - GetBucketTagging has the following special error: - -
  • - - Error code: NoSuchTagSetError - -
    • - - Description: There is no tag set associated with the bucket. - -
- - The following operations are related to GetBucketTagging: - - - - Container for the necessary parameters to execute the GetBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketTagging service method, as returned by S3. - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - The name of the bucket for which to get the versioning information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketVersioning service method, as returned by S3. - - - - Returns the versioning state of a bucket. - - - - To retrieve the versioning state of a bucket, you must be the bucket owner. - - - - This implementation also returns the MFA Delete status of the versioning state. If - the MFA Delete status is enabled, the bucket owner must use an authentication - device to change the versioning state of the bucket. - - - - The following operations are related to GetBucketVersioning: - - - - Container for the necessary parameters to execute the GetBucketVersioning service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketVersioning service method, as returned by S3. - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET operation requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - The bucket name for which to get the website configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketWebsite service method, as returned by S3. - - - - Returns the website configuration for a bucket. To host website on Amazon S3, you - can configure a bucket as website by adding a website configuration. For more information - about hosting websites, see Hosting - Websites on Amazon S3. - - - - This GET operation requires the S3:GetBucketWebsite permission. By default, - only the bucket owner can read the bucket website configuration. However, bucket owners - can allow other users to read the website configuration by writing a bucket policy - granting them the S3:GetBucketWebsite permission. - - - - The following operations are related to DeleteBucketWebsite: - - - - Container for the necessary parameters to execute the GetBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetBucketWebsite service method, as returned by S3. - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - The bucket name for which to get the cors configuration. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetCORSConfiguration service method, as returned by S3. - - - - Returns the cors configuration information set for the bucket. - - - - To use this operation, you must have permission to perform the s3:GetBucketCORS action. - By default, the bucket owner has this permission and can grant it to others. - - - - For more information about cors, see - Enabling Cross-Origin Resource Sharing. - - - - The following operations are related to GetBucketCors: - - - - Container for the necessary parameters to execute the GetCORSConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetCORSConfiguration service method, as returned by S3. - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are still using previous version of the lifecycle configuration, it works. - For the earlier API description, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to DeleteBucketMetricsConfiguration: - - - - The name of the bucket for which to get the lifecycle information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetLifecycleConfiguration service method, as returned by S3. - - - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The response describes the new filter element that - you can use to specify a filter to select a subset of objects to which the rule applies. - If you are still using previous version of the lifecycle configuration, it works. - For the earlier API description, see GetBucketLifecycle. - - - - Returns the lifecycle configuration information set on the bucket. For information - about lifecycle configuration, see Object - Lifecycle Management. - - - - To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration - action. The bucket owner has this permission, by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - GetBucketLifecycleConfiguration has the following special error: - -
  • - - Error code: NoSuchLifecycleConfiguration - -
    • - - Description: The lifecycle configuration does not exist. - -
    • - - HTTP Status Code: 404 Not Found - -
    • - - SOAP Fault Code Prefix: Client - -
- - The following operations are related to DeleteBucketMetricsConfiguration: - - - - Container for the necessary parameters to execute the GetLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetLifecycleConfiguration service method, as returned by S3. - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object to get. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Key of the object to get. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - - - - Retrieves objects from Amazon S3. To use GET, you must have READ - access to the object. If you grant READ access to the anonymous user, - you can return the object without using an authorization header. - - - - An Amazon S3 bucket has no directory hierarchy such as you would find in a typical - computer file system. You can, however, create a logical hierarchy by using object - key names that imply a folder structure. For example, instead of naming an object - sample.jpg, you can name it photos/2006/February/sample.jpg. - - - - To get an object from such a logical hierarchy, specify the full key name for the - object in the GET operation. For a virtual hosted-style request example, - if you have the object photos/2006/February/sample.jpg, specify the resource - as /photos/2006/February/sample.jpg. For a path-style request example, - if you have the object photos/2006/February/sample.jpg in the bucket - named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. - For more information about request types, see HTTP - Host Header Bucket Specification. - - - - To distribute large files to many people, you can save bandwidth costs by using BitTorrent. - For more information, see Amazon - S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. - - - - If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage - classes, before you can retrieve the object you must first restore a copy using . - Otherwise, this operation returns an InvalidObjectStateError error. For - information about restoring archived objects, see Restoring - Archived Objects. - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging - action), the response also returns the x-amz-tagging-count header that - provides the count of number of tags associated with the object. You can use GetObjectTagging - to retrieve the tag set associated with an object. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 will - return an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 will return - an HTTP status code 403 ("access denied") error. - -
- - Versioning - - - - By default, the GET operation returns the current version of an object. To return - a different version, use the versionId subresource. - - - - If the current version of the object is a delete marker, Amazon S3 behaves as if the - object was deleted and includes x-amz-delete-marker: true in the response. - - - - For more information about versioning, see PutBucketVersioning. - - - - Overriding Response Header Values - - - - There are times when you want to override certain response header values in a GET - response. For example, you might override the Content-Disposition response header - value in your GET request. - - - - You can override values for a set of response headers using the following query parameters. - These response header values are sent only on a successful request, that is, when - status code 200 OK is returned. The set of headers you can override using these parameters - is a subset of the headers that Amazon S3 accepts when you create an object. The response - headers that you can override for the GET response are Content-Type, - Content-Language, Expires, Cache-Control, Content-Disposition, - and Content-Encoding. To override these header values in the GET response, - you use the following request parameters. - - - - You must sign the request, either using an Authorization header or a presigned URL, - when using these parameters. They cannot be used with an unsigned (anonymous) request. - -
  • - - response-content-type - -
  • - - response-content-language - -
  • - - response-expires - -
  • - - response-cache-control - -
  • - - response-content-disposition - -
  • - - response-content-encoding - -
- - Additional Considerations about Request Headers - - - - If both of the If-Match and If-Unmodified-Since headers - are present in the request as follows: If-Match condition evaluates to - true, and; If-Unmodified-Since condition evaluates to false; - then, S3 returns 200 OK and the data requested. - - - - If both of the If-None-Match and If-Modified-Since headers - are present in the request as follows: If-None-Match condition evaluates - to false, and; If-Modified-Since condition evaluates to - true; then, S3 returns 304 Not Modified response code. - - - - For more information about conditional requests, see RFC - 7232. - - - - The following operations are related to GetObject: - - - - Container for the necessary parameters to execute the GetObject service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObject service method, as returned by S3. - - - - Gets an object's current Legal Hold status. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLegalHold service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectLegalHold service method, as returned by S3. - - - - Gets the Object Lock configuration for a bucket. The rule specified in the Object - Lock configuration will be applied by default to every new object placed in the specified - bucket. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectLockConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectLockConfiguration service method, as returned by S3. - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - The name of the bucket containing the object. - The object key. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - The name of the bucket containing the object. - The object key. - VersionId used to reference a specific version of the object. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - - - - The HEAD operation retrieves metadata from an object without returning the object - itself. This operation is useful if you're only interested in an object's metadata. - To use HEAD, you must have READ access to the object. - - - - A HEAD request has the same options as a GET operation on - an object. The response is identical to the GET response except that - there is no response body. - - - - If you encrypt an object by using server-side encryption with customer-provided encryption - keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata - from the object, you must use the following headers: - -
  • - - x-amz-server-side​-encryption​-customer-algorithm - -
  • - - x-amz-server-side​-encryption​-customer-key - -
  • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
- - For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys). - - - - Encryption request headers, like x-amz-server-side-encryption, should - not be sent for GET requests if your object uses server-side encryption with CMKs - stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - BadRequest error. - - - - Request headers are limited to 8 KB in size. For more information, see Common - Request Headers. - - - - Consider the following when using request headers: - -
  • - - Consideration 1 – If both of the If-Match and If-Unmodified-Since - headers are present in the request as follows: - -
    • - - If-Match condition evaluates to true, and; - -
    • - - If-Unmodified-Since condition evaluates to false; - -
    - - Then Amazon S3 returns 200 OK and the data requested. - -
  • - - Consideration 2 – If both of the If-None-Match and If-Modified-Since - headers are present in the request as follows: - -
    • - - If-None-Match condition evaluates to false, and; - -
    • - - If-Modified-Since condition evaluates to true; - -
    - - Then Amazon S3 returns the 304 Not Modified response code. - -
- - For more information about conditional requests, see RFC - 7232. - - - - Permissions - - - - You need the s3:GetObject permission for this operation. For more information, - see Specifying - Permissions in a Policy. If the object you request does not exist, the error Amazon - S3 returns depends on whether you also have the s3:ListBucket permission. - -
  • - - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - an HTTP status code 404 ("no such key") error. - -
  • - - If you don’t have the s3:ListBucket permission, Amazon S3 returns an - HTTP status code 403 ("access denied") error. - -
- - The following operation is related to HeadObject: - - - - Container for the necessary parameters to execute the GetObjectMetadata service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectMetadata service method, as returned by S3. - - - - Retrieves an object's retention settings. For more information, see Locking - Objects. - - Container for the necessary parameters to execute the GetObjectRetention service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectRetention service method, as returned by S3. - - - - Returns the tag-set of an object. You send the GET request against the tagging subresource - associated with the object. - - - - To use this operation, you must have permission to perform the s3:GetObjectTagging - action. By default, the GET operation returns information about current version of - an object. For a versioned bucket, you can have multiple versions of an object in - your bucket. To retrieve tags of any other version, use the versionId query parameter. - You also need permission for the s3:GetObjectVersionTagging action. - - - - By default, the bucket owner has this permission and can grant this permission to - others. - - - - For information about the Amazon S3 object tagging feature, see Object - Tagging. - - - - The following operation is related to GetObjectTagging: - - - - Container for the necessary parameters to execute the GetObjectTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTagging service method, as returned by S3. - - - - Return torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Amazon - S3 Torrent. - - - - You can get torrent only for objects that are less than 5 GB in size and that are - not encrypted using server-side encryption with customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - The following operation is related to GetObjectTorrent: - - - - The name of the bucket containing the object for which to get the torrent files. - The object key for which to get the information. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTorrent service method, as returned by S3. - - - - Return torrent files from a bucket. BitTorrent can save you bandwidth when you're - distributing large files. For more information about BitTorrent, see Amazon - S3 Torrent. - - - - You can get torrent only for objects that are less than 5 GB in size and that are - not encrypted using server-side encryption with customer-provided encryption key. - - - - To use GET, you must have READ access to the object. - - - - The following operation is related to GetObjectTorrent: - - - - Container for the necessary parameters to execute the GetObjectTorrent service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetObjectTorrent service method, as returned by S3. - - - - Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. - To use this operation, you must have the s3:GetBucketPublicAccessBlock - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy. - - - - When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket - or an object, it checks the PublicAccessBlock configuration for both - the bucket (or the bucket that contains the object) and the bucket owner's account. - If the PublicAccessBlock settings are different between the bucket and - the account, Amazon S3 uses the most restrictive combination of the bucket-level and - account-level settings. - - - - For more information about when Amazon S3 considers a bucket or an object public, - see The - Meaning of "Public". - - - - The following operations are related to GetPublicAccessBlock: - - - - Container for the necessary parameters to execute the GetPublicAccessBlock service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the GetPublicAccessBlock service method, as returned by S3. - - - - This operation initiates a multipart upload and returns an upload ID. This upload - ID is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort operation - and Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload API and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart) and UploadPartCopy) requests must match the headers you - used in the request to initiate the upload by using CreateMultipartUpload. - - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, - kms:GenerateDataKey*, and kms:DescribeKey actions on the - key. These permissions are required because Amazon S3 must decrypt and read data from - the encrypted file parts before it completes the multipart upload. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - The following operations are related to CreateMultipartUpload: - - - - The name of the bucket to which to initiate the upload - Object key for which the multipart upload is to be initiated. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the InitiateMultipartUpload service method, as returned by S3. - - - - This operation initiates a multipart upload and returns an upload ID. This upload - ID is used to associate all of the parts in the specific multipart upload. You specify - this upload ID in each of your subsequent upload part requests (see UploadPart). - You also include this upload ID in the final request to either complete or abort the - multipart upload request. - - - - For more information about multipart uploads, see Multipart - Upload Overview. - - - - If you have configured a lifecycle rule to abort incomplete multipart uploads, the - upload must complete within the number of days specified in the bucket lifecycle configuration. - Otherwise, the incomplete multipart upload becomes eligible for an abort operation - and Amazon S3 aborts the multipart upload. For more information, see Aborting - Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. - - - - For information about the permissions required to use the multipart upload API, see - Multipart - Upload API and Permissions. - - - - For request signing, multipart upload is just a series of regular requests. You initiate - a multipart upload, send one or more requests to upload parts, and then complete the - multipart upload process. You sign each request individually. There is nothing special - about signing multipart upload requests. For more information about signing, see Authenticating - Requests (AWS Signature Version 4). - - - - After you initiate a multipart upload and upload one or more parts, to stop being - charged for storing the uploaded parts, you must either complete or abort the multipart - upload. Amazon S3 frees up the space used to store the parts and stop charging you - for storing them only after you either complete or abort a multipart upload. - - - - You can optionally request server-side encryption. For server-side encryption, Amazon - S3 encrypts your data as it writes it to disks in its data centers and decrypts it - when you access it. You can provide your own encryption key, or use AWS Key Management - Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. - If you choose to provide your own encryption key, the request headers you provide - in UploadPart) and UploadPartCopy) requests must match the headers you - used in the request to initiate the upload by using CreateMultipartUpload. - - - - - To perform a multipart upload with encryption using an AWS KMS CMK, the requester - must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, - kms:GenerateDataKey*, and kms:DescribeKey actions on the - key. These permissions are required because Amazon S3 must decrypt and read data from - the encrypted file parts before it completes the multipart upload. - - - - If your AWS Identity and Access Management (IAM) user or role is in the same AWS account - as the AWS KMS CMK, then you must have these permissions on the key policy. If your - IAM user or role belongs to a different account than the key, then you must have the - permissions on both the key policy and your IAM user or role. - - - - For more information, see Protecting - Data Using Server-Side Encryption. - -
Access Permissions
- - When copying an object, you can optionally specify the accounts or groups that should - be granted specific permissions on the new object. There are two ways to grant the - permissions using the request headers: - -
  • - - Specify a canned ACL with the x-amz-acl request header. For more information, - see Canned - ACL. - -
  • - - Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, - x-amz-grant-write-acp, and x-amz-grant-full-control headers. - These parameters map to the set of permissions that Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - -
Server-Side- Encryption-Specific Request Headers
- - You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts it when you access it. The - option you use depends on whether you want to use AWS managed encryption keys or provide - your own encryption key. - -
  • - - Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in - AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to - encrypt data, specify the following headers in the request. - -
    • - - x-amz-server-side​-encryption - -
    • - - x-amz-server-side-encryption-aws-kms-key-id - -
    • - - x-amz-server-side-encryption-context - -
    - - If you specify x-amz-server-side-encryption:aws:kms, but don't provide - x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed - CMK in AWS KMS to protect the data. - - - - All GET and PUT requests for an object protected by AWS KMS fail if you don't make - them with SSL or by using SigV4. - - - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
  • - - Use customer-provided encryption keys – If you want to manage your own encryption - keys, provide all the following headers in the request. - -
    • - - x-amz-server-side​-encryption​-customer-algorithm - -
    • - - x-amz-server-side​-encryption​-customer-key - -
    • - - x-amz-server-side​-encryption​-customer-key-MD5 - -
    - - For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), - see Protecting - Data Using Server-Side Encryption with CMKs stored in AWS KMS. - -
Access-Control-List (ACL)-Specific Request Headers
- - - You also can use the following access control–related headers with this operation. - By default, all objects are private. Only the owner has full access control. When - adding a new object, you can grant permissions to individual AWS accounts or to predefined - groups defined by Amazon S3. These permissions are then added to the access control - list (ACL) on the object. For more information, see Using - ACLs. With this operation, you can grant access permissions using one of the following - two methods: - -
  • - - Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined - ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees - and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly — To explicitly grant access permissions to - specific AWS accounts or groups, use the following headers. Each header maps to specific - permissions that Amazon S3 supports in an ACL. For more information, see Access - Control List (ACL) Overview. In the header, you specify a list of grantees who - get the specific permission. To grant permissions explicitly, use: - -
    • - - x-amz-grant-read - -
    • - - x-amz-grant-write - -
    • - - x-amz-grant-read-acp - -
    • - - x-amz-grant-write-acp - -
    • - - x-amz-grant-full-control - -
    - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - The following operations are related to CreateMultipartUpload: - - - - Container for the necessary parameters to execute the InitiateMultipartUpload service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the InitiateMultipartUpload service method, as returned by S3. - - - - Lists the analytics configurations for the bucket. You can have up to 1,000 analytics - configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. You should always check the IsTruncated element in the response. - If there are no more configurations to list, IsTruncated is set to false. - If there are more configurations to list, IsTruncated is set to true, - and there will be a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about Amazon S3 analytics feature, see Amazon - S3 Analytics – Storage Class Analysis. - - - - The following operations are related to ListBucketAnalyticsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketAnalyticsConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketAnalyticsConfigurations service method, as returned by S3. - - - - Returns a list of inventory configurations for the bucket. You can have up to 1,000 - analytics configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about the Amazon S3 inventory feature, see Amazon - S3 Inventory - - - - The following operations are related to ListBucketInventoryConfigurations: - - - - Container for the necessary parameters to execute the ListBucketInventoryConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketInventoryConfigurations service method, as returned by S3. - - - - Lists the metrics configurations for the bucket. The metrics configurations are only - for the request metrics of the bucket and do not provide information on daily storage - metrics. You can have up to 1,000 configurations per bucket. - - - - This operation supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. If there - are no more configurations to list, IsTruncated is set to false. If there - are more configurations to list, IsTruncated is set to true, and there - is a value in NextContinuationToken. You use the NextContinuationToken - value to continue the pagination of the list by passing the value in continuation-token - in the request to GET the next page. - - - - To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For more information about metrics configurations and CloudWatch request metrics, - see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to ListBucketMetricsConfigurations: - - - - Container for the necessary parameters to execute the ListBucketMetricsConfigurations service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBucketMetricsConfigurations service method, as returned by S3. - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBuckets service method, as returned by S3. - - - - Returns a list of all buckets owned by the authenticated sender of the request. - - Container for the necessary parameters to execute the ListBuckets service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListBuckets service method, as returned by S3. - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - - - - This operation lists in-progress multipart uploads. An in-progress multipart upload - is a multipart upload that has been initiated using the Initiate Multipart Upload - request, but has not yet been completed or aborted. - - - - This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is also the - default value. You can further limit the number of uploads in a response by specifying - the max-uploads parameter in the response. If additional multipart uploads - satisfy the list criteria, the response will contain an IsTruncated element - with the value true. To list the additional multipart uploads, use the key-marker - and upload-id-marker request parameters. - - - - In the response, the uploads are sorted by key. If your application has initiated - more than one multipart upload using the same object key, then uploads in the response - are first sorted by key. Additionally, uploads are sorted in ascending order within - each key by the upload initiation time. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListMultipartUploads: - - - - Container for the necessary parameters to execute the ListMultipartUploads service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListMultipartUploads service method, as returned by S3. - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - The name of the bucket containing the objects. - Limits the response to keys that begin with the specified prefix. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Be sure to design your application - to parse the contents of the response and handle it appropriately. - - - - This API has been revised. We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues to support - ListObjects. - - - - The following operations are related to ListObjects: - - - - Container for the necessary parameters to execute the ListObjects service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjects service method, as returned by S3. - - - - Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - parameters as selection criteria to return a subset of the objects in a bucket. A - 200 OK response can contain valid or invalid XML. Make sure to design - your application to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - To use this operation in an AWS Identity and Access Management (IAM) policy, you must - have permissions to perform the s3:ListBucket action. The bucket owner - has this permission by default and can grant this permission to others. For more information - about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - This section describes the latest revision of the API. We recommend that you use this - revised API for application development. For backward compatibility, Amazon S3 continues - to support the prior version of this API, ListObjects. - - - - To get a list of your buckets, see ListBuckets. - - - - The following operations are related to ListObjectsV2: - - - - Container for the necessary parameters to execute the ListObjectsV2 service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListObjectsV2 service method, as returned by S3. - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). This request returns a maximum of 1,000 - uploaded parts. The default number of parts returned is 1,000 parts. You can restrict - the number of parts returned by specifying the max-parts request parameter. - If your multipart upload consists of more than 1,000 parts, the response returns an - IsTruncated field with the value of true, and a NextPartNumberMarker - element. In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListParts: - - - - Name of the bucket to which the parts are being uploaded. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Object key for which the multipart upload was initiated. - Upload ID identifying the multipart upload whose parts are being listed. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListParts service method, as returned by S3. - - - - Lists the parts that have been uploaded for a specific multipart upload. This operation - must include the upload ID, which you obtain by sending the initiate multipart upload - request (see CreateMultipartUpload). This request returns a maximum of 1,000 - uploaded parts. The default number of parts returned is 1,000 parts. You can restrict - the number of parts returned by specifying the max-parts request parameter. - If your multipart upload consists of more than 1,000 parts, the response returns an - IsTruncated field with the value of true, and a NextPartNumberMarker - element. In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response. - - - - For more information on multipart uploads, see Uploading - Objects Using Multipart Upload. - - - - For information on permissions required to use the multipart upload API, see Multipart - Upload API and Permissions. - - - - The following operations are related to ListParts: - - - - Container for the necessary parameters to execute the ListParts service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListParts service method, as returned by S3. - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - The bucket name that contains the objects. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. - Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - - - - Returns metadata about all of the versions of objects in a bucket. You can also use - request parameters as selection criteria to return metadata about a subset of all - the object versions. - - - - A 200 OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately. - - - - To use this operation, you must have READ access to the bucket. - - - - The following operations are related to ListObjectVersions: - - - - Container for the necessary parameters to execute the ListVersions service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the ListVersions service method, as returned by S3. - - - - - Creates a new bucket. To create a bucket, you must register with Amazon S3 and have - a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed - to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information on bucket naming restrictions, - see Working - with Amazon S3 Buckets. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the EU (Ireland) - Region. For more information, see How - to Select a Region for Your Buckets. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - Hosting of Buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - The name of the bucket to create. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucket service method, as returned by S3. - - - - Creates a new bucket. To create a bucket, you must register with Amazon S3 and have - a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed - to create buckets. By creating the bucket, you become the bucket owner. - - - - Not every string is an acceptable bucket name. For information on bucket naming restrictions, - see Working - with Amazon S3 Buckets. - - - - By default, the bucket is created in the US East (N. Virginia) Region. You can optionally - specify a Region in the request body. You might choose a Region to optimize latency, - minimize costs, or address regulatory requirements. For example, if you reside in - Europe, you will probably find it advantageous to create buckets in the EU (Ireland) - Region. For more information, see How - to Select a Region for Your Buckets. - - - - If you send your create bucket request to the s3.amazonaws.com endpoint, - the request goes to the us-east-1 Region. Accordingly, the signature calculations - in Signature Version 4 must use us-east-1 as the Region, even if the location constraint - in the request specifies another Region where the bucket is to be created. If you - create a bucket in a Region other than US East (N. Virginia), your application must - be able to handle 307 redirect. For more information, see Virtual - Hosting of Buckets. - - - - When creating a bucket using this operation, you can optionally specify the accounts - or groups that should be granted specific permissions on the bucket. There are two - ways to grant the appropriate permissions using the request headers. - -
  • - - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports - a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined - set of grantees and permissions. For more information, see Canned - ACL. - -
  • - - Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, - x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control - headers. These headers map to the set of permissions Amazon S3 supports in an ACL. - For more information, see Access - Control List (ACL) Overview. - - - - You specify each grantee as a type=value pair, where the type is one of the following: - -
    • - - emailAddress – if the value specified is the email address of an AWS - account - -
    • - - id – if the value specified is the canonical user ID of an AWS account - -
    • - - uri – if you are granting permissions to a predefined group - -
    - - For example, the following x-amz-grant-read header grants the AWS accounts - identified by email addresses permissions to read object data and its metadata: - - - - x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" - - -
- - You can use either a canned ACL or specify access permissions explicitly. You cannot - do both. - - - - The following operations are related to CreateBucket: - - - - Container for the necessary parameters to execute the PutBucket service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucket service method, as returned by S3. - - - - Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration - is a bucket-level feature that enables you to perform faster data transfers to Amazon - S3. - - - - To use this operation, you must have permission to perform the s3:PutAccelerateConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - The Transfer Acceleration state of a bucket can be set to one of the following two - values: - -
  • - - Enabled – Enables accelerated data transfers to the bucket. - -
  • - - Suspended – Disables accelerated data transfers to the bucket. - -
- - The GetBucketAccelerateConfiguration operation returns the transfer acceleration - state of a bucket. - - - - After setting the Transfer Acceleration state of a bucket to Enabled, it might take - up to thirty minutes before the data transfer rates to the bucket increase. - - - - The name of the bucket used for Transfer Acceleration must be DNS-compliant and must - not contain periods ("."). - - - - For more information about transfer acceleration, see Transfer - Acceleration. - - - - The following operations are related to PutBucketAccelerateConfiguration: - - - - Container for the necessary parameters to execute the PutBucketAccelerateConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketAccelerateConfiguration service method, as returned by S3. - - - - - - - Set the logging parameters for a bucket and to specify permissions for who can view - and modify the logging parameters. All logs are saved to buckets in the same AWS Region - as the source bucket. To set the logging status of a bucket, you must be the bucket - owner. - - - - The bucket owner is automatically granted FULL_CONTROL to all logs. You use the Grantee - request element to grant access to other people. The Permissions request - element specifies the kind of access the grantee has to the logs. - - - - Grantee Values - - - - You can specify the person (grantee) to whom you're assigning access rights (using - request elements) in the following ways: - -
  • - - By the person's ID: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> - </Grantee> - - - - DisplayName is optional and ignored in the request. - -
  • - - By Email address: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee> - - - - - The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl - request, appears as the CanonicalUser. - -
  • - - By URI: - - - - <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee> - - -
- - To enable logging, you use LoggingEnabled and its children request elements. To disable - logging, you use an empty BucketLoggingStatus request element: - - - - <BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01" /> - - - - - For more information about server access logging, see Server - Access Logging. - - - - For more information about creating a bucket, see CreateBucket. For more information - about returning the logging status of a bucket, see GetBucketLogging. - - - - The following operations are related to PutBucketLogging: - - - - Container for the necessary parameters to execute the PutBucketLogging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketLogging service method, as returned by S3. - - - - Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. - You can have up to 1,000 metrics configurations per bucket. If you're updating an - existing metrics configuration, note that this is a full replacement of the existing - metrics configuration. If you don't include the elements you want to keep, they are - erased. - - - - To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner can grant - this permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - For information about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch. - - - - The following operations are related to PutBucketMetricsConfiguration: - - - - GetBucketLifecycle has the following special error: - -
  • - - Error code: TooManyConfigurations - -
    • - - Description: You are attempting to create a new configuration but have already reached - the 1,000-configuration limit. - -
    • - - HTTP Status Code: HTTP 400 Bad Request - -
- - Container for the necessary parameters to execute the PutBucketMetricsConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketMetricsConfiguration service method, as returned by S3. - - - - Enables notifications of specified events for a bucket. For more information about - event notifications, see Configuring - Event Notifications. - - - - Using this API, you can replace an existing notification configuration. The configuration - is an XML file that defines the event types that you want Amazon S3 to publish and - the destination where you want Amazon S3 to publish an event notification when it - detects an event of the specified type. - - - - By default, your bucket has no event notifications configured. That is, the notification - configuration will be an empty NotificationConfiguration. - - - - <NotificationConfiguration> - - - - </NotificationConfiguration> - - - - This operation replaces the existing notification configuration with the configuration - you include in the request body. - - - - After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification - Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, - and that the bucket owner has permission to publish to it by sending a test notification. - In the case of AWS Lambda destinations, Amazon S3 verifies that the Lambda function - permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. - For more information, see Configuring - Notifications for Amazon S3 Events. - - - - You can disable notifications by adding the empty NotificationConfiguration element. - - - - By default, only the bucket owner can configure notifications on a bucket. However, - bucket owners can use a bucket policy to grant permission to other users to set this - configuration with s3:PutBucketNotification permission. - - - - The PUT notification is an atomic operation. For example, suppose your notification - configuration includes SNS topic, SQS queue, and Lambda function configurations. When - you send a PUT request with this configuration, Amazon S3 sends test messages to your - SNS topic. If the message fails, the entire PUT operation will fail, and Amazon S3 - will not add the configuration to your bucket. - - - - Responses - - - - If the configuration in the request body includes only one TopicConfiguration - specifying only the s3:ReducedRedundancyLostObject event type, the response - will also include the x-amz-sns-test-message-id header containing the - message ID of the test notification sent to the topic. - - - - The following operation is related to PutBucketNotificationConfiguration: - - - - Container for the necessary parameters to execute the PutBucketNotification service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketNotification service method, as returned by S3. - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - The name of the bucket. - The bucket policy as a JSON document. - The MD5 hash of the request body. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - - - - Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity - other than the root user of the AWS account that owns the bucket, the calling identity - must have the PutBucketPolicy permissions on the specified bucket and - belong to the bucket owner's account in order to use this operation. - - - - If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - Access Denied error. If you have the correct permissions, but you're not using - an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 - Method Not Allowed error. - - - - As a security precaution, the root user of the AWS account that owns a bucket can - always use this operation, even if the policy explicitly denies the root user the - ability to perform this action. - - - - For more information about bucket policies, see Using - Bucket Policies and User Policies. - - - - The following operations are related to PutBucketPolicy: - - - - Container for the necessary parameters to execute the PutBucketPolicy service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketPolicy service method, as returned by S3. - - - - Creates a replication configuration or replaces an existing one. For more information, - see Replication - in the Amazon S3 Developer Guide. - - - - To perform this operation, the user or role performing the operation must have the - iam:PassRole - permission. - - - - Specify the replication configuration in the request body. In the replication configuration, - you provide the name of the destination bucket where you want Amazon S3 to replicate - objects, the IAM role that Amazon S3 can assume to replicate objects on your behalf, - and other relevant information. - - - - A replication configuration must include at least one rule, and can contain a maximum - of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects - in the source bucket. To choose additional subsets of objects to replicate, add a - rule for each subset. All rules must specify the same destination bucket. - - - - To specify a subset of the objects in the source bucket to apply a replication rule - to, add the Filter element as a child of the Rule element. You can filter objects - based on an object key prefix, one or more object tags, or both. When you add the - Filter element in the configuration, you must also add the following elements: DeleteMarkerReplication, - Status, and Priority. - - - - For information about enabling versioning on a bucket, see Using - Versioning. - - - - By default, a resource owner, in this case the AWS account that created the bucket, - can perform this operation. The resource owner can also grant others permissions to - perform the operation. For more information about permissions, see Specifying - Permissions in a Policy and Managing - Access Permissions to Your Amazon S3 Resources. - - - - Handling Replication of Encrypted Objects - - - - By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side - encryption with CMKs stored in AWS KMS. To replicate AWS KMS-encrypted objects, add - the following: SourceSelectionCriteria, SseKmsEncryptedObjects, - Status, EncryptionConfiguration, and ReplicaKmsKeyID. - For information about replication configuration, see Replicating - Objects Created with SSE Using CMKs stored in AWS KMS. - - - - For information on PutBucketReplication errors, see ReplicationErrorCodeList - - - - - The following operations are related to PutBucketReplication: - - - - Container for the necessary parameters to execute the PutBucketReplication service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketReplication service method, as returned by S3. - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - The bucket name. - Container for Payer. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketRequestPayment service method, as returned by S3. - - - - Sets the request payment configuration for a bucket. By default, the bucket owner - pays for downloads from the bucket. This configuration parameter enables the bucket - owner (only) to specify that the person requesting the download will be charged for - the download. For more information, see Requester - Pays Buckets. - - - - The following operations are related to PutBucketRequestPayment: - - - - Container for the necessary parameters to execute the PutBucketRequestPayment service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketRequestPayment service method, as returned by S3. - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging. - - - - Within a bucket, if you add a tag that has the same key as an existing tag, the new - value overwrites the old value. For more information, see Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional operation is currently in progress against - this resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - The bucket name. - A property of PutBucketTaggingRequest used to execute the PutBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketTagging service method, as returned by S3. - - - - Sets the tags for a bucket. - - - - Use tags to organize your AWS bill to reflect your own cost structure. To do this, - sign up to get your AWS account bill with tag key values included. Then, to see the - cost of combined resources, organize your billing information according to resources - with the same tag key values. For example, you can tag several resources with a specific - application name, and then organize your billing information to see the total cost - of that application across several services. For more information, see Cost - Allocation and Tagging. - - - - Within a bucket, if you add a tag that has the same key as an existing tag, the new - value overwrites the old value. For more information, see Using - Cost Allocation in Amazon S3 Bucket Tags. - - - - To use this operation, you must have permissions to perform the s3:PutBucketTagging - action. The bucket owner has this permission by default and can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources. - - - - PutBucketTagging has the following special errors: - -
  • - - Error code: InvalidTagError - -
  • - - Error code: MalformedXMLError - -
    • - - Description: The XML provided does not match the schema. - -
  • - - Error code: OperationAbortedError - -
    • - - Description: A conflicting conditional operation is currently in progress against - this resource. Please try again. - -
  • - - Error code: InternalError - -
    • - - Description: The service was unable to apply the provided tag to the bucket. - -
- - The following operations are related to PutBucketTagging: - - - - Container for the necessary parameters to execute the PutBucketTagging service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketTagging service method, as returned by S3. - - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT operation requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - The bucket name. - Container for the request. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketWebsite service method, as returned by S3. - - - - Sets the configuration of the website that is specified in the website - subresource. To configure a bucket as a website, you can add this subresource on the - bucket with website configuration information such as the file name of the index document - and any redirect rules. For more information, see Hosting - Websites on Amazon S3. - - - - This PUT operation requires the S3:PutBucketWebsite permission. By default, - only the bucket owner can configure the website attached to a bucket; however, bucket - owners can allow other users to set the website configuration by writing a bucket - policy that grants them the S3:PutBucketWebsite permission. - - - - To redirect all website requests sent to the bucket's website endpoint, you add a - website configuration with the following elements. Because all requests are sent to - another website, you don't need to provide index document name for the bucket. - -
  • - - WebsiteConfiguration - -
  • - - RedirectAllRequestsTo - -
  • - - HostName - -
  • - - Protocol - -
- - If you want granular control over redirects, you can use the following elements to - add routing rules that describe conditions for redirecting requests and information - about the redirect destination. In this case, the website configuration must provide - an index document for the bucket, because some requests might not be redirected. - -
  • - - WebsiteConfiguration - -
  • - - IndexDocument - -
  • - - Suffix - -
  • - - ErrorDocument - -
  • - - Key - -
  • - - RoutingRules - -
  • - - RoutingRule - -
  • - - Condition - -
  • - - HttpErrorCodeReturnedEquals - -
  • - - KeyPrefixEquals - -
  • - - Redirect - -
  • - - Protocol - -
  • - - HostName - -
  • - - ReplaceKeyPrefixWith - -
  • - - ReplaceKeyWith - -
  • - - HttpRedirectCode - -
- - Container for the necessary parameters to execute the PutBucketWebsite service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutBucketWebsite service method, as returned by S3. - - - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - The name of the bucket for which to set the configuration. - A property of PutLifecycleConfigurationRequest used to execute the PutLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutLifecycleConfiguration service method, as returned by S3. - - - - Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - configuration. For information about lifecycle configuration, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - Bucket lifecycle configuration now supports specifying a lifecycle rule using an object - key name prefix, one or more object tags, or a combination of both. Accordingly, this - section describes the latest API. The previous version of the API supported filtering - based only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle. - - - - Rules - - - - You specify the lifecycle configuration in your request body. The lifecycle configuration - is specified as XML consisting of one or more rules. Each rule consists of the following: - -
  • - - Filter identifying a subset of objects to which the rule applies. The filter can be - based on a key name prefix, object tags, or a combination of both. - -
  • - - Status whether the rule is in effect. - -
  • - - One or more lifecycle transition and expiration actions that you want Amazon S3 to - perform on the objects identified by the filter. If the state of your bucket is versioning-enabled - or versioning-suspended, you can have many versions of the same object (one current - version and zero or more noncurrent versions). Amazon S3 provides predefined actions - that you can specify for current and noncurrent object versions. - -
- - For more information, see Object - Lifecycle Management and Lifecycle - Configuration Elements. - - - - Permissions - - - - By default, all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). Only - the resource owner (that is, the AWS account that created it) can access the resource. - The resource owner can optionally grant access permissions to others by writing an - access policy. For this operation, a user must get the s3:PutLifecycleConfiguration - permission. - - - - You can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting objects - from your bucket, you must deny them permissions for the following actions: - -
  • - - s3:DeleteObject - -
  • - - s3:DeleteObjectVersion - -
  • - - s3:PutLifecycleConfiguration - -
- - For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources. - - - - The following are related to PutBucketLifecycleConfiguration: - - - - Container for the necessary parameters to execute the PutLifecycleConfiguration service method. - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - The response from the PutLifecycleConfiguration service method, as returned by S3. - - - - - - - - - - - - - - - - - Custom pipeline handler to clean up streams in case of an exception. - - - - - Catch exceptions and clean up any open streams. - - - - - - Catch exceptions and clean up any open streams. - - - - - - - Custom pipeline handler to enable sig V4 for Get requests. - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Custom pipeline handler to enable sig V4 for Get requests. - - - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls pre invoke logic before calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Calls the post invoke logic after calling the next handler - in the pipeline. - - The execution context which contains both the - requests and response context. - - - - Calls the and post invoke logic after calling the next handler - in the pipeline. - - The response type for the current request. - The execution context, it contains the - request and response context. - A task that represents the asynchronous operation. - - - - Constructor for AmazonS3RetryPolicy. - - The IClientConfig object - - - - Perform the processor-bound portion of the RetryForException logic. - This is shared by the sync, async, and APM versions of the RetryForException method. - - - - a value if it can be determined, or null if the IO-bound calculations need to be done - - - - Return true if the request should be retried. Implements additional checks - specific to S3 on top of the checks in DefaultRetryPolicy. - - Request context containing the state of the request. - The exception thrown by the previous request. - Return true if the request should be retried. - - - - Marker interface to identify AmazonS3EncryptionClient. - - - - - Service metadata for Amazon S3 service - - - - - Gets the value of the Service Id. - - - - - Gets the dictionary that gives mapping of renamed operations - - - - - The parameters to request an abort of a multipart upload. - - - After a multipart upload is aborted, no additional parts can be uploaded using that upload ID. - The storage consumed by any previously uploaded parts will be freed. However, if any part uploads - are currently in progress, those part uploads might or might not succeed. As a result, it might be - necessary to abort a given multipart upload multiple times in order to completely free all storage - consumed by all parts. - - - - - The bucket name to which the upload was taking place. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The key of the S3 object that was being uploaded. - - - - - The upload id for the in-progress multipart upload that should be aborted. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the AbortMultipartUpload response metadata. - The AbortMultipartUpload operation has a void result type. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Bucket accelerate configuration. - - - - - The accelerate status of the bucket. - - - - - AccessControlTranslation class - - - - - The override value for the owner of the replica object. - - - - - Class for AnalyticsAndOperator - A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. - The operator must have at least two predicates, and an object must match all of the predicates - in order for the filter to apply. - - Note: The current implementation restricts the usage to atmost one AnalyticsPrefixPredicate - and any number of AnalyticsTagPredicates. - - - - Class for AnalyticsConfiguration - - - - - The identifier used to represent an analytics configuration. - - - - - The filter used to describe a set of objects for analyses. - A filter must have exactly one prefix, one tag, or one conjunction (AnalyticsAndOperator). - If no filter is provided, all objects will be considered in any analysis. - - - - - If present, it indicates that data related to access patterns will be collected - and made available to analyze the tradeoffs between different storage classes. - - - - - Class for AnalyticsExportDestination - - - - - A destination signifying output to an S3 bucket. - - - - - Filter class for Metrics. - - - - - Filter Predicate setup for specific filter types. - - - - - Filter Predicate abstract class for specific filter types to be derived from. - - - - - Abstract class that can be used over logical filter predicates,i.e. AND/OR. - - - - - Internal implementation of Metrics Predicate visitor interface. - - - - - Interface for implementing visitor pattern in Analytics Predicate Filter. - - - - - Interface for implementing visitor pattern in Inventory Predicate Filter. - - - - - Interface for implementing visitor pattern in Metrics Predicate Filter. - - - - - Defines the interface that is used to visit all the different - implementations of - - - - - Visit a - - - - - - Visit a - - - - - - Visit a - - - - - - Implementation of to marshall . - - - - - AbortIncompleteMultipartUpload Unmarshaller - - - - - Abort Multipart Upload Request Marshaller - - - - - Response Unmarshaller for AbortMultipartUpload operation - - - - - AnalyticsConfiguration Unmarshaller - - - - - AnalyticsExportDestinationUnmarshaller - - - - - AnalyticsFilter Unmarshaller - - - - - AnalyticsS3BucketDestination Unmarshaller - - - - - Bucket Unmarshaller - - - - - CommonPrefixesItem Unmarshaller - - - - - Complete Multipart Upload Request Marshaller - - - - - Response Unmarshaller for CompleteMultipartUpload operation - - - - - ContentsItem Unmarshaller - - - - - Copy Object Request Marshaller - - - - - Response Unmarshaller for CopyObject operation - - - - - Upload Part Copy Request Marshaller - - - - - Response Unmarshaller for CopyPart operation - - - - - CORSRule Unmarshaller - - - - - Response Unmarshaller for DefaultRetention Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Delete InventoryConfiguration Request Marshaller - - - - - Response Unmarshaller for DeleteAnalyticsConfiguration operation - - - - - Response Unmarshaller for DeleteCORSConfiguration operation - - - - - Delete InventoryConfiguration Request Marshaller - - - - - Response Unmarshaller for DeleteInventoryConfiguration operation - - - - - Delete Bucket MetricsConfiguration Request Marshaller - - - - - Response Unmarshaller for DeleteBucketMetricsConfiguration operation - - - - - Delete Bucket Policy Request Marshaller - - - - - Response Unmarshaller for DeleteBucketPolicy operation - - - - - Delete Bucket Request Marshaller - - - - - Response Unmarshaller for DeleteBucket operation - - - - - Delete Bucket Tagging Request Marshaller - - - - - Response Unmarshaller for DeleteBucketTagging operation - - - - - Delete Bucket Website Request Marshaller - - - - - Response Unmarshaller for DeleteBucketWebsite operation - - - - - Delete Bucket Cors Request Marshaller - - - - - DeletedObject Unmarshaller - - - - - Delete Bucket Lifecycle Request Marshaller - - - - - Response Unmarshaller for DeleteBucketLifecycle operation - - - - - Delete Object Request Marshaller - - - - - Response Unmarshaller for DeleteObject operation - - - - - Delete Objects Request Marshaller - - - - - Response Unmarshaller for DeleteObjects operation - - - - - DeleteObjectTaggingRequest Marshaller - - - - - Marshall DeleteObjectTaggingRequest object into an http request. - - - - - Marshall DeleteObjectTaggingRequest object into an http request. - - - - - Response Unmarshaller for DeleteObjectTagging operation - - - - - DeletePublicAccessBlock Request Marshaller - - - - - Response Unmarshaller for DeletePublicAccessBlock operation - - - - - ErrorsItem Unmarshaller - - - - - Expiration Unmarshaller - - - - - FilterRule Unmarshaller - - - - - Filter Unmarshaller - - - - - Get Object Acl Request Marshaller - - - - - Response Unmarshaller for GetACL operation - - - - - Get Object Accelerate Configuration Request Marshaller - - - - - Response Unmarshaller for GetACL operation - - - - - Get BucketAnalyticsConfiguration Request Marshaller - - - - - Response Unmarshaller for GetAnalyticsConfiguration operation - - - - - Get InventoryConfiguration Request Marshaller - - - - - Response Unmarshaller for GetInventoryConfiguration operation - - - - - Get Bucket Location Request Marshaller - - - - - Response Unmarshaller for GetBucketLocation operation - - - - - Get Bucket Logging Request Marshaller - - - - - Response Unmarshaller for GetBucketLogging operation - - - - - Get Bucket MetricsConfigurationRequest Marshaller - - - - - Response Unmarshaller for GetBucketMetricsConfiguration operation - - - - - Get Bucket Notification Request Marshaller - - - - - Response Unmarshaller for GetBucketNotification operation - - - - - Get BucketName Policy Request Marshaller - - - - - Response Unmarshaller for GetBucketPolicy operation - - - - - GetBucketPolicyStatusRequestMarshaller - - - - - Response Unmarshaller for GetBucketPolicyStatus operation - - - - - Get Bucket Request Payment Request Marshaller - - - - - Response Unmarshaller for GetBucketRequestPayment operation - - - - - Get Bucket Tagging Request Marshaller - - - - - Response Unmarshaller for GetBucketTagging operation - - - - - Get Bucket Versioning Request Marshaller - - - - - Response Unmarshaller for GetBucketVersioning operation - - - - - Get Bucket Website Request Marshaller - - - - - Response Unmarshaller for GetBucketWebsite operation - - - - - Get Bucket Cors Request Marshaller - - - - - Response Unmarshaller for GetCORSConfiguration operation - - - - - Get Bucket Lifecycle Request Marshaller - - - - - Response Unmarshaller for GetLifecycleConfiguration operation - - - - - GetObjectLegalHold Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for GetObjectLegalHold operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - GetObjectLockConfiguration Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for GetObjectLockConfiguration operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - GetObjectMetadata Marshaller - - - - - Response Unmarshaller for GetObjectMetadata operation - - - - - Get Object Request Marshaller - - - - - Response Unmarshaller for GetObject operation - - - - - GetObjectRetention Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for GetObjectRetention operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - GetObjectTaggingRequest Marshaller - - - - - Marshall GetObjectTaggingRequest into an http request. - - - - - Marshall GetObjectTaggingRequest into an http request. - - - - - Response Unmarshaller for GetObjectTagging operation - - - - - Get Object Torrent Request Marshaller - - - - - Response Unmarshaller for GetObjectTorrent operation - - - - - GetPublicAccessBlockRequestMarshaller - - - - - Response Unmarshaller for GetPublicAccessBlock operation - - - - - Grantee Unmarshaller - - - - - Grant Unmarshaller - - - - - Head Bucket Request Marshaller - - - - - Response Unmarshaller for HeadBucket operation - - - - - Create Multipart Upload Request Marshaller - - - - - Response Unmarshaller for InitiateMultipartUpload operation - - - - - Initiator Unmarshaller - - - - - InventoryConfiguration Unmarshaller - - - - - InventoryDestination Unmarshaller - - - - - InventoryEncryption Unmarshaller - - - - - InventoryFilter Unmarshaller - - - - - InventoryS3BucketDestination Unmarshaller - - - - - InventorySchedule Unmarshaller - - - - - LifecycleFilterPredicate Unmarshaller - - - - - LifecycleRuleNoncurrentVersionExpiration Unmarshaller - - - - - LifecycleRuleNoncurrentVersionTransition Unmarshaller - - - - - List AnalyticsConfiguration Request Marshaller - - - - - Response Unmarshaller for ListAnalyticsConfiguration operation - - - - - List InventoryConfiguration Request Marshaller - - - - - Response Unmarshaller for ListInventoryConfiguration operation - - - - - List Bucket MetricsConfigurationRequest Marshaller - - - - - Response Unmarshaller for ListBucketMetricsConfiguration operation - - - - - List Buckets Request Marshaller - - - - - Response Unmarshaller for ListBuckets operation - - - - - List Multipart Uploads Request Marshaller - - - - - Response Unmarshaller for ListMultipartUploads operation - - - - - List Objects Request Marshaller - - - - - Response Unmarshaller for ListObjects operation - - - - - List Objects Request Marshaller - - - - - Response Unmarshaller for ListObjects operation - - - - - List Parts Request Marshaller - - - - - Response Unmarshaller for ListParts operation - - - - - List Object Versions Request Marshaller - - - - - Response Unmarshaller for ListVersions operation - - - - - LoggingEnabled Unmarshaller - - - - - MetricsConfiguration Unmarshaller - - - - - MetricsFilte Unmarshaller - - - - - UploadsItem Unmarshaller - - - - - Response Unmarshaller for ObjectLockConfiguration Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Response Unmarshaller for ObjectLockLegalHold Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Response Unmarshaller for ObjectLockRetention Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Response Unmarshaller for ObjectLockRule Object - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Owner Unmarshaller - - - - - PartsItem Unmarshaller - - - - - PolicyStatus Unmarshaller - - - - - PublicAccessBlockConfiguration Unmarshaller - - - - - Put Object Acl Request Marshaller - - - - - Response Unmarshaller for PutObjectAcl operation - - - - - Put Object Acl Request Marshaller - - - - - Response Unmarshaller for PutBucketAccelerate operation - - - - - Request Marshaller for PutAnalyticsConfiguration operation - - - - - Response Unmarshaller for PutBucketAnalytics operation - - - - - Request Marshaller for PutInventoryConfiguration operation - - - - - Response Unmarshaller for PutBucketWebsite operation - - - - - Enable Bucket Logging Request Marshaller - - - - - Response Unmarshaller for PutBucketLogging operation - - - - - Put Bucket MetricsConfigurationRequest Marshaller - - - - - Response Unmarshaller for PutBucketMetricsConfiguration operation - - - - - Put Bucket Notification Request Marshaller - - - - - Response Unmarshaller for PutBucketNotification operation - - - - - Put Bucket Policy Request Marshaller - - - - - Response Unmarshaller for PutBucketPolicy operation - - - - - Put Buckeyt Replication Request Marshaller - - - - - Response Unmarshaller for PutBucketReplication operation. - - - - - Put Bucket Request Marshaller - - - - - Put Bucket Request Payment Request Marshaller - - - - - Response Unmarshaller for PutBucketRequestPayment operation - - - - - Response Unmarshaller for PutBucket operation - - - - - Put Bucket Tagging Request Marshaller - - - - - Response Unmarshaller for PutBucketTagging operation - - - - - Put Bucket Versioning Request Marshaller - - - - - Response Unmarshaller for PutBucketVersioning operation - - - - - Put Bucket Website Request Marshaller - - - - - Response Unmarshaller for PutBucketWebsite operation - - - - - Put Bucket Cors Request Marshaller - - - - - Response Unmarshaller for PutCORSConfiguration operation - - - - - Put Bucket Lifecycle Request Marshaller - - - - - Response Unmarshaller for PutLifecycleConfiguration operation - - - - - PutObjectLegalHold Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for PutObjectLegalHold operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - PutObjectLockConfiguration Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for PutObjectLockConfiguration operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Put Object Request Marshaller - - - - - Response Unmarshaller for PutObject operation - - - - - PutObjectRetention Request Marshaller - - - - - Marshaller the request object to the HTTP request. - - - - - - - Marshaller the request object to the HTTP request. - - - - - - - Response Unmarshaller for PutObjectRetention operation - - - - - Unmarshaller the response from the service to the response class. - - - - - - - Gets the singleton. - - - - - Delete Object Tagging Request Marshaller - - - - - Marshall PutObjectTaggingRequest into an http request. - - - - - Marshall PutObjectTaggingRequest into an http request. - - - - - Response Unmarshaller for DeleteObjectTagging operation - - - - - PutPublicAccessBlock Request Marshaller - - - - - Response Unmarshaller for PutPublicAccessBlock operation - - - - - Restore Object Request Marshaller - - - - - Response Unmarshaller for RestoreObject operation - - - - - Condition Unmarshaller - - - - - Redirect Unmarshaller - - - - - RoutingRule Unmarshaller - - - - - RulesItem Unmarshaller - - - - - Response Unmarshaller for all Errors - - - - - Build an S3ErrorResponse from XML - - The XML parsing context. - Usually an Amazon.Runtime.Internal.UnmarshallerContext. - An S3ErrorResponse object. - - - - Grant Unmarshaller - - - - - Class for unmarshalling S3 service responses - - - - - Specialized S3 unmarshaller context. - - - - - Wrap an XmlTextReader with state for event-based parsing of an XML stream. - - Stream with the XML from a service response. - If set to true, maintains a copy of the complete response body as the stream is being read. - Response data coming back from the request - - - - Reads to the next node in the XML document, and updates the context accordingly. - If node is RequestId, reads the contents and stores in RequestId property. - - - True if a node was read, false if there are no more elements to read./ - - - - - SSEKMS Unmarshaller - - - - - StorageClassAnalysisDataExportDataExportUnmarshaller - - - - - StorageClassAnalysisUnmarshaller - - - - - Tag Unmarshaller - - - - - TopicConfiguration Unmarshaller - - - - - Transition Unmarshaller - - - - - Upload Part Request Marshaller - - - - - Response Unmarshaller for UploadPart operation - - - - - VersionsItem Unmarshaller - - - - - Internal implementation of Inventory Predicate visitor interface. - - - - - Internal implementation of Metrics Predicate visitor interface. - - - - - Class for AnalyticsPrefixPredicate - The prefix used when evaluating a metrics filter. - - - - - Class for AnalyticsS3BucketDestination - - - - - The file format used when exporting data to Amazon S3. - - - - - The account ID that owns the destination bucket. If no account ID is provided, the owner will not be validated prior to exporting data. - - - - - The Amazon resource name (ARN) of the bucket to which data is exported. - - - - - The prefix to use when exporting data. The exported data begins with this prefix. - - - - - Class for MetricsTagPredicate - The tag used when evaluating a metrics filter. - - - - - This class represents the byte range for a range GET from S3. - - - - - Constructs a ByteRange and sets the start and end. - - - - - - - Constructs a ByteRange and sets the header to the value specified. - - - - - - A private string, represending the byte range. - - - - - The starting byte number of the range - - - - - The ending byte number of the range - - - - - The formatted string representing the byte range to be set for the range header. - - - - - Container for the parameters to the CompleteMultipartUpload operation. - Completes a multipart upload by assembling previously uploaded parts. - - - - - The name of the bucketName containing the S3 object that was being uploaded in parts. - - - - - The key of the S3 object that was being uploaded. - - - - - A collection of part numbers and corresponding etags. - - - - - Adds a collection of part numbers and corresponding etags. - - PartETags that will added to this request. - - - - Adds a collection of part numbers and corresponding etags. - - PartETags that will added to this request. - - - - Adds a collection of part numbers and corresponding etags by transforming the UploadPartResponses into PartETags. - - The list of response objects return from UploadParts. - - - - Adds a collection of part numbers and corresponding etags by transforming the UploadPartResponses into PartETags. - - The list of response objects return from UploadParts. - - - - Adds a collection of part numbers and corresponding etags by transforming the CopyPartResponse into PartETags. - - The list of response objects return from CopyParts. - - - - Adds a collection of part numbers and corresponding etags by transforming the CopyPartResponse into PartETags. - - The list of response objects return from CopyParts. - - - - The upload id for the in-progress multipart upload that should be completed. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the CompleteMultipartUpload response and response metadata. - - - - - Gets and sets the URI that identifies the newly created object. - - - - - Gets and sets the name of the bucketName that contains the newly created object. - - - - - Gets and sets the object key of the newly created object. - - - - - Gets and sets Entity tag that identifies the newly created object's data. Objects with different - object data will have different entity tags. The entity tag is an opaque string. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - Gets and sets the ServerSideEncryptionMethod property. - Specifies the encryption used on the server to - store the content. - Default is None. - - - - - Gets and sets the VersionId property. - This is the version-id of the S3 object - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the CopyObject operation. - Creates a copy of an object that is already stored in Amazon S3. - - - - - The name of the bucket containing the object to copy. - - - - - Checks if SourceBucket property is set. - - true if SourceBucket property is set. - - - - The key of the object to copy. - - - - - Checks if SourceKey property is set. - - true if SourceKey property is set. - - - - Specifies a particular version of the source object to copy. By default the latest version is copied. - - - - - Checks if SourceVersionId property is set. - - true if SourceVersionId property is set. - - - - The name of the bucket to contain the copy of the source object. - - - - - Checks if DestinationBucket property is set. - - true if DestinationBucket property is set. - - - - The key to be given to the copy of the source object. - - - - - Checks if DestinationKey property is set. - - true if DestinationKey property is set. - - - - A canned access control list (CACL) to apply to the object. - Please refer to for - information on S3 Canned ACLs. - - - - - ETag to be matched as a pre-condition for copying the source object - otherwise returns a PreconditionFailed. - - - Copies the object if its entity tag (ETag) matches - the specified tag; otherwise return a 412 (precondition failed). - Constraints: This property can be used with IfUnmodifiedSince, - but cannot be used with other conditional copy properties. - - - - - Checks if ETagToMatch property is set. - - - Copies the object if its entity tag (ETag) is different - than the specified Etag; otherwise returns a 412 (failed condition). - Constraints: This header can be used with IfModifiedSince, but cannot - be used with other conditional copy properties. - - true if ETagToMatch property is set. - - - - ETag that must not be matched as a pre-condition for copying the source object, - otherwise returns a PreconditionFailed. - - - - - Checks if ETagToNotMatch property is set. - - true if ETagToNotMatch property is set. - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or - ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Copies the object if it has been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it has been modified since the - specified time; otherwise returns a 412 (failed condition). - Constraints: This property can be used with ETagToNotMatch, - but cannot be used with other conditional copy properties. - - - - - Copies the object if it has been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it has been modified since the - specified time; otherwise returns a 412 (failed condition). - Constraints: This property can be used with ETagToNotMatch, - but cannot be used with other conditional copy properties. - - - - - Checks if ModifiedSinceDateUtc property is set. - - true if ModifiedSinceDateUtc property is set. - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or - UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Copies the object if it has not been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it hasn't been modified since the - specified time; otherwise returns a 412 (precondition failed). - Constraints: This property can be used with ETagToMatch, - but cannot be used with other conditional copy properties. - - - - - Copies the object if it has not been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it hasn't been modified since the - specified time; otherwise returns a 412 (precondition failed). - Constraints: This property can be used with ETagToMatch, - but cannot be used with other conditional copy properties. - - - - - Checks if UnmodifiedSinceDateUtc property is set. - - true if UnmodifiedSinceDateUtc property is set. - - - - Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request. - - - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - Specifies whether you want to apply a Legal Hold to the copied object. - - - - - - Gets and sets the property ObjectLockMode. - - The Object Lock mode that you want to apply to the copied object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - The date and time when you want the copied object's Object Lock to expire. - - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - Checks if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - true if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - - - The type of storage to use for the object. Defaults to 'STANDARD'. - - - - - - If the bucketName is configured as a website, redirects requests for this object to another object in the same bucketName or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - This is a convenience property for Headers.ContentType. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - /// - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The customer provided encryption key for the source object of the copy. - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - true if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the CopySourceServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if CopySourceServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - The tag-set for the object destination object this value must be used in conjunction with the TaggingDirective. The tag-set must be encoded as URL Query parameters. - - - - - Checks if Tagging property is set - - true if Tagging is set. - - - - Returns information about the CopyObject response and response metadata. - - - - - Gets and sets the ETag property. - - - - - Gets and sets the LastModified property. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - Gets and sets the SourceVersionId property. - This is the Version Id of the Source Object - - - - - Version ID of the newly created copy. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the CopyPart operation. - Uploads a part by copying data from an existing object as data source. - - - - - The name of the bucket containing the object to copy. - - - - - Checks if SourceBucket property is set. - - true if SourceBucket property is set. - - - - The key of the object to copy. - - - - - Checks if SourceKey property is set. - - true if SourceKey property is set. - - - - Specifies a particular version of the source object to copy. By default the latest version is copied. - - - - - Checks if SourceVersionId property is set. - - true if SourceVersionId property is set. - - - - The name of the bucket to contain the copy of the source object. - - - - - Checks if DestinationBucket property is set. - - true if DestinationBucket property is set. - - - - The key to be given to the copy of the source object. - - - - - Checks if DestinationKey property is set. - - true if DestinationKey property is set. - - - - The ID identifying multipart upload for which we are copying a part. - - - - - Checks if UploadId property is set. - - true if UploadId property is set. - - - - Collection of ETags to be matched as a pre-condition for copying the source object - otherwise returns a PreconditionFailed. - - - Copies the object if its entity tag (ETag) matches one of - the specified tags; otherwise return a 412 (precondition failed). - Constraints: This property can be used with IfUnmodifiedSince, - but cannot be used with other conditional copy properties. - - - - - Checks if ETagsToMatch property is set. - - true if ETagToMatch property is set. - - - - Collection of ETags that must not be matched as a pre-condition for copying the source object - otherwise returns a PreconditionFailed. - - - Copies the object if its entity tag (ETag) does not match any of the specified - tags; otherwise returns a 412 (failed condition). - Constraints: This header can be used with IfModifiedSince, but cannot - be used with other conditional copy properties. - - - - - Checks if ETagToNotMatch property is set. - - true if ETagToNotMatch property is set. - - - - Copies the object if it has been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it has been modified since the - specified time; otherwise returns a 412 (failed condition). - Constraints: This property can be used with ETagToNotMatch, - but cannot be used with other conditional copy properties. - - - - - Checks if ModifiedSinceDate property is set. - - true if ModifiedSinceDate property is set. - - - - Copies the object if it has not been modified since the specified time, otherwise returns a PreconditionFailed. - - - Copies the object if it hasn't been modified since the - specified time; otherwise returns a 412 (precondition failed). - Constraints: This property can be used with ETagToMatch, - but cannot be used with other conditional copy properties. - - - - - Checks if UnmodifiedSinceDate property is set. - - true if UnmodifiedSinceDate property is set. - - - - The number of the part to be copied. - - - Valid part numbers are from 1 to 10,000 inclusive and will uniquely identify the part - and determine the relative ordering within the destination object. If a part already - exists with the PartNumber it will be overwritten. - - - - - Checks if PartNumber property is set. - - true if PartNumber property is set. - - - - The location of the first byte in the range if only a portion of the - source object is to be copied as the part. - - - The LastByte property must also be set or this value will be ignored. - - - - - Checks if FirstByte property is set. - - true if FirstByte property is set. - - - - The location of the last byte in the range if only a portion of the - source object is to be copied as the part. - - - The FirstByte property must also be set or this value will be ignored. - - - - - Checks if LastByte property is set. - - true if LastByte property is set. - - - - - This property is obsolete. Use ServerSideEncryptionMethod in InitiateMultipartUploadRequest instead. - - - Default: None - - - - - - Checks if ServerSideEncryptionMethod property is set. - - true if ServerSideEncryptionMethod property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - This property is obsolete. Use ServerSideEncryptionKeyManagementServiceKeyId in InitiateMultipartUploadRequest instead. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The customer provided encryption key for the source object of the copy. - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - true if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the CopySourceServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if CopySourceServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if CopySourceServerSideEncryptionCustomerProvidedKey property is set. - - - - Returns information about the CopyPart response and response metadata. - - - - - The version of the source object that was copied, if you have enabled versioning on the source bucketName. - - - - - - Entity tag of the object. - - - - - - Date and time at which the object was uploaded. - - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - Gets and sets the PartNumber property. - This is the part number in it's multi-part upload that will uniquely identify the part - and determine the relative ordering within the destination object. - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - A collection of up to 100 cross-origin resource sharing (CORS) rules. - - - - - The collection of rules in this configuration. - - - - C O R S Rule - - - - - Identifies HTTP methods that the domain/origin specified in the rule is allowed to execute. - - - - - - One or more origins you want customers to be able to access the bucket from. - - - - - - An optional unique identifier for the rule. - - - The ID value can be up to 255 characters long. The IDs help you find a rule in the configuration. - - - - - Checks if Id property is set. - - true if Id property is set. - - - - One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript - XMLHttpRequest object). - - - - - - The time in seconds that your browser is to cache the preflight response for the specified resource. - - - - - - Specifies which headers are allowed in a pre-flight OPTIONS request through the - Access-Control-Request-Headers header. - - - Each header name specified in the Access-Control-Request-Headers must have a corresponding - entry in the rule. Only the headers that were requested will be sent back. - This element can contain at most one * wildcard character. - - - - - Checks if AllowedHeaders property is set. - - true if AllowedHeaders property is set. - - - - Describes how a CSV-formatted input object is formatted. - - - - - Describes the first line of input. Valid values: None, Ignore, Use. - - - - - Single character used to indicate a row should be ignored when present at the start of a row. - - - - - Single character used for escaping the quote character inside an already escaped value. - - - - - Value used to separate individual records. - - - - - Value used to separate individual fields in a record. - - - - - Value used for escaping where the field delimiter is part of the value. - - - - - Specifies that CSV field values may contain quoted record delimiters and such records should be allowed. Default value is FALSE. Setting this value to TRUE may lower performance. - - - - - Describes how CSV-formatted results are formatted. - - - - - Indicates whether or not all output fields should be quoted. - - - - - Single character used for escaping the quote character inside an already escaped value. - - - - - Value used to separate individual records. - - - - - Value used to separate individual fields in a record. - - - - - Value used for escaping where the field delimiter is part of the value. - - - - - The container element for specifying the default Object Lock retention settings for - new objects placed in the specified bucket. - - - - - Gets and sets the property Days. - - The number of days that you want to specify for the default retention period. - - - - - - Gets and sets the property Mode. - - The default Object Lock retention mode you want to apply to new objects placed in - the specified bucket. - - - - - - Gets and sets the property Years. - - The number of years that you want to specify for the default retention period. - - - - - - Container for the parameters to the DeleteBucketAnalyticsConfiguration operation. - Deletes an analytics configuration for the bucket (specified by the analytics configuration ID). - - - - - The name of the bucket from which an analytics configuration is deleted. - - - - - The identifier used to represent an analytics configuration. - - - - - Returns information about the DeleteBucketAnalyticsConfiguration response metadata. - The DeleteBucketAnalyticsConfiguration operation has a void result type. - - - - - Request object for the DeleteBucketEncryption operation. - Request Deletes the server-side encryption configuration from the bucket. - - - - - The name of the bucket containing the server-side encryption configuration to delete. - - - - - Returns information about the DeleteBucketEncryption response metadata. - The DeleteBucketEncryption operation has a void result type. - - - - - Container for the parameters to the DeleteInventoryConfiguration operation. - Deletes an inventory configuration (identified by the inventory ID) from the bucket. - - - - - The name of the bucket containing the inventory configuration to delete. - - - - - The ID used to identify the inventory configuration. - - - - - Returns information about the DeleteInventoryConfiguration response metadata. - The DeleteInventoryConfiguration operation has a void result type. - - - - - Container for the parameters to the DeleteBucketMetricsConfiguration operation. - Deletes a metrics configuration (specified by the metrics configuration ID) from the bucket. - - - - - The name of the bucket on which Inventory configuration is to be removed. - - - - - The ID used to identify the metrics configuration. - - - - - Returns information about the DeleteBucketMetricsConfiguration response metadata. - The DeleteBucketMetricsConfiguration operation has a void result type. - - - - - Container for the parameters to the DeleteBucketPolicy operation. - Deletes the policy from the bucket. - - - - - The bucket on which the policy is to be deleted. - - - - - Returns information about the DeleteBucketPolicy response metadata. - The DeleteBucketPolicy operation has a void result type. - - - - - Request object for the DeleteBucketReplication operation. - - - - - Gets and sets the property BucketName. -

Deletes the replication subresource associated with the specified - bucket.

There is usually some time lag before - replication configuration deletion is fully propagated to all the - Amazon S3 systems.

For more information, see - - Cross-Region Replication (CRR) in the Amazon S3 Developer - Guide.

- - - - - Returns information about the DeleteBucketReplication response metadata. - The DeleteBucketReplication operation has a void result type. - - - - - Container for the parameters to the DeleteBucket operation. - Deletes the bucket. All objects (including all object versions and Delete Markers) in the bucket must be deleted before the bucket - itself can be deleted. - - - - - The name of the bucket to be created. - - - - - The region locality for the bucket. - - - When set, this will determine the region the bucket exists in. - Refer - for a list of possible values. - - - - - If set to true the bucket will be deleted in the same region as the configuration of the AmazonS3 client. - DeleteBucketRequest.BucketRegion takes precedence over this property if both are set. - Default: true. - - - - - Returns information about the DeleteBucket response metadata. - The DeleteBucket operation has a void result type. - - - - - The parameters to request deletion of a tag set from a bucket. - - - To use this operation, you must have permission to perform the s3:PutBucketTagging action. - By default, the bucket owner has this permission and can grant this permission to others. - - - - - The name of the bucket on which the tag set is to be removed. - - - - - Returns information about the DeleteBucketTagging response metadata. - The DeleteBucketTagging operation has a void result type. - - - - - Container for the parameters to the DeleteBucketWebsite operation. - This operation removes the website configuration from the bucket. - - - - - The name of the bucket on which website configuration is to be removed. - - - - - Returns information about the DeleteBucketWebsite response metadata. - The DeleteBucketWebsite operation has a void result type. - - - - - Container for the parameters to the DeleteCORSConfiguration operation. - Deletes the cors configuration information set for the bucket. - - - - - Gets and sets the BucketName property. - - - - - Returns information about the DeleteCORSConfiguration response metadata. - The DeleteCORSConfiguration operation has a void result type. - - - - - Contains information about a successful delete operation against a specific S3 object. - - - - - Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a - delete marker. In a simple DELETE, this header indicates whether (true) or not (false) a delete - marker was created. - - - - - The version ID of the delete marker created as a result of the DELETE operation. If you delete a - specific object version, the value returned by this header is the version ID of the object version - deleted. - - - - - The key of the deleted S3 object. - - - - - The version of the deleted S3 object. - - - - - Contains information about a failed delete operation against a specific S3 object. - - - - - The key of the S3 object. - - - - - The version of the S3 object. - - - - - The failure code for the delete error. - - - - - The failure message for the delete error. - - - - - The parameters to request deletion of the lifecycle configuration on a bucket. - - - - Amazon S3 removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. - Your objects never expire, and Amazon S3 no longer automatically deletes any objects on the basis of rules contained - in the deleted lifecycle configuration. - - - To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration action. By default, the - bucket owner has this permission and the bucket owner can grant this permission to others. - - - There is usually some time lag before lifecycle configuration deletion is fully propagated to all the Amazon S3 systems. - - - - - - The name of the bucket on which the lifecycle configuration is to be deleted. - - - - - Returns information about the DeleteLifecycleConfiguration response metadata. - The DeleteLifecycleConfiguration operation has a void result type. - - - - -

Specifies whether Amazon S3 should replicate delete makers.

- - - - - Gets and sets the property Status. -

The status of the delete marker replication.

-

In the current implementation, Amazon S3 does not replicate - the delete markers. Therefore, the status must be - Disabled.

- - - - - The parameters to request deletion of an object in a bucket. - The operation removes the null version (if there is one) of an object and inserts a delete marker, which - becomes the latest version of the object. - - - - To remove a specific version, you must be the bucket owner and you must use the versionId subresource. - Using this subresource permanently deletes the version. - - - If the object you want to delete is in a bucket where the bucket versioning configuration is MFA Delete enabled, - you must include specify the MFA serial number and value in the request. - - - If there isn't a null version, Amazon S3 does not remove any objects. - - - - - - The bucket name of the bucket containing the object. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property BypassGovernanceRetention. - - - - - The key identifying the object to delete. - - - - - The identifier for the specific version of the object to be deleted, if required. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - The MfaCodes Tuple associates the Serial Number and the current Token/Code displayed on the - Multi-Factor Authentication device associated with your AWS Account. - - - This is a required property for this request if:
- 1. EnableMfaDelete was configured on the bucket - containing this object's version.
- 2. You are deleting an object's version - - - - - Checks if the MfaCodes property is set. - - true if the MfaCodes property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the DeleteObject response and response metadata. - - - - - Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a delete marker. - - - - - - Returns the version ID of the delete marker created as a result of the DELETE operation. - - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the DeleteObjects operation. - This operation enables you to delete multiple objects from a bucket using a single HTTP request. You may specify up to 1000 - keys. - - - Container for the parameters to the DeleteObjects operation. - This operation enables you to delete multiple objects from a bucket using a single HTTP request. You may specify up to 1000 - keys. - - - - - The bucket name containing the objects to delete. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property BypassGovernanceRetention. - - Specifies whether you want to delete this object even if it has a Governance-type - Object Lock in place. You must have sufficient permissions to perform this operation. - - - - - - List of object keys to delete. - - - - - Toggles between Quiet and Verbose mode for the operation. - If set to true (Quiet mode), the response includes only those keys for objects on which - the delete operation failed. - - - By default this property is false and keys for both successful deletes - and failures are returned in the response. - - - - - The MfaCodes Tuple associates the Serial Number and the current Token/Code displayed on the - Multi-Factor Authentication device associated with your AWS Account. - - - This is a required property for this request if:
- 1. EnableMfaDelete was configured on the bucket - containing this object's version.
- 2. You are deleting an object's version - - - - - Checks if the MfaCodes property is set. - - true if the MfaCodes property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Add a key to the set of keys of objects to be deleted. - - Object key - - - - Add a key and a version to be deleted. - - Key of the object to be deleted. - Version of the object to be deleted. - - - - Add a KeyVersion object representing the S3 object to be deleted. - - KeyVersion representation of object to be deleted. - - - - Returns information about the DeleteObjects response and response metadata. - - - - - A default constructor for DeleteObjectsResponse - - - - - Gets and sets the DeletedObjects property. - A list of successful deletes. - Set only when Quiet=false on DeleteObjectsRequest. - - - - - Gets and sets the DeleteErrors property. - A list of errors encountered while deleting objects. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the DeleteObjectTaggingRequest operation. - - - - - The bucket name containing the objects from which to remove the tags. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Check to see if Bucket property is set - - - - - The key identifying the object tagging to delete. - - - - - Check to see if Key property is set - - - - - The identifier for the specific version of the object to be deleted, if required. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - Returns information about the DeleteObjectTagging response and response metadata. - - - - - Returns the version ID of the delete marker created as a result of the DELETE operation. - - - - - Check to see if VersionId property is set - - - - - Container for the parameters to the DeletePublicAccessBlock operation. - Removes the Public Access Block configuration for an Amazon S3 bucket. - - - - - Gets and sets the property BucketName. - - The Amazon S3 bucket whose Public Access Block configuration you want to delete. - - - - - - This is the response object from the DeletePublicAccessBlock operation. - - - - - EncryptionConfiguration class - - - - - The ID of the AWS KMS key for the region where the destination bucket - resides. Amazon S3 uses this key to encrypt the replica object. - - - - - The Continuation Event. - - - - - Constructs a Continuation Event. - - - - - Constructs a Continuation Event. - - - - - - The End Event. - - - - - Constructs an End Event. - - - - - Constructs an End Event. - - - - - - Common Contract for S3 Events. - - - - - The Progress event details. - - - - - Current number of object bytes scanned. - - - - - Current number of uncompressed object bytes processed. - - - - - Total number of bytes of records payload data returned. - - - - - Constructs a instance of Progress. - - - - - The Progress Event. - - - - - The Progress event details. - - - - - Constructs a ProgressEvent. - - - - - Constructs a ProgressEvent. - - - - - - The Records Event - - - - - The byte array of partial, one or more result records. - - Payload is a , which is not thread-safe. - - - - - Constructs a RecordsEvent - - - - - Creates a new End Event. - - - - - - Modeled Exception that either comes over the stream from the service model, or wraps other exceptions for the purpose of raising events. If it is - modelled, it will be a subclass. - - - - - Creates a new S3EventStreamException - - - - - Creates a new S3EventStreamException - - - - - - Creates a new S3EventStreamException - - - - - - - The contract for the SelectObjectContentEventStream. - - - - - Event that encompasses all IS3Events. - - - - - Event that encompasses S3EventStreamExceptions. - - - - - Reaised when a Records event is received. - - - - - Reaised when a Stats event is received. - - - - - Reaised when a Progress event is received. - - - - - Reaised when a Continuation event is received. - - - - - Reaised when an End event is received. - - - - - A Stream of Events returned by the SelectObjectContent operation. Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treaded as mutually exclusive. - - - - - The mapping of event message to a generator function to construct the matching Event Stream event. - - - - - The mapping of event message to a generator function to construct the matching Event Stream exception. - - - - - Whether the backround processing loop is running. - - - - - Event that encompasses all IS3Events. - - - - - Event that encompasses S3EventStreamExceptions. - - - - - Reaised when a Records event is received. - - - - - Reaised when a Stats event is received. - - - - - Reaised when a Progress event is received. - - - - - Reaised when a Continuation event is received. - - - - - Reaised when an End event is received. - - - - - Event Stream returned by SelectObjectContentStream. - - Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treated as mutually exclusive. - - The network stream which events will be parsed from. - - - - Event Stream returned by SelectObjectContentStream. - - Events can be retrieved from this stream by either - - attaching handlers to listen events, and then call StartProcessing or - enumerating over the events. - - - These options should be treaded as mutually exclusive. - - The network stream which events will be parsed from. - The decoder responsible for parsing events. - - - - The Stats event details. - - - - - Total number of object bytes scanned. - - - - - Total number of uncompressed object bytes processed. - - - - - Total number of bytes of records payload data returned. - - - - - Constructs an instance of Stats. - - - - - The Stats Event. - - - - - The Stats event details. - - - - - Constructs a StatsEvent - - - - - Constructs a ProgressEvent. - - - - - - This Event is returned if an event is retrieved from the event stream, but a generator function - for the event is not defined. - - - - - Constructs an UnknownEventStreamEvent. - - - - - Constructs an UnknownEventStreamEvent. - - The Message recieved from the event stream before conversion. - - - - Constructs an UnknownEventStreamEvent. - - The Message recieved from the event stream before conversion. - The event type. - - - - A container that specifies information about existing object replication. You can choose whether to enable or disable the replication of existing objects. - - - - - Specifies whether existing object replication is enabled. - - - - - Defines the expiration policy for a given object. - - - - - This property is deprecated. This property exposes a DateTime of kind Unspecified. Use ExpiryDateUtc instead. - The date and time for expiry. - - - - - The date and time for expiry. - - - - - Id of the configuration rule for this expiry. - - - - - Constructs an empty instance of an Expiration object - - - - Bucket - Represents a set of filter criteria that limits the objects that can trigger event notifications - - - - - Filter criteria that limits the objects that can trigger event notifications based on their S3 Key name. - - - - - Bucket - Represents a Filter Rule for a NotificationConfiguration. - - - - - Constructs an empty FilterRule. - - - - - Constructs a FilterRule with a specific name and value. - - - - - - - The name of the filter rule. - - - - - The value of the filter rule. - - - - - Container for the parameters to the GetACL operation. - Returns the access control list (ACL) of an object. - - - - - The bucket name that contains the object for which to get the ACL information. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The key of the S3 object to be queried. - - - - - VersionId used to reference a specific version of the object. - - - - - Returns information about the GetACL response and response metadata. - - - - - Gets and sets the AccessControlList property. - - - - - Container for the parameters to the GetBucketAccelerateConfiguration operation. - - - - - The name of the bucket. - - - - - The response class for GetBucketAccelerateConfiguration operation. - - - - - The accelerate status of the bucket. - - - - - Container for the parameters to the GetBucketAnalyticsConfiguration operation. - Gets an analytics configuration for the bucket (specified by the analytics configuration ID). - - - - - The name of the bucket from which an analytics configuration is retrieved. - - - - - The identifier used to represent an analytics configuration. - - - - - GetBucketAnalyticsConfigurationResponse Response - - - - - The configuration and any analyses for the analytics filter. - - - - - Container for the parameters to the GetBucketEncryptionRequest operation. - Returns the server-side encryption configuration of a bucket. - - - - - The name of the bucket. - - - - - GetBucketEncryptionResponse Response - - - - - Container for server-side encryption configuration rules. Currently S3 supports one rule only. - - - - - Container for the parameters to the GetInventoryConfigurationRequest operation. - Returns an inventory configuration (identified by the inventory ID) from the bucket. - - - - - The name of the bucket containing the inventory configuration to retrieve. - - - - - The ID used to identify the inventory configuration. - - - - - GetInventoryConfigurationResponse Response - - - - - Specifies the inventory configuration. - - - - - Container for the parameters to the GetBucketLocation operation. - Returns the region the bucket resides in. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetBucketLocation response and response metadata. - - - - - Gets and sets the Location property. - If the the bucket is located in us-east-1 S3Region.US will be return which has a - value of empty string. - - - - - Container for the parameters to the GetBucketLogging operation. - Returns the logging status of a bucket and the permissions users have to view and modify that status. To use GET, you must be the - bucket owner. - - - - - The name of the bucket to query. - - - - - Returns information about the GetBucketLogging response and response metadata. - - - - - Gets and sets the LoggingConfig property. - - - - - Container for the parameters to the GetBucketMetricsConfiguration operation. - Gets a metrics configuration (specified by the metrics configuration ID) from the bucket. - - - - - The name of the bucket containing the metrics configuration to retrieve. - - - - - The ID used to identify the metrics configuration. - - - - - GetBucketMetricsConfiguration Response - - - - - Specifies the metrics configuration. - - - - - Container for the parameters to the GetBucketNotification operation. - Return the notification configuration of a bucket. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetBucketNotification response and response metadata. - - - - - Gets and sets the TopicConfigurations property. TopicConfigurations are configuration - for Amazon S3 events to be sent to Amazon SNS topics. - - - - - Gets and sets the QueueConfigurations property. QueueConfigurations are configuration - for Amazon S3 events to be sent to Amazon SQS queues. - - - - - Gets and sets the LambdaFunctionConfigurations property. LambdaFunctionConfigurations are configuration - for Amazon S3 events to be sent to an Amazon Lambda cloud function. - - - - - Container for the parameters to the GetBucketPolicy operation. - Returns the policy of a specified bucket. - - - - - The name of the bucket. - - - - - Get BucketName Policy Response - - - - - The bucket policy as a JSON document. - - - - - Container for the parameters to the GetBucketPolicyStatus operation. - Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket - is public. - - - - - Gets and sets the property BucketName. - - The name of the Amazon S3 bucket whose public-policy status you want to retrieve. - - - - - - This is the response object from the GetBucketPolicyStatus operation. - - - - - The public-policy status for this bucket. - - - - - Container for the parameters to the GetBucketReplicationConfiguration operation. - Returns the replication configuration information set on the bucket. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetReplicationConfiguration response and response metadata. - - - - - The replication configuration for the buccket specified in the request. - - - - - Container for the parameters to the GetBucketRequestPayment operation. - Returns the request payment configuration of a bucket. - - - - - The name of the bucket. - - - - - Returns information about the GetBucketRequestPayment response and response metadata. - - - - - Specifies who pays for the download and request fees. - - - - - - Container for the parameters to the GetBucketTagging operation. - Returns the tag set associated with the bucket. - - - - - The name of the bucket to be queried. - - - - - Returns information about the GetBucketTagging response and response metadata. - - - - - The collection of tags. - - - - - Container for the parameters to the GetBucketVersioning operation. - Returns the versioning state of a bucket. - - - - - The name of the bucket to be queried. - - - - - Returns information about the GetBucketVersioning response and response metadata. - - - - - Gets and sets the Versioning property. - Unless Versioning has been explicitly "Enabled" on a bucket, - Versioning Status is "Off". Once Versioning has been - "Enabled", it can be "Suspended" but cannot be switched "Off". - - - - - Container for the parameters to the GetBucketWebsite operation. - Returns the website configuration for a bucket. - - - - - The name of the bucket to be queried. - - - - - Returns information about the GetBucketWebsite response and response metadata. - - - - - Gets and sets the WebsiteConfiguration property. - - This is where the index document suffix and custom error page are defined. - - - - - Container for the parameters to the GetBucketCors operation. - Returns the cors configuration for the bucket. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetBucketCors response and response metadata. - - - - - The current CORSConfiguration for the bucket. - - - - - Container for the parameters to the GetLifecycleConfiguration operation. - Returns the lifecycle configuration information set on the bucket. - - - - - Gets and sets the BucketName. - - - - - Returns information about the GetLifecycleConfiguration response and response metadata. - - - - - Gets and Sets the property that governs whether - the response includes successful deletes as well as errors - following the DeleteObjects call against S3. - - By default this property is false and successful deletes - are returned in the response. - - - - - Container for the parameters to the GetObjectLegalHold operation. - Gets an object's current Legal Hold status. - - - - - The bucket name containing the object whose Legal Hold status you want to retrieve. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property Key. - - The key name for the object whose Legal Hold status you want to retrieve. - - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property VersionId. - - The version ID of the object whose Legal Hold status you want to retrieve. - - - - - - This is the response object from the GetObjectLegalHold operation. - - - - - Gets and sets the property LegalHold. - - The current Legal Hold status for the specified object. - - - - - - Container for the parameters to the GetObjectLockConfiguration operation. - Gets the Object Lock configuration for a bucket. The rule specified in the Object - Lock configuration will be applied by default to every new object placed in the specified - bucket. - - - - - Gets and sets the property BucketName. - - The bucket whose Object Lock configuration you want to retrieve. - - - - - - This is the response object from the GetObjectLockConfiguration operation. - - - - - Gets and sets the property ObjectLockConfiguration. - - The specified bucket's Object Lock configuration. - - - - - - Container for the parameters to the HeadObject operation. - The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you''re only - interested in an object''s metadata. To use HEAD, you must have READ access to the object. - - - - - The name of the bucket that contains the object. - - - - - ETag to be matched as a pre-condition for returning the object, - otherwise a PreconditionFailed signal is returned. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or - ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Returns the object only if it has been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Returns the object only if it has been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - ETag that should not be matched as a pre-condition for returning the object, - otherwise a PreconditionFailed signal is returned. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or - UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Returns the object only if it has not been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Returns the object only if it has not been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - The key of the object. - - - - - VersionId used to reference a specific version of the object. - - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to decrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - Part number of the object being read. This is a positive integer between 1 and 10,000. - Effectively performs a 'ranged' HEAD request for the part specified. - Useful querying about the size of the part and the number of parts in this object. - - - - - Check if PartNumber property is set. - - true if PartNumber property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the HeadObject response and response metadata. - - - - - Flag which returns true if the Expires property has been unmarshalled - from the raw value or set by user code. - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the - response. - - - - - - Gets and sets the AcceptRanges. - - - - - Gets and sets the ContentRange. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - Gets and sets the RestoreExpiration property. - RestoreExpiration will be set for objects that have been restored from Amazon Glacier. - It indiciates for those objects how long the restored object will exist. - - - - - Gets and sets the RestoreInProgress - Will be true when the object is in the process of being restored from Amazon Glacier. - - - - - Last modified date of the object - - - - - - An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL - - - - - - This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like - SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal - HTTP headers. - - - - - - Version of the object. - - - - - - The date and time at which the object is no longer cacheable. - - - - - - If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The status of the replication job associated with this source object. - - - - - Checks if ReplicationStatus property is set. - - true if ReplicationStatus property is set. - - - - The count of parts this object has. - - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - The Legal Hold status for the specified object. - - - - - - Gets and sets the property ObjectLockMode. - - The Object Lock mode currently in place for this object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - The date and time when this object's Object Lock will expire. - - - - - - The class of storage used to store the object. - - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the GetObject operation. - Retrieves objects from Amazon S3. - - - - - The bucket name containing the object. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - ETag to be matched as a pre-condition for returning the object, - otherwise a PreconditionFailed signal is returned. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or - ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Returns the object only if it has been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Returns the object only if it has been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - ETag that should not be matched as a pre-condition for returning the object, - otherwise a PreconditionFailed signal is returned. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or - UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Returns the object only if it has not been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Returns the object only if it has not been modified since the specified time, - otherwise returns a PreconditionFailed. - - - - - Gets and sets the Key property. This is the user defined key that identifies the object in the bucket. - - - - - Downloads the specified range bytes of an object. - - - - - A set of response headers that should be returned with the object. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ResponseExpiresUtc instead. Setting either ResponseExpires or - ResponseExpiresUtc results in both ResponseExpires and ResponseExpiresUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ResponseExpires is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Sets the Expires header of the response. - - - - - Sets the Expires header of the response. - - - - - VersionId used to reference a specific version of the object. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to decrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - Part number of the object being read. This is a positive integer between 1 and 10,000. - Effectively performs a 'ranged' GET request for the part specified. Useful for downloading just a part of an object. - - - - - Checks if PartNumber property is set. - - true if PartNumber property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the GetObject response and response metadata. - - - - - Flag which returns true if the Expires property has been unmarshalled - from the raw value or set by user code. - - - - - Gets and sets the BucketName property. - - - - - Gets and sets the Key property. - - - - - Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the - response. - - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - Gets and sets the AcceptRanges. - - - - - Gets and sets the ContentRange. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - Gets and sets the RestoreExpiration property. - RestoreExpiration will be set for objects that have been restored from Amazon Glacier. - It indiciates for those objects how long the restored object will exist. - - - - - Gets and sets the RestoreInProgress - Will be true when the object is in the process of being restored from Amazon Glacier. - - - - - Last modified date of the object - - - - - - An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL - - - - - - This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like - SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal - HTTP headers. - - - - - - Version of the object. - - - - - - The date and time at which the object is no longer cacheable. - - - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - - - - Gets and sets the property ObjectLockMode. - - The Object Lock mode currently in place for this object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - The date and time when this object's Object Lock will expire. - - - - - - If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The class of storage used to store the object. - - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The status of the replication job associated with this source object. - - - - - Checks if ReplicationStatus property is set. - - true if ReplicationStatus property is set. - - - - The number of parts this oject has. - - - - - Checks if PartsCount is set. - - true if PartsCount property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - The number of tags, if any, on the object. - - - - - The event for Write Object progress notifications. All - subscribers will be notified when a new progress - event is raised. - - - Subscribe to this event if you want to receive - put object progress notifications. Here is how:
- 1. Define a method with a signature similar to this one: - - private void displayProgress(object sender, WriteObjectProgressArgs args) - { - Console.WriteLine(args); - } - - 2. Add this method to the Put Object Progress Event delegate's invocation list - - GetObjectResponse response = s3Client.GetObject(request); - response.WriteObjectProgressEvent += displayProgress; - - - - - - This method is called by a producer of write object progress - notifications. When called, all the subscribers in the - invocation list will be called sequentially. - - The file being written. - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - True if transfer is complete - - - - Writes the content of the ResponseStream a file indicated by the filePath argument. - - The location where to write the ResponseStream - Whether or not to append to the file if it exists - Cancellation token which can be used to cancel this operation. - - - - Encapsulates the information needed to provide - download progress for the Write Object Event. - - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The bucket name for the S3 object being written. - The object key for the S3 object being written. - The version-id of the S3 object. - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - True if finished writing - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The bucket name for the S3 object being written. - The object key for the S3 object being written. - The file for the S3 object being written. - The version-id of the S3 object. - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - True if finished writing - - - - Gets the bucket name for the S3 object being written. - - - - - Gets the object key for the S3 object being written. - - - - - Gets the version-id of the S3 object. - - - - - The file for the S3 object being written. - - - - - True if writing is complete - - - - - Container for the parameters to the GetObjectRetention operation. - Retrieves an object's retention settings. - - - - - The bucket name containing the object whose retention settings you want to retrieve. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property Key. - - The key name for the object whose retention settings you want to retrieve. - - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property VersionId. - - The version ID for the object whose retention settings you want to retrieve. - - - - - - This is the response object from the GetObjectRetention operation. - - - - - Gets and sets the property Retention. - - The container element for an object's retention settings. - - - - - - Container for the parameters to the GetObjectTaggingRequest operation. - - - - - The bucket name containing the object for which to get the tagging information. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Check to see if Bucket property is set - - - - - Gets and sets the Key property. This is the user defined key that identifies the object in the bucket. - - - - - Check to see if Key property is set - - - - - VersionId used to reference a specific version of the object. - - - - - - Returns information about the GetObjectTagging response and response metadata. - - - - - Gets or sets tag-set for a given object - - - - - Container for the parameters to the GetObjectTorrent operation. - Return torrent files from a bucket. - - - - - The name of the bucket containing the object. - - - - - The key identifying the object. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the GetObjectTorrent response and response metadata. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - The parameters to create a pre-signed URL to a bucket or object. - - - For more information, refer to: . -
Required Parameters: BucketName, Expires -
Optional Parameters: Key, VersionId, Verb: default is GET - - - - - The name of the bucket to create a pre-signed url to, or containing the object. - - - - - Checks if BucketName property is set. - - true if BucketName property is set. - - - - The key to the object for which a pre-signed url should be created. - - - - - Checks if Key property is set. - - true if Key property is set. - - - - A standard MIME type describing the format of the object data. - - - - The content type for the content being uploaded. This property defaults to "binary/octet-stream". - For more information, refer to: . - - - Note that if content type is specified, it should also be included in the HttpRequest headers - of the eventual upload request, otherwise a signature error may result. - - - - - - The expiry date and time for the pre-signed url. - - - - - Checks if Expires property is set. - - true if Expires property is set. - - - - The requested protocol (http/https) for the pre-signed url. - - - Defaults to https. - - - - - The verb for the pre-signed url. - - - Accepted verbs are GET, PUT, DELETE and HEAD. - Default is GET. - - - - - Version id for the object that the pre-signed url will reference. If not set, - the url will reference the latest version of the object. - - - This is the VersionId for the S3 Object you want to get - a PreSigned URL for. The VersionId property will be ignored - for PreSigned "PUT" requests and for requests that don't specify - the Key property. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - Specifies the encryption used on the server to store the content. - - - - Default is None. - - - If specifying encryption (not None), the corresponding request must include header - "x-amz-server-side-encryption" with the value of the encryption. - - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - Confirms that the requester knows that she or he will be charged for the request. - Bucket owners need not specify this parameter in their requests. - - - - - A set of response headers that should be returned with the pre-signed url creation response. - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - Custom parameters to include in the signed request, so that they are tamper-proof. - - - - - The parameters for a pre-signed URL to a bucket or object as a string. - - - For more information, refer to: . - - - - - The PreSignedURL as a string - - - - - Constructor - - A url returned from GetPreSignedUrlRequest - - - - Container for the parameters to the GetPublicAccessBlock operation. - Retrieves the Public Access Block configuration for an Amazon S3 bucket. - - - - - Gets and sets the property BucketName. - - The name of the Amazon S3 bucket whose Public Access Block configuration you want - to retrieve. - - - - - - This is the response object from the GetPublicAccessBlock operation. - - - - - The Public Access Block configuration currently in effect for this Amazon S3 bucket. - - - - - Container for the parameters to the HeadBucket operation. - This operation is useful to determine if a bucket exists and you have permission to access it. - - - - - Returns information about the HeadBucket response metadata. - The HeadBucket operation has a void result type. - - - - - This class contains the headers for an S3 object. - - - - - Gets and sets headers to set for the object. - - The name of the header - The value for the header - - - - Gets the count of headers. - - - - - Gets the names of the headers set. - - - - - Specifies caching behavior along the request/reply chain. - - - - - - Specifies presentational information for the object. - - - - - - Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type - referenced by the Content-Type header field. - - - - - - The size of the object, in bytes. - - - - - The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. This - header can be used as a message integrity check to verify that the data is the same data that was originally sent. - - - - - A standard MIME type describing the format of the object data. - - - - - - The date and time at which the object is no longer cacheable. - - - - - - - Container for the parameters to the InitiateMultipartUpload operation. - Initiates a multipart upload and returns an upload ID. - - - - - Envelope Key to Encrypt data - - - - - Encrypted Envelope Key to Encrypt data - - - - - Initialization Vector for encryption - - - - - Storage mode for encryption information. - - - - - A canned access control list (ACL) to apply to the object. - Please refer to for information on S3 Canned ACLs. - - - - - The name of the bucketName where the new object will be created, or existing object updated. - - - - - The key of the object to create or update. - - - - - StorageClass property for the object. - - - Default: S3StorageClass.Standard. Set this property - only if you want reduced redundancy for this object. - Please refer to - for - information on S3 Storage Classes. - - - - - If the bucketName is configured as a website, redirects requests for this object to another object in the same bucketName or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - This is a convenience property for Headers.ContentType. - - - - - - Specifies the encryption to be used on the server for the new object. - - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - Checks if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - true if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - Specifies whether you want to apply a Legal Hold to the uploaded object. - - - - - - Gets and sets the property ObjectLockMode. - - Specifies the Object Lock mode that you want to apply to the uploaded object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - Specifies the date and time when you want the Object Lock to expire. - - - - - - The tag-set for the object. The tag-set must be encoded as URL Query parameters. - - - - - Checks if Tagging property is set - - true if Tagging is set. - - - - Returns information about the InitiateMultipartUpload response and response metadata. - - - - - Name of the bucketName to which the multipart upload was initiated. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Object key for which the multipart upload was initiated. - - - - - - Gets and sets the initiated multipart upload id. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - Date when multipart upload will become eligible for abort operation by lifecycle. - - - - - Id of the lifecycle rule that makes a multipart upload eligible for abort operation. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Identifies who initiated the multipart upload. - - - - - Name of the Principal. - - - - - - If the principal is an AWS account, it provides the Canonical User ID. If the principal is an IAM User, it provides a user ARN value. - - - - - - Describes the serialization format of the object. - - - - - Describes the serialization of a CSV-encoded object. - - - - - Specifies object's compression format. Valid values: NONE, GZIP. Default Value: NONE. - - - - - Specifies JSON as object's input serialization format. - - - - - Specifies Parquet as object's input serialization format. - - - - - Class for MetricsConfiguration - - - - - Contains information about where to publish the inventory results. - - - - - Specifies whether the inventory is enabled or disabled. - - - - - Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria. - - - - - The ID used to identify the inventory configuration. - - - - - Specifies which object version(s) to included in the inventory results. - - - - - Contains the optional fields that are included in the inventory results. - - - - - Specifies the schedule for generating inventory results. - - - - - Class for InventoryDestination - - - - - Contains the bucket name, file format, bucket owner (optional), and prefix (optional) where inventory results are published. - - - - - InventoryEncryption class - - - - - Specifies the use of SSE-S3 to encrypt delievered Inventory reports. - - - - - Specifies the use of SSE-KMS to encrypt delievered Inventory reports. - - - - - Class for InventoryFilter - - - - - Filter Predicate setup for specific filter types. - - - - - Filter Predicate abstract class for specific filter types to be derived from. - - - - - Class for InventoryPrefixPredicate - The prefix that an object must have to be included in the inventory results. - - - - - The ID of the account that owns the destination bucket. - - - - - The Amazon resource name (ARN) of the bucket where inventory results will be published. - - - - - The prefix that is prepended to all inventory results. - - - - - Specifies the output format of the inventory results. - - - - - Contains the type of server-side encryption used to encrypt the inventory results. - - - - - Class for InventorySchedule - - - - - Specifies how frequently inventory results are produced. - - - - - Specifies JSON as object's input serialization format. - - - - - The type of JSON. Valid values: Document, Lines. - - - - - Specifies JSON as request's output serialization format - - - - - The value used to separate individual records in the output. - - - - - Specifies an object key and optional object version. - - - - - Key name of the object to delete. - - - - - - VersionId for the specific version of the object to delete. - - - - - - This class contains the configuration Amazon S3 uses to figure out what events you want to listen - and send the event to an Amazon Lambda cloud function. - - - - - Gets and set the Id property. The Id will be provided in the event content and can be used - to identify which configuration caused an event to fire. If the Id is not provided for the configuration, one will be generated. - - - - - Gets and sets the FunctionArn property. This is the Amazon Lambda cloud function to which Amazon S3 will invoke with the events. - - - - Lifecycle Configuration - - - - - Gets and sets the Rules property. These rules defined the lifecycle configuration. - - - - - Base class for all the different predicates that can be used - in a filter. - - - - - This method is called by the visitor when it wants to visit the predicate. - - - - - - Filter identifying one or more objects to which a applies. - - - - - The predicate used by the filter. - - - - - Base class for lifecycle operators. - - - - - The list of objects - that this operator operates on. - - - - - The logical and operator for filtering objects for a - - - - - Accept a visit from an - - - This method is used internally by the SDK. - - - - - - A predicate that filters objects for a - by matching a particular prefix. - - - - - The prefix to be matched by filtered objects. - - - - - Accept a visit from an - - - This method is used internally by the SDK. - - - - - - A predicate that filters objects for a - by matching a particular key and value. - - - - - The Tag to be matched by filtered objects. - - - - - Accept a visit from an - - - This method is used internally by the SDK. - - - - - - Rules Item - - - - - Defines the length of time, in days, before objects expire. - - - - - Unique identifier for the rule. The value cannot be longer than 255 characters. - - - - - Prefix identifying one or more objects to which the rule applies. - - - - - - Filter identifying one or more objects to which the rule applies. - - - - - If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied. - - - - - - The transition rule that describes when objects transition to a different storage class. - - Lifecycle rules can now contain multiple transitions. This property is obsolete in favor of the Transitions property. - This property will always get or set the the zeroth element in the Transitions collection. - - - - - - Defines the length of time, in days, before noncurrent versions expire. - - - - - The transition rule that describes when noncurrent versions transition to - a different storage class. - - Lifecycle rules can now contain multiple noncurrent version transitions. This property - is obsolete in favor of the NoncurrentVersionTransitions property. - This property will always get or set the the zeroth element in the NoncurrentVersionTransitions collection. - - - - - - The transition rules that describe when objects transition to a different storage class. - - - - - The transition rules that describe when noncurrent versions transition to - a different storage class. - - - - - Specifies the days since the initiation of an Incomplete Multipart Upload - that Lifecycle will wait before permanently removing all parts of the upload. - - - - - Specifies the days since the initiation of an Incomplete Multipart Upload - that Lifecycle will wait before permanently removing all parts of the upload. - - - - - Indicates the number of days that must pass since initiation for Lifecycle - to abort an Incomplete Multipart Upload. - - - - Expiration - - - - - Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format. - - - - - - Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer. - - - - - - Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set to true, the delete marker will be expired; if set to false the policy takes no action. This cannot be specified with Days or Date in a Lifecycle Expiration Policy. - - - - - - Noncurrent Version Expiration - - - - - Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated - action. For information about the noncurrent days calculations, see - How Amazon S3 Calculates When an Object Became Noncurrent - in the Amazon Simple Storage Service Developer Guide. - - - - - LifecycleTransition defines when and how objects transition. - - - - - Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated - action. For information about the noncurrent days calculations, see - How Amazon S3 Calculates When an Object Became Noncurrent - in the Amazon Simple Storage Service Developer Guide. - - - - - The class of storage used to store the object. - - - - - - LifecycleTransition defines when and how objects transition. - - - - - Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format. - - - - - - Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer. - - - - - - The class of storage used to store the object. - - - - - - Container for the parameters to the ListInventoryConfigurationsRequest operation. - Lists the analytics configurations for the bucket. - - - - - The name of the bucket containing the analytics configurations to retrieve. - - - - - The ContinuationToken that represents a placeholder from where this request should begin. - - - - - Returns information about the ListBucketAnalyticsConfigurationsResponse response and response metadata. - - - - - The ContinuationToken that represents where this request began. - - - - - The list of analytics configurations for a bucket. - - - - - Indicates whether the returned list of analytics configurations is complete. - A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request. - - - - - NextContinuationToken is sent when isTruncated is true, which indicates that there are more analytics configurations to list. - The next request must include this NextContinuationToken. The token is obfuscated and is not a usable value. - - - - - Container for the parameters to the ListInventoryConfigurationsRequest operation. - Returns a list of inventory configurations for the bucket. - - - - - The name of the bucket containing the inventory configurations to retrieve. - - - - - The marker used to continue an inventory configuration listing that has been truncated. - Use the NextContinuationToken from a previously truncated list response to continue the listing. - The continuation token is an opaque value that Amazon S3 understands. - - - - - Returns information about the ListInventoryConfigurationsResponse response and response metadata. - - - - - If sent in the request, the marker that is used as a starting point for this inventory configuration list response. - - - - - The list of inventory configurations for a bucket. - - - - - Indicates whether the returned list of inventory configurations is truncated in this response. A value of true indicates that the list is truncated. - - - - - The marker used to continue this inventory configuration listing. Use the NextContinuationToken from this response to continue the listing in a subsequent request. - The continuation token is an opaque value that Amazon S3 understands. - - - - - Container for the parameters to the ListBucketMetricsConfigurationRequest operation. - Lists the metrics configurations for the bucket. - - - - - The name of the bucket containing the metrics configurations to retrieve. - - - - - - The marker that is used to continue a metrics configuration listing that has been truncated. - Use the NextContinuationToken from a previously truncated list response to continue the listing. - The continuation token is an opaque value that Amazon S3 understands. - - - - - - Returns information about the ListBucketMetricsConfiguration response and response metadata. - - - - - - The marker that is used to continue a metrics configuration listing that has been truncated. - Use the NextContinuationToken from a previously truncated list response to continue the listing. - The continuation token is an opaque value that Amazon S3 understands. - - - - - - The list of metrics configurations for a bucket. - - - - - - Indicates whether the returned list of metrics configurations is complete. - A value of true indicates that the list is not complete and the NextContinuationToken will be provided for - a subsequent request. - - - - - - - The marker used to continue a metrics configuration listing that has been truncated. - Use the NextContinuationToken from a previously truncated list response to continue the listing. - The continuation token is an opaque value that Amazon S3 understands. - - - - - - Container for the parameters to the ListBuckets operation. - Returns a list of all buckets owned by the authenticated sender of the request. - - - - - Returns information about the ListBuckets response and response metadata. - - - - - List of buckets. - - - - - Owner of the buckets. - - - - - Container for the parameters to the ListMultipartUploads operation. - This operation lists in-progress multipart uploads. - - - - - Name of the bucket to which the multipart upload was initiated. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Character you use to group keys. - - - - - - Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin. - - - - - - Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response body. 1,000 is the maximum number of uploads that - can be returned in a response. - - - - - - Lists in-progress uploads only for those keys that begin with the specified prefix. - - - - - - Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the - upload-id-marker parameter is ignored. - - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - Returns information about the ListMultipartUploads response and response metadata. - - - - - Name of the bucketName to which the multipart upload was initiated. - - - - - - The key at or after which the listing began. - - - - - - Upload ID after which listing began. - - - - - - When a list is truncated, this element specifies the value that should be used for the key-marker request parameter in a subsequent request. - - - - - - When a list is truncated, this element specifies the value that should be used for the upload-id-marker request parameter in a subsequent - request. - - - - - - Maximum number of multipart uploads that could have been included in the response. - - - - - - Indicates whether the returned list of multipart uploads is truncated. A value of true indicates that the list was truncated. The list can - be truncated if the number of multipart uploads exceeds the limit allowed or specified by max uploads. - - - - - - Gets and sets the MultipartUploads property. - - Container for elements related to a particular multipart upload. A response - can contain zero or more Upload elements. - - - - - - Gets and sets the Prefix property. - - - - - Gets and sets the Delimiter property. - - - - - Gets the CommonPrefixes property. - A response can contain CommonPrefixes only if you specify a delimiter. - When you do, CommonPrefixes contains all (if there are any) keys between - Prefix and the next occurrence of the string specified by delimiter. In effect, - CommonPrefixes lists keys that act like subdirectories in the directory specified - by Prefix. For example, if prefix is notes/ and delimiter is a slash (/), in - notes/summer/july, the common prefix is notes/summer/. - - - - - Container for the parameters to the ListObjects operation. - Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a - subset of the objects in a bucket. - - - - - The name of the bucket containing the objects whose keys are to be listed. - - - - - A delimiter is a character you use to group keys. - - - - - Specifies the key to start with when listing objects in a bucket. - - - - - Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more. - - - - - Limits the response to keys that begin with the specified prefix. - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the ListObjects response and response metadata. - - - - - A flag that indicates whether or not Amazon S3 returned all of the results that satisfied - the search criteria. - - - - - Gets and sets the NextMarker property. - NextMarker is set by S3 only if a Delimiter was specified - in the original ListObjects request. If a delimiter was - not specified, the AWS SDK for .NET returns the last Key - of the List of Objects retrieved from S3 as the NextMarker. - - - - - Gets the S3Objects property. This is a list of - objects in the bucket that match your search criteria. - - - - - Gets and sets the Name property which is the name of the bucket. - - - - - Gets and sets the Prefix property. - - - - - Gets and sets the MaxKeys property. This is max number of object keys returned by the list operation. - - - - - Gets the CommonPrefixes property. - A response can contain CommonPrefixes only if you specify a delimiter. - When you do, CommonPrefixes contains all (if there are any) keys between - Prefix and the next occurrence of the string specified by delimiter. In effect, - CommonPrefixes lists keys that act like subdirectories in the directory specified - by Prefix. For example, if prefix is notes/ and delimiter is a slash (/), in - notes/summer/july, the common prefix is notes/summer/. - - - - - Gets and sets the Delimiter property. - Causes keys that contain the same string between the prefix and the - first occurrence of the delimiter to be rolled up into a single result - element in the CommonPrefixes collection. - - - These rolled-up keys are not returned elsewhere in the response. - - - - - Container for the parameters to the ListObjects operation. - Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a - subset of the objects in a bucket. - - - - - Bucket name to list. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - A delimiter is a character you use to group keys. - - - - - Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more. - - - - - Limits the response to keys that begin with the specified prefix. - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts - listing after this specified key. StartAfter can be any key in the bucket. - Cannot be set at the same time as ContinuationToken. - - - - - ContinuationToken indicates Amazon S3 that the list is being continued on this - bucket with a token. ContinuationToken is obfuscated and is not a real key. - - - - - The owner field is not present in ListObjectsV2 responses by default. - If you want to return owner field with each key in the result then set this field to true. - If not specified, the Owner field on S3Object will be null. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the ListObjects response and response metadata. - - - - - A flag that indicates whether or not Amazon S3 returned all of the results that satisfied - the search criteria. - - - - - Gets and sets the S3Objects property. Metadata about each object returned. - - - - - Bucket name. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the Prefix property. - - - - - Gets and sets the MaxKeys property. This is max number of object keys returned by the list operation. - - - - - Gets and sets the CommonPrefixes property. - CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence - of the string specified by delimiter - - - - - Gets and sets the Delimiter property. - Causes keys that contain the same string between the prefix and the - first occurrence of the delimiter to be rolled up into a single result - element in the CommonPrefixes collection. - - - These rolled-up keys are not returned elsewhere in the response. - - - - - Encoding type used by Amazon S3 to encode object keys in the response. - - - - - KeyCount is the number of keys returned with this request. - KeyCount will always be less than or equal to MaxKeys field. - - - - - ContinuationToken indicates Amazon S3 that the list is being continued - on this bucket with a token. - ContinuationToken is obfuscated and is not a real key - - - - - NextContinuationToken is sent when isTruncated is true which means there - are more keys in the bucket that can be listed. The next ListObjectV2 call - to Amazon S3 can be continued with this NextContinuationToken. - NextContinuationToken is obfuscated and is not a real key. - - - - - StartAfter is where you want Amazon S3 to start listing from. - Amazon S3 starts listing after this specified key. - StartAfter can be any key in the bucket. - - - - - Container for the parameters to the ListParts operation. - Lists the parts that have been uploaded for a specific multipart upload. - - - - - Name of the bucket to which the parts are being uploaded. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The object key for which the multipart upload was initiated. - - - - - Sets the maximum number of parts to return. - - - - - - Specifies the part after which listing should begin. Only parts with higher part numbers will be listed. - - - - - - Upload ID identifying the multipart upload whose parts are being listed. - - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the ListParts response and response metadata. - - - - - Name of the bucketName to which the multipart upload was initiated. - - - - - - Object key for which the multipart upload was initiated. - - - - - - Upload ID identifying the multipart upload whose parts are being listed. - - - - - - Part number after which listing begins. - - - - - - When a list is truncated, this element specifies the last part in the list, as well as the value to use for the part-number-marker request - parameter in a subsequent request. - - - - - - Maximum number of parts that were allowed in the response. - - - - - - Indicates whether the returned list of parts is truncated. - - - - - - Gets and sets the Parts property. - - PartDetails is a container for elements related to a particular part. A response can contain - zero or more Part elements. - - - - - - Identifies who initiated the multipart upload. - - - - - - Gets and sets the Owner property. - - - - - The class of storage used to store the object. - - - - - - Date when multipart upload will become eligible for abort operation by lifecycle. - - - - - Id of the lifecycle rule that makes a multipart upload eligible for abort operation. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the ListVersions operation. - Returns metadata about all of the versions of objects in a bucket. - - - - - The bucket name that contains the objects. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - A delimiter is a character you use to group keys. - - - - - Specifies the key to start with when listing objects in a bucket. - - - - - Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more. - - - - - Limits the response to keys that begin with the specified prefix. - - - - - Specifies the object version you want to start listing from. - - - - - Requests Amazon S3 to encode the object keys in the response and specifies - the encoding method to use. An object key may contain any Unicode character; - however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the - keys in the response. - - - - - Returns information about the ListVersions response and response metadata. - - - - - A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria. If your results were - truncated, you can make a follow-up paginated request using the NextKeyMarker and NextVersionIdMarker response parameters as a starting - place in another request to return the rest of the results. - - - - - - Marks the last Key returned in a truncated response. - - - - - - Gets and sets the VersionIdMarker property. - Marks the last Version-Id returned in a truncated response. - - - - - Use this value for the key marker request parameter in a subsequent request. - - - - - - Use this value for the next version id marker parameter in a subsequent request. - - - - - - Gets and sets the Versions property. This is a list of - object versions in the bucket that match your search criteria. - - - - - Gets and sets the Name property. - The bucket's name. - - - - - Gets and sets the Prefix property. - Keys that begin with the indicated prefix are listed. - - - - - Gets and sets the MaxKeys property. - This is the maximum number of keys in the S3ObjectVersions collection. - The value is derived from the MaxKeys parameter to ListVersionsRequest. - - - - - Gets the CommonPrefixes property. - A response can contain CommonPrefixes only if you specify a delimiter. - When you do, CommonPrefixes contains all (if there are any) keys between - Prefix and the next occurrence of the string specified by delimiter. - - - - - Gets and sets the Delimiter property. - Causes keys that contain the same string between the prefix and the - first occurrence of the delimiter to be rolled up into a single result - element in the CommonPrefixes collection. - - - These rolled-up keys are not returned elsewhere in the response. - - - - - This class contains the meta data for an S3 object. - - - - - Gets and sets meta data for the object. Meta data names must start with "x-amz-meta-". If the name passeed in as the indexer - doesn't start with "x-amz-meta-" then it will be prepended. - - The name of the meta data. - The value for the meta data - - - - Adds the metadata to the collection, if the name already exists it will be overwritten. - - The name of the metadata element - The value for the metadata - - - - Gets the count of headers. - - - - - Gets the names of the meta data elements. - - - - - A metadata key-value pair to store with an object. - - - - - Key of metadata key-value pair - - - - - Value of metadata key-value pair - - - - - A container specifying replication metrics-related information, including whether - emitting metrics and Amazon S3 events for replication are enabled. In addition, contains - configurations related to specific metrics or events. Must be specified together with a - ReplicationTime block. - - - - - Specifies whether the replication metrics are enabled. - - - - - A container specifying the time threshold for emitting the - s3:Replication:OperationMissedThreshold event. - - - - - Class for MetricsAndOperatorPredicate - A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. - The operator must have at least two predicates, and an object must match all of the predicates - in order for the filter to apply. - - Note: The current implementation restricts the usage to atmost one MetricsPrefixPredicate - and any number of MetricsTagPredicates. - - - - Class for MetricsConfiguration - - - - - The ID used to identify the metrics configuration. - - - - - Specifies a metrics configuration filter. - The metrics configuration will only include objects that meet the filter's criteria. - A filter must be a prefix, a tag, or a conjunction (MetricsAndOperator). - - - - - Filter class for Metrics. - - - - - Filter Predicate setup for specific filter types. - - - - - Filter Predicate abstract class for specific filter types to be derived from. - - - - - Abstract class that can be used over logical filter predicates,i.e. AND/OR. - - - - - Class for MetricsPrefixPredicate - The prefix used when evaluating a metrics filter. - - - - - Class for MetricsTagPredicate - The tag used when evaluating a metrics filter. - - - - - This class contains the mfa codes used authentication - - - - - Gets and sets the serial number of the authentication device - - - - - Gets and sets the displated value on the authentication device - - - - - The formatted string of the mfa codes to be passed to S3. - - - - - Container for elements related to a particular multipart upload. - - - - - Date and time at which the multipart upload was initiated. - - - - - - Identifies who initiated the multipart upload. - - - - - - Key of the object for which the multipart upload was initiated. - - - - - - Gets and sets the Owner property. - - - - - The class of storage used to store the object. - - - - - - Upload ID that identifies the multipart upload. - - - - - - An abstract class for all the notification configurations associated with an Amazon S3 bucket. - - - - - Gets and sets the Events property. These are the events the configuration will listen to. - - - - - Filter criteria for determining which S3 objects trigger event notifications. - - - - - - The container element for Object Lock configuration parameters. - - - - - Gets and sets the property ObjectLockEnabled. - - Indicates whether this object has an Object Lock configuration enabled. - - - - - - Gets and sets the property Rule. - - The Object Lock rule in place for the specified object. - - - - - - A Legal Hold configuration for an object. - - - - - Gets and sets the property Status. - - Indicates whether the specified object has a Legal Hold in place. - - - - - - A Retention configuration for an object. - - - - - Gets and sets the property Mode. - - Indicates the Retention mode for the specified object. - - - - - - Gets and sets the property RetainUntilDate. - - - - - The container element for an Object Lock rule. - - - - - Gets and sets the property DefaultRetention. - - The default retention period that you want to apply to new objects placed in the specified - bucket. - - - - - - Describes the location where the restore job's output is stored. - - - - - Describes an S3 location that will receive the results of the restore request. - - - - - Describes how results of the Select job are serialized. - - - - - Describes the serialization of CSV-encoded Select results. - - - - - Specifies JSON as request's output serialization format. - - - - - The owner of an S3 bucket. - - - - - The display name of the owner. - - - - - The unique identifier of the owner. - - - - - This class contains custom querystring parameters for an S3 object, which can then be signed as part of a Pre-signed URL request - - - - - Gets and sets parameters for the object. Parameter names must start with "x-". If the name passeed in as the indexer - doesn't start with "x-" then it will be prepended. - - The name of the parameter. - The value for the meta data - - - - Adds the parameter to the collection, if the name already exists it will be overwritten. - - The name of the parameter - The value for the parameter - - - - Gets the count of parameters. - - - - - Gets the names of the parameter elements. - - - - - Specifies Parquet as object's input serialization format. - - - - - A container for elements related to a particular part in a multipart operation. - A response can contain zero or more Part elements. - - - - - The date and time at which the part was uploaded. - - - - - The size of the uploaded part data. - - - - - A container holding the part number and etag used when completing a multipart upload. - - - - - Default constructor. - - - - - Constructs an instance of PartETag and sets the part number and etag. - - The part number. - the associated ETag for the part number. - - - - Compares the current object with another object of the same type. - - An object to compare with this object. - - A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has the following meanings: - Value - Meaning - Less than zero - This object is less than the parameter. - Zero - This object is equal to . - Greater than zero - This object is greater than . - - - - - The part number identifying the part. - - - - - The entity tag associated with the part. - - - - - The container element for this bucket's public-policy status. - - - - - Gets and sets the property IsPublic. - - The public-policy status for this bucket. TRUE indicates that this bucket - is public. FALSE indicates that the bucket is not public. - - - - - - The container element for all Public Access Block configuration options. You can enable - the configuration options in any combination. - - - - Amazon S3 considers a bucket policy public unless at least one of the following conditions - is true: - -
  1. - - The policy limits access to a set of CIDRs using aws:SourceIp. For more - information on CIDR, see http://www.rfc-editor.org/rfc/rfc4632.txt - - -
  2. - - The policy grants permissions, not including any "bad actions," to one of the following: - -
    • - - A fixed AWS principal, user, role, or service principal - -
    • - - A fixed aws:SourceArn - -
    • - - A fixed aws:SourceVpc - -
    • - - A fixed aws:SourceVpce - -
    • - - A fixed aws:SourceOwner - -
    • - - A fixed aws:SourceAccount - -
    • - - A fixed value of s3:x-amz-server-side-encryption-aws-kms-key-id - -
    • - - A fixed value of aws:userid outside the pattern "AROLEID:*" - -
- - "Bad actions" are those that could expose the data inside a bucket to reads or writes - by the public. These actions are s3:Get*, s3:List*, s3:AbortMultipartUpload, - s3:Delete*, s3:Put*, and s3:RestoreObject. - - - - The star notation for bad actions indicates that all matching operations are considered - bad actions. For example, because s3:Get* is a bad action, s3:GetObject, - s3:GetObjectVersion, and s3:GetObjectAcl are all bad actions. - - - - - - Gets and sets the property BlockPublicAcls. - - Specifies whether Amazon S3 should block public ACLs for this bucket. Setting this - element to TRUE causes the following behavior: - -
  • - - PUT Bucket acl and PUT Object acl calls will fail if the specified ACL allows public - access. - -
  • - - PUT Object calls will fail if the request includes an object ACL. - -
- - Note that enabling this setting doesn't affect existing policies or ACLs. - - - - - - Gets and sets the property IgnorePublicAcls. - - Specifies whether Amazon S3 should ignore public ACLs for this bucket. Setting this - element to TRUE causes Amazon S3 to ignore all public ACLs on this bucket - and any objects that it contains. - - - - Note that enabling this setting doesn't affect the persistence of any existing ACLs - and doesn't prevent new public ACLs from being set. - - - - - - Gets and sets the property BlockPublicPolicy. - - Specifies whether Amazon S3 should block public bucket policies for this bucket. Setting - this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy - if the specified bucket policy allows public access. - - - - Note that enabling this setting doesn't affect existing bucket policies. - - - - - - Gets and sets the property RestrictPublicBuckets. - - Specifies whether Amazon S3 should restrict public bucket policies for this bucket. - If this element is set to TRUE, then only the bucket owner and AWS Services - can access this bucket if it has a public policy. - - - - Note that enabling this setting doesn't affect previously stored bucket policies, - except that public and cross-account access within any public bucket policy, including - non-public delegation to specific accounts, is blocked. - - - - - - Container for the parameters to the PutAcl operation. - uses the acl subresource to set the access control list (ACL) permissions for an object that already exists in a bucket - - - - - The canned ACL to apply to the bucket. - - - - - - Custom ACLs to be applied to the bucket or object. - - - - - The bucket name that contains the object to which you want to attach the ACL. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The key of an S3 object. - If not specified, the ACLs are applied to the bucket. - - - - - If set and an object key has been specified, the ACLs are applied - to the specific version of the object. - This property is ignored if the ACL is to be set on a Bucket. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - Returns information about the PutObjectAcl response metadata. - The PutAcl operation has a void result type. - - - - - The response for the PutBucketAccelerateConfiguration operation. - Adds an object to a bucket. - - - - - Container for the parameters to the PutBucketAccelerateConfiguration request. - - - - - The name of the bucket to contain the object. - - - - - Accelerate configuration for the bucket. - - - - - Container for the parameters to the PutBucketAnalyticsConfiguration operation. - Sets an analytics configuration for the bucket (specified by the analytics configuration ID). - - - - - The name of the bucket to which an analytics configuration is stored. - - - - - The identifier used to represent an analytics configuration. - - - - - The configuration and any analyses for the analytics filter. - - - - - Returns information about the PutBucketAnalyticsConfigurationResponse response metadata. - The PutBucketAnalyticsConfigurationResponse operation has a void result type. - - - - - Container for the parameters to the PutBucketRequestPayment operation. - Creates a new server-side encryption configuration (or replaces an existing one, if present). - - - - - The name of the bucket for which the server-side encryption configuration is set. - - - - - The base64-encoded 128-bit MD5 digest of the server-side encryption configuration. - - - This header can be used as a message integrity check to verify that the data is the same data that was originally sent. - Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. - - - - - Container for server-side encryption configuration rules. Currently S3 supports one rule only. - - - - - Container for the parameters to the PutBucketRequestPayment operation. - Adds an inventory configuration (identified by the inventory ID) from the bucket. - - - - - The name of the bucket where the inventory configuration will be stored. - - - - - Specifies the inventory Id. - - - - - Specifies the inventory configuration. - - - - - Returns information about the PutInventoryConfigurationResponse response metadata. - The PutInventoryConfigurationResponse operation has a void result type. - - - - - Container for the parameters to the PutBucketLoggingRequest operation. - Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. To set the - logging status of a bucket, you must be the bucket owner. - - - - - Gets and sets the BucketName property. - - - - - Gets and sets the LoggingConfig property. - - - - - Returns information about the PutBucketLogging response metadata. - The EnableBucketLogging operation has a void result type. - - - - - Container for the parameters to the PutBucketMetricsConfigurationRequest operation. - Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. - - - - - The name of the bucket for which the metrics configuration is set. - - - - - The ID used to identify the metrics configuration. - - - - - Specifies the metrics configuration. - - - - - Returns information about the PutBucketMetricsConfiguration response metadata. - The PutBucketMetricsConfiguration operation has a void result type. - - - - - Container for the parameters to the PutBucketNotification operation. - Enables notifications of specified events for a bucket. - - - - - Gets and sets the BucketName property. - - - - - Gets and sets the TopicConfigurations property. TopicConfigurations are configuration for Amazon S3 - events to be sent to Amazon SNS topics. - - - - - Gets and sets the QueueConfigurations property. QueueConfigurations are configuration for Amazon S3 - events to be sent to Amazon SQS queues. - - - - - Gets and sets the LambdaFunctionConfigurations property. LambdaFunctionConfigurations are configuration for - Amazon S3 events to be sent to an Amazon Lambda cloud function. - - - - - Returns information about the PutBucketNotification response metadata. - The PutBucketNotification operation has a void result type. - - - - - Container for the parameters to the PutBucketPolicy operation. - Replaces a policy on a bucket. If the bucket already has a policy, the one in this request completely replaces it. - - - - - The name of the bucket. - - - - - The base64 encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. - - - This header can be used as a message integrity check to verify that the data is the same data that was originally sent. - Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. - - - - - The bucket policy as a JSON document. - - - - - Set this parameter to true to confirm that you want to remove your - permissions to change this bucket policy in the future. - - - - - Overriden to turn off sending SHA256 header. - - - - - Returns information about the PutBucketPolicy response metadata. - The PutBucketPolicy operation has a void result type. - - - - - Container for the parameters to the PutBucketReplication operation. - Sets replication configuration for your bucket. If a replication configuration exists, this replaces it. - - - - - The name of the bucket to have the replication configuration applied. - - - - - The replication configuration to be applied. - - - - - Gets and sets the property Token. - - - - - Returns information about the PutBucketReplicationConfiguration response metadata. - The PutBucketReplicationConfiguration operation has a void result type. - - - - - Container for the parameters to the PutBucket operation. - Creates a new bucket. - - - - - The canned ACL to apply to the bucket. - - - - - - If set to true the bucket will be created in the same region - as the configuration of the AmazonS3 client. - If PutBucketRequest.BucketRegion or PutBucketRequest.BucketRegionName are set they take precedence over - this property. - Default: true. - - - - - The name of the bucket to be created. - - - - - The region locality for the bucket. - - - When set, this will determine where your data will - reside in S3. Refer - for a list of possible values. - - - - - The bucket region locality expressed using the name of the region. - When set, this will determine where your data will reside in S3. - Valid values: us-east-1, us-west-1, us-west-2, eu-west-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, sa-east-1 - - - - - Gets and sets the property ObjectLockEnabledForBucket. - - Specifies whether you want S3 Object Lock to be enabled for the new bucket. - - - - - - Container for the parameters to the PutBucketRequestPayment operation. - Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This - configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the - download. - - - - - The name of the bucket to set payment config. - - - - - Gets and sets request payment configuration - - - - - Returns information about the PutBucketRequestPayment response metadata. - The PutBucketRequestPayment operation has a void result type. - - - - - Returns information about the PutBucket response and response metadata. - - - - - Container for the parameters to the PutBucketTagging operation. - Sets the tags for a bucket. - - - - - The name of the bucket to apply the tags to. - - - - - The collection of tags. - - - - - Returns information about the PutBucketTagging response metadata. - The PutBucketTagging operation has a void result type. - - - - - Container for the parameters to the PutBucketVersioning operation. - Sets the versioning state of an existing bucket. To set the versioning state, you must be the bucket owner. - - - - - The name of the bucket to be updated. - - - - - The MfaCodes Tuple associates the Serial Number and the current Token/Code displayed on the - Multi-Factor Authentication device associated with your AWS Account. - - - This is a required property for this request if:
- 1. EnableMfaDelete was configured on the bucket - containing this object's version.
- 2. You are deleting an object's version - - - - - Checks if the MfaCodes property is set. - - true if the MfaCodes property is set. - - - - The versioning configuration to apply to the bucket. - - - Once Versioning has been "Enabled" on a bucket, it can be "Suspended" - but cannot be switched "Off". If EnableMfaDelete is set, - the MfaCodes property needs to contain the Serial of and current Token - displayed on the MFA device. - - - - - Returns information about the PutBucketVersioning response metadata. - The PutBucketVersioning operation has a void result type. - - - - - Container for the parameters to the PutBucketWebsite operation. - Set the website configuration for a bucket. - - - - - The name of the bucket to apply the configuration to. - - - - - The website configuration to apply. The configuration defines the index - document suffix and custom error page. - - - - - Returns information about the PutBucketWebsite response metadata. - The PutBucketWebsite operation has a void result type. - - - - - Container for the parameters to the PutCORSConfiguration operation. - Sets the cors configuration for a bucket. - - - - - The name of the bucket to have the CORS configuration applied. - - - - - The CORS configuration to apply. - - - - - Returns information about the PutCORSConfiguration response metadata. - The PutCORSConfiguration operation has a void result type. - - - - - Container for the parameters to the PutLifecycleConfiguration operation. - Sets lifecycle configuration for your bucket. If a lifecycle configuration exists, it replaces it. - - - - - The name of the bucket to have the lifecycle configuration applied. - - - - - The lifecycle configuration to be applied. - - - - - Returns information about the PutLifecycleConfiguration response metadata. - The PutLifecycleConfiguration operation has a void result type. - - - - - Container for the parameters to the PutObjectLegalHold operation. - Applies a Legal Hold configuration to the specified object. - - - - - The bucket name containing the object that you want to place a Legal Hold on. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property ContentMD5. - - The MD5 signature for the configuration included in your request. - - - - - - Gets and sets the property Key. - - The key name for the object that you want to place a Legal Hold on. - - - - - - Gets and sets the property LegalHold. - - Container element for the Legal Hold configuration you want to apply to the specified - object. - - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property VersionId. - - The version ID of the object that you want to place a Legal Hold on. - - - - - - This is the response object from the PutObjectLegalHold operation. - - - - - Gets and sets the property RequestCharged. - - - - - Container for the parameters to the PutObjectLockConfiguration operation. - Places an Object Lock configuration on the specified bucket. The rule specified in - the Object Lock configuration will be applied by default to every new object placed - in the specified bucket. - - - - - Gets and sets the property BucketName. - - The bucket whose Object Lock configuration you want to create or replace. - - - - - - Gets and sets the property ContentMD5. - - The MD5 signature for the configuration included in your request. - - - - - - Gets and sets the property ObjectLockConfiguration. - - The Object Lock configuration that you want to apply to the specified bucket. - - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property Token. - - - - - This is the response object from the PutObjectLockConfiguration operation. - - - - - Gets and sets the property RequestCharged. - - - - - Container for the parameters to the PutObject operation. - Adds an object to a bucket. - - - Container for the parameters to the PutObject operation. - Adds an object to a bucket. - - - - - A canned access control list (CACL) to apply to the object. - Please refer to for - information on S3 Canned ACLs. - - - - - Input stream for the request; content for the request will be read from the stream. - - - - - - The full path and name to a file to be uploaded. - If this is set the request will upload the specified file to S3. - - - For WinRT and Windows Phone this property must be in the form of "ms-appdata:///local/file.txt". - - - - - - Text content to be uploaded. Use this property if you want to upload plaintext to S3. - The content type will be set to 'text/plain'. - - - - - If this value is set to true then the stream used with this request will be closed when all the content - is read from the stream. - Default: true. - - - - - If this value is set to true then the stream will be seeked back to the start before being read for upload. - Default: true. - - - - - If this value is set to true then a chunked encoding upload will be used for the request. - Default: true. - - - - - Bucket name to which the PUT operation was initiated. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - Gets and sets Key property. This key is used to identify the object in S3. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - Checks if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - true if ServerSideEncryptionKeyManagementServiceEncryptionContext property is set. - - - - The type of storage to use for the object. Defaults to 'STANDARD'. - - - - - - Gets and sets the property ObjectLockLegalHoldStatus. - - The Legal Hold status that you want to apply to the specified object. - - - - - - Gets and sets the property ObjectLockMode. - - The Object Lock mode that you want to apply to this object. - - - - - - Gets and sets the property ObjectLockRetainUntilDate. - - The date and time when you want this object's Object Lock to expire. - - - - - - If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - - - - - - Attach a callback that will be called as data is being sent to the AWS Service. - - - - - This is a convenience property for Headers.ContentType. - - - - - An MD5 digest for the content. - - - - The base64 encoded 128-bit MD5 digest of the message - (without the headers) according to RFC 1864. This header - can be used as a message integrity check to verify that - the data is the same data that was originally sent. - - - If supplied, after the file has been uploaded to S3, - S3 checks to ensure that the MD5 hash of the uploaded file - matches the hash supplied. - - - Although it is optional, we recommend using the - Content-MD5 mechanism as an end-to-end integrity check. - - - - - - Checks if MD5Digest property is set. - - true if MD5Digest property is set. - - - - Overriden to turn off sending SHA256 header. - - - - - Overriden to turn on expect 100 continue. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - The tag-set for the object. The tag-set must be encoded as URL Query parameters. - - - - - Checks if Tagging property is set - - true if Tagging is set. - - - - Returns information about the PutObject response and response metadata. - - - - - Gets and sets the Expiration property. - Specifies the expiration date for the object and the - rule governing the expiration. - Is null if expiration is not applicable. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - Entity tag for the uploaded object. - - - - - - Version of the object. - - - - - - The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Specifies the AWS KMS Encryption Context to use for object encryption. - The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Container for the parameters to the PutObjectRetention operation. - Places an Object Retention configuration on an object. - - - - - The bucket name that contains the object you want to apply this Object Retention configuration to. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the property BypassGovernanceRetention. - - - - - Gets and sets the property ContentMD5. - - The MD5 signature for the configuration included in your request. - - - - - - Gets and sets the property Key. - - The key name for the object that you want to apply this Object Retention configuration - to. - - - - - - Gets and sets the property RequestPayer. - - - - - Gets and sets the property Retention. - - The container element for the Object Retention configuration. - - - - - - Gets and sets the property VersionId. - - The version ID for the object that you want to apply this Object Retention configuration - to. - - - - - - This is the response object from the PutObjectRetention operation. - - - - - Gets and sets the property RequestCharged. - - - - - Container for the parameters to the PutObjectTagging operation. - - - - - The bucket name containing the object. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Check to see if Bucket property is set - - - - - Gets and sets Key property. This key is used to identify the object in S3. - - - - - Check to see if Key property is set - - - - - The tag-set for the object. The tag-set must be encoded as URL Query parameters - - - - - Checks if Tagging property is set. - - - - - VersionId used to reference a specific version of the object. - - - - - - Returns information about the PutObjectTagging response and response metadata. - - - - - Version of the object. - - - - - Container for the parameters to the PutPublicAccessBlock operation. - Creates or modifies the Public Access Block configuration for an Amazon S3 bucket. - - - - - Gets and sets the property BucketName. - - The name of the Amazon S3 bucket whose Public Access Block configuration you want - to set. - - - - - - Gets and sets the property ContentMD5. - - The MD5 hash of the PutPublicBlock request body. - - - - - - Gets and sets the property PublicAccessBlockConfiguration. - - The Public Access Block configuration that you want to apply to this Amazon S3 bucket. - - - - - - This is the response object from the PutPublicAccessBlock operation. - - - - - Base class for put operations that can also put an ACL. - - - - - Gets the access control lists (ACLs) for this request. - Please refer to for information on - S3 Grants. - - - - - This class contains the configuration Amazon S3 uses to figure out what events you want to listen - and send the event to an Amazon SQS queue. - - The queue's policy must allow S3 to send messages to it. The utility method - Amazon.SQS.AmazonSQSClient.AuthorizeS3ToSendMessage(string,string) - can be used to help setup the queue policy. - - - - - - Gets and set the Id property. The Id will be provided in the event content and can be used - to identify which configuration caused an event to fire. If the Id is not provided for the configuration, one will be generated. - - - - - Gets and sets the Queue property. Amazon SQS queue to which Amazon S3 will publish a message - to report the specified events for the bucket. - - The queue's policy must allow S3 to send messages to it. The utility method - Amazon.SQS.AmazonSQSClient.AuthorizeS3ToSendMessage(string,string) - can be used to help setup the queue policy. - - - - - - This class defines the configuration for replication. - - - - - Indicates the ARN of the role to assume. - - - - - Check to see if the Role property is set. - - true if the Role property is set. - - - - Container for information about a particular replication rule. - Replication configuration must have at least one rule and can contain up to 1,000 rules. - - - - - Checks to see if the Rules property is set. - - true if the Rules property is set. - - - - Destination configuration for a replication rule. - - - - -

Amazon resource name (ARN) of the bucket where you want Amazon - S3 to store replicas of the object identified by the rule.

- If you have multiple rules in your replication configuration, all - rules must specify the same bucket as the destination. A replication - configuration can replicate objects only to one destination bucket.

- - - - - Checks to see if BucketArn property is set. - - true if BucketArn property is set. - - - - The class of storage used to store the object. - - - - - -

Account ID of the destination bucket. Currently Amazon S3 verifies this - value only if Access Control Translation is enabled.

In a cross-account - scenario, if you tell Amazon S3 to change replica ownership to the AWS account - that owns the destination bucket by adding the AccessControlTranslation - element, this is the account ID of the destination bucket owner.

- - - - -

Container for information regarding the access control for replicas.

-

Use only in a cross-account scenario, where source and destination bucket - owners are not the same, when you want to change replica ownership to the AWS - account that owns the destination bucket. If you don't add this element to the - replication configuration, the replicas are owned by same AWS account that - owns the source object.

- - - - -

Container that provides encryption-related information. You must - specify this element if the SourceSelectionCriteria is - specified.

- - - - - A container specifying the time when all objects and operations on objects are - replicated. Must be specified together with a Metrics block. - - - - - A container specifying replication metrics-related information, including whether - emitting metrics and Amazon S3 events for replication are enabled. In addition, - contains configurations related to specific metrics or events. Must be specified - together with a ReplicationTime block. - - - - - Rule that specifies the replication configuration. - - - - - Unique identifier for the rule. The value cannot be longer than 255 characters. - - - - - Checks to see if Id property is set. - - true if Id property is set. - - - -

The priority associated with the rule. If you specify multiple rules in a - replication configuration, then Amazon S3 applies rule priority in the event - there are conflicts (two or more rules identify the same object based on - filter specified). The rule with higher priority takes precedence. For - example,

  • Same object quality prefix based filter criteria - If prefixes you specified in multiple rules overlap.

  • Same - object qualify tag based filter criteria specified in multiple rules

    • -

For more information, see - - Cross-Region Replication (CRR) in the Amazon S3 Developer Guide.

- - - - - Checks to see if Priority property is set. - - true if Priority property is set. - - - - Object keyname prefix identifying one or more objects to which the - rule applies. Maximum prefix length can be up to 1,024 characters. - - - - - Checks to see if Prefix property is set. - - true if Prefix property is set. - - - - Gets and sets the property Filter. - - - - - Checks to see if Filter property is set. - - true if Filter property is set. - - - - Whether the rule is applied or ignored. - - - - - Checks to see if Status property is set. - - true if Status property is set. - - - - Container for replication destination information. - - - - - Checks to see if Destination property is set. - - true if Destination property is set. - - - -

Container that describes additional filters in identifying source objects that - you want to replicate. Currently, Amazon S3 supports only the filter that you can - specify for objects created with server-side encryption using an AWS KMS-managed - key. You can choose to enable or disable replication of these objects.

if - you want Amazon S3 to replicate objects created with server-side encryption using - AWS KMS-managed keys.

- - - - - A container that specifies information about existing object replication. - You can choose whether to enable or disable the replication of existing objects. - - - - - Checks to see if ExistingObjectReplication property is set. - - true if ExistingObjectReplication property is set. - - - - Specifies whether Amazon S3 should replicate delete makers. - - - - - Checks to see if DeleteMarkerReplication property is set. - - true if DeleteMarkerReplication property is set. - - - - - - - - Object keyname prefix that identifies subset of objects to which the rule applies. - - - - - Checks to see if Prefix property is set. - - true if Prefix property is set. - - - - All of these tags must exist in the object's tag set in order for the rule to apply. - - - - - Checks to see if Tags property is set. - - true if Tags property is set. - - - - Filter that identifies subset of objects to which the replication rule applies. - A Filter must specify exactly one Prefix, - Tag, or an And child element. - - - - - Object keyname prefix that identifies subset of objects to which the rule applies. - - - - - Checks to see if Prefix property is set. - - true if Prefix property is set. - - - -

Container for specifying a tag key and value.

-

The rule applies only to objects having the tag in its tagset.

- - - - - Checks to see if Tag property is set. - - true if Tag property is set. - - - -

Container for specifying rule filters. These filters determine the - subset of objects to which the rule applies. The element is required - only if you specify more than one filter. For example:

  • -

    You specify both a Prefix and a Tag - filters. Then you wrap these in an And tag.

    • -

  • You specify filter based on multiple tags. Then you wrap the - Tag elements in an And tag.

- - - - - Checks to see if And property is set. - - true if And property is set. - - - - A container specifying the time when all objects and operations on objects are replicated. Must be specified together with a Metrics block. - - - - - Specifies whether the replication time is enabled. - - - - - A container specifying the time by which replication should complete for all objects and operations on objects. - - - - - A container specifying the time value. - - - - - Contains an integer specifying time in minutes. - - - - - Request Payment Configuration - - - - - Specifies who pays for the download and request fees. - - - - - Container for values of the response headers that will be set on a response from a GetObject request. - These values override any headers that were set when the object was uploaded to S3. - - - - - A standard MIME type describing the format of the object data. - - - The content type for the content being uploaded. This property defaults to "binary/octet-stream". - For more information, refer to: - - - - - ContentLanguage header value. - - - - - Expiry header value. - - - - - CacheControl header value. - - - - - The ContentDisposition header value. - - - - - The ContentEncoding header value. - - - - - Container for the parameters to the RestoreObject operation. - Restores an archived copy of an object back into Amazon S3 - - - - - The bucket name or containing the object to restore. - When using this API with an access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this operation using an access point through the AWS SDKs, you provide the access point - ARN in place of the bucket name. For more information about access point ARNs, see - Using Access Points - in the Amazon Simple Storage Service Developer Guide. - - - - - Gets and sets the Key property. This key indicates the S3 object to restore. - - - - - Lifetime of the active copy in days - ** Do not use with restores that specify OutputLocation ** - - - - - VersionId used to reference a specific version of the object. - - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Glacier retrieval tier at which the restore will be processed. - ** Do not use with restores that specify OutputLocation ** - - - - - Glacier retrieval tier at which the restore will be processed. - ** Only use with restores that require OutputLocation ** - - - - - Type of restore request. - - - - - The optional description for the job. - - - - - Describes the parameters for Select job types. - - - - - Describes the location where the restore job's output is stored. - - - - - Returns information about the RestoreObject response metadata. - The RestoreObject operation has a void result type. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - - Indicates the path in the provided S3 output location where Select results will be restored to. - - - - Routing Rule - - - - - A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the - /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might - process the error. - - - - - - Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event of an - error, you can can specify a different error code to return. - - - - - - A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages - in the /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you - might process the error. - - - - - The HTTP error code when the redirect is applied. In the event of an error, if the error code equals this value, then the specified redirect - is applied. Required when parent element Condition is specified and sibling KeyPrefixEquals is not specified. If both are specified, then - both must be true for the redirect to be applied. - - - - - - The object key name prefix when the redirect is applied. For example, to redirect requests for ExamplePage.html, the key prefix will be - ExamplePage.html. To redirect request for all pages with the prefix docs/, the key prefix will be /docs, which identifies all objects in the - docs/ folder. Required when the parent element Condition is specified and sibling HttpErrorCodeReturnedEquals is not specified. If both - conditions are specified, both must be true for the redirect to be applied. - - - - - - Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event - of an error, you can can specify a different error code to return. - - - - - Name of the host where requests will be redirected. - - - - - - The HTTP redirect code to use on the response. Not required if one of the siblings is present. - - - - - - Protocol to use (http, https) when redirecting requests. The default is the protocol that is used in the original request. - - - - - - The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix docs/ (objects in the - docs/ folder) to documents/, you can set a condition block with KeyPrefixEquals set to docs/ and in the Redirect set ReplaceKeyPrefixWith to - /documents. Not required if one of the siblings is present. Can be present only if ReplaceKeyWith is not provided. - - - - - - The specific object key to use in the redirect request. For example, redirect request to error.html. Not required if one of the sibling is - present. Can be present only if ReplaceKeyPrefixWith is not provided. - - - - - - Represents an access control list (ACL) for S3. An AccessControlList is represented by an Owner, - and a List of Grants, where each Grant is a Grantee and a Permission. - - - - Each bucket and object in Amazon S3 has an ACL that defines its access control policy. - When a request is made, Amazon S3 authenticates the request using its standard - authentication procedure and then checks the ACL to verify the sender was granted access - to the bucket or object. If the sender is approved, the request proceeds. - Otherwise, Amazon S3 returns an error. - - - An ACL is a list of grants. A grant consists of one grantee and one permission. - ACLs only grant permissions; they do not deny them. - - - For convenience, some commonly used Access Control Lists are defined in - S3CannedACL. - - - Note: BucketName and object ACLs are completely independent; an object does not inherit the ACL - from its bucket. For example, if you create a bucket and grant write access to another user, - you will not be able to access the user's objects unless the user explicitly grants access. - This also applies if you grant anonymous write access to a bucket. Only the user "anonymous" - will be able to access objects the user created unless permission is explicitly granted to - the bucket owner. - - - Important: We highly recommend that you do not grant the anonymous group write access to your - buckets as you will have no control over the objects others can store and their associated charges. - For more information, see Grantees and Permissions - - - - - Creates a S3Grant and adds it to the list of grants. - - The grantee for the grant. - The permission for the grantee. - - - - Removes a specific permission for the given grantee. - - The grantee - The permission for the grantee to remove - - - - Removes all permissions for the given grantee. - - - - - - The owner of the bucket or object. - - - - Every bucket and object in Amazon S3 has an owner, the user that - created the bucket or object. The owner of a bucket or object cannot - be changed. However, if the object is overwritten by another user - (deleted and rewritten), the new object will have a new owner. - - - Note: Even the owner is subject to the ACL. For example, if an owner - does not have Permission.READ access to an object, the owner cannot read - that object. However, the owner of an object always has write access to the - access control policy (Permission.WriteAcp) and can change the ACL to - read the object. - - - - - - Checks if Owner property is set. - - true if Owner property is set. - - - - A collection of grants. - - - - - Checks if Grants property is set. - - true if Grants property is set. - - - Bucket - Represents an S3 bucket, contains the name of the S3 bucket and the date that the bucket was created. - - - - - Date the bucket was created. - - - - - - The name of the bucket. - - - - - Logging Enabled - - - - - Specifies the bucket where you want Amazon S3 to store server access logs. You can have your logs delivered to any bucket that you own, - including the same bucket that is being logged. You can also configure multiple buckets to deliver their logs to the same target bucket. In - this case you should choose a different TargetPrefix for each source bucket so that the delivered log files can be distinguished by key. - - - - - A collection of grants. - - - - - This element lets you specify a prefix for the keys that the log files will be stored under. - - - - - Creates a S3Grant and adds it to the list of grants. - - The grantee for the grant. - The permission for the grantee. - - - - Removes a specific permission for the given grantee. - - The grantee - The permission for the grantee to remove - - - - Removes all permissions for the given grantee. - - - - - - An S3 bucket versioning configuration. - - - Contains the bucket's versioning status (Off, Enabled, Suspended) and whether an MFADelete - has been enabled for the bucket. - - - - - Versioning status for the bucket. - Accepted values: Off, Enabled, Suspended. - - - - - Checks if Status property is set - - true if Status property is set - - - - Specifies whether MFA Delete is enabled on this S3 Bucket. - - - If this property is set, please ensure that the - PutBucketVersioningRequest's MfaCodes property is set with - the Serial of and Token on the MFA device. - - - - - Checks if EnableMfaDelete property is set. - - true if Status property is set - - - - Describes the server-side encryption that will be applied to the restore results. - - - - - The server-side encryption algorithm used when storing job results in Amazon S3 (e.g., AES256, aws:kms). - - - - - Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by - AWS KMS will fail if not made via SSL or using SigV4. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at - http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version - - - - - If the encryption type is aws:kms, this optional value can be used to specify the encryption context for the restore results. - - - - Grant - - - - - The grantee details. - - - - - Specifies the permission given to the grantee. - - - - - Grantee - - - - - Type of grantee - - - - - - Screen name of the grantee. - - - - - - Email address of the grantee. - - - - - - The canonical user ID of the grantee. - - - - - - URI of the grantee group. - - - - - - Filter criteria that allows for event notification filtering based on an S3 Object's key name. - - - - - Gets and sets the filterRules property. - These are the filter rules for this filter. - - - - - Describes an S3 location that will receive the results of the restore request. - - - - - The name of the bucket where the restore results will be placed. - - - - - The prefix that is prepended to the restore results for this request. - - - - - The canned ACL to apply to the restore results. - - - - - A list of grants that control access to the staged results. - - - - - The tag-set that is applied to the restore results. - - - - - A map of metadata to store with the restore results in S3. - - - - - The class of storage used to store the restore results. - - - - - Represents an S3 Object. Contains all attributes that an S3 Object has. - For more information about S3 Objects refer: - - - - - - Any ETag set on the object. - - - - - The name of the bucket containing this object. - - - - - The key of the object. - - - - - The date and time the object was last modified. - - The date retrieved from S3 is in ISO8601 format. A GMT formatted date is passed back to the user. - - - - - - The owner of the object. - - - - - The size of the object. - - - - - The class of storage used to store the object. - - - - - - Represents a version of an object in an S3 Bucket. An S3 object version is an S3 object - that also has a version identifier, an indication of whether this is the latest version of the object - and whether it's a DeleteMarker or not. - - - - - Specifies whether the object is (true) or is not (false) the latest version of an object. - - - - - Version ID of an object. - - - - - If true, the object is a delete marker for a deleted object. - - - - - Specifies the byte range of the object to get the records from. A record is processed when its first byte is contained by the range. - - - - - Specifies the start of the byte range. This parameter is optional. Valid values: non-negative integers. The default value is 0. - - - - - Specifies the end of the byte range. This parameter is optional. Valid values: non-negative integers. The default value is one less than the size of the object being queried. - - - - - Request to filter the contents of an Amazon S3 object based on a simple Structured Query Language (SQL) statement. - - In the request, along with the SQL expression, you must also specify a data serialization format (JSON or CSV) of the object. - Amazon S3 uses this to parse object data into records, and returns only records - that match the specified SQL expression. You must also specify the data serialization format for the response. - - - - S3Select API Documentation - - - - - The S3 Bucket. - - - - - The Object Key. - - - - - The SSE Algorithm used to encrypt the object. - - - Server-Side Encryption (Using Customer-Provided Encryption Keys. - - - - - The SSE Customer Key. - - - Server-Side Encryption (Using Customer-Provided Encryption Keys. - - - - - The SSE Customer Key MD5. - - - Server-Side Encryption (Using Customer-Provided Encryption Keys. - - - - - The expression that is used to query the object. - - - - - The type of the provided expression (e.g., SQL). - - - - - Specifies if periodic request progress information should be enabled. - - - - - Describes the format of the data in the object that is being queried. - - - - - Describes the format of the data that you want Amazon S3 to return in response. - - - - - The byte range of the object to get the records from. - - - - - Contains the response Payload for the SelectObjectContent request - - - - - The Event Stream result of SelectObjectContent - - - - - Describes the parameters for Select job types. - - - - - Describes the serialization format of the object. - - - - - The type of the provided expression (e.g., SQL). - - - - - The expression that is used to query the object. - - - - - Describes how the results of the Select job are serialized. - - - - - ServerSideEncryptionByDefault class - - - - - Server-side encryption algorithm to use for the default encryption. - - - - - KMS master key ID to use for the default encryption. - This parameter is allowed if SSEAlgorithm is aws:kms. - - - - - ServerSideEncryptionConfiguration class - - - - - Container for information about a particular server-side encryption configuration rule. - - - - - ServerSideEncryptionRule class - - - - - Describes the default server-side encryption to apply to - new objects in the bucket. If Put Object request - does not specify any server-side encryption, - this default encryption will be applied. - - - - - SourceSelectionCriteria class - - - - - Container for filter information of selection of KMS Encrypted - S3 objects. The element is required if you include - SourceSelectionCriteria in the replication - configuration. - - - - - SSEKMS class - - - - - Specifies the ID of the AWS Key Management Service (KMS) - master encryption key to use for encrypting Inventory reports. - - - - - SseKmsEncryptedObjects class - - - - - The replication for KMS encrypted S3 objects is disabled if status is not Enabled. - - - - - SSES3 class - - - - - Class for StorageClassAnalysis - - - - - A container used to describe how data related to the storage class analysis should be exported. - - - - - Class for StorageClassAnalysisDataExport - - - - - The version of the output schema to use when exporting data. Must be V_1. - - - - - The place to store the data for an analysis. - - - - - Base class for responses that return a stream. - - - - - Disposes of all managed and unmanaged resources. - - - - - An open stream read from to get the data from S3. In order to - use this stream without leaking the underlying resource, please - wrap access to the stream within a using block. - - - - - The exception that is thrown when the size of a stream does not match it's expected size. - - - - - Gets and sets ExpectedSize property. - - - - - Gets and sets ActualSize property. - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - - Construct an instance of StreamSizeMismatchException. - - - - - - - - - - - - Tag is a key-value pair of metadata associated with an S3Object - - - - - Name of the tag. - - - - - Value of the tag. - - - - - Structure that contains list of Tags - - - - - TagSet - - - - - This class contains the configuration Amazon S3 uses to figure out what events you want to listen - and send the event to an Amazon SNS topic. - - The topic's policy must allow S3 to publish messages to it. The utility method - Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.AuthorizeS3ToPublish(string,string) - can be used to help setup the topic policy. - - - - - - Gets and set the Id property. The Id will be provided in the event content and can be used - to identify which configuration caused an event to fire. If the Id is not provided for the configuration, one will be generated. - - - - - Bucket event for which to send notifications. - - Topic configurations can now contain multiple events. This property is obsolete in favor of the Events property. - This property will always get or set the the zeroth element in the Events collection. - - - - - - Gets and sets the Topic property. Amazon SNS topic to which Amazon S3 will publish a message to report the - specified events for the bucket. - - The topic's policy must allow S3 to publish messages to it. The utility method - Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.AuthorizeS3ToPublish(string,string) - can be used to help setup the topic policy. - - - - - - The parameters to request upload of a part in a multipart upload operation. - - - - If PartSize is not specified then the rest of the content from the file - or stream will be sent to Amazon S3. - - - You must set either the FilePath or InputStream. If FilePath is set then the FilePosition - property must be set. - - - - The parameters to request upload of a part in a multipart upload operation. - - - - If PartSize is not specified then the rest of the content from the file - or stream will be sent to Amazon S3. - - - You must set either the FilePath or InputStream. If FilePath is set then the FilePosition - property must be set. - - - - - - Caller needs to set this to true when uploading the last part. This property only needs to be set - when using the AmazonS3EncryptionClient. - - - - - Input stream for the request; content for the request will be read from the stream. - - - - - The name of the bucket containing the object to receive the part. - - - - - The key of the object. - - - - - Part number of part being uploaded. - - - - - - The size of the part to be uploaded. - - - - - Checks if PartSize property is set. - - true if PartSize property is set. - - - - Upload ID identifying the multipart upload whose part is being uploaded. - - - - - - An MD5 digest for the part. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - Checks if ServerSideEncryptionCustomerProvidedKey property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Checks if ServerSideEncryptionCustomerProvidedKeyMD5 property is set. - - true if ServerSideEncryptionCustomerProvidedKey property is set. - - - - - Full path and name of a file from which the content for the part is retrieved. - - - For WinRT and Windows Phone this property must be in the form of "ms-appdata:///local/file.txt". - - - - - - Checks if the FilePath property is set. - - true if FilePath property is set. - - - - Position in the file specified by FilePath from which to retrieve the content of the part. - This field is required when a file path is specified. It is ignored when using the InputStream property. - - - - - If this value is set to true then a chunked encoding upload will be used for the request. - Default: true. - - - - - Checks if the FilePosition property is set. - - true if FilePosition property is set. - - - - Checks if the MD5Digest property is set. - - true if Md5Digest property is set. - - - - Attach a callback that will be called as data is being sent to the AWS Service. - - - - - Overriden to turn off sending SHA256 header. - - - - - Overriden to turn on Expect 100 continue. - - - - - Confirms that the requester knows that she or he will be charged for the list objects request. - Bucket owners need not specify this parameter in their requests. - - - - - Checks to see if RequetsPayer is set. - - true, if RequestPayer property is set. - - - - Returns information about the UploadPart response and response metadata. - - - - - The Server-side encryption algorithm used when storing this object in S3. - - - - - - Entity tag for the uploaded object. - - - - - - Gets and sets the part number specified for the part upload. This is needed when - completing the multipart upload. - - - - - If present, indicates that the requester was successfully charged for the request. - - - - - Checks to see if RequestCharged is set. - - true, if RequestCharged property is set. - - - Website Configuration - - - - - The ErrorDocument value, an object key name to use when a 4XX class error occurs. - - - - - - This value is a suffix that is appended to a request that is for a "directory" - on the website endpoint (e.g. if the suffix is index.html and - you make a request to samplebucket/images/ the data that - is returned will be for the object with the key name - images/index.html) - - - The suffix must not be empty and must not include a slash - character. - - - - - - Container for redirect information where all requests will be redirect - to. You can redirect requests to another host, to another page, or with - another protocol. In the event of an error, you can can specify a - different error code to return. . - - - - - The list of routing rules that can be used for configuring redirects if certain conditions are meet. - - - - - Arguments containing event details for an in-flight transfer. - - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The number of bytes transferred since last event - The number of bytes transferred - The total number of bytes to be transferred - - - - Gets the percentage of transfer completed - - - - - Gets the number of bytes transferred since last event - - - - - Gets the number of bytes transferred - - - - - Gets the total number of bytes to be transferred - - - - - Returns a string representation of this object - - - - - - AmazonS3 exception. - Thrown when DeleteObjects returns successfully, but some of the objects - were not deleted. - - - - - Gets and sets the ErrorResponse property. - The DeleteObjectsErrorResponse associated with this exception. - - - - - Constructs an instance of DeleteObjectsException - - - - - - The file format used when exporting data to Amazon S3. - - - - - CSV file format. - - - - - Construct instance of AnalyticsS3ExportFileFormat. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to an AnalyticsS3ExportFileFormat. - - - - - - - Represents the accelerate status for a bucket. - - - - - Bucket acceleration is enabled. - - - - - Bucket acceleration is suspended. - - - - - Construct instance of BucketAccelerateStatus. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to an BucketAccelerateStatus - - - - - - - The status of the delete marker replication. - - - - - Delete marker replication is enabled. - - - - - Delete marker replication is disabled. - - - - - Construct instance of DeleteMarkerReplicationStatus. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to a DeleteMarkerReplicationStatus - - - - - - - A list of all possible CannedACLs that can be used - for S3 Buckets or S3 Objects. For more information about CannedACLs, refer to - . - - - - - Owner gets FULL_CONTROL. - No one else has access rights (default). - - - - - Owner gets FULL_CONTROL. - No one else has access rights (default). - - - - - Owner gets FULL_CONTROL and the anonymous principal is granted READ access. - If this policy is used on an object, it can be read from a browser with no authentication. - - - - - Owner gets FULL_CONTROL, the anonymous principal is granted READ and WRITE access. - This can be a useful policy to apply to a bucket, but is generally not recommended. - - - - - Owner gets FULL_CONTROL, and any principal authenticated as a registered Amazon - S3 user is granted READ access. - - - - - Owner gets FULL_CONTROL. Amazon EC2 gets READ access to GET an - Amazon Machine Image (AMI) bundle from Amazon S3. - - - - - Object Owner gets FULL_CONTROL, Bucket Owner gets READ - This ACL applies only to objects and is equivalent to private when used with PUT Bucket. - You use this ACL to let someone other than the bucket owner write content (get full control) - in the bucket but still grant the bucket owner read access to the objects. - - - - - Object Owner gets FULL_CONTROL, Bucket Owner gets FULL_CONTROL. - This ACL applies only to objects and is equivalent to private when used with PUT Bucket. - You use this ACL to let someone other than the bucket owner write content (get full control) - in the bucket but still grant the bucket owner full rights over the objects. - - - - - The LogDelivery group gets WRITE and READ_ACP permissions on the bucket. - - - - - Construct instance of S3CannedACL. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to an S3CannedACL - - - - - - - A list of all possible S3 Bucket region possibilities. For - more information, refer to - . - - - - - Specifies that the S3 Bucket should use US locality. - This is the default value. - - - - - Specifies that the S3 Bucket should use US-EAST-2 locality. - - - - - Specifies that the S3 Bucket should use EU locality which defaults to EU-WEST-1 - - - - - Specifies that the S3 Bucket should use the EU-NORTH-1 locality. - - - - - Specifies that the S3 Bucket should use the EU-WEST-1 locality. - - - - - Specifies that the S3 Bucket should use the EU-WEST-2 locality. - - - - - Specifies that the S3 Bucket should use the EU-WEST-3 locality. - - - - - Specifies that the S3 Bucket should use the EU-CENTRAL-1 locality. - - - - - Specifies that the S3 Bucket should use US-WEST-1 locality. - - - - - Specifies that the S3 Bucket should use US-WEST-2 locality. - - - - - Specifies that the S3 Bucket should use US-GOV-EAST-1 locality. - - - - - Specifies that the S3 Bucket should use US-GOV-WEST-1 locality. - - - - - Specifies that the S3 Bucket should use the AP-EAST-1 locality. - - - - - Specifies that the S3 Bucket should use the AP-SOUTHEAST-1 locality. - - - - - Specifies that the S3 Bucket should use the AP-SOUTHEAST-2 locality. - - - - - Specifies that the S3 Bucket should use the AP-NORTHEAST-1 locality. - - - - - Specifies that the S3 Bucket should use the AP-NORTHEAST-2 locality. - - - - - Specifies that the S3 Bucket should use the AP-NORTHEAST-3 locality. - - - - - Specifies that the S3 Bucket should use the AP-SOUTH-1 locality. - - - - - Specifies that the S3 Bucket should use the SA-EAST-1 locality. - - - - - Specifies that the S3 Bucket should use CN-NORTH-1 locality. - - - - - Specifies that the S3 Bucket should use CN-NORTHWEST-1 locality. - - - - - Specifies that the S3 Bucket should use CA-CENTRAL-1 locality. - - - - - Specifies that the S3 Bucket should use US-WEST-1 locality. - - - - - Specifies that the S3 Bucket should use CN-NORTH-1 locality. - - - - - Specifies that the S3 Bucket should use US-GOV-WEST-1 locality. - - - - - Construct instance of S3Region. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to the S3Region class - - - - - - - A list of all ACL permissions. For more information, refer to - . - - - - - When applied to a bucket, grants permission to list the bucket. - When applied to an object, this grants permission to read the - object data and/or metadata. - - - - - When applied to a bucket, grants permission to create, overwrite, - and delete any object in the bucket. This permission is not - supported for objects. - - - - - Grants permission to read the ACL for the applicable bucket or object. - The owner of a bucket or object always has this permission implicitly. - - - - - Gives permission to overwrite the ACP for the applicable bucket or object. - The owner of a bucket or object always has this permission implicitly. - Granting this permission is equivalent to granting FULL_CONTROL because - the grant recipient can make any changes to the ACP. - - - - - Provides READ, WRITE, READ_ACP, and WRITE_ACP permissions. - It does not convey additional rights and is provided only for convenience. - - - - - Gives permission to restore an object that is currently stored in Amazon Glacier - for archival storage. - - - - - Construct S3Permission. - - - - - - Construct instance of S3Permission. It is not intended for this constructor to be called. Instead users should call the FindValue. - - - - - - - Gets and sets the HeaderName property. - - - - - Finds the constant for the unique value. - - - - - - - Converts the string to an S3Permission - - - - - - - An enumeration of all Metadata directives that - can be used for the CopyObject operation. - - - - - Specifies that the metadata is copied from the source object. - - - - - Specifies that the metadata is replaced with metadata provided in the request. - All original metadata is replaced by the metadata you specify. - - - - - An enumeration of all protocols that the pre-signed - URL can be created against. - - - - - https protocol will be used in the pre-signed URL. - - - - - http protocol will be used in the pre-signed URL. - - - - - An enumeration of supported HTTP verbs - - - - - The GET HTTP verb. - - - - - The HEAD HTTP verb. - - - - - The PUT HTTP verb. - - - - - The DELETE HTTP verb. - - - - - S3 Storage Class Definitions - - - - - The STANDARD storage class, which is the default - storage class for S3. - - Durability 99.999999999%; Availability 99.99% over a given year. - - - - - REDUCED_REDUNDANCY provides the same availability as standard, but at a lower durability. - - Durability 99.99%; Availability 99.99% over a given year. - - - - - The GLACIER storage is for object that are stored in Amazon Glacier. - This storage class is for objects that are for archival purpose and - get operations are rare. - - Durability 99.999999999% - - - - - The STANDARD_IA storage is for infrequently accessed objects. - This storage class is for objects that are long-lived and less frequently accessed, - like backups and older data. - - Durability 99.999999999%; Availability 99.9% over a given year. - - - - - The ONEZONE_IA storage is for infrequently accessed objects. It is similiar to STANDARD_IA, but - only stores object data within one Availablity Zone in a given region. - - Durability 99.999999999%; Availability 99% over a given year. - - - - - IntelligentTiering makes it easy to lower your overall cost of storage by automatically placing data in the storage - class that best matches the access patterns for the storage. With IntelligentTiering, you don’t need to define - and manage individual policies for lifecycle data management or write code to transition objects - between storage classes. Instead, you can use IntelligentTiering to manage transitions between Standard and - S-IA without writing any application code. IntelligentTiering also manages transitions automatically to - Glacier for long term archive in addition to S3 storage classes. - - - - - S3 Glacier Deep Archive provides secure, durable object storage class for long term data archival. - It is the ideal storage class to make an archival, durable copy of data that rarely, if ever, needs to be accessed. - It can be used as an offline backup for their most important data assets and to meet long-term retention needs. - - - - - Construct an instance of S3StorageClass. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to S3StorageClass. - - - - - - - The constants for the known event names used by S3 notification. S3 might add new - events before the SDK is updated. In which case the names listed in the S3 documentation - will work as well as these constants. - - - - - An event that says an object has been lost in the reduced redundancy storage. - - - - - A list of all server-side encryption methods for customer provided encryption keys. - - - - - No server side encryption to be used. - - - - - Use AES 256 server side encryption. - - - - - Constructs an instance of ServerSideEncryptionCustomerMethod. - - - - - - Finds the constant for the unique value. - - - - - - - Converts string to ServerSideEncryptionCustomerMethod. - - - - - - - A list of all server-side encryption methods. - - - - - No server side encryption to be used. - - - - - Use AES 256 server side encryption. - - - - - Use AWS Key Management Service for server side encryption. - - - - - Construct instance of ServerSideEncryptionMethod. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to ServerSideEncryptionCustomerMethod. - - - - - - - A list of all grantee types. - - - - - The predefined group. - - - - - The email address of an AWS account - - - - - The canonical user ID of an AWS account - - - - - Construct an instance of GranteeType. - - - - - - Finds the constant for the unique value. - - - - - - - Convert a string to GranteeType. - - - - - - - A list of all lifecycle statuses. - - - - - The rule is enabled. - - - - - The rule is disabled. - - - - - Constructs an instance LifecycleRuleStatus. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to LifecycleRuleStatus. - - - - - - - A list of all version statuses. - - - - - The rule is off. - - - - - The rule is suspended. - - - - - The rule is enabled. - - - - - Construct an instance of VersionStatus. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to VersionStatus. - - - - - - - A list of all encoding types. - - - - - Url encoding. - - - - - Constructs intance of EncodingType - - - - - - Finds the constant for the unique value. - - - - - - - Converts string to EncodingType - - - - - - - The bucket event for which to send notifications. - - - - - The event encapsulates all the object create events - - - - - Event for put operations - - - - - Event for post operations - - - - - Event for copy operations - - - - - Event for completing a multi part upload - - - - - This event encapsulates all the object removed events - - - - - Event for object removed, delete operation. - - - - - Event for object removed, delete marker created operation. - - - - - Event for objects stored in reduced redundancy and S3 detects the object is lost - - - - - Event for all object restore - - - - - Event for restore post operations. - - - - - Event for when object restore is completed. - - - - - Event for replication of all - - - - - Event for operation failed replication - - - - - Evemt for replication operation not tracked - - - - - Event for replication operation missed threshold - - - - - Event for operation replicated after threshold - - - - - Constructs instance of EventType. - - - - - - Finds the constant for the unique value. - - - - - - - Convert string to EventType. - - - - - - - Compares if the ConstantClass instances are equals. - - - - - - - Compares if the ConstantClass instances are equals. This is ovewritten to handle the - discrepancy with S3 events coming from Lambda that don't have the prefix "s3:". - - - - - - - A list of all Inventory Formats. - - - - - CSV inventory format - - - - - ORC inventory format - - - - - Parquet inventory format - - - - - Construct instance of InventoryFormat. - - - - - - Finds the constant for the unique value. - - The string representation of the InventoryFormat. - The InventoryFormat object for that string. - - - - Convert string to InventoryFormat. - - - - - - - A list of inventory included object versions. - - - - - All Inventory Included Object Versions - - - - - Current Inventory Included Object Versions - - - - - Construct instance of InventoryIncludedObjectVersions. - - - - - - Finds the constant for the unique value. - - The string representation of the InventoryIncludedObjectVersions. - The InventoryIncludedObjectVersions object for that string. - - - - Convert string to InventoryIncludedObjectVersions. - - - - - - - A list of inventory frequencies. - - - - - Daily Inventory Frequency - - - - - Weekly Inventory Frequency - - - - - Construct instance of InventoryFrequency. - - - - - - Finds the constant for the unique value. - - The string representation of the InventoryFrequency. - The InventoryFrequency object for that string. - - - - Convert string to InventoryFrequency. - - - - - - - A list of inventory optional fields. - - - - - InventoryOptionalField for Size - - - - - InventoryOptionalField for LastModifiedDate - - - - - InventoryOptionalField for StorageClass - - - - - InventoryOptionalField for ETag - - - - - InventoryOptionalField for IsMultipartUploaded - - - - - InventoryOptionalField for ReplicationStatus - - - - - InventoryOptionalField for EncryptionStatus - - - - - InventoryOptionalField for ObjectLockRetainUntilDate - - - - - InventoryOptionalField for ObjectLockMode - - - - - InventoryOptionalField for ObjectLockLegalHoldStatus - - - - - InventoryOptionalField for IntelligentTieringAccessTier - - - - - Construct instance of InventoryOptionalField. - - - - - - Finds the constant for the unique value. - - The string representation of the InventoryOptionalField. - The InventoryIncludedObjectVersions object for that string. - - - - Convert string to InventoryOptionalField. - - - - - - - The status of the replication job associated with this source object. - - - - - The object is pending replication. - - - - - The object has been replicated. - - - - - The object was created as a result of replication. - - - - - The object replication has failed due to a customer-attributable reason, and the replication will not be attempted again. - - - - - Construct instance of ReplicationStatus. - - - - - - Finds the constant for the unique value. - - The string representation of the ReplicationStatus. - The ReplicationStatus object for that string. - - - - Convert string to ReplicationStatus. - - - - - - - Whether a replication rule is applied or ignored. - - - - - The rule will be applied. - - - - - The rule will be ignored. - - - - - Construct instance of ReplicationRuleStatus - - - - - - Finds the constant for the unique value. - - The string representation of the ReplicationRuleStatus. - The ReplicationRuleStatus object for that string. - - - - Convert string to ReplicationRuleStatus. - - - - - - - Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request. - - - - - The object tag-set is copied from the source object. - - - - - The object tag-set is replaced with tag-set provided in the request. - - - - - Construct instance of TaggingDirective - - - - - Finds the constant for the unique value. - - The string representation of the TaggingDirective. - The TaggingDirective object for that string. - - - - Convert string to TaggingDirective. - - - - - All enumerations type for retrieval tier for Glacier restore. - - - - - Standard Tier for Glacier restore. - - - - - Bulk Tier for Glacier restore. - - - - - Expedited Tier for Glacier restore. - - - - - Construct instance of RestoreObjectRequestGlacierJobTier - - - - - - Finds the constant for the unique value. - - The string representation of the RestoreObjectRequestGlacierJobTier. - The RestoreObjectRequestGlacierJobTier object for that string. - - - - Convert string to RestoreObjectRequestGlacierJobTier. - - - - - - - The version of the output schema to use when exporting data. - - - - - The schema output version V_1. - - - - - Construct instance of StorageClassAnalysisSchemaVersion - - - - - - Finds the constant for the unique value. - - The string representation of the StorageClassAnalysisSchemaVersion. - The StorageClassAnalysisSchemaVersion object for that string. - - - - Convert string to StorageClassAnalysisSchemaVersion. - - - - - - - Acknowledges that requester pays for the operation. - - - - - Requester pays for the operation. - - - - - Finds the RequestPayer instance for the string value. - - - - - Converts string to RequestPayer instance - - - - - The response from S3 that it confirms that requester pays. - - - - - S3 acknowledges that the requester pays. - - - - - Finds the RequestCharged instance for the string value - - - - - converts the string to RequestCharged instance - - - - - The override value for the owner of the replica object. - - - - - Overrides destination bucket's owner. - - - - - Finds the OwnerOverride instance for the string value - - - - - converts the string to OwnerOverride instance - - - - - The replication for KMS encrypted S3 objects is disabled if status is not Enabled. - - - - - The replication for KMS encrypted S3 objects is enabled. - - - - - The replication for KMS encrypted S3 objects is disabled. - - - - - - - - - - Finds the SseKmsEncryptedObjectsStatus instance for the string value - - - - - Converts the string to SseKmsEncryptedObjectsStatus instance - - - - - Specify how headers will be handled. - - - - - Headers will be usable in SELECT clause. - - - - - Headers will be skipped - - - - - No header is present. - - - - - Finds the FileHeaderInfo instance for the string value - - - - - - - Converts the string to FileHeaderInfo instance - - - - - Specifies whether existing object replication is enabled. - - - - - Enable the replication of existing objects - - - - - Disable the replication of existing objects - - - - - Finds the ExistingObjectReplicationStatus instance for the string value - - - - - - - Converts the string to ExistingObjectReplicationStatus instance - - - - - Describes when fields in output should be surrounded with quotes. - - - - - Specifies that fields in output should always be surrounded in quotes. - - - - - Specifies that fields in output should be surrounded in quotes as necessary. - - - - - Finds the QuoteFields instance for the string value - - string value that maps to QuoteFields enum - QuoteFields enum - - - - Converts the string to QuoteFields instance - - - - - Type of the expression provided in the Expression member. - - - - - SQL expression - - - - - Finds the ExpressionType instance for the string value - - string value that maps to ExpressionType enum - ExpressionType enum - - - - Converts the string to ExpressionType instance - - - - - Indicates what type of job is being initiated. - - - - - Finds the RestoreRequestType instance for the string value - - - - - Converts the string to RestoreRequestType instance - - - - - The type of JSON. - - - - - Finds the JsonType instance for the string value - - - - - Converts the string to JsonType instance - - - - - Specifies object's compression format. - - - - - Finds the CompressionType instance for the string value - - - - - Converts the string to CompressionType instance - - - - - The type of ObjectLockEnabled - - - - - Finds the ObjectLockEnabled instance for the string value - - - - - Converts the string to ObjectLockEnabled instance - - - - - The type of ObjectLockLegalHoldStatus - - - - - Finds the ObjectLockLegalHoldStatus instance for the string value - - - - - Converts the string to ObjectLockLegalHoldStatus instance - - - - - The type of ObjectLockRetentionMode - - - - - Finds the ObjectLockRetentionMode instance for the string value - - - - - Converts the string to ObjectLockRetentionMode instance - - - - - The type of ObjectLockMode - - - - - Finds the ObjectLockMode instance for the string value - - - - - Converts the string to ObjectLockMode instance - - - - - Specifies whether the replication time is enabled. - - - - - Replication time is enabled. - - - - - Replication time is disabled. - - - - - Finds the ReplicationTimeStatus instance for the string value - - - - - - - Converts the string to ReplicationTimeStatus instance - - - - - - Specifies whether the replication metrics are enabled. - - - - - Replication metrics are enabled. - - - - - Replication metrics are disabled. - - - - - Finds the MetricsStatus instance for the string value - - - - - - - Converts the string to MetricsStatus instance - - - - - - The base class for requests that return Amazon S3 objects. - - - - - Gets or sets the name of the bucket. - - - The name of the bucket. - - - - - Gets whether or not the bucket name is set. - - - A value of true if the bucket name is set. - Returns false if otherwise. - - - - - Gets or sets the key under which the Amazon S3 object is stored. - - - The key under which the Amazon S3 object is stored. - - - - - Gets whether or not the key property is set. - - - A value of true if key property is set. - Returns false if otherwise. - - - - - Gets or sets the version ID of the Amazon S3 object. - - - The version ID of the Amazon S3 object. - - - - - Checks if VersionId property is set. - - true if VersionId property is set. - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or - ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Gets or sets the ModifiedSinceDate property. - - - The ModifiedSinceDate property. - - - - - Gets or sets the ModifiedSinceDate property. - - - The ModifiedSinceDate property. - - - - - - This property is deprecated. Setting this property results in non-UTC DateTimes not - being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or - UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, - the latest assignment to either one of the two property is reflected in the value of both. - UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime - to it results in the wrong timestamp being passed to the service. - - Gets or sets the UnmodifiedSinceDate property. - - - The UnmodifiedSinceDate property. - - - - - Gets or sets the UnmodifiedSinceDate property. - - - The UnmodifiedSinceDate property. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The base64-encoded encryption key for Amazon S3 to use to decrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - The base class TransferUtility request classes. - - - - - Waits for all of the tasks to complete or till any task fails or is canceled. - - - - - Waits for all of the tasks to complete or till any task fails or is canceled. - - - - - Returns the amount of bytes remaining that need to be pulled down from S3. - - The fully qualified path of the file. - - - - - The command to manage an upload using the S3 multipart API. - - - - - Initializes a new instance of the class. - - The s3 client. - The config object that has the number of threads to use. - The file transporter request. - - - - This command is for doing regular PutObject requests. - - - - - This command files all the files that meets the criteria specified in the TransferUtilityUploadDirectoryRequest request - and uploads them. - - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - - Gets the Amazon S3 client used for making calls into Amazon S3. - - - The Amazon S3 client used for making calls into Amazon S3. - - - - - Uploads the specified file. - The object key is derived from the file's name. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the specified file. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the contents of the specified stream. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The stream to read to obtain the content to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the stream to. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the file or stream specified by the request. - To track the progress of the upload, - add an event listener to the request's UploadProgressEvent. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - Contains all the parameters required to upload to Amazon S3. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Aborts the multipart uploads that were initiated before the specified date. - - - The name of the bucket containing multipart uploads. - - - The date before which the multipart uploads were initiated. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the content from Amazon S3 and writes it to the specified file. - If the key is not specified in the request parameter, - the file name will used as the key name. - - - Contains all the parameters required to download an Amazon S3 object. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Returns a stream from which the caller can read the content from the specified - Amazon S3 bucket and key. - The caller of this method is responsible for closing the stream. - - - The name of the bucket. - - - The object key. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Returns a stream to read the contents from Amazon S3 as - specified by the TransferUtilityOpenStreamRequest. - The caller of this method is responsible for closing the stream. - - - Contains all the parameters required for the OpenStream operation. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - A pattern used to identify the files from the source directory to upload. - - - A search option that specifies whether to recursively search for files to upload - in subdirectories. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The request that contains all the parameters required to upload a directory. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by s3Directory. - - - The name of the bucket containing the Amazon S3 objects to download. - - - The directory in Amazon S3 to download. - - - The local directory to download the objects to. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by the S3Directory - property of the passed in TransferUtilityDownloadDirectoryRequest object. - - - Contains all the parameters required to download objects from Amazon S3 - into a local directory. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the content from Amazon S3 and writes it to the specified file. - - - The file path where the content from Amazon S3 will be written to. - - - The name of the bucket containing the Amazon S3 object to download. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - A pattern used to identify the files from the source directory to upload. - - - A search option that specifies whether to recursively search for files to upload - in subdirectories. - - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The request that contains all the parameters required to upload a directory. - - - - - Uploads the specified file. - The object key is derived from the file's name. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - - - Uploads the specified file. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - The key under which the Amazon S3 object is stored. - - - - - Uploads the contents of the specified stream. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The stream to read to obtain the content to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the stream to. - - - The key under which the Amazon S3 object is stored. - - - - - Uploads the file or stream specified by the request. - To track the progress of the upload, - add an event listener to the request's UploadProgressEvent. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - Contains all the parameters required to upload to Amazon S3. - - - - - Returns a stream from which the caller can read the content from the specified - Amazon S3 bucket and key. - The caller of this method is responsible for closing the stream. - - - The name of the bucket. - - - The object key. - - - A stream of the contents from the specified Amazon S3 and key. - - - - - Returns a stream to read the contents from Amazon S3 as - specified by the TransferUtilityOpenStreamRequest. - The caller of this method is responsible for closing the stream. - - - Contains all the parameters required to open a stream to an S3 object. - - - A stream of the contents from Amazon S3. - - - - - Downloads the content from Amazon S3 and writes it to the specified file. - - - The file path where the content from Amazon S3 will be written to. - - - The name of the bucket containing the Amazon S3 object to download. - - - The key under which the Amazon S3 object is stored. - - - - - Downloads the content from Amazon S3 and writes it to the specified file. - If the key is not specified in the request parameter, - the file name will used as the key name. - - - Contains all the parameters required to download an Amazon S3 object. - - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by s3Directory. - - - The name of the bucket containing the Amazon S3 objects to download. - - - The directory in Amazon S3 to download. - - - The local directory to download the objects to. - - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by the S3Directory - property of the passed in TransferUtilityDownloadDirectoryRequest object. - - - Contains all the parameters required to download objects from Amazon S3 - into a local directory. - - - - - Aborts the multipart uploads that were initiated before the specified date. - - - The name of the bucket containing multipart uploads. - - - The date before which the multipart uploads were initiated. - - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - Provides a high level utility for managing transfers to and from Amazon S3. - - - TransferUtility provides a simple API for - uploading content to and downloading content - from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to - achieve enhanced throughput, performance, and reliability. - - - When uploading large files by specifying file paths instead of a stream, - TransferUtility uses multiple threads to upload - multiple parts of a single upload at once. When dealing with large content - sizes and high bandwidth, this can increase throughput significantly. - - - - - Transfers are stored in memory. If the application is restarted, - previous transfers are no longer accessible. In this situation, if necessary, - you should clean up any multipart uploads that are incomplete. - - - - - - Constructs a new class. - - - The AWS Access Key ID. - - - The AWS Secret Access Key. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new class. - - - The AWS Access Key ID. - - - The AWS Secret Access Key. - - - The region to configure the transfer utility for. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new instance of the class. - - - The AWS Access Key ID. - - - The AWS Secret Access Key. - - - Specifies advanced settings. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new instance of the class. - - - The AWS Access Key ID. - - - The AWS Secret Access Key. - - - The region to configure the transfer utility for. - - - Specifies advanced settings. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new instance of the class. - - - The Amazon S3 client. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Initializes a new instance of the class. - - - The Amazon S3 client. - - - Specifies advanced configuration settings for . - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new class. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new class. - - - The region to configure the transfer utility for. - - - - If a Timeout needs to be specified, use the constructor which takes an as a paramater. - Use an instance of constructed with an object with the Timeout specified. - - - - - - Constructs a new class. - - - Specifies advanced configuration settings for . - - - - - - - Gets the Amazon S3 client used for making calls into Amazon S3. - - - The Amazon S3 client used for making calls into Amazon S3. - - - - - Implements the Dispose pattern - - Whether this object is being disposed via a call to Dispose - or garbage collected. - - - - Disposes of all managed and unmanaged resources. - - - - - Uploads the specified file. - The object key is derived from the file's name. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the specified file. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the contents of the specified stream. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - The stream to read to obtain the content to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the stream to. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads the file or stream specified by the request. - To track the progress of the upload, - add an event listener to the request's UploadProgressEvent. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. - - - - Contains all the parameters required to upload to Amazon S3. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Aborts the multipart uploads that were initiated before the specified date. - - - The name of the bucket containing multipart uploads. - - - The date before which the multipart uploads were initiated. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the content from Amazon S3 and writes it to the specified file. - If the key is not specified in the request parameter, - the file name will used as the key name. - - - Contains all the parameters required to download an Amazon S3 object. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Returns a stream from which the caller can read the content from the specified - Amazon S3 bucket and key. - The caller of this method is responsible for closing the stream. - - - The name of the bucket. - - - The object key. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Returns a stream to read the contents from Amazon S3 as - specified by the TransferUtilityOpenStreamRequest. - The caller of this method is responsible for closing the stream. - - - Contains all the parameters required for the OpenStream operation. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - A pattern used to identify the files from the source directory to upload. - - - A search option that specifies whether to recursively search for files to upload - in subdirectories. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The request that contains all the parameters required to upload a directory. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by s3Directory. - - - The name of the bucket containing the Amazon S3 objects to download. - - - The directory in Amazon S3 to download. - - - The local directory to download the objects to. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by the S3Directory - property of the passed in TransferUtilityDownloadDirectoryRequest object. - - - Contains all the parameters required to download objects from Amazon S3 - into a local directory. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Downloads the content from Amazon S3 and writes it to the specified file. - - - The file path where the content from Amazon S3 will be written to. - - - The name of the bucket containing the Amazon S3 object to download. - - - The key under which the Amazon S3 object is stored. - - - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - The task object representing the asynchronous operation. - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The source directory, that is, the directory containing the files to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. - - - A pattern used to identify the files from the source directory to upload. - - - A search option that specifies whether to recursively search for files to upload - in subdirectories. - - - - - Uploads files from a specified directory. - The object key is derived from the file names - inside the directory. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The request that contains all the parameters required to upload a directory. - - - - - Uploads the specified file. - The object key is derived from the file's name. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - - - Uploads the specified file. - Multiple threads are used to read the file and perform multiple uploads in parallel. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The file path of the file to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. - - - The key under which the Amazon S3 object is stored. - - - - - Uploads the contents of the specified stream. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - The stream to read to obtain the content to upload. - - - The target Amazon S3 bucket, that is, the name of the bucket to upload the stream to. - - - The key under which the Amazon S3 object is stored. - - - - - Uploads the file or stream specified by the request. - To track the progress of the upload, - add an event listener to the request's UploadProgressEvent. - For large uploads, the file will be divided and uploaded in parts using - Amazon S3's multipart API. The parts will be reassembled as one object in - Amazon S3. - - - - If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. - If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. - Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able - to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, - you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. - - - - Contains all the parameters required to upload to Amazon S3. - - - - - Returns a stream from which the caller can read the content from the specified - Amazon S3 bucket and key. - The caller of this method is responsible for closing the stream. - - - The name of the bucket. - - - The object key. - - - A stream of the contents from the specified Amazon S3 and key. - - - - - Returns a stream to read the contents from Amazon S3 as - specified by the TransferUtilityOpenStreamRequest. - The caller of this method is responsible for closing the stream. - - - Contains all the parameters required to open a stream to an S3 object. - - - A stream of the contents from Amazon S3. - - - - - Downloads the content from Amazon S3 and writes it to the specified file. - - - The file path where the content from Amazon S3 will be written to. - - - The name of the bucket containing the Amazon S3 object to download. - - - The key under which the Amazon S3 object is stored. - - - - - Downloads the content from Amazon S3 and writes it to the specified file. - If the key is not specified in the request parameter, - the file name will used as the key name. - - - Contains all the parameters required to download an Amazon S3 object. - - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by s3Directory. - - - The name of the bucket containing the Amazon S3 objects to download. - - - The directory in Amazon S3 to download. - - - The local directory to download the objects to. - - - - - Downloads the objects in Amazon S3 that have a key that starts with the value - specified by the S3Directory - property of the passed in TransferUtilityDownloadDirectoryRequest object. - - - Contains all the parameters required to download objects from Amazon S3 - into a local directory. - - - - - Aborts the multipart uploads that were initiated before the specified date. - - - The name of the bucket containing multipart uploads. - - - The date before which the multipart uploads were initiated. - - - - - - Provides configuration options for how processes requests. - - - The best configuration settings depend on network - configuration, latency and bandwidth. - The default configuration settings are suitable - for most applications, but this class enables developers to experiment with - different configurations and tune transfer manager performance. - - - - - - Default constructor. - - - - - Gets or sets the minimum part size for upload parts in bytes. The default is 16 MB. - Decreasing the minimum part size causes - multipart uploads to be split into a larger number - of smaller parts. Setting this value too low has a negative effect - on transfer speeds, causing extra latency and network - communication for each part. - - - - - This property determines how many active threads - or the number of concurrent asynchronous web requests - will be used to upload/download the file . - The default value is 10. - - - A value less than or equal to 0 will be silently ignored. - - - - - Gets or sets the number of executing threads. - This property determines how many active threads will be used to upload - the file. The default value is 10 threads. - - - A value less than or equal to 0 will be silently ignored. - - - - - Request object for downloading a directory with the TransferUtility. - - - - - Gets or sets the name of the bucket. - - - The name of the bucket. - - - - - Gets whether or not the bucket name is set. - - - A value of true if the bucket name is set. - Otherwise, returns false. - - - - - Gets or sets the local directory where objects from Amazon S3 will be downloaded. - If the directory doesn't exist, it will be created. - - - The local directory where objects from Amazon S3 will be downloaded. - - - - - Gets whether or not the LocalDirectory property is set. - - - A value of true if LocalDirectory property is set. - Otherwise, returns false. - - - - - Gets or sets the Amazon S3 directory to download from. - This is translated to a key prefix; keys that have this prefix will be - downloaded. - - - - - Gets whether or not the S3Directory property is set. - - - A value of true if S3Directory property is set. - Otherwise, returns false. - - - - - - This property is deprecated. This property doesn't honor the DateTimeKind, please - use ModifiedSinceDateUtc instead. - - Gets or sets the ModifiedSinceDate property. - Only objects that have been modified since this date will be - downloaded. - - - The ModifiedSinceDate property. - - - - - Checks if ModifiedSinceDate property is set. - - A value of true if ModifiedSinceDate property is set. - Otherwise, returns false. - - - - Gets or sets the ModifiedSinceDateUtc property. - Only objects that have been modified since this date will be - downloaded. - - - The ModifiedSinceDateUtc property. - - - - - Checks if ModifiedSinceDateUtc property is set. - - A value of true if ModifiedSinceDateUtc property is set. - Otherwise, returns false. - - - - - This property is deprecated. This property doesn't honor the DateTimeKind, please - use UnmodifiedSinceDateUtc instead. - - Gets or sets the UnmodifiedSinceDate property. - Only objects that have not been modified since this date will be downloaded. - - - The UnmodifiedSinceDate property. - - - - - Checks if UnmodifiedSinceDate property is set. - - true if UnmodifiedSinceDate property is set. - - - - Gets or sets the UnmodifiedSinceDateUtc property. - Only objects that have not been modified since this date will be downloaded. - - - The UnmodifiedSinceDateUtc property. - - - - - Checks if UnmodifiedSinceDateUtc property is set. - - true if UnmodifiedSinceDateUtc property is set. - - - - Gets or sets the DownloadFilesConcurrently property. - Specifies if multiple files will be downloaded concurrently. - The number of concurrent web requests used is controlled - by the TransferUtilityConfig.ConcurrencyLevel property. - - - - - The event for DownloadedDirectoryProgressEvent notifications. All - subscribers will be notified when a new progress - event is raised. - - The DownloadedDirectoryProgressEvent is fired as data - is downloaded from Amazon S3. The delegates attached to the event - will be passed information detailing how much data - has been downloaded as well as how much will be downloaded. - - - - Subscribe to this event if you want to receive - DownloadedDirectoryProgressEvent notifications. Here is how:
- 1. Define a method with a signature similar to this one: - - private void displayProgress(object sender, DownloadDirectoryProgressArgs args) - { - Console.WriteLine(args); - } - - 2. Add this method to the DownloadedDirectoryProgressEvent delegate's invocation list - - TransferUtilityDownloadDirectoryRequest request = new TransferUtilityDownloadDirectoryRequest(); - request.DownloadedDirectoryProgressEvent += displayProgress; - - - - - - Encapsulates the information needed to provide - transfer progress to subscribers of the DownloadDirectory - event. - - - - - Constructs a new instance of DownloadDirectoryProgressArgs. - - - The number of files downloaded. - - - The total number of files to download. - - - The current file being downloaded - - - The number of transferred bytes for the current file. - - - The size of the current file in bytes. - - - - - Constructs a new instance of DownloadDirectoryProgressArgs. - - - The number of files downloaded. - - - The total number of files to download. - - - The bytes transferred across all files being downloaded. - - - The total number of bytes across all files being downloaded. - - - The current file being downloaded. - - - The number of transferred bytes for the current file. - - - The size of the current file in bytes. - - - - - Gets or sets the total number of files. - - The total number of files. - - - - Gets or sets the number of files downloaded so far. - - The number of files downloaded. - - - - Gets or sets the total number of bytes across all files being downloaded. - - The total number of bytes across all files being downloaded. - - - - Gets or sets the bytes transferred across all files being downloaded. - - The bytes transferred across all files being downloaded. - - - - Gets or sets the current file being downloaded. - - The current file being downloaded. - - - - Gets or sets the transferred bytes for the current file. - - The transferred bytes for the current file. - - - - Gets or sets the total number of bytes for the current file. - - The total number of bytes for the current file. - - - - The string representation of this instance of DownloadDirectoryProgressArgs. - - The string representation of this instance of DownloadDirectoryProgressArgs. - - - - Contains all the parameters - that can be set when making a this request with the - TransferUtility method. - - - - - Get or sets the file path location of where the - downloaded Amazon S3 object will be written to. - - - The file path location of where the downloaded Amazon S3 object will be written to. - - - - - Checks if FilePath property is set. - - True if FilePath property is set. - - - - The event for WriteObjectProgressEvent notifications. All - subscribers will be notified when a new progress - event is raised. - - The WriteObjectProgressEvent is fired as data - is downloaded from S3. The delegates attached to the event - will be passed information detailing how much data - has been downloaded as well as how much will be downloaded. - - - - Subscribe to this event if you want to receive - WriteObjectProgressEvent notifications. Here is how:
- 1. Define a method with a signature similar to this one: - - private void displayProgress(object sender, WriteObjectProgressArgs args) - { - Console.WriteLine(args); - } - - 2. Add this method to the WriteObjectProgressEvent delegate's invocation list - - TransferUtilityDownloadRequest request = new TransferUtilityDownloadRequest(); - request.WriteObjectProgressEvent += displayProgress; - - - - - - Causes the WriteObjectProgressEvent event to be fired. - - Progress data for the stream being written to file. - - - - Contains all the parameters - that can be set when making a this request with the - TransferUtility method. - - - - - Contains all the parameters - that can be set when making a this request with the - TransferUtility method. - - - - - Gets or sets the directory where files are uploaded from. - - - The directory where files are uploaded from. - - - - - Checks if Directory property is set. - - true if Directory property is set. - - - - Gets or sets the KeyPrefix property. As object keys are generated for the - files being uploaded this value will prefix the key. This is useful when a directory - needs to be uploaded into sub directory in the S3 Bucket. - - - The directory where files are uploaded from. - - - - - Checks if KeyPrefix property is set. - - true if KeyPrefix property is set. - - - - Gets and sets the search pattern used to determine which - files in the directory are uploaded. - - - The search pattern used to deterimine which - files in the directory are uploaded. - The default value is "*", specifying that all files - in the directory will be uploaded. - - - - - Checks if SearchPattern property is set. - - true if SearchPattern property is set. - - - - Gets or sets the recursive options for the directory upload. - - - The recursive options for the directory upload. - Set by default to TopDirectoryOnly, - specifying that files will be uploaded from the root directory only. - - - - - Gets or sets the name of the bucket. - - - The name of the bucket. - - - - - Checks if BucketName property is set. - - true if BucketName property is set. - - - - Gets or sets the canned access control list (ACL) - for the uploaded objects. - Please refer to - for - information on Amazon S3 canned ACLs. - - - The canned access control list (ACL) - for the uploaded objects. - - - - - Checks if the CannedACL property is set. - - true if there is the CannedACL property is set. - - - - Gets or sets the content type for the uploaded Amazon S3 objects. - The default behavior when this field is not set is to use the file - extension to set the content type. If this field is set to a value it - will be applied to all uploaded files in the directory, overriding - file extension inspection. - - - The content type for all the uploaded Amazon S3 objects. - - - - - Gets or sets the storage class for the uploaded Amazon S3 objects. - Please refer to - for - information on S3 Storage Classes. - - - The storage class for the uploaded Amazon S3 objects. - - - - - The collection of meta data for the request. - - - - - Gets or sets the ServerSideEncryptionMethod property. - Specifies the encryption used on the server to - store the content. - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Gets or sets the UploadFilesConcurrently property. - Specifies if multiple files will be uploaded concurrently. - The number of concurrent web requests used is controlled - by the TransferUtilityConfig.ConcurrencyLevel property. - - - - - The event for UploadDirectoryProgressEvent notifications. All - subscribers will be notified when a new progress - event is raised. - - The UploadDirectoryProgressEvent is fired as data - is uploaded to S3. The delegates attached to the event - will be passed information detailing how much data - has been uploaded as well as how much will be uploaded. - - - - Subscribe to this event if you want to receive - UploadDirectoryProgressEvent notifications. Here is how:
- 1. Define a method with a signature similar to this one: - - private void displayProgress(object sender, UploadDirectoryProgressArgs args) - { - Console.WriteLine(args); - } - - 2. Add this method to the UploadDirectoryProgressEvent delegate's invocation list - - TransferUtilityUploadDirectoryRequest request = new TransferUtilityUploadDirectoryRequest(); - request.UploadDirectoryProgressEvent += displayProgress; - - - - - - The event for modifying individual TransferUtilityUploadRequest for each file - being uploaded. - - - - - Causes the UploadDirectoryProgressEvent event to be fired. - - Progress data for files currently being uploaded. - - - - Tags that will be applied to all objects in the diretory. - - - - - Encapsulates the information needed to provide - transfer progress to subscribers of the UploadDirectory - event. - - - - - Constructs a new instance of UploadDirectoryProgressArgs. - - - The number of files uploaded. - - - The total number of files to upload. - - - The current file - - - The number of transferred bytes for current file. - - - The size of the current file in bytes. - - - - - Constructs a new instance of UploadDirectoryProgressArgs. - - - The number of files uploaded. - - - The total number of files to upload. - - - The bytes transferred across all files being uploaded. - - - The total number of bytes across all files being uploaded. - - - The current file being uploaded. - - - The number of transferred bytes for current file. - - - The size of the current file in bytes. - - - - - Gets or sets the total number of files. - - The total number of files. - - - - Gets or sets the number of files uploaded. - - The number of files uploaded. - - - - Gets or sets the total number of bytes across all files being uploaded. - - The total number of bytes across all files being uploaded. - - - - Gets or sets the bytes transferred across all files being uploaded. - - The bytes transferred across all files being uploaded. - - - - Gets or sets the current file. - - - This property is only valid if UploadDirectory is used without enabling concurrent file uploads (by default concurrent upload is disabled). - If concurrent file uploads are enabled by setting TransferUtilityUploadDirectoryRequest.UploadFilesConcurrently to true, this property - will return null. - - The current file. - - - - Gets or sets the transferred bytes for current file. - - - This property is only valid if UploadDirectory is used without enabling concurrent file uploads (by default concurrent upload is disabled). - If concurrent file uploads are enabled by setting TransferUtilityUploadDirectoryRequest.UploadFilesConcurrently to true, this property - will return 0. - - The transferred bytes for current file. - - - - Gets or sets the total number of bytes for current file. - - - This property is only valid if UploadDirectory is used without enabling concurrent file uploads (by default concurrent upload is disabled). - If concurrent file uploads are enabled by setting TransferUtilityUploadDirectoryRequest.UploadFilesConcurrently to true, this property - will return 0. - - The total number of bytes for current file. - - - - The string representation of this instance of UploadDirectoryProgressArgs. - - The string representation of this instance of UploadDirectoryProgressArgs. - - - - Contains a single TransferUtilityUploadRequest corresponding - to a single file about to be uploaded, allowing changes to - the request before it is executed. - - - - - Constructs a new UploadDirectoryFileRequestArgs instance. - - Request being processed. - - - - Gets and sets the UploadRequest property. - - - - - Contains all the parameters - that can be set when making a this request with the - TransferUtility method. - - - - - Gets or sets the name of the bucket. - - - The name of the bucket. - - - - - Checks if BucketName property is set. - - true if BucketName property is set. - - - - Gets or sets the key under which the Amazon S3 object is to be stored. - - - The key under which the Amazon S3 object is to be stored. - - - - - Checks if Key property is set. - - true if Key property is set. - - - - Gets or sets the canned access control list (ACL) - for the uploaded object. - Please refer to - for - information on Amazon S3 canned ACLs. - - - The canned access control list (ACL) - for the uploaded object. - - - - - Checks if the CannedACL property is set. - - true if there is the CannedACL property is set. - - - - Removes the cannned access control list (ACL) - for the uploaded object. - - - - - Gets or sets the content type of the uploaded Amazon S3 object. - - - The content type of the uploaded Amazon S3 object. - - - - - Checks if ContentType property is set. - - true if ContentType property is set. - - - - Gets or sets the storage class for the uploaded Amazon S3 object. - Please refer to - for - information on S3 Storage Classes. - - - The storage class for the uploaded Amazon S3 object. - - - - - Gets and sets the ServerSideEncryptionMethod property. - Specifies the encryption used on the server to - store the content. - - - - - The Server-side encryption algorithm to be used with the customer provided key. - - - - - - The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. - If a key id is not specified, the default key will be used for encryption and decryption. - - - - - Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - true if ServerSideEncryptionKeyManagementServiceKeyId property is set. - - - - The base64-encoded encryption key for Amazon S3 to use to encrypt the object - - Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes - to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only - thing you do is manage the encryption keys you provide. - - - When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies - the encryption key you provided matches, and then decrypts the object before returning the object data to you. - - - Important: Amazon S3 does not store the encryption key you provide. - - - - - - The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is - base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. - - - - - Input stream for the request; content for the request will be read from the stream. - - - - - - Gets or sets the file path - where the Amazon S3 object will be uploaded from. - - - For WinRT and Windows Phone this property must be in the form of "ms-appdata:///local/file.txt". - - - - The file path where the Amazon S3 object will be uploaded from. - - - - - Checks if FilePath property is set. - - true if FilePath property is set. - - - - Gets or sets the part size of the upload in bytes. - The uploaded file will be divided into - parts the size specified and - uploaded to Amazon S3 individually. - - - The part size of the upload. - - - - - Checks if PartSize property is set. - - true if PartSize property is set. - - - - The collection of headers for the request. - - - - - The collection of meta data for the request. - - - - - The tag-set for the object. - - - - - The event for UploadProgressEvent notifications. All - subscribers will be notified when a new progress - event is raised. - - The UploadProgressEvent is fired as data - is uploaded to S3. The delegates attached to the event - will be passed information detailing how much data - has been uploaded as well as how much will be uploaded. - - - - Subscribe to this event if you want to receive - UploadProgressEvent notifications. Here is how:
- 1. Define a method with a signature similar to this one: - - private void displayProgress(object sender, UploadProgressArgs args) - { - Console.WriteLine(args); - } - - 2. Add this method to the UploadProgressEvent delegate's invocation list - - TransferUtilityUploadRequest request = new TransferUtilityUploadRequest(); - request.UploadProgressEvent += displayProgress; - - - - - - Causes the UploadProgressEvent event to be fired. - - Progress data for the file being uploaded. - - - - Gets the length of the content by either checking the FileInfo.Length property or the Stream.Length property. - - The length of the content. - - - - Gets or sets whether or not the stream used with this request is - automatically closed when all of the content is read from the stream. - - - A value of true if the if the stream is - automatically closed when all of the content is read from the stream. - A value of false if otherwise. - - - - - If this value is set to true then the stream's position will be reset to the start before being read for upload. - Default: true. - - - - - Sets whether or not the stream used with this request is - automatically closed when all of the content is read from the stream - and returns this object instance, - enabling additional method calls to be chained together. - - - A value of true if the if the stream is - automatically closed when all of the content is read from the stream. - A value of false if otherwise. - - - This object instance, enabling additional method calls to be chained together. - - - - - Encapsulates the information needed to provide - transfer progress to subscribers of the Put Object - Event. - - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The how many bytes were transferred since last event. - The number of bytes transferred - The total number of bytes to be transferred - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The how many bytes were transferred since last event. - The number of bytes transferred - The total number of bytes to be transferred - The file being uploaded - - - - The constructor takes the number of - currently transferred bytes and the - total number of bytes to be transferred - - The how many bytes were transferred since last event. - The number of bytes transferred - The total number of bytes to be transferred - A compensation for any upstream aggregators if this event to correct theit totalTransferred count, - in case the underlying request is retried. - The file being uploaded - - - - Gets the FilePath. - - - - - Uri wrapper that can parse out information (bucket, key, region, style) from an - S3 URI. - - - - - True if the URI contains the bucket in the path, false if it contains the bucket in the authority. - - - - - The bucket name parsed from the URI (or null if no bucket specified). - - - - - The key parsed from the URI (or null if no key specified). - - - - - The region parsed from the URI (or null if no region specified). - - - - - Constructs a parser for the S3 URI specified as a string. - - The S3 URI to be parsed. - - - - Constructs a parser for the S3 URI specified as a Uri instance. - - The S3 URI to be parsed. - - - - If the given string is an AmazonS3Endpoint return true and set the AmazonS3Uri out parameter. - - - - true if the string is an AmazonS3Endpoint, and the out paramter has been filled in, false otherwise - - - - If the given Uri is an AmazonS3Endpoint return true and set the AmazonS3Uri out parameter. - - - - true if the Uri is an AmazonS3Endpoint, and the out paramter has been filled in, false otherwise - - - - Checks whether the given URI is a Amazon S3 URI. - - The S3 URI to be checked. - true if the URI is a Amazon S3 URI, false; otherwise. - - - - Checks whether the given URI is a Amazon S3 URI. - - The S3 URI to be checked. - true if the URI is a Amazon S3 URI, false; otherwise. - - - - Percent-decodes the given string, with a fast path for strings that are not - percent-encoded. - - The string to decode - The decoded string - - - - Percent-decodes the given string. - - The string to decode - The index of the first '%' in the string - The decoded string - - - - Decodes the percent-encoded character at the given index in the string - and appends the decoded value to the string under construction. - - - The string under construction to which the decoded character will be - appended. - - The string being decoded. - The index of the '%' character in the string. - - - - Converts a hex character (0-9A-Fa-f) into its corresponding quad value. - - The hex character - The quad value - - - - Provides utilities used by the Amazon S3 client implementation. - These utilities might be useful to consumers of the Amazon S3 - library. - - - Provides utilities used by the Amazon S3 client implementation. - These utilities might be useful to consumers of the Amazon S3 - library. - - - - - Determines MIME type from a file extension - - The extension of the file - The MIME type for the extension, or text/plain - - - - URL encodes a string. If the path property is specified, - the accepted path characters {/+:} are not encoded. - - The string to encode - Whether the string is a URL path or not - - - - - Converts a non-seekable stream into a System.IO.MemoryStream. - A MemoryStream's position can be moved arbitrarily - - The stream to be converted - A seekable MemoryStream - MemoryStreams use byte arrays as their backing store. - Please use this judicially as it is likely that a very large - stream will cause system resources to be used up. - - - - - Formats the current date as a GMT timestamp - - A GMT formatted string representation - of the current date and time - - - - - Generates an MD5 Digest for the string-based content - - The content for which the MD5 Digest needs - to be computed. - - Whether the returned checksum should be - base64 encoded. - - A string representation of the hash with or w/o base64 encoding - - - - - Version2 S3 buckets adhere to RFC 1035: - - Less than 255 characters, with each label less than 63 characters. - Label must start with a letter - Label must end with a letter or digit - Label can have a string of letter, digits and hyphens in the middle. - Although names can be case-sensitive, no significance is attached to the case. - RFC 1123: Allow label to start with letter or digit (e.g. 3ware.com works) - RFC 2181: No restrictions apart from the length restrictions. - - S3 V2 will start with RFCs 1035 and 1123 and impose the following additional restrictions: - - Length between 3 and 63 characters (to allow headroom for upper-level domains, - as well as to avoid separate length restrictions for bucket-name and its labels - Only lower-case to avoid user confusion. - No dotted-decimal IPv4-like strings - - - The BucketName to validate if V2 addressing should be used - True if the BucketName should use V2 bucket addressing, false otherwise - - S3 v2 Bucket restrictions - - - - Determines whether an S3 bucket exists or not. - - The name of the bucket to check. - The Amazon S3 Client to use for S3 specific operations. - False is returned in case S3 responds with a NoSuchBucket error. - True is returned in case of success, AccessDenied error or PermanentRedirect error. - An exception is thrown in case of any other error. - This method calls GetACL for the bucket. - - - - Determines whether an S3 bucket exists or not. - This is done by: - 1. Creating a PreSigned Url for the bucket. To work with Signature V4 only regions, as - well as Signature V4-optional regions, we keep the expiry to within the maximum for V4 - (which is one week). - 2. Making a HEAD request to the Url - - The name of the bucket to check. - The Amazon S3 Client to use for S3 specific operations. - - - - - Deletes an S3 bucket which contains objects. - An S3 bucket which contains objects cannot be deleted until all the objects - in it are deleted. This method deletes all the objects in the specified - bucket and then deletes the bucket itself. - - The bucket to be deleted. - The Amazon S3 Client to use for S3 specific operations. - - - - Deletes an S3 bucket which contains objects. - An S3 bucket which contains objects cannot be deleted until all the objects - in it are deleted. This method deletes all the objects in the specified - bucket and then deletes the bucket itself. - - The bucket to be deleted. - The Amazon S3 Client to use for S3 specific operations. - Options to control the behavior of the delete operation. - - - - Initiates the asynchronous execution of the DeleteS3BucketWithObjects operation. - DeleteS3BucketWithObjects deletes an S3 bucket which contains objects. - An S3 bucket which contains objects cannot be deleted until all the objects - in it are deleted. This method deletes all the objects in the specified - bucket and then deletes the bucket itself. - - The bucket to be deleted. - The Amazon S3 Client to use for S3 specific operations. - token to check if the operation has been request to cancel. - An IAsyncCancelableResult that can be used to poll or wait for results, or both; - this value is also needed when invoking EndDeleteS3BucketWithObjects. IAsyncCancelableResult can also - be used to cancel the operation while it's in progress. - - - - Initiates the asynchronous execution of the DeleteS3BucketWithObjects operation. - DeleteS3BucketWithObjects deletes an S3 bucket which contains objects. - An S3 bucket which contains objects cannot be deleted until all the objects - in it are deleted. This method deletes all the objects in the specified - bucket and then deletes the bucket itself. - - The bucket to be deleted. - The Amazon S3 Client to use for S3 specific operations. - Options to control the behavior of the delete operation. - token to check if the operation has been request to cancel. - An IAsyncCancelableResult that can be used to poll or wait for results, or both; - this value is also needed when invoking EndDeleteS3BucketWithObjects. IAsyncCancelableResult can also - be used to cancel the operation while it's in progress. - - - - Initiates the asynchronous execution of the DeleteS3BucketWithObjects operation. - DeleteS3BucketWithObjects deletes an S3 bucket which contains objects. - An S3 bucket which contains objects cannot be deleted until all the objects - in it are deleted. This method deletes all the objects in the specified - bucket and then deletes the bucket itself. - - The bucket to be deleted. - The Amazon S3 Client to use for S3 specific operations. - >Options to control the behavior of the delete operation. - An callback that is invoked to send updates while delete operation is in progress. - token to check if the operation has been request to cancel. - An IAsyncCancelableResult that can be used to poll or wait for results, or both; - this value is also needed when invoking EndDeleteS3BucketWithObjects. IAsyncCancelableResult can also - be used to cancel the operation while it's in progress. - - - - Invokes the DeleteS3BucketWithObjectsInternal method. - - The Request object that has all the data to complete the operation. - token to request the operation to be cancelled. - - - - Deletes an S3 bucket which contains objects. - An S3 bucket which contains objects cannot be deleted until all the objects - in it are deleted. The function deletes all the objects in the specified - bucket and then deletes the bucket itself. - - The bucket to be deleted. - The Amazon S3 Client to use for S3 specific operations. - Options to control the behavior of the delete operation. - The callback which is used to send updates about the delete operation. - token to check if the operation has been request to cancel. - - - - Invokes the callback which provides updated about the delete operation. - - The callback to be invoked. - The data being passed to the callback. - 8 - - - - Class to manage and cache the correct region for buckets accessed without an explicit region. - - - Class to manage and cache the correct region for buckets accessed without an explicit region. - - - - - A cache of BucketName -> RegionEndpoint pairs. - The cache is used to make sure that bucket requests are signed for the correct region, - even when requesting them without an explicit region. - - - - - Detect a bucket region mismatch based on the x-amz-bucket-region header, and the status code provided. - - - - - - - - - Detects if the signature is malformed, and the requested bucket is in a Region - different from the Region of the request. - - - - the correct region if a mismatch was detected, null otherwise - - - - Detects if the signature is malformed, and the requested bucket is in a Region - different from the Region of the request. - - - - - the correct region if a mismatch was detected, null otherwise - - - - Use a HEAD bucket request to get the region for the given bucket. - - This method creates an AmazonS3Client from the credentials passed in. - It's critical that the AmazonS3Client is not used to make any requests that will - be routed through the pipeline. - - - - the value of the x-amz-bucket-region header from the response - - - - Options which control the behaviour of the DeleteS3BucketWithObjects operation. - - - - - Gets or sets a value which indicates whether the - operation should be aborted if an error is encountered during execution. - - - - - Gets or sets a value which indicated whether verbose results shoule be returned to the - callback. - If quiet mode is true the callback will receive only keys where the delete operation encountered an error. - If quiet mode is false the callback will receive keys for both successful and unsuccessful delete operations. - - - - - Internal class used to pass the parameters for DeleteS3BucketWithObjects operation. - - - - - Name of the bucket to be deleted. - - - - - The Amazon S3 Client to use for S3 specific operations. - - - - - Options to control the behavior of the delete operation. - - - - - The callback which is used to send updates about the delete operation. - - - - - Contains updates from DeleteS3BucketWithObjects operation. - - - - - The list of objects which were successfully deleted. - - - - - The list of objects for which the delete operation failed. - - - - - A helper class that represents a strongly typed S3 EventNotification item sent to SQS - - - - - Parse the JSON string into a S3EventNotification object. - - The function will try its best to parse input JSON string as best as it can. - It will not fail even if the JSON string contains unknown properties. - - For any parsing errors - - - - - Gets and sets the records for the S3 event notification - - - - - The class holds the user identity properties. - - - - - Gets and sets the PrincipalId property. - - - - - This class contains the identity information for an S3 bucket. - - - - - Gets and sets the name of the bucket. - - - - - Gets and sets the bucket owner id. - - - - - Gets and sets the S3 bucket arn. - - - - - This class contains the information for an object in S3. - - - - - Gets and sets the key for the object stored in S3. - - - - - Gets and sets the size of the object in S3. - - - - - Gets and sets the etag of the object. This can be used to determine if the object has changed. - - - - - Gets and sets the version id of the object in S3. - - - - - Gets and sets the sequencer a string representation of a hexadecimal value used to determine event sequence, only used with PUTs and DELETEs. - - - - - Gets and sets the meta information describing S3. - - - - - Gets and sets the ConfigurationId. This ID can be found in the bucket notification configuration. - - - - - Gets and sets the Bucket property. - - - - - Gets and sets the Object property. - - - - - Gets and sets the S3SchemaVersion property. - - - - - The class holds the request parameters - - - - - Gets and sets the SourceIPAddress. This is the ip address where the request came from. - - - - - This class holds the response elements. - - - - - Gets and sets the XAmzId2 Property. This is the Amazon S3 host that processed the request. - - - - - Gets and sets the XAmzRequestId. This is the Amazon S3 generated request ID. - - - - - The class holds the glacier event data elements. - - - - - Gets and sets the RestoreEventData property. - - - - - The class holds the restore event data elements. - - - - - Gets and sets the LifecycleRestorationExpiryTime the time when the object restoration will be expired. - - - - - Gets and sets the LifecycleRestoreStorageClass the source storage class for restore. - - - - - The class holds the event notification. - - - - - Gets and sets the AwsRegion property. - - - - - Gets and sets the EventName property. This identities what type of event occurred. - For example for an object just put in S3 this will be set to EventType.ObjectCreatedPut. - - - - - Gets and sets the EventSource property. - - - - - Gets and sets the EventType property. The time when S3 finished processing the request. - - - - - Gets and sets the EventVersion property. - - - - - Gets and sets the RequestParameters property. - - - - - Gets and sets the ResponseElements property. - - - - - Gets and sets the S3 property. - - - - - Gets and sets the UserIdentity property. - - - - - Get and sets the GlacierEventData property. - - - - - Configuration for the S3 section of AWS configuration. - Changes to some settings may not take effect until a new client is constructed. - - Example section: - - <configSections> - <section name="aws" type="Amazon.AWSSection, AWSSDK"/> - </configSections> - <aws> - <s3 useSignatureVersion4="true" /> - </aws> - - - - - - Key for the S3UseSignatureVersion4Key property. - - - - - - Configures if the S3 client should use Signature Version 4 signing with requests. - By default, this setting is set to true which will use Signature Version 4 for all - requests except presigned URL requests when the region is set to us-east-1. When - UseSignatureVersion4 is explicitly set to true by directly setting this property or - directly setting this property through configuration, Signature Version 4 will be - used for all requests when able to do so. - When this setting is false, Signature Version 2 will be used. Note that when the - setting is false, Signature Version 4 may still be used by default in some cases - or with some regions. - - - - - Was the value of the UseSignatureVersion4 property set explicitly? - This can be done via configuration or by directly setting the property. - - This is used to determine if the user set UseSignatureVersion4 to true, - or if it's true because the default was changed to true in the SDK. - - - - diff --git a/packages/AWSSDK.S3.3.5.0-beta/tools/install.ps1 b/packages/AWSSDK.S3.3.5.0-beta/tools/install.ps1 deleted file mode 100644 index 8178834..0000000 --- a/packages/AWSSDK.S3.3.5.0-beta/tools/install.ps1 +++ /dev/null @@ -1,49 +0,0 @@ -param($installPath, $toolsPath, $package, $project) - -$analyzersPaths = Join-Path (Join-Path (Split-Path -Path $toolsPath -Parent) "analyzers" ) * -Resolve - -foreach($analyzersPath in $analyzersPaths) -{ - # Install the language agnostic analyzers. - if (Test-Path $analyzersPath) - { - foreach ($analyzerFilePath in Get-ChildItem $analyzersPath -Filter *.dll) - { - if($project.Object.AnalyzerReferences) - { - $project.Object.AnalyzerReferences.Add($analyzerFilePath.FullName) - } - } - } -} - -# $project.Type gives the language name like (C# or VB.NET) -$languageFolder = "" -if($project.Type -eq "C#") -{ - $languageFolder = "cs" -} -if($project.Type -eq "VB.NET") -{ - $languageFolder = "vb" -} -if($languageFolder -eq "") -{ - return -} - -foreach($analyzersPath in $analyzersPaths) -{ - # Install language specific analyzers. - $languageAnalyzersPath = join-path $analyzersPath $languageFolder - if (Test-Path $languageAnalyzersPath) - { - foreach ($analyzerFilePath in Get-ChildItem $languageAnalyzersPath -Filter *.dll) - { - if($project.Object.AnalyzerReferences) - { - $project.Object.AnalyzerReferences.Add($analyzerFilePath.FullName) - } - } - } -} \ No newline at end of file diff --git a/packages/AWSSDK.S3.3.5.0-beta/tools/uninstall.ps1 b/packages/AWSSDK.S3.3.5.0-beta/tools/uninstall.ps1 deleted file mode 100644 index 9130bcb..0000000 --- a/packages/AWSSDK.S3.3.5.0-beta/tools/uninstall.ps1 +++ /dev/null @@ -1,56 +0,0 @@ -param($installPath, $toolsPath, $package, $project) - -$analyzersPaths = Join-Path (Join-Path (Split-Path -Path $toolsPath -Parent) "analyzers" ) * -Resolve - -foreach($analyzersPath in $analyzersPaths) -{ - # Uninstall the language agnostic analyzers. - if (Test-Path $analyzersPath) - { - foreach ($analyzerFilePath in Get-ChildItem $analyzersPath -Filter *.dll) - { - if($project.Object.AnalyzerReferences) - { - $project.Object.AnalyzerReferences.Remove($analyzerFilePath.FullName) - } - } - } -} - -# $project.Type gives the language name like (C# or VB.NET) -$languageFolder = "" -if($project.Type -eq "C#") -{ - $languageFolder = "cs" -} -if($project.Type -eq "VB.NET") -{ - $languageFolder = "vb" -} -if($languageFolder -eq "") -{ - return -} - -foreach($analyzersPath in $analyzersPaths) -{ - # Uninstall language specific analyzers. - $languageAnalyzersPath = join-path $analyzersPath $languageFolder - if (Test-Path $languageAnalyzersPath) - { - foreach ($analyzerFilePath in Get-ChildItem $languageAnalyzersPath -Filter *.dll) - { - if($project.Object.AnalyzerReferences) - { - try - { - $project.Object.AnalyzerReferences.Remove($analyzerFilePath.FullName) - } - catch - { - - } - } - } - } -} \ No newline at end of file